模块 ngx_http_realip_module

Example Configuration
Directives
     set_real_ip_from
     real_ip_header
     real_ip_recursive
Embedded Variables

ngx_http_realip_module模块用于将客户端地址和可选端口更改为在指定标头字段中发送的内容。

该模块不是默认构建的,需要通过 --with-http_realip_module 配置参数启用。

配置示例

set_real_ip_from  192.168.1.0/24;
set_real_ip_from  192.168.2.1;
set_real_ip_from  2001:0db8::/32;
real_ip_header    X-Forwarded-For;
real_ip_recursive on;

指令

句法: set_real_ip_from address | CIDR | unix:;
默认:
语境: http, server,location

定义已知可发送正确替换地址的可信地址。如果指定了特殊值unix:,则所有 UNIX 域套接字都将受到信任。可信地址也可以使用主机名 (1.13.1) 来指定。

从版本 1.3.0 和 1.2.1 开始支持 IPv6 地址。

句法: real_ip_header field | X-Real-IP | X-Forwarded-For | proxy_protocol;
默认:
real_ip_header X-Real-IP;
语境: http, server,location

定义请求标头字段,其值将用于替换客户端地址。

包含可选端口的请求标头字段值也用于替换客户端端口 (1.11.0)。应根据 RFC 3986指定地址和端口。

参数proxy_protocol(1.5.12) 将客户端地址更改为 PROXY 协议标头中的地址。PROXY 协议必须预先通过设置 listenproxy_protocol指令中的参数来启用。

句法: real_ip_recursive on | off;
默认:
real_ip_recursive off;
语境: http, server,location

该指令出现在版本 1.3.0 和 1.2.1 中。

如果禁用递归搜索,则与可信地址之一匹配的原始客户端地址将替换为 real_ip_header 指令定义的请求标头字段中发送的最后一个 地址。如果启用递归搜索,则与可信地址之一匹配的原始客户端地址将被请求标头字段中发送的最后一个不可信地址替换。

嵌入变量

$realip_remote_addr
保留原始客户端地址(1.9.7)
$realip_remote_port
保留原始客户端端口(1.11.0)