What is passport-google-oauth20?
The passport-google-oauth20 npm package is a Passport strategy for authenticating with Google using the OAuth 2.0 API. It allows applications to authenticate users using their Google account and access their Google profile information.
What are passport-google-oauth20's main functionalities?
Google OAuth 2.0 Authentication
This feature allows you to authenticate users using their Google account. The code sample demonstrates how to configure the Google OAuth 2.0 strategy with Passport, including setting up the client ID, client secret, and callback URL.
const passport = require('passport');
const GoogleStrategy = require('passport-google-oauth20').Strategy;
passport.use(new GoogleStrategy({
clientID: 'YOUR_GOOGLE_CLIENT_ID',
clientSecret: 'YOUR_GOOGLE_CLIENT_SECRET',
callbackURL: 'http://www.example.com/auth/google/callback'
},
function(accessToken, refreshToken, profile, done) {
User.findOrCreate({ googleId: profile.id }, function (err, user) {
return done(err, user);
});
}));
Handling Authentication Callback
This feature handles the authentication callback from Google. The code sample shows how to set up routes for initiating Google authentication and handling the callback after authentication. If authentication is successful, the user is redirected to the home page; otherwise, they are redirected to the login page.
app.get('/auth/google',
passport.authenticate('google', { scope: ['profile', 'email'] }));
app.get('/auth/google/callback',
passport.authenticate('google', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
Other packages similar to passport-google-oauth20
passport-facebook
The passport-facebook package is a Passport strategy for authenticating with Facebook using the OAuth 2.0 API. It allows applications to authenticate users using their Facebook account and access their Facebook profile information. Similar to passport-google-oauth20, it provides a way to integrate social login into your application, but it is specific to Facebook.
passport-twitter
The passport-twitter package is a Passport strategy for authenticating with Twitter using the OAuth 1.0a API. It allows applications to authenticate users using their Twitter account and access their Twitter profile information. While it serves a similar purpose to passport-google-oauth20, it uses OAuth 1.0a instead of OAuth 2.0 and is specific to Twitter.
passport-github
The passport-github package is a Passport strategy for authenticating with GitHub using the OAuth 2.0 API. It allows applications to authenticate users using their GitHub account and access their GitHub profile information. Like passport-google-oauth20, it uses OAuth 2.0 for authentication but is specific to GitHub.
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:
![Dependencies](https://img.shields.io/david/jaredhanson/passport-google-oauth2.svg)
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:
app.get('/auth/google',
passport.authenticate('google', { scope: ['profile'] }));
app.get('/auth/google/callback',
passport.authenticate('google', { failureRedirect: '/login' }),
function(req, res) {
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.
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/>