1. module basic-auth
   1. function basic-auth (req)
   2. function basic-auth.index (req)
   3. function basic-auth.parse (string)
2. module basic-auth.index
   1. function basic-auth.index (req)
   2. function basic-auth.index.parse (string)

module basic-auth

function basic-auth (req)

• description and source-code

  function auth(req) {
    if (!req) {
      throw new TypeError('argument req is required')
    }
  
    if (typeof req !== 'object') {
      throw new TypeError('argument req is required to be an object')
    }
  
    // get header
    var header = getAuthorization(req.req || req)
  
    // parse header
    return parse(header)
  }

• example usage

  n/a

function basic-auth.index (req)

• description and source-code

  function auth(req) {
    if (!req) {
      throw new TypeError('argument req is required')
    }
  
    if (typeof req !== 'object') {
      throw new TypeError('argument req is required to be an object')
    }
  
    // get header
    var header = getAuthorization(req.req || req)
  
    // parse header
    return parse(header)
  }

• example usage

  n/a

function basic-auth.parse (string)

• description and source-code

  function parse(string) {
    if (typeof string !== 'string') {
      return undefined
    }
  
    // parse header
    var match = CREDENTIALS_REGEXP.exec(string)
  
    if (!match) {
      return undefined
    }
  
    // decode user pass
    var userPass = USER_PASS_REGEXP.exec(decodeBase64(match[1]))
  
    if (!userPass) {
      return undefined
    }
  
    // return credentials object
    return new Credentials(userPass[1], userPass[2])
  }

• example usage

  ...
  
  ### 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 request or koa Context object to the module exported. If
  ...

module basic-auth.index

function basic-auth.index (req)

• description and source-code

  function auth(req) {
    if (!req) {
      throw new TypeError('argument req is required')
    }
  
    if (typeof req !== 'object') {
      throw new TypeError('argument req is required to be an object')
    }
  
    // get header
    var header = getAuthorization(req.req || req)
  
    // parse header
    return parse(header)
  }

• example usage

  n/a

function basic-auth.index.parse (string)

• description and source-code

  function parse(string) {
    if (typeof string !== 'string') {
      return undefined
    }
  
    // parse header
    var match = CREDENTIALS_REGEXP.exec(string)
  
    if (!match) {
      return undefined
    }
  
    // decode user pass
    var userPass = USER_PASS_REGEXP.exec(decodeBase64(match[1]))
  
    if (!userPass) {
      return undefined
    }
  
    // return credentials object
    return new Credentials(userPass[1], userPass[2])
  }

• example usage

  ...
  
  ### 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 request or koa Context object to the module exported. If
  ...