passport-facebook
Advanced tools
The passport-facebook npm package is a Passport strategy for authenticating with Facebook using the OAuth 2.0 API. It allows applications to authenticate users via their Facebook accounts, enabling features such as login, registration, and profile access.
Facebook Authentication
This feature allows you to authenticate users using their Facebook accounts. The code sample demonstrates how to set up the Facebook strategy with Passport, including the necessary client ID, client secret, and callback URL.
const passport = require('passport');
const FacebookStrategy = require('passport-facebook').Strategy;
passport.use(new FacebookStrategy({
clientID: FACEBOOK_APP_ID,
clientSecret: FACEBOOK_APP_SECRET,
callbackURL: 'http://www.example.com/auth/facebook/callback'
},
function(accessToken, refreshToken, profile, done) {
User.findOrCreate({ facebookId: profile.id }, function (err, user) {
return done(err, user);
});
}));Handling Authentication Callback
This feature handles the authentication callback from Facebook. The code sample shows how to set up routes to initiate Facebook authentication and handle the callback, redirecting users based on the success or failure of the authentication.
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('/');
});User Profile Access
This feature allows access to the user's Facebook profile information. The code sample demonstrates how to request specific profile fields such as id, displayName, photos, and email during the authentication process.
passport.use(new FacebookStrategy({
clientID: FACEBOOK_APP_ID,
clientSecret: FACEBOOK_APP_SECRET,
callbackURL: 'http://www.example.com/auth/facebook/callback',
profileFields: ['id', 'displayName', 'photos', 'email']
},
function(accessToken, refreshToken, profile, done) {
User.findOrCreate({ facebookId: profile.id }, function (err, user) {
return done(err, user);
});
}));The passport-google-oauth20 package is a Passport strategy for authenticating with Google using the OAuth 2.0 API. It provides similar functionality to passport-facebook but for Google accounts, allowing applications to authenticate users via their Google accounts.
The passport-twitter package is a Passport strategy for authenticating with Twitter using the OAuth 1.0a API. It offers similar features to passport-facebook but for Twitter accounts, enabling applications to authenticate users via their Twitter accounts.
The passport-github package is a Passport strategy for authenticating with GitHub using the OAuth 2.0 API. It provides similar functionality to passport-facebook but for GitHub accounts, allowing applications to authenticate users via their GitHub accounts.
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.
$ npm install passport-facebook
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);
});
}
));
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('/');
});
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'] }));
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' }));
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.
For a complete, working example, refer to the login example.
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
$ npm install
$ npm test
Copyright (c) 2011-2014 Jared Hanson <http://jaredhanson.net/>
FAQs
Facebook authentication strategy for Passport.
The npm package passport-facebook receives a total of 91,502 weekly downloads. As such, passport-facebook popularity was classified as popular.
We found that passport-facebook demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.