ua-restriction

目录

名字

ua-restriction 可以通过将指定 User-Agent 列入白名单或黑名单的方式来限制对服务或接口的访问。

属性

参数名类型可选项默认值有效值描述
bypass_missingboolean可选falseUser-Agent 不存在时是否绕过检查
allowlistarray[string]可选加入白名单的 User-Agent
denylistarray[string]可选加入黑名单的 User-Agent
messagestring可选Not allowed.长度限制：[1, 1024]在未允许的 User-Agent 访问的情况下返回的信息

白名单或黑名单可以同时启用，此插件对 User-Agent 的检查先后顺序依次如下：白名单、黑名单。message可以由用户自定义。

如何启用

下面是一个示例，在指定的 route 上开启了 ua-restriction 插件:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/index.html",    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:1980": 1        }    },    "plugins": {        "ua-restriction": {            "bypass_missing": true,             "allowlist": [                 "my-bot1",                 "(Baiduspider)/(\\d+)\\.(\\d+)"             ],             "denylist": [                 "my-bot2",                 "(Twitterspider)/(\\d+)\\.(\\d+)"             ]        }    }}'

当未允许的 User-Agent 访问时，默认返回{"message":"Not allowed"}。如果你想使用自定义的message，可以在插件部分进行配置:

  1. "plugins": {    "ua-restriction": {        "denylist": [            "my-bot2",            "(Twitterspider)/(\\d+)\\.(\\d+)"        ],        "message": "Do you want to do something bad?"    }}

测试插件

通过正常的 UA 访问：

  1. $ curl http://127.0.0.1:9080/index.html --header 'User-Agent: YourApp/2.0.0'HTTP/1.1 200 OK

通过爬虫 User-Agent 访问：

  1. $ curl http://127.0.0.1:9080/index.html --header 'User-Agent: Twitterspider/2.0'HTTP/1.1 403 Forbidden

禁用插件

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

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/index.html",    "plugins": {},    "upstream": {        "type": "roundrobin",        "nodes": {            "39.97.63.215:80": 1        }    }}'

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