Key 认证
功能说明
key-auth插件实现了基于 API Key 进行认证鉴权的功能，支持从 HTTP 请求的 URL 参数或者请求头解析 API Key，同时验证该 API Key 是否有权限访问。
运行属性
插件执行阶段：认证阶段
插件执行优先级：310
配置字段
全局配置
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
consumers | array of object | 必填 | - | 配置服务的调用者，用于对请求进行认证 |
keys | array of string | 必填 | - | API Key 的来源字段名称，可以是 URL 参数或者 HTTP 请求头名称 |
in_query | bool | in_query 和 in_header 至少有一个为 true | true | 配置 true 时，网关会尝试从 URL 参数中解析 API Key |
in_header | bool | in_query 和 in_header 至少有一个为 true | true | 配置 true 时，网关会尝试从 HTTP 请求头中解析 API Key |
global_auth | bool | 选填 | - | 若配置为true，则全局生效认证机制; 若配置为false，则只对做了配置的域名和路由生效认证机制; 若不配置则仅当没有域名和路由配置时全局生效（兼容机制） |
consumers中每一项的配置字段说明如下：
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
credential | string | 必填 | - | 配置该consumer的访问凭证 |
name | string | 必填 | - | 配置该consumer的名称 |
域名和路由级配置
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
allow | array of string | 必填 | - | 对于符合匹配条件的请求，配置允许访问的consumer名称 |
注意：
- 对于通过认证鉴权的请求，请求的header会被添加一个
X-Mse-Consumer字段，用以标识调用者的名称。
配置示例
对特定路由或域名开启
以下配置将对网关特定路由或域名开启 Key Auth 认证和鉴权，注意credential字段不能重复
全局配置
consumers:
- credential: 2bda943c-ba2b-11ec-ba07-00163e1250b5
name: consumer1
- credential: c8c8e9ca-558e-4a2d-bb62-e700dcc40e35
name: consumer2
keys:
- apikey
in_query: true
global_auth: false
路由级配置
对 route-a 和 route-b 这两个路由做如下配置：
allow:
- consumer1
对 *.exmaple.com 和 test.com 在这两个域名做如下配置:
allow:
- consumer2
若是在控制台进行配置，此例指定的 route-a 和 route-b 即在控制台创建路由时填写的路由名称，当匹配到这两个路由时，将允许name为consumer1的调用者访问，其他调用者不允许访问；
此例指定的 *.example.com 和 test.com 用于匹配请求的域名，当发现域名匹配时，将允许name为consumer2的调用者访问，其他调用者不允许访问。
根据该配置，下列请求可以允许访问：
假设以下请求会匹配到route-a这条路由
将 API Key 设置在 url 参数中
curl http://xxx.hello.com/test?apikey=2bda943c-ba2b-11ec-ba07-00163e1250b5
将 API Key 设置在 http 请求头中
curl http://xxx.hello.com/test -H 'x-api-key: 2bda943c-ba2b-11ec-ba07-00163e1250b5'
认证鉴权通过后，请求的header中会被添加一个X-Mse-Consumer字段，在此例中其值为consumer1，用以标识调用方的名称
下列请求将拒绝访问：
请求未提供 API Key，返回401
curl http://xxx.hello.com/test
请求提供的 API Key 无权访问，返回401
curl http://xxx.hello.com/test?apikey=926d90ac-ba2e-11ec-ab68-00163e1250b5
根据请求提供的 API Key匹配到的调用者无访问权限，返回403
# consumer2不在route-a的allow列表里
curl http://xxx.hello.com/test?apikey=c8c8e9ca-558e-4a2d-bb62-e700dcc40e35
相关错误码
| HTTP 状态码 | 出错信息 | 原因说明 |
|---|---|---|
| 401 | No API key found in request | 请求未提供 API Key |
| 401 | Request denied by Key Auth check. Invalid API key | 不允许当前 API Key 访问 |
| 403 | Request denied by Basic Auth check. Unauthorized consumer | 请求的调用方无访问权限 |