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
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);
});
}
));
Use passport.authenticate(), specifying the 'openid' strategy, to
authenticate requests.
For example, as route middleware in an Express application:
app.post('/auth/openid',
passport.authenticate('openid'),
function(req, res){
// The request will be redirected to the user's OpenID provider for
// authentication, so this function will not be called.
});
app.get('/auth/openid/return',
passport.authenticate('openid', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
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.
| Strategy |
|---|
| Steam |
| Yahoo! |
$ npm install --dev
$ make test
(The MIT License)
Copyright (c) 2011 Jared Hanson
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.