跳到主要内容
版本:3.8.x

基于列表控制访问

有时,你需要比身份认证插件所提供的更精细的访问控制。例如,你可能希望维护一份允许访问 API 的消费者白名单。此时,消费者必须发送经过身份认证的请求、位于白名单中且不在黑名单中,才能访问 API。

备注

实施基于消费者的访问控制前,请考虑 API Portal 是否是更合适的解决方案。

本教程指导你通过 consumer-restriction 插件创建消费者白名单,以配置精细的访问控制。

前提条件​

  1. 安装 API7 企业版。
  2. 创建启用了 key-auth 的路由。
  3. 创建具有凭证的消费者 alice。

应用消费者白名单​

消费者发送经过身份认证的请求时,API7 Gateway 会将消费者名称传递给路由。因此,路由无需直接访问消费者凭证,使用起来更加方便。

  1. 在侧边导航栏中选择网关组的 Published Services,然后选择要配置的服务,例如版本为 1.0.0 的 httpbin。
  2. 在侧边导航栏中选择 Plugins,然后点击 Add Plugin。
  3. 搜索 Consumer Restriction 插件,然后点击 Add。
  4. 在对话框中执行以下操作:
  • 在 JSON Editor 中添加以下配置:

    {
    "whitelist": [
    "Alice"
    ]
    }

    如果你完成了前提条件中的教程,就已创建了具有 Key Authentication 凭证的消费者 Alice。

  • 点击 Add。

  1. 创建一个具有 Key Authentication 凭证的新消费者 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. 在侧边导航栏中选择网关组的 Published Services,然后选择要配置的服务,例如版本为 1.0.0 的 httpbin。
  2. 在侧边导航栏中选择 Plugins,然后点击 Add Plugin。
  3. 搜索 consumer-restriction 插件,然后点击 Add。
  4. 在对话框中执行以下操作:
  • 在 JSON Editor 中添加以下配置:

    {
    "blacklist": [
    "Lisa"
    ]
    }

    如果你完成了前提条件中的教程,就已创建了具有 Key Authentication 凭证的消费者 Alice。

  • 点击 Add。

  1. 创建一个具有 Key Authentication 凭证的新消费者 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."}

其他资源​