Passport-Local 技术文档

本文档旨在详细介绍如何安装和使用 Passport-Local，这是一个基于 Node.js 的认证策略模块，允许用户通过用户名和密码进行认证。以下是安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

要安装 Passport-Local，请运行以下命令：

$ npm install passport-local

2. 项目使用说明

配置策略

Local 认证策略通过用户名和密码来认证用户。该策略需要一个 verify 回调函数，它接受这些凭证，并调用 done 函数，提供用户信息。

passport.use(new LocalStrategy(
  function(username, password, done) {
    User.findOne({ username: username }, function (err, user) {
      if (err) { return done(err); }
      if (!user) { return done(null, false); }
      if (!user.verifyPassword(password)) { return done(null, false); }
      return done(null, user);
    });
  }
));

可用选项

策略接受一个可选的选项哈希对象，例如 new LocalStrategy({/* options */, callback})。

可用选项包括：

• usernameField - 可选，默认为 'username'
• passwordField - 可选，默认为 'password'

这两个字段定义了 POST 请求体中发送到服务器的属性名称。

参数

默认情况下，LocalStrategy 期望在参数名为 username 和 password 的地方找到凭证。如果您的网站偏好使用不同的字段名称，可以通过选项来更改默认值。

passport.use(new LocalStrategy({
    usernameField: 'email',
    passwordField: 'passwd',
    session: false
  },
  function(username, password, done) {
    // ...
  }
));

当不需要会话支持时，可以安全地通过设置 session 选项为 false 来禁用它。

如果需要将 request 对象传递给 verify 回调函数，可以将 passReqToCallback 选项设置为 true，并相应地调整回调参数。

passport.use(new LocalStrategy({
    usernameField: 'email',
    passwordField: 'passwd',
    passReqToCallback: true,
    session: false
  },
  function(req, username, password, done) {
    // request 对象现在是第一个参数
    // ...
  }
));

认证请求

使用 passport.authenticate() 函数，并指定 'local' 策略来认证请求。

例如，在一个 Express 应用中作为路由中间件使用：

app.post('/login', 
  passport.authenticate('local', { failureRedirect: '/login' }),
  function(req, res) {
    res.redirect('/');
  });

3. 项目 API 使用文档

Passport-Local 的 API 使用文档可以在其官方文档中找到，其中包括了详细的策略配置和使用方式。

4. 项目安装方式

Passport-Local 可以通过 npm 进行安装，使用以下命令：

$ npm install passport-local

以上就是 Passport-Local 的技术文档，希望对您的使用有所帮助。