git.sur5r.net Git - bacula/docs/blob - docs/manual/tls.tex

   1
   2 \section*{Bacula TLS}
   3 \label{_ChapterStart61}
   4 \index[general]{Bacula TLS}
   5 \index[general]{TLS}
   6 \addcontentsline{toc}{section}{Bacula TLS}
   7
   8 Bacula TLS (Transport Layer Security) is built-in network
   9 encryption code to provide secure network transport similar to
  10 that offered by {\bf stunnel} or {\bf ssh}. The Bacula code was
  11 written by Landon Fuller.
  12
  13 Supported features of this code include:
  14 \begin{itemize}
  15 \item Client/Server TLS Requirement Negotiation
  16 \item TLSv1 Connections with Server and Client Certificate
  17 Validation
  18 \item Forward Secrecy Support via Diffie-Hellman Ephemeral Keying
  19 \end{itemize}
  20
  21 This document will refer to both ``server'' and ``client'' contexts.  These
  22 terms refer to the accepting and initiating peer, respectively.
  23
  24 Diffie-Hellman anonymous ciphers are not supported by this code.  The
  25 use of DH anonymous ciphers increases the code complexity and places
  26 explicit trust upon the two-way CRAM-MD5 implementation.  CRAM-MD5 is
  27 subject to known plaintext attacks, and it should be considered
  28 considerably less secure than PKI certificate-based authentication.
  29
  30 Appropriate autoconf macros have been added to detect and use OpenSSL
  31 if enabled on the {\bf ./configure} line with {\bf \verb?--?enable-openssl}
  32
  33 \subsection*{TLS Configuration Directives}
  34 \addcontentsline{toc}{section}{TLS Configuration Directives}
  35 Additional configuration directives have been added to all the daemons
  36 (Director, File daemon, and Storage daemon) as well as the various
  37 different Console programs.
  38 These new directives are defined as follows:
  39
  40 \begin{description}
  41 \item [TLS Enable = \lt{}yes|no\gt{}]
  42 Enable TLS support.
  43
  44 \item [TLS Require = \lt{}yes|no\gt{}]
  45 Require TLS connections.
  46
  47 \item [TLS Certificate = \lt{}Directory\gt{}]
  48 Path to a PEM encoded TLS certificate.  It can be used as either a client
  49 or server certificate. PEM stands for Privacy Enhanced Mail, but in
  50 this context refers to how the certificates are encoded. It is used
  51 because PEM files are base64 encoded and hence ASCII text based
  52 rather than binary. They may also contain encrypted information.
  53
  54 \item [TLS Key = \lt{}Directory\gt{}]
  55 Path to a PEM encoded TLS private key.  It must correspond to the TLS
  56 certificate.
  57
  58 \item [TLS Verify Peer = \lt{}yes|no\gt{}]
  59 Verify peer certificate.  Instructs server to request and verify the
  60 client's x509 certificate.  Any client certificate signed by a known-CA
  61 will be accepted unless the TLS Allowed CN configuration directive is used,
  62 in which case the client certificate must correspond to the Allowed
  63 Common Name specified. This directive is valid only for a server
  64 and not in a client context.
  65
  66 \item [TLS Allowed CN = \lt{}string list\gt{}]
  67 Common name attribute of allowed peer certificates.  If this directive is
  68 specified, all client certificates will be verified against this list.
  69 This directive may be specified more than once. It is not valid in a client
  70 context.
  71
  72 \item [TLS CA Certificate File = \lt{}Filename\gt{}]
  73 The full path and filename specifying a
  74 PEM encoded TLS CA certificate(s).  Multiple certificates are
  75 permitted in the file.  One of \emph{TLS CA Certificate File} or \emph{TLS
  76 CA Certificate Dir} are required in a server context if \emph{TLS
  77 Verify Peer} (see above) is also specified, and are always required in a client
  78 context.
  79
  80 \item [TLS CA Certificate Dir = \lt{}Directory\gt{}]
  81 Full path to TLS CA certificate directory.  In the current implementation,
  82 certificates must be stored PEM encoded with OpenSSL-compatible hashes,
  83 which is the subject name's hash and an extension of {bf .0}.
  84 One of \emph{TLS CA Certificate File} or \emph{TLS CA Certificate Dir} are
  85 required in a server context if \emph{TLS Verify Peer} is also specified,
  86 and are always required in a client context.
  87
  88 \item [TLS DH File = \lt{}Directory\gt{}]
  89 Path to PEM encoded Diffie-Hellman parameter file.  If this directive is
  90 specified, DH key exchange will be used for the ephemeral keying, allowing
  91 for forward secrecy of communications.  DH key exchange adds an additional
  92 level of security because the key used for encryption/decryption by the
  93 server and the client is computed on each end and thus is never passed over
  94 the network if Diffie-Hellman key exchange is used.  Even if DH key
  95 exchange is not used, the encryption/decryption key is always passed
  96 encrypted.  This directive is only valid within a server context.
  97
  98 To generate the parameter file, you
  99 may use openssl:
 100
 101 \begin{verbatim}
 102    openssl dhparam -out dh1024.pem -5 1024
 103 \end{verbatim}
 104
 105 \end{description}
 106
 107 \subsection*{Creating a Self-signed Certificate}
 108 \index[general]{Creating a Self-signed Certificate }
 109 \index[general]{Certificate!Creating a Self-signed }
 110 \addcontentsline{toc}{subsection}{Creating a Self-signed Certificate}
 111
 112 You may create a self-signed certificate for use with the Bacula TLS that
 113 will permit you to make it function, but will not allow certificate
 114 validation.  The .pem file containing both the certificate and the key
 115 valid for 10 years can be made with the following:
 116
 117 \footnotesize
 118 \begin{verbatim}
 119    openssl req -new -x509 -nodes -out bacula.pem -keyout bacula.pem -days 3650
 120 \end{verbatim}
 121 \normalsize
 122
 123 The above script will ask you a number of questions. You may simply answer
 124 each of them by entering a return, or if you wish you may enter your own data.
 125
 126
 127 \subsection*{Getting a CA Signed Certificate}
 128 \index[general]{Certificate!Getting a CA Signed }
 129 \index[general]{Getting a CA Signed Certificate }
 130 \addcontentsline{toc}{subsection}{Getting a CA Signed Certificate}
 131
 132 The process of getting a certificate that is signed by a CA is quite a bit
 133 more complicated. You can purchase one from quite a number of PKI vendors, but
 134 that is not at all necessary for use with Bacula. To get a CA signed
 135 certificate, you will either need to find a friend that has setup his own CA
 136 or to become a CA yourself, and thus you can sign all your own certificates.
 137 The book OpenSSL by John Viega, Matt Mesier \& Pravir Chandra from O'Reilly
 138 explains how to do it, or you can read the documentation provided in the
 139 Open-source PKI Book project at Source Forge:
 140 \elink{
 141 http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}
 142 {http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}.
 143 Note, this link may change.