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

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