passport-idn

Build Status Dependencies Status Dev Dependencies Status

Passport strategy for authenticating with La Poste IDN using the OAuth 2.0 API.

This module lets you authenticate using La Poste IDN (Identité Numérique) in your Node.js applications. By plugging into Passport, IDN authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

$ npm install passport-idn

Usage

Configure Strategy

The IDN authentication strategy authenticates users using a IDN 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 IdnStrategy({
    clientID: IDN_CLIENT_ID,
    clientSecret: IDN_CLIENT_SECRET,
    callbackURL: 'http://127.0.0.1:3000/auth/idn/callback'
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ idnId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Tests

$ npm install --dev
$ make test

Credits

License

The MIT License

Supported by

SEARCH FOR STRATEGIES

0STRATEGIES