Mercurial > hg > nginx-site

annotate xml/en/docs/mail/ngx_mail_ssl_module.xml @ 1266:35d6ac64bf27

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented five directives in the mail ssl module. The following directives were documented: ssl_ciphers, ssl_dhparam, ssl_ecdh_curve, ssl_password_file, ssl_session_tickets.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 05 Aug 2014 19:07:39 +0400
parents ac131944d349
children 06322891b4e3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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"
1266
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
13 rev="4">
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
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
35 <section id="directives" name="Directives">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
36
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
37 <directive name="ssl">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
38 <syntax><literal>on</literal> | <literal>off</literal></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
39 <default>off</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
40 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
41 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
42
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
43 <para>
751
9c1ffd02f1b7 Removed "virtual" and HTTPS references from mail modules.
Vladimir Homutov <vl@nginx.com>
parents: 664
diff changeset
44 Enables the SSL/TLS protocol for the given server.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
45 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
46
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
47 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
48
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
49
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
50 <directive name="ssl_certificate">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
51 <syntax><value>file</value></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
52 <default/>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
53 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
54 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
55
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
56 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
57 Specifies a file with the certificate in the PEM format for the given
751
9c1ffd02f1b7 Removed "virtual" and HTTPS references from mail modules.
Vladimir Homutov <vl@nginx.com>
parents: 664
diff changeset
58 server.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
59 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
60 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
61 order: the primary certificate comes first, then the intermediate certificates.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
62 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
63 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
64
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
65 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
66
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
67
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
68 <directive name="ssl_certificate_key">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
69 <syntax><value>file</value></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
70 <default/>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
71 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
72 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
73
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
74 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
75 Specifies a file with the secret key in the PEM format for the given
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
76 server.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
77 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
78
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
79 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
80
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
81
1266
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
82 <directive name="ssl_ciphers">
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
83 <syntax><value>ciphers</value></syntax>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
84 <default>HIGH:!aNULL:!MD5</default>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
85 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
86 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
87
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
88 <para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
89 Specifies the enabled ciphers.
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
90 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
91 OpenSSL library, for example:
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
92 <example>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
93 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
94 </example>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
95 </para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
96
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
97 <para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
98 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
99 “<command>openssl ciphers</command>” command.
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
100 </para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
101
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
102 <para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
103 <note>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
104 The previous versions of nginx used
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
105 <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
106 ciphers by default.
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
107 </note>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
108 </para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
109
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
110 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
111
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
112
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
113 <directive name="ssl_dhparam">
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
114 <syntax><value>file</value></syntax>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
115 <default/>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
116 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
117 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
118 <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
119
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
120 <para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
121 Specifies a <value>file</value> with DH parameters for EDH ciphers.
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
122 </para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
123
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
124 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
125
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
126
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
127 <directive name="ssl_ecdh_curve">
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
128 <syntax><value>curve</value></syntax>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
129 <default>prime256v1</default>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
130 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
131 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
132 <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
133 <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
134
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
135 <para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
136 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
137 </para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
138
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
139 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
140
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
141
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
142 <directive name="ssl_password_file">
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
143 <syntax><value>file</value></syntax>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
144 <default/>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
145 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
146 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
147 <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
148
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
149 <para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
150 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
151 <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
152 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
153 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
154 </para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
155
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
156 <para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
157 Example:
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
158 <example>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
159 mail {
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
160 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
161 ...
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
162
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
163 server {
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
164 server_name mail1.example.com;
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
165 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
166 }
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
167
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
168 server {
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
169 server_name mail2.example.com;
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
170
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
171 # 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
172 ssl_password_file /etc/keys/fifo;
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
173 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
174 }
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
175 }
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
176 </example>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
177 </para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
178
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
179 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
180
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
181
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
182 <directive name="ssl_prefer_server_ciphers">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
183 <syntax><literal>on</literal> | <literal>off</literal></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
184 <default>off</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
185 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
186 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
187
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
188 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
189 Specifies that server ciphers should be preferred over client ciphers
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
190 when the SSLv3 and TLS protocols are used.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
191 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
192
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
193 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
194
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
195
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
196 <directive name="ssl_protocols">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
197 <syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
198 [<literal>SSLv2</literal>]
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
199 [<literal>SSLv3</literal>]
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
200 [<literal>TLSv1</literal>]
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
201 [<literal>TLSv1.1</literal>]
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
202 [<literal>TLSv1.2</literal>]</syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
203 <default>SSLv3 TLSv1 TLSv1.1 TLSv1.2</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
204 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
205 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
206
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
207 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
208 Enables the specified protocols.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
209 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
210 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
211 <note>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
212 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
213 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
214 so when the OpenSSL version 1.0.1 or higher
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
215 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
216 be disabled.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
217 </note>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
218 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
219
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
220 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
221
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
222
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
223 <directive name="ssl_session_cache">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
224 <syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
225 <literal>off</literal> |
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
226 <literal>none</literal> |
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
227 [<literal>builtin</literal>[:<value>size</value>]]
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
228 [<literal>shared</literal>:<value>name</value>:<value>size</value>]</syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
229 <default>none</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
230 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
231 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
232
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
233 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
234 Sets the types and sizes of caches that store session parameters.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
235 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
236 <list type="tag">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
237
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
238 <tag-name><literal>off</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
239 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
240 the use of a session cache is strictly prohibited:
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
241 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
242 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
243
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
244 <tag-name><literal>none</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
245 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
246 the use of a session cache is gently disallowed:
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
247 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
248 actually store session parameters in the cache.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
249 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
250
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
251 <tag-name><literal>builtin</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
252 <tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
253 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
254 The cache size is specified in sessions.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
255 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
256 Use of the built-in cache can cause memory fragmentation.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
257 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
258
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
259 <tag-name><literal>shared</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
260 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
261 a cache shared between all worker processes.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
262 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
263 about 4000 sessions.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
264 Each shared cache should have an arbitrary name.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
265 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
266 servers.
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
267 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
268
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
269 </list>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
270 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
271
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
272 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
273 Both cache types can be used simultaneously, for example:
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
274 <example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
275 ssl_session_cache builtin:1000 shared:SSL:10m;
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
276 </example>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
277 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
278 be more efficient.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
279 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
280
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
281 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
282
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
283
1019
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
284 <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
285 <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
286 <default/>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
287 <context>mail</context>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
288 <context>server</context>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
289 <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
290
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
291 <para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
292 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
293 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
294 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
295 multiple servers.
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
296 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
297 </para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
298
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
299 <para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
300 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
301 used to encrypt TLS session tickets.
1144
ac131944d349 Changed infinitive to gerund after "allow".
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1019
diff changeset
302 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
303 <example>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
304 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
305 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
306 </example>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
307 </para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
308
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
309 <para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
310 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
311 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
312 <example>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
313 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
314 </example>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
315 </para>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
316
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
317 </directive>
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
318
2b6a858c60dc Documented the "ssl_session_ticket_key" directive in http and mail.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
319
1266
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
320 <directive name="ssl_session_tickets">
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
321 <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
322 <default>on</default>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
323 <context>mail</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
324 <context>server</context>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
325 <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
326
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
327 <para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
328 Enables or disables session resumption through
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
329 <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
330 </para>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
331
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
332 </directive>
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
333
35d6ac64bf27 Documented five directives in the mail ssl module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1144
diff changeset
334
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
335 <directive name="ssl_session_timeout">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
336 <syntax><value>time</value></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
337 <default>5m</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
338 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
339 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
340
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
341 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
342 Specifies a time during which a client may reuse the
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
343 session parameters stored in a cache.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
344 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
345
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
346 </directive>
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
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
349 <directive name="starttls">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
350 <syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
351 <literal>on</literal> |
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
352 <literal>off</literal> |
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
353 <literal>only</literal></syntax>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
354 <default>off</default>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
355 <context>mail</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
356 <context>server</context>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
357
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
358 <para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
359 <list type="tag">
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
360
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
361 <tag-name><literal>on</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
362 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
363 allow usage of the <literal>STLS</literal> command for the POP3
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
364 and the <literal>STARTTLS</literal> command for the IMAP;
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
365 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
366
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
367 <tag-name><literal>off</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
368 <tag-desc>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 751
diff changeset
369 deny usage of the <literal>STLS</literal>
664
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
370 and <literal>STARTTLS</literal> commands;
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
371 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
372
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
373 <tag-name><literal>only</literal></tag-name>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
374 <tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
375 require preliminary TLS transition.
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
376 </tag-desc>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
377
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
378 </list>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
379 </para>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
380
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
381 </directive>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
382
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
383 </section>
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
384
8283b1048b27 Translated mail modules into English.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
385 </module>