功能说明

OAuth2插件实现了基于JWT(JSON Web Tokens)进行OAuth2 Access Token签发的能力, 遵循RFC9068规范

运行属性

插件执行阶段：认证阶段 插件执行优先级：350

配置字段

认证配置

名称数据类型填写要求默认值描述
consumersarray of object必填-配置服务的调用者，用于对请求进行认证
issuerstring选填Higress-Gateway用于填充JWT中的issuer
auth_pathstring选填/oauth2/token指定路径后缀用于签发Token，路由级配置时，要确保首先能匹配对应的路由, 使用 API 管理时，需要创建相同路径的接口
global_credentialsbool选填ture在通过 consumer 认证的前提下，允许任意路由签发的凭证访问
auth_header_namestring选填Authorization用于指定从哪个请求头获取JWT
token_ttlnumber选填7200token从签发后多久内有效，单位为秒
clock_skew_secondsnumber选填60校验JWT的exp和iat字段时允许的时钟偏移量，单位为秒
keep_tokenbool选填ture转发给后端时是否保留JWT
global_autharray of string选填(仅实例级别配置)-只能在实例级别配置，若配置为true，则全局生效认证机制; 若配置为false，则只对做了配置的域名和路由生效认证机制; 若不配置则仅当没有域名和路由配置时全局 生效（兼容老用户使用习惯）

consumers中每一项的配置字段说明如下：

名称数据类型填写要求默认值描述
namestring必填-配置该consumer的名称
client_idstring必填-OAuth2 client id
client_secretstring必填-OAuth2 client secret

注意：

  • 对于开启该配置的路由，如果路径后缀和auth_path匹配，则该路由不会到原目标服务，而是用于生成Token
  • 如果关闭global_credentials,请确保启用此插件的路由不是精确匹配路由，此时若存在另一条前缀匹配路由，则可能导致预期外行为
  • 对于通过认证鉴权的请求，请求的header会被添加一个X-Mse-Consumer字段，用以标识调用者的名称。

鉴权配置（非必需）

名称数据类型填写要求默认值描述
allowarray of string选填(非实例级别配置)-只能在路由或域名等细粒度规则上配置，对于符合匹配条件的请求，配置允许访问的 consumer，从而实现细粒度的权限控制

注意：

  • 在一个规则里，鉴权配置和认证配置不可同时存在

配置示例

路由粒度配置认证

在route-a和route-b两个路由做如下插件配置：

  1. consumers:
  2. - name: consumer1
  3.   client_id: 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  4.   client_secret: abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx

此时虽然使用同一份配置，但route-a 下签发的凭证无法用于访问 route-b，反之亦然。

如果希望同一份配置共享凭证访问权限，可以做如下配置:

  1. global_credentials: true
  2. consumers:
  3. - name: consumer1
  4.   client_id: 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  5.   client_secret: abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx

全局配置认证，路由粒度进行鉴权

以下配置将对网关特定路由或域名开启 Jwt Auth 认证和鉴权，注意如果一个JWT能匹配多个jwks，则按照配置顺序命中第一个匹配的consumer

在实例级别做如下插件配置：

  1. global_auth: false
  2. consumers:
  3. - name: consumer1
  4.   client_id: 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  5.   client_secret: abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  6. - name: consumer2
  7.   client_id: 87654321-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  8.   client_secret: hgfedcba-xxxx-xxxx-xxxx-xxxxxxxxxxxx

在route-a和route-b两个路由做如下插件配置：

  1. allow:
  2. - consumer1

在*.exmaple.com和test.com两个域名做如下插件配置：

  1. allow:
  2. - consumer2

此例指定的 route-a 和 route-b 即在创建网关路由时填写的路由名称，当匹配到这两个路由时，将允许name为consumer1的调用者访问，其他调用者不允许访问；

此例指定的 *.example.com 和 test.com 用于匹配请求的域名，当发现域名匹配时，将允许name为consumer2的调用者访问，其他调用者不允许访问。

网关实例级别开启

以下配置将对网关实例级别开启 OAuth2 认证，所有请求均需要经过认证后才能访问

  1. global_auth: true
  2. consumers:
  3. - name: consumer1
  4.   client_id: 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  5.   client_secret: abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  6. - name: consumer2
  7.   client_id: 87654321-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  8.   client_secret: hgfedcba-xxxx-xxxx-xxxx-xxxxxxxxxxxx

请求示例

使用 Client Credential 授权模式

获取 AccessToken

  1. # 通过 GET 方法获取（推荐）
  7. # 通过 POST 方法获取（需要先匹配到有真实目标服务的路由，否则网关不会读取请求 Body）
  10. curl ‘http://test.com/oauth2/token‘ -H ‘content-type: application/x-www-form-urlencoded’ -d ‘grant_type=client_credentials&client_id=12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx&client_secret=abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx’
  13. # 获取响应中的 access_token 字段即可:
  14. {
  15.   “token_type”: “bearer”,
  16.   “access_token”: “eyJhbGciOiJIUzI1NiIsInR5cCI6ImFwcGxpY2F0aW9uXC9hdCtqd3QifQ.eyJhdWQiOiJkZWZhdWx0IiwiY2xpZW50X2lkIjoiMTIzNDU2NzgteHh4eC14eHh4LXh4eHgteHh4eHh4eHh4eHh4IiwiZXhwIjoxNjg3OTUxNDYzLCJpYXQiOjE2ODc5NDQyNjMsImlzcyI6IkhpZ3Jlc3MtR2F0ZXdheSIsImp0aSI6IjEwOTU5ZDFiLThkNjEtNGRlYy1iZWE3LTk0ODEwMzc1YjYzYyIsInN1YiI6ImNvbnN1bWVyMSJ9.NkT_rG3DcV9543vBQgneVqoGfIhVeOuUBwLJJ4Wycb0”,
  17.   “expires_in”: 7200
  18. }

使用 AccessToken 请求

  1. curl ‘http://test.com‘ -H ‘Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6ImFwcGxpY2F0aW9uXC9hdCtqd3QifQ.eyJhdWQiOiJkZWZhdWx0IiwiY2xpZW50X2lkIjoiMTIzNDU2NzgteHh4eC14eHh4LXh4eHgteHh4eHh4eHh4eHh4IiwiZXhwIjoxNjg3OTUxNDYzLCJpYXQiOjE2ODc5NDQyNjMsImlzcyI6IkhpZ3Jlc3MtR2F0ZXdheSIsImp0aSI6IjEwOTU5ZDFiLThkNjEtNGRlYy1iZWE3LTk0ODEwMzc1YjYzYyIsInN1YiI6ImNvbnN1bWVyMSJ9.NkT_rG3DcV9543vBQgneVqoGfIhVeOuUBwLJJ4Wycb0’

常见错误码说明

HTTP 状态码出错信息原因说明
401Invalid Jwt token请求头未提供JWT, 或者JWT格式错误，或过期等原因
403Access Denied无权限访问当前路由