readme.md

passport-ionisx

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

Description

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

Install

$ npm install passport-ionisx

Usage

Configure Strategy

The IONISx authentication strategy authenticates users using a IONISx 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 IonisxStrategy({
        clientID: IONISX_CLIENT_ID,
        clientSecret: IONISX_CLIENT_SECRET,
        callbackURL: 'http://127.0.0.1:3000/auth/ionisx/callback'
    },
    function (accessToken, refreshToken, profile, done) {
        User.findOrCreate({ ionisxId: profile.id }, function (err, user) {
            return done(err, user);
        });
    }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Tests

$ npm install --dev
$ gulp test

Development

Feel free to contribute :)

    ╚⊙ ⊙╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝