Facebook authentication strategy for Passport and Node.js.
JavaScript
Clone or download
Pull request Compare This branch is 101 commits behind jaredhanson:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples/login
lib/passport-facebook
test
.gitignore
.npmignore
.travis.yml
LICENSE
Makefile
README.md
package.json

README.md

Passport-Facebook

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

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

Install

$ npm install passport-facebook

Usage

Configure Strategy

The Facebook authentication strategy authenticates users using a Facebook 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 app ID, app secret, and callback URL.

passport.use(new FacebookStrategy({
    clientID: FACEBOOK_APP_ID,
    clientSecret: FACEBOOK_APP_SECRET,
    callbackURL: "http://localhost:3000/auth/facebook/callback"
  },
  function(accessToken, refreshToken, profile, done) {
    User.findOrCreate({ facebookId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Extended Permissions

If you need extended permissions from the user, the permissions can be requested via the scope option to passport.authenticate().

For example, this authorization requests permission to the user's statuses and checkins:

app.get('/auth/facebook',
  passport.authenticate('facebook', { scope: ['user_status', 'user_checkins'] }));

Display Mode

The display mode with which to render the authorization dialog can be set by specifying the display option. Refer to Facebook's OAuth Dialog documentation for more information.

app.get('/auth/facebook',
  passport.authenticate('facebook', { display: 'touch' }));

Profile Fields

The Facebook profile is very rich, and may contain a lot of information. The strategy can be configured with a profileFields parameter which specifies a list of fields (named by Portable Contacts convention) your application needs. For example, to fetch only user's facebook ID, name, and picture, configure strategy like this.

passport.use(new FacebookStrategy({
    // clientID, clientSecret and callbackURL
    profileFields: ['id', 'displayName', 'photos']
  },
  // verify callback
));

If profileFields is not specified, the default fields supplied by Facebook will be parsed.

Examples

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

Issues

Facebook's OAuth 2.0 implementation has a [bug][1] in which the fragment #_=_ is appended to the callback URL. This appears to affect Firefox and Chrome, but not Safari. This fragment can be removed via client-side JavaScript, and @niftylettuce provides a suggested [workaround][2]. Developers are encouraged to direct their complaints to Facebook in an effort to get them to implement a proper fix for this issue. [1]: https://developers.facebook.com/bugs/196125357123225 [2]: https://github.com/jaredhanson/passport-facebook/issues/12#issuecomment-5913711

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

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