1. module passport-ldapauth
   1. function passport-ldapauth (options, verify)
   2. function passport-ldapauth.Strategy (options, verify)
   3. function passport-ldapauth.super_ ()
   4. object passport-ldapauth.Strategy.prototype
   5. object passport-ldapauth.super_.prototype
2. module passport-ldapauth.Strategy
   1. function passport-ldapauth.Strategy (options, verify)
   2. function passport-ldapauth.Strategy.super_ ()
3. module passport-ldapauth.Strategy.prototype
   1. function passport-ldapauth.Strategy.prototype.authenticate (req, options)
4. module passport-ldapauth.super_
   1. function passport-ldapauth.super_ ()
   2. function passport-ldapauth.super_.Strategy ()
5. module passport-ldapauth.super_.prototype
   1. function passport-ldapauth.super_.prototype.authenticate (req, options)

module passport-ldapauth

function passport-ldapauth (options, verify)

• description and source-code

  passport-ldapauth = function (options, verify) {
    // We now accept function as options as well so we cannot assume anymore
    // that a call with a function parameter only would have skipped options
    // and just provided a verify callback
    if (!options) {
      throw new Error('LDAP authentication strategy requires options');
    }
  
    this.options    = null;
    this.getOptions = null;
  
    if (typeof options === 'object') {
      this.options = setDefaults(options);
    } else if (typeof options === 'function') {
      this.getOptions = options;
    }
  
    passport.Strategy.call(this);
  
    this.name   = 'ldapauth';
    this.verify = verify;
  }

• example usage

  n/a

function passport-ldapauth.Strategy (options, verify)

• description and source-code

  Strategy = function (options, verify) {
    // We now accept function as options as well so we cannot assume anymore
    // that a call with a function parameter only would have skipped options
    // and just provided a verify callback
    if (!options) {
      throw new Error('LDAP authentication strategy requires options');
    }
  
    this.options    = null;
    this.getOptions = null;
  
    if (typeof options === 'object') {
      this.options = setDefaults(options);
    } else if (typeof options === 'function') {
      this.getOptions = options;
    }
  
    passport.Strategy.call(this);
  
    this.name   = 'ldapauth';
    this.verify = verify;
  }

• example usage

  n/a

function passport-ldapauth.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-ldapauth.Strategy

function passport-ldapauth.Strategy (options, verify)

• description and source-code

  Strategy = function (options, verify) {
    // We now accept function as options as well so we cannot assume anymore
    // that a call with a function parameter only would have skipped options
    // and just provided a verify callback
    if (!options) {
      throw new Error('LDAP authentication strategy requires options');
    }
  
    this.options    = null;
    this.getOptions = null;
  
    if (typeof options === 'object') {
      this.options = setDefaults(options);
    } else if (typeof options === 'function') {
      this.getOptions = options;
    }
  
    passport.Strategy.call(this);
  
    this.name   = 'ldapauth';
    this.verify = verify;
  }

• example usage

  n/a

function passport-ldapauth.Strategy.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-ldapauth.Strategy.prototype

function passport-ldapauth.Strategy.prototype.authenticate (req, options)

• description and source-code

  authenticate = function (req, options) {
    if ((typeof this.options === 'object') && (!this.getOptions)) {
      return handleAuthentication.call(this, req, options);
    }
  
    var callback = function(err, configuration) {
      if (err) return this.fail(err);
  
      this.options = setDefaults(configuration);
      handleAuthentication.call(this, req, options);
    };
  
    // Added functionality: getOptions can accept now up to 2 parameters
    if (this.getOptions.length ===1) { // Accepts 1 parameter, backwards compatibility
      this.getOptions(callback.bind(this));
    } else { // Accepts 2 parameters, pass request as well
      this.getOptions(req, callback.bind(this));
    }
  }

• example usage

  ...
           }
         ));
  
  Note: you can pass a function instead of an object as `options`, see the [example below](#options-as-function)
  
  ### Authenticate requests
  
  Use `passport.authenticate()`, specifying the `'ldapauth'` strategy, to authenticate
   requests.
  
  #### `authenticate()` options
  
  In addition to [default authentication options](http://passportjs.org/guide/authenticate/) the following flash message options are
   available for `passport.authenticate()`:
  
  * `badRequestMessage`: missing username/password (default: 'Missing credentials')
  * `invalidCredentials`: `InvalidCredentialsError`, `NoSuchObjectError`, and `/no such user/i` LDAP errors (default: 'Invalid
   username/password')
  ...

module passport-ldapauth.super_

function passport-ldapauth.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

function passport-ldapauth.super_.Strategy ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-ldapauth.super_.prototype

function passport-ldapauth.super_.prototype.authenticate (req, options)

• description and source-code

  authenticate = function (req, options) {
    throw new Error('Strategy#authenticate must be overridden by subclass');
  }

• example usage

  ...
           }
         ));
  
  Note: you can pass a function instead of an object as `options`, see the [example below](#options-as-function)
  
  ### Authenticate requests
  
  Use `passport.authenticate()`, specifying the `'ldapauth'` strategy, to authenticate
   requests.
  
  #### `authenticate()` options
  
  In addition to [default authentication options](http://passportjs.org/guide/authenticate/) the following flash message options are
   available for `passport.authenticate()`:
  
  * `badRequestMessage`: missing username/password (default: 'Missing credentials')
  * `invalidCredentials`: `InvalidCredentialsError`, `NoSuchObjectError`, and `/no such user/i` LDAP errors (default: 'Invalid
   username/password')
  ...