Passport-xao NPM

Passport-XAO

Passport strategy for authenticating with XAO using the OAuth 2.0 API.

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

Installation

$ npm install passport-xao

Usage

Configure Strategy

The XAO authentication strategy authenticates users using a XAO 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 XaoStrategy({
    clientID: XAO_CLIENT_ID,
    clientSecret: XAO_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/xao/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ xaoId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/xao',
  passport.authenticate('xao', { scope: [ 'user:email' ] }));

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