2.0.0 • Published 9 years ago

passport-makerpass v2.0.0

Weekly downloads
1
License
-
Repository
github
Last release
9 years ago

Passport-Makerpass

Passport strategy for authenticating with Makerpass using the OAuth 2.0 API.

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

Install

$ npm install passport-makerpass

Usage

Configure Strategy

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

passport.use(new MakerpassStrategy({
    clientID: process.env.MAKERPASS_CLIENT_ID,
    clientSecret: process.env.MAKERPASS_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/makerpass/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ makerpassId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Tests

$ npm install --dev
$ make test

Credits

License

The MIT License