1 %%\subsection{Mail Servers}
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.
5 \subsubsection{Dovecot}
9 \item[Tested with Version:] Dovecot 2.2:
11 \item[Settings:] \mbox{}
12 % Example: http://dovecot.org/list/dovecot/2013-October/092999.html
14 \begin{lstlisting}[breaklines]
15 ssl_cipher_list = '@@@CIPHERSTRINGB@@@'
16 ssl_prefer_server_ciphers = yes
19 \item[Additional info:] \mbox{}
21 Dovecot 2.1: Almost as good as dovecot 2.2. Does not support
22 ssl\_prefer\_server\_ciphers
24 \item[Limitations:] \mbox{}
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}}.
31 %\item[Justification for special settings (if needed):] \mbox{}
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
35 \item[References:] \url{http://wiki2.dovecot.org/SSL}
37 % add any further references or best practice documents here
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.
46 %% ----------------------------------------------------------------------
48 \subsubsection{cyrus-imapd (based on 2.4.17)}
50 \paragraph*{imapd.conf}\mbox{}\\
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
58 Do not forget to add necessary intermediate certificates to the .pem file.\\
60 Limiting the ciphers provided may force (especially older) clients to connect without encryption at all! Sticking to the defaults is recommended.\\
62 If you still want to force strong encryption use
63 \begin{lstlisting}[breaklines]
64 tls_cipher_list: @@@CIPHERSTRINGB@@@
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.\\
69 To prevent unencrypted connections on the STARTTLS ports you can set
70 \begin{lstlisting}[breaklines]
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.\\
75 \paragraph*{cyrus.conf}\mbox{}\\
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
82 to the SERVICES section.\\
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
91 \paragraph*{Limitations}\mbox{}\\
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.\\
95 Currently there is no way to prefer server ciphers or to disable compression.\\
97 There is a working patch for all three features:
98 \url{https://bugzilla.cyrusimap.org/show_bug.cgi?id=3823}\\
104 % XXX config von Adi?
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
110 %% ----------------------------------------------------------------------
112 \subsubsection{SMTP in general}
113 \label{subsection:smtp_general}
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.\\
117 Furthermore a mailserver can operate in three modes:
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)
124 We recommend the following basic setup for all modes:
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
131 For SMTP client mode we additionally recommend:
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
139 For MSA operation we recommend:
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
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.
151 We strongly recommend to allow all cipher suites for anything but MSA
152 mode, because the alternative is plain text transmission.
154 %% ----------------------------------------------------------------------
156 \subsubsection{Postfix}
159 \item[Tested with Version:] \mbox{}
162 \item Postfix 2.9.6 (Debian Wheezy)
165 \item[Settings:] \mbox{}
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.
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.
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.
182 %% First, you need to generate Diffie Hellman parameters (please first take a look at the section \ref{section:RNGs}):
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
190 %% Next, we specify these DH parameters in \verb|main.cf|:
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
197 \paragraph*{MX and SMTP client configuration}\mbox{}\\
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|:
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
216 \paragraph*{MSA}\mbox{}\\
218 For the MSA \verb|smtpd| process, we first define the ciphers that are
219 acceptable for the ``mandatory'' security level, again in
222 \begin{lstlisting}[breaklines]
223 smtpd_tls_mandatory_protocols = !SSLv2, !SSLv3
224 smtpd_tls_mandatory_ciphers=high
225 tls_high_cipherlist=@@@CIPHERSTRINGB@@@
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:
231 \begin{lstlisting}[breaklines]
232 587 inet n - - - - smtpd
233 -o smtpd_tls_security_level=encrypt -o tls_preempt_cipherlist = yes
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
241 \item[Limitations:] \mbox{}
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
247 tls\_preempt\_cipherlist is supported from Postfix 2.8 onwards. Again,
248 you can leave the statement in for older versions.
252 Refer to \url{http://www.postfix.org/TLS_README.html} for an in-depth
255 \item[Additional settings:]
257 Postfix has two sets of built-in DH parameters that can be overridden
258 with the \verb|smtpd_tls_dh512_param_file|
259 and \verb|smtpd_tls_dh1024_param_file| options. The ``dh512''
260 parameters are used for export ciphers, while the ``dh1024'' ones are
261 used for all other ciphers.
263 The ``bit lenght'' in those parameter names is just a name, so one
264 could use stronger parameter sets; it should be possible to e.g. use the
265 IKE Group14 parameters (see section \ref{section:DH}) without much
266 interoperability risk, but we have not tested this yet.
268 % \item[Justification for special settings (if needed):]
269 % no special settings
273 You can check the effect of the settings with the following command:
274 \begin{lstlisting}[breaklines]
275 $ 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
276 1 SSLv3 with cipher DHE-RSA-AES256-SHA
277 23 TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384
278 60 TLSv1 with cipher ECDHE-RSA-AES256-SHA
279 270 TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384
280 335 TLSv1 with cipher DHE-RSA-AES256-SHA
286 %% ----------------------------------------------------------------------
288 \subsubsection{Exim (based on 4.82)}
290 It is highly recommended to read
292 \url{http://exim.org/exim-html-current/doc/html/spec_html/ch-encrypted_smtp_connections_using_tlsssl.html}
296 \paragraph*{MSA mode (submission)}\mbox{}\\
298 In the main config section of Exim add:
300 \begin{lstlisting}[breaklines]
301 tls_certificate = ..../cert.pem
302 tls_privatekey = ..../cert.key
304 don't forget to add intermediate certificates to the .pem file if needed.\\
306 Tell Exim to advertise STARTTLS in the EHLO answer to everyone:
307 \begin{lstlisting}[breaklines]
308 tls_advertise_hosts = *
311 If you want to support legacy SMTPS on port 465, and STARTTLS on smtp(25)/submission(587) ports set
312 \begin{lstlisting}[breaklines]
313 daemon_smtp_ports = smtp : smtps : submission
314 tls_on_connect_ports = 465
317 It is highly recommended to limit SMTP AUTH to SSL connections only. To do so add
318 \begin{lstlisting}[breaklines]
319 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
321 to every authenticator defined.\\
323 Add the following rules on top of your acl\_smtp\_mail:
324 \begin{lstlisting}[breaklines]
326 control = submission/sender_retain
328 This switches Exim to submission mode and allows addition of missing ``Message-ID'' and ``Date'' headers.\\
330 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.\\
331 % Exim maintainers do not recommend to change default ciphers
332 % I think we shouldn't, too
334 %\begin{lstlisting}[breaklines]
335 % tls_require_ciphers = <...recommended ciphersuite...>
338 The cipher used is written to the logfiles by default. You may want to add
339 \begin{lstlisting}[breaklines]
340 log_selector = <....whatever your log_selector already contains...> \
341 +tls_certificate_verified +tls_peerdn +tls_sni
343 to get even more TLS information logged.
346 \paragraph*{server mode (incoming)}\mbox{}\\
348 In the main config section of Exim add:
350 \begin{lstlisting}[breaklines]
351 tls_certificate = ..../cert.pem
352 tls_privatekey = ..../cert.key
354 don't forget to add intermediate certificates to the .pem file if needed.\\
356 Tell Exim to advertise STARTTLS in the EHLO answer to everyone:
357 \begin{lstlisting}[breaklines]
358 tls_advertise_hosts = *
361 Listen on smtp(25) port only
362 \begin{lstlisting}[breaklines]
363 daemon_smtp_ports = smtp
366 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.\\
367 % Exim maintainers do not recommend to change default ciphers
370 %\begin{lstlisting}[breaklines]
371 % tls_require_ciphers = <...recommended ciphersuite...>
374 If you want to request and verify client certificates from sending hosts set
375 \begin{lstlisting}[breaklines]
376 tls_verify_certificates = /etc/pki/tls/certs/ca-bundle.crt
377 tls_try_verify_hosts = *
380 tls\_try\_verify\_hosts only reports the result to your logfile. If you want to disconnect such clients you have to use
381 \begin{lstlisting}[breaklines]
385 The cipher used is written to the logfiles by default. You may want to add
386 \begin{lstlisting}[breaklines]
387 log_selector = <....whatever your log_selector already contains...> \
388 +tls_certificate_verified +tls_peerdn +tls_sni
390 to get even more TLS information logged.
392 \paragraph*{client mode (outgoing)}\mbox{}\\
394 Exim uses opportunistic encryption in the SMTP transport by default.
396 Client mode settings have to be done in the configuration section of the smtp transport (driver = smtp).
398 If you want to use a client certificate (most server certificates can be used as client certificate, too) set
399 \begin{lstlisting}[breaklines]
400 tls_certificate = .../cert.pem
401 tls_privatekey = .../cert.key
403 This is recommended for MTA-MTA traffic.\\
405 %If you want to limit used ciphers set
406 %\begin{lstlisting}[breaklines]
407 % tls_require_ciphers = <...recommended ciphersuite...>
409 % Exim Maintainers do not recommend ciphers. We shouldn't do so, too.
410 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.
412 \paragraph*{OpenSSL}\mbox{}\\
413 Exim already disables SSLv2 by default. We recommend to add
414 \begin{lstlisting}[breaklines]
415 openssl_options = +all +no_sslv2 +no_compression +cipher_server_preference
417 to the main configuration.\\
418 Note: +all is misleading here since OpenSSL only activates the most common workarounds. But that's how SSL\_OP\_ALL is defined.\\
420 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).
421 If you want to set your own DH parameters please read the TLS documentation of exim.\\
425 \paragraph*{GnuTLS}\mbox{}\\
427 GnuTLS is different in only some respects to OpenSSL:
429 \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.
430 \item There is no option like openssl\_options
433 \paragraph*{Exim string expansion}\mbox{}\\
435 Note that most of the options accept expansion strings. This way you can eg. set cipher lists or STARTTLS advertisement conditionally. Please follow the link to the official Exim documentation to get more information.
437 \paragraph*{Limitations}\mbox{}\\
439 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.
440 There already is a working patch to provide support:\\
441 \url{http://bugs.exim.org/show_bug.cgi?id=1397}
444 % do we need to documment starttls in detail?
445 %\subsubsection{starttls?}
447 %% ----------------------------------------------------------------------
448 \subsubsection{Exchange}
450 \todo{FIXME: write this section}
453 \item[Tested with Version:] \todo{version?}
455 \item[Settings:] \mbox{}
457 \begin{lstlisting}[breaklines]
458 %Here goes your setting string
461 \item[Additional settings:] \mbox{}
463 %Here you can add additional settings
465 \begin{lstlisting}[breaklines]
466 %copy \& paste additional settings
469 \item[Justification for special settings (if needed):] \mbox{}
471 % 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
473 \item[References:] \todo{add references}
475 % add any further references or best practice documents here
478 % 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.