passport-paypal-openidconnect

0.1.1 • Public • Published

Passport-PayPal-Openidconnect

This is a fork from Passport-PayPal-OAuth, to modify it to support openidconnect paypal auth instead(work in progress to complete the fork)

Passport strategy for authenticating with PayPal using the OpenIDConnect API.

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

Install

$ npm install passport-paypal-openidconnect

Usage

Configure Strategy

The PayPal authentication strategy authenticates users using a PayPal 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 app ID, app secret, and callback URL.

passport.use(new PayPalStrategy({
    clientID: PAYPAL_APP_ID,
    clientSecret: PAYPAL_APP_SECRET,
    callbackURL: "http://localhost:3000/auth/paypal/callback"
    authorizationURL: "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize",
    tokenURL: "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/tokenservice",
    profileURL: "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/userinfo"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ paypalId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/paypal',
  passport.authenticate('paypal'));

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

Providing nonce

You can provide a function to PayPalStrategy for the nonce

passport.use(new PayPalStrategy({
    clientID: PAYPAL_APP_ID,
    clientSecret: PAYPAL_APP_SECRET,
    callbackURL: "http://localhost:3000/auth/paypal/callback"
    authorizationURL: "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize",
    tokenURL: "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/tokenservice",
    profileURL: "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/userinfo",
    nonce: function(respond) {
      respond(generateSomeId)
    }
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ paypalId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

Readme

Keywords

none

Package Sidebar

Install

npm i passport-paypal-openidconnect

Weekly Downloads

203

Version

0.1.1

License

none

Last publish

Collaborators

  • shekhei