passport-local Documentation

Install the passport-local strategy using npm to enable username and password authentication in your Node.js application.

$ npm install passport-local

The LocalStrategy constructor accepts an optional configuration object before the verify callback. Use these options to customize how credentials are extracted from the request body and how the callback behaves.

Available options:

• usernameField: The name of the username property in the POST body (defaults to 'username').
• passwordField: The name of the password property in the POST body (defaults to 'password').
• session: Set to false to disable session support.
• passReqToCallback: Set to true to include the request object as the first argument in the verify callback.

passport.use(new LocalStrategy({
    usernameField: 'email',
    passwordField: 'passwd',
    passReqToCallback: true,
    session: false
  },
  function(req, username, password, done) {
    // request object is now first argument
    // ...
  }
));

To trigger the authentication process, use passport.authenticate() middleware in your routes, specifying 'local' as the strategy name. You can provide options like failureRedirect to specify where to send the user if authentication fails.

app.post('/login', 
  passport.authenticate('local', { failureRedirect: '/login' }),
  function(req, res) {
    res.redirect('/');
  });

To use the local authentication strategy, instantiate LocalStrategy and pass it to passport.use(). You must provide a verify callback function that receives the credentials and calls done(err, user) to signal the result of the authentication attempt.

By default, the callback arguments are (username, password, done). If you set the passReqToCallback option to true, the request object will be passed as the first argument: (req, username, password, done).

passport.use(new LocalStrategy(
  function(username, password, done) {
    User.findOne({ username: username }, function (err, user) {
      if (err) { return done(err); }
      if (!user) { return done(null, false); }
      if (!user.verifyPassword(password)) { return done(null, false); }
      return done(null, user);
    });
  }
));