BrowserID authentication strategy for Passport and Node.js.
JavaScript
Latest commit 8935c8f May 25, 2013 @jaredhanson Bump version to 0.1.4.
Failed to load latest commit information.
examples/signin Update example. May 25, 2013
lib/passport-browserid
test Update test data Feb 13, 2013
.gitignore Update ignore files. May 25, 2013
.npmignore Update ignore files. May 25, 2013
.travis.yml Update ignore files. May 25, 2013
LICENSE Update project metadata. May 25, 2013
Makefile Update project metadata. May 25, 2013
README.md Update README. May 25, 2013
package.json Bump version to 0.1.4. May 25, 2013

README.md

Passport-BrowserID

Passport strategy for authenticating with BrowserID.

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

Install

$ npm install passport-browserid

Usage

Configure Strategy

The BrowserID authentication strategy authenticates users using an assertion of email address ownership, obtained via the BrowserID JavaScript API. The strategy requires a validate callback, which accepts an email address and calls done providing a user.

passport.use(new BrowserIDStrategy({
    audience: 'http://www.example.com'
  },
  function(email, done) {
    User.findByEmail({ email: email }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

Implementation

This module is implemented based on the specifications being developed by Mozilla Identity, which remain a work-in-progress and are not final. Implementers are encouraged to track the progress of these specifications and update update their implementations as necessary. Furthermore, the implications of relying on non-final specifications should be understood prior to deployment.

Examples

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

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

Copyright (c) 2011-2013 Jared Hanson <http://jaredhanson.net/>