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

module passport-local

function passport-local (options, verify)

• description and source-code

  function Strategy(options, verify) {
    if (typeof options == 'function') {
      verify = options;
      options = {};
    }
    if (!verify) { throw new TypeError('LocalStrategy requires a verify callback'); }
  
    this._usernameField = options.usernameField || 'username';
    this._passwordField = options.passwordField || 'password';
  
    passport.Strategy.call(this);
    this.name = 'local';
    this._verify = verify;
    this._passReqToCallback = options.passReqToCallback;
  }

• example usage

  n/a

function passport-local.Strategy (options, verify)

• description and source-code

  function Strategy(options, verify) {
    if (typeof options == 'function') {
      verify = options;
      options = {};
    }
    if (!verify) { throw new TypeError('LocalStrategy requires a verify callback'); }
  
    this._usernameField = options.usernameField || 'username';
    this._passwordField = options.passwordField || 'password';
  
    passport.Strategy.call(this);
    this.name = 'local';
    this._verify = verify;
    this._passReqToCallback = options.passReqToCallback;
  }

• example usage

  n/a

function passport-local.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-local.Strategy

function passport-local.Strategy (options, verify)

• description and source-code

  function Strategy(options, verify) {
    if (typeof options == 'function') {
      verify = options;
      options = {};
    }
    if (!verify) { throw new TypeError('LocalStrategy requires a verify callback'); }
  
    this._usernameField = options.usernameField || 'username';
    this._passwordField = options.passwordField || 'password';
  
    passport.Strategy.call(this);
    this.name = 'local';
    this._verify = verify;
    this._passReqToCallback = options.passReqToCallback;
  }

• example usage

  n/a

function passport-local.Strategy.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-local.Strategy.prototype

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

• description and source-code

  authenticate = function (req, options) {
    options = options || {};
    var username = lookup(req.body, this._usernameField) || lookup(req.query, this._usernameField);
    var password = lookup(req.body, this._passwordField) || lookup(req.query, this._passwordField);
  
    if (!username || !password) {
      return this.fail({ message: options.badRequestMessage || 'Missing credentials' }, 400);
    }
  
    var self = this;
  
    function verified(err, user, info) {
      if (err) { return self.error(err); }
      if (!user) { return self.fail(info); }
      self.success(user, info);
    }
  
    try {
      if (self._passReqToCallback) {
        this._verify(req, username, password, verified);
      } else {
        this._verify(username, password, verified);
      }
    } catch (ex) {
      return self.error(ex);
    }
  }

• example usage

  ...
        return done(null, user);
      });
    }
  ));
  
  #### Authenticate Requests
  
  Use `passport.authenticate()`, specifying the `'local'` strategy, to
  authenticate requests.
  
  For example, as route middleware in an [Express](http://expressjs.com/)
  application:
  
  app.post('/login',
    passport.authenticate('local', { failureRedirect: '/login' }),
  ...

module passport-local.super_

function passport-local.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

function passport-local.super_.Strategy ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-local.super_.prototype

function passport-local.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

  ...
        return done(null, user);
      });
    }
  ));
  
  #### Authenticate Requests
  
  Use `passport.authenticate()`, specifying the `'local'` strategy, to
  authenticate requests.
  
  For example, as route middleware in an [Express](http://expressjs.com/)
  application:
  
  app.post('/login',
    passport.authenticate('local', { failureRedirect: '/login' }),
  ...