ua-restriction

描述

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

一种常见的场景是用来设置爬虫规则。User-Agent 是客户端在向服务器发送请求时的身份标识,用户可以将一些爬虫程序的请求头列入 ua-restriction 插件的白名单或黑名单中。

属性

名称类型必选项默认值有效值描述
allowlistarray[string]加入白名单的 User-Agent
denylistarray[string]加入黑名单的 User-Agent
messagestring“Not allowed”[1, 1024]当未允许的 User-Agent 访问时返回的信息。
bypass_missingbooleanfalse当设置为 true 时,如果 User-Agent 请求头不存在或格式有误时,将绕过检查。
ua-restriction - 图1note

allowlistdenylist 可以同时启用。同时启用时,插件会根据 User-Agent 先检查 allowlist,再检查 denylist

启用插件

以下示例展示了如何在指定路由上启用并配置 ua-restriction 插件:

  1. curl http://127.0.0.1:9180/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. "ua-restriction": {
  12. "bypass_missing": true,
  13. "allowlist": [
  14. "my-bot1",
  15. "(Baiduspider)/(\\d+)\\.(\\d+)"
  16. ],
  17. "denylist": [
  18. "my-bot2",
  19. "(Twitterspider)/(\\d+)\\.(\\d+)"
  20. ]
  21. }
  22. }
  23. }'

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

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

测试插件

通过上述命令启用插件后,你可以先发起一个简单的请求测试:

  1. curl http://127.0.0.1:9080/index.html -i

返回的 HTTP 响应头中带有 200 状态码,代表请求成功:

  1. HTTP/1.1 200 OK
  2. ...

接下来,请求的同时指定处于 denylist 中的 User-Agent,如 Twitterspider/2.0

  1. curl http://127.0.0.1:9080/index.html --header 'User-Agent: Twitterspider/2.0'

返回的 HTTP 响应头中带有 403 状态码,请求失败,代表插件生效:

  1. HTTP/1.1 403 Forbidden
  2. ...
  3. {"message":"Not allowed"}

禁用插件

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

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