1.0.3 • Published 8 years ago

passport-cisco-spark v1.0.3

Weekly downloads
111
License
MIT
Repository
github
Last release
8 years ago

Passport - Cisco Spark

Passport strategy for authenticating with Cisco Spark using the OAuth 2.0 API.

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

Install

$ npm install passport-cisco-spark

Usage

Configure Strategy

The Cisco Spark authentication strategy authenticates users using a Cisco Spark 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 CiscoSparkStrategy({
    clientID: CISCO_SPARK_CLIENT_ID,
    clientSecret: CISCO_SPARK_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/spark/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ sparkId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'cisco-spark' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/spark',
  passport.authenticate('cisco-spark'));

app.get('/auth/spark/callback', 
  passport.authenticate('cisco-spark', { 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

License

The MIT License