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