nginx定制header返回信息模块ngx_headers_more

默北 Nginx959,36210字数 4359阅读14分31秒阅读模式

一. 介绍ngx_headers_more

ngx_headers_more 用于添加、设置和清除输入和输出的头信息。nginx源码没有包含该模块,需要另行添加。

该模块是ngx_http_headers_module模块的增强版,提供了更多的实用工具,比如复位或清除内置头信息,如Content-Type, Content-Length, 和Server。文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

可以允许你使用-s选项指定HTTP状态码,使用-t选项指定内容类型,通过more_set_headers 和 more_clear_headers 指令来修改输出头信息。如:文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

more_set_headers -s 404 -t 'text/html' 'X-Foo: Bar';

输入头信息也可以这么修改,如:文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

location /foo {
    more_set_input_headers 'Host: foo' 'User-Agent: faked';
    # now $host, $http_host, $user_agent, and
    #   $http_user_agent all have their new values.
}

-t选项也可以在more_set_input_headers和more_clear_input_headers指令中使用。文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

不像标准头模块,该模块的指示适用于所有的状态码,包括4xx和5xx的。 add_header只适用于200,201,204,206,301,302,303,304,或307。文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

标准头模块ngx_http_headers_module参见:《ngx_http_headers_module模块add_header和expires指令文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

二. 安装ngx_headers_more

wget 'http://nginx.org/download/nginx-1.5.8.tar.gz'
tar -xzvf nginx-1.5.8.tar.gz
cd nginx-1.5.8/

# Here we assume you would install you nginx under /opt/nginx/.
./configure --prefix=/opt/nginx \
    --add-module=/path/to/headers-more-nginx-module

make
make install

ngx_headers_more 包下载地址:http://github.com/agentzh/headers-more-nginx-module/tags文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

ngx_openresty包含该模块。文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

三. 指令说明

more_set_headers

语法:more_set_headers [-t <content-type list>]... [-s <status-code list>]... <new-header>...文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

默认值:no文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

配置段:http, server, location, location if文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

阶段:输出报头过滤器文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

替换(如有)或增加(如果不是所有)指定的输出头时响应状态代码与-s选项相匹配和响应的内容类型的-t选项指定的类型相匹配的。文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

如果没有指定-s或-t,或有一个空表值,无需匹配。因此,对于下面的指定,任何状态码和任何内容类型都讲设置。文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

more_set_headers    "Server: my_server";

具有相同名称的响应头总是覆盖。如果要添加头,可以使用标准的add_header指令代替。文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

单个指令可以设置/添加多个输出头。如:文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

more_set_headers 'Foo: bar' 'Baz: bah';

在单一指令中,选项可以多次出现,如:文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

 more_set_headers -s 404 -s '500 503' 'Foo: bar';

等同于:文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

 more_set_headers -s '404 500 503' 'Foo: bar';

新的头是下面形式之一:文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

  1. Name: Value
  2. Name:
  3. Name

最后两个有效清除的头名称的值。Nginx的变量允许是头值,如:文章源自运维生存时间-https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/

set $my_var "dog";
more_set_headers "Server: $my_var";

注意:more_set_headers允许在location的if块中,但不允许在server的if块中。下面的配置就报语法错误:

 # This is NOT allowed!
  server {
        if ($args ~ 'download') {
           more_set_headers 'Foo: Bar';
        }
       ...
   }
more_clear_headers

语法:more_clear_headers [-t <content-type list>]... [-s <status-code list>]... <new-header>...

默认值:no

配置段:http, server, location, location if

阶段:输出报头过滤器

清除指定的输出头。

more_clear_headers -s 404 -t 'text/plain' Foo Baz;
等同于
more_set_headers -s 404 -t 'text/plain' "Foo: " "Baz: ";
或
more_set_headers -s 404 -t 'text/plain' Foo Baz

也可以使用通配符*,如:

more_clear_headers 'X-Hidden-*';

清除开始由“X-Hidden-”任何输出头。

more_set_input_headers

语法:more_set_input_headers [-r] [-t <content-type list>]... <new-header>...

默认值:no

配置段:http, server, location, location if

阶段: rewrite tail

非常类似more_set_headers,不同的是它工作在输入头(或请求头),它仅支持-t选项。

注意:使用-t选项的是过滤请求头的Content-Type,而不是响应头的。

more_clear_input_headers

语法:more_clear_input_headers [-t <content-type list>]... <new-header>...

默认值:no

配置段:http, server, location, location if

阶段: rewrite tail

清除指定输入头。如:

more_clear_input_headers -s 404 -t 'text/plain' Foo Baz;
等同于
more_set_input_headers -s 404 -t 'text/plain' "Foo: " "Baz: ";
或
more_set_input_headers -s 404 -t 'text/plain' Foo Baz

四. ngx_headers_more局限性

1. 不同于标准头模块,该模块不会对下面头有效: Expires, Cache-Control, 和Last-Modified。

2. 使用此模块无法删除Connection的响应报头。唯一方法是更改src/ HTTP/ ngx_http_header_filter_module.c文件。

五. 使用ngx_headers_more

# set the Server output header
more_set_headers 'Server: my-server';

# set and clear output headers
location /bar {
    more_set_headers 'X-MyHeader: blah' 'X-MyHeader2: foo';
    more_set_headers -t 'text/plain text/css' 'Content-Type: text/foo';
    more_set_headers -s '400 404 500 503' -s 413 'Foo: Bar';
    more_clear_headers 'Content-Type';

    # your proxy_pass/memcached_pass/or any other config goes here...
}

# set output headers
location /type {
    more_set_headers 'Content-Type: text/plain';
    # ...
}

# set input headers
location /foo {
    set $my_host 'my dog';
    more_set_input_headers 'Host: $my_host';
    more_set_input_headers -t 'text/plain' 'X-Foo: bah';

    # now $host and $http_host have their new values...
    # ...
}

# replace input header X-Foo *only* if it already exists
more_set_input_headers -r 'X-Foo: howdy';

六. 应用ngx_headers_more

修改web服务器是什么软件,什么版本,同时隐藏Centent-Type、Accept-Range、Content-Length头信息。

add_header

 more_set_headers "Server: ttlsa.com Web Server";
 more_clear_headers "Content-Type:";
 more_clear_headers "Accept-Ranges: ";
 more_clear_headers "Content-Length: ";

add_header

404状态码添加header

配置如下:

more_set_headers "Server: ttlsa.com Web Server";
more_set_headers -s 404 "Error: Not found";
more_clear_headers "Content-Type:";
more_clear_headers "Accept-Ranges: ";
more_clear_headers "Content-Length: ";

add_header

weinxin
我的微信
微信公众号
扫一扫关注运维生存时间公众号,获取最新技术文章~
默北
  • 本文由 发表于 29/11/2014 01:00:44
  • 转载请务必保留本文链接:https://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-ngx_headers_more/
评论  9  访客  9
    • 美剧天堂
      美剧天堂 1

      不错,准备自己也该一下

      • junze
        junze 1

        我安装了 然后执行
        [root@wujunze]# more_set_headers
        -bash: more_set_headers: command not found
        提示命令找不到 是为什么?

        • 牧童Damian
          牧童Damian 9

          能操作If-None-Match这种头吗?

          • 牧童Damian
            牧童Damian 9

            mark

            • 高强
              高强 9

              恩 这个模块不知道可以不可以修改 <head></head>之间的内容呢 比如插入js 现在 sub_filter 模块可以查找替换 但是效率会低一些

                • TTLSA
                  TTLSA 9

                  @ 高强 这边的header是http协议的头部信息,你说的head是html语言的head,不要混淆了

                    • 高强
                      高强 9

                      @ TTLSA 是的 没有弄混 ~ 我问的也是 这个模块是不是也能够像 sub_filter 模块一样替换 HTML的内容(html的header只是一部分) 现在来看文章提到的是处理http的头

                        • TTLSA
                          TTLSA 9

                          @ 高强 是的,可以替换head头内容

                    • 西秦公子
                      西秦公子 9

                      北爷→_→
                      我刚问你这个问题你就写了这个模块的文章。

                    评论已关闭!