# passport-oauth2 > OAuth 2.0 authentication strategy for Passport. Latest version **1.8.0** (published 2024-02-02) · MIT license · 0 weekly downloads ## Install ```sh npm install passport-oauth2 pnpm add passport-oauth2 yarn add passport-oauth2 bun add passport-oauth2 ``` ## Health **Score 23/100 (F)** — status: abandoned. Positive: has types package; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.8.0 | | Published | 2024-02-02 | | First published | 2013-08-15 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | separate (@types/passport-oauth2) | | Module format | CommonJS | | Node | >= 0.4.0 | | Dependencies | 5 | | Unpacked size | 35.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 618 | | Author | Jared Hanson | | Maintainers | jaredhanson | | Keywords | passport, auth, authn, authentication, authz, authorization, oauth, oauth2 | ## Links - npm: https://www.npmjs.com/package/passport-oauth2 - Repository: https://github.com/jaredhanson/passport-oauth2 - Homepage: https://github.com/jaredhanson/passport-oauth2#readme - Issues: http://github.com/jaredhanson/passport-oauth2/issues - Funding: https://github.com/sponsors/jaredhanson - npm.io page: https://npm.io/package/passport-oauth2 ## Dependencies (5) - [uid2](https://npm.io/package/uid2.md) 0.0.x - [oauth](https://npm.io/package/oauth.md) 0.10.x - [base64url](https://npm.io/package/base64url.md) 3.x.x - [utils-merge](https://npm.io/package/utils-merge.md) 1.x.x - [passport-strategy](https://npm.io/package/passport-strategy.md) 1.x.x ## Alternatives - [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads - [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads - [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads - [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads - [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads ## Recent versions - 1.8.0 (latest) — 2024-02-02 - 1.7.0 — 2023-03-02 - 1.6.1 — 2021-09-24 - 1.6.0 — 2021-07-01 - 1.5.0 — 2019-03-15 - 1.4.0 — 2016-12-20 - 1.3.0 — 2016-03-30 - 1.2.0 — 2016-02-09 - 1.1.2 — 2014-03-08 - 1.1.1 — 2013-09-11 - 1.1.0 — 2013-08-15 - 1.0.0 — 2013-08-15 ## README # passport-oauth2 General-purpose OAuth 2.0 authentication strategy for [Passport](https://www.passportjs.org/). This module lets you authenticate using OAuth 2.0 in your Node.js applications. By plugging into Passport, OAuth 2.0-based sign in can be easily and unobtrusively integrated into any application or framework that supports [Connect](https://github.com/senchalabs/connect#readme)-style middleware, including [Express](https://expressjs.com/). Note that this strategy provides generic OAuth 2.0 support. In many cases, a provider-specific strategy can be used instead, which cuts down on unnecessary configuration, and accommodates any provider-specific quirks. See the [list](https://github.com/jaredhanson/passport/wiki/Strategies) for supported providers. Developers who need to implement authentication against an OAuth 2.0 provider that is not already supported are encouraged to sub-class this strategy. If you choose to open source the new provider-specific strategy, please add it to the list so other people can find it.
:brain: [Understanding OAuth 2.0](https://www.passportjs.org/concepts/oauth2/?utm_source=github&utm_medium=referral&utm_campaign=passport-oauth2&utm_content=nav-concept) • :heart: [Sponsors](https://www.passportjs.org/sponsors/?utm_source=github&utm_medium=referral&utm_campaign=passport-oauth2&utm_content=nav-sponsors)
---

Advertisement
Learn OAuth 2.0 - Get started as an API Security Expert
Just imagine what could happen to YOUR professional career if you had skills in OAuth > 8500 satisfied students

--- [![npm](https://img.shields.io/npm/v/passport-oauth2.svg)](https://www.npmjs.com/package/passport-oauth2) [![build](https://img.shields.io/travis/jaredhanson/passport-oauth2.svg)](https://travis-ci.org/jaredhanson/passport-oauth2) [![coverage](https://img.shields.io/coveralls/jaredhanson/passport-oauth2.svg)](https://coveralls.io/github/jaredhanson/passport-oauth2) [...](https://github.com/jaredhanson/passport-oauth2/wiki/Status) ## Install $ npm install passport-oauth2 ## Usage #### Configure Strategy The OAuth 2.0 authentication strategy authenticates users using a third-party account and OAuth 2.0 tokens. The provider's OAuth 2.0 endpoints, as well as the client identifer and secret, are specified as options. The strategy requires a `verify` callback, which receives an access token and profile, and calls `cb` providing a user. ```js passport.use(new OAuth2Strategy({ authorizationURL: 'https://www.example.com/oauth2/authorize', tokenURL: 'https://www.example.com/oauth2/token', clientID: EXAMPLE_CLIENT_ID, clientSecret: EXAMPLE_CLIENT_SECRET, callbackURL: "http://localhost:3000/auth/example/callback" }, function(accessToken, refreshToken, profile, cb) { User.findOrCreate({ exampleId: profile.id }, function (err, user) { return cb(err, user); }); } )); ``` #### Authenticate Requests Use `passport.authenticate()`, specifying the `'oauth2'` strategy, to authenticate requests. For example, as route middleware in an [Express](http://expressjs.com/) application: ```js app.get('/auth/example', passport.authenticate('oauth2')); app.get('/auth/example/callback', passport.authenticate('oauth2', { failureRedirect: '/login' }), function(req, res) { // Successful authentication, redirect home. res.redirect('/'); }); ``` ## Related Modules - [passport-oauth1](https://github.com/jaredhanson/passport-oauth1) — OAuth 1.0 authentication strategy - [passport-http-bearer](https://github.com/jaredhanson/passport-http-bearer) — Bearer token authentication strategy for APIs - [OAuth2orize](https://github.com/jaredhanson/oauth2orize) — OAuth 2.0 authorization server toolkit ## Contributing #### Tests The test suite is located in the `test/` directory. All new features are expected to have corresponding test cases. Ensure that the complete test suite passes by executing: ```bash $ make test ``` #### Coverage All new feature development is expected to have test coverage. Patches that increse test coverage are happily accepted. Coverage reports can be viewed by executing: ```bash $ make test-cov $ make view-cov ``` ## License [The MIT License](http://opensource.org/licenses/MIT) Copyright (c) 2011-2016 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)> --- _Source: https://npm.io/package/passport-oauth2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._