passport-bitbucket

Bitbucket authentication strategy for Passport.

Passport-Bitbucket

Passport strategy for authenticating with Bitbucket using the OAuth 1.0a API.

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

$ npm install passport-bitbucket

The Bitbucket authentication strategy authenticates users using a Bitbucket account 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, and callback URL.

passport.use(new BitbucketStrategy({
    consumerKey: BITBUCKET_CONSUMER_KEY,
    consumerSecret: BITBUCKET_CONSUMER_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/bitbucket/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ bitbucketId: profile.username }, function (err, user) {
      return done(err, user);
    });
  }
));

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

For example, as route middleware in an Express application:

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

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

Developers using the popular Express web framework can refer to an example as a starting point for their own web applications. The example shows how to authenticate users using Twitter. However, because both Twitter and Bitbucket use OAuth 1.0, the code is similar. Simply replace references to Twitter with corresponding references to Bitbucket.

$ npm install --dev
$ make test

The MIT License

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