OpenID authentication strategy for Passport and Node.js.
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples/signon Add signon example. Nov 4, 2011
lib/passport-openid Remove pkginfo. Sep 24, 2015
test Remove pkginfo. Sep 24, 2015
.gitignore Update ignore files. Feb 10, 2013
.npmignore Update ignore files. Feb 10, 2013
.travis.yml Update package.json to use node-openid@1.0 Aug 25, 2015
LICENSE Update project metadata. Feb 11, 2013
Makefile Update project metadata. Feb 11, 2013 Add code sponsor placement. Sep 16, 2017
package.json Bump version to 0.4.0. Sep 24, 2015


Passport strategy for authenticating with OpenID.

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-style middleware, including Express.


$ npm install passport-openid


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 application:'/auth/openid',

  passport.authenticate('openid', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.

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)


For a complete, working example, refer to the signon example.

Strategies using OpenID

Cloud Foundry UAA (OpenID Connect)


$ npm install --dev
$ make test

Build Status



The MIT License

Copyright (c) 2011-2013 Jared Hanson <>