passport-khan

0.2.0 • Public • Published

Passport-Khan

Passport strategy for authenticating with Khan Academy using the OAuth 1.0a API.

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

Install

$ npm install passport-khan

Usage

Configure Strategy

The Khan Academy authentication strategy authenticates users using a Khan Academy 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 KhanStrategy({
    consumerKey: KHAN_CONSUMER_KEY,
    consumerSecret: KHAN_CONSUMER_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/khan/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ kaid: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

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

Tests

$ npm install --dev
$ make test

Build Status

Credits

Shamelessly copied from the passport-vimeo repo by Jared Hanson

License

The MIT License

Package Sidebar

Install

npm i passport-khan

Weekly Downloads

0

Version

0.2.0

License

MIT

Last publish

Collaborators

  • jesseditson