Passport-Next/Passport-Local

Status:

About

This module lets you authenticate using a username and password in your Node.js applications. By plugging into Passport, local authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

npm install @passport-next/passport-local

Usage

Configure Strategy

The local authentication strategy authenticates users using a username and password. The strategy requires a verify callback, which accepts these credentials and resolves to a user (or throws or returns false).

import passport from '@passport-next/passport';
import {Strategy as LocalStrategy} from '@passport-next/passport-local';

passport.use(new LocalStrategy(
  async function (username, password) {
    let user;
    try {
      user = await User.findOne({username});
    } catch (err) {
      console.log(err);
      throw err;
    }
    if (!user || !user.verifyPassword(password)) {
      return {user: false};
    }
    return {user};
  }
));

Available Options

This strategy takes an optional options hash before the function, e.g. new LocalStrategy({/* options */ }, callback).

The available options are:

• usernameField - Optional, defaults to 'username'
• passwordField - Optional, defaults to 'password'

Both fields define the name of the properties in the POST body that are sent to the server.

Parameters

By default, LocalStrategy expects to find credentials in parameters named username and password. If your site prefers to name these fields differently, options are available to change the defaults.

passport.use(
  new LocalStrategy({
    usernameField: 'email',
    passwordField: 'passwd'
  },
  function (username, password, done) {
    // ...
  })
);

The verify callback can be supplied with the request object by setting the passReqToCallback option to true, and changing callback arguments accordingly.

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

Use passport.authenticate(), specifying the 'local' strategy, to authenticate requests. It searches for fields in the query string and req.body, so ensure body parsers are in place if these fields are sent in the body.

For example, as route middleware in an Express application:

import bodyParser from 'body-parser';

app.use(bodyParser.urlencoded({extended: true}));
app.use(passport.initialize());

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

Examples

Developers using the popular Express web framework can refer to an example as a starting point for their own web applications.

Docs

Please see the wiki

Need help?

Please raise an issue and/or ask a question on Stackoverflow with the passport.js tag.

Support policy

We support all node versions supported by the Node Foundation.

Contributing

Please see CONTRIBUTING.md.

npm install
npm test