Passport-FamilySearch

Passport strategy for authenticating with FamilySearch using the OAuth 2.0 API.

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

Install

$ npm install passport-familysearch

Usage

Configure Strategy

The FamilySearch authentication strategy authenticates users using a FamilySearch account and 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 developer key and callback URL.

var FamilySearchStrategy = require('passport-familysearch').Strategy;

passport.use(new FamilySearchStrategy({
    devKey: FAMILYSEARCH_DEVELOPER_KEY,
    callbackURL: "http://127.0.0.1:3000/auth/familysearch/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ familysearchId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

The authenticate method takes an optional parameter for additional configuration. In addition to the parameters supported by passport, these additional options are available:

display (optional): if you specify lite or wap the sign in page will be displayed in a simplified format for browsers with limited capabilities or bandwidth. See http://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
username (optional): will pre-fill the username of the sign in form

passport.authenticate('familysearch', { failureRedirect: '/login', display: 'lite', username: 'fred' })

Examples

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

Tests

$ npm install --dev
$ make test

Credits

License

The MIT License

FamilySearch/passport-familysearch