/passport-coinbase

Coinbase authentication strategy for Passport and Node.js.

Primary LanguageJavaScriptMIT LicenseMIT

Passport-Coinbase

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

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

Install

$ npm install passport-coinbase

Usage

Configure Strategy

The Coinbase authentication strategy authenticates users using a Coinbase 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 CoinbaseStrategy({
    clientID: COINBASE_CLIENT_ID,
    clientSecret: COINBASE_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/coinbase/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    // ...
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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