Nginx官方文档(二十八)【ngx_http_random_index_module|ngx_http_realip_module|ngx_http_referer_module】

阳光穿透心脏的1/2处 2021-07-04 13:40 325阅读 0赞

# ngx\_http\_random\_index\_module #

`ngx_http_random_index_module` 模块处理以 `/` 结尾的请求，然后随机选择目录中的一个文件作为索引文件展示，该模块优先于 ngx\_http\_index\_module 之前处理。

该模块默认不会被构建到 nginx 中，需要在编译时加入 `--with-http_random_index_module` 配置参数启用。

## 配置示例 ##

location / {
        random_index on;
    }

### random\_index ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>random_index</strong> <code>on</code> | <code>off</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">random_index off;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">location</td> 
  </tr> 
 </tbody> 
</table>

启用或禁用 `location` 周边的模块处理。

## 原文档 ##

*  [http://nginx.org/en/docs/http/ngx\_http\_random\_index\_module.html][http_nginx.org_en_docs_http_ngx_http_random_index_module.html]

--------------------

# ngx\_http\_realip\_module #

*  示例配置
 *  指令
    
     *  set\_real\_ip\_from
     *  real\_ip\_header
     *  real\_ip\_recursive
 *  内嵌变量

`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 ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>set_real_ip_from</strong> <code>address</code> | <code>CIDR</code> | <code>unix:</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
 </tbody> 
</table>

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

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

### real\_ip\_header ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>real_ip_header</strong> <code>field</code> | <code>X-Real-IP</code> | <code>X-Forwarded-For</code> | <code>proxy_protocol</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">real_ip_header X-Real-IP;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
 </tbody> 
</table>

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

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

`proxy_protocol` 参数（1.5.12）将客户端地址更改为 PROXY 协议头中的地址。必须先通过在 listen 指令中设置 `proxy_protocol` 参数来启用 PROXY 协议。

### real\_ip\_recursive ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>real_ip_recursive</strong> <code>on</code> | <code>off</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">real_ip_recursive off;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>提示</strong></td> 
   <td align="left">该指令在 1.3.0 版本和 1.2.1 版本中出现</td> 
  </tr> 
 </tbody> 
</table>

如果禁用递归搜索，则匹配其中一个可信地址的原始客户端地址替换为 real\_ip\_header 指令定义的请求头字段中发送的最后一个地址。如果启用了递归搜索，则匹配其中一个可信地址的原始客户端地址替换为请求头字段中发送的最后一个非受信任地址。

## 内嵌变量 ##

*  `$realip_remote_addr`
    
    原始客户端地址
 *  `$realip_remote_port`
    
    原始客户端端口

## 原文档 ##

[http://nginx.org/en/docs/http/ngx\_http\_realip\_module.html][http_nginx.org_en_docs_http_ngx_http_realip_module.html]

--------------------

# ngx\_http\_referer\_module #

*  示例配置
 *  指令
    
     *  referer\_hash\_bucket\_size
     *  referer\_hash\_max\_size
     *  valid\_referers
 *  内嵌变量

`ngx_http_referer_module` 模块用于阻止 **Referer** 头字段为无效值的请求访问站点。需记住的是，使用适当的 **Referer** 字段值来伪造请求非常容易，因此本模块的预期目的不是要彻底阻止此类请求，而是阻止常规浏览器发送的大量流量请求。还应该考虑到，即使是有效请求，常规浏览器也可能不发送 **Referer** 字段。

## 示例配置 ##

valid_referers none blocked server_names
                   *.example.com example.* www.example.org/galleries/
                   ~\.google\.;
    
    if ($invalid_referer) {
        return 403;
    }

## 指令 ##

### referer\_hash\_bucket\_size ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>referer_hash_bucket_size</strong> <code>size</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">referer_hash_bucket_size 64;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">server、location</td> 
  </tr> 
 </tbody> 
</table>

设置有效引用哈希表的桶大小。设置哈希表的详细信息在单独的文档中提供。

### referer\_hash\_max\_size ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>referer_hash_max_size</strong> <code>size</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">referer_hash_max_size 2048;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">server、location</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>提示</strong></td> 
   <td align="left">该指令在 1.0.5 版本中出现</td> 
  </tr> 
 </tbody> 
</table>

设置有效引用哈希表的最大 `size`。设置哈希表的详细信息在单独的文档中提供。

### valid\_referers ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>valid_referers</strong> <code>none</code> | <code>blocked</code> | <code>server_names</code> | <code>string ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">server、location</td> 
  </tr> 
 </tbody> 
</table>

指定 **Referer** 请求头字段值将导致内嵌的 `$invalid_referer` 变量设置为空字符串。否则，变量将为 `1`。匹配搜索不区分大小写。

参数说明如下：

*  `none`
    
    请求头中缺少 **Referer** 字段
 *  `blocked`
    
    **Referer** 字段出现在请求头中，但其值已被防火墙或代理服务器删除，这些值为不以 `http://` 或 `https://` 开头的字符串
 *  `server_names`
    
    **Referer** 请求头字段包含一个服务器名称
 *  任意字符串
    
    定义一个服务器名称和一个可选的 URI 前缀。服务器名称的开头或结尾可以包含`*`。在检查期间，**Referer** 字段中的服务器端口被忽略
 *  正则表达式
    
    第一个符号应为 `〜`。要注意的是，表达式只与 `http://` 或 `https://` 之后的文本匹配。

示例：

valid_referers none blocked server_names
                   *.example.com example.* www.example.org/galleries/
                   ~\.google\.;

## 内嵌变量 ##

*  `$invalid_referer`
    
    如果 **Referer** 请求头字段的值有效，则为空字符串，否则为 1。

## 原文档 ##

[http://nginx.org/en/docs/http/ngx\_http\_referer\_module.html][http_nginx.org_en_docs_http_ngx_http_referer_module.html]

[http_nginx.org_en_docs_http_ngx_http_random_index_module.html]: http://nginx.org/en/docs/http/ngx_http_random_index_module.html
[RFC 3986]: https://tools.ietf.org/html/rfc3986
[http_nginx.org_en_docs_http_ngx_http_realip_module.html]: http://nginx.org/en/docs/http/ngx_http_realip_module.html
[http_nginx.org_en_docs_http_ngx_http_referer_module.html]: http://nginx.org/en/docs/http/ngx_http_referer_module.html