文档

获取客户端真实IP

网站接入Web应用防火墙(Web Application Firewall,简称WAF)后,访问请求在到达源站服务器之前,需要经过WAF的代理转发。这种情况下,源站服务器可以通过解析回源请求中的X-Forwarded-For记录,获取客户端的真实IP。本文介绍如何配置不同类型的Web应用服务器(包括Nginx、IIS 6、IIS 7、Apache、Tomcat)以及容器K8s,以获取客户端的真实IP。

背景信息

WAF在将客户端的访问请求转发到下一环节的服务器时,会在HTTP的请求头中添加一条X-Forwarded-For记录,用于记录客户端的IP,格式为X-Forwarded-For:客户端IP。如果客户端和源站服务器之间有多个代理服务器(例如WAF、DDoS高防、CDN等),则X-Forwarded-For记录使用以下格式记录客户端IP和依次经过的代理服务器IP:X-Forwarded-For:客户端IP, 代理服务器1的IP, 代理服务器2的IP, 代理服务器3的IP, ……

因此,常见的Web应用服务器(包括Nginx、IIS 6、IIS 7、Apache、Tomcat)以及容器K8s可以通过解析X-Forwarded-For记录获取客户端真实IP。

下文分别介绍如何配置Nginx、IIS 6、IIS 7、Apache和Tomcat服务器以及容器K8s,解析X-Forwarded-For记录,获取客户端的真实IP。

重要

开始配置之前,请务必备份现有环境,包括ECS快照备份和Web应用服务器配置文件备份。

Nginx配置方案

Nginx服务器使用http_realip_module模块解析X-Forwarded-For记录。您可以参考如下步骤,安装http_realip_module模块,修改Nginx配置。

  1. 安装http_realip_module模块。

    在Nginx服务器上执行# nginx -V | grep http_realip_module命令,查看是否已安装http_realip_module模块。

    • 如果已在Nginx服务器上安装该模块,请跳过该步骤。

    • 如果没有在Nginx服务器上安装该模块,请重新编译Nginx服务并参考如下方法安装该模块。

      说明

      一般情况下,通过一键安装包安装的Nginx服务器默认不安装http_realip_module模块。

      wget http://nginx.org/download/nginx-1.12.2.tar.gz
      tar zxvf nginx-1.12.2.tar.gz
      cd nginx-1.12.2
      ./configure --user=www --group=www --prefix=/alidata/server/nginx --with-http_stub_status_module --without-http-cache --with-http_ssl_module --with-http_realip_module
      make
      make install
      kill -USR2 `cat /alidata/server/nginx/logs/nginx.pid`
      kill -QUIT `cat /alidata/server/nginx/logs/nginx.pid.oldbin`
  2. 修改Nginx服务器配置文件。

    1. 打开default.conf配置文件。

    2. location / {}中添加以下内容:

      set_real_ip_from <ip_range1>;
      set_real_ip_from <ip_range2>;
      ...
      set_real_ip_from <ip_rangex>;
      real_ip_header X-Forwarded-For;

      其中,<ip_range1><ip_range2><ip_rangex>需要设置为代理服务器(即WAF)的回源IP段。获取WAF回源IP段的具体操作,请参见放行WAF回源IP段

      多个回源IP段必须分行添加。假设WAF的回源IP段包含10.0.0.1、10.0.0.2、10.0.0.3,则使用如下格式:

      set_real_ip_from 10.0.0.1;
      set_real_ip_from 10.0.0.2;
      set_real_ip_from 10.0.0.3;
      real_ip_header X-Forwarded-For;
  3. 修改log_format日志记录格式。

    1. 打开nginx.conf配置文件,定位到http配置部分的log_format

    2. log_format中添加x-forwarded-for字段,替换默认的remote-address字段。

      修改后的log_format内容如下:

      log_format  main  '$http_x_forwarded_for - $remote_user [$time_local] "$request" ' '$status $body_bytes_sent "$http_referer" ' '"$http_user_agent" ';
  4. 执行nginx -s reload命令,重启Nginx服务器,使配置生效。

IIS 6配置方案

IIS 6服务器使用F5XForwardedFor模块解析X-Forwarded-For记录。您可以参考如下步骤,安装F5XForwardedFor模块。

  1. x86\Releasex64\Release目录下的F5XForwardedFor.dll文件拷贝到某个自定义目录(例如C:\ISAPIFilters\x86C:\ISAPIFilters\x64)。

    说明
    • 请确保IIS进程拥有自定义目录的读写权限。

    • 如果该目录下,没有F5XForwardedFor.dll文件,请手动下载该文件,并将该文件放到自定义目录。下载路径,请参见F5XForwardedFor.dll

  2. 打开IIS管理器,定位到目标站点,右键单击属性

  3. ISAPI筛选器页签,单击添加。完成如下配置后,单击确定

    以32位操作系统为例:

    • 筛选器名称x_forwarded_for_x86

    • 可执行文件F5XForwardedFor.dll文件所在的完整路径(例如C:\ISAPIFilters\x86\F5XForwardedFor.dll)。

  4. 重启IIS 6服务器,使配置生效。

IIS 7配置方案

IIS 7服务器使用F5XForwardedFor模块解析X-Forwarded-For记录。您可以参考如下步骤,安装F5XForwardedFor模块。

  1. x86\Releasex64\Release目录下的F5XFFHttpModule.dllF5XFFHttpModule.ini文件拷贝到某个自定义目录(例如C:\x_forwarded_for\x86C:\x_forwarded_for\x64)。

    说明
    • 请确保IIS进程拥有自定义目录的读写权限。

    • 如果该目录下,没有F5XForwardedFor.dllF5XFFHttpModule.ini文件,请手动下载文件,并将文件放到自定义目录。下载路径,请参见F5XForwardedFor模块

  2. 打开IIS管理器,在IIS区域,双击模块

  3. 模块页面右侧操作区域,单击配置本机模块

  4. 配置本机模块对话框,单击注册。填写注册信息后,单击确定

    以32位操作系统为例:

    • 名称x_forwarded_for_x86

    • 路径F5XFFHttpModule.dll文件所在的完整路径(例如C:\x_forwarded_for\x86\F5XFFHttpModule.dll)。

  5. 配置本机模块对话框,选中新注册的模块,单击确定

  6. ISAPI 和CGI限制页面,添加已注册的DLL,并将限制设置为允许

  7. 重启IIS 7服务器,使配置生效。

Apache配置方案

Windows操作系统

Apache 2.4及以上版本的安装包中自带remoteip_module模块文件(mod_remoteip.so),Apache服务器使用该模块获取客户端IP地址。

  1. 进入Apache服务器的extra配置文件夹(conf/extra/),新建httpd-remoteip.conf配置文件。

    说明

    通过引入remoteip.conf配置文件的方式加载相关配置,减少直接修改httpd.conf配置文件的次数,避免因操作失误导致业务异常。

  2. 编辑httpd-remoteip.conf配置文件,在文件中添加以下内容:

    # 加载mod_remoteip.so模块
    LoadModule remoteip_module modules/mod_remoteip.so
    # 设置RemoteIPHeader头部
    RemoteIPHeader X-Forwarded-For
    # 设置回源IP段
    RemoteIPInternalProxy <ip_range1> <ip_range2> …… <ip_rangex>

    其中,<ip_range1><ip_range2><ip_rangex>需要设置为代理服务器(即WAF)的回源IP段。获取WAF回源IP段的具体操作,请参见放行WAF回源IP段

    多个回源IP段之前使用空格分隔。假设代理服务器的回源IP段包含10.0.0.1、10.0.0.2、10.0.0.3,则使用以下格式:

    RemoteIPInternalProxy 10.0.0.1 10.0.0.2 10.0.0.3
  3. 编辑conf/httpd.conf配置文件,在文件中添加以下内容:

    Include conf/extra/httpd-remoteip.conf

    以上命令表示在conf/httpd.conf中插入httpd-remoteip.conf配置文件。

  4. httpd.conf配置文件中修改日志格式。

    LogFormat "%a %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
    LogFormat "%a %l %u %t \"%r\" %>s %b" common
  5. 重启Apache服务,使配置生效。

Linux操作系统

您可以参考上述Windows操作系统服务器的配置方式,添加Apache 2.4及以上版本自带的remoteip_module模块(mod_remoteip.so)并配置日志格式,获取客户端IP地址。

如果Linux服务器使用的Apache版本低于2.4,请参照以下步骤,通过设置Apache的第三方模块(mod_rpaf),获取客户端IP地址。

  1. 安装mod_rpaf模块。

    wget https://github.com/gnif/mod_rpaf/archive/v0.6.0.tar.gz
    tar zxvf mod_rpaf-0.6.tar.gz
    cd mod_rpaf-0.6
    /alidata/server/httpd/bin/apxs -i -c -n mod_rpaf-2.0.so mod_rpaf-2.0.c
  2. 编辑Apache配置文件/alidata/server/httpd/conf/httpd.conf,在文件最后添加以下内容:

    LoadModule rpaf_module modules/mod_rpaf-2.0.so
    RPAFenable On
    RPAFsethostname On
    RPAFproxy_ips <rpaf ip地址>
    RPAFheader X-Forwarded-For

    其中,<rpaf ip地址>不是代理服务器的公网IP地址,具体IP请通过Apache日志查询。通常包含两个IP地址,示例如下:

    LoadModule rpaf_module modules/mod_rpaf-2.0.so
    RPAFenable On
    RPAFsethostname On
    RPAFproxy_ips 10.XX.XX.65 10.XX.XX.131
    RPAFheader X-Forwarded-For
  3. 重启Apache服务,使配置生效。

    /alidata/server/httpd/bin/apachectl restart

更多Apache相关模块的信息,请参见Apache帮助文档

Tomcat配置方案

Tomcat服务器通过启用X-Forwarded-For功能,获取客户端IP地址。

  1. 打开tomcat/conf/server.xml配置文件。

  2. 将AccessLogValve日志记录功能部分修改为以下内容:

    <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
    prefix="localhost_access_log." suffix=".txt"
    pattern="%{X-FORWARDED-FOR}i %l %u %t %r %s %b %D %q %{User-Agent}i %T" resolveHosts="false"/>

容器K8s配置方案

如果您的服务部署在K8s上,K8s会将真实的客户端IP记录在X-Original-Forwarded-For字段中,并将WAF回源地址记录在X-Forwarded-For字段中。您需要修改容器的配置文件,使Ingress将真实的IP添加到X-Forwarded-For字段中,以便您正常获取真实的客户端IP地址。

您可以参考以下步骤,对容器配置文件进行修改。

  1. 执行以下命令修改配置文件kube-system/nginx-configuration

    kubectl -n kube-system edit cm nginx-configuration
  2. 在配置文件中添加以下内容:

    compute-full-forwarded-for: "true"
    forwarded-for-header: "X-Forwarded-For"
    use-forwarded-headers: "true"
  3. 保存配置文件。

    保存后配置即刻生效,Ingress会将真实的客户端IP添加到X-Forwarded-For字段中。

  4. 将业务程序获取客户端真实IP的字段修改为X-Original-Forwarded-For。

  • 本页导读 (1)