No Princess, Mario

    @passport-next/passport-google-oauth2

    1.0.0 • Public • Published

    Passport strategy for Google OAuth 2.0

    NPM version Build Status Coverage Status Maintainability Dependencies

    Install

    $ npm install @passport-next/passport-google-oauth2

    Usage

    Create an Application

    Before using @passport-next/passport-google-oauth2, 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-next/passport-google-oauth2').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:

    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.

    Install

    npm i @passport-next/passport-google-oauth2

    DownloadsWeekly Downloads

    1,278

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    18.4 kB

    Total Files

    13

    Last publish

    Collaborators

    • brettz9
    • rwky
    • adamhathcock
    • guyellis