Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 2.5 KB

README.md

File metadata and controls

81 lines (56 loc) · 2.5 KB

Passport-Yahoo-OAuth

Passport strategies for authenticating with Yahoo! using the OAuth 1.0a API.

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.

Installation

$ npm install passport-yahoo-oauth

Usage

Configure Strategy

The Yahoo authentication strategy authenticates users using a Yahoo 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.

passport.use(new YahooStrategy({
    consumerKey: YAHOO_CONSUMER_KEY,
    consumerSecret: YAHOO_CONSUMER_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/yahoo/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ yahooId: profile.id }, 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/callback',
  passport.authenticate('yahoo', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });

Examples

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

Issues

If you receive a 401 Unauthorized error, it is most likely because you have not yet specified any application "Permissions". Once you do so, Yahoo! will generate new credentials for usage, and will then authenticate your requests properly.

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

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