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

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