使用 Fastify OAuth2.0 与外部服务器进行身份验证-JavaScript中文网-JavaScript教程资源分享门户

在实际的web应用中，许多情况下需要对用户身份进行验证。这时候OAuth2将是一种非常方便的选择。Fastify是一个快速且低开销的Web框架，和OAuth2结合起来可以快速地实现身份验证。在本文中，我们将会了解如何使用Fastify OAuth2进行身份验证，并模拟一个外部服务器进行验证的场景。

OAuth2

OAuth2是一种授权框架，用在客户端和服务端之间。其目的在于允许用户授权第三方网站访问他们的资源，而无需将用户名和密码传给第三方网站。OAuth2通过授权码流程来获得访问令牌(access token)，从而对访问进行控制。

Fastify

Fastify是一个高效的Web框架，针对 Node.js 设计。Fastify 吸收了很多优秀Web框架的优秀点，比如Express、hapi、Restify等。同时，它考虑到了 Node.js 自身的特性，在路由、中间件等方面做了优化，从而提供了非常高效和稳定的基础环境。Fastify通过一个koa-like的中间处理器(handler)机制，可以非常方便地实现数据解析、路由分发等操作。

使用Fastify OAuth2进行身份验证

Fastify OAuth2是一个OAuth2.0框架，可以通过几个简单的步骤将OAuth2服务和Fastify集成在一起。它支持所有的OAuth2逻辑，包括授权流程和访问令牌管理。

首先安装Fastify OAuth2：

npm install fastify-oauth2

创建Fastify实例

创建Fastify实例并初始化Fastify OAuth2对象：

// javascriptcn.com 代码示例
const Fastify = require('fastify')
// 引入Fastify OAuth2
const OAuth2 = require('fastify-oauth2')

const fastify = Fastify()

// 定义OAuth2配置
const oAuth2Config = {
  name: 'outerServer',
  scope: ['openid', 'profile', 'email'],
  credentials: {
    client: {
      id: 'your-client-id-here',
      secret: 'your-client-secret-here',
    },
    auth: {
      tokenHost: 'https://your.tokenhost.com'
      tokenPath: '/oauth/access_token',
      authorizePath: '/oauth/authorize',
    },
  },
}

// 初始化Fastify OAuth2插件
fastify.register(oAuth2, oAuth2Config)

上面代码中，首先引入 fastify-oauth2 模块，然后定义定义OAuth2配置，其中 name 为本次OAuth2认证的名称， scope 指定请求中需要的资源， credentials 指定认证的客户端ID、密钥以及token相关路径。最后引入fastify-oauth2模块并注册到Fastify上。

客户端认证

接下来要通过Fastify OAuth2，拿到access token。基本步骤如下：

定义认证链接
生成OAuth2登录链接
发起请求获取access token

// javascriptcn.com 代码示例
//定义认证链接
const authorizeURL = fastify.outerServer.getAuthorizationUrl({
  redirect_uri: YOUR_REDIRECT_URI,
  scope: YOUR_SCOPE,
  response_type: 'token',
})

//生成OAuth2登录链接
fastify.get('/login', async (req, res) => {
  res.redirect(authorizeURL)
})

//exchange access token
const tokenOptions = {
  grant_type: 'authorization_code'
}

const accessToken = await fastify.outerServer.getAccessTokenFromAuthorizationCodeFlow(req.query.code, tokenOptions)

上述代码中，authorizeURL 是拼接的认证链接。Fastify OAuth2通过 Fastify.getAuthorizationUrl() 方法来生成OAuth2登录链接，生成的链接通常会重定向至oauth2服务器的授权页面，供用户进行登录。当授权完成后，服务器会将access_token作为查询参数返回至当前域名下的回调地址，由此我们可以获得access token，最后调用 getAccessTokenFromAuthorizationCodeFlow() 方法获取token。

通过access token 认证

有了access token之后，我们可以使用Fastify OAuth2提供的方法进行身份验证了。

const userDetails = await  fastify.outerServer.verifyAccessToken(accessToken);

上述代码会返回一个包含用户信息的对象(userDetails)。

模拟外部OAuth2认证服务器

接下来，我们需要模拟一个简单的OAuth2认证服务器。这里我们使用 hapi-auth-basic模块来模拟一个基本的认证服务器。

首先安装 hapi-auth-basic，并启动一个 hapi 实例：

// javascriptcn.com 代码示例
const hapi = require('@hapi/hapi')
const Joi = require('joi')
const authBasic = require('hapi-auth-basic')

const server = new hapi.Server({
    host: 'localhost',
    port: 3000
})

// 注册 hapi-auth-basic 插件
await server.register(authBasic)

// 定义自定义的策略
server.auth.strategy('simple', 'basic', {
    validate: async (request, username, password, h) => {
      // username 和 password 都来自请求头
      const isValid = username === 'journey' && password === '123456';
      const credentials = { user: 'journey' };
      const artifacts = { };
      return { isValid, credentials, artifacts };
    }
});

// 定义路由
server.route({
  method: 'GET',
  path: '/basic',
  config: {
    auth: 'simple',
    handler: (request, h) => {
      return { text: 'Success! You can not see this without a token' }
    }
  }
})

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

在上述代码中，我们先引入 @hapi/hapi 模块，然后引入 hapi-auth-basic 模块，执行 server.register(authBasic)命令将 hapi-auth-basic插件注册到服务器中。接着，使用 server.auth.strategy()方法定义了一个自定义的策略，策略名称为 simple。请求头的用户名密码与预设的账号密码进行比对，若一致则返回 credentials。最后定义了一个路由，此路由需要进行简单的Basic认证。

现在我们已经模拟了一个OAuth2认证服务器。接下来会使用使用 Fastify OAuth2 实现与这个认证服务器的交互。

// javascriptcn.com 代码示例
// 定义OAuth2配置
const oAuth2Config = {
  name: 'outerServer',
  scope: ['openid', 'profile', 'email'],
  credentials: {
    client: {
      id: 'fastify-oauth2',
      secret: 'this-is-password',
    },
    auth: {
      authorizeHost: 'localhost',
      authorizePath: '/basic',
      tokenPath: '/basic',
      authorizeQueryParams : {
        response_type: 'token',
      },
      tokenQueryParams: {
        grant_type: 'authorization_code',
      },
    },
    options: {
      authorizationMethod: 'get'
    }
  },
}

fastify
  .register(oAuth2, oAuth2Config)
  .get('/', async (request, reply) => {
    return { hello: 'world' };
  })
  .listen(PORT);

在上述代码中，定义了一个OAuth2认证的client，与我们需要验证的Basic认证服务器的地址（'localhost:3000'）做交互。credentials.client 中包含了客户端的ID和密码，credentials.auth 中包含了具体身份认证标准，如 authorizePath、tokenPath等，credentials.options 中包含了一些其他的配置信息。最后，我们在Fastify中注册OAuth2后调用listen()函数，它将启动Fastify服务器并监听端口。

这样我们就完成了一个基本的Fastify OAuth2 应用，能够模拟一个Basic认证服务器并与之交互。

总结

OAuth2是一种常用的身份认证方式，而 Fastify 又是高效的Node.js Web框架，将这两者结合使用相当方便。我们在本文中，介绍了如何使用Fastify OAuth2进行身份验证，并实现与一个模拟Basic认证服务器的交互。相信读者在学完本文后，便可以轻松地使用Fastify OAuth2 在许多Web应用中实现身份验证。若要查看更多相关内容详见官方文档：fastify-oauth2 - npm (npmjs.com)

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