referer-restriction

描述

referer-restriction 插件允许用户将 Referer 请求头中的域名列入白名单或黑名单来限制该域名对服务或路由的访问。

属性

名称	类型	必选项	默认值	有效值	描述
whitelist	array[string]	否			白名单域名列表。域名开头可以用 * 作为通配符。
blacklist	array[string]	否			黑名单域名列表。域名开头可以用 * 作为通配符。
message	string	否	"Your referer host is not allowed"	[1, 1024]	在未允许访问的情况下返回的信息。
bypass_missing	boolean	否	false		当设置为 true 时，如果 Referer 请求头不存在或格式有误，将绕过检查。

IMPORTANT

whitelist 和 blacklist 属性无法同时在同一个服务或路由上使用，只能使用其中之一。

启用插件

以下示例展示了如何在特定路由上启用 referer-restriction 插件，并配置 whitelist 和 bypass_missing 属性：

curl http://127.0.0.1:9180/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 测试插件：

curl http://127.0.0.1:9080/index.html -H 'Referer: http://xx.com/x'

返回的 HTTP 响应头中带有 200 状态码则表示访问成功：

HTTP/1.1 200 OK
...

接下来，将请求设置为 Referer: http://yy.com/x：

curl http://127.0.0.1:9080/index.html -H 'Referer: http://yy.com/x'

返回的 HTTP 响应头中带有 403 状态码，并在响应体中带有 message 属性值，代表访问被阻止：

HTTP/1.1 403 Forbidden
...
{"message":"Your referer host is not allowed"}

因为启用插件时会将属性 bypass_missing 设置为 true，所以未指定 Refer 请求头的请求将跳过检查：

curl http://127.0.0.1:9080/index.html

返回的 HTTP 响应头中带有 200 状态码，代表访问成功：

HTTP/1.1 200 OK
...

禁用插件

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

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