https://github.com/jaredhanson/passport-google

Google (OpenID) authentication strategy for Passport and Node.js.
https://github.com/jaredhanson/passport-google

Last synced: 8 months ago
JSON representation

Google (OpenID) authentication strategy for Passport and Node.js.

• Host: GitHub
• URL: https://github.com/jaredhanson/passport-google
• Owner: jaredhanson
• License: mit
• Created: 2011-11-04T02:03:03.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2018-01-04T16:34:01.000Z (about 8 years ago)
• Last Synced: 2025-05-13T01:45:36.486Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 150
• Watchers: 11
• Forks: 81
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
** NOTICE: Google no-longer supports OpenID 2, and this plugin is no longer functional. Please use [Passport-Google-OAuth](https://github.com/jaredhanson/passport-google-oauth) instead. **

** For more information, see the [Google OpenID 2 shutdown timetable](https://developers.google.com/identity/protocols/OpenID2Migration#shutdown-timetable). **

# Passport-Google

[Passport](http://passportjs.org/) strategy for authenticating with [Google](http://www.google.com/)

using OpenID 2.0.

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](http://www.senchalabs.org/connect/)-style middleware, including

[Express](http://expressjs.com/).

## Install

    $ npm install passport-google

## Usage

#### Configure Strategy

The Google authentication strategy authenticates users using a Google account,

which is also an OpenID 2.0 identifier.  The strategy requires a `validate`

callback, which accepts this identifier and calls `done` providing a user.

Additionally, options can be supplied to specify a return URL and realm.

    passport.use(new GoogleStrategy({

        returnURL: 'http://localhost:3000/auth/google/return',

        realm: 'http://localhost:3000/'

      },

      function(identifier, done) {

        User.findByOpenID({ openId: identifier }, function (err, user) {

          return done(err, user);

        });

      }

    ));

#### Authenticate Requests

Use `passport.authenticate()`, specifying the `'google'` strategy, to

authenticate requests.

For example, as route middleware in an [Express](http://expressjs.com/)

application:

    app.get('/auth/google',

      passport.authenticate('google'));

    app.get('/auth/google/return', 

      passport.authenticate('google', { failureRedirect: '/login' }),

      function(req, res) {

        // Successful authentication, redirect home.

        res.redirect('/');

      });

## Examples

For a complete, working example, refer to the [signon example](https://github.com/jaredhanson/passport-google/tree/master/examples/signon).

## Tests

    $ npm install --dev

    $ make test

[![Build Status](https://secure.travis-ci.org/jaredhanson/passport-google.png)](http://travis-ci.org/jaredhanson/passport-google)

## Credits

  - [Jared Hanson](http://github.com/jaredhanson)

## License

[The MIT License](http://opensource.org/licenses/MIT)

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