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