Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_secure_link_module.xml @ 348:5a848934a12d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
English translation of ngx_http_geoip_module, ngx_http_map_module, ngx_http_realip_module, ngx_http_secure_link_module, ngx_http_split_clients_module, and ngx_http_sub_module.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 23 Jan 2012 16:50:35 +0000
parents
children be54c443235a
comparison
equal deleted inserted replaced
347:daae2b619815 348:5a848934a12d
1 <?xml version="1.0"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Module ngx_http_secure_link_module"
6 link="/en/docs/http/ngx_http_secure_link_module.html"
7 lang="en">
8
9 <section id="summary">
10
11 <para>
12 The <literal>ngx_http_secure_link_module</literal> module (0.7.18+) checks
13 the validity of the requested link.
14 </para>
15
16 <para>
17 This module is not built by default, it should be enabled with the
18 <literal>--with-http_secure_link_module</literal>
19 configuration parameter.
20 </para>
21
22 </section>
23
24
25 <section id="example" name="Example Configuration">
26
27 <para>
28 <example>
29 location /p/ {
30 secure_link_secret some_secret_word;
31
32 if ($secure_link = "") {
33 return 403;
34 }
35 }
36 </example>
37 </para>
38
39 </section>
40
41
42 <section id="directives" name="Directives">
43
44 <directive name="secure_link_secret">
45 <syntax><value>word</value></syntax>
46 <default/>
47 <context>location</context>
48
49 <para>
50 Defines a secret <value>word</value> used to check the validity of the link.
51 The full URL of the protected link looks as follows:
52 <example>
53 /prefix/<value>hash</value>/<value>link</value>
54 </example>
55 where <value>hash</value> is computed as
56 <example>
57 md5(link, secret_word);
58 </example>
59 </para>
60
61 <para>
62 A prefix is an arbitrary string not including a slash.
63 </para>
64
65 </directive>
66
67 </section>
68
69
70 <section id="variables" name="Embedded Variables">
71
72 <para>
73 <list type="tag">
74
75 <tag-name><var>$secure_link</var></tag-name>
76 <tag-desc>
77 equals to the link extracted from the full URL.
78 If hash is incorrect, this variable is set to an empty string.
79 </tag-desc>
80
81 </list>
82 </para>
83
84 </section>
85
86 </module>