Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_ssl_module.xml @ 2091:fe66463d0799
Updated OpenSSL version used for win32 builds.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 27 Dec 2017 22:01:58 +0300 |
parents | 3d9e7993c201 |
children | aa5d65fe4916 |
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" |
2068
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
13 rev="37"> |
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> |
2068
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
42 set the number of |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
43 <link doc="../ngx_core_module.xml" id="worker_processes">worker processes</link> |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
44 equal to the number of processors, |
384
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 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 <listitem> |
2068
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
48 enable |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
49 <link doc="ngx_http_core_module.xml" id="keepalive_timeout">keep-alive</link> |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
50 connections, |
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> |
2068
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
54 enable the <link id="ssl_session_cache_shared">shared</link> 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> |
2068
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
58 disable the <link id="ssl_session_cache_builtin">built-in</link> session cache, |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
59 </listitem> |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
60 |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
61 <listitem> |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
62 and possibly increase the session <link id="ssl_session_timeout">lifetime</link> |
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
63 (by default, 5 minutes): |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
64 </listitem> |
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 </list> |
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 <example> |
817
4fecf0715bbf
Introducing "worker_processes auto" in SSL configuration examples.
Andrei Belov <defan@nginx.com>
parents:
801
diff
changeset
|
69 <emphasis>worker_processes auto;</emphasis> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 http { |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 |
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 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 server { |
801
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
76 listen 443 ssl; |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 <emphasis>keepalive_timeout 70;</emphasis> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 |
1411
8fe28c6edaa1
Removed SSLv3 from ssl_protocols parameters list as insecure example.
Sergey Budnevitch <sb@waeme.net>
parents:
1239
diff
changeset
|
79 ssl_protocols TLSv1 TLSv1.1 TLSv1.2; |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 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
|
81 ssl_certificate /usr/local/nginx/conf/cert.pem; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 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
|
83 <emphasis>ssl_session_cache shared:SSL:10m;</emphasis> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 <emphasis>ssl_session_timeout 10m;</emphasis> |
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 ... |
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 </example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 </para> |
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 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 <section id="directives" name="Directives"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 <directive name="ssl"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 <default>off</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 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
|
104 <note> |
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
105 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
|
106 <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
|
107 of this directive. |
b95a6d779c89
Documented that "listen ... ssl" is preferred over "ssl on".
Ruslan Ermilov <ru@nginx.com>
parents:
763
diff
changeset
|
108 </note> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 |
1039
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
114 <directive name="ssl_buffer_size"> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
115 <syntax><value>size</value></syntax> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
116 <default>16k</default> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
117 <context>http</context> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
118 <context>server</context> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
119 <appeared-in>1.5.9</appeared-in> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
120 |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
121 <para> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
122 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
|
123 </para> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
124 |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
125 <para> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
126 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
|
127 overhead when sending big responses. |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
128 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
|
129 for example: |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
130 <example> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
131 ssl_buffer_size 4k; |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
132 </example> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
133 </para> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
134 |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
135 </directive> |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
136 |
f7ca80263893
Documented the "ssl_buffer_size" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1019
diff
changeset
|
137 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 <directive name="ssl_certificate"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 <para> |
966 | 145 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
|
146 for the given virtual server. |
1457
78ccd1af1400
Minimized diffs between http, mail, and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1456
diff
changeset
|
147 If intermediate certificates should be specified in addition to a primary |
78ccd1af1400
Minimized diffs between http, mail, and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1456
diff
changeset
|
148 certificate, they should be specified in the same file in the following |
78ccd1af1400
Minimized diffs between http, mail, and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1456
diff
changeset
|
149 order: the primary certificate comes first, then the intermediate certificates. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 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
|
151 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 <para> |
1726
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
154 Since version 1.11.0, |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
155 this directive can be specified multiple times |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
156 to load certificates of different types, for example, RSA and ECDSA: |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
157 <example> |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
158 server { |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
159 listen 443 ssl; |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
160 server_name example.com; |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
161 |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
162 ssl_certificate example.com.rsa.crt; |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
163 ssl_certificate_key example.com.rsa.key; |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
164 |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
165 ssl_certificate example.com.ecdsa.crt; |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
166 ssl_certificate_key example.com.ecdsa.key; |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
167 |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
168 ... |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
169 } |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
170 </example> |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
171 <note> |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
172 Only OpenSSL 1.0.2 or higher supports separate |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
173 <link doc="configuring_https_servers.xml" id="chains">certificate chains</link> |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
174 for different certificates. |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
175 With older versions, only one certificate chain can be used. |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
176 </note> |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
177 </para> |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
178 |
a0bc284941f6
Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1725
diff
changeset
|
179 <para> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 It should be kept in mind that due to the HTTPS protocol limitations |
2040
093855e77388
Updated info about SNI.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2027
diff
changeset
|
181 for maximum interoperability virtual servers should listen on |
093855e77388
Updated info about SNI.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2027
diff
changeset
|
182 <link doc="configuring_https_servers.xml" id="name_based_https_servers">different |
093855e77388
Updated info about SNI.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2027
diff
changeset
|
183 IP addresses</link>. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 |
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 <directive name="ssl_certificate_key"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 <para> |
966 | 196 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
|
197 for the given virtual server. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 |
1456
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1428
diff
changeset
|
200 <para> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1428
diff
changeset
|
201 The value |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1428
diff
changeset
|
202 <literal>engine</literal>:<value>name</value>:<value>id</value> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1428
diff
changeset
|
203 can be specified instead of the <value>file</value> (1.7.9), |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1428
diff
changeset
|
204 which loads a secret key with a specified <value>id</value> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1428
diff
changeset
|
205 from the OpenSSL engine <value>name</value>. |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1428
diff
changeset
|
206 </para> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1428
diff
changeset
|
207 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 <directive name="ssl_ciphers"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 <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
|
213 <default>HIGH:!aNULL:!MD5</default> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 Specifies the enabled ciphers. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 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
|
220 OpenSSL library, for example: |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 <example> |
538
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
222 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
|
223 </example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 The full list can be viewed using the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 “<command>openssl ciphers</command>” command. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 |
538
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
231 <para> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
232 <note> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
233 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
|
234 <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
|
235 ciphers by default. |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
236 </note> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
237 </para> |
58dd64aef626
Documented ciphers used by default in modern nginx versions (closes #177).
Ruslan Ermilov <ru@nginx.com>
parents:
393
diff
changeset
|
238 |
384
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_client_certificate"> |
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 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
248 <para> |
715
3f25469cbc49
Highlighted 'file' parameters in the http_ssl_module directives.
Vladimir Homutov <vl@nginx.com>
parents:
712
diff
changeset
|
249 Specifies a <value>file</value> with trusted CA certificates in the PEM format |
1428
933831d7bf0b
Link to "ssl_verify_client" from client certificate directives.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1411
diff
changeset
|
250 used to <link id="ssl_verify_client">verify</link> client certificates and |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
251 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
|
252 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
253 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
254 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
255 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
|
256 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
|
257 directive can be used. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
263 <directive name="ssl_crl"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
264 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
265 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 <appeared-in>0.8.7</appeared-in> |
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 <para> |
715
3f25469cbc49
Highlighted 'file' parameters in the http_ssl_module directives.
Vladimir Homutov <vl@nginx.com>
parents:
712
diff
changeset
|
271 Specifies a <value>file</value> with revoked certificates (CRL) |
1428
933831d7bf0b
Link to "ssl_verify_client" from client certificate directives.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1411
diff
changeset
|
272 in the PEM format used to <link id="ssl_verify_client">verify</link> |
933831d7bf0b
Link to "ssl_verify_client" from client certificate directives.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1411
diff
changeset
|
273 client certificates. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
275 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
277 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
278 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 <directive name="ssl_dhparam"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
280 <syntax><value>file</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
281 <default/> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
282 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
284 <appeared-in>0.7.2</appeared-in> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
285 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 <para> |
1706
6f5497797cde
Changed "EDH ciphers" to "DHE ciphers".
Maxim Dounin <mdounin@mdounin.ru>
parents:
1499
diff
changeset
|
287 Specifies a <value>file</value> with DH parameters for DHE ciphers. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 </directive> |
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 |
1054
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
293 <directive name="ssl_ecdh_curve"> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
294 <syntax><value>curve</value></syntax> |
1711
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
295 <default>auto</default> |
1054
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
296 <context>http</context> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
297 <context>server</context> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
298 <appeared-in>1.1.0</appeared-in> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
299 <appeared-in>1.0.6</appeared-in> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
300 |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
301 <para> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
302 Specifies a <value>curve</value> for ECDHE ciphers. |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
303 </para> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
304 |
1711
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
305 <para> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
306 When using OpenSSL 1.0.2 or higher, |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
307 it is possible to specify multiple curves (1.11.0), for example: |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
308 <example> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
309 ssl_ecdh_curve prime256v1:secp384r1; |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
310 </example> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
311 </para> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
312 |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
313 <para> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
314 The special value <literal>auto</literal> (1.11.0) instructs nginx to use |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
315 a list built into the OpenSSL library when using OpenSSL 1.0.2 or higher, |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
316 or <literal>prime256v1</literal> with older versions. |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
317 </para> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
318 |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
319 <para> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
320 <note> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
321 Prior to version 1.11.0, |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
322 the <literal>prime256v1</literal> curve was used by default. |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
323 </note> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
324 </para> |
38fb3e6b71e8
Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1706
diff
changeset
|
325 |
1054
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
326 </directive> |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
327 |
c5793e5c30d4
Documented the "ssl_ecdh_curve" directive.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1039
diff
changeset
|
328 |
1239
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
329 <directive name="ssl_password_file"> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
330 <syntax><value>file</value></syntax> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
331 <default/> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
332 <context>http</context> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
333 <context>server</context> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
334 <appeared-in>1.7.3</appeared-in> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
335 |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
336 <para> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
337 Specifies a <value>file</value> with passphrases for |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
338 <link id="ssl_certificate_key">secret keys</link> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
339 where each passphrase is specified on a separate line. |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
340 Passphrases are tried in turn when loading the key. |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
341 </para> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
342 |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
343 <para> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
344 Example: |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
345 <example> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
346 http { |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
347 ssl_password_file /etc/keys/global.pass; |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
348 ... |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
349 |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
350 server { |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
351 server_name www1.example.com; |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
352 ssl_certificate_key /etc/keys/first.key; |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
353 } |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
354 |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
355 server { |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
356 server_name www2.example.com; |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
357 |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
358 # named pipe can also be used instead of a file |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
359 ssl_password_file /etc/keys/fifo; |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
360 ssl_certificate_key /etc/keys/second.key; |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
361 } |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
362 } |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
363 </example> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
364 </para> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
365 |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
366 </directive> |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
367 |
35cf5dca5fa4
SSL: added the ssl_password_file directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1201
diff
changeset
|
368 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 <directive name="ssl_prefer_server_ciphers"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 <default>off</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
373 <context>server</context> |
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 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
|
377 ciphers when using the SSLv3 and TLS protocols. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
378 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
379 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
380 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
381 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
382 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
383 <directive name="ssl_protocols"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
384 <syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
385 [<literal>SSLv2</literal>] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
386 [<literal>SSLv3</literal>] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
387 [<literal>TLSv1</literal>] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
388 [<literal>TLSv1.1</literal>] |
1978
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
389 [<literal>TLSv1.2</literal>] |
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
390 [<literal>TLSv1.3</literal>]</syntax> |
1499
3687cc9a3592
Removed SSLv3 from the default value of ssl_protocols and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1457
diff
changeset
|
391 <default>TLSv1 TLSv1.1 TLSv1.2</default> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
392 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
393 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
394 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
395 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
396 Enables the specified protocols. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
397 <note> |
1978
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
398 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters |
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
399 (1.1.13, 1.0.12) work only when OpenSSL 1.0.1 or higher is used. |
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
400 </note> |
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
401 <note> |
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
402 The <literal>TLSv1.3</literal> parameter (1.13.0) works only when |
8f1a568a8bbf
Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1923
diff
changeset
|
403 OpenSSL 1.1.1 built with TLSv1.3 support is used. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
404 </note> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
405 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
406 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
407 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
408 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
409 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
410 <directive name="ssl_session_cache"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
411 <syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
412 <literal>off</literal> | |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 <literal>none</literal> | |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
414 [<literal>builtin</literal>[:<value>size</value>]] |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
415 [<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
|
416 <default>none</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
417 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
418 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
419 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
420 <para> |
966 | 421 Sets the types and sizes of caches that store session parameters. |
422 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
|
423 <list type="tag"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
424 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
425 <tag-name><literal>off</literal></tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
426 <tag-desc> |
966 | 427 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
|
428 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
|
429 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
430 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
431 <tag-name><literal>none</literal></tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
432 <tag-desc> |
966 | 433 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
|
434 nginx tells a client that sessions may be reused, but does not |
966 | 435 actually store session parameters in the cache. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
436 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
437 |
2068
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
438 <tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
439 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
440 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
|
441 The cache size is specified in sessions. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
442 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
|
443 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
|
444 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
445 |
2068
3d9e7993c201
Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2040
diff
changeset
|
446 <tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
447 <tag-desc> |
966 | 448 a cache shared between all worker processes. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
449 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
|
450 about 4000 sessions. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
451 Each shared cache should have an arbitrary name. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
452 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
|
453 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
454 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
455 </list> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
456 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
457 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
458 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
459 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
|
460 <example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
461 ssl_session_cache builtin:1000 shared:SSL:10m; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
462 </example> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
463 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
|
464 be more efficient. |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
465 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
466 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
467 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
468 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
469 |
1019
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
470 <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
|
471 <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
|
472 <default/> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
473 <context>http</context> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
474 <context>server</context> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
475 <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
|
476 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
477 <para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
478 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
|
479 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
|
480 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
|
481 multiple servers. |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
482 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
|
483 </para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
484 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
485 <para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
486 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
|
487 used to encrypt TLS session tickets. |
1144
ac131944d349
Changed infinitive to gerund after "allow".
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1072
diff
changeset
|
488 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
|
489 <example> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
490 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
|
491 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
|
492 </example> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
493 </para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
494 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
495 <para> |
1877
aa29a64a5e9d
Documented ssl_session_ticket_key 80-byte keys.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1871
diff
changeset
|
496 The <value>file</value> must contain 80 or 48 bytes |
aa29a64a5e9d
Documented ssl_session_ticket_key 80-byte keys.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1871
diff
changeset
|
497 of random data and can be created using the following command: |
1019
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
498 <example> |
1877
aa29a64a5e9d
Documented ssl_session_ticket_key 80-byte keys.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1871
diff
changeset
|
499 openssl rand 80 > ticket.key |
1019
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
500 </example> |
1877
aa29a64a5e9d
Documented ssl_session_ticket_key 80-byte keys.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1871
diff
changeset
|
501 Depending on the file size either AES256 (for 80-byte keys, 1.11.8) |
aa29a64a5e9d
Documented ssl_session_ticket_key 80-byte keys.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1871
diff
changeset
|
502 or AES128 (for 48-byte keys) is used for encryption. |
1019
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
503 </para> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
504 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
505 </directive> |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
506 |
2b6a858c60dc
Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents:
966
diff
changeset
|
507 |
1055
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
508 <directive name="ssl_session_tickets"> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
509 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
510 <default>on</default> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
511 <context>http</context> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
512 <context>server</context> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
513 <appeared-in>1.5.9</appeared-in> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
514 |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
515 <para> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
516 Enables or disables session resumption through |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1877
diff
changeset
|
517 <link url="https://tools.ietf.org/html/rfc5077">TLS session tickets</link>. |
1055
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
518 </para> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
519 |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
520 </directive> |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
521 |
e26a9f598e40
Documented the "ssl_session_tickets" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1054
diff
changeset
|
522 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
523 <directive name="ssl_session_timeout"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
524 <syntax><value>time</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
525 <default>5m</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
526 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
527 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
528 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
529 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
530 Specifies a time during which a client may reuse the |
1785
3fa0944ddc6a
Removed info about session cache from ssl_session_timeout.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1726
diff
changeset
|
531 session parameters. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
532 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
533 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
534 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
535 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
536 |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
537 <directive name="ssl_stapling"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
538 <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
|
539 <default>off</default> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
540 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
541 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
542 <appeared-in>1.3.7</appeared-in> |
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> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
545 Enables or disables |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1877
diff
changeset
|
546 <link url="https://tools.ietf.org/html/rfc4366#section-3.6">stapling |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
547 of OCSP responses</link> by the server. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
548 Example: |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
549 <example> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
550 ssl_stapling on; |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
551 resolver 192.0.2.1; |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
552 </example> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
553 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
554 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
555 <para> |
966 | 556 For the OCSP stapling to work, the certificate of the server certificate |
557 issuer should be known. | |
712
2c9e8facc761
Resolved ambiguity regarding lists of certificates and fixed links.
Vladimir Homutov <vl@nginx.com>
parents:
696
diff
changeset
|
558 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
|
559 not contain intermediate certificates, |
966 | 560 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
|
561 present in the |
712
2c9e8facc761
Resolved ambiguity regarding lists of certificates and fixed links.
Vladimir Homutov <vl@nginx.com>
parents:
696
diff
changeset
|
562 <link id="ssl_trusted_certificate"/> file. |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
563 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
564 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
565 <para> |
966 | 566 For a resolution of the OCSP responder hostname, |
567 the <link doc="ngx_http_core_module.xml" id="resolver"/> directive | |
568 should also be specified. | |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
569 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
570 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
571 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
572 |
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 <directive name="ssl_stapling_file"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
575 <syntax><value>file</value></syntax> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
576 <default/> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
577 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
578 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
579 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
580 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
581 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
582 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
|
583 specified <value>file</value> instead of querying |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
584 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
|
585 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
586 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
587 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
588 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
|
589 “<literal>openssl ocsp</literal>” command. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
590 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
591 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
592 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
593 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
594 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
595 <directive name="ssl_stapling_responder"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
596 <syntax><value>url</value></syntax> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
597 <default/> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
598 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
599 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
600 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
601 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
602 <para> |
966 | 603 Overrides the URL of the OCSP responder specified in the |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1877
diff
changeset
|
604 “<link url="https://tools.ietf.org/html/rfc5280#section-4.2.2.1">Authority |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
605 Information Access</link>” certificate extension. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
606 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
607 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
608 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
609 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
|
610 <example> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
611 ssl_stapling_responder http://ocsp.example.com/; |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
612 </example> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
613 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
614 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
615 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
616 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
617 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
618 <directive name="ssl_stapling_verify"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
619 <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
|
620 <default>off</default> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
621 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
622 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
623 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
624 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
625 <para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
626 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
|
627 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
628 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
629 <para> |
966 | 630 For verification to work, the certificate of the server certificate |
631 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
|
632 should be configured as trusted using the |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
633 <link id="ssl_trusted_certificate"/> directive. |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
634 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
635 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
636 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
637 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
638 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
639 <directive name="ssl_trusted_certificate"> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
640 <syntax><value>file</value></syntax> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
641 <default/> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
642 <context>http</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
643 <context>server</context> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
644 <appeared-in>1.3.7</appeared-in> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
645 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
646 <para> |
715
3f25469cbc49
Highlighted 'file' parameters in the http_ssl_module directives.
Vladimir Homutov <vl@nginx.com>
parents:
712
diff
changeset
|
647 Specifies a <value>file</value> with trusted CA certificates in the PEM format |
1428
933831d7bf0b
Link to "ssl_verify_client" from client certificate directives.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1411
diff
changeset
|
648 used to <link id="ssl_verify_client">verify</link> client certificates and |
695
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
649 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
|
650 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
651 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
652 <para> |
966 | 653 In contrast to the certificate set by <link id="ssl_client_certificate"/>, |
654 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
|
655 </para> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
656 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
657 </directive> |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
658 |
2eb83e89b239
Added the OCSP stapling documentation in English.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
659 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
660 <directive name="ssl_verify_client"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
661 <syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
662 <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
|
663 <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
|
664 <default>off</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
665 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
666 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
667 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
668 <para> |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
669 Enables verification of client certificates. |
966 | 670 The verification result is stored in the |
1871
5f156621b8b5
Added links to $ssl_client_verify and $ssl_client_cert.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1870
diff
changeset
|
671 <link id="var_ssl_client_verify">$ssl_client_verify</link> variable. |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
672 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
673 |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
674 <para> |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
675 The <literal>optional</literal> parameter (0.8.7+) requests the client |
966 | 676 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
|
677 </para> |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
678 |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
679 <para> |
763
cd581dbdaf76
The "optional_no_ca" parameter of the "ssl_verify_client" directive
Ruslan Ermilov <ru@nginx.com>
parents:
717
diff
changeset
|
680 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
|
681 requests the client |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
682 certificate but does not require it to be signed by a trusted CA certificate. |
966 | 683 This is intended for the use in cases when a service that is external to nginx |
684 performs the actual certificate verification. | |
685 The contents of the certificate is accessible through the | |
1871
5f156621b8b5
Added links to $ssl_client_verify and $ssl_client_cert.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1870
diff
changeset
|
686 <link id="var_ssl_client_cert">$ssl_client_cert</link> variable. |
717
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
687 </para> |
c5facf2eff6f
Documented the recently added "optional_no_ca" parameter of the
Ruslan Ermilov <ru@nginx.com>
parents:
715
diff
changeset
|
688 |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
689 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
690 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
691 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
692 <directive name="ssl_verify_depth"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
693 <syntax><value>number</value></syntax> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
694 <default>1</default> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
695 <context>http</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
696 <context>server</context> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
697 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
698 <para> |
966 | 699 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
|
700 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
701 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
702 </directive> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
703 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
704 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
705 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
706 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
707 <section id="errors" name="Error Processing"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
708 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
709 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
710 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
|
711 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
|
712 <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
|
713 <list type="tag"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
714 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
715 <tag-name>495</tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
716 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
717 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
|
718 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
719 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
720 <tag-name>496</tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
721 <tag-desc> |
966 | 722 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
|
723 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
724 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
725 <tag-name>497</tag-name> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
726 <tag-desc> |
966 | 727 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
|
728 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
729 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
730 </list> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
731 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
732 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
733 <para> |
966 | 734 The redirection happens after the request is fully parsed and |
735 the variables, such as <var>$request_uri</var>, | |
736 <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
|
737 </para> |
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 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
740 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
741 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
742 <section id="variables" name="Embedded Variables"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
743 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
744 <para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
745 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
|
746 several embedded variables: |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
747 <list type="tag"> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
748 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
749 <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
|
750 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
751 returns the string of ciphers used |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
752 for an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
753 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
754 |
1857
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
755 <tag-name id="var_ssl_ciphers"><var>$ssl_ciphers</var></tag-name> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
756 <tag-desc> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
757 returns the list of ciphers supported by the client (1.11.7). |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
758 Known ciphers are listed by names, unknown are shown in hexadecimal, |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
759 for example: |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
760 <example> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
761 AES128-SHA:AES256-SHA:0x00ff |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
762 </example> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
763 <note> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
764 The variable is fully supported only when using OpenSSL version 1.0.2 or higher. |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
765 With older versions, the variable is available |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
766 only for new sessions and lists only known ciphers. |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
767 </note> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
768 </tag-desc> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
769 |
2027
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
770 <tag-name id="var_ssl_client_escaped_cert"><var>$ssl_client_escaped_cert</var></tag-name> |
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
771 <tag-desc> |
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
772 returns the client certificate in the PEM format (urlencoded) |
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
773 for an established SSL connection (1.13.5); |
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
774 </tag-desc> |
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
775 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
776 <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
|
777 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
778 returns the client certificate in the PEM format |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
779 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
|
780 prepended with the tab character; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
781 this is intended for the use in the |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
782 <link doc="ngx_http_proxy_module.xml" id="proxy_set_header"/> directive; |
2027
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
783 <note> |
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
784 The variable is deprecated, |
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
785 the <var>$ssl_client_escaped_cert</var> variable should be used instead. |
dabca59da4ce
Documented the $ssl_client_escaped_cert variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1978
diff
changeset
|
786 </note> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
787 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
788 |
1201
db4b017b5796
SSL: documented the ssl_client_fingerprint variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1167
diff
changeset
|
789 <tag-name id="var_ssl_client_fingerprint"><var>$ssl_client_fingerprint</var></tag-name> |
db4b017b5796
SSL: documented the ssl_client_fingerprint variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1167
diff
changeset
|
790 <tag-desc> |
db4b017b5796
SSL: documented the ssl_client_fingerprint variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1167
diff
changeset
|
791 returns the SHA1 fingerprint of the client certificate |
db4b017b5796
SSL: documented the ssl_client_fingerprint variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1167
diff
changeset
|
792 for an established SSL connection (1.7.1); |
db4b017b5796
SSL: documented the ssl_client_fingerprint variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1167
diff
changeset
|
793 </tag-desc> |
db4b017b5796
SSL: documented the ssl_client_fingerprint variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1167
diff
changeset
|
794 |
1870
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
795 <tag-name id="var_ssl_client_i_dn"><var>$ssl_client_i_dn</var></tag-name> |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
796 <tag-desc> |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
797 returns the “issuer DN” string of the client certificate |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
798 for an established SSL connection according to |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
799 <link url="https://tools.ietf.org/html/rfc2253">RFC 2253</link> (1.11.6); |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
800 </tag-desc> |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
801 |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
802 <tag-name id="var_ssl_client_i_dn_legacy"><var>$ssl_client_i_dn_legacy</var></tag-name> |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
803 <tag-desc> |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
804 returns the “issuer DN” string of the client certificate |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
805 for an established SSL connection; |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
806 <note> |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
807 Prior to version 1.11.6, the variable name was <var>$ssl_client_i_dn</var>. |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
808 </note> |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
809 </tag-desc> |
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
810 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
811 <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
|
812 </tag-name> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
813 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
814 returns the client certificate in the PEM format |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
815 for an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
816 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
817 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
818 <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
|
819 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
820 returns the “subject DN” string of the client certificate |
1824
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
821 for an established SSL connection according to |
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
822 <link url="https://tools.ietf.org/html/rfc2253">RFC 2253</link> (1.11.6); |
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
823 </tag-desc> |
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
824 |
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
825 <tag-name id="var_ssl_client_s_dn_legacy"><var>$ssl_client_s_dn_legacy</var></tag-name> |
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
826 <tag-desc> |
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
827 returns the “subject DN” string of the client certificate |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
828 for an established SSL connection; |
1824
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
829 <note> |
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
830 Prior to version 1.11.6, the variable name was <var>$ssl_client_s_dn</var>. |
e8811a423130
Added RFC2253-compliant $ssl_client_s_dn, $ssl_client_i_dn and legacy vars.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1785
diff
changeset
|
831 </note> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
832 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
833 |
1870
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
834 <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
|
835 <tag-desc> |
1870
fa7542e40381
Relocated $ssl_client_i_dn, $ssl_client_i_dn_legacy, $ssl_client_serial.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1863
diff
changeset
|
836 returns the serial number of the client certificate |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
837 for an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
838 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
839 |
1855
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
840 <tag-name id="var_ssl_client_v_end"><var>$ssl_client_v_end</var></tag-name> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
841 <tag-desc> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
842 returns the end date of the client certificate (1.11.7); |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
843 </tag-desc> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
844 |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
845 <tag-name id="var_ssl_client_v_remain"><var>$ssl_client_v_remain</var></tag-name> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
846 <tag-desc> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
847 returns the number of days |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
848 until the client certificate expires (1.11.7); |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
849 </tag-desc> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
850 |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
851 <tag-name id="var_ssl_client_v_start"><var>$ssl_client_v_start</var></tag-name> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
852 <tag-desc> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
853 returns the start date of the client certificate (1.11.7); |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
854 </tag-desc> |
2ef67c4d2226
Documented $ssl_client_v_end, $ssl_client_v_start, $ssl_client_v_remain variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1824
diff
changeset
|
855 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
856 <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
|
857 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
858 returns the result of client certificate verification: |
1856
7133004fa5b3
$ssl_client_verify extended with a failure reason.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1855
diff
changeset
|
859 “<literal>SUCCESS</literal>”, “<literal>FAILED:</literal><value>reason</value>”, |
1863
fef4ab2d990c
Removed unnecessary version for "FAILED:reason" in $ssl_client_verify.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1857
diff
changeset
|
860 and “<literal>NONE</literal>” if a certificate was not present; |
1856
7133004fa5b3
$ssl_client_verify extended with a failure reason.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1855
diff
changeset
|
861 <note> |
7133004fa5b3
$ssl_client_verify extended with a failure reason.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1855
diff
changeset
|
862 Prior to version 1.11.7, the “<literal>FAILED</literal>” result |
7133004fa5b3
$ssl_client_verify extended with a failure reason.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1855
diff
changeset
|
863 did not contain the <value>reason</value> string. |
7133004fa5b3
$ssl_client_verify extended with a failure reason.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1855
diff
changeset
|
864 </note> |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
865 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
866 |
1857
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
867 <tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
868 <tag-desc> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
869 returns the list of curves supported by the client (1.11.7). |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
870 Known curves are listed by names, unknown are shown in hexadecimal, |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
871 for example: |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
872 <example> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
873 0x001d:prime256v1:secp521r1:secp384r1 |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
874 </example> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
875 <note> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
876 The variable is supported only when using OpenSSL version 1.0.2 or higher. |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
877 With older versions, the variable value will be an empty string. |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
878 </note> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
879 <note> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
880 The variable is available only for new sessions. |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
881 </note> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
882 </tag-desc> |
0882ccb0c00f
Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1856
diff
changeset
|
883 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
884 <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
|
885 <tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
886 returns the protocol of an established SSL connection; |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
887 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
888 |
1167
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
889 <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
|
890 <tag-desc> |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
891 returns the server name requested through |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
892 <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
|
893 (1.7.0); |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
894 </tag-desc> |
cac06b81957c
Documented the $ssl_server_name variable.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
895 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
896 <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
|
897 <tag-desc> |
1072
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
898 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
|
899 </tag-desc> |
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
900 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1144
diff
changeset
|
901 <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
|
902 <tag-desc> |
502f4be2d62e
Documented the "ssl_session_reused" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1055
diff
changeset
|
903 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
|
904 or “<literal>.</literal>” otherwise (1.5.11). |
384
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
905 </tag-desc> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
906 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
907 </list> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
908 </para> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
909 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
910 </section> |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
911 |
331a86bc51ff
English translation of ngx_http_ssl_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
912 </module> |