nginx--常见模块,headers-more-nginx and set-misc-nginx 等

骑猪看日落 2022-11-30 15:42 371阅读 0赞

### 文章目录 ###

*  nginx--常见模块,headers-more-nginx and set-misc-nginx 等
 *   *  nginx module : headers-more-nginx
     *   *  install and overview
         *  Detail
     *  nginx module : set-misc-nginx
     *   *  install and overview
         *  Detial
     *  nginx module : ngx\_http\_image\_filter\_module
     *   *  install and overview

# nginx–常见模块,headers-more-nginx and set-misc-nginx 等 #

## nginx module : headers-more-nginx ##

### install and overview ###

ngx\_http\_headers\_module是在Nginx编译时默认自带的模块，主要包含add\_header和expires两个指令。之前有专门的文档介绍过该模板的配置与使用；文章链接： https://blog.csdn.net/LL845876425/article/details/102773194

而ngx\_http\_headers\_module 的2个主要指令(add\_header, expires) 中的add\_header指令，只适合用来添加响应头，如需对HTTP请求头进行处理，可以使用第三方模块headers-more-nginx，它可以用来添加、删除、修改HTTP请求头和响应头。该模块地址为https://github.com/openresty/headers-more-nginx-module.git，其安装方式如下:  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center][]

[root@network-test nginx]# ll
    total 1036
    drwxr-xr-x 6 root root    4096 Aug 24 10:59 headers-more-nginx-module
    -rw-r--r-- 1 root root 1048727 Aug 11 23:03 nginx-1.19.2.tar.gz
    [root@network-test nginx]# # git clone https://github.com/openresty/headers-more-nginx-module.git
    [root@network-test nginx]# # wget http://nginx.org/download/nginx-1.19.2.tar.gz
    [root@network-test nginx]# 
    [root@network-test nginx]# tar -xf nginx-1.19.2.tar.gz
    [root@network-test nginx]# cd nginx-1.19.2/
    [root@network-test nginx-1.19.2]# ./configure --prefix=/usr/local/nginx --add-module=../headers-more-nginx-module
    [root@network-test nginx-1.19.2]# make && make install

安装完成后，对其进行配置，让它实现和add\_header指令一样的功能。

实例1：

more_set_headers 'Cache-Control : 1000';
    # 上述配置等同于add_header Cache-Control 1000 always;   # 作用是无论返回的状态码是什么都会输出响应头。

初始header；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 1][]

添加nginx 配置 `more_set_headers 'Cache-Control : 1000';`

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 2][]

验证已经添加成功：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 3][]

实例2：

more_set_headers -s '200 301' 'Cache-Control:1000';

上述配置等同于`add_header Cache-Control 1000;`，表示当状态码是200或301时才输出响应头，从而加强对响应头的控制。

当后端服务器返回的响应头和使用more\_set\_headers指令时相同时，响应头的值会被more\_set\_headers替换掉，这样就不会同时出现两个相同的响应头了。

headers-more-nginx模块常用的操作指令还有很多，例如more\_set\_headers、more\_clear\_headers、more\_set\_input\_headers、more\_clear\_input\_headers等.

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 4][]  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 5][]

### Detail ###

1.根据HTTP状态控制响应头

> 指令：more\_set\_headers
> 
> 语法：more\_set\_headers \[-t \] … \[ -s \]……
> 
> 默认值：无
> 
> 环境：http、server、location、location if
> 
> 执行阶段：output-header-filter
> 
> 示例：more\_set\_headers -s 404 -s ‘500 502’ ‘Result:error’ ‘F:X-re’;
> 
> 含义：在返回响应报文前对响应头进行新增或替换操作。

示例的意思是当响应状态码（-s参数的作用就是匹配对应的状态码）是404、500或502时，如果添加’Result:error’和’F:X-re’两个响应头，当后端服务器返回其中任何一个响应头时，more\_set\_headers都会替换返回的值。

more_set_headers -s 404  -s '500 502' 'Result:error' 'F:X-re';

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 6][]

2.根据HTTP状态清除响应头

> 指令：more\_clear\_headers
> 
> 语法：more\_clear\_headers \[-t \]…\[-s \]……
> 
> 默认值：无
> 
> 环境：http、server、location、location if
> 
> 执行阶段：output-header-filter
> 
> 示例：more\_clear\_headers -s 200 -t ‘text/plain’ F Result;
> 
> 含义：在返回响应报文前清除指定的响应头。

more_clear_headers -s 200 -t 'text/plain' F Result;
    more_clear_headers -s 200 -t 'X-*';

示例中的意思是当响应状态码是200时清除’text/plain’、F、Result这3个响应头；如果不用-s参数（即不对状态码进行匹配），指定的响应头在任何状态码下都会被清除。  
该指令还可以使用通配符，例如，想要清除以X-开头的响应头，只需使用`more_clear_headers -s 200 -t 'X-*'`即可。

3.设置HTTP请求头

> 指令：more\_set\_input\_headers
> 
> 语法：more\_set\_input\_headers ‘Host:testnginx.com’;
> 
> 环境：http、server、location、location if
> 
> 执行阶段：rewritetail
> 
> 含义：当请求在rewrite阶段并执行到最后时，再添加一个请求头，该请求头将和请求一起到达下一个阶段;

示例如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 7][]

4.清除HTTP请求头

> 指令：more\_clear\_input\_headers
> 
> 语法：more\_clear\_input\_headers -t Cache-Control;
> 
> 环境：http、server、location、location if
> 
> 执行阶段：rewrite tail
> 
> 含义：当请求在rewrite阶段并执行到最后时，如果匹配到的请求头是CacheControl就清除掉。

该指令支持通配符，如“more\_clear\_input\_headers ‘Test\*’;”，指的就是以Test开头的请求头将全部被清除。

more_clear_input_headers 'Test*';

5.实战经验

*  关于指令more\_clear\_headers清除响应头操作可以用来隐藏服务内部的一些敏感信息，如varnish自带的响应头，或者PHP框架生成的响应头等。在实际业务中首先要确定需要传递给客户端的响应头信息，而不必传递给客户端的信息则可以使用此方法进行清除。
 *  关于指令more\_set\_input\_headers和more\_clear\_input\_headers ; 这两个指令都在 rewrite tail阶段使用，如果在同一个执行阶段使用这两个指令，会按照指令的前后顺序执行。
 *  headers-more-nginx模块的指令都是区分大小写的，所以要注意区分字母的大小写。

## nginx module : set-misc-nginx ##

第三方模块set-misc-nginx在rewrite阶段使用，它功能丰富，具有设置变量、URL转义、生成随机数、防止SQL注入、解码与编码等多项功能。

### install and overview ###

该模块地址为https://github.com/openresty/set-misc-nginx-module.git

安装时直接编译即可，如下所示：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 8][]

git clone https://github.com/openresty/set-misc-nginx-module.git
    git clone https://github.com/vision5/ngx_devel_kit.git
    cd nginx-1.19.2/
    ./configure --prefix=/usr/local/nginx --add-module=../ngx_devel_kit --add-module=../set-misc-nginx-module
    make && make install

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 9][]

**注意：很多第三方模块在编译时都需要加入ngx\_devel\_kit模块，因为ngx\_devel\_kit扩展了Nginx服务器的核心功能，很多第三方模块都是基于它实现的。**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 10][]

### Detial ###

1、设置变量：

> 设置变量指令：set\_if\_empty
> 
> 语法：set\_if\_empty $dst
> 
> 环境：location、location if
> 
> 执行阶段：rewrite

示例如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 11][]

如果不使用此模块，而直接用Nginx进行配置会比较麻烦。

下面的其他功能指令由于使用的机会不会很多；尽做展示；需要时实际再查即可；

2、防止SQL注入

指令：set\_quote\_sql\_str

3、字符串非转义和转义

指令：set\_unescape\_uri

4、基于键值的集群分片

Nginx通过第三方模块可以和数据库进行交互，这使API 服务更容易部署和开发。当需要对数据库中的数据分片读取时，可以使用指令set\_hashed\_upstream进行配置。

指令：set\_hashed\_upstream

5、base编码

指令：set\_encode\_base32

6、md5编码

指令：set\_md5

7、生成随机数

指令：set\_random

指令：set\_secure\_random\_alphanum

指令：set\_secure\_random\_lcalpha

8、本地时间的输出

指令：set\_local\_today

9、实战经验

*  关于指令set\_if\_empty
    
    要尽量减少if语句的使用，而且使用set\_if\_empty能够提升Nginx的可读性。
 *  关于指令set\_quote\_sql\_str一旦让Nginx和数据库直接交互，要确保set\_quote\_sql\_str指令的存在，以防止SQL注入。
 *  关于指令set\_unescape\_uri和set\_escape\_uri在处理数据时，如URL，需要确保转义和非转义的统一性，避免出现前面的代码做了转义，但后面的某些环节却使用非转义数据的情况，因为这样会导致在匹配和对比时出现数据不一致的情况。
 *  关于指令set\_hashed\_upstream该类型的分片比较简单，不涉及高可用。如果某个upstream服务全部“挂掉”，则会报错。因此，在设计分片时要考虑足够多的可能性。

## nginx module : ngx\_http\_image\_filter\_module ##

### install and overview ###

Nginx可以使用ngx\_http\_image\_filter\_module对图片进行切割裁剪，这为动态处理图片提供了支持。

安装方式：只需在编译Nginx时，添加`--with-http_image_filter_module`即可。

依赖库：libgd（gddevel），在CentOS系统下通过yum安装即可（推荐使用最新版本）。

具体的使用；在有需要时，可以查阅对应官网说明和使用手册；

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/982332036ea14244891e56d869683d02.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/cd021ca9cbc64e6384e5130c4a3b5dbb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/2228964da8414f6a87c36d7c0c920b20.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221123/e97bd47f331f47dcb1c8e97bfb99aabd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221123/21108fcc5ccc4856a8c4b93a136e0111.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221123/136e29a3407c4df593b299df3855687f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221123/0209ecc0b8fe41d881c39b0904ecd6b9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221123/0ae6f5467e39424fa4aae13d60ae8fc2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20221123/19303f903a8b4a4e84c38916283cb6ae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20221123/66a74effe8a34be6b6f9ffc0cb5f264f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 10]: /images/20221123/20858a1d4e89478085d795ec9fb3102c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xMODQ1ODc2NDI1_size_16_color_FFFFFF_t_70_pic_center 11]: /images/20221123/d77d406626284920a6e64c88885e3301.png