基于列表控制访问
有时,你需要比身份认证插件所提供的更精细的访问控制。例如,你可能希望维护一份允许访问 API 的消费者白名单。此时,消费者必须发送经过身份认证的请求、位于白名单中且不在黑名单中,才能访问 API。
实施基于消费者的访问控制前,请考虑 API Portal 是否是更合适的解决方案。
本教程指导你通过 consumer-restriction 插件创建消费者白名单,以配置精细的访问控制。
前提条件
应用消费者白名单
消费者发送经过身份认证的请求时,API7 Gateway 会将消费者名称传递给路由。因此,路由无需直接访问消费者凭证,使用起来更加方便。
- 控制台
- ADC
- Ingress Controller
- 在侧边导航栏中选择网关组的 Published Services,然后选择要配置的服务,例如版本为
1.0.0的httpbin。 - 在侧边导航栏中选择 Plugins,然后点击 Add Plugin。
- 搜索 Consumer Restriction 插件,然后点击 Add。
- 在对话框中执行以下操作:
-
在 JSON Editor 中添加以下配置:
{"whitelist": ["Alice"]}如果你完成了前提条件中的教程,就已创建了具有 Key Authentication 凭证的消费者
Alice。 -
点击 Add。
- 创建一个具有 Key Authentication 凭证的新消费者
Lisa,并将 Key 设为lisa-key。
按以下方式更新 ADC 配置:
services:
- name: httpbin
upstream:
name: default
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
plugins:
key-auth:
_meta:
disable: false
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
- Gateway API
- APISIX CRD
创建用于路由的 Kubernetes 清单文件(同时创建服务),并在服务上启用 consumer-restriction 和 key-auth 插件:
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
namespace: api7
name: consumer-restriction-key-auth-plugin-config
spec:
plugins:
- name: key-auth
- name: consumer-restriction
config:
whitelist:
- api7_alice
---
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
namespace: api7
name: httpbin
spec:
parentRefs:
- name: apisix
rules:
- matches:
- path:
type: Exact
value: /ip
filters:
- type: ExtensionRef
extensionRef:
group: apisix.apache.org
kind: PluginConfig
name: consumer-restriction-key-auth-plugin-config
backendRefs:
- name: httpbin
port: 80
❶ Ingress Controller 创建的实际消费者名称带有命名空间前缀。请相应更新白名单中的消费者名称。
创建另一个 Kubernetes 清单文件,配置消费者 lisa:
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
namespace: api7
name: lisa
spec:
gatewayRef:
name: apisix
credentials:
- type: key-auth
name: lisa-key
config:
key: lisa-key
将配置应用到集群:
kubectl apply -f consumer-restriction-route.yaml -f consumer-lisa-key-auth.yaml
创建用于路由的 Kubernetes 清单文件(同时创建服务),并在路由上启用 consumer-restriction 和 key-auth 插件:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
namespace: api7
name: httpbin
spec:
ingressClassName: apisix
http:
- name: get-ip
match:
paths:
- /ip
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- name: key-auth
enable: true
- name: consumer-restriction
enable: true
config:
whitelist:
- api7_alice
❶ Ingress Controller 创建的实际消费者名称带有命名空间前缀。请相应更新白名单中的消费者名称。
创建另一个 Kubernetes 清单文件,配置消费者 lisa:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
namespace: api7
name: lisa
spec:
ingressClassName: apisix
authParameter:
keyAuth:
value:
key: lisa-key
将配置应用到集群:
kubectl apply -f consumer-restriction-route.yaml -f consumer-lisa-key-auth.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
- 在侧边导航栏中选择网关组的 Published Services,然后选择要配置的服务,例如版本为
1.0.0的httpbin。 - 在侧边导航栏中选择 Plugins,然后点击 Add Plugin。
- 搜索
consumer-restriction插件,然后点击 Add。 - 在对话框中执行以下操作:
-
在 JSON Editor 中添加以下配置:
{"blacklist": ["Lisa"]}如果你完成了前提条件中的教程,就已创建了具有 Key Authentication 凭证的消费者
Alice。 -
点击 Add。
- 创建一个具有 Key Authentication 凭证的新消费者
Lisa,并将 Key 设为lisa-key。
按以下方式更新 ADC 配置:
services:
- name: httpbin
upstream:
name: default
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
plugins:
key-auth:
_meta:
disable: false
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-key
type: key-auth
config:
key: lisa-key
将配置同步到 API7 企业版:
adc sync -f adc.yaml
创建用于路由的 Kubernetes 清单文件(同时创建服务),并启用 consumer-restriction 和 key-auth 插件:
- Gateway API
- APISIX CRD
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
namespace: api7
name: consumer-restriction-key-auth-plugin-config
spec:
plugins:
- name: key-auth
- name: consumer-restriction
config:
blacklist:
- api7_lisa
---
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
namespace: api7
name: httpbin
spec:
parentRefs:
- name: apisix
rules:
- matches:
- path:
type: Exact
value: /ip
filters:
- type: ExtensionRef
extensionRef:
group: apisix.apache.org
kind: PluginConfig
name: consumer-restriction-key-auth-plugin-config
backendRefs:
- name: httpbin
port: 80
❶ Ingress Controller 创建的实际消费者名称带有命名空间前缀。请相应更新黑名单中的消费者名称。
创建另一个用于消费者 lisa 的 Kubernetes 清单文件:
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
namespace: api7
name: lisa
spec:
gatewayRef:
name: apisix
credentials:
- type: key-auth
name: lisa-key
config:
key: lisa-key
将配置应用到集群:
kubectl apply -f consumer-restriction-route.yaml -f consumer.yaml
创建用于路由的 Kubernetes 清单文件(同时创建服务),并在路由上启用 consumer-restriction 和 key-auth 插件:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
namespace: api7
name: httpbin
spec:
ingressClassName: apisix
http:
- name: get-ip
match:
paths:
- /ip
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- name: key-auth
enable: true
- name: consumer-restriction
enable: true
config:
blacklist:
- api7_lisa
❶ Ingress Controller 创建的实际消费者名称带有命名空间前缀。请相应更新黑名单中的消费者名称。
创建另一个 Kubernetes 清单文件,配置消费者 lisa:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
namespace: api7
name: lisa
spec:
ingressClassName: apisix
authParameter:
keyAuth:
value:
key: lisa-key
将配置应用到集群:
kubectl apply -f consumer-restriction-route.yaml -f consumer-lisa-key-auth.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."}
其他资源
- 核心概念
- API 安全
- API 消费
- 插件中心