mirror of
https://github.com/atlanticbiomedical/biomedjs.git
synced 2025-07-02 00:47:26 -04:00
115 lines
3.7 KiB
Markdown
115 lines
3.7 KiB
Markdown
# Passport-Google-OAuth
|
|
|
|
[Passport](http://passportjs.org/) strategies for authenticating with [Google](http://www.google.com/)
|
|
using OAuth 1.0a and OAuth 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-oauth
|
|
|
|
## Usage of OAuth 1.0
|
|
|
|
#### Configure Strategy
|
|
|
|
The Google OAuth 1.0 authentication strategy authenticates users using a Google
|
|
account and OAuth tokens. The strategy requires a `verify` callback, which
|
|
accepts these credentials and calls `done` providing a user, as well as `options`
|
|
specifying a consumer key, consumer secret, and callback URL.
|
|
|
|
passport.use(new GoogleStrategy({
|
|
consumerKey: GOOGLE_CONSUMER_KEY,
|
|
consumerSecret: GOOGLE_CONSUMER_SECRET,
|
|
callbackURL: "http://127.0.0.1:3000/auth/google/callback"
|
|
},
|
|
function(token, tokenSecret, profile, done) {
|
|
User.findOrCreate({ googleId: profile.id }, 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', { scope: 'https://www.google.com/m8/feeds' }));
|
|
|
|
app.get('/auth/google/callback',
|
|
passport.authenticate('google', { failureRedirect: '/login' }),
|
|
function(req, res) {
|
|
// Successful authentication, redirect home.
|
|
res.redirect('/');
|
|
});
|
|
|
|
## Usage of OAuth 2.0
|
|
|
|
#### Configure Strategy
|
|
|
|
The Google OAuth 2.0 authentication strategy authenticates users using a Google
|
|
account and OAuth 2.0 tokens. The strategy requires a `verify` callback, which
|
|
accepts these credentials and calls `done` providing a user, as well as
|
|
`options` specifying a client ID, client secret, and callback URL.
|
|
|
|
passport.use(new GoogleStrategy({
|
|
clientID: GOOGLE_CLIENT_ID,
|
|
clientSecret: GOOGLE_CLIENT_SECRET,
|
|
callbackURL: "http://127.0.0.1:3000/auth/google/callback"
|
|
},
|
|
function(accessToken, refreshToken, profile, done) {
|
|
User.findOrCreate({ googleId: profile.id }, 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/callback',
|
|
passport.authenticate('google', { failureRedirect: '/login' }),
|
|
function(req, res) {
|
|
// Successful authentication, redirect home.
|
|
res.redirect('/');
|
|
});
|
|
|
|
## Examples
|
|
|
|
For a complete, working example, refer to the [OAuth 1.0 example](https://github.com/jaredhanson/passport-google-oauth/tree/master/examples/oauth)
|
|
and the [OAuth 2.0 example](https://github.com/jaredhanson/passport-google-oauth/tree/master/examples/oauth2).
|
|
|
|
## Tests
|
|
|
|
$ npm install --dev
|
|
$ make test
|
|
|
|
[](http://travis-ci.org/jaredhanson/passport-google-oauth)
|
|
|
|
## Credits
|
|
|
|
- [Jared Hanson](http://github.com/jaredhanson)
|
|
|
|
## License
|
|
|
|
[The MIT License](http://opensource.org/licenses/MIT)
|
|
|
|
Copyright (c) 2012-2013 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>
|