如何配置OAuth2插件-阿里云帮助中心

OAuth2插件实现了基于JWT（JSON Web Tokens）进行OAuth2 Access Token签发的能力, 遵循RFC9068规范。本文介绍如何配置OAuth2插件。

插件类型

认证鉴权。

插件配置说明

配置字段

认证配置

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

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

名称	数据类型	填写要求	默认值	描述
name	string	必填	-	配置该consumer的名称。
client_id	string	必填	-	OAuth2 client id。
client_secret	string	必填	-	OAuth2 client secret。

重要

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

鉴权配置（非必需）

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

重要

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

配置示例

路由粒度配置认证

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

consumers:
- name: consumer1
  client_id: 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  client_secret: abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

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

global_credentials: true
consumers:
- name: consumer1
  client_id: 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  client_secret: abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

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

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

global_auth: false
consumers:
- name: consumer1
  client_id: 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  client_secret: abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- name: consumer2
  client_id: 87654321-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  client_secret: hgfedcba-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

allow:
- consumer1

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

allow:
- consumer2

说明

此例指定的route-a和route-b即在创建网关路由时填写的路由名称，当匹配到这两个路由时，将允许name为consumer1的调用者访问，其他调用者不允许访问。
此例指定的*.example.com和test.com用于匹配请求的域名，当发现域名匹配时，将允许name为consumer2的调用者访问，其他调用者不允许访问。

网关实例级别开启

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

global_auth: true
consumers:
- name: consumer1
  client_id: 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  client_secret: abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- name: consumer2
  client_id: 87654321-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  client_secret: hgfedcba-xxxx-xxxx-xxxx-xxxxxxxxxxxx

请求示例

使用 Client Credential 授权模式

获取 AccessToken

# 通过 GET 方法获取（推荐）
curl 'http://test.com/oauth2/token?grant_type=client_credentials&client_id=12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx&client_secret=abcdefgh-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

# 通过 POST 方法获取（需要先匹配到有真实目标服务的路由，否则网关不会读取请求 Body）
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'

# 获取响应中的 access_token 字段即可:
{
  "token_type": "bearer",
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6ImFwcGxpY2F0aW9uXC9hdCtqd3QifQ.eyJhdWQiOiJkZWZhdWx0IiwiY2xpZW50X2lkIjoiMTIzNDU2NzgteHh4eC14eHh4LXh4eHgteHh4eHh4eHh4eHh4IiwiZXhwIjoxNjg3OTUxNDYzLCJpYXQiOjE2ODc5NDQyNjMsImlzcyI6IkhpZ3Jlc3MtR2F0ZXdheSIsImp0aSI6IjEwOTU5ZDFiLThkNjEtNGRlYy1iZWE3LTk0ODEwMzc1YjYzYyIsInN1YiI6ImNvbnN1bWVyMSJ9.NkT_rG3DcV9543vBQgneVqoGfIhVeOuUBwLJJ4Wycb0",
  "expires_in": 7200
}

使用 AccessToken 请求

curl 'http://test.com' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6ImFwcGxpY2F0aW9uXC9hdCtqd3QifQ.eyJhdWQiOiJkZWZhdWx0IiwiY2xpZW50X2lkIjoiMTIzNDU2NzgteHh4eC14eHh4LXh4eHgteHh4eHh4eHh4eHh4IiwiZXhwIjoxNjg3OTUxNDYzLCJpYXQiOjE2ODc5NDQyNjMsImlzcyI6IkhpZ3Jlc3MtR2F0ZXdheSIsImp0aSI6IjEwOTU5ZDFiLThkNjEtNGRlYy1iZWE3LTk0ODEwMzc1YjYzYyIsInN1YiI6ImNvbnN1bWVyMSJ9.NkT_rG3DcV9543vBQgneVqoGfIhVeOuUBwLJJ4Wycb0'

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

oauth插件