2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
4 <!-- $LastChangedRevision$ -->
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
14 http://www.apache.org/licenses/LICENSE-2.0
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.
23 <modulesynopsis metafile="mod_ssl.xml.meta">
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>
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>
36 <p>This module relies on <a href="http://www.openssl.org/">OpenSSL</a>
37 to provide the cryptography engine.</p>
39 <p>Further details, discussion, and examples are provided in the
40 <a href="../ssl/">SSL documentation</a>.</p>
43 <section id="envvars"><title>Environment Variables</title>
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>
55 <columnspec><column width=".3"/><column width=".2"/><column width=".5"/>
58 <th><a name="table3">Variable Name:</a></th>
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_I_DN</code></td> <td>string</td> <td>Issuer DN of client's certificate</td></tr>
79 <tr><td><code>SSL_CLIENT_I_DN_</code><em>x509</em></td> <td>string</td> <td>Component of client's Issuer DN</td></tr>
80 <tr><td><code>SSL_CLIENT_V_START</code></td> <td>string</td> <td>Validity of client's certificate (start time)</td></tr>
81 <tr><td><code>SSL_CLIENT_V_END</code></td> <td>string</td> <td>Validity of client's certificate (end time)</td></tr>
82 <tr><td><code>SSL_CLIENT_V_REMAIN</code></td> <td>string</td> <td>Number of days until client's certificate expires</td></tr>
83 <tr><td><code>SSL_CLIENT_A_SIG</code></td> <td>string</td> <td>Algorithm used for the signature of client's certificate</td></tr>
84 <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>
85 <tr><td><code>SSL_CLIENT_CERT</code></td> <td>string</td> <td>PEM-encoded client certificate</td></tr>
86 <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>
87 <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>
88 <tr><td><code>SSL_SERVER_M_VERSION</code></td> <td>string</td> <td>The version of the server certificate</td></tr>
89 <tr><td><code>SSL_SERVER_M_SERIAL</code></td> <td>string</td> <td>The serial of the server certificate</td></tr>
90 <tr><td><code>SSL_SERVER_S_DN</code></td> <td>string</td> <td>Subject DN in server's certificate</td></tr>
91 <tr><td><code>SSL_SERVER_S_DN_</code><em>x509</em></td> <td>string</td> <td>Component of server's Subject DN</td></tr>
92 <tr><td><code>SSL_SERVER_I_DN</code></td> <td>string</td> <td>Issuer DN of server's certificate</td></tr>
93 <tr><td><code>SSL_SERVER_I_DN_</code><em>x509</em></td> <td>string</td> <td>Component of server's Issuer DN</td></tr>
94 <tr><td><code>SSL_SERVER_V_START</code></td> <td>string</td> <td>Validity of server's certificate (start time)</td></tr>
95 <tr><td><code>SSL_SERVER_V_END</code></td> <td>string</td> <td>Validity of server's certificate (end time)</td></tr>
96 <tr><td><code>SSL_SERVER_A_SIG</code></td> <td>string</td> <td>Algorithm used for the signature of server's certificate</td></tr>
97 <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>
98 <tr><td><code>SSL_SERVER_CERT</code></td> <td>string</td> <td>PEM-encoded server certificate</td></tr>
99 <tr><td><code>SSL_SRP_USER</code></td> <td>string</td> <td>SRP username</td></tr>
100 <tr><td><code>SSL_SRP_USERINFO</code></td> <td>string</td> <td>SRP user info</td></tr>
101 <tr><td><code>SSL_TLS_SNI</code></td> <td>string</td> <td>Contents of the SNI TLS extension (if supplied with ClientHello)</td></tr>
104 <p><em>x509</em> specifies a component of an X.509 DN; one of
105 <code>C,ST,L,O,OU,CN,T,I,G,S,D,UID,Email</code>. In Apache 2.1 and
106 later, <em>x509</em> may also include a numeric <code>_n</code>
107 suffix. If the DN in question contains multiple attributes of the
108 same name, this suffix is used as a zero-based index to select a
109 particular attribute. For example, where the server certificate
110 subject DN included two OU attributes, <code>SSL_SERVER_S_DN_OU_0</code>
112 <code>SSL_SERVER_S_DN_OU_1</code> could be used to reference each. A
113 variable name without a <code>_n</code> suffix is equivalent to that
114 name with a <code>_0</code> suffix; the first (or only) attribute.
115 When the environment table is populated using
116 the <code>StdEnvVars</code> option of
117 the <directive module="mod_ssl">SSLOptions</directive> directive, the
118 first (or only) attribute of any DN is added only under a non-suffixed
119 name; i.e. no <code>_0</code> suffixed entries are added.</p>
121 <p>The format of the <em>*_DN</em> variables has changed in Apache HTTPD
122 2.3.11. See the <code>LegacyDNStringFormat</code> option for
123 <directive module="mod_ssl">SSLOptions</directive> for details.</p>
125 <p><code>SSL_CLIENT_V_REMAIN</code> is only available in version 2.1
128 <p>A number of additional environment variables can also be used
129 in <directive>SSLRequire</directive> expressions, or in custom log
132 <note><pre>HTTP_USER_AGENT PATH_INFO AUTH_TYPE
133 HTTP_REFERER QUERY_STRING SERVER_SOFTWARE
134 HTTP_COOKIE REMOTE_HOST API_VERSION
135 HTTP_FORWARDED REMOTE_IDENT TIME_YEAR
136 HTTP_HOST IS_SUBREQ TIME_MON
137 HTTP_PROXY_CONNECTION DOCUMENT_ROOT TIME_DAY
138 HTTP_ACCEPT SERVER_ADMIN TIME_HOUR
139 THE_REQUEST SERVER_NAME TIME_MIN
140 REQUEST_FILENAME SERVER_PORT TIME_SEC
141 REQUEST_METHOD SERVER_PROTOCOL TIME_WDAY
142 REQUEST_SCHEME REMOTE_ADDR TIME
143 REQUEST_URI REMOTE_USER</pre></note>
145 <p>In these contexts, two special formats can also be used:</p>
148 <dt><code>ENV:<em>variablename</em></code></dt>
149 <dd>This will expand to the standard environment
150 variable <em>variablename</em>.</dd>
152 <dt><code>HTTP:<em>headername</em></code></dt>
153 <dd>This will expand to the value of the request header with name
154 <em>headername</em>.</dd>
159 <section id="logformats"><title>Custom Log Formats</title>
161 <p>When <module>mod_ssl</module> is built into Apache or at least
162 loaded (under DSO situation) additional functions exist for the <a
163 href="mod_log_config.html#formats">Custom Log Format</a> of
164 <module>mod_log_config</module>. First there is an
165 additional ``<code>%{</code><em>varname</em><code>}x</code>''
166 eXtension format function which can be used to expand any variables
167 provided by any module, especially those provided by mod_ssl which can
168 you find in the above table.</p>
170 For backward compatibility there is additionally a special
171 ``<code>%{</code><em>name</em><code>}c</code>'' cryptography format function
172 provided. Information about this function is provided in the <a
173 href="../ssl/ssl_compat.html">Compatibility</a> chapter.</p>
174 <example><title>Example</title>
175 <highlight language="config">
176 CustomLog logs/ssl_request_log "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
181 <section id="notes"><title>Request Notes</title>
183 <p><module>mod_ssl</module> sets "notes" for the request which can be
184 used in logging with the <code>%{<em>name</em>}n</code> format
185 string in <module>mod_log_config</module>.</p>
187 <p>The notes supported are as follows:</p>
190 <dt><code>ssl-access-forbidden</code></dt>
191 <dd>This note is set to the value <code>1</code> if access was
192 denied due to an <directive>SSLRequire</directive>
193 or <directive>SSLRequireSSL</directive> directive.</dd>
195 <dt><code>ssl-secure-reneg</code></dt>
196 <dd>If <module>mod_ssl</module> is built against a version of
197 OpenSSL which supports the secure renegotiation extension, this note
198 is set to the value <code>1</code> if SSL is in used for the current
199 connection, and the client also supports the secure renegotiation
200 extension. If the client does not support the secure renegotiation
201 extension, the note is set to the value <code>0</code>.
202 If <module>mod_ssl</module> is not built against a version of
203 OpenSSL which supports secure renegotiation, or if SSL is not in use
204 for the current connection, the note is not set.</dd>
209 <section id="authzproviders"><title>Authorization providers for use with Require</title>
211 <p><module>mod_ssl</module> provides a few authentication providers for use
212 with <module>mod_authz_core</module>'s
213 <directive module="mod_authz_core">Require</directive> directive.</p>
215 <section id="reqssl"><title>Require ssl</title>
217 <p>The <code>ssl</code> provider denies access if a connection is not
218 encrypted with SSL. This is similar to the
219 <directive>SSLRequireSSL</directive> directive.</p>
221 <highlight language="config">
227 <section id="reqverifyclient"><title>Require ssl-verify-client</title>
229 <p>The <code>ssl</code> provider allows access if the user is
230 authenticated with a valid client certificate. This is only
231 useful if <code>SSLVerifyClient optional</code> is in effect.</p>
233 <p>The following example grants access if the user is authenticated
234 either with a client certificate or by username and password.</p>
236 <highlight language="config">
237 Require ssl-verify-client<br/>
246 <name>SSLPassPhraseDialog</name>
247 <description>Type of pass phrase dialog for encrypted private
249 <syntax>SSLPassPhraseDialog <em>type</em></syntax>
250 <default>SSLPassPhraseDialog builtin</default>
251 <contextlist><context>server config</context></contextlist>
255 When Apache starts up it has to read the various Certificate (see
256 <directive module="mod_ssl">SSLCertificateFile</directive>) and
257 Private Key (see <directive
258 module="mod_ssl">SSLCertificateKeyFile</directive>) files of the
259 SSL-enabled virtual servers. Because for security reasons the Private
260 Key files are usually encrypted, mod_ssl needs to query the
261 administrator for a Pass Phrase in order to decrypt those files. This
262 query can be done in two ways which can be configured by
265 <li><code>builtin</code>
267 This is the default where an interactive terminal dialog occurs at startup
268 time just before Apache detaches from the terminal. Here the administrator
269 has to manually enter the Pass Phrase for each encrypted Private Key file.
270 Because a lot of SSL-enabled virtual hosts can be configured, the
271 following reuse-scheme is used to minimize the dialog: When a Private Key
272 file is encrypted, all known Pass Phrases (at the beginning there are
273 none, of course) are tried. If one of those known Pass Phrases succeeds no
274 dialog pops up for this particular Private Key file. If none succeeded,
275 another Pass Phrase is queried on the terminal and remembered for the next
276 round (where it perhaps can be reused).</p>
278 This scheme allows mod_ssl to be maximally flexible (because for N encrypted
279 Private Key files you <em>can</em> use N different Pass Phrases - but then
280 you have to enter all of them, of course) while minimizing the terminal
281 dialog (i.e. when you use a single Pass Phrase for all N Private Key files
282 this Pass Phrase is queried only once).</p></li>
284 <li><code>|/path/to/program [args...]</code>
286 <p>This mode allows an external program to be used which acts as a
287 pipe to a particular input device; the program is sent the standard
288 prompt text used for the <code>builtin</code> mode on
289 <code>stdin</code>, and is expected to write password strings on
290 <code>stdout</code>. If several passwords are needed (or an
291 incorrect password is entered), additional prompt text will be
292 written subsequent to the first password being returned, and more
293 passwords must then be written back.</p></li>
295 <li><code>exec:/path/to/program</code>
297 Here an external program is configured which is called at startup for each
298 encrypted Private Key file. It is called with two arguments (the first is
299 of the form ``<code>servername:portnumber</code>'', the second is either
300 ``<code>RSA</code>'', ``<code>DSA</code>'', or ``<code>ECC</code>''), which
301 indicate for which server and algorithm it has to print the corresponding
302 Pass Phrase to <code>stdout</code>. The intent is that this external
303 program first runs security checks to make sure that the system is not
304 compromised by an attacker, and only when these checks were passed
305 successfully it provides the Pass Phrase.</p>
307 Both these security checks, and the way the Pass Phrase is determined, can
308 be as complex as you like. Mod_ssl just defines the interface: an
309 executable program which provides the Pass Phrase on <code>stdout</code>.
310 Nothing more or less! So, if you're really paranoid about security, here
311 is your interface. Anything else has to be left as an exercise to the
312 administrator, because local security requirements are so different.</p>
314 The reuse-algorithm above is used here, too. In other words: The external
315 program is called only once per unique Pass Phrase.</p></li>
317 <example><title>Example</title>
318 <highlight language="config">
319 SSLPassPhraseDialog exec:/usr/local/apache/sbin/pp-filter
326 <name>SSLRandomSeed</name>
327 <description>Pseudo Random Number Generator (PRNG) seeding
329 <syntax>SSLRandomSeed <em>context</em> <em>source</em>
330 [<em>bytes</em>]</syntax>
331 <contextlist><context>server config</context></contextlist>
335 This configures one or more sources for seeding the Pseudo Random Number
336 Generator (PRNG) in OpenSSL at startup time (<em>context</em> is
337 <code>startup</code>) and/or just before a new SSL connection is established
338 (<em>context</em> is <code>connect</code>). This directive can only be used
339 in the global server context because the PRNG is a global facility.</p>
341 The following <em>source</em> variants are available:</p>
343 <li><code>builtin</code>
344 <p> This is the always available builtin seeding source. Its usage
345 consumes minimum CPU cycles under runtime and hence can be always used
346 without drawbacks. The source used for seeding the PRNG contains of the
347 current time, the current process id and (when applicable) a randomly
348 chosen 1KB extract of the inter-process scoreboard structure of Apache.
349 The drawback is that this is not really a strong source and at startup
350 time (where the scoreboard is still not available) this source just
351 produces a few bytes of entropy. So you should always, at least for the
352 startup, use an additional seeding source.</p></li>
353 <li><code>file:/path/to/source</code>
355 This variant uses an external file <code>/path/to/source</code> as the
356 source for seeding the PRNG. When <em>bytes</em> is specified, only the
357 first <em>bytes</em> number of bytes of the file form the entropy (and
358 <em>bytes</em> is given to <code>/path/to/source</code> as the first
359 argument). When <em>bytes</em> is not specified the whole file forms the
360 entropy (and <code>0</code> is given to <code>/path/to/source</code> as
361 the first argument). Use this especially at startup time, for instance
362 with an available <code>/dev/random</code> and/or
363 <code>/dev/urandom</code> devices (which usually exist on modern Unix
364 derivatives like FreeBSD and Linux).</p>
366 <em>But be careful</em>: Usually <code>/dev/random</code> provides only as
367 much entropy data as it actually has, i.e. when you request 512 bytes of
368 entropy, but the device currently has only 100 bytes available two things
369 can happen: On some platforms you receive only the 100 bytes while on
370 other platforms the read blocks until enough bytes are available (which
371 can take a long time). Here using an existing <code>/dev/urandom</code> is
372 better, because it never blocks and actually gives the amount of requested
373 data. The drawback is just that the quality of the received data may not
374 be the best.</p></li>
376 <li><code>exec:/path/to/program</code>
378 This variant uses an external executable
379 <code>/path/to/program</code> as the source for seeding the
380 PRNG. When <em>bytes</em> is specified, only the first
381 <em>bytes</em> number of bytes of its <code>stdout</code> contents
382 form the entropy. When <em>bytes</em> is not specified, the
383 entirety of the data produced on <code>stdout</code> form the
384 entropy. Use this only at startup time when you need a very strong
385 seeding with the help of an external program (for instance as in
386 the example above with the <code>truerand</code> utility you can
387 find in the mod_ssl distribution which is based on the AT&T
388 <em>truerand</em> library). Using this in the connection context
389 slows down the server too dramatically, of course. So usually you
390 should avoid using external programs in that context.</p></li>
391 <li><code>egd:/path/to/egd-socket</code> (Unix only)
393 This variant uses the Unix domain socket of the
394 external Entropy Gathering Daemon (EGD) (see <a
395 href="http://www.lothar.com/tech/crypto/">http://www.lothar.com/tech
396 /crypto/</a>) to seed the PRNG. Use this if no random device exists
397 on your platform.</p></li>
399 <example><title>Example</title>
400 <highlight language="config">
401 SSLRandomSeed startup builtin
402 SSLRandomSeed startup file:/dev/random
403 SSLRandomSeed startup file:/dev/urandom 1024
404 SSLRandomSeed startup exec:/usr/local/bin/truerand 16
405 SSLRandomSeed connect builtin
406 SSLRandomSeed connect file:/dev/random
407 SSLRandomSeed connect file:/dev/urandom 1024
414 <name>SSLSessionCache</name>
415 <description>Type of the global/inter-process SSL Session
417 <syntax>SSLSessionCache <em>type</em></syntax>
418 <default>SSLSessionCache none</default>
419 <contextlist><context>server config</context></contextlist>
423 This configures the storage type of the global/inter-process SSL Session
424 Cache. This cache is an optional facility which speeds up parallel request
425 processing. For requests to the same server process (via HTTP keep-alive),
426 OpenSSL already caches the SSL session information locally. But because modern
427 clients request inlined images and other data via parallel requests (usually
428 up to four parallel requests are common) those requests are served by
429 <em>different</em> pre-forked server processes. Here an inter-process cache
430 helps to avoid unnecessary session handshakes.</p>
432 The following five storage <em>type</em>s are currently supported:</p>
434 <li><code>none</code>
436 <p>This disables the global/inter-process Session Cache. This
437 will incur a noticeable speed penalty and may cause problems if
438 using certain browsers, particularly if client certificates are
439 enabled. This setting is not recommended.</p></li>
441 <li><code>nonenotnull</code>
443 <p>This disables any global/inter-process Session Cache. However
444 it does force OpenSSL to send a non-null session ID to
445 accommodate buggy clients that require one.</p></li>
447 <li><code>dbm:/path/to/datafile</code>
449 <p>This makes use of a DBM hashfile on the local disk to
450 synchronize the local OpenSSL memory caches of the server
451 processes. This session cache may suffer reliability issues under
452 high load. To use this, ensure that
453 <module>mod_socache_dbm</module> is loaded.</p></li>
455 <li><code>shmcb:/path/to/datafile</code>[<code>(</code><em>size</em><code>)</code>]
457 <p>This makes use of a high-performance cyclic buffer
458 (approx. <em>size</em> bytes in size) inside a shared memory
459 segment in RAM (established via <code>/path/to/datafile</code>) to
460 synchronize the local OpenSSL memory caches of the server
461 processes. This is the recommended session cache. To use this,
462 ensure that <module>mod_socache_shmcb</module> is loaded.</p></li>
464 <li><code>dc:UNIX:/path/to/socket</code>
466 <p>This makes use of the <a
467 href="http://www.distcache.org/">distcache</a> distributed session
468 caching libraries. The argument should specify the location of
469 the server or proxy to be used using the distcache address syntax;
470 for example, <code>UNIX:/path/to/socket</code> specifies a UNIX
471 domain socket (typically a local dc_client proxy);
472 <code>IP:server.example.com:9001</code> specifies an IP
473 address. To use this, ensure that
474 <module>mod_socache_dc</module> is loaded.</p></li>
478 <example><title>Examples</title>
479 <highlight language="config">
480 SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data
481 SSLSessionCache shmcb:/usr/local/apache/logs/ssl_gcache_data(512000)
485 <p>The <code>ssl-cache</code> mutex is used to serialize access to
486 the session cache to prevent corruption. This mutex can be configured
487 using the <directive module="core">Mutex</directive> directive.</p>
492 <name>SSLSessionCacheTimeout</name>
493 <description>Number of seconds before an SSL session expires
494 in the Session Cache</description>
495 <syntax>SSLSessionCacheTimeout <em>seconds</em></syntax>
496 <default>SSLSessionCacheTimeout 300</default>
497 <contextlist><context>server config</context>
498 <context>virtual host</context></contextlist>
502 This directive sets the timeout in seconds for the information stored in the
503 global/inter-process SSL Session Cache and the OpenSSL internal memory cache.
504 It can be set as low as 15 for testing, but should be set to higher
505 values like 300 in real life.</p>
506 <example><title>Example</title>
507 <highlight language="config">
508 SSLSessionCacheTimeout 600
515 <name>SSLEngine</name>
516 <description>SSL Engine Operation Switch</description>
517 <syntax>SSLEngine on|off|optional</syntax>
518 <default>SSLEngine off</default>
519 <contextlist><context>server config</context>
520 <context>virtual host</context></contextlist>
524 This directive toggles the usage of the SSL/TLS Protocol Engine. This
525 is should be used inside a <directive module="core"
526 type="section">VirtualHost</directive> section to enable SSL/TLS for a
527 that virtual host. By default the SSL/TLS Protocol Engine is
528 disabled for both the main server and all configured virtual hosts.</p>
529 <example><title>Example</title>
530 <highlight language="config">
531 <VirtualHost _default_:443>
537 <p>In Apache 2.1 and later, <directive>SSLEngine</directive> can be set to
538 <code>optional</code>. This enables support for
539 <a href="http://www.ietf.org/rfc/rfc2817.txt">RFC 2817</a>, Upgrading to TLS
540 Within HTTP/1.1. At this time no web browsers support RFC 2817.</p>
546 <description>SSL FIPS mode Switch</description>
547 <syntax>SSLFIPS on|off</syntax>
548 <default>SSLFIPS off</default>
549 <contextlist><context>server config</context></contextlist>
553 This directive toggles the usage of the SSL library FIPS_mode flag.
554 It must be set in the global server context and cannot be configured
555 with conflicting settings (SSLFIPS on followed by SSLFIPS off or
556 similar). The mode applies to all SSL library operations.
559 If httpd was compiled against an SSL library which did not support
560 the FIPS_mode flag, <code>SSLFIPS on</code> will fail. Refer to the
561 FIPS 140-2 Security Policy document of the SSL provider library for
562 specific requirements to use mod_ssl in a FIPS 140-2 approved mode
563 of operation; note that mod_ssl itself is not validated, but may be
564 described as using FIPS 140-2 validated cryptographic module, when
565 all components are assembled and operated under the guidelines imposed
566 by the applicable Security Policy.
572 <name>SSLProtocol</name>
573 <description>Configure usable SSL/TLS protocol versions</description>
574 <syntax>SSLProtocol [+|-]<em>protocol</em> ...</syntax>
575 <default>SSLProtocol all</default>
576 <contextlist><context>server config</context>
577 <context>virtual host</context></contextlist>
581 This directive can be used to control which versions of the SSL/TLS protocol
582 will be accepted in new connections.</p>
584 The available (case-insensitive) <em>protocol</em>s are:</p>
586 <li><code>SSLv3</code>
588 This is the Secure Sockets Layer (SSL) protocol, version 3.0, from
589 the Netscape Corporation.
590 It is the successor to SSLv2 and the predecessor to TLSv1.</p></li>
592 <li><code>TLSv1</code>
594 This is the Transport Layer Security (TLS) protocol, version 1.0.
595 It is the successor to SSLv3 and is defined in
596 <a href="http://www.ietf.org/rfc/rfc2246.txt">RFC 2246</a>.
597 It is supported by nearly every client.</p></li>
599 <li><code>TLSv1.1</code> (when using OpenSSL 1.0.1 and later)
601 A revision of the TLS 1.0 protocol, as defined in
602 <a href="http://www.ietf.org/rfc/rfc4346.txt">RFC 4346</a>.</p></li>
604 <li><code>TLSv1.2</code> (when using OpenSSL 1.0.1 and later)
606 A revision of the TLS 1.1 protocol, as defined in
607 <a href="http://www.ietf.org/rfc/rfc5246.txt">RFC 5246</a>.</p></li>
611 This is a shortcut for ``<code>+SSLv3 +TLSv1</code>'' or
612 - when using OpenSSL 1.0.1 and later -
613 ``<code>+SSLv3 +TLSv1 +TLSv1.1 +TLSv1.2</code>, respectively.</p></li>
615 <example><title>Example</title>
616 <highlight language="config">
624 <name>SSLCipherSuite</name>
625 <description>Cipher Suite available for negotiation in SSL
626 handshake</description>
627 <syntax>SSLCipherSuite <em>cipher-spec</em></syntax>
628 <default>SSLCipherSuite DEFAULT (depends on OpenSSL version)</default>
629 <contextlist><context>server config</context>
630 <context>virtual host</context>
631 <context>directory</context>
632 <context>.htaccess</context></contextlist>
633 <override>AuthConfig</override>
637 This complex directive uses a colon-separated <em>cipher-spec</em> string
638 consisting of OpenSSL cipher specifications to configure the Cipher Suite the
639 client is permitted to negotiate in the SSL handshake phase. Notice that this
640 directive can be used both in per-server and per-directory context. In
641 per-server context it applies to the standard SSL handshake when a connection
642 is established. In per-directory context it forces a SSL renegotiation with the
643 reconfigured Cipher Suite after the HTTP request was read but before the HTTP
644 response is sent.</p>
646 An SSL cipher specification in <em>cipher-spec</em> is composed of 4 major
647 attributes plus a few extra minor ones:</p>
649 <li><em>Key Exchange Algorithm</em>:<br />
650 RSA, Diffie-Hellman, Elliptic Curve Diffie-Hellman, Secure Remote Password
652 <li><em>Authentication Algorithm</em>:<br />
653 RSA, Diffie-Hellman, DSS, ECDSA, or none.
655 <li><em>Cipher/Encryption Algorithm</em>:<br />
656 AES, DES, Triple-DES, RC4, RC2, IDEA, etc.
658 <li><em>MAC Digest Algorithm</em>:<br />
659 MD5, SHA or SHA1, SHA256, SHA384.
662 <p>An SSL cipher can also be an export cipher. SSLv2 ciphers are no longer
663 supported. To specify which ciphers to use, one can either specify all the
664 Ciphers, one at a time, or use aliases to specify the preference and order
665 for the ciphers (see <a href="#table1">Table
666 1</a>). The actually available ciphers and aliases depends on the used
667 openssl version. Newer openssl versions may include additional ciphers.</p>
670 <columnspec><column width=".5"/><column width=".5"/></columnspec>
671 <tr><th><a name="table1">Tag</a></th> <th>Description</th></tr>
672 <tr><td colspan="2"><em>Key Exchange Algorithm:</em></td></tr>
673 <tr><td><code>kRSA</code></td> <td>RSA key exchange</td></tr>
674 <tr><td><code>kDHr</code></td> <td>Diffie-Hellman key exchange with RSA key</td></tr>
675 <tr><td><code>kDHd</code></td> <td>Diffie-Hellman key exchange with DSA key</td></tr>
676 <tr><td><code>kEDH</code></td> <td>Ephemeral (temp.key) Diffie-Hellman key exchange (no cert)</td> </tr>
677 <tr><td><code>kSRP</code></td> <td>Secure Remote Password (SRP) key exchange</td></tr>
678 <tr><td colspan="2"><em>Authentication Algorithm:</em></td></tr>
679 <tr><td><code>aNULL</code></td> <td>No authentication</td></tr>
680 <tr><td><code>aRSA</code></td> <td>RSA authentication</td></tr>
681 <tr><td><code>aDSS</code></td> <td>DSS authentication</td> </tr>
682 <tr><td><code>aDH</code></td> <td>Diffie-Hellman authentication</td></tr>
683 <tr><td colspan="2"><em>Cipher Encoding Algorithm:</em></td></tr>
684 <tr><td><code>eNULL</code></td> <td>No encryption</td> </tr>
685 <tr><td><code>NULL</code></td> <td>alias for eNULL</td> </tr>
686 <tr><td><code>AES</code></td> <td>AES encryption</td> </tr>
687 <tr><td><code>DES</code></td> <td>DES encryption</td> </tr>
688 <tr><td><code>3DES</code></td> <td>Triple-DES encryption</td> </tr>
689 <tr><td><code>RC4</code></td> <td>RC4 encryption</td> </tr>
690 <tr><td><code>RC2</code></td> <td>RC2 encryption</td> </tr>
691 <tr><td><code>IDEA</code></td> <td>IDEA encryption</td> </tr>
692 <tr><td colspan="2"><em>MAC Digest Algorithm</em>:</td></tr>
693 <tr><td><code>MD5</code></td> <td>MD5 hash function</td></tr>
694 <tr><td><code>SHA1</code></td> <td>SHA1 hash function</td></tr>
695 <tr><td><code>SHA</code></td> <td>alias for SHA1</td> </tr>
696 <tr><td><code>SHA256</code></td> <td>SHA256 hash function</td> </tr>
697 <tr><td><code>SHA384</code></td> <td>SHA384 hash function</td> </tr>
698 <tr><td colspan="2"><em>Aliases:</em></td></tr>
699 <tr><td><code>SSLv3</code></td> <td>all SSL version 3.0 ciphers</td> </tr>
700 <tr><td><code>TLSv1</code></td> <td>all TLS version 1.0 ciphers</td> </tr>
701 <tr><td><code>EXP</code></td> <td>all export ciphers</td> </tr>
702 <tr><td><code>EXPORT40</code></td> <td>all 40-bit export ciphers only</td> </tr>
703 <tr><td><code>EXPORT56</code></td> <td>all 56-bit export ciphers only</td> </tr>
704 <tr><td><code>LOW</code></td> <td>all low strength ciphers (no export, single DES)</td></tr>
705 <tr><td><code>MEDIUM</code></td> <td>all ciphers with 128 bit encryption</td> </tr>
706 <tr><td><code>HIGH</code></td> <td>all ciphers using Triple-DES</td> </tr>
707 <tr><td><code>RSA</code></td> <td>all ciphers using RSA key exchange</td> </tr>
708 <tr><td><code>DH</code></td> <td>all ciphers using Diffie-Hellman key exchange</td> </tr>
709 <tr><td><code>EDH</code></td> <td>all ciphers using Ephemeral Diffie-Hellman key exchange</td> </tr>
710 <tr><td><code>ECDH</code></td> <td>Elliptic Curve Diffie-Hellman key exchange</td> </tr>
711 <tr><td><code>ADH</code></td> <td>all ciphers using Anonymous Diffie-Hellman key exchange</td> </tr>
712 <tr><td><code>AECDH</code></td> <td>all ciphers using Anonymous Elliptic Curve Diffie-Hellman key exchange</td> </tr>
713 <tr><td><code>SRP</code></td> <td>all ciphers using Secure Remote Password (SRP) key exchange</td> </tr>
714 <tr><td><code>DSS</code></td> <td>all ciphers using DSS authentication</td> </tr>
715 <tr><td><code>ECDSA</code></td> <td>all ciphers using ECDSA authentication</td> </tr>
716 <tr><td><code>aNULL</code></td> <td>all ciphers using no authentication</td> </tr>
719 Now where this becomes interesting is that these can be put together
720 to specify the order and ciphers you wish to use. To speed this up
721 there are also aliases (<code>SSLv3, TLSv1, EXP, LOW, MEDIUM,
722 HIGH</code>) for certain groups of ciphers. These tags can be joined
723 together with prefixes to form the <em>cipher-spec</em>. Available
726 <li>none: add cipher to list</li>
727 <li><code>+</code>: move matching ciphers to the current location in list</li>
728 <li><code>-</code>: remove cipher from list (can be added later again)</li>
729 <li><code>!</code>: kill cipher from list completely (can <strong>not</strong> be added later again)</li>
733 <title><code>aNULL</code>, <code>eNULL</code> and <code>EXP</code>
734 ciphers are always disabled</title>
735 <p>Beginning with version 2.5.0-dev as of 2013-09-25, null and export-grade
736 ciphers are always disabled, as mod_ssl unconditionally prepends any supplied
737 cipher suite string with <code>!aNULL:!eNULL:!EXP:</code> at initialization.</p>
740 <p>A simpler way to look at all of this is to use the ``<code>openssl ciphers
741 -v</code>'' command which provides a nice way to successively create the
742 correct <em>cipher-spec</em> string. The default <em>cipher-spec</em> string
743 depends on the version of the OpenSSL libraries used. Let's suppose it is
744 ``<code>RC4-SHA:AES128-SHA:HIGH:MEDIUM:!aNULL:!MD5</code>'' which
745 means the following: Put <code>RC4-SHA</code> and <code>AES128-SHA</code> at
746 the beginning. We do this, because these ciphers offer a good compromise
747 between speed and security. Next, include high and medium security ciphers.
748 Finally, remove all ciphers which do not authenticate, i.e. for SSL the
749 Anonymous Diffie-Hellman ciphers, as well as all ciphers which use
750 <code>MD5</code> as hash algorithm, because it has been proven insufficient.</p>
753 $ openssl ciphers -v 'RC4-SHA:AES128-SHA:HIGH:MEDIUM:!aNULL:!MD5'
754 RC4-SHA SSLv3 Kx=RSA Au=RSA Enc=RC4(128) Mac=SHA1
755 AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
756 DHE-RSA-AES256-SHA SSLv3 Kx=DH Au=RSA Enc=AES(256) Mac=SHA1
758 SEED-SHA SSLv3 Kx=RSA Au=RSA Enc=SEED(128) Mac=SHA1
759 PSK-RC4-SHA SSLv3 Kx=PSK Au=PSK Enc=RC4(128) Mac=SHA1
760 KRB5-RC4-SHA SSLv3 Kx=KRB5 Au=KRB5 Enc=RC4(128) Mac=SHA1
763 <p>The complete list of particular RSA & DH ciphers for SSL is given in <a
764 href="#table2">Table 2</a>.</p>
765 <example><title>Example</title>
766 <highlight language="config">
767 SSLCipherSuite RSA:!EXP:!NULL:+HIGH:+MEDIUM:-LOW
771 <columnspec><column width=".3"/><column width=".1"/><column width=".13"/>
772 <column width=".1"/><column width=".13"/><column width=".1"/>
773 <column width=".13"/></columnspec>
774 <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>
775 <tr><td colspan="7"><em>RSA Ciphers:</em></td></tr>
776 <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>
777 <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>
778 <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>
779 <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>
780 <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>
781 <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>
782 <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>
783 <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>
784 <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>
785 <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>
786 <tr><td colspan="7"><em>Diffie-Hellman Ciphers:</em></td></tr>
787 <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>
788 <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>
789 <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>
790 <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>
791 <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>
792 <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>
793 <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>
794 <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>
795 <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>
796 <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>
797 <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>
803 <name>SSLCertificateFile</name>
804 <description>Server PEM-encoded X.509 certificate data file</description>
805 <syntax>SSLCertificateFile <em>file-path</em></syntax>
806 <contextlist><context>server config</context>
807 <context>virtual host</context></contextlist>
811 This directive points to a file with certificate data in PEM format.
812 At a minimum, the file must include an end-entity (leaf) certificate.
813 Beginning with version 2.5.0-dev as of 2013-12-28, it may also
814 include intermediate CA certificates, sorted from leaf to root,
815 and obsoletes <directive module="mod_ssl">SSLCertificateChainFile</directive>.
819 Additional optional elements are DH parameters and/or an EC curve name
820 for ephemeral keys, as generated by <code>openssl dhparam</code> and
821 <code>openssl ecparam</code>, respectively (supported in version 2.5.0-dev
822 as of 2013-09-29), and finally, the end-entity certificate's private key.
823 If the private key is encrypted, the pass phrase dialog is forced
827 This directive can be used multiple times (referencing different filenames)
828 to support multiple algorithms for server authentication - typically
829 RSA, DSA, and ECC. The number of supported algorithms depends on the
830 OpenSSL version being used for mod_ssl: with version 1.0.0 or later,
831 <code>openssl list-public-key-algorithms</code> will output a list
832 of supported algorithms.</p>
835 When running with OpenSSL 1.0.2 or later, this directive allows
836 to configure the intermediate CA chain on a per-certificate basis,
837 which removes a limitation of the (now obsolete)
838 <directive module="mod_ssl">SSLCertificateChainFile</directive> directive.
839 DH and ECDH parameters, however, are only read from the first
840 <directive>SSLCertificateFile</directive> directive, as they
841 are applied independently of the authentication algorithm type.</p>
844 <title>DH parameter interoperability with primes > 1024 bit</title>
846 Beginning with version 2.5.0-dev as of 2013-09-29, mod_ssl makes use of
847 standardized DH parameters with prime lengths of 2048, 3072 and 4096 bits
848 (from <a href="http://www.ietf.org/rfc/rfc3526.txt">RFC 3526</a>), and hands
849 them out to clients based on the length of the certificate's RSA/DSA key.
850 With Java-based clients in particular (Java 7 or earlier), this may lead
851 to handshake failures - see this
852 <a href="../ssl/ssl_faq.html#javadh">FAQ answer</a> for working around
857 <example><title>Example</title>
858 <highlight language="config">
859 SSLCertificateFile /usr/local/apache2/conf/ssl.crt/server.crt
866 <name>SSLCertificateKeyFile</name>
867 <description>Server PEM-encoded private key file</description>
868 <syntax>SSLCertificateKeyFile <em>file-path</em></syntax>
869 <contextlist><context>server config</context>
870 <context>virtual host</context></contextlist>
874 This directive points to the PEM-encoded private key file for the
875 server (the private key may also be combined with the certificate in the
876 <directive module="mod_ssl">SSLCertificateFile</directive>, but this practice
877 is discouraged). If the contained private key is encrypted, the pass phrase
878 dialog is forced at startup time.</p>
881 The directive can be used multiple times (referencing different filenames)
882 to support multiple algorithms for server authentication. For each
883 <directive module="mod_ssl">SSLCertificateKeyFile</directive>
884 directive, there must be a matching <directive>SSLCertificateFile</directive>
887 <example><title>Example</title>
888 <highlight language="config">
889 SSLCertificateKeyFile /usr/local/apache2/conf/ssl.key/server.key
896 <name>SSLCertificateChainFile</name>
897 <description>File of PEM-encoded Server CA Certificates</description>
898 <syntax>SSLCertificateChainFile <em>file-path</em></syntax>
899 <contextlist><context>server config</context>
900 <context>virtual host</context></contextlist>
903 <note><title>SSLCertificateChainFile is deprecated</title>
904 <p><code>SSLCertificateChainFile</code> became obsolete with version
905 2.5.0-dev as of 2013-12-28, when
906 <directive module="mod_ssl">SSLCertificateFile</directive>
907 was extended to also load intermediate CA certificates from the server
908 certificate file.</p>
912 This directive sets the optional <em>all-in-one</em> file where you can
913 assemble the certificates of Certification Authorities (CA) which form the
914 certificate chain of the server certificate. This starts with the issuing CA
915 certificate of the server certificate and can range up to the root CA
916 certificate. Such a file is simply the concatenation of the various
917 PEM-encoded CA Certificate files, usually in certificate chain order.</p>
919 This should be used alternatively and/or additionally to <directive
920 module="mod_ssl">SSLCACertificatePath</directive> for explicitly
921 constructing the server certificate chain which is sent to the browser
922 in addition to the server certificate. It is especially useful to
923 avoid conflicts with CA certificates when using client
924 authentication. Because although placing a CA certificate of the
925 server certificate chain into <directive
926 module="mod_ssl">SSLCACertificatePath</directive> has the same effect
927 for the certificate chain construction, it has the side-effect that
928 client certificates issued by this same CA certificate are also
929 accepted on client authentication.</p>
931 But be careful: Providing the certificate chain works only if you are using a
932 <em>single</em> RSA <em>or</em> DSA based server certificate. If you are
933 using a coupled RSA+DSA certificate pair, this will work only if actually both
934 certificates use the <em>same</em> certificate chain. Else the browsers will be
935 confused in this situation.</p>
936 <example><title>Example</title>
937 <highlight language="config">
938 SSLCertificateChainFile /usr/local/apache2/conf/ssl.crt/ca.crt
945 <name>SSLCACertificatePath</name>
946 <description>Directory of PEM-encoded CA Certificates for
947 Client Auth</description>
948 <syntax>SSLCACertificatePath <em>directory-path</em></syntax>
949 <contextlist><context>server config</context>
950 <context>virtual host</context></contextlist>
954 This directive sets the directory where you keep the Certificates of
955 Certification Authorities (CAs) whose clients you deal with. These are used to
956 verify the client certificate on Client Authentication.</p>
958 The files in this directory have to be PEM-encoded and are accessed through
959 hash filenames. So usually you can't just place the Certificate files
960 there: you also have to create symbolic links named
961 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
962 contains the appropriate symbolic links.</p>
963 <example><title>Example</title>
964 <highlight language="config">
965 SSLCACertificatePath /usr/local/apache2/conf/ssl.crt/
972 <name>SSLCACertificateFile</name>
973 <description>File of concatenated PEM-encoded CA Certificates
974 for Client Auth</description>
975 <syntax>SSLCACertificateFile <em>file-path</em></syntax>
976 <contextlist><context>server config</context>
977 <context>virtual host</context></contextlist>
981 This directive sets the <em>all-in-one</em> file where you can assemble the
982 Certificates of Certification Authorities (CA) whose <em>clients</em> you deal
983 with. These are used for Client Authentication. Such a file is simply the
984 concatenation of the various PEM-encoded Certificate files, in order of
985 preference. This can be used alternatively and/or additionally to
986 <directive module="mod_ssl">SSLCACertificatePath</directive>.</p>
987 <example><title>Example</title>
988 <highlight language="config">
989 SSLCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-client.crt
996 <name>SSLCADNRequestFile</name>
997 <description>File of concatenated PEM-encoded CA Certificates
998 for defining acceptable CA names</description>
999 <syntax>SSLCADNRequestFile <em>file-path</em></syntax>
1000 <contextlist><context>server config</context>
1001 <context>virtual host</context></contextlist>
1004 <p>When a client certificate is requested by mod_ssl, a list of
1005 <em>acceptable Certificate Authority names</em> is sent to the client
1006 in the SSL handshake. These CA names can be used by the client to
1007 select an appropriate client certificate out of those it has
1010 <p>If neither of the directives <directive
1011 module="mod_ssl">SSLCADNRequestPath</directive> or <directive
1012 module="mod_ssl">SSLCADNRequestFile</directive> are given, then the
1013 set of acceptable CA names sent to the client is the names of all the
1014 CA certificates given by the <directive
1015 module="mod_ssl">SSLCACertificateFile</directive> and <directive
1016 module="mod_ssl">SSLCACertificatePath</directive> directives; in other
1017 words, the names of the CAs which will actually be used to verify the
1018 client certificate.</p>
1020 <p>In some circumstances, it is useful to be able to send a set of
1021 acceptable CA names which differs from the actual CAs used to verify
1022 the client certificate - for example, if the client certificates are
1023 signed by intermediate CAs. In such cases, <directive
1024 module="mod_ssl">SSLCADNRequestPath</directive> and/or <directive
1025 module="mod_ssl">SSLCADNRequestFile</directive> can be used; the
1026 acceptable CA names are then taken from the complete set of
1027 certificates in the directory and/or file specified by this pair of
1030 <p><directive module="mod_ssl">SSLCADNRequestFile</directive> must
1031 specify an <em>all-in-one</em> file containing a concatenation of
1032 PEM-encoded CA certificates.</p>
1034 <example><title>Example</title>
1035 <highlight language="config">
1036 SSLCADNRequestFile /usr/local/apache2/conf/ca-names.crt
1040 </directivesynopsis>
1043 <name>SSLCADNRequestPath</name>
1044 <description>Directory of PEM-encoded CA Certificates for
1045 defining acceptable CA names</description>
1046 <syntax>SSLCADNRequestPath <em>directory-path</em></syntax>
1047 <contextlist><context>server config</context>
1048 <context>virtual host</context></contextlist>
1052 <p>This optional directive can be used to specify the set of
1053 <em>acceptable CA names</em> which will be sent to the client when a
1054 client certificate is requested. See the <directive
1055 module="mod_ssl">SSLCADNRequestFile</directive> directive for more
1058 <p>The files in this directory have to be PEM-encoded and are accessed
1059 through hash filenames. So usually you can't just place the
1060 Certificate files there: you also have to create symbolic links named
1061 <em>hash-value</em><code>.N</code>. And you should always make sure
1062 this directory contains the appropriate symbolic links.</p>
1063 <example><title>Example</title>
1064 <highlight language="config">
1065 SSLCADNRequestPath /usr/local/apache2/conf/ca-names.crt/
1069 </directivesynopsis>
1072 <name>SSLCARevocationPath</name>
1073 <description>Directory of PEM-encoded CA CRLs for
1074 Client Auth</description>
1075 <syntax>SSLCARevocationPath <em>directory-path</em></syntax>
1076 <contextlist><context>server config</context>
1077 <context>virtual host</context></contextlist>
1081 This directive sets the directory where you keep the Certificate Revocation
1082 Lists (CRL) of Certification Authorities (CAs) whose clients you deal with.
1083 These are used to revoke the client certificate on Client Authentication.</p>
1085 The files in this directory have to be PEM-encoded and are accessed through
1086 hash filenames. So usually you have not only to place the CRL files there.
1087 Additionally you have to create symbolic links named
1088 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
1089 contains the appropriate symbolic links.</p>
1090 <example><title>Example</title>
1091 <highlight language="config">
1092 SSLCARevocationPath /usr/local/apache2/conf/ssl.crl/
1096 </directivesynopsis>
1099 <name>SSLCARevocationFile</name>
1100 <description>File of concatenated PEM-encoded CA CRLs for
1101 Client Auth</description>
1102 <syntax>SSLCARevocationFile <em>file-path</em></syntax>
1103 <contextlist><context>server config</context>
1104 <context>virtual host</context></contextlist>
1108 This directive sets the <em>all-in-one</em> file where you can
1109 assemble the Certificate Revocation Lists (CRL) of Certification
1110 Authorities (CA) whose <em>clients</em> you deal with. These are used
1111 for Client Authentication. Such a file is simply the concatenation of
1112 the various PEM-encoded CRL files, in order of preference. This can be
1113 used alternatively and/or additionally to <directive
1114 module="mod_ssl">SSLCARevocationPath</directive>.</p>
1115 <example><title>Example</title>
1116 <highlight language="config">
1117 SSLCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-client.crl
1121 </directivesynopsis>
1124 <name>SSLCARevocationCheck</name>
1125 <description>Enable CRL-based revocation checking</description>
1126 <syntax>SSLCARevocationCheck chain|leaf|none</syntax>
1127 <default>SSLCARevocationCheck none</default>
1128 <contextlist><context>server config</context>
1129 <context>virtual host</context></contextlist>
1133 Enables certificate revocation list (CRL) checking. At least one of
1134 <directive module="mod_ssl">SSLCARevocationFile</directive>
1135 or <directive module="mod_ssl">SSLCARevocationPath</directive> must be
1136 configured. When set to <code>chain</code> (recommended setting),
1137 CRL checks are applied to all certificates in the chain, while setting it to
1138 <code>leaf</code> limits the checks to the end-entity cert.
1141 <title>When set to <code>chain</code> or <code>leaf</code>,
1142 CRLs <em>must</em> be available for successful validation</title>
1144 Prior to version 2.3.15, CRL checking in mod_ssl also succeeded when
1145 no CRL(s) were found in any of the locations configured with
1146 <directive module="mod_ssl">SSLCARevocationFile</directive>
1147 or <directive module="mod_ssl">SSLCARevocationPath</directive>.
1148 With the introduction of this directive, the behavior has been changed:
1149 when checking is enabled, CRLs <em>must</em> be present for the validation
1150 to succeed - otherwise it will fail with an
1151 <code>"unable to get certificate CRL"</code> error.
1154 <example><title>Example</title>
1155 <highlight language="config">
1156 SSLCARevocationCheck chain
1160 </directivesynopsis>
1163 <name>SSLVerifyClient</name>
1164 <description>Type of Client Certificate verification</description>
1165 <syntax>SSLVerifyClient <em>level</em></syntax>
1166 <default>SSLVerifyClient none</default>
1167 <contextlist><context>server config</context>
1168 <context>virtual host</context>
1169 <context>directory</context>
1170 <context>.htaccess</context></contextlist>
1171 <override>AuthConfig</override>
1175 This directive sets the Certificate verification level for the Client
1176 Authentication. Notice that this directive can be used both in per-server and
1177 per-directory context. In per-server context it applies to the client
1178 authentication process used in the standard SSL handshake when a connection is
1179 established. In per-directory context it forces a SSL renegotiation with the
1180 reconfigured client verification level after the HTTP request was read but
1181 before the HTTP response is sent.</p>
1183 The following levels are available for <em>level</em>:</p>
1185 <li><strong>none</strong>:
1186 no client Certificate is required at all</li>
1187 <li><strong>optional</strong>:
1188 the client <em>may</em> present a valid Certificate</li>
1189 <li><strong>require</strong>:
1190 the client <em>has to</em> present a valid Certificate</li>
1191 <li><strong>optional_no_ca</strong>:
1192 the client may present a valid Certificate<br />
1193 but it need not to be (successfully) verifiable.</li>
1195 <p>In practice only levels <strong>none</strong> and
1196 <strong>require</strong> are really interesting, because level
1197 <strong>optional</strong> doesn't work with all browsers and level
1198 <strong>optional_no_ca</strong> is actually against the idea of
1199 authentication (but can be used to establish SSL test pages, etc.)</p>
1200 <example><title>Example</title>
1201 <highlight language="config">
1202 SSLVerifyClient require
1206 </directivesynopsis>
1209 <name>SSLVerifyDepth</name>
1210 <description>Maximum depth of CA Certificates in Client
1211 Certificate verification</description>
1212 <syntax>SSLVerifyDepth <em>number</em></syntax>
1213 <default>SSLVerifyDepth 1</default>
1214 <contextlist><context>server config</context>
1215 <context>virtual host</context>
1216 <context>directory</context>
1217 <context>.htaccess</context></contextlist>
1218 <override>AuthConfig</override>
1222 This directive sets how deeply mod_ssl should verify before deciding that the
1223 clients don't have a valid certificate. Notice that this directive can be
1224 used both in per-server and per-directory context. In per-server context it
1225 applies to the client authentication process used in the standard SSL
1226 handshake when a connection is established. In per-directory context it forces
1227 a SSL renegotiation with the reconfigured client verification depth after the
1228 HTTP request was read but before the HTTP response is sent.</p>
1230 The depth actually is the maximum number of intermediate certificate issuers,
1231 i.e. the number of CA certificates which are max allowed to be followed while
1232 verifying the client certificate. A depth of 0 means that self-signed client
1233 certificates are accepted only, the default depth of 1 means the client
1234 certificate can be self-signed or has to be signed by a CA which is directly
1235 known to the server (i.e. the CA's certificate is under
1236 <directive module="mod_ssl">SSLCACertificatePath</directive>), etc.</p>
1237 <example><title>Example</title>
1238 <highlight language="config">
1243 </directivesynopsis>
1246 <name>SSLSRPVerifierFile</name>
1247 <description>Path to SRP verifier file</description>
1248 <syntax>SSLSRPVerifierFile <em>file-path</em></syntax>
1249 <contextlist><context>server config</context>
1250 <context>virtual host</context></contextlist>
1254 This directive enables TLS-SRP and sets the path to the OpenSSL SRP (Secure
1255 Remote Password) verifier file containing TLS-SRP usernames, verifiers, salts,
1256 and group parameters.</p>
1257 <example><title>Example</title>
1258 SSLSRPVerifierFile "/path/to/file.srpv"
1261 The verifier file can be created with the <code>openssl</code> command line
1263 <example><title>Creating the SRP verifier file</title>
1264 openssl srp -srpvfile passwd.srpv -userinfo "some info" -add username
1266 <p> The value given with the optional <code>-userinfo</code> parameter is
1267 avalable in the <code>SSL_SRP_USERINFO</code> request environment variable.</p>
1270 </directivesynopsis>
1273 <name>SSLSRPUnknownUserSeed</name>
1274 <description>SRP unknown user seed</description>
1275 <syntax>SSLSRPUnknownUserSeed <em>secret-string</em></syntax>
1276 <contextlist><context>server config</context>
1277 <context>virtual host</context></contextlist>
1281 This directive sets the seed used to fake SRP user parameters for unknown
1282 users, to avoid leaking whether a given user exists. Specify a secret
1283 string. If this directive is not used, then Apache will return the
1284 UNKNOWN_PSK_IDENTITY alert to clients who specify an unknown username.
1286 <example><title>Example</title>
1287 SSLSRPUnknownUserSeed "secret"
1290 </directivesynopsis>
1293 <name>SSLOptions</name>
1294 <description>Configure various SSL engine run-time options</description>
1295 <syntax>SSLOptions [+|-]<em>option</em> ...</syntax>
1296 <contextlist><context>server config</context>
1297 <context>virtual host</context>
1298 <context>directory</context>
1299 <context>.htaccess</context></contextlist>
1300 <override>Options</override>
1304 This directive can be used to control various run-time options on a
1305 per-directory basis. Normally, if multiple <code>SSLOptions</code>
1306 could apply to a directory, then the most specific one is taken
1307 completely; the options are not merged. However if <em>all</em> the
1308 options on the <code>SSLOptions</code> directive are preceded by a
1309 plus (<code>+</code>) or minus (<code>-</code>) symbol, the options
1310 are merged. Any options preceded by a <code>+</code> are added to the
1311 options currently in force, and any options preceded by a
1312 <code>-</code> are removed from the options currently in force.</p>
1314 The available <em>option</em>s are:</p>
1316 <li><code>StdEnvVars</code>
1318 When this option is enabled, the standard set of SSL related CGI/SSI
1319 environment variables are created. This per default is disabled for
1320 performance reasons, because the information extraction step is a
1321 rather expensive operation. So one usually enables this option for
1322 CGI and SSI requests only.</p>
1324 <li><code>ExportCertData</code>
1326 When this option is enabled, additional CGI/SSI environment variables are
1327 created: <code>SSL_SERVER_CERT</code>, <code>SSL_CLIENT_CERT</code> and
1328 <code>SSL_CLIENT_CERT_CHAIN_</code><em>n</em> (with <em>n</em> = 0,1,2,..).
1329 These contain the PEM-encoded X.509 Certificates of server and client for
1330 the current HTTPS connection and can be used by CGI scripts for deeper
1331 Certificate checking. Additionally all other certificates of the client
1332 certificate chain are provided, too. This bloats up the environment a
1333 little bit which is why you have to use this option to enable it on
1336 <li><code>FakeBasicAuth</code>
1338 When this option is enabled, the Subject Distinguished Name (DN) of the
1339 Client X509 Certificate is translated into a HTTP Basic Authorization
1340 username. This means that the standard Apache authentication methods can
1341 be used for access control. The user name is just the Subject of the
1342 Client's X509 Certificate (can be determined by running OpenSSL's
1343 <code>openssl x509</code> command: <code>openssl x509 -noout -subject -in
1344 </code><em>certificate</em><code>.crt</code>). The optional <directive
1345 module="mod_ssl">SSLUserName</directive> directive can be used to
1346 specify which part of the certificate Subject is embedded in the username.
1347 Note that no password is obtained from the user. Every entry in the user
1348 file needs this password: ``<code>xxj31ZMTZzkVA</code>'', which is the
1349 DES-encrypted version of the word `<code>password</code>''. Those who
1350 live under MD5-based encryption (for instance under FreeBSD or BSD/OS,
1351 etc.) should use the following MD5 hash of the same word:
1352 ``<code>$1$OXLyS...$Owx8s2/m9/gfkcRVXzgoE/</code>''.</p>
1354 <p>Note that the <directive module="mod_auth_basic">AuthBasicFake</directive>
1355 directive within <module>mod_auth_basic</module> can be used as a more
1356 general mechanism for faking basic authentication, giving control over the
1357 structure of both the username and password.</p>
1359 <li><code>StrictRequire</code>
1361 This <em>forces</em> forbidden access when <code>SSLRequireSSL</code> or
1362 <code>SSLRequire</code> successfully decided that access should be
1363 forbidden. Usually the default is that in the case where a ``<code>Satisfy
1364 any</code>'' directive is used, and other access restrictions are passed,
1365 denial of access due to <code>SSLRequireSSL</code> or
1366 <code>SSLRequire</code> is overridden (because that's how the Apache
1367 <code>Satisfy</code> mechanism should work.) But for strict access restriction
1368 you can use <code>SSLRequireSSL</code> and/or <code>SSLRequire</code> in
1369 combination with an ``<code>SSLOptions +StrictRequire</code>''. Then an
1370 additional ``<code>Satisfy Any</code>'' has no chance once mod_ssl has
1371 decided to deny access.</p>
1373 <li><code>OptRenegotiate</code>
1375 This enables optimized SSL connection renegotiation handling when SSL
1376 directives are used in per-directory context. By default a strict
1377 scheme is enabled where <em>every</em> per-directory reconfiguration of
1378 SSL parameters causes a <em>full</em> SSL renegotiation handshake. When this
1379 option is used mod_ssl tries to avoid unnecessary handshakes by doing more
1380 granular (but still safe) parameter checks. Nevertheless these granular
1381 checks sometimes may not be what the user expects, so enable this on a
1382 per-directory basis only, please.</p>
1384 <li><code>LegacyDNStringFormat</code>
1386 This option influences how values of the
1387 <code>SSL_{CLIENT,SERVER}_{I,S}_DN</code> variables are formatted. Since
1388 version 2.3.11, Apache HTTPD uses a RFC 2253 compatible format by
1389 default. This uses commas as delimiters between the attributes, allows the
1390 use of non-ASCII characters (which are converted to UTF8), escapes
1391 various special characters with backslashes, and sorts the attributes
1392 with the "C" attribute last.</p>
1394 <p>If <code>LegacyDNStringFormat</code> is set, the old format will be
1395 used which sorts the "C" attribute first, uses slashes as separators, and
1396 does not handle non-ASCII and special characters in any consistent way.
1400 <example><title>Example</title>
1401 <highlight language="config">
1402 SSLOptions +FakeBasicAuth -StrictRequire
1403 <Files ~ "\.(cgi|shtml)$">
1404 SSLOptions +StdEnvVars -ExportCertData
1409 </directivesynopsis>
1412 <name>SSLRequireSSL</name>
1413 <description>Deny access when SSL is not used for the
1414 HTTP request</description>
1415 <syntax>SSLRequireSSL</syntax>
1416 <contextlist><context>directory</context>
1417 <context>.htaccess</context></contextlist>
1418 <override>AuthConfig</override>
1421 <p><!-- XXX: I think the syntax is wrong -->
1422 This directive forbids access unless HTTP over SSL (i.e. HTTPS) is enabled for
1423 the current connection. This is very handy inside the SSL-enabled virtual
1424 host or directories for defending against configuration errors that expose
1425 stuff that should be protected. When this directive is present all requests
1426 are denied which are not using SSL.</p>
1427 <example><title>Example</title>
1428 <highlight language="config">
1433 </directivesynopsis>
1436 <name>SSLRequire</name>
1437 <description>Allow access only when an arbitrarily complex
1438 boolean expression is true</description>
1439 <syntax>SSLRequire <em>expression</em></syntax>
1440 <contextlist><context>directory</context>
1441 <context>.htaccess</context></contextlist>
1442 <override>AuthConfig</override>
1446 <note><title>SSLRequire is deprecated</title>
1447 <p><code>SSLRequire</code> is deprecated and should in general be replaced
1448 by <a href="mod_authz_core.html#reqexpr">Require expr</a>. The so called
1449 <a href="../expr.html">ap_expr</a> syntax of <code>Require expr</code> is
1450 a superset of the syntax of <code>SSLRequire</code>, with the following
1453 <p>In <code>SSLRequire</code>, the comparison operators <code><</code>,
1454 <code><=</code>, ... are completely equivalent to the operators
1455 <code>lt</code>, <code>le</code>, ... and work in a somewhat peculiar way that
1456 first compares the length of two strings and then the lexical order.
1457 On the other hand, <a href="../expr.html">ap_expr</a> has two sets of
1458 comparison operators: The operators <code><</code>,
1459 <code><=</code>, ... do lexical string comparison, while the operators
1460 <code>-lt</code>, <code>-le</code>, ... do integer comparison.
1461 For the latter, there are also aliases without the leading dashes:
1462 <code>lt</code>, <code>le</code>, ...
1468 This directive specifies a general access requirement which has to be
1469 fulfilled in order to allow access. It is a very powerful directive because the
1470 requirement specification is an arbitrarily complex boolean expression
1471 containing any number of access checks.</p>
1473 The <em>expression</em> must match the following syntax (given as a BNF
1474 grammar notation):</p>
1477 expr ::= "<strong>true</strong>" | "<strong>false</strong>"
1478 | "<strong>!</strong>" expr
1479 | expr "<strong>&&</strong>" expr
1480 | expr "<strong>||</strong>" expr
1481 | "<strong>(</strong>" expr "<strong>)</strong>"
1484 comp ::= word "<strong>==</strong>" word | word "<strong>eq</strong>" word
1485 | word "<strong>!=</strong>" word | word "<strong>ne</strong>" word
1486 | word "<strong><</strong>" word | word "<strong>lt</strong>" word
1487 | word "<strong><=</strong>" word | word "<strong>le</strong>" word
1488 | word "<strong>></strong>" word | word "<strong>gt</strong>" word
1489 | word "<strong>>=</strong>" word | word "<strong>ge</strong>" word
1490 | word "<strong>in</strong>" "<strong>{</strong>" wordlist "<strong>}</strong>"
1491 | word "<strong>in</strong>" "<strong>PeerExtList(</strong>" word "<strong>)</strong>"
1492 | word "<strong>=~</strong>" regex
1493 | word "<strong>!~</strong>" regex
1496 | wordlist "<strong>,</strong>" word
1505 variable ::= "<strong>%{</strong>" varname "<strong>}</strong>"
1506 function ::= funcname "<strong>(</strong>" funcargs "<strong>)</strong>"
1509 <p>For <code>varname</code> any of the variables described in <a
1510 href="#envvars">Environment Variables</a> can be used. For
1511 <code>funcname</code> the available functions are listed in
1512 the <a href="../expr.html#functions">ap_expr documentation</a>.</p>
1514 <p>The <em>expression</em> is parsed into an internal machine
1515 representation when the configuration is loaded, and then evaluated
1516 during request processing. In .htaccess context, the <em>expression</em> is
1517 both parsed and executed each time the .htaccess file is encountered during
1518 request processing.</p>
1520 <example><title>Example</title>
1521 <highlight language="config">
1522 SSLRequire ( %{SSL_CIPHER} !~ m/^(EXP|NULL)-/ \
1523 and %{SSL_CLIENT_S_DN_O} eq "Snake Oil, Ltd." \
1524 and %{SSL_CLIENT_S_DN_OU} in {"Staff", "CA", "Dev"} \
1525 and %{TIME_WDAY} -ge 1 and %{TIME_WDAY} -le 5 \
1526 and %{TIME_HOUR} -ge 8 and %{TIME_HOUR} -le 20 ) \
1527 or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/
1531 <p>The <code>PeerExtList(<em>object-ID</em>)</code> function expects
1532 to find zero or more instances of the X.509 certificate extension
1533 identified by the given <em>object ID</em> (OID) in the client certificate.
1534 The expression evaluates to true if the left-hand side string matches
1535 exactly against the value of an extension identified with this OID.
1536 (If multiple extensions with the same OID are present, at least one
1537 extension must match).</p>
1539 <example><title>Example</title>
1540 <highlight language="config">
1541 SSLRequire "foobar" in PeerExtList("1.2.3.4.5.6")
1545 <note><title>Notes on the PeerExtList function</title>
1549 <li><p>The object ID can be specified either as a descriptive
1550 name recognized by the SSL library, such as <code>"nsComment"</code>,
1551 or as a numeric OID, such as <code>"1.2.3.4.5.6"</code>.</p></li>
1553 <li><p>Expressions with types known to the SSL library are rendered to
1554 a string before comparison. For an extension with a type not
1555 recognized by the SSL library, mod_ssl will parse the value if it is
1556 one of the primitive ASN.1 types UTF8String, IA5String, VisibleString,
1557 or BMPString. For an extension of one of these types, the string
1558 value will be converted to UTF-8 if necessary, then compared against
1559 the left-hand-side expression.</p></li>
1565 <seealso><a href="../env.html">Environment Variables in Apache HTTP Server</a>,
1566 for additional examples.
1568 <seealso><a href="mod_authz_core.html#reqexpr">Require expr</a></seealso>
1569 <seealso><a href="../expr.html">Generic expression syntax in Apache HTTP Server</a>
1571 </directivesynopsis>
1574 <name>SSLRenegBufferSize</name>
1575 <description>Set the size for the SSL renegotiation buffer</description>
1576 <syntax>SSLRenegBufferSize <var>bytes</var></syntax>
1577 <default>SSLRenegBufferSize 131072</default>
1578 <contextlist><context>directory</context>
1579 <context>.htaccess</context></contextlist>
1580 <override>AuthConfig</override>
1584 <p>If an SSL renegotiation is required in per-location context, for
1585 example, any use of <directive
1586 module="mod_ssl">SSLVerifyClient</directive> in a Directory or
1587 Location block, then <module>mod_ssl</module> must buffer any HTTP
1588 request body into memory until the new SSL handshake can be performed.
1589 This directive can be used to set the amount of memory that will be
1590 used for this buffer. </p>
1592 <note type="warning"><p>
1593 Note that in many configurations, the client sending the request body
1594 will be untrusted so a denial of service attack by consumption of
1595 memory must be considered when changing this configuration setting.
1598 <example><title>Example</title>
1599 <highlight language="config">
1600 SSLRenegBufferSize 262144
1604 </directivesynopsis>
1607 <name>SSLStrictSNIVHostCheck</name>
1608 <description>Whether to allow non-SNI clients to access a name-based virtual
1611 <syntax>SSLStrictSNIVHostCheck on|off</syntax>
1612 <default>SSLStrictSNIVHostCheck off</default>
1613 <contextlist><context>server config</context>
1614 <context>virtual host</context></contextlist>
1618 This directive sets whether a non-SNI client is allowed to access a name-based
1619 virtual host. If set to <code>on</code> in the default name-based virtual
1620 host, clients that are SNI unaware will not be allowed to access <em>any</em>
1621 virtual host, belonging to this particular IP / port combination.
1622 If set to <code>on</code> in any other virtual host, SNI unaware clients
1623 are not allowed to access this particular virtual host.
1626 <note type="warning"><p>
1627 This option is only available if httpd was compiled against an SNI capable
1631 <example><title>Example</title>
1632 <highlight language="config">
1633 SSLStrictSNIVHostCheck on
1637 </directivesynopsis>
1640 <name>SSLProxyMachineCertificatePath</name>
1641 <description>Directory of PEM-encoded client certificates and keys to be used by the proxy</description>
1642 <syntax>SSLProxyMachineCertificatePath <em>directory</em></syntax>
1643 <contextlist><context>server config</context></contextlist>
1644 <override>Not applicable</override>
1648 This directive sets the directory where you keep the certificates and
1649 keys used for authentication of the proxy server to remote servers.
1651 <p>The files in this directory must be PEM-encoded and are accessed through
1652 hash filenames. Additionally, you must create symbolic links named
1653 <code><em>hash-value</em>.N</code>. And you should always make sure this
1654 directory contains the appropriate symbolic links.</p>
1655 <note type="warning">
1656 <p>Currently there is no support for encrypted private keys</p>
1658 <example><title>Example</title>
1659 <highlight language="config">
1660 SSLProxyMachineCertificatePath /usr/local/apache2/conf/proxy.crt/
1664 </directivesynopsis>
1668 <name>SSLProxyMachineCertificateFile</name>
1669 <description>File of concatenated PEM-encoded client certificates and keys to be used by the proxy</description>
1670 <syntax>SSLProxyMachineCertificateFile <em>filename</em></syntax>
1671 <contextlist><context>server config</context></contextlist>
1672 <override>Not applicable</override>
1676 This directive sets the all-in-one file where you keep the certificates and
1677 keys used for authentication of the proxy server to remote servers.
1680 This referenced file is simply the concatenation of the various PEM-encoded
1681 certificate files, in order of preference. Use this directive alternatively
1682 or additionally to <code>SSLProxyMachineCertificatePath</code>.
1684 <note type="warning">
1685 <p>Currently there is no support for encrypted private keys</p>
1687 <example><title>Example</title>
1688 <highlight language="config">
1689 SSLProxyMachineCertificateFile /usr/local/apache2/conf/ssl.crt/proxy.pem
1693 </directivesynopsis>
1696 <name>SSLProxyMachineCertificateChainFile</name>
1697 <description>File of concatenated PEM-encoded CA certificates to be used by the proxy for choosing a certificate</description>
1698 <syntax>SSLProxyMachineCertificateChainFile <em>filename</em></syntax>
1699 <contextlist><context>server config</context></contextlist>
1700 <override>Not applicable</override>
1704 This directive sets the all-in-one file where you keep the certificate chain
1705 for all of the client certs in use. This directive will be needed if the
1706 remote server presents a list of CA certificates that are not direct signers
1707 of one of the configured client certificates.
1710 This referenced file is simply the concatenation of the various PEM-encoded
1711 certificate files. Upon startup, each client certificate configured will
1712 be examined and a chain of trust will be constructed.
1714 <note type="warning"><title>Security warning</title>
1715 <p>If this directive is enabled, all of the certificates in the file will be
1716 trusted as if they were also in <directive module="mod_ssl">
1717 SSLProxyCACertificateFile</directive>.</p>
1719 <example><title>Example</title>
1720 <highlight language="config">
1721 SSLProxyMachineCertificateChainFile /usr/local/apache2/conf/ssl.crt/proxyCA.pem
1725 </directivesynopsis>
1728 <name>SSLProxyVerify</name>
1729 <description>Type of remote server Certificate verification</description>
1730 <syntax>SSLProxyVerify <em>level</em></syntax>
1731 <default>SSLProxyVerify none</default>
1732 <contextlist><context>server config</context>
1733 <context>virtual host</context> </contextlist>
1737 <p>When a proxy is configured to forward requests to a remote SSL
1738 server, this directive can be used to configure certificate
1739 verification of the remote server. </p>
1741 The following levels are available for <em>level</em>:</p>
1743 <li><strong>none</strong>:
1744 no remote server Certificate is required at all</li>
1745 <li><strong>optional</strong>:
1746 the remote server <em>may</em> present a valid Certificate</li>
1747 <li><strong>require</strong>:
1748 the remote server <em>has to</em> present a valid Certificate</li>
1749 <li><strong>optional_no_ca</strong>:
1750 the remote server may present a valid Certificate<br />
1751 but it need not to be (successfully) verifiable.</li>
1753 <p>In practice only levels <strong>none</strong> and
1754 <strong>require</strong> are really interesting, because level
1755 <strong>optional</strong> doesn't work with all servers and level
1756 <strong>optional_no_ca</strong> is actually against the idea of
1757 authentication (but can be used to establish SSL test pages, etc.)</p>
1758 <example><title>Example</title>
1759 <highlight language="config">
1760 SSLProxyVerify require
1764 </directivesynopsis>
1767 <name>SSLProxyVerifyDepth</name>
1768 <description>Maximum depth of CA Certificates in Remote Server
1769 Certificate verification</description>
1770 <syntax>SSLProxyVerifyDepth <em>number</em></syntax>
1771 <default>SSLProxyVerifyDepth 1</default>
1772 <contextlist><context>server config</context>
1773 <context>virtual host</context> </contextlist>
1777 This directive sets how deeply mod_ssl should verify before deciding that the
1778 remote server does not have a valid certificate. </p>
1780 The depth actually is the maximum number of intermediate certificate issuers,
1781 i.e. the number of CA certificates which are max allowed to be followed while
1782 verifying the remote server certificate. A depth of 0 means that self-signed
1783 remote server certificates are accepted only, the default depth of 1 means
1784 the remote server certificate can be self-signed or has to be signed by a CA
1785 which is directly known to the server (i.e. the CA's certificate is under
1786 <directive module="mod_ssl">SSLProxyCACertificatePath</directive>), etc.</p>
1787 <example><title>Example</title>
1788 <highlight language="config">
1789 SSLProxyVerifyDepth 10
1793 </directivesynopsis>
1796 <name>SSLProxyCheckPeerExpire</name>
1797 <description>Whether to check if remote server certificate is expired
1799 <syntax>SSLProxyCheckPeerExpire on|off</syntax>
1800 <default>SSLProxyCheckPeerExpire on</default>
1801 <contextlist><context>server config</context>
1802 <context>virtual host</context></contextlist>
1806 This directive sets whether it is checked if the remote server certificate
1807 is expired or not. If the check fails a 502 status code (Bad Gateway) is
1810 <example><title>Example</title>
1811 <highlight language="config">
1812 SSLProxyCheckPeerExpire on
1816 </directivesynopsis>
1819 <name>SSLProxyCheckPeerCN</name>
1820 <description>Whether to check the remote server certificate's CN field
1822 <syntax>SSLProxyCheckPeerCN on|off</syntax>
1823 <default>SSLProxyCheckPeerCN on</default>
1824 <contextlist><context>server config</context>
1825 <context>virtual host</context></contextlist>
1829 This directive sets whether the remote server certificate's CN field is
1830 compared against the hostname of the request URL. If both are not equal
1831 a 502 status code (Bad Gateway) is sent.
1834 SSLProxyCheckPeerCN has been superseded by
1835 <directive module="mod_ssl">SSLProxyCheckPeerName</directive>, and its
1836 setting is only taken into account when
1837 <code>SSLProxyCheckPeerName off</code> is specified at the same time.
1839 <example><title>Example</title>
1840 <highlight language="config">
1841 SSLProxyCheckPeerCN on
1845 </directivesynopsis>
1848 <name>SSLProxyCheckPeerName</name>
1849 <description>Configure host name checking for remote server certificates
1851 <syntax>SSLProxyCheckPeerName on|off</syntax>
1852 <default>SSLProxyCheckPeerName on</default>
1853 <contextlist><context>server config</context>
1854 <context>virtual host</context></contextlist>
1858 This directive configures host name checking for server certificates
1859 when mod_ssl is acting as an SSL client. The check will
1860 succeed if the host name from the request URI is found in
1861 either the subjectAltName extension or (one of) the CN attribute(s)
1862 in the certificate's subject. If the check fails, the SSL request
1863 is aborted and a 502 status code (Bad Gateway) is returned.
1864 The directive supersedes <directive module="mod_ssl">SSLProxyCheckPeerCN</directive>,
1865 which only checks for the expected host name in the first CN attribute.
1868 Wildcard matching is supported in one specific flavor: subjectAltName entries
1869 of type dNSName or CN attributes starting with <code>*.</code> will match
1870 for any DNS name with the same number of labels and the same suffix
1871 (i.e., <code>*.example.org</code> matches for <code>foo.example.org</code>,
1872 but not for <code>foo.bar.example.org</code>).
1875 </directivesynopsis>
1878 <name>SSLProxyEngine</name>
1879 <description>SSL Proxy Engine Operation Switch</description>
1880 <syntax>SSLProxyEngine on|off</syntax>
1881 <default>SSLProxyEngine off</default>
1882 <contextlist><context>server config</context>
1883 <context>virtual host</context></contextlist>
1887 This directive toggles the usage of the SSL/TLS Protocol Engine for proxy. This
1888 is usually used inside a <directive module="core"
1889 type="section">VirtualHost</directive> section to enable SSL/TLS for proxy
1890 usage in a particular virtual host. By default the SSL/TLS Protocol Engine is
1891 disabled for proxy both for the main server and all configured virtual hosts.</p>
1893 <p>Note that the SSLProxyEngine directive should not, in
1894 general, be included in a virtual host that will be acting as a
1895 forward proxy (using <Proxy> or <ProxyRequest> directives.
1896 SSLProxyEngine is not required to enable a forward proxy server to
1897 proxy SSL/TLS requests.</p>
1899 <example><title>Example</title>
1900 <highlight language="config">
1901 <VirtualHost _default_:443>
1904 </VirtualHost>
1908 </directivesynopsis>
1911 <name>SSLProxyProtocol</name>
1912 <description>Configure usable SSL protocol flavors for proxy usage</description>
1913 <syntax>SSLProxyProtocol [+|-]<em>protocol</em> ...</syntax>
1914 <default>SSLProxyProtocol all</default>
1915 <contextlist><context>server config</context>
1916 <context>virtual host</context></contextlist>
1917 <override>Options</override>
1920 <!-- XXX Why does this have an override and not .htaccess context? -->
1922 This directive can be used to control the SSL protocol flavors mod_ssl should
1923 use when establishing its server environment for proxy . It will only connect
1924 to servers using one of the provided protocols.</p>
1925 <p>Please refer to <directive module="mod_ssl">SSLProtocol</directive>
1926 for additional information.
1929 </directivesynopsis>
1932 <name>SSLProxyCipherSuite</name>
1933 <description>Cipher Suite available for negotiation in SSL
1934 proxy handshake</description>
1935 <syntax>SSLProxyCipherSuite <em>cipher-spec</em></syntax>
1936 <default>SSLProxyCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+EXP</default>
1937 <contextlist><context>server config</context>
1938 <context>virtual host</context>
1939 <context>directory</context>
1940 <context>.htaccess</context></contextlist>
1941 <override>AuthConfig</override>
1943 <p>Equivalent to <code>SSLCipherSuite</code>, but for the proxy connection.
1944 Please refer to <directive module="mod_ssl">SSLCipherSuite</directive>
1945 for additional information.</p>
1948 </directivesynopsis>
1950 <name>SSLProxyCACertificatePath</name>
1951 <description>Directory of PEM-encoded CA Certificates for
1952 Remote Server Auth</description>
1953 <syntax>SSLProxyCACertificatePath <em>directory-path</em></syntax>
1954 <contextlist><context>server config</context>
1955 <context>virtual host</context></contextlist>
1959 This directive sets the directory where you keep the Certificates of
1960 Certification Authorities (CAs) whose remote servers you deal with. These are used to
1961 verify the remote server certificate on Remote Server Authentication.</p>
1963 The files in this directory have to be PEM-encoded and are accessed through
1964 hash filenames. So usually you can't just place the Certificate files
1965 there: you also have to create symbolic links named
1966 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
1967 contains the appropriate symbolic links.</p>
1968 <example><title>Example</title>
1969 <highlight language="config">
1970 SSLProxyCACertificatePath /usr/local/apache2/conf/ssl.crt/
1974 </directivesynopsis>
1977 <name>SSLProxyCACertificateFile</name>
1978 <description>File of concatenated PEM-encoded CA Certificates
1979 for Remote Server Auth</description>
1980 <syntax>SSLProxyCACertificateFile <em>file-path</em></syntax>
1981 <contextlist><context>server config</context>
1982 <context>virtual host</context></contextlist>
1986 This directive sets the <em>all-in-one</em> file where you can assemble the
1987 Certificates of Certification Authorities (CA) whose <em>remote servers</em> you deal
1988 with. These are used for Remote Server Authentication. Such a file is simply the
1989 concatenation of the various PEM-encoded Certificate files, in order of
1990 preference. This can be used alternatively and/or additionally to
1991 <directive module="mod_ssl">SSLProxyCACertificatePath</directive>.</p>
1992 <example><title>Example</title>
1993 <highlight language="config">
1994 SSLProxyCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-remote-server.crt
1998 </directivesynopsis>
2001 <name>SSLProxyCARevocationPath</name>
2002 <description>Directory of PEM-encoded CA CRLs for
2003 Remote Server Auth</description>
2004 <syntax>SSLProxyCARevocationPath <em>directory-path</em></syntax>
2005 <contextlist><context>server config</context>
2006 <context>virtual host</context></contextlist>
2010 This directive sets the directory where you keep the Certificate Revocation
2011 Lists (CRL) of Certification Authorities (CAs) whose remote servers you deal with.
2012 These are used to revoke the remote server certificate on Remote Server Authentication.</p>
2014 The files in this directory have to be PEM-encoded and are accessed through
2015 hash filenames. So usually you have not only to place the CRL files there.
2016 Additionally you have to create symbolic links named
2017 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
2018 contains the appropriate symbolic links.</p>
2019 <example><title>Example</title>
2020 <highlight language="config">
2021 SSLProxyCARevocationPath /usr/local/apache2/conf/ssl.crl/
2025 </directivesynopsis>
2028 <name>SSLProxyCARevocationFile</name>
2029 <description>File of concatenated PEM-encoded CA CRLs for
2030 Remote Server Auth</description>
2031 <syntax>SSLProxyCARevocationFile <em>file-path</em></syntax>
2032 <contextlist><context>server config</context>
2033 <context>virtual host</context></contextlist>
2037 This directive sets the <em>all-in-one</em> file where you can
2038 assemble the Certificate Revocation Lists (CRL) of Certification
2039 Authorities (CA) whose <em>remote servers</em> you deal with. These are used
2040 for Remote Server Authentication. Such a file is simply the concatenation of
2041 the various PEM-encoded CRL files, in order of preference. This can be
2042 used alternatively and/or additionally to <directive
2043 module="mod_ssl">SSLProxyCARevocationPath</directive>.</p>
2044 <example><title>Example</title>
2045 <highlight language="config">
2046 SSLProxyCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-remote-server.crl
2050 </directivesynopsis>
2053 <name>SSLProxyCARevocationCheck</name>
2054 <description>Enable CRL-based revocation checking for Remote Server Auth</description>
2055 <syntax>SSLProxyCARevocationCheck chain|leaf|none</syntax>
2056 <default>SSLProxyCARevocationCheck none</default>
2057 <contextlist><context>server config</context>
2058 <context>virtual host</context></contextlist>
2062 Enables certificate revocation list (CRL) checking for the
2063 <em>remote servers</em> you deal with. At least one of
2064 <directive module="mod_ssl">SSLProxyCARevocationFile</directive>
2065 or <directive module="mod_ssl">SSLProxyCARevocationPath</directive> must be
2066 configured. When set to <code>chain</code> (recommended setting),
2067 CRL checks are applied to all certificates in the chain, while setting it to
2068 <code>leaf</code> limits the checks to the end-entity cert.
2071 <title>When set to <code>chain</code> or <code>leaf</code>,
2072 CRLs <em>must</em> be available for successful validation</title>
2074 Prior to version 2.3.15, CRL checking in mod_ssl also succeeded when
2075 no CRL(s) were found in any of the locations configured with
2076 <directive module="mod_ssl">SSLProxyCARevocationFile</directive>
2077 or <directive module="mod_ssl">SSLProxyCARevocationPath</directive>.
2078 With the introduction of this directive, the behavior has been changed:
2079 when checking is enabled, CRLs <em>must</em> be present for the validation
2080 to succeed - otherwise it will fail with an
2081 <code>"unable to get certificate CRL"</code> error.
2084 <example><title>Example</title>
2085 <highlight language="config">
2086 SSLProxyCARevocationCheck chain
2090 </directivesynopsis>
2093 <name>SSLUserName</name>
2094 <description>Variable name to determine user name</description>
2095 <syntax>SSLUserName <em>varname</em></syntax>
2096 <contextlist><context>server config</context>
2097 <context>directory</context>
2098 <context>.htaccess</context></contextlist>
2099 <override>AuthConfig</override>
2103 This directive sets the "user" field in the Apache request object.
2104 This is used by lower modules to identify the user with a character
2105 string. In particular, this may cause the environment variable
2106 <code>REMOTE_USER</code> to be set. The <em>varname</em> can be
2107 any of the <a href="#envvars">SSL environment variables</a>.</p>
2109 <p>When the <code>FakeBasicAuth</code> option is enabled, this directive
2110 instead controls the value of the username embedded within the basic
2111 authentication header (see <a href="#ssloptions">SSLOptions</a>).</p>
2113 <example><title>Example</title>
2114 <highlight language="config">
2115 SSLUserName SSL_CLIENT_S_DN_CN
2119 </directivesynopsis>
2122 <name>SSLHonorCipherOrder</name>
2123 <description>Option to prefer the server's cipher preference order</description>
2124 <syntax>SSLHonorCipherOrder on|off</syntax>
2125 <default>SSLHonorCipherOrder off</default>
2126 <contextlist><context>server config</context>
2127 <context>virtual host</context></contextlist>
2128 <compatibility>Available if using OpenSSL 0.9.7 or later</compatibility>
2131 <p>When choosing a cipher during an SSLv3 or TLSv1 handshake, normally
2132 the client's preference is used. If this directive is enabled, the
2133 server's preference will be used instead.</p>
2134 <example><title>Example</title>
2135 <highlight language="config">
2136 SSLHonorCipherOrder on
2140 </directivesynopsis>
2143 <name>SSLCryptoDevice</name>
2144 <description>Enable use of a cryptographic hardware accelerator</description>
2145 <syntax>SSLCryptoDevice <em>engine</em></syntax>
2146 <default>SSLCryptoDevice builtin</default>
2147 <contextlist><context>server config</context></contextlist>
2151 This directive enables use of a cryptographic hardware accelerator
2152 board to offload some of the SSL processing overhead. This directive
2153 can only be used if the SSL toolkit is built with "engine" support;
2154 OpenSSL 0.9.7 and later releases have "engine" support by default, the
2155 separate "-engine" releases of OpenSSL 0.9.6 must be used.</p>
2157 <p>To discover which engine names are supported, run the command
2158 "<code>openssl engine</code>".</p>
2160 <example><title>Example</title>
2161 <highlight language="config">
2162 # For a Broadcom accelerator:
2163 SSLCryptoDevice ubsec
2167 </directivesynopsis>
2170 <name>SSLOCSPEnable</name>
2171 <description>Enable OCSP validation of the client certificate chain</description>
2172 <syntax>SSLOCSPEnable on|off</syntax>
2173 <default>SSLOCSPEnable off</default>
2174 <contextlist><context>server config</context>
2175 <context>virtual host</context></contextlist>
2176 <compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
2179 <p>This option enables OCSP validation of the client certificate
2180 chain. If this option is enabled, certificates in the client's
2181 certificate chain will be validated against an OCSP responder after
2182 normal verification (including CRL checks) have taken place.</p>
2184 <p>The OCSP responder used is either extracted from the certificate
2185 itself, or derived by configuration; see the
2186 <directive module="mod_ssl">SSLOCSPDefaultResponder</directive> and
2187 <directive module="mod_ssl">SSLOCSPOverrideResponder</directive>
2190 <example><title>Example</title>
2191 <highlight language="config">
2194 SSLOCSPDefaultResponder http://responder.example.com:8888/responder
2195 SSLOCSPOverrideResponder on
2199 </directivesynopsis>
2202 <name>SSLOCSPDefaultResponder</name>
2203 <description>Set the default responder URI for OCSP validation</description>
2204 <syntax>SSLOCSDefaultResponder <em>uri</em></syntax>
2205 <contextlist><context>server config</context>
2206 <context>virtual host</context></contextlist>
2207 <compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
2210 <p>This option sets the default OCSP responder to use. If <directive
2211 module="mod_ssl">SSLOCSPOverrideResponder</directive> is not enabled,
2212 the URI given will be used only if no responder URI is specified in
2213 the certificate being verified.</p>
2215 </directivesynopsis>
2218 <name>SSLOCSPOverrideResponder</name>
2219 <description>Force use of the default responder URI for OCSP validation</description>
2220 <syntax>SSLOCSPOverrideResponder on|off</syntax>
2221 <default>SSLOCSPOverrideResponder off</default>
2222 <contextlist><context>server config</context>
2223 <context>virtual host</context></contextlist>
2224 <compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
2227 <p>This option forces the configured default OCSP responder to be used
2228 during OCSP certificate validation, regardless of whether the
2229 certificate being validated references an OCSP responder.</p>
2231 </directivesynopsis>
2234 <name>SSLOCSPResponseTimeSkew</name>
2235 <description>Maximum allowable time skew for OCSP response validation</description>
2236 <syntax>SSLOCSPResponseTimeSkew <em>seconds</em></syntax>
2237 <default>SSLOCSPResponseTimeSkew 300</default>
2238 <contextlist><context>server config</context>
2239 <context>virtual host</context></contextlist>
2240 <compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
2243 <p>This option sets the maximum allowable time skew for OCSP responses
2244 (when checking their <code>thisUpdate</code> and <code>nextUpdate</code> fields).</p>
2246 </directivesynopsis>
2249 <name>SSLOCSPResponseMaxAge</name>
2250 <description>Maximum allowable age for OCSP responses</description>
2251 <syntax>SSLOCSPResponseMaxAge <em>seconds</em></syntax>
2252 <default>SSLOCSPResponseMaxAge -1</default>
2253 <contextlist><context>server config</context>
2254 <context>virtual host</context></contextlist>
2255 <compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
2258 <p>This option sets the maximum allowable age ("freshness") for OCSP responses.
2259 The default value (<code>-1</code>) does not enforce a maximum age,
2260 which means that OCSP responses are considered valid as long as their
2261 <code>nextUpdate</code> field is in the future.</p>
2263 </directivesynopsis>
2266 <name>SSLOCSPResponderTimeout</name>
2267 <description>Timeout for OCSP queries</description>
2268 <syntax>SSLOCSPResponderTimeout <em>seconds</em></syntax>
2269 <default>SSLOCSPResponderTimeout 10</default>
2270 <contextlist><context>server config</context>
2271 <context>virtual host</context></contextlist>
2272 <compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
2275 <p>This option sets the timeout for queries to OCSP responders, when
2276 <directive module="mod_ssl">SSLOCSPEnable</directive> is turned on.</p>
2278 </directivesynopsis>
2281 <name>SSLOCSPUseRequestNonce</name>
2282 <description>Use a nonce within OCSP queries</description>
2283 <syntax>SSLOCSPUseRequestNonce on|off</syntax>
2284 <default>SSLOCSPUseRequestNonce on</default>
2285 <contextlist><context>server config</context>
2286 <context>virtual host</context></contextlist>
2287 <compatibility>Available in httpd 2.4.10 and later, if using OpenSSL 0.9.7 or later</compatibility>
2290 <p>This option determines whether queries to OCSP responders should contain
2291 a nonce or not. By default, a query nonce is always used and checked against
2292 the response's one. When the responder does not use nonces (eg. Microsoft OCSP
2293 Responder), this option ought to be turned <code>off</code>.</p>
2295 </directivesynopsis>
2298 <name>SSLInsecureRenegotiation</name>
2299 <description>Option to enable support for insecure renegotiation</description>
2300 <syntax>SSLInsecureRenegotiation on|off</syntax>
2301 <default>SSLInsecureRenegotiation off</default>
2302 <contextlist><context>server config</context>
2303 <context>virtual host</context></contextlist>
2304 <compatibility>Available if using OpenSSL 0.9.8m or later</compatibility>
2307 <p>As originally specified, all versions of the SSL and TLS protocols
2308 (up to and including TLS/1.2) were vulnerable to a Man-in-the-Middle
2310 (<a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-2009-3555</a>)
2311 during a renegotiation. This vulnerability allowed an attacker to
2312 "prefix" a chosen plaintext to the HTTP request as seen by the web
2313 server. A protocol extension was developed which fixed this
2314 vulnerability if supported by both client and server.</p>
2316 <p>If <module>mod_ssl</module> is linked against OpenSSL version 0.9.8m
2317 or later, by default renegotiation is only supported with
2318 clients supporting the new protocol extension. If this directive is
2319 enabled, renegotiation will be allowed with old (unpatched) clients,
2320 albeit insecurely.</p>
2322 <note type="warning"><title>Security warning</title>
2323 <p>If this directive is enabled, SSL connections will be vulnerable to
2324 the Man-in-the-Middle prefix attack as described
2325 in <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-2009-3555</a>.</p>
2328 <example><title>Example</title>
2329 <highlight language="config">
2330 SSLInsecureRenegotiation on
2334 <p>The <code>SSL_SECURE_RENEG</code> environment variable can be used
2335 from an SSI or CGI script to determine whether secure renegotiation is
2336 supported for a given SSL connection.</p>
2339 </directivesynopsis>
2342 <name>SSLUseStapling</name>
2343 <description>Enable stapling of OCSP responses in the TLS handshake</description>
2344 <syntax>SSLUseStapling on|off</syntax>
2345 <default>SSLUseStapling off</default>
2346 <contextlist><context>server config</context>
2347 <context>virtual host</context></contextlist>
2348 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2351 <p>This option enables OCSP stapling, as defined by the "Certificate
2352 Status Request" TLS extension specified in RFC 6066. If enabled (and
2353 requested by the client), mod_ssl will include an OCSP response
2354 for its own certificate in the TLS handshake. Configuring an
2355 <directive module="mod_ssl">SSLStaplingCache</directive> is a
2356 prerequisite for enabling OCSP stapling.</p>
2358 <p>OCSP stapling relieves the client of querying the OCSP responder
2359 on its own, but it should be noted that with the RFC 6066 specification,
2360 the server's <code>CertificateStatus</code> reply may only include an
2361 OCSP response for a single cert. For server certificates with intermediate
2362 CA certificates in their chain (the typical case nowadays),
2363 stapling in its current implementation therefore only partially achieves the
2364 stated goal of "saving roundtrips and resources" - see also
2365 <a href="http://www.ietf.org/rfc/rfc6961.txt">RFC 6961</a>
2366 (TLS Multiple Certificate Status Extension).
2369 </directivesynopsis>
2372 <name>SSLStaplingCache</name>
2373 <description>Configures the OCSP stapling cache</description>
2374 <syntax>SSLStaplingCache <em>type</em></syntax>
2375 <contextlist><context>server config</context></contextlist>
2376 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2379 <p>Configures the cache used to store OCSP responses which get included
2380 in the TLS handshake if <directive module="mod_ssl">SSLUseStapling</directive>
2381 is enabled. Configuration of a cache is mandatory for OCSP stapling.
2382 With the exception of <code>none</code> and <code>nonenotnull</code>,
2383 the same storage types are supported as with
2384 <directive module="mod_ssl">SSLSessionCache</directive>.</p>
2386 </directivesynopsis>
2389 <name>SSLStaplingResponseTimeSkew</name>
2390 <description>Maximum allowable time skew for OCSP stapling response validation</description>
2391 <syntax>SSLStaplingResponseTimeSkew <em>seconds</em></syntax>
2392 <default>SSLStaplingResponseTimeSkew 300</default>
2393 <contextlist><context>server config</context>
2394 <context>virtual host</context></contextlist>
2395 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2398 <p>This option sets the maximum allowable time skew when mod_ssl checks the
2399 <code>thisUpdate</code> and <code>nextUpdate</code> fields of OCSP responses
2400 which get included in the TLS handshake (OCSP stapling). Only applicable
2401 if <directive module="mod_ssl">SSLUseStapling</directive> is turned on.</p>
2403 </directivesynopsis>
2406 <name>SSLStaplingResponderTimeout</name>
2407 <description>Timeout for OCSP stapling queries</description>
2408 <syntax>SSLStaplingResponderTimeout <em>seconds</em></syntax>
2409 <default>SSLStaplingResponderTimeout 10</default>
2410 <contextlist><context>server config</context>
2411 <context>virtual host</context></contextlist>
2412 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2415 <p>This option sets the timeout for queries to OCSP responders when
2416 <directive module="mod_ssl">SSLUseStapling</directive> is enabled
2417 and mod_ssl is querying a responder for OCSP stapling purposes.</p>
2419 </directivesynopsis>
2422 <name>SSLStaplingResponseMaxAge</name>
2423 <description>Maximum allowable age for OCSP stapling responses</description>
2424 <syntax>SSLStaplingResponseMaxAge <em>seconds</em></syntax>
2425 <default>SSLStaplingResponseMaxAge -1</default>
2426 <contextlist><context>server config</context>
2427 <context>virtual host</context></contextlist>
2428 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2431 <p>This option sets the maximum allowable age ("freshness") when
2432 considering OCSP responses for stapling purposes, i.e. when
2433 <directive module="mod_ssl">SSLUseStapling</directive> is turned on.
2434 The default value (<code>-1</code>) does not enforce a maximum age,
2435 which means that OCSP responses are considered valid as long as their
2436 <code>nextUpdate</code> field is in the future.</p>
2438 </directivesynopsis>
2441 <name>SSLStaplingStandardCacheTimeout</name>
2442 <description>Number of seconds before expiring responses in the OCSP stapling cache</description>
2443 <syntax>SSLStaplingStandardCacheTimeout <em>seconds</em></syntax>
2444 <default>SSLStaplingStandardCacheTimeout 3600</default>
2445 <contextlist><context>server config</context>
2446 <context>virtual host</context></contextlist>
2447 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2450 <p>Sets the timeout in seconds before responses in the OCSP stapling cache
2451 (configured through <directive module="mod_ssl">SSLStaplingCache</directive>)
2452 will expire. This directive applies to <em>valid</em> responses, while
2453 <directive module="mod_ssl">SSLStaplingErrorCacheTimeout</directive> is
2454 used for controlling the timeout for invalid/unavailable responses.
2457 </directivesynopsis>
2460 <name>SSLStaplingReturnResponderErrors</name>
2461 <description>Pass stapling related OCSP errors on to client</description>
2462 <syntax>SSLStaplingReturnResponderErrors on|off</syntax>
2463 <default>SSLStaplingReturnResponderErrors on</default>
2464 <contextlist><context>server config</context>
2465 <context>virtual host</context></contextlist>
2466 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2469 <p>When enabled, mod_ssl will pass responses from unsuccessful
2470 stapling related OCSP queries (such as status errors, expired responses etc.)
2471 on to the client. If set to <code>off</code>, no stapled responses
2472 for failed queries will be included in the TLS handshake.</p>
2474 </directivesynopsis>
2477 <name>SSLStaplingFakeTryLater</name>
2478 <description>Synthesize "tryLater" responses for failed OCSP stapling queries</description>
2479 <syntax>SSLStaplingFakeTryLater on|off</syntax>
2480 <default>SSLStaplingFakeTryLater on</default>
2481 <contextlist><context>server config</context>
2482 <context>virtual host</context></contextlist>
2483 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2486 <p>When enabled and a query to an OCSP responder for stapling
2487 purposes fails, mod_ssl will synthesize a "tryLater" response for the
2488 client. Only effective if <directive
2489 module="mod_ssl">SSLStaplingReturnResponderErrors</directive>
2490 is also enabled.</p>
2492 </directivesynopsis>
2495 <name>SSLStaplingErrorCacheTimeout</name>
2496 <description>Number of seconds before expiring invalid responses in the OCSP stapling cache</description>
2497 <syntax>SSLStaplingErrorCacheTimeout <em>seconds</em></syntax>
2498 <default>SSLStaplingErrorCacheTimeout 600</default>
2499 <contextlist><context>server config</context>
2500 <context>virtual host</context></contextlist>
2501 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2504 <p>Sets the timeout in seconds before <em>invalid</em> responses
2505 in the OCSP stapling cache (configured through <directive
2506 module="mod_ssl">SSLStaplingCache</directive>) will expire.
2507 To set the cache timeout for valid responses, see
2508 <directive module="mod_ssl">SSLStaplingStandardCacheTimeout</directive>.</p>
2510 </directivesynopsis>
2513 <name>SSLStaplingForceURL</name>
2514 <description>Override the OCSP responder URI specified in the certificate's AIA extension</description>
2515 <syntax>SSLStaplingForceURL <em>uri</em></syntax>
2516 <contextlist><context>server config</context>
2517 <context>virtual host</context></contextlist>
2518 <compatibility>Available in httpd 2.3.3 and later, if using OpenSSL 0.9.8h or later</compatibility>
2521 <p>This directive overrides the URI of an OCSP responder as obtained from
2522 the authorityInfoAccess (AIA) extension of the certificate.
2523 Of potential use when going through a proxy for retrieving OCSP queries.</p>
2525 </directivesynopsis>
2528 <name>SSLSessionTicketKeyFile</name>
2529 <description>Persistent encryption/decryption key for TLS session tickets</description>
2530 <syntax>SSLSessionTicketKeyFile <em>file-path</em></syntax>
2531 <contextlist><context>server config</context>
2532 <context>virtual host</context></contextlist>
2533 <compatibility>Available in httpd 2.4.0 and later, if using OpenSSL 0.9.8h or later</compatibility>
2536 <p>Optionally configures a secret key for encrypting and decrypting
2537 TLS session tickets, as defined in
2538 <a href="http://www.ietf.org/rfc/rfc5077.txt">RFC 5077</a>.
2539 Primarily suitable for clustered environments where TLS sessions information
2540 should be shared between multiple nodes. For single-instance httpd setups,
2541 it is recommended to <em>not</em> configure a ticket key file, but to
2542 rely on (random) keys generated by mod_ssl at startup, instead.</p>
2543 <p>The ticket key file must contain 48 bytes of random data,
2544 preferrably created from a high-entropy source. On a Unix-based system,
2545 a ticket key file can be created as follows:</p>
2548 dd if=/dev/random of=/path/to/file.tkey bs=1 count=48
2551 <p>Ticket keys should be rotated (replaced) on a frequent basis,
2552 as this is the only way to invalidate an existing session ticket -
2553 OpenSSL currently doesn't allow to specify a limit for ticket lifetimes.</p>
2555 <note type="warning">
2556 <p>The ticket key file contains sensitive keying material and should
2557 be protected with file permissions similar to those used for
2558 <directive module="mod_ssl">SSLCertificateKeyFile</directive>.</p>
2561 </directivesynopsis>
2564 <name>SSLCompression</name>
2565 <description>Enable compression on the SSL level</description>
2566 <syntax>SSLCompression on|off</syntax>
2567 <default>SSLCompression off</default>
2568 <contextlist><context>server config</context>
2569 <context>virtual host</context></contextlist>
2570 <compatibility>Available in httpd 2.4.3 and later, if using OpenSSL 0.9.8 or later;
2571 virtual host scope available if using OpenSSL 1.0.0 or later.
2572 The default used to be <code>on</code> in version 2.4.3.</compatibility>
2575 <p>This directive allows to enable compression on the SSL level.</p>
2576 <note type="warning">
2577 <p>Enabling compression causes security issues in most setups (the so called
2581 </directivesynopsis>
2584 <name>SSLOpenSSLConfCmd</name>
2585 <description>Configure OpenSSL parameters through its <em>SSL_CONF</em> API</description>
2586 <syntax>SSLOpenSSLConfCmd <em>command-name</em> <em>command-value</em></syntax>
2587 <contextlist><context>server config</context>
2588 <context>virtual host</context></contextlist>
2589 <compatibility>Available in httpd 2.5.0-dev and later, if using OpenSSL 1.0.2 or later</compatibility>
2592 <p>This directive exposes OpenSSL's <em>SSL_CONF</em> API to mod_ssl,
2593 allowing a flexible configuration of OpenSSL parameters without the need
2594 of implementing additional <module>mod_ssl</module> directives when new
2595 features are added to OpenSSL.</p>
2597 <p>The set of available <directive>SSLOpenSSLConfCmd</directive> commands
2598 depends on the OpenSSL version being used for <module>mod_ssl</module>
2599 (at least version 1.0.2 is required). For a list of supported command
2600 names, see the section <em>Supported configuration file commands</em> in the
2601 <a href="http://www.openssl.org/docs/ssl/SSL_CONF_cmd.html#SUPPORTED_CONFIGURATION_FILE_COM">SSL_CONF_cmd(3)</a> manual page for OpenSSL.</p>
2603 <p>Some of the <directive>SSLOpenSSLConfCmd</directive> commands can be used
2604 as an alternative to existing directives (such as
2605 <directive module="mod_ssl">SSLCipherSuite</directive> or
2606 <directive module="mod_ssl">SSLProtocol</directive>),
2607 though it should be noted that the syntax / allowable values for the parameters
2608 may sometimes differ.</p>
2610 <example><title>Examples</title>
2611 <highlight language="config">
2612 SSLOpenSSLConfCmd Options -SessionTicket,ServerPreference
2613 SSLOpenSSLConfCmd ECDHParameters brainpoolP256r1
2614 SSLOpenSSLConfCmd ServerInfoFile /usr/local/apache2/conf/server-info.pem
2615 SSLOpenSSLConfCmd Protocol "-ALL, TLSv1.2"
2616 SSLOpenSSLConfCmd SignatureAlgorithms RSA+SHA384:ECDSA+SHA256
2620 </directivesynopsis>