passport-box-standard

Passport-box

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

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

Install

$ npm install passport-box-standard

Usage

Configure Strategy

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

The consumer key and secret are obtained by creating an application at Box's developer site.

    passport.use(new BoxStrategy({
        clientID: BOX_CLIENT_ID,
        clientSecret: BOX_CLIENT_SECRET,
        callbackURL: "http://127.0.0.1:3000/auth/box/callback"
      },
      function(accessToken, refreshToken, profile, done) {
        User.findOrCreate({ boxId: profile.id }, function (err, user) {
          return done(err, user);
        });
      }
    ));

Authenticate Requests

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

For example, as route middleware in an Express application:

    app.get('/auth/box',
      passport.authenticate('box'));

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

Examples

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

Credits

• Sluggy Bear

Copyright (c) 2016 Sluggy Bear <https://www.slugbay.com>

Thanks

• Jared Hanson

License

• The MIT License