referer-restriction插件
更新时间 2026-04-21 15:48:56
最近更新时间: 2026-04-21 15:48:56
本文将详细介绍referer-restriction插件功能、配置和使用。
功能说明
referer-restriction 插件通过将指定 Referer 列入白名单或黑名单的方式来限制对服务或路由的访问。Referer是 HTTP 请求头的一部分,用于标识当前请求的来源页面(即用户从哪个页面点击链接进入了当前页面)。
配置字段
| 名称 | 类型 | 填写要求 | 默认值 | 有效值 | 描述 |
|---|---|---|---|---|---|
| whitelist | array[string] | 与blacklist二选一 | 白名单域名列表。域名开头可以用 * 作为通配符。 | ||
| blacklist | array[string] | 与whitelist二选一 | 黑名单域名列表。域名开头可以用 * 作为通配符。 | ||
| message | string | 可选 | "Your referer host is not allowed" | 字符数[1,1024] | 当未允许访问时返回的信息。 |
| bypass_missing | boolean | 可选 | false | 当设置为 true 时,如果Referer请求头不存在或格式有误时,将绕过检查。 |
注意
配置模板中对于黑白名单域名列表,如果采用*作为通配符,则需要通过引号填写字段值。
配置示例
设置 Referer 白名单
whitelist:
- "ctyun.com"
- "*.ctyun.com"若不做该配置,从ctyun.com页面跳转的链接被禁止访问。
设置 Referer 黑名单
blacklist:
- "black.com"根据该配置,以下请求会被禁止。
curl http://example.com -H 'Referer: http://black.com/test'该请求的响应结果为
HTTP/1.1 403 Forbidden
......
{"message":"Your referer host is not allowed"}配置模板
#[必填,黑白名单二选一]黑/白名单域名列表。域名开头可以用 * 作为通配符。
whitelist:
- "*.ctyun.com"
#blacklist:
# - "b.com"
#[可选]未允许访问时返回的信息。有效长度1-1024,默认为Your refer host is not allowed
#message: "Your refer host is not allowed"
#[可选]当设置为 true 时,如果 Referer请求头不存在或格式有误时,将绕过检查。默认false
#bypass_missing: false