Skip to main content
Version: 2.14

uri-blocker

描述#

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

属性#

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

启用方式#

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

curl -i http://127.0.0.1:9080/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 -i http://127.0.0.1:9080/root.exe?a=a
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" ,将会收到如下的响应体:

$ curl -i http://127.0.0.1:9080/root.exe?a=a
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

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

禁用插件#

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

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

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