consumer-restriction

描述

consumer-restriction 根据选择的不同对象做相应的访问限制。

属性

参数名类型可选项默认值有效值描述
typestring可选consumer_name[“consumer_name”, “service_id”, “route_id”]根据不同的对象做相应的限制,支持 consumer_nameservice_idroute_id
whitelistarray[string]必选blacklist二选一,只能单独启用白名单或黑名单,两个不能一起使用。
blacklistarray[string]必选whitelist二选一,只能单独启用白名单或黑名单,两个不能一起使用。
rejected_codeinteger可选403[200,…]当请求被拒绝时,返回的 HTTP 状态码。
rejected_msgString可选当请求被拒绝时,返回的消息内容。
allowed_by_methodsarray[object]可选为用户设置允许的HTTP methods列表 , HTTP methods 可以为 [“GET”, “POST”, “PUT”, “DELETE”, “PATCH”, “HEAD”, “OPTIONS”, “CONNECT”, “TRACE”]

对于 type 字段是个枚举类型,它可以是 consumer_nameservice_id 。分别代表以下含义:

  • consumer_name:把 consumerusername 列入白名单或黑名单(支持单个或多个 consumer)来限制对服务或路线的访问。
  • service_id:把 serviceid 列入白名单或黑名单(支持一个或多个 service)来限制 service 的访问,需要结合授权插件一起使用。

示例

如何限制 consumer_name

下面是一个示例,在指定的 route 上开启了 consumer-restriction 插件,限制 consumer 访问:

  1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
  12. {
  13. "username": "jack2",
  14. "plugins": {
  15. "basic-auth": {
  16. "username":"jack2020",
  17. "password": "123456"
  18. }
  19. }
  20. }'
  21. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  22. {
  23. "uri": "/index.html",
  24. "upstream": {
  25. "type": "roundrobin",
  26. "nodes": {
  27. "127.0.0.1:1980": 1
  28. }
  29. },
  30. "plugins": {
  31. "basic-auth": {},
  32. "consumer-restriction": {
  33. "whitelist": [
  34. "jack1"
  35. ]
  36. }
  37. }
  38. }'

测试插件

jack1 访问:

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

jack2 访问:

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

如何限制 allowed_by_methods

下面是一个示例,在指定的 route 上开启了 consumer-restriction 插件,限制 jack1 只能使用 POST 进行访问:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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 访问:

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

增加 jack1 GET 访问能力:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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 访问:

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

如何限制 service_id

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

1、创建两个 service

  1. curl http://127.0.0.1:9080/apisix/admin/services/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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:9080/apisix/admin/services/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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. }'

2、在 consumer 上绑定 consumer-restriction 插件(需要与一个授权插件配合才能绑定),并添加 service_id 白名单列表

  1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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. }'

3、在 route 上开启 key-auth 插件并绑定 service_id1

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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. }'

测试插件

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

说明在白名单列中的 service_id 允许访问,插件配置生效。

4、在 route 上开启 key-auth 插件并绑定 service_id2

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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. }'

测试插件

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

说明不在白名单列表的 service_id 被拒绝访问,插件配置生效。

禁用插件

当你想去掉 consumer-restriction 插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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. }'

现在就已移除 consumer-restriction 插件,其它插件的开启和移除也类似。