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