Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_ssl_module.xml @ 1168:384bb0349a8a
Documented the "if" parameter of the "access_log" directive.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 24 Apr 2014 12:25:59 +0400 |
parents | cac06b81957c |
children | db4b017b5796 |
rev | line source |
---|---|
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
538
diff
changeset
|
3 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
538
diff
changeset
|
4 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
538
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
538
diff
changeset
|
6 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
538
diff
changeset
|
7 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_ssl_module" |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_ssl_module.html" |
589 | 12 lang="en" |
1167
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
13 rev="14"> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
18 The <literal>ngx_http_ssl_module</literal> module provides the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 necessary support for HTTPS. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 This module is not built by default, it should be enabled with the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 <literal>--with-http_ssl_module</literal> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 configuration parameter. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 <note> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 This module requires the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 <link url="http://www.openssl.org">OpenSSL</link> library. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 </note> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 <section id="example" name="Example Configuration"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 To reduce the processor load it is recommended to |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 <list type="bullet"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 <listitem> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 set the number of worker processes equal to the number of processors, |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 </listitem> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 <listitem> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 enable keep-alive connections, |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 </listitem> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 <listitem> |
966 | 50 enable the shared session cache, |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
51 </listitem> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
53 <listitem> |
966 | 54 disable the built-in session cache, |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 </listitem> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 <listitem> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 and possibly increase the session lifetime (by default, 5 minutes): |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
59 </listitem> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
60 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
61 </list> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
62 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
63 <example> |
817
4fecf0715bbf
Introducing "worker_processes auto" in SSL configuration examples.
Andrei Belov <defan@nginx.com>
parents:
801
diff
changeset
|
64 <emphasis>worker_processes auto;</emphasis> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
65 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
66 http { |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
67 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
68 ... |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
69 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 server { |
801
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
71 listen 443 ssl; |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 <emphasis>keepalive_timeout 70;</emphasis> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 ssl_protocols SSLv3 TLSv1 TLSv1.1 TLSv1.2; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 ssl_ciphers AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 ssl_certificate /usr/local/nginx/conf/cert.pem; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 ssl_certificate_key /usr/local/nginx/conf/cert.key; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 <emphasis>ssl_session_cache shared:SSL:10m;</emphasis> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 <emphasis>ssl_session_timeout 10m;</emphasis> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 ... |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 } |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 </example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 <section id="directives" name="Directives"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 <directive name="ssl"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 <default>off</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 Enables the HTTPS protocol for the given virtual server. |
801
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
99 <note> |
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
100 It is recommended to use the <literal>ssl</literal> parameter of the |
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
101 <link doc="ngx_http_core_module.xml" id="listen"/> directive instead |
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
102 of this directive. |
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
103 </note> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 |
1039
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
109 <directive name="ssl_buffer_size"> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
110 <syntax><value>size</value></syntax> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
111 <default>16k</default> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
112 <context>http</context> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
113 <context>server</context> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
114 <appeared-in>1.5.9</appeared-in> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
115 |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
116 <para> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
117 Sets the size of the buffer used for sending data. |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
118 </para> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
119 |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
120 <para> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
121 By default, the buffer size is 16k, which corresponds to minimal |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
122 overhead when sending big responses. |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
123 To minimize Time To First Byte it may be beneficial to use smaller values, |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
124 for example: |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
125 <example> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
126 ssl_buffer_size 4k; |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
127 </example> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
128 </para> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
129 |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
130 </directive> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
131 |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
132 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
133 <directive name="ssl_certificate"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
135 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
136 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
137 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 <para> |
966 | 140 Specifies a <value>file</value> with the certificate in the PEM format |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 for the given virtual server. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 If intermediate certificates should be specified in addition |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 to a primary certificate, they should be specified in the same file |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 in the following order: the primary certificate comes first, then |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 the intermediate certificates. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 A secret key in the PEM format may be placed in the same file. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 It should be kept in mind that due to the HTTPS protocol limitations |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 virtual servers should listen on different IP addresses: |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 <example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 server { |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 listen 192.168.1.1:443; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 server_name one.example.com; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 ssl_certificate /usr/local/nginx/conf/one.example.com.cert; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 ... |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 } |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 server { |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 listen 192.168.1.2:443; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 server_name two.example.com; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 ssl_certificate /usr/local/nginx/conf/two.example.com.cert; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 ... |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 } |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 </example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 otherwise |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 <link doc="configuring_https_servers.xml" |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 id="name_based_https_servers">the first server’s certificate</link> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 will be issued for the second site. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 <directive name="ssl_certificate_key"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 <para> |
966 | 183 Specifies a <value>file</value> with the secret key in the PEM format |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 for the given virtual server. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 <directive name="ssl_ciphers"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 <syntax><value>ciphers</value></syntax> |
538
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
192 <default>HIGH:!aNULL:!MD5</default> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 Specifies the enabled ciphers. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 The ciphers are specified in the format understood by the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 OpenSSL library, for example: |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 <example> |
538
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
201 ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP; |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 </example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 The full list can be viewed using the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 “<command>openssl ciphers</command>” command. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 |
538
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
210 <para> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
211 <note> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
212 The previous versions of nginx used |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
213 <link doc="configuring_https_servers.xml" id="compatibility">different</link> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
214 ciphers by default. |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
215 </note> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
216 </para> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
217 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 <directive name="ssl_client_certificate"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 <para> |
715
3f25469cbc49
Highlighted 'file' parameters in the http_ssl_module directives.
Vladimir Homutov <vl@nginx.com>
parents:
712
diff
changeset
|
228 Specifies a <value>file</value> with trusted CA certificates in the PEM format |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
229 used to verify client certificates and |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
230 OCSP responses if <link id="ssl_stapling"/> is enabled. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
231 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
232 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
233 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
234 The list of certificates will be sent to clients. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
235 If this is not desired, the <link id="ssl_trusted_certificate"/> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
236 directive can be used. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
241 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
242 <directive name="ssl_crl"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 <appeared-in>0.8.7</appeared-in> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
248 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
249 <para> |
715
3f25469cbc49
Highlighted 'file' parameters in the http_ssl_module directives.
Vladimir Homutov <vl@nginx.com>
parents:
712
diff
changeset
|
250 Specifies a <value>file</value> with revoked certificates (CRL) |
881
d7f2325fa832
Fix up wording in the description of "ssl_crl".
Ruslan Ermilov <ru@nginx.com>
parents:
817
diff
changeset
|
251 in the PEM format used to verify client certificates. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
252 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
253 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
254 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
256 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 <directive name="ssl_dhparam"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 <appeared-in>0.7.2</appeared-in> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
263 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
264 <para> |
715
3f25469cbc49
Highlighted 'file' parameters in the http_ssl_module directives.
Vladimir Homutov <vl@nginx.com>
parents:
712
diff
changeset
|
265 Specifies a <value>file</value> with DH parameters for EDH ciphers. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 |
1054
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
271 <directive name="ssl_ecdh_curve"> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
272 <syntax><value>curve</value></syntax> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
273 <default>prime256v1</default> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
274 <context>http</context> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
275 <context>server</context> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
276 <appeared-in>1.1.0</appeared-in> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
277 <appeared-in>1.0.6</appeared-in> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
278 |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
279 <para> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
280 Specifies a <value>curve</value> for ECDHE ciphers. |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
281 </para> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
282 |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
283 </directive> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
284 |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
285 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 <directive name="ssl_prefer_server_ciphers"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 <default>off</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 Specifies that server ciphers should be preferred over client |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 ciphers when using the SSLv3 and TLS protocols. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
295 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
296 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
297 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
298 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
299 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
300 <directive name="ssl_protocols"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
301 <syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
302 [<literal>SSLv2</literal>] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
303 [<literal>SSLv3</literal>] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
304 [<literal>TLSv1</literal>] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
305 [<literal>TLSv1.1</literal>] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
306 [<literal>TLSv1.2</literal>]</syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
307 <default>SSLv3 TLSv1 TLSv1.1 TLSv1.2</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
308 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
309 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
310 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
311 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
312 Enables the specified protocols. |
966 | 313 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters work |
314 only when the OpenSSL library of version 1.0.1 or higher is used. | |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
315 <note> |
966 | 316 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters are |
317 supported starting from versions 1.1.13 and 1.0.12, | |
318 so when the OpenSSL version 1.0.1 or higher | |
319 is used on older nginx versions, these protocols work, but cannot | |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
320 be disabled. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
321 </note> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
322 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
325 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
326 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
327 <directive name="ssl_session_cache"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
328 <syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
329 <literal>off</literal> | |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
330 <literal>none</literal> | |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
331 [<literal>builtin</literal>[:<value>size</value>]] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
332 [<literal>shared</literal>:<value>name</value>:<value>size</value>]</syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
333 <default>none</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
334 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
335 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
336 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
337 <para> |
966 | 338 Sets the types and sizes of caches that store session parameters. |
339 A cache can be of any of the following types: | |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
340 <list type="tag"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
341 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
342 <tag-name><literal>off</literal></tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
343 <tag-desc> |
966 | 344 the use of a session cache is strictly prohibited: |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
345 nginx explicitly tells a client that sessions may not be reused. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
346 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
347 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
348 <tag-name><literal>none</literal></tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 <tag-desc> |
966 | 350 the use of a session cache is gently disallowed: |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
351 nginx tells a client that sessions may be reused, but does not |
966 | 352 actually store session parameters in the cache. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
353 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
354 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
355 <tag-name><literal>builtin</literal></tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
356 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 a cache built in OpenSSL; used by one worker process only. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
358 The cache size is specified in sessions. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
359 If size is not given, it is equal to 20480 sessions. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
360 Use of the built-in cache can cause memory fragmentation. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
361 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
362 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
363 <tag-name><literal>shared</literal></tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 <tag-desc> |
966 | 365 a cache shared between all worker processes. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 The cache size is specified in bytes; one megabyte can store |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 about 4000 sessions. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
368 Each shared cache should have an arbitrary name. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 A cache with the same name can be used in several virtual servers. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 </list> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
373 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
374 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
375 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
376 Both cache types can be used simultaneously, for example: |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
377 <example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
378 ssl_session_cache builtin:1000 shared:SSL:10m; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
379 </example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
380 but using only shared cache without the built-in cache should |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
381 be more efficient. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
382 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
383 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
384 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
385 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
386 |
1019
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
387 <directive name="ssl_session_ticket_key"> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
388 <syntax><value>file</value></syntax> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
389 <default/> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
390 <context>http</context> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
391 <context>server</context> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
392 <appeared-in>1.5.7</appeared-in> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
393 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
394 <para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
395 Sets a <value>file</value> with the secret key used to encrypt |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
396 and decrypt TLS session tickets. |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
397 The directive is necessary if the same key has to be shared between |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
398 multiple servers. |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
399 By default, a randomly generated key is used. |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
400 </para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
401 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
402 <para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
403 If several keys are specified, only the first key is |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
404 used to encrypt TLS session tickets. |
1144
ac131944d349
Changed infinitive to gerund after "allow".
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1072
diff
changeset
|
405 This allows configuring key rotation, for example: |
1019
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
406 <example> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
407 ssl_session_ticket_key current.key; |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
408 ssl_session_ticket_key previous.key; |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
409 </example> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
410 </para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
411 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
412 <para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
413 The <value>file</value> must contain 48 bytes of random data and can |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
414 be created using the following command: |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
415 <example> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
416 openssl rand 48 > ticket.key |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
417 </example> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
418 </para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
419 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
420 </directive> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
421 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
422 |
1055
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
423 <directive name="ssl_session_tickets"> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
424 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
425 <default>on</default> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
426 <context>http</context> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
427 <context>server</context> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
428 <appeared-in>1.5.9</appeared-in> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
429 |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
430 <para> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
431 Enables or disables session resumption through |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
432 <link url="http://tools.ietf.org/html/rfc5077">TLS session tickets</link>. |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
433 </para> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
434 |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
435 </directive> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
436 |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
437 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
438 <directive name="ssl_session_timeout"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
439 <syntax><value>time</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
440 <default>5m</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
441 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
442 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
443 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
444 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
445 Specifies a time during which a client may reuse the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
446 session parameters stored in a cache. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
447 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
448 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
449 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
450 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
451 |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
452 <directive name="ssl_stapling"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
453 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
454 <default>off</default> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
455 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
456 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
457 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
458 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
459 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
460 Enables or disables |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
461 <link url="http://tools.ietf.org/html/rfc4366#section-3.6">stapling |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
462 of OCSP responses</link> by the server. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
463 Example: |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
464 <example> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
465 ssl_stapling on; |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
466 resolver 192.0.2.1; |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
467 </example> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
468 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
469 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
470 <para> |
966 | 471 For the OCSP stapling to work, the certificate of the server certificate |
472 issuer should be known. | |
712
2c9e8facc761
Resolved ambiguity regarding lists of certificates and fixed links.
Vladimir Homutov <vl@nginx.com>
parents:
696
diff
changeset
|
473 If the <link id="ssl_certificate"/> file does |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
474 not contain intermediate certificates, |
966 | 475 the certificate of the server certificate issuer should be |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
476 present in the |
712
2c9e8facc761
Resolved ambiguity regarding lists of certificates and fixed links.
Vladimir Homutov <vl@nginx.com>
parents:
696
diff
changeset
|
477 <link id="ssl_trusted_certificate"/> file. |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
478 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
479 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
480 <para> |
966 | 481 For a resolution of the OCSP responder hostname, |
482 the <link doc="ngx_http_core_module.xml" id="resolver"/> directive | |
483 should also be specified. | |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
484 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
485 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
486 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
487 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
488 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
489 <directive name="ssl_stapling_file"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
490 <syntax><value>file</value></syntax> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
491 <default/> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
492 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
493 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
494 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
495 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
496 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
497 When set, the stapled OCSP response will be taken from the |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
498 specified <value>file</value> instead of querying |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
499 the OCSP responder specified in the server certificate. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
500 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
501 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
502 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
503 The file should be in the DER format as produced by the |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
504 “<literal>openssl ocsp</literal>” command. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
505 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
506 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
507 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
508 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
509 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
510 <directive name="ssl_stapling_responder"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
511 <syntax><value>url</value></syntax> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
512 <default/> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
513 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
514 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
515 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
516 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
517 <para> |
966 | 518 Overrides the URL of the OCSP responder specified in the |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
519 “<link url="http://tools.ietf.org/html/rfc5280#section-4.2.2.1">Authority |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
520 Information Access</link>” certificate extension. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
521 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
522 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
523 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
524 Only “<literal>http://</literal>” OCSP responders are supported: |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
525 <example> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
526 ssl_stapling_responder http://ocsp.example.com/; |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
527 </example> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
528 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
529 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
530 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
531 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
532 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
533 <directive name="ssl_stapling_verify"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
534 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
535 <default>off</default> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
536 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
537 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
538 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
539 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
540 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
541 Enables or disables verification of OCSP responses by the server. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
542 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
543 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
544 <para> |
966 | 545 For verification to work, the certificate of the server certificate |
546 issuer, the root certificate, and all intermediate certificates | |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
547 should be configured as trusted using the |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
548 <link id="ssl_trusted_certificate"/> directive. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
549 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
550 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
551 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
552 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
553 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
554 <directive name="ssl_trusted_certificate"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
555 <syntax><value>file</value></syntax> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
556 <default/> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
557 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
558 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
559 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
560 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
561 <para> |
715
3f25469cbc49
Highlighted 'file' parameters in the http_ssl_module directives.
Vladimir Homutov <vl@nginx.com>
parents:
712
diff
changeset
|
562 Specifies a <value>file</value> with trusted CA certificates in the PEM format |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
563 used to verify client certificates and |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
564 OCSP responses if <link id="ssl_stapling"/> is enabled. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
565 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
566 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
567 <para> |
966 | 568 In contrast to the certificate set by <link id="ssl_client_certificate"/>, |
569 the list of these certificates will not be sent to clients. | |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
570 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
571 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
572 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
573 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
574 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
575 <directive name="ssl_verify_client"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
576 <syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
577 <literal>on</literal> | <literal>off</literal> | |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
578 <literal>optional</literal> | <literal>optional_no_ca</literal></syntax> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
579 <default>off</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
580 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
581 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
582 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
583 <para> |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
584 Enables verification of client certificates. |
966 | 585 The verification result is stored in the |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
586 <var>$ssl_client_verify</var> variable. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
587 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
588 |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
589 <para> |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
590 The <literal>optional</literal> parameter (0.8.7+) requests the client |
966 | 591 certificate and verifies it if the certificate is present. |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
592 </para> |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
593 |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
594 <para> |
763
cd581dbdaf76
The "optional_no_ca" parameter of the "ssl_verify_client" directive
Ruslan Ermilov <ru@nginx.com>
parents:
717
diff
changeset
|
595 The <literal>optional_no_ca</literal> parameter (1.3.8, 1.2.5) |
cd581dbdaf76
The "optional_no_ca" parameter of the "ssl_verify_client" directive
Ruslan Ermilov <ru@nginx.com>
parents:
717
diff
changeset
|
596 requests the client |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
597 certificate but does not require it to be signed by a trusted CA certificate. |
966 | 598 This is intended for the use in cases when a service that is external to nginx |
599 performs the actual certificate verification. | |
600 The contents of the certificate is accessible through the | |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
601 <var>$ssl_client_cert</var> variable. |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
602 </para> |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
603 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
604 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
605 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
606 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
607 <directive name="ssl_verify_depth"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
608 <syntax><value>number</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
609 <default>1</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
610 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
611 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
612 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
613 <para> |
966 | 614 Sets the verification depth in the client certificates chain. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
615 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
616 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
617 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
618 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
619 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
620 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
621 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
622 <section id="errors" name="Error Processing"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
623 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
624 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
625 The <literal>ngx_http_ssl_module</literal> module supports several |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
626 non-standard error codes that can be used for redirects using the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
627 <link doc="ngx_http_core_module.xml" id="error_page"/> directive: |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
628 <list type="tag"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
629 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
630 <tag-name>495</tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
631 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
632 an error has occurred during the client certificate verification; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
633 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
634 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
635 <tag-name>496</tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
636 <tag-desc> |
966 | 637 a client has not presented the required certificate; |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
638 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
639 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
640 <tag-name>497</tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
641 <tag-desc> |
966 | 642 a regular request has been sent to the HTTPS port. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
643 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
644 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
645 </list> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
646 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
647 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
648 <para> |
966 | 649 The redirection happens after the request is fully parsed and |
650 the variables, such as <var>$request_uri</var>, | |
651 <var>$uri</var>, <var>$args</var> and others, are available. | |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
652 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
653 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
654 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
655 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
656 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
657 <section id="variables" name="Embedded Variables"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
658 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
659 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
660 The <literal>ngx_http_ssl_module</literal> module supports |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
661 several embedded variables: |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
662 <list type="tag"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
663 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
664 <tag-name id="var_ssl_cipher"><var>$ssl_cipher</var></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
665 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
666 returns the string of ciphers used |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
667 for an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
668 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
669 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
670 <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
671 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
672 returns the client certificate in the PEM format |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
673 for an established SSL connection, with each line except the first |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
674 prepended with the tab character; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
675 this is intended for the use in the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
676 <link doc="ngx_http_proxy_module.xml" id="proxy_set_header"/> directive; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
677 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
678 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
679 <tag-name id="var_ssl_client_raw_cert"><var>$ssl_client_raw_cert</var> |
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
680 </tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
681 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
682 returns the client certificate in the PEM format |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
683 for an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
684 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
685 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
686 <tag-name id="var_ssl_client_serial"><var>$ssl_client_serial</var></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
687 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
688 returns the serial number of the client certificate |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
689 for an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
690 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
691 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
692 <tag-name id="var_ssl_client_s_dn"><var>$ssl_client_s_dn</var></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
693 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
694 returns the “subject DN” string of the client certificate |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
695 for an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
696 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
697 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
698 <tag-name id="var_ssl_client_i_dn"><var>$ssl_client_i_dn</var></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
699 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
700 returns the “issuer DN” string of the client certificate |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
701 for an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
702 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
703 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
704 <tag-name id="var_ssl_client_verify"><var>$ssl_client_verify</var></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
705 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
706 returns the result of client certificate verification: |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
707 “<literal>SUCCESS</literal>”, “<literal>FAILED</literal>”, and |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
708 “<literal>NONE</literal>” if a certificate was not present; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
709 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
710 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
711 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
712 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
713 returns the protocol of an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
714 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
715 |
1167
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
716 <tag-name id="var_ssl_server_name"><var>$ssl_server_name</var></tag-name> |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
717 <tag-desc> |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
718 returns the server name requested through |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
719 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">SNI</link> |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
720 (1.7.0); |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
721 </tag-desc> |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
722 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
723 <tag-name id="var_ssl_session_id"><var>$ssl_session_id</var></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
724 <tag-desc> |
1072
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
725 returns the session identifier of an established SSL connection; |
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
726 </tag-desc> |
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
727 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
728 <tag-name id="var_ssl_session_reused"><var>$ssl_session_reused</var></tag-name> |
1072
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
729 <tag-desc> |
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
730 returns “<literal>r</literal>” if an SSL session was reused, |
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
731 or “<literal>.</literal>” otherwise (1.5.11). |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
732 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
733 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
734 </list> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
735 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
736 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
737 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
738 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
739 </module> |