Skip to content

AOL (OpenID) authentication strategy for Passport and Node.js.

License

Notifications You must be signed in to change notification settings

jaredhanson/passport-aol

Repository files navigation

Passport-AOL

Passport strategy for authenticating with AOL using OpenID 2.0.

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

Install

$ npm install passport-aol

Usage

Configure Strategy

The AOL authentication strategy authenticates users using a AOL account, which is also an OpenID 2.0 identifier. The strategy requires a verify 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 AOLStrategy({
    returnURL: 'http://localhost:3000/auth/aol/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 'aol' strategy, to authenticate requests.

For example, as route middleware in an Express application:

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

app.get('/auth/aol/return', 
  passport.authenticate('aol', { 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) 2012-2013 Jared Hanson <http://jaredhanson.net/>

About

AOL (OpenID) authentication strategy for Passport and Node.js.

Resources

License

Stars

Watchers

Forks

Packages

No packages published