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

nginx module : headers-more-nginx

install and overview

ngx_http_headers_module是在Nginx编译时默认自带的模块&＃xff0c;主要包含add_header和expires两个指令。之前有专门的文档介绍过该模板的配置与使用&＃xff1b;文章链接&＃xff1a; https://blog.csdn.net/LL845876425/article/details/102773194

而ngx_http_headers_module 的2个主要指令(add_header, expires) 中的add_header指令&＃xff0c;只适合用来添加响应头&＃xff0c;如需对HTTP请求头进行处理&＃xff0c;可以使用第三方模块headers-more-nginx&＃xff0c;它可以用来添加、删除、修改HTTP请求头和响应头。该模块地址为https://github.com/openresty/headers-more-nginx-module.git&＃xff0c;其安装方式如下:

[root&＃64;network-test nginx]# lltotal 1036drwxr-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&＃64;network-test nginx]# # git clone https://github.com/openresty/headers-more-nginx-module.git[root&＃64;network-test nginx]# # wget http://nginx.org/download/nginx-1.19.2.tar.gz[root&＃64;network-test nginx]# [root&＃64;network-test nginx]# tar -xf nginx-1.19.2.tar.gz[root&＃64;network-test nginx]# cd nginx-1.19.2/[root&＃64;network-test nginx-1.19.2]# ./configure --prefix&＃61;/usr/local/nginx --add-module&＃61;../headers-more-nginx-module[root&＃64;network-test nginx-1.19.2]# make && make install

安装完成后&＃xff0c;对其进行配置&＃xff0c;让它实现和add_header指令一样的功能。

实例1&＃xff1a;

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

初始header&＃xff1b;

添加nginx 配置 more_set_headers &＃39;Cache-Control : 1000&＃39;;

验证已经添加成功&＃xff1a;

实例2&＃xff1a;

more_set_headers -s &＃39;200 301&＃39; &＃39;Cache-Control:1000&＃39;;

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

当后端服务器返回的响应头和使用more_set_headers指令时相同时&＃xff0c;响应头的值会被more_set_headers替换掉&＃xff0c;这样就不会同时出现两个相同的响应头了。

headers-more-nginx模块常用的操作指令还有很多&＃xff0c;例如more_set_headers、more_clear_headers、more_set_input_headers、more_clear_input_headers等。

Detail

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

指令&＃xff1a;more_set_headers

语法&＃xff1a;more_set_headers [-t ] … [ -s ]……

默认值&＃xff1a;无

环境&＃xff1a;http、server、location、location if

执行阶段&＃xff1a;output-header-filter

示例&＃xff1a;more_set_headers -s 404 -s ‘500 502’ ‘Result:error’ ‘F:X-re’;

含义&＃xff1a;在返回响应报文前对响应头进行新增或替换操作。

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

more_set_headers -s 404 -s &＃39;500 502&＃39; &＃39;Result:error&＃39; &＃39;F:X-re&＃39;;

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

指令&＃xff1a;more_clear_headers

语法&＃xff1a;more_clear_headers [-t ]…[-s ]……

默认值&＃xff1a;无

环境&＃xff1a;http、server、location、location if

执行阶段&＃xff1a;output-header-filter

示例&＃xff1a;more_clear_headers -s 200 -t ‘text/plain’ F Result;

含义&＃xff1a;在返回响应报文前清除指定的响应头。

more_clear_headers -s 200 -t &＃39;text/plain&＃39; F Result;more_clear_headers -s 200 -t &＃39;X-*&＃39;;

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

3.设置HTTP请求头

指令&＃xff1a;more_set_input_headers

语法&＃xff1a;more_set_input_headers ‘Host:testnginx.com’;

环境&＃xff1a;http、server、location、location if

执行阶段&＃xff1a;rewritetail

含义&＃xff1a;当请求在rewrite阶段并执行到最后时&＃xff0c;再添加一个请求头&＃xff0c;该请求头将和请求一起到达下一个阶段;

示例如下&＃xff1a;

4.清除HTTP请求头

指令&＃xff1a;more_clear_input_headers

语法&＃xff1a;more_clear_input_headers -t Cache-Control;

环境&＃xff1a;http、server、location、location if

执行阶段&＃xff1a;rewrite tail

含义&＃xff1a;当请求在rewrite阶段并执行到最后时&＃xff0c;如果匹配到的请求头是CacheControl就清除掉。

该指令支持通配符&＃xff0c;如“more_clear_input_headers ‘Test*’;”&＃xff0c;指的就是以Test开头的请求头将全部被清除。

more_clear_input_headers &＃39;Test*&＃39;;

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

5.实战经验

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

nginx module : set-misc-nginx

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

install and overview

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

安装时直接编译即可&＃xff0c;如下所示&＃xff1a;

git clone https://github.com/openresty/set-misc-nginx-module.gitgit clone https://github.com/vision5/ngx_devel_kit.gitcd nginx-1.19.2/./configure --prefix&＃61;/usr/local/nginx --add-module&＃61;../ngx_devel_kit --add-module&＃61;../set-misc-nginx-modulemake && make install

注意&＃xff1a;很多第三方模块在编译时都需要加入ngx_devel_kit模块&＃xff0c;因为ngx_devel_kit扩展了Nginx服务器的核心功能&＃xff0c;很多第三方模块都是基于它实现的。

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

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

2、防止SQL注入

指令&＃xff1a;set_quote_sql_str

3、字符串非转义和转义

指令&＃xff1a;set_unescape_uri

4、基于键值的集群分片

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

指令&＃xff1a;set_hashed_upstream

5、base编码

指令&＃xff1a;set_encode_base32

6、md5编码

指令&＃xff1a;set_md5

7、生成随机数

指令&＃xff1a;set_random

指令&＃xff1a;set_secure_random_alphanum

指令&＃xff1a;set_secure_random_lcalpha

8、本地时间的输出

指令&＃xff1a;set_local_today

9、实战经验

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

nginx module : ngx_http_image_filter_module

install and overview

Nginx可以使用ngx_http_image_filter_module对图片进行切割裁剪&＃xff0c;这为动态处理图片提供了支持。

安装方式&＃xff1a;只需在编译Nginx时&＃xff0c;添加--with-http_image_filter_module即可。

依赖库&＃xff1a;libgd(gddevel)&＃xff0c;在CentOS系统下通过yum安装即可(推荐使用最新版本)。

具体的使用&＃xff1b;在有需要时&＃xff0c;可以查阅对应官网说明和使用手册&＃xff1b;