/passport-yahoo

Yahoo! (OpenID) authentication strategy for Passport and Node.js.

Primary LanguageJavaScriptMIT LicenseMIT

Passport-Yahoo

Passport strategy for authenticating with Yahoo! using OpenID 2.0.

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

Install

$ npm install passport-yahoo

Usage

Configure Strategy

The Yahoo authentication strategy authenticates users using a Yahoo account, which is also an OpenID 2.0 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 YahooStrategy({
    returnURL: 'http://localhost:3000/auth/yahoo/return',
    realm: 'http://localhost:3000/'
  },
  function(identifier, done) {
    User.findByOpenID({ openId: identifier }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

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

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

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

Sponsor