granicus.if.org Git - apache/blob - docs/manual/mod/mod_ssl.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_ssl - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_ssl</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_ssl.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Strong cryptography using the Secure Sockets
  27 Layer (SSL) and Transport Layer Security (TLS) protocols</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>ssl_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_ssl.c</td></tr></table>
  31 <h3>Summary</h3>
  32
  33 <p>This module provides SSL v2/v3 and TLS v1 support for the Apache
  34 HTTP Server.  It was contributed by Ralf S. Engeschall based on his
  35 mod_ssl project and originally derived from work by Ben Laurie.</p>
  36
  37 <p>This module relies on <a href="http://www.openssl.org/">OpenSSL</a>
  38 to provide the cryptography engine.</p>
  39
  40 <p>Further details, discussion, and examples are provided in the
  41 <a href="../ssl/">SSL documentation</a>.</p>
  42 </div>
  43 <div id="quickview"><h3 class="directives">Directives</h3>
  44 <ul id="toc">
  45 <li><img alt="" src="../images/down.gif" /> <a href="#sslcacertificatefile">SSLCACertificateFile</a></li>
  46 <li><img alt="" src="../images/down.gif" /> <a href="#sslcacertificatepath">SSLCACertificatePath</a></li>
  47 <li><img alt="" src="../images/down.gif" /> <a href="#sslcadnrequestfile">SSLCADNRequestFile</a></li>
  48 <li><img alt="" src="../images/down.gif" /> <a href="#sslcadnrequestpath">SSLCADNRequestPath</a></li>
  49 <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationfile">SSLCARevocationFile</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationpath">SSLCARevocationPath</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatechainfile">SSLCertificateChainFile</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatefile">SSLCertificateFile</a></li>
  53 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></li>
  54 <li><img alt="" src="../images/down.gif" /> <a href="#sslciphersuite">SSLCipherSuite</a></li>
  55 <li><img alt="" src="../images/down.gif" /> <a href="#sslcryptodevice">SSLCryptoDevice</a></li>
  56 <li><img alt="" src="../images/down.gif" /> <a href="#sslengine">SSLEngine</a></li>
  57 <li><img alt="" src="../images/down.gif" /> <a href="#sslhonorcipherorder">SSLHonorCipherOrder</a></li>
  58 <li><img alt="" src="../images/down.gif" /> <a href="#sslmutex">SSLMutex</a></li>
  59 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspdefaultresponder">SSLOCSPDefaultResponder</a></li>
  60 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspenable">SSLOCSPEnable</a></li>
  61 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></li>
  62 <li><img alt="" src="../images/down.gif" /> <a href="#ssloptions">SSLOptions</a></li>
  63 <li><img alt="" src="../images/down.gif" /> <a href="#sslpassphrasedialog">SSLPassPhraseDialog</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#sslprotocol">SSLProtocol</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycacertificatefile">SSLProxyCACertificateFile</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationfile">SSLProxyCARevocationFile</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycheckpeercn">SSLProxyCheckPeerCN</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycheckpeerexpire">SSLProxyCheckPeerExpire</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyciphersuite">SSLProxyCipherSuite</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyengine">SSLProxyEngine</a></li>
  73 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatefile">SSLProxyMachineCertificateFile</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatepath">SSLProxyMachineCertificatePath</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyprotocol">SSLProxyProtocol</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyverify">SSLProxyVerify</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyverifydepth">SSLProxyVerifyDepth</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#sslrandomseed">SSLRandomSeed</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#sslrenegbuffersize">SSLRenegBufferSize</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#sslrequire">SSLRequire</a></li>
  81 <li><img alt="" src="../images/down.gif" /> <a href="#sslrequiressl">SSLRequireSSL</a></li>
  82 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessioncache">SSLSessionCache</a></li>
  83 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessioncachetimeout">SSLSessionCacheTimeout</a></li>
  84 <li><img alt="" src="../images/down.gif" /> <a href="#sslusername">SSLUserName</a></li>
  85 <li><img alt="" src="../images/down.gif" /> <a href="#sslverifyclient">SSLVerifyClient</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#sslverifydepth">SSLVerifyDepth</a></li>
  87 </ul>
  88 <h3>Topics</h3>
  89 <ul id="topics">
  90 <li><img alt="" src="../images/down.gif" /> <a href="#envvars">Environment Variables</a></li>
  91 <li><img alt="" src="../images/down.gif" /> <a href="#logformats">Custom Log Formats</a></li>
  92 </ul></div>
  93 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  94 <div class="section">
  95 <h2><a name="envvars" id="envvars">Environment Variables</a></h2>
  96
  97 <p>This module provides a lot of SSL information as additional environment
  98 variables to the SSI and CGI namespace. The generated variables are listed in
  99 the table below. For backward compatibility the information can
 100 be made available under different names, too. Look in the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter for details on the
 101 compatibility variables.</p>
 102
 103 <table class="bordered">
 104
 105 <tr>
 106  <th><a name="table3">Variable Name:</a></th>
 107  <th>Value Type:</th>
 108  <th>Description:</th>
 109 </tr>
 110 <tr><td><code>HTTPS</code></td>                         <td>flag</td>      <td>HTTPS is being used.</td></tr>
 111 <tr><td><code>SSL_PROTOCOL</code></td>                  <td>string</td>    <td>The SSL protocol version (SSLv2, SSLv3, TLSv1)</td></tr>
 112 <tr><td><code>SSL_SESSION_ID</code></td>                <td>string</td>    <td>The hex-encoded SSL session id</td></tr>
 113 <tr><td><code>SSL_CIPHER</code></td>                    <td>string</td>    <td>The cipher specification name</td></tr>
 114 <tr><td><code>SSL_CIPHER_EXPORT</code></td>             <td>string</td>    <td><code>true</code> if cipher is an export cipher</td></tr>
 115 <tr><td><code>SSL_CIPHER_USEKEYSIZE</code></td>         <td>number</td>    <td>Number of cipher bits (actually used)</td></tr>
 116 <tr><td><code>SSL_CIPHER_ALGKEYSIZE</code></td>         <td>number</td>    <td>Number of cipher bits (possible)</td></tr>
 117 <tr><td><code>SSL_COMPRESS_METHOD</code></td>           <td>string</td>    <td>SSL compression method negotiated</td></tr>
 118 <tr><td><code>SSL_VERSION_INTERFACE</code></td>         <td>string</td>    <td>The mod_ssl program version</td></tr>
 119 <tr><td><code>SSL_VERSION_LIBRARY</code></td>           <td>string</td>    <td>The OpenSSL program version</td></tr>
 120 <tr><td><code>SSL_CLIENT_M_VERSION</code></td>          <td>string</td>    <td>The version of the client certificate</td></tr>
 121 <tr><td><code>SSL_CLIENT_M_SERIAL</code></td>           <td>string</td>    <td>The serial of the client certificate</td></tr>
 122 <tr><td><code>SSL_CLIENT_S_DN</code></td>               <td>string</td>    <td>Subject DN in client's certificate</td></tr>
 123 <tr><td><code>SSL_CLIENT_S_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of client's Subject DN</td></tr>
 124 <tr><td><code>SSL_CLIENT_I_DN</code></td>               <td>string</td>    <td>Issuer DN of client's certificate</td></tr>
 125 <tr><td><code>SSL_CLIENT_I_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of client's Issuer DN</td></tr>
 126 <tr><td><code>SSL_CLIENT_V_START</code></td>            <td>string</td>    <td>Validity of client's certificate (start time)</td></tr>
 127 <tr><td><code>SSL_CLIENT_V_END</code></td>              <td>string</td>    <td>Validity of client's certificate (end time)</td></tr>
 128 <tr><td><code>SSL_CLIENT_V_REMAIN</code></td>           <td>string</td>    <td>Number of days until client's certificate expires</td></tr>
 129 <tr><td><code>SSL_CLIENT_A_SIG</code></td>              <td>string</td>    <td>Algorithm used for the signature of client's certificate</td></tr>
 130 <tr><td><code>SSL_CLIENT_A_KEY</code></td>              <td>string</td>    <td>Algorithm used for the public key of client's certificate</td></tr>
 131 <tr><td><code>SSL_CLIENT_CERT</code></td>               <td>string</td>    <td>PEM-encoded client certificate</td></tr>
 132 <tr><td><code>SSL_CLIENT_CERT_CHAIN_</code><em>n</em></td> <td>string</td>    <td>PEM-encoded certificates in client certificate chain</td></tr>
 133 <tr><td><code>SSL_CLIENT_VERIFY</code></td>             <td>string</td>    <td><code>NONE</code>, <code>SUCCESS</code>, <code>GENEROUS</code> or <code>FAILED:</code><em>reason</em></td></tr>
 134 <tr><td><code>SSL_SERVER_M_VERSION</code></td>          <td>string</td>    <td>The version of the server certificate</td></tr>
 135 <tr><td><code>SSL_SERVER_M_SERIAL</code></td>           <td>string</td>    <td>The serial of the server certificate</td></tr>
 136 <tr><td><code>SSL_SERVER_S_DN</code></td>               <td>string</td>    <td>Subject DN in server's certificate</td></tr>
 137 <tr><td><code>SSL_SERVER_S_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of server's Subject DN</td></tr>
 138 <tr><td><code>SSL_SERVER_I_DN</code></td>               <td>string</td>    <td>Issuer DN of server's certificate</td></tr>
 139 <tr><td><code>SSL_SERVER_I_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of server's Issuer DN</td></tr>
 140 <tr><td><code>SSL_SERVER_V_START</code></td>            <td>string</td>    <td>Validity of server's certificate (start time)</td></tr>
 141 <tr><td><code>SSL_SERVER_V_END</code></td>              <td>string</td>    <td>Validity of server's certificate (end time)</td></tr>
 142 <tr><td><code>SSL_SERVER_A_SIG</code></td>              <td>string</td>    <td>Algorithm used for the signature of server's certificate</td></tr>
 143 <tr><td><code>SSL_SERVER_A_KEY</code></td>              <td>string</td>    <td>Algorithm used for the public key of server's certificate</td></tr>
 144 <tr><td><code>SSL_SERVER_CERT</code></td>               <td>string</td>    <td>PEM-encoded server certificate</td></tr>
 145 </table>
 146
 147 <p><em>x509</em> specifies a component of an X.509 DN; one of
 148 <code>C,ST,L,O,OU,CN,T,I,G,S,D,UID,Email</code>.  In Apache 2.1 and
 149 later, <em>x509</em> may also include a numeric <code>_n</code>
 150 suffix.  If the DN in question contains multiple attributes of the
 151 same name, this suffix is used as an index to select a particular
 152 attribute.  For example, where the server certificate subject DN
 153 included two OU fields, <code>SSL_SERVER_S_DN_OU_0</code> and
 154 <code>SSL_SERVER_S_DN_OU_1</code> could be used to reference each.</p>
 155
 156 <p><code>SSL_CLIENT_V_REMAIN</code> is only available in version 2.1
 157 and later.</p>
 158
 159 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 160 <div class="section">
 161 <h2><a name="logformats" id="logformats">Custom Log Formats</a></h2>
 162
 163 <p>When <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is built into Apache or at least
 164 loaded (under DSO situation) additional functions exist for the <a href="mod_log_config.html#formats">Custom Log Format</a> of
 165 <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code>. First there is an
 166 additional ``<code>%{</code><em>varname</em><code>}x</code>''
 167 eXtension format function which can be used to expand any variables
 168 provided by any module, especially those provided by mod_ssl which can
 169 you find in the above table.</p>
 170 <p>
 171 For backward compatibility there is additionally a special
 172 ``<code>%{</code><em>name</em><code>}c</code>'' cryptography format function
 173 provided. Information about this function is provided in the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter.</p>
 174 <div class="example"><h3>Example</h3><p><code>
 175 CustomLog logs/ssl_request_log \
 176           "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
 177 </code></p></div>
 178 </div>
 179 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 180 <div class="directive-section"><h2><a name="SSLCACertificateFile" id="SSLCACertificateFile">SSLCACertificateFile</a> <a name="sslcacertificatefile" id="sslcacertificatefile">Directive</a></h2>
 181 <table class="directive">
 182 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
 183 for Client Auth</td></tr>
 184 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCACertificateFile <em>file-path</em></code></td></tr>
 185 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 186 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 187 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 188 </table>
 189 <p>
 190 This directive sets the <em>all-in-one</em> file where you can assemble the
 191 Certificates of Certification Authorities (CA) whose <em>clients</em> you deal
 192 with. These are used for Client Authentication. Such a file is simply the
 193 concatenation of the various PEM-encoded Certificate files, in order of
 194 preference. This can be used alternatively and/or additionally to
 195 <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code>.</p>
 196 <div class="example"><h3>Example</h3><p><code>
 197 SSLCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-client.crt
 198 </code></p></div>
 199
 200 </div>
 201 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 202 <div class="directive-section"><h2><a name="SSLCACertificatePath" id="SSLCACertificatePath">SSLCACertificatePath</a> <a name="sslcacertificatepath" id="sslcacertificatepath">Directive</a></h2>
 203 <table class="directive">
 204 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
 205 Client Auth</td></tr>
 206 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCACertificatePath <em>directory-path</em></code></td></tr>
 207 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 208 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 209 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 210 </table>
 211 <p>
 212 This directive sets the directory where you keep the Certificates of
 213 Certification Authorities (CAs) whose clients you deal with. These are used to
 214 verify the client certificate on Client Authentication.</p>
 215 <p>
 216 The files in this directory have to be PEM-encoded and are accessed through
 217 hash filenames. So usually you can't just place the Certificate files
 218 there: you also have to create symbolic links named
 219 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
 220 contains the appropriate symbolic links. Use the <code>Makefile</code> which
 221 comes with mod_ssl to accomplish this task.</p>
 222 <div class="example"><h3>Example</h3><p><code>
 223 SSLCACertificatePath /usr/local/apache2/conf/ssl.crt/
 224 </code></p></div>
 225
 226 </div>
 227 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 228 <div class="directive-section"><h2><a name="SSLCADNRequestFile" id="SSLCADNRequestFile">SSLCADNRequestFile</a> <a name="sslcadnrequestfile" id="sslcadnrequestfile">Directive</a></h2>
 229 <table class="directive">
 230 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
 231 for defining acceptable CA names</td></tr>
 232 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCADNRequestFile <em>file-path</em></code></td></tr>
 233 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 234 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 235 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 236 </table>
 237 <p>When a client certificate is requested by mod_ssl, a list of
 238 <em>acceptable Certificate Authority names</em> is sent to the client
 239 in the SSL handshake.  These CA names can be used by the client to
 240 select an appropriate client certificate out of those it has
 241 available.</p>
 242
 243 <p>If neither of the directives <code class="directive"><a href="#sslcadnrequestpath">SSLCADNRequestPath</a></code> or <code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> are given, then the
 244 set of acceptable CA names sent to the client is the names of all the
 245 CA certificates given by the <code class="directive"><a href="#sslcacertificatefile">SSLCACertificateFile</a></code> and <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> directives; in other
 246 words, the names of the CAs which will actually be used to verify the
 247 client certificate.</p>
 248
 249 <p>In some circumstances, it is useful to be able to send a set of
 250 acceptable CA names which differs from the actual CAs used to verify
 251 the client certificate - for example, if the client certificates are
 252 signed by intermediate CAs.  In such cases, <code class="directive"><a href="#sslcadnrequestpath">SSLCADNRequestPath</a></code> and/or <code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> can be used; the
 253 acceptable CA names are then taken from the complete set of
 254 certificates in the directory and/or file specified by this pair of
 255 directives.</p>
 256
 257 <p><code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> must
 258 specify an <em>all-in-one</em> file containing a concatenation of
 259 PEM-encoded CA certificates.</p>
 260
 261 <div class="example"><h3>Example</h3><p><code>
 262 SSLCADNRequestFile /usr/local/apache2/conf/ca-names.crt
 263 </code></p></div>
 264
 265 </div>
 266 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 267 <div class="directive-section"><h2><a name="SSLCADNRequestPath" id="SSLCADNRequestPath">SSLCADNRequestPath</a> <a name="sslcadnrequestpath" id="sslcadnrequestpath">Directive</a></h2>
 268 <table class="directive">
 269 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
 270 defining acceptable CA names</td></tr>
 271 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCADNRequestPath <em>directory-path</em></code></td></tr>
 272 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 273 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 274 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 275 </table>
 276
 277 <p>This optional directive can be used to specify the set of
 278 <em>acceptable CA names</em> which will be sent to the client when a
 279 client certificate is requested.  See the <code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> directive for more
 280 details.</p>
 281
 282 <p>The files in this directory have to be PEM-encoded and are accessed
 283 through hash filenames. So usually you can't just place the
 284 Certificate files there: you also have to create symbolic links named
 285 <em>hash-value</em><code>.N</code>. And you should always make sure
 286 this directory contains the appropriate symbolic links. Use the
 287 <code>Makefile</code> which comes with mod_ssl to accomplish this
 288 task.</p>
 289 <div class="example"><h3>Example</h3><p><code>
 290 SSLCADNRequestPath /usr/local/apache2/conf/ca-names.crt/
 291 </code></p></div>
 292
 293 </div>
 294 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 295 <div class="directive-section"><h2><a name="SSLCARevocationFile" id="SSLCARevocationFile">SSLCARevocationFile</a> <a name="sslcarevocationfile" id="sslcarevocationfile">Directive</a></h2>
 296 <table class="directive">
 297 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA CRLs for
 298 Client Auth</td></tr>
 299 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationFile <em>file-path</em></code></td></tr>
 300 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 301 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 302 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 303 </table>
 304 <p>
 305 This directive sets the <em>all-in-one</em> file where you can
 306 assemble the Certificate Revocation Lists (CRL) of Certification
 307 Authorities (CA) whose <em>clients</em> you deal with. These are used
 308 for Client Authentication.  Such a file is simply the concatenation of
 309 the various PEM-encoded CRL files, in order of preference. This can be
 310 used alternatively and/or additionally to <code class="directive"><a href="#sslcarevocationpath">SSLCARevocationPath</a></code>.</p>
 311 <div class="example"><h3>Example</h3><p><code>
 312 SSLCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-client.crl
 313 </code></p></div>
 314
 315 </div>
 316 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 317 <div class="directive-section"><h2><a name="SSLCARevocationPath" id="SSLCARevocationPath">SSLCARevocationPath</a> <a name="sslcarevocationpath" id="sslcarevocationpath">Directive</a></h2>
 318 <table class="directive">
 319 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA CRLs for
 320 Client Auth</td></tr>
 321 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationPath <em>directory-path</em></code></td></tr>
 322 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 323 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 324 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 325 </table>
 326 <p>
 327 This directive sets the directory where you keep the Certificate Revocation
 328 Lists (CRL) of Certification Authorities (CAs) whose clients you deal with.
 329 These are used to revoke the client certificate on Client Authentication.</p>
 330 <p>
 331 The files in this directory have to be PEM-encoded and are accessed through
 332 hash filenames. So usually you have not only to place the CRL files there.
 333 Additionally you have to create symbolic links named
 334 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
 335 contains the appropriate symbolic links. Use the <code>Makefile</code> which
 336 comes with <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> to accomplish this task.</p>
 337 <div class="example"><h3>Example</h3><p><code>
 338 SSLCARevocationPath /usr/local/apache2/conf/ssl.crl/
 339 </code></p></div>
 340
 341 </div>
 342 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 343 <div class="directive-section"><h2><a name="SSLCertificateChainFile" id="SSLCertificateChainFile">SSLCertificateChainFile</a> <a name="sslcertificatechainfile" id="sslcertificatechainfile">Directive</a></h2>
 344 <table class="directive">
 345 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of PEM-encoded Server CA Certificates</td></tr>
 346 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateChainFile <em>file-path</em></code></td></tr>
 347 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 348 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 349 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 350 </table>
 351 <p>
 352 This directive sets the optional <em>all-in-one</em> file where you can
 353 assemble the certificates of Certification Authorities (CA) which form the
 354 certificate chain of the server certificate. This starts with the issuing CA
 355 certificate of of the server certificate and can range up to the root CA
 356 certificate. Such a file is simply the concatenation of the various
 357 PEM-encoded CA Certificate files, usually in certificate chain order.</p>
 358 <p>
 359 This should be used alternatively and/or additionally to <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> for explicitly
 360 constructing the server certificate chain which is sent to the browser
 361 in addition to the server certificate. It is especially useful to
 362 avoid conflicts with CA certificates when using client
 363 authentication. Because although placing a CA certificate of the
 364 server certificate chain into <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> has the same effect
 365 for the certificate chain construction, it has the side-effect that
 366 client certificates issued by this same CA certificate are also
 367 accepted on client authentication.</p>
 368 <p>
 369 But be careful: Providing the certificate chain works only if you are using a
 370 <em>single</em> RSA <em>or</em> DSA based server certificate. If you are
 371 using a coupled RSA+DSA certificate pair, this will work only if actually both
 372 certificates use the <em>same</em> certificate chain. Else the browsers will be
 373 confused in this situation.</p>
 374 <div class="example"><h3>Example</h3><p><code>
 375 SSLCertificateChainFile /usr/local/apache2/conf/ssl.crt/ca.crt
 376 </code></p></div>
 377
 378 </div>
 379 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 380 <div class="directive-section"><h2><a name="SSLCertificateFile" id="SSLCertificateFile">SSLCertificateFile</a> <a name="sslcertificatefile" id="sslcertificatefile">Directive</a></h2>
 381 <table class="directive">
 382 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Server PEM-encoded X.509 Certificate file</td></tr>
 383 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateFile <em>file-path</em></code></td></tr>
 384 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 385 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 386 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 387 </table>
 388 <p>
 389 This directive points to the PEM-encoded Certificate file for the server and
 390 optionally also to the corresponding RSA or DSA Private Key file for it
 391 (contained in the same file). If the contained Private Key is encrypted the
 392 Pass Phrase dialog is forced at startup time. This directive can be used up to
 393 two times (referencing different filenames) when both a RSA and a DSA based
 394 server certificate is used in parallel.</p>
 395 <div class="example"><h3>Example</h3><p><code>
 396 SSLCertificateFile /usr/local/apache2/conf/ssl.crt/server.crt
 397 </code></p></div>
 398
 399 </div>
 400 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 401 <div class="directive-section"><h2><a name="SSLCertificateKeyFile" id="SSLCertificateKeyFile">SSLCertificateKeyFile</a> <a name="sslcertificatekeyfile" id="sslcertificatekeyfile">Directive</a></h2>
 402 <table class="directive">
 403 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Server PEM-encoded Private Key file</td></tr>
 404 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateKeyFile <em>file-path</em></code></td></tr>
 405 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 406 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 407 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 408 </table>
 409 <p>
 410 This directive points to the PEM-encoded Private Key file for the
 411 server. If the Private Key is not combined with the Certificate in the
 412 <code class="directive">SSLCertificateFile</code>, use this additional directive to
 413 point to the file with the stand-alone Private Key. When
 414 <code class="directive">SSLCertificateFile</code> is used and the file
 415 contains both the Certificate and the Private Key this directive need
 416 not be used. But we strongly discourage this practice.  Instead we
 417 recommend you to separate the Certificate and the Private Key. If the
 418 contained Private Key is encrypted, the Pass Phrase dialog is forced
 419 at startup time. This directive can be used up to two times
 420 (referencing different filenames) when both a RSA and a DSA based
 421 private key is used in parallel.</p>
 422 <div class="example"><h3>Example</h3><p><code>
 423 SSLCertificateKeyFile /usr/local/apache2/conf/ssl.key/server.key
 424 </code></p></div>
 425
 426 </div>
 427 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 428 <div class="directive-section"><h2><a name="SSLCipherSuite" id="SSLCipherSuite">SSLCipherSuite</a> <a name="sslciphersuite" id="sslciphersuite">Directive</a></h2>
 429 <table class="directive">
 430 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cipher Suite available for negotiation in SSL
 431 handshake</td></tr>
 432 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCipherSuite <em>cipher-spec</em></code></td></tr>
 433 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</code></td></tr>
 434 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 435 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 436 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 437 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 438 </table>
 439 <p>
 440 This complex directive uses a colon-separated <em>cipher-spec</em> string
 441 consisting of OpenSSL cipher specifications to configure the Cipher Suite the
 442 client is permitted to negotiate in the SSL handshake phase. Notice that this
 443 directive can be used both in per-server and per-directory context. In
 444 per-server context it applies to the standard SSL handshake when a connection
 445 is established. In per-directory context it forces a SSL renegotation with the
 446 reconfigured Cipher Suite after the HTTP request was read but before the HTTP
 447 response is sent.</p>
 448 <p>
 449 An SSL cipher specification in <em>cipher-spec</em> is composed of 4 major
 450 attributes plus a few extra minor ones:</p>
 451 <ul>
 452 <li><em>Key Exchange Algorithm</em>:<br />
 453     RSA or Diffie-Hellman variants.
 454 </li>
 455 <li><em>Authentication Algorithm</em>:<br />
 456     RSA, Diffie-Hellman, DSS or none.
 457 </li>
 458 <li><em>Cipher/Encryption Algorithm</em>:<br />
 459     DES, Triple-DES, RC4, RC2, IDEA or none.
 460 </li>
 461 <li><em>MAC Digest Algorithm</em>:<br />
 462     MD5, SHA or SHA1.
 463 </li>
 464 </ul>
 465 <p>An SSL cipher can also be an export cipher and is either a SSLv2 or SSLv3/TLSv1
 466 cipher (here TLSv1 is equivalent to SSLv3). To specify which ciphers to use,
 467 one can either specify all the Ciphers, one at a time, or use aliases to
 468 specify the preference and order for the ciphers (see <a href="#table1">Table
 469 1</a>).</p>
 470
 471 <table class="bordered">
 472
 473 <tr><th><a name="table1">Tag</a></th> <th>Description</th></tr>
 474 <tr><td colspan="2"><em>Key Exchange Algorithm:</em></td></tr>
 475 <tr><td><code>kRSA</code></td>   <td>RSA key exchange</td></tr>
 476 <tr><td><code>kDHr</code></td>   <td>Diffie-Hellman key exchange with RSA key</td></tr>
 477 <tr><td><code>kDHd</code></td>   <td>Diffie-Hellman key exchange with DSA key</td></tr>
 478 <tr><td><code>kEDH</code></td>   <td>Ephemeral (temp.key) Diffie-Hellman key exchange (no cert)</td>   </tr>
 479 <tr><td colspan="2"><em>Authentication Algorithm:</em></td></tr>
 480 <tr><td><code>aNULL</code></td>  <td>No authentication</td></tr>
 481 <tr><td><code>aRSA</code></td>   <td>RSA authentication</td></tr>
 482 <tr><td><code>aDSS</code></td>   <td>DSS authentication</td> </tr>
 483 <tr><td><code>aDH</code></td>    <td>Diffie-Hellman authentication</td></tr>
 484 <tr><td colspan="2"><em>Cipher Encoding Algorithm:</em></td></tr>
 485 <tr><td><code>eNULL</code></td>  <td>No encoding</td>         </tr>
 486 <tr><td><code>DES</code></td>    <td>DES encoding</td>        </tr>
 487 <tr><td><code>3DES</code></td>   <td>Triple-DES encoding</td> </tr>
 488 <tr><td><code>RC4</code></td>    <td>RC4 encoding</td>       </tr>
 489 <tr><td><code>RC2</code></td>    <td>RC2 encoding</td>       </tr>
 490 <tr><td><code>IDEA</code></td>   <td>IDEA encoding</td>       </tr>
 491 <tr><td colspan="2"><em>MAC Digest Algorithm</em>:</td></tr>
 492 <tr><td><code>MD5</code></td>    <td>MD5 hash function</td></tr>
 493 <tr><td><code>SHA1</code></td>   <td>SHA1 hash function</td></tr>
 494 <tr><td><code>SHA</code></td>    <td>SHA hash function</td> </tr>
 495 <tr><td colspan="2"><em>Aliases:</em></td></tr>
 496 <tr><td><code>SSLv2</code></td>  <td>all SSL version 2.0 ciphers</td></tr>
 497 <tr><td><code>SSLv3</code></td>  <td>all SSL version 3.0 ciphers</td> </tr>
 498 <tr><td><code>TLSv1</code></td>  <td>all TLS version 1.0 ciphers</td> </tr>
 499 <tr><td><code>EXP</code></td>    <td>all export ciphers</td>  </tr>
 500 <tr><td><code>EXPORT40</code></td> <td>all 40-bit export ciphers only</td>  </tr>
 501 <tr><td><code>EXPORT56</code></td> <td>all 56-bit export ciphers only</td>  </tr>
 502 <tr><td><code>LOW</code></td>    <td>all low strength ciphers (no export, single DES)</td></tr>
 503 <tr><td><code>MEDIUM</code></td> <td>all ciphers with 128 bit encryption</td> </tr>
 504 <tr><td><code>HIGH</code></td>   <td>all ciphers using Triple-DES</td>     </tr>
 505 <tr><td><code>RSA</code></td>    <td>all ciphers using RSA key exchange</td> </tr>
 506 <tr><td><code>DH</code></td>     <td>all ciphers using Diffie-Hellman key exchange</td> </tr>
 507 <tr><td><code>EDH</code></td>    <td>all ciphers using Ephemeral Diffie-Hellman key exchange</td> </tr>
 508 <tr><td><code>ADH</code></td>    <td>all ciphers using Anonymous Diffie-Hellman key exchange</td> </tr>
 509 <tr><td><code>DSS</code></td>    <td>all ciphers using DSS authentication</td> </tr>
 510 <tr><td><code>NULL</code></td>   <td>all ciphers using no encryption</td> </tr>
 511 </table>
 512 <p>
 513 Now where this becomes interesting is that these can be put together
 514 to specify the order and ciphers you wish to use. To speed this up
 515 there are also aliases (<code>SSLv2, SSLv3, TLSv1, EXP, LOW, MEDIUM,
 516 HIGH</code>) for certain groups of ciphers. These tags can be joined
 517 together with prefixes to form the <em>cipher-spec</em>. Available
 518 prefixes are:</p>
 519 <ul>
 520 <li>none: add cipher to list</li>
 521 <li><code>+</code>: add ciphers to list and pull them to current location in list</li>
 522 <li><code>-</code>: remove cipher from list (can be added later again)</li>
 523 <li><code>!</code>: kill cipher from list completely (can <strong>not</strong> be added later again)</li>
 524 </ul>
 525 <p>A simpler way to look at all of this is to use the ``<code>openssl ciphers
 526 -v</code>'' command which provides a nice way to successively create the
 527 correct <em>cipher-spec</em> string. The default <em>cipher-spec</em> string
 528 is ``<code>ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</code>'' which
 529 means the following: first, remove from consideration any ciphers that do not
 530 authenticate, i.e. for SSL only the Anonymous Diffie-Hellman ciphers. Next,
 531 use ciphers using RC4 and RSA. Next include the high, medium and then the low
 532 security ciphers. Finally <em>pull</em> all SSLv2 and export ciphers to the
 533 end of the list.</p>
 534 <div class="example"><pre>
 535 $ openssl ciphers -v 'ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP'
 536 NULL-SHA                SSLv3 Kx=RSA      Au=RSA  Enc=None      Mac=SHA1
 537 NULL-MD5                SSLv3 Kx=RSA      Au=RSA  Enc=None      Mac=MD5
 538 EDH-RSA-DES-CBC3-SHA    SSLv3 Kx=DH       Au=RSA  Enc=3DES(168) Mac=SHA1
 539 ...                     ...               ...     ...           ...
 540 EXP-RC4-MD5             SSLv3 Kx=RSA(512) Au=RSA  Enc=RC4(40)   Mac=MD5  export
 541 EXP-RC2-CBC-MD5         SSLv2 Kx=RSA(512) Au=RSA  Enc=RC2(40)   Mac=MD5  export
 542 EXP-RC4-MD5             SSLv2 Kx=RSA(512) Au=RSA  Enc=RC4(40)   Mac=MD5  export
 543 </pre></div>
 544 <p>The complete list of particular RSA &amp; DH ciphers for SSL is given in <a href="#table2">Table 2</a>.</p>
 545 <div class="example"><h3>Example</h3><p><code>
 546 SSLCipherSuite RSA:!EXP:!NULL:+HIGH:+MEDIUM:-LOW
 547 </code></p></div>
 548 <table class="bordered">
 549
 550 <tr><th><a name="table2">Cipher-Tag</a></th> <th>Protocol</th> <th>Key Ex.</th> <th>Auth.</th> <th>Enc.</th> <th>MAC</th> <th>Type</th> </tr>
 551 <tr><td colspan="7"><em>RSA Ciphers:</em></td></tr>
 552 <tr><td><code>DES-CBC3-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>3DES(168)</td> <td>SHA1</td> <td /> </tr>
 553 <tr><td><code>DES-CBC3-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>3DES(168)</td> <td>MD5</td> <td /> </tr>
 554 <tr><td><code>IDEA-CBC-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>IDEA(128)</td> <td>SHA1</td> <td /> </tr>
 555 <tr><td><code>RC4-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>RC4(128)</td> <td>SHA1</td> <td /> </tr>
 556 <tr><td><code>RC4-MD5</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>RC4(128)</td> <td>MD5</td> <td /> </tr>
 557 <tr><td><code>IDEA-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>IDEA(128)</td> <td>MD5</td> <td /> </tr>
 558 <tr><td><code>RC2-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC2(128)</td> <td>MD5</td> <td /> </tr>
 559 <tr><td><code>RC4-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC4(128)</td> <td>MD5</td> <td /> </tr>
 560 <tr><td><code>DES-CBC-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>DES(56)</td> <td>SHA1</td> <td /> </tr>
 561 <tr><td><code>RC4-64-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC4(64)</td> <td>MD5</td> <td /> </tr>
 562 <tr><td><code>DES-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>DES(56)</td> <td>MD5</td> <td /> </tr>
 563 <tr><td><code>EXP-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>RSA(512)</td> <td>RSA</td> <td>DES(40)</td> <td>SHA1</td> <td> export</td> </tr>
 564 <tr><td><code>EXP-RC2-CBC-MD5</code></td> <td>SSLv3</td> <td>RSA(512)</td> <td>RSA</td> <td>RC2(40)</td> <td>MD5</td> <td>  export</td> </tr>
 565 <tr><td><code>EXP-RC4-MD5</code></td> <td>SSLv3</td> <td>RSA(512)</td> <td>RSA</td> <td>RC4(40)</td> <td>MD5</td> <td>  export</td> </tr>
 566 <tr><td><code>EXP-RC2-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA(512)</td> <td>RSA</td> <td>RC2(40)</td> <td>MD5</td> <td>  export</td> </tr>
 567 <tr><td><code>EXP-RC4-MD5</code></td> <td>SSLv2</td> <td>RSA(512)</td> <td>RSA</td> <td>RC4(40)</td> <td>MD5</td> <td>  export</td> </tr>
 568 <tr><td><code>NULL-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>None</td> <td>SHA1</td> <td /> </tr>
 569 <tr><td><code>NULL-MD5</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>None</td> <td>MD5</td> <td /> </tr>
 570 <tr><td colspan="7"><em>Diffie-Hellman Ciphers:</em></td></tr>
 571 <tr><td><code>ADH-DES-CBC3-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>None</td> <td>3DES(168)</td> <td>SHA1</td> <td /> </tr>
 572 <tr><td><code>ADH-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>None</td> <td>DES(56)</td> <td>SHA1</td> <td /> </tr>
 573 <tr><td><code>ADH-RC4-MD5</code></td> <td>SSLv3</td> <td>DH</td> <td>None</td> <td>RC4(128)</td> <td>MD5</td> <td /> </tr>
 574 <tr><td><code>EDH-RSA-DES-CBC3-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>RSA</td> <td>3DES(168)</td> <td>SHA1</td> <td /> </tr>
 575 <tr><td><code>EDH-DSS-DES-CBC3-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>DSS</td> <td>3DES(168)</td> <td>SHA1</td> <td /> </tr>
 576 <tr><td><code>EDH-RSA-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>RSA</td> <td>DES(56)</td> <td>SHA1</td> <td /> </tr>
 577 <tr><td><code>EDH-DSS-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>DSS</td> <td>DES(56)</td> <td>SHA1</td> <td /> </tr>
 578 <tr><td><code>EXP-EDH-RSA-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH(512)</td> <td>RSA</td> <td>DES(40)</td> <td>SHA1</td> <td> export</td> </tr>
 579 <tr><td><code>EXP-EDH-DSS-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH(512)</td> <td>DSS</td> <td>DES(40)</td> <td>SHA1</td> <td> export</td> </tr>
 580 <tr><td><code>EXP-ADH-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH(512)</td> <td>None</td> <td>DES(40)</td> <td>SHA1</td> <td> export</td> </tr>
 581 <tr><td><code>EXP-ADH-RC4-MD5</code></td> <td>SSLv3</td> <td>DH(512)</td> <td>None</td> <td>RC4(40)</td> <td>MD5</td> <td>  export</td> </tr>
 582 </table>
 583
 584 </div>
 585 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 586 <div class="directive-section"><h2><a name="SSLCryptoDevice" id="SSLCryptoDevice">SSLCryptoDevice</a> <a name="sslcryptodevice" id="sslcryptodevice">Directive</a></h2>
 587 <table class="directive">
 588 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable use of a cryptographic hardware accelerator</td></tr>
 589 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCryptoDevice <em>engine</em></code></td></tr>
 590 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCryptoDevice builtin</code></td></tr>
 591 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 592 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 593 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 594 </table>
 595 <p>
 596 This directive enables use of a cryptographic hardware accelerator
 597 board to offload some of the SSL processing overhead.  This directive
 598 can only be used if the SSL toolkit is built with "engine" support;
 599 OpenSSL 0.9.7 and later releases have "engine" support by default, the
 600 separate "-engine" releases of OpenSSL 0.9.6 must be used.</p>
 601
 602 <p>To discover which engine names are supported, run the command
 603 "<code>openssl engine</code>".</p>
 604
 605 <div class="example"><h3>Example</h3><p><code>
 606 # For a Broadcom accelerator:<br />
 607 SSLCryptoDevice ubsec
 608 </code></p></div>
 609
 610 </div>
 611 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 612 <div class="directive-section"><h2><a name="SSLEngine" id="SSLEngine">SSLEngine</a> <a name="sslengine" id="sslengine">Directive</a></h2>
 613 <table class="directive">
 614 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL Engine Operation Switch</td></tr>
 615 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLEngine on|off|optional</code></td></tr>
 616 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLEngine off</code></td></tr>
 617 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 618 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 619 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 620 </table>
 621 <p>
 622 This directive toggles the usage of the SSL/TLS Protocol Engine. This
 623 is usually used inside a <code class="directive"><a href="../mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code> section to enable SSL/TLS for a
 624 particular virtual host. By default the SSL/TLS Protocol Engine is
 625 disabled for both the main server and all configured virtual hosts.</p>
 626 <div class="example"><h3>Example</h3><p><code>
 627 &lt;VirtualHost _default_:443&gt;<br />
 628 SSLEngine on<br />
 629 ...<br />
 630 &lt;/VirtualHost&gt;
 631 </code></p></div>
 632 <p>In Apache 2.1 and later, <code class="directive">SSLEngine</code> can be set to
 633 <code>optional</code>. This enables support for
 634 <a href="http://www.ietf.org/rfc/rfc2817.txt">RFC 2817</a>, Upgrading to TLS
 635 Within HTTP/1.1. At this time no web browsers support RFC 2817.</p>
 636
 637 </div>
 638 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 639 <div class="directive-section"><h2><a name="SSLHonorCipherOrder" id="SSLHonorCipherOrder">SSLHonorCipherOrder</a> <a name="sslhonorcipherorder" id="sslhonorcipherorder">Directive</a></h2>
 640 <table class="directive">
 641 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Option to prefer the server's cipher preference order</td></tr>
 642 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLHonorCiperOrder <em>flag</em></code></td></tr>
 643 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 644 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 645 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 646 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later, if using OpenSSL 0.9.7 or later</td></tr>
 647 </table>
 648 <p>When choosing a cipher during an SSLv3 or TLSv1 handshake, normally
 649 the client's preference is used.  If this directive is enabled, the
 650 server's preference will be used instead.</p>
 651 <div class="example"><h3>Example</h3><p><code>
 652 SSLHonorCipherOrder on
 653 </code></p></div>
 654
 655 </div>
 656 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 657 <div class="directive-section"><h2><a name="SSLMutex" id="SSLMutex">SSLMutex</a> <a name="sslmutex" id="sslmutex">Directive</a></h2>
 658 <table class="directive">
 659 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Semaphore for internal mutual exclusion of
 660 operations</td></tr>
 661 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLMutex <em>type</em></code></td></tr>
 662 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLMutex none</code></td></tr>
 663 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 664 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 665 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 666 </table>
 667 <p>
 668 This configures the SSL engine's semaphore (aka. lock) which is used for mutual
 669 exclusion of operations which have to be done in a synchronized way between the
 670 pre-forked Apache server processes. This directive can only be used in the
 671 global server context because it's only useful to have one global mutex.
 672 This directive is designed to closely match the
 673 <code class="directive"><a href="../mod/mpm_common.html#acceptmutex">AcceptMutex</a></code> directive.</p>
 674 <p>
 675 The following Mutex <em>types</em> are available:</p>
 676 <ul>
 677 <li><code>none | no</code>
 678     <p>
 679     This is the default where no Mutex is used at all. Use it at your own
 680     risk. But because currently the Mutex is mainly used for synchronizing
 681     write access to the SSL Session Cache you can live without it as long
 682     as you accept a sometimes garbled Session Cache. So it's not recommended
 683     to leave this the default. Instead configure a real Mutex.</p></li>
 684 <li><code>posixsem</code>
 685     <p>
 686     This is an elegant Mutex variant where a Posix Semaphore is used when possible.
 687     It is only available when the underlying platform
 688     and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> supports it.</p></li>
 689 <li><code>sysvsem</code>
 690     <p>
 691     This is a somewhat elegant Mutex variant where a SystemV IPC Semaphore is used when
 692     possible. It is possible to "leak" SysV semaphores if processes crash before
 693     the semaphore is removed. It is only available when the underlying platform
 694     and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> supports it.</p></li>
 695 <li><code>sem</code>
 696     <p>
 697     This directive tells the SSL Module to pick the "best" semaphore implementation
 698     available to it, choosing between Posix and SystemV IPC, in that order. It is only
 699     available when the underlying platform and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> supports at least one of the 2.</p></li>
 700 <li><code>pthread</code>
 701     <p>
 702     This directive tells the SSL Module to use Posix thread mutexes. It is only available
 703     if the underlying platform and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> supports it.</p></li>
 704 <li><code>fcntl:/path/to/mutex</code>
 705     <p>
 706     This is a portable Mutex variant where a physical (lock-)file and the <code>fcntl()</code>
 707     fucntion are used as the Mutex.
 708     Always use a local disk filesystem for <code>/path/to/mutex</code> and never a file
 709     residing on a NFS- or AFS-filesystem. It is only available when the underlying platform
 710     and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> supports it. Note: Internally, the Process ID (PID) of the
 711     Apache parent process is automatically appended to
 712     <code>/path/to/mutex</code> to make it unique, so you don't have to worry
 713     about conflicts yourself. Notice that this type of mutex is not available
 714     under the Win32 environment. There you <em>have</em> to use the semaphore
 715     mutex.</p></li>
 716 <li><code>flock:/path/to/mutex</code>
 717     <p>
 718     This is similar to the <code>fcntl:/path/to/mutex</code> method with the
 719     exception that the <code>flock()</code> function is used to provide file
 720     locking. It is only available when the underlying platform
 721     and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> supports it.</p></li>
 722 <li><code>file:/path/to/mutex</code>
 723     <p>
 724     This directive tells the SSL Module to pick the "best" file locking implementation
 725     available to it, choosing between <code>fcntl</code> and <code>flock</code>,
 726     in that order. It is only available when the underlying platform and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> supports
 727     at least one of the 2.</p></li>
 728 <li><code>default | yes</code>
 729     <p>
 730     This directive tells the SSL Module to pick the default locking implementation
 731     as determined by the platform and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>.</p></li>
 732 </ul>
 733 <div class="example"><h3>Example</h3><p><code>
 734 SSLMutex file:/usr/local/apache/logs/ssl_mutex
 735 </code></p></div>
 736
 737 </div>
 738 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 739 <div class="directive-section"><h2><a name="SSLOCSPDefaultResponder" id="SSLOCSPDefaultResponder">SSLOCSPDefaultResponder</a> <a name="sslocspdefaultresponder" id="sslocspdefaultresponder">Directive</a></h2>
 740 <table class="directive">
 741 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the default responder URI for OCSP validation</td></tr>
 742 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSDefaultResponder <em>uri</em></code></td></tr>
 743 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 744 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 745 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 746 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</td></tr>
 747 </table>
 748 <p>This option sets the default OCSP responder to use.  If <code class="directive"><a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></code> is not enabled,
 749 the URI given will be used only if no responder URI is specified in
 750 the certificate being verified.</p>
 751
 752 </div>
 753 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 754 <div class="directive-section"><h2><a name="SSLOCSPEnable" id="SSLOCSPEnable">SSLOCSPEnable</a> <a name="sslocspenable" id="sslocspenable">Directive</a></h2>
 755 <table class="directive">
 756 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable OCSP validation of the client certificate chain</td></tr>
 757 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPEnable <em>flag</em></code></td></tr>
 758 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 759 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 760 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 761 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</td></tr>
 762 </table>
 763 <p>This option enables OCSP validation of the client certificate
 764 chain.  If this option is enabled, certificates in the client's
 765 certificate chain will be validated against an OCSP responder after
 766 normal verification (including CRL checks) have taken place.</p>
 767
 768 <p>The OCSP responder used is either extracted from the certificate
 769 itself, or derived by configuration; see the
 770 <code class="directive"><a href="#sslocspdefaultresponder">SSLOCSPDefaultResponder</a></code> and
 771 <code class="directive"><a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></code>
 772 directives.</p>
 773
 774 <div class="example"><h3>Example</h3><p><code>
 775 SSLVerifyClient on<br />
 776 SSLOCSPEnable on<br />
 777 SSLOCSPDefaultResponder http://responder.example.com:8888/responder<br />
 778 SSLOCSPOverrideResponder on
 779 </code></p></div>
 780
 781 </div>
 782 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 783 <div class="directive-section"><h2><a name="SSLOCSPOverrideResponder" id="SSLOCSPOverrideResponder">SSLOCSPOverrideResponder</a> <a name="sslocspoverrideresponder" id="sslocspoverrideresponder">Directive</a></h2>
 784 <table class="directive">
 785 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Force use of the default responder URI for OCSP validation</td></tr>
 786 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPOverrideResponder <em>flag</em></code></td></tr>
 787 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 788 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 789 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 790 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</td></tr>
 791 </table>
 792 <p>This option forces the configured default OCSP responder to be used
 793 during OCSP certificate validation, regardless of whether the
 794 certificate being validated references an OCSP responder.</p>
 795
 796 </div>
 797 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 798 <div class="directive-section"><h2><a name="SSLOptions" id="SSLOptions">SSLOptions</a> <a name="ssloptions" id="ssloptions">Directive</a></h2>
 799 <table class="directive">
 800 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure various SSL engine run-time options</td></tr>
 801 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOptions [+|-]<em>option</em> ...</code></td></tr>
 802 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 803 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
 804 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 805 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 806 </table>
 807 <p>
 808 This directive can be used to control various run-time options on a
 809 per-directory basis. Normally, if multiple <code>SSLOptions</code>
 810 could apply to a directory, then the most specific one is taken
 811 completely; the options are not merged. However if <em>all</em> the
 812 options on the <code>SSLOptions</code> directive are preceded by a
 813 plus (<code>+</code>) or minus (<code>-</code>) symbol, the options
 814 are merged. Any options preceded by a <code>+</code> are added to the
 815 options currently in force, and any options preceded by a
 816 <code>-</code> are removed from the options currently in force.</p>
 817 <p>
 818 The available <em>option</em>s are:</p>
 819 <ul>
 820 <li><code>StdEnvVars</code>
 821     <p>
 822     When this option is enabled, the standard set of SSL related CGI/SSI
 823     environment variables are created. This per default is disabled for
 824     performance reasons, because the information extraction step is a
 825     rather expensive operation. So one usually enables this option for
 826     CGI and SSI requests only.</p>
 827 </li>
 828 <li><code>CompatEnvVars</code>
 829     <p>
 830     When this option is enabled, additional CGI/SSI environment variables are
 831     created for backward compatibility to other Apache SSL solutions. Look in
 832     the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter for details
 833     on the particular variables generated.</p>
 834 </li>
 835 <li><code>ExportCertData</code>
 836     <p>
 837     When this option is enabled, additional CGI/SSI environment variables are
 838     created: <code>SSL_SERVER_CERT</code>, <code>SSL_CLIENT_CERT</code> and
 839     <code>SSL_CLIENT_CERT_CHAIN_</code><em>n</em> (with <em>n</em> = 0,1,2,..).
 840     These contain the PEM-encoded X.509 Certificates of server and client for
 841     the current HTTPS connection and can be used by CGI scripts for deeper
 842     Certificate checking. Additionally all other certificates of the client
 843     certificate chain are provided, too. This bloats up the environment a
 844     little bit which is why you have to use this option to enable it on
 845     demand.</p>
 846 </li>
 847 <li><code>FakeBasicAuth</code>
 848     <p>
 849     When this option is enabled, the Subject Distinguished Name (DN) of the
 850     Client X509 Certificate is translated into a HTTP Basic Authorization
 851     username. This means that the standard Apache authentication methods can
 852     be used for access control. The user name is just the Subject of the
 853     Client's X509 Certificate (can be determined by running OpenSSL's
 854     <code>openssl x509</code> command: <code>openssl x509 -noout -subject -in
 855     </code><em>certificate</em><code>.crt</code>). Note that no password is
 856     obtained from the user. Every entry in the user file needs this password:
 857     ``<code>xxj31ZMTZzkVA</code>'', which is the DES-encrypted version of the
 858     word `<code>password</code>''. Those who live under MD5-based encryption
 859     (for instance under FreeBSD or BSD/OS, etc.) should use the following MD5
 860     hash of the same word: ``<code>$1$OXLyS...$Owx8s2/m9/gfkcRVXzgoE/</code>''.</p>
 861 </li>
 862 <li><code>StrictRequire</code>
 863     <p>
 864     This <em>forces</em> forbidden access when <code>SSLRequireSSL</code> or
 865     <code>SSLRequire</code> successfully decided that access should be
 866     forbidden. Usually the default is that in the case where a ``<code>Satisfy
 867     any</code>'' directive is used, and other access restrictions are passed,
 868     denial of access due to <code>SSLRequireSSL</code> or
 869     <code>SSLRequire</code> is overridden (because that's how the Apache
 870     <code>Satisfy</code> mechanism should work.) But for strict access restriction
 871     you can use <code>SSLRequireSSL</code> and/or <code>SSLRequire</code> in
 872     combination with an ``<code>SSLOptions +StrictRequire</code>''. Then an
 873     additional ``<code>Satisfy Any</code>'' has no chance once mod_ssl has
 874     decided to deny access.</p>
 875 </li>
 876 <li><code>OptRenegotiate</code>
 877     <p>
 878     This enables optimized SSL connection renegotiation handling when SSL
 879     directives are used in per-directory context. By default a strict
 880     scheme is enabled where <em>every</em> per-directory reconfiguration of
 881     SSL parameters causes a <em>full</em> SSL renegotiation handshake. When this
 882     option is used mod_ssl tries to avoid unnecessary handshakes by doing more
 883     granular (but still safe) parameter checks. Nevertheless these granular
 884     checks sometimes maybe not what the user expects, so enable this on a
 885     per-directory basis only, please.</p>
 886 </li>
 887 </ul>
 888 <div class="example"><h3>Example</h3><p><code>
 889 SSLOptions +FakeBasicAuth -StrictRequire<br />
 890 &lt;Files ~ "\.(cgi|shtml)$"&gt;<br />
 891     SSLOptions +StdEnvVars +CompatEnvVars -ExportCertData<br />
 892 &lt;Files&gt;
 893 </code></p></div>
 894
 895 </div>
 896 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 897 <div class="directive-section"><h2><a name="SSLPassPhraseDialog" id="SSLPassPhraseDialog">SSLPassPhraseDialog</a> <a name="sslpassphrasedialog" id="sslpassphrasedialog">Directive</a></h2>
 898 <table class="directive">
 899 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of pass phrase dialog for encrypted private
 900 keys</td></tr>
 901 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLPassPhraseDialog <em>type</em></code></td></tr>
 902 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLPassPhraseDialog builtin</code></td></tr>
 903 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 904 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 905 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 906 </table>
 907 <p>
 908 When Apache starts up it has to read the various Certificate (see
 909 <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>) and
 910 Private Key (see <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>) files of the
 911 SSL-enabled virtual servers. Because for security reasons the Private
 912 Key files are usually encrypted, mod_ssl needs to query the
 913 administrator for a Pass Phrase in order to decrypt those files. This
 914 query can be done in two ways which can be configured by
 915 <em>type</em>:</p>
 916 <ul>
 917 <li><code>builtin</code>
 918     <p>
 919     This is the default where an interactive terminal dialog occurs at startup
 920     time just before Apache detaches from the terminal. Here the administrator
 921     has to manually enter the Pass Phrase for each encrypted Private Key file.
 922     Because a lot of SSL-enabled virtual hosts can be configured, the
 923     following reuse-scheme is used to minimize the dialog: When a Private Key
 924     file is encrypted, all known Pass Phrases (at the beginning there are
 925     none, of course) are tried. If one of those known Pass Phrases succeeds no
 926     dialog pops up for this particular Private Key file. If none succeeded,
 927     another Pass Phrase is queried on the terminal and remembered for the next
 928     round (where it perhaps can be reused).</p>
 929     <p>
 930     This scheme allows mod_ssl to be maximally flexible (because for N encrypted
 931     Private Key files you <em>can</em> use N different Pass Phrases - but then
 932     you have to enter all of them, of course) while minimizing the terminal
 933     dialog (i.e. when you use a single Pass Phrase for all N Private Key files
 934     this Pass Phrase is queried only once).</p></li>
 935
 936 <li><code>|/path/to/program [args...]</code>
 937
 938    <p>This mode allows an external program to be used which acts as a
 939    pipe to a particular input device; the program is sent the standard
 940    prompt text used for the <code>builtin</code> mode on
 941    <code>stdin</code>, and is expected to write password strings on
 942    <code>stdout</code>.  If several passwords are needed (or an
 943    incorrect password is entered), additional prompt text will be
 944    written subsequent to the first password being returned, and more
 945    passwords must then be written back.</p></li>
 946
 947 <li><code>exec:/path/to/program</code>
 948     <p>
 949     Here an external program is configured which is called at startup for each
 950     encrypted Private Key file. It is called with two arguments (the first is
 951     of the form ``<code>servername:portnumber</code>'', the second is either
 952     ``<code>RSA</code>'' or ``<code>DSA</code>''), which indicate for which
 953     server and algorithm it has to print the corresponding Pass Phrase to
 954     <code>stdout</code>. The intent is that this external program first runs
 955     security checks to make sure that the system is not compromised by an
 956     attacker, and only when these checks were passed successfully it provides
 957     the Pass Phrase.</p>
 958     <p>
 959     Both these security checks, and the way the Pass Phrase is determined, can
 960     be as complex as you like. Mod_ssl just defines the interface: an
 961     executable program which provides the Pass Phrase on <code>stdout</code>.
 962     Nothing more or less! So, if you're really paranoid about security, here
 963     is your interface. Anything else has to be left as an exercise to the
 964     administrator, because local security requirements are so different.</p>
 965     <p>
 966     The reuse-algorithm above is used here, too. In other words: The external
 967     program is called only once per unique Pass Phrase.</p></li>
 968 </ul>
 969 <div class="example"><h3>Example</h3><p><code>
 970 SSLPassPhraseDialog exec:/usr/local/apache/sbin/pp-filter
 971 </code></p></div>
 972
 973 </div>
 974 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 975 <div class="directive-section"><h2><a name="SSLProtocol" id="SSLProtocol">SSLProtocol</a> <a name="sslprotocol" id="sslprotocol">Directive</a></h2>
 976 <table class="directive">
 977 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure usable SSL protocol versions</td></tr>
 978 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProtocol [+|-]<em>protocol</em> ...</code></td></tr>
 979 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProtocol all</code></td></tr>
 980 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 981 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 982 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 983 </table>
 984 <p>
 985 This directive can be used to control which versions of the SSL protocol
 986 will be accepted in new connections.</p>
 987 <p>
 988 The available (case-insensitive) <em>protocol</em>s are:</p>
 989 <ul>
 990 <li><code>SSLv2</code>
 991     <p>
 992     This is the Secure Sockets Layer (SSL) protocol, version 2.0. It is the
 993     original SSL protocol as designed by Netscape Corporation.  Though it's
 994     use has been deprecated, because of weaknesses in the security of the protocol.</p></li>
 995
 996 <li><code>SSLv3</code>
 997     <p>
 998     This is the Secure Sockets Layer (SSL) protocol, version 3.0, from the Netscape Corportaion.
 999     It is the successor to SSLv2 and the predecessor to TLSv1. It's supported by
1000     almost all popular browsers.</p></li>
1001
1002 <li><code>TLSv1</code>
1003     <p>
1004     This is the Transport Layer Security (TLS) protocol, version 1.0. It is the
1005     successor to SSLv3 and is defined in <a href="http://www.ietf.org/rfc/rfc2246.txt">RFC2246</a>.
1006     Which has been obsoleted by <a href="http://www.ietf.org/rfc/rfc4346.txt">RFC4346</a>.</p></li>
1007
1008 <li><code>All</code>
1009     <p>
1010     This is a shortcut for ``<code>+SSLv2 +SSLv3 +TLSv1</code>'' and a
1011     convenient way for enabling all protocols except one when used in
1012     combination with the minus sign on a protocol as the example above
1013     shows.</p></li>
1014 </ul>
1015 <div class="example"><h3>Example</h3><p><code>
1016 #   enable SSLv3 and TLSv1, but not SSLv2<br />
1017 SSLProtocol all -SSLv2
1018 </code></p></div>
1019
1020 </div>
1021 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1022 <div class="directive-section"><h2><a name="SSLProxyCACertificateFile" id="SSLProxyCACertificateFile">SSLProxyCACertificateFile</a> <a name="sslproxycacertificatefile" id="sslproxycacertificatefile">Directive</a></h2>
1023 <table class="directive">
1024 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
1025 for Remote Server Auth</td></tr>
1026 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCACertificateFile <em>file-path</em></code></td></tr>
1027 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1028 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1029 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1030 </table>
1031 <p>
1032 This directive sets the <em>all-in-one</em> file where you can assemble the
1033 Certificates of Certification Authorities (CA) whose <em>remote servers</em> you deal
1034 with. These are used for Remote Server Authentication. Such a file is simply the
1035 concatenation of the various PEM-encoded Certificate files, in order of
1036 preference. This can be used alternatively and/or additionally to
1037 <code class="directive"><a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></code>.</p>
1038 <div class="example"><h3>Example</h3><p><code>
1039 SSLProxyCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-remote-server.crt
1040 </code></p></div>
1041
1042 </div>
1043 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1044 <div class="directive-section"><h2><a name="SSLProxyCACertificatePath" id="SSLProxyCACertificatePath">SSLProxyCACertificatePath</a> <a name="sslproxycacertificatepath" id="sslproxycacertificatepath">Directive</a></h2>
1045 <table class="directive">
1046 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
1047 Remote Server Auth</td></tr>
1048 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCACertificatePath <em>directory-path</em></code></td></tr>
1049 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1050 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1051 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1052 </table>
1053 <p>
1054 This directive sets the directory where you keep the Certificates of
1055 Certification Authorities (CAs) whose remote servers you deal with. These are used to
1056 verify the remote server certificate on Remote Server Authentication.</p>
1057 <p>
1058 The files in this directory have to be PEM-encoded and are accessed through
1059 hash filenames. So usually you can't just place the Certificate files
1060 there: you also have to create symbolic links named
1061 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
1062 contains the appropriate symbolic links. Use the <code>Makefile</code> which
1063 comes with mod_ssl to accomplish this task.</p>
1064 <div class="example"><h3>Example</h3><p><code>
1065 SSLProxyCACertificatePath /usr/local/apache2/conf/ssl.crt/
1066 </code></p></div>
1067
1068 </div>
1069 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1070 <div class="directive-section"><h2><a name="SSLProxyCARevocationFile" id="SSLProxyCARevocationFile">SSLProxyCARevocationFile</a> <a name="sslproxycarevocationfile" id="sslproxycarevocationfile">Directive</a></h2>
1071 <table class="directive">
1072 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA CRLs for
1073 Remote Server Auth</td></tr>
1074 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationFile <em>file-path</em></code></td></tr>
1075 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1076 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1077 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1078 </table>
1079 <p>
1080 This directive sets the <em>all-in-one</em> file where you can
1081 assemble the Certificate Revocation Lists (CRL) of Certification
1082 Authorities (CA) whose <em>remote servers</em> you deal with. These are used
1083 for Remote Server Authentication.  Such a file is simply the concatenation of
1084 the various PEM-encoded CRL files, in order of preference. This can be
1085 used alternatively and/or additionally to <code class="directive"><a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></code>.</p>
1086 <div class="example"><h3>Example</h3><p><code>
1087 SSLProxyCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-remote-server.crl
1088 </code></p></div>
1089
1090 </div>
1091 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1092 <div class="directive-section"><h2><a name="SSLProxyCARevocationPath" id="SSLProxyCARevocationPath">SSLProxyCARevocationPath</a> <a name="sslproxycarevocationpath" id="sslproxycarevocationpath">Directive</a></h2>
1093 <table class="directive">
1094 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA CRLs for
1095 Remote Server Auth</td></tr>
1096 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationPath <em>directory-path</em></code></td></tr>
1097 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1098 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1099 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1100 </table>
1101 <p>
1102 This directive sets the directory where you keep the Certificate Revocation
1103 Lists (CRL) of Certification Authorities (CAs) whose remote servers you deal with.
1104 These are used to revoke the remote server certificate on Remote Server Authentication.</p>
1105 <p>
1106 The files in this directory have to be PEM-encoded and are accessed through
1107 hash filenames. So usually you have not only to place the CRL files there.
1108 Additionally you have to create symbolic links named
1109 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
1110 contains the appropriate symbolic links. Use the <code>Makefile</code> which
1111 comes with <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> to accomplish this task.</p>
1112 <div class="example"><h3>Example</h3><p><code>
1113 SSLProxyCARevocationPath /usr/local/apache2/conf/ssl.crl/
1114 </code></p></div>
1115
1116 </div>
1117 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1118 <div class="directive-section"><h2><a name="SSLProxyCheckPeerCN" id="SSLProxyCheckPeerCN">SSLProxyCheckPeerCN</a> <a name="sslproxycheckpeercn" id="sslproxycheckpeercn">Directive</a></h2>
1119 <table class="directive">
1120 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether to check the remote server certificates CN field
1121 </td></tr>
1122 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCheckPeerCN on|off|optional</code></td></tr>
1123 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCheckPeerCN off</code></td></tr>
1124 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1125 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1126 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1127 </table>
1128 <p>
1129 This directive sets whether the remote server certificates CN field is
1130 compared against the hostname of the request URL. If both are not equal
1131 a 502 status code (Bad Gateway) is sent.
1132 </p>
1133 <div class="example"><h3>Example</h3><p><code>
1134 SSLProxyCheckPeerCN on
1135 </code></p></div>
1136
1137 </div>
1138 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1139 <div class="directive-section"><h2><a name="SSLProxyCheckPeerExpire" id="SSLProxyCheckPeerExpire">SSLProxyCheckPeerExpire</a> <a name="sslproxycheckpeerexpire" id="sslproxycheckpeerexpire">Directive</a></h2>
1140 <table class="directive">
1141 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether to check if remote server certificate is expired
1142 </td></tr>
1143 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCheckPeerExpire on|off|optional</code></td></tr>
1144 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCheckPeerExpire off</code></td></tr>
1145 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1146 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1147 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1148 </table>
1149 <p>
1150 This directive sets whether it is checked if the remote server certificate
1151 is expired or not. If the check fails a 502 status code (Bad Gateway) is
1152 sent.
1153 </p>
1154 <div class="example"><h3>Example</h3><p><code>
1155 SSLProxyCheckPeerExpire on
1156 </code></p></div>
1157
1158 </div>
1159 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1160 <div class="directive-section"><h2><a name="SSLProxyCipherSuite" id="SSLProxyCipherSuite">SSLProxyCipherSuite</a> <a name="sslproxyciphersuite" id="sslproxyciphersuite">Directive</a></h2>
1161 <table class="directive">
1162 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cipher Suite available for negotiation in SSL
1163 proxy handshake</td></tr>
1164 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCipherSuite <em>cipher-spec</em></code></td></tr>
1165 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</code></td></tr>
1166 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1167 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1168 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1169 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1170 </table>
1171 <p>Equivalent to <code>SSLCipherSuite</code>, but for the proxy connection.
1172 Please refer to <code class="directive"><a href="#sslciphersuite">SSLCipherSuite</a></code>
1173 for additional information.</p>
1174
1175 </div>
1176 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1177 <div class="directive-section"><h2><a name="SSLProxyEngine" id="SSLProxyEngine">SSLProxyEngine</a> <a name="sslproxyengine" id="sslproxyengine">Directive</a></h2>
1178 <table class="directive">
1179 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL Proxy Engine Operation Switch</td></tr>
1180 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyEngine on|off</code></td></tr>
1181 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyEngine off</code></td></tr>
1182 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1183 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1184 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1185 </table>
1186 <p>
1187 This directive toggles the usage of the SSL/TLS Protocol Engine for proxy. This
1188 is usually used inside a <code class="directive"><a href="../mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code> section to enable SSL/TLS for proxy
1189 usage in a particular virtual host. By default the SSL/TLS Protocol Engine is
1190 disabled for proxy image both for the main server and all configured virtual hosts.</p>
1191 <div class="example"><h3>Example</h3><p><code>
1192 &lt;VirtualHost _default_:443&gt;<br />
1193 SSLProxyEngine on<br />
1194 ...<br />
1195 &lt;/VirtualHost&gt;
1196 </code></p></div>
1197
1198 </div>
1199 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1200 <div class="directive-section"><h2><a name="SSLProxyMachineCertificateFile" id="SSLProxyMachineCertificateFile">SSLProxyMachineCertificateFile</a> <a name="sslproxymachinecertificatefile" id="sslproxymachinecertificatefile">Directive</a></h2>
1201 <table class="directive">
1202 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded client certificates and keys to be used by the proxy</td></tr>
1203 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificateFile <em>filename</em></code></td></tr>
1204 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1205 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1206 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1207 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1208 </table>
1209 <p>
1210 This directive sets the all-in-one file where you keep the certificates and
1211 keys used for authentication of the proxy server to remote servers.
1212 </p>
1213 <p>
1214 This referenced file is simply the concatenation of the various PEM-encoded
1215 certificate files, in order of preference. Use this directive alternatively
1216 or additionally to <code>SSLProxyMachineCertificatePath</code>.
1217 </p>
1218 <div class="warning">
1219 <p>Currently there is no support for encrypted private keys</p>
1220 </div>
1221 <div class="example"><h3>Example</h3><p><code>
1222 SSLProxyMachineCertificateFile /usr/local/apache2/conf/ssl.crt/proxy.pem
1223 </code></p></div>
1224
1225 </div>
1226 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1227 <div class="directive-section"><h2><a name="SSLProxyMachineCertificatePath" id="SSLProxyMachineCertificatePath">SSLProxyMachineCertificatePath</a> <a name="sslproxymachinecertificatepath" id="sslproxymachinecertificatepath">Directive</a></h2>
1228 <table class="directive">
1229 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded client certificates and keys to be used by the proxy</td></tr>
1230 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificatePath <em>directory</em></code></td></tr>
1231 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1232 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1233 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1234 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1235 </table>
1236 <p>
1237 This directive sets the directory where you keep the certificates and
1238 keys used for authentication of the proxy server to remote servers.
1239 </p>
1240 <p>The files in this directory must be PEM-encoded and are accessed through
1241 hash filenames. Additionally, you must create symbolic links named
1242 <code><em>hash-value</em>.N</code>. And you should always make sure this
1243 directory contains the appropriate symbolic links. Use the Makefile which
1244 comes with mod_ssl to accomplish this task.
1245 </p>
1246 <div class="warning">
1247 <p>Currently there is no support for encrypted private keys</p>
1248 </div>
1249 <div class="example"><h3>Example</h3><p><code>
1250 SSLProxyMachineCertificatePath /usr/local/apache2/conf/proxy.crt/
1251 </code></p></div>
1252
1253 </div>
1254 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1255 <div class="directive-section"><h2><a name="SSLProxyProtocol" id="SSLProxyProtocol">SSLProxyProtocol</a> <a name="sslproxyprotocol" id="sslproxyprotocol">Directive</a></h2>
1256 <table class="directive">
1257 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure usable SSL protocol flavors for proxy usage</td></tr>
1258 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyProtocol [+|-]<em>protocol</em> ...</code></td></tr>
1259 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyProtocol all</code></td></tr>
1260 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1261 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
1262 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1263 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1264 </table>
1265
1266 <p>
1267 This directive can be used to control the SSL protocol flavors mod_ssl should
1268 use when establishing its server environment for proxy . It will only connect
1269 to servers using one of the provided protocols.</p>
1270 <p>Please refer to <code class="directive"><a href="#sslprotocol">SSLProtocol</a></code>
1271 for additional information.
1272 </p>
1273
1274 </div>
1275 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1276 <div class="directive-section"><h2><a name="SSLProxyVerify" id="SSLProxyVerify">SSLProxyVerify</a> <a name="sslproxyverify" id="sslproxyverify">Directive</a></h2>
1277 <table class="directive">
1278 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of remote server Certificate verification</td></tr>
1279 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyVerify <em>level</em></code></td></tr>
1280 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyVerify none</code></td></tr>
1281 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1282 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1283 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1284 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1285 </table>
1286
1287 <p>When a proxy is configured to forward requests to a remote SSL
1288 server, this directive can be used to configure certificate
1289 verification of the remote server.  Notice that this directive can be
1290 used both in per-server and per-directory context. In per-server
1291 context it applies to the remote server authentication process used in
1292 the standard SSL handshake when a connection is established by the
1293 proxy. In per-directory context it forces a SSL renegotation with the
1294 reconfigured remote server verification level after the HTTP request
1295 was read but before the HTTP response is sent.</p>
1296
1297 <div class="warning">
1298 <p>Note that even when certificate verification is enabled,
1299 <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> does <strong>not</strong> check whether the
1300 <code>commonName</code> (hostname) attribute of the server certificate
1301 matches the hostname used to connect to the server.  In other words,
1302 the proxy does not guarantee that the SSL connection to the backend
1303 server is "secure" beyond the fact that the certificate is signed by
1304 one of the CAs configured using the
1305 <code class="directive">SSLProxyCACertificatePath</code> and/or
1306 <code class="directive">SSLProxyCACertificateFile</code> directives.</p>
1307 </div>
1308
1309 <p>
1310 The following levels are available for <em>level</em>:</p>
1311 <ul>
1312 <li><strong>none</strong>:
1313      no remote server Certificate is required at all</li>
1314 <li><strong>optional</strong>:
1315      the remote server <em>may</em> present a valid Certificate</li>
1316 <li><strong>require</strong>:
1317      the remote server <em>has to</em> present a valid Certificate</li>
1318 <li><strong>optional_no_ca</strong>:
1319      the remote server may present a valid Certificate<br />
1320      but it need not to be (successfully) verifiable.</li>
1321 </ul>
1322 <p>In practice only levels <strong>none</strong> and
1323 <strong>require</strong> are really interesting, because level
1324 <strong>optional</strong> doesn't work with all servers and level
1325 <strong>optional_no_ca</strong> is actually against the idea of
1326 authentication (but can be used to establish SSL test pages, etc.)</p>
1327 <div class="example"><h3>Example</h3><p><code>
1328 SSLProxyVerify require
1329 </code></p></div>
1330
1331 </div>
1332 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1333 <div class="directive-section"><h2><a name="SSLProxyVerifyDepth" id="SSLProxyVerifyDepth">SSLProxyVerifyDepth</a> <a name="sslproxyverifydepth" id="sslproxyverifydepth">Directive</a></h2>
1334 <table class="directive">
1335 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum depth of CA Certificates in Remote Server
1336 Certificate verification</td></tr>
1337 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyVerifyDepth <em>number</em></code></td></tr>
1338 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyVerifyDepth 1</code></td></tr>
1339 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1340 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1341 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1342 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1343 </table>
1344 <p>
1345 This directive sets how deeply mod_ssl should verify before deciding that the
1346 remote server does not have a valid certificate. Notice that this directive can be
1347 used both in per-server and per-directory context. In per-server context it
1348 applies to the client authentication process used in the standard SSL
1349 handshake when a connection is established. In per-directory context it forces
1350 a SSL renegotation with the reconfigured remote server verification depth after the
1351 HTTP request was read but before the HTTP response is sent.</p>
1352 <p>
1353 The depth actually is the maximum number of intermediate certificate issuers,
1354 i.e. the number of CA certificates which are max allowed to be followed while
1355 verifying the remote server certificate. A depth of 0 means that self-signed
1356 remote server certificates are accepted only, the default depth of 1 means
1357 the remote server certificate can be self-signed or has to be signed by a CA
1358 which is directly known to the server (i.e. the CA's certificate is under
1359 <code class="directive"><a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></code>), etc.</p>
1360 <div class="example"><h3>Example</h3><p><code>
1361 SSLProxyVerifyDepth 10
1362 </code></p></div>
1363
1364 </div>
1365 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1366 <div class="directive-section"><h2><a name="SSLRandomSeed" id="SSLRandomSeed">SSLRandomSeed</a> <a name="sslrandomseed" id="sslrandomseed">Directive</a></h2>
1367 <table class="directive">
1368 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pseudo Random Number Generator (PRNG) seeding
1369 source</td></tr>
1370 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRandomSeed <em>context</em> <em>source</em>
1371 [<em>bytes</em>]</code></td></tr>
1372 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1373 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1374 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1375 </table>
1376 <p>
1377 This configures one or more sources for seeding the Pseudo Random Number
1378 Generator (PRNG) in OpenSSL at startup time (<em>context</em> is
1379 <code>startup</code>) and/or just before a new SSL connection is established
1380 (<em>context</em> is <code>connect</code>). This directive can only be used
1381 in the global server context because the PRNG is a global facility.</p>
1382 <p>
1383 The following <em>source</em> variants are available:</p>
1384 <ul>
1385 <li><code>builtin</code>
1386     <p> This is the always available builtin seeding source. It's usage
1387     consumes minimum CPU cycles under runtime and hence can be always used
1388     without drawbacks. The source used for seeding the PRNG contains of the
1389     current time, the current process id and (when applicable) a randomly
1390     choosen 1KB extract of the inter-process scoreboard structure of Apache.
1391     The drawback is that this is not really a strong source and at startup
1392     time (where the scoreboard is still not available) this source just
1393     produces a few bytes of entropy. So you should always, at least for the
1394     startup, use an additional seeding source.</p></li>
1395 <li><code>file:/path/to/source</code>
1396     <p>
1397     This variant uses an external file <code>/path/to/source</code> as the
1398     source for seeding the PRNG. When <em>bytes</em> is specified, only the
1399     first <em>bytes</em> number of bytes of the file form the entropy (and
1400     <em>bytes</em> is given to <code>/path/to/source</code> as the first
1401     argument). When <em>bytes</em> is not specified the whole file forms the
1402     entropy (and <code>0</code> is given to <code>/path/to/source</code> as
1403     the first argument). Use this especially at startup time, for instance
1404     with an available <code>/dev/random</code> and/or
1405     <code>/dev/urandom</code> devices (which usually exist on modern Unix
1406     derivates like FreeBSD and Linux).</p>
1407     <p>
1408     <em>But be careful</em>: Usually <code>/dev/random</code> provides only as
1409     much entropy data as it actually has, i.e. when you request 512 bytes of
1410     entropy, but the device currently has only 100 bytes available two things
1411     can happen: On some platforms you receive only the 100 bytes while on
1412     other platforms the read blocks until enough bytes are available (which
1413     can take a long time). Here using an existing <code>/dev/urandom</code> is
1414     better, because it never blocks and actually gives the amount of requested
1415     data. The drawback is just that the quality of the received data may not
1416     be the best.</p>
1417     <p>
1418     On some platforms like FreeBSD one can even control how the entropy is
1419     actually generated, i.e. by which system interrupts. More details one can
1420     find under <em>rndcontrol(8)</em> on those platforms. Alternatively, when
1421     your system lacks such a random device, you can use tool
1422     like <a href="http://www.lothar.com/tech/crypto/">EGD</a>
1423     (Entropy Gathering Daemon) and run it's client program with the
1424     <code>exec:/path/to/program/</code> variant (see below) or use
1425     <code>egd:/path/to/egd-socket</code> (see below).</p></li>
1426
1427 <li><code>exec:/path/to/program</code>
1428     <p>
1429     This variant uses an external executable
1430     <code>/path/to/program</code> as the source for seeding the
1431     PRNG. When <em>bytes</em> is specified, only the first
1432     <em>bytes</em> number of bytes of its <code>stdout</code> contents
1433     form the entropy. When <em>bytes</em> is not specified, the
1434     entirety of the data produced on <code>stdout</code> form the
1435     entropy. Use this only at startup time when you need a very strong
1436     seeding with the help of an external program (for instance as in
1437     the example above with the <code>truerand</code> utility you can
1438     find in the mod_ssl distribution which is based on the AT&amp;T
1439     <em>truerand</em> library). Using this in the connection context
1440     slows down the server too dramatically, of course.  So usually you
1441     should avoid using external programs in that context.</p></li>
1442 <li><code>egd:/path/to/egd-socket</code> (Unix only)
1443     <p>
1444     This variant uses the Unix domain socket of the
1445     external Entropy Gathering Daemon (EGD) (see <a href="http://www.lothar.com/tech/crypto/">http://www.lothar.com/tech
1446     /crypto/</a>) to seed the PRNG. Use this if no random device exists
1447     on your platform.</p></li>
1448 </ul>
1449 <div class="example"><h3>Example</h3><p><code>
1450 SSLRandomSeed startup builtin<br />
1451 SSLRandomSeed startup file:/dev/random<br />
1452 SSLRandomSeed startup file:/dev/urandom 1024<br />
1453 SSLRandomSeed startup exec:/usr/local/bin/truerand 16<br />
1454 SSLRandomSeed connect builtin<br />
1455 SSLRandomSeed connect file:/dev/random<br />
1456 SSLRandomSeed connect file:/dev/urandom 1024<br />
1457 </code></p></div>
1458
1459 </div>
1460 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1461 <div class="directive-section"><h2><a name="SSLRenegBufferSize" id="SSLRenegBufferSize">SSLRenegBufferSize</a> <a name="sslrenegbuffersize" id="sslrenegbuffersize">Directive</a></h2>
1462 <table class="directive">
1463 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the size for the SSL renegotiation buffer</td></tr>
1464 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRenegBufferSize <var>bytes</var></code></td></tr>
1465 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLRenegBufferSize 131072</code></td></tr>
1466 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
1467 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1468 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1469 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1470 </table>
1471
1472 <p>If an SSL renegotiation is required in per-location context, for
1473 example, any use of <code class="directive"><a href="#sslverifyclient">SSLVerifyClient</a></code> in a Directory or
1474 Location block, then <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> must buffer any HTTP
1475 request body into memory until the new SSL handshake can be performed.
1476 This directive can be used to set the amount of memory that will be
1477 used for this buffer. </p>
1478
1479 <div class="warning"><p>
1480 Note that in many configurations, the client sending the request body
1481 will be untrusted so a denial of service attack by consumption of
1482 memory must be considered when changing this configuration setting.
1483 </p></div>
1484
1485 <div class="example"><h3>Example</h3><p><code>
1486 SSLRenegBufferSize 262144
1487 </code></p></div>
1488
1489 </div>
1490 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1491 <div class="directive-section"><h2><a name="SSLRequire" id="SSLRequire">SSLRequire</a> <a name="sslrequire" id="sslrequire">Directive</a></h2>
1492 <table class="directive">
1493 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow access only when an arbitrarily complex
1494 boolean expression is true</td></tr>
1495 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRequire <em>expression</em></code></td></tr>
1496 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
1497 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1498 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1499 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1500 </table>
1501 <p>
1502 This directive specifies a general access requirement which has to be
1503 fulfilled in order to allow access. It is a very powerful directive because the
1504 requirement specification is an arbitrarily complex boolean expression
1505 containing any number of access checks.</p>
1506 <div class="warning">
1507 <p>The implementation of <code>SSLRequire</code> is not thread safe.
1508    Using <code>SSLRequire</code> inside <code>.htaccess</code> files
1509    on a threaded <a href="../mpm.html">MPM</a> may cause random crashes.
1510 </p>
1511 </div>
1512 <p>
1513 The <em>expression</em> must match the following syntax (given as a BNF
1514 grammar notation):</p>
1515 <blockquote>
1516 <pre>
1517 expr     ::= "<strong>true</strong>" | "<strong>false</strong>"
1518            | "<strong>!</strong>" expr
1519            | expr "<strong>&amp;&amp;</strong>" expr
1520            | expr "<strong>||</strong>" expr
1521            | "<strong>(</strong>" expr "<strong>)</strong>"
1522            | comp
1523
1524 comp     ::= word "<strong>==</strong>" word | word "<strong>eq</strong>" word
1525            | word "<strong>!=</strong>" word | word "<strong>ne</strong>" word
1526            | word "<strong>&lt;</strong>"  word | word "<strong>lt</strong>" word
1527            | word "<strong>&lt;=</strong>" word | word "<strong>le</strong>" word
1528            | word "<strong>&gt;</strong>"  word | word "<strong>gt</strong>" word
1529            | word "<strong>&gt;=</strong>" word | word "<strong>ge</strong>" word
1530            | word "<strong>in</strong>" "<strong>{</strong>" wordlist "<strong>}</strong>"
1531            | word "<strong>in</strong>" "<strong>PeerExtList(</strong>" word "<strong>)</strong>"
1532            | word "<strong>=~</strong>" regex
1533            | word "<strong>!~</strong>" regex
1534
1535 wordlist ::= word
1536            | wordlist "<strong>,</strong>" word
1537
1538 word     ::= digit
1539            | cstring
1540            | variable
1541            | function
1542
1543 digit    ::= [0-9]+
1544 cstring  ::= "..."
1545 variable ::= "<strong>%{</strong>" varname "<strong>}</strong>"
1546 function ::= funcname "<strong>(</strong>" funcargs "<strong>)</strong>"
1547 </pre>
1548 </blockquote>
1549 <p>while for <code>varname</code> any variable from <a href="#table3">Table 3</a> can be used. Finally for
1550 <code>funcname</code> the following functions are available:</p>
1551 <ul>
1552 <li><code>file(</code><em>filename</em><code>)</code>
1553     <p>
1554     This function takes one string argument and expands to the contents of the
1555     file. This is especially useful for matching this contents against a
1556     regular expression, etc.</p>
1557 </li>
1558 </ul>
1559 <p>Notice that <em>expression</em> is first parsed into an internal machine
1560 representation and then evaluated in a second step. Actually, in Global and
1561 Per-Server Class context <em>expression</em> is parsed at startup time and
1562 at runtime only the machine representation is executed. For Per-Directory
1563 context this is different: here <em>expression</em> has to be parsed and
1564 immediately executed for every request.</p>
1565 <div class="example"><h3>Example</h3><p><code>
1566 SSLRequire (    %{SSL_CIPHER} !~ m/^(EXP|NULL)-/ \<br />
1567             and %{SSL_CLIENT_S_DN_O} eq "Snake Oil, Ltd." \<br />
1568             and %{SSL_CLIENT_S_DN_OU} in {"Staff", "CA", "Dev"} \<br />
1569             and %{TIME_WDAY} &gt;= 1 and %{TIME_WDAY} &lt;= 5 \<br />
1570             and %{TIME_HOUR} &gt;= 8 and %{TIME_HOUR} &lt;= 20       ) \<br />
1571            or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/
1572 </code></p></div>
1573 <p>The <code>PeerExtList(<em>object id</em>)</code> function expects to find
1574 zero or more instances of the X.509 Certificate Extension (as identified by
1575 the given <em>object id</em>) in the client certificate, and compares the
1576 left-hand side string against the value of any matching attribute value. Every
1577 extension with the specified object id is checked, until a match is found.
1578 </p>
1579
1580 <p><em>Standard CGI/1.0 and Apache variables:</em></p>
1581 <pre>
1582 HTTP_USER_AGENT        PATH_INFO             AUTH_TYPE
1583 HTTP_REFERER           QUERY_STRING          SERVER_SOFTWARE
1584 HTTP_COOKIE            REMOTE_HOST           API_VERSION
1585 HTTP_FORWARDED         REMOTE_IDENT          TIME_YEAR
1586 HTTP_HOST              IS_SUBREQ             TIME_MON
1587 HTTP_PROXY_CONNECTION  DOCUMENT_ROOT         TIME_DAY
1588 HTTP_ACCEPT            SERVER_ADMIN          TIME_HOUR
1589 HTTP:headername        SERVER_NAME           TIME_MIN
1590 THE_REQUEST            SERVER_PORT           TIME_SEC
1591 REQUEST_METHOD         SERVER_PROTOCOL       TIME_WDAY
1592 REQUEST_SCHEME         REMOTE_ADDR           TIME
1593 REQUEST_URI            REMOTE_USER           ENV:<strong>variablename</strong>
1594 REQUEST_FILENAME
1595 </pre>
1596 <p><em>SSL-related variables:</em></p>
1597 <pre>
1598 HTTPS                  SSL_CLIENT_M_VERSION   SSL_SERVER_M_VERSION
1599                        SSL_CLIENT_M_SERIAL    SSL_SERVER_M_SERIAL
1600 SSL_PROTOCOL           SSL_CLIENT_V_START     SSL_SERVER_V_START
1601 SSL_SESSION_ID         SSL_CLIENT_V_END       SSL_SERVER_V_END
1602 SSL_CIPHER             SSL_CLIENT_S_DN        SSL_SERVER_S_DN
1603 SSL_CIPHER_EXPORT      SSL_CLIENT_S_DN_C      SSL_SERVER_S_DN_C
1604 SSL_CIPHER_ALGKEYSIZE  SSL_CLIENT_S_DN_ST     SSL_SERVER_S_DN_ST
1605 SSL_CIPHER_USEKEYSIZE  SSL_CLIENT_S_DN_L      SSL_SERVER_S_DN_L
1606 SSL_VERSION_LIBRARY    SSL_CLIENT_S_DN_O      SSL_SERVER_S_DN_O
1607 SSL_VERSION_INTERFACE  SSL_CLIENT_S_DN_OU     SSL_SERVER_S_DN_OU
1608                        SSL_CLIENT_S_DN_CN     SSL_SERVER_S_DN_CN
1609                        SSL_CLIENT_S_DN_T      SSL_SERVER_S_DN_T
1610                        SSL_CLIENT_S_DN_I      SSL_SERVER_S_DN_I
1611                        SSL_CLIENT_S_DN_G      SSL_SERVER_S_DN_G
1612                        SSL_CLIENT_S_DN_S      SSL_SERVER_S_DN_S
1613                        SSL_CLIENT_S_DN_D      SSL_SERVER_S_DN_D
1614                        SSL_CLIENT_S_DN_UID    SSL_SERVER_S_DN_UID
1615                        SSL_CLIENT_S_DN_Email  SSL_SERVER_S_DN_Email
1616                        SSL_CLIENT_I_DN        SSL_SERVER_I_DN
1617                        SSL_CLIENT_I_DN_C      SSL_SERVER_I_DN_C
1618                        SSL_CLIENT_I_DN_ST     SSL_SERVER_I_DN_ST
1619                        SSL_CLIENT_I_DN_L      SSL_SERVER_I_DN_L
1620                        SSL_CLIENT_I_DN_O      SSL_SERVER_I_DN_O
1621                        SSL_CLIENT_I_DN_OU     SSL_SERVER_I_DN_OU
1622                        SSL_CLIENT_I_DN_CN     SSL_SERVER_I_DN_CN
1623                        SSL_CLIENT_I_DN_T      SSL_SERVER_I_DN_T
1624                        SSL_CLIENT_I_DN_I      SSL_SERVER_I_DN_I
1625                        SSL_CLIENT_I_DN_G      SSL_SERVER_I_DN_G
1626                        SSL_CLIENT_I_DN_S      SSL_SERVER_I_DN_S
1627                        SSL_CLIENT_I_DN_D      SSL_SERVER_I_DN_D
1628                        SSL_CLIENT_I_DN_UID    SSL_SERVER_I_DN_UID
1629                        SSL_CLIENT_I_DN_Email  SSL_SERVER_I_DN_Email
1630                        SSL_CLIENT_A_SIG       SSL_SERVER_A_SIG
1631                        SSL_CLIENT_A_KEY       SSL_SERVER_A_KEY
1632                        SSL_CLIENT_CERT        SSL_SERVER_CERT
1633                        SSL_CLIENT_CERT_CHAIN_<strong>n</strong>
1634                        SSL_CLIENT_VERIFY
1635 </pre>
1636
1637 </div>
1638 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1639 <div class="directive-section"><h2><a name="SSLRequireSSL" id="SSLRequireSSL">SSLRequireSSL</a> <a name="sslrequiressl" id="sslrequiressl">Directive</a></h2>
1640 <table class="directive">
1641 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Deny access when SSL is not used for the
1642 HTTP request</td></tr>
1643 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRequireSSL</code></td></tr>
1644 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
1645 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1646 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1647 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1648 </table>
1649 <p>
1650 This directive forbids access unless HTTP over SSL (i.e. HTTPS) is enabled for
1651 the current connection. This is very handy inside the SSL-enabled virtual
1652 host or directories for defending against configuration errors that expose
1653 stuff that should be protected. When this directive is present all requests
1654 are denied which are not using SSL.</p>
1655 <div class="example"><h3>Example</h3><p><code>
1656 SSLRequireSSL
1657 </code></p></div>
1658
1659 </div>
1660 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1661 <div class="directive-section"><h2><a name="SSLSessionCache" id="SSLSessionCache">SSLSessionCache</a> <a name="sslsessioncache" id="sslsessioncache">Directive</a></h2>
1662 <table class="directive">
1663 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of the global/inter-process SSL Session
1664 Cache</td></tr>
1665 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionCache <em>type</em></code></td></tr>
1666 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionCache none</code></td></tr>
1667 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1668 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1669 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1670 </table>
1671 <p>
1672 This configures the storage type of the global/inter-process SSL Session
1673 Cache. This cache is an optional facility which speeds up parallel request
1674 processing. For requests to the same server process (via HTTP keep-alive),
1675 OpenSSL already caches the SSL session information locally. But because modern
1676 clients request inlined images and other data via parallel requests (usually
1677 up to four parallel requests are common) those requests are served by
1678 <em>different</em> pre-forked server processes. Here an inter-process cache
1679 helps to avoid unneccessary session handshakes.</p>
1680 <p>
1681 The following four storage <em>type</em>s are currently supported:</p>
1682 <ul>
1683 <li><code>none</code>
1684
1685     <p>This disables the global/inter-process Session Cache.  This
1686     will incur a noticeable speed penalty and may cause problems if
1687     using certain browsers, particularly if client certificates are
1688     enabled.  This setting is not recommended.</p></li>
1689
1690 <li><code>nonenotnull</code>
1691
1692     <p>This disables any global/inter-process Session Cache.  However
1693     it does force OpenSSL to send a non-null session ID to
1694     accommodate buggy clients that require one.</p></li>
1695
1696 <li><code>dbm:/path/to/datafile</code>
1697
1698     <p>This makes use of a DBM hashfile on the local disk to
1699     synchronize the local OpenSSL memory caches of the server
1700     processes.  This session cache may suffer reliability issues under
1701     high load.</p></li>
1702
1703 <li><code>shm:/path/to/datafile</code>[<code>(</code><em>size</em><code>)</code>]
1704
1705     <p>This makes use of a high-performance cyclic buffer
1706     (approx. <em>size</em> bytes in size) inside a shared memory
1707     segment in RAM (established via <code>/path/to/datafile</code>) to
1708     synchronize the local OpenSSL memory caches of the server
1709     processes.  This is the recommended session cache.</p></li>
1710
1711 <li><code>dc:UNIX:/path/to/socket</code>
1712
1713     <p>This makes use of the <a href="http://www.distcache.org/">distcache</a> distributed session
1714     caching libraries.  The argument should specify the location of
1715     the server or proxy to be used using the distcache address syntax;
1716     for example, <code>UNIX:/path/to/socket</code> specifies a UNIX
1717     domain socket (typically a local dc_client proxy);
1718     <code>IP:server.example.com:9001</code> specifies an IP
1719     address.</p></li>
1720
1721 </ul>
1722 <div class="example"><h3>Examples</h3><p><code>
1723 SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data<br />
1724 SSLSessionCache shm:/usr/local/apache/logs/ssl_gcache_data(512000)
1725 </code></p></div>
1726
1727 </div>
1728 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1729 <div class="directive-section"><h2><a name="SSLSessionCacheTimeout" id="SSLSessionCacheTimeout">SSLSessionCacheTimeout</a> <a name="sslsessioncachetimeout" id="sslsessioncachetimeout">Directive</a></h2>
1730 <table class="directive">
1731 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of seconds before an SSL session expires
1732 in the Session Cache</td></tr>
1733 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionCacheTimeout <em>seconds</em></code></td></tr>
1734 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionCacheTimeout 300</code></td></tr>
1735 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1736 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1737 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1738 </table>
1739 <p>
1740 This directive sets the timeout in seconds for the information stored in the
1741 global/inter-process SSL Session Cache and the OpenSSL internal memory cache.
1742 It can be set as low as 15 for testing, but should be set to higher
1743 values like 300 in real life.</p>
1744 <div class="example"><h3>Example</h3><p><code>
1745 SSLSessionCacheTimeout 600
1746 </code></p></div>
1747
1748 </div>
1749 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1750 <div class="directive-section"><h2><a name="SSLUserName" id="SSLUserName">SSLUserName</a> <a name="sslusername" id="sslusername">Directive</a></h2>
1751 <table class="directive">
1752 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Variable name to determine user name</td></tr>
1753 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLUserName <em>varname</em></code></td></tr>
1754 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, directory, .htaccess</td></tr>
1755 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1756 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1757 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1758 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.51 and later</td></tr>
1759 </table>
1760 <p>
1761 This directive sets the "user" field in the Apache request object.
1762 This is used by lower modules to identify the user with a character
1763 string. In particular, this may cause the environment variable
1764 <code>REMOTE_USER</code> to be set.  The <em>varname</em> can be
1765 any of the <a href="#envvars">SSL environment variables</a>.</p>
1766
1767 <p>Note that this directive has no effect if the
1768 <code>FakeBasic</code> option is used (see <a href="#ssloptions">SSLOptions</a>).</p>
1769
1770 <div class="example"><h3>Example</h3><p><code>
1771 SSLUserName SSL_CLIENT_S_DN_CN
1772 </code></p></div>
1773
1774 </div>
1775 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1776 <div class="directive-section"><h2><a name="SSLVerifyClient" id="SSLVerifyClient">SSLVerifyClient</a> <a name="sslverifyclient" id="sslverifyclient">Directive</a></h2>
1777 <table class="directive">
1778 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of Client Certificate verification</td></tr>
1779 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLVerifyClient <em>level</em></code></td></tr>
1780 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLVerifyClient none</code></td></tr>
1781 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1782 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1783 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1784 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1785 </table>
1786 <p>
1787 This directive sets the Certificate verification level for the Client
1788 Authentication. Notice that this directive can be used both in per-server and
1789 per-directory context. In per-server context it applies to the client
1790 authentication process used in the standard SSL handshake when a connection is
1791 established. In per-directory context it forces a SSL renegotation with the
1792 reconfigured client verification level after the HTTP request was read but
1793 before the HTTP response is sent.</p>
1794 <p>
1795 The following levels are available for <em>level</em>:</p>
1796 <ul>
1797 <li><strong>none</strong>:
1798      no client Certificate is required at all</li>
1799 <li><strong>optional</strong>:
1800      the client <em>may</em> present a valid Certificate</li>
1801 <li><strong>require</strong>:
1802      the client <em>has to</em> present a valid Certificate</li>
1803 <li><strong>optional_no_ca</strong>:
1804      the client may present a valid Certificate<br />
1805      but it need not to be (successfully) verifiable.</li>
1806 </ul>
1807 <p>In practice only levels <strong>none</strong> and
1808 <strong>require</strong> are really interesting, because level
1809 <strong>optional</strong> doesn't work with all browsers and level
1810 <strong>optional_no_ca</strong> is actually against the idea of
1811 authentication (but can be used to establish SSL test pages, etc.)</p>
1812 <div class="example"><h3>Example</h3><p><code>
1813 SSLVerifyClient require
1814 </code></p></div>
1815
1816 </div>
1817 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1818 <div class="directive-section"><h2><a name="SSLVerifyDepth" id="SSLVerifyDepth">SSLVerifyDepth</a> <a name="sslverifydepth" id="sslverifydepth">Directive</a></h2>
1819 <table class="directive">
1820 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum depth of CA Certificates in Client
1821 Certificate verification</td></tr>
1822 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLVerifyDepth <em>number</em></code></td></tr>
1823 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLVerifyDepth 1</code></td></tr>
1824 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1825 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1826 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1827 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1828 </table>
1829 <p>
1830 This directive sets how deeply mod_ssl should verify before deciding that the
1831 clients don't have a valid certificate. Notice that this directive can be
1832 used both in per-server and per-directory context. In per-server context it
1833 applies to the client authentication process used in the standard SSL
1834 handshake when a connection is established. In per-directory context it forces
1835 a SSL renegotation with the reconfigured client verification depth after the
1836 HTTP request was read but before the HTTP response is sent.</p>
1837 <p>
1838 The depth actually is the maximum number of intermediate certificate issuers,
1839 i.e. the number of CA certificates which are max allowed to be followed while
1840 verifying the client certificate. A depth of 0 means that self-signed client
1841 certificates are accepted only, the default depth of 1 means the client
1842 certificate can be self-signed or has to be signed by a CA which is directly
1843 known to the server (i.e. the CA's certificate is under
1844 <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code>), etc.</p>
1845 <div class="example"><h3>Example</h3><p><code>
1846 SSLVerifyDepth 10
1847 </code></p></div>
1848
1849 </div>
1850 </div>
1851 <div class="bottomlang">
1852 <p><span>Available Languages: </span><a href="../en/mod/mod_ssl.html" title="English">&nbsp;en&nbsp;</a></p>
1853 </div><div id="footer">
1854 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
1855 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
1856 </body></html>