basic-auth

node.js basic auth parser

basic-auth

Generic basic auth Authorization header field parser for whatever.

Installation

$ npm install basic-auth

API

var auth = require('basic-auth')

Get the basic auth credentials from the given request. The Authorization header is parsed and if the header is invalid, undefined is returned, otherwise an object with name and pass properties.

Example

Pass a node request or koa Context object to the module exported. If parsing fails undefined is returned, otherwise an object with .name and .pass.

var auth = require('basic-auth');
var user = auth(req);
// => { name: 'something', pass: 'whatever' }

With vanilla node.js http server

var http = require('http')
var auth = require('basic-auth')
 
// Create server 
var server = http.createServer(function (req, res) {
  var credentials = auth(req)
 
  if (!credentials || credentials.name !== 'john' || credentials.pass !== 'secret') {
    res.statusCode = 401
    res.setHeader('WWW-Authenticate', 'Basic realm="example"')
    res.end('Access denied')
  } else {
    res.end('Access granted')
  }
})
 
// Listen 
server.listen(3000)

License

MIT

Aug	SEP	Oct
	06
2014	2015	2016

private npm is here.

publish unlimited private modules for just $7/month

basic-auth

basic-auth

Installation

API

auth(req)

Example

With vanilla node.js http server

License

Collaborators

Stats

Keywords

Dependencies

Dependents