passport-ping-oauth2 v1.0.0

passport-ping-oauth2

PingFederate OAuth 2.0 authentication strategy for Passport.

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

Install

$ npm install passport-ping-oauth2

Usage

Configure Strategy

The Ping authentication strategy authenticates users using a Ping account and OAuth 2.0 tokens. Ping'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://www.example.com/as/authorization.oauth2',
    tokenURL: 'https://www.example.com/as/token.oauth2',
    clientID: EXAMPLE_CLIENT_ID,
    clientSecret: EXAMPLE_CLIENT_SECRET,
    callbackURL: "http://localhost:3000/auth/oauth2/callback'
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOne({ 'ping.id' : profile.id }, function (err, user) {
        if (err) { return done(err); }
        if (user) {
            return done(null, user);
        } else {
            var newUser = new User();
            newUser.ping.id    = profile.id;
            newUser.ping.token = accessToken;
            newUser.ping.name  = profile.displayName;
            newUser.ping.email = profile.email;
            newUser.save(function(err) {
                if (err) { throw err; }
                return done(null, newUser);
            });
        }
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'ping-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
• Yongzheng Huang

License

The MIT License