管理消费者的访问凭证
消费者是使用你的 API 的应用或开发者。在 API 的服务上启用身份验证可以控制访问,要求消费者先取得访问凭证,再访问路由。
服务上启用的身份验证插件相当于 API 的锁,消费者的访问凭证则是开锁的钥匙。在 API7 网关中,创建消费者需要唯一的用户名和至少一个访问凭证。
本教程介绍如何创建消费者并配置密钥认证。
前提条件
添加启用了密钥认证的消费者
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的 消费者。
- 点击 新增消费者。
- 在对话框中执行以下操作:
- 在 名称字段中输入
Alice。 - 点击 添加。
- 在 插件字段中点击 启用插件。
- 搜索
key-auth插件,然后点击 启用。 - 在对话框中执行以下操作:
-
将以下配置添加到 JSON 编辑器:
{"key": "secret-key"} -
点击 启用。
要使用 ADC 在同一个网关组中创建消费者和 API,请按以下示例更新配置:
adc.yaml
services:
- name: httpbin
upstream:
name: default
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
routes:
- uris:
- /ip
name: get-ip
methods:
- GET
consumers:
- username: Alice
plugins:
key-auth:
_meta:
disable: false
key: secret-key
将配置同步到 API7 网关:
adc sync -f adc.yaml
创建 Kubernetes 清单文件,使用 ApisixConsumer 自定义资源配置消费者:
consumer.yaml
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
name: alice
# namespace: api7 # replace with your namespace
spec:
authParameter:
keyAuth:
value:
key: "secret-key"
将配置应用到集群:
kubectl apply -f consumer.yaml
验证
按以下步骤验证密钥认证。
发送不带密钥的请求
发送不含 apikey 请求头的请求:
curl -i "http://127.0.0.1:9080/ip"
由于未提供密钥,你将收到 HTTP/1.1 401 Unauthorized 响应,正文如下:
{"message":"Missing API key found in request"}
发送带有错误密钥的请求
在 apikey 请求头中使用错误的密钥发送请求:
curl -i "http://127.0.0.1:9080/ip" -H "apikey: wrongkey"
由于密钥错误,你将收到 HTTP/1.1 401 Unauthorized 响应,正文如下:
{"message":"Invalid API key in request"}
发送带有正确密钥的请求
在 apikey 请求头中使用正确的密钥发送请求:
curl -i "http://127.0.0.1:9080/ip" -H "apikey: secret-key"
使用正确的密钥发送请求后,你将收到 HTTP/1.1 200 OK 响应,正文如下:
{
"origin": "192.168.0.102, 35.259.159.12"
}
相关阅读
- 核心概念
- API 安全
- API 消费