Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_referer_module.xml @ 966:95c3c3bbf1ce

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Text review.
author Egor Nikitin <yegor.nikitin@gmail.com>
date Wed, 14 Aug 2013 12:03:41 +0400
parents 77a3314c74a7
children a8a643647c76
comparison
equal deleted inserted replaced
965:fadccc156188 966:95c3c3bbf1ce
13 rev="1"> 13 rev="1">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_referer_module</literal> module allows to block 18 The <literal>ngx_http_referer_module</literal> module is used to block
19 access to a site for requests with invalid values in the 19 access to a site for requests with invalid values in the
20 <header>Referer</header> header field. 20 <header>Referer</header> header field.
21 It should be kept in mind that fabricating a request with an appropriate 21 It should be kept in mind that fabricating a request with an appropriate
22 <header>Referer</header> field value is quite easy, and so the intended 22 <header>Referer</header> field value is quite easy, and so the intended
23 purpose of this module is not to block such requests thoroughly but to block 23 purpose of this module is not to block such requests thoroughly but to block
55 <context>location</context> 55 <context>location</context>
56 <appeared-in>1.0.5</appeared-in> 56 <appeared-in>1.0.5</appeared-in>
57 57
58 <para> 58 <para>
59 Sets the bucket size for the valid referers hash tables. 59 Sets the bucket size for the valid referers hash tables.
60 Details of setting up hash tables are provided in a separate 60 The details of setting up hash tables are provided in a separate
61 <link doc="../hash.xml">document</link>. 61 <link doc="../hash.xml">document</link>.
62 </para> 62 </para>
63 63
64 </directive> 64 </directive>
65 65
71 <context>location</context> 71 <context>location</context>
72 <appeared-in>1.0.5</appeared-in> 72 <appeared-in>1.0.5</appeared-in>
73 73
74 <para> 74 <para>
75 Sets the maximum <value>size</value> of the valid referers hash tables. 75 Sets the maximum <value>size</value> of the valid referers hash tables.
76 Details of setting up hash tables are provided in a separate 76 The details of setting up hash tables are provided in a separate
77 <link doc="../hash.xml">document</link>. 77 <link doc="../hash.xml">document</link>.
78 </para> 78 </para>
79 79
80 </directive> 80 </directive>
81 81
90 <default/> 90 <default/>
91 <context>server</context> 91 <context>server</context>
92 <context>location</context> 92 <context>location</context>
93 93
94 <para> 94 <para>
95 Specifies values of the <header>Referer</header> request header field 95 Specifies the <header>Referer</header> request header field values
96 that will cause the embedded variable <var>$invalid_referer</var> to 96 that will cause the embedded <var>$invalid_referer</var> variable to
97 be set to an empty string. 97 be set to an empty string.
98 Otherwise, the variable will be set to “<literal>1</literal>”. 98 Otherwise, the variable will be set to “<literal>1</literal>”.
99 Search for a match is case-insensitive. 99 Search for a match is case-insensitive.
100 </para> 100 </para>
101 101
109 </tag-desc> 109 </tag-desc>
110 110
111 <tag-name><literal>blocked</literal></tag-name> 111 <tag-name><literal>blocked</literal></tag-name>
112 <tag-desc> 112 <tag-desc>
113 the <header>Referer</header> field is present in the request header, 113 the <header>Referer</header> field is present in the request header,
114 but its value was deleted by a firewall or proxy server; 114 but its value has been deleted by a firewall or proxy server;
115 such values are strings that do not start from 115 such values are strings that do not start with
116 “<literal>http://</literal>” or “<literal>https://</literal>”; 116 “<literal>http://</literal>” or “<literal>https://</literal>”;
117 </tag-desc> 117 </tag-desc>
118 118
119 <tag-name><literal>server_names</literal></tag-name> 119 <tag-name><literal>server_names</literal></tag-name>
120 <tag-desc> 120 <tag-desc>
124 124
125 <tag-name>arbitrary string</tag-name> 125 <tag-name>arbitrary string</tag-name>
126 <tag-desc> 126 <tag-desc>
127 defines a server name and an optional URI prefix. 127 defines a server name and an optional URI prefix.
128 A server name can have an “<literal>*</literal>” at the beginning or end. 128 A server name can have an “<literal>*</literal>” at the beginning or end.
129 When checking, the server’s port in the <header>Referer</header> field 129 During the checking, the server’s port in the <header>Referer</header> field
130 is ignored; 130 is ignored;
131 </tag-desc> 131 </tag-desc>
132 132
133 <tag-name>regular expression</tag-name> 133 <tag-name>regular expression</tag-name>
134 <tag-desc> 134 <tag-desc>