consumer-restriction

描述

consumer-restriction 插件允许用户根据 Route、Service、Consumer 或 Consumer Group 来设置相应的访问限制。

属性

名称类型必选项默认值有效值描述
typestringconsumer_name[“consumer_name”, “consumer_group_id”, “service_id”, “route_id”]支持设置访问限制的对象类型。
whitelistarray[string]加入白名单的对象,优先级高于allowed_by_methods
blacklistarray[string]加入黑名单的对象,优先级高于whitelist
rejected_codeinteger403[200,…]当请求被拒绝时,返回的 HTTP 状态码。
rejected_msgstring当请求被拒绝时,返回的错误信息。
allowed_by_methodsarray[object]一组为 Consumer 设置允许的配置,包括用户名和允许的 HTTP 方法列表。
allowed_by_methods.userstring为 Consumer 设置的用户名。
allowed_by_methods.methodsarray[string][“GET”, “POST”, “PUT”, “DELETE”, “PATCH”, “HEAD”, “OPTIONS”, “CONNECT”, “TRACE”, “PURGE”]为 Consumer 设置的允许的 HTTP 方法列表。
consumer-restriction - 图1note

不同的 type 属性值分别代表以下含义:

  • consumer_name:把 Consumer 的 username 列入白名单或黑名单来限制 Consumer 对 Route 或 Service 的访问。
  • consumer_group_id: 把 Consumer Group 的 id 列入白名单或黑名单来限制 Consumer 对 Route 或 Service 的访问。
  • service_id:把 Service 的 id 列入白名单或黑名单来限制 Consumer 对 Service 的访问,需要结合授权插件一起使用。
  • route_id:把 Route 的 id 列入白名单或黑名单来限制 Consumer 对 Route 的访问。

启用并测试插件

通过 consumer_name 限制访问

首先,创建两个 Consumer,分别为 jack1jack2

consumer-restriction - 图2note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量:

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl http://127.0.0.1:9180/apisix/admin/consumers -H "X-API-KEY: $admin_key" -X PUT -i -d '
  2. {
  3. "username": "jack1",
  4. "plugins": {
  5. "basic-auth": {
  6. "username":"jack2019",
  7. "password": "123456"
  8. }
  9. }
  10. }'
  11. curl http://127.0.0.1:9180/apisix/admin/consumers -H "X-API-KEY: $admin_key" -X PUT -i -d '
  12. {
  13. "username": "jack2",
  14. "plugins": {
  15. "basic-auth": {
  16. "username":"jack2020",
  17. "password": "123456"
  18. }
  19. }
  20. }'

然后,在指定路由上启用并配置 consumer-restriction 插件,并通过将 consumer_name 加入 whitelist 来限制不同 Consumer 的访问:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "127.0.0.1:1980": 1
  8. }
  9. },
  10. "plugins": {
  11. "basic-auth": {},
  12. "consumer-restriction": {
  13. "whitelist": [
  14. "jack1"
  15. ]
  16. }
  17. }
  18. }'

测试插件

jack1 发出访问请求,返回 200 HTTP 状态码,代表访问成功:

  1. curl -u jack2019:123456 http://127.0.0.1:9080/index.html -i
  1. HTTP/1.1 200 OK

jack2 发出访问请求,返回 403 HTTP 状态码,代表访问被限制,插件生效:

  1. curl -u jack2020:123456 http://127.0.0.1:9080/index.html -i
  1. HTTP/1.1 403 Forbidden
  2. ...
  3. {"message":"The consumer_name is forbidden."}

通过 allowed_by_methods 限制访问

首先,创建两个 Consumer,分别为 jack1jack2,创建方法请参考通过 consumer_name 限制访问

然后,在指定路由上启用并配置 consumer-restriction 插件,并且仅允许 jack1 使用 POST 方法进行访问:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "127.0.0.1:1980": 1
  8. }
  9. },
  10. "plugins": {
  11. "basic-auth": {},
  12. "consumer-restriction": {
  13. "allowed_by_methods":[{
  14. "user": "jack1",
  15. "methods": ["POST"]
  16. }]
  17. }
  18. }
  19. }'

测试插件

jack1 发出访问请求,返回 403 HTTP 状态码,代表访问被限制:

  1. curl -u jack2019:123456 http://127.0.0.1:9080/index.html
  1. HTTP/1.1 403 Forbidden
  2. ...
  3. {"message":"The consumer_name is forbidden."}

现在更新插件配置,增加 jack1GET 访问能力:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "127.0.0.1:1980": 1
  8. }
  9. },
  10. "plugins": {
  11. "basic-auth": {},
  12. "consumer-restriction": {
  13. "allowed_by_methods":[{
  14. "user": "jack1",
  15. "methods": ["POST","GET"]
  16. }]
  17. }
  18. }
  19. }'

jack1 再次发出访问请求,返回 200 HTTP 状态码,代表访问成功:

  1. curl -u jack2019:123456 http://127.0.0.1:9080/index.html
  1. HTTP/1.1 200 OK

通过 service_id 限制访问

使用 service_id 的方式需要与授权插件一起配合使用,这里以 key-auth 授权插件为例。

首先,创建两个 Service:

  1. curl http://127.0.0.1:9180/apisix/admin/services/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "upstream": {
  4. "nodes": {
  5. "127.0.0.1:1980": 1
  6. },
  7. "type": "roundrobin"
  8. },
  9. "desc": "new service 001"
  10. }'
  11. curl http://127.0.0.1:9180/apisix/admin/services/2 -H "X-API-KEY: $admin_key" -X PUT -d '
  12. {
  13. "upstream": {
  14. "nodes": {
  15. "127.0.0.1:1980": 1
  16. },
  17. "type": "roundrobin"
  18. },
  19. "desc": "new service 002"
  20. }'

在指定 Consumer 上配置 key-authconsumer-restriction 插件,并通过将 service_id 加入 whitelist 来限制 Consumer 对 Service 的访问:

  1. curl http://127.0.0.1:9180/apisix/admin/consumers -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "username": "new_consumer",
  4. "plugins": {
  5. "key-auth": {
  6. "key": "auth-jack"
  7. },
  8. "consumer-restriction": {
  9. "type": "service_id",
  10. "whitelist": [
  11. "1"
  12. ],
  13. "rejected_code": 403
  14. }
  15. }
  16. }'

测试插件

在指定路由上启用并配置 key-auth 插件,并绑定 service_id1

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "127.0.0.1:1980": 1
  8. }
  9. },
  10. "service_id": 1,
  11. "plugins": {
  12. "key-auth": {
  13. }
  14. }
  15. }'

对 Service 发出访问请求,返回 403 HTTP 状态码,说明在白名单列中的 service_id 允许访问,插件生效:

  1. curl http://127.0.0.1:9080/index.html -H 'apikey: auth-jack' -i
  1. HTTP/1.1 200 OK

更新配置 key-auth 插件,并绑定 service_id2

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "127.0.0.1:1980": 1
  8. }
  9. },
  10. "service_id": 2,
  11. "plugins": {
  12. "key-auth": {
  13. }
  14. }
  15. }'

再次对 Service 发出访问请求,返回 403 HTTP 状态码,说明不在白名单列表的 service_id 被拒绝访问,插件生效:

  1. curl http://127.0.0.1:9080/index.html -H 'apikey: auth-jack' -i
  1. HTTP/1.1 403 Forbidden
  2. ...
  3. {"message":"The service_id is forbidden."}

删除插件

当你需要删除该插件时,可以通过以下命令删除相应的 JSON 配置,APISIX 将会自动重新加载相关配置,无需重启服务:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "127.0.0.1:1980": 1
  8. }
  9. },
  10. "plugins": {
  11. "basic-auth": {}
  12. }
  13. }'