Skip to main content
Version: 3.0.0-beta

uri-blocker

描述#

uri-blocker 插件通过指定一系列 block_rules 来拦截用户请求。

属性#

名称类型必选项默认值有效值描述
block_rulesarray[string]正则过滤数组。它们都是正则规则,如果当前请求 URI 命中其中任何一个,则将响应代码设置为 rejected_code 以退出当前用户请求。例如:["root.exe", "root.m+"]
rejected_codeinteger403[200, ...]当请求 URI 命中 block_rules 中的任何一个时,将返回的 HTTP 状态代码。
rejected_msgstring非空当请求 URI 命中 block_rules 中的任何一个时,将返回的 HTTP 响应体。
case_insensitivebooleanfalse是否忽略大小写。当设置为 true 时,在匹配请求 URI 时将忽略大小写。

启用插件#

以下示例展示了如何在指定的路由上启用 uri-blocker 插件:

curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/*",
"plugins": {
"uri-blocker": {
"block_rules": ["root.exe", "root.m+"]
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'

测试插件#

启用并配置插件后,使用 curl 命令尝试访问 block_rules 中指定文件的 URI:

curl -i http://127.0.0.1:9080/root.exe?a=a

如果发现返回了带有 403 状态码的 HTTP 响应头,则代表插件生效:

HTTP/1.1 403 Forbidden
Date: Wed, 17 Jun 2020 13:55:41 GMT
Content-Type: text/html; charset=utf-8
Content-Length: 150
Connection: keep-alive
Server: APISIX web server
...

通过设置属性 rejected_msg 的值为 access is not allowed,将会收到包含如下信息的响应体:

...
{"error_msg":"access is not allowed"}
...

禁用插件#

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

curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/*",
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'