http-auth

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

Installation

Via git (or downloaded tarball):

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

Via npm:

$ npm install http-auth

Basic example

// HTTP module
const http = require("http");

// Authentication module.
const auth = require("http-auth");
const basic = auth.basic({
  realm: "Simon Area.",
  file: __dirname + "/../data/users.htpasswd" // gevorg:gpass, Sarah:testpass
});

// Creating new HTTP server.
http
  .createServer(
    basic.check((req, res) => {
      res.end(`Welcome to private area - ${req.user}!`);
    })
  )
  .listen(1337, () => {
    // Log URL.
    console.log("Server running at http://127.0.0.1:1337/");
  });

Custom authentication

// HTTP module
const http = require("http");

// Authentication module.
const auth = require("http-auth");
const basic = auth.basic(
  {
    realm: "Simon Area."
  },
  (username, password, callback) => {
    // Custom authentication method.
    callback(username === "Tina" && password === "Bullock");
  }
);

// Creating new HTTP server.
http
  .createServer(
    basic.check((req, res) => {
      res.end(`Welcome to private area - ${req.user}!`);
    })
  )
  .listen(1337, () => {
    // Log URL.
    console.log("Server running at http://127.0.0.1:1337/");
  });

http-proxy integration

// HTTP proxy module.
const http = require("http");
// eslint-disable-next-line node/no-unpublished-require
const httpProxy = require("http-proxy");

// Authentication module.
const auth = require("http-auth");
const basic = auth.basic({
  realm: "Simon Area.",
  file: __dirname + "/../data/users.htpasswd", // gevorg:gpass, Sarah:testpass
  proxy: true
});

// Create your proxy server.
const proxy = httpProxy.createProxyServer({});
http
  .createServer(
    basic.check((req, res) => {
      proxy.web(req, res, { target: "http://127.0.0.1:1338" });
    })
  )
  .listen(1337);

// Create your target server.
http
  .createServer((req, res) => {
    res.end("Request successfully proxied!");
  })
  .listen(1338, () => {
    // Log URL.
    console.log("Server running at http://127.0.0.1:1338/");
  });

// You can test proxy authentication using curl.
// $ curl -x 127.0.0.1:1337  127.0.0.1:1337 -U gevorg

Events

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.

// HTTP module
const http = require("http");

// Authentication module.
const auth = require("http-auth");
const basic = auth.basic({
  realm: "Simon Area.",
  file: __dirname + "/../data/users.htpasswd" // gevorg:gpass, Sarah:testpass
});

// Adding event listeners.
basic.on("success", result => {
  console.log(`User authenticated: ${result.user}`);
});

basic.on("fail", result => {
  console.log(`User authentication failed: ${result.user}`);
});

basic.on("error", error => {
  console.log(`Authentication error: ${error.code + " - " + error.message}`);
});

basic.on("preauth", (preauth, req) => {
  if (req.headers.host === "example.com") {
    preauth = { user: "preauth", pass: true }
  }
});

// Creating new HTTP server.
http
  .createServer(
    basic.check((req, res) => {
      res.end(`Welcome to private area - ${req.user}!`);
    })
  )
  .listen(1337, () => {
    // Log URL.
    console.log("Server running at http://127.0.0.1:1337/");
  });

Configurations

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.
proxy - Set this to true, if you want to use it with http-proxy.

Running tests

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

$ npm test

Issues

You can find list of issues using this link.

Questions

You can also use stackoverflow to ask questions using http-auth tag.

Requirements

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

Utilities

htpasswd - Node.js package for HTTP Basic Authentication password file utility.
htdigest - Node.js package for HTTP Digest Authentication password file utility.

Integrations

http-auth-connect - Connect integration.
http-auth-passport - Passport.js integration.
http-auth-koa - Koa framework integration.
http-auth-hapi - Hapi framework integration.

Dependencies

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).
bcrypt.js - Optimized bcrypt in plain JavaScript with zero dependencies.

License

The MIT License (MIT)

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.

evanbarter/http-auth