Skip to content

Latest commit

 

History

History
154 lines (126 loc) · 5.35 KB

README.md

File metadata and controls

154 lines (126 loc) · 5.35 KB
Raw

http-auth

Node.js package for HTTP basic and digest access authentication.

Build Status

Installation

Via git (or downloaded tarball):

$ git clone git://github.com/gevorg/http-auth.git

Via npm:

$ npm install http-auth

Example of usage

/**
 * Requesting new authentication instance.
 */
var basic = auth({
	authRealm : "Private area.",
	// username is mia, password is supergirl.
	authList : ['mia:{SHA}x511ncXd+4fOnYAotcGPFD0peYo=']
});

/**
 * Creating new HTTP server.
 */
http.createServer(function(req, res) {
	// Apply authentication to server.
	basic.apply(req, res, function(username) {
		res.end("Welcome to private area - " + username + "!");
	});
}).listen(1337);

Example of loading list of users from file

/**
 * Requesting new authentication instance.
 */
var basic = auth({
	authRealm : "Private area.",
	authFile : __dirname + '/users.htpasswd'
});

/**
 * Creating new HTTP server.
 */
http.createServer(function(req, res) {
	// Apply authentication to server.
	basic.apply(req, res, function(username) {
		res.end("Welcome to private area, " + username + "!");
	});
}).listen(1337);

Example with express framework integration

/**
 * Requesting new authentication instance.
 */
var basic = auth({
	authRealm : "Private area.",
	authList : ['Shi:many222', 'Lota:123456']
});

/**
 * Handler for path with authentication.
 */
app.get('/', function(req, res) {
    basic.apply(req, res, function(username) {
        res.send("Welcome to private area - " + username + "!");
    });
});

Example with http-proxy integration

/**
 * Requesting new authentication instance.
 */
var basic = auth({
	authRealm : "Private area.",
	authList : ['mia:supergirl', 'Carlos:test456', 'Sam:oho']
});

/**
 * Create a proxy server with custom application logic.
 */
httpProxy.createServer(function(req, res, proxy) {
	basic.apply(req, res, function() {
		proxy.proxyRequest(req, res, {
			host : 'localhost',
			port : 9000
		});
	});
}).listen(8000);

/**
 * Destination server.
 */
http.createServer(function(req, res) {
	res.end('request successfully proxied!');
}).listen(9000);

Configurations

  • authRealm - Authentication realm.
  • authHelper - Function that allows to override standard authentication method by providing custom user loading mechanism.
  • authFile - File where user details are stored in format {user:pass} or {user:passHash} for basic access and {user:realm:passHash} for digest access.
  • authList - List where user details are stored in format {user:pass} or {user:passHash} for basic access and {user:realm:passHash} for digest access, ignored if authFile is specified.
  • authType - Type of authentication, may be basic or digest, optional, default is basic.
  • algorithm - Algorithm that will be used for authentication, may be MD5 or MD5-sess, optional, default is MD5. Only for digest authType.

Running tests

It uses nodeunit, so just run following command in package directory:

$ npm test

Issues

You can find list of issues using this link.

Requirements

  • Node.js - Event-driven I/O server-side JavaScript environment based on V8.
  • npm - Package manager. Installs, publishes and manages node programs.

Dependencies

  • node-uuid - Generate RFC4122(v4) UUIDs, and also non-RFC compact ids.
  • htpasswd - Node.js package for HTTP Basic Authentication password file utility.
  • htdigest - Node.js package for HTTP Digest Authentication password file utility.

Development dependencies

  • nodeunit - Easy unit testing in node.js and the browser, based on the assert module.
  • nodemock - Simple Yet Powerful Mocking Framework for NodeJs.

License

(The MIT License)

Copyright (c) 2013 Gevorg Harutyunyan gevorg.ha@gmail.com

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.