Passport-Helsinki

Passport strategy for authenticating with City of Helsinki SSO using the OAuth 2.0 API.

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

Install

$ npm install git+https://github.com/City-of-Helsinki/passport-helsinki.git

Usage

Configure Strategy

The Helsinki authentication strategy authenticates users using 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 HelsinkiStrategy({
    clientID: OAUTH2_CLIENT_ID,
    clientSecret: OAUTH2_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/github/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ id: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

Credits

• Juha Yrjölä
• Jared Hanson (boilerplate code)

License

The MIT License

Copyright (c) 2015 City of Helsinki <http://www.hel.fi/>