referer-restriction

目录

名字

referer-restriction 插件可以根据 Referer 请求头限制访问。

属性

参数名类型可选项默认值有效值描述
whitelistarray[string]可选白名单域名列表。域名开头可以用’‘作为通配符。
blacklistarray[string]可选黑名单域名列表。域名开头可以用’‘作为通配符。
messagestring可选Your referer host is not allowed[1, 1024]在未允许访问的情况下返回的信息。
bypass_missingboolean可选false当 Referer 不存在或格式有误时，是否绕过检查。

只能单独启用白名单或黑名单，两个不能一起使用。 message可以由用户自定义。

如何启用

下面是一个示例，在指定的 route 上开启了 referer-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": {        "referer-restriction": {            "bypass_missing": true,            "whitelist": [                "xx.com",                "*.xx.com"            ]        }    }}'

测试插件

带 Referer: http://xx.com/x 请求:

  1. $ curl http://127.0.0.1:9080/index.html -H 'Referer: http://xx.com/x'HTTP/1.1 200 OK...

带 Referer: http://yy.com/x 请求:

  1. $ curl http://127.0.0.1:9080/index.html -H 'Referer: http://yy.com/x'HTTP/1.1 403 Forbidden...{"message":"Your referer host is not allowed"}

不带 Referer 请求:

  1. $ curl http://127.0.0.1:9080/index.htmlHTTP/1.1 200 OK...

禁用插件

当你想去掉 referer-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        }    }}'

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