Add information about DH param compatibility
[ach-master.git] / src / practical_settings / mailserver.tex
1 % hack.
2 \gdef\currentsectionname{MailServers}
3 This section documents the most common mail (SMTP) and IMAPs/POPs servers. Another option to secure IMAPs/POPs servers is to place them behind an stunnel server.
4
5
6 %% ----------------------------------------------------------------------
7 \subsection{SMTP in general}
8 \label{subsection:smtp_general}
9 SMTP usually makes use of opportunistic TLS. This means that an MTA will accept TLS connections when asked for it during handshake but will not require it. One should always support incoming opportunistic TLS and always try TLS handshake outgoing.
10
11 Furthermore a mailserver can operate in three modes:
12 \begin{itemize*}
13   \item As MSA (Mail Submission Agent) your mailserver receives mail from your clients MUAs (Mail User Agent).
14   \item As receiving MTA (Mail Transmission Agent, MX)
15   \item As sending MTA (SMTP client)
16 \end{itemize*}
17 We recommend the following basic setup for all modes:
18 \begin{itemize*}
19   \item correctly setup MX, A and PTR RRs without using CNAMEs at all.
20   \item enable encryption (opportunistic TLS)
21   \item do not use self signed certificates
22 \end{itemize*}
23
24 For SMTP client mode we additionally recommend:
25 \begin{itemize*}
26   \item the hostname used as HELO must match the PTR RR
27   \item setup a client certificate (most server certificates are client certificates as well)
28   \item either the common name or at least an alternate subject name of your certificate must match the PTR RR
29   \item do not modify the cipher suite for client mode
30 \end{itemize*}
31
32 For MSA operation we recommend:
33 \begin{itemize*}
34   \item listen on submission port 587
35   \item enforce SMTP AUTH even for local networks
36   \item do not allow SMTP AUTH on unencrypted connections
37   \item optionally use the recommended cipher suites if (and only if) all your connecting MUAs support them
38 \end{itemize*}
39
40
41 % Note that (with the exception of MSA mode), it might be better to allow any cipher suite -- since any encryption is better than no encryption when it comes to opportunistic TLS.
42
43 We strongly recommend to allow all cipher suites for anything but MSA
44 mode, because the alternative is plain text transmission.
45
46 %% ----------------------------------------------------------------------
47 \subsection{Dovecot}
48
49
50 \subsubsection{Tested with Version}
51 \begin{itemize*}
52   \item Dovecot 2.1.7, Debian Wheezy (without ``ssl\_prefer\_server\_ciphers'' setting)
53   \item Dovecot 2.2.9, Debian Jessie
54   \item 2.0.19apple1 on OS X Server 10.8.5 (without ``ssl\_prefer\_server\_ciphers'' setting)
55   \item Dovecot 2.2.9 on Ubuntu 14.04 trusty
56 \end{itemize*}
57
58 \subsubsection{Settings}
59 % Example: http://dovecot.org/list/dovecot/2013-October/092999.html
60
61 \configfile{10-ssl.conf}{48-55}{Dovecot SSL configuration}
62
63 \subsubsection{Additional info}
64 Dovecot 2.0, 2.1: Almost as good as dovecot 2.2. Dovecot does not ignore unknown configuration parameters. Does not support
65 ssl\_prefer\_server\_ciphers
66
67 \subsubsection{Limitations}
68 Dovecot currently does not support disabling TLS compression. Furthermore, DH
69 parameters greater than 1024bit are not supported. The most recent version
70 2.2.7 of Dovecot implements configurable DH parameter length
71 \footnote{\url{http://hg.dovecot.org/dovecot-2.2/rev/43ab5abeb8f0}}.
72
73 %\subsubsection{Justification for special settings (if needed)}
74
75 % in case you have the need for further justifications why you chose this and that setting or if the settings do not fit into the standard Variant A or Variant B schema, please document this here
76
77 \subsubsection{References}
78 \begin{itemize*}
79   \item \url{http://wiki2.dovecot.org/SSL}
80 \end{itemize*}
81
82 % add any further references or best practice documents here
83
84 \subsubsection{How to test}
85 % describe here or point the admin to tools (can be a simple footnote or \ref{} to  the tools section) which help the admin to test his settings.
86 \begin{lstlisting}
87 openssl s_client -crlf -connect SERVER.TLD:993
88 \end{lstlisting}
89
90
91 %% ----------------------------------------------------------------------
92 \subsection{cyrus-imapd}
93 \subsubsection{Tested with Versions}
94 \begin{itemize*}
95   \item 2.4.17
96 \end{itemize*}
97
98 \subsubsection{Settings}
99
100 To activate SSL/TLS configure your certificate with
101 \configfile{imapd.conf}{206-206,209-209}{Activating TLS in cyrus}
102
103 Do not forget to add necessary intermediate certificates to the .pem file.
104
105 Limiting the ciphers provided may force (especially older) clients to connect without encryption at all! Sticking to the defaults is recommended.
106
107 If you still want to force strong encryption use
108 \configfile{imapd.conf}{263-263}{TLS cipher selection in cyrus}
109
110 cyrus-imapd loads hardcoded 1024 bit DH parameters using get\_rfc2409\_prime\_1024() by default. If you want to load your own DH parameters add them PEM encoded to the certificate file given in tls\_cert\_file. Do not forget to re-add them after updating your certificate.
111
112 To prevent unencrypted connections on the STARTTLS ports you can set
113 \configfile{imapd.conf}{131-131}{Force encrypted connections in cyrus}
114 This way MUAs can only authenticate with plain text authentication schemes after issuing the STARTTLS command. Providing CRAM-MD5 or DIGEST-MD5 methods is not recommended.
115
116 To support POP3/IMAP on ports 110/143 with STARTTLS and POP3S/IMAPS on ports
117 995/993 check the SERVICES section in \texttt{cyrus.conf}
118 \configfile{cyrus.conf}{28-28,31-34,71-71}{STARTTLS for POP3/IMAP and POP3S/IMAPS in cyrus}
119
120
121 \subsubsection{Limitations}
122 cyrus-imapd currently (2.4.17, trunk) does not support elliptic curve cryptography. Hence, ECDHE will not work even if defined in your cipher list.
123
124 Currently there is no way to prefer server ciphers or to disable compression.
125
126 There is a working patch for all three features:
127 \url{https://bugzilla.cyrusimap.org/show_bug.cgi?id=3823}
128
129 \subsubsection{How to test}
130 \begin{lstlisting}
131 openssl s_client -crlf -connect SERVER.TLD:993
132 \end{lstlisting}
133
134 % XXX config von Adi?
135 % sslVersion = TLSv1
136 % ciphers = EDH+CAMELLIA256:EDH+aRSA:+SSLv3:!aNULL:!eNULL:!LOW:!3DES:!MD5:!EXP:!PSK:!SRP:!DSS:!RC4:!SEED:-AES128:!CAMELLIA128:!ECDSA:AES256-SHA:EDH+AES128;
137 % options = CIPHER_SERVER_PREFERENCE
138 % TIMEOUTclose = 1
139
140
141 %% ----------------------------------------------------------------------
142 \subsection{Postfix}
143
144 \subsubsection{Tested with Versions}
145 \begin{itemize*}
146   \item Postfix 2.9.6, Debian Wheezy
147 \end{itemize*}
148
149
150 \subsubsection{Settings}
151
152 %% I (cm) consider the generation of own DH parameters to be voodoo until
153 %% someone can explain the contrary. They are, after all, public, and
154 %% I found no research that would show that long-term use of a
155 %% parameter set would weaken the DH exchange. Also notice that IPSEC
156 %% uses fixed parameter sets only.
157 %&
158 %% also notice the following comment from  src/tls/tls_dh.c:
159 %% * Compiled-in EDH primes (the compiled-in generator is always 2). These are
160 %% * used when no parameters are explicitly loaded from a site-specific file.
161 %% *
162 %% * 512-bit parameters are used for export ciphers, and 1024-bit parameters are
163 %% * used for non-export ciphers. An ~80-bit strong EDH key exchange is really
164 %% * too weak to protect 128+ bit keys, but larger DH primes are
165 %% * computationally expensive. When greater security is required, use EECDH.
166
167 %% First, you need to generate Diffie Hellman parameters (please first take a look at the section \ref{section:RNGs}):
168
169 %% \todo{FIXME: this is a really weak setting! See also: http://postfix.1071664.n5.nabble.com/postfix-hardening-what-can-we-do-td61874.html}
170 %% \begin{lstlisting}
171 %%   % openssl gendh -out /etc/postfix/dh_param_512.pem -2 512
172 %%   % openssl gendh -out /etc/postfix/dh_param_1024.pem -2 1024
173 %% \end{lstlisting}
174
175 %% Next, we specify these DH parameters in \verb|main.cf|:
176
177 %% \begin{lstlisting}
178 %%   smtpd_tls_dh512_param_file = /etc/postfix/dh_param_512.pem
179 %%   smtpd_tls_dh1024_param_file = /etc/postfix/dh_param_1024.pem
180 %% \end{lstlisting}
181
182 \paragraph{MX and SMTP client configuration:}
183 As discussed in section \ref{subsection:smtp_general}, because of opportunistic encryption we do not
184 restrict the list of ciphers. There are still some steps needed to
185 enable TLS, all in \verb|main.cf|:
186
187 \configfile{main.cf}{22-33}{Opportunistic TLS in Postfix}
188
189 \paragraph{MSA:}
190 For the MSA \verb|smtpd| process, we first define the ciphers that are
191 acceptable for the ``mandatory'' security level, again in
192 \verb|main.cf|:
193
194 \configfile{main.cf}{35-37}{MSA TLS configuration in Postfix}
195
196 Then, we configure the MSA smtpd in \verb|master.cf| with two
197 additional options that are only used for this instance of smtpd:
198
199 \configfile{master.cf}{12-14}{MSA smtpd service configuration in Postfix}
200
201 For those users who want to use EECDH key exchange, it is possible to customize this via:
202 \configfile{main.cf}{38-38}{EECDH customization in Postfix}
203 The default value since Postfix 2.8 is ``strong''.
204
205
206 \subsubsection{Limitations}
207 tls\_ssl\_options is supported from Postfix 2.11 onwards. You can
208 leave the statement in the configuration for older versions, it will
209 be ignored.
210
211 tls\_preempt\_cipherlist is supported from Postfix 2.8 onwards. Again,
212 you can leave the statement in for older versions.
213
214 \subsubsection{References}
215 Refer to \url{http://www.postfix.org/TLS_README.html} for an in-depth
216 discussion.
217
218 \subsubsection{Additional settings}
219 Postfix has two sets of built-in DH parameters that can be overridden
220 with the \verb|smtpd_tls_dh512_param_file|
221 and \verb|smtpd_tls_dh1024_param_file| options. The ``dh512''
222 parameters are used for export ciphers, while the ``dh1024'' ones are
223 used for all other ciphers.
224
225 The ``bit length'' in those parameter names is just a name, so one
226 could use stronger parameter sets; it should be possible to e.g. use the
227 IKE Group14 parameters (see section \ref{section:DH}) without much
228 interoperability risk, but we have not tested this yet.
229
230 % \subsubsection{Justification for special settings (if needed)}
231 % no special settings
232
233
234 \subsubsection{How to test}
235 You can check the effect of the settings with the following command:
236 \begin{lstlisting}
237 $ zegrep "TLS connection established from.*with cipher" /var/log/mail.log | awk '{printf("%s %s %s %s\n", $12, $13, $14, $15)}' | sort | uniq -c | sort -n
238       1 SSLv3 with cipher DHE-RSA-AES256-SHA
239      23 TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384
240      60 TLSv1 with cipher ECDHE-RSA-AES256-SHA
241     270 TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384
242     335 TLSv1 with cipher DHE-RSA-AES256-SHA
243 \end{lstlisting}
244
245 \begin{lstlisting}
246 openssl s_client -starttls smtp -crlf -connect SERVER.TLD:25
247 \end{lstlisting}
248
249 %% ----------------------------------------------------------------------
250
251 \subsection{Exim}
252
253 \subsubsection{Tested with Versions}
254 \begin{itemize*}
255   \item Exim 4.82, Debian Jessie
256 \end{itemize*}
257
258
259 It is highly recommended to read
260 \url{http://exim.org/exim-html-current/doc/html/spec_html/ch-encrypted_smtp_connections_using_tlsssl.html}
261 first.
262
263 \paragraph{MSA mode (submission):}
264 In the main config section of Exim add:
265 \configfile{configure.msa}{153-154}{Certificate selection in Exim (MSA)}
266 Don't forget to add intermediate certificates to the .pem file if needed.
267
268 Tell Exim to advertise STARTTLS in the EHLO answer to everyone:
269 \configfile{configure.msa}{145-145}{TLS advertise in Exim (MSA)}
270
271 If you want to support legacy SMTPS on port 465, and STARTTLS on smtp(25)/submission(587) ports set
272 \configfile{configure.msa}{165-166}{STARTTLS and SMTPS in Exim (MSA)}
273
274 It is highly recommended to limit SMTP AUTH to SSL connections only. To do so add
275 \configfile{configure.msa}{813-813}{SSL-only authentication in Exim (MSA)}
276 to every authenticator defined.
277
278 Add the following rules on top of your acl\_smtp\_mail:
279 \configfile{configure.msa}{111-111,501-505}{Submission mode in Exim (MSA)}
280 This switches Exim to submission mode and allows addition of missing ``Message-ID'' and ``Date'' headers.
281
282 It is not advisable to restrict the default cipher list for MSA mode if you don't know all connecting MUAs. If you still want to define one please consult the Exim documentation or ask on the exim-users mailinglist.
283 % Exim maintainers do not recommend to change default ciphers
284 % I think we shouldn't, too
285 %use:
286 %\begin{lstlisting}
287 %  tls_require_ciphers = <...recommended ciphersuite...>
288 %\end{lstlisting}
289
290 The cipher used is written to the logfiles by default. You may want to add
291 \begin{lstlisting}
292 log_selector = <whatever your log_selector already contains> +tls_certificate_verified +tls_peerdn +tls_sni
293 \end{lstlisting}
294 to get even more TLS information logged.
295
296
297 \paragraph{Server mode (incoming):}
298 In the main config section of Exim add:
299 \configfile{configure.server}{152-153}{Certificate selection in Exim (Server)}
300 don't forget to add intermediate certificates to the .pem file if needed.
301
302 Tell Exim to advertise STARTTLS in the EHLO answer to everyone:
303 \configfile{configure.server}{144-144}{TLS advertise in Exim (Server)}
304
305 Listen on smtp(25) port only
306 \configfile{configure.server}{166-166}{STARTTLS on SMTP in Exim (Server)}
307
308 It is not advisable to restrict the default cipher list for opportunistic encryption as used by SMTP. Do not use cipher lists recommended for HTTPS! If you still want to define one please consult the Exim documentation or ask on the exim-users mailinglist.
309 % Exim maintainers do not recommend to change default ciphers
310 % We shouldn't, too
311 %use:
312 %\begin{lstlisting}
313 %  tls_require_ciphers = <...recommended ciphersuite...>
314 %\end{lstlisting}
315
316 If you want to request and verify client certificates from sending hosts set
317 \configfile{configure.server}{154-155}{TLS certificate verifiaction in Exim (Server)}
318
319 tls\_try\_verify\_hosts only reports the result to your logfile. If you want to disconnect such clients you have to use
320 \begin{lstlisting}
321 tls_verify_hosts = *
322 \end{lstlisting}
323
324 The cipher used is written to the logfiles by default. You may want to add
325 \begin{lstlisting}
326 log_selector = <whatever your log_selector already contains> +tls_certificate_verified +tls_peerdn +tls_sni
327 \end{lstlisting}
328 to get even more TLS information logged.
329
330 \paragraph{Client mode (outgoing):}
331 Exim uses opportunistic encryption in the SMTP transport by default.
332
333 Client mode settings have to be done in the configuration section of the smtp transport (driver = smtp).
334
335 If you want to use a client certificate (most server certificates can be used as client certificate, too) set
336 \configfile{configure.client}{152-153}{Certificate selection in Exim (Client)}
337 This is recommended for MTA-MTA traffic.
338
339 %If you want to limit used ciphers set
340 %\begin{lstlisting}
341 %  tls_require_ciphers = <...recommended ciphersuite...>
342 %\end{lstlisting}
343 % Exim Maintainers do not recommend ciphers. We shouldn't do so, too.
344 Do not limit ciphers without a very good reason. In the worst case you end up without encryption at all instead of some weak encryption. Please consult the Exim documentation if you really need to define ciphers.
345
346 \paragraph{OpenSSL:}
347 Exim already disables SSLv2 by default. We recommend to add
348 \begin{lstlisting}
349 openssl_options = +all +no_sslv2 +no_compression +cipher_server_preference
350 \end{lstlisting}
351 to the main configuration.
352
353 Note: +all is misleading here since OpenSSL only activates the most common workarounds. But that's how SSL\_OP\_ALL is defined.
354
355 You do not need to set dh\_parameters. Exim with OpenSSL by default uses parameter initialization with the "2048-bit MODP Group with 224-bit Prime Order Subgroup" defined in section 2.2 of RFC 5114~\cite{rfc5114} (ike23).
356 If you want to set your own DH parameters please read the TLS documentation of exim.
357
358
359 \paragraph{GnuTLS:}
360 GnuTLS is different in only some respects to OpenSSL:
361 \begin{itemize*}
362   \item tls\_require\_ciphers needs a GnuTLS priority string instead of a cipher list. It is recommended to use the defaults by not defining this option. It highly depends on the version of GnuTLS used. Therefore it is not advisable to change the defaults.
363   \item There is no option like openssl\_options
364 \end{itemize*}
365
366 \paragraph{Exim string expansion:}
367 Note that most of the options accept expansion strings. This way you can e.g. set cipher lists or STARTTLS advertisement conditionally. Please follow the link to the official Exim documentation to get more information.
368
369 \paragraph{Limitations:}
370 Exim currently (4.82) does not support elliptic curves with OpenSSL. This means that ECDHE is not used even if defined in your cipher list.
371 There already is a working patch to provide support:
372 \url{http://bugs.exim.org/show_bug.cgi?id=1397}
373
374 \subsubsection{How to test}
375 \begin{lstlisting}
376 openssl s_client -starttls smtp -crlf -connect SERVER.TLD:25
377 \end{lstlisting}
378
379
380 %% ----------------------------------------------------------------------
381 %\subsection{Exchange}
382
383 %\todo{FIXME: write this section}