Mercurial > hg > nginx-site

annotate xml/en/docs/stream/ngx_stream_ssl_module.xml @ 2865:0d355d154181

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Corrected syntax of ssl_conf_command and friends. Each directive takes exactly two arguments: command name and value.
author Sergey Kandaurov <pluknet@nginx.com>
date Thu, 23 Jun 2022 14:00:09 +0400
parents 92e5dca02091
children 8033ffaedeb9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <!--
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 -->
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9 <module name="Module ngx_stream_ssl_module"
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 link="/en/docs/stream/ngx_stream_ssl_module.html"
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 lang="en"
2865
0d355d154181 Corrected syntax of ssl_conf_command and friends.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2837
diff changeset
12 rev="30">
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 <section id="summary">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 <para>
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1456
diff changeset
17 The <literal>ngx_stream_ssl_module</literal> module (1.9.0)
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 provides the necessary support for a stream proxy server to work with
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 the SSL/TLS protocol.
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1456
diff changeset
20 This module is not built by default, it should be enabled with the
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1456
diff changeset
21 <literal>--with-stream_ssl_module</literal>
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1456
diff changeset
22 configuration parameter.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 </section>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27
1521
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
28 <section id="example" name="Example Configuration">
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
29
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
30 <para>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
31 To reduce the processor load, it is recommended to
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
32 <list type="bullet">
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
33
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
34 <listitem>
2068
3d9e7993c201 Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1978
diff changeset
35 set the number of
3d9e7993c201 Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1978
diff changeset
36 <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: 1978
diff changeset
37 equal to the number of processors,
1521
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
38 </listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
39
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
40 <listitem>
2068
3d9e7993c201 Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1978
diff changeset
41 enable the <link id="ssl_session_cache_shared">shared</link> session cache,
1521
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
42 </listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
43
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
44 <listitem>
2068
3d9e7993c201 Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1978
diff changeset
45 disable the <link id="ssl_session_cache_builtin">built-in</link> session cache,
1521
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
46 </listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
47
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
48 <listitem>
2068
3d9e7993c201 Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1978
diff changeset
49 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: 1978
diff changeset
50 (by default, 5 minutes):
1521
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
51 </listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
52
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
53 </list>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
54
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
55 <example>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
56 <emphasis>worker_processes auto;</emphasis>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
57
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
58 stream {
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
59
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
60 ...
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
61
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
62 server {
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
63 listen 12345 ssl;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
64
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
65 ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
66 ssl_ciphers AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
67 ssl_certificate /usr/local/nginx/conf/cert.pem;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
68 ssl_certificate_key /usr/local/nginx/conf/cert.key;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
69 <emphasis>ssl_session_cache shared:SSL:10m;</emphasis>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
70 <emphasis>ssl_session_timeout 10m;</emphasis>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
71
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
72 ...
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
73 }
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
74 </example>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
75 </para>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
76
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
77 </section>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
78
e3d3e2ed4275 Added example configuration to mail and stream ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
79
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <section id="directives" name="Directives">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81
2790
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
82 <directive name="ssl_alpn">
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
83 <syntax><value>protocol</value> ...</syntax>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
84 <default/>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
85 <context>stream</context>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
86 <context>server</context>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
87 <appeared-in>1.21.4</appeared-in>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
88
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
89 <para>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
90 Specifies the list of supported
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
91 <link url="https://datatracker.ietf.org/doc/html/rfc7301">ALPN</link> protocols.
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
92 One of the protocols must be
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
93 <link id="var_ssl_alpn_protocol">negotiated</link> if the client uses ALPN:
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
94 <example>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
95 map $ssl_alpn_protocol $proxy {
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
96 h2 127.0.0.1:8001;
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
97 http/1.1 127.0.0.1:8002;
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
98 }
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
99
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
100 server {
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
101 listen 12346;
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
102 proxy_pass $proxy;
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
103 ssl_alpn h2 http/1.1;
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
104 }
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
105 </example>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
106 </para>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
107
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
108 </directive>
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
109
a281f61b5ad8 Documented the ssl_alpn directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2789
diff changeset
110
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <directive name="ssl_certificate">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 <para>
1456
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
118 Specifies a <value>file</value> with the certificate in the PEM format
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
119 for the given server.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 If intermediate certificates should be specified in addition to a primary
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 certificate, they should be specified in the same file in the following
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 order: the primary certificate comes first, then the intermediate certificates.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 A secret key in the PEM format may be placed in the same file.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125
1726
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
126 <para>
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
127 Since version 1.11.0,
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
128 this directive can be specified multiple times
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
129 to load certificates of different types, for example, RSA and ECDSA:
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
130 <example>
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
131 server {
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
132 listen 12345 ssl;
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
133
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
134 ssl_certificate example.com.rsa.crt;
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
135 ssl_certificate_key example.com.rsa.key;
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
136
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
137 ssl_certificate example.com.ecdsa.crt;
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
138 ssl_certificate_key example.com.ecdsa.key;
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
139
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
140 ...
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
141 }
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
142 </example>
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
143 <note>
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
144 Only OpenSSL 1.0.2 or higher supports separate certificate chains
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
145 for different certificates.
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
146 With older versions, only one certificate chain can be used.
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
147 </note>
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
148 </para>
a0bc284941f6 Documented multiple certificates support.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1711
diff changeset
149
2334
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
150 <para>
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
151 Since version 1.15.9, variables can be used in the <value>file</value> name
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
152 when using OpenSSL 1.0.2 or higher:
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
153 <example>
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
154 ssl_certificate $ssl_server_name.crt;
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
155 ssl_certificate_key $ssl_server_name.key;
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
156 </example>
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
157 Note that using variables implies that
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
158 a certificate will be loaded for each SSL handshake,
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
159 and this may have a negative impact on performance.
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
160 </para>
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
161
2350
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
162 <para id="ssl_certificate_data">
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
163 The value
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
164 <literal>data</literal>:<value>$variable</value>
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
165 can be specified instead of the <value>file</value> (1.15.10),
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
166 which loads a certificate from a variable without using intermediate files.
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
167 Note that inappropriate use of this syntax may have its security implications,
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
168 such as writing secret key data to
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
169 <link doc="../ngx_core_module.xml" id="error_log">error log</link>.
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
170 </para>
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
171
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 <directive name="ssl_certificate_key">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 <para>
1456
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
182 Specifies a <value>file</value> with the secret key in the PEM format
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
183 for the given server.
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
184 </para>
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
185
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
186 <para>
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
187 The value
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
188 <literal>engine</literal>:<value>name</value>:<value>id</value>
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1456
diff changeset
189 can be specified instead of the <value>file</value>,
1456
acba294382d6 Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
190 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: 1450
diff changeset
191 from the OpenSSL engine <value>name</value>.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193
2350
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
194 <para id="ssl_certificate_key_data">
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
195 The value
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
196 <literal>data</literal>:<value>$variable</value>
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
197 can be specified instead of the <value>file</value> (1.15.10),
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
198 which loads a secret key from a variable without using intermediate files.
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
199 Note that inappropriate use of this syntax may have its security implications,
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
200 such as writing secret key data to
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
201 <link doc="../ngx_core_module.xml" id="error_log">error log</link>.
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
202 </para>
8e35f3af574b Documented the "data:" syntax for ssl_certificate and key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2334
diff changeset
203
2334
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
204 <para>
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
205 Since version 1.15.9, variables can be used in the <value>file</value> name
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
206 when using OpenSSL 1.0.2 or higher.
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
207 </para>
dbe55598d3f6 Added variables support in ssl_certificate and ssl_certificate_key.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2296
diff changeset
208
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 <directive name="ssl_ciphers">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213 <syntax><value>ciphers</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 <default>HIGH:!aNULL:!MD5</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 Specifies the enabled ciphers.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 The ciphers are specified in the format understood by the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 OpenSSL library, for example:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 <example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 </example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228 The full list can be viewed using the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229 “<command>openssl ciphers</command>” command.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234
1869
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
235 <directive name="ssl_client_certificate">
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
236 <syntax><value>file</value></syntax>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
237 <default/>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
238 <context>stream</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
239 <context>server</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
240 <appeared-in>1.11.8</appeared-in>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
241
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
242 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
243 Specifies a <value>file</value> with trusted CA certificates in the PEM format
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
244 used to <link id="ssl_verify_client">verify</link> client certificates.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
245 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
246
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
247 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
248 The list of certificates will be sent to clients.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
249 If this is not desired, the <link id="ssl_trusted_certificate"/>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
250 directive can be used.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
251 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
252
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
253 </directive>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
254
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
255
2616
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
256 <directive name="ssl_conf_command">
2865
0d355d154181 Corrected syntax of ssl_conf_command and friends.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2837
diff changeset
257 <syntax><value>name</value> <value>value</value></syntax>
2616
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
258 <default/>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
259 <context>stream</context>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
260 <context>server</context>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
261 <appeared-in>1.19.4</appeared-in>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
262
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
263 <para>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
264 Sets arbitrary OpenSSL configuration
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
265 <link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">commands</link>.
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
266 <note>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
267 The directive is supported when using OpenSSL 1.0.2 or higher.
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
268 </note>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
269 </para>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
270
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
271 <para>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
272 Several <literal>ssl_conf_command</literal> directives
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
273 can be specified on the same level:
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
274 <example>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
275 ssl_conf_command Options PrioritizeChaCha;
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
276 ssl_conf_command Ciphersuites TLS_CHACHA20_POLY1305_SHA256;
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
277 </example>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
278 These directives are inherited from the previous configuration level
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
279 if and only if there are no <literal>ssl_conf_command</literal> directives
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
280 defined on the current level.
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
281 </para>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
282
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
283 <para>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
284 <note>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
285 Note that configuring OpenSSL directly
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
286 might result in unexpected behavior.
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
287 </note>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
288 </para>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
289
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
290 </directive>
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
291
d8bf37d20449 Documented the ssl_conf_command directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2460
diff changeset
292
1869
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
293 <directive name="ssl_crl">
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
294 <syntax><value>file</value></syntax>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
295 <default/>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
296 <context>stream</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
297 <context>server</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
298 <appeared-in>1.11.8</appeared-in>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
299
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
300 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
301 Specifies a <value>file</value> with revoked certificates (CRL)
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
302 in the PEM format used to <link id="ssl_verify_client">verify</link>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
303 client certificates.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
304 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
305
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
306 </directive>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
307
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
308
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
309 <directive name="ssl_dhparam">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
310 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
311 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
312 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
313 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
314
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
315 <para>
1706
6f5497797cde Changed "EDH ciphers" to "DHE ciphers".
Maxim Dounin <mdounin@mdounin.ru>
parents: 1521
diff changeset
316 Specifies a <value>file</value> with DH parameters for DHE ciphers.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
317 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
318
2296
e2e71f9477a8 Added note about ssl_dhparam defaults.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2068
diff changeset
319 <para>
e2e71f9477a8 Added note about ssl_dhparam defaults.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2068
diff changeset
320 By default no parameters are set,
e2e71f9477a8 Added note about ssl_dhparam defaults.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2068
diff changeset
321 and therefore DHE ciphers will not be used.
e2e71f9477a8 Added note about ssl_dhparam defaults.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2068
diff changeset
322 <note>
e2e71f9477a8 Added note about ssl_dhparam defaults.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2068
diff changeset
323 Prior to version 1.11.0, builtin parameters were used by default.
e2e71f9477a8 Added note about ssl_dhparam defaults.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2068
diff changeset
324 </note>
e2e71f9477a8 Added note about ssl_dhparam defaults.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2068
diff changeset
325 </para>
e2e71f9477a8 Added note about ssl_dhparam defaults.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2068
diff changeset
326
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
327 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
328
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
329
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
330 <directive name="ssl_ecdh_curve">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
331 <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
332 <default>auto</default>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
333 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
334 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
335
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
336 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
337 Specifies a <value>curve</value> for ECDHE ciphers.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
338 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
339
1711
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
340 <para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
341 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
342 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
343 <example>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
344 ssl_ecdh_curve prime256v1:secp384r1;
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
345 </example>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
346 </para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
347
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
348 <para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
349 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
350 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
351 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
352 </para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
353
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
354 <para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
355 <note>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
356 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
357 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
358 </note>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
359 </para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1706
diff changeset
360
2648
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
361 <para>
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
362 <note>
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
363 When using OpenSSL 1.0.2 or higher,
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
364 this directive sets the list of curves supported by the server.
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
365 Thus, in order for ECDSA certificates to work,
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
366 it is important to include the curves used in the certificates.
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
367 </note>
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
368 </para>
78161967514f Mentioned ECDSA in ssl_ecdh_curve.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2616
diff changeset
369
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
370 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
371
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
372
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
373 <directive name="ssl_handshake_timeout">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
374 <syntax><value>time</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
375 <default>60s</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
376 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
377 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
378
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
379 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
380 Specifies a timeout for the SSL handshake to complete.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
381 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
382
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
383 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
384
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
385
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
386 <directive name="ssl_password_file">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
387 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
388 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
389 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
390 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
391
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
392 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
393 Specifies a <value>file</value> with passphrases for
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
394 <link id="ssl_certificate_key">secret keys</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
395 where each passphrase is specified on a separate line.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
396 Passphrases are tried in turn when loading the key.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
397 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
398
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
399 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
400 Example:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
401 <example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
402 stream {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
403 ssl_password_file /etc/keys/global.pass;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
404 ...
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
405
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
406 server {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
407 listen 127.0.0.1:12345;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
408 ssl_certificate_key /etc/keys/first.key;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
409 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
410
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
411 server {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
412 listen 127.0.0.1:12346;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
413
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
414 # named pipe can also be used instead of a file
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
415 ssl_password_file /etc/keys/fifo;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
416 ssl_certificate_key /etc/keys/second.key;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
417 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
418 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
419 </example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
420 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
421
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
422 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
423
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
424
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
425 <directive name="ssl_prefer_server_ciphers">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
426 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
427 <default>off</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
428 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
429 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
430
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
431 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
432 Specifies that server ciphers should be preferred over client ciphers
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
433 when the SSLv3 and TLS protocols are used.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
434 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
435
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
436 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
437
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
438
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
439 <directive name="ssl_protocols">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
440 <syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
441 [<literal>SSLv2</literal>]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
442 [<literal>SSLv3</literal>]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
443 [<literal>TLSv1</literal>]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
444 [<literal>TLSv1.1</literal>]
1978
8f1a568a8bbf Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
445 [<literal>TLSv1.2</literal>]
8f1a568a8bbf Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
446 [<literal>TLSv1.3</literal>]</syntax>
1499
3687cc9a3592 Removed SSLv3 from the default value of ssl_protocols and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
447 <default>TLSv1 TLSv1.1 TLSv1.2</default>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
448 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
449 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
451 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
452 Enables the specified protocols.
1978
8f1a568a8bbf Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
453 <note>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
454 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters work
1978
8f1a568a8bbf Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
455 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
456 </note>
8f1a568a8bbf Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
457 <note>
8f1a568a8bbf Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
458 The <literal>TLSv1.3</literal> parameter (1.13.0) works only when
2769
16f6fa718be2 Updated TLSv1.3 support notes.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2648
diff changeset
459 OpenSSL 1.1.1 or higher is used.
1978
8f1a568a8bbf Documented "TLSv1.3" parameter of the "ssl_protocols" directive.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1923
diff changeset
460 </note>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
461 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
462
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
463 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
464
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
465
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
466 <directive name="ssl_session_cache">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
467 <syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
468 <literal>off</literal> |
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
469 <literal>none</literal> |
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
470 [<literal>builtin</literal>[:<value>size</value>]]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
471 [<literal>shared</literal>:<value>name</value>:<value>size</value>]</syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
472 <default>none</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
473 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
474 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
475
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
476 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
477 Sets the types and sizes of caches that store session parameters.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
478 A cache can be of any of the following types:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
479 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
480
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
481 <tag-name><literal>off</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
482 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
483 the use of a session cache is strictly prohibited:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
484 nginx explicitly tells a client that sessions may not be reused.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
485 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
486
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
487 <tag-name><literal>none</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
488 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
489 the use of a session cache is gently disallowed:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
490 nginx tells a client that sessions may be reused, but does not
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
491 actually store session parameters in the cache.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
492 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
493
2068
3d9e7993c201 Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1978
diff changeset
494 <tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
495 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
496 a cache built in OpenSSL; used by one worker process only.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
497 The cache size is specified in sessions.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
498 If size is not given, it is equal to 20480 sessions.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
499 Use of the built-in cache can cause memory fragmentation.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
500 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
501
2068
3d9e7993c201 Added links to directives in the example of ssl modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1978
diff changeset
502 <tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
503 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
504 a cache shared between all worker processes.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
505 The cache size is specified in bytes; one megabyte can store
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
506 about 4000 sessions.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
507 Each shared cache should have an arbitrary name.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
508 A cache with the same name can be used in several
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
509 servers.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
510 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
511
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
512 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
513 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
514
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
515 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
516 Both cache types can be used simultaneously, for example:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
517 <example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
518 ssl_session_cache builtin:1000 shared:SSL:10m;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
519 </example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
520 but using only shared cache without the built-in cache should
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
521 be more efficient.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
522 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
523
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
524 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
525
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
526
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
527 <directive name="ssl_session_ticket_key">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
528 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
529 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
530 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
531 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
532
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
533 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
534 Sets a <value>file</value> with the secret key used to encrypt
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
535 and decrypt TLS session tickets.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
536 The directive is necessary if the same key has to be shared between
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
537 multiple servers.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
538 By default, a randomly generated key is used.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
539 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
540
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
541 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
542 If several keys are specified, only the first key is
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
543 used to encrypt TLS session tickets.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
544 This allows configuring key rotation, for example:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
545 <example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
546 ssl_session_ticket_key current.key;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
547 ssl_session_ticket_key previous.key;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
548 </example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
549 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
550
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
551 <para>
1877
aa29a64a5e9d Documented ssl_session_ticket_key 80-byte keys.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1876
diff changeset
552 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: 1876
diff changeset
553 of random data and can be created using the following command:
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
554 <example>
1877
aa29a64a5e9d Documented ssl_session_ticket_key 80-byte keys.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1876
diff changeset
555 openssl rand 80 > ticket.key
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
556 </example>
1877
aa29a64a5e9d Documented ssl_session_ticket_key 80-byte keys.
Maxim Dounin <mdounin@mdounin.ru>
parents: 1876
diff changeset
557 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: 1876
diff changeset
558 or AES128 (for 48-byte keys) is used for encryption.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
559 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
560
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
561 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
562
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
563
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
564 <directive name="ssl_session_tickets">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
565 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
566 <default>on</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
567 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
568 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
569
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
570 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
571 Enables or disables session resumption through
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2807
diff changeset
572 <link url="https://datatracker.ietf.org/doc/html/rfc5077">TLS session tickets</link>.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
573 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
574
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
575 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
576
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
577
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
578 <directive name="ssl_session_timeout">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
579 <syntax><value>time</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
580 <default>5m</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
581 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
582 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
583
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
584 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
585 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: 1745
diff changeset
586 session parameters.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
587 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
588
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
589 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
590
1869
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
591
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
592 <directive name="ssl_trusted_certificate">
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
593 <syntax><value>file</value></syntax>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
594 <default/>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
595 <context>stream</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
596 <context>server</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
597 <appeared-in>1.11.8</appeared-in>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
598
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
599 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
600 Specifies a <value>file</value> with trusted CA certificates in the PEM format
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
601 used to <link id="ssl_verify_client">verify</link> client certificates.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
602 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
603
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
604 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
605 In contrast to the certificate set by <link id="ssl_client_certificate"/>,
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
606 the list of these certificates will not be sent to clients.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
607 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
608
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
609 </directive>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
610
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
611
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
612 <directive name="ssl_verify_client">
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
613 <syntax>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
614 <literal>on</literal> | <literal>off</literal> |
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
615 <literal>optional</literal> | <literal>optional_no_ca</literal></syntax>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
616 <default>off</default>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
617 <context>stream</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
618 <context>server</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
619 <appeared-in>1.11.8</appeared-in>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
620
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
621 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
622 Enables verification of client certificates.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
623 The verification result is stored in the
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
624 <link id="var_ssl_client_verify">$ssl_client_verify</link> variable.
1876
b451f03e0a4b Described behavior of stream ssl_verify_client in case of error.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1869
diff changeset
625 If an error has occurred during the client certificate verification
b451f03e0a4b Described behavior of stream ssl_verify_client in case of error.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1869
diff changeset
626 or a client has not presented the required certificate,
b451f03e0a4b Described behavior of stream ssl_verify_client in case of error.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1869
diff changeset
627 the connection is closed.
1869
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
628 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
629
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
630 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
631 The <literal>optional</literal> parameter requests the client
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
632 certificate and verifies it if the certificate is present.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
633 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
634
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
635 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
636 The <literal>optional_no_ca</literal> parameter
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
637 requests the client
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
638 certificate but does not require it to be signed by a trusted CA certificate.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
639 This is intended for the use in cases when a service that is external to nginx
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
640 performs the actual certificate verification.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
641 The contents of the certificate is accessible through the
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
642 <link id="var_ssl_client_cert">$ssl_client_cert</link> variable.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
643 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
644
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
645 </directive>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
646
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
647
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
648 <directive name="ssl_verify_depth">
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
649 <syntax><value>number</value></syntax>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
650 <default>1</default>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
651 <context>stream</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
652 <context>server</context>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
653 <appeared-in>1.11.8</appeared-in>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
654
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
655 <para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
656 Sets the verification depth in the client certificates chain.
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
657 </para>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
658
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
659 </directive>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
660
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
661 </section>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
662
1745
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
663
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
664 <section id="variables" name="Embedded Variables">
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
665
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
666 <para>
1790
6da8d19f89c0 Corrected module name in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1785
diff changeset
667 The <literal>ngx_stream_ssl_module</literal> module supports variables
1745
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
668 since 1.11.2.
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
669 <list type="tag">
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
670
2789
d16409187314 Documented the $ssl_alpn_protocol variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2769
diff changeset
671 <tag-name id="var_ssl_alpn_protocol"><var>$ssl_alpn_protocol</var></tag-name>
d16409187314 Documented the $ssl_alpn_protocol variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2769
diff changeset
672 <tag-desc>
d16409187314 Documented the $ssl_alpn_protocol variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2769
diff changeset
673 returns the protocol selected by ALPN during the SSL handshake,
d16409187314 Documented the $ssl_alpn_protocol variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2769
diff changeset
674 or an empty string otherwise (1.21.4);
d16409187314 Documented the $ssl_alpn_protocol variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2769
diff changeset
675 </tag-desc>
d16409187314 Documented the $ssl_alpn_protocol variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2769
diff changeset
676
1745
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
677 <tag-name id="var_ssl_cipher"><var>$ssl_cipher</var></tag-name>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
678 <tag-desc>
2460
c60a8a15010c Clarified description of the $ssl_cipher variable.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2350
diff changeset
679 returns the name of the cipher used
1745
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
680 for an established SSL connection;
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
681 </tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
682
1857
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
683 <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: 1790
diff changeset
684 <tag-desc>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
685 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: 1790
diff changeset
686 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: 1790
diff changeset
687 for example:
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
688 <example>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
689 AES128-SHA:AES256-SHA:0x00ff
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
690 </example>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
691 <note>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
692 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: 1790
diff changeset
693 With older versions, the variable is available
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
694 only for new sessions and lists only known ciphers.
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
695 </note>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
696 </tag-desc>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
697
1869
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
698 <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
699 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
700 returns the client certificate in the PEM format
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
701 for an established SSL connection, with each line except the first
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
702 prepended with the tab character (1.11.8);
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
703 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
704
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
705 <tag-name id="var_ssl_client_fingerprint"><var>$ssl_client_fingerprint</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
706 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
707 returns the SHA1 fingerprint of the client certificate
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
708 for an established SSL connection (1.11.8);
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
709 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
710
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
711 <tag-name id="var_ssl_client_i_dn"><var>$ssl_client_i_dn</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
712 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
713 returns the “issuer DN” string of the client certificate
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
714 for an established SSL connection according to
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2807
diff changeset
715 <link url="https://datatracker.ietf.org/doc/html/rfc2253">RFC 2253</link> (1.11.8);
1869
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
716 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
717
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
718 <tag-name id="var_ssl_client_raw_cert"><var>$ssl_client_raw_cert</var>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
719 </tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
720 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
721 returns the client certificate in the PEM format
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
722 for an established SSL connection (1.11.8);
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
723 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
724
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
725 <tag-name id="var_ssl_client_s_dn"><var>$ssl_client_s_dn</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
726 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
727 returns the “subject DN” string of the client certificate
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
728 for an established SSL connection according to
2831
4add6ae1296f Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents: 2807
diff changeset
729 <link url="https://datatracker.ietf.org/doc/html/rfc2253">RFC 2253</link> (1.11.8);
1869
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
730 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
731
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
732 <tag-name id="var_ssl_client_serial"><var>$ssl_client_serial</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
733 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
734 returns the serial number of the client certificate
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
735 for an established SSL connection (1.11.8);
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
736 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
737
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
738 <tag-name id="var_ssl_client_v_end"><var>$ssl_client_v_end</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
739 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
740 returns the end date of the client certificate (1.11.8);
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
741 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
742
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
743 <tag-name id="var_ssl_client_v_remain"><var>$ssl_client_v_remain</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
744 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
745 returns the number of days
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
746 until the client certificate expires (1.11.8);
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
747 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
748
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
749 <tag-name id="var_ssl_client_v_start"><var>$ssl_client_v_start</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
750 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
751 returns the start date of the client certificate (1.11.8);
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
752 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
753
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
754 <tag-name id="var_ssl_client_verify"><var>$ssl_client_verify</var></tag-name>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
755 <tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
756 returns the result of client certificate verification (1.11.8):
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
757 “<literal>SUCCESS</literal>”, “<literal>FAILED:</literal><value>reason</value>”,
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
758 and “<literal>NONE</literal>” if a certificate was not present;
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
759 </tag-desc>
e1d0b56c0310 Documented support for client certificate verification in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1857
diff changeset
760
2807
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
761 <tag-name id="var_ssl_curve"><var>$ssl_curve</var></tag-name>
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
762 <tag-desc>
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
763 returns the negotiated curve used for
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
764 SSL handshake key exchange process (1.21.5).
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
765 Known curves are listed by names, unknown are shown in hexadecimal,
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
766 for example:
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
767 <example>
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
768 prime256v1
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
769 </example>
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
770 <note>
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
771 The variable is supported only when using OpenSSL version 3.0 or higher.
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
772 With older versions, the variable value will be an empty string.
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
773 </note>
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
774 </tag-desc>
4b73197f8ca9 Documented the $ssl_curve variable for http and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2790
diff changeset
775
1857
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
776 <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: 1790
diff changeset
777 <tag-desc>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
778 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: 1790
diff changeset
779 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: 1790
diff changeset
780 for example:
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
781 <example>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
782 0x001d:prime256v1:secp521r1:secp384r1
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
783 </example>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
784 <note>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
785 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: 1790
diff changeset
786 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: 1790
diff changeset
787 </note>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
788 <note>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
789 The variable is available only for new sessions.
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
790 </note>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
791 </tag-desc>
0882ccb0c00f Documented the $ssl_curves and $ssl_ciphers variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1790
diff changeset
792
1745
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
793 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
794 <tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
795 returns the protocol of an established SSL connection;
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
796 </tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
797
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
798 <tag-name id="var_ssl_server_name"><var>$ssl_server_name</var></tag-name>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
799 <tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
800 returns the server name requested through
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
801 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">SNI</link>;
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
802 </tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
803
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
804 <tag-name id="var_ssl_session_id"><var>$ssl_session_id</var></tag-name>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
805 <tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
806 returns the session identifier of an established SSL connection;
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
807 </tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
808
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
809 <tag-name id="var_ssl_session_reused"><var>$ssl_session_reused</var></tag-name>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
810 <tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
811 returns “<literal>r</literal>” if an SSL session was reused,
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
812 or “<literal>.</literal>” otherwise.
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
813 </tag-desc>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
814
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
815 </list>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
816 </para>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
817
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
818 </section>
0dfb7628bfee Documented variables in ngx_stream_ssl_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1726
diff changeset
819
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
820 </module>