Skip to content
This repository

Dropbox authentication strategy for Passport and Node.js.

branch: master
README.md

Passport-Dropbox

Passport strategy for authenticating with Dropbox using the OAuth 1.0 API.

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

Install

$ npm install passport-dropbox

Usage

Configure Strategy

The Dropbox authentication strategy authenticates users using a Dropbox 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 DropboxStrategy({
    consumerKey: DROPBOX_APP_KEY,
    consumerSecret: DROPBOX_APP_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/dropbox/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ dropboxId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

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

Something went wrong with that request. Please try again.