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

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