Skip to content

Reddit oauth2 authentication strategy for passport.js, reworked to use commonJS modules

License

Notifications You must be signed in to change notification settings

Nidrux/passport-reddit-commonJS

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Passport-Reddit-commonJS

This is a rework of the original package to use commonJS modules instead of ES6. All credits to them for making this strategy possible! This fork is not activly maintained, but will recieve an update when I need to make changes for my own projects aswell.

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

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

Install

$ npm install passport-reddit-commonjs

Usage

Configure Strategy

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

const RedditStrategy = require("passport-reddit-commonjs").Strategy

passport.use(new RedditStrategy({
    clientID: REDDIT_CONSUMER_KEY,
    clientSecret: REDDIT_CONSUMER_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/reddit/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ redditId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/reddit', function(req, res, next){
  passport.authenticate('reddit', {
    duration: 'permanent',
  })(req, res, next);
});

app.get('/auth/reddit/callback', function(req, res, next){
  passport.authenticate('reddit', {
    successRedirect: '/',
    failureRedirect: '/login'
  })(req, res, next);
});
duration option on authenticate call

This strategy supportsduration option on authenticate call, to request an indefinite authorization as opposed to 1 hour default.
Possible values: permanent and temporary (1 hour).

Defined in the official Reddit OAuth spec

Credits

License

The MIT License

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

Modified work Copyright (c) 2013 Dmytro Soltys <http://slotos.net/>

Modified work Copyright (c) 2013 Brian Partridge <http://brianpartridge.com/>

About

Reddit oauth2 authentication strategy for passport.js, reworked to use commonJS modules

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%