Passport strategy for authenticating with SheKnows Connect using the OAuth 2.0 API.
This module lets you authenticate using SheKnows in your Node.js applications. By plugging into Passport, SheKnows authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
$ npm install passport-sheknows
- Head to staging or production Connect client administration.
- Add a new client
- Once created, Client and Client Secret will be generated for you
The SheKnows authentication strategy authenticates users using a SheKnows 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 client ID, client secret, and callback URL.
passport.use(new SheKnowsStrategy({
clientID: SHEKNOWS_CLIENT_ID,
clientSecret: SHEKNOWS_CLIENT_SECRET,
callbackURL: "http://127.0.0.1:3000/auth/sheknows/callback"
},
function(accessToken, refreshToken, profile, done) {
User.findOrCreate({ SheKnowsId: profile.id }, function (err, user) {
return done(err, user);
});
}
));
Use passport.authenticate(), specifying the 'sheknows' strategy, to
authenticate requests.
For example, as route middleware in an Express application:
app.get('/auth/sheknows',
passport.authenticate('sheknows'));
app.get('/auth/sheknows/callback',
passport.authenticate('sheknows', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
Run the test suite:
$ npm install --dev
$ npm test
Many thanks to the Passport-GitHub module for providing an excellent Passport plugin for GitHub.
Copyright (c) 2013 SheKnows, LLC <http://www.sheknows.com>