基于黑白名单的访问控制
有时,身份验证插件提供的访问控制还不够精细。例如,你可以用白名单指定哪些消费者可以访问 API。消费者必须发送经过身份验证的请求,同时在白名单中且不在黑名单中,才能访问 API。
本教程介绍如何使用 consumer-restriction 插件创建消费者白名单,实现更精细的访问控制。
前提条件
应用消费者白名单
消费者发送经过身份验证的请求时,API7 网关会将消费者名称传递给路由,简化了访问控制流程,路由无需直接读取消费者凭据。
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的已发布服务,然后选择要配置的服务,例如版本为
1.0.0的httpbin。 - 从侧边栏选择插件,然后点击启用插件。
- 搜索消费者限制插件,然后点击启用。
- 在对话框中完成以下操作。
-
将以下配置添加到 JSON 编辑器。
{"whitelist": ["Alice"]}如果你已按前提条件中的教程操作,此时应该已有一个配置了密钥认证凭据的消费者
Alice。 -
点击启用。
- 创建一个名为
Lisa的消费者,并添加密钥认证凭据,将 Key 设置为lisa-key。
按以下示例更新 ADC 配置。
services:
- name: httpbin
upstream:
name: default
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
plugins:
consumer-restriction:
whitelist:
- Alice
consumers:
- username: Alice
credentials:
- name: primary-key
type: key-auth
config:
key: alice-primary-key
- username: Lisa
credentials:
- name: lisa-key
type: key-auth
config:
key: lisa-key
将配置同步到 API7 企业版。
adc sync -f adc.yaml
Ingress Controller 目前不支持 ApisixService 资源。
要在路由上配置 consumer-restriction 插件,请按以下示例更新该路由的 Kubernetes 清单文件。
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin
namespace: api7 # replace with your namespace
spec:
http:
- name: get-ip
match:
paths:
- /ip
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- name: consumer-restriction
enable: true
config:
whitelist:
- alice
创建另一个 Kubernetes 清单文件,使用 ApisixConsumer 自定义资源配置消费者 lisa。
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
name: lisa
namespace: api7 # replace with your namespace
spec:
authParameter:
keyAuth:
value:
key: "lisa-key"
将这些配置应用到集群。
kubectl apply -f httpbin-route.yaml -f consumer.yaml
验证
以消费者 Alice 的身份向服务发送请求。
curl -i "http://127.0.0.1:9080/ip" -H "apikey: alice-primary-key"
由于 Alice 在白名单中,请求会成功并返回 200 OK。
接着,以新创建的消费者 Lisa 的身份向服务发送请求。
curl -i "http://127.0.0.1:9080/ip" -H "apikey: lisa-key"
由于 Lisa 不在白名单中,你会收到 403 Forbidden 和以下响应正文。
{"message":"The consumer_name is forbidden."}
应用消费者黑名单
consumer-restriction 插件决定是否授予访问权限时,会优先检查黑名单。
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的已发布服务,然后选择要配置的服务,例如版本为
1.0.0的httpbin。 - 从侧边栏选择插件,然后点击启用插件。
- 搜索
consumer-restriction插件,然后点击启用。 - 在对话框中完成以下操作。
-
将以下配置添加到 JSON 编辑器。
{"blacklist": ["Lisa"]}如果你已按前提条件中的教程操作,此时应该已有一个配置了密钥认证凭据的消费者
Alice。 -
点击启用。
- 创建一个名为
Lisa的消费者,并添加密钥认证凭据,将 Key 设置为lisa-key。
按以下示例更新 ADC 配置。
services:
- name: httpbin Service
upstream:
name: default
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
plugins:
consumer-restriction:
blacklist:
- Lisa
consumers:
- username: Alice
credentials:
- name: alice-primary-key
type: key-auth
config:
key: alice-primary-key
- username: Lisa
credentials:
- name: lisa-primary-key
type: key-auth
config:
key: lisa-key
将配置同步到 API7 企业版。
adc sync -f adc.yaml
Ingress Controller 目前不支持 ApisixService 资源。
要在路由上配置 consumer-restriction 插件,请按以下示例更新该路由的 Kubernetes 清单文件。
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin
namespace: api7 # replace with your namespace
spec:
http:
- name: get-ip
match:
paths:
- /ip
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- name: consumer-restriction
enable: true
config:
blacklist:
- lisa
创建另一个 Kubernetes 清单文件,使用 ApisixConsumer 自定义资源配置消费者 lisa。
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
name: lisa
namespace: api7 # replace with your namespace
spec:
authParameter:
keyAuth:
value:
key: "lisa-key"
将这些配置应用到集群。
kubectl apply -f httpbin-route.yaml -f consumer.yaml
验证
以消费者 Alice 的身份向服务发送请求。
curl -i "http://127.0.0.1:9080/ip" -H "apikey: alice-primary-key"
由于 Alice 不在黑名单中,请求会成功并返回 200 OK。
接着,以新创建的消费者 Lisa 的身份向服务发送请求。
curl -i "http://127.0.0.1:9080/ip" -H "apikey: lisa-key"
由于 Lisa 在黑名单中,你会收到 403 Forbidden 和以下响应正文。
{"message":"The consumer_name is forbidden."}