Need help with passport?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

jaredhanson
19.1K Stars 1.1K Forks MIT License 507 Commits 330 Opened issues

Description

Simple, unobtrusive authentication for Node.js.

Services available

!
?

Need anything else?

Contributors list

# 4,942
JavaScr...
C
npm
React N...
399 commits
# 3,937
Python
HTML
Flask
stripe
5 commits
# 43,345
JavaScr...
oauth2
openid-...
C#
3 commits
# 75,964
Erlang
Shell
Node.js
Angular
3 commits
# 10,997
npm
Markdow...
ESLint
ecmascr...
2 commits
# 128,184
socket-...
Shell
Node.js
TypeScr...
2 commits
# 76,121
HTML
svg-spr...
PHP
Gulp
2 commits
# 45,832
nsis
hotp
node-js
Ember
2 commits
# 140,704
errors
user-ma...
Windows
C
1 commit
# 130,421
HTML
Svelte
Mobile
React N...
1 commit
# 17,521
JavaScr...
CSS
hapi
Node.js
1 commit
# 80,284
Ruby
fluentd
s3
Amazon ...
1 commit
# 47,699
charset
Rust
XML
pdf-mer...
1 commit
# 15,024
rhel
Express
express...
jQuery
1 commit
# 58,550
C
Shell
Sass
client-...
1 commit
# 192,096
JavaScr...
1 commit
# 96,503
HTML
CSS
civic-t...
Shell
1 commit
# 19,938
Go
angular...
angular...
ionic
1 commit
# 39,366
PHP
Shell
Symfony
randomi...
1 commit
# 163,764
Spring ...
Spring
spring-...
java8
1 commit

passport banner

Passport

Passport is Express-compatible authentication middleware for Node.js.

Passport's sole purpose is to authenticate requests, which it does through an extensible set of plugins known as strategies. Passport does not mount routes or assume any particular database schema, which maximizes flexibility and allows application-level decisions to be made by the developer. The API is simple: you provide Passport a request to authenticate, and Passport provides hooks for controlling what occurs when authentication succeeds or fails.


Sponsors

LoginRadius is built for the developer community to integrate robust Authentication and Single Sign-On in just a few lines of code.
FREE Signup


Your app, enterprise-ready.
Start selling to enterprise customers with just a few lines of code. Add Single Sign-On (and more) in minutes instead of months.


Status: Build Coverage Dependencies

Install

$ npm install passport

Usage

Strategies

Passport uses the concept of strategies to authenticate requests. Strategies can range from verifying username and password credentials, delegated authentication using OAuth (for example, via Facebook or Twitter), or federated authentication using OpenID.

Before authenticating requests, the strategy (or strategies) used by an application must be configured.

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);
    });
  }
));

There are 480+ strategies. Find the ones you want at: passportjs.org

Sessions

Passport will maintain persistent login sessions. In order for persistent sessions to work, the authenticated user must be serialized to the session, and deserialized when subsequent requests are made.

Passport does not impose any restrictions on how your user records are stored. Instead, you provide functions to Passport which implements the necessary serialization and deserialization logic. In a typical application, this will be as simple as serializing the user ID, and finding the user by ID when deserializing.

passport.serializeUser(function(user, done) {
  done(null, user.id);
});

passport.deserializeUser(function(id, done) { User.findById(id, function (err, user) { done(err, user); }); });

Middleware

To use Passport in an Express or Connect-based application, configure it with the required

passport.initialize()
middleware. If your application uses persistent login sessions (recommended, but not required),
passport.session()
middleware must also be used.
var app = express();
app.use(require('serve-static')(__dirname + '/../../public'));
app.use(require('cookie-parser')());
app.use(require('body-parser').urlencoded({ extended: true }));
app.use(require('express-session')({ secret: 'keyboard cat', resave: true, saveUninitialized: true }));
app.use(passport.initialize());
app.use(passport.session());

Authenticate Requests

Passport provides an

authenticate()
function, which is used as route middleware to authenticate requests.
app.post('/login', 
  passport.authenticate('local', { failureRedirect: '/login' }),
  function(req, res) {
    res.redirect('/');
  });

Strategies

Passport has a comprehensive set of over 480 authentication strategies covering social networking, enterprise integration, API services, and more.

Search all strategies

There is a Strategy Search at passportjs.org

The following table lists commonly used strategies:

|Strategy | Protocol |Developer | |---------------------------------------------------------------|--------------------------|------------------------------------------------| |Local | HTML form |Jared Hanson | |OpenID | OpenID |Jared Hanson | |BrowserID | BrowserID |Jared Hanson | |Facebook | OAuth 2.0 |Jared Hanson | |Google | OpenID |Jared Hanson | |Google | OAuth / OAuth 2.0 |Jared Hanson | |Twitter | OAuth |Jared Hanson | |Azure Active Directory | OAuth 2.0 / OpenID / SAML |Azure |

Examples

Related Modules

The modules page on the wiki lists other useful modules that build upon or integrate with Passport.

License

The MIT License

Copyright (c) 2011-2019 Jared Hanson <http://jaredhanson.net/>

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.