tested with ubuntu 14.04
[ach-master.git] / src / practical_settings / mailserver.tex
index 71cd01f..d9846cf 100644 (file)
@@ -1,4 +1,6 @@
-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. 
+% hack.
+\gdef\currentsectionname{MailServers}
+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.
 
 
 %% ----------------------------------------------------------------------
@@ -45,20 +47,18 @@ mode, because the alternative is plain text transmission.
 \subsection{Dovecot}
 
 
-\subsubsection{Tested with Version} 
+\subsubsection{Tested with Version}
 \begin{itemize*}
-  \item Dovecot 2.1.17, Debian Wheezy (without ``ssl\_prefer\_server\_ciphers'' setting)
-  \item Dovecot 2.2
+  \item Dovecot 2.1.7, Debian Wheezy (without ``ssl\_prefer\_server\_ciphers'' setting)
+  \item Dovecot 2.2.9, Debian Jessie
   \item 2.0.19apple1 on OS X Server 10.8.5 (without ``ssl\_prefer\_server\_ciphers'' setting)
+  \item Dovecot 2.2.9 on Ubuntu 14.04 trusty
 \end{itemize*}
 
 \subsubsection{Settings}
 % Example: http://dovecot.org/list/dovecot/2013-October/092999.html
 
-\begin{lstlisting}
-ssl_cipher_list = '%*\cipherStringB*)'
-ssl_prefer_server_ciphers = yes
-\end{lstlisting}
+\configfile{10-ssl.conf}{48-55}{Dovecot SSL configuration}
 
 \subsubsection{Additional info}
 Dovecot 2.0, 2.1: Almost as good as dovecot 2.2. Dovecot does not ignore unknown configuration parameters. Does not support
@@ -96,48 +96,29 @@ openssl s_client -crlf -connect SERVER.TLD:993
 \end{itemize*}
 
 \subsubsection{Settings}
-\paragraphDiamond{imapd.conf}
+
 To activate SSL/TLS configure your certificate with
-\begin{lstlisting}
-tls_cert_file: .../cert.pem
-tls_key_file: .../cert.key
-\end{lstlisting}
+\configfile{imapd.conf}{206-206,209-209}{Activating TLS in cyrus}
 
 Do not forget to add necessary intermediate certificates to the .pem file.
 
 Limiting the ciphers provided may force (especially older) clients to connect without encryption at all! Sticking to the defaults is recommended.
 
 If you still want to force strong encryption use
-\begin{lstlisting}
-tls_cipher_list: %*\cipherStringB*)
-\end{lstlisting}
+\configfile{imapd.conf}{263-263}{TLS cipher selection in cyrus}
 
 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.
 
 To prevent unencrypted connections on the STARTTLS ports you can set
-\begin{lstlisting}
-allowplaintext: 0
-\end{lstlisting}
-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.
-
-\paragraphDiamond{cyrus.conf}
+\configfile{imapd.conf}{131-131}{Force encrypted connections in cyrus}
+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.
 
-To support POP3/IMAP on ports 110/143 with STARTTLS add
-\begin{lstlisting}
-imap         cmd="imapd" listen="imap" prefork=3
-pop3         cmd="pop3d" listen="pop3" prefork=1
-\end{lstlisting}
-to the SERVICES section.
-
-To support POP3S/IMAPS on ports 995/993 add
-\begin{lstlisting}
-imaps        cmd="imapd -s" listen="imaps" prefork=3
-pop3s        cmd="pop3d -s" listen="pop3s" prefork=1
-\end{lstlisting}
+To support POP3/IMAP on ports 110/143 with STARTTLS and POP3S/IMAPS on ports
+995/993 check the SERVICES section in \texttt{cyrus.conf}
+\configfile{cyrus.conf}{28-28,31-34,71-71}{STARTTLS for POP3/IMAP and POP3S/IMAPS in cyrus}
 
 
 \subsubsection{Limitations}
-
 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.
 
 Currently there is no way to prefer server ciphers or to disable compression.
@@ -162,22 +143,30 @@ openssl s_client -crlf -connect SERVER.TLD:993
 
 \subsubsection{Tested with Versions}
 \begin{itemize*}
-  \item Postfix 2.9.6, Debian Wheezy
+  \item Postfix 2.9.6, Debian Wheezy with OpenSSL 1.0.1e
+  \item Postfix 2.11.0 on Ubuntu 14.04.02 with OpenSSL 1.0.1f
 \end{itemize*}
 
 
 \subsubsection{Settings}
 
+Postfix has five internal lists of ciphers, and the possibility to switch
+between those with \emph{smtpd_tls_ciphers}. However, we leave this at its
+default value for server to server connections, as many mail servers only
+support outdated protocols and ciphers. We consider bad encryption still better
+than plain text transmission. For connections to MUAs, TLS is mandatory and the
+ciphersuite is modified.
+
 %% I (cm) consider the generation of own DH parameters to be voodoo until
 %% someone can explain the contrary. They are, after all, public, and
 %% I found no research that would show that long-term use of a
 %% parameter set would weaken the DH exchange. Also notice that IPSEC
 %% uses fixed parameter sets only.
-%& 
+%&
 %% also notice the following comment from  src/tls/tls_dh.c:
 %% * Compiled-in EDH primes (the compiled-in generator is always 2). These are
 %% * used when no parameters are explicitly loaded from a site-specific file.
-%% * 
+%% *
 %% * 512-bit parameters are used for export ciphers, and 1024-bit parameters are
 %% * used for non-export ciphers. An ~80-bit strong EDH key exchange is really
 %% * too weak to protect 128+ bit keys, but larger DH primes are
@@ -198,47 +187,29 @@ openssl s_client -crlf -connect SERVER.TLD:993
 %%   smtpd_tls_dh1024_param_file = /etc/postfix/dh_param_1024.pem
 %% \end{lstlisting}
 
-\paragraphDiamond{MX and SMTP client configuration}
-As discussed in section \ref{subsection:smtp_general}, because of opportunistic encryption we do not
-restrict the list of ciphers. There are still some steps needed to
-enable TLS, all in \verb|main.cf|:
+\paragraph{MX and SMTP client configuration:}
+As discussed in section \ref{subsection:smtp_general}, because of opportunistic
+encryption we do not restrict the list of ciphers or protocols for communication
+with other mail servers to avoid transmission in plain text. There are still
+some steps needed to enable TLS, all in \verb|main.cf|:
 
-\begin{lstlisting}
-smtpd_tls_cert_file = /etc/postfix/server.pem
-smtpd_tls_key_file = /etc/postfix/server.key
-# use 0 for Postfix >= 2.9, and 1 for earlier versions
-smtpd_tls_loglevel = 0
-# enable opportunistic TLS support in the SMTP server and client
-smtpd_tls_security_level = may
-smtp_tls_security_level = may
-# if you have authentication enabled, only offer it after STARTTLS
-smtpd_tls_auth_only = yes
-tls_ssl_options = NO_COMPRESSION
-\end{lstlisting}
+\configfile{main.cf}{22-33}{Opportunistic TLS in Postfix}
 
-\paragraphDiamond{MSA}
-For the MSA \verb|smtpd| process, we first define the ciphers that are
-acceptable for the ``mandatory'' security level, again in
-\verb|main.cf|:
+\paragraph{MSA:}
+For the MSA \verb|smtpd| process which communicates with mail clients, we first
+define the ciphers that are acceptable for the ``mandatory'' security level,
+again in \verb|main.cf|:
 
-\begin{lstlisting}
-smtpd_tls_mandatory_protocols = !SSLv2, !SSLv3
-smtpd_tls_mandatory_ciphers=high
-tls_high_cipherlist=%*\cipherStringB*)
-\end{lstlisting}
+\configfile{main.cf}{35-37}{MSA TLS configuration in Postfix}
 
 Then, we configure the MSA smtpd in \verb|master.cf| with two
 additional options that are only used for this instance of smtpd:
 
-\begin{lstlisting}
-587       inet  n       -       -       -       -       smtpd 
-        -o smtpd_tls_security_level=encrypt -o tls_preempt_cipherlist = yes
-\end{lstlisting}
+\configfile{master.cf}{12-14}{MSA smtpd service configuration in Postfix}
 
-For those users who want to use ECC key exchange, it is possible to specify this via:
-\begin{lstlisting}
-smtpd_tls_eecdh_grade = ultra
-\end{lstlisting}
+For those users who want to use EECDH key exchange, it is possible to customize this via:
+\configfile{main.cf}{38-38}{EECDH customization in Postfix}
+The default value since Postfix 2.8 is ``strong''.
 
 \subsubsection{Limitations}
 tls\_ssl\_options is supported from Postfix 2.11 onwards. You can
@@ -285,42 +256,36 @@ openssl s_client -starttls smtp -crlf -connect SERVER.TLD:25
 
 %% ----------------------------------------------------------------------
 
-\subsection{Exim (based on 4.82)}
+\subsection{Exim}
+
+\subsubsection{Tested with Versions}
+\begin{itemize*}
+  \item Exim 4.82, Debian Jessie
+  \item Exim 4.82, Ubuntu 14.04.2 with OpenSSL 1.0.1e
+\end{itemize*}
+
+
 It is highly recommended to read
 \url{http://exim.org/exim-html-current/doc/html/spec_html/ch-encrypted_smtp_connections_using_tlsssl.html}
 first.
 
-\paragraphDiamond{MSA mode (submission)}
+\paragraph{MSA mode (submission):}
 In the main config section of Exim add:
-
-\begin{lstlisting}
-tls_certificate = ..../cert.pem
-tls_privatekey = ..../cert.key
-\end{lstlisting}
-don't forget to add intermediate certificates to the .pem file if needed.
+\configfile{configure.msa}{153-154}{Certificate selection in Exim (MSA)}
+Don't forget to add intermediate certificates to the .pem file if needed.
 
 Tell Exim to advertise STARTTLS in the EHLO answer to everyone:
-\begin{lstlisting}
-tls_advertise_hosts = *
-\end{lstlisting}
+\configfile{configure.msa}{145-145}{TLS advertise in Exim (MSA)}
 
 If you want to support legacy SMTPS on port 465, and STARTTLS on smtp(25)/submission(587) ports set
-\begin{lstlisting}
-daemon_smtp_ports = smtp : smtps : submission
-tls_on_connect_ports = 465
-\end{lstlisting}
+\configfile{configure.msa}{165-166}{STARTTLS and SMTPS in Exim (MSA)}
 
 It is highly recommended to limit SMTP AUTH to SSL connections only. To do so add
-\begin{lstlisting}
-server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
-\end{lstlisting}
+\configfile{configure.msa}{813-813}{SSL-only authentication in Exim (MSA)}
 to every authenticator defined.
 
 Add the following rules on top of your acl\_smtp\_mail:
-\begin{lstlisting}
-warn    hosts           = *
-        control         = submission/sender_retain
-\end{lstlisting}
+\configfile{configure.msa}{111-111,501-505}{Submission mode in Exim (MSA)}
 This switches Exim to submission mode and allows addition of missing ``Message-ID'' and ``Date'' headers.
 
 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.
@@ -338,25 +303,16 @@ log_selector = <whatever your log_selector already contains> +tls_certificate_ve
 to get even more TLS information logged.
 
 
-\paragraphDiamond{server mode (incoming)}
-
+\paragraph{Server mode (incoming):}
 In the main config section of Exim add:
-
-\begin{lstlisting}
-tls_certificate = ..../cert.pem
-tls_privatekey = ..../cert.key
-\end{lstlisting}
+\configfile{configure.server}{152-153}{Certificate selection in Exim (Server)}
 don't forget to add intermediate certificates to the .pem file if needed.
 
 Tell Exim to advertise STARTTLS in the EHLO answer to everyone:
-\begin{lstlisting}
-tls_advertise_hosts = *
-\end{lstlisting}
+\configfile{configure.server}{144-144}{TLS advertise in Exim (Server)}
 
 Listen on smtp(25) port only
-\begin{lstlisting}
-daemon_smtp_ports = smtp
-\end{lstlisting}
+\configfile{configure.server}{166-166}{STARTTLS on SMTP in Exim (Server)}
 
 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.
 % Exim maintainers do not recommend to change default ciphers
@@ -367,10 +323,7 @@ It is not advisable to restrict the default cipher list for opportunistic encryp
 %\end{lstlisting}
 
 If you want to request and verify client certificates from sending hosts set
-\begin{lstlisting}
-tls_verify_certificates = /etc/pki/tls/certs/ca-bundle.crt
-tls_try_verify_hosts = *
-\end{lstlisting}
+\configfile{configure.server}{154-155}{TLS certificate verifiaction in Exim (Server)}
 
 tls\_try\_verify\_hosts only reports the result to your logfile. If you want to disconnect such clients you have to use
 \begin{lstlisting}
@@ -383,16 +336,13 @@ log_selector = <whatever your log_selector already contains> +tls_certificate_ve
 \end{lstlisting}
 to get even more TLS information logged.
 
-\paragraphDiamond{client mode (outgoing)}
+\paragraph{Client mode (outgoing):}
 Exim uses opportunistic encryption in the SMTP transport by default.
 
 Client mode settings have to be done in the configuration section of the smtp transport (driver = smtp).
 
 If you want to use a client certificate (most server certificates can be used as client certificate, too) set
-\begin{lstlisting}
-tls_certificate   = .../cert.pem
-tls_privatekey    = .../cert.key
-\end{lstlisting}
+\configfile{configure.client}{152-153}{Certificate selection in Exim (Client)}
 This is recommended for MTA-MTA traffic.
 
 %If you want to limit used ciphers set
@@ -402,7 +352,7 @@ This is recommended for MTA-MTA traffic.
 % Exim Maintainers do not recommend ciphers. We shouldn't do so, too.
 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.
 
-\paragraphDiamond{OpenSSL}
+\paragraph{OpenSSL:}
 Exim already disables SSLv2 by default. We recommend to add
 \begin{lstlisting}
 openssl_options = +all +no_sslv2 +no_compression +cipher_server_preference
@@ -415,22 +365,22 @@ You do not need to set dh\_parameters. Exim with OpenSSL by default uses paramet
 If you want to set your own DH parameters please read the TLS documentation of exim.
 
 
-\paragraphDiamond{GnuTLS}
+\paragraph{GnuTLS:}
 GnuTLS is different in only some respects to OpenSSL:
 \begin{itemize*}
   \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.
   \item There is no option like openssl\_options
 \end{itemize*}
 
-\paragraphDiamond{Exim string expansion}
+\paragraph{Exim string expansion:}
 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.
 
-\paragraphDiamond{Limitations}
+\paragraph{Limitations:}
 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.
 There already is a working patch to provide support:
 \url{http://bugs.exim.org/show_bug.cgi?id=1397}
 
-\paragraphDiamond{How to test}
+\subsubsection{How to test}
 \begin{lstlisting}
 openssl s_client -starttls smtp -crlf -connect SERVER.TLD:25
 \end{lstlisting}
@@ -440,4 +390,3 @@ openssl s_client -starttls smtp -crlf -connect SERVER.TLD:25
 %\subsection{Exchange}
 
 %\todo{FIXME: write this section}
-