Passport strategy for authenticating with FamilySearch using the OAuth 2.0 API. The legacy strategy using the OAuth 1.0a API is available for use, to support older applications.
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.
$ npm install passport-familysearch
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);
});
}
));
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('/');
});
For a complete, working example, refer to the login example.
The FamilySearch authentication strategy authenticates users using a
FamilySearch account and OAuth tokens. The strategy requires a verify
callback, which accepts these credentials and calls done providing a user, as
well as options specifying a consumer key, consumer secret, and callback URL.
var FamilySearchStrategy = require('passport-familysearch').LegacyStrategy;
passport.use(new FamilySearchStrategy({
consumerKey: FAMILYSEARCH_DEVELOPER_KEY,
consumerSecret: '',
callbackURL: "http://127.0.0.1:3000/auth/familysearch/callback"
},
function(token, tokenSecret, profile, done) {
User.findOrCreate({ familysearchId: profile.id }, function (err, user) {
return done(err, user);
});
}
));
$ npm install --dev
$ make test
Copyright (c) 2012-2013 Jared Hanson <http://jaredhanson.net/>