1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7 This file is generated from xml source: DO NOT EDIT
8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10 <title>mod_ssl - Apache HTTP Server Version 2.5</title>
11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
19 <div id="page-header">
20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
21 <p class="apache">Apache HTTP Server Version 2.5</p>
22 <img alt="" src="../images/feather.png" /></div>
23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
25 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
26 <div id="page-content">
27 <div id="preamble"><h1>Apache Module mod_ssl</h1>
29 <p><span>Available Languages: </span><a href="../en/mod/mod_ssl.html" title="English"> en </a></p>
31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Strong cryptography using the Secure Sockets
32 Layer (SSL) and Transport Layer Security (TLS) protocols</td></tr>
33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>ssl_module</td></tr>
35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_ssl.c</td></tr></table>
38 <p>This module provides SSL v3 and TLS v1.x support for the Apache
39 HTTP Server. SSL v2 is no longer supported.</p>
41 <p>This module relies on <a href="http://www.openssl.org/">OpenSSL</a>
42 to provide the cryptography engine.</p>
44 <p>Further details, discussion, and examples are provided in the
45 <a href="../ssl/">SSL documentation</a>.</p>
47 <div id="quickview"><h3>Topics</h3>
49 <li><img alt="" src="../images/down.gif" /> <a href="#envvars">Environment Variables</a></li>
50 <li><img alt="" src="../images/down.gif" /> <a href="#logformats">Custom Log Formats</a></li>
51 <li><img alt="" src="../images/down.gif" /> <a href="#notes">Request Notes</a></li>
52 <li><img alt="" src="../images/down.gif" /> <a href="#expressionparser">Expression Parser Extension</a></li>
53 <li><img alt="" src="../images/down.gif" /> <a href="#authzproviders">Authorization providers for use with Require</a></li>
54 </ul><h3 class="directives">Directives</h3>
56 <li><img alt="" src="../images/down.gif" /> <a href="#sslcacertificatefile">SSLCACertificateFile</a></li>
57 <li><img alt="" src="../images/down.gif" /> <a href="#sslcacertificatepath">SSLCACertificatePath</a></li>
58 <li><img alt="" src="../images/down.gif" /> <a href="#sslcadnrequestfile">SSLCADNRequestFile</a></li>
59 <li><img alt="" src="../images/down.gif" /> <a href="#sslcadnrequestpath">SSLCADNRequestPath</a></li>
60 <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationcheck">SSLCARevocationCheck</a></li>
61 <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationfile">SSLCARevocationFile</a></li>
62 <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationpath">SSLCARevocationPath</a></li>
63 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatechainfile">SSLCertificateChainFile</a></li>
64 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatefile">SSLCertificateFile</a></li>
65 <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></li>
66 <li><img alt="" src="../images/down.gif" /> <a href="#sslciphersuite">SSLCipherSuite</a></li>
67 <li><img alt="" src="../images/down.gif" /> <a href="#sslcompression">SSLCompression</a></li>
68 <li><img alt="" src="../images/down.gif" /> <a href="#sslcryptodevice">SSLCryptoDevice</a></li>
69 <li><img alt="" src="../images/down.gif" /> <a href="#sslengine">SSLEngine</a></li>
70 <li><img alt="" src="../images/down.gif" /> <a href="#sslfips">SSLFIPS</a></li>
71 <li><img alt="" src="../images/down.gif" /> <a href="#sslhonorcipherorder">SSLHonorCipherOrder</a></li>
72 <li><img alt="" src="../images/down.gif" /> <a href="#sslinsecurerenegotiation">SSLInsecureRenegotiation</a></li>
73 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspdefaultresponder">SSLOCSPDefaultResponder</a></li>
74 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspenable">SSLOCSPEnable</a></li>
75 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></li>
76 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspproxyurl">SSLOCSPProxyURL</a></li>
77 <li><img alt="" src="../images/down.gif" /> <a href="#sslocsprespondertimeout">SSLOCSPResponderTimeout</a></li>
78 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspresponsemaxage">SSLOCSPResponseMaxAge</a></li>
79 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspresponsetimeskew">SSLOCSPResponseTimeSkew</a></li>
80 <li><img alt="" src="../images/down.gif" /> <a href="#sslocspuserequestnonce">SSLOCSPUseRequestNonce</a></li>
81 <li><img alt="" src="../images/down.gif" /> <a href="#sslopensslconfcmd">SSLOpenSSLConfCmd</a></li>
82 <li><img alt="" src="../images/down.gif" /> <a href="#ssloptions">SSLOptions</a></li>
83 <li><img alt="" src="../images/down.gif" /> <a href="#sslpassphrasedialog">SSLPassPhraseDialog</a></li>
84 <li><img alt="" src="../images/down.gif" /> <a href="#sslprotocol">SSLProtocol</a></li>
85 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycacertificatefile">SSLProxyCACertificateFile</a></li>
86 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></li>
87 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationcheck">SSLProxyCARevocationCheck</a></li>
88 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationfile">SSLProxyCARevocationFile</a></li>
89 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></li>
90 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycheckpeercn">SSLProxyCheckPeerCN</a></li>
91 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycheckpeerexpire">SSLProxyCheckPeerExpire</a></li>
92 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycheckpeername">SSLProxyCheckPeerName</a></li>
93 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyciphersuite">SSLProxyCipherSuite</a></li>
94 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyengine">SSLProxyEngine</a></li>
95 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatechainfile">SSLProxyMachineCertificateChainFile</a></li>
96 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatefile">SSLProxyMachineCertificateFile</a></li>
97 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatepath">SSLProxyMachineCertificatePath</a></li>
98 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyprotocol">SSLProxyProtocol</a></li>
99 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyverify">SSLProxyVerify</a></li>
100 <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyverifydepth">SSLProxyVerifyDepth</a></li>
101 <li><img alt="" src="../images/down.gif" /> <a href="#sslrandomseed">SSLRandomSeed</a></li>
102 <li><img alt="" src="../images/down.gif" /> <a href="#sslrenegbuffersize">SSLRenegBufferSize</a></li>
103 <li><img alt="" src="../images/down.gif" /> <a href="#sslrequire">SSLRequire</a></li>
104 <li><img alt="" src="../images/down.gif" /> <a href="#sslrequiressl">SSLRequireSSL</a></li>
105 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessioncache">SSLSessionCache</a></li>
106 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessioncachetimeout">SSLSessionCacheTimeout</a></li>
107 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessionticketkeyfile">SSLSessionTicketKeyFile</a></li>
108 <li><img alt="" src="../images/down.gif" /> <a href="#sslsessiontickets">SSLSessionTickets</a></li>
109 <li><img alt="" src="../images/down.gif" /> <a href="#sslsrpunknownuserseed">SSLSRPUnknownUserSeed</a></li>
110 <li><img alt="" src="../images/down.gif" /> <a href="#sslsrpverifierfile">SSLSRPVerifierFile</a></li>
111 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingcache">SSLStaplingCache</a></li>
112 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingerrorcachetimeout">SSLStaplingErrorCacheTimeout</a></li>
113 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingfaketrylater">SSLStaplingFakeTryLater</a></li>
114 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingforceurl">SSLStaplingForceURL</a></li>
115 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingrespondertimeout">SSLStaplingResponderTimeout</a></li>
116 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingresponsemaxage">SSLStaplingResponseMaxAge</a></li>
117 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingresponsetimeskew">SSLStaplingResponseTimeSkew</a></li>
118 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingreturnrespondererrors">SSLStaplingReturnResponderErrors</a></li>
119 <li><img alt="" src="../images/down.gif" /> <a href="#sslstaplingstandardcachetimeout">SSLStaplingStandardCacheTimeout</a></li>
120 <li><img alt="" src="../images/down.gif" /> <a href="#sslstrictsnivhostcheck">SSLStrictSNIVHostCheck</a></li>
121 <li><img alt="" src="../images/down.gif" /> <a href="#sslusername">SSLUserName</a></li>
122 <li><img alt="" src="../images/down.gif" /> <a href="#sslusestapling">SSLUseStapling</a></li>
123 <li><img alt="" src="../images/down.gif" /> <a href="#sslverifyclient">SSLVerifyClient</a></li>
124 <li><img alt="" src="../images/down.gif" /> <a href="#sslverifydepth">SSLVerifyDepth</a></li>
126 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_ssl">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_ssl">Report a bug</a></li></ul><h3>See also</h3>
128 <li><a href="#comments_section">Comments</a></li></ul></div>
129 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
130 <div class="section">
131 <h2><a name="envvars" id="envvars">Environment Variables</a></h2>
133 <p>This module can be configured to provide several items of SSL information
134 as additional environment variables to the SSI and CGI namespace. This
135 information is not provided by default for performance reasons. (See
136 <code class="directive">SSLOptions</code> StdEnvVars, below.) The generated variables
137 are listed in the table below. For backward compatibility the information can
138 be made available under different names, too. Look in the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter for details on the
139 compatibility variables.</p>
141 <table class="bordered">
144 <th><a name="table3">Variable Name:</a></th>
146 <th>Description:</th>
148 <tr><td><code>HTTPS</code></td> <td>flag</td> <td>HTTPS is being used.</td></tr>
149 <tr><td><code>SSL_PROTOCOL</code></td> <td>string</td> <td>The SSL protocol version (SSLv3, TLSv1, TLSv1.1, TLSv1.2)</td></tr>
150 <tr><td><code>SSL_SESSION_ID</code></td> <td>string</td> <td>The hex-encoded SSL session id</td></tr>
151 <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>
152 <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>
153 <tr><td><code>SSL_CIPHER</code></td> <td>string</td> <td>The cipher specification name</td></tr>
154 <tr><td><code>SSL_CIPHER_EXPORT</code></td> <td>string</td> <td><code>true</code> if cipher is an export cipher</td></tr>
155 <tr><td><code>SSL_CIPHER_USEKEYSIZE</code></td> <td>number</td> <td>Number of cipher bits (actually used)</td></tr>
156 <tr><td><code>SSL_CIPHER_ALGKEYSIZE</code></td> <td>number</td> <td>Number of cipher bits (possible)</td></tr>
157 <tr><td><code>SSL_COMPRESS_METHOD</code></td> <td>string</td> <td>SSL compression method negotiated</td></tr>
158 <tr><td><code>SSL_VERSION_INTERFACE</code></td> <td>string</td> <td>The mod_ssl program version</td></tr>
159 <tr><td><code>SSL_VERSION_LIBRARY</code></td> <td>string</td> <td>The OpenSSL program version</td></tr>
160 <tr><td><code>SSL_CLIENT_M_VERSION</code></td> <td>string</td> <td>The version of the client certificate</td></tr>
161 <tr><td><code>SSL_CLIENT_M_SERIAL</code></td> <td>string</td> <td>The serial of the client certificate</td></tr>
162 <tr><td><code>SSL_CLIENT_S_DN</code></td> <td>string</td> <td>Subject DN in client's certificate</td></tr>
163 <tr><td><code>SSL_CLIENT_S_DN_</code><em>x509</em></td> <td>string</td> <td>Component of client's Subject DN</td></tr>
164 <tr><td><code>SSL_CLIENT_SAN_Email_</code><em>n</em></td> <td>string</td> <td>Client certificate's subjectAltName extension entries of type rfc822Name</td></tr>
165 <tr><td><code>SSL_CLIENT_SAN_DNS_</code><em>n</em></td> <td>string</td> <td>Client certificate's subjectAltName extension entries of type dNSName</td></tr>
166 <tr><td><code>SSL_CLIENT_SAN_OTHER_msUPN_</code><em>n</em></td> <td>string</td> <td>Client certificate's subjectAltName extension entries of type otherName, Microsoft User Principal Name form (OID 1.3.6.1.4.1.311.20.2.3)</td></tr>
167 <tr><td><code>SSL_CLIENT_I_DN</code></td> <td>string</td> <td>Issuer DN of client's certificate</td></tr>
168 <tr><td><code>SSL_CLIENT_I_DN_</code><em>x509</em></td> <td>string</td> <td>Component of client's Issuer DN</td></tr>
169 <tr><td><code>SSL_CLIENT_V_START</code></td> <td>string</td> <td>Validity of client's certificate (start time)</td></tr>
170 <tr><td><code>SSL_CLIENT_V_END</code></td> <td>string</td> <td>Validity of client's certificate (end time)</td></tr>
171 <tr><td><code>SSL_CLIENT_V_REMAIN</code></td> <td>string</td> <td>Number of days until client's certificate expires</td></tr>
172 <tr><td><code>SSL_CLIENT_A_SIG</code></td> <td>string</td> <td>Algorithm used for the signature of client's certificate</td></tr>
173 <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>
174 <tr><td><code>SSL_CLIENT_CERT</code></td> <td>string</td> <td>PEM-encoded client certificate</td></tr>
175 <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>
176 <tr><td><code>SSL_CLIENT_CERT_RFC4523_CEA</code></td> <td>string</td> <td>Serial number and issuer of the certificate. The format matches that of the CertificateExactAssertion in RFC4523</td></tr>
177 <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>
178 <tr><td><code>SSL_SERVER_M_VERSION</code></td> <td>string</td> <td>The version of the server certificate</td></tr>
179 <tr><td><code>SSL_SERVER_M_SERIAL</code></td> <td>string</td> <td>The serial of the server certificate</td></tr>
180 <tr><td><code>SSL_SERVER_S_DN</code></td> <td>string</td> <td>Subject DN in server's certificate</td></tr>
181 <tr><td><code>SSL_SERVER_SAN_Email_</code><em>n</em></td> <td>string</td> <td>Server certificate's subjectAltName extension entries of type rfc822Name</td></tr>
182 <tr><td><code>SSL_SERVER_SAN_DNS_</code><em>n</em></td> <td>string</td> <td>Server certificate's subjectAltName extension entries of type dNSName</td></tr>
183 <tr><td><code>SSL_SERVER_SAN_OTHER_dnsSRV_</code><em>n</em></td> <td>string</td> <td>Server certificate's subjectAltName extension entries of type otherName, SRVName form (OID 1.3.6.1.5.5.7.8.7, RFC 4985)</td></tr>
184 <tr><td><code>SSL_SERVER_S_DN_</code><em>x509</em></td> <td>string</td> <td>Component of server's Subject DN</td></tr>
185 <tr><td><code>SSL_SERVER_I_DN</code></td> <td>string</td> <td>Issuer DN of server's certificate</td></tr>
186 <tr><td><code>SSL_SERVER_I_DN_</code><em>x509</em></td> <td>string</td> <td>Component of server's Issuer DN</td></tr>
187 <tr><td><code>SSL_SERVER_V_START</code></td> <td>string</td> <td>Validity of server's certificate (start time)</td></tr>
188 <tr><td><code>SSL_SERVER_V_END</code></td> <td>string</td> <td>Validity of server's certificate (end time)</td></tr>
189 <tr><td><code>SSL_SERVER_A_SIG</code></td> <td>string</td> <td>Algorithm used for the signature of server's certificate</td></tr>
190 <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>
191 <tr><td><code>SSL_SERVER_CERT</code></td> <td>string</td> <td>PEM-encoded server certificate</td></tr>
192 <tr><td><code>SSL_SRP_USER</code></td> <td>string</td> <td>SRP username</td></tr>
193 <tr><td><code>SSL_SRP_USERINFO</code></td> <td>string</td> <td>SRP user info</td></tr>
194 <tr><td><code>SSL_TLS_SNI</code></td> <td>string</td> <td>Contents of the SNI TLS extension (if supplied with ClientHello)</td></tr>
197 <p><em>x509</em> specifies a component of an X.509 DN; one of
198 <code>C,ST,L,O,OU,CN,T,I,G,S,D,UID,Email</code>. In Apache 2.1 and
199 later, <em>x509</em> may also include a numeric <code>_n</code>
200 suffix. If the DN in question contains multiple attributes of the
201 same name, this suffix is used as a zero-based index to select a
202 particular attribute. For example, where the server certificate
203 subject DN included two OU attributes, <code>SSL_SERVER_S_DN_OU_0</code>
205 <code>SSL_SERVER_S_DN_OU_1</code> could be used to reference each. A
206 variable name without a <code>_n</code> suffix is equivalent to that
207 name with a <code>_0</code> suffix; the first (or only) attribute.
208 When the environment table is populated using
209 the <code>StdEnvVars</code> option of
210 the <code class="directive"><a href="#ssloptions">SSLOptions</a></code> directive, the
211 first (or only) attribute of any DN is added only under a non-suffixed
212 name; i.e. no <code>_0</code> suffixed entries are added.</p>
214 <p>The format of the <em>*_DN</em> variables has changed in Apache HTTPD
215 2.3.11. See the <code>LegacyDNStringFormat</code> option for
216 <code class="directive"><a href="#ssloptions">SSLOptions</a></code> for details.</p>
218 <p><code>SSL_CLIENT_V_REMAIN</code> is only available in version 2.1
221 <p>A number of additional environment variables can also be used
222 in <code class="directive">SSLRequire</code> expressions, or in custom log
225 <div class="note"><pre>HTTP_USER_AGENT PATH_INFO AUTH_TYPE
226 HTTP_REFERER QUERY_STRING SERVER_SOFTWARE
227 HTTP_COOKIE REMOTE_HOST API_VERSION
228 HTTP_FORWARDED REMOTE_IDENT TIME_YEAR
229 HTTP_HOST IS_SUBREQ TIME_MON
230 HTTP_PROXY_CONNECTION DOCUMENT_ROOT TIME_DAY
231 HTTP_ACCEPT SERVER_ADMIN TIME_HOUR
232 THE_REQUEST SERVER_NAME TIME_MIN
233 REQUEST_FILENAME SERVER_PORT TIME_SEC
234 REQUEST_METHOD SERVER_PROTOCOL TIME_WDAY
235 REQUEST_SCHEME REMOTE_ADDR TIME
236 REQUEST_URI REMOTE_USER</pre></div>
238 <p>In these contexts, two special formats can also be used:</p>
241 <dt><code>ENV:<em>variablename</em></code></dt>
242 <dd>This will expand to the standard environment
243 variable <em>variablename</em>.</dd>
245 <dt><code>HTTP:<em>headername</em></code></dt>
246 <dd>This will expand to the value of the request header with name
247 <em>headername</em>.</dd>
250 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
251 <div class="section">
252 <h2><a name="logformats" id="logformats">Custom Log Formats</a></h2>
254 <p>When <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is built into Apache or at least
255 loaded (under DSO situation) additional functions exist for the <a href="mod_log_config.html#formats">Custom Log Format</a> of
256 <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code>. First there is an
257 additional ``<code>%{</code><em>varname</em><code>}x</code>''
258 eXtension format function which can be used to expand any variables
259 provided by any module, especially those provided by mod_ssl which can
260 you find in the above table.</p>
262 For backward compatibility there is additionally a special
263 ``<code>%{</code><em>name</em><code>}c</code>'' cryptography format function
264 provided. Information about this function is provided in the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter.</p>
265 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">CustomLog "logs/ssl_request_log" "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"</pre>
267 <p>These formats even work without setting the <code>StdEnvVars</code>
268 option of the <code class="directive"><a href="#ssloptions">SSLOptions</a></code>
270 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
271 <div class="section">
272 <h2><a name="notes" id="notes">Request Notes</a></h2>
274 <p><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> sets "notes" for the request which can be
275 used in logging with the <code>%{<em>name</em>}n</code> format
276 string in <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code>.</p>
278 <p>The notes supported are as follows:</p>
281 <dt><code>ssl-access-forbidden</code></dt>
282 <dd>This note is set to the value <code>1</code> if access was
283 denied due to an <code class="directive">SSLRequire</code>
284 or <code class="directive">SSLRequireSSL</code> directive.</dd>
286 <dt><code>ssl-secure-reneg</code></dt>
287 <dd>If <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is built against a version of
288 OpenSSL which supports the secure renegotiation extension, this note
289 is set to the value <code>1</code> if SSL is in used for the current
290 connection, and the client also supports the secure renegotiation
291 extension. If the client does not support the secure renegotiation
292 extension, the note is set to the value <code>0</code>.
293 If <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is not built against a version of
294 OpenSSL which supports secure renegotiation, or if SSL is not in use
295 for the current connection, the note is not set.</dd>
298 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
299 <div class="section">
300 <h2><a name="expressionparser" id="expressionparser">Expression Parser Extension</a></h2>
302 <p>When <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is built into Apache or at least
303 loaded (under DSO situation) any <a name="envvars">variables</a>
304 provided by <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> can be used in expressions
305 for the <a href="../expr.html">ap_expr Expression Parser</a>.
306 The variables can be referenced using the syntax
307 ``<code>%{</code><em>varname</em><code>}</code>''. Starting
308 with version 2.4.18 one can also use the
309 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> style syntax
310 ``<code>%{SSL:</code><em>varname</em><code>}</code>'' or
311 the function style syntax
312 ``<code>ssl(</code><em>varname</em><code>)</code>''.</p>
313 <div class="example"><h3>Example (using <code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code>)</h3><pre class="prettyprint lang-config">Header set X-SSL-PROTOCOL "expr=%{SSL_PROTOCOL}"
314 Header set X-SSL-CIPHER "expr=%{SSL:SSL_CIPHER}"</pre>
316 <p>This feature even works without setting the <code>StdEnvVars</code>
317 option of the <code class="directive"><a href="#ssloptions">SSLOptions</a></code>
319 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
320 <div class="section">
321 <h2><a name="authzproviders" id="authzproviders">Authorization providers for use with Require</a></h2>
323 <p><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> provides a few authentication providers for use
324 with <code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code>'s
325 <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directive.</p>
327 <h3><a name="reqssl" id="reqssl">Require ssl</a></h3>
329 <p>The <code>ssl</code> provider denies access if a connection is not
330 encrypted with SSL. This is similar to the
331 <code class="directive">SSLRequireSSL</code> directive.</p>
333 <pre class="prettyprint lang-config">Require ssl</pre>
338 <h3><a name="reqverifyclient" id="reqverifyclient">Require ssl-verify-client</a></h3>
340 <p>The <code>ssl</code> provider allows access if the user is
341 authenticated with a valid client certificate. This is only
342 useful if <code>SSLVerifyClient optional</code> is in effect.</p>
344 <p>The following example grants access if the user is authenticated
345 either with a client certificate or by username and password.</p>
347 <pre class="prettyprint lang-config">Require ssl-verify-client
348 Require valid-user</pre>
354 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
355 <div class="directive-section"><h2><a name="SSLCACertificateFile" id="SSLCACertificateFile">SSLCACertificateFile</a> <a name="sslcacertificatefile" id="sslcacertificatefile">Directive</a></h2>
356 <table class="directive">
357 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
358 for Client Auth</td></tr>
359 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCACertificateFile <em>file-path</em></code></td></tr>
360 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
361 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
362 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
365 This directive sets the <em>all-in-one</em> file where you can assemble the
366 Certificates of Certification Authorities (CA) whose <em>clients</em> you deal
367 with. These are used for Client Authentication. Such a file is simply the
368 concatenation of the various PEM-encoded Certificate files, in order of
369 preference. This can be used alternatively and/or additionally to
370 <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code>.</p>
371 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-client.crt</pre>
375 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
376 <div class="directive-section"><h2><a name="SSLCACertificatePath" id="SSLCACertificatePath">SSLCACertificatePath</a> <a name="sslcacertificatepath" id="sslcacertificatepath">Directive</a></h2>
377 <table class="directive">
378 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
379 Client Auth</td></tr>
380 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCACertificatePath <em>directory-path</em></code></td></tr>
381 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
382 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
383 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
386 This directive sets the directory where you keep the Certificates of
387 Certification Authorities (CAs) whose clients you deal with. These are used to
388 verify the client certificate on Client Authentication.</p>
390 The files in this directory have to be PEM-encoded and are accessed through
391 hash filenames. So usually you can't just place the Certificate files
392 there: you also have to create symbolic links named
393 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
394 contains the appropriate symbolic links.</p>
395 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCACertificatePath /usr/local/apache2/conf/ssl.crt/</pre>
399 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
400 <div class="directive-section"><h2><a name="SSLCADNRequestFile" id="SSLCADNRequestFile">SSLCADNRequestFile</a> <a name="sslcadnrequestfile" id="sslcadnrequestfile">Directive</a></h2>
401 <table class="directive">
402 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
403 for defining acceptable CA names</td></tr>
404 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCADNRequestFile <em>file-path</em></code></td></tr>
405 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
406 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
407 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
409 <p>When a client certificate is requested by mod_ssl, a list of
410 <em>acceptable Certificate Authority names</em> is sent to the client
411 in the SSL handshake. These CA names can be used by the client to
412 select an appropriate client certificate out of those it has
415 <p>If neither of the directives <code class="directive"><a href="#sslcadnrequestpath">SSLCADNRequestPath</a></code> or <code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> are given, then the
416 set of acceptable CA names sent to the client is the names of all the
417 CA certificates given by the <code class="directive"><a href="#sslcacertificatefile">SSLCACertificateFile</a></code> and <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> directives; in other
418 words, the names of the CAs which will actually be used to verify the
419 client certificate.</p>
421 <p>In some circumstances, it is useful to be able to send a set of
422 acceptable CA names which differs from the actual CAs used to verify
423 the client certificate - for example, if the client certificates are
424 signed by intermediate CAs. In such cases, <code class="directive"><a href="#sslcadnrequestpath">SSLCADNRequestPath</a></code> and/or <code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> can be used; the
425 acceptable CA names are then taken from the complete set of
426 certificates in the directory and/or file specified by this pair of
429 <p><code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> must
430 specify an <em>all-in-one</em> file containing a concatenation of
431 PEM-encoded CA certificates.</p>
433 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCADNRequestFile /usr/local/apache2/conf/ca-names.crt</pre>
437 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
438 <div class="directive-section"><h2><a name="SSLCADNRequestPath" id="SSLCADNRequestPath">SSLCADNRequestPath</a> <a name="sslcadnrequestpath" id="sslcadnrequestpath">Directive</a></h2>
439 <table class="directive">
440 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
441 defining acceptable CA names</td></tr>
442 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCADNRequestPath <em>directory-path</em></code></td></tr>
443 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
444 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
445 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
448 <p>This optional directive can be used to specify the set of
449 <em>acceptable CA names</em> which will be sent to the client when a
450 client certificate is requested. See the <code class="directive"><a href="#sslcadnrequestfile">SSLCADNRequestFile</a></code> directive for more
453 <p>The files in this directory have to be PEM-encoded and are accessed
454 through hash filenames. So usually you can't just place the
455 Certificate files there: you also have to create symbolic links named
456 <em>hash-value</em><code>.N</code>. And you should always make sure
457 this directory contains the appropriate symbolic links.</p>
458 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCADNRequestPath /usr/local/apache2/conf/ca-names.crt/</pre>
462 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
463 <div class="directive-section"><h2><a name="SSLCARevocationCheck" id="SSLCARevocationCheck">SSLCARevocationCheck</a> <a name="sslcarevocationcheck" id="sslcarevocationcheck">Directive</a></h2>
464 <table class="directive">
465 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable CRL-based revocation checking</td></tr>
466 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationCheck chain|leaf|none <em>flag</em>s</code></td></tr>
467 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCARevocationCheck none</code></td></tr>
468 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
469 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
470 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
471 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Optional <em>flag</em>s available in httpd 2.5-dev or
475 Enables certificate revocation list (CRL) checking. At least one of
476 <code class="directive"><a href="#sslcarevocationfile">SSLCARevocationFile</a></code>
477 or <code class="directive"><a href="#sslcarevocationpath">SSLCARevocationPath</a></code> must be
478 configured. When set to <code>chain</code> (recommended setting),
479 CRL checks are applied to all certificates in the chain, while setting it to
480 <code>leaf</code> limits the checks to the end-entity cert.
482 <p>The available <em>flag</em>s are:</p>
484 <li><code>no_crl_for_cert_ok</code>
486 Prior to version 2.3.15, CRL checking in mod_ssl also succeeded when
487 no CRL(s) for the checked certificate(s) were found in any of the locations
488 configured with <code class="directive"><a href="#sslcarevocationfile">SSLCARevocationFile</a></code>
489 or <code class="directive"><a href="#sslcarevocationpath">SSLCARevocationPath</a></code>.
492 With the introduction of <code class="directive">SSLCARevocationFile</code>,
493 the behavior has been changed: by default with <code>chain</code> or
494 <code>leaf</code>, CRLs <strong>must</strong> be present for the
495 validation to succeed - otherwise it will fail with an
496 <code>"unable to get certificate CRL"</code> error.
499 The <em>flag</em> <code>no_crl_for_cert_ok</code> allows to restore
504 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCARevocationCheck chain</pre>
506 <div class="example"><h3>Compatibility with versions 2.2</h3><pre class="prettyprint lang-config">SSLCARevocationCheck chain no_crl_for_cert_ok</pre>
510 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
511 <div class="directive-section"><h2><a name="SSLCARevocationFile" id="SSLCARevocationFile">SSLCARevocationFile</a> <a name="sslcarevocationfile" id="sslcarevocationfile">Directive</a></h2>
512 <table class="directive">
513 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA CRLs for
514 Client Auth</td></tr>
515 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationFile <em>file-path</em></code></td></tr>
516 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
517 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
518 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
521 This directive sets the <em>all-in-one</em> file where you can
522 assemble the Certificate Revocation Lists (CRL) of Certification
523 Authorities (CA) whose <em>clients</em> you deal with. These are used
524 for Client Authentication. Such a file is simply the concatenation of
525 the various PEM-encoded CRL files, in order of preference. This can be
526 used alternatively and/or additionally to <code class="directive"><a href="#sslcarevocationpath">SSLCARevocationPath</a></code>.</p>
527 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-client.crl</pre>
531 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
532 <div class="directive-section"><h2><a name="SSLCARevocationPath" id="SSLCARevocationPath">SSLCARevocationPath</a> <a name="sslcarevocationpath" id="sslcarevocationpath">Directive</a></h2>
533 <table class="directive">
534 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA CRLs for
535 Client Auth</td></tr>
536 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationPath <em>directory-path</em></code></td></tr>
537 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
538 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
539 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
542 This directive sets the directory where you keep the Certificate Revocation
543 Lists (CRL) of Certification Authorities (CAs) whose clients you deal with.
544 These are used to revoke the client certificate on Client Authentication.</p>
546 The files in this directory have to be PEM-encoded and are accessed through
547 hash filenames. So usually you have not only to place the CRL files there.
548 Additionally you have to create symbolic links named
549 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
550 contains the appropriate symbolic links.</p>
551 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCARevocationPath /usr/local/apache2/conf/ssl.crl/</pre>
555 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
556 <div class="directive-section"><h2><a name="SSLCertificateChainFile" id="SSLCertificateChainFile">SSLCertificateChainFile</a> <a name="sslcertificatechainfile" id="sslcertificatechainfile">Directive</a></h2>
557 <table class="directive">
558 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of PEM-encoded Server CA Certificates</td></tr>
559 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateChainFile <em>file-path</em></code></td></tr>
560 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
561 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
562 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
564 <div class="note"><h3>SSLCertificateChainFile is deprecated</h3>
565 <p><code>SSLCertificateChainFile</code> became obsolete with version 2.4.8,
566 when <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>
567 was extended to also load intermediate CA certificates from the server
568 certificate file.</p>
572 This directive sets the optional <em>all-in-one</em> file where you can
573 assemble the certificates of Certification Authorities (CA) which form the
574 certificate chain of the server certificate. This starts with the issuing CA
575 certificate of the server certificate and can range up to the root CA
576 certificate. Such a file is simply the concatenation of the various
577 PEM-encoded CA Certificate files, usually in certificate chain order.</p>
579 This should be used alternatively and/or additionally to <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> for explicitly
580 constructing the server certificate chain which is sent to the browser
581 in addition to the server certificate. It is especially useful to
582 avoid conflicts with CA certificates when using client
583 authentication. Because although placing a CA certificate of the
584 server certificate chain into <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> has the same effect
585 for the certificate chain construction, it has the side-effect that
586 client certificates issued by this same CA certificate are also
587 accepted on client authentication.</p>
589 But be careful: Providing the certificate chain works only if you are using a
590 <em>single</em> RSA <em>or</em> DSA based server certificate. If you are
591 using a coupled RSA+DSA certificate pair, this will work only if actually both
592 certificates use the <em>same</em> certificate chain. Else the browsers will be
593 confused in this situation.</p>
594 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCertificateChainFile /usr/local/apache2/conf/ssl.crt/ca.crt</pre>
598 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
599 <div class="directive-section"><h2><a name="SSLCertificateFile" id="SSLCertificateFile">SSLCertificateFile</a> <a name="sslcertificatefile" id="sslcertificatefile">Directive</a></h2>
600 <table class="directive">
601 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Server PEM-encoded X.509 certificate data file</td></tr>
602 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateFile <em>file-path</em></code></td></tr>
603 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
604 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
605 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
608 This directive points to a file with certificate data in PEM format.
609 At a minimum, the file must include an end-entity (leaf) certificate.
610 The directive can be used multiple times (referencing different filenames)
611 to support multiple algorithms for server authentication - typically
612 RSA, DSA, and ECC. The number of supported algorithms depends on the
613 OpenSSL version being used for mod_ssl: with version 1.0.0 or later,
614 <code>openssl list-public-key-algorithms</code> will output a list
615 of supported algorithms, see also the note below about limitations
616 of OpenSSL versions prior to 1.0.2 and the ways to work around them.
620 The files may also include intermediate CA certificates, sorted from
621 leaf to root. This is supported with version 2.4.8 and later,
622 and obsoletes <code class="directive"><a href="#sslcertificatechainfile">SSLCertificateChainFile</a></code>.
623 When running with OpenSSL 1.0.2 or later, this allows
624 to configure the intermediate CA chain on a per-certificate basis.
628 Custom DH parameters and an EC curve name for ephemeral keys,
629 can also be added to end of the first file configured using
630 <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>.
631 This is supported in version 2.4.7 or later.
632 Such parameters can be generated using the commands
633 <code>openssl dhparam</code> and <code>openssl ecparam</code>.
634 The parameters can be added as-is to the end of the first
635 certificate file. Only the first file can be used for custom
636 parameters, as they are applied independently of the authentication
641 Finally the end-entity certificate's private key can also be
642 added to the certificate file instead of using a separate
643 <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>
644 directive. This practice is highly discouraged. If it is used,
645 the certificate files using such an embedded key must be configured
646 after the certificates using a separate key file. If the private
647 key is encrypted, the pass phrase dialog is forced at startup time.
651 <h3>DH parameter interoperability with primes > 1024 bit</h3>
653 Beginning with version 2.4.7, mod_ssl makes use of
654 standardized DH parameters with prime lengths of 2048, 3072 and 4096 bits
655 and with additional prime lengths of 6144 and 8192 bits beginning with
657 (from <a href="http://www.ietf.org/rfc/rfc3526.txt">RFC 3526</a>), and hands
658 them out to clients based on the length of the certificate's RSA/DSA key.
659 With Java-based clients in particular (Java 7 or earlier), this may lead
660 to handshake failures - see this
661 <a href="../ssl/ssl_faq.html#javadh">FAQ answer</a> for working around
667 <h3>Default DH parameters when using multiple certificates and OpenSSL
668 versions prior to 1.0.2</h3>
670 When using multiple certificates to support different authentication algorithms
671 (like RSA, DSA, but mainly ECC) and OpenSSL prior to 1.0.2, it is recommended
672 to either use custom DH parameters (preferably) by adding them to the
673 first certificate file (as described above), or to order the
674 <code class="directive">SSLCertificateFile</code> directives such that RSA/DSA
675 certificates are placed <strong>after</strong> the ECC one.
678 This is due to a limitation in older versions of OpenSSL which don't let the
679 Apache HTTP Server determine the currently selected certificate at handshake
680 time (when the DH parameters must be sent to the peer) but instead always
681 provide the last configured certificate. Consequently, the server may select
682 default DH parameters based on the length of the wrong certificate's key (ECC
683 keys are much smaller than RSA/DSA ones and their length is not relevant for
684 selecting DH primes).
687 Since custom DH parameters always take precedence over the default ones, this
688 issue can be avoided by creating and configuring them (as described above),
689 thus using a custom/suitable length.
693 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCertificateFile /usr/local/apache2/conf/ssl.crt/server.crt</pre>
697 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
698 <div class="directive-section"><h2><a name="SSLCertificateKeyFile" id="SSLCertificateKeyFile">SSLCertificateKeyFile</a> <a name="sslcertificatekeyfile" id="sslcertificatekeyfile">Directive</a></h2>
699 <table class="directive">
700 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Server PEM-encoded private key file</td></tr>
701 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateKeyFile <em>file-path</em></code></td></tr>
702 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
703 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
704 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
707 This directive points to the PEM-encoded private key file for the
708 server. If the contained private key is encrypted, the pass phrase
709 dialog is forced at startup time.</p>
712 The directive can be used multiple times (referencing different filenames)
713 to support multiple algorithms for server authentication. For each
714 <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>
715 directive, there must be a matching <code class="directive">SSLCertificateFile</code>
719 The private key may also be combined with the certificate in the file given by
720 <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>, but this practice
721 is highly discouraged. If it is used, the certificate files using such
722 an embedded key must be configured after the certificates using a separate
725 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCertificateKeyFile /usr/local/apache2/conf/ssl.key/server.key</pre>
729 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
730 <div class="directive-section"><h2><a name="SSLCipherSuite" id="SSLCipherSuite">SSLCipherSuite</a> <a name="sslciphersuite" id="sslciphersuite">Directive</a></h2>
731 <table class="directive">
732 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cipher Suite available for negotiation in SSL
734 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCipherSuite <em>cipher-spec</em></code></td></tr>
735 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCipherSuite DEFAULT (depends on OpenSSL version)</code></td></tr>
736 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
737 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
738 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
739 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
742 This complex directive uses a colon-separated <em>cipher-spec</em> string
743 consisting of OpenSSL cipher specifications to configure the Cipher Suite the
744 client is permitted to negotiate in the SSL handshake phase. Notice that this
745 directive can be used both in per-server and per-directory context. In
746 per-server context it applies to the standard SSL handshake when a connection
747 is established. In per-directory context it forces a SSL renegotiation with the
748 reconfigured Cipher Suite after the HTTP request was read but before the HTTP
749 response is sent.</p>
751 An SSL cipher specification in <em>cipher-spec</em> is composed of 4 major
752 attributes plus a few extra minor ones:</p>
754 <li><em>Key Exchange Algorithm</em>:<br />
755 RSA, Diffie-Hellman, Elliptic Curve Diffie-Hellman, Secure Remote Password
757 <li><em>Authentication Algorithm</em>:<br />
758 RSA, Diffie-Hellman, DSS, ECDSA, or none.
760 <li><em>Cipher/Encryption Algorithm</em>:<br />
761 AES, DES, Triple-DES, RC4, RC2, IDEA, etc.
763 <li><em>MAC Digest Algorithm</em>:<br />
764 MD5, SHA or SHA1, SHA256, SHA384.
767 <p>An SSL cipher can also be an export cipher. SSLv2 ciphers are no longer
768 supported. To specify which ciphers to use, one can either specify all the
769 Ciphers, one at a time, or use aliases to specify the preference and order
770 for the ciphers (see <a href="#table1">Table
771 1</a>). The actually available ciphers and aliases depends on the used
772 openssl version. Newer openssl versions may include additional ciphers.</p>
774 <table class="bordered">
776 <tr><th><a name="table1">Tag</a></th> <th>Description</th></tr>
777 <tr><td colspan="2"><em>Key Exchange Algorithm:</em></td></tr>
778 <tr><td><code>kRSA</code></td> <td>RSA key exchange</td></tr>
779 <tr><td><code>kDHr</code></td> <td>Diffie-Hellman key exchange with RSA key</td></tr>
780 <tr><td><code>kDHd</code></td> <td>Diffie-Hellman key exchange with DSA key</td></tr>
781 <tr><td><code>kEDH</code></td> <td>Ephemeral (temp.key) Diffie-Hellman key exchange (no cert)</td> </tr>
782 <tr><td><code>kSRP</code></td> <td>Secure Remote Password (SRP) key exchange</td></tr>
783 <tr><td colspan="2"><em>Authentication Algorithm:</em></td></tr>
784 <tr><td><code>aNULL</code></td> <td>No authentication</td></tr>
785 <tr><td><code>aRSA</code></td> <td>RSA authentication</td></tr>
786 <tr><td><code>aDSS</code></td> <td>DSS authentication</td> </tr>
787 <tr><td><code>aDH</code></td> <td>Diffie-Hellman authentication</td></tr>
788 <tr><td colspan="2"><em>Cipher Encoding Algorithm:</em></td></tr>
789 <tr><td><code>eNULL</code></td> <td>No encryption</td> </tr>
790 <tr><td><code>NULL</code></td> <td>alias for eNULL</td> </tr>
791 <tr><td><code>AES</code></td> <td>AES encryption</td> </tr>
792 <tr><td><code>DES</code></td> <td>DES encryption</td> </tr>
793 <tr><td><code>3DES</code></td> <td>Triple-DES encryption</td> </tr>
794 <tr><td><code>RC4</code></td> <td>RC4 encryption</td> </tr>
795 <tr><td><code>RC2</code></td> <td>RC2 encryption</td> </tr>
796 <tr><td><code>IDEA</code></td> <td>IDEA encryption</td> </tr>
797 <tr><td colspan="2"><em>MAC Digest Algorithm</em>:</td></tr>
798 <tr><td><code>MD5</code></td> <td>MD5 hash function</td></tr>
799 <tr><td><code>SHA1</code></td> <td>SHA1 hash function</td></tr>
800 <tr><td><code>SHA</code></td> <td>alias for SHA1</td> </tr>
801 <tr><td><code>SHA256</code></td> <td>SHA256 hash function</td> </tr>
802 <tr><td><code>SHA384</code></td> <td>SHA384 hash function</td> </tr>
803 <tr><td colspan="2"><em>Aliases:</em></td></tr>
804 <tr><td><code>SSLv3</code></td> <td>all SSL version 3.0 ciphers</td> </tr>
805 <tr><td><code>TLSv1</code></td> <td>all TLS version 1.0 ciphers</td> </tr>
806 <tr><td><code>EXP</code></td> <td>all export ciphers</td> </tr>
807 <tr><td><code>EXPORT40</code></td> <td>all 40-bit export ciphers only</td> </tr>
808 <tr><td><code>EXPORT56</code></td> <td>all 56-bit export ciphers only</td> </tr>
809 <tr><td><code>LOW</code></td> <td>all low strength ciphers (no export, single DES)</td></tr>
810 <tr><td><code>MEDIUM</code></td> <td>all ciphers with 128 bit encryption</td> </tr>
811 <tr><td><code>HIGH</code></td> <td>all ciphers using Triple-DES</td> </tr>
812 <tr><td><code>RSA</code></td> <td>all ciphers using RSA key exchange</td> </tr>
813 <tr><td><code>DH</code></td> <td>all ciphers using Diffie-Hellman key exchange</td> </tr>
814 <tr><td><code>EDH</code></td> <td>all ciphers using Ephemeral Diffie-Hellman key exchange</td> </tr>
815 <tr><td><code>ECDH</code></td> <td>Elliptic Curve Diffie-Hellman key exchange</td> </tr>
816 <tr><td><code>ADH</code></td> <td>all ciphers using Anonymous Diffie-Hellman key exchange</td> </tr>
817 <tr><td><code>AECDH</code></td> <td>all ciphers using Anonymous Elliptic Curve Diffie-Hellman key exchange</td> </tr>
818 <tr><td><code>SRP</code></td> <td>all ciphers using Secure Remote Password (SRP) key exchange</td> </tr>
819 <tr><td><code>DSS</code></td> <td>all ciphers using DSS authentication</td> </tr>
820 <tr><td><code>ECDSA</code></td> <td>all ciphers using ECDSA authentication</td> </tr>
821 <tr><td><code>aNULL</code></td> <td>all ciphers using no authentication</td> </tr>
824 Now where this becomes interesting is that these can be put together
825 to specify the order and ciphers you wish to use. To speed this up
826 there are also aliases (<code>SSLv3, TLSv1, EXP, LOW, MEDIUM,
827 HIGH</code>) for certain groups of ciphers. These tags can be joined
828 together with prefixes to form the <em>cipher-spec</em>. Available
831 <li>none: add cipher to list</li>
832 <li><code>+</code>: move matching ciphers to the current location in list</li>
833 <li><code>-</code>: remove cipher from list (can be added later again)</li>
834 <li><code>!</code>: kill cipher from list completely (can <strong>not</strong> be added later again)</li>
838 <h3><code>aNULL</code>, <code>eNULL</code> and <code>EXP</code>
839 ciphers are always disabled</h3>
840 <p>Beginning with version 2.4.7, null and export-grade
841 ciphers are always disabled, as mod_ssl unconditionally adds
842 <code>!aNULL:!eNULL:!EXP</code> to any cipher string at initialization.</p>
845 <p>A simpler way to look at all of this is to use the ``<code>openssl ciphers
846 -v</code>'' command which provides a nice way to successively create the
847 correct <em>cipher-spec</em> string. The default <em>cipher-spec</em> string
848 depends on the version of the OpenSSL libraries used. Let's suppose it is
849 ``<code>RC4-SHA:AES128-SHA:HIGH:MEDIUM:!aNULL:!MD5</code>'' which
850 means the following: Put <code>RC4-SHA</code> and <code>AES128-SHA</code> at
851 the beginning. We do this, because these ciphers offer a good compromise
852 between speed and security. Next, include high and medium security ciphers.
853 Finally, remove all ciphers which do not authenticate, i.e. for SSL the
854 Anonymous Diffie-Hellman ciphers, as well as all ciphers which use
855 <code>MD5</code> as hash algorithm, because it has been proven insufficient.</p>
856 <div class="example"><pre>$ openssl ciphers -v 'RC4-SHA:AES128-SHA:HIGH:MEDIUM:!aNULL:!MD5'
857 RC4-SHA SSLv3 Kx=RSA Au=RSA Enc=RC4(128) Mac=SHA1
858 AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
859 DHE-RSA-AES256-SHA SSLv3 Kx=DH Au=RSA Enc=AES(256) Mac=SHA1
861 SEED-SHA SSLv3 Kx=RSA Au=RSA Enc=SEED(128) Mac=SHA1
862 PSK-RC4-SHA SSLv3 Kx=PSK Au=PSK Enc=RC4(128) Mac=SHA1
863 KRB5-RC4-SHA SSLv3 Kx=KRB5 Au=KRB5 Enc=RC4(128) Mac=SHA1</pre></div>
864 <p>The complete list of particular RSA & DH ciphers for SSL is given in <a href="#table2">Table 2</a>.</p>
865 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLCipherSuite RSA:!EXP:!NULL:+HIGH:+MEDIUM:-LOW</pre>
867 <table class="bordered">
869 <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>
870 <tr><td colspan="7"><em>RSA Ciphers:</em></td></tr>
871 <tr><td><code>DES-CBC3-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>3DES(168)</td> <td>SHA1</td> <td /> </tr>
872 <tr><td><code>IDEA-CBC-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>IDEA(128)</td> <td>SHA1</td> <td /> </tr>
873 <tr><td><code>RC4-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>RC4(128)</td> <td>SHA1</td> <td /> </tr>
874 <tr><td><code>RC4-MD5</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>RC4(128)</td> <td>MD5</td> <td /> </tr>
875 <tr><td><code>DES-CBC-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>DES(56)</td> <td>SHA1</td> <td /> </tr>
876 <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>
877 <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>
878 <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>
879 <tr><td><code>NULL-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>None</td> <td>SHA1</td> <td /> </tr>
880 <tr><td><code>NULL-MD5</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>None</td> <td>MD5</td> <td /> </tr>
881 <tr><td colspan="7"><em>Diffie-Hellman Ciphers:</em></td></tr>
882 <tr><td><code>ADH-DES-CBC3-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>None</td> <td>3DES(168)</td> <td>SHA1</td> <td /> </tr>
883 <tr><td><code>ADH-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>None</td> <td>DES(56)</td> <td>SHA1</td> <td /> </tr>
884 <tr><td><code>ADH-RC4-MD5</code></td> <td>SSLv3</td> <td>DH</td> <td>None</td> <td>RC4(128)</td> <td>MD5</td> <td /> </tr>
885 <tr><td><code>EDH-RSA-DES-CBC3-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>RSA</td> <td>3DES(168)</td> <td>SHA1</td> <td /> </tr>
886 <tr><td><code>EDH-DSS-DES-CBC3-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>DSS</td> <td>3DES(168)</td> <td>SHA1</td> <td /> </tr>
887 <tr><td><code>EDH-RSA-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>RSA</td> <td>DES(56)</td> <td>SHA1</td> <td /> </tr>
888 <tr><td><code>EDH-DSS-DES-CBC-SHA</code></td> <td>SSLv3</td> <td>DH</td> <td>DSS</td> <td>DES(56)</td> <td>SHA1</td> <td /> </tr>
889 <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>
890 <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>
891 <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>
892 <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>
896 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
897 <div class="directive-section"><h2><a name="SSLCompression" id="SSLCompression">SSLCompression</a> <a name="sslcompression" id="sslcompression">Directive</a></h2>
898 <table class="directive">
899 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable compression on the SSL level</td></tr>
900 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCompression on|off</code></td></tr>
901 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCompression off</code></td></tr>
902 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
903 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
904 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
905 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.3 and later, if using OpenSSL 0.9.8 or later;
906 virtual host scope available if using OpenSSL 1.0.0 or later.
907 The default used to be <code>on</code> in version 2.4.3.</td></tr>
909 <p>This directive allows to enable compression on the SSL level.</p>
910 <div class="warning">
911 <p>Enabling compression causes security issues in most setups (the so called
916 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
917 <div class="directive-section"><h2><a name="SSLCryptoDevice" id="SSLCryptoDevice">SSLCryptoDevice</a> <a name="sslcryptodevice" id="sslcryptodevice">Directive</a></h2>
918 <table class="directive">
919 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable use of a cryptographic hardware accelerator</td></tr>
920 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCryptoDevice <em>engine</em></code></td></tr>
921 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCryptoDevice builtin</code></td></tr>
922 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
923 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
924 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
927 This directive enables use of a cryptographic hardware accelerator
928 board to offload some of the SSL processing overhead. This directive
929 can only be used if the SSL toolkit is built with "engine" support;
930 OpenSSL 0.9.7 and later releases have "engine" support by default, the
931 separate "-engine" releases of OpenSSL 0.9.6 must be used.</p>
933 <p>To discover which engine names are supported, run the command
934 "<code>openssl engine</code>".</p>
936 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"># For a Broadcom accelerator:
937 SSLCryptoDevice ubsec</pre>
941 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
942 <div class="directive-section"><h2><a name="SSLEngine" id="SSLEngine">SSLEngine</a> <a name="sslengine" id="sslengine">Directive</a></h2>
943 <table class="directive">
944 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL Engine Operation Switch</td></tr>
945 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLEngine on|off|optional</code></td></tr>
946 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLEngine off</code></td></tr>
947 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
948 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
949 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
952 This directive toggles the usage of the SSL/TLS Protocol Engine. This
953 is should be used inside a <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> section to enable SSL/TLS for a
954 that virtual host. By default the SSL/TLS Protocol Engine is
955 disabled for both the main server and all configured virtual hosts.</p>
956 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><VirtualHost _default_:443>
959 </VirtualHost></pre>
961 <p>In Apache 2.1 and later, <code class="directive">SSLEngine</code> can be set to
962 <code>optional</code>. This enables support for
963 <a href="http://www.ietf.org/rfc/rfc2817.txt">RFC 2817</a>, Upgrading to TLS
964 Within HTTP/1.1. At this time no web browsers support RFC 2817.</p>
967 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
968 <div class="directive-section"><h2><a name="SSLFIPS" id="SSLFIPS">SSLFIPS</a> <a name="sslfips" id="sslfips">Directive</a></h2>
969 <table class="directive">
970 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL FIPS mode Switch</td></tr>
971 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLFIPS on|off</code></td></tr>
972 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLFIPS off</code></td></tr>
973 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
974 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
975 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
978 This directive toggles the usage of the SSL library FIPS_mode flag.
979 It must be set in the global server context and cannot be configured
980 with conflicting settings (SSLFIPS on followed by SSLFIPS off or
981 similar). The mode applies to all SSL library operations.
984 If httpd was compiled against an SSL library which did not support
985 the FIPS_mode flag, <code>SSLFIPS on</code> will fail. Refer to the
986 FIPS 140-2 Security Policy document of the SSL provider library for
987 specific requirements to use mod_ssl in a FIPS 140-2 approved mode
988 of operation; note that mod_ssl itself is not validated, but may be
989 described as using FIPS 140-2 validated cryptographic module, when
990 all components are assembled and operated under the guidelines imposed
991 by the applicable Security Policy.
995 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
996 <div class="directive-section"><h2><a name="SSLHonorCipherOrder" id="SSLHonorCipherOrder">SSLHonorCipherOrder</a> <a name="sslhonorcipherorder" id="sslhonorcipherorder">Directive</a></h2>
997 <table class="directive">
998 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Option to prefer the server's cipher preference order</td></tr>
999 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLHonorCipherOrder on|off</code></td></tr>
1000 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLHonorCipherOrder off</code></td></tr>
1001 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1002 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1003 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1005 <p>When choosing a cipher during an SSLv3 or TLSv1 handshake, normally
1006 the client's preference is used. If this directive is enabled, the
1007 server's preference will be used instead.</p>
1008 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLHonorCipherOrder on</pre>
1012 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1013 <div class="directive-section"><h2><a name="SSLInsecureRenegotiation" id="SSLInsecureRenegotiation">SSLInsecureRenegotiation</a> <a name="sslinsecurerenegotiation" id="sslinsecurerenegotiation">Directive</a></h2>
1014 <table class="directive">
1015 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Option to enable support for insecure renegotiation</td></tr>
1016 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLInsecureRenegotiation on|off</code></td></tr>
1017 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLInsecureRenegotiation off</code></td></tr>
1018 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1019 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1020 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1021 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8m or later</td></tr>
1023 <p>As originally specified, all versions of the SSL and TLS protocols
1024 (up to and including TLS/1.2) were vulnerable to a Man-in-the-Middle
1026 (<a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-2009-3555</a>)
1027 during a renegotiation. This vulnerability allowed an attacker to
1028 "prefix" a chosen plaintext to the HTTP request as seen by the web
1029 server. A protocol extension was developed which fixed this
1030 vulnerability if supported by both client and server.</p>
1032 <p>If <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is linked against OpenSSL version 0.9.8m
1033 or later, by default renegotiation is only supported with
1034 clients supporting the new protocol extension. If this directive is
1035 enabled, renegotiation will be allowed with old (unpatched) clients,
1036 albeit insecurely.</p>
1038 <div class="warning"><h3>Security warning</h3>
1039 <p>If this directive is enabled, SSL connections will be vulnerable to
1040 the Man-in-the-Middle prefix attack as described
1041 in <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2009-3555">CVE-2009-3555</a>.</p>
1044 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLInsecureRenegotiation on</pre>
1047 <p>The <code>SSL_SECURE_RENEG</code> environment variable can be used
1048 from an SSI or CGI script to determine whether secure renegotiation is
1049 supported for a given SSL connection.</p>
1053 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1054 <div class="directive-section"><h2><a name="SSLOCSPDefaultResponder" id="SSLOCSPDefaultResponder">SSLOCSPDefaultResponder</a> <a name="sslocspdefaultresponder" id="sslocspdefaultresponder">Directive</a></h2>
1055 <table class="directive">
1056 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the default responder URI for OCSP validation</td></tr>
1057 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSDefaultResponder <em>uri</em></code></td></tr>
1058 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1059 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1060 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1062 <p>This option sets the default OCSP responder to use. If <code class="directive"><a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></code> is not enabled,
1063 the URI given will be used only if no responder URI is specified in
1064 the certificate being verified.</p>
1067 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1068 <div class="directive-section"><h2><a name="SSLOCSPEnable" id="SSLOCSPEnable">SSLOCSPEnable</a> <a name="sslocspenable" id="sslocspenable">Directive</a></h2>
1069 <table class="directive">
1070 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable OCSP validation of the client certificate chain</td></tr>
1071 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPEnable on|off</code></td></tr>
1072 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPEnable off</code></td></tr>
1073 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1074 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1075 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1077 <p>This option enables OCSP validation of the client certificate
1078 chain. If this option is enabled, certificates in the client's
1079 certificate chain will be validated against an OCSP responder after
1080 normal verification (including CRL checks) have taken place.</p>
1082 <p>The OCSP responder used is either extracted from the certificate
1083 itself, or derived by configuration; see the
1084 <code class="directive"><a href="#sslocspdefaultresponder">SSLOCSPDefaultResponder</a></code> and
1085 <code class="directive"><a href="#sslocspoverrideresponder">SSLOCSPOverrideResponder</a></code>
1088 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLVerifyClient on
1090 SSLOCSPDefaultResponder http://responder.example.com:8888/responder
1091 SSLOCSPOverrideResponder on</pre>
1095 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1096 <div class="directive-section"><h2><a name="SSLOCSPOverrideResponder" id="SSLOCSPOverrideResponder">SSLOCSPOverrideResponder</a> <a name="sslocspoverrideresponder" id="sslocspoverrideresponder">Directive</a></h2>
1097 <table class="directive">
1098 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Force use of the default responder URI for OCSP validation</td></tr>
1099 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPOverrideResponder on|off</code></td></tr>
1100 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPOverrideResponder off</code></td></tr>
1101 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1102 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1103 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1105 <p>This option forces the configured default OCSP responder to be used
1106 during OCSP certificate validation, regardless of whether the
1107 certificate being validated references an OCSP responder.</p>
1110 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1111 <div class="directive-section"><h2><a name="SSLOCSPProxyURL" id="SSLOCSPProxyURL">SSLOCSPProxyURL</a> <a name="sslocspproxyurl" id="sslocspproxyurl">Directive</a></h2>
1112 <table class="directive">
1113 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Proxy URL to use for OCSP requests</td></tr>
1114 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPProxyURL <em>url</em></code></td></tr>
1115 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1116 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1117 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1118 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.19 and later</td></tr>
1120 <p>This option allows to set the URL of a HTTP proxy that should be used for
1121 all queries to OCSP responders.</p>
1124 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1125 <div class="directive-section"><h2><a name="SSLOCSPResponderTimeout" id="SSLOCSPResponderTimeout">SSLOCSPResponderTimeout</a> <a name="sslocsprespondertimeout" id="sslocsprespondertimeout">Directive</a></h2>
1126 <table class="directive">
1127 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Timeout for OCSP queries</td></tr>
1128 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPResponderTimeout <em>seconds</em></code></td></tr>
1129 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPResponderTimeout 10</code></td></tr>
1130 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1131 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1132 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1134 <p>This option sets the timeout for queries to OCSP responders, when
1135 <code class="directive"><a href="#sslocspenable">SSLOCSPEnable</a></code> is turned on.</p>
1138 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1139 <div class="directive-section"><h2><a name="SSLOCSPResponseMaxAge" id="SSLOCSPResponseMaxAge">SSLOCSPResponseMaxAge</a> <a name="sslocspresponsemaxage" id="sslocspresponsemaxage">Directive</a></h2>
1140 <table class="directive">
1141 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum allowable age for OCSP responses</td></tr>
1142 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPResponseMaxAge <em>seconds</em></code></td></tr>
1143 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPResponseMaxAge -1</code></td></tr>
1144 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1145 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1146 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1148 <p>This option sets the maximum allowable age ("freshness") for OCSP responses.
1149 The default value (<code>-1</code>) does not enforce a maximum age,
1150 which means that OCSP responses are considered valid as long as their
1151 <code>nextUpdate</code> field is in the future.</p>
1154 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1155 <div class="directive-section"><h2><a name="SSLOCSPResponseTimeSkew" id="SSLOCSPResponseTimeSkew">SSLOCSPResponseTimeSkew</a> <a name="sslocspresponsetimeskew" id="sslocspresponsetimeskew">Directive</a></h2>
1156 <table class="directive">
1157 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum allowable time skew for OCSP response validation</td></tr>
1158 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPResponseTimeSkew <em>seconds</em></code></td></tr>
1159 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPResponseTimeSkew 300</code></td></tr>
1160 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1161 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1162 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1164 <p>This option sets the maximum allowable time skew for OCSP responses
1165 (when checking their <code>thisUpdate</code> and <code>nextUpdate</code> fields).</p>
1168 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1169 <div class="directive-section"><h2><a name="SSLOCSPUseRequestNonce" id="SSLOCSPUseRequestNonce">SSLOCSPUseRequestNonce</a> <a name="sslocspuserequestnonce" id="sslocspuserequestnonce">Directive</a></h2>
1170 <table class="directive">
1171 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use a nonce within OCSP queries</td></tr>
1172 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOCSPUseRequestNonce on|off</code></td></tr>
1173 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLOCSPUseRequestNonce on</code></td></tr>
1174 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1175 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1176 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1177 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.10 and later</td></tr>
1179 <p>This option determines whether queries to OCSP responders should contain
1180 a nonce or not. By default, a query nonce is always used and checked against
1181 the response's one. When the responder does not use nonces (e.g. Microsoft OCSP
1182 Responder), this option should be turned <code>off</code>.</p>
1185 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1186 <div class="directive-section"><h2><a name="SSLOpenSSLConfCmd" id="SSLOpenSSLConfCmd">SSLOpenSSLConfCmd</a> <a name="sslopensslconfcmd" id="sslopensslconfcmd">Directive</a></h2>
1187 <table class="directive">
1188 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure OpenSSL parameters through its <em>SSL_CONF</em> API</td></tr>
1189 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOpenSSLConfCmd <em>command-name</em> <em>command-value</em></code></td></tr>
1190 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1191 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1192 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1193 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.8 and later, if using OpenSSL 1.0.2 or later</td></tr>
1195 <p>This directive exposes OpenSSL's <em>SSL_CONF</em> API to mod_ssl,
1196 allowing a flexible configuration of OpenSSL parameters without the need
1197 of implementing additional <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> directives when new
1198 features are added to OpenSSL.</p>
1200 <p>The set of available <code class="directive">SSLOpenSSLConfCmd</code> commands
1201 depends on the OpenSSL version being used for <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
1202 (at least version 1.0.2 is required). For a list of supported command
1203 names, see the section <em>Supported configuration file commands</em> in the
1204 <a href="http://www.openssl.org/docs/man1.0.2/ssl/SSL_CONF_cmd.html#SUPPORTED-CONFIGURATION-FILE-COMMANDS">SSL_CONF_cmd(3)</a> manual page for OpenSSL.</p>
1206 <p>Some of the <code class="directive">SSLOpenSSLConfCmd</code> commands can be used
1207 as an alternative to existing directives (such as
1208 <code class="directive"><a href="#sslciphersuite">SSLCipherSuite</a></code> or
1209 <code class="directive"><a href="#sslprotocol">SSLProtocol</a></code>),
1210 though it should be noted that the syntax / allowable values for the parameters
1211 may sometimes differ.</p>
1213 <div class="example"><h3>Examples</h3><pre class="prettyprint lang-config">SSLOpenSSLConfCmd Options -SessionTicket,ServerPreference
1214 SSLOpenSSLConfCmd ECDHParameters brainpoolP256r1
1215 SSLOpenSSLConfCmd ServerInfoFile /usr/local/apache2/conf/server-info.pem
1216 SSLOpenSSLConfCmd Protocol "-ALL, TLSv1.2"
1217 SSLOpenSSLConfCmd SignatureAlgorithms RSA+SHA384:ECDSA+SHA256</pre>
1221 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1222 <div class="directive-section"><h2><a name="SSLOptions" id="SSLOptions">SSLOptions</a> <a name="ssloptions" id="ssloptions">Directive</a></h2>
1223 <table class="directive">
1224 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure various SSL engine run-time options</td></tr>
1225 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOptions [+|-]<em>option</em> ...</code></td></tr>
1226 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1227 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
1228 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1229 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1232 This directive can be used to control various run-time options on a
1233 per-directory basis. Normally, if multiple <code>SSLOptions</code>
1234 could apply to a directory, then the most specific one is taken
1235 completely; the options are not merged. However if <em>all</em> the
1236 options on the <code>SSLOptions</code> directive are preceded by a
1237 plus (<code>+</code>) or minus (<code>-</code>) symbol, the options
1238 are merged. Any options preceded by a <code>+</code> are added to the
1239 options currently in force, and any options preceded by a
1240 <code>-</code> are removed from the options currently in force.</p>
1242 The available <em>option</em>s are:</p>
1244 <li><code>StdEnvVars</code>
1246 When this option is enabled, the standard set of SSL related CGI/SSI
1247 environment variables are created. This per default is disabled for
1248 performance reasons, because the information extraction step is a
1249 rather expensive operation. So one usually enables this option for
1250 CGI and SSI requests only.</p>
1252 <li><code>ExportCertData</code>
1254 When this option is enabled, additional CGI/SSI environment variables are
1255 created: <code>SSL_SERVER_CERT</code>, <code>SSL_CLIENT_CERT</code> and
1256 <code>SSL_CLIENT_CERT_CHAIN_</code><em>n</em> (with <em>n</em> = 0,1,2,..).
1257 These contain the PEM-encoded X.509 Certificates of server and client for
1258 the current HTTPS connection and can be used by CGI scripts for deeper
1259 Certificate checking. Additionally all other certificates of the client
1260 certificate chain are provided, too. This bloats up the environment a
1261 little bit which is why you have to use this option to enable it on
1264 <li><code>FakeBasicAuth</code>
1266 When this option is enabled, the Subject Distinguished Name (DN) of the
1267 Client X509 Certificate is translated into a HTTP Basic Authorization
1268 username. This means that the standard Apache authentication methods can
1269 be used for access control. The user name is just the Subject of the
1270 Client's X509 Certificate (can be determined by running OpenSSL's
1271 <code>openssl x509</code> command: <code>openssl x509 -noout -subject -in
1272 </code><em>certificate</em><code>.crt</code>). The optional <code class="directive"><a href="#sslusername">SSLUserName</a></code> directive can be used to
1273 specify which part of the certificate Subject is embedded in the username.
1274 Note that no password is obtained from the user. Every entry in the user
1275 file needs this password: ``<code>xxj31ZMTZzkVA</code>'', which is the
1276 DES-encrypted version of the word `<code>password</code>''. Those who
1277 live under MD5-based encryption (for instance under FreeBSD or BSD/OS,
1278 etc.) should use the following MD5 hash of the same word:
1279 ``<code>$1$OXLyS...$Owx8s2/m9/gfkcRVXzgoE/</code>''.</p>
1281 <p>Note that the <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicfake">AuthBasicFake</a></code>
1282 directive within <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> can be used as a more
1283 general mechanism for faking basic authentication, giving control over the
1284 structure of both the username and password.</p>
1286 <li><code>StrictRequire</code>
1288 This <em>forces</em> forbidden access when <code>SSLRequireSSL</code> or
1289 <code>SSLRequire</code> successfully decided that access should be
1290 forbidden. Usually the default is that in the case where a ``<code>Satisfy
1291 any</code>'' directive is used, and other access restrictions are passed,
1292 denial of access due to <code>SSLRequireSSL</code> or
1293 <code>SSLRequire</code> is overridden (because that's how the Apache
1294 <code>Satisfy</code> mechanism should work.) But for strict access restriction
1295 you can use <code>SSLRequireSSL</code> and/or <code>SSLRequire</code> in
1296 combination with an ``<code>SSLOptions +StrictRequire</code>''. Then an
1297 additional ``<code>Satisfy Any</code>'' has no chance once mod_ssl has
1298 decided to deny access.</p>
1300 <li><code>OptRenegotiate</code>
1302 This enables optimized SSL connection renegotiation handling when SSL
1303 directives are used in per-directory context. By default a strict
1304 scheme is enabled where <em>every</em> per-directory reconfiguration of
1305 SSL parameters causes a <em>full</em> SSL renegotiation handshake. When this
1306 option is used mod_ssl tries to avoid unnecessary handshakes by doing more
1307 granular (but still safe) parameter checks. Nevertheless these granular
1308 checks sometimes may not be what the user expects, so enable this on a
1309 per-directory basis only, please.</p>
1311 <li><code>LegacyDNStringFormat</code>
1313 This option influences how values of the
1314 <code>SSL_{CLIENT,SERVER}_{I,S}_DN</code> variables are formatted. Since
1315 version 2.3.11, Apache HTTPD uses a RFC 2253 compatible format by
1316 default. This uses commas as delimiters between the attributes, allows the
1317 use of non-ASCII characters (which are converted to UTF8), escapes
1318 various special characters with backslashes, and sorts the attributes
1319 with the "C" attribute last.</p>
1321 <p>If <code>LegacyDNStringFormat</code> is set, the old format will be
1322 used which sorts the "C" attribute first, uses slashes as separators, and
1323 does not handle non-ASCII and special characters in any consistent way.
1327 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLOptions +FakeBasicAuth -StrictRequire
1328 <Files ~ "\.(cgi|shtml)$">
1329 SSLOptions +StdEnvVars -ExportCertData
1330 </Files></pre>
1334 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1335 <div class="directive-section"><h2><a name="SSLPassPhraseDialog" id="SSLPassPhraseDialog">SSLPassPhraseDialog</a> <a name="sslpassphrasedialog" id="sslpassphrasedialog">Directive</a></h2>
1336 <table class="directive">
1337 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of pass phrase dialog for encrypted private
1339 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLPassPhraseDialog <em>type</em></code></td></tr>
1340 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLPassPhraseDialog builtin</code></td></tr>
1341 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1342 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1343 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1346 When Apache starts up it has to read the various Certificate (see
1347 <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>) and
1348 Private Key (see <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>) files of the
1349 SSL-enabled virtual servers. Because for security reasons the Private
1350 Key files are usually encrypted, mod_ssl needs to query the
1351 administrator for a Pass Phrase in order to decrypt those files. This
1352 query can be done in two ways which can be configured by
1355 <li><code>builtin</code>
1357 This is the default where an interactive terminal dialog occurs at startup
1358 time just before Apache detaches from the terminal. Here the administrator
1359 has to manually enter the Pass Phrase for each encrypted Private Key file.
1360 Because a lot of SSL-enabled virtual hosts can be configured, the
1361 following reuse-scheme is used to minimize the dialog: When a Private Key
1362 file is encrypted, all known Pass Phrases (at the beginning there are
1363 none, of course) are tried. If one of those known Pass Phrases succeeds no
1364 dialog pops up for this particular Private Key file. If none succeeded,
1365 another Pass Phrase is queried on the terminal and remembered for the next
1366 round (where it perhaps can be reused).</p>
1368 This scheme allows mod_ssl to be maximally flexible (because for N encrypted
1369 Private Key files you <em>can</em> use N different Pass Phrases - but then
1370 you have to enter all of them, of course) while minimizing the terminal
1371 dialog (i.e. when you use a single Pass Phrase for all N Private Key files
1372 this Pass Phrase is queried only once).</p></li>
1374 <li><code>|/path/to/program [args...]</code>
1376 <p>This mode allows an external program to be used which acts as a
1377 pipe to a particular input device; the program is sent the standard
1378 prompt text used for the <code>builtin</code> mode on
1379 <code>stdin</code>, and is expected to write password strings on
1380 <code>stdout</code>. If several passwords are needed (or an
1381 incorrect password is entered), additional prompt text will be
1382 written subsequent to the first password being returned, and more
1383 passwords must then be written back.</p></li>
1385 <li><code>exec:/path/to/program</code>
1387 Here an external program is configured which is called at startup for each
1388 encrypted Private Key file. It is called with one argument, a string of the
1389 form ``<code>servername:portnumber:index</code>'' (with <code>index</code>
1390 being a zero-based sequence number), which indicates for which server,
1391 TCP port and certificate number it has to print the corresponding
1392 Pass Phrase to <code>stdout</code>. The intent is that this external
1393 program first runs security checks to make sure that the system is not
1394 compromised by an attacker, and only when these checks were passed
1395 successfully it provides the Pass Phrase.</p>
1397 Both these security checks, and the way the Pass Phrase is determined, can
1398 be as complex as you like. Mod_ssl just defines the interface: an
1399 executable program which provides the Pass Phrase on <code>stdout</code>.
1400 Nothing more or less! So, if you're really paranoid about security, here
1401 is your interface. Anything else has to be left as an exercise to the
1402 administrator, because local security requirements are so different.</p>
1404 The reuse-algorithm above is used here, too. In other words: The external
1405 program is called only once per unique Pass Phrase.</p></li>
1407 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLPassPhraseDialog exec:/usr/local/apache/sbin/pp-filter</pre>
1411 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1412 <div class="directive-section"><h2><a name="SSLProtocol" id="SSLProtocol">SSLProtocol</a> <a name="sslprotocol" id="sslprotocol">Directive</a></h2>
1413 <table class="directive">
1414 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure usable SSL/TLS protocol versions</td></tr>
1415 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProtocol [+|-]<em>protocol</em> ...</code></td></tr>
1416 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProtocol all -SSLv3</code></td></tr>
1417 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1418 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1419 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1422 This directive can be used to control which versions of the SSL/TLS protocol
1423 will be accepted in new connections.</p>
1425 The available (case-insensitive) <em>protocol</em>s are:</p>
1427 <li><code>SSLv3</code>
1429 This is the Secure Sockets Layer (SSL) protocol, version 3.0, from
1430 the Netscape Corporation.
1431 It is the successor to SSLv2 and the predecessor to TLSv1, but is
1432 deprecated in <a href="http://www.ietf.org/rfc/rfc7568.txt">RFC 7568</a>.</p></li>
1434 <li><code>TLSv1</code>
1436 This is the Transport Layer Security (TLS) protocol, version 1.0.
1437 It is the successor to SSLv3 and is defined in
1438 <a href="http://www.ietf.org/rfc/rfc2246.txt">RFC 2246</a>.
1439 It is supported by nearly every client.</p></li>
1441 <li><code>TLSv1.1</code> (when using OpenSSL 1.0.1 and later)
1443 A revision of the TLS 1.0 protocol, as defined in
1444 <a href="http://www.ietf.org/rfc/rfc4346.txt">RFC 4346</a>.</p></li>
1446 <li><code>TLSv1.2</code> (when using OpenSSL 1.0.1 and later)
1448 A revision of the TLS 1.1 protocol, as defined in
1449 <a href="http://www.ietf.org/rfc/rfc5246.txt">RFC 5246</a>.</p></li>
1451 <li><code>all</code>
1453 This is a shortcut for ``<code>+SSLv3 +TLSv1</code>'' or
1454 - when using OpenSSL 1.0.1 and later -
1455 ``<code>+SSLv3 +TLSv1 +TLSv1.1 +TLSv1.2</code>'', respectively
1456 (except for OpenSSL versions compiled with the ``no-ssl3'' configuration
1457 option, where <code>all</code> does not include <code>+SSLv3</code>).</p></li>
1459 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProtocol TLSv1</pre>
1463 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1464 <div class="directive-section"><h2><a name="SSLProxyCACertificateFile" id="SSLProxyCACertificateFile">SSLProxyCACertificateFile</a> <a name="sslproxycacertificatefile" id="sslproxycacertificatefile">Directive</a></h2>
1465 <table class="directive">
1466 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates
1467 for Remote Server Auth</td></tr>
1468 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCACertificateFile <em>file-path</em></code></td></tr>
1469 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1470 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1471 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1472 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1475 This directive sets the <em>all-in-one</em> file where you can assemble the
1476 Certificates of Certification Authorities (CA) whose <em>remote servers</em> you deal
1477 with. These are used for Remote Server Authentication. Such a file is simply the
1478 concatenation of the various PEM-encoded Certificate files, in order of
1479 preference. This can be used alternatively and/or additionally to
1480 <code class="directive"><a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></code>.</p>
1481 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-remote-server.crt</pre>
1485 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1486 <div class="directive-section"><h2><a name="SSLProxyCACertificatePath" id="SSLProxyCACertificatePath">SSLProxyCACertificatePath</a> <a name="sslproxycacertificatepath" id="sslproxycacertificatepath">Directive</a></h2>
1487 <table class="directive">
1488 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for
1489 Remote Server Auth</td></tr>
1490 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCACertificatePath <em>directory-path</em></code></td></tr>
1491 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1492 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1493 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1494 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1497 This directive sets the directory where you keep the Certificates of
1498 Certification Authorities (CAs) whose remote servers you deal with. These are used to
1499 verify the remote server certificate on Remote Server Authentication.</p>
1501 The files in this directory have to be PEM-encoded and are accessed through
1502 hash filenames. So usually you can't just place the Certificate files
1503 there: you also have to create symbolic links named
1504 <em>hash-value</em><code>.N</code>. And you should always make sure this directory
1505 contains the appropriate symbolic links.</p>
1506 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCACertificatePath /usr/local/apache2/conf/ssl.crt/</pre>
1510 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1511 <div class="directive-section"><h2><a name="SSLProxyCARevocationCheck" id="SSLProxyCARevocationCheck">SSLProxyCARevocationCheck</a> <a name="sslproxycarevocationcheck" id="sslproxycarevocationcheck">Directive</a></h2>
1512 <table class="directive">
1513 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable CRL-based revocation checking for Remote Server Auth</td></tr>
1514 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationCheck chain|leaf|none</code></td></tr>
1515 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCARevocationCheck none</code></td></tr>
1516 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1517 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1518 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1519 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1522 Enables certificate revocation list (CRL) checking for the
1523 <em>remote servers</em> you deal with. At least one of
1524 <code class="directive"><a href="#sslproxycarevocationfile">SSLProxyCARevocationFile</a></code>
1525 or <code class="directive"><a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></code> must be
1526 configured. When set to <code>chain</code> (recommended setting),
1527 CRL checks are applied to all certificates in the chain, while setting it to
1528 <code>leaf</code> limits the checks to the end-entity cert.
1531 <h3>When set to <code>chain</code> or <code>leaf</code>,
1532 CRLs <em>must</em> be available for successful validation</h3>
1534 Prior to version 2.3.15, CRL checking in mod_ssl also succeeded when
1535 no CRL(s) were found in any of the locations configured with
1536 <code class="directive"><a href="#sslproxycarevocationfile">SSLProxyCARevocationFile</a></code>
1537 or <code class="directive"><a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></code>.
1538 With the introduction of this directive, the behavior has been changed:
1539 when checking is enabled, CRLs <em>must</em> be present for the validation
1540 to succeed - otherwise it will fail with an
1541 <code>"unable to get certificate CRL"</code> error.
1544 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCARevocationCheck chain</pre>
1548 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1549 <div class="directive-section"><h2><a name="SSLProxyCARevocationFile" id="SSLProxyCARevocationFile">SSLProxyCARevocationFile</a> <a name="sslproxycarevocationfile" id="sslproxycarevocationfile">Directive</a></h2>
1550 <table class="directive">
1551 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA CRLs for
1552 Remote Server Auth</td></tr>
1553 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationFile <em>file-path</em></code></td></tr>
1554 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1555 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1556 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1557 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1560 This directive sets the <em>all-in-one</em> file where you can
1561 assemble the Certificate Revocation Lists (CRL) of Certification
1562 Authorities (CA) whose <em>remote servers</em> you deal with. These are used
1563 for Remote Server Authentication. Such a file is simply the concatenation of
1564 the various PEM-encoded CRL files, in order of preference. This can be
1565 used alternatively and/or additionally to <code class="directive"><a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></code>.</p>
1566 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-remote-server.crl</pre>
1570 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1571 <div class="directive-section"><h2><a name="SSLProxyCARevocationPath" id="SSLProxyCARevocationPath">SSLProxyCARevocationPath</a> <a name="sslproxycarevocationpath" id="sslproxycarevocationpath">Directive</a></h2>
1572 <table class="directive">
1573 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA CRLs for
1574 Remote Server Auth</td></tr>
1575 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationPath <em>directory-path</em></code></td></tr>
1576 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1577 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1578 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1579 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1582 This directive sets the directory where you keep the Certificate Revocation
1583 Lists (CRL) of Certification Authorities (CAs) whose remote servers you deal with.
1584 These are used to revoke the remote server certificate on Remote Server Authentication.</p>
1586 The files in this directory have to be PEM-encoded and are accessed through
1587 hash filenames. So usually you have not only to place the CRL files there.
1588 Additionally you have to create symbolic links named
1589 <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
1590 contains the appropriate symbolic links.</p>
1591 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCARevocationPath /usr/local/apache2/conf/ssl.crl/</pre>
1595 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1596 <div class="directive-section"><h2><a name="SSLProxyCheckPeerCN" id="SSLProxyCheckPeerCN">SSLProxyCheckPeerCN</a> <a name="sslproxycheckpeercn" id="sslproxycheckpeercn">Directive</a></h2>
1597 <table class="directive">
1598 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether to check the remote server certificate's CN field
1600 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCheckPeerCN on|off</code></td></tr>
1601 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCheckPeerCN on</code></td></tr>
1602 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1603 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1604 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1605 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1608 This directive sets whether the remote server certificate's CN field is
1609 compared against the hostname of the request URL. If both are not equal
1610 a 502 status code (Bad Gateway) is sent. <code>SSLProxyCheckPeerCN</code> is
1611 superseded by <code class="directive"><a href="#sslproxycheckpeername">SSLProxyCheckPeerName</a></code>
1612 in release 2.4.5 and later.
1615 In all releases 2.4.5 through 2.4.20, setting
1616 <code>SSLProxyCheckPeerName off</code> was sufficient to enable this behavior
1617 (as the <code>SSLProxyCheckPeerCN</code> default was <code>on</code>.) In
1618 these releases, both directives must be set to <code>off</code> to completely
1619 avoid remote server certificate name validation. Many users reported this
1620 to be very confusing.
1623 As of release 2.4.21, all configurations which enable either one of the
1624 <code>SSLProxyCheckPeerName</code> or <code>SSLProxyCheckPeerCN</code> options
1625 will use the new <code class="directive"><a href="#sslproxycheckpeername">SSLProxyCheckPeerName</a></code>
1626 behavior, and all configurations which disable either one of the
1627 <code>SSLProxyCheckPeerName</code> or <code>SSLProxyCheckPeerCN</code> options
1628 will supress all remote server certificate name validation. Only the following
1629 configuration will trigger the legacy certificate CN comparison in 2.4.21 and
1632 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCheckPeerCN on
1633 SSLProxyCheckPeerName off</pre>
1637 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1638 <div class="directive-section"><h2><a name="SSLProxyCheckPeerExpire" id="SSLProxyCheckPeerExpire">SSLProxyCheckPeerExpire</a> <a name="sslproxycheckpeerexpire" id="sslproxycheckpeerexpire">Directive</a></h2>
1639 <table class="directive">
1640 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether to check if remote server certificate is expired
1642 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCheckPeerExpire on|off</code></td></tr>
1643 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCheckPeerExpire on</code></td></tr>
1644 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1645 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1646 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1647 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1650 This directive sets whether it is checked if the remote server certificate
1651 is expired or not. If the check fails a 502 status code (Bad Gateway) is
1654 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyCheckPeerExpire on</pre>
1658 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1659 <div class="directive-section"><h2><a name="SSLProxyCheckPeerName" id="SSLProxyCheckPeerName">SSLProxyCheckPeerName</a> <a name="sslproxycheckpeername" id="sslproxycheckpeername">Directive</a></h2>
1660 <table class="directive">
1661 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure host name checking for remote server certificates
1663 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCheckPeerName on|off</code></td></tr>
1664 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCheckPeerName on</code></td></tr>
1665 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1666 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1667 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1668 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1669 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache HTTP Server 2.4.5 and later</td></tr>
1672 This directive configures host name checking for server certificates when
1673 mod_ssl is acting as an SSL client. The check will succeed if the host name
1674 from the request URI matches one of the CN attribute(s) of the certificate's
1675 subject, or matches the subjectAltName extension. If the check fails, the SSL
1676 request is aborted and a 502 status code (Bad Gateway) is returned.
1679 Wildcard matching is supported for specific cases: an subjectAltName entry
1680 of type dNSName, or CN attributes starting with <code>*.</code> will match
1681 with any host name of the same number of name elements and the same suffix.
1682 E.g. <code>*.example.org</code> will match <code>foo.example.org</code>,
1683 but will not match <code>foo.bar.example.org</code>, because the number of
1684 elements in the respective host names differs.
1687 This feature was introduced in 2.4.5 and superseded the behavior of the
1688 <code class="directive"><a href="#sslproxycheckpeercn">SSLProxyCheckPeerCN</a></code> directive, which
1689 only tested the exact value in the first CN attribute against the host name.
1690 However, many users were confused by the behavior of using these directives
1691 individually, so the mutual behavior of <code>SSLProxyCheckPeerName</code>
1692 and <code>SSLProxyCheckPeerCN</code> directives were improved in release
1693 2.4.21. See the <code class="directive"><a href="#sslproxycheckpeercn">SSLProxyCheckPeerCN</a></code>
1694 directive description for the original behavior and details of these
1699 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1700 <div class="directive-section"><h2><a name="SSLProxyCipherSuite" id="SSLProxyCipherSuite">SSLProxyCipherSuite</a> <a name="sslproxyciphersuite" id="sslproxyciphersuite">Directive</a></h2>
1701 <table class="directive">
1702 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cipher Suite available for negotiation in SSL
1703 proxy handshake</td></tr>
1704 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCipherSuite <em>cipher-spec</em></code></td></tr>
1705 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+EXP</code></td></tr>
1706 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1707 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1708 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1709 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1711 <p>Equivalent to <code class="directive"><a href="#sslciphersuite">SSLCipherSuite</a></code>, but
1712 for the proxy connection.
1713 Please refer to <code class="directive"><a href="#sslciphersuite">SSLCipherSuite</a></code>
1714 for additional information.</p>
1717 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1718 <div class="directive-section"><h2><a name="SSLProxyEngine" id="SSLProxyEngine">SSLProxyEngine</a> <a name="sslproxyengine" id="sslproxyengine">Directive</a></h2>
1719 <table class="directive">
1720 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL Proxy Engine Operation Switch</td></tr>
1721 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyEngine on|off</code></td></tr>
1722 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyEngine off</code></td></tr>
1723 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1724 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1725 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1726 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1729 This directive toggles the usage of the SSL/TLS Protocol Engine for proxy. This
1730 is usually used inside a <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> section to enable SSL/TLS for proxy
1731 usage in a particular virtual host. By default the SSL/TLS Protocol Engine is
1732 disabled for proxy both for the main server and all configured virtual hosts.</p>
1734 <p>Note that the <code class="directive">SSLProxyEngine</code> directive should not, in
1735 general, be included in a virtual host that will be acting as a
1736 forward proxy (using <code class="directive"><a href="../mod/mod_proxy.html#proxy"><Proxy></a></code>
1737 or <code class="directive"><a href="../mod/mod_proxy.html#proxyrequests">ProxyRequests</a></code> directives).
1738 <code class="directive">SSLProxyEngine</code> is not required to enable a forward proxy
1739 server to proxy SSL/TLS requests.</p>
1741 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><VirtualHost _default_:443>
1744 </VirtualHost></pre>
1748 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1749 <div class="directive-section"><h2><a name="SSLProxyMachineCertificateChainFile" id="SSLProxyMachineCertificateChainFile">SSLProxyMachineCertificateChainFile</a> <a name="sslproxymachinecertificatechainfile" id="sslproxymachinecertificatechainfile">Directive</a></h2>
1750 <table class="directive">
1751 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA certificates to be used by the proxy for choosing a certificate</td></tr>
1752 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificateChainFile <em>filename</em></code></td></tr>
1753 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1754 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1755 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1756 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1759 This directive sets the all-in-one file where you keep the certificate chain
1760 for all of the client certs in use. This directive will be needed if the
1761 remote server presents a list of CA certificates that are not direct signers
1762 of one of the configured client certificates.
1765 This referenced file is simply the concatenation of the various PEM-encoded
1766 certificate files. Upon startup, each client certificate configured will
1767 be examined and a chain of trust will be constructed.
1769 <div class="warning"><h3>Security warning</h3>
1770 <p>If this directive is enabled, all of the certificates in the file will be
1771 trusted as if they were also in <code class="directive"><a href="#sslproxycacertificatefile">
1772 SSLProxyCACertificateFile</a></code>.</p>
1774 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyMachineCertificateChainFile /usr/local/apache2/conf/ssl.crt/proxyCA.pem</pre>
1778 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1779 <div class="directive-section"><h2><a name="SSLProxyMachineCertificateFile" id="SSLProxyMachineCertificateFile">SSLProxyMachineCertificateFile</a> <a name="sslproxymachinecertificatefile" id="sslproxymachinecertificatefile">Directive</a></h2>
1780 <table class="directive">
1781 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded client certificates and keys to be used by the proxy</td></tr>
1782 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificateFile <em>filename</em></code></td></tr>
1783 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1784 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1785 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1786 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1789 This directive sets the all-in-one file where you keep the certificates and
1790 keys used for authentication of the proxy server to remote servers.
1793 This referenced file is simply the concatenation of the various PEM-encoded
1794 certificate files, in order of preference. Use this directive alternatively
1795 or additionally to <code>SSLProxyMachineCertificatePath</code>.
1797 <div class="warning">
1798 <p>Currently there is no support for encrypted private keys</p>
1800 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyMachineCertificateFile /usr/local/apache2/conf/ssl.crt/proxy.pem</pre>
1804 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1805 <div class="directive-section"><h2><a name="SSLProxyMachineCertificatePath" id="SSLProxyMachineCertificatePath">SSLProxyMachineCertificatePath</a> <a name="sslproxymachinecertificatepath" id="sslproxymachinecertificatepath">Directive</a></h2>
1806 <table class="directive">
1807 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded client certificates and keys to be used by the proxy</td></tr>
1808 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificatePath <em>directory</em></code></td></tr>
1809 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1810 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1811 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1812 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1815 This directive sets the directory where you keep the certificates and
1816 keys used for authentication of the proxy server to remote servers.
1818 <p>The files in this directory must be PEM-encoded and are accessed through
1819 hash filenames. Additionally, you must create symbolic links named
1820 <code><em>hash-value</em>.N</code>. And you should always make sure this
1821 directory contains the appropriate symbolic links.</p>
1822 <div class="warning">
1823 <p>Currently there is no support for encrypted private keys</p>
1825 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyMachineCertificatePath /usr/local/apache2/conf/proxy.crt/</pre>
1829 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1830 <div class="directive-section"><h2><a name="SSLProxyProtocol" id="SSLProxyProtocol">SSLProxyProtocol</a> <a name="sslproxyprotocol" id="sslproxyprotocol">Directive</a></h2>
1831 <table class="directive">
1832 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure usable SSL protocol flavors for proxy usage</td></tr>
1833 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyProtocol [+|-]<em>protocol</em> ...</code></td></tr>
1834 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyProtocol all -SSLv3</code></td></tr>
1835 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1836 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1837 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1838 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1842 This directive can be used to control the SSL protocol flavors mod_ssl should
1843 use when establishing its server environment for proxy . It will only connect
1844 to servers using one of the provided protocols.</p>
1845 <p>Please refer to <code class="directive"><a href="#sslprotocol">SSLProtocol</a></code>
1846 for additional information.
1850 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1851 <div class="directive-section"><h2><a name="SSLProxyVerify" id="SSLProxyVerify">SSLProxyVerify</a> <a name="sslproxyverify" id="sslproxyverify">Directive</a></h2>
1852 <table class="directive">
1853 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of remote server Certificate verification</td></tr>
1854 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyVerify <em>level</em></code></td></tr>
1855 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyVerify none</code></td></tr>
1856 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1857 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1858 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1859 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1862 <p>When a proxy is configured to forward requests to a remote SSL
1863 server, this directive can be used to configure certificate
1864 verification of the remote server. </p>
1866 The following levels are available for <em>level</em>:</p>
1868 <li><strong>none</strong>:
1869 no remote server Certificate is required at all</li>
1870 <li><strong>optional</strong>:
1871 the remote server <em>may</em> present a valid Certificate</li>
1872 <li><strong>require</strong>:
1873 the remote server <em>has to</em> present a valid Certificate</li>
1874 <li><strong>optional_no_ca</strong>:
1875 the remote server may present a valid Certificate<br />
1876 but it need not to be (successfully) verifiable.</li>
1878 <p>In practice only levels <strong>none</strong> and
1879 <strong>require</strong> are really interesting, because level
1880 <strong>optional</strong> doesn't work with all servers and level
1881 <strong>optional_no_ca</strong> is actually against the idea of
1882 authentication (but can be used to establish SSL test pages, etc.)</p>
1883 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyVerify require</pre>
1887 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1888 <div class="directive-section"><h2><a name="SSLProxyVerifyDepth" id="SSLProxyVerifyDepth">SSLProxyVerifyDepth</a> <a name="sslproxyverifydepth" id="sslproxyverifydepth">Directive</a></h2>
1889 <table class="directive">
1890 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum depth of CA Certificates in Remote Server
1891 Certificate verification</td></tr>
1892 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyVerifyDepth <em>number</em></code></td></tr>
1893 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyVerifyDepth 1</code></td></tr>
1894 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, proxy section</td></tr>
1895 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
1896 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1897 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1900 This directive sets how deeply mod_ssl should verify before deciding that the
1901 remote server does not have a valid certificate. </p>
1903 The depth actually is the maximum number of intermediate certificate issuers,
1904 i.e. the number of CA certificates which are max allowed to be followed while
1905 verifying the remote server certificate. A depth of 0 means that self-signed
1906 remote server certificates are accepted only, the default depth of 1 means
1907 the remote server certificate can be self-signed or has to be signed by a CA
1908 which is directly known to the server (i.e. the CA's certificate is under
1909 <code class="directive"><a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></code>), etc.</p>
1910 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLProxyVerifyDepth 10</pre>
1914 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1915 <div class="directive-section"><h2><a name="SSLRandomSeed" id="SSLRandomSeed">SSLRandomSeed</a> <a name="sslrandomseed" id="sslrandomseed">Directive</a></h2>
1916 <table class="directive">
1917 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pseudo Random Number Generator (PRNG) seeding
1919 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRandomSeed <em>context</em> <em>source</em>
1920 [<em>bytes</em>]</code></td></tr>
1921 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1922 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1923 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
1926 This configures one or more sources for seeding the Pseudo Random Number
1927 Generator (PRNG) in OpenSSL at startup time (<em>context</em> is
1928 <code>startup</code>) and/or just before a new SSL connection is established
1929 (<em>context</em> is <code>connect</code>). This directive can only be used
1930 in the global server context because the PRNG is a global facility.</p>
1932 The following <em>source</em> variants are available:</p>
1934 <li><code>builtin</code>
1935 <p> This is the always available builtin seeding source. Its usage
1936 consumes minimum CPU cycles under runtime and hence can be always used
1937 without drawbacks. The source used for seeding the PRNG contains of the
1938 current time, the current process id and (when applicable) a randomly
1939 chosen 1KB extract of the inter-process scoreboard structure of Apache.
1940 The drawback is that this is not really a strong source and at startup
1941 time (where the scoreboard is still not available) this source just
1942 produces a few bytes of entropy. So you should always, at least for the
1943 startup, use an additional seeding source.</p></li>
1944 <li><code>file:/path/to/source</code>
1946 This variant uses an external file <code>/path/to/source</code> as the
1947 source for seeding the PRNG. When <em>bytes</em> is specified, only the
1948 first <em>bytes</em> number of bytes of the file form the entropy (and
1949 <em>bytes</em> is given to <code>/path/to/source</code> as the first
1950 argument). When <em>bytes</em> is not specified the whole file forms the
1951 entropy (and <code>0</code> is given to <code>/path/to/source</code> as
1952 the first argument). Use this especially at startup time, for instance
1953 with an available <code>/dev/random</code> and/or
1954 <code>/dev/urandom</code> devices (which usually exist on modern Unix
1955 derivatives like FreeBSD and Linux).</p>
1957 <em>But be careful</em>: Usually <code>/dev/random</code> provides only as
1958 much entropy data as it actually has, i.e. when you request 512 bytes of
1959 entropy, but the device currently has only 100 bytes available two things
1960 can happen: On some platforms you receive only the 100 bytes while on
1961 other platforms the read blocks until enough bytes are available (which
1962 can take a long time). Here using an existing <code>/dev/urandom</code> is
1963 better, because it never blocks and actually gives the amount of requested
1964 data. The drawback is just that the quality of the received data may not
1965 be the best.</p></li>
1967 <li><code>exec:/path/to/program</code>
1969 This variant uses an external executable
1970 <code>/path/to/program</code> as the source for seeding the
1971 PRNG. When <em>bytes</em> is specified, only the first
1972 <em>bytes</em> number of bytes of its <code>stdout</code> contents
1973 form the entropy. When <em>bytes</em> is not specified, the
1974 entirety of the data produced on <code>stdout</code> form the
1975 entropy. Use this only at startup time when you need a very strong
1976 seeding with the help of an external program (for instance as in
1977 the example above with the <code>truerand</code> utility you can
1978 find in the mod_ssl distribution which is based on the AT&T
1979 <em>truerand</em> library). Using this in the connection context
1980 slows down the server too dramatically, of course. So usually you
1981 should avoid using external programs in that context.</p></li>
1982 <li><code>egd:/path/to/egd-socket</code> (Unix only)
1984 This variant uses the Unix domain socket of the
1985 external Entropy Gathering Daemon (EGD) (see <a href="http://www.lothar.com/tech/crypto/">http://www.lothar.com/tech
1986 /crypto/</a>) to seed the PRNG. Use this if no random device exists
1987 on your platform.</p></li>
1989 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRandomSeed startup builtin
1990 SSLRandomSeed startup file:/dev/random
1991 SSLRandomSeed startup file:/dev/urandom 1024
1992 SSLRandomSeed startup exec:/usr/local/bin/truerand 16
1993 SSLRandomSeed connect builtin
1994 SSLRandomSeed connect file:/dev/random
1995 SSLRandomSeed connect file:/dev/urandom 1024</pre>
1999 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2000 <div class="directive-section"><h2><a name="SSLRenegBufferSize" id="SSLRenegBufferSize">SSLRenegBufferSize</a> <a name="sslrenegbuffersize" id="sslrenegbuffersize">Directive</a></h2>
2001 <table class="directive">
2002 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the size for the SSL renegotiation buffer</td></tr>
2003 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRenegBufferSize <var>bytes</var></code></td></tr>
2004 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLRenegBufferSize 131072</code></td></tr>
2005 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2006 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2007 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2008 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2011 <p>If an SSL renegotiation is required in per-location context, for
2012 example, any use of <code class="directive"><a href="#sslverifyclient">SSLVerifyClient</a></code> in a Directory or
2013 Location block, then <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> must buffer any HTTP
2014 request body into memory until the new SSL handshake can be performed.
2015 This directive can be used to set the amount of memory that will be
2016 used for this buffer. </p>
2018 <div class="warning"><p>
2019 Note that in many configurations, the client sending the request body
2020 will be untrusted so a denial of service attack by consumption of
2021 memory must be considered when changing this configuration setting.
2024 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRenegBufferSize 262144</pre>
2028 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2029 <div class="directive-section"><h2><a name="SSLRequire" id="SSLRequire">SSLRequire</a> <a name="sslrequire" id="sslrequire">Directive</a></h2>
2030 <table class="directive">
2031 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow access only when an arbitrarily complex
2032 boolean expression is true</td></tr>
2033 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRequire <em>expression</em></code></td></tr>
2034 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2035 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2036 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2037 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2040 <div class="note"><h3>SSLRequire is deprecated</h3>
2041 <p><code>SSLRequire</code> is deprecated and should in general be replaced
2042 by <a href="mod_authz_core.html#reqexpr">Require expr</a>. The so called
2043 <a href="../expr.html">ap_expr</a> syntax of <code>Require expr</code> is
2044 a superset of the syntax of <code>SSLRequire</code>, with the following
2047 <p>In <code>SSLRequire</code>, the comparison operators <code><</code>,
2048 <code><=</code>, ... are completely equivalent to the operators
2049 <code>lt</code>, <code>le</code>, ... and work in a somewhat peculiar way that
2050 first compares the length of two strings and then the lexical order.
2051 On the other hand, <a href="../expr.html">ap_expr</a> has two sets of
2052 comparison operators: The operators <code><</code>,
2053 <code><=</code>, ... do lexical string comparison, while the operators
2054 <code>-lt</code>, <code>-le</code>, ... do integer comparison.
2055 For the latter, there are also aliases without the leading dashes:
2056 <code>lt</code>, <code>le</code>, ...
2062 This directive specifies a general access requirement which has to be
2063 fulfilled in order to allow access. It is a very powerful directive because the
2064 requirement specification is an arbitrarily complex boolean expression
2065 containing any number of access checks.</p>
2067 The <em>expression</em> must match the following syntax (given as a BNF
2068 grammar notation):</p>
2070 <pre>expr ::= "<strong>true</strong>" | "<strong>false</strong>"
2071 | "<strong>!</strong>" expr
2072 | expr "<strong>&&</strong>" expr
2073 | expr "<strong>||</strong>" expr
2074 | "<strong>(</strong>" expr "<strong>)</strong>"
2077 comp ::= word "<strong>==</strong>" word | word "<strong>eq</strong>" word
2078 | word "<strong>!=</strong>" word | word "<strong>ne</strong>" word
2079 | word "<strong><</strong>" word | word "<strong>lt</strong>" word
2080 | word "<strong><=</strong>" word | word "<strong>le</strong>" word
2081 | word "<strong>></strong>" word | word "<strong>gt</strong>" word
2082 | word "<strong>>=</strong>" word | word "<strong>ge</strong>" word
2083 | word "<strong>in</strong>" "<strong>{</strong>" wordlist "<strong>}</strong>"
2084 | word "<strong>in</strong>" "<strong>PeerExtList(</strong>" word "<strong>)</strong>"
2085 | word "<strong>=~</strong>" regex
2086 | word "<strong>!~</strong>" regex
2089 | wordlist "<strong>,</strong>" word
2098 variable ::= "<strong>%{</strong>" varname "<strong>}</strong>"
2099 function ::= funcname "<strong>(</strong>" funcargs "<strong>)</strong>"</pre>
2101 <p>For <code>varname</code> any of the variables described in <a href="#envvars">Environment Variables</a> can be used. For
2102 <code>funcname</code> the available functions are listed in
2103 the <a href="../expr.html#functions">ap_expr documentation</a>.</p>
2105 <p>The <em>expression</em> is parsed into an internal machine
2106 representation when the configuration is loaded, and then evaluated
2107 during request processing. In .htaccess context, the <em>expression</em> is
2108 both parsed and executed each time the .htaccess file is encountered during
2109 request processing.</p>
2111 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRequire ( %{SSL_CIPHER} !~ m/^(EXP|NULL)-/ \
2112 and %{SSL_CLIENT_S_DN_O} eq "Snake Oil, Ltd." \
2113 and %{SSL_CLIENT_S_DN_OU} in {"Staff", "CA", "Dev"} \
2114 and %{TIME_WDAY} -ge 1 and %{TIME_WDAY} -le 5 \
2115 and %{TIME_HOUR} -ge 8 and %{TIME_HOUR} -le 20 ) \
2116 or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/</pre>
2119 <p>The <code>PeerExtList(<em>object-ID</em>)</code> function expects
2120 to find zero or more instances of the X.509 certificate extension
2121 identified by the given <em>object ID</em> (OID) in the client certificate.
2122 The expression evaluates to true if the left-hand side string matches
2123 exactly against the value of an extension identified with this OID.
2124 (If multiple extensions with the same OID are present, at least one
2125 extension must match).</p>
2127 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRequire "foobar" in PeerExtList("1.2.3.4.5.6")</pre>
2130 <div class="note"><h3>Notes on the PeerExtList function</h3>
2134 <li><p>The object ID can be specified either as a descriptive
2135 name recognized by the SSL library, such as <code>"nsComment"</code>,
2136 or as a numeric OID, such as <code>"1.2.3.4.5.6"</code>.</p></li>
2138 <li><p>Expressions with types known to the SSL library are rendered to
2139 a string before comparison. For an extension with a type not
2140 recognized by the SSL library, mod_ssl will parse the value if it is
2141 one of the primitive ASN.1 types UTF8String, IA5String, VisibleString,
2142 or BMPString. For an extension of one of these types, the string
2143 value will be converted to UTF-8 if necessary, then compared against
2144 the left-hand-side expression.</p></li>
2152 <li><a href="../env.html">Environment Variables in Apache HTTP Server</a>,
2153 for additional examples.
2155 <li><a href="mod_authz_core.html#reqexpr">Require expr</a></li>
2156 <li><a href="../expr.html">Generic expression syntax in Apache HTTP Server</a>
2160 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2161 <div class="directive-section"><h2><a name="SSLRequireSSL" id="SSLRequireSSL">SSLRequireSSL</a> <a name="sslrequiressl" id="sslrequiressl">Directive</a></h2>
2162 <table class="directive">
2163 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Deny access when SSL is not used for the
2164 HTTP request</td></tr>
2165 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRequireSSL</code></td></tr>
2166 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2167 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2168 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2169 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2172 This directive forbids access unless HTTP over SSL (i.e. HTTPS) is enabled for
2173 the current connection. This is very handy inside the SSL-enabled virtual
2174 host or directories for defending against configuration errors that expose
2175 stuff that should be protected. When this directive is present all requests
2176 are denied which are not using SSL.</p>
2177 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLRequireSSL</pre>
2181 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2182 <div class="directive-section"><h2><a name="SSLSessionCache" id="SSLSessionCache">SSLSessionCache</a> <a name="sslsessioncache" id="sslsessioncache">Directive</a></h2>
2183 <table class="directive">
2184 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of the global/inter-process SSL Session
2186 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionCache <em>type</em></code></td></tr>
2187 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionCache none</code></td></tr>
2188 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
2189 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2190 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2193 This configures the storage type of the global/inter-process SSL Session
2194 Cache. This cache is an optional facility which speeds up parallel request
2195 processing. For requests to the same server process (via HTTP keep-alive),
2196 OpenSSL already caches the SSL session information locally. But because modern
2197 clients request inlined images and other data via parallel requests (usually
2198 up to four parallel requests are common) those requests are served by
2199 <em>different</em> pre-forked server processes. Here an inter-process cache
2200 helps to avoid unnecessary session handshakes.</p>
2202 The following five storage <em>type</em>s are currently supported:</p>
2204 <li><code>none</code>
2206 <p>This disables the global/inter-process Session Cache. This
2207 will incur a noticeable speed penalty and may cause problems if
2208 using certain browsers, particularly if client certificates are
2209 enabled. This setting is not recommended.</p></li>
2211 <li><code>nonenotnull</code>
2213 <p>This disables any global/inter-process Session Cache. However
2214 it does force OpenSSL to send a non-null session ID to
2215 accommodate buggy clients that require one.</p></li>
2217 <li><code>dbm:/path/to/datafile</code>
2219 <p>This makes use of a DBM hashfile on the local disk to
2220 synchronize the local OpenSSL memory caches of the server
2221 processes. This session cache may suffer reliability issues under
2222 high load. To use this, ensure that
2223 <code class="module"><a href="../mod/mod_socache_dbm.html">mod_socache_dbm</a></code> is loaded.</p></li>
2225 <li><code>shmcb:/path/to/datafile</code>[<code>(</code><em>size</em><code>)</code>]
2227 <p>This makes use of a high-performance cyclic buffer
2228 (approx. <em>size</em> bytes in size) inside a shared memory
2229 segment in RAM (established via <code>/path/to/datafile</code>) to
2230 synchronize the local OpenSSL memory caches of the server
2231 processes. This is the recommended session cache. To use this,
2232 ensure that <code class="module"><a href="../mod/mod_socache_shmcb.html">mod_socache_shmcb</a></code> is loaded.</p></li>
2234 <li><code>dc:UNIX:/path/to/socket</code>
2236 <p>This makes use of the <a href="http://distcache.sourceforge.net/">distcache</a> distributed session
2237 caching libraries. The argument should specify the location of
2238 the server or proxy to be used using the distcache address syntax;
2239 for example, <code>UNIX:/path/to/socket</code> specifies a UNIX
2240 domain socket (typically a local dc_client proxy);
2241 <code>IP:server.example.com:9001</code> specifies an IP
2242 address. To use this, ensure that
2243 <code class="module"><a href="../mod/mod_socache_dc.html">mod_socache_dc</a></code> is loaded.</p></li>
2247 <div class="example"><h3>Examples</h3><pre class="prettyprint lang-config">SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data
2248 SSLSessionCache shmcb:/usr/local/apache/logs/ssl_gcache_data(512000)</pre>
2251 <p>The <code>ssl-cache</code> mutex is used to serialize access to
2252 the session cache to prevent corruption. This mutex can be configured
2253 using the <code class="directive"><a href="../mod/core.html#mutex">Mutex</a></code> directive.</p>
2256 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2257 <div class="directive-section"><h2><a name="SSLSessionCacheTimeout" id="SSLSessionCacheTimeout">SSLSessionCacheTimeout</a> <a name="sslsessioncachetimeout" id="sslsessioncachetimeout">Directive</a></h2>
2258 <table class="directive">
2259 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of seconds before an SSL session expires
2260 in the Session Cache</td></tr>
2261 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionCacheTimeout <em>seconds</em></code></td></tr>
2262 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionCacheTimeout 300</code></td></tr>
2263 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2264 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2265 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2266 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Applies also to RFC 5077 TLS session resumption in Apache 2.4.10 and later</td></tr>
2269 This directive sets the timeout in seconds for the information stored in the
2270 global/inter-process SSL Session Cache, the OpenSSL internal memory cache and
2271 for sessions resumed by TLS session resumption (RFC 5077).
2272 It can be set as low as 15 for testing, but should be set to higher
2273 values like 300 in real life.</p>
2274 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLSessionCacheTimeout 600</pre>
2278 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2279 <div class="directive-section"><h2><a name="SSLSessionTicketKeyFile" id="SSLSessionTicketKeyFile">SSLSessionTicketKeyFile</a> <a name="sslsessionticketkeyfile" id="sslsessionticketkeyfile">Directive</a></h2>
2280 <table class="directive">
2281 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Persistent encryption/decryption key for TLS session tickets</td></tr>
2282 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionTicketKeyFile <em>file-path</em></code></td></tr>
2283 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2284 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2285 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2286 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.0 and later, if using OpenSSL 0.9.8h or later</td></tr>
2288 <p>Optionally configures a secret key for encrypting and decrypting
2289 TLS session tickets, as defined in
2290 <a href="http://www.ietf.org/rfc/rfc5077.txt">RFC 5077</a>.
2291 Primarily suitable for clustered environments where TLS sessions information
2292 should be shared between multiple nodes. For single-instance httpd setups,
2293 it is recommended to <em>not</em> configure a ticket key file, but to
2294 rely on (random) keys generated by mod_ssl at startup, instead.</p>
2295 <p>The ticket key file must contain 48 bytes of random data,
2296 preferrably created from a high-entropy source. On a Unix-based system,
2297 a ticket key file can be created as follows:</p>
2299 <div class="example"><p><code>
2300 dd if=/dev/random of=/path/to/file.tkey bs=1 count=48
2303 <p>Ticket keys should be rotated (replaced) on a frequent basis,
2304 as this is the only way to invalidate an existing session ticket -
2305 OpenSSL currently doesn't allow to specify a limit for ticket lifetimes.
2306 A new ticket key only gets used after restarting the web server.
2307 All existing session tickets become invalid after a restart.</p>
2309 <div class="warning">
2310 <p>The ticket key file contains sensitive keying material and should
2311 be protected with file permissions similar to those used for
2312 <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>.</p>
2316 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2317 <div class="directive-section"><h2><a name="SSLSessionTickets" id="SSLSessionTickets">SSLSessionTickets</a> <a name="sslsessiontickets" id="sslsessiontickets">Directive</a></h2>
2318 <table class="directive">
2319 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable or disable use of TLS session tickets</td></tr>
2320 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionTickets on|off</code></td></tr>
2321 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionTickets on</code></td></tr>
2322 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2323 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2324 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2325 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.11 and later, if using OpenSSL 0.9.8f
2328 <p>This directive allows to enable or disable the use of TLS session tickets
2330 <div class="warning">
2331 <p>TLS session tickets are enabled by default. Using them without restarting
2332 the web server with an appropriate frequency (e.g. daily) compromises perfect
2333 forward secrecy.</p>
2337 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2338 <div class="directive-section"><h2><a name="SSLSRPUnknownUserSeed" id="SSLSRPUnknownUserSeed">SSLSRPUnknownUserSeed</a> <a name="sslsrpunknownuserseed" id="sslsrpunknownuserseed">Directive</a></h2>
2339 <table class="directive">
2340 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SRP unknown user seed</td></tr>
2341 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSRPUnknownUserSeed <em>secret-string</em></code></td></tr>
2342 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2343 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2344 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2345 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.4 and later, if using OpenSSL 1.0.1 or
2349 This directive sets the seed used to fake SRP user parameters for unknown
2350 users, to avoid leaking whether a given user exists. Specify a secret
2351 string. If this directive is not used, then Apache will return the
2352 UNKNOWN_PSK_IDENTITY alert to clients who specify an unknown username.
2354 <div class="example"><h3>Example</h3><p><code>
2355 SSLSRPUnknownUserSeed "secret"
2359 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2360 <div class="directive-section"><h2><a name="SSLSRPVerifierFile" id="SSLSRPVerifierFile">SSLSRPVerifierFile</a> <a name="sslsrpverifierfile" id="sslsrpverifierfile">Directive</a></h2>
2361 <table class="directive">
2362 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Path to SRP verifier file</td></tr>
2363 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSRPVerifierFile <em>file-path</em></code></td></tr>
2364 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2365 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2366 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2367 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.4 and later, if using OpenSSL 1.0.1 or
2371 This directive enables TLS-SRP and sets the path to the OpenSSL SRP (Secure
2372 Remote Password) verifier file containing TLS-SRP usernames, verifiers, salts,
2373 and group parameters.</p>
2374 <div class="example"><h3>Example</h3><p><code>
2375 SSLSRPVerifierFile "/path/to/file.srpv"
2378 The verifier file can be created with the <code>openssl</code> command line
2380 <div class="example"><h3>Creating the SRP verifier file</h3><p><code>
2381 openssl srp -srpvfile passwd.srpv -userinfo "some info" -add username
2383 <p> The value given with the optional <code>-userinfo</code> parameter is
2384 avalable in the <code>SSL_SRP_USERINFO</code> request environment variable.</p>
2388 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2389 <div class="directive-section"><h2><a name="SSLStaplingCache" id="SSLStaplingCache">SSLStaplingCache</a> <a name="sslstaplingcache" id="sslstaplingcache">Directive</a></h2>
2390 <table class="directive">
2391 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the OCSP stapling cache</td></tr>
2392 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingCache <em>type</em></code></td></tr>
2393 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
2394 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2395 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2396 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2398 <p>Configures the cache used to store OCSP responses which get included
2399 in the TLS handshake if <code class="directive"><a href="#sslusestapling">SSLUseStapling</a></code>
2400 is enabled. Configuration of a cache is mandatory for OCSP stapling.
2401 With the exception of <code>none</code> and <code>nonenotnull</code>,
2402 the same storage types are supported as with
2403 <code class="directive"><a href="#sslsessioncache">SSLSessionCache</a></code>.</p>
2406 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2407 <div class="directive-section"><h2><a name="SSLStaplingErrorCacheTimeout" id="SSLStaplingErrorCacheTimeout">SSLStaplingErrorCacheTimeout</a> <a name="sslstaplingerrorcachetimeout" id="sslstaplingerrorcachetimeout">Directive</a></h2>
2408 <table class="directive">
2409 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of seconds before expiring invalid responses in the OCSP stapling cache</td></tr>
2410 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingErrorCacheTimeout <em>seconds</em></code></td></tr>
2411 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingErrorCacheTimeout 600</code></td></tr>
2412 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2413 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2414 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2415 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2417 <p>Sets the timeout in seconds before <em>invalid</em> responses
2418 in the OCSP stapling cache (configured through <code class="directive"><a href="#sslstaplingcache">SSLStaplingCache</a></code>) will expire.
2419 To set the cache timeout for valid responses, see
2420 <code class="directive"><a href="#sslstaplingstandardcachetimeout">SSLStaplingStandardCacheTimeout</a></code>.</p>
2423 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2424 <div class="directive-section"><h2><a name="SSLStaplingFakeTryLater" id="SSLStaplingFakeTryLater">SSLStaplingFakeTryLater</a> <a name="sslstaplingfaketrylater" id="sslstaplingfaketrylater">Directive</a></h2>
2425 <table class="directive">
2426 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Synthesize "tryLater" responses for failed OCSP stapling queries</td></tr>
2427 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingFakeTryLater on|off</code></td></tr>
2428 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingFakeTryLater on</code></td></tr>
2429 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2430 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2431 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2432 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2434 <p>When enabled and a query to an OCSP responder for stapling
2435 purposes fails, mod_ssl will synthesize a "tryLater" response for the
2436 client. Only effective if <code class="directive"><a href="#sslstaplingreturnrespondererrors">SSLStaplingReturnResponderErrors</a></code>
2437 is also enabled.</p>
2440 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2441 <div class="directive-section"><h2><a name="SSLStaplingForceURL" id="SSLStaplingForceURL">SSLStaplingForceURL</a> <a name="sslstaplingforceurl" id="sslstaplingforceurl">Directive</a></h2>
2442 <table class="directive">
2443 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Override the OCSP responder URI specified in the certificate's AIA extension</td></tr>
2444 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingForceURL <em>uri</em></code></td></tr>
2445 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2446 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2447 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2448 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2450 <p>This directive overrides the URI of an OCSP responder as obtained from
2451 the authorityInfoAccess (AIA) extension of the certificate.
2452 One potential use is when a proxy is used for retrieving OCSP queries.</p>
2455 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2456 <div class="directive-section"><h2><a name="SSLStaplingResponderTimeout" id="SSLStaplingResponderTimeout">SSLStaplingResponderTimeout</a> <a name="sslstaplingrespondertimeout" id="sslstaplingrespondertimeout">Directive</a></h2>
2457 <table class="directive">
2458 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Timeout for OCSP stapling queries</td></tr>
2459 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingResponderTimeout <em>seconds</em></code></td></tr>
2460 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingResponderTimeout 10</code></td></tr>
2461 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2462 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2463 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2464 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2466 <p>This option sets the timeout for queries to OCSP responders when
2467 <code class="directive"><a href="#sslusestapling">SSLUseStapling</a></code> is enabled
2468 and mod_ssl is querying a responder for OCSP stapling purposes.</p>
2471 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2472 <div class="directive-section"><h2><a name="SSLStaplingResponseMaxAge" id="SSLStaplingResponseMaxAge">SSLStaplingResponseMaxAge</a> <a name="sslstaplingresponsemaxage" id="sslstaplingresponsemaxage">Directive</a></h2>
2473 <table class="directive">
2474 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum allowable age for OCSP stapling responses</td></tr>
2475 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingResponseMaxAge <em>seconds</em></code></td></tr>
2476 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingResponseMaxAge -1</code></td></tr>
2477 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2478 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2479 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2480 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2482 <p>This option sets the maximum allowable age ("freshness") when
2483 considering OCSP responses for stapling purposes, i.e. when
2484 <code class="directive"><a href="#sslusestapling">SSLUseStapling</a></code> is turned on.
2485 The default value (<code>-1</code>) does not enforce a maximum age,
2486 which means that OCSP responses are considered valid as long as their
2487 <code>nextUpdate</code> field is in the future.</p>
2490 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2491 <div class="directive-section"><h2><a name="SSLStaplingResponseTimeSkew" id="SSLStaplingResponseTimeSkew">SSLStaplingResponseTimeSkew</a> <a name="sslstaplingresponsetimeskew" id="sslstaplingresponsetimeskew">Directive</a></h2>
2492 <table class="directive">
2493 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum allowable time skew for OCSP stapling response validation</td></tr>
2494 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingResponseTimeSkew <em>seconds</em></code></td></tr>
2495 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingResponseTimeSkew 300</code></td></tr>
2496 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2497 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2498 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2499 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2501 <p>This option sets the maximum allowable time skew when mod_ssl checks the
2502 <code>thisUpdate</code> and <code>nextUpdate</code> fields of OCSP responses
2503 which get included in the TLS handshake (OCSP stapling). Only applicable
2504 if <code class="directive"><a href="#sslusestapling">SSLUseStapling</a></code> is turned on.</p>
2507 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2508 <div class="directive-section"><h2><a name="SSLStaplingReturnResponderErrors" id="SSLStaplingReturnResponderErrors">SSLStaplingReturnResponderErrors</a> <a name="sslstaplingreturnrespondererrors" id="sslstaplingreturnrespondererrors">Directive</a></h2>
2509 <table class="directive">
2510 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pass stapling related OCSP errors on to client</td></tr>
2511 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingReturnResponderErrors on|off</code></td></tr>
2512 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingReturnResponderErrors on</code></td></tr>
2513 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2514 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2515 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2516 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2518 <p>When enabled, mod_ssl will pass responses from unsuccessful
2519 stapling related OCSP queries (such as responses with an overall status
2520 other than "successful", responses with a certificate status other than
2521 "good", expired responses etc.) on to the client.
2522 If set to <code>off</code>, only responses indicating a certificate status
2523 of "good" will be included in the TLS handshake.</p>
2526 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2527 <div class="directive-section"><h2><a name="SSLStaplingStandardCacheTimeout" id="SSLStaplingStandardCacheTimeout">SSLStaplingStandardCacheTimeout</a> <a name="sslstaplingstandardcachetimeout" id="sslstaplingstandardcachetimeout">Directive</a></h2>
2528 <table class="directive">
2529 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of seconds before expiring responses in the OCSP stapling cache</td></tr>
2530 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStaplingStandardCacheTimeout <em>seconds</em></code></td></tr>
2531 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStaplingStandardCacheTimeout 3600</code></td></tr>
2532 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2533 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2534 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2535 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2537 <p>Sets the timeout in seconds before responses in the OCSP stapling cache
2538 (configured through <code class="directive"><a href="#sslstaplingcache">SSLStaplingCache</a></code>)
2539 will expire. This directive applies to <em>valid</em> responses, while
2540 <code class="directive"><a href="#sslstaplingerrorcachetimeout">SSLStaplingErrorCacheTimeout</a></code> is
2541 used for controlling the timeout for invalid/unavailable responses.
2545 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2546 <div class="directive-section"><h2><a name="SSLStrictSNIVHostCheck" id="SSLStrictSNIVHostCheck">SSLStrictSNIVHostCheck</a> <a name="sslstrictsnivhostcheck" id="sslstrictsnivhostcheck">Directive</a></h2>
2547 <table class="directive">
2548 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether to allow non-SNI clients to access a name-based virtual
2551 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLStrictSNIVHostCheck on|off</code></td></tr>
2552 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLStrictSNIVHostCheck off</code></td></tr>
2553 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2554 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2555 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2558 This directive sets whether a non-SNI client is allowed to access a name-based
2559 virtual host. If set to <code>on</code> in the default name-based virtual
2560 host, clients that are SNI unaware will not be allowed to access <em>any</em>
2561 virtual host, belonging to this particular IP / port combination.
2562 If set to <code>on</code> in any other virtual host, SNI unaware clients
2563 are not allowed to access this particular virtual host.
2566 <div class="warning"><p>
2567 This option is only available if httpd was compiled against an SNI capable
2571 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLStrictSNIVHostCheck on</pre>
2575 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2576 <div class="directive-section"><h2><a name="SSLUserName" id="SSLUserName">SSLUserName</a> <a name="sslusername" id="sslusername">Directive</a></h2>
2577 <table class="directive">
2578 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Variable name to determine user name</td></tr>
2579 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLUserName <em>varname</em></code></td></tr>
2580 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, directory, .htaccess</td></tr>
2581 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2582 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2583 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2586 This directive sets the "user" field in the Apache request object.
2587 This is used by lower modules to identify the user with a character
2588 string. In particular, this may cause the environment variable
2589 <code>REMOTE_USER</code> to be set. The <em>varname</em> can be
2590 any of the <a href="#envvars">SSL environment variables</a>.</p>
2592 <p>When the <code>FakeBasicAuth</code> option is enabled, this directive
2593 instead controls the value of the username embedded within the basic
2594 authentication header (see <a href="#ssloptions">SSLOptions</a>).</p>
2596 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLUserName SSL_CLIENT_S_DN_CN</pre>
2600 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2601 <div class="directive-section"><h2><a name="SSLUseStapling" id="SSLUseStapling">SSLUseStapling</a> <a name="sslusestapling" id="sslusestapling">Directive</a></h2>
2602 <table class="directive">
2603 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable stapling of OCSP responses in the TLS handshake</td></tr>
2604 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLUseStapling on|off</code></td></tr>
2605 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLUseStapling off</code></td></tr>
2606 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2607 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2608 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2609 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available if using OpenSSL 0.9.8h or later</td></tr>
2611 <p>This option enables OCSP stapling, as defined by the "Certificate
2612 Status Request" TLS extension specified in RFC 6066. If enabled (and
2613 requested by the client), mod_ssl will include an OCSP response
2614 for its own certificate in the TLS handshake. Configuring an
2615 <code class="directive"><a href="#sslstaplingcache">SSLStaplingCache</a></code> is a
2616 prerequisite for enabling OCSP stapling.</p>
2618 <p>OCSP stapling relieves the client of querying the OCSP responder
2619 on its own, but it should be noted that with the RFC 6066 specification,
2620 the server's <code>CertificateStatus</code> reply may only include an
2621 OCSP response for a single cert. For server certificates with intermediate
2622 CA certificates in their chain (the typical case nowadays),
2623 stapling in its current implementation therefore only partially achieves the
2624 stated goal of "saving roundtrips and resources" - see also
2625 <a href="http://www.ietf.org/rfc/rfc6961.txt">RFC 6961</a>
2626 (TLS Multiple Certificate Status Extension).
2629 <p>When OCSP stapling is enabled, the <code>ssl-stapling</code> mutex is used
2630 to control access to the OCSP stapling cache in order to prevent corruption,
2631 and the <code>sss-stapling-refresh</code> mutex is used to control refreshes
2632 of OCSP responses. These mutexes can be configured using the
2633 <code class="directive"><a href="../mod/core.html#mutex">Mutex</a></code> directive.
2638 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2639 <div class="directive-section"><h2><a name="SSLVerifyClient" id="SSLVerifyClient">SSLVerifyClient</a> <a name="sslverifyclient" id="sslverifyclient">Directive</a></h2>
2640 <table class="directive">
2641 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of Client Certificate verification</td></tr>
2642 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLVerifyClient <em>level</em></code></td></tr>
2643 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLVerifyClient none</code></td></tr>
2644 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2645 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2646 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2647 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2650 This directive sets the Certificate verification level for the Client
2651 Authentication. Notice that this directive can be used both in per-server and
2652 per-directory context. In per-server context it applies to the client
2653 authentication process used in the standard SSL handshake when a connection is
2654 established. In per-directory context it forces a SSL renegotiation with the
2655 reconfigured client verification level after the HTTP request was read but
2656 before the HTTP response is sent.</p>
2658 The following levels are available for <em>level</em>:</p>
2660 <li><strong>none</strong>:
2661 no client Certificate is required at all</li>
2662 <li><strong>optional</strong>:
2663 the client <em>may</em> present a valid Certificate</li>
2664 <li><strong>require</strong>:
2665 the client <em>has to</em> present a valid Certificate</li>
2666 <li><strong>optional_no_ca</strong>:
2667 the client may present a valid Certificate<br />
2668 but it need not to be (successfully) verifiable.</li>
2670 <p>In practice only levels <strong>none</strong> and
2671 <strong>require</strong> are really interesting, because level
2672 <strong>optional</strong> doesn't work with all browsers and level
2673 <strong>optional_no_ca</strong> is actually against the idea of
2674 authentication (but can be used to establish SSL test pages, etc.)</p>
2675 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLVerifyClient require</pre>
2679 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2680 <div class="directive-section"><h2><a name="SSLVerifyDepth" id="SSLVerifyDepth">SSLVerifyDepth</a> <a name="sslverifydepth" id="sslverifydepth">Directive</a></h2>
2681 <table class="directive">
2682 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum depth of CA Certificates in Client
2683 Certificate verification</td></tr>
2684 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLVerifyDepth <em>number</em></code></td></tr>
2685 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLVerifyDepth 1</code></td></tr>
2686 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2687 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2688 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
2689 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
2692 This directive sets how deeply mod_ssl should verify before deciding that the
2693 clients don't have a valid certificate. Notice that this directive can be
2694 used both in per-server and per-directory context. In per-server context it
2695 applies to the client authentication process used in the standard SSL
2696 handshake when a connection is established. In per-directory context it forces
2697 a SSL renegotiation with the reconfigured client verification depth after the
2698 HTTP request was read but before the HTTP response is sent.</p>
2700 The depth actually is the maximum number of intermediate certificate issuers,
2701 i.e. the number of CA certificates which are max allowed to be followed while
2702 verifying the client certificate. A depth of 0 means that self-signed client
2703 certificates are accepted only, the default depth of 1 means the client
2704 certificate can be self-signed or has to be signed by a CA which is directly
2705 known to the server (i.e. the CA's certificate is under
2706 <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code>), etc.</p>
2707 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">SSLVerifyDepth 10</pre>
2712 <div class="bottomlang">
2713 <p><span>Available Languages: </span><a href="../en/mod/mod_ssl.html" title="English"> en </a></p>
2714 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
2715 <script type="text/javascript"><!--//--><![CDATA[//><!--
2716 var comments_shortname = 'httpd';
2717 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_ssl.html';
2719 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
2720 d.write('<div id="comments_thread"><\/div>');
2721 var s = d.createElement('script');
2722 s.type = 'text/javascript';
2724 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
2725 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
2728 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
2730 })(window, document);
2731 //--><!]]></script></div><div id="footer">
2732 <p class="apache">Copyright 2016 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
2733 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
2734 if (typeof(prettyPrint) !== 'undefined') {