Facebook authentication strategy for Passport.
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.
$ npm install passport-facebook
passport-facebook, you must register an application with
Facebook. If you have not already done so, a new application can be created at
Facebook Developers. Your application will
be issued an app ID and app secret, which need to be provided to the strategy.
You will also need to configure a redirect URI which matches the route in your
The Facebook authentication strategy authenticates users using a Facebook
account and OAuth 2.0 tokens. The app ID and secret obtained when creating an
application are supplied as options when creating the strategy. The strategy
also requires a
verify callback, which receives the access token and optional
refresh token, as well as
profile which contains the authenticated user's
Facebook profile. The
verify callback must call
cb providing a user to
passportuseclientID: FACEBOOK_APP_IDclientSecret: FACEBOOK_APP_SECRETcallbackURL: ""UserfindOrCreate facebookId: profileidreturn cberr user;;;
passport.authenticate(), specifying the
'facebook' strategy, to
For example, as route middleware in an Express application:
appget'/auth/facebook'passportauthenticate'facebook';appget'/auth/facebook/callback'passportauthenticate'facebook' failureRedirect: '/login'// Successful authentication, redirect home.resredirect'/';;
If you need additional permissions from the user, the permissions can be
requested via the
scope option to
appget'/auth/facebook'passportauthenticate'facebook' scope: 'user_friends' 'manage_pages' ;
Refer to permissions with Facebook Login for further details.
authType option to
rerequest when authenticating.
appget'/auth/facebook'passportauthenticate'facebook' authType: 'rerequest' scope: 'user_friends' 'manage_pages' ;
Refer to re-asking for declined permissions for further details.
The Facebook profile contains a lot of information about a user. By default,
not all the fields in a profile are returned. The fields need by an application
can be indicated by setting the
clientID: FACEBOOK_APP_IDclientSecret: FACEBOOK_APP_SECRETcallbackURL: ""profileFields: 'id' 'displayName' 'photos' 'email'
Refer to the User section of the Graph API Reference for the complete set of available fields.
enableProof option when creating the strategy.
clientID: FACEBOOK_APP_IDclientSecret: FACEBOOK_APP_SECRETcallbackURL: ""enableProof: true
As detailed in securing graph API requests, requiring the app secret for server API requests helps prevent use of tokens stolen by malicous software or man in the middle attacks.
This behavior is "by design" according to Facebook's response to a bug filed regarding this issue.
Fragment identifiers are not supplied in requests made to a server, and as such this strategy is not aware that this behavior is exhibited and is not affected by it. If desired, this fragment can be removed on the client side. Refer to this discussion on Stack Overflow for recommendations on how to accomplish such removal.
The test suite is located in the
test/ directory. All new features are
expected to have corresponding test cases. Ensure that the complete test suite
passes by executing:
$ make test
The test suite covers 100% of the code base. All new feature development is expected to maintain that level. Coverage reports can be viewed by executing:
$ make test-cov$ make view-cov
This software is provided to you as open source, free of charge. The time and effort to develop and maintain this project is dedicated by @jaredhanson. If you (or your employer) benefit from this project, please consider a financial contribution. Your contribution helps continue the efforts that produce this and other open source software.
Copyright (c) 2011-2016 Jared Hanson <http://jaredhanson.net/>