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
// 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, function(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."
}, function (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, function(req, res) {
res.end("Welcome to private area - " + req.user + "!");
}).listen(1337);
express framework integration
// 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('/', function(req, res) {
res.send("Hello from express - " + req.user + "!");
});
koa framework integration
// Authentication module.
var auth = require('http-auth');
var basic = auth.basic({
realm: "Simon Area.",
file: __dirname + "/../data/users.htpasswd"
});
// Enable auth.
app.use(auth.koa(basic));
// Final handler.
app.use(function *() {
this.body = "Hello from koa - " + this.req.user + "!";
});
// 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), function(req, res) {
res.send("Hello from admin area - " + req.user + "!");
});
// Setup route.
app.get('/', function(req, res) {
res.send("Not protected area!");
});
passport integration
// 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}),
function(req, res) {
res.end("Welcome to private area - " + req.user + "!");
}
);
http-proxy integration
// 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(function (req, res) {
res.end("Request successfully proxied!");
}).listen(1338);
realm
- Authentication realm, by default it is Users.file
- File where user details are stored.- Line format is {user:pass} or {user:passHash} for basic access.
- Line format is {user:realm:passHash} for digest access.
algorithm
- Algorithm that will be used only for digest access authentication.- MD5 by default.
- MD5-sess can be set.
qop
- Quality of protection that is used only for digest access authentication.- auth is set by default.
- none this option is disabling protection.
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.
- Node.js - Event-driven I/O server-side JavaScript environment based on V8.
- npm - Package manager. Installs, publishes and manages node programs.
- htpasswd - Node.js package for HTTP Basic Authentication password file utility.
- htdigest - Node.js package for HTTP Digest Authentication password file utility.
- node-uuid - Generate RFC4122(v4) UUIDs, and also non-RFC compact ids.
- apache-md5 - Node.js module for Apache style password encryption using md5.
- apache-crypt - Node.js module for Apache style password encryption using crypt(3).
- babel - compiler for writing next generation JavaScript.
- mocha - simple, flexible, fun javascript test framework for node.js & the browser.
- chai - BDD / TDD assertion framework for node.js and the browser that can be paired with any testing framework.
- express - Sinatra inspired web development framework for node.js -- insanely fast, flexible, and simple.
- http-proxy - A full-featured http proxy for node.js.
- request - Simplified HTTP request client.
- passport - Simple, unobtrusive authentication for Node.js.
- koa - next generation web framework for node.js.
The MIT License (MIT)
Copyright (c) 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.