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