passport-idsus v1.0.1

passport-idsus (SUSConectaLogin)

Passport strategy for authenticating with SUSConectaLogin.

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

Install

$ npm install passport-idsus

Usage

Create an Application

Before using passport-idsus, you must register an application with SUSConectaLogin. Your application will be issued an app ID and app secret, which need to be provided to the strategy. You will also need to configure a redirect URI which matches the route in your application.

Configure Strategy

The SUSConectaLogin authentication strategy authenticates users using a SUSConectaLogin account and OAuth 2.0 tokens. The app ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a verify callback, which receives the access token and some other informations including a userwhich contains the authenticated user's SUSConectaLogin profile. The verify callback must call cb providing a user to complete authentication.

passport.use(new IdSUSStrategy({
    authURL: SUSCONECTALOGIN_HOST,
    clientID: SUSCONECTALOGIN_APP_CLIENTID,
    clientSecret: SUSCONECTALOGIN_APP_CLIENT_SECRET,
    callbackURL: "http://localhost:3000/auth/idsus/callback" // Must match the callback registered in the app
  },
  function(accessToken, tokenType, expiresIn, refreshToken, scope, user, cb) {
    User.findOrCreate({ email: user.email }, function (err, user) {
      return cb(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Contributing

Tests

The test suite is located in the test/ directory. All new features are expected to have corresponding test cases. Ensure that the complete test suite passes by executing:

$ npm test

Coverage

The test suite covers 100% of the code base. All new feature development is expected to maintain that level. Coverage reports can be viewed by executing:

$ npm run coverage
$ npm run open-coverage

License

The MIT License