passport-facebook 项目技术文档

1. 安装指南

安装步骤

1. 打开终端或命令行工具。

2. 导航到你的项目目录。

3. 运行以下命令安装 passport-facebook 模块：

   npm install passport-facebook
   

依赖项

• Node.js
• npm
• Passport.js

2. 项目的使用说明

注册应用程序

在使用 passport-facebook 之前，你需要在 Facebook 开发者平台上注册你的应用程序。注册完成后，你将获得一个应用 ID 和应用密钥，这些信息将用于配置 Facebook 认证策略。

配置策略

在配置策略时，你需要提供以下信息：

• clientID: 你的 Facebook 应用 ID。
• clientSecret: 你的 Facebook 应用密钥。
• callbackURL: 认证成功后重定向的 URL。

示例代码：

var FacebookStrategy = require('passport-facebook');

passport.use(new FacebookStrategy({
    clientID: process.env['FACEBOOK_APP_ID'],
    clientSecret: process.env['FACEBOOK_APP_SECRET'],
    callbackURL: 'https://www.example.com/oauth2/redirect/facebook',
    state: true
  },
  function verify(accessToken, refreshToken, profile, cb) {
    // 验证逻辑
  }
));

定义路由

你需要定义两个路由来处理用户登录：

1. 第一个路由将用户重定向到 Facebook 进行认证：

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

2. 第二个路由处理 Facebook 重定向回来的认证响应：

   app.get('/oauth2/redirect/facebook',
     passport.authenticate('facebook', { failureRedirect: '/login', failureMessage: true }),
     function(req, res) {
       res.redirect('/');
     });
   

3. 项目API使用文档

获取用户额外权限

如果你需要从用户那里获取额外的权限，可以使用 scope 选项：

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

重新请求被拒绝的权限

如果你需要重新请求被用户拒绝的权限，可以使用 authType 选项：

app.get('/auth/facebook',
  passport.authenticate('facebook', { authType: 'reauthenticate', scope: ['user_friends', 'manage_pages'] }));

获取用户特定字段

默认情况下，Facebook 不会返回用户资料的所有字段。你可以通过 profileFields 选项指定需要返回的字段：

new FacebookStrategy({
  clientID: FACEBOOK_APP_ID,
  clientSecret: FACEBOOK_APP_SECRET,
  callbackURL: "http://localhost:3000/auth/facebook/callback",
  profileFields: ['id', 'displayName', 'photos', 'email']
}, ...)

启用应用密钥证明

为了增强安全性，你可以启用应用密钥证明：

new FacebookStrategy({
  clientID: FACEBOOK_APP_ID,
  clientSecret: FACEBOOK_APP_SECRET,
  callbackURL: "http://localhost:3000/auth/facebook/callback",
  enableProof: true
}, ...)

4. 项目安装方式

通过 npm 安装

npm install passport-facebook

手动安装

如果你不想使用 npm，也可以手动下载并添加到项目中。

1. 下载 passport-facebook 模块的源代码。

2. 将源代码解压并放置在你的项目目录中。

3. 在项目中引用模块：

   var FacebookStrategy = require('./path/to/passport-facebook');
   

通过以上步骤，你就可以成功安装并使用 passport-facebook 模块进行 Facebook 认证了。