passport-gigya-oauth2 v1.0.0

passport-gigya-oauth2

Gigya OAuth 2.0 authentication strategy for Passport.

This module lets you authenticate using Gigya in your Node.js applications. By plugging into Passport, Gigya authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

$ npm install passport-gigya-oauth2

Usage

Configure Strategy

The Gigya authentication strategy authenticates users using a Gigya account and OAuth 2.0 tokens. Gigya's OAuth 2.0 endpoints, as well as the client identifer and secret, are specified as options. The strategy requires a verify callback, which receives an access token and profile, and calls done providing a user.

passport.use(new OAuth2Strategy({
    authorizationURL: 'https://<Data_Center>/oidc/op/v1.0/<API_KEY>/authorize',
    tokenURL: 'https://<Data_Center>/oidc/op/v1.0/<API_KEY>/token',
    userInfoURL: 'https://<Data_Center>/oidc/op/v1.0/<API_KEY>/userinfo',
    clientID: EXAMPLE_CLIENT_ID,
    clientSecret: EXAMPLE_CLIENT_SECRET,
    callbackURL: "http://localhost:3000/auth/oauth2/callback',
    customHeaders: {'Authorization': 'Basic MTIzLTQ1Ni03ODk6c2hoaC1pdHMtYS1zZWNyZXQ='}
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOne({ 'gigya.sub': profile.sub }, function (err, user) {
        if (err) { return done(err); }
        if (user) {
            return done(null, user);
        } else {
            var newUser = new User();
            newUser.gigya.sub    = profile.sub;
            newUser.gigya.token = accessToken;
            newUser.gigya.name  = profile.name;
            newUser.gigya.email = profile.email;
            newUser.save(function(err) {
                if (err) { throw err; }
                return done(null, newUser);
            });
        }
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'oauth2' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/oauth2',
    passport.authenticate('oauth2', { scope : ['openid', 'profile', 'email'] }));

app.get('/auth/oauth2/callback',
    passport.authenticate('oauth2', { failureRedirect: '/login' }),
    function(req, res) {
        // Successful authentication, redirect home.
        res.redirect('/');
    });

Related Modules

• passport-oauth2 — OAuth 2.0 authentication strategy

Tests

$ npm install
$ npm test

Credits

• Brenden McKamey

License

The MIT License