Mercurial > hg > nginx-site

comparison xml/en/docs/mail/ngx_mail_ssl_module.xml @ 966:95c3c3bbf1ce

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Text review.
author Egor Nikitin <yegor.nikitin@gmail.com>
date Wed, 14 Aug 2013 12:03:41 +0400
parents 9c1ffd02f1b7
children 2b6a858c60dc
comparison
equal deleted inserted replaced
965:fadccc156188 966:95c3c3bbf1ce
13 rev="2"> 13 rev="2">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_mail_ssl_module</literal> provides the necessary 18 The <literal>ngx_mail_ssl_module</literal> module provides the necessary
19 support for mail proxy server for the SSL/TLS protocol. 19 support for a mail proxy server to work with the SSL/TLS protocol.
20 </para> 20 </para>
21 21
22 <para> 22 <para>
23 This module is not built by default, it should be enabled with 23 This module is not built by default, it should be enabled with
24 the <literal>--with-mail_ssl_module</literal> 24 the <literal>--with-mail_ssl_module</literal>
52 <default/> 52 <default/>
53 <context>mail</context> 53 <context>mail</context>
54 <context>server</context> 54 <context>server</context>
55 55
56 <para> 56 <para>
57 Specifies a file with a certificate in the PEM format for the given 57 Specifies a file with the certificate in the PEM format for the given
58 server. 58 server.
59 If intermediate certificates should be specified in addition to a primary 59 If intermediate certificates should be specified in addition to a primary
60 certificate, they should be specified in the same file in the following 60 certificate, they should be specified in the same file in the following
61 order: the primary certificate comes first, then the intermediate certificates. 61 order: the primary certificate comes first, then the intermediate certificates.
62 A secret key in the PEM format may be placed in the same file. 62 A secret key in the PEM format may be placed in the same file.
70 <default/> 70 <default/>
71 <context>mail</context> 71 <context>mail</context>
72 <context>server</context> 72 <context>server</context>
73 73
74 <para> 74 <para>
75 Specifies a file with a secret key in the PEM format for the given 75 Specifies a file with the secret key in the PEM format for the given
76 server. 76 server.
77 </para> 77 </para>
78 78
79 </directive> 79 </directive>
80 80
85 <context>mail</context> 85 <context>mail</context>
86 <context>server</context> 86 <context>server</context>
87 87
88 <para> 88 <para>
89 Specifies that server ciphers should be preferred over client ciphers 89 Specifies that server ciphers should be preferred over client ciphers
90 when using the SSLv3 and TLS protocols. 90 when the SSLv3 and TLS protocols are used.
91 </para> 91 </para>
92 92
93 </directive> 93 </directive>
94 94
95 95
104 <context>mail</context> 104 <context>mail</context>
105 <context>server</context> 105 <context>server</context>
106 106
107 <para> 107 <para>
108 Enables the specified protocols. 108 Enables the specified protocols.
109 The parameters <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> work 109 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters work
110 only when using the OpenSSL library version 1.0.1 and higher. 110 only when the OpenSSL library of version 1.0.1 or higher is used.
111 <note> 111 <note>
112 The parameters <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> are 112 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters are
113 supported starting from versions 1.1.13 and 1.0.12 113 supported starting from versions 1.1.13 and 1.0.12
114 so when using OpenSSL version 1.0.1 114 so when the OpenSSL version 1.0.1 or higher
115 and higher on older nginx versions these protocols will work but could not 115 is used on older nginx versions, these protocols work, but cannot
116 be disabled. 116 be disabled.
117 </note> 117 </note>
118 </para> 118 </para>
119 119
120 </directive> 120 </directive>
129 <default>none</default> 129 <default>none</default>
130 <context>mail</context> 130 <context>mail</context>
131 <context>server</context> 131 <context>server</context>
132 132
133 <para> 133 <para>
134 Sets types and sizes of caches that store session parameters. 134 Sets the types and sizes of caches that store session parameters.
135 A cache can be any of the following types: 135 A cache can be of any of the following types:
136 <list type="tag"> 136 <list type="tag">
137 137
138 <tag-name><literal>off</literal></tag-name> 138 <tag-name><literal>off</literal></tag-name>
139 <tag-desc> 139 <tag-desc>
140 the use of session cache is strictly prohibited: 140 the use of a session cache is strictly prohibited:
141 nginx explicitly tells a client that sessions may not be reused. 141 nginx explicitly tells a client that sessions may not be reused.
142 </tag-desc> 142 </tag-desc>
143 143
144 <tag-name><literal>none</literal></tag-name> 144 <tag-name><literal>none</literal></tag-name>
145 <tag-desc> 145 <tag-desc>
146 the use of session cache is gently disallowed: 146 the use of a session cache is gently disallowed:
147 nginx tells a client that sessions may be reused, but does not 147 nginx tells a client that sessions may be reused, but does not
148 actually do that. 148 actually store session parameters in the cache.
149 </tag-desc> 149 </tag-desc>
150 150
151 <tag-name><literal>builtin</literal></tag-name> 151 <tag-name><literal>builtin</literal></tag-name>
152 <tag-desc> 152 <tag-desc>
153 a cache built in OpenSSL; used by one worker process only. 153 a cache built in OpenSSL; used by one worker process only.
156 Use of the built-in cache can cause memory fragmentation. 156 Use of the built-in cache can cause memory fragmentation.
157 </tag-desc> 157 </tag-desc>
158 158
159 <tag-name><literal>shared</literal></tag-name> 159 <tag-name><literal>shared</literal></tag-name>
160 <tag-desc> 160 <tag-desc>
161 shared between all worker processes. 161 a cache shared between all worker processes.
162 The cache size is specified in bytes; one megabyte can store 162 The cache size is specified in bytes; one megabyte can store
163 about 4000 sessions. 163 about 4000 sessions.
164 Each shared cache should have an arbitrary name. 164 Each shared cache should have an arbitrary name.
165 A cache with the same name can be used in several 165 A cache with the same name can be used in several
166 servers. 166 servers.
207 <para> 207 <para>
208 <list type="tag"> 208 <list type="tag">
209 209
210 <tag-name><literal>on</literal></tag-name> 210 <tag-name><literal>on</literal></tag-name>
211 <tag-desc> 211 <tag-desc>
212 Allow usage of <literal>STLS</literal> command for the POP3 212 allow usage of the <literal>STLS</literal> command for the POP3
213 and <literal>STARTTLS</literal> command for the IMAP; 213 and the <literal>STARTTLS</literal> command for the IMAP;
214 </tag-desc> 214 </tag-desc>
215 215
216 <tag-name><literal>off</literal></tag-name> 216 <tag-name><literal>off</literal></tag-name>
217 <tag-desc> 217 <tag-desc>
218 Deny usage of <literal>STLS</literal> 218 deny usage of the <literal>STLS</literal>
219 and <literal>STARTTLS</literal> commands; 219 and <literal>STARTTLS</literal> commands;
220 </tag-desc> 220 </tag-desc>
221 221
222 <tag-name><literal>only</literal></tag-name> 222 <tag-name><literal>only</literal></tag-name>
223 <tag-desc> 223 <tag-desc>