nginx定製header信息：ngx_headers_more

一. 介紹ngx_headers_more

ngx_headers_more 用於添加、設置和清除輸入和輸出的頭信息。nginx源碼沒有包含該模塊，須要另行添加。

該模塊是ngx_http_headers_module模塊的加強版，提供了更多的實用工具，好比復位或清除內置頭信息，如Content-Type, Content-Length, 和Server。

能夠容許你使用-s選項指定HTTP狀態碼，使用-t選項指定內容類型，經過more_set_headers 和 more_clear_headers 指令來修改輸出頭信息。如：

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

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

輸入頭信息也能夠這麼修改，如：

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. }

1 2 3 4 5

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指令中使用。

不像標準頭模塊，該模塊的指示適用於全部的狀態碼，包括4xx和5xx的。 add_header只適用於200，201，204，206，301，302，303，304，或307。

標準頭模塊ngx_http_headers_module參見：《ngx_http_headers_module模塊add_header和expires指令》

二. 安裝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

1 2 3 4 5 6 7 8 9 10

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

ngx_openresty包含該模塊。

三. 指令說明

more_set_headers

語法：more_set_headers [-t <content-type list>]... [-s <status-code list>]... <new-header>...

默認值：no

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

階段：輸出報頭過濾器

替換（若有）或增長（若是不是全部）指定的輸出頭時響應狀態代碼與-s選項相匹配和響應的內容類型的-t選項指定的類型相匹配的。

若是沒有指定-s或-t，或有一個空表值，無需匹配。所以，對於下面的指定，任何狀態碼和任何內容類型都講設置。

more_set_headers    "Server: my_server";

1	more_set_headers    "Server: my_server";

具備相同名稱的響應頭老是覆蓋。若是要添加頭，可使用標準的add_header指令代替。

單個指令能夠設置/添加多個輸出頭。如：

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

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

在單一指令中，選項能夠屢次出現，如：

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

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

等同於：

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

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

新的頭是下面形式之一：

1. Name: Value

2. Name:

3. Name

最後兩個有效清除的頭名稱的值。Nginx的變量容許是頭值，如：

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

1 2	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';        }       ...   }

1 2 3 4 5 6 7

# 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

1 2 3 4 5

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-*';

1	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

1 2 3 4 5

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/<a href="http://www.ttlsa.com/nosql/memcache/" title="memcache"target="_blank">memcache</a>d_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';

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

# 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頭信息。

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

1 2 3 4

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

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: ";

1 2 3 4 5

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: ";