http://www.ttlsa.com/nginx/nginx-custom-header-to-return-information-module-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 指令來修改輸出頭信息。如:
1
|
more_set_headers -s 404 -t 'text/html' 'X-Foo: Bar';
|
輸入頭信息也可以這么修改,如:
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
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,或有一個空表值,無需匹配。因此,對於下面的指定,任何狀態碼和任何內容類型都講設置。
1
|
more_set_headers "Server: my_server";
|
具有相同名稱的響應頭總是覆蓋。如果要添加頭,可以使用標准的add_header指令代替。
單個指令可以設置/添加多個輸出頭。如:
1
|
more_set_headers 'Foo: bar' 'Baz: bah';
|
在單一指令中,選項可以多次出現,如:
1
|
more_set_headers -s 404 -s '500 503' 'Foo: bar';
|
等同於:
1
|
more_set_headers -s '404 500 503' 'Foo: bar';
|
新的頭是下面形式之一:
Name: Value
Name:
Name
最后兩個有效清除的頭名稱的值。Nginx的變量允許是頭值,如:
1
2
|
set $my_var "dog";
more_set_headers "Server: $my_var";
|
注意:more_set_headers允許在location的if塊中,但不允許在server的if塊中。下面的配置就報語法錯誤:
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
階段:輸出報頭過濾器
清除指定的輸出頭。
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
|
也可以使用通配符*,如:
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
清除指定輸入頭。如:
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
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頭信息。
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
配置如下:
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: ";
|