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