Skip to content

feedbackfruits/passport-canvas

Repository files navigation

passport-canvas

CircleCIcodecov

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

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

Install

$ npm install passport-canvas

Usage

Configure Strategy

The Canvas authentication strategy authenticates users using a Canvas 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 CanvasStrategy({
    host: CANVAS_HOST,
    clientID: CANVAS_CLIENT_ID,
    clientSecret: CANVAS_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/canvas/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ canvasId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/canvas',
  passport.authenticate('canvas', { }));

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

Tests

$ npm install --dev
$ make test

License

The MIT License

About

Canvas authentication via OAuth 2.0 with Passport

Resources

License

Stars

Watchers

Forks

Packages

No packages published