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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_ssl - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_ssl</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_ssl.html" title="English">&nbsp;en&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Strong cryptography using the Secure Sockets
  32 Layer (SSL) and Transport Layer Security (TLS) protocols</td></tr>
  33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>ssl_module</td></tr>
  35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_ssl.c</td></tr></table>
  36 <h3>Summary</h3>
  37
  38 <p>This module provides SSL v3 and TLS v1.x support for the Apache
  39 HTTP Server. SSL v2 is no longer supported.</p>
  40
  41 <p>This module relies on <a href="http://www.openssl.org/">OpenSSL</a>
  42 to provide the cryptography engine.</p>
  43
  44 <p>Further details, discussion, and examples are provided in the
  45 <a href="../ssl/">SSL documentation</a>.</p>
  46 </div>
  47 <div id="quickview"><h3>Topics</h3>
  48 <ul id="topics">
  49 <li><img alt="" src="../images/down.gif" /> <a href="#envvars">Environment Variables</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#logformats">Custom Log Formats</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#notes">Request Notes</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#expressionparser">Expression Parser Extension</a></li>
  53 <li><img alt="" src="../images/down.gif" /> <a href="#authzproviders">Authorization providers for use with Require</a></li>
  54 </ul><h3 class="directives">Directives</h3>
  55 <ul id="toc">
  56 <li><img alt="" src="../images/down.gif" /> <a href="#sslcacertificatefile">SSLCACertificateFile</a></li>
  57 <li><img alt="" src="../images/down.gif" /> <a href="#sslcacertificatepath">SSLCACertificatePath</a></li>
  58 <li><img alt="" src="../images/down.gif" /> <a href="#sslcadnrequestfile">SSLCADNRequestFile</a></li>
  59 <li><img alt="" src="../images/down.gif" /> <a href="#sslcadnrequestpath">SSLCADNRequestPath</a></li>
  60 <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationcheck">SSLCARevocationCheck</a></li>
  61 <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationfile">SSLCARevocationFile</a></li>
  62 <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationpath">SSLCARevocationPath</a></li>
  63 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatechainfile">SSLCertificateChainFile</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatefile">SSLCertificateFile</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#sslciphersuite">SSLCipherSuite</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#sslcompression">SSLCompression</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#sslcryptodevice">SSLCryptoDevice</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#sslengine">SSLEngine</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#sslfips">SSLFIPS</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#sslhonorcipherorder">SSLHonorCipherOrder</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#sslinsecurerenegotiation">SSLInsecureRenegotiation</a></li>
  73 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspdefaultresponder">SSLOCSPDefaultResponder</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspenable">SSLOCSPEnable</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspproxyurl">SSLOCSPProxyURL</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#sslocsprespondertimeout">SSLOCSPResponderTimeout</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspresponsemaxage">SSLOCSPResponseMaxAge</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspresponsetimeskew">SSLOCSPResponseTimeSkew</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspuserequestnonce">SSLOCSPUseRequestNonce</a></li>
  81 <li><img alt="" src="../images/down.gif" /> <a href="#sslopensslconfcmd">SSLOpenSSLConfCmd</a></li>
  82 <li><img alt="" src="../images/down.gif" /> <a href="#ssloptions">SSLOptions</a></li>
  83 <li><img alt="" src="../images/down.gif" /> <a href="#sslpassphrasedialog">SSLPassPhraseDialog</a></li>
  84 <li><img alt="" src="../images/down.gif" /> <a href="#sslprotocol">SSLProtocol</a></li>
  85 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycacertificatefile">SSLProxyCACertificateFile</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></li>
  87 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationcheck">SSLProxyCARevocationCheck</a></li>
  88 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationfile">SSLProxyCARevocationFile</a></li>
  89 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></li>
  90 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycheckpeercn">SSLProxyCheckPeerCN</a></li>
  91 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycheckpeerexpire">SSLProxyCheckPeerExpire</a></li>
  92 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycheckpeername">SSLProxyCheckPeerName</a></li>
  93 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyciphersuite">SSLProxyCipherSuite</a></li>
  94 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyengine">SSLProxyEngine</a></li>
  95 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatechainfile">SSLProxyMachineCertificateChainFile</a></li>
  96 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatefile">SSLProxyMachineCertificateFile</a></li>
  97 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatepath">SSLProxyMachineCertificatePath</a></li>
  98 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyprotocol">SSLProxyProtocol</a></li>
  99 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyverify">SSLProxyVerify</a></li>
 100 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyverifydepth">SSLProxyVerifyDepth</a></li>
 101 <li><img alt="" src="../images/down.gif" /> <a href="#sslrandomseed">SSLRandomSeed</a></li>
 102 <li><img alt="" src="../images/down.gif" /> <a href="#sslrenegbuffersize">SSLRenegBufferSize</a></li>
 103 <li><img alt="" src="../images/down.gif" /> <a href="#sslrequire">SSLRequire</a></li>
 104 <li><img alt="" src="../images/down.gif" /> <a href="#sslrequiressl">SSLRequireSSL</a></li>
 105 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessioncache">SSLSessionCache</a></li>
 106 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessioncachetimeout">SSLSessionCacheTimeout</a></li>
 107 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessionticketkeyfile">SSLSessionTicketKeyFile</a></li>
 108 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessiontickets">SSLSessionTickets</a></li>
 109 <li><img alt="" src="../images/down.gif" /> <a href="#sslsrpunknownuserseed">SSLSRPUnknownUserSeed</a></li>
 110 <li><img alt="" src="../images/down.gif" /> <a href="#sslsrpverifierfile">SSLSRPVerifierFile</a></li>
 111 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingcache">SSLStaplingCache</a></li>
 112 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingerrorcachetimeout">SSLStaplingErrorCacheTimeout</a></li>
 113 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingfaketrylater">SSLStaplingFakeTryLater</a></li>
 114 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingforceurl">SSLStaplingForceURL</a></li>
 115 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingrespondertimeout">SSLStaplingResponderTimeout</a></li>
 116 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingresponsemaxage">SSLStaplingResponseMaxAge</a></li>
 117 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingresponsetimeskew">SSLStaplingResponseTimeSkew</a></li>
 118 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingreturnrespondererrors">SSLStaplingReturnResponderErrors</a></li>
 119 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingstandardcachetimeout">SSLStaplingStandardCacheTimeout</a></li>
 120 <li><img alt="" src="../images/down.gif" /> <a href="#sslstrictsnivhostcheck">SSLStrictSNIVHostCheck</a></li>
 121 <li><img alt="" src="../images/down.gif" /> <a href="#sslusername">SSLUserName</a></li>
 122 <li><img alt="" src="../images/down.gif" /> <a href="#sslusestapling">SSLUseStapling</a></li>
 123 <li><img alt="" src="../images/down.gif" /> <a href="#sslverifyclient">SSLVerifyClient</a></li>
 124 <li><img alt="" src="../images/down.gif" /> <a href="#sslverifydepth">SSLVerifyDepth</a></li>
 125 </ul>
 126 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_ssl">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_ssl">Report a bug</a></li></ul><h3>See also</h3>
 127 <ul class="seealso">
 128 <li><a href="#comments_section">Comments</a></li></ul></div>
 129 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 130 <div class="section">
 131 <h2><a name="envvars" id="envvars">Environment Variables</a></h2>
 132
 133 <p>This module can be configured to provide several items of SSL information
 134 as additional environment variables to the SSI and CGI namespace. This
 135 information is not provided by default for performance reasons. (See
 136 <code class="directive">SSLOptions</code> StdEnvVars, below.) The generated variables
 137 are listed in the table below. For backward compatibility the information can
 138 be made available under different names, too. Look in the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter for details on the
 139 compatibility variables.</p>
 140
 141 <table class="bordered">
 142
 143 <tr>
 144  <th><a name="table3">Variable Name:</a></th>
 145  <th>Value Type:</th>
 146  <th>Description:</th>
 147 </tr>
 148 <tr><td><code>HTTPS</code></td>                         <td>flag</td>      <td>HTTPS is being used.</td></tr>
 149 <tr><td><code>SSL_PROTOCOL</code></td>                  <td>string</td>    <td>The SSL protocol version (SSLv3, TLSv1, TLSv1.1, TLSv1.2)</td></tr>
 150 <tr><td><code>SSL_SESSION_ID</code></td>                <td>string</td>    <td>The hex-encoded SSL session id</td></tr>
 151 <tr><td><code>SSL_SESSION_RESUMED</code></td>           <td>string</td>    <td>Initial or Resumed SSL Session.  Note: multiple requests may be served over the same (Initial or Resumed) SSL session if HTTP KeepAlive is in use</td></tr>
 152 <tr><td><code>SSL_SECURE_RENEG</code></td>              <td>string</td>    <td><code>true</code> if secure renegotiation is supported, else <code>false</code></td></tr>
 153 <tr><td><code>SSL_CIPHER</code></td>                    <td>string</td>    <td>The cipher specification name</td></tr>
 154 <tr><td><code>SSL_CIPHER_EXPORT</code></td>             <td>string</td>    <td><code>true</code> if cipher is an export cipher</td></tr>
 155 <tr><td><code>SSL_CIPHER_USEKEYSIZE</code></td>         <td>number</td>    <td>Number of cipher bits (actually used)</td></tr>
 156 <tr><td><code>SSL_CIPHER_ALGKEYSIZE</code></td>         <td>number</td>    <td>Number of cipher bits (possible)</td></tr>
 157 <tr><td><code>SSL_COMPRESS_METHOD</code></td>           <td>string</td>    <td>SSL compression method negotiated</td></tr>
 158 <tr><td><code>SSL_VERSION_INTERFACE</code></td>         <td>string</td>    <td>The mod_ssl program version</td></tr>
 159 <tr><td><code>SSL_VERSION_LIBRARY</code></td>           <td>string</td>    <td>The OpenSSL program version</td></tr>
 160 <tr><td><code>SSL_CLIENT_M_VERSION</code></td>          <td>string</td>    <td>The version of the client certificate</td></tr>
 161 <tr><td><code>SSL_CLIENT_M_SERIAL</code></td>           <td>string</td>    <td>The serial of the client certificate</td></tr>
 162 <tr><td><code>SSL_CLIENT_S_DN</code></td>               <td>string</td>    <td>Subject DN in client's certificate</td></tr>
 163 <tr><td><code>SSL_CLIENT_S_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of client's Subject DN</td></tr>
 164 <tr><td><code>SSL_CLIENT_SAN_Email_</code><em>n</em></td> <td>string</td>  <td>Client certificate's subjectAltName extension entries of type rfc822Name</td></tr>
 165 <tr><td><code>SSL_CLIENT_SAN_DNS_</code><em>n</em></td> <td>string</td>    <td>Client certificate's subjectAltName extension entries of type dNSName</td></tr>
 166 <tr><td><code>SSL_CLIENT_SAN_OTHER_msUPN_</code><em>n</em></td> <td>string</td>    <td>Client certificate's subjectAltName extension entries of type otherName, Microsoft User Principal Name form (OID 1.3.6.1.4.1.311.20.2.3)</td></tr>
 167 <tr><td><code>SSL_CLIENT_I_DN</code></td>               <td>string</td>    <td>Issuer DN of client's certificate</td></tr>
 168 <tr><td><code>SSL_CLIENT_I_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of client's Issuer DN</td></tr>
 169 <tr><td><code>SSL_CLIENT_V_START</code></td>            <td>string</td>    <td>Validity of client's certificate (start time)</td></tr>
 170 <tr><td><code>SSL_CLIENT_V_END</code></td>              <td>string</td>    <td>Validity of client's certificate (end time)</td></tr>
 171 <tr><td><code>SSL_CLIENT_V_REMAIN</code></td>           <td>string</td>    <td>Number of days until client's certificate expires</td></tr>
 172 <tr><td><code>SSL_CLIENT_A_SIG</code></td>              <td>string</td>    <td>Algorithm used for the signature of client's certificate</td></tr>
 173 <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>
 174 <tr><td><code>SSL_CLIENT_CERT</code></td>               <td>string</td>    <td>PEM-encoded client certificate</td></tr>
 175 <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>
 176 <tr><td><code>SSL_CLIENT_CERT_RFC4523_CEA</code></td>   <td>string</td>    <td>Serial number and issuer of the certificate. The format matches that of the CertificateExactAssertion in RFC4523</td></tr>
 177 <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>
 178 <tr><td><code>SSL_SERVER_M_VERSION</code></td>          <td>string</td>    <td>The version of the server certificate</td></tr>
 179 <tr><td><code>SSL_SERVER_M_SERIAL</code></td>           <td>string</td>    <td>The serial of the server certificate</td></tr>
 180 <tr><td><code>SSL_SERVER_S_DN</code></td>               <td>string</td>    <td>Subject DN in server's certificate</td></tr>
 181 <tr><td><code>SSL_SERVER_SAN_Email_</code><em>n</em></td> <td>string</td>  <td>Server certificate's subjectAltName extension entries of type rfc822Name</td></tr>
 182 <tr><td><code>SSL_SERVER_SAN_DNS_</code><em>n</em></td> <td>string</td>    <td>Server certificate's subjectAltName extension entries of type dNSName</td></tr>
 183 <tr><td><code>SSL_SERVER_SAN_OTHER_dnsSRV_</code><em>n</em></td> <td>string</td>    <td>Server certificate's subjectAltName extension entries of type otherName, SRVName form (OID 1.3.6.1.5.5.7.8.7, RFC 4985)</td></tr>
 184 <tr><td><code>SSL_SERVER_S_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of server's Subject DN</td></tr>
 185 <tr><td><code>SSL_SERVER_I_DN</code></td>               <td>string</td>    <td>Issuer DN of server's certificate</td></tr>
 186 <tr><td><code>SSL_SERVER_I_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of server's Issuer DN</td></tr>
 187 <tr><td><code>SSL_SERVER_V_START</code></td>            <td>string</td>    <td>Validity of server's certificate (start time)</td></tr>
 188 <tr><td><code>SSL_SERVER_V_END</code></td>              <td>string</td>    <td>Validity of server's certificate (end time)</td></tr>
 189 <tr><td><code>SSL_SERVER_A_SIG</code></td>              <td>string</td>    <td>Algorithm used for the signature of server's certificate</td></tr>
 190 <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>
 191 <tr><td><code>SSL_SERVER_CERT</code></td>               <td>string</td>    <td>PEM-encoded server certificate</td></tr>
 192 <tr><td><code>SSL_SRP_USER</code></td>                  <td>string</td>    <td>SRP username</td></tr>
 193 <tr><td><code>SSL_SRP_USERINFO</code></td>              <td>string</td>    <td>SRP user info</td></tr>
 194 <tr><td><code>SSL_TLS_SNI</code></td>                   <td>string</td>    <td>Contents of the SNI TLS extension (if supplied with ClientHello)</td></tr>
 195 </table>
 196
 197 <p><em>x509</em> specifies a component of an X.509 DN; one of
 198 <code>C,ST,L,O,OU,CN,T,I,G,S,D,UID,Email</code>.  In Apache 2.1 and
 199 later, <em>x509</em> may also include a numeric <code>_n</code>
 200 suffix.  If the DN in question contains multiple attributes of the
 201 same name, this suffix is used as a zero-based index to select a
 202 particular attribute.  For example, where the server certificate
 203 subject DN included two OU attributes, <code>SSL_SERVER_S_DN_OU_0</code>
 204 and
 205 <code>SSL_SERVER_S_DN_OU_1</code> could be used to reference each.  A
 206 variable name without a <code>_n</code> suffix is equivalent to that
 207 name with a <code>_0</code> suffix; the first (or only) attribute.
 208 When the environment table is populated using
 209 the <code>StdEnvVars</code> option of
 210 the <code class="directive"><a href="#ssloptions">SSLOptions</a></code> directive, the
 211 first (or only) attribute of any DN is added only under a non-suffixed
 212 name; i.e. no <code>_0</code> suffixed entries are added.</p>
 213
 214 <p>The format of the <em>*_DN</em> variables has changed in Apache HTTPD
 215 2.3.11. See the <code>LegacyDNStringFormat</code> option for
 216 <code class="directive"><a href="#ssloptions">SSLOptions</a></code> for details.</p>
 217
 218 <p><code>SSL_CLIENT_V_REMAIN</code> is only available in version 2.1
 219 and later.</p>
 220
 221 <p>A number of additional environment variables can also be used
 222 in <code class="directive">SSLRequire</code> expressions, or in custom log
 223 formats:</p>
 224
 225 <div class="note"><pre>HTTP_USER_AGENT        PATH_INFO             AUTH_TYPE
 226 HTTP_REFERER           QUERY_STRING          SERVER_SOFTWARE
 227 HTTP_COOKIE            REMOTE_HOST           API_VERSION
 228 HTTP_FORWARDED         REMOTE_IDENT          TIME_YEAR
 229 HTTP_HOST              IS_SUBREQ             TIME_MON
 230 HTTP_PROXY_CONNECTION  DOCUMENT_ROOT         TIME_DAY
 231 HTTP_ACCEPT            SERVER_ADMIN          TIME_HOUR
 232 THE_REQUEST            SERVER_NAME           TIME_MIN
 233 REQUEST_FILENAME       SERVER_PORT           TIME_SEC
 234 REQUEST_METHOD         SERVER_PROTOCOL       TIME_WDAY
 235 REQUEST_SCHEME         REMOTE_ADDR           TIME
 236 REQUEST_URI            REMOTE_USER</pre></div>
 237
 238 <p>In these contexts, two special formats can also be used:</p>
 239
 240 <dl>
 241   <dt><code>ENV:<em>variablename</em></code></dt>
 242   <dd>This will expand to the standard environment
 243   variable <em>variablename</em>.</dd>
 244
 245   <dt><code>HTTP:<em>headername</em></code></dt>
 246   <dd>This will expand to the value of the request header with name
 247   <em>headername</em>.</dd>
 248 </dl>
 249
 250 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 251 <div class="section">
 252 <h2><a name="logformats" id="logformats">Custom Log Formats</a></h2>
 253
 254 <p>When <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is built into Apache or at least
 255 loaded (under DSO situation) additional functions exist for the <a href="mod_log_config.html#formats">Custom Log Format</a> of
 256 <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code>. First there is an
 257 additional ``<code>%{</code><em>varname</em><code>}x</code>''
 258 eXtension format function which can be used to expand any variables
 259 provided by any module, especially those provided by mod_ssl which can
 260 you find in the above table.</p>
 261 <p>
 262 For backward compatibility there is additionally a special
 263 ``<code>%{</code><em>name</em><code>}c</code>'' cryptography format function
 264 provided. Information about this function is provided in the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter.</p>
 265 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">CustomLog "logs/ssl_request_log" "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"</pre>
 266 </div>
 267 <p>These formats even work without setting the <code>StdEnvVars</code>
 268 option of the <code class="directive"><a href="#ssloptions">SSLOptions</a></code>
 269 directive.</p>
 270 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 271 <div class="section">
 272 <h2><a name="notes" id="notes">Request Notes</a></h2>
 273
 274 <p><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> sets "notes" for the request which can be
 275 used in logging with the <code>%{<em>name</em>}n</code> format
 276 string in <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code>.</p>
 277
 278 <p>The notes supported are as follows:</p>
 279
 280 <dl>
 281   <dt><code>ssl-access-forbidden</code></dt>
 282   <dd>This note is set to the value <code>1</code> if access was
 283   denied due to an <code class="directive">SSLRequire</code>
 284   or <code class="directive">SSLRequireSSL</code> directive.</dd>
 285
 286   <dt><code>ssl-secure-reneg</code></dt>
 287   <dd>If <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is built against a version of
 288   OpenSSL which supports the secure renegotiation extension, this note
 289   is set to the value <code>1</code> if SSL is in used for the current
 290   connection, and the client also supports the secure renegotiation
 291   extension.  If the client does not support the secure renegotiation
 292   extension, the note is set to the value <code>0</code>.
 293   If <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is not built against a version of
 294   OpenSSL which supports secure renegotiation, or if SSL is not in use
 295   for the current connection, the note is not set.</dd>
 296 </dl>
 297
 298 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 299 <div class="section">
 300 <h2><a name="expressionparser" id="expressionparser">Expression Parser Extension</a></h2>
 301
 302 <p>When <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is built into Apache or at least
 303 loaded (under DSO situation) any <a name="envvars">variables</a>
 304 provided by <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> can be used in expressions
 305 for the <a href="../expr.html">ap_expr Expression Parser</a>.
 306 The variables can be referenced using the syntax
 307 ``<code>%{</code><em>varname</em><code>}</code>''. Starting
 308 with version 2.4.18 one can also use the
 309 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> style syntax
 310 ``<code>%{SSL:</code><em>varname</em><code>}</code>'' or
 311 the function style syntax
 312 ``<code>ssl(</code><em>varname</em><code>)</code>''.</p>
 313 <div class="example"><h3>Example (using <code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code>)</h3><pre class="prettyprint lang-config">Header set X-SSL-PROTOCOL "expr=%{SSL_PROTOCOL}"
 314 Header set X-SSL-CIPHER "expr=%{SSL:SSL_CIPHER}"</pre>
 315 </div>
 316 <p>This feature even works without setting the <code>StdEnvVars</code>
 317 option of the <code class="directive"><a href="#ssloptions">SSLOptions</a></code>
 318 directive.</p>
 319 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 320 <div class="section">
 321 <h2><a name="authzproviders" id="authzproviders">Authorization providers for use with Require</a></h2>
 322
 323   <p><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> provides a few authentication providers for use
 324   with <code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code>'s
 325   <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directive.</p>
 326
 327   <h3><a name="reqssl" id="reqssl">Require ssl</a></h3>
 328
 329     <p>The <code>ssl</code> provider denies access if a connection is not
 330        encrypted with SSL. This is similar to the
 331        <code class="directive">SSLRequireSSL</code> directive.</p>
 332
 333     <pre class="prettyprint lang-config">Require ssl</pre>
 334
 335
 336
 337
 338   <h3><a name="reqverifyclient" id="reqverifyclient">Require ssl-verify-client</a></h3>
 339
 340     <p>The <code>ssl</code> provider allows access if the user is
 341        authenticated with a valid client certificate. This is only
 342        useful if <code>SSLVerifyClient optional</code> is in effect.</p>
 343
 344     <p>The following example grants access if the user is authenticated
 345        either with a client certificate or by username and password.</p>
 346
 347     <pre class="prettyprint lang-config">      Require ssl-verify-client<br />
 348       Require valid-user</pre>
 349
 350
 351
 352
 353 </div>
 354 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 355 <div class="directive-section"><h2><a name="SSLCACertificateFile" id="SSLCACertificateFile">SSLCACertificateFile</a> <a name="sslcacertificatefile" id="sslcacertificatefile">Directive</a></h2>
 356 <table class="directive">
 357 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
 358 for Client Auth</td></tr>
 359 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCACertificateFile <em>file-path</em></code></td></tr>
 360 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 361 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 362 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 363 </table>
 364 <p>
 365 This directive sets the <em>all-in-one</em> file where you can assemble the
 366 Certificates of Certification Authorities (CA) whose <em>clients</em> you deal
 367 with. These are used for Client Authentication. Such a file is simply the
 368 concatenation of the various PEM-encoded Certificate files, in order of
 369 preference. This can be used alternatively and/or additionally to
 370 <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code>.</p>
 371 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-client.crt</pre>
 372 </div>
 373
 374 </div>
 375 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 376 <div class="directive-section"><h2><a name="SSLCACertificatePath" id="SSLCACertificatePath">SSLCACertificatePath</a> <a name="sslcacertificatepath" id="sslcacertificatepath">Directive</a></h2>
 377 <table class="directive">
 378 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
 379 Client Auth</td></tr>
 380 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCACertificatePath <em>directory-path</em></code></td></tr>
 381 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 382 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 383 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 384 </table>
 385 <p>
 386 This directive sets the directory where you keep the Certificates of
 387 Certification Authorities (CAs) whose clients you deal with. These are used to
 388 verify the client certificate on Client Authentication.</p>
 389 <p>
 390 The files in this directory have to be PEM-encoded and are accessed through
 391 hash filenames. So usually you can't just place the Certificate files
 392 there: you also have to create symbolic links named
 393 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
 394 contains the appropriate symbolic links.</p>
 395 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCACertificatePath /usr/local/apache2/conf/ssl.crt/</pre>
 396 </div>
 397
 398 </div>
 399 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 400 <div class="directive-section"><h2><a name="SSLCADNRequestFile" id="SSLCADNRequestFile">SSLCADNRequestFile</a> <a name="sslcadnrequestfile" id="sslcadnrequestfile">Directive</a></h2>
 401 <table class="directive">
 402 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
 403 for defining acceptable CA names</td></tr>
 404 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCADNRequestFile <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>When a client certificate is requested by mod_ssl, a list of
 410 <em>acceptable Certificate Authority names</em> is sent to the client
 411 in the SSL handshake.  These CA names can be used by the client to
 412 select an appropriate client certificate out of those it has
 413 available.</p>
 414
 415 <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
 416 set of acceptable CA names sent to the client is the names of all the
 417 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
 418 words, the names of the CAs which will actually be used to verify the
 419 client certificate.</p>
 420
 421 <p>In some circumstances, it is useful to be able to send a set of
 422 acceptable CA names which differs from the actual CAs used to verify
 423 the client certificate - for example, if the client certificates are
 424 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
 425 acceptable CA names are then taken from the complete set of
 426 certificates in the directory and/or file specified by this pair of
 427 directives.</p>
 428
 429 <p><code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> must
 430 specify an <em>all-in-one</em> file containing a concatenation of
 431 PEM-encoded CA certificates.</p>
 432
 433 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCADNRequestFile /usr/local/apache2/conf/ca-names.crt</pre>
 434 </div>
 435
 436 </div>
 437 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 438 <div class="directive-section"><h2><a name="SSLCADNRequestPath" id="SSLCADNRequestPath">SSLCADNRequestPath</a> <a name="sslcadnrequestpath" id="sslcadnrequestpath">Directive</a></h2>
 439 <table class="directive">
 440 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
 441 defining acceptable CA names</td></tr>
 442 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCADNRequestPath <em>directory-path</em></code></td></tr>
 443 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 444 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 445 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 446 </table>
 447
 448 <p>This optional directive can be used to specify the set of
 449 <em>acceptable CA names</em> which will be sent to the client when a
 450 client certificate is requested.  See the <code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> directive for more
 451 details.</p>
 452
 453 <p>The files in this directory have to be PEM-encoded and are accessed
 454 through hash filenames. So usually you can't just place the
 455 Certificate files there: you also have to create symbolic links named
 456 <em>hash-value</em><code>.N</code>. And you should always make sure
 457 this directory contains the appropriate symbolic links.</p>
 458 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCADNRequestPath /usr/local/apache2/conf/ca-names.crt/</pre>
 459 </div>
 460
 461 </div>
 462 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 463 <div class="directive-section"><h2><a name="SSLCARevocationCheck" id="SSLCARevocationCheck">SSLCARevocationCheck</a> <a name="sslcarevocationcheck" id="sslcarevocationcheck">Directive</a></h2>
 464 <table class="directive">
 465 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable CRL-based revocation checking</td></tr>
 466 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationCheck chain|leaf|none <em>flag</em>s</code></td></tr>
 467 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCARevocationCheck none</code></td></tr>
 468 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 469 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 470 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 471 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Optional <em>flag</em>s available in httpd 2.5-dev or
 472 later</td></tr>
 473 </table>
 474 <p>
 475 Enables certificate revocation list (CRL) checking. At least one of
 476 <code class="directive"><a href="#sslcarevocationfile">SSLCARevocationFile</a></code>
 477 or <code class="directive"><a href="#sslcarevocationpath">SSLCARevocationPath</a></code> must be
 478 configured. When set to <code>chain</code> (recommended setting),
 479 CRL checks are applied to all certificates in the chain, while setting it to
 480 <code>leaf</code> limits the checks to the end-entity cert.
 481 </p>
 482 <p>The available <em>flag</em>s are:</p>
 483 <ul>
 484 <li><code>no_crl_for_cert_ok</code>
 485     <p>
 486     Prior to version 2.3.15, CRL checking in mod_ssl also succeeded when
 487     no CRL(s) for the checked certificate(s) were found in any of the locations
 488     configured with <code class="directive"><a href="#sslcarevocationfile">SSLCARevocationFile</a></code>
 489     or <code class="directive"><a href="#sslcarevocationpath">SSLCARevocationPath</a></code>.
 490     </p>
 491     <p>
 492     With the introduction of <code class="directive">SSLCARevocationFile</code>,
 493     the behavior has been changed: by default with <code>chain</code> or
 494     <code>leaf</code>, CRLs <strong>must</strong> be present for the
 495     validation to succeed - otherwise it will fail with an
 496     <code>"unable to get certificate CRL"</code> error.
 497     </p>
 498     <p>
 499     The <em>flag</em> <code>no_crl_for_cert_ok</code> allows to restore
 500     previous behaviour.
 501     </p>
 502 </li>
 503 </ul>
 504 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCARevocationCheck chain</pre>
 505 </div>
 506 <div class="example"><h3>Compatibility with versions 2.2</h3><pre class="prettyprint lang-config">SSLCARevocationCheck chain no_crl_for_cert_ok</pre>
 507 </div>
 508
 509 </div>
 510 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 511 <div class="directive-section"><h2><a name="SSLCARevocationFile" id="SSLCARevocationFile">SSLCARevocationFile</a> <a name="sslcarevocationfile" id="sslcarevocationfile">Directive</a></h2>
 512 <table class="directive">
 513 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA CRLs for
 514 Client Auth</td></tr>
 515 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationFile <em>file-path</em></code></td></tr>
 516 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 517 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 518 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 519 </table>
 520 <p>
 521 This directive sets the <em>all-in-one</em> file where you can
 522 assemble the Certificate Revocation Lists (CRL) of Certification
 523 Authorities (CA) whose <em>clients</em> you deal with. These are used
 524 for Client Authentication.  Such a file is simply the concatenation of
 525 the various PEM-encoded CRL files, in order of preference. This can be
 526 used alternatively and/or additionally to <code class="directive"><a href="#sslcarevocationpath">SSLCARevocationPath</a></code>.</p>
 527 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-client.crl</pre>
 528 </div>
 529
 530 </div>
 531 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 532 <div class="directive-section"><h2><a name="SSLCARevocationPath" id="SSLCARevocationPath">SSLCARevocationPath</a> <a name="sslcarevocationpath" id="sslcarevocationpath">Directive</a></h2>
 533 <table class="directive">
 534 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA CRLs for
 535 Client Auth</td></tr>
 536 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationPath <em>directory-path</em></code></td></tr>
 537 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 538 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 539 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 540 </table>
 541 <p>
 542 This directive sets the directory where you keep the Certificate Revocation
 543 Lists (CRL) of Certification Authorities (CAs) whose clients you deal with.
 544 These are used to revoke the client certificate on Client Authentication.</p>
 545 <p>
 546 The files in this directory have to be PEM-encoded and are accessed through
 547 hash filenames. So usually you have not only to place the CRL files there.
 548 Additionally you have to create symbolic links named
 549 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
 550 contains the appropriate symbolic links.</p>
 551 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCARevocationPath /usr/local/apache2/conf/ssl.crl/</pre>
 552 </div>
 553
 554 </div>
 555 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 556 <div class="directive-section"><h2><a name="SSLCertificateChainFile" id="SSLCertificateChainFile">SSLCertificateChainFile</a> <a name="sslcertificatechainfile" id="sslcertificatechainfile">Directive</a></h2>
 557 <table class="directive">
 558 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of PEM-encoded Server CA Certificates</td></tr>
 559 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateChainFile <em>file-path</em></code></td></tr>
 560 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 561 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 562 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 563 </table>
 564 <div class="note"><h3>SSLCertificateChainFile is deprecated</h3>
 565 <p><code>SSLCertificateChainFile</code> became obsolete with version 2.4.8,
 566 when <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>
 567 was extended to also load intermediate CA certificates from the server
 568 certificate file.</p>
 569 </div>
 570
 571 <p>
 572 This directive sets the optional <em>all-in-one</em> file where you can
 573 assemble the certificates of Certification Authorities (CA) which form the
 574 certificate chain of the server certificate. This starts with the issuing CA
 575 certificate of the server certificate and can range up to the root CA
 576 certificate. Such a file is simply the concatenation of the various
 577 PEM-encoded CA Certificate files, usually in certificate chain order.</p>
 578 <p>
 579 This should be used alternatively and/or additionally to <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> for explicitly
 580 constructing the server certificate chain which is sent to the browser
 581 in addition to the server certificate. It is especially useful to
 582 avoid conflicts with CA certificates when using client
 583 authentication. Because although placing a CA certificate of the
 584 server certificate chain into <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> has the same effect
 585 for the certificate chain construction, it has the side-effect that
 586 client certificates issued by this same CA certificate are also
 587 accepted on client authentication.</p>
 588 <p>
 589 But be careful: Providing the certificate chain works only if you are using a
 590 <em>single</em> RSA <em>or</em> DSA based server certificate. If you are
 591 using a coupled RSA+DSA certificate pair, this will work only if actually both
 592 certificates use the <em>same</em> certificate chain. Else the browsers will be
 593 confused in this situation.</p>
 594 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCertificateChainFile /usr/local/apache2/conf/ssl.crt/ca.crt</pre>
 595 </div>
 596
 597 </div>
 598 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 599 <div class="directive-section"><h2><a name="SSLCertificateFile" id="SSLCertificateFile">SSLCertificateFile</a> <a name="sslcertificatefile" id="sslcertificatefile">Directive</a></h2>
 600 <table class="directive">
 601 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Server PEM-encoded X.509 certificate data file</td></tr>
 602 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateFile <em>file-path</em></code></td></tr>
 603 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 604 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 605 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 606 </table>
 607 <p>
 608 This directive points to a file with certificate data in PEM format.
 609 At a minimum, the file must include an end-entity (leaf) certificate.
 610 The directive can be used multiple times (referencing different filenames)
 611 to support multiple algorithms for server authentication - typically
 612 RSA, DSA, and ECC. The number of supported algorithms depends on the
 613 OpenSSL version being used for mod_ssl: with version 1.0.0 or later,
 614 <code>openssl list-public-key-algorithms</code> will output a list
 615 of supported algorithms, see also the note below about limitations
 616 of OpenSSL versions prior to 1.0.2 and the ways to work around them.
 617 </p>
 618
 619 <p>
 620 The files may also include intermediate CA certificates, sorted from
 621 leaf to root. This is supported with version 2.4.8 and later,
 622 and obsoletes <code class="directive"><a href="#sslcertificatechainfile">SSLCertificateChainFile</a></code>.
 623 When running with OpenSSL 1.0.2 or later, this allows
 624 to configure the intermediate CA chain on a per-certificate basis.
 625 </p>
 626
 627 <p>
 628 Custom DH parameters and an EC curve name for ephemeral keys,
 629 can also be added to end of the first file configured using
 630 <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>.
 631 This is supported in version 2.4.7 or later.
 632 Such parameters can be generated using the commands
 633 <code>openssl dhparam</code> and <code>openssl ecparam</code>.
 634 The parameters can be added as-is to the end of the first
 635 certificate file. Only the first file can be used for custom
 636 parameters, as they are applied independently of the authentication
 637 algorithm type.
 638 </p>
 639
 640 <p>
 641 Finally the end-entity certificate's private key can also be
 642 added to the certificate file instead of using a separate
 643 <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>
 644 directive. This practice is highly discouraged. If it is used,
 645 the certificate files using such an embedded key must be configured
 646 after the certificates using a separate key file. If the private
 647 key is encrypted, the pass phrase dialog is forced at startup time.
 648 </p>
 649
 650 <div class="note">
 651 <h3>DH parameter interoperability with primes &gt; 1024 bit</h3>
 652 <p>
 653 Beginning with version 2.4.7, mod_ssl makes use of
 654 standardized DH parameters with prime lengths of 2048, 3072 and 4096 bits
 655 and with additional prime lengths of 6144 and 8192 bits beginning with
 656 version 2.4.10
 657 (from <a href="http://www.ietf.org/rfc/rfc3526.txt">RFC 3526</a>), and hands
 658 them out to clients based on the length of the certificate's RSA/DSA key.
 659 With Java-based clients in particular (Java 7 or earlier), this may lead
 660 to handshake failures - see this
 661 <a href="../ssl/ssl_faq.html#javadh">FAQ answer</a> for working around
 662 such issues.
 663 </p>
 664 </div>
 665
 666 <div class="note">
 667 <h3>Default DH parameters when using multiple certificates and OpenSSL
 668 versions prior to 1.0.2</h3>
 669 <p>
 670 When using multiple certificates to support different authentication algorithms
 671 (like RSA, DSA, but mainly ECC) and OpenSSL prior to 1.0.2, it is recommended
 672 to either use custom DH parameters (preferably) by adding them to the
 673 first certificate file (as described above), or to order the
 674 <code class="directive">SSLCertificateFile</code> directives such that RSA/DSA
 675 certificates are placed <strong>after</strong> the ECC one.
 676 </p>
 677 <p>
 678 This is due to a limitation in older versions of OpenSSL which don't let the
 679 Apache HTTP Server determine the currently selected certificate at handshake
 680 time (when the DH parameters must be sent to the peer) but instead always
 681 provide the last configured certificate. Consequently, the server may select
 682 default DH parameters based on the length of the wrong certificate's key (ECC
 683 keys are much smaller than RSA/DSA ones and their length is not relevant for
 684 selecting DH primes).
 685 </p>
 686 <p>
 687 Since custom DH parameters always take precedence over the default ones, this
 688 issue can be avoided by creating and configuring them (as described above),
 689 thus using a custom/suitable length.
 690 </p>
 691 </div>
 692
 693 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCertificateFile /usr/local/apache2/conf/ssl.crt/server.crt</pre>
 694 </div>
 695
 696 </div>
 697 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 698 <div class="directive-section"><h2><a name="SSLCertificateKeyFile" id="SSLCertificateKeyFile">SSLCertificateKeyFile</a> <a name="sslcertificatekeyfile" id="sslcertificatekeyfile">Directive</a></h2>
 699 <table class="directive">
 700 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Server PEM-encoded private key file</td></tr>
 701 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateKeyFile <em>file-path</em></code></td></tr>
 702 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 703 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 704 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 705 </table>
 706 <p>
 707 This directive points to the PEM-encoded private key file for the
 708 server. If the contained private key is encrypted, the pass phrase
 709 dialog is forced at startup time.</p>
 710
 711 <p>
 712 The directive can be used multiple times (referencing different filenames)
 713 to support multiple algorithms for server authentication. For each
 714 <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>
 715 directive, there must be a matching <code class="directive">SSLCertificateFile</code>
 716 directive.</p>
 717
 718 <p>
 719 The private key may also be combined with the certificate in the file given by
 720 <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>, but this practice
 721 is highly discouraged. If it is used, the certificate files using such
 722 an embedded key must be configured after the certificates using a separate
 723 key file.</p>
 724
 725 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCertificateKeyFile /usr/local/apache2/conf/ssl.key/server.key</pre>
 726 </div>
 727
 728 </div>
 729 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 730 <div class="directive-section"><h2><a name="SSLCipherSuite" id="SSLCipherSuite">SSLCipherSuite</a> <a name="sslciphersuite" id="sslciphersuite">Directive</a></h2>
 731 <table class="directive">
 732 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cipher Suite available for negotiation in SSL
 733 handshake</td></tr>
 734 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCipherSuite <em>cipher-spec</em></code></td></tr>
 735 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCipherSuite DEFAULT (depends on OpenSSL version)</code></td></tr>
 736 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 737 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 738 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 739 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 740 </table>
 741 <p>
 742 This complex directive uses a colon-separated <em>cipher-spec</em> string
 743 consisting of OpenSSL cipher specifications to configure the Cipher Suite the
 744 client is permitted to negotiate in the SSL handshake phase. Notice that this
 745 directive can be used both in per-server and per-directory context. In
 746 per-server context it applies to the standard SSL handshake when a connection
 747 is established. In per-directory context it forces a SSL renegotiation with the
 748 reconfigured Cipher Suite after the HTTP request was read but before the HTTP
 749 response is sent.</p>
 750 <p>
 751 An SSL cipher specification in <em>cipher-spec</em> is composed of 4 major
 752 attributes plus a few extra minor ones:</p>
 753 <ul>
 754 <li><em>Key Exchange Algorithm</em>:<br />
 755     RSA, Diffie-Hellman, Elliptic Curve Diffie-Hellman, Secure Remote Password
 756 </li>
 757 <li><em>Authentication Algorithm</em>:<br />
 758     RSA, Diffie-Hellman, DSS, ECDSA, or none.
 759 </li>
 760 <li><em>Cipher/Encryption Algorithm</em>:<br />
 761     AES, DES, Triple-DES, RC4, RC2, IDEA, etc.
 762 </li>
 763 <li><em>MAC Digest Algorithm</em>:<br />
 764     MD5, SHA or SHA1, SHA256, SHA384.
 765 </li>
 766 </ul>
 767 <p>An SSL cipher can also be an export cipher. SSLv2 ciphers are no longer
 768 supported. To specify which ciphers to use, one can either specify all the
 769 Ciphers, one at a time, or use aliases to specify the preference and order
 770 for the ciphers (see <a href="#table1">Table
 771 1</a>). The actually available ciphers and aliases depends on the used
 772 openssl version. Newer openssl versions may include additional ciphers.</p>
 773
 774 <table class="bordered">
 775
 776 <tr><th><a name="table1">Tag</a></th> <th>Description</th></tr>
 777 <tr><td colspan="2"><em>Key Exchange Algorithm:</em></td></tr>
 778 <tr><td><code>kRSA</code></td>   <td>RSA key exchange</td></tr>
 779 <tr><td><code>kDHr</code></td>   <td>Diffie-Hellman key exchange with RSA key</td></tr>
 780 <tr><td><code>kDHd</code></td>   <td>Diffie-Hellman key exchange with DSA key</td></tr>
 781 <tr><td><code>kEDH</code></td>   <td>Ephemeral (temp.key) Diffie-Hellman key exchange (no cert)</td>   </tr>
 782 <tr><td><code>kSRP</code></td>   <td>Secure Remote Password (SRP) key exchange</td></tr>
 783 <tr><td colspan="2"><em>Authentication Algorithm:</em></td></tr>
 784 <tr><td><code>aNULL</code></td>  <td>No authentication</td></tr>
 785 <tr><td><code>aRSA</code></td>   <td>RSA authentication</td></tr>
 786 <tr><td><code>aDSS</code></td>   <td>DSS authentication</td> </tr>
 787 <tr><td><code>aDH</code></td>    <td>Diffie-Hellman authentication</td></tr>
 788 <tr><td colspan="2"><em>Cipher Encoding Algorithm:</em></td></tr>
 789 <tr><td><code>eNULL</code></td>  <td>No encryption</td>         </tr>
 790 <tr><td><code>NULL</code></td>   <td>alias for eNULL</td>         </tr>
 791 <tr><td><code>AES</code></td>    <td>AES encryption</td>        </tr>
 792 <tr><td><code>DES</code></td>    <td>DES encryption</td>        </tr>
 793 <tr><td><code>3DES</code></td>   <td>Triple-DES encryption</td> </tr>
 794 <tr><td><code>RC4</code></td>    <td>RC4 encryption</td>       </tr>
 795 <tr><td><code>RC2</code></td>    <td>RC2 encryption</td>       </tr>
 796 <tr><td><code>IDEA</code></td>   <td>IDEA encryption</td>       </tr>
 797 <tr><td colspan="2"><em>MAC Digest Algorithm</em>:</td></tr>
 798 <tr><td><code>MD5</code></td>    <td>MD5 hash function</td></tr>
 799 <tr><td><code>SHA1</code></td>   <td>SHA1 hash function</td></tr>
 800 <tr><td><code>SHA</code></td>    <td>alias for SHA1</td> </tr>
 801 <tr><td><code>SHA256</code></td> <td>SHA256 hash function</td> </tr>
 802 <tr><td><code>SHA384</code></td> <td>SHA384 hash function</td> </tr>
 803 <tr><td colspan="2"><em>Aliases:</em></td></tr>
 804 <tr><td><code>SSLv3</code></td>  <td>all SSL version 3.0 ciphers</td> </tr>
 805 <tr><td><code>TLSv1</code></td>  <td>all TLS version 1.0 ciphers</td> </tr>
 806 <tr><td><code>EXP</code></td>    <td>all export ciphers</td>  </tr>
 807 <tr><td><code>EXPORT40</code></td> <td>all 40-bit export ciphers only</td>  </tr>
 808 <tr><td><code>EXPORT56</code></td> <td>all 56-bit export ciphers only</td>  </tr>
 809 <tr><td><code>LOW</code></td>    <td>all low strength ciphers (no export, single DES)</td></tr>
 810 <tr><td><code>MEDIUM</code></td> <td>all ciphers with 128 bit encryption</td> </tr>
 811 <tr><td><code>HIGH</code></td>   <td>all ciphers using Triple-DES</td>     </tr>
 812 <tr><td><code>RSA</code></td>    <td>all ciphers using RSA key exchange</td> </tr>
 813 <tr><td><code>DH</code></td>     <td>all ciphers using Diffie-Hellman key exchange</td> </tr>
 814 <tr><td><code>EDH</code></td>    <td>all ciphers using Ephemeral Diffie-Hellman key exchange</td> </tr>
 815 <tr><td><code>ECDH</code></td>   <td>Elliptic Curve Diffie-Hellman key exchange</td>   </tr>
 816 <tr><td><code>ADH</code></td>    <td>all ciphers using Anonymous Diffie-Hellman key exchange</td> </tr>
 817 <tr><td><code>AECDH</code></td>    <td>all ciphers using Anonymous Elliptic Curve Diffie-Hellman key exchange</td> </tr>
 818 <tr><td><code>SRP</code></td>    <td>all ciphers using Secure Remote Password (SRP) key exchange</td> </tr>
 819 <tr><td><code>DSS</code></td>    <td>all ciphers using DSS authentication</td> </tr>
 820 <tr><td><code>ECDSA</code></td>    <td>all ciphers using ECDSA authentication</td> </tr>
 821 <tr><td><code>aNULL</code></td>   <td>all ciphers using no authentication</td> </tr>
 822 </table>
 823 <p>
 824 Now where this becomes interesting is that these can be put together
 825 to specify the order and ciphers you wish to use. To speed this up
 826 there are also aliases (<code>SSLv3, TLSv1, EXP, LOW, MEDIUM,
 827 HIGH</code>) for certain groups of ciphers. These tags can be joined
 828 together with prefixes to form the <em>cipher-spec</em>. Available
 829 prefixes are:</p>
 830 <ul>
 831 <li>none: add cipher to list</li>
 832 <li><code>+</code>: move matching ciphers to the current location in list</li>
 833 <li><code>-</code>: remove cipher from list (can be added later again)</li>
 834 <li><code>!</code>: kill cipher from list completely (can <strong>not</strong> be added later again)</li>
 835 </ul>
 836
 837 <div class="note">
 838 <h3><code>aNULL</code>, <code>eNULL</code> and <code>EXP</code>
 839 ciphers are always disabled</h3>
 840 <p>Beginning with version 2.4.7, null and export-grade
 841 ciphers are always disabled, as mod_ssl unconditionally adds
 842 <code>!aNULL:!eNULL:!EXP</code> to any cipher string at initialization.</p>
 843 </div>
 844
 845 <p>A simpler way to look at all of this is to use the ``<code>openssl ciphers
 846 -v</code>'' command which provides a nice way to successively create the
 847 correct <em>cipher-spec</em> string. The default <em>cipher-spec</em> string
 848 depends on the version of the OpenSSL libraries used. Let's suppose it is
 849 ``<code>RC4-SHA:AES128-SHA:HIGH:MEDIUM:!aNULL:!MD5</code>'' which
 850 means the following: Put <code>RC4-SHA</code> and <code>AES128-SHA</code> at
 851 the beginning. We do this, because these ciphers offer a good compromise
 852 between speed and security. Next, include high and medium security ciphers.
 853 Finally, remove all ciphers which do not authenticate, i.e. for SSL the
 854 Anonymous Diffie-Hellman ciphers, as well as all ciphers which use
 855 <code>MD5</code> as hash algorithm, because it has been proven insufficient.</p>
 856 <div class="example"><pre>$ openssl ciphers -v 'RC4-SHA:AES128-SHA:HIGH:MEDIUM:!aNULL:!MD5'
 857 RC4-SHA                 SSLv3 Kx=RSA      Au=RSA  Enc=RC4(128)  Mac=SHA1
 858 AES128-SHA              SSLv3 Kx=RSA      Au=RSA  Enc=AES(128)  Mac=SHA1
 859 DHE-RSA-AES256-SHA      SSLv3 Kx=DH       Au=RSA  Enc=AES(256)  Mac=SHA1
 860 ...                     ...               ...     ...           ...
 861 SEED-SHA                SSLv3 Kx=RSA      Au=RSA  Enc=SEED(128) Mac=SHA1
 862 PSK-RC4-SHA             SSLv3 Kx=PSK      Au=PSK  Enc=RC4(128)  Mac=SHA1
 863 KRB5-RC4-SHA            SSLv3 Kx=KRB5     Au=KRB5 Enc=RC4(128)  Mac=SHA1</pre></div>
 864 <p>The complete list of particular RSA &amp; DH ciphers for SSL is given in <a href="#table2">Table 2</a>.</p>
 865 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCipherSuite RSA:!EXP:!NULL:+HIGH:+MEDIUM:-LOW</pre>
 866 </div>
 867 <table class="bordered">
 868
 869 <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>
 870 <tr><td colspan="7"><em>RSA Ciphers:</em></td></tr>
 871 <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>
 872 <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>
 873 <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>
 874 <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>
 875 <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>
 876 <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>
 877 <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>
 878 <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>
 879 <tr><td><code>NULL-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>None</td> <td>SHA1</td> <td /> </tr>
 880 <tr><td><code>NULL-MD5</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>None</td> <td>MD5</td> <td /> </tr>
 881 <tr><td colspan="7"><em>Diffie-Hellman Ciphers:</em></td></tr>
 882 <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>
 883 <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>
 884 <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>
 885 <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>
 886 <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>
 887 <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>
 888 <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>
 889 <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>
 890 <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>
 891 <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>
 892 <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>
 893 </table>
 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="SSLCompression" id="SSLCompression">SSLCompression</a> <a name="sslcompression" id="sslcompression">Directive</a></h2>
 898 <table class="directive">
 899 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable compression on the SSL level</td></tr>
 900 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCompression on|off</code></td></tr>
 901 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCompression off</code></td></tr>
 902 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 903 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 904 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 905 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.3 and later, if using OpenSSL 0.9.8 or later;
 906 virtual host scope available if using OpenSSL 1.0.0 or later.
 907 The default used to be <code>on</code> in version 2.4.3.</td></tr>
 908 </table>
 909 <p>This directive allows to enable compression on the SSL level.</p>
 910 <div class="warning">
 911 <p>Enabling compression causes security issues in most setups (the so called
 912 CRIME attack).</p>
 913 </div>
 914
 915 </div>
 916 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 917 <div class="directive-section"><h2><a name="SSLCryptoDevice" id="SSLCryptoDevice">SSLCryptoDevice</a> <a name="sslcryptodevice" id="sslcryptodevice">Directive</a></h2>
 918 <table class="directive">
 919 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable use of a cryptographic hardware accelerator</td></tr>
 920 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCryptoDevice <em>engine</em></code></td></tr>
 921 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCryptoDevice builtin</code></td></tr>
 922 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 923 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 924 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 925 </table>
 926 <p>
 927 This directive enables use of a cryptographic hardware accelerator
 928 board to offload some of the SSL processing overhead.  This directive
 929 can only be used if the SSL toolkit is built with "engine" support;
 930 OpenSSL 0.9.7 and later releases have "engine" support by default, the
 931 separate "-engine" releases of OpenSSL 0.9.6 must be used.</p>
 932
 933 <p>To discover which engine names are supported, run the command
 934 "<code>openssl engine</code>".</p>
 935
 936 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"># For a Broadcom accelerator:
 937 SSLCryptoDevice ubsec</pre>
 938 </div>
 939
 940 </div>
 941 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 942 <div class="directive-section"><h2><a name="SSLEngine" id="SSLEngine">SSLEngine</a> <a name="sslengine" id="sslengine">Directive</a></h2>
 943 <table class="directive">
 944 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL Engine Operation Switch</td></tr>
 945 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLEngine on|off|optional</code></td></tr>
 946 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLEngine off</code></td></tr>
 947 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 948 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 949 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 950 </table>
 951 <p>
 952 This directive toggles the usage of the SSL/TLS Protocol Engine. This
 953 is should be used inside a <code class="directive"><a href="../mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code> section to enable SSL/TLS for a
 954 that virtual host. By default the SSL/TLS Protocol Engine is
 955 disabled for both the main server and all configured virtual hosts.</p>
 956 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">&lt;VirtualHost _default_:443&gt;
 957 SSLEngine on
 958 #...
 959 &lt;/VirtualHost&gt;</pre>
 960 </div>
 961 <p>In Apache 2.1 and later, <code class="directive">SSLEngine</code> can be set to
 962 <code>optional</code>. This enables support for
 963 <a href="http://www.ietf.org/rfc/rfc2817.txt">RFC 2817</a>, Upgrading to TLS
 964 Within HTTP/1.1. At this time no web browsers support RFC 2817.</p>
 965
 966 </div>
 967 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 968 <div class="directive-section"><h2><a name="SSLFIPS" id="SSLFIPS">SSLFIPS</a> <a name="sslfips" id="sslfips">Directive</a></h2>
 969 <table class="directive">
 970 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL FIPS mode Switch</td></tr>
 971 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLFIPS on|off</code></td></tr>
 972 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLFIPS off</code></td></tr>
 973 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 974 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 975 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
 976 </table>
 977 <p>
 978 This directive toggles the usage of the SSL library FIPS_mode flag.
 979 It must be set in the global server context and cannot be configured
 980 with conflicting settings (SSLFIPS on followed by SSLFIPS off or
 981 similar).  The mode applies to all SSL library operations.
 982 </p>
 983 <p>
 984 If httpd was compiled against an SSL library which did not support
 985 the FIPS_mode flag, <code>SSLFIPS on</code> will fail.  Refer to the
 986 FIPS 140-2 Security Policy document of the SSL provider library for
 987 specific requirements to use mod_ssl in a FIPS 140-2 approved mode
 988 of operation; note that mod_ssl itself is not validated, but may be
 989 described as using FIPS 140-2 validated cryptographic module, when
 990 all components are assembled and operated under the guidelines imposed
 991 by the applicable Security Policy.
 992 </p>
 993
 994 </div>
 995 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 996 <div class="directive-section"><h2><a name="SSLHonorCipherOrder" id="SSLHonorCipherOrder">SSLHonorCipherOrder</a> <a name="sslhonorcipherorder" id="sslhonorcipherorder">Directive</a></h2>
 997 <table class="directive">
 998 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Option to prefer the server's cipher preference order</td></tr>
 999 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLHonorCipherOrder on|off</code></td></tr>
1000 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLHonorCipherOrder off</code></td></tr>
1001 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1002 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1003 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1004 </table>
1005 <p>When choosing a cipher during an SSLv3 or TLSv1 handshake, normally
1006 the client's preference is used.  If this directive is enabled, the
1007 server's preference will be used instead.</p>
1008 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLHonorCipherOrder on</pre>
1009 </div>
1010
1011 </div>
1012 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1013 <div class="directive-section"><h2><a name="SSLInsecureRenegotiation" id="SSLInsecureRenegotiation">SSLInsecureRenegotiation</a> <a name="sslinsecurerenegotiation" id="sslinsecurerenegotiation">Directive</a></h2>
1014 <table class="directive">
1015 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Option to enable support for insecure renegotiation</td></tr>
1016 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLInsecureRenegotiation on|off</code></td></tr>
1017 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLInsecureRenegotiation off</code></td></tr>
1018 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1019 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1020 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1021 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8m or later</td></tr>
1022 </table>
1023 <p>As originally specified, all versions of the SSL and TLS protocols
1024 (up to and including TLS/1.2) were vulnerable to a Man-in-the-Middle
1025 attack
1026 (<a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-2009-3555</a>)
1027 during a renegotiation.  This vulnerability allowed an attacker to
1028 "prefix" a chosen plaintext to the HTTP request as seen by the web
1029 server.  A protocol extension was developed which fixed this
1030 vulnerability if supported by both client and server.</p>
1031
1032 <p>If <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is linked against OpenSSL version 0.9.8m
1033 or later, by default renegotiation is only supported with
1034 clients supporting the new protocol extension.  If this directive is
1035 enabled, renegotiation will be allowed with old (unpatched) clients,
1036 albeit insecurely.</p>
1037
1038 <div class="warning"><h3>Security warning</h3>
1039 <p>If this directive is enabled, SSL connections will be vulnerable to
1040 the Man-in-the-Middle prefix attack as described
1041 in <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-2009-3555</a>.</p>
1042 </div>
1043
1044 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLInsecureRenegotiation on</pre>
1045 </div>
1046
1047 <p>The <code>SSL_SECURE_RENEG</code> environment variable can be used
1048 from an SSI or CGI script to determine whether secure renegotiation is
1049 supported for a given SSL connection.</p>
1050
1051
1052 </div>
1053 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1054 <div class="directive-section"><h2><a name="SSLOCSPDefaultResponder" id="SSLOCSPDefaultResponder">SSLOCSPDefaultResponder</a> <a name="sslocspdefaultresponder" id="sslocspdefaultresponder">Directive</a></h2>
1055 <table class="directive">
1056 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the default responder URI for OCSP validation</td></tr>
1057 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSDefaultResponder <em>uri</em></code></td></tr>
1058 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1059 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1060 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1061 </table>
1062 <p>This option sets the default OCSP responder to use.  If <code class="directive"><a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></code> is not enabled,
1063 the URI given will be used only if no responder URI is specified in
1064 the certificate being verified.</p>
1065
1066 </div>
1067 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1068 <div class="directive-section"><h2><a name="SSLOCSPEnable" id="SSLOCSPEnable">SSLOCSPEnable</a> <a name="sslocspenable" id="sslocspenable">Directive</a></h2>
1069 <table class="directive">
1070 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable OCSP validation of the client certificate chain</td></tr>
1071 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPEnable on|off</code></td></tr>
1072 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPEnable off</code></td></tr>
1073 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1074 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1075 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1076 </table>
1077 <p>This option enables OCSP validation of the client certificate
1078 chain.  If this option is enabled, certificates in the client's
1079 certificate chain will be validated against an OCSP responder after
1080 normal verification (including CRL checks) have taken place.</p>
1081
1082 <p>The OCSP responder used is either extracted from the certificate
1083 itself, or derived by configuration; see the
1084 <code class="directive"><a href="#sslocspdefaultresponder">SSLOCSPDefaultResponder</a></code> and
1085 <code class="directive"><a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></code>
1086 directives.</p>
1087
1088 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLVerifyClient on
1089 SSLOCSPEnable on
1090 SSLOCSPDefaultResponder http://responder.example.com:8888/responder
1091 SSLOCSPOverrideResponder on</pre>
1092 </div>
1093
1094 </div>
1095 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1096 <div class="directive-section"><h2><a name="SSLOCSPOverrideResponder" id="SSLOCSPOverrideResponder">SSLOCSPOverrideResponder</a> <a name="sslocspoverrideresponder" id="sslocspoverrideresponder">Directive</a></h2>
1097 <table class="directive">
1098 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Force use of the default responder URI for OCSP validation</td></tr>
1099 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPOverrideResponder on|off</code></td></tr>
1100 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPOverrideResponder off</code></td></tr>
1101 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1102 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1103 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1104 </table>
1105 <p>This option forces the configured default OCSP responder to be used
1106 during OCSP certificate validation, regardless of whether the
1107 certificate being validated references an OCSP responder.</p>
1108
1109 </div>
1110 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1111 <div class="directive-section"><h2><a name="SSLOCSPProxyURL" id="SSLOCSPProxyURL">SSLOCSPProxyURL</a> <a name="sslocspproxyurl" id="sslocspproxyurl">Directive</a></h2>
1112 <table class="directive">
1113 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Proxy URL to use for OCSP requests</td></tr>
1114 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPProxyURL <em>url</em></code></td></tr>
1115 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1116 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1117 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1118 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.19 and later</td></tr>
1119 </table>
1120 <p>This option allows to set the URL of a HTTP proxy that should be used for
1121 all queries to OCSP responders.</p>
1122
1123 </div>
1124 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1125 <div class="directive-section"><h2><a name="SSLOCSPResponderTimeout" id="SSLOCSPResponderTimeout">SSLOCSPResponderTimeout</a> <a name="sslocsprespondertimeout" id="sslocsprespondertimeout">Directive</a></h2>
1126 <table class="directive">
1127 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Timeout for OCSP queries</td></tr>
1128 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPResponderTimeout <em>seconds</em></code></td></tr>
1129 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPResponderTimeout 10</code></td></tr>
1130 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1131 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1132 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1133 </table>
1134 <p>This option sets the timeout for queries to OCSP responders, when
1135 <code class="directive"><a href="#sslocspenable">SSLOCSPEnable</a></code> is turned on.</p>
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="SSLOCSPResponseMaxAge" id="SSLOCSPResponseMaxAge">SSLOCSPResponseMaxAge</a> <a name="sslocspresponsemaxage" id="sslocspresponsemaxage">Directive</a></h2>
1140 <table class="directive">
1141 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum allowable age for OCSP responses</td></tr>
1142 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPResponseMaxAge <em>seconds</em></code></td></tr>
1143 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPResponseMaxAge -1</code></td></tr>
1144 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1145 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1146 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1147 </table>
1148 <p>This option sets the maximum allowable age ("freshness") for OCSP responses.
1149 The default value (<code>-1</code>) does not enforce a maximum age,
1150 which means that OCSP responses are considered valid as long as their
1151 <code>nextUpdate</code> field is in the future.</p>
1152
1153 </div>
1154 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1155 <div class="directive-section"><h2><a name="SSLOCSPResponseTimeSkew" id="SSLOCSPResponseTimeSkew">SSLOCSPResponseTimeSkew</a> <a name="sslocspresponsetimeskew" id="sslocspresponsetimeskew">Directive</a></h2>
1156 <table class="directive">
1157 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum allowable time skew for OCSP response validation</td></tr>
1158 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPResponseTimeSkew <em>seconds</em></code></td></tr>
1159 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPResponseTimeSkew 300</code></td></tr>
1160 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1161 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1162 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1163 </table>
1164 <p>This option sets the maximum allowable time skew for OCSP responses
1165 (when checking their <code>thisUpdate</code> and <code>nextUpdate</code> fields).</p>
1166
1167 </div>
1168 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1169 <div class="directive-section"><h2><a name="SSLOCSPUseRequestNonce" id="SSLOCSPUseRequestNonce">SSLOCSPUseRequestNonce</a> <a name="sslocspuserequestnonce" id="sslocspuserequestnonce">Directive</a></h2>
1170 <table class="directive">
1171 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use a nonce within OCSP queries</td></tr>
1172 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPUseRequestNonce on|off</code></td></tr>
1173 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPUseRequestNonce on</code></td></tr>
1174 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1175 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1176 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1177 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.10 and later</td></tr>
1178 </table>
1179 <p>This option determines whether queries to OCSP responders should contain
1180 a nonce or not. By default, a query nonce is always used and checked against
1181 the response's one. When the responder does not use nonces (e.g. Microsoft OCSP
1182 Responder), this option should be turned <code>off</code>.</p>
1183
1184 </div>
1185 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1186 <div class="directive-section"><h2><a name="SSLOpenSSLConfCmd" id="SSLOpenSSLConfCmd">SSLOpenSSLConfCmd</a> <a name="sslopensslconfcmd" id="sslopensslconfcmd">Directive</a></h2>
1187 <table class="directive">
1188 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure OpenSSL parameters through its <em>SSL_CONF</em> API</td></tr>
1189 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOpenSSLConfCmd <em>command-name</em> <em>command-value</em></code></td></tr>
1190 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1191 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1192 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1193 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.8 and later, if using OpenSSL 1.0.2 or later</td></tr>
1194 </table>
1195 <p>This directive exposes OpenSSL's <em>SSL_CONF</em> API to mod_ssl,
1196 allowing a flexible configuration of OpenSSL parameters without the need
1197 of implementing additional <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> directives when new
1198 features are added to OpenSSL.</p>
1199
1200 <p>The set of available <code class="directive">SSLOpenSSLConfCmd</code> commands
1201 depends on the OpenSSL version being used for <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
1202 (at least version 1.0.2 is required). For a list of supported command
1203 names, see the section <em>Supported configuration file commands</em> in the
1204 <a href="http://www.openssl.org/docs/man1.0.2/ssl/SSL_CONF_cmd.html#SUPPORTED-CONFIGURATION-FILE-COMMANDS">SSL_CONF_cmd(3)</a> manual page for OpenSSL.</p>
1205
1206 <p>Some of the <code class="directive">SSLOpenSSLConfCmd</code> commands can be used
1207 as an alternative to existing directives (such as
1208 <code class="directive"><a href="#sslciphersuite">SSLCipherSuite</a></code> or
1209 <code class="directive"><a href="#sslprotocol">SSLProtocol</a></code>),
1210 though it should be noted that the syntax / allowable values for the parameters
1211 may sometimes differ.</p>
1212
1213 <div class="example"><h3>Examples</h3><pre class="prettyprint lang-config">SSLOpenSSLConfCmd Options -SessionTicket,ServerPreference
1214 SSLOpenSSLConfCmd ECDHParameters brainpoolP256r1
1215 SSLOpenSSLConfCmd ServerInfoFile /usr/local/apache2/conf/server-info.pem
1216 SSLOpenSSLConfCmd Protocol "-ALL, TLSv1.2"
1217 SSLOpenSSLConfCmd SignatureAlgorithms RSA+SHA384:ECDSA+SHA256</pre>
1218 </div>
1219
1220 </div>
1221 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1222 <div class="directive-section"><h2><a name="SSLOptions" id="SSLOptions">SSLOptions</a> <a name="ssloptions" id="ssloptions">Directive</a></h2>
1223 <table class="directive">
1224 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure various SSL engine run-time options</td></tr>
1225 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOptions [+|-]<em>option</em> ...</code></td></tr>
1226 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1227 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
1228 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1229 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1230 </table>
1231 <p>
1232 This directive can be used to control various run-time options on a
1233 per-directory basis. Normally, if multiple <code>SSLOptions</code>
1234 could apply to a directory, then the most specific one is taken
1235 completely; the options are not merged. However if <em>all</em> the
1236 options on the <code>SSLOptions</code> directive are preceded by a
1237 plus (<code>+</code>) or minus (<code>-</code>) symbol, the options
1238 are merged. Any options preceded by a <code>+</code> are added to the
1239 options currently in force, and any options preceded by a
1240 <code>-</code> are removed from the options currently in force.</p>
1241 <p>
1242 The available <em>option</em>s are:</p>
1243 <ul>
1244 <li><code>StdEnvVars</code>
1245     <p>
1246     When this option is enabled, the standard set of SSL related CGI/SSI
1247     environment variables are created. This per default is disabled for
1248     performance reasons, because the information extraction step is a
1249     rather expensive operation. So one usually enables this option for
1250     CGI and SSI requests only.</p>
1251 </li>
1252 <li><code>ExportCertData</code>
1253     <p>
1254     When this option is enabled, additional CGI/SSI environment variables are
1255     created: <code>SSL_SERVER_CERT</code>, <code>SSL_CLIENT_CERT</code> and
1256     <code>SSL_CLIENT_CERT_CHAIN_</code><em>n</em> (with <em>n</em> = 0,1,2,..).
1257     These contain the PEM-encoded X.509 Certificates of server and client for
1258     the current HTTPS connection and can be used by CGI scripts for deeper
1259     Certificate checking. Additionally all other certificates of the client
1260     certificate chain are provided, too. This bloats up the environment a
1261     little bit which is why you have to use this option to enable it on
1262     demand.</p>
1263 </li>
1264 <li><code>FakeBasicAuth</code>
1265     <p>
1266     When this option is enabled, the Subject Distinguished Name (DN) of the
1267     Client X509 Certificate is translated into a HTTP Basic Authorization
1268     username. This means that the standard Apache authentication methods can
1269     be used for access control. The user name is just the Subject of the
1270     Client's X509 Certificate (can be determined by running OpenSSL's
1271     <code>openssl x509</code> command: <code>openssl x509 -noout -subject -in
1272     </code><em>certificate</em><code>.crt</code>). The optional <code class="directive"><a href="#sslusername">SSLUserName</a></code> directive can be used to
1273     specify which part of the certificate Subject is embedded in the username.
1274     Note that no password is obtained from the user. Every entry in the user
1275     file needs this password: ``<code>xxj31ZMTZzkVA</code>'', which is the
1276     DES-encrypted version of the word `<code>password</code>''. Those who
1277     live under MD5-based encryption (for instance under FreeBSD or BSD/OS,
1278     etc.) should use the following MD5 hash of the same word:
1279      ``<code>$1$OXLyS...$Owx8s2/m9/gfkcRVXzgoE/</code>''.</p>
1280
1281     <p>Note that the <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicfake">AuthBasicFake</a></code>
1282     directive within <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> can be used as a more
1283     general mechanism for faking basic authentication, giving control over the
1284     structure of both the username and password.</p>
1285 </li>
1286 <li><code>StrictRequire</code>
1287     <p>
1288     This <em>forces</em> forbidden access when <code>SSLRequireSSL</code> or
1289     <code>SSLRequire</code> successfully decided that access should be
1290     forbidden. Usually the default is that in the case where a ``<code>Satisfy
1291     any</code>'' directive is used, and other access restrictions are passed,
1292     denial of access due to <code>SSLRequireSSL</code> or
1293     <code>SSLRequire</code> is overridden (because that's how the Apache
1294     <code>Satisfy</code> mechanism should work.) But for strict access restriction
1295     you can use <code>SSLRequireSSL</code> and/or <code>SSLRequire</code> in
1296     combination with an ``<code>SSLOptions +StrictRequire</code>''. Then an
1297     additional ``<code>Satisfy Any</code>'' has no chance once mod_ssl has
1298     decided to deny access.</p>
1299 </li>
1300 <li><code>OptRenegotiate</code>
1301     <p>
1302     This enables optimized SSL connection renegotiation handling when SSL
1303     directives are used in per-directory context. By default a strict
1304     scheme is enabled where <em>every</em> per-directory reconfiguration of
1305     SSL parameters causes a <em>full</em> SSL renegotiation handshake. When this
1306     option is used mod_ssl tries to avoid unnecessary handshakes by doing more
1307     granular (but still safe) parameter checks. Nevertheless these granular
1308     checks sometimes may not be what the user expects, so enable this on a
1309     per-directory basis only, please.</p>
1310 </li>
1311 <li><code>LegacyDNStringFormat</code>
1312     <p>
1313     This option influences how values of the
1314     <code>SSL_{CLIENT,SERVER}_{I,S}_DN</code> variables are formatted. Since
1315     version 2.3.11, Apache HTTPD uses a RFC 2253 compatible format by
1316     default. This uses commas as delimiters between the attributes, allows the
1317     use of non-ASCII characters (which are converted to UTF8), escapes
1318     various special characters with backslashes, and sorts the attributes
1319     with the "C" attribute last.</p>
1320
1321     <p>If <code>LegacyDNStringFormat</code> is set, the old format will be
1322     used which sorts the "C" attribute first, uses slashes as separators, and
1323     does not handle non-ASCII and special characters in any consistent way.
1324     </p>
1325 </li>
1326 </ul>
1327 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLOptions +FakeBasicAuth -StrictRequire
1328 &lt;Files ~ "\.(cgi|shtml)$"&gt;
1329     SSLOptions +StdEnvVars -ExportCertData
1330 &lt;/Files&gt;</pre>
1331 </div>
1332
1333 </div>
1334 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1335 <div class="directive-section"><h2><a name="SSLPassPhraseDialog" id="SSLPassPhraseDialog">SSLPassPhraseDialog</a> <a name="sslpassphrasedialog" id="sslpassphrasedialog">Directive</a></h2>
1336 <table class="directive">
1337 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of pass phrase dialog for encrypted private
1338 keys</td></tr>
1339 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLPassPhraseDialog <em>type</em></code></td></tr>
1340 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLPassPhraseDialog builtin</code></td></tr>
1341 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1342 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1343 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1344 </table>
1345 <p>
1346 When Apache starts up it has to read the various Certificate (see
1347 <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>) and
1348 Private Key (see <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>) files of the
1349 SSL-enabled virtual servers. Because for security reasons the Private
1350 Key files are usually encrypted, mod_ssl needs to query the
1351 administrator for a Pass Phrase in order to decrypt those files. This
1352 query can be done in two ways which can be configured by
1353 <em>type</em>:</p>
1354 <ul>
1355 <li><code>builtin</code>
1356     <p>
1357     This is the default where an interactive terminal dialog occurs at startup
1358     time just before Apache detaches from the terminal. Here the administrator
1359     has to manually enter the Pass Phrase for each encrypted Private Key file.
1360     Because a lot of SSL-enabled virtual hosts can be configured, the
1361     following reuse-scheme is used to minimize the dialog: When a Private Key
1362     file is encrypted, all known Pass Phrases (at the beginning there are
1363     none, of course) are tried. If one of those known Pass Phrases succeeds no
1364     dialog pops up for this particular Private Key file. If none succeeded,
1365     another Pass Phrase is queried on the terminal and remembered for the next
1366     round (where it perhaps can be reused).</p>
1367     <p>
1368     This scheme allows mod_ssl to be maximally flexible (because for N encrypted
1369     Private Key files you <em>can</em> use N different Pass Phrases - but then
1370     you have to enter all of them, of course) while minimizing the terminal
1371     dialog (i.e. when you use a single Pass Phrase for all N Private Key files
1372     this Pass Phrase is queried only once).</p></li>
1373
1374 <li><code>|/path/to/program [args...]</code>
1375
1376    <p>This mode allows an external program to be used which acts as a
1377    pipe to a particular input device; the program is sent the standard
1378    prompt text used for the <code>builtin</code> mode on
1379    <code>stdin</code>, and is expected to write password strings on
1380    <code>stdout</code>.  If several passwords are needed (or an
1381    incorrect password is entered), additional prompt text will be
1382    written subsequent to the first password being returned, and more
1383    passwords must then be written back.</p></li>
1384
1385 <li><code>exec:/path/to/program</code>
1386     <p>
1387     Here an external program is configured which is called at startup for each
1388     encrypted Private Key file. It is called with one argument, a string of the
1389     form ``<code>servername:portnumber:index</code>'' (with <code>index</code>
1390     being a zero-based sequence number), which indicates for which server,
1391     TCP port and certificate number it has to print the corresponding
1392     Pass Phrase to <code>stdout</code>.  The intent is that this external
1393     program first runs security checks to make sure that the system is not
1394     compromised by an attacker, and only when these checks were passed
1395     successfully it provides the Pass Phrase.</p>
1396     <p>
1397     Both these security checks, and the way the Pass Phrase is determined, can
1398     be as complex as you like. Mod_ssl just defines the interface: an
1399     executable program which provides the Pass Phrase on <code>stdout</code>.
1400     Nothing more or less! So, if you're really paranoid about security, here
1401     is your interface. Anything else has to be left as an exercise to the
1402     administrator, because local security requirements are so different.</p>
1403     <p>
1404     The reuse-algorithm above is used here, too. In other words: The external
1405     program is called only once per unique Pass Phrase.</p></li>
1406 </ul>
1407 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLPassPhraseDialog exec:/usr/local/apache/sbin/pp-filter</pre>
1408 </div>
1409
1410 </div>
1411 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1412 <div class="directive-section"><h2><a name="SSLProtocol" id="SSLProtocol">SSLProtocol</a> <a name="sslprotocol" id="sslprotocol">Directive</a></h2>
1413 <table class="directive">
1414 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure usable SSL/TLS protocol versions</td></tr>
1415 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProtocol [+|-]<em>protocol</em> ...</code></td></tr>
1416 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProtocol all -SSLv3</code></td></tr>
1417 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1418 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1419 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1420 </table>
1421 <p>
1422 This directive can be used to control which versions of the SSL/TLS protocol
1423 will be accepted in new connections.</p>
1424 <p>
1425 The available (case-insensitive) <em>protocol</em>s are:</p>
1426 <ul>
1427 <li><code>SSLv3</code>
1428     <p>
1429     This is the Secure Sockets Layer (SSL) protocol, version 3.0, from
1430     the Netscape Corporation.
1431     It is the successor to SSLv2 and the predecessor to TLSv1, but is
1432     deprecated in <a href="http://www.ietf.org/rfc/rfc7568.txt">RFC 7568</a>.</p></li>
1433
1434 <li><code>TLSv1</code>
1435     <p>
1436     This is the Transport Layer Security (TLS) protocol, version 1.0.
1437     It is the successor to SSLv3 and is defined in
1438     <a href="http://www.ietf.org/rfc/rfc2246.txt">RFC 2246</a>.
1439     It is supported by nearly every client.</p></li>
1440
1441 <li><code>TLSv1.1</code> (when using OpenSSL 1.0.1 and later)
1442     <p>
1443     A revision of the TLS 1.0 protocol, as defined in
1444     <a href="http://www.ietf.org/rfc/rfc4346.txt">RFC 4346</a>.</p></li>
1445
1446 <li><code>TLSv1.2</code> (when using OpenSSL 1.0.1 and later)
1447     <p>
1448     A revision of the TLS 1.1 protocol, as defined in
1449     <a href="http://www.ietf.org/rfc/rfc5246.txt">RFC 5246</a>.</p></li>
1450
1451 <li><code>all</code>
1452     <p>
1453     This is a shortcut for ``<code>+SSLv3 +TLSv1</code>'' or
1454     - when using OpenSSL 1.0.1 and later -
1455     ``<code>+SSLv3 +TLSv1 +TLSv1.1 +TLSv1.2</code>'', respectively
1456     (except for OpenSSL versions compiled with the ``no-ssl3'' configuration
1457     option, where <code>all</code> does not include <code>+SSLv3</code>).</p></li>
1458 </ul>
1459 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProtocol TLSv1</pre>
1460 </div>
1461
1462 </div>
1463 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1464 <div class="directive-section"><h2><a name="SSLProxyCACertificateFile" id="SSLProxyCACertificateFile">SSLProxyCACertificateFile</a> <a name="sslproxycacertificatefile" id="sslproxycacertificatefile">Directive</a></h2>
1465 <table class="directive">
1466 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
1467 for Remote Server Auth</td></tr>
1468 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCACertificateFile <em>file-path</em></code></td></tr>
1469 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1470 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1471 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1472 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1473 </table>
1474 <p>
1475 This directive sets the <em>all-in-one</em> file where you can assemble the
1476 Certificates of Certification Authorities (CA) whose <em>remote servers</em> you deal
1477 with. These are used for Remote Server Authentication. Such a file is simply the
1478 concatenation of the various PEM-encoded Certificate files, in order of
1479 preference. This can be used alternatively and/or additionally to
1480 <code class="directive"><a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></code>.</p>
1481 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-remote-server.crt</pre>
1482 </div>
1483
1484 </div>
1485 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1486 <div class="directive-section"><h2><a name="SSLProxyCACertificatePath" id="SSLProxyCACertificatePath">SSLProxyCACertificatePath</a> <a name="sslproxycacertificatepath" id="sslproxycacertificatepath">Directive</a></h2>
1487 <table class="directive">
1488 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
1489 Remote Server Auth</td></tr>
1490 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCACertificatePath <em>directory-path</em></code></td></tr>
1491 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1492 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1493 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1494 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1495 </table>
1496 <p>
1497 This directive sets the directory where you keep the Certificates of
1498 Certification Authorities (CAs) whose remote servers you deal with. These are used to
1499 verify the remote server certificate on Remote Server Authentication.</p>
1500 <p>
1501 The files in this directory have to be PEM-encoded and are accessed through
1502 hash filenames. So usually you can't just place the Certificate files
1503 there: you also have to create symbolic links named
1504 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
1505 contains the appropriate symbolic links.</p>
1506 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCACertificatePath /usr/local/apache2/conf/ssl.crt/</pre>
1507 </div>
1508
1509 </div>
1510 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1511 <div class="directive-section"><h2><a name="SSLProxyCARevocationCheck" id="SSLProxyCARevocationCheck">SSLProxyCARevocationCheck</a> <a name="sslproxycarevocationcheck" id="sslproxycarevocationcheck">Directive</a></h2>
1512 <table class="directive">
1513 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable CRL-based revocation checking for Remote Server Auth</td></tr>
1514 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationCheck chain|leaf|none</code></td></tr>
1515 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCARevocationCheck none</code></td></tr>
1516 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1517 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1518 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1519 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1520 </table>
1521 <p>
1522 Enables certificate revocation list (CRL) checking for the
1523 <em>remote servers</em> you deal with. At least one of
1524 <code class="directive"><a href="#sslproxycarevocationfile">SSLProxyCARevocationFile</a></code>
1525 or <code class="directive"><a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></code> must be
1526 configured. When set to <code>chain</code> (recommended setting),
1527 CRL checks are applied to all certificates in the chain, while setting it to
1528 <code>leaf</code> limits the checks to the end-entity cert.
1529 </p>
1530 <div class="note">
1531 <h3>When set to <code>chain</code> or <code>leaf</code>,
1532 CRLs <em>must</em> be available for successful validation</h3>
1533 <p>
1534 Prior to version 2.3.15, CRL checking in mod_ssl also succeeded when
1535 no CRL(s) were found in any of the locations configured with
1536 <code class="directive"><a href="#sslproxycarevocationfile">SSLProxyCARevocationFile</a></code>
1537 or <code class="directive"><a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></code>.
1538 With the introduction of this directive, the behavior has been changed:
1539 when checking is enabled, CRLs <em>must</em> be present for the validation
1540 to succeed - otherwise it will fail with an
1541 <code>"unable to get certificate CRL"</code> error.
1542 </p>
1543 </div>
1544 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCARevocationCheck chain</pre>
1545 </div>
1546
1547 </div>
1548 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1549 <div class="directive-section"><h2><a name="SSLProxyCARevocationFile" id="SSLProxyCARevocationFile">SSLProxyCARevocationFile</a> <a name="sslproxycarevocationfile" id="sslproxycarevocationfile">Directive</a></h2>
1550 <table class="directive">
1551 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA CRLs for
1552 Remote Server Auth</td></tr>
1553 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationFile <em>file-path</em></code></td></tr>
1554 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1555 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1556 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1557 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1558 </table>
1559 <p>
1560 This directive sets the <em>all-in-one</em> file where you can
1561 assemble the Certificate Revocation Lists (CRL) of Certification
1562 Authorities (CA) whose <em>remote servers</em> you deal with. These are used
1563 for Remote Server Authentication.  Such a file is simply the concatenation of
1564 the various PEM-encoded CRL files, in order of preference. This can be
1565 used alternatively and/or additionally to <code class="directive"><a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></code>.</p>
1566 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-remote-server.crl</pre>
1567 </div>
1568
1569 </div>
1570 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1571 <div class="directive-section"><h2><a name="SSLProxyCARevocationPath" id="SSLProxyCARevocationPath">SSLProxyCARevocationPath</a> <a name="sslproxycarevocationpath" id="sslproxycarevocationpath">Directive</a></h2>
1572 <table class="directive">
1573 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA CRLs for
1574 Remote Server Auth</td></tr>
1575 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationPath <em>directory-path</em></code></td></tr>
1576 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1577 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1578 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1579 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1580 </table>
1581 <p>
1582 This directive sets the directory where you keep the Certificate Revocation
1583 Lists (CRL) of Certification Authorities (CAs) whose remote servers you deal with.
1584 These are used to revoke the remote server certificate on Remote Server Authentication.</p>
1585 <p>
1586 The files in this directory have to be PEM-encoded and are accessed through
1587 hash filenames. So usually you have not only to place the CRL files there.
1588 Additionally you have to create symbolic links named
1589 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
1590 contains the appropriate symbolic links.</p>
1591 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCARevocationPath /usr/local/apache2/conf/ssl.crl/</pre>
1592 </div>
1593
1594 </div>
1595 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1596 <div class="directive-section"><h2><a name="SSLProxyCheckPeerCN" id="SSLProxyCheckPeerCN">SSLProxyCheckPeerCN</a> <a name="sslproxycheckpeercn" id="sslproxycheckpeercn">Directive</a></h2>
1597 <table class="directive">
1598 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether to check the remote server certificate's CN field
1599 </td></tr>
1600 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCheckPeerCN on|off</code></td></tr>
1601 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCheckPeerCN on</code></td></tr>
1602 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1603 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1604 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1605 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1606 </table>
1607 <p>
1608 This directive sets whether the remote server certificate's CN field is
1609 compared against the hostname of the request URL. If both are not equal
1610 a 502 status code (Bad Gateway) is sent.
1611 </p>
1612 <p>
1613 In 2.4.5 and later, SSLProxyCheckPeerCN has been superseded by
1614 <code class="directive"><a href="#sslproxycheckpeername">SSLProxyCheckPeerName</a></code>, and its
1615 setting is only taken into account when
1616 <code>SSLProxyCheckPeerName off</code> is specified at the same time.
1617 </p>
1618 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCheckPeerCN on</pre>
1619 </div>
1620
1621 </div>
1622 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1623 <div class="directive-section"><h2><a name="SSLProxyCheckPeerExpire" id="SSLProxyCheckPeerExpire">SSLProxyCheckPeerExpire</a> <a name="sslproxycheckpeerexpire" id="sslproxycheckpeerexpire">Directive</a></h2>
1624 <table class="directive">
1625 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether to check if remote server certificate is expired
1626 </td></tr>
1627 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCheckPeerExpire on|off</code></td></tr>
1628 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCheckPeerExpire on</code></td></tr>
1629 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1630 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1631 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1632 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1633 </table>
1634 <p>
1635 This directive sets whether it is checked if the remote server certificate
1636 is expired or not. If the check fails a 502 status code (Bad Gateway) is
1637 sent.
1638 </p>
1639 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCheckPeerExpire on</pre>
1640 </div>
1641
1642 </div>
1643 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1644 <div class="directive-section"><h2><a name="SSLProxyCheckPeerName" id="SSLProxyCheckPeerName">SSLProxyCheckPeerName</a> <a name="sslproxycheckpeername" id="sslproxycheckpeername">Directive</a></h2>
1645 <table class="directive">
1646 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure host name checking for remote server certificates
1647 </td></tr>
1648 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCheckPeerName on|off</code></td></tr>
1649 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCheckPeerName on</code></td></tr>
1650 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1651 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1652 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1653 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1654 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache HTTP Server 2.4.5 and later</td></tr>
1655 </table>
1656 <p>
1657 This directive configures host name checking for server certificates
1658 when mod_ssl is acting as an SSL client. The check will
1659 succeed if the host name from the request URI is found in
1660 either the subjectAltName extension or (one of) the CN attribute(s)
1661 in the certificate's subject. If the check fails, the SSL request
1662 is aborted and a 502 status code (Bad Gateway) is returned.
1663 The directive supersedes <code class="directive"><a href="#sslproxycheckpeercn">SSLProxyCheckPeerCN</a></code>,
1664 which only checks for the expected host name in the first CN attribute.
1665 </p>
1666 <p>
1667 Wildcard matching is supported in one specific flavor: subjectAltName entries
1668 of type dNSName or CN attributes starting with <code>*.</code> will match
1669 for any DNS name with the same number of labels and the same suffix
1670 (i.e., <code>*.example.org</code> matches for <code>foo.example.org</code>,
1671 but not for <code>foo.bar.example.org</code>).
1672 </p>
1673
1674 </div>
1675 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1676 <div class="directive-section"><h2><a name="SSLProxyCipherSuite" id="SSLProxyCipherSuite">SSLProxyCipherSuite</a> <a name="sslproxyciphersuite" id="sslproxyciphersuite">Directive</a></h2>
1677 <table class="directive">
1678 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cipher Suite available for negotiation in SSL
1679 proxy handshake</td></tr>
1680 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCipherSuite <em>cipher-spec</em></code></td></tr>
1681 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+EXP</code></td></tr>
1682 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1683 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1684 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1685 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1686 </table>
1687 <p>Equivalent to <code>SSLCipherSuite</code>, but for the proxy connection.
1688 Please refer to <code class="directive"><a href="#sslciphersuite">SSLCipherSuite</a></code>
1689 for additional information.</p>
1690
1691 </div>
1692 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1693 <div class="directive-section"><h2><a name="SSLProxyEngine" id="SSLProxyEngine">SSLProxyEngine</a> <a name="sslproxyengine" id="sslproxyengine">Directive</a></h2>
1694 <table class="directive">
1695 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL Proxy Engine Operation Switch</td></tr>
1696 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyEngine on|off</code></td></tr>
1697 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyEngine off</code></td></tr>
1698 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1699 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1700 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1701 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1702 </table>
1703 <p>
1704 This directive toggles the usage of the SSL/TLS Protocol Engine for proxy. This
1705 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
1706 usage in a particular virtual host. By default the SSL/TLS Protocol Engine is
1707 disabled for proxy both for the main server and all configured virtual hosts.</p>
1708
1709 <p>Note that the SSLProxyEngine directive should not, in
1710 general, be included in a virtual host that will be acting as a
1711 forward proxy (using &lt;Proxy&gt; or &lt;ProxyRequest&gt; directives.
1712 SSLProxyEngine is not required to enable a forward proxy server to
1713 proxy SSL/TLS requests.</p>
1714
1715 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">&lt;VirtualHost _default_:443&gt;
1716     SSLProxyEngine on
1717     #...
1718 &lt;/VirtualHost&gt;</pre>
1719 </div>
1720
1721 </div>
1722 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1723 <div class="directive-section"><h2><a name="SSLProxyMachineCertificateChainFile" id="SSLProxyMachineCertificateChainFile">SSLProxyMachineCertificateChainFile</a> <a name="sslproxymachinecertificatechainfile" id="sslproxymachinecertificatechainfile">Directive</a></h2>
1724 <table class="directive">
1725 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA certificates to be used by the proxy for choosing a certificate</td></tr>
1726 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificateChainFile <em>filename</em></code></td></tr>
1727 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1728 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1729 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1730 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1731 </table>
1732 <p>
1733 This directive sets the all-in-one file where you keep the certificate chain
1734 for all of the client certs in use. This directive will be needed if the
1735 remote server presents a list of CA certificates that are not direct signers
1736 of one of the configured client certificates.
1737 </p>
1738 <p>
1739 This referenced file is simply the concatenation of the various PEM-encoded
1740 certificate files. Upon startup, each client certificate configured will
1741 be examined and a chain of trust will be constructed.
1742 </p>
1743 <div class="warning"><h3>Security warning</h3>
1744 <p>If this directive is enabled, all of the certificates in the file will be
1745 trusted as if they were also in <code class="directive"><a href="#sslproxycacertificatefile">
1746 SSLProxyCACertificateFile</a></code>.</p>
1747 </div>
1748 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyMachineCertificateChainFile /usr/local/apache2/conf/ssl.crt/proxyCA.pem</pre>
1749 </div>
1750
1751 </div>
1752 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1753 <div class="directive-section"><h2><a name="SSLProxyMachineCertificateFile" id="SSLProxyMachineCertificateFile">SSLProxyMachineCertificateFile</a> <a name="sslproxymachinecertificatefile" id="sslproxymachinecertificatefile">Directive</a></h2>
1754 <table class="directive">
1755 <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>
1756 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificateFile <em>filename</em></code></td></tr>
1757 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1758 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1759 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1760 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1761 </table>
1762 <p>
1763 This directive sets the all-in-one file where you keep the certificates and
1764 keys used for authentication of the proxy server to remote servers.
1765 </p>
1766 <p>
1767 This referenced file is simply the concatenation of the various PEM-encoded
1768 certificate files, in order of preference. Use this directive alternatively
1769 or additionally to <code>SSLProxyMachineCertificatePath</code>.
1770 </p>
1771 <div class="warning">
1772 <p>Currently there is no support for encrypted private keys</p>
1773 </div>
1774 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyMachineCertificateFile /usr/local/apache2/conf/ssl.crt/proxy.pem</pre>
1775 </div>
1776
1777 </div>
1778 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1779 <div class="directive-section"><h2><a name="SSLProxyMachineCertificatePath" id="SSLProxyMachineCertificatePath">SSLProxyMachineCertificatePath</a> <a name="sslproxymachinecertificatepath" id="sslproxymachinecertificatepath">Directive</a></h2>
1780 <table class="directive">
1781 <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>
1782 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificatePath <em>directory</em></code></td></tr>
1783 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1784 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1785 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1786 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1787 </table>
1788 <p>
1789 This directive sets the directory where you keep the certificates and
1790 keys used for authentication of the proxy server to remote servers.
1791 </p>
1792 <p>The files in this directory must be PEM-encoded and are accessed through
1793 hash filenames. Additionally, you must create symbolic links named
1794 <code><em>hash-value</em>.N</code>. And you should always make sure this
1795 directory contains the appropriate symbolic links.</p>
1796 <div class="warning">
1797 <p>Currently there is no support for encrypted private keys</p>
1798 </div>
1799 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyMachineCertificatePath /usr/local/apache2/conf/proxy.crt/</pre>
1800 </div>
1801
1802 </div>
1803 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1804 <div class="directive-section"><h2><a name="SSLProxyProtocol" id="SSLProxyProtocol">SSLProxyProtocol</a> <a name="sslproxyprotocol" id="sslproxyprotocol">Directive</a></h2>
1805 <table class="directive">
1806 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure usable SSL protocol flavors for proxy usage</td></tr>
1807 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyProtocol [+|-]<em>protocol</em> ...</code></td></tr>
1808 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyProtocol all -SSLv3</code></td></tr>
1809 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1810 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1811 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1812 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1813 </table>
1814
1815 <p>
1816 This directive can be used to control the SSL protocol flavors mod_ssl should
1817 use when establishing its server environment for proxy . It will only connect
1818 to servers using one of the provided protocols.</p>
1819 <p>Please refer to <code class="directive"><a href="#sslprotocol">SSLProtocol</a></code>
1820 for additional information.
1821 </p>
1822
1823 </div>
1824 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1825 <div class="directive-section"><h2><a name="SSLProxyVerify" id="SSLProxyVerify">SSLProxyVerify</a> <a name="sslproxyverify" id="sslproxyverify">Directive</a></h2>
1826 <table class="directive">
1827 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of remote server Certificate verification</td></tr>
1828 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyVerify <em>level</em></code></td></tr>
1829 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyVerify none</code></td></tr>
1830 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1831 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1832 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1833 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1834 </table>
1835
1836 <p>When a proxy is configured to forward requests to a remote SSL
1837 server, this directive can be used to configure certificate
1838 verification of the remote server. </p>
1839 <p>
1840 The following levels are available for <em>level</em>:</p>
1841 <ul>
1842 <li><strong>none</strong>:
1843      no remote server Certificate is required at all</li>
1844 <li><strong>optional</strong>:
1845      the remote server <em>may</em> present a valid Certificate</li>
1846 <li><strong>require</strong>:
1847      the remote server <em>has to</em> present a valid Certificate</li>
1848 <li><strong>optional_no_ca</strong>:
1849      the remote server may present a valid Certificate<br />
1850      but it need not to be (successfully) verifiable.</li>
1851 </ul>
1852 <p>In practice only levels <strong>none</strong> and
1853 <strong>require</strong> are really interesting, because level
1854 <strong>optional</strong> doesn't work with all servers and level
1855 <strong>optional_no_ca</strong> is actually against the idea of
1856 authentication (but can be used to establish SSL test pages, etc.)</p>
1857 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyVerify require</pre>
1858 </div>
1859
1860 </div>
1861 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1862 <div class="directive-section"><h2><a name="SSLProxyVerifyDepth" id="SSLProxyVerifyDepth">SSLProxyVerifyDepth</a> <a name="sslproxyverifydepth" id="sslproxyverifydepth">Directive</a></h2>
1863 <table class="directive">
1864 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum depth of CA Certificates in Remote Server
1865 Certificate verification</td></tr>
1866 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyVerifyDepth <em>number</em></code></td></tr>
1867 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyVerifyDepth 1</code></td></tr>
1868 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1869 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1870 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1871 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1872 </table>
1873 <p>
1874 This directive sets how deeply mod_ssl should verify before deciding that the
1875 remote server does not have a valid certificate. </p>
1876 <p>
1877 The depth actually is the maximum number of intermediate certificate issuers,
1878 i.e. the number of CA certificates which are max allowed to be followed while
1879 verifying the remote server certificate. A depth of 0 means that self-signed
1880 remote server certificates are accepted only, the default depth of 1 means
1881 the remote server certificate can be self-signed or has to be signed by a CA
1882 which is directly known to the server (i.e. the CA's certificate is under
1883 <code class="directive"><a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></code>), etc.</p>
1884 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyVerifyDepth 10</pre>
1885 </div>
1886
1887 </div>
1888 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1889 <div class="directive-section"><h2><a name="SSLRandomSeed" id="SSLRandomSeed">SSLRandomSeed</a> <a name="sslrandomseed" id="sslrandomseed">Directive</a></h2>
1890 <table class="directive">
1891 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pseudo Random Number Generator (PRNG) seeding
1892 source</td></tr>
1893 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRandomSeed <em>context</em> <em>source</em>
1894 [<em>bytes</em>]</code></td></tr>
1895 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1896 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1897 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1898 </table>
1899 <p>
1900 This configures one or more sources for seeding the Pseudo Random Number
1901 Generator (PRNG) in OpenSSL at startup time (<em>context</em> is
1902 <code>startup</code>) and/or just before a new SSL connection is established
1903 (<em>context</em> is <code>connect</code>). This directive can only be used
1904 in the global server context because the PRNG is a global facility.</p>
1905 <p>
1906 The following <em>source</em> variants are available:</p>
1907 <ul>
1908 <li><code>builtin</code>
1909     <p> This is the always available builtin seeding source. Its usage
1910     consumes minimum CPU cycles under runtime and hence can be always used
1911     without drawbacks. The source used for seeding the PRNG contains of the
1912     current time, the current process id and (when applicable) a randomly
1913     chosen 1KB extract of the inter-process scoreboard structure of Apache.
1914     The drawback is that this is not really a strong source and at startup
1915     time (where the scoreboard is still not available) this source just
1916     produces a few bytes of entropy. So you should always, at least for the
1917     startup, use an additional seeding source.</p></li>
1918 <li><code>file:/path/to/source</code>
1919     <p>
1920     This variant uses an external file <code>/path/to/source</code> as the
1921     source for seeding the PRNG. When <em>bytes</em> is specified, only the
1922     first <em>bytes</em> number of bytes of the file form the entropy (and
1923     <em>bytes</em> is given to <code>/path/to/source</code> as the first
1924     argument). When <em>bytes</em> is not specified the whole file forms the
1925     entropy (and <code>0</code> is given to <code>/path/to/source</code> as
1926     the first argument). Use this especially at startup time, for instance
1927     with an available <code>/dev/random</code> and/or
1928     <code>/dev/urandom</code> devices (which usually exist on modern Unix
1929     derivatives like FreeBSD and Linux).</p>
1930     <p>
1931     <em>But be careful</em>: Usually <code>/dev/random</code> provides only as
1932     much entropy data as it actually has, i.e. when you request 512 bytes of
1933     entropy, but the device currently has only 100 bytes available two things
1934     can happen: On some platforms you receive only the 100 bytes while on
1935     other platforms the read blocks until enough bytes are available (which
1936     can take a long time). Here using an existing <code>/dev/urandom</code> is
1937     better, because it never blocks and actually gives the amount of requested
1938     data. The drawback is just that the quality of the received data may not
1939     be the best.</p></li>
1940
1941 <li><code>exec:/path/to/program</code>
1942     <p>
1943     This variant uses an external executable
1944     <code>/path/to/program</code> as the source for seeding the
1945     PRNG. When <em>bytes</em> is specified, only the first
1946     <em>bytes</em> number of bytes of its <code>stdout</code> contents
1947     form the entropy. When <em>bytes</em> is not specified, the
1948     entirety of the data produced on <code>stdout</code> form the
1949     entropy. Use this only at startup time when you need a very strong
1950     seeding with the help of an external program (for instance as in
1951     the example above with the <code>truerand</code> utility you can
1952     find in the mod_ssl distribution which is based on the AT&amp;T
1953     <em>truerand</em> library). Using this in the connection context
1954     slows down the server too dramatically, of course.  So usually you
1955     should avoid using external programs in that context.</p></li>
1956 <li><code>egd:/path/to/egd-socket</code> (Unix only)
1957     <p>
1958     This variant uses the Unix domain socket of the
1959     external Entropy Gathering Daemon (EGD) (see <a href="http://www.lothar.com/tech/crypto/">http://www.lothar.com/tech
1960     /crypto/</a>) to seed the PRNG. Use this if no random device exists
1961     on your platform.</p></li>
1962 </ul>
1963 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRandomSeed startup builtin
1964 SSLRandomSeed startup file:/dev/random
1965 SSLRandomSeed startup file:/dev/urandom 1024
1966 SSLRandomSeed startup exec:/usr/local/bin/truerand 16
1967 SSLRandomSeed connect builtin
1968 SSLRandomSeed connect file:/dev/random
1969 SSLRandomSeed connect file:/dev/urandom 1024</pre>
1970 </div>
1971
1972 </div>
1973 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1974 <div class="directive-section"><h2><a name="SSLRenegBufferSize" id="SSLRenegBufferSize">SSLRenegBufferSize</a> <a name="sslrenegbuffersize" id="sslrenegbuffersize">Directive</a></h2>
1975 <table class="directive">
1976 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the size for the SSL renegotiation buffer</td></tr>
1977 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRenegBufferSize <var>bytes</var></code></td></tr>
1978 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLRenegBufferSize 131072</code></td></tr>
1979 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
1980 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
1981 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1982 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1983 </table>
1984
1985 <p>If an SSL renegotiation is required in per-location context, for
1986 example, any use of <code class="directive"><a href="#sslverifyclient">SSLVerifyClient</a></code> in a Directory or
1987 Location block, then <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> must buffer any HTTP
1988 request body into memory until the new SSL handshake can be performed.
1989 This directive can be used to set the amount of memory that will be
1990 used for this buffer. </p>
1991
1992 <div class="warning"><p>
1993 Note that in many configurations, the client sending the request body
1994 will be untrusted so a denial of service attack by consumption of
1995 memory must be considered when changing this configuration setting.
1996 </p></div>
1997
1998 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRenegBufferSize 262144</pre>
1999 </div>
2000
2001 </div>
2002 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2003 <div class="directive-section"><h2><a name="SSLRequire" id="SSLRequire">SSLRequire</a> <a name="sslrequire" id="sslrequire">Directive</a></h2>
2004 <table class="directive">
2005 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow access only when an arbitrarily complex
2006 boolean expression is true</td></tr>
2007 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRequire <em>expression</em></code></td></tr>
2008 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2009 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2010 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2011 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2012 </table>
2013
2014 <div class="note"><h3>SSLRequire is deprecated</h3>
2015 <p><code>SSLRequire</code> is deprecated and should in general be replaced
2016 by <a href="mod_authz_core.html#reqexpr">Require expr</a>. The so called
2017 <a href="../expr.html">ap_expr</a> syntax of <code>Require expr</code> is
2018 a superset of the syntax of <code>SSLRequire</code>, with the following
2019 exception:</p>
2020
2021 <p>In <code>SSLRequire</code>, the comparison operators <code>&lt;</code>,
2022 <code>&lt;=</code>, ... are completely equivalent to the operators
2023 <code>lt</code>, <code>le</code>, ... and work in a somewhat peculiar way that
2024 first compares the length of two strings and then the lexical order.
2025 On the other hand, <a href="../expr.html">ap_expr</a> has two sets of
2026 comparison operators: The operators <code>&lt;</code>,
2027 <code>&lt;=</code>, ... do lexical string comparison, while the operators
2028 <code>-lt</code>, <code>-le</code>, ... do integer comparison.
2029 For the latter, there are also aliases without the leading dashes:
2030 <code>lt</code>, <code>le</code>, ...
2031 </p>
2032
2033 </div>
2034
2035 <p>
2036 This directive specifies a general access requirement which has to be
2037 fulfilled in order to allow access. It is a very powerful directive because the
2038 requirement specification is an arbitrarily complex boolean expression
2039 containing any number of access checks.</p>
2040 <p>
2041 The <em>expression</em> must match the following syntax (given as a BNF
2042 grammar notation):</p>
2043 <blockquote>
2044 <pre>expr     ::= "<strong>true</strong>" | "<strong>false</strong>"
2045            | "<strong>!</strong>" expr
2046            | expr "<strong>&amp;&amp;</strong>" expr
2047            | expr "<strong>||</strong>" expr
2048            | "<strong>(</strong>" expr "<strong>)</strong>"
2049            | comp
2050
2051 comp     ::= word "<strong>==</strong>" word | word "<strong>eq</strong>" word
2052            | word "<strong>!=</strong>" word | word "<strong>ne</strong>" word
2053            | word "<strong>&lt;</strong>"  word | word "<strong>lt</strong>" word
2054            | word "<strong>&lt;=</strong>" word | word "<strong>le</strong>" word
2055            | word "<strong>&gt;</strong>"  word | word "<strong>gt</strong>" word
2056            | word "<strong>&gt;=</strong>" word | word "<strong>ge</strong>" word
2057            | word "<strong>in</strong>" "<strong>{</strong>" wordlist "<strong>}</strong>"
2058            | word "<strong>in</strong>" "<strong>PeerExtList(</strong>" word "<strong>)</strong>"
2059            | word "<strong>=~</strong>" regex
2060            | word "<strong>!~</strong>" regex
2061
2062 wordlist ::= word
2063            | wordlist "<strong>,</strong>" word
2064
2065 word     ::= digit
2066            | cstring
2067            | variable
2068            | function
2069
2070 digit    ::= [0-9]+
2071 cstring  ::= "..."
2072 variable ::= "<strong>%{</strong>" varname "<strong>}</strong>"
2073 function ::= funcname "<strong>(</strong>" funcargs "<strong>)</strong>"</pre>
2074 </blockquote>
2075 <p>For <code>varname</code> any of the variables described in <a href="#envvars">Environment Variables</a> can be used.  For
2076 <code>funcname</code> the available functions are listed in
2077 the <a href="../expr.html#functions">ap_expr documentation</a>.</p>
2078
2079 <p>The <em>expression</em> is parsed into an internal machine
2080 representation when the configuration is loaded, and then evaluated
2081 during request processing.  In .htaccess context, the <em>expression</em> is
2082 both parsed and executed each time the .htaccess file is encountered during
2083 request processing.</p>
2084
2085 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRequire (    %{SSL_CIPHER} !~ m/^(EXP|NULL)-/                   \
2086             and %{SSL_CLIENT_S_DN_O} eq "Snake Oil, Ltd."          \
2087             and %{SSL_CLIENT_S_DN_OU} in {"Staff", "CA", "Dev"}    \
2088             and %{TIME_WDAY} -ge 1 and %{TIME_WDAY} -le 5          \
2089             and %{TIME_HOUR} -ge 8 and %{TIME_HOUR} -le 20       ) \
2090            or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/</pre>
2091 </div>
2092
2093 <p>The <code>PeerExtList(<em>object-ID</em>)</code> function expects
2094 to find zero or more instances of the X.509 certificate extension
2095 identified by the given <em>object ID</em> (OID) in the client certificate.
2096 The expression evaluates to true if the left-hand side string matches
2097 exactly against the value of an extension identified with this OID.
2098 (If multiple extensions with the same OID are present, at least one
2099 extension must match).</p>
2100
2101 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRequire "foobar" in PeerExtList("1.2.3.4.5.6")</pre>
2102 </div>
2103
2104 <div class="note"><h3>Notes on the PeerExtList function</h3>
2105
2106 <ul>
2107
2108 <li><p>The object ID can be specified either as a descriptive
2109 name recognized by the SSL library, such as <code>"nsComment"</code>,
2110 or as a numeric OID, such as <code>"1.2.3.4.5.6"</code>.</p></li>
2111
2112 <li><p>Expressions with types known to the SSL library are rendered to
2113 a string before comparison.  For an extension with a type not
2114 recognized by the SSL library, mod_ssl will parse the value if it is
2115 one of the primitive ASN.1 types UTF8String, IA5String, VisibleString,
2116 or BMPString.  For an extension of one of these types, the string
2117 value will be converted to UTF-8 if necessary, then compared against
2118 the left-hand-side expression.</p></li>
2119
2120 </ul>
2121 </div>
2122
2123
2124 <h3>See also</h3>
2125 <ul>
2126 <li><a href="../env.html">Environment Variables in Apache HTTP Server</a>,
2127 for additional examples.
2128 </li>
2129 <li><a href="mod_authz_core.html#reqexpr">Require expr</a></li>
2130 <li><a href="../expr.html">Generic expression syntax in Apache HTTP Server</a>
2131 </li>
2132 </ul>
2133 </div>
2134 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2135 <div class="directive-section"><h2><a name="SSLRequireSSL" id="SSLRequireSSL">SSLRequireSSL</a> <a name="sslrequiressl" id="sslrequiressl">Directive</a></h2>
2136 <table class="directive">
2137 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Deny access when SSL is not used for the
2138 HTTP request</td></tr>
2139 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRequireSSL</code></td></tr>
2140 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2141 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2142 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2143 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2144 </table>
2145 <p>
2146 This directive forbids access unless HTTP over SSL (i.e. HTTPS) is enabled for
2147 the current connection. This is very handy inside the SSL-enabled virtual
2148 host or directories for defending against configuration errors that expose
2149 stuff that should be protected. When this directive is present all requests
2150 are denied which are not using SSL.</p>
2151 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRequireSSL</pre>
2152 </div>
2153
2154 </div>
2155 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2156 <div class="directive-section"><h2><a name="SSLSessionCache" id="SSLSessionCache">SSLSessionCache</a> <a name="sslsessioncache" id="sslsessioncache">Directive</a></h2>
2157 <table class="directive">
2158 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of the global/inter-process SSL Session
2159 Cache</td></tr>
2160 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionCache <em>type</em></code></td></tr>
2161 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionCache none</code></td></tr>
2162 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
2163 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2164 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2165 </table>
2166 <p>
2167 This configures the storage type of the global/inter-process SSL Session
2168 Cache. This cache is an optional facility which speeds up parallel request
2169 processing. For requests to the same server process (via HTTP keep-alive),
2170 OpenSSL already caches the SSL session information locally. But because modern
2171 clients request inlined images and other data via parallel requests (usually
2172 up to four parallel requests are common) those requests are served by
2173 <em>different</em> pre-forked server processes. Here an inter-process cache
2174 helps to avoid unnecessary session handshakes.</p>
2175 <p>
2176 The following five storage <em>type</em>s are currently supported:</p>
2177 <ul>
2178 <li><code>none</code>
2179
2180     <p>This disables the global/inter-process Session Cache.  This
2181     will incur a noticeable speed penalty and may cause problems if
2182     using certain browsers, particularly if client certificates are
2183     enabled.  This setting is not recommended.</p></li>
2184
2185 <li><code>nonenotnull</code>
2186
2187     <p>This disables any global/inter-process Session Cache.  However
2188     it does force OpenSSL to send a non-null session ID to
2189     accommodate buggy clients that require one.</p></li>
2190
2191 <li><code>dbm:/path/to/datafile</code>
2192
2193     <p>This makes use of a DBM hashfile on the local disk to
2194     synchronize the local OpenSSL memory caches of the server
2195     processes. This session cache may suffer reliability issues under
2196     high load. To use this, ensure that
2197     <code class="module"><a href="../mod/mod_socache_dbm.html">mod_socache_dbm</a></code> is loaded.</p></li>
2198
2199 <li><code>shmcb:/path/to/datafile</code>[<code>(</code><em>size</em><code>)</code>]
2200
2201     <p>This makes use of a high-performance cyclic buffer
2202     (approx. <em>size</em> bytes in size) inside a shared memory
2203     segment in RAM (established via <code>/path/to/datafile</code>) to
2204     synchronize the local OpenSSL memory caches of the server
2205     processes.  This is the recommended session cache. To use this,
2206     ensure that <code class="module"><a href="../mod/mod_socache_shmcb.html">mod_socache_shmcb</a></code> is loaded.</p></li>
2207
2208 <li><code>dc:UNIX:/path/to/socket</code>
2209
2210     <p>This makes use of the <a href="http://distcache.sourceforge.net/">distcache</a> distributed session
2211     caching libraries.  The argument should specify the location of
2212     the server or proxy to be used using the distcache address syntax;
2213     for example, <code>UNIX:/path/to/socket</code> specifies a UNIX
2214     domain socket (typically a local dc_client proxy);
2215     <code>IP:server.example.com:9001</code> specifies an IP
2216     address. To use this, ensure that
2217     <code class="module"><a href="../mod/mod_socache_dc.html">mod_socache_dc</a></code> is loaded.</p></li>
2218
2219 </ul>
2220
2221 <div class="example"><h3>Examples</h3><pre class="prettyprint lang-config">SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data
2222 SSLSessionCache shmcb:/usr/local/apache/logs/ssl_gcache_data(512000)</pre>
2223 </div>
2224
2225 <p>The <code>ssl-cache</code> mutex is used to serialize access to
2226 the session cache to prevent corruption.  This mutex can be configured
2227 using the <code class="directive"><a href="../mod/core.html#mutex">Mutex</a></code> directive.</p>
2228
2229 </div>
2230 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2231 <div class="directive-section"><h2><a name="SSLSessionCacheTimeout" id="SSLSessionCacheTimeout">SSLSessionCacheTimeout</a> <a name="sslsessioncachetimeout" id="sslsessioncachetimeout">Directive</a></h2>
2232 <table class="directive">
2233 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of seconds before an SSL session expires
2234 in the Session Cache</td></tr>
2235 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionCacheTimeout <em>seconds</em></code></td></tr>
2236 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionCacheTimeout 300</code></td></tr>
2237 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2238 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2239 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2240 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Applies also to RFC 5077 TLS session resumption in Apache 2.4.10 and later</td></tr>
2241 </table>
2242 <p>
2243 This directive sets the timeout in seconds for the information stored in the
2244 global/inter-process SSL Session Cache, the OpenSSL internal memory cache and
2245 for sessions resumed by TLS session resumption (RFC 5077).
2246 It can be set as low as 15 for testing, but should be set to higher
2247 values like 300 in real life.</p>
2248 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLSessionCacheTimeout 600</pre>
2249 </div>
2250
2251 </div>
2252 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2253 <div class="directive-section"><h2><a name="SSLSessionTicketKeyFile" id="SSLSessionTicketKeyFile">SSLSessionTicketKeyFile</a> <a name="sslsessionticketkeyfile" id="sslsessionticketkeyfile">Directive</a></h2>
2254 <table class="directive">
2255 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Persistent encryption/decryption key for TLS session tickets</td></tr>
2256 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionTicketKeyFile <em>file-path</em></code></td></tr>
2257 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2258 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2259 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2260 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.0 and later, if using OpenSSL 0.9.8h or later</td></tr>
2261 </table>
2262 <p>Optionally configures a secret key for encrypting and decrypting
2263 TLS session tickets, as defined in
2264 <a href="http://www.ietf.org/rfc/rfc5077.txt">RFC 5077</a>.
2265 Primarily suitable for clustered environments where TLS sessions information
2266 should be shared between multiple nodes. For single-instance httpd setups,
2267 it is recommended to <em>not</em> configure a ticket key file, but to
2268 rely on (random) keys generated by mod_ssl at startup, instead.</p>
2269 <p>The ticket key file must contain 48 bytes of random data,
2270 preferrably created from a high-entropy source. On a Unix-based system,
2271 a ticket key file can be created as follows:</p>
2272
2273 <div class="example"><p><code>
2274 dd if=/dev/random of=/path/to/file.tkey bs=1 count=48
2275 </code></p></div>
2276
2277 <p>Ticket keys should be rotated (replaced) on a frequent basis,
2278 as this is the only way to invalidate an existing session ticket -
2279 OpenSSL currently doesn't allow to specify a limit for ticket lifetimes.
2280 A new ticket key only gets used after restarting the web server.
2281 All existing session tickets become invalid after a restart.</p>
2282
2283 <div class="warning">
2284 <p>The ticket key file contains sensitive keying material and should
2285 be protected with file permissions similar to those used for
2286 <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>.</p>
2287 </div>
2288
2289 </div>
2290 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2291 <div class="directive-section"><h2><a name="SSLSessionTickets" id="SSLSessionTickets">SSLSessionTickets</a> <a name="sslsessiontickets" id="sslsessiontickets">Directive</a></h2>
2292 <table class="directive">
2293 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable or disable use of TLS session tickets</td></tr>
2294 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionTickets on|off</code></td></tr>
2295 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionTickets on</code></td></tr>
2296 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2297 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2298 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2299 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.11 and later, if using OpenSSL 0.9.8f
2300 or later.</td></tr>
2301 </table>
2302 <p>This directive allows to enable or disable the use of TLS session tickets
2303 (RFC 5077).</p>
2304 <div class="warning">
2305 <p>TLS session tickets are enabled by default. Using them without restarting
2306 the web server with an appropriate frequency (e.g. daily) compromises perfect
2307 forward secrecy.</p>
2308 </div>
2309
2310 </div>
2311 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2312 <div class="directive-section"><h2><a name="SSLSRPUnknownUserSeed" id="SSLSRPUnknownUserSeed">SSLSRPUnknownUserSeed</a> <a name="sslsrpunknownuserseed" id="sslsrpunknownuserseed">Directive</a></h2>
2313 <table class="directive">
2314 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SRP unknown user seed</td></tr>
2315 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSRPUnknownUserSeed <em>secret-string</em></code></td></tr>
2316 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2317 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2318 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2319 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.4 and later, if using OpenSSL 1.0.1 or
2320 later</td></tr>
2321 </table>
2322 <p>
2323 This directive sets the seed used to fake SRP user parameters for unknown
2324 users, to avoid leaking whether a given user exists. Specify a secret
2325 string. If this directive is not used, then Apache will return the
2326 UNKNOWN_PSK_IDENTITY alert to clients who specify an unknown username.
2327 </p>
2328 <div class="example"><h3>Example</h3><p><code>
2329 SSLSRPUnknownUserSeed "secret"
2330 </code></p></div>
2331
2332 </div>
2333 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2334 <div class="directive-section"><h2><a name="SSLSRPVerifierFile" id="SSLSRPVerifierFile">SSLSRPVerifierFile</a> <a name="sslsrpverifierfile" id="sslsrpverifierfile">Directive</a></h2>
2335 <table class="directive">
2336 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Path to SRP verifier file</td></tr>
2337 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSRPVerifierFile <em>file-path</em></code></td></tr>
2338 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2339 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2340 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2341 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.4 and later, if using OpenSSL 1.0.1 or
2342 later</td></tr>
2343 </table>
2344 <p>
2345 This directive enables TLS-SRP and sets the path to the OpenSSL SRP (Secure
2346 Remote Password) verifier file containing TLS-SRP usernames, verifiers, salts,
2347 and group parameters.</p>
2348 <div class="example"><h3>Example</h3><p><code>
2349 SSLSRPVerifierFile "/path/to/file.srpv"
2350 </code></p></div>
2351 <p>
2352 The verifier file can be created with the <code>openssl</code> command line
2353 utility:</p>
2354 <div class="example"><h3>Creating the SRP verifier file</h3><p><code>
2355 openssl srp -srpvfile passwd.srpv -userinfo "some info" -add username
2356 </code></p></div>
2357 <p> The value given with the optional <code>-userinfo</code> parameter is
2358 avalable in the <code>SSL_SRP_USERINFO</code> request environment variable.</p>
2359
2360
2361 </div>
2362 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2363 <div class="directive-section"><h2><a name="SSLStaplingCache" id="SSLStaplingCache">SSLStaplingCache</a> <a name="sslstaplingcache" id="sslstaplingcache">Directive</a></h2>
2364 <table class="directive">
2365 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the OCSP stapling cache</td></tr>
2366 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingCache <em>type</em></code></td></tr>
2367 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
2368 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2369 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2370 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2371 </table>
2372 <p>Configures the cache used to store OCSP responses which get included
2373 in the TLS handshake if <code class="directive"><a href="#sslusestapling">SSLUseStapling</a></code>
2374 is enabled. Configuration of a cache is mandatory for OCSP stapling.
2375 With the exception of <code>none</code> and <code>nonenotnull</code>,
2376 the same storage types are supported as with
2377 <code class="directive"><a href="#sslsessioncache">SSLSessionCache</a></code>.</p>
2378
2379 </div>
2380 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2381 <div class="directive-section"><h2><a name="SSLStaplingErrorCacheTimeout" id="SSLStaplingErrorCacheTimeout">SSLStaplingErrorCacheTimeout</a> <a name="sslstaplingerrorcachetimeout" id="sslstaplingerrorcachetimeout">Directive</a></h2>
2382 <table class="directive">
2383 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of seconds before expiring invalid responses in the OCSP stapling cache</td></tr>
2384 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingErrorCacheTimeout <em>seconds</em></code></td></tr>
2385 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingErrorCacheTimeout 600</code></td></tr>
2386 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2387 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2388 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2389 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2390 </table>
2391 <p>Sets the timeout in seconds before <em>invalid</em> responses
2392 in the OCSP stapling cache (configured through <code class="directive"><a href="#sslstaplingcache">SSLStaplingCache</a></code>) will expire.
2393 To set the cache timeout for valid responses, see
2394 <code class="directive"><a href="#sslstaplingstandardcachetimeout">SSLStaplingStandardCacheTimeout</a></code>.</p>
2395
2396 </div>
2397 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2398 <div class="directive-section"><h2><a name="SSLStaplingFakeTryLater" id="SSLStaplingFakeTryLater">SSLStaplingFakeTryLater</a> <a name="sslstaplingfaketrylater" id="sslstaplingfaketrylater">Directive</a></h2>
2399 <table class="directive">
2400 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Synthesize "tryLater" responses for failed OCSP stapling queries</td></tr>
2401 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingFakeTryLater on|off</code></td></tr>
2402 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingFakeTryLater on</code></td></tr>
2403 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2404 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2405 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2406 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2407 </table>
2408 <p>When enabled and a query to an OCSP responder for stapling
2409 purposes fails, mod_ssl will synthesize a "tryLater" response for the
2410 client. Only effective if <code class="directive"><a href="#sslstaplingreturnrespondererrors">SSLStaplingReturnResponderErrors</a></code>
2411 is also enabled.</p>
2412
2413 </div>
2414 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2415 <div class="directive-section"><h2><a name="SSLStaplingForceURL" id="SSLStaplingForceURL">SSLStaplingForceURL</a> <a name="sslstaplingforceurl" id="sslstaplingforceurl">Directive</a></h2>
2416 <table class="directive">
2417 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Override the OCSP responder URI specified in the certificate's AIA extension</td></tr>
2418 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingForceURL <em>uri</em></code></td></tr>
2419 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2420 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2421 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2422 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2423 </table>
2424 <p>This directive overrides the URI of an OCSP responder as obtained from
2425 the authorityInfoAccess (AIA) extension of the certificate.
2426 One potential use is when a proxy is used for retrieving OCSP queries.</p>
2427
2428 </div>
2429 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2430 <div class="directive-section"><h2><a name="SSLStaplingResponderTimeout" id="SSLStaplingResponderTimeout">SSLStaplingResponderTimeout</a> <a name="sslstaplingrespondertimeout" id="sslstaplingrespondertimeout">Directive</a></h2>
2431 <table class="directive">
2432 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Timeout for OCSP stapling queries</td></tr>
2433 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingResponderTimeout <em>seconds</em></code></td></tr>
2434 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingResponderTimeout 10</code></td></tr>
2435 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2436 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2437 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2438 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2439 </table>
2440 <p>This option sets the timeout for queries to OCSP responders when
2441 <code class="directive"><a href="#sslusestapling">SSLUseStapling</a></code> is enabled
2442 and mod_ssl is querying a responder for OCSP stapling purposes.</p>
2443
2444 </div>
2445 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2446 <div class="directive-section"><h2><a name="SSLStaplingResponseMaxAge" id="SSLStaplingResponseMaxAge">SSLStaplingResponseMaxAge</a> <a name="sslstaplingresponsemaxage" id="sslstaplingresponsemaxage">Directive</a></h2>
2447 <table class="directive">
2448 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum allowable age for OCSP stapling responses</td></tr>
2449 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingResponseMaxAge <em>seconds</em></code></td></tr>
2450 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingResponseMaxAge -1</code></td></tr>
2451 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2452 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2453 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2454 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2455 </table>
2456 <p>This option sets the maximum allowable age ("freshness") when
2457 considering OCSP responses for stapling purposes, i.e. when
2458 <code class="directive"><a href="#sslusestapling">SSLUseStapling</a></code> is turned on.
2459 The default value (<code>-1</code>) does not enforce a maximum age,
2460 which means that OCSP responses are considered valid as long as their
2461 <code>nextUpdate</code> field is in the future.</p>
2462
2463 </div>
2464 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2465 <div class="directive-section"><h2><a name="SSLStaplingResponseTimeSkew" id="SSLStaplingResponseTimeSkew">SSLStaplingResponseTimeSkew</a> <a name="sslstaplingresponsetimeskew" id="sslstaplingresponsetimeskew">Directive</a></h2>
2466 <table class="directive">
2467 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum allowable time skew for OCSP stapling response validation</td></tr>
2468 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingResponseTimeSkew <em>seconds</em></code></td></tr>
2469 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingResponseTimeSkew 300</code></td></tr>
2470 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2471 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2472 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2473 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2474 </table>
2475 <p>This option sets the maximum allowable time skew when mod_ssl checks the
2476 <code>thisUpdate</code> and <code>nextUpdate</code> fields of OCSP responses
2477 which get included in the TLS handshake (OCSP stapling). Only applicable
2478 if <code class="directive"><a href="#sslusestapling">SSLUseStapling</a></code> is turned on.</p>
2479
2480 </div>
2481 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2482 <div class="directive-section"><h2><a name="SSLStaplingReturnResponderErrors" id="SSLStaplingReturnResponderErrors">SSLStaplingReturnResponderErrors</a> <a name="sslstaplingreturnrespondererrors" id="sslstaplingreturnrespondererrors">Directive</a></h2>
2483 <table class="directive">
2484 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pass stapling related OCSP errors on to client</td></tr>
2485 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingReturnResponderErrors on|off</code></td></tr>
2486 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingReturnResponderErrors on</code></td></tr>
2487 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2488 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2489 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2490 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2491 </table>
2492 <p>When enabled, mod_ssl will pass responses from unsuccessful
2493 stapling related OCSP queries (such as responses with an overall status
2494 other than "successful", responses with a certificate status other than
2495 "good", expired responses etc.) on to the client.
2496 If set to <code>off</code>, only responses indicating a certificate status
2497 of "good" will be included in the TLS handshake.</p>
2498
2499 </div>
2500 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2501 <div class="directive-section"><h2><a name="SSLStaplingStandardCacheTimeout" id="SSLStaplingStandardCacheTimeout">SSLStaplingStandardCacheTimeout</a> <a name="sslstaplingstandardcachetimeout" id="sslstaplingstandardcachetimeout">Directive</a></h2>
2502 <table class="directive">
2503 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of seconds before expiring responses in the OCSP stapling cache</td></tr>
2504 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingStandardCacheTimeout <em>seconds</em></code></td></tr>
2505 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingStandardCacheTimeout 3600</code></td></tr>
2506 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2507 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2508 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2509 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2510 </table>
2511 <p>Sets the timeout in seconds before responses in the OCSP stapling cache
2512 (configured through <code class="directive"><a href="#sslstaplingcache">SSLStaplingCache</a></code>)
2513 will expire. This directive applies to <em>valid</em> responses, while
2514 <code class="directive"><a href="#sslstaplingerrorcachetimeout">SSLStaplingErrorCacheTimeout</a></code> is
2515 used for controlling the timeout for invalid/unavailable responses.
2516 </p>
2517
2518 </div>
2519 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2520 <div class="directive-section"><h2><a name="SSLStrictSNIVHostCheck" id="SSLStrictSNIVHostCheck">SSLStrictSNIVHostCheck</a> <a name="sslstrictsnivhostcheck" id="sslstrictsnivhostcheck">Directive</a></h2>
2521 <table class="directive">
2522 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether to allow non-SNI clients to access a name-based virtual
2523 host.
2524 </td></tr>
2525 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStrictSNIVHostCheck on|off</code></td></tr>
2526 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStrictSNIVHostCheck off</code></td></tr>
2527 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2528 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2529 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2530 </table>
2531 <p>
2532 This directive sets whether a non-SNI client is allowed to access a name-based
2533 virtual host. If set to <code>on</code> in the default name-based virtual
2534 host, clients that are SNI unaware will not be allowed to access <em>any</em>
2535 virtual host, belonging to this particular IP / port combination.
2536 If set to <code>on</code> in any other virtual host, SNI unaware clients
2537 are not allowed to access this particular virtual host.
2538 </p>
2539
2540 <div class="warning"><p>
2541 This option is only available if httpd was compiled against an SNI capable
2542 version of OpenSSL.
2543 </p></div>
2544
2545 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLStrictSNIVHostCheck on</pre>
2546 </div>
2547
2548 </div>
2549 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2550 <div class="directive-section"><h2><a name="SSLUserName" id="SSLUserName">SSLUserName</a> <a name="sslusername" id="sslusername">Directive</a></h2>
2551 <table class="directive">
2552 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Variable name to determine user name</td></tr>
2553 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLUserName <em>varname</em></code></td></tr>
2554 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, directory, .htaccess</td></tr>
2555 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2556 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2557 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2558 </table>
2559 <p>
2560 This directive sets the "user" field in the Apache request object.
2561 This is used by lower modules to identify the user with a character
2562 string. In particular, this may cause the environment variable
2563 <code>REMOTE_USER</code> to be set.  The <em>varname</em> can be
2564 any of the <a href="#envvars">SSL environment variables</a>.</p>
2565
2566 <p>When the <code>FakeBasicAuth</code> option is enabled, this directive
2567 instead controls the value of the username embedded within the basic
2568 authentication header (see <a href="#ssloptions">SSLOptions</a>).</p>
2569
2570 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLUserName SSL_CLIENT_S_DN_CN</pre>
2571 </div>
2572
2573 </div>
2574 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2575 <div class="directive-section"><h2><a name="SSLUseStapling" id="SSLUseStapling">SSLUseStapling</a> <a name="sslusestapling" id="sslusestapling">Directive</a></h2>
2576 <table class="directive">
2577 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable stapling of OCSP responses in the TLS handshake</td></tr>
2578 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLUseStapling on|off</code></td></tr>
2579 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLUseStapling off</code></td></tr>
2580 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2581 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2582 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2583 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2584 </table>
2585 <p>This option enables OCSP stapling, as defined by the "Certificate
2586 Status Request" TLS extension specified in RFC 6066. If enabled (and
2587 requested by the client), mod_ssl will include an OCSP response
2588 for its own certificate in the TLS handshake. Configuring an
2589 <code class="directive"><a href="#sslstaplingcache">SSLStaplingCache</a></code> is a
2590 prerequisite for enabling OCSP stapling.</p>
2591
2592 <p>OCSP stapling relieves the client of querying the OCSP responder
2593 on its own, but it should be noted that with the RFC 6066 specification,
2594 the server's <code>CertificateStatus</code> reply may only include an
2595 OCSP response for a single cert. For server certificates with intermediate
2596 CA certificates in their chain (the typical case nowadays),
2597 stapling in its current implementation therefore only partially achieves the
2598 stated goal of "saving roundtrips and resources" - see also
2599 <a href="http://www.ietf.org/rfc/rfc6961.txt">RFC 6961</a>
2600 (TLS Multiple Certificate Status Extension).
2601 </p>
2602
2603 <p>When OCSP stapling is enabled, the <code>ssl-stapling</code> mutex is used
2604 to control access to the OCSP stapling cache in order to prevent corruption,
2605 and the <code>sss-stapling-refresh</code> mutex is used to control refreshes
2606 of OCSP responses.  These mutexes can be configured using the
2607 <code class="directive"><a href="../mod/core.html#mutex">Mutex</a></code> directive.
2608 </p>
2609
2610
2611 </div>
2612 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2613 <div class="directive-section"><h2><a name="SSLVerifyClient" id="SSLVerifyClient">SSLVerifyClient</a> <a name="sslverifyclient" id="sslverifyclient">Directive</a></h2>
2614 <table class="directive">
2615 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of Client Certificate verification</td></tr>
2616 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLVerifyClient <em>level</em></code></td></tr>
2617 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLVerifyClient none</code></td></tr>
2618 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2619 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2620 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2621 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2622 </table>
2623 <p>
2624 This directive sets the Certificate verification level for the Client
2625 Authentication. Notice that this directive can be used both in per-server and
2626 per-directory context. In per-server context it applies to the client
2627 authentication process used in the standard SSL handshake when a connection is
2628 established. In per-directory context it forces a SSL renegotiation with the
2629 reconfigured client verification level after the HTTP request was read but
2630 before the HTTP response is sent.</p>
2631 <p>
2632 The following levels are available for <em>level</em>:</p>
2633 <ul>
2634 <li><strong>none</strong>:
2635      no client Certificate is required at all</li>
2636 <li><strong>optional</strong>:
2637      the client <em>may</em> present a valid Certificate</li>
2638 <li><strong>require</strong>:
2639      the client <em>has to</em> present a valid Certificate</li>
2640 <li><strong>optional_no_ca</strong>:
2641      the client may present a valid Certificate<br />
2642      but it need not to be (successfully) verifiable.</li>
2643 </ul>
2644 <p>In practice only levels <strong>none</strong> and
2645 <strong>require</strong> are really interesting, because level
2646 <strong>optional</strong> doesn't work with all browsers and level
2647 <strong>optional_no_ca</strong> is actually against the idea of
2648 authentication (but can be used to establish SSL test pages, etc.)</p>
2649 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLVerifyClient require</pre>
2650 </div>
2651
2652 </div>
2653 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2654 <div class="directive-section"><h2><a name="SSLVerifyDepth" id="SSLVerifyDepth">SSLVerifyDepth</a> <a name="sslverifydepth" id="sslverifydepth">Directive</a></h2>
2655 <table class="directive">
2656 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum depth of CA Certificates in Client
2657 Certificate verification</td></tr>
2658 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLVerifyDepth <em>number</em></code></td></tr>
2659 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLVerifyDepth 1</code></td></tr>
2660 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2661 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2662 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2663 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2664 </table>
2665 <p>
2666 This directive sets how deeply mod_ssl should verify before deciding that the
2667 clients don't have a valid certificate. Notice that this directive can be
2668 used both in per-server and per-directory context. In per-server context it
2669 applies to the client authentication process used in the standard SSL
2670 handshake when a connection is established. In per-directory context it forces
2671 a SSL renegotiation with the reconfigured client verification depth after the
2672 HTTP request was read but before the HTTP response is sent.</p>
2673 <p>
2674 The depth actually is the maximum number of intermediate certificate issuers,
2675 i.e. the number of CA certificates which are max allowed to be followed while
2676 verifying the client certificate. A depth of 0 means that self-signed client
2677 certificates are accepted only, the default depth of 1 means the client
2678 certificate can be self-signed or has to be signed by a CA which is directly
2679 known to the server (i.e. the CA's certificate is under
2680 <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code>), etc.</p>
2681 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLVerifyDepth 10</pre>
2682 </div>
2683
2684 </div>
2685 </div>
2686 <div class="bottomlang">
2687 <p><span>Available Languages: </span><a href="../en/mod/mod_ssl.html" title="English">&nbsp;en&nbsp;</a></p>
2688 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
2689 <script type="text/javascript"><!--//--><![CDATA[//><!--
2690 var comments_shortname = 'httpd';
2691 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_ssl.html';
2692 (function(w, d) {
2693     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
2694         d.write('<div id="comments_thread"><\/div>');
2695         var s = d.createElement('script');
2696         s.type = 'text/javascript';
2697         s.async = true;
2698         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
2699         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
2700     }
2701     else {
2702         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
2703     }
2704 })(window, document);
2705 //--><!]]></script></div><div id="footer">
2706 <p class="apache">Copyright 2016 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>
2707 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
2708 if (typeof(prettyPrint) !== 'undefined') {
2709     prettyPrint();
2710 }
2711 //--><!]]></script>
2712 </body></html>