Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
PayPal (OpenID) authentication strategy for Passport and Node.js.
JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples/signon
lib/passport-paypal
test
.gitignore
.npmignore
.travis.yml
LICENSE
Makefile
README.md
package.json

README.md

Passport-PayPal

Passport strategy for authenticating with PayPal using OpenID 2.0.

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

Usage

Configure Strategy

The PayPal authentication strategy authenticates users using a PayPal account, which is also an OpenID 2.0 identifier. The strategy requires a verify callback, which accepts this identifier and calls done providing a user. Additionally, options can be supplied to specify a return URL and realm.

passport.use(new PayPalStrategy({
    returnURL: 'http://localhost:3000/auth/paypal/return',
    realm: 'http://localhost:3000/'
  },
  function(identifier, done) {
    User.findByOpenID({ openId: identifier }, 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('/');
  });

Examples

For a complete, working example, refer to the signon example.

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

Copyright (c) 2012-2013 Jared Hanson <http://jaredhanson.net/>

Something went wrong with that request. Please try again.