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

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