passport-google-oauth20

Google (OAuth 2.0) authentication strategy for Passport.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
passport-google-oauth20
759512.0.04 years ago7 years agoMinified + gzip package size for passport-google-oauth20 in KB

Readme

passport-google-oauth20
Passport strategy for authenticating with Google using the OAuth 2.0 API.
This module lets you authenticate using Google in your Node.js applications. By plugging into Passport, Google authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

1Password, the only password manager you should trust. Industry-leading security and award winning design.


Status: Build Coverage Quality Dependencies

Install

$ npm install passport-google-oauth20

Usage

Create an Application

Before using passport-google-oauth20, you must register an application with Google. If you have not already done so, a new project can be created in the Google Developers Console. Your application will be issued a client ID and client secret, which need to be provided to the strategy. You will also need to configure a redirect URI which matches the route in your application.

Configure Strategy

The Google authentication strategy authenticates users using a Google account and OAuth 2.0 tokens. The client ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a verify callback, which receives the access token and optional refresh token, as well as profile which contains the authenticated user's Google profile. The verify callback must call cb providing a user to complete authentication.
var GoogleStrategy = require('passport-google-oauth20').Strategy;

passport.use(new GoogleStrategy({
    clientID: GOOGLE_CLIENT_ID,
    clientSecret: GOOGLE_CLIENT_SECRET,
    callbackURL: "http://www.example.com/auth/google/callback"
  },
  function(accessToken, refreshToken, profile, cb) {
    User.findOrCreate({ googleId: profile.id }, function (err, user) {
      return cb(err, user);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'google' strategy, to authenticate requests.
For example, as route middleware in an Express application:
```javascript app.get('/auth/google', passport.authenticate('google', { scope: 'profile' }));
app.get('/auth/google/callback', passport.authenticate('google', { failureRedirect: '/login' }), function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
}); ```

Examples

Developers using the popular Express web framework can refer to an example as a starting point for their own web applications. The example shows how to authenticate users using Facebook. However, because both Facebook and Google use OAuth 2.0, the code is similar. Simply replace references to Facebook with corresponding references to Google.

Sponsorship

Passport is open source software. Ongoing development is made possible by generous contributions from individuals and corporations. To learn more about how you can help keep this project financially sustainable, please visit Jared Hanson's page on Patreon.

License

The MIT License
Copyright (c) 2012-2016 Jared Hanson <http://jaredhanson.net/>