Package: node-basic-auth (2.0.1-2)

Generic basic auth Authorization header field parser for whatever

nodejs basic auth parser module. This package is used as a dependency for node web applications that require a simple authentication mechanism.

API

var auth = require('basic-auth')

auth(req)

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.

auth.parse(string)

Parse a basic auth authorization header string. This will return an object with name and pass properties, or undefined if the string is invalid.

Example

Pass a Node.js request object to the module export. 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' }

A header string from any other location can also be parsed with auth.parse, for example a Proxy-Authorization header:

var auth = require('basic-auth') var user = auth.parse(req.getHeader('Proxy-Authorization'))

This page is also available in the following languages (How to set the default document language):