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