nginx-site: xml/en/docs/mail/ngx_mail_ssl

annotate xml/en/docs/mail/ngx_mail_ssl_module.xml @ 1711:38fb3e6b71e8

Documented ssl_ecdh_curve changes in 1.11.0.

author	Maxim Dounin <mdounin@mdounin.ru>
date	Fri, 27 May 2016 19:05:15 +0300
parents	6f5497797cde
children	a0bc284941f6

rev	line source
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3 <!--
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	4 Copyright (C) 2006, 2007 Anton Yuzhaninov
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	5 Copyright (C) Nginx, Inc.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	6 -->
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	7
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	9
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	10 <module name="Module ngx_mail_ssl_module"
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	11 link="/en/docs/mail/ngx_mail_ssl_module.html"
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	12 lang="en"
1711 38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	13 rev="10">
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	14
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	15 <section id="summary">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	16
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	17 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	18 The <literal>ngx_mail_ssl_module</literal> module provides the necessary
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	19 support for a mail proxy server to work with the SSL/TLS protocol.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	20 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	21
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	22 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	23 This module is not built by default, it should be enabled with
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	24 the <literal>--with-mail_ssl_module</literal>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	25 configuration parameter.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	26 <note>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	27 This module requires the <link url="http://www.openssl.org">OpenSSL</link>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	28 library.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	29 </note>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	30 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	31
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	32 </section>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	33
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	34
1521 e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	35 <section id="example" name="Example Configuration">
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	36
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	37 <para>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	38 To reduce the processor load, it is recommended to
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	39 <list type="bullet">
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	40
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	41 <listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	42 set the number of worker processes equal to the number of processors,
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	43 </listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	44
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	45 <listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	46 enable the shared session cache,
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	47 </listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	48
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	49 <listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	50 disable the built-in session cache,
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	51 </listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	52
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	53 <listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	54 and possibly increase the session lifetime (by default, 5 minutes):
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	55 </listitem>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	56
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	57 </list>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	58
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	59 <example>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	60 <emphasis>worker_processes auto;</emphasis>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	61
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	62 mail {
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	63
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	64 ...
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	65
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	66 server {
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	67 listen 993 ssl;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	68
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	69 ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	70 ssl_ciphers AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	71 ssl_certificate /usr/local/nginx/conf/cert.pem;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	72 ssl_certificate_key /usr/local/nginx/conf/cert.key;
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	73 <emphasis>ssl_session_cache shared:SSL:10m;</emphasis>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	74 <emphasis>ssl_session_timeout 10m;</emphasis>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	75
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	76 ...
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	77 }
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	78 </example>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	79 </para>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	80
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	81 </section>
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	82
e3d3e2ed4275 Added example configuration to mail and stream ssl modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 1499 diff changeset	83
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	84 <section id="directives" name="Directives">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	85
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	86 <directive name="ssl">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	87 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	88 <default>off</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	89 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	90 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	91
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	92 <para>
751 9c1ffd02f1b7 Removed "virtual" and HTTPS references from mail modules. Vladimir Homutov <vl@nginx.com> parents: 664 diff changeset	93 Enables the SSL/TLS protocol for the given server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	94 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	95
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	96 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	97
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	98
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	99 <directive name="ssl_certificate">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	100 <syntax><value>file</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	101 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	102 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	103 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	104
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	105 <para>
1456 acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	106 Specifies a <value>file</value> with the certificate in the PEM format
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	107 for the given server.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	108 If intermediate certificates should be specified in addition to a primary
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	109 certificate, they should be specified in the same file in the following
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	110 order: the primary certificate comes first, then the intermediate certificates.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	111 A secret key in the PEM format may be placed in the same file.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	112 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	113
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	114 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	115
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	116
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	117 <directive name="ssl_certificate_key">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	118 <syntax><value>file</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	119 <default/>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	120 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	121 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	122
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	123 <para>
1456 acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	124 Specifies a <value>file</value> with the secret key in the PEM format
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	125 for the given server.
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	126 </para>
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	127
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	128 <para>
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	129 The value
acba294382d6 Documented engine support in ssl_certificate_key and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1429 diff changeset	130 <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: 1429 diff changeset	131 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: 1429 diff changeset	132 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: 1429 diff changeset	133 from the OpenSSL engine <value>name</value>.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	134 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	135
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	136 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	137
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	138
1266 35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	139 <directive name="ssl_ciphers">
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	140 <syntax><value>ciphers</value></syntax>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	141 <default>HIGH:!aNULL:!MD5</default>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	142 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	143 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	144
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	145 <para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	146 Specifies the enabled ciphers.
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	147 The ciphers are specified in the format understood by the
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	148 OpenSSL library, for example:
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	149 <example>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	150 ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	151 </example>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	152 </para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	153
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	154 <para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	155 The full list can be viewed using the
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	156 “<command>openssl ciphers</command>” command.
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	157 </para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	158
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	159 <para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	160 <note>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	161 The previous versions of nginx used
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	162 <link doc="../http/configuring_https_servers.xml" id="compatibility">different</link>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	163 ciphers by default.
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	164 </note>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	165 </para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	166
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	167 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	168
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	169
1429 06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	170 <directive name="ssl_client_certificate">
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	171 <syntax><value>file</value></syntax>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	172 <default/>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	173 <context>mail</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	174 <context>server</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	175 <appeared-in>1.7.11</appeared-in>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	176
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	177 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	178 Specifies a <value>file</value> with trusted CA certificates in the PEM format
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	179 used to <link id="ssl_verify_client">verify</link> client certificates.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	180 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	181
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	182 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	183 The list of certificates will be sent to clients.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	184 If this is not desired, the <link id="ssl_trusted_certificate"/>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	185 directive can be used.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	186 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	187
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	188 </directive>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	189
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	190
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	191 <directive name="ssl_crl">
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	192 <syntax><value>file</value></syntax>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	193 <default/>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	194 <context>mail</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	195 <context>server</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	196 <appeared-in>1.7.11</appeared-in>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	197
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	198 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	199 Specifies a <value>file</value> with revoked certificates (CRL)
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	200 in the PEM format used to <link id="ssl_verify_client">verify</link>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	201 client certificates.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	202 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	203
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	204 </directive>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	205
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	206
1266 35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	207 <directive name="ssl_dhparam">
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	208 <syntax><value>file</value></syntax>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	209 <default/>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	210 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	211 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	212 <appeared-in>0.7.2</appeared-in>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	213
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	214 <para>
1706 6f5497797cde Changed "EDH ciphers" to "DHE ciphers". Maxim Dounin <mdounin@mdounin.ru> parents: 1521 diff changeset	215 Specifies a <value>file</value> with DH parameters for DHE ciphers.
1266 35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	216 </para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	217
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	218 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	219
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	220
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	221 <directive name="ssl_ecdh_curve">
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	222 <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	223 <default>auto</default>
1266 35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	224 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	225 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	226 <appeared-in>1.1.0</appeared-in>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	227 <appeared-in>1.0.6</appeared-in>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	228
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	229 <para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	230 Specifies a <value>curve</value> for ECDHE ciphers.
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	231 </para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	232
1711 38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	233 <para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	234 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	235 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	236 <example>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	237 ssl_ecdh_curve prime256v1:secp384r1;
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	238 </example>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	239 </para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	240
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	241 <para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	242 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	243 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	244 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	245 </para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	246
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	247 <para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	248 <note>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	249 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	250 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	251 </note>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	252 </para>
38fb3e6b71e8 Documented ssl_ecdh_curve changes in 1.11.0. Maxim Dounin <mdounin@mdounin.ru> parents: 1706 diff changeset	253
1266 35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	254 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	255
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	256
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	257 <directive name="ssl_password_file">
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	258 <syntax><value>file</value></syntax>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	259 <default/>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	260 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	261 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	262 <appeared-in>1.7.3</appeared-in>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	263
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	264 <para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	265 Specifies a <value>file</value> with passphrases for
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	266 <link id="ssl_certificate_key">secret keys</link>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	267 where each passphrase is specified on a separate line.
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	268 Passphrases are tried in turn when loading the key.
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	269 </para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	270
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	271 <para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	272 Example:
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	273 <example>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	274 mail {
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	275 ssl_password_file /etc/keys/global.pass;
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	276 ...
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	277
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	278 server {
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	279 server_name mail1.example.com;
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	280 ssl_certificate_key /etc/keys/first.key;
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	281 }
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	282
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	283 server {
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	284 server_name mail2.example.com;
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	285
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	286 # named pipe can also be used instead of a file
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	287 ssl_password_file /etc/keys/fifo;
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	288 ssl_certificate_key /etc/keys/second.key;
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	289 }
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	290 }
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	291 </example>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	292 </para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	293
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	294 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	295
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	296
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	297 <directive name="ssl_prefer_server_ciphers">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	298 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	299 <default>off</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	300 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	301 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	302
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	303 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	304 Specifies that server ciphers should be preferred over client ciphers
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	305 when the SSLv3 and TLS protocols are used.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	306 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	307
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	308 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	309
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	310
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	311 <directive name="ssl_protocols">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	312 <syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	313 [<literal>SSLv2</literal>]
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	314 [<literal>SSLv3</literal>]
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	315 [<literal>TLSv1</literal>]
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	316 [<literal>TLSv1.1</literal>]
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	317 [<literal>TLSv1.2</literal>]</syntax>
1499 3687cc9a3592 Removed SSLv3 from the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1456 diff changeset	318 <default>TLSv1 TLSv1.1 TLSv1.2</default>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	319 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	320 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	321
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	322 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	323 Enables the specified protocols.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	324 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters work
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	325 only when the OpenSSL library of version 1.0.1 or higher is used.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	326 <note>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	327 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters are
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	328 supported starting from versions 1.1.13 and 1.0.12
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	329 so when the OpenSSL version 1.0.1 or higher
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	330 is used on older nginx versions, these protocols work, but cannot
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	331 be disabled.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	332 </note>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	333 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	334
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	335 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	336
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	337
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	338 <directive name="ssl_session_cache">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	339 <syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	340 <literal>off</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	341 <literal>none</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	342 [<literal>builtin</literal>[:<value>size</value>]]
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	343 [<literal>shared</literal>:<value>name</value>:<value>size</value>]</syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	344 <default>none</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	345 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	346 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	347
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	348 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	349 Sets the types and sizes of caches that store session parameters.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	350 A cache can be of any of the following types:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	351 <list type="tag">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	352
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	353 <tag-name><literal>off</literal></tag-name>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	354 <tag-desc>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	355 the use of a session cache is strictly prohibited:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	356 nginx explicitly tells a client that sessions may not be reused.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	357 </tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	358
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	359 <tag-name><literal>none</literal></tag-name>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	360 <tag-desc>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	361 the use of a session cache is gently disallowed:
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	362 nginx tells a client that sessions may be reused, but does not
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	363 actually store session parameters in the cache.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	364 </tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	365
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	366 <tag-name><literal>builtin</literal></tag-name>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	367 <tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	368 a cache built in OpenSSL; used by one worker process only.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	369 The cache size is specified in sessions.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	370 If size is not given, it is equal to 20480 sessions.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	371 Use of the built-in cache can cause memory fragmentation.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	372 </tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	373
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	374 <tag-name><literal>shared</literal></tag-name>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	375 <tag-desc>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	376 a cache shared between all worker processes.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	377 The cache size is specified in bytes; one megabyte can store
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	378 about 4000 sessions.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	379 Each shared cache should have an arbitrary name.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	380 A cache with the same name can be used in several
751 9c1ffd02f1b7 Removed "virtual" and HTTPS references from mail modules. Vladimir Homutov <vl@nginx.com> parents: 664 diff changeset	381 servers.
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	382 </tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	383
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	384 </list>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	385 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	386
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	387 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	388 Both cache types can be used simultaneously, for example:
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	389 <example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	390 ssl_session_cache builtin:1000 shared:SSL:10m;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	391 </example>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	392 but using only shared cache without the built-in cache should
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	393 be more efficient.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	394 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	395
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	396 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	397
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	398
1019 2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	399 <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	400 <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	401 <default/>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	402 <context>mail</context>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	403 <context>server</context>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	404 <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	405
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	406 <para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	407 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	408 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	409 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	410 multiple servers.
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	411 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	412 </para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	413
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	414 <para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	415 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	416 used to encrypt TLS session tickets.
1144 ac131944d349 Changed infinitive to gerund after "allow". Yaroslav Zhuravlev <yar@nginx.com> parents: 1019 diff changeset	417 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	418 <example>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	419 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	420 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	421 </example>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	422 </para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	423
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	424 <para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	425 The <value>file</value> must contain 48 bytes of random data and can
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	426 be created using the following command:
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	427 <example>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	428 openssl rand 48 > ticket.key
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	429 </example>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	430 </para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	431
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	432 </directive>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	433
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	434
1266 35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	435 <directive name="ssl_session_tickets">
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	436 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	437 <default>on</default>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	438 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	439 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	440 <appeared-in>1.5.9</appeared-in>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	441
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	442 <para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	443 Enables or disables session resumption through
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	444 <link url="http://tools.ietf.org/html/rfc5077">TLS session tickets</link>.
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	445 </para>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	446
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	447 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	448
35d6ac64bf27 Documented five directives in the mail ssl module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1144 diff changeset	449
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	450 <directive name="ssl_session_timeout">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	451 <syntax><value>time</value></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	452 <default>5m</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	453 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	454 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	455
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	456 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	457 Specifies a time during which a client may reuse the
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	458 session parameters stored in a cache.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	459 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	460
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	461 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	462
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	463
1429 06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	464 <directive name="ssl_trusted_certificate">
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	465 <syntax><value>file</value></syntax>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	466 <default/>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	467 <context>mail</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	468 <context>server</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	469 <appeared-in>1.7.11</appeared-in>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	470
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	471 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	472 Specifies a <value>file</value> with trusted CA certificates in the PEM format
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	473 used to <link id="ssl_verify_client">verify</link> client certificates.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	474 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	475
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	476 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	477 In contrast to the certificate set by <link id="ssl_client_certificate"/>,
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	478 the list of these certificates will not be sent to clients.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	479 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	480
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	481 </directive>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	482
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	483
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	484 <directive name="ssl_verify_client">
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	485 <syntax>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	486 <literal>on</literal> \| <literal>off</literal> \|
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	487 <literal>optional</literal> \| <literal>optional_no_ca</literal></syntax>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	488 <default>off</default>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	489 <context>mail</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	490 <context>server</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	491 <appeared-in>1.7.11</appeared-in>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	492
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	493 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	494 Enables verification of client certificates.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	495 The verification result is passed in the
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	496 <header>Auth-SSL-Verify</header> header of the
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	497 <link doc="ngx_mail_auth_http_module.xml" id="auth_http">authentication</link>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	498 request.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	499 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	500
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	501 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	502 The <literal>optional</literal> parameter requests the client
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	503 certificate and verifies it if the certificate is present.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	504 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	505
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	506 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	507 The <literal>optional_no_ca</literal> parameter
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	508 requests the client
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	509 certificate but does not require it to be signed by a trusted CA certificate.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	510 This is intended for the use in cases when a service that is external to nginx
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	511 performs the actual certificate verification.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	512 The contents of the certificate is accessible through requests
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	513 <link doc="ngx_mail_auth_http_module.xml"
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	514 id="auth_http_pass_client_cert">sent</link>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	515 to the authentication server.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	516 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	517
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	518 </directive>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	519
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	520
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	521 <directive name="ssl_verify_depth">
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	522 <syntax><value>number</value></syntax>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	523 <default>1</default>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	524 <context>mail</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	525 <context>server</context>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	526 <appeared-in>1.7.11</appeared-in>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	527
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	528 <para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	529 Sets the verification depth in the client certificates chain.
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	530 </para>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	531
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	532 </directive>
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	533
06322891b4e3 Client certificate directives in mail_ssl_module and associates. Sergey Kandaurov <pluknet@nginx.com> parents: 1266 diff changeset	534
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	535 <directive name="starttls">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	536 <syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	537 <literal>on</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	538 <literal>off</literal> \|
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	539 <literal>only</literal></syntax>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	540 <default>off</default>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	541 <context>mail</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	542 <context>server</context>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	543
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	544 <para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	545 <list type="tag">
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	546
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	547 <tag-name><literal>on</literal></tag-name>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	548 <tag-desc>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	549 allow usage of the <literal>STLS</literal> command for the POP3
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	550 and the <literal>STARTTLS</literal> command for the IMAP;
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	551 </tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	552
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	553 <tag-name><literal>off</literal></tag-name>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	554 <tag-desc>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 751 diff changeset	555 deny usage of the <literal>STLS</literal>
664 8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	556 and <literal>STARTTLS</literal> commands;
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	557 </tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	558
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	559 <tag-name><literal>only</literal></tag-name>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	560 <tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	561 require preliminary TLS transition.
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	562 </tag-desc>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	563
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	564 </list>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	565 </para>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	566
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	567 </directive>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	568
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	569 </section>
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	570
8283b1048b27 Translated mail modules into English. Vladimir Homutov <vl@nginx.com> parents: diff changeset	571 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_ssl_module.xml @ 1711:38fb3e6b71e8