Naughty Pterodactyl Maid
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    basic-authpublic

    basic-auth

    NPM Version NPM Downloads Node.js Version Build Status Test Coverage

    Generic basic auth Authorization header field parser for whatever.

    Installation

    This is a Node.js module available through the npm registry. Installation is done using the npm install command:

    $ npm install basic-auth
    

    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'))

    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

    install

    npm i basic-auth

    Downloadsweekly downloads

    1,785,043

    version

    2.0.0

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar
    • avatar
    • avatar
    • avatar