UNPKG

passport-openid

Version:

OpenID authentication strategy for Passport.

111 lines (81 loc) 3.62 kB
# Passport-OpenID [Passport](https://github.com/jaredhanson/passport) strategy for authenticating with [OpenID](http://openid.net/). This module lets you authenticate using OpenID in your Node.js applications. By plugging into Passport, OpenID authentication can be easily and unobtrusively integrated into any application or framework that supports [Connect](http://www.senchalabs.org/connect/)-style middleware, including [Express](http://expressjs.com/). ## Install $ npm install passport-openid ## Usage #### Configure Strategy The OpenID authentication strategy authenticates users using an OpenID identifier. The strategy requires a `validate` 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 OpenIDStrategy({ returnURL: 'http://localhost:3000/auth/openid/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 `'openid'` strategy, to authenticate requests. For example, as route middleware in an [Express](http://expressjs.com/) application: app.post('/auth/openid', passport.authenticate('openid')); app.get('/auth/openid/return', passport.authenticate('openid', { failureRedirect: '/login' }), function(req, res) { // Successful authentication, redirect home. res.redirect('/'); }); #### Saving Associations Associations between a relying party and an OpenID provider are used to verify subsequent protocol messages and reduce round trips. In order to take advantage of this, an application must store these associations. This can be done by registering functions with `saveAssociation` and `loadAssociation`. strategy.saveAssociation(function(handle, provider, algorithm, secret, expiresIn, done) { // custom storage implementation saveAssoc(handle, provider, algorithm, secret, expiresIn, function(err) { if (err) { return done(err) } return done(); }); }); strategy.loadAssociation(function(handle, done) { // custom retrieval implementation loadAssoc(handle, function(err, provider, algorithm, secret) { if (err) { return done(err) } return done(null, provider, algorithm, secret) }); }); ## Examples For a complete, working example, refer to the [signon example](https://github.com/jaredhanson/passport-openid/tree/master/examples/signon). ## Strategies using OpenID <table> <thead> <tr><th>Strategy</th></tr> </thead> <tbody> <tr><td><a href="https://github.com/rajaraodv/passport-cloudfoundry-openidconnect">Cloud Foundry UAA (OpenID Connect)</a></td></tr> <tr><td><a href="https://github.com/jaredhanson/passport-google">Google</a></td></tr> <tr><td><a href="https://github.com/liamcurry/passport-steam">Steam</a></td></tr> <tr><td><a href="https://github.com/jaredhanson/passport-yahoo">Yahoo!</a></td></tr> </tbody> </table> ## Tests $ npm install --dev $ make test [![Build Status](https://secure.travis-ci.org/jaredhanson/passport-openid.png)](http://travis-ci.org/jaredhanson/passport-openid) ## Credits - [Jared Hanson](http://github.com/jaredhanson) ## License [The MIT License](http://opensource.org/licenses/MIT) Copyright (c) 2011-2013 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>