passport README

The project's README from github.com/jaredhanson/passport. As one markdown file: README.md.

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

Simple Authentication
Make login our problem. Not yours.

Auth0 by Okta provides a simple and customizable login page to authenticate your users. You can dynamically add new capabilities to it - including social login, multi-factor authentication, or passkeys - without making changes to your app’s code.

We help protect your app and your users from attacks - defending your application from bot attacks and detecting runtime anomalies based on suspicious IPs, breached credentials, user context, and more.


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.


Drag and drop your auth
Add authentication and user management to your consumer and business apps with a few lines of code.


Auth. Built for Devs, by Devs
Add login, registration, SSO, MFA, and a bazillion other features to your app in minutes. Integrates with any codebase and installs on any server, anywhere in the world.


API-first AuthN, AuthZ, and Fraud Prevention
The most powerful identity platform built for developers. Easily build and secure a modern auth flow with user & org management, multi-tenant SSO, MFA, RBAC, device fingerprinting, and more.


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

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

License

The MIT License

Copyright (c) 2011-2021 Jared Hanson <https://www.jaredhanson.me/>

passport (jaredhanson/passport)

Searching Database…

23.5K ·GitHub
Что это такое?Passport — это middleware для аутентификации в Node.js, совместимое с Express. Его единственная задача — аутентификация запросов, и делает он это через расширяемый набор плагинов, которые называются стратегиями.
Это готовый облачный сервис для входа или то, что я встраиваю в своё приложение?Это middleware, которое вы встраиваете в Node.js-приложение на основе Express или Connect. Сам он не создаёт маршрутов и не предполагает никакой схемы базы данных — маршрутизация, хранение данных и решения на уровне приложения остаются за вами.
Как добавить его в своё приложение?Установите пакет через npm, затем добавьте необходимое middleware passport.initialize() в ваше приложение на Express или Connect. Используйте authenticate() как middleware для маршрутов, а passport.session() — для постоянных сессий входа.
Он работает только с Express или с любым проектом на Node.js?Он рассчитан на приложения на основе Express или Connect и работает на Node 0.4.0 и новее. Ядро намеренно небольшое — всего три зависимости, — потому что каждый способ входа поставляется отдельным пакетом-стратегией.
То есть сам он логины не проверяет — как тогда проходит аутентификация?Через стратегии: подключаемые модули, каждый из которых отвечает за один способ — от форм с логином и паролем до входа через OAuth (Facebook или Twitter) и федерации OpenID. Вы настраиваете только те стратегии, которые нужны вашему приложению.
Это серверная штука или какая-то часть работает в браузере?Он работает на сервере, внутри вашего Node.js-процесса рядом с Express или Connect. В браузер ничего не подгружается — аутентификация идёт через обычные маршруты вашего приложения.
Можно ли использовать его в коммерческих проектах?Да — Passport распространяется по лицензии MIT, поэтому его можно свободно использовать, изменять и поставлять в составе коммерческого ПО.
Мне придётся менять свою базу данных или модель пользователя?Нет. Passport не накладывает ограничений на то, как хранятся записи пользователей, — вы сами предоставляете функции serialize и deserialize для сессий: обычно в сессию сохраняется только ID пользователя, а при последующих запросах пользователь загружается по нему.
Какие провайдеры входа и протоколы поддерживаются?Более 480 стратегий, их можно искать на passportjs.org. Среди популярных: Local (вход через HTML-форму), Facebook и Twitter через OAuth, Google через OpenID или OAuth 2.0, а также Azure Active Directory через OAuth 2.0, OpenID или SAML.
А что с вещами вокруг входа, например защитой маршрутов?Экосистема закрывает и их: connect-ensure-login добавляет middleware, которое проверяет наличие сессии входа, OAuth2orize — набор инструментов для создания серверов авторизации OAuth 2.0, а OAuthorize — для провайдеров OAuth-сервисов.
Есть ли готовый рабочий пример, с которого можно начать?Да — в репозитории есть полный пример на основе passport-local, а в README есть ссылки на туториалы: по локальной аутентификации с Mongo или Postgres и по входу через соцсети, на Express 3.x и 4.x.
What are similar projects?hydra, django-allauth, logto, next-auth, helmet, zitadel, cas, LibreChat
Size
0.8 MB
Stars
23.5K
Updated
CommitAug 16
Age
15y
Commits · 90 Days