Merge branch 'master' of github.com:BetterCrypto/Applied-Crypto-Hardening
[ach-master.git] / src / practical_settings / mailserver.tex
1 %%\subsection{Mail Servers}
2
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
8 \subsection{SMTP in general}
9 \label{subsection:smtp_general}
10
11 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.\\
12
13 Furthermore a mailserver can operate in three modes:
14 \begin{itemize}
15 \item As MSA (Mail Submission Agent) your mailserver receives mail from your clients MUAs (Mail User Agent).
16 \item As receiving MTA (Mail Transmission Agent, MX)
17 \item As sending MTA (SMTP client)
18 \end{itemize}
19 \mbox{}\\
20 We recommend the following basic setup for all modes:
21 \begin{itemize}
22 \item correctly setup MX, A and PTR RRs without using CNAMEs at all.
23 \item enable encryption (opportunistic TLS)
24 \item do not use self signed certificates
25 \end{itemize}
26
27 For SMTP client mode we additionally recommend:
28 \begin{itemize}
29 \item the hostname used as HELO must match the PTR RR
30 \item setup a client certificate (most server certificates are client certificates as well)
31 \item either the common name or at least an alternate subject name of your certificate must match the PTR RR
32 \item do not modify the cipher suite for client mode
33 \end{itemize}
34
35 For MSA operation we recommend:
36 \begin{itemize}
37 \item listen on submission port 587
38 \item enforce SMTP AUTH even for local networks
39 \item do not allow SMTP AUTH on unencrypted connections
40 \item optionally use the recommended cipher suites if (and only if) all your connecting MUAs support them
41 \end{itemize}
42
43
44
45 % 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.
46
47 We strongly recommend to allow all cipher suites for anything but MSA
48 mode, because the alternative is plain text transmission.
49
50 %% ---------------------------------------------------------------------- 
51
52 \subsection{Dovecot}
53
54
55 \subsubsection{Tested with Version} 
56 \begin{itemize}
57 \item Dovecot 2.2
58 \item 2.0.19apple1 on OS X Server 10.8.5 (without ssl\_prefer\_server\_ciphers)
59 \end{itemize}
60
61 \subsubsection{Settings}
62 % Example: http://dovecot.org/list/dovecot/2013-October/092999.html
63
64 \begin{lstlisting}
65   ssl_cipher_list = '%*\cipherstringB*)'
66   ssl_prefer_server_ciphers = yes
67 \end{lstlisting}
68
69 \subsubsection{Additional info}
70
71 Dovecot 2.0, 2.1: Almost as good as dovecot 2.2. Dovecot does not ignore unknown configuration parameters. Does not support
72 ssl\_prefer\_server\_ciphers
73
74 \subsubsection{Limitations}
75
76 Dovecot currently does not support disabling TLS compression. Furthermore, DH
77 parameters greater than 1024bit are not supported. The most recent version
78 2.2.7 of Dovecot implements configurable DH parameter length
79 \footnote{\url{http://hg.dovecot.org/dovecot-2.2/rev/43ab5abeb8f0}}.
80
81 %\item[Justification for special settings (if needed):] \mbox{}
82
83 % 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
84
85 \subsubsection{References} \url{http://wiki2.dovecot.org/SSL}
86
87 % add any further references or best practice documents here
88
89 \subsubsection{How to test}
90 % 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.
91 \begin{lstlisting}
92  openssl s_client -crlf -connect SERVER.TLD:993
93 \end{lstlisting}
94
95
96 %% ---------------------------------------------------------------------- 
97
98 \subsection{cyrus-imapd (based on 2.4.17)}
99
100 \subsubsection{Tested with Version} \todo{FIXME: add}
101
102 \subsubsection{Settings}
103 \paragraph*{imapd.conf}\mbox{}\\
104
105 To activate SSL/TLS configure your certificate with
106 \begin{lstlisting}
107   tls_cert_file: .../cert.pem
108   tls_key_file: .../cert.key
109 \end{lstlisting}
110
111 Do not forget to add necessary intermediate certificates to the .pem file.\\
112
113 Limiting the ciphers provided may force (especially older) clients to connect without encryption at all! Sticking to the defaults is recommended.\\
114
115 If you still want to force strong encryption use
116 \begin{lstlisting}
117   tls_cipher_list: %*\cipherstringB*)
118 \end{lstlisting}
119
120 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.\\
121
122 To prevent unencrypted connections on the STARTTLS ports you can set
123 \begin{lstlisting}
124   allowplaintext: 0
125 \end{lstlisting}
126 This way MUAs can only authenticate after STARTTLS if you only provide plaintext and SASL PLAIN login methods. Therefore providing CRAM-MD5 or DIGEST-MD5 methods is not recommended.\\
127
128 \paragraph*{cyrus.conf}\mbox{}\\
129
130 To support POP3/IMAP on ports 110/143 with STARTTLS add
131 \begin{lstlisting}
132   imap         cmd="imapd" listen="imap" prefork=3
133   pop3         cmd="pop3d" listen="pop3" prefork=1
134 \end{lstlisting}
135 to the SERVICES section.\\
136
137 To support POP3S/IMAPS on ports 995/993 add
138 \begin{lstlisting}
139   imaps        cmd="imapd -s" listen="imaps" prefork=3
140   pop3s        cmd="pop3d -s" listen="pop3s" prefork=1
141 \end{lstlisting}
142
143
144 \subsubsection{Limitations}
145
146 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.\\
147
148 Currently there is no way to prefer server ciphers or to disable compression.\\
149
150 There is a working patch for all three features:
151 \url{https://bugzilla.cyrusimap.org/show_bug.cgi?id=3823}\\
152
153 \subsubsection{How to test}
154 \begin{lstlisting}
155   openssl s_client -crlf -connect SERVER.TLD:993
156 \end{lstlisting}
157
158
159
160 % XXX config von Adi?
161 % sslVersion = TLSv1
162 % ciphers = EDH+CAMELLIA256:EDH+aRSA:+SSLv3:!aNULL:!eNULL:!LOW:!3DES:!MD5:!EXP:!PSK:!SRP:!DSS:!RC4:!SEED:-AES128:!CAMELLIA128:!ECDSA:AES256-SHA:EDH+AES128;
163 % options = CIPHER_SERVER_PREFERENCE
164 % TIMEOUTclose = 1
165
166 \subsection{Postfix}
167
168 \subsubsection{Tested with Version} Postfix 2.9.6 (Debian Wheezy)
169 \subsubsection{Settings}
170
171 %% I (cm) consider the generation of own DH parameters to be voodoo until
172 %% someone can explain the contrary. They are, after all, public, and
173 %% I found no research that would show that long-term use of a
174 %% parameter set would weaken the DH exchange. Also notice that IPSEC
175 %% uses fixed parameter sets only.
176 %& 
177 %% also notice the following comment from  src/tls/tls_dh.c:
178 %% * Compiled-in EDH primes (the compiled-in generator is always 2). These are
179 %% * used when no parameters are explicitly loaded from a site-specific file.
180 %% * 
181 %% * 512-bit parameters are used for export ciphers, and 1024-bit parameters are
182 %% * used for non-export ciphers. An ~80-bit strong EDH key exchange is really
183 %% * too weak to protect 128+ bit keys, but larger DH primes are
184 %% * computationally expensive. When greater security is required, use EECDH.
185
186 %% First, you need to generate Diffie Hellman parameters (please first take a look at the section \ref{section:RNGs}):
187
188 %% \todo{FIXME: this is a really weak setting! See also: http://postfix.1071664.n5.nabble.com/postfix-hardening-what-can-we-do-td61874.html}
189 %% \begin{lstlisting}
190 %%   % openssl gendh -out /etc/postfix/dh_param_512.pem -2 512
191 %%   % openssl gendh -out /etc/postfix/dh_param_1024.pem -2 1024
192 %% \end{lstlisting}
193
194 %% Next, we specify these DH parameters in \verb|main.cf|:
195
196 %% \begin{lstlisting}
197 %%   smtpd_tls_dh512_param_file = /etc/postfix/dh_param_512.pem
198 %%   smtpd_tls_dh1024_param_file = /etc/postfix/dh_param_1024.pem
199 %% \end{lstlisting}
200
201 \paragraph*{MX and SMTP client configuration}\mbox{}\\
202
203 As discussed in section \ref{subsection:smtp_general}, because of opportunistic encryption we do not
204 restrict the list of ciphers. There are still some steps needed to
205 enable TLS, all in \verb|main.cf|:
206
207 \begin{lstlisting}
208   smtpd_tls_cert_file = /etc/postfix/server.pem
209   smtpd_tls_key_file = /etc/postfix/server.key
210   # use 0 for Postfix >= 2.9, and 1 for earlier versions
211   smtpd_tls_loglevel = 0
212   # enable opportunistic TLS support in the SMTP server and client
213   smtpd_tls_security_level = may
214   smtp_tls_security_level = may
215   # if you have authentication enabled, only offer it after STARTTLS
216   smtpd_tls_auth_only = yes
217   tls_ssl_options = NO_COMPRESSION
218 \end{lstlisting}
219
220 \paragraph*{MSA}\mbox{}\\
221
222 For the MSA \verb|smtpd| process, we first define the ciphers that are
223 acceptable for the ``mandatory'' security level, again in
224 \verb|main.cf|:
225
226 \begin{lstlisting}
227   smtpd_tls_mandatory_protocols = !SSLv2, !SSLv3
228   smtpd_tls_mandatory_ciphers=high
229   tls_high_cipherlist=%*\cipherstringB*)
230 \end{lstlisting}
231
232 Then, we configure the MSA smtpd in \verb|master.cf| with two
233 additional options that are only used for this instance of smtpd:
234
235 \begin{lstlisting}
236 587       inet  n       -       -       -       -       smtpd 
237         -o smtpd_tls_security_level=encrypt -o tls_preempt_cipherlist = yes
238 \end{lstlisting}
239
240 For those users who want to use ECC key exchange, it is possible to specify this via:
241 \begin{lstlisting}
242   smtpd_tls_eecdh_grade = ultra
243 \end{lstlisting}
244
245 \subsubsection{Limitations}
246
247 tls\_ssl\_options is supported from Postfix 2.11 onwards. You can
248 leave the statement in the configuration for older versions, it will
249 be ignored.
250
251 tls\_preempt\_cipherlist is supported from Postfix 2.8 onwards. Again,
252 you can leave the statement in for older versions.
253
254 \subsubsection{References}
255
256 Refer to \url{http://www.postfix.org/TLS_README.html} for an in-depth
257 discussion.
258
259 \subsubsection{Additional settings}
260
261 Postfix has two sets of built-in DH parameters that can be overridden
262 with the \verb|smtpd_tls_dh512_param_file|
263 and \verb|smtpd_tls_dh1024_param_file| options. The ``dh512''
264 parameters are used for export ciphers, while the ``dh1024'' ones are
265 used for all other ciphers.
266
267 The ``bit length'' in those parameter names is just a name, so one
268 could use stronger parameter sets; it should be possible to e.g. use the
269 IKE Group14 parameters (see section \ref{section:DH}) without much
270 interoperability risk, but we have not tested this yet.
271
272 % \item[Justification for special settings (if needed):]
273 % no special settings
274
275
276 \subsubsection{How to test}
277
278 You can check the effect of the settings with the following command:
279 \begin{lstlisting}
280 $ 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
281       1 SSLv3 with cipher DHE-RSA-AES256-SHA
282      23 TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384
283      60 TLSv1 with cipher ECDHE-RSA-AES256-SHA
284     270 TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384
285     335 TLSv1 with cipher DHE-RSA-AES256-SHA
286 \end{lstlisting}
287
288 \begin{lstlisting}
289  openssl s_client -starttls smtp -crlf -connect SERVER.TLD:25
290 \end{lstlisting}
291
292 \subsubsection{References} \todo{FIXME}
293
294 %% ---------------------------------------------------------------------- 
295
296 \subsection{Exim (based on 4.82)}
297
298 It is highly recommended to read
299 \url{http://exim.org/exim-html-current/doc/html/spec_html/ch-encrypted_smtp_connections_using_tlsssl.html}
300 first.
301
302 \paragraph*{MSA mode (submission)}\mbox{}\\
303
304 In the main config section of Exim add:
305
306 \begin{lstlisting}
307   tls_certificate = ..../cert.pem
308   tls_privatekey = ..../cert.key
309 \end{lstlisting}
310 don't forget to add intermediate certificates to the .pem file if needed.\\
311 \\
312 Tell Exim to advertise STARTTLS in the EHLO answer to everyone:
313 \begin{lstlisting}
314   tls_advertise_hosts = *
315 \end{lstlisting}
316
317 If you want to support legacy SMTPS on port 465, and STARTTLS on smtp(25)/submission(587) ports set
318 \begin{lstlisting}
319   daemon_smtp_ports = smtp : smtps : submission
320   tls_on_connect_ports = 465
321 \end{lstlisting}
322 \mbox{}\\
323 It is highly recommended to limit SMTP AUTH to SSL connections only. To do so add
324 \begin{lstlisting}
325   server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
326 \end{lstlisting}
327 to every authenticator defined.\\
328
329 Add the following rules on top of your acl\_smtp\_mail:
330 \begin{lstlisting}
331   warn    hosts           = *
332           control         = submission/sender_retain
333 \end{lstlisting}
334 This switches Exim to submission mode and allows addition of missing ``Message-ID'' and ``Date'' headers.\\
335
336 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.\\
337 % Exim maintainers do not recommend to change default ciphers
338 % I think we shouldn't, too
339 %use:
340 %\begin{lstlisting}
341 %  tls_require_ciphers = <...recommended ciphersuite...>
342 %\end{lstlisting}
343
344 The cipher used is written to the logfiles by default. You may want to add
345 \begin{lstlisting}
346   log_selector = <....whatever your log_selector already contains...> \
347    +tls_certificate_verified +tls_peerdn +tls_sni
348 \end{lstlisting}
349 to get even more TLS information logged.
350
351
352 \paragraph*{server mode (incoming)}\mbox{}\\
353
354 In the main config section of Exim add:
355
356 \begin{lstlisting}
357   tls_certificate = ..../cert.pem
358   tls_privatekey = ..../cert.key
359 \end{lstlisting}
360 don't forget to add intermediate certificates to the .pem file if needed.\\
361 \\
362 Tell Exim to advertise STARTTLS in the EHLO answer to everyone:
363 \begin{lstlisting}
364   tls_advertise_hosts = *
365 \end{lstlisting}
366
367 Listen on smtp(25) port only
368 \begin{lstlisting}
369   daemon_smtp_ports = smtp
370 \end{lstlisting}
371
372 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.\\
373 % Exim maintainers do not recommend to change default ciphers
374 % We shouldn't, too
375 %use:
376 %\begin{lstlisting}
377 %  tls_require_ciphers = <...recommended ciphersuite...>
378 %\end{lstlisting}
379
380 If you want to request and verify client certificates from sending hosts set
381 \begin{lstlisting}
382   tls_verify_certificates = /etc/pki/tls/certs/ca-bundle.crt
383   tls_try_verify_hosts = *
384 \end{lstlisting}
385
386 tls\_try\_verify\_hosts only reports the result to your logfile. If you want to disconnect such clients you have to use
387 \begin{lstlisting}
388   tls_verify_hosts = *
389 \end{lstlisting}
390
391 The cipher used is written to the logfiles by default. You may want to add
392 \begin{lstlisting}
393   log_selector = <....whatever your log_selector already contains...> \
394    +tls_certificate_verified +tls_peerdn +tls_sni
395 \end{lstlisting}
396 to get even more TLS information logged.
397
398 \paragraph*{client mode (outgoing)}\mbox{}\\
399
400 Exim uses opportunistic encryption in the SMTP transport by default.
401
402 Client mode settings have to be done in the configuration section of the smtp transport (driver = smtp).
403
404 If you want to use a client certificate (most server certificates can be used as client certificate, too) set
405 \begin{lstlisting}
406   tls_certificate   = .../cert.pem
407   tls_privatekey    = .../cert.key
408 \end{lstlisting}
409 This is recommended for MTA-MTA traffic.\\
410
411 %If you want to limit used ciphers set
412 %\begin{lstlisting}
413 %  tls_require_ciphers = <...recommended ciphersuite...>
414 %\end{lstlisting}
415 % Exim Maintainers do not recommend ciphers. We shouldn't do so, too.
416 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.
417
418 \paragraph*{OpenSSL}\mbox{}\\
419 Exim already disables SSLv2 by default. We recommend to add
420 \begin{lstlisting}
421   openssl_options = +all +no_sslv2 +no_compression +cipher_server_preference
422 \end{lstlisting}
423 to the main configuration.\\
424 Note: +all is misleading here since OpenSSL only activates the most common workarounds. But that's how SSL\_OP\_ALL is defined.\\
425
426 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).
427 If you want to set your own DH parameters please read the TLS documentation of exim.\\
428
429
430
431 \paragraph*{GnuTLS}\mbox{}\\
432
433 GnuTLS is different in only some respects to OpenSSL:
434 \begin{itemize}
435 \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.
436 \item There is no option like openssl\_options
437 \end{itemize}
438
439 \paragraph*{Exim string expansion}\mbox{}\\
440
441 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.
442
443 \paragraph*{Limitations}\mbox{}\\
444
445 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.
446 There already is a working patch to provide support:\\
447 \url{http://bugs.exim.org/show_bug.cgi?id=1397}
448
449 \paragraph*{How to test}\mbox{}\\
450 \begin{lstlisting}
451  openssl s_client -starttls smtp -crlf -connect SERVER.TLD:25
452 \end{lstlisting}
453
454
455 %% ----------------------------------------------------------------------
456 \subsection{Exchange}
457
458 \todo{FIXME: write this section}
459
460
461