uri-blocker

目录

定义

该插件可帮助我们拦截用户请求，只需要指定block_rules即可。

属性列表

名称 类型 必选项 默认值 有效值 描述
block_rules array[string] 必须 正则过滤数组。它们都是正则规则，如果当前请求 URI 命中任何一个，请将响应代码设置为 rejected_code 以退出当前用户请求。例如: ["root.exe", "root.m+"]。
rejected_code integer 可选 403 [200, …] 当请求 URI 命中block_rules中的任何一个时，将返回的 HTTP 状态代码.

启用方式

这是一个示例，在指定的路由上启用uri blocker插件：

  1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/*",
  4.     "plugins": {
  5.         "uri-blocker": {
  6.             "block_rules": ["root.exe", "root.m+"]
  7.         }
  8.     },
  9.     "upstream": {
  10.         "type": "roundrobin",
  11.         "nodes": {
  12.             "127.0.0.1:1980": 1
  13.         }
  14.     }
  15. }'

测试插件

  1. $ curl -i http://127.0.0.1:9080/root.exe?a=a
  2. HTTP/1.1 403 Forbidden
  3. Date: Wed, 17 Jun 2020 13:55:41 GMT
  4. Content-Type: text/html; charset=utf-8
  5. Content-Length: 150
  6. Connection: keep-alive
  7. Server: APISIX web server
  9. ... ...

禁用插件

当想禁用uri blocker插件时，非常简单，只需要在插件配置中删除相应的 json 配置，无需重启服务，即可立即生效：

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/*",
  4.     "upstream": {
  5.         "type": "roundrobin",
  6.         "nodes": {
  7.             "127.0.0.1:1980": 1
  8.         }
  9.     }
  10. }'

uri blocker 插件现在已被禁用，它也适用于其他插件。