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.
1Password, the only password manager you should trust. Industry-leading security and award winning design.
Status:
$ npm install passport-facebook
Before using 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
application.
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
complete authentication.
passport.use(new FacebookStrategy({
clientID: FACEBOOK_APP_ID,
clientSecret: FACEBOOK_APP_SECRET,
callbackURL: "http://localhost:3000/auth/facebook/callback"
},
function(accessToken, refreshToken, profile, cb) {
User.findOrCreate({ facebookId: profile.id }, function (err, user) {
return cb(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('/');
});
Developers using the popular Express web framework can refer to an example as a starting point for their own web applications.
If you need additional permissions from the user, the permissions can be
requested via the scope option to passport.authenticate().
app.get('/auth/facebook',
passport.authenticate('facebook', { scope: ['user_friends', 'manage_pages'] }));
Refer to permissions with Facebook Login for further details.
Set the authType option to reauthenticate when authenticating.
app.get('/auth/facebook',
passport.authenticate('facebook', { authType: 'reauthenticate', 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 needed by an application
can be indicated by setting the profileFields option.
new FacebookStrategy({
clientID: FACEBOOK_APP_ID,
clientSecret: FACEBOOK_APP_SECRET,
callbackURL: "http://localhost:3000/auth/facebook/callback",
profileFields: ['id', 'displayName', 'photos', 'email']
}), ...)
Refer to the User section of the Graph API Reference for the complete set of available fields.
Set the enableProof option when creating the strategy.
new FacebookStrategy({
clientID: FACEBOOK_APP_ID,
clientSecret: FACEBOOK_APP_SECRET,
callbackURL: "http://localhost:3000/auth/facebook/callback",
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.
Passport is open source software. Ongoing development is made possible by generous contributions from individuals and corporations. To learn more about how you can help keep this project financially sustainable, please visit Jared Hanson's page on Patreon.
Copyright (c) 2011-2016 Jared Hanson <http://jaredhanson.net/>
FAQs
Facebook authentication strategy for Passport.
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
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.