nginx-site: xml/en/docs/http/ngx_http_ssl

annotate xml/en/docs/http/ngx_http_ssl_module.xml @ 2168:3535437f97d2

Deprecated the "ssl" directive for http and mail.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Fri, 25 May 2018 16:21:20 +0300
parents	aa5d65fe4916
children	f1e12641fc8a

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

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_ssl_module.xml @ 2168:3535437f97d2