跳到主要内容
版本:3.2.16.6

基于黑白名单的访问控制

有时,身份验证插件提供的访问控制还不够精细。例如,你可以用白名单指定哪些消费者可以访问 API。消费者必须发送经过身份验证的请求,同时在白名单中且不在黑名单中,才能访问 API。

本教程介绍如何使用 consumer-restriction 插件创建消费者白名单,实现更精细的访问控制。

前提条件​

  1. 安装 API7 企业版。
  2. 在网关组中运行一个 API。
  3. 拥有一个已配置凭据的消费者。

应用消费者白名单​

消费者发送经过身份验证的请求时,API7 网关会将消费者名称传递给路由,简化了访问控制流程,路由无需直接读取消费者凭据。

  1. 从侧边栏选择网关组的已发布服务,然后选择要配置的服务,例如版本为 1.0.0 的 httpbin。
  2. 从侧边栏选择插件,然后点击启用插件。
  3. 搜索消费者限制插件,然后点击启用。
  4. 在对话框中完成以下操作。
  • 将以下配置添加到 JSON 编辑器。

    {
    "whitelist": [
    "Alice"
    ]
    }

    如果你已按前提条件中的教程操作,此时应该已有一个配置了密钥认证凭据的消费者 Alice。

  • 点击启用。

  1. 创建一个名为 Lisa 的消费者,并添加密钥认证凭据,将 Key 设置为 lisa-key。

验证​

以消费者 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 插件决定是否授予访问权限时,会优先检查黑名单。

  1. 从侧边栏选择网关组的已发布服务,然后选择要配置的服务,例如版本为 1.0.0 的 httpbin。
  2. 从侧边栏选择插件,然后点击启用插件。
  3. 搜索 consumer-restriction 插件,然后点击启用。
  4. 在对话框中完成以下操作。
  • 将以下配置添加到 JSON 编辑器。

    {
    "blacklist": [
    "Lisa"
    ]
    }

    如果你已按前提条件中的教程操作,此时应该已有一个配置了密钥认证凭据的消费者 Alice。

  • 点击启用。

  1. 创建一个名为 Lisa 的消费者,并添加密钥认证凭据,将 Key 设置为 lisa-key。

验证​

以消费者 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."}

相关阅读​