如何使用 Hapi 和 Passport 进行用户认证和授权

前端开发过程中，用户认证和授权是经常需要处理的问题。Hapi 和 Passport 是两个常用的 Node.js 框架，它们可以帮助我们轻松地完成用户认证和授权的任务。本篇文章将详细介绍如何使用 Hapi 和 Passport 进行用户认证和授权，并提供示例代码。

什么是 Hapi 和 Passport？

• Hapi

Hapi 是 Node.js 的一个开源框架，它提供了一套工具和插件，帮助开发者快捷地构建 Web 应用程序和服务。Hapi 具有易扩展性、插件化和自定义的特点，可以帮助我们快捷而可靠地创建 Web 应用程序和服务。

• Passport

Passport 是一个 Node.js 的身份验证库，它提供了一种简单、灵活的方式来认证用户。Passport 处理身份验证的过程包括身份验证策略的选择、用户登录和授权处理。Passport 支持多种身份验证策略，包括本地认证、OAuth、OpenID 等。

如何使用 Hapi 和 Passport 进行用户认证和授权？

首先，我们需要安装 Hapi 和 Passport，可以使用 npm 命令来进行安装，例如：

npm install hapi
npm install passport

接着，我们需要引入 Hapi 和 Passport：

const Hapi = require('hapi');
const Passport = require('passport');

使用本地身份验证策略

下面，我们将使用本地身份验证策略进行用户认证。首先，我们需要配置本地身份验证策略：

const LocalStrategy = require('passport-local').Strategy;
Passport.use(new LocalStrategy(
  function(username, password, done) {
      // 在此处对用户名和密码进行验证，验证通过则调用 done(null, user) 返回 user 对象，否则调用 done(null, false) 或者 done(err)。
  }
));

在上述代码中，我们引入了本地身份验证策略，并使用 Passport.use() 方法将其注册到 Passport 中。LocalStrategy 构造函数接收三个参数，分别为 username、password 和 done，其中 done 为回调函数，用于验证用户身份是否合法。如果用户名和密码正确，则调用 done(null, user) 返回 user 对象，否则调用 done(null, false) 表示验证失败。

接着，我们需要定义登录和注册接口，以供用户进行登录和注册操作：

// 登录接口
server.route({
  method: 'POST',
  path: '/login',
  handler: function(request, h) {
      // 在此处调用 Passport.authenticate() 方法验证用户身份，验证通过则返回用户信息，否则返回错误信息或 401 状态码。
  },
});

// 注册接口
server.route({
  method: 'POST',
  path: '/register',
  handler: function(request, h) {
      // 在此处对用户信息进行处理，处理完成后调用 Passport.authenticate() 方法验证用户身份，验证通过则返回成功信息，否则返回错误信息。
  },
});

在上述代码中，我们使用 server.route() 方法定义了登录和注册接口的路由。在登录接口中，我们可以使用 Passport.authenticate() 方法进行本地身份验证。在接收到请求之后，Passport.authenticate() 方法会自动调用上述的 LocalStrategy 进行验证，验证成功则返回用户信息，否则返回错误信息。

在注册接口中，我们需要先对用户信息进行处理，并将用户信息存入数据库中。接着，我们可以使用 Passport.authenticate() 方法进行本地身份验证。

使用 Token 身份验证策略

除了本地身份认证策略，我们还可以使用 Token 身份认证策略进行身份验证。下面，我们将详细介绍如何在 Hapi 和 Passport 中实现 Token 身份认证策略。

首先，我们需要在 Hapi 中配置 Token 认证插件：

// 安装 hapi-auth-jwt2 插件
npm install hapi-auth-jwt2

// 配置插件
server.register(require('hapi-auth-jwt2'), function(err) {
  if (err) {
      console.log(err);
  }

  // 定义 Token 身份验证策略
  server.auth.strategy('jwt', 'jwt', {
      key: 'your_jwt_secret_key', // 用于签署和验证 Token 的密钥
      validate: async function (decoded, request) {
          // 在此处对 Token 进行验证，如果验证成功则返回 true，否则返回 false 或错误信息。
      },
      verifyOptions: {
          algorithms: ['HS256'], // 指定签名算法
      }
  });

  // 设置默认的身份验证策略
  server.auth.default('jwt');

  // 定义路由
  server.route({
      method: 'POST',
      path: '/private',
      handler: function (request, h) {
          // 获取当前用户信息
          const user = request.auth.credentials;

          // 在此处处理请求，并返回响应数据
          return user;
      },
      config: {
          auth: 'jwt', // 指定使用 Token 身份验证策略
      }
  });
});

在上述代码中，我们安装了 hapi-auth-jwt2 插件，并使用 server.auth.strategy() 方法定义了 Token 身份验证策略。其中，key 用于签署和验证 Token 的密钥，validate 属性为验证函数，用于验证 Token 是否合法。在收到请求之后，服务器将自动调用定义的 verify 函数进行 Token 的验证。

接着，我们使用 server.auth.default() 方法为默认身份验证策略设置 Token 身份验证策略，将默认的身份验证策略设置为 jwt。最后，我们使用 server.route() 方法定义了路由，并通过 config.auth 属性指定使用 Token 身份验证策略。

示例代码

使用本地身份验证策略的示例代码：

const Hapi = require('hapi');
const Passport = require('passport');
const LocalStrategy = require('passport-local').Strategy;
const Bcrypt = require('bcrypt'); // 用于加密密码

// 定义 users 对象，模拟用户数据
const users = [
    {
        id: 1,
        username: 'user1',
        password: '$2b$10$LOyBrEw37gqpp3t2rKjTveTtT0I/gnkJ615Ja1BS74NbwNt8PvN.e', // 密码为 123456
    },
    {
        id: 2,
        username: 'user2',
        password: '$2b$10$.pbuG/bWGTl8iLweNOFL6OyGpFn5M5fzY5KfwO9MadNC51VaUxwm6', // 密码为 abcdefg
    },
];

// 创建服务器
const server = Hapi.server({
    port: 3000,
    host: 'localhost',
});

// 配置本地身份验证策略
Passport.use(new LocalStrategy(
    function (username, password, done) {
        const user = users.find(user => user.username === username);

        if (!user) {
            return done(null, false, { message: 'Incorrect username.' });
        }

        Bcrypt.compare(password, user.password, function(err, res) {
            if (res) {
                return done(null, user);
            } else {
                return done(null, false, { message: 'Incorrect password.' });
            }
        });
    }
));

// 配置 server.auth 插件
await server.register(require('hapi-auth-cookie'));
server.auth.strategy('session', 'cookie', {
    cookie: {
        name: 'session',
        password: 'password-should-be-32-characters',
        isSecure: false,
    },
    redirectTo: '/login',
});

// 定义登录接口
server.route({
    method: 'POST',
    path: '/login',
    handler: async function(request, h) {
        try {
            const response = await Passport.authenticate('local', { session: false })(request, h);
            return response;
        } catch (err) {
            console.error(err);
            throw err;
        }
    },
    config: {
        auth: 'session',
    },
});

// 定义注册接口
server.route({
    method: 'POST',
    path: '/register',
    handler: async function(request, h) {
        try {
            const { username, password } = request.payload;
            const hashedPassword = await Bcrypt.hash(password, 10);

            const newUserId = users.length + 1;
            const newUser = { id: newUserId, username, password: hashedPassword };
            users.push(newUser);

            const response = await Passport.authenticate('local', { session: false })(request, h);
            return response;
        } catch (err) {
            console.error(err);
            throw err;
        }
    },
});

await server.start();
console.log('Server running on %s', server.info.uri);

使用 Token 身份验证策略的示例代码：

const Hapi = require('hapi');
const Jwt = require('jsonwebtoken'); // 用于签署和验证 Token

// 创建服务器
const server = Hapi.server({
    port: 3000,
    host: 'localhost',
});

// 定义路由
server.route({
    method: 'GET',
    path: '/public',
    handler: function(request, h) {
        // 在此处处理请求，并返回响应数据
        return { message: 'Hello World!' };
    },
});

server.route({
    method: 'POST',
    path: '/login',
    handler: function(request, h) {
        const { username, password } = request.payload;
        // 在此处对用户名和密码进行验证，验证通过则返回 user 对象，否则返回 null
        const user = null;

        if (user) {
            // 签署 Token
            const token = Jwt.sign({ userId: user.id }, 'your_jwt_secret_key', { expiresIn: '1h' });
            return { success: true, token };
        } else {
            return { success: false };
        }
    }
});

server.register(require('hapi-auth-jwt2'), function(err) {
    if (err) {
        console.log(err);
    }

    // 定义 Token 验证策略
    server.auth.strategy('jwt', 'jwt', {
        key: 'your_jwt_secret_key', // 用于签署和验证 Token 的密钥
        validate: async function (decoded, request) {
            // 在此处对 Token 进行验证，如果验证成功则返回 true，否则返回 false 或错误信息。
            const user = users.find(user => user.id === decoded.userId);
            if (user) {
                return { isValid: true, credentials: user };
            } else {
                return { isvalid: false };
            }
        },
        verifyOptions: {
            algorithms: ['HS256'], // 指定签名算法
        }
    });

    // 设置默认的身份验证策略
    server.auth.default('jwt');

    // 定义路由
    server.route({
        method: 'POST',
        path: '/private',
        handler: function (request, h) {
            // 获取当前用户信息
            const user = request.auth.credentials;

            // 在此处处理请求，并返回响应数据
            return user;
        },
        config: {
            auth: 'jwt', // 指定使用 Token 身份验证策略
        }
    });
});

await server.start();
console.log('Server running on %s', server.info.uri);

总结

本篇文章介绍了如何使用 Hapi 和 Passport 进行用户认证和授权。在开发过程中，根据应用场景的不同，我们可以选择不同的身份验证策略来满足需求。同时，还提供了示例代码，帮助大家更好地理解如何使用 Hapi 和 Passport。希望本篇文章对大家学习前端开发有所帮助。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65ae8a4badd4f0e0ff8121fe