Skip to content

headlessme/passport-chalkable-oauth2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Passport-Chalkable-OAuth2

Passport strategies for authenticating with Chalkable using OAuth 2.0.

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

Install

$ npm install passport-chalkable-oauth2

Usage

Configure Strategy

The Chalkable OAuth 2.0 authentication strategy authenticates users using a Chalkable 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.

var ChalkableStrategy = require('passport-chalkable-oauth2').OAuth2Strategy;

passport.use(new ChalkableStrategy({
    clientID: CHALKABLE_CLIENT_ID,
    clientSecret: CHALKABLE_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/chalkable/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ chalkableId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

Credits

  • Jared Hanson for the orignial passport module, and the Google OAuth module from which this is derived.

License

The MIT License

Copyright (c) 2012-2013 Jared Hanson <http://jaredhanson.net/>

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published