1. module http-auth
   1. function http-auth.basic (options, checker)
   2. function http-auth.connect (auth)
   3. function http-auth.digest (options, checker)
   4. function http-auth.hapi ()
   5. function http-auth.koa (auth)
   6. function http-auth.passport (auth)
   7. object http-auth.http_auth
   8. object http-auth.utils
2. module http-auth.hapi
   1. function http-auth.hapi.register (plugin, options, next)
3. module http-auth.http_auth
   1. function http-auth.http_auth.basic (options, checker)
   2. function http-auth.http_auth.connect (auth)
   3. function http-auth.http_auth.digest (options, checker)
   4. function http-auth.http_auth.hapi ()
   5. function http-auth.http_auth.koa (auth)
   6. function http-auth.http_auth.passport (auth)
4. module http-auth.utils
   1. function http-auth.utils.base64 (input)
   2. function http-auth.utils.decodeBase64 (input)
   3. function http-auth.utils.isAvailable (path)
   4. function http-auth.utils.md5 (input)
   5. function http-auth.utils.sha1 (input)

module http-auth

function http-auth.basic (options, checker)

• description and source-code

  (options, checker) => {
      return require('./auth/basic')(options, checker);
  }

• example usage

  ...
  $ 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}!`);
  ...

function http-auth.connect (auth)

• description and source-code

  (auth) => {
      return require('./server/connect')(auth);
  }

• example usage

  ...
  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}!`);
  });
  ```
  ...

function http-auth.digest (options, checker)

• description and source-code

  (options, checker) => {
      return require('./auth/digest')(options, checker);
  }

• example usage

  ...
  const utils = {};
  
  // Generates md5 hash of input.
  utils.md5 = (input) => {
  let hash = crypto.createHash('MD5');
  hash.update(input);
  
  return hash.digest('hex');
  };
  
  // Generates sha1 hash of input.
  utils.sha1 = (input) => {
  let hash = crypto.createHash('sha1');
  hash.update(input);
  ...

function http-auth.hapi ()

• description and source-code

  () => {
      return require('./server/hapi');
  }

• example usage

  ...
  });
  
  // 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',
  ...

function http-auth.koa (auth)

• description and source-code

  (auth) => {
      return require('./server/koa')(auth);
  }

• example usage

  ...
  // Final handler.
  app.use(function *(next) {
      yield next;
      this.body = `Hello from koa - ${this.req.user}!`;
  });
  
  // Enable auth.
  app.use(auth.koa(basic));
  ```
  
  ## For [koa@next](https://github.com/koajs/koa/tree/v2.x) you can use [http-auth-koa](https://github.com/http-auth/http-auth-koa
  )
  ```javascript
  // Authentication module.
  import auth from 'http-auth'
  import koaAuth from 'http-auth-koa'
  ...

function http-auth.passport (auth)

• description and source-code

  (auth) => {
      return require('./server/passport')(auth);
  }

• example usage

  ...
  });
  
  // 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}!`);
      }
  );
  ...

module http-auth.hapi

function http-auth.hapi.register (plugin, options, next)

• description and source-code

  (plugin, options, next) => {
      plugin.auth.scheme('http', httpScheme);
      next();
  }

• example usage

  ...
  });
  
  // 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',
  ...

module http-auth.http_auth

function http-auth.http_auth.basic (options, checker)

• description and source-code

  (options, checker) => {
      return require('./auth/basic')(options, checker);
  }

• example usage

  ...
  $ 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}!`);
  ...

function http-auth.http_auth.connect (auth)

• description and source-code

  (auth) => {
      return require('./server/connect')(auth);
  }

• example usage

  ...
  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}!`);
  });
  ```
  ...

function http-auth.http_auth.digest (options, checker)

• description and source-code

  (options, checker) => {
      return require('./auth/digest')(options, checker);
  }

• example usage

  ...
  const utils = {};
  
  // Generates md5 hash of input.
  utils.md5 = (input) => {
  let hash = crypto.createHash('MD5');
  hash.update(input);
  
  return hash.digest('hex');
  };
  
  // Generates sha1 hash of input.
  utils.sha1 = (input) => {
  let hash = crypto.createHash('sha1');
  hash.update(input);
  ...

function http-auth.http_auth.hapi ()

• description and source-code

  () => {
      return require('./server/hapi');
  }

• example usage

  ...
  });
  
  // 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',
  ...

function http-auth.http_auth.koa (auth)

• description and source-code

  (auth) => {
      return require('./server/koa')(auth);
  }

• example usage

  ...
  // Final handler.
  app.use(function *(next) {
      yield next;
      this.body = `Hello from koa - ${this.req.user}!`;
  });
  
  // Enable auth.
  app.use(auth.koa(basic));
  ```
  
  ## For [koa@next](https://github.com/koajs/koa/tree/v2.x) you can use [http-auth-koa](https://github.com/http-auth/http-auth-koa
  )
  ```javascript
  // Authentication module.
  import auth from 'http-auth'
  import koaAuth from 'http-auth-koa'
  ...

function http-auth.http_auth.passport (auth)

• description and source-code

  (auth) => {
      return require('./server/passport')(auth);
  }

• example usage

  ...
  });
  
  // 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}!`);
      }
  );
  ...

module http-auth.utils

function http-auth.utils.base64 (input)

• description and source-code

  (input) => {
      return new Buffer(input, 'utf8').toString('base64');
  }

• example usage

  n/a

function http-auth.utils.decodeBase64 (input)

• description and source-code

  (input) => {
      return new Buffer(input, 'base64').toString('utf8');
  }

• example usage

  ...
      return tokens[1];
  }
      }
  
      // Searching for user.
      findUser(req, hash, callback) {
  // Decode base64.
  let splitHash = utils.decodeBase64(hash).split(":");
  let username = splitHash.shift();
  let password = splitHash.join(":");
  
  let self = this;
  
  if (this.checker) {
      // Custom auth.
  ...

function http-auth.utils.isAvailable (path)

• description and source-code

  (path) => {
      try {
          return !!require.resolve(path);
      } catch (err) {
          return false;
      }
  }

• example usage

  ...
  // http integration.
  require('./server/http');
  
  // https integration.
  require('./server/https');
  
  // http-proxy integration.
  if (utils.isAvailable('http-proxy')) {
  require('./server/proxy');
  }
  
  // Exports.
  module.exports = {
  // Basic authentication.
  basic: (options, checker) => {
  ...

function http-auth.utils.md5 (input)

• description and source-code

  (input) => {
      let hash = crypto.createHash('MD5');
      hash.update(input);
  
      return hash.digest('hex');
  }

• example usage

  ...
  
      // Validating hash.
      validate(ha2, co, hash) {
  let ha1 = hash;
  
  // Algorithm.
  if (co.algorithm === 'MD5-sess') {
      ha1 = utils.md5(`${ha1}:${co.nonce}:${co.cnonce}`);
  }
  
  let response = undefined;
  
  // Quality of protection.
  if (co.qop) {
      response = utils.md5(`${ha1}:${co.nonce}:${co.nc}:${co.cnonce}:${co.qop}:${ha2}`);
  ...

function http-auth.utils.sha1 (input)

• description and source-code

  (input) => {
      let hash = crypto.createHash('sha1');
      hash.update(input);
  
      return hash.digest('base64');
  }

• example usage

  ...
      super(options, checker);
  }
  
  // Verifies if password is correct.
  validate (hash, password) {
      if (hash.substr(0, 5) === '{SHA}') {
          hash = hash.substr(5);
          return hash === utils.sha1(password);
      } else if (hash.substr(0, 6) === '$apr1$' || hash.substr(0, 3) === '$1$') {
          return hash === md5(password, hash);
      } else if (hash.substr(0, 4) === '$2y$' || hash.substr(0, 4) === '$2a$') {
          return bcrypt.compareSync(password, hash);
      } else if (hash === crypt(password, hash)) {
          return true;
      } else if (hash.length === password.length) {
  ...