simple-oauth2-google-plus
v0.5.1
Published
A simple Node.js client library for Google+ OAuth2
Downloads
22
Maintainers
Readme
Simple OAuth2 Google+
This library is a wrapper around Simple OAuth2 Library
Specially made for Authorization Code Flow with Google+.
Requirements
Latest Node 8 LTS or newer versions.
Getting started
npm install --save simple-oauth2 simple-oauth2-google-plus
or
yarn add simple-oauth2 simple-oauth2-google-plus
Usage
const simpleOAuth2GooglePlus = require('simple-oauth2-google-plus');
const google = simpleOAuth2GooglePlus.create(options);
google
object exposes 3 keys:
- authorize: Middleware to request user's authorization.
- getToken: Middleware for callback processing and exchange the authorization token for an
access_token
- oauth2: The underlying simple-oauth2 instance.
Options
SimpleOAuth2GooglePlus comes with default values for most of the options.
Required options
| Option | Description | |--------------|-----------------------------------------------| | clientId | Your App Id. | | clientSecret | Your App Secret Id. | | callbackURL | Callback configured when you created the app. |
Other options
| Option | Default | Description | |------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | scope | 'profile email' | https://developers.google.com/identity/protocols/googlescopes#plusv1 | | state | '' | Your CSRF anti-forgery token. More at: https://auth0.com/docs/protocols/oauth2/oauth-state | | returnError | false | When is false (default), will call the next middleware with the error object. When is true, will set req.tokenError to the error, and call the next middleware as if there were no error. | | authorizeHost | 'https://accounts.google.com'| | | authorizePath | '/o/oauth2/v2/auth' | | | tokenHost | 'https://www.googleapis.com' | | | tokenPath | '/oauth2/v4/token' | | | authorizeOptions | {} | Pass extra parameters when requesting authorization. | | tokenOptions | {} | Pass extra parameters when requesting access_token. |
Example
Original boilerplate
const oauth2 = require('simple-oauth2').create({
client: {
id: process.env.GOOGLE_CLIENT_ID,
secret: process.env.GOOGLE_CLIENT_SECRET
},
auth: {
authorizeHost: 'https://accounts.google.com',
authorizePath: '/o/oauth2/v2/auth',
tokenHost: 'https://www.googleapis.com',
tokenPath: '/oauth2/v4/token'
}
});
router.get('/auth/google', (req, res) => {
const authorizationUri = oauth2.authorizationCode.authorizeURL({
redirect_uri: 'http://localhost:3000/auth/google/callback',
scope: 'profile email'
});
res.redirect(authorizationUri);
});
router.get('/auth/google/callback', async(req, res) => {
const code = req.query.code;
const options = {
code,
redirect_uri: 'http://localhost:3000/auth/google/callback'
};
try {
// The resulting token.
const result = await oauth2.authorizationCode.getToken(options);
// Exchange for the access token.
const token = oauth2.accessToken.create(result);
return res.status(200).json(token);
} catch (error) {
console.error('Access Token Error', error.message);
return res.status(500).json('Authentication failed');
}
});
With SimpleOAuth2GooglePlus
const simpleOAuth2GooglePlus = require('simple-oauth2-google-plus');
const google = simpleOAuth2GooglePlus.create({
clientId: process.env.GOOGLE_CLIENT_ID,
clientSecret: process.env.GOOGLE_CLIENT_SECRET,
callbackURL: 'http://localhost:3000/auth/google/callback'
});
// Ask the user to authorize.
router.get('/auth/google', google.authorize);
// Exchange the token for the access token.
router.get('/auth/google/callback', google.accessToken, (req, res) => {
return res.status(200).json(req.token);
});
References
- https://developers.google.com/+/web/api/rest/oauth
- https://developers.google.com/identity/protocols/OAuth2
- https://developers.google.com/identity/protocols/googlescopes#plusv1