Skip to content

acruxray/passport-stack-exchange

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Passport-Stack-Exchange

Passport strategy for authenticating with Stack Exchange using the OAuth 2.0 API.

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

Install

npm install passport-stack-exchange

Usage

Configure Strategy

The Stack Exchange authentication strategy authenticates users using a Stack Exchange account (Stack Overflow) 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, callback URL, and API key for Stackapps. Register the application on the service page.

var StackExchangeStrategy = require('passport-stack-exchange');

passport.use(new StackExchangeStrategy({
    clientID: STACKEXCHANGE_CLIENT_ID,
    clientSecret: STACKEXCHANGE_CLIENT_SECRET,
    callbackURL: 'http://127.0.0.1:3000/auth/stack-exchange/callback',
    stackAppsKey: STACKEXCHANGE_APPS_KEY,
    site: 'stackoverflow'
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ stackexchangeId: profile.username }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'stack-exchange' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/stack-exchange',
  passport.authenticate('stack-exchange'));

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

Examples

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

Credits

License

The MIT License

Copyright (c) 2015 Moo Yeol, Lee (Prescott)

About

Stack Exchange authentication strategy for Passport and Node.js.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%