mod_ssl.xml revision c33dbf8773dd8ae2d89a7a5bd97df00fd582e008
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd<!-- $LastChangedRevision$ -->
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding Licensed to the Apache Software Foundation (ASF) under one or more
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding contributor license agreements. See the NOTICE file distributed with
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding this work for additional information regarding copyright ownership.
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding The ASF licenses this file to You under the Apache License, Version 2.0
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding (the "License"); you may not use this file except in compliance with
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding the License. You may obtain a copy of the License at
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd Unless required by applicable law or agreed to in writing, software
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd distributed under the License is distributed on an "AS IS" BASIS,
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd See the License for the specific language governing permissions and
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd limitations under the License.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Strong cryptography using the Secure Sockets
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveLayer (SSL) and Transport Layer Security (TLS) protocols</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>This module provides SSL v2/v3 and TLS v1 support for the Apache
b76a31daaa6e83bb0fd627a04f20e82bffcf1df4poirierHTTP Server. It was contributed by Ralf S. Engeschall based on his
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemod_ssl project and originally derived from work by Ben Laurie.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>This module relies on <a href="http://www.openssl.org/">OpenSSL</a>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveto provide the cryptography engine.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>Further details, discussion, and examples are provided in the
53bae66d3dc14a667e14a451f7bc65a893dd450fnd<section id="envvars"><title>Environment Variables</title>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>This module provides a lot of SSL information as additional environment
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivevariables to the SSI and CGI namespace. The generated variables are listed in
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivethe table below. For backward compatibility the information can
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivebe made available under different names, too. Look in the <a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivehref="/ssl/ssl_compat.html">Compatibility</a> chapter for details on the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecompatibility variables.</p>
1597043cec6ad37fa4154bf09b0fccdabed1a239slive<columnspec><column width=".3"/><column width=".2"/><column width=".5"/>
1597043cec6ad37fa4154bf09b0fccdabed1a239slive</columnspec>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>HTTPS</code></td> <td>flag</td> <td>HTTPS is being used.</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_PROTOCOL</code></td> <td>string</td> <td>The SSL protocol version (SSLv2, SSLv3, TLSv1)</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SESSION_ID</code></td> <td>string</td> <td>The hex-encoded SSL session id</td></tr>
98b409eae9ad8033008f8589b5c7c02ed49db767sctemme<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>
f7489468254ddf807594db3dfb994035f0ec1c7djorton<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CIPHER</code></td> <td>string</td> <td>The cipher specification name</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CIPHER_EXPORT</code></td> <td>string</td> <td><code>true</code> if cipher is an export cipher</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CIPHER_USEKEYSIZE</code></td> <td>number</td> <td>Number of cipher bits (actually used)</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CIPHER_ALGKEYSIZE</code></td> <td>number</td> <td>Number of cipher bits (possible)</td></tr>
08ff7ca3674b179f36b9e0798ae2a9bdbb72c437wrowe<tr><td><code>SSL_COMPRESS_METHOD</code></td> <td>string</td> <td>SSL compression method negotiated</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_VERSION_INTERFACE</code></td> <td>string</td> <td>The mod_ssl program version</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_VERSION_LIBRARY</code></td> <td>string</td> <td>The OpenSSL program version</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_M_VERSION</code></td> <td>string</td> <td>The version of the client certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_M_SERIAL</code></td> <td>string</td> <td>The serial of the client certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_S_DN</code></td> <td>string</td> <td>Subject DN in client's certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_S_DN_</code><em>x509</em></td> <td>string</td> <td>Component of client's Subject DN</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_I_DN</code></td> <td>string</td> <td>Issuer DN of client's certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_I_DN_</code><em>x509</em></td> <td>string</td> <td>Component of client's Issuer DN</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_V_START</code></td> <td>string</td> <td>Validity of client's certificate (start time)</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_V_END</code></td> <td>string</td> <td>Validity of client's certificate (end time)</td></tr>
8514af9d926a1c330756d11eb71acfcf6e8e56bdjorton<tr><td><code>SSL_CLIENT_V_REMAIN</code></td> <td>string</td> <td>Number of days until client's certificate expires</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_A_SIG</code></td> <td>string</td> <td>Algorithm used for the signature of client's certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_CLIENT_CERT</code></td> <td>string</td> <td>PEM-encoded client certificate</td></tr>
256c9fec76025218e564ad19e100d4a38da10f42jorton<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_M_VERSION</code></td> <td>string</td> <td>The version of the server certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_M_SERIAL</code></td> <td>string</td> <td>The serial of the server certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_S_DN</code></td> <td>string</td> <td>Subject DN in server's certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_S_DN_</code><em>x509</em></td> <td>string</td> <td>Component of server's Subject DN</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_I_DN</code></td> <td>string</td> <td>Issuer DN of server's certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_I_DN_</code><em>x509</em></td> <td>string</td> <td>Component of server's Issuer DN</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_V_START</code></td> <td>string</td> <td>Validity of server's certificate (start time)</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_V_END</code></td> <td>string</td> <td>Validity of server's certificate (end time)</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_A_SIG</code></td> <td>string</td> <td>Algorithm used for the signature of server's certificate</td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>SSL_SERVER_CERT</code></td> <td>string</td> <td>PEM-encoded server certificate</td></tr>
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jorton<p><em>x509</em> specifies a component of an X.509 DN; one of
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jorton<code>C,ST,L,O,OU,CN,T,I,G,S,D,UID,Email</code>. In Apache 2.1 and
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jortonlater, <em>x509</em> may also include a numeric <code>_n</code>
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jortonsuffix. If the DN in question contains multiple attributes of the
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jortonsame name, this suffix is used as an index to select a particular
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jortonattribute. For example, where the server certificate subject DN
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jortonincluded two OU fields, <code>SSL_SERVER_S_DN_OU_0</code> and
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jorton<code>SSL_SERVER_S_DN_OU_1</code> could be used to reference each.</p>
8514af9d926a1c330756d11eb71acfcf6e8e56bdjorton<p><code>SSL_CLIENT_V_REMAIN</code> is only available in version 2.1
8514af9d926a1c330756d11eb71acfcf6e8e56bdjortonand later.</p>
f7ac17a355153b91b25db5d526afd752465aa489jorton<section id="logformats"><title>Custom Log Formats</title>
f7ac17a355153b91b25db5d526afd752465aa489jorton<p>When <module>mod_ssl</module> is built into Apache or at least
f7ac17a355153b91b25db5d526afd752465aa489jortonloaded (under DSO situation) additional functions exist for the <a
f7ac17a355153b91b25db5d526afd752465aa489jortonhref="mod_log_config.html#formats">Custom Log Format</a> of
f7ac17a355153b91b25db5d526afd752465aa489jortonadditional ``<code>%{</code><em>varname</em><code>}x</code>''
f7ac17a355153b91b25db5d526afd752465aa489jortoneXtension format function which can be used to expand any variables
f7ac17a355153b91b25db5d526afd752465aa489jortonprovided by any module, especially those provided by mod_ssl which can
f7ac17a355153b91b25db5d526afd752465aa489jortonyou find in the above table.</p>
f7ac17a355153b91b25db5d526afd752465aa489jortonFor backward compatibility there is additionally a special
f7ac17a355153b91b25db5d526afd752465aa489jorton``<code>%{</code><em>name</em><code>}c</code>'' cryptography format function
f7ac17a355153b91b25db5d526afd752465aa489jortonprovided. Information about this function is provided in the <a
f7ac17a355153b91b25db5d526afd752465aa489jortonhref="/ssl/ssl_compat.html">Compatibility</a> chapter.</p>
f7ac17a355153b91b25db5d526afd752465aa489jorton "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
f7ac17a355153b91b25db5d526afd752465aa489jorton<p><module>mod_ssl</module> sets "notes" for the request which can be
f7ac17a355153b91b25db5d526afd752465aa489jortonused in logging with the <code>%{<em>name</em>}n</code> format
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <dd>This note is set to the value <code>1</code> if access was
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <dd>If <module>mod_ssl</module> is built against a version of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive OpenSSL which supports the secure renegotiation extension, this note
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive is set to the value <code>1</code> if SSL is in used for the current
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive connection, and the client also supports the secure renegotiation
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive extension. If the client does not support the secure renegotiation
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive extension, the note is set to the value <code>0</code>.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive If <module>mod_ssl</module> is not built against a version of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive OpenSSL which supports secure renegotiation, or if SSL is not in use
4cd185b8f43b3014d0ef735b16c733844956c665jorton for the current connection, the note is not set.</dd>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton<description>Type of pass phrase dialog for encrypted private
2ff3ef24f2af86bdafd2b4ca698091048e066b28jortonkeys</description>
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton<contextlist><context>server config</context></contextlist>
2ff3ef24f2af86bdafd2b4ca698091048e066b28jortonWhen Apache starts up it has to read the various Certificate (see
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton<directive module="mod_ssl">SSLCertificateFile</directive>) and
2ff3ef24f2af86bdafd2b4ca698091048e066b28jortonPrivate Key (see <directive
2ff3ef24f2af86bdafd2b4ca698091048e066b28jortonmodule="mod_ssl">SSLCertificateKeyFile</directive>) files of the
2ff3ef24f2af86bdafd2b4ca698091048e066b28jortonSSL-enabled virtual servers. Because for security reasons the Private
2ff3ef24f2af86bdafd2b4ca698091048e066b28jortonKey files are usually encrypted, mod_ssl needs to query the
2ff3ef24f2af86bdafd2b4ca698091048e066b28jortonadministrator for a Pass Phrase in order to decrypt those files. This
2ff3ef24f2af86bdafd2b4ca698091048e066b28jortonquery can be done in two ways which can be configured by
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton This is the default where an interactive terminal dialog occurs at startup
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton time just before Apache detaches from the terminal. Here the administrator
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton has to manually enter the Pass Phrase for each encrypted Private Key file.
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton Because a lot of SSL-enabled virtual hosts can be configured, the
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton following reuse-scheme is used to minimize the dialog: When a Private Key
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton file is encrypted, all known Pass Phrases (at the beginning there are
2ff3ef24f2af86bdafd2b4ca698091048e066b28jorton none, of course) are tried. If one of those known Pass Phrases succeeds no
eac658ceff08fb117e2484d8e16a38c775840b3fsf dialog pops up for this particular Private Key file. If none succeeded,
eac658ceff08fb117e2484d8e16a38c775840b3fsf another Pass Phrase is queried on the terminal and remembered for the next
eac658ceff08fb117e2484d8e16a38c775840b3fsf round (where it perhaps can be reused).</p>
eac658ceff08fb117e2484d8e16a38c775840b3fsf This scheme allows mod_ssl to be maximally flexible (because for N encrypted
eac658ceff08fb117e2484d8e16a38c775840b3fsf Private Key files you <em>can</em> use N different Pass Phrases - but then
eac658ceff08fb117e2484d8e16a38c775840b3fsf you have to enter all of them, of course) while minimizing the terminal
eac658ceff08fb117e2484d8e16a38c775840b3fsf dialog (i.e. when you use a single Pass Phrase for all N Private Key files
eac658ceff08fb117e2484d8e16a38c775840b3fsf <p>This mode allows an external program to be used which acts as a
eac658ceff08fb117e2484d8e16a38c775840b3fsf pipe to a particular input device; the program is sent the standard
eac658ceff08fb117e2484d8e16a38c775840b3fsf <code>stdin</code>, and is expected to write password strings on
eac658ceff08fb117e2484d8e16a38c775840b3fsf <code>stdout</code>. If several passwords are needed (or an
eac658ceff08fb117e2484d8e16a38c775840b3fsf incorrect password is entered), additional prompt text will be
eac658ceff08fb117e2484d8e16a38c775840b3fsf written subsequent to the first password being returned, and more
eac658ceff08fb117e2484d8e16a38c775840b3fsf Here an external program is configured which is called at startup for each
eac658ceff08fb117e2484d8e16a38c775840b3fsf encrypted Private Key file. It is called with two arguments (the first is
eac658ceff08fb117e2484d8e16a38c775840b3fsf of the form ``<code>servername:portnumber</code>'', the second is either
eac658ceff08fb117e2484d8e16a38c775840b3fsf ``<code>RSA</code>'' or ``<code>DSA</code>''), which indicate for which
eac658ceff08fb117e2484d8e16a38c775840b3fsf server and algorithm it has to print the corresponding Pass Phrase to
eac658ceff08fb117e2484d8e16a38c775840b3fsf <code>stdout</code>. The intent is that this external program first runs
eac658ceff08fb117e2484d8e16a38c775840b3fsf security checks to make sure that the system is not compromised by an
eac658ceff08fb117e2484d8e16a38c775840b3fsf attacker, and only when these checks were passed successfully it provides
eac658ceff08fb117e2484d8e16a38c775840b3fsf the Pass Phrase.</p>
eac658ceff08fb117e2484d8e16a38c775840b3fsf Both these security checks, and the way the Pass Phrase is determined, can
eac658ceff08fb117e2484d8e16a38c775840b3fsf be as complex as you like. Mod_ssl just defines the interface: an
eac658ceff08fb117e2484d8e16a38c775840b3fsf executable program which provides the Pass Phrase on <code>stdout</code>.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive Nothing more or less! So, if you're really paranoid about security, here
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive is your interface. Anything else has to be left as an exercise to the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive administrator, because local security requirements are so different.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive The reuse-algorithm above is used here, too. In other words: The external
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive program is called only once per unique Pass Phrase.</p></li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLPassPhraseDialog exec:/usr/local/apache/sbin/pp-filter
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Pseudo Random Number Generator (PRNG) seeding
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivesource</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<contextlist><context>server config</context></contextlist>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis configures one or more sources for seeding the Pseudo Random Number
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveGenerator (PRNG) in OpenSSL at startup time (<em>context</em> is
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<code>startup</code>) and/or just before a new SSL connection is established
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive(<em>context</em> is <code>connect</code>). This directive can only be used
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivein the global server context because the PRNG is a global facility.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThe following <em>source</em> variants are available:</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <p> This is the always available builtin seeding source. It's usage
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive consumes minimum CPU cycles under runtime and hence can be always used
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive without drawbacks. The source used for seeding the PRNG contains of the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive current time, the current process id and (when applicable) a randomly
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive choosen 1KB extract of the inter-process scoreboard structure of Apache.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive The drawback is that this is not really a strong source and at startup
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive time (where the scoreboard is still not available) this source just
c668ba618761ec81a1ee079106036454e8a88c96jorton produces a few bytes of entropy. So you should always, at least for the
c668ba618761ec81a1ee079106036454e8a88c96jorton This variant uses an external file <code>/path/to/source</code> as the
c668ba618761ec81a1ee079106036454e8a88c96jorton source for seeding the PRNG. When <em>bytes</em> is specified, only the
c668ba618761ec81a1ee079106036454e8a88c96jorton first <em>bytes</em> number of bytes of the file form the entropy (and
c668ba618761ec81a1ee079106036454e8a88c96jorton <em>bytes</em> is given to <code>/path/to/source</code> as the first
c668ba618761ec81a1ee079106036454e8a88c96jorton argument). When <em>bytes</em> is not specified the whole file forms the
c668ba618761ec81a1ee079106036454e8a88c96jorton entropy (and <code>0</code> is given to <code>/path/to/source</code> as
c668ba618761ec81a1ee079106036454e8a88c96jorton the first argument). Use this especially at startup time, for instance
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>/dev/urandom</code> devices (which usually exist on modern Unix
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive derivates like FreeBSD and Linux).</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <em>But be careful</em>: Usually <code>/dev/random</code> provides only as
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive much entropy data as it actually has, i.e. when you request 512 bytes of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive entropy, but the device currently has only 100 bytes available two things
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive can happen: On some platforms you receive only the 100 bytes while on
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive other platforms the read blocks until enough bytes are available (which
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive can take a long time). Here using an existing <code>/dev/urandom</code> is
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive better, because it never blocks and actually gives the amount of requested
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive data. The drawback is just that the quality of the received data may not
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive be the best.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive On some platforms like FreeBSD one can even control how the entropy is
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive actually generated, i.e. by which system interrupts. More details one can
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive find under <em>rndcontrol(8)</em> on those platforms. Alternatively, when
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive your system lacks such a random device, you can use tool
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive like <a href="http://www.lothar.com/tech/crypto/">EGD</a>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive (Entropy Gathering Daemon) and run it's client program with the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>exec:/path/to/program/</code> variant (see below) or use
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>egd:/path/to/egd-socket</code> (see below).</p></li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive This variant uses an external executable
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>/path/to/program</code> as the source for seeding the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive PRNG. When <em>bytes</em> is specified, only the first
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <em>bytes</em> number of bytes of its <code>stdout</code> contents
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive form the entropy. When <em>bytes</em> is not specified, the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive entirety of the data produced on <code>stdout</code> form the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive entropy. Use this only at startup time when you need a very strong
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive seeding with the help of an external program (for instance as in
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive the example above with the <code>truerand</code> utility you can
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive find in the mod_ssl distribution which is based on the AT&T
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <em>truerand</em> library). Using this in the connection context
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive slows down the server too dramatically, of course. So usually you
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive should avoid using external programs in that context.</p></li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive This variant uses the Unix domain socket of the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive external Entropy Gathering Daemon (EGD) (see <a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive href="http://www.lothar.com/tech/crypto/">http://www.lothar.com/tech
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive /crypto/</a>) to seed the PRNG. Use this if no random device exists
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLRandomSeed startup builtin<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLRandomSeed startup exec:/usr/local/bin/truerand 16<br />
b76a31daaa6e83bb0fd627a04f20e82bffcf1df4poirierSSLRandomSeed connect builtin<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Type of the global/inter-process SSL Session
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveCache</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<contextlist><context>server config</context></contextlist>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis configures the storage type of the global/inter-process SSL Session
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveCache. This cache is an optional facility which speeds up parallel request
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveprocessing. For requests to the same server process (via HTTP keep-alive),
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveOpenSSL already caches the SSL session information locally. But because modern
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveclients request inlined images and other data via parallel requests (usually
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveup to four parallel requests are common) those requests are served by
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<em>different</em> pre-forked server processes. Here an inter-process cache
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivehelps to avoid unneccessary session handshakes.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThe following four storage <em>type</em>s are currently supported:</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <p>This disables the global/inter-process Session Cache. This
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive will incur a noticeable speed penalty and may cause problems if
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive using certain browsers, particularly if client certificates are
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <p>This disables any global/inter-process Session Cache. However
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive it does force OpenSSL to send a non-null session ID to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <p>This makes use of a DBM hashfile on the local disk to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive synchronize the local OpenSSL memory caches of the server
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive processes. This session cache may suffer reliability issues under
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<li><code>shm:/path/to/datafile</code>[<code>(</code><em>size</em><code>)</code>]
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <p>This makes use of a high-performance cyclic buffer
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive (approx. <em>size</em> bytes in size) inside a shared memory
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive segment in RAM (established via <code>/path/to/datafile</code>) to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive synchronize the local OpenSSL memory caches of the server
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive processes. This is the recommended session cache.</p></li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive href="http://www.distcache.org/">distcache</a> distributed session
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive caching libraries. The argument should specify the location of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive the server or proxy to be used using the distcache address syntax;
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive for example, <code>UNIX:/path/to/socket</code> specifies a UNIX
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive domain socket (typically a local dc_client proxy);
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>IP:server.example.com:9001</code> specifies an IP
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLSessionCache shm:/usr/local/apache/logs/ssl_gcache_data(512000)
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>The <code>ssl-cache</code> mutex is used to serialize access to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivethe session cache to prevent corruption. This mutex can be configured
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveusing the <directive module="core">Mutex</directive> directive.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Number of seconds before an SSL session expires
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivein the Session Cache</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<syntax>SSLSessionCacheTimeout <em>seconds</em></syntax>
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djortonThis directive sets the timeout in seconds for the information stored in the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveglobal/inter-process SSL Session Cache and the OpenSSL internal memory cache.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveIt can be set as low as 15 for testing, but should be set to higher
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djortonvalues like 300 in real life.</p>
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djortonSSLSessionCacheTimeout 600
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djorton</directivesynopsis>
75394345f1e542f71a0a37c7755070543124af7ejim<directivesynopsis>
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djortonThis directive toggles the usage of the SSL/TLS Protocol Engine. This
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivetype="section">VirtualHost</directive> section to enable SSL/TLS for a
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djortonparticular virtual host. By default the SSL/TLS Protocol Engine is
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djortondisabled for both the main server and all configured virtual hosts.</p>
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djorton<VirtualHost _default_:443><br />
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djortonSSLEngine on<br />
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djorton</VirtualHost>
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djorton<p>In Apache 2.1 and later, <directive>SSLEngine</directive> can be set to
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djorton<a href="http://www.ietf.org/rfc/rfc2817.txt">RFC 2817</a>, Upgrading to TLS
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djortonWithin HTTP/1.1. At this time no web browsers support RFC 2817.</p>
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djorton</directivesynopsis>
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djorton<directivesynopsis>
31b36a43da79a1f7fe303f0eb9b7c7bb1677a70djorton<description>Configure usable SSL protocol versions</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<syntax>SSLProtocol [+|-]<em>protocol</em> ...</syntax>
180b8666f2271cf300f22560ed3d78b30982c097trawickThis directive can be used to control which versions of the SSL protocol
180b8666f2271cf300f22560ed3d78b30982c097trawickwill be accepted in new connections.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThe available (case-insensitive) <em>protocol</em>s are:</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive This is the Secure Sockets Layer (SSL) protocol, version 2.0. It is the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive original SSL protocol as designed by Netscape Corporation. Though it's
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive use has been deprecated, because of weaknesses in the security of the protocol.</p></li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive This is the Secure Sockets Layer (SSL) protocol, version 3.0, from
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive the Netscape Corporation.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive It is the successor to SSLv2 and the predecessor to TLSv1. It's supported by
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive This is the Transport Layer Security (TLS) protocol, version 1.0. It is the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive successor to SSLv3 and is defined in <a href="http://www.ietf.org/rfc/rfc2246.txt">RFC2246</a>.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive Which has been obsoleted by <a href="http://www.ietf.org/rfc/rfc4346.txt">RFC4346</a>.</p></li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive This is a shortcut for ``<code>+SSLv2 +SSLv3 +TLSv1</code>'' and a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive convenient way for enabling all protocols except one when used in
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive combination with the minus sign on a protocol as the example above
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive# enable SSLv3 and TLSv1, but not SSLv2<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLProtocol all -SSLv2
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
1428f44b421e1c9ee0721b4b709dd10064758c40rbowen<directivesynopsis>
1428f44b421e1c9ee0721b4b709dd10064758c40rbowen<description>Cipher Suite available for negotiation in SSL
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivehandshake</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<default>SSLCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</default>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis complex directive uses a colon-separated <em>cipher-spec</em> string
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveconsisting of OpenSSL cipher specifications to configure the Cipher Suite the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveclient is permitted to negotiate in the SSL handshake phase. Notice that this
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowedirective can be used both in per-server and per-directory context. In
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wroweper-server context it applies to the standard SSL handshake when a connection
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wroweis established. In per-directory context it forces a SSL renegotation with the
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowereconfigured Cipher Suite after the HTTP request was read but before the HTTP
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wroweresponse is sent.</p>
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wroweAn SSL cipher specification in <em>cipher-spec</em> is composed of 4 major
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wroweattributes plus a few extra minor ones:</p>
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowe RSA or Diffie-Hellman variants.
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowe RSA, Diffie-Hellman, DSS or none.
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowe DES, Triple-DES, RC4, RC2, IDEA or none.
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowe MD5, SHA or SHA1.
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowe<p>An SSL cipher can also be an export cipher and is either a SSLv2 or SSLv3/TLSv1
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowecipher (here TLSv1 is equivalent to SSLv3). To specify which ciphers to use,
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wroweone can either specify all the Ciphers, one at a time, or use aliases to
e9eabac76b50e8f00d0c391f6070d0f42db77aa2wrowespecify the preference and order for the ciphers (see <a href="#table1">Table
610981f18632eeb2fbefd7d59681ebdfcba806fbjorton<columnspec><column width=".5"/><column width=".5"/></columnspec>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><th><a name="table1">Tag</a></th> <th>Description</th></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td colspan="2"><em>Key Exchange Algorithm:</em></td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>kRSA</code></td> <td>RSA key exchange</td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>kDHr</code></td> <td>Diffie-Hellman key exchange with RSA key</td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>kDHd</code></td> <td>Diffie-Hellman key exchange with DSA key</td></tr>
610981f18632eeb2fbefd7d59681ebdfcba806fbjorton<tr><td><code>kEDH</code></td> <td>Ephemeral (temp.key) Diffie-Hellman key exchange (no cert)</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td colspan="2"><em>Authentication Algorithm:</em></td></tr>
610981f18632eeb2fbefd7d59681ebdfcba806fbjorton<tr><td><code>aNULL</code></td> <td>No authentication</td></tr>
610981f18632eeb2fbefd7d59681ebdfcba806fbjorton<tr><td><code>aRSA</code></td> <td>RSA authentication</td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>aDSS</code></td> <td>DSS authentication</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>aDH</code></td> <td>Diffie-Hellman authentication</td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td colspan="2"><em>Cipher Encoding Algorithm:</em></td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>eNULL</code></td> <td>No encoding</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>DES</code></td> <td>DES encoding</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>3DES</code></td> <td>Triple-DES encoding</td> </tr>
a654b81078edd96412866655d47033a355152c2cpctony<tr><td><code>RC4</code></td> <td>RC4 encoding</td> </tr>
a654b81078edd96412866655d47033a355152c2cpctony<tr><td><code>RC2</code></td> <td>RC2 encoding</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>IDEA</code></td> <td>IDEA encoding</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td colspan="2"><em>MAC Digest Algorithm</em>:</td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>MD5</code></td> <td>MD5 hash function</td></tr>
38283aab65389dd92a565cc907fa620b309ea26blgentis<tr><td><code>SHA1</code></td> <td>SHA1 hash function</td></tr>
38283aab65389dd92a565cc907fa620b309ea26blgentis<tr><td><code>SHA</code></td> <td>SHA hash function</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>SSLv2</code></td> <td>all SSL version 2.0 ciphers</td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>SSLv3</code></td> <td>all SSL version 3.0 ciphers</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>TLSv1</code></td> <td>all TLS version 1.0 ciphers</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>EXP</code></td> <td>all export ciphers</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>EXPORT40</code></td> <td>all 40-bit export ciphers only</td> </tr>
a654b81078edd96412866655d47033a355152c2cpctony<tr><td><code>EXPORT56</code></td> <td>all 56-bit export ciphers only</td> </tr>
a654b81078edd96412866655d47033a355152c2cpctony<tr><td><code>LOW</code></td> <td>all low strength ciphers (no export, single DES)</td></tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>MEDIUM</code></td> <td>all ciphers with 128 bit encryption</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>HIGH</code></td> <td>all ciphers using Triple-DES</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>RSA</code></td> <td>all ciphers using RSA key exchange</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>DH</code></td> <td>all ciphers using Diffie-Hellman key exchange</td> </tr>
610981f18632eeb2fbefd7d59681ebdfcba806fbjorton<tr><td><code>EDH</code></td> <td>all ciphers using Ephemeral Diffie-Hellman key exchange</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>ADH</code></td> <td>all ciphers using Anonymous Diffie-Hellman key exchange</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>DSS</code></td> <td>all ciphers using DSS authentication</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>NULL</code></td> <td>all ciphers using no encryption</td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveNow where this becomes interesting is that these can be put together
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveto specify the order and ciphers you wish to use. To speed this up
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivethere are also aliases (<code>SSLv2, SSLv3, TLSv1, EXP, LOW, MEDIUM,
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHIGH</code>) for certain groups of ciphers. These tags can be joined
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivetogether with prefixes to form the <em>cipher-spec</em>. Available
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveprefixes are:</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<li><code>+</code>: add ciphers to list and pull them to current location in list</li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<li><code>-</code>: remove cipher from list (can be added later again)</li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<li><code>!</code>: kill cipher from list completely (can <strong>not</strong> be added later again)</li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>A simpler way to look at all of this is to use the ``<code>openssl ciphers
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive-v</code>'' command which provides a nice way to successively create the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecorrect <em>cipher-spec</em> string. The default <em>cipher-spec</em> string
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveis ``<code>ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</code>'' which
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemeans the following: first, remove from consideration any ciphers that do not
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveauthenticate, i.e. for SSL only the Anonymous Diffie-Hellman ciphers. Next,
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveuse ciphers using RC4 and RSA. Next include the high, medium and then the low
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivesecurity ciphers. Finally <em>pull</em> all SSLv2 and export ciphers to the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveend of the list.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive$ openssl ciphers -v 'ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP'
b76a31daaa6e83bb0fd627a04f20e82bffcf1df4poirierNULL-SHA SSLv3 Kx=RSA Au=RSA Enc=None Mac=SHA1
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveNULL-MD5 SSLv3 Kx=RSA Au=RSA Enc=None Mac=MD5
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveEDH-RSA-DES-CBC3-SHA SSLv3 Kx=DH Au=RSA Enc=3DES(168) Mac=SHA1
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive... ... ... ... ...
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveEXP-RC4-MD5 SSLv3 Kx=RSA(512) Au=RSA Enc=RC4(40) Mac=MD5 export
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveEXP-RC2-CBC-MD5 SSLv2 Kx=RSA(512) Au=RSA Enc=RC2(40) Mac=MD5 export
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveEXP-RC4-MD5 SSLv2 Kx=RSA(512) Au=RSA Enc=RC4(40) Mac=MD5 export
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>The complete list of particular RSA & DH ciphers for SSL is given in <a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLCipherSuite RSA:!EXP:!NULL:+HIGH:+MEDIUM:-LOW
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<columnspec><column width=".3"/><column width=".1"/><column width=".13"/>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<column width=".1"/><column width=".13"/><column width=".1"/>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<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>
b76a31daaa6e83bb0fd627a04f20e82bffcf1df4poirier<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>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>DES-CBC3-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>3DES(168)</td> <td>MD5</td> <td></td> </tr>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<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>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<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>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<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>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<tr><td><code>IDEA-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>IDEA(128)</td> <td>MD5</td> <td></td> </tr>
97a9a944b5887e91042b019776c41d5dd74557aferikabele<tr><td><code>RC2-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC2(128)</td> <td>MD5</td> <td></td> </tr>
1597043cec6ad37fa4154bf09b0fccdabed1a239slive<tr><td><code>RC4-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC4(128)</td> <td>MD5</td> <td></td> </tr>
984276e3760754bae346208618ad01194ddd4e73rbowen<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>RC4-64-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC4(64)</td> <td>MD5</td> <td></td> </tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>DES-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>DES(56)</td> <td>MD5</td> <td></td> </tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>EXP-RC2-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA(512)</td> <td>RSA</td> <td>RC2(40)</td> <td>MD5</td> <td> export</td> </tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td><code>EXP-RC4-MD5</code></td> <td>SSLv2</td> <td>RSA(512)</td> <td>RSA</td> <td>RC4(40)</td> <td>MD5</td> <td> export</td> </tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<tr><td colspan="7"><em>Diffie-Hellman Ciphers:</em></td></tr>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<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>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj</directivesynopsis>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<directivesynopsis>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<description>Server PEM-encoded X.509 Certificate file</description>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<syntax>SSLCertificateFile <em>file-path</em></syntax>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjThis directive points to the PEM-encoded Certificate file for the server and
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjoptionally also to the corresponding RSA or DSA Private Key file for it
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj(contained in the same file). If the contained Private Key is encrypted the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivePass Phrase dialog is forced at startup time. This directive can be used up to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivetwo times (referencing different filenames) when both a RSA and a DSA based
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveserver certificate is used in parallel.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLCertificateFile /usr/local/apache2/conf/ssl.crt/server.crt
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Server PEM-encoded Private Key file</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<syntax>SSLCertificateKeyFile <em>file-path</em></syntax>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis directive points to the PEM-encoded Private Key file for the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveserver. If the Private Key is not combined with the Certificate in the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directive>SSLCertificateFile</directive>, use this additional directive to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivepoint to the file with the stand-alone Private Key. When
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directive>SSLCertificateFile</directive> is used and the file
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecontains both the Certificate and the Private Key this directive need
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivenot be used. But we strongly discourage this practice. Instead we
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliverecommend you to separate the Certificate and the Private Key. If the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecontained Private Key is encrypted, the Pass Phrase dialog is forced
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveat startup time. This directive can be used up to two times
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive(referencing different filenames) when both a RSA and a DSA based
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveprivate key is used in parallel.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLCertificateKeyFile /usr/local/apache2/conf/ssl.key/server.key
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>File of PEM-encoded Server CA Certificates</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<syntax>SSLCertificateChainFile <em>file-path</em></syntax>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjThis directive sets the optional <em>all-in-one</em> file where you can
97a9a944b5887e91042b019776c41d5dd74557aferikabeleassemble the certificates of Certification Authorities (CA) which form the
97a9a944b5887e91042b019776c41d5dd74557aferikabelecertificate chain of the server certificate. This starts with the issuing CA
97a9a944b5887e91042b019776c41d5dd74557aferikabelecertificate of the server certificate and can range up to the root CA
97a9a944b5887e91042b019776c41d5dd74557aferikabelecertificate. Such a file is simply the concatenation of the various
97a9a944b5887e91042b019776c41d5dd74557aferikabelePEM-encoded CA Certificate files, usually in certificate chain order.</p>
97a9a944b5887e91042b019776c41d5dd74557aferikabeleThis should be used alternatively and/or additionally to <directive
97a9a944b5887e91042b019776c41d5dd74557aferikabelemodule="mod_ssl">SSLCACertificatePath</directive> for explicitly
97a9a944b5887e91042b019776c41d5dd74557aferikabeleconstructing the server certificate chain which is sent to the browser
97a9a944b5887e91042b019776c41d5dd74557aferikabelein addition to the server certificate. It is especially useful to
97a9a944b5887e91042b019776c41d5dd74557aferikabeleavoid conflicts with CA certificates when using client
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjauthentication. Because although placing a CA certificate of the
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjserver certificate chain into <directive
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjmodule="mod_ssl">SSLCACertificatePath</directive> has the same effect
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjfor the certificate chain construction, it has the side-effect that
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjclient certificates issued by this same CA certificate are also
97a9a944b5887e91042b019776c41d5dd74557aferikabeleaccepted on client authentication.</p>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikjBut be careful: Providing the certificate chain works only if you are using a
97a9a944b5887e91042b019776c41d5dd74557aferikabele<em>single</em> RSA <em>or</em> DSA based server certificate. If you are
97a9a944b5887e91042b019776c41d5dd74557aferikabeleusing a coupled RSA+DSA certificate pair, this will work only if actually both
97a9a944b5887e91042b019776c41d5dd74557aferikabelecertificates use the <em>same</em> certificate chain. Else the browsers will be
97a9a944b5887e91042b019776c41d5dd74557aferikabeleconfused in this situation.</p>
97a9a944b5887e91042b019776c41d5dd74557aferikabeleSSLCertificateChainFile /usr/local/apache2/conf/ssl.crt/ca.crt
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj</directivesynopsis>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Directory of PEM-encoded CA Certificates for
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveClient Auth</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<syntax>SSLCACertificatePath <em>directory-path</em></syntax>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis directive sets the directory where you keep the Certificates of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveCertification Authorities (CAs) whose clients you deal with. These are used to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveverify the client certificate on Client Authentication.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThe files in this directory have to be PEM-encoded and are accessed through
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivehash filenames. So usually you can't just place the Certificate files
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivethere: you also have to create symbolic links named
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<em>hash-value</em><code>.N</code>. And you should always make sure this directory
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecontains the appropriate symbolic links. Use the <code>Makefile</code> which
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecomes with mod_ssl to accomplish this task.</p>
e22983c2cda01e5df1a8a6b72c2ff687370975aaerikabeleSSLCACertificatePath /usr/local/apache2/conf/ssl.crt/
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>File of concatenated PEM-encoded CA Certificates
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivefor Client Auth</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<syntax>SSLCACertificateFile <em>file-path</em></syntax>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis directive sets the <em>all-in-one</em> file where you can assemble the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveCertificates of Certification Authorities (CA) whose <em>clients</em> you deal
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivewith. These are used for Client Authentication. Such a file is simply the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveconcatenation of the various PEM-encoded Certificate files, in order of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivepreference. This can be used alternatively and/or additionally to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directive module="mod_ssl">SSLCACertificatePath</directive>.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-client.crt
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e22983c2cda01e5df1a8a6b72c2ff687370975aaerikabele<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>File of concatenated PEM-encoded CA Certificates
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivefor defining acceptable CA names</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>When a client certificate is requested by mod_ssl, a list of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<em>acceptable Certificate Authority names</em> is sent to the client
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivein the SSL handshake. These CA names can be used by the client to
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveselect an appropriate client certificate out of those it has
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveavailable.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemodule="mod_ssl">SSLCADNRequestPath</directive> or <directive
38283aab65389dd92a565cc907fa620b309ea26blgentismodule="mod_ssl">SSLCADNRequestFile</directive> are given, then the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveset of acceptable CA names sent to the client is the names of all the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveCA certificates given by the <directive
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemodule="mod_ssl">SSLCACertificateFile</directive> and <directive
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemodule="mod_ssl">SSLCACertificatePath</directive> directives; in other
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivewords, the names of the CAs which will actually be used to verify the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveclient certificate.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>In some circumstances, it is useful to be able to send a set of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveacceptable CA names which differs from the actual CAs used to verify
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivethe client certificate - for example, if the client certificates are
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivesigned by intermediate CAs. In such cases, <directive
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemodule="mod_ssl">SSLCADNRequestPath</directive> and/or <directive
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemodule="mod_ssl">SSLCADNRequestFile</directive> can be used; the
60d4e69911c2076d97a593f75947d53173a7a02anoodlacceptable CA names are then taken from the complete set of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecertificates in the directory and/or file specified by this pair of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivedirectives.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p><directive module="mod_ssl">SSLCADNRequestFile</directive> must
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivespecify an <em>all-in-one</em> file containing a concatenation of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivePEM-encoded CA certificates.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLCADNRequestFile /usr/local/apache2/conf/ca-names.crt
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Directory of PEM-encoded CA Certificates for
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivedefining acceptable CA names</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<syntax>SSLCADNRequestPath <em>directory-path</em></syntax>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>This optional directive can be used to specify the set of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<em>acceptable CA names</em> which will be sent to the client when a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveclient certificate is requested. See the <directive
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemodule="mod_ssl">SSLCADNRequestFile</directive> directive for more
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivedetails.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>The files in this directory have to be PEM-encoded and are accessed
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivethrough hash filenames. So usually you can't just place the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveCertificate files there: you also have to create symbolic links named
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<em>hash-value</em><code>.N</code>. And you should always make sure
e22983c2cda01e5df1a8a6b72c2ff687370975aaerikabelethis directory contains the appropriate symbolic links. Use the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<code>Makefile</code> which comes with mod_ssl to accomplish this
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLCADNRequestPath /usr/local/apache2/conf/ca-names.crt/
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Directory of PEM-encoded CA CRLs for
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveClient Auth</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<syntax>SSLCARevocationPath <em>directory-path</em></syntax>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis directive sets the directory where you keep the Certificate Revocation
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveLists (CRL) of Certification Authorities (CAs) whose clients you deal with.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThese are used to revoke the client certificate on Client Authentication.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThe files in this directory have to be PEM-encoded and are accessed through
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivehash filenames. So usually you have not only to place the CRL files there.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveAdditionally you have to create symbolic links named
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<em>hash-value</em><code>.rN</code>. And you should always make sure this directory
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortoncontains the appropriate symbolic links. Use the <code>Makefile</code> which
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortoncomes with <module>mod_ssl</module> to accomplish this task.</p>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton</directivesynopsis>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton<directivesynopsis>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton<description>File of concatenated PEM-encoded CA CRLs for
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonClient Auth</description>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton<syntax>SSLCARevocationFile <em>file-path</em></syntax>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonThis directive sets the <em>all-in-one</em> file where you can
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonassemble the Certificate Revocation Lists (CRL) of Certification
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonAuthorities (CA) whose <em>clients</em> you deal with. These are used
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonfor Client Authentication. Such a file is simply the concatenation of
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonthe various PEM-encoded CRL files, in order of preference. This can be
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonSSLCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-client.crl
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton</directivesynopsis>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton<directivesynopsis>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton<description>Type of Client Certificate verification</description>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonThis directive sets the Certificate verification level for the Client
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonAuthentication. Notice that this directive can be used both in per-server and
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonper-directory context. In per-server context it applies to the client
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonauthentication process used in the standard SSL handshake when a connection is
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonestablished. In per-directory context it forces a SSL renegotation with the
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonreconfigured client verification level after the HTTP request was read but
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonbefore the HTTP response is sent.</p>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonThe following levels are available for <em>level</em>:</p>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton no client Certificate is required at all</li>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton the client <em>may</em> present a valid Certificate</li>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton the client <em>has to</em> present a valid Certificate</li>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton the client may present a valid Certificate<br />
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton but it need not to be (successfully) verifiable.</li>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton<strong>require</strong> are really interesting, because level
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton<strong>optional</strong> doesn't work with all browsers and level
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton<strong>optional_no_ca</strong> is actually against the idea of
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonauthentication (but can be used to establish SSL test pages, etc.)</p>
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jortonSSLVerifyClient require
cb689fbd5d89f1dd470a51fde2a04fa0ad21a440jorton</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Maximum depth of CA Certificates in Client
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveCertificate verification</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis directive sets how deeply mod_ssl should verify before deciding that the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveclients don't have a valid certificate. Notice that this directive can be
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveused both in per-server and per-directory context. In per-server context it
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveapplies to the client authentication process used in the standard SSL
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivehandshake when a connection is established. In per-directory context it forces
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivea SSL renegotation with the reconfigured client verification depth after the
e22983c2cda01e5df1a8a6b72c2ff687370975aaerikabeleHTTP request was read but before the HTTP response is sent.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThe depth actually is the maximum number of intermediate certificate issuers,
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivei.e. the number of CA certificates which are max allowed to be followed while
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveverifying the client certificate. A depth of 0 means that self-signed client
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecertificates are accepted only, the default depth of 1 means the client
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecertificate can be self-signed or has to be signed by a CA which is directly
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveknown to the server (i.e. the CA's certificate is under
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directive module="mod_ssl">SSLCACertificatePath</directive>), etc.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLVerifyDepth 10
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Configure various SSL engine run-time options</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis directive can be used to control various run-time options on a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveper-directory basis. Normally, if multiple <code>SSLOptions</code>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecould apply to a directory, then the most specific one is taken
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecompletely; the options are not merged. However if <em>all</em> the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveoptions on the <code>SSLOptions</code> directive are preceded by a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveplus (<code>+</code>) or minus (<code>-</code>) symbol, the options
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveare merged. Any options preceded by a <code>+</code> are added to the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveoptions currently in force, and any options preceded by a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<code>-</code> are removed from the options currently in force.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive When this option is enabled, the standard set of SSL related CGI/SSI
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive environment variables are created. This per default is disabled for
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive performance reasons, because the information extraction step is a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive rather expensive operation. So one usually enables this option for
b76a31daaa6e83bb0fd627a04f20e82bffcf1df4poirier CGI and SSI requests only.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive When this option is enabled, additional CGI/SSI environment variables are
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive created: <code>SSL_SERVER_CERT</code>, <code>SSL_CLIENT_CERT</code> and
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>SSL_CLIENT_CERT_CHAIN_</code><em>n</em> (with <em>n</em> = 0,1,2,..).
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive These contain the PEM-encoded X.509 Certificates of server and client for
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive the current HTTPS connection and can be used by CGI scripts for deeper
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive Certificate checking. Additionally all other certificates of the client
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive certificate chain are provided, too. This bloats up the environment a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive little bit which is why you have to use this option to enable it on
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive demand.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive When this option is enabled, the Subject Distinguished Name (DN) of the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive Client X509 Certificate is translated into a HTTP Basic Authorization
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive username. This means that the standard Apache authentication methods can
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive be used for access control. The user name is just the Subject of the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive Client's X509 Certificate (can be determined by running OpenSSL's
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>openssl x509</code> command: <code>openssl x509 -noout -subject -in
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive </code><em>certificate</em><code>.crt</code>). Note that no password is
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive obtained from the user. Every entry in the user file needs this password:
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive ``<code>xxj31ZMTZzkVA</code>'', which is the DES-encrypted version of the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive word `<code>password</code>''. Those who live under MD5-based encryption
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive (for instance under FreeBSD or BSD/OS, etc.) should use the following MD5
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive hash of the same word: ``<code>$1$OXLyS...$Owx8s2/m9/gfkcRVXzgoE/</code>''.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive This <em>forces</em> forbidden access when <code>SSLRequireSSL</code> or
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>SSLRequire</code> successfully decided that access should be
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive forbidden. Usually the default is that in the case where a ``<code>Satisfy
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive any</code>'' directive is used, and other access restrictions are passed,
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>SSLRequire</code> is overridden (because that's how the Apache
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code>Satisfy</code> mechanism should work.) But for strict access restriction
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive you can use <code>SSLRequireSSL</code> and/or <code>SSLRequire</code> in
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive combination with an ``<code>SSLOptions +StrictRequire</code>''. Then an
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive additional ``<code>Satisfy Any</code>'' has no chance once mod_ssl has
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive decided to deny access.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive This enables optimized SSL connection renegotiation handling when SSL
b76a31daaa6e83bb0fd627a04f20e82bffcf1df4poirier directives are used in per-directory context. By default a strict
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive scheme is enabled where <em>every</em> per-directory reconfiguration of
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL parameters causes a <em>full</em> SSL renegotiation handshake. When this
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive option is used mod_ssl tries to avoid unnecessary handshakes by doing more
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive granular (but still safe) parameter checks. Nevertheless these granular
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive checks sometimes maybe not what the user expects, so enable this on a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive per-directory basis only, please.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLOptions +FakeBasicAuth -StrictRequire<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<Files ~ "\.(cgi|shtml)$"><br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSLOptions +StdEnvVars -ExportCertData<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<Files>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Deny access when SSL is not used for the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP request</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis directive forbids access unless HTTP over SSL (i.e. HTTPS) is enabled for
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivethe current connection. This is very handy inside the SSL-enabled virtual
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivehost or directories for defending against configuration errors that expose
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivestuff that should be protected. When this directive is present all requests
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveare denied which are not using SSL.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLRequireSSL
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Allow access only when an arbitrarily complex
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveboolean expression is true</description>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThis directive specifies a general access requirement which has to be
256c9fec76025218e564ad19e100d4a38da10f42jortonfulfilled in order to allow access. It is a very powerful directive because the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliverequirement specification is an arbitrarily complex boolean expression
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecontaining any number of access checks.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>The implementation of <code>SSLRequire</code> is not thread safe.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive Using <code>SSLRequire</code> inside <code>.htaccess</code> files
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive on a threaded <a href="/mpm.html">MPM</a> may cause random crashes.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveThe <em>expression</em> must match the following syntax (given as a BNF
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivegrammar notation):</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<blockquote>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveexpr ::= "<strong>true</strong>" | "<strong>false</strong>"
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecomp ::= word "<strong>==</strong>" word | word "<strong>eq</strong>" word
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive | word "<strong>!=</strong>" word | word "<strong>ne</strong>" word
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive | word "<strong><</strong>" word | word "<strong>lt</strong>" word
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive | word "<strong><=</strong>" word | word "<strong>le</strong>" word
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive | word "<strong>></strong>" word | word "<strong>gt</strong>" word
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive | word "<strong>>=</strong>" word | word "<strong>ge</strong>" word
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive | word "<strong>in</strong>" "<strong>{</strong>" wordlist "<strong>}</strong>"
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive | word "<strong>in</strong>" "<strong>PeerExtList(</strong>" word "<strong>)</strong>"
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivewordlist ::= word
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveword ::= digit
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivedigit ::= [0-9]+
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecstring ::= "..."
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivevariable ::= "<strong>%{</strong>" varname "<strong>}</strong>"
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivefunction ::= funcname "<strong>(</strong>" funcargs "<strong>)</strong>"
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</blockquote>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<code>funcname</code> the following functions are available:</p>
a56a8e999892460eea79a9d2d20c762dc5f47a10sf This function takes one string argument and expands to the contents of the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive file. This is especially useful for matching this contents against a
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive regular expression, etc.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>Notice that <em>expression</em> is first parsed into an internal machine
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliverepresentation and then evaluated in a second step. Actually, in Global and
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivePer-Server Class context <em>expression</em> is parsed at startup time and
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveat runtime only the machine representation is executed. For Per-Directory
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivecontext this is different: here <em>expression</em> has to be parsed and
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveimmediately executed for every request.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSLRequire ( %{SSL_CIPHER} !~ m/^(EXP|NULL)-/ \<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive and %{SSL_CLIENT_S_DN_O} eq "Snake Oil, Ltd." \<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive and %{SSL_CLIENT_S_DN_OU} in {"Staff", "CA", "Dev"} \<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive and %{TIME_WDAY} >= 1 and %{TIME_WDAY} <= 5 \<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive and %{TIME_HOUR} >= 8 and %{TIME_HOUR} <= 20 ) \<br />
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<p>The <code>PeerExtList(<em>object id</em>)</code> function expects to find
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivezero or more instances of the X.509 Certificate Extension (as identified by
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivethe given <em>object id</em>) in the client certificate, and compares the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveleft-hand side string against the value of any matching attribute value. Every
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveextension with the specified object id is checked, until a match is found.
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP_USER_AGENT PATH_INFO AUTH_TYPE
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP_REFERER QUERY_STRING SERVER_SOFTWARE
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP_COOKIE REMOTE_HOST API_VERSION
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP_FORWARDED REMOTE_IDENT TIME_YEAR
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP_HOST IS_SUBREQ TIME_MON
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP_PROXY_CONNECTION DOCUMENT_ROOT TIME_DAY
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP_ACCEPT SERVER_ADMIN TIME_HOUR
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTP:headername SERVER_NAME TIME_MIN
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveTHE_REQUEST SERVER_PORT TIME_SEC
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveREQUEST_METHOD SERVER_PROTOCOL TIME_WDAY
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveREQUEST_SCHEME REMOTE_ADDR TIME
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveREQUEST_URI REMOTE_USER ENV:<strong>variablename</strong>
e55568369c0cb7b40f0faa9a6cf751676695f6bfmartinREQUEST_FILENAME
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveHTTPS SSL_CLIENT_M_VERSION SSL_SERVER_M_VERSION
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_M_SERIAL SSL_SERVER_M_SERIAL
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_PROTOCOL SSL_CLIENT_V_START SSL_SERVER_V_START
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_SESSION_ID SSL_CLIENT_V_END SSL_SERVER_V_END
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_SESSION_RESUMED SSL_CLIENT_S_DN SSL_SERVER_S_DN
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_CIPHER SSL_CLIENT_S_DN_C SSL_SERVER_S_DN_C
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_CIPHER_EXPORT SSL_CLIENT_S_DN_ST SSL_SERVER_S_DN_ST
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_CIPHER_ALGKEYSIZE SSL_CLIENT_S_DN_L SSL_SERVER_S_DN_L
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_CIPHER_USEKEYSIZE SSL_CLIENT_S_DN_O SSL_SERVER_S_DN_O
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_VERSION_LIBRARY SSL_CLIENT_S_DN_OU SSL_SERVER_S_DN_OU
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37sliveSSL_VERSION_INTERFACE SSL_CLIENT_S_DN_CN SSL_SERVER_S_DN_CN
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_S_DN_T SSL_SERVER_S_DN_T
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_S_DN_I SSL_SERVER_S_DN_I
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_S_DN_G SSL_SERVER_S_DN_G
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_S_DN_S SSL_SERVER_S_DN_S
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_S_DN_D SSL_SERVER_S_DN_D
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_S_DN_UID SSL_SERVER_S_DN_UID
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_S_DN_Email SSL_SERVER_S_DN_Email
e1c1bf4d7684950ea2a31a0419dc46991ec539abmartin SSL_CLIENT_I_DN SSL_SERVER_I_DN
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_C SSL_SERVER_I_DN_C
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_ST SSL_SERVER_I_DN_ST
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_L SSL_SERVER_I_DN_L
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_O SSL_SERVER_I_DN_O
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_OU SSL_SERVER_I_DN_OU
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_CN SSL_SERVER_I_DN_CN
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_T SSL_SERVER_I_DN_T
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_I SSL_SERVER_I_DN_I
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_G SSL_SERVER_I_DN_G
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_S SSL_SERVER_I_DN_S
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_D SSL_SERVER_I_DN_D
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_UID SSL_SERVER_I_DN_UID
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_I_DN_Email SSL_SERVER_I_DN_Email
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_A_SIG SSL_SERVER_A_SIG
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_A_KEY SSL_SERVER_A_KEY
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive SSL_CLIENT_CERT SSL_SERVER_CERT
f7ac17a355153b91b25db5d526afd752465aa489jorton SSL_CLIENT_VERIFY
02c4e4fe19f1120c6bdf561950ab60077c61cc5fsf</directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<directivesynopsis>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<description>Set the size for the SSL renegotiation buffer</description>
f7ac17a355153b91b25db5d526afd752465aa489jorton<p>If an SSL renegotiation is required in per-location context, for
f7ac17a355153b91b25db5d526afd752465aa489jortonexample, any use of <directive
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivemodule="mod_ssl">SSLVerifyClient</directive> in a Directory or
b2e4e96cb2848d55d437c11c53d944edac79824asliveLocation block, then <module>mod_ssl</module> must buffer any HTTP
f7ac17a355153b91b25db5d526afd752465aa489jortonrequest body into memory until the new SSL handshake can be performed.
f7ac17a355153b91b25db5d526afd752465aa489jortonThis directive can be used to set the amount of memory that will be
db0a69066a507e4b86b8b93d5e9e0c15df4c0237jortonused for this buffer. </p>
f7ac17a355153b91b25db5d526afd752465aa489jortonNote that in many configurations, the client sending the request body
f7ac17a355153b91b25db5d526afd752465aa489jortonwill be untrusted so a denial of service attack by consumption of
f7ac17a355153b91b25db5d526afd752465aa489jortonmemory must be considered when changing this configuration setting.
f7ac17a355153b91b25db5d526afd752465aa489jortonSSLRenegBufferSize 262144
f7ac17a355153b91b25db5d526afd752465aa489jorton</directivesynopsis>
db0a69066a507e4b86b8b93d5e9e0c15df4c0237jorton<directivesynopsis>
db0a69066a507e4b86b8b93d5e9e0c15df4c0237jorton<description>Whether to allow non SNI clients to access a name based virtual
f7ac17a355153b91b25db5d526afd752465aa489jorton</description>
f7ac17a355153b91b25db5d526afd752465aa489jorton<compatibility>Available in Apache 2.2.12 and later</compatibility>
f7ac17a355153b91b25db5d526afd752465aa489jortonThis directive sets whether a non SNI client is allowed to access a name based
f7ac17a355153b91b25db5d526afd752465aa489jortonvirtual host. If set to <code>on</code> in the default name based virtual
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slivehost, clients that are SNI unaware will not be allowed to access <em>any</em>
f28cb43e0ae51d68dee099bbf7ddbc84252cbd7eigalicvirtual host, belonging to this particular IP / port combination.
f28cb43e0ae51d68dee099bbf7ddbc84252cbd7eigalicIf set to <code>on</code> in any other virtual host, SNI unaware clients
f28cb43e0ae51d68dee099bbf7ddbc84252cbd7eigalicare not allowed to access this particular virtual host.
0eead7b938755d271961071a208b9934617ecedfrpluemThis option is only available if httpd was compiled against an SNI capable
53dc45378bd4ed291a736a89089387f48b9005f1jortonversion of OpenSSL.
0eead7b938755d271961071a208b9934617ecedfrpluemSSLStrictSNIVHostCheck on
0eead7b938755d271961071a208b9934617ecedfrpluem</directivesynopsis>
53dc45378bd4ed291a736a89089387f48b9005f1jorton<directivesynopsis>
53dc45378bd4ed291a736a89089387f48b9005f1jorton<description>Directory of PEM-encoded client certificates and keys to be used by the proxy</description>
53dc45378bd4ed291a736a89089387f48b9005f1jorton<syntax>SSLProxyMachineCertificatePath <em>directory</em></syntax>
53dc45378bd4ed291a736a89089387f48b9005f1jorton<contextlist><context>server config</context></contextlist>
53dc45378bd4ed291a736a89089387f48b9005f1jortonThis directive sets the directory where you keep the certificates and
53dc45378bd4ed291a736a89089387f48b9005f1jortonkeys used for authentication of the proxy server to remote servers.
53dc45378bd4ed291a736a89089387f48b9005f1jorton<p>The files in this directory must be PEM-encoded and are accessed through
53dc45378bd4ed291a736a89089387f48b9005f1jortonhash filenames. Additionally, you must create symbolic links named
0eead7b938755d271961071a208b9934617ecedfrpluem<code><em>hash-value</em>.N</code>. And you should always make sure this
0eead7b938755d271961071a208b9934617ecedfrpluemdirectory contains the appropriate symbolic links. Use the Makefile which
0eead7b938755d271961071a208b9934617ecedfrpluemcomes with mod_ssl to accomplish this task.
0eead7b938755d271961071a208b9934617ecedfrpluem<p>Currently there is no support for encrypted private keys</p>
1fd5131d5732e639b0b4225ca0afea717c41bc11trawickSSLProxyMachineCertificatePath /usr/local/apache2/conf/proxy.crt/
e3715027f352040ef98da03359b00f13ddb506cbrpluem</directivesynopsis>
e3715027f352040ef98da03359b00f13ddb506cbrpluem<directivesynopsis>
e3715027f352040ef98da03359b00f13ddb506cbrpluem<description>File of concatenated PEM-encoded client certificates and keys to be used by the proxy</description>
e3715027f352040ef98da03359b00f13ddb506cbrpluem<syntax>SSLProxyMachineCertificateFile <em>filename</em></syntax>
e3715027f352040ef98da03359b00f13ddb506cbrpluem<contextlist><context>server config</context></contextlist>
c33dbf8773dd8ae2d89a7a5bd97df00fd582e008igalicThis directive sets the all-in-one file where you keep the certificates and
c33dbf8773dd8ae2d89a7a5bd97df00fd582e008igalickeys used for authentication of the proxy server to remote servers.
e3715027f352040ef98da03359b00f13ddb506cbrpluemThis referenced file is simply the concatenation of the various PEM-encoded
e3715027f352040ef98da03359b00f13ddb506cbrpluemcertificate files, in order of preference. Use this directive alternatively
e3715027f352040ef98da03359b00f13ddb506cbrpluemor additionally to <code>SSLProxyMachineCertificatePath</code>.
e3715027f352040ef98da03359b00f13ddb506cbrpluem<p>Currently there is no support for encrypted private keys</p>
e3715027f352040ef98da03359b00f13ddb506cbrpluemSSLProxyMachineCertificateFile /usr/local/apache2/conf/ssl.crt/proxy.pem
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
65e536f8dab0d8c715fc718e7405fbbac4b0837bmads<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>Type of remote server Certificate verification</description>
d99faa99674be527e7fcc0ab5903463be779934drbowen<p>When a proxy is configured to forward requests to a remote SSL
d99faa99674be527e7fcc0ab5903463be779934drbowenserver, this directive can be used to configure certificate
d99faa99674be527e7fcc0ab5903463be779934drbowenverification of the remote server. Notice that this directive can be
65e536f8dab0d8c715fc718e7405fbbac4b0837bmadsused both in per-server and per-directory context. In per-server
65e536f8dab0d8c715fc718e7405fbbac4b0837bmadscontext it applies to the remote server authentication process used in
65e536f8dab0d8c715fc718e7405fbbac4b0837bmadsthe standard SSL handshake when a connection is established by the
4cd185b8f43b3014d0ef735b16c733844956c665jortonproxy. In per-directory context it forces a SSL renegotation with the
65e536f8dab0d8c715fc718e7405fbbac4b0837bmadsreconfigured remote server verification level after the HTTP request
d99faa99674be527e7fcc0ab5903463be779934drbowenwas read but before the HTTP response is sent.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenThe following levels are available for <em>level</em>:</p>
d99faa99674be527e7fcc0ab5903463be779934drbowen no remote server Certificate is required at all</li>
d99faa99674be527e7fcc0ab5903463be779934drbowen the remote server <em>may</em> present a valid Certificate</li>
d99faa99674be527e7fcc0ab5903463be779934drbowen the remote server <em>has to</em> present a valid Certificate</li>
d99faa99674be527e7fcc0ab5903463be779934drbowen the remote server may present a valid Certificate<br />
d99faa99674be527e7fcc0ab5903463be779934drbowen but it need not to be (successfully) verifiable.</li>
d99faa99674be527e7fcc0ab5903463be779934drbowen<strong>require</strong> are really interesting, because level
d99faa99674be527e7fcc0ab5903463be779934drbowen<strong>optional</strong> doesn't work with all servers and level
d99faa99674be527e7fcc0ab5903463be779934drbowen<strong>optional_no_ca</strong> is actually against the idea of
d99faa99674be527e7fcc0ab5903463be779934drbowenauthentication (but can be used to establish SSL test pages, etc.)</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenSSLProxyVerify require
65e536f8dab0d8c715fc718e7405fbbac4b0837bmads</directivesynopsis>
65e536f8dab0d8c715fc718e7405fbbac4b0837bmads<directivesynopsis>
65e536f8dab0d8c715fc718e7405fbbac4b0837bmads<description>Maximum depth of CA Certificates in Remote Server
d99faa99674be527e7fcc0ab5903463be779934drbowenCertificate verification</description>
6a93ff92c722b879358b25415302e090833a2c75jortonThis directive sets how deeply mod_ssl should verify before deciding that the
6a93ff92c722b879358b25415302e090833a2c75jortonremote server does not have a valid certificate. Notice that this directive can be
6a93ff92c722b879358b25415302e090833a2c75jortonused both in per-server and per-directory context. In per-server context it
68aed4e74d7db15eaab99b93bb8a10f981979626covenerapplies to the client authentication process used in the standard SSL
d99faa99674be527e7fcc0ab5903463be779934drbowenhandshake when a connection is established. In per-directory context it forces
d99faa99674be527e7fcc0ab5903463be779934drbowena SSL renegotation with the reconfigured remote server verification depth after the
d99faa99674be527e7fcc0ab5903463be779934drbowenHTTP request was read but before the HTTP response is sent.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenThe depth actually is the maximum number of intermediate certificate issuers,
d99faa99674be527e7fcc0ab5903463be779934drboweni.e. the number of CA certificates which are max allowed to be followed while
d99faa99674be527e7fcc0ab5903463be779934drbowenverifying the remote server certificate. A depth of 0 means that self-signed
d99faa99674be527e7fcc0ab5903463be779934drbowenremote server certificates are accepted only, the default depth of 1 means
d99faa99674be527e7fcc0ab5903463be779934drbowenthe remote server certificate can be self-signed or has to be signed by a CA
d99faa99674be527e7fcc0ab5903463be779934drbowenwhich is directly known to the server (i.e. the CA's certificate is under
d99faa99674be527e7fcc0ab5903463be779934drbowen<directive module="mod_ssl">SSLProxyCACertificatePath</directive>), etc.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenSSLProxyVerifyDepth 10
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>Whether to check if remote server certificate is expired
d99faa99674be527e7fcc0ab5903463be779934drbowen</description>
ab20e201bcefe9fa3fb65d6218773ffa7190a3f9sliveThis directive sets whether it is checked if the remote server certificate
ab20e201bcefe9fa3fb65d6218773ffa7190a3f9sliveis expired or not. If the check fails a 502 status code (Bad Gateway) is
d99faa99674be527e7fcc0ab5903463be779934drbowenSSLProxyCheckPeerExpire on
68aed4e74d7db15eaab99b93bb8a10f981979626covener</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>Whether to check the remote server certificates CN field
d99faa99674be527e7fcc0ab5903463be779934drbowen</description>
d99faa99674be527e7fcc0ab5903463be779934drbowenThis directive sets whether the remote server certificates CN field is
d99faa99674be527e7fcc0ab5903463be779934drbowencompared against the hostname of the request URL. If both are not equal
8f2700898323915da289644dc1f3ee11a5e5b4earpluema 502 status code (Bad Gateway) is sent.
8f2700898323915da289644dc1f3ee11a5e5b4earpluemSSLProxyCheckPeerCN on
8f2700898323915da289644dc1f3ee11a5e5b4earpluem</directivesynopsis>
8f2700898323915da289644dc1f3ee11a5e5b4earpluem<directivesynopsis>
8f2700898323915da289644dc1f3ee11a5e5b4earpluem<description>SSL Proxy Engine Operation Switch</description>
8f2700898323915da289644dc1f3ee11a5e5b4earpluemThis directive toggles the usage of the SSL/TLS Protocol Engine for proxy. This
8f2700898323915da289644dc1f3ee11a5e5b4earpluemtype="section">VirtualHost</directive> section to enable SSL/TLS for proxy
8f2700898323915da289644dc1f3ee11a5e5b4earpluemusage in a particular virtual host. By default the SSL/TLS Protocol Engine is
8f2700898323915da289644dc1f3ee11a5e5b4earpluemdisabled for proxy image both for the main server and all configured virtual hosts.</p>
8f2700898323915da289644dc1f3ee11a5e5b4earpluem<VirtualHost _default_:443><br />
9e208f082c3decf02610a0c49f0f5688ea3eb8f9rpluemSSLProxyEngine on<br />
8f2700898323915da289644dc1f3ee11a5e5b4earpluem</VirtualHost>
8f2700898323915da289644dc1f3ee11a5e5b4earpluem</directivesynopsis>
8f2700898323915da289644dc1f3ee11a5e5b4earpluem<directivesynopsis>
8f2700898323915da289644dc1f3ee11a5e5b4earpluem<description>Configure usable SSL protocol flavors for proxy usage</description>
8f2700898323915da289644dc1f3ee11a5e5b4earpluem<syntax>SSLProxyProtocol [+|-]<em>protocol</em> ...</syntax>
d99faa99674be527e7fcc0ab5903463be779934drbowen<!-- XXX Why does this have an override and not .htaccess context? -->
d99faa99674be527e7fcc0ab5903463be779934drbowenThis directive can be used to control the SSL protocol flavors mod_ssl should
d99faa99674be527e7fcc0ab5903463be779934drbowenuse when establishing its server environment for proxy . It will only connect
d99faa99674be527e7fcc0ab5903463be779934drbowento servers using one of the provided protocols.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowen<p>Please refer to <directive module="mod_ssl">SSLProtocol</directive>
d99faa99674be527e7fcc0ab5903463be779934drbowenfor additional information.
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>Cipher Suite available for negotiation in SSL
d99faa99674be527e7fcc0ab5903463be779934drbowenproxy handshake</description>
d99faa99674be527e7fcc0ab5903463be779934drbowen<syntax>SSLProxyCipherSuite <em>cipher-spec</em></syntax>
d99faa99674be527e7fcc0ab5903463be779934drbowen<default>SSLProxyCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</default>
d99faa99674be527e7fcc0ab5903463be779934drbowen<p>Equivalent to <code>SSLCipherSuite</code>, but for the proxy connection.
d99faa99674be527e7fcc0ab5903463be779934drbowenPlease refer to <directive module="mod_ssl">SSLCipherSuite</directive>
d99faa99674be527e7fcc0ab5903463be779934drbowenfor additional information.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>Directory of PEM-encoded CA Certificates for
d99faa99674be527e7fcc0ab5903463be779934drbowenRemote Server Auth</description>
d99faa99674be527e7fcc0ab5903463be779934drbowen<syntax>SSLProxyCACertificatePath <em>directory-path</em></syntax>
d99faa99674be527e7fcc0ab5903463be779934drbowenThis directive sets the directory where you keep the Certificates of
d99faa99674be527e7fcc0ab5903463be779934drbowenCertification Authorities (CAs) whose remote servers you deal with. These are used to
d99faa99674be527e7fcc0ab5903463be779934drbowenverify the remote server certificate on Remote Server Authentication.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenThe files in this directory have to be PEM-encoded and are accessed through
d99faa99674be527e7fcc0ab5903463be779934drbowenhash filenames. So usually you can't just place the Certificate files
d99faa99674be527e7fcc0ab5903463be779934drbowenthere: you also have to create symbolic links named
d99faa99674be527e7fcc0ab5903463be779934drbowen<em>hash-value</em><code>.N</code>. And you should always make sure this directory
d99faa99674be527e7fcc0ab5903463be779934drbowencontains the appropriate symbolic links. Use the <code>Makefile</code> which
d99faa99674be527e7fcc0ab5903463be779934drbowencomes with mod_ssl to accomplish this task.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenSSLProxyCACertificatePath /usr/local/apache2/conf/ssl.crt/
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>File of concatenated PEM-encoded CA Certificates
d99faa99674be527e7fcc0ab5903463be779934drbowenfor Remote Server Auth</description>
2e1789ae4b1b62d36ed53ccdd391f626640d642frbowen<syntax>SSLProxyCACertificateFile <em>file-path</em></syntax>
d99faa99674be527e7fcc0ab5903463be779934drbowenThis directive sets the <em>all-in-one</em> file where you can assemble the
d99faa99674be527e7fcc0ab5903463be779934drbowenCertificates of Certification Authorities (CA) whose <em>remote servers</em> you deal
d99faa99674be527e7fcc0ab5903463be779934drbowenwith. These are used for Remote Server Authentication. Such a file is simply the
d99faa99674be527e7fcc0ab5903463be779934drbowenconcatenation of the various PEM-encoded Certificate files, in order of
d99faa99674be527e7fcc0ab5903463be779934drbowenpreference. This can be used alternatively and/or additionally to
d99faa99674be527e7fcc0ab5903463be779934drbowen<directive module="mod_ssl">SSLProxyCACertificatePath</directive>.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenSSLProxyCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-remote-server.crt
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>Directory of PEM-encoded CA CRLs for
d99faa99674be527e7fcc0ab5903463be779934drbowenRemote Server Auth</description>
d99faa99674be527e7fcc0ab5903463be779934drbowen<syntax>SSLProxyCARevocationPath <em>directory-path</em></syntax>
d99faa99674be527e7fcc0ab5903463be779934drbowenThis directive sets the directory where you keep the Certificate Revocation
d99faa99674be527e7fcc0ab5903463be779934drbowenLists (CRL) of Certification Authorities (CAs) whose remote servers you deal with.
d99faa99674be527e7fcc0ab5903463be779934drbowenThese are used to revoke the remote server certificate on Remote Server Authentication.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenThe files in this directory have to be PEM-encoded and are accessed through
d99faa99674be527e7fcc0ab5903463be779934drbowenhash filenames. So usually you have not only to place the CRL files there.
d99faa99674be527e7fcc0ab5903463be779934drbowenAdditionally you have to create symbolic links named
d99faa99674be527e7fcc0ab5903463be779934drbowen<em>hash-value</em><code>.rN</code>. And you should always make sure this directory
d99faa99674be527e7fcc0ab5903463be779934drbowencontains the appropriate symbolic links. Use the <code>Makefile</code> which
d99faa99674be527e7fcc0ab5903463be779934drbowencomes with <module>mod_ssl</module> to accomplish this task.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenSSLProxyCARevocationPath /usr/local/apache2/conf/ssl.crl/
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>File of concatenated PEM-encoded CA CRLs for
e22983c2cda01e5df1a8a6b72c2ff687370975aaerikabeleRemote Server Auth</description>
d99faa99674be527e7fcc0ab5903463be779934drbowen<syntax>SSLProxyCARevocationFile <em>file-path</em></syntax>
d99faa99674be527e7fcc0ab5903463be779934drbowenThis directive sets the <em>all-in-one</em> file where you can
d99faa99674be527e7fcc0ab5903463be779934drbowenassemble the Certificate Revocation Lists (CRL) of Certification
d99faa99674be527e7fcc0ab5903463be779934drbowenAuthorities (CA) whose <em>remote servers</em> you deal with. These are used
d99faa99674be527e7fcc0ab5903463be779934drbowenfor Remote Server Authentication. Such a file is simply the concatenation of
d99faa99674be527e7fcc0ab5903463be779934drbowenthe various PEM-encoded CRL files, in order of preference. This can be
d99faa99674be527e7fcc0ab5903463be779934drbowenmodule="mod_ssl">SSLProxyCARevocationPath</directive>.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowenSSLProxyCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-remote-server.crl
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>Variable name to determine user name</description>
d99faa99674be527e7fcc0ab5903463be779934drbowen<compatibility>Available in Apache 2.0.51 and later</compatibility>
d99faa99674be527e7fcc0ab5903463be779934drbowenThis directive sets the "user" field in the Apache request object.
d99faa99674be527e7fcc0ab5903463be779934drbowenThis is used by lower modules to identify the user with a character
d99faa99674be527e7fcc0ab5903463be779934drbowenstring. In particular, this may cause the environment variable
d99faa99674be527e7fcc0ab5903463be779934drbowen<code>REMOTE_USER</code> to be set. The <em>varname</em> can be
d99faa99674be527e7fcc0ab5903463be779934drbowenany of the <a href="#envvars">SSL environment variables</a>.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowen<p>Note that this directive has no effect if the
d99faa99674be527e7fcc0ab5903463be779934drbowenSSLUserName SSL_CLIENT_S_DN_CN
d99faa99674be527e7fcc0ab5903463be779934drbowen</directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<directivesynopsis>
d99faa99674be527e7fcc0ab5903463be779934drbowen<description>Option to prefer the server's cipher preference order</description>
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jorton<compatibility>Available in Apache 2.1 and later, if using OpenSSL 0.9.7 or later</compatibility>
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jorton<p>When choosing a cipher during an SSLv3 or TLSv1 handshake, normally
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jortonthe client's preference is used. If this directive is enabled, the
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jortonserver's preference will be used instead.</p>
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jortonSSLHonorCipherOrder on
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jorton</directivesynopsis>
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jorton<directivesynopsis>
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jorton<description>Enable use of a cryptographic hardware accelerator</description>
1ab9cf3bb2ffedd3dd13008be6a1d64423afeefejorton<contextlist><context>server config</context></contextlist>
1ab9cf3bb2ffedd3dd13008be6a1d64423afeefejortonThis directive enables use of a cryptographic hardware accelerator
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jortonboard to offload some of the SSL processing overhead. This directive
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jortoncan only be used if the SSL toolkit is built with "engine" support;
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jortonOpenSSL 0.9.7 and later releases have "engine" support by default, the
eff8e38d2e04f20febd66366f5bb8a5a640ca4f8jortonseparate "-engine" releases of OpenSSL 0.9.6 must be used.</p>
d99faa99674be527e7fcc0ab5903463be779934drbowen<p>To discover which engine names are supported, run the command
04cbb7628e2c07fd67e84a77881aeeefb8a6c252sf# For a Broadcom accelerator:<br />
d2e618b3d0951b9f6a590dea8f21b9a2350d26d0jortonSSLCryptoDevice ubsec
d2e618b3d0951b9f6a590dea8f21b9a2350d26d0jorton</directivesynopsis>
d2e618b3d0951b9f6a590dea8f21b9a2350d26d0jorton<directivesynopsis>
d2e618b3d0951b9f6a590dea8f21b9a2350d26d0jorton<description>Enable OCSP validation of the client certificate chain</description>
d2e618b3d0951b9f6a590dea8f21b9a2350d26d0jorton<compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
4cd185b8f43b3014d0ef735b16c733844956c665jorton<p>This option enables OCSP validation of the client certificate
4cd185b8f43b3014d0ef735b16c733844956c665jortonchain. If this option is enabled, certificates in the client's
4cd185b8f43b3014d0ef735b16c733844956c665jortoncertificate chain will be validated against an OCSP responder after
4cd185b8f43b3014d0ef735b16c733844956c665jortonnormal verification (including CRL checks) have taken place.</p>
4cd185b8f43b3014d0ef735b16c733844956c665jorton<p>The OCSP responder used is either extracted from the certificate
4cd185b8f43b3014d0ef735b16c733844956c665jortonitself, or derived by configuration; see the
4cd185b8f43b3014d0ef735b16c733844956c665jorton<directive module="mod_ssl">SSLOCSPDefaultResponder</directive> and
4cd185b8f43b3014d0ef735b16c733844956c665jorton<directive module="mod_ssl">SSLOCSPOverrideResponder</directive>
4cd185b8f43b3014d0ef735b16c733844956c665jortondirectives.</p>
4cd185b8f43b3014d0ef735b16c733844956c665jortonSSLVerifyClient on<br/>
4cd185b8f43b3014d0ef735b16c733844956c665jortonSSLOCSPEnable on<br/>
4cd185b8f43b3014d0ef735b16c733844956c665jortonSSLOCSPDefaultResponder http://responder.example.com:8888/responder<br/>
4cd185b8f43b3014d0ef735b16c733844956c665jortonSSLOCSPOverrideResponder on
4cd185b8f43b3014d0ef735b16c733844956c665jorton</directivesynopsis>
4cd185b8f43b3014d0ef735b16c733844956c665jorton<directivesynopsis>
4cd185b8f43b3014d0ef735b16c733844956c665jorton<description>Set the default responder URI for OCSP validation</description>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<p>This option sets the default OCSP responder to use. If <directive
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonmodule="mod_ssl">SSLOCSPOverrideResponder</directive> is not enabled,
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonthe URI given will be used only if no responder URI is specified in
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonthe certificate being verified.</p>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton</directivesynopsis>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<directivesynopsis>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<description>Force use of the default responder URI for OCSP validation</description>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<syntax>SSLOCSPOverrideResponder <em>flag</em></syntax>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<compatibility>Available in httpd 2.3 and later, if using OpenSSL 0.9.7 or later</compatibility>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<p>This option forces the configured default OCSP responder to be used
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonduring OCSP certificate validation, regardless of whether the
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortoncertificate being validated references an OCSP responder.</p>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton</directivesynopsis>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<directivesynopsis>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<description>Option to enable support for insecure renegotiation</description>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<syntax>SSLInsecureRenegotiation <em>flag</em></syntax>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<compatibility>Available in httpd 2.2.15 and later, if using OpenSSL 0.9.8m or later</compatibility>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<p>As originally specified, all versions of the SSL and TLS protocols
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton(up to and including TLS/1.2) were vulnerable to a Man-in-the-Middle
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton(<a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-2009-3555</a>)
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonduring a renegotiation. This vulnerability allowed an attacker to
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton"prefix" a chosen plaintext to the HTTP request as seen by the web
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonserver. A protocol extension was developed which fixed this
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonvulnerability if supported by both client and server.</p>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<p>If <module>mod_ssl</module> is linked against OpenSSL version 0.9.8m
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonor later, by default renegotiation is only supported with
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonclients supporting the new protocol extension. If this directive is
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonenabled, renegotiation will be allowed with old (unpatched) clients,
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonalbeit insecurely.</p>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jorton<p>If this directive is enabled, SSL connections will be vulnerable to
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonthe Man-in-the-Middle prefix attack as described
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonin <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-2009-3555</a>.</p>
512185ecf62bdf08a826a2b6ce7ae7157fd5c793jortonSSLInsecureRenegotiation on
f7489468254ddf807594db3dfb994035f0ec1c7djorton<p>The <code>SSL_SECURE_RENEG</code> environment variable can be used
f7489468254ddf807594db3dfb994035f0ec1c7djortonfrom an SSI or CGI script to determine whether secure renegotiation is
f7489468254ddf807594db3dfb994035f0ec1c7djortonsupported for a given SSL connection.</p>
f7489468254ddf807594db3dfb994035f0ec1c7djorton</directivesynopsis>
f7489468254ddf807594db3dfb994035f0ec1c7djorton</modulesynopsis>