Node.js package for HTTP basic and digest access authentication.
Via git (or downloaded tarball):
$ git clone git://github.com/http-auth/http-auth.git
Via npm:
$ npm install http-auth
```
## Basic example
```javascript
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Creating new HTTP server.
http.createServer(basic, (req, res) => {
res.end(`Welcome to private area - ${req.user}!`);
}).listen(1337);
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area."
}, (username, password, callback) => {
// Custom authentication
// Use callback(error) if you want to throw async error.
callback(username === "Tina" && password === "Bullock");
}
);
// Creating new HTTP server.
http.createServer(basic, (req, res) => {
res.end(`Welcome to private area - ${req.user}!`);
}).listen(1337);
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Application setup.
var app = express();
app.use(auth.connect(basic));
// Setup route.
app.get('/', (req, res) => {
res.send(`Hello from express - ${req.user}!`);
});
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Final handler.
app.use(function *(next) {
yield next;
this.body = `Hello from koa - ${this.req.user}!`;
});
// Enable auth.
app.use(auth.koa(basic));
// Authentication module.
import auth from 'http-auth'
import koaAuth from 'http-auth-koa'
const basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Koa setup.
import Koa from 'koa'
const app = new Koa();
// Setup basic handler.
app.use(async (ctx, next) => {
await next();
ctx.body = `Welcome to koa ${ctx.req.user}!`;
});
// Setup auth.
app.use(koaAuth(basic));
// Authentication module.
const auth = require('http-auth');
// Setup auth.
const basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Create server.
const server = new Hapi.Server();
server.connection({ port: 1337 });
// Register auth plugin.
server.register(auth.hapi());
// Setup strategy.
server.auth.strategy('http-auth', 'http', basic);
// Setup route.
server.route({
method: 'GET',
path: '/',
config: {
auth: 'http-auth',
handler: (request, reply) => {
reply(`Welcome from Hapi - ${request.auth.credentials.name}!`);
}
}
});
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Application setup.
var app = express();
// Setup route.
app.get('/admin', auth.connect(basic), (req, res) => {
res.send(`Hello from admin area - ${req.user}!`);
});
// Setup route.
app.get('/', (req, res) => {
res.send("Not protected area!");
});
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Application setup.
var app = express();
// Setup strategy.
var passport = require('passport');
passport.use(auth.passport(basic));
// Setup route.
app.get('/', passport.authenticate('http', {session: false}),
(req, res) => {
res.end(`Welcome to private area - ${req.user}!`);
}
);
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Create your proxy server.
httpProxy.createServer(basic, {
target: 'http://localhost:1338'
}).listen(1337);
// Create your target server.
http.createServer((req, res) => {
res.end("Request successfully proxied!");
}).listen(1338);
The auth middleware emits three types of events: error, fail and success. Each event passes the result object (the error in case of fail
) and the http request req
to the listener function.
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
basic.on('success', (result, req) => {
console.log(`User authenticated: ${result.user}`);
});
basic.on('fail', (result, req) => {
console.log(`User authentication failed: ${result.user}`);
});
basic.on('error', (error, req) => {
console.log(`Authentication error: ${error.code + " - " + error.message}`);
});
realm
- Authentication realm, by default it is Users.file
- File where user details are stored.
algorithm
- Algorithm that will be used only for digest access authentication.
qop
- Quality of protection that is used only for digest access authentication.
msg401
- Message for failed authentication 401 page.msg407
- Message for failed authentication 407 page.contentType
- Content type for failed authentication page.skipUser
- Set this to true, if you don’t want req.user to be filled with authentication info.It uses mocha, so just run following command in package directory:
$ npm test
You can find list of issues using this link.
You can also use stackoverflow to ask questions using http-auth tag.
The MIT License (MIT)
Copyright © 2016 Gevorg Harutyunyan
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.