home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278121_mod_ssl.html.en < prev    next >
Extensible Markup Language  |  2004-04-12  |  98KB  |  1,512 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mod_ssl - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_ssl</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_ssl.html" title="English"> en </a></p>
  25. </div>
  26. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Strong cryptography using the Secure Sockets
  27. Layer (SSL) and Transport Layer Security (TLS) protocols</td></tr>
  28. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>ssl_module</td></tr>
  30. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_ssl.c</td></tr></table>
  31. <h3>Summary</h3>
  32.  
  33. <p>This module provides SSL v2/v3 and TLS v1 support for the Apache
  34. HTTP Server.  It was contributed by Ralf S. Engeschall based on his
  35. mod_ssl project and originally derived from work by Ben Laurie.</p>
  36.  
  37. <p>This module relies on <a href="http://www.openssl.org/">OpenSSL</a>
  38. to provide the cryptography engine.</p>
  39.  
  40. <p>Further details, discussion, and examples are provided in the
  41. <a href="../ssl/">SSL documentation</a>.</p>
  42. </div>
  43. <div id="quickview"><h3 class="directives">Directives</h3>
  44. <ul id="toc">
  45. <li><img alt="" src="../images/down.gif" /> <a href="#sslcacertificatefile">SSLCACertificateFile</a></li>
  46. <li><img alt="" src="../images/down.gif" /> <a href="#sslcacertificatepath">SSLCACertificatePath</a></li>
  47. <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationfile">SSLCARevocationFile</a></li>
  48. <li><img alt="" src="../images/down.gif" /> <a href="#sslcarevocationpath">SSLCARevocationPath</a></li>
  49. <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatechainfile">SSLCertificateChainFile</a></li>
  50. <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatefile">SSLCertificateFile</a></li>
  51. <li><img alt="" src="../images/down.gif" /> <a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></li>
  52. <li><img alt="" src="../images/down.gif" /> <a href="#sslciphersuite">SSLCipherSuite</a></li>
  53. <li><img alt="" src="../images/down.gif" /> <a href="#sslengine">SSLEngine</a></li>
  54. <li><img alt="" src="../images/down.gif" /> <a href="#sslmutex">SSLMutex</a></li>
  55. <li><img alt="" src="../images/down.gif" /> <a href="#ssloptions">SSLOptions</a></li>
  56. <li><img alt="" src="../images/down.gif" /> <a href="#sslpassphrasedialog">SSLPassPhraseDialog</a></li>
  57. <li><img alt="" src="../images/down.gif" /> <a href="#sslprotocol">SSLProtocol</a></li>
  58. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycacertificatefile">SSLProxyCACertificateFile</a></li>
  59. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></li>
  60. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationfile">SSLProxyCARevocationFile</a></li>
  61. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></li>
  62. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyciphersuite">SSLProxyCipherSuite</a></li>
  63. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyengine">SSLProxyEngine</a></li>
  64. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatefile">SSLProxyMachineCertificateFile</a></li>
  65. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxymachinecertificatepath">SSLProxyMachineCertificatePath</a></li>
  66. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyprotocol">SSLProxyProtocol</a></li>
  67. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyverify">SSLProxyVerify</a></li>
  68. <li><img alt="" src="../images/down.gif" /> <a href="#sslproxyverifydepth">SSLProxyVerifyDepth</a></li>
  69. <li><img alt="" src="../images/down.gif" /> <a href="#sslrandomseed">SSLRandomSeed</a></li>
  70. <li><img alt="" src="../images/down.gif" /> <a href="#sslrequire">SSLRequire</a></li>
  71. <li><img alt="" src="../images/down.gif" /> <a href="#sslrequiressl">SSLRequireSSL</a></li>
  72. <li><img alt="" src="../images/down.gif" /> <a href="#sslsessioncache">SSLSessionCache</a></li>
  73. <li><img alt="" src="../images/down.gif" /> <a href="#sslsessioncachetimeout">SSLSessionCacheTimeout</a></li>
  74. <li><img alt="" src="../images/down.gif" /> <a href="#sslverifyclient">SSLVerifyClient</a></li>
  75. <li><img alt="" src="../images/down.gif" /> <a href="#sslverifydepth">SSLVerifyDepth</a></li>
  76. </ul>
  77. <h3>Topics</h3>
  78. <ul id="topics">
  79. <li><img alt="" src="../images/down.gif" /> <a href="#envvars">Environment Variables</a></li>
  80. <li><img alt="" src="../images/down.gif" /> <a href="#logformats">Custom Log Formats</a></li>
  81. </ul></div>
  82. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  83. <div class="section">
  84. <h2><a name="envvars" id="envvars">Environment Variables</a></h2>
  85.  
  86. <p>This module provides a lot of SSL information as additional environment
  87. variables to the SSI and CGI namespace. The generated variables are listed in
  88. the table below. For backward compatibility the information can
  89. be made available under different names, too. Look in the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter for details on the
  90. compatibility variables.</p>
  91.  
  92. <table class="bordered">
  93.  
  94. <tr>
  95.  <th>Variable Name:</th>
  96.  <th>Value Type:</th>
  97.  <th>Description:</th>
  98. </tr>
  99. <tr><td><code>HTTPS</code></td>                         <td>flag</td>      <td>HTTPS is being used.</td></tr>
  100. <tr><td><code>SSL_PROTOCOL</code></td>                  <td>string</td>    <td>The SSL protocol version (SSLv2, SSLv3, TLSv1)</td></tr>
  101. <tr><td><code>SSL_SESSION_ID</code></td>                <td>string</td>    <td>The hex-encoded SSL session id</td></tr>
  102. <tr><td><code>SSL_CIPHER</code></td>                    <td>string</td>    <td>The cipher specification name</td></tr>
  103. <tr><td><code>SSL_CIPHER_EXPORT</code></td>             <td>string</td>    <td><code>true</code> if cipher is an export cipher</td></tr>
  104. <tr><td><code>SSL_CIPHER_USEKEYSIZE</code></td>         <td>number</td>    <td>Number of cipher bits (actually used)</td></tr>
  105. <tr><td><code>SSL_CIPHER_ALGKEYSIZE</code></td>         <td>number</td>    <td>Number of cipher bits (possible)</td></tr>
  106. <tr><td><code>SSL_VERSION_INTERFACE</code></td>         <td>string</td>    <td>The mod_ssl program version</td></tr>
  107. <tr><td><code>SSL_VERSION_LIBRARY</code></td>           <td>string</td>    <td>The OpenSSL program version</td></tr>
  108. <tr><td><code>SSL_CLIENT_M_VERSION</code></td>          <td>string</td>    <td>The version of the client certificate</td></tr>
  109. <tr><td><code>SSL_CLIENT_M_SERIAL</code></td>           <td>string</td>    <td>The serial of the client certificate</td></tr>
  110. <tr><td><code>SSL_CLIENT_S_DN</code></td>               <td>string</td>    <td>Subject DN in client's certificate</td></tr>
  111. <tr><td><code>SSL_CLIENT_S_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of client's Subject DN</td></tr>
  112. <tr><td><code>SSL_CLIENT_I_DN</code></td>               <td>string</td>    <td>Issuer DN of client's certificate</td></tr>
  113. <tr><td><code>SSL_CLIENT_I_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of client's Issuer DN</td></tr>
  114. <tr><td><code>SSL_CLIENT_V_START</code></td>            <td>string</td>    <td>Validity of client's certificate (start time)</td></tr>
  115. <tr><td><code>SSL_CLIENT_V_END</code></td>              <td>string</td>    <td>Validity of client's certificate (end time)</td></tr>
  116. <tr><td><code>SSL_CLIENT_A_SIG</code></td>              <td>string</td>    <td>Algorithm used for the signature of client's certificate</td></tr>
  117. <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>
  118. <tr><td><code>SSL_CLIENT_CERT</code></td>               <td>string</td>    <td>PEM-encoded client certificate</td></tr>
  119. <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>
  120. <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>
  121. <tr><td><code>SSL_SERVER_M_VERSION</code></td>          <td>string</td>    <td>The version of the server certificate</td></tr>
  122. <tr><td><code>SSL_SERVER_M_SERIAL</code></td>           <td>string</td>    <td>The serial of the server certificate</td></tr>
  123. <tr><td><code>SSL_SERVER_S_DN</code></td>               <td>string</td>    <td>Subject DN in server's certificate</td></tr>
  124. <tr><td><code>SSL_SERVER_S_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of server's Subject DN</td></tr>
  125. <tr><td><code>SSL_SERVER_I_DN</code></td>               <td>string</td>    <td>Issuer DN of server's certificate</td></tr>
  126. <tr><td><code>SSL_SERVER_I_DN_</code><em>x509</em></td> <td>string</td>    <td>Component of server's Issuer DN</td></tr>
  127. <tr><td><code>SSL_SERVER_V_START</code></td>            <td>string</td>    <td>Validity of server's certificate (start time)</td></tr>
  128. <tr><td><code>SSL_SERVER_V_END</code></td>              <td>string</td>    <td>Validity of server's certificate (end time)</td></tr>
  129. <tr><td><code>SSL_SERVER_A_SIG</code></td>              <td>string</td>    <td>Algorithm used for the signature of server's certificate</td></tr>
  130. <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>
  131. <tr><td><code>SSL_SERVER_CERT</code></td>               <td>string</td>    <td>PEM-encoded server certificate</td></tr>
  132. </table>
  133. <p>[ where <em>x509</em> is a component of a X.509 DN:
  134.   <code>C,ST,L,O,OU,CN,T,I,G,S,D,UID,Email</code> ]</p>
  135. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  136. <div class="section">
  137. <h2><a name="logformats" id="logformats">Custom Log Formats</a></h2>
  138.  
  139. <p>When <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is built into Apache or at least
  140. loaded (under DSO situation) additional functions exist for the <a href="mod_log_config.html#formats">Custom Log Format</a> of 
  141. <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code>. First there is an
  142. additional ``<code>%{</code><em>varname</em><code>}x</code>''
  143. eXtension format function which can be used to expand any variables
  144. provided by any module, especially those provided by mod_ssl which can
  145. you find in the above table.</p>
  146. <p>
  147. For backward compatibility there is additionally a special
  148. ``<code>%{</code><em>name</em><code>}c</code>'' cryptography format function
  149. provided. Information about this function is provided in the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter.</p>
  150. <p>
  151. Example:</p>
  152. <div class="example"><p><code>
  153. CustomLog logs/ssl_request_log \
  154.           "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
  155. </code></p></div>
  156. </div>
  157. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  158. <div class="directive-section"><h2><a name="SSLCACertificateFile" id="SSLCACertificateFile">SSLCACertificateFile</a> <a name="sslcacertificatefile" id="sslcacertificatefile">Directive</a></h2>
  159. <table class="directive">
  160. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates 
  161. for Client Auth</td></tr>
  162. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCACertificateFile <em>file-path</em></code></td></tr>
  163. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  164. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  165. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  166. </table>
  167. <p>
  168. This directive sets the <em>all-in-one</em> file where you can assemble the
  169. Certificates of Certification Authorities (CA) whose <em>clients</em> you deal
  170. with. These are used for Client Authentication. Such a file is simply the
  171. concatenation of the various PEM-encoded Certificate files, in order of
  172. preference. This can be used alternatively and/or additionally to 
  173. <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code>.</p>
  174. <div class="example"><h3>Example</h3><p><code>
  175. SSLCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-client.crt
  176. </code></p></div>
  177.  
  178. </div>
  179. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  180. <div class="directive-section"><h2><a name="SSLCACertificatePath" id="SSLCACertificatePath">SSLCACertificatePath</a> <a name="sslcacertificatepath" id="sslcacertificatepath">Directive</a></h2>
  181. <table class="directive">
  182. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for 
  183. Client Auth</td></tr>
  184. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCACertificatePath <em>directory-path</em></code></td></tr>
  185. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  186. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  187. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  188. </table>
  189. <p>
  190. This directive sets the directory where you keep the Certificates of
  191. Certification Authorities (CAs) whose clients you deal with. These are used to
  192. verify the client certificate on Client Authentication.</p>
  193. <p>
  194. The files in this directory have to be PEM-encoded and are accessed through
  195. hash filenames. So usually you can't just place the Certificate files
  196. there: you also have to create symbolic links named
  197. <em>hash-value</em><code>.N</code>. And you should always make sure this directory
  198. contains the appropriate symbolic links. Use the <code>Makefile</code> which
  199. comes with mod_ssl to accomplish this task.</p>
  200. <div class="example"><h3>Example</h3><p><code>
  201. SSLCACertificatePath /usr/local/apache2/conf/ssl.crt/
  202. </code></p></div>
  203.  
  204. </div>
  205. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  206. <div class="directive-section"><h2><a name="SSLCARevocationFile" id="SSLCARevocationFile">SSLCARevocationFile</a> <a name="sslcarevocationfile" id="sslcarevocationfile">Directive</a></h2>
  207. <table class="directive">
  208. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA CRLs for 
  209. Client Auth</td></tr>
  210. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationFile <em>file-path</em></code></td></tr>
  211. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  212. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  213. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  214. </table>
  215. <p>
  216. This directive sets the <em>all-in-one</em> file where you can
  217. assemble the Certificate Revocation Lists (CRL) of Certification
  218. Authorities (CA) whose <em>clients</em> you deal with. These are used
  219. for Client Authentication.  Such a file is simply the concatenation of
  220. the various PEM-encoded CRL files, in order of preference. This can be
  221. used alternatively and/or additionally to <code class="directive"><a href="#sslcarevocationpath">SSLCARevocationPath</a></code>.</p>
  222. <div class="example"><h3>Example</h3><p><code>
  223. SSLCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-client.crl
  224. </code></p></div>
  225.  
  226. </div>
  227. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  228. <div class="directive-section"><h2><a name="SSLCARevocationPath" id="SSLCARevocationPath">SSLCARevocationPath</a> <a name="sslcarevocationpath" id="sslcarevocationpath">Directive</a></h2>
  229. <table class="directive">
  230. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA CRLs for 
  231. Client Auth</td></tr>
  232. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCARevocationPath <em>directory-path</em></code></td></tr>
  233. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  234. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  235. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  236. </table>
  237. <p>
  238. This directive sets the directory where you keep the Certificate Revocation
  239. Lists (CRL) of Certification Authorities (CAs) whose clients you deal with.
  240. These are used to revoke the client certificate on Client Authentication.</p>
  241. <p>
  242. The files in this directory have to be PEM-encoded and are accessed through
  243. hash filenames. So usually you have not only to place the CRL files there.
  244. Additionally you have to create symbolic links named
  245. <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
  246. contains the appropriate symbolic links. Use the <code>Makefile</code> which
  247. comes with <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> to accomplish this task.</p>
  248. <div class="example"><h3>Example</h3><p><code>
  249. SSLCARevocationPath /usr/local/apache2/conf/ssl.crl/
  250. </code></p></div>
  251.  
  252. </div>
  253. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  254. <div class="directive-section"><h2><a name="SSLCertificateChainFile" id="SSLCertificateChainFile">SSLCertificateChainFile</a> <a name="sslcertificatechainfile" id="sslcertificatechainfile">Directive</a></h2>
  255. <table class="directive">
  256. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of PEM-encoded Server CA Certificates</td></tr>
  257. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateChainFile <em>file-path</em></code></td></tr>
  258. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  259. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  260. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  261. </table>
  262. <p>
  263. This directive sets the optional <em>all-in-one</em> file where you can
  264. assemble the certificates of Certification Authorities (CA) which form the
  265. certificate chain of the server certificate. This starts with the issuing CA
  266. certificate of of the server certificate and can range up to the root CA
  267. certificate. Such a file is simply the concatenation of the various
  268. PEM-encoded CA Certificate files, usually in certificate chain order.</p>
  269. <p>
  270. This should be used alternatively and/or additionally to <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> for explicitly
  271. constructing the server certificate chain which is sent to the browser
  272. in addition to the server certificate. It is especially useful to
  273. avoid conflicts with CA certificates when using client
  274. authentication. Because although placing a CA certificate of the
  275. server certificate chain into <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code> has the same effect
  276. for the certificate chain construction, it has the side-effect that
  277. client certificates issued by this same CA certificate are also
  278. accepted on client authentication. That's usually not one expect.</p>
  279. <p>
  280. But be careful: Providing the certificate chain works only if you are using a
  281. <em>single</em> (either RSA <em>or</em> DSA) based server certificate. If you are
  282. using a coupled RSA+DSA certificate pair, this will work only if actually both
  283. certificates use the <em>same</em> certificate chain. Else the browsers will be
  284. confused in this situation.</p>
  285. <div class="example"><h3>Example</h3><p><code>
  286. SSLCertificateChainFile /usr/local/apache2/conf/ssl.crt/ca.crt
  287. </code></p></div>
  288.  
  289. </div>
  290. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  291. <div class="directive-section"><h2><a name="SSLCertificateFile" id="SSLCertificateFile">SSLCertificateFile</a> <a name="sslcertificatefile" id="sslcertificatefile">Directive</a></h2>
  292. <table class="directive">
  293. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Server PEM-encoded X.509 Certificate file</td></tr>
  294. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateFile <em>file-path</em></code></td></tr>
  295. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  296. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  297. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  298. </table>
  299. <p>
  300. This directive points to the PEM-encoded Certificate file for the server and
  301. optionally also to the corresponding RSA or DSA Private Key file for it
  302. (contained in the same file). If the contained Private Key is encrypted the
  303. Pass Phrase dialog is forced at startup time. This directive can be used up to
  304. two times (referencing different filenames) when both a RSA and a DSA based
  305. server certificate is used in parallel.</p>
  306. <div class="example"><h3>Example</h3><p><code>
  307. SSLCertificateFile /usr/local/apache2/conf/ssl.crt/server.crt
  308. </code></p></div>
  309.  
  310. </div>
  311. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  312. <div class="directive-section"><h2><a name="SSLCertificateKeyFile" id="SSLCertificateKeyFile">SSLCertificateKeyFile</a> <a name="sslcertificatekeyfile" id="sslcertificatekeyfile">Directive</a></h2>
  313. <table class="directive">
  314. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Server PEM-encoded Private Key file</td></tr>
  315. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCertificateKeyFile <em>file-path</em></code></td></tr>
  316. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  317. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  318. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  319. </table>
  320. <p>
  321. This directive points to the PEM-encoded Private Key file for the
  322. server. If the Private Key is not combined with the Certificate in the
  323. <code class="directive">SSLCertificateFile</code>, use this additional directive to
  324. point to the file with the stand-alone Private Key. When
  325. <code class="directive">SSLCertificateFile</code> is used and the file
  326. contains both the Certificate and the Private Key this directive need
  327. not be used. But we strongly discourage this practice.  Instead we
  328. recommend you to separate the Certificate and the Private Key. If the
  329. contained Private Key is encrypted, the Pass Phrase dialog is forced
  330. at startup time. This directive can be used up to two times
  331. (referencing different filenames) when both a RSA and a DSA based
  332. private key is used in parallel.</p>
  333. <div class="example"><h3>Example</h3><p><code>
  334. SSLCertificateKeyFile /usr/local/apache2/conf/ssl.key/server.key
  335. </code></p></div>
  336.  
  337. </div>
  338. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  339. <div class="directive-section"><h2><a name="SSLCipherSuite" id="SSLCipherSuite">SSLCipherSuite</a> <a name="sslciphersuite" id="sslciphersuite">Directive</a></h2>
  340. <table class="directive">
  341. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cipher Suite available for negotiation in SSL 
  342. handshake</td></tr>
  343. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLCipherSuite <em>cipher-spec</em></code></td></tr>
  344. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</code></td></tr>
  345. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  346. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  347. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  348. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  349. </table>
  350. <p>
  351. This complex directive uses a colon-separated <em>cipher-spec</em> string
  352. consisting of OpenSSL cipher specifications to configure the Cipher Suite the
  353. client is permitted to negotiate in the SSL handshake phase. Notice that this
  354. directive can be used both in per-server and per-directory context. In
  355. per-server context it applies to the standard SSL handshake when a connection
  356. is established. In per-directory context it forces a SSL renegotation with the
  357. reconfigured Cipher Suite after the HTTP request was read but before the HTTP
  358. response is sent.</p>
  359. <p>
  360. An SSL cipher specification in <em>cipher-spec</em> is composed of 4 major
  361. attributes plus a few extra minor ones:</p>
  362. <ul>
  363. <li><em>Key Exchange Algorithm</em>:<br />
  364.     RSA or Diffie-Hellman variants.
  365. </li>
  366. <li><em>Authentication Algorithm</em>:<br />
  367.     RSA, Diffie-Hellman, DSS or none.
  368. </li>
  369. <li><em>Cipher/Encryption Algorithm</em>:<br />
  370.     DES, Triple-DES, RC4, RC2, IDEA or none.
  371. </li>
  372. <li><em>MAC Digest Algorithm</em>:<br />
  373.     MD5, SHA or SHA1.
  374. </li>
  375. </ul>
  376. <p>An SSL cipher can also be an export cipher and is either a SSLv2 or SSLv3/TLSv1
  377. cipher (here TLSv1 is equivalent to SSLv3). To specify which ciphers to use,
  378. one can either specify all the Ciphers, one at a time, or use aliases to
  379. specify the preference and order for the ciphers (see <a href="#table1">Table
  380. 1</a>).</p>
  381.  
  382. <table class="bordered">
  383.  
  384. <tr><th>Tag</th> <th>Description</th></tr>
  385. <tr><td colspan="2"><em>Key Exchange Algorithm:</em></td></tr>
  386. <tr><td><code>kRSA</code></td>   <td>RSA key exchange</td></tr>
  387. <tr><td><code>kDHr</code></td>   <td>Diffie-Hellman key exchange with RSA key</td></tr>
  388. <tr><td><code>kDHd</code></td>   <td>Diffie-Hellman key exchange with DSA key</td></tr>
  389. <tr><td><code>kEDH</code></td>   <td>Ephemeral (temp.key) Diffie-Hellman key exchange (no cert)</td>   </tr>
  390. <tr><td colspan="2"><em>Authentication Algorithm:</em></td></tr>
  391. <tr><td><code>aNULL</code></td>  <td>No authentication</td></tr>
  392. <tr><td><code>aRSA</code></td>   <td>RSA authentication</td></tr>
  393. <tr><td><code>aDSS</code></td>   <td>DSS authentication</td> </tr>
  394. <tr><td><code>aDH</code></td>    <td>Diffie-Hellman authentication</td></tr>
  395. <tr><td colspan="2"><em>Cipher Encoding Algorithm:</em></td></tr>
  396. <tr><td><code>eNULL</code></td>  <td>No encoding</td>         </tr>
  397. <tr><td><code>DES</code></td>    <td>DES encoding</td>        </tr>
  398. <tr><td><code>3DES</code></td>   <td>Triple-DES encoding</td> </tr>
  399. <tr><td><code>RC4</code></td>    <td>RC4 encoding</td>       </tr>
  400. <tr><td><code>RC2</code></td>    <td>RC2 encoding</td>       </tr>
  401. <tr><td><code>IDEA</code></td>   <td>IDEA encoding</td>       </tr>
  402. <tr><td colspan="2"><em>MAC Digest Algorithm</em>:</td></tr>
  403. <tr><td><code>MD5</code></td>    <td>MD5 hash function</td></tr>
  404. <tr><td><code>SHA1</code></td>   <td>SHA1 hash function</td></tr>
  405. <tr><td><code>SHA</code></td>    <td>SHA hash function</td> </tr>
  406. <tr><td colspan="2"><em>Aliases:</em></td></tr>
  407. <tr><td><code>SSLv2</code></td>  <td>all SSL version 2.0 ciphers</td></tr>
  408. <tr><td><code>SSLv3</code></td>  <td>all SSL version 3.0 ciphers</td> </tr>
  409. <tr><td><code>TLSv1</code></td>  <td>all TLS version 1.0 ciphers</td> </tr>
  410. <tr><td><code>EXP</code></td>    <td>all export ciphers</td>  </tr>
  411. <tr><td><code>EXPORT40</code></td> <td>all 40-bit export ciphers only</td>  </tr>
  412. <tr><td><code>EXPORT56</code></td> <td>all 56-bit export ciphers only</td>  </tr>
  413. <tr><td><code>LOW</code></td>    <td>all low strength ciphers (no export, single DES)</td></tr>
  414. <tr><td><code>MEDIUM</code></td> <td>all ciphers with 128 bit encryption</td> </tr>
  415. <tr><td><code>HIGH</code></td>   <td>all ciphers using Triple-DES</td>     </tr>
  416. <tr><td><code>RSA</code></td>    <td>all ciphers using RSA key exchange</td> </tr>
  417. <tr><td><code>DH</code></td>     <td>all ciphers using Diffie-Hellman key exchange</td> </tr>
  418. <tr><td><code>EDH</code></td>    <td>all ciphers using Ephemeral Diffie-Hellman key exchange</td> </tr>
  419. <tr><td><code>ADH</code></td>    <td>all ciphers using Anonymous Diffie-Hellman key exchange</td> </tr>
  420. <tr><td><code>DSS</code></td>    <td>all ciphers using DSS authentication</td> </tr>
  421. <tr><td><code>NULL</code></td>   <td>all ciphers using no encryption</td> </tr>
  422. </table>
  423. <p>
  424. Now where this becomes interesting is that these can be put together
  425. to specify the order and ciphers you wish to use. To speed this up
  426. there are also aliases (<code>SSLv2, SSLv3, TLSv1, EXP, LOW, MEDIUM,
  427. HIGH</code>) for certain groups of ciphers. These tags can be joined
  428. together with prefixes to form the <em>cipher-spec</em>. Available
  429. prefixes are:</p>
  430. <ul>
  431. <li>none: add cipher to list</li>
  432. <li><code>+</code>: add ciphers to list and pull them to current location in list</li>
  433. <li><code>-</code>: remove cipher from list (can be added later again)</li>
  434. <li><code>!</code>: kill cipher from list completely (can <strong>not</strong> be added later again)</li>
  435. </ul>
  436. <p>A simpler way to look at all of this is to use the ``<code>openssl ciphers
  437. -v</code>'' command which provides a nice way to successively create the
  438. correct <em>cipher-spec</em> string. The default <em>cipher-spec</em> string
  439. is ``<code>ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</code>'' which
  440. means the following: first, remove from consideration any ciphers that do not
  441. authenticate, i.e. for SSL only the Anonymous Diffie-Hellman ciphers. Next,
  442. use ciphers using RC4 and RSA. Next include the high, medium and then the low
  443. security ciphers. Finally <em>pull</em> all SSLv2 and export ciphers to the
  444. end of the list.</p>
  445. <div class="example"><pre>
  446. $ openssl ciphers -v 'ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP'
  447. NULL-SHA                SSLv3 Kx=RSA      Au=RSA  Enc=None      Mac=SHA1
  448. NULL-MD5                SSLv3 Kx=RSA      Au=RSA  Enc=None      Mac=MD5
  449. EDH-RSA-DES-CBC3-SHA    SSLv3 Kx=DH       Au=RSA  Enc=3DES(168) Mac=SHA1
  450. ...                     ...               ...     ...           ...
  451. EXP-RC4-MD5             SSLv3 Kx=RSA(512) Au=RSA  Enc=RC4(40)   Mac=MD5  export
  452. EXP-RC2-CBC-MD5         SSLv2 Kx=RSA(512) Au=RSA  Enc=RC2(40)   Mac=MD5  export
  453. EXP-RC4-MD5             SSLv2 Kx=RSA(512) Au=RSA  Enc=RC4(40)   Mac=MD5  export
  454. </pre></div>
  455. <p>The complete list of particular RSA & DH ciphers for SSL is given in <a href="#table2">Table 2</a>.</p>
  456. <div class="example"><h3>Example</h3><p><code>
  457. SSLCipherSuite RSA:!EXP:!NULL:+HIGH:+MEDIUM:-LOW
  458. </code></p></div>
  459. <table class="bordered">
  460.  
  461. <tr><th>Cipher-Tag</th> <th>Protocol</th> <th>Key Ex.</th> <th>Auth.</th> <th>Enc.</th> <th>MAC</th> <th>Type</th> </tr>
  462. <tr><td colspan="7"><em>RSA Ciphers:</em></td></tr>
  463. <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>
  464. <tr><td><code>DES-CBC3-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>3DES(168)</td> <td>MD5</td> <td /> </tr>
  465. <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>
  466. <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>
  467. <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>
  468. <tr><td><code>IDEA-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>IDEA(128)</td> <td>MD5</td> <td /> </tr>
  469. <tr><td><code>RC2-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC2(128)</td> <td>MD5</td> <td /> </tr>
  470. <tr><td><code>RC4-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC4(128)</td> <td>MD5</td> <td /> </tr>
  471. <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>
  472. <tr><td><code>RC4-64-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>RC4(64)</td> <td>MD5</td> <td /> </tr>
  473. <tr><td><code>DES-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA</td> <td>RSA</td> <td>DES(56)</td> <td>MD5</td> <td /> </tr>
  474. <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>
  475. <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>
  476. <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>
  477. <tr><td><code>EXP-RC2-CBC-MD5</code></td> <td>SSLv2</td> <td>RSA(512)</td> <td>RSA</td> <td>RC2(40)</td> <td>MD5</td> <td>  export</td> </tr>
  478. <tr><td><code>EXP-RC4-MD5</code></td> <td>SSLv2</td> <td>RSA(512)</td> <td>RSA</td> <td>RC4(40)</td> <td>MD5</td> <td>  export</td> </tr>
  479. <tr><td><code>NULL-SHA</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>None</td> <td>SHA1</td> <td /> </tr>
  480. <tr><td><code>NULL-MD5</code></td> <td>SSLv3</td> <td>RSA</td> <td>RSA</td> <td>None</td> <td>MD5</td> <td /> </tr>
  481. <tr><td colspan="7"><em>Diffie-Hellman Ciphers:</em></td></tr>
  482. <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>
  483. <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>
  484. <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>
  485. <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>
  486. <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>
  487. <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>
  488. <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>
  489. <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>
  490. <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>
  491. <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>
  492. <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>
  493. </table>
  494.  
  495. </div>
  496. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  497. <div class="directive-section"><h2><a name="SSLEngine" id="SSLEngine">SSLEngine</a> <a name="sslengine" id="sslengine">Directive</a></h2>
  498. <table class="directive">
  499. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL Engine Operation Switch</td></tr>
  500. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLEngine on|off</code></td></tr>
  501. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLEngine off</code></td></tr>
  502. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  503. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  504. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  505. </table>
  506. <p>
  507. This directive toggles the usage of the SSL/TLS Protocol Engine. This
  508. is usually used inside a <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> section to enable SSL/TLS for a
  509. particular virtual host. By default the SSL/TLS Protocol Engine is
  510. disabled for both the main server and all configured virtual hosts.</p>
  511. <div class="example"><h3>Example</h3><p><code>
  512. <VirtualHost _default_:443><br />
  513. SSLEngine on<br />
  514. ...<br />
  515. </VirtualHost>
  516. </code></p></div>
  517.  
  518. </div>
  519. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  520. <div class="directive-section"><h2><a name="SSLMutex" id="SSLMutex">SSLMutex</a> <a name="sslmutex" id="sslmutex">Directive</a></h2>
  521. <table class="directive">
  522. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Semaphore for internal mutual exclusion of 
  523. operations</td></tr>
  524. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLMutex <em>type</em></code></td></tr>
  525. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLMutex none</code></td></tr>
  526. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  527. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  528. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  529. </table>
  530. <p>
  531. This configures the SSL engine's semaphore (aka. lock) which is used for mutual
  532. exclusion of operations which have to be done in a synchronized way between the
  533. pre-forked Apache server processes. This directive can only be used in the
  534. global server context because it's only useful to have one global mutex.
  535. This directive is designed to closely match the
  536. <a href="http://httpd.apache.org/docs-2.0/mod/mpm_common.html#acceptmutex">AcceptMutex</a> directive</p>
  537. <p>
  538. The following Mutex <em>types</em> are available:</p>
  539. <ul>
  540. <li><code>none | no</code>
  541.     <p>
  542.     This is the default where no Mutex is used at all. Use it at your own
  543.     risk. But because currently the Mutex is mainly used for synchronizing
  544.     write access to the SSL Session Cache you can live without it as long
  545.     as you accept a sometimes garbled Session Cache. So it's not recommended
  546.     to leave this the default. Instead configure a real Mutex.</p></li>
  547. <li><code>posixsem</code>
  548.     <p>
  549.     This is an elegant Mutex variant where a Posix Semaphore is used when possible.
  550.     It is only available when the underlying platform
  551.     and APR supports it.</p></li>
  552. <li><code>sysvsem</code>
  553.     <p>
  554.     This is a somewhat elegant Mutex variant where a SystemV IPC Semaphore is used when
  555.     possible. It is possible to "leak" SysV semaphores if processes crash before
  556.     the semaphore is removed. It is only available when the underlying platform
  557.     and APR supports it.</p></li>
  558. <li><code>sem</code>
  559.     <p>
  560.     This directive tells the SSL Module to pick the "best" semaphore implementation
  561.     available to it, choosing between Posix and SystemV IPC, in that order. It is only
  562.     available when the underlying platform and APR supports at least one of the 2.</p></li>
  563. <li><code>pthread</code>
  564.     <p>
  565.     This directive tells the SSL Module to use Posix thread mutexes. It is only available
  566.     if the underlying platform and APR supports it.</p></li>
  567. <li><code>fcntl:/path/to/mutex</code>
  568.     <p>
  569.     This is a portable Mutex variant where a physical (lock-)file and the <code>fcntl()</code>
  570.     fucntion are used as the Mutex.
  571.     Always use a local disk filesystem for <code>/path/to/mutex</code> and never a file
  572.     residing on a NFS- or AFS-filesystem. It is only available when the underlying platform
  573.     and APR supports it. Note: Internally, the Process ID (PID) of the
  574.     Apache parent process is automatically appended to
  575.     <code>/path/to/mutex</code> to make it unique, so you don't have to worry
  576.     about conflicts yourself. Notice that this type of mutex is not available
  577.     under the Win32 environment. There you <em>have</em> to use the semaphore
  578.     mutex.</p></li>
  579. <li><code>flock:/path/to/mutex</code>
  580.     <p>
  581.     This is similar to the <code>fcntl:/path/to/mutex</code> method with the
  582.     exception that the <code>flock()</code> function is used to provide file
  583.     locking. It is only available when the underlying platform
  584.     and APR supports it.</p></li>
  585. <li><code>file:/path/to/mutex</code>
  586.     <p>
  587.     This directive tells the SSL Module to pick the "best" file locking implementation
  588.     available to it, choosing between <code>fcntl</code> and <code>flock</code>,
  589.     in that order. It is only available when the underlying platform and APR supports
  590.     at least one of the 2.</p></li>
  591. <li><code>default | yes</code>
  592.     <p>
  593.     This directive tells the SSL Module to pick the default locking implementation
  594.     as determined by the platform and APR.</p></li>
  595. </ul>
  596. <div class="example"><h3>Example</h3><p><code>
  597. SSLMutex file:/usr/local/apache/logs/ssl_mutex
  598. </code></p></div>
  599.  
  600. </div>
  601. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  602. <div class="directive-section"><h2><a name="SSLOptions" id="SSLOptions">SSLOptions</a> <a name="ssloptions" id="ssloptions">Directive</a></h2>
  603. <table class="directive">
  604. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure various SSL engine run-time options</td></tr>
  605. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLOptions [+|-]<em>option</em> ...</code></td></tr>
  606. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  607. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
  608. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  609. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  610. </table>
  611. <p>
  612. This directive can be used to control various run-time options on a
  613. per-directory basis. Normally, if multiple <code>SSLOptions</code>
  614. could apply to a directory, then the most specific one is taken
  615. completely; the options are not merged. However if <em>all</em> the
  616. options on the <code>SSLOptions</code> directive are preceded by a
  617. plus (<code>+</code>) or minus (<code>-</code>) symbol, the options
  618. are merged. Any options preceded by a <code>+</code> are added to the
  619. options currently in force, and any options preceded by a
  620. <code>-</code> are removed from the options currently in force.</p>
  621. <p>
  622. The available <em>option</em>s are:</p>
  623. <ul>
  624. <li><code>StdEnvVars</code>
  625.     <p>
  626.     When this option is enabled, the standard set of SSL related CGI/SSI
  627.     environment variables are created. This per default is disabled for
  628.     performance reasons, because the information extraction step is a
  629.     rather expensive operation. So one usually enables this option for
  630.     CGI and SSI requests only.</p>
  631. </li>
  632. <li><code>CompatEnvVars</code>
  633.     <p>
  634.     When this option is enabled, additional CGI/SSI environment variables are
  635.     created for backward compatibility to other Apache SSL solutions. Look in
  636.     the <a href="../ssl/ssl_compat.html">Compatibility</a> chapter for details
  637.     on the particular variables generated.</p>
  638. </li>
  639. <li><code>ExportCertData</code>
  640.     <p>
  641.     When this option is enabled, additional CGI/SSI environment variables are
  642.     created: <code>SSL_SERVER_CERT</code>, <code>SSL_CLIENT_CERT</code> and
  643.     <code>SSL_CLIENT_CERT_CHAIN</code><em>n</em> (with <em>n</em> = 0,1,2,..).
  644.     These contain the PEM-encoded X.509 Certificates of server and client for
  645.     the current HTTPS connection and can be used by CGI scripts for deeper
  646.     Certificate checking. Additionally all other certificates of the client
  647.     certificate chain are provided, too. This bloats up the environment a
  648.     little bit which is why you have to use this option to enable it on
  649.     demand.</p>
  650. </li>
  651. <li><code>FakeBasicAuth</code>
  652.     <p>
  653.     When this option is enabled, the Subject Distinguished Name (DN) of the
  654.     Client X509 Certificate is translated into a HTTP Basic Authorization
  655.     username. This means that the standard Apache authentication methods can
  656.     be used for access control. The user name is just the Subject of the
  657.     Client's X509 Certificate (can be determined by running OpenSSL's
  658.     <code>openssl x509</code> command: <code>openssl x509 -noout -subject -in
  659.     </code><em>certificate</em><code>.crt</code>). Note that no password is
  660.     obtained from the user. Every entry in the user file needs this password:
  661.     ``<code>xxj31ZMTZzkVA</code>'', which is the DES-encrypted version of the
  662.     word `<code>password</code>''. Those who live under MD5-based encryption
  663.     (for instance under FreeBSD or BSD/OS, etc.) should use the following MD5
  664.     hash of the same word: ``<code>$1$OXLyS...$Owx8s2/m9/gfkcRVXzgoE/</code>''.</p>
  665. </li>
  666. <li><code>StrictRequire</code>
  667.     <p>
  668.     This <em>forces</em> forbidden access when <code>SSLRequireSSL</code> or
  669.     <code>SSLRequire</code> successfully decided that access should be
  670.     forbidden. Usually the default is that in the case where a ``<code>Satisfy
  671.     any</code>'' directive is used, and other access restrictions are passed,
  672.     denial of access due to <code>SSLRequireSSL</code> or
  673.     <code>SSLRequire</code> is overridden (because that's how the Apache
  674.     <code>Satisfy</code> mechanism should work.) But for strict access restriction
  675.     you can use <code>SSLRequireSSL</code> and/or <code>SSLRequire</code> in
  676.     combination with an ``<code>SSLOptions +StrictRequire</code>''. Then an
  677.     additional ``<code>Satisfy Any</code>'' has no chance once mod_ssl has
  678.     decided to deny access.</p>
  679. </li>
  680. <li><code>OptRenegotiate</code>
  681.     <p>
  682.     This enables optimized SSL connection renegotiation handling when SSL
  683.     directives are used in per-directory context. By default a strict
  684.     scheme is enabled where <em>every</em> per-directory reconfiguration of
  685.     SSL parameters causes a <em>full</em> SSL renegotiation handshake. When this
  686.     option is used mod_ssl tries to avoid unnecessary handshakes by doing more
  687.     granular (but still safe) parameter checks. Nevertheless these granular
  688.     checks sometimes maybe not what the user expects, so enable this on a
  689.     per-directory basis only, please.</p>
  690. </li>
  691. </ul>
  692. <div class="example"><h3>Example</h3><p><code>
  693. SSLOptions +FakeBasicAuth -StrictRequire<br />
  694. <Files ~ "\.(cgi|shtml)$"><br />
  695.     SSLOptions +StdEnvVars +CompatEnvVars -ExportCertData<br />
  696. <Files>
  697. </code></p></div>
  698.  
  699. </div>
  700. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  701. <div class="directive-section"><h2><a name="SSLPassPhraseDialog" id="SSLPassPhraseDialog">SSLPassPhraseDialog</a> <a name="sslpassphrasedialog" id="sslpassphrasedialog">Directive</a></h2>
  702. <table class="directive">
  703. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of pass phrase dialog for encrypted private 
  704. keys</td></tr>
  705. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLPassPhraseDialog <em>type</em></code></td></tr>
  706. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLPassPhraseDialog builtin</code></td></tr>
  707. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  708. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  709. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  710. </table>
  711. <p>
  712. When Apache starts up it has to read the various Certificate (see
  713. <code class="directive"><a href="#sslcertificatefile">SSLCertificateFile</a></code>) and
  714. Private Key (see <code class="directive"><a href="#sslcertificatekeyfile">SSLCertificateKeyFile</a></code>) files of the
  715. SSL-enabled virtual servers. Because for security reasons the Private
  716. Key files are usually encrypted, mod_ssl needs to query the
  717. administrator for a Pass Phrase in order to decrypt those files. This
  718. query can be done in two ways which can be configured by
  719. <em>type</em>:</p>
  720. <ul>
  721. <li><code>builtin</code>
  722.     <p>
  723.     This is the default where an interactive terminal dialog occurs at startup
  724.     time just before Apache detaches from the terminal. Here the administrator
  725.     has to manually enter the Pass Phrase for each encrypted Private Key file.
  726.     Because a lot of SSL-enabled virtual hosts can be configured, the
  727.     following reuse-scheme is used to minimize the dialog: When a Private Key
  728.     file is encrypted, all known Pass Phrases (at the beginning there are
  729.     none, of course) are tried. If one of those known Pass Phrases succeeds no
  730.     dialog pops up for this particular Private Key file. If none succeeded,
  731.     another Pass Phrase is queried on the terminal and remembered for the next
  732.     round (where it perhaps can be reused).</p>
  733.     <p>
  734.     This scheme allows mod_ssl to be maximally flexible (because for N encrypted
  735.     Private Key files you <em>can</em> use N different Pass Phrases - but then
  736.     you have to enter all of them, of course) while minimizing the terminal
  737.     dialog (i.e. when you use a single Pass Phrase for all N Private Key files
  738.     this Pass Phrase is queried only once).</p></li>
  739.  
  740. <li><code>exec:/path/to/program</code>
  741.     <p>
  742.     Here an external program is configured which is called at startup for each
  743.     encrypted Private Key file. It is called with two arguments (the first is
  744.     of the form ``<code>servername:portnumber</code>'', the second is either
  745.     ``<code>RSA</code>'' or ``<code>DSA</code>''), which indicate for which
  746.     server and algorithm it has to print the corresponding Pass Phrase to
  747.     <code>stdout</code>. The intent is that this external program first runs
  748.     security checks to make sure that the system is not compromised by an
  749.     attacker, and only when these checks were passed successfully it provides
  750.     the Pass Phrase.</p>
  751.     <p>
  752.     Both these security checks, and the way the Pass Phrase is determined, can
  753.     be as complex as you like. Mod_ssl just defines the interface: an
  754.     executable program which provides the Pass Phrase on <code>stdout</code>.
  755.     Nothing more or less! So, if you're really paranoid about security, here
  756.     is your interface. Anything else has to be left as an exercise to the
  757.     administrator, because local security requirements are so different.</p>
  758.     <p>
  759.     The reuse-algorithm above is used here, too. In other words: The external
  760.     program is called only once per unique Pass Phrase.</p></li>
  761. </ul>
  762. <p>
  763. Example:</p>
  764. <div class="example"><p><code>
  765. SSLPassPhraseDialog exec:/usr/local/apache/sbin/pp-filter
  766. </code></p></div>
  767.  
  768. </div>
  769. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  770. <div class="directive-section"><h2><a name="SSLProtocol" id="SSLProtocol">SSLProtocol</a> <a name="sslprotocol" id="sslprotocol">Directive</a></h2>
  771. <table class="directive">
  772. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure usable SSL protocol flavors</td></tr>
  773. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProtocol [+|-]<em>protocol</em> ...</code></td></tr>
  774. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProtocol all</code></td></tr>
  775. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  776. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
  777. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  778. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  779. </table>
  780. <p>
  781. This directive can be used to control the SSL protocol flavors mod_ssl should
  782. use when establishing its server environment. Clients then can only connect
  783. with one of the provided protocols.</p>
  784. <p>
  785. The available (case-insensitive) <em>protocol</em>s are:</p>
  786. <ul>
  787. <li><code>SSLv2</code>
  788.     <p>
  789.     This is the Secure Sockets Layer (SSL) protocol, version 2.0. It is the
  790.     original SSL protocol as designed by Netscape Corporation.</p></li>
  791.  
  792. <li><code>SSLv3</code>
  793.     <p>
  794.     This is the Secure Sockets Layer (SSL) protocol, version 3.0. It is the
  795.     successor to SSLv2 and the currently (as of February 1999) de-facto
  796.     standardized SSL protocol from Netscape Corporation. It's supported by
  797.     almost all popular browsers.</p></li>
  798.  
  799. <li><code>TLSv1</code>
  800.     <p>
  801.     This is the Transport Layer Security (TLS) protocol, version 1.0. It is the
  802.     successor to SSLv3 and currently (as of February 1999) still under
  803.     construction by the Internet Engineering Task Force (IETF). It's still
  804.     not supported by any popular browsers.</p></li>
  805.  
  806. <li><code>All</code>
  807.     <p>
  808.     This is a shortcut for ``<code>+SSLv2 +SSLv3 +TLSv1</code>'' and a
  809.     convinient way for enabling all protocols except one when used in
  810.     combination with the minus sign on a protocol as the example above 
  811.     shows.</p></li>
  812. </ul>
  813. <div class="example"><h3>Example</h3><p><code>
  814. #   enable SSLv3 and TLSv1, but not SSLv2<br />
  815. SSLProtocol all -SSLv2
  816. </code></p></div>
  817.  
  818. </div>
  819. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  820. <div class="directive-section"><h2><a name="SSLProxyCACertificateFile" id="SSLProxyCACertificateFile">SSLProxyCACertificateFile</a> <a name="sslproxycacertificatefile" id="sslproxycacertificatefile">Directive</a></h2>
  821. <table class="directive">
  822. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA Certificates 
  823. for Remote Server Auth</td></tr>
  824. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCACertificateFile <em>file-path</em></code></td></tr>
  825. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  826. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  827. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  828. </table>
  829. <p>
  830. This directive sets the <em>all-in-one</em> file where you can assemble the
  831. Certificates of Certification Authorities (CA) whose <em>remote servers</em> you deal
  832. with. These are used for Remote Server Authentication. Such a file is simply the
  833. concatenation of the various PEM-encoded Certificate files, in order of
  834. preference. This can be used alternatively and/or additionally to 
  835. <code class="directive"><a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></code>.</p>
  836. <div class="example"><h3>Example</h3><p><code>
  837. SSLProxyCACertificateFile /usr/local/apache2/conf/ssl.crt/ca-bundle-remote-server.crt
  838. </code></p></div>
  839.  
  840. </div>
  841. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  842. <div class="directive-section"><h2><a name="SSLProxyCACertificatePath" id="SSLProxyCACertificatePath">SSLProxyCACertificatePath</a> <a name="sslproxycacertificatepath" id="sslproxycacertificatepath">Directive</a></h2>
  843. <table class="directive">
  844. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA Certificates for 
  845. Remote Server Auth</td></tr>
  846. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCACertificatePath <em>directory-path</em></code></td></tr>
  847. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  848. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  849. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  850. </table>
  851. <p>
  852. This directive sets the directory where you keep the Certificates of
  853. Certification Authorities (CAs) whose remote servers you deal with. These are used to
  854. verify the remote server certificate on Remote Server Authentication.</p>
  855. <p>
  856. The files in this directory have to be PEM-encoded and are accessed through
  857. hash filenames. So usually you can't just place the Certificate files
  858. there: you also have to create symbolic links named
  859. <em>hash-value</em><code>.N</code>. And you should always make sure this directory
  860. contains the appropriate symbolic links. Use the <code>Makefile</code> which
  861. comes with mod_ssl to accomplish this task.</p>
  862. <div class="example"><h3>Example</h3><p><code>
  863. SSLProxyCACertificatePath /usr/local/apache2/conf/ssl.crt/
  864. </code></p></div>
  865.  
  866. </div>
  867. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  868. <div class="directive-section"><h2><a name="SSLProxyCARevocationFile" id="SSLProxyCARevocationFile">SSLProxyCARevocationFile</a> <a name="sslproxycarevocationfile" id="sslproxycarevocationfile">Directive</a></h2>
  869. <table class="directive">
  870. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File of concatenated PEM-encoded CA CRLs for 
  871. Remote Server Auth</td></tr>
  872. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationFile <em>file-path</em></code></td></tr>
  873. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  874. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  875. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  876. </table>
  877. <p>
  878. This directive sets the <em>all-in-one</em> file where you can
  879. assemble the Certificate Revocation Lists (CRL) of Certification
  880. Authorities (CA) whose <em>remote servers</em> you deal with. These are used
  881. for Remote Server Authentication.  Such a file is simply the concatenation of
  882. the various PEM-encoded CRL files, in order of preference. This can be
  883. used alternatively and/or additionally to <code class="directive"><a href="#sslproxycarevocationpath">SSLProxyCARevocationPath</a></code>.</p>
  884. <div class="example"><h3>Example</h3><p><code>
  885. SSLProxyCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-remote-server.crl
  886. </code></p></div>
  887.  
  888. </div>
  889. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  890. <div class="directive-section"><h2><a name="SSLProxyCARevocationPath" id="SSLProxyCARevocationPath">SSLProxyCARevocationPath</a> <a name="sslproxycarevocationpath" id="sslproxycarevocationpath">Directive</a></h2>
  891. <table class="directive">
  892. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory of PEM-encoded CA CRLs for 
  893. Remote Server Auth</td></tr>
  894. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCARevocationPath <em>directory-path</em></code></td></tr>
  895. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  896. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  897. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  898. </table>
  899. <p>
  900. This directive sets the directory where you keep the Certificate Revocation
  901. Lists (CRL) of Certification Authorities (CAs) whose remote servers you deal with.
  902. These are used to revoke the remote server certificate on Remote Server Authentication.</p>
  903. <p>
  904. The files in this directory have to be PEM-encoded and are accessed through
  905. hash filenames. So usually you have not only to place the CRL files there.
  906. Additionally you have to create symbolic links named
  907. <em>hash-value</em><code>.rN</code>. And you should always make sure this directory
  908. contains the appropriate symbolic links. Use the <code>Makefile</code> which
  909. comes with <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> to accomplish this task.</p>
  910. <div class="example"><h3>Example</h3><p><code>
  911. SSLProxyCARevocationPath /usr/local/apache2/conf/ssl.crl/
  912. </code></p></div>
  913.  
  914. </div>
  915. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  916. <div class="directive-section"><h2><a name="SSLProxyCipherSuite" id="SSLProxyCipherSuite">SSLProxyCipherSuite</a> <a name="sslproxyciphersuite" id="sslproxyciphersuite">Directive</a></h2>
  917. <table class="directive">
  918. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Cipher Suite available for negotiation in SSL 
  919. proxy handshake</td></tr>
  920. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyCipherSuite <em>cipher-spec</em></code></td></tr>
  921. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyCipherSuite ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP</code></td></tr>
  922. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  923. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  924. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  925. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  926. </table>
  927. <p>Equivalent to <code>SSLCipherSuite</code>, but for the proxy connection.
  928. Please refer to <code class="directive"><a href="#sslciphersuite">SSLCipherSuite</a></code>
  929. for additional information.</p>
  930.  
  931. </div>
  932. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  933. <div class="directive-section"><h2><a name="SSLProxyEngine" id="SSLProxyEngine">SSLProxyEngine</a> <a name="sslproxyengine" id="sslproxyengine">Directive</a></h2>
  934. <table class="directive">
  935. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SSL Proxy Engine Operation Switch</td></tr>
  936. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyEngine on|off</code></td></tr>
  937. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyEngine off</code></td></tr>
  938. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  939. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  940. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  941. </table>
  942. <p>
  943. This directive toggles the usage of the SSL/TLS Protocol Engine for proxy. This
  944. is usually used inside a <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> section to enable SSL/TLS for proxy
  945. usage in a particular virtual host. By default the SSL/TLS Protocol Engine is
  946. disabled for proxy image both for the main server and all configured virtual hosts.</p>
  947. <div class="example"><h3>Example</h3><p><code>
  948. <VirtualHost _default_:443><br />
  949. SSLProxyEngine on<br />
  950. ...<br />
  951. </VirtualHost>
  952. </code></p></div>
  953.  
  954. </div>
  955. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  956. <div class="directive-section"><h2><a name="SSLProxyMachineCertificateFile" id="SSLProxyMachineCertificateFile">SSLProxyMachineCertificateFile</a> <a name="sslproxymachinecertificatefile" id="sslproxymachinecertificatefile">Directive</a></h2>
  957. <table class="directive">
  958. <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>
  959. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificateFile <em>filename</em></code></td></tr>
  960. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  961. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
  962. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  963. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  964. </table>
  965. <p>
  966. This directive sets the all-in-one file where you keep the certificates and
  967. keys used for authentication of the proxy server to remote servers.
  968. </p>
  969. <p>
  970. This referenced file is simply the concatenation of the various PEM-encoded
  971. certificate files, in order of preference. Use this directive alternatively
  972. or additionally to <code>SSLProxyMachineCertificatePath</code>.
  973. </p>
  974. <div class="warning">
  975. <p>Currently there is no support for encrypted private keys</p>
  976. </div>
  977. <p>
  978. Example:</p>
  979. <div class="example"><p><code>
  980. SSLProxyMachineCertificateFile /usr/local/apache2/conf/ssl.crt/proxy.pem
  981. </code></p></div>
  982.  
  983. </div>
  984. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  985. <div class="directive-section"><h2><a name="SSLProxyMachineCertificatePath" id="SSLProxyMachineCertificatePath">SSLProxyMachineCertificatePath</a> <a name="sslproxymachinecertificatepath" id="sslproxymachinecertificatepath">Directive</a></h2>
  986. <table class="directive">
  987. <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>
  988. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyMachineCertificatePath <em>directory</em></code></td></tr>
  989. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  990. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Not applicable</td></tr>
  991. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  992. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  993. </table>
  994. <p>
  995. This directive sets the directory where you keep the certificates and
  996. keys used for authentication of the proxy server to remote servers.
  997. </p>
  998. <p>The files in this directory must be PEM-encoded and are accessed through
  999. hash filenames. Additionally, you must create symbolic links named
  1000. <code><em>hash-value</em>.N</code>. And you should always make sure this
  1001. directory contains the appropriate symbolic links. Use the Makefile which
  1002. comes with mod_ssl to accomplish this task.
  1003. </p>
  1004. <div class="warning">
  1005. <p>Currently there is no support for encrypted private keys</p>
  1006. </div>
  1007. <p>
  1008. Example:</p>
  1009. <div class="example"><p><code>
  1010. SSLProxyMachineCertificatePath /usr/local/apache2/conf/proxy.crt/
  1011. </code></p></div> 
  1012.  
  1013. </div>
  1014. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1015. <div class="directive-section"><h2><a name="SSLProxyProtocol" id="SSLProxyProtocol">SSLProxyProtocol</a> <a name="sslproxyprotocol" id="sslproxyprotocol">Directive</a></h2>
  1016. <table class="directive">
  1017. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure usable SSL protocol flavors for proxy usage</td></tr>
  1018. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyProtocol [+|-]<em>protocol</em> ...</code></td></tr>
  1019. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyProtocol all</code></td></tr>
  1020. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  1021. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
  1022. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1023. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1024. </table>
  1025.  
  1026. <p>
  1027. This directive can be used to control the SSL protocol flavors mod_ssl should
  1028. use when establishing its server environment for proxy . It will only connect
  1029. to servers using one of the provided protocols.</p>
  1030. <p>Please refer to <code class="directive"><a href="#sslprotocol">SSLProtocol</a></code>
  1031. for additional information.
  1032. </p>
  1033.  
  1034. </div>
  1035. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1036. <div class="directive-section"><h2><a name="SSLProxyVerify" id="SSLProxyVerify">SSLProxyVerify</a> <a name="sslproxyverify" id="sslproxyverify">Directive</a></h2>
  1037. <table class="directive">
  1038. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of remote server Certificate verification</td></tr>
  1039. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyVerify <em>level</em></code></td></tr>
  1040. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyVerify none</code></td></tr>
  1041. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  1042. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  1043. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1044. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1045. </table>
  1046. <p>
  1047. This directive sets the Certificate verification level for the remote server
  1048. Authentication. Notice that this directive can be used both in per-server and
  1049. per-directory context. In per-server context it applies to the remote server
  1050. authentication process used in the standard SSL handshake when a connection is
  1051. established. In per-directory context it forces a SSL renegotation with the
  1052. reconfigured remote server verification level after the HTTP request was read but
  1053. before the HTTP response is sent.</p>
  1054. <p>
  1055. The following levels are available for <em>level</em>:</p>
  1056. <ul>
  1057. <li><strong>none</strong>:
  1058.      no remote server Certificate is required at all</li>
  1059. <li><strong>optional</strong>:
  1060.      the remote server <em>may</em> present a valid Certificate</li>
  1061. <li><strong>require</strong>:
  1062.      the remote server <em>has to</em> present a valid Certificate</li>
  1063. <li><strong>optional_no_ca</strong>:
  1064.      the remote server may present a valid Certificate<br />
  1065.      but it need not to be (successfully) verifiable.</li>
  1066. </ul>
  1067. <p>In practice only levels <strong>none</strong> and
  1068. <strong>require</strong> are really interesting, because level
  1069. <strong>optional</strong> doesn't work with all servers and level
  1070. <strong>optional_no_ca</strong> is actually against the idea of
  1071. authentication (but can be used to establish SSL test pages, etc.)</p>
  1072. <div class="example"><h3>Example</h3><p><code>
  1073. SSLProxyVerify require
  1074. </code></p></div>
  1075.  
  1076. </div>
  1077. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1078. <div class="directive-section"><h2><a name="SSLProxyVerifyDepth" id="SSLProxyVerifyDepth">SSLProxyVerifyDepth</a> <a name="sslproxyverifydepth" id="sslproxyverifydepth">Directive</a></h2>
  1079. <table class="directive">
  1080. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum depth of CA Certificates in Remote Server
  1081. Certificate verification</td></tr>
  1082. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLProxyVerifyDepth <em>number</em></code></td></tr>
  1083. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLProxyVerifyDepth 1</code></td></tr>
  1084. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  1085. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  1086. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1087. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1088. </table>
  1089. <p>
  1090. This directive sets how deeply mod_ssl should verify before deciding that the
  1091. remote server does not have a valid certificate. Notice that this directive can be
  1092. used both in per-server and per-directory context. In per-server context it
  1093. applies to the client authentication process used in the standard SSL
  1094. handshake when a connection is established. In per-directory context it forces
  1095. a SSL renegotation with the reconfigured remote server verification depth after the
  1096. HTTP request was read but before the HTTP response is sent.</p>
  1097. <p>
  1098. The depth actually is the maximum number of intermediate certificate issuers,
  1099. i.e. the number of CA certificates which are max allowed to be followed while
  1100. verifying the remote server certificate. A depth of 0 means that self-signed
  1101. remote server certificates are accepted only, the default depth of 1 means
  1102. the remote server certificate can be self-signed or has to be signed by a CA
  1103. which is directly known to the server (i.e. the CA's certificate is under
  1104. <code class="directive"><a href="#sslproxycacertificatepath">SSLProxyCACertificatePath</a></code>), etc.</p>
  1105. <div class="example"><h3>Example</h3><p><code>
  1106. SSLProxyVerifyDepth 10
  1107. </code></p></div>
  1108.  
  1109. </div>
  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="SSLRandomSeed" id="SSLRandomSeed">SSLRandomSeed</a> <a name="sslrandomseed" id="sslrandomseed">Directive</a></h2>
  1112. <table class="directive">
  1113. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pseudo Random Number Generator (PRNG) seeding 
  1114. source</td></tr>
  1115. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRandomSeed <em>context</em> <em>source</em> 
  1116. [<em>bytes</em>]</code></td></tr>
  1117. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  1118. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1119. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1120. </table>
  1121. <p>
  1122. This configures one or more sources for seeding the Pseudo Random Number
  1123. Generator (PRNG) in OpenSSL at startup time (<em>context</em> is
  1124. <code>startup</code>) and/or just before a new SSL connection is established
  1125. (<em>context</em> is <code>connect</code>). This directive can only be used
  1126. in the global server context because the PRNG is a global facility.</p>
  1127. <p>
  1128. The following <em>source</em> variants are available:</p>
  1129. <ul>
  1130. <li><code>builtin</code>
  1131.     <p> This is the always available builtin seeding source. It's usage
  1132.     consumes minimum CPU cycles under runtime and hence can be always used
  1133.     without drawbacks. The source used for seeding the PRNG contains of the
  1134.     current time, the current process id and (when applicable) a randomly
  1135.     choosen 1KB extract of the inter-process scoreboard structure of Apache.
  1136.     The drawback is that this is not really a strong source and at startup
  1137.     time (where the scoreboard is still not available) this source just
  1138.     produces a few bytes of entropy. So you should always, at least for the
  1139.     startup, use an additional seeding source.</p></li>
  1140. <li><code>file:/path/to/source</code>
  1141.     <p>
  1142.     This variant uses an external file <code>/path/to/source</code> as the
  1143.     source for seeding the PRNG. When <em>bytes</em> is specified, only the
  1144.     first <em>bytes</em> number of bytes of the file form the entropy (and
  1145.     <em>bytes</em> is given to <code>/path/to/source</code> as the first
  1146.     argument). When <em>bytes</em> is not specified the whole file forms the
  1147.     entropy (and <code>0</code> is given to <code>/path/to/source</code> as
  1148.     the first argument). Use this especially at startup time, for instance
  1149.     with an available <code>/dev/random</code> and/or
  1150.     <code>/dev/urandom</code> devices (which usually exist on modern Unix
  1151.     derivates like FreeBSD and Linux).</p>
  1152.     <p>
  1153.     <em>But be careful</em>: Usually <code>/dev/random</code> provides only as
  1154.     much entropy data as it actually has, i.e. when you request 512 bytes of
  1155.     entropy, but the device currently has only 100 bytes available two things
  1156.     can happen: On some platforms you receive only the 100 bytes while on
  1157.     other platforms the read blocks until enough bytes are available (which
  1158.     can take a long time). Here using an existing <code>/dev/urandom</code> is
  1159.     better, because it never blocks and actually gives the amount of requested
  1160.     data. The drawback is just that the quality of the received data may not
  1161.     be the best.</p>
  1162.     <p>
  1163.     On some platforms like FreeBSD one can even control how the entropy is
  1164.     actually generated, i.e. by which system interrupts. More details one can
  1165.     find under <em>rndcontrol(8)</em> on those platforms. Alternatively, when
  1166.     your system lacks such a random device, you can use tool
  1167.     like <a href="http://www.lothar.com/tech/crypto/">EGD</a>
  1168.     (Entropy Gathering Daemon) and run it's client program with the
  1169.     <code>exec:/path/to/program/</code> variant (see below) or use
  1170.     <code>egd:/path/to/egd-socket</code> (see below).</p></li>
  1171.  
  1172. <li><code>exec:/path/to/program</code>
  1173.     <p>
  1174.     This variant uses an external executable
  1175.     <code>/path/to/program</code> as the source for seeding the
  1176.     PRNG. When <em>bytes</em> is specified, only the first
  1177.     <em>bytes</em> number of bytes of its <code>stdout</code> contents
  1178.     form the entropy. When <em>bytes</em> is not specified, the
  1179.     entirety of the data produced on <code>stdout</code> form the
  1180.     entropy. Use this only at startup time when you need a very strong
  1181.     seeding with the help of an external program (for instance as in
  1182.     the example above with the <code>truerand</code> utility you can
  1183.     find in the mod_ssl distribution which is based on the AT&T
  1184.     <em>truerand</em> library). Using this in the connection context
  1185.     slows down the server too dramatically, of course.  So usually you
  1186.     should avoid using external programs in that context.</p></li>
  1187. <li><code>egd:/path/to/egd-socket</code> (Unix only)
  1188.     <p>
  1189.     This variant uses the Unix domain socket of the
  1190.     external Entropy Gathering Daemon (EGD) (see <a href="http://www.lothar.com/tech/crypto/">http://www.lothar.com/tech
  1191.     /crypto/</a>) to seed the PRNG. Use this if no random device exists
  1192.     on your platform.</p></li>
  1193. </ul>
  1194. <div class="example"><h3>Example</h3><p><code>
  1195. SSLRandomSeed startup builtin<br />
  1196. SSLRandomSeed startup file:/dev/random<br />
  1197. SSLRandomSeed startup file:/dev/urandom 1024<br />
  1198. SSLRandomSeed startup exec:/usr/local/bin/truerand 16<br />
  1199. SSLRandomSeed connect builtin<br />
  1200. SSLRandomSeed connect file:/dev/random<br />
  1201. SSLRandomSeed connect file:/dev/urandom 1024<br />
  1202. </code></p></div>
  1203.  
  1204. </div>
  1205. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1206. <div class="directive-section"><h2><a name="SSLRequire" id="SSLRequire">SSLRequire</a> <a name="sslrequire" id="sslrequire">Directive</a></h2>
  1207. <table class="directive">
  1208. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow access only when an arbitrarily complex 
  1209. boolean expression is true</td></tr>
  1210. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRequire <em>expression</em></code></td></tr>
  1211. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  1212. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  1213. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1214. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1215. </table>
  1216. <p>
  1217. This directive specifies a general access requirement which has to be
  1218. fulfilled in order to allow access. It's a very powerful directive because the
  1219. requirement specification is an arbitrarily complex boolean expression
  1220. containing any number of access checks.</p>
  1221. <p>
  1222. The <em>expression</em> must match the following syntax (given as a BNF
  1223. grammar notation):</p>
  1224. <blockquote>
  1225. <pre>
  1226. expr     ::= "<strong>true</strong>" | "<strong>false</strong>"
  1227.            | "<strong>!</strong>" expr
  1228.            | expr "<strong>&&</strong>" expr
  1229.            | expr "<strong>||</strong>" expr
  1230.            | "<strong>(</strong>" expr "<strong>)</strong>"
  1231.            | comp
  1232.  
  1233. comp     ::= word "<strong>==</strong>" word | word "<strong>eq</strong>" word
  1234.            | word "<strong>!=</strong>" word | word "<strong>ne</strong>" word
  1235.            | word "<strong><</strong>"  word | word "<strong>lt</strong>" word
  1236.            | word "<strong><=</strong>" word | word "<strong>le</strong>" word
  1237.            | word "<strong>></strong>"  word | word "<strong>gt</strong>" word
  1238.            | word "<strong>>=</strong>" word | word "<strong>ge</strong>" word
  1239.            | word "<strong>in</strong>" "<strong>{</strong>" wordlist "<strong>}</strong>"
  1240.            | word "<strong>=~</strong>" regex
  1241.            | word "<strong>!~</strong>" regex
  1242.  
  1243. wordlist ::= word
  1244.            | wordlist "<strong>,</strong>" word
  1245.  
  1246. word     ::= digit
  1247.            | cstring
  1248.            | variable
  1249.            | function
  1250.  
  1251. digit    ::= [0-9]+
  1252. cstring  ::= "..."
  1253. variable ::= "<strong>%{</strong>" varname "<strong>}</strong>"
  1254. function ::= funcname "<strong>(</strong>" funcargs "<strong>)</strong>"
  1255. </pre>
  1256. </blockquote>
  1257. <p>while for <code>varname</code> any variable from <a href="#table3">Table 3</a> can be used. Finally for
  1258. <code>funcname</code> the following functions are available:</p>
  1259. <ul>
  1260. <li><code>file(</code><em>filename</em><code>)</code>
  1261.     <p>
  1262.     This function takes one string argument and expands to the contents of the
  1263.     file. This is especially useful for matching this contents against a
  1264.     regular expression, etc.</p>
  1265. </li>
  1266. </ul>
  1267. <p>Notice that <em>expression</em> is first parsed into an internal machine
  1268. representation and then evaluated in a second step. Actually, in Global and
  1269. Per-Server Class context <em>expression</em> is parsed at startup time and
  1270. at runtime only the machine representation is executed. For Per-Directory
  1271. context this is different: here <em>expression</em> has to be parsed and
  1272. immediately executed for every request.</p>
  1273. <div class="example"><h3>Example</h3><p><code>
  1274. SSLRequire (    %{SSL_CIPHER} !~ m/^(EXP|NULL)-/ \<br />
  1275.             and %{SSL_CLIENT_S_DN_O} eq "Snake Oil, Ltd." \<br />
  1276.             and %{SSL_CLIENT_S_DN_OU} in {"Staff", "CA", "Dev"} \<br />
  1277.             and %{TIME_WDAY} >= 1 and %{TIME_WDAY} <= 5 \<br />
  1278.             and %{TIME_HOUR} >= 8 and %{TIME_HOUR} <= 20       ) \<br />
  1279.            or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/
  1280. </code></p></div>
  1281.  
  1282. <p><em>Standard CGI/1.0 and Apache variables:</em></p>
  1283. <pre>
  1284. HTTP_USER_AGENT        PATH_INFO             AUTH_TYPE
  1285. HTTP_REFERER           QUERY_STRING          SERVER_SOFTWARE
  1286. HTTP_COOKIE            REMOTE_HOST           API_VERSION
  1287. HTTP_FORWARDED         REMOTE_IDENT          TIME_YEAR
  1288. HTTP_HOST              IS_SUBREQ             TIME_MON
  1289. HTTP_PROXY_CONNECTION  DOCUMENT_ROOT         TIME_DAY
  1290. HTTP_ACCEPT            SERVER_ADMIN          TIME_HOUR
  1291. HTTP:headername        SERVER_NAME           TIME_MIN
  1292. THE_REQUEST            SERVER_PORT           TIME_SEC
  1293. REQUEST_METHOD         SERVER_PROTOCOL       TIME_WDAY
  1294. REQUEST_SCHEME         REMOTE_ADDR           TIME
  1295. REQUEST_URI            REMOTE_USER           ENV:<strong>variablename</strong>
  1296. REQUEST_FILENAME
  1297. </pre>
  1298. <p><em>SSL-related variables:</em></p>
  1299. <pre>
  1300. HTTPS                  SSL_CLIENT_M_VERSION   SSL_SERVER_M_VERSION
  1301.                        SSL_CLIENT_M_SERIAL    SSL_SERVER_M_SERIAL
  1302. SSL_PROTOCOL           SSL_CLIENT_V_START     SSL_SERVER_V_START
  1303. SSL_SESSION_ID         SSL_CLIENT_V_END       SSL_SERVER_V_END
  1304. SSL_CIPHER             SSL_CLIENT_S_DN        SSL_SERVER_S_DN
  1305. SSL_CIPHER_EXPORT      SSL_CLIENT_S_DN_C      SSL_SERVER_S_DN_C
  1306. SSL_CIPHER_ALGKEYSIZE  SSL_CLIENT_S_DN_ST     SSL_SERVER_S_DN_ST
  1307. SSL_CIPHER_USEKEYSIZE  SSL_CLIENT_S_DN_L      SSL_SERVER_S_DN_L
  1308. SSL_VERSION_LIBRARY    SSL_CLIENT_S_DN_O      SSL_SERVER_S_DN_O
  1309. SSL_VERSION_INTERFACE  SSL_CLIENT_S_DN_OU     SSL_SERVER_S_DN_OU
  1310.                        SSL_CLIENT_S_DN_CN     SSL_SERVER_S_DN_CN
  1311.                        SSL_CLIENT_S_DN_T      SSL_SERVER_S_DN_T
  1312.                        SSL_CLIENT_S_DN_I      SSL_SERVER_S_DN_I
  1313.                        SSL_CLIENT_S_DN_G      SSL_SERVER_S_DN_G
  1314.                        SSL_CLIENT_S_DN_S      SSL_SERVER_S_DN_S
  1315.                        SSL_CLIENT_S_DN_D      SSL_SERVER_S_DN_D
  1316.                        SSL_CLIENT_S_DN_UID    SSL_SERVER_S_DN_UID
  1317.                        SSL_CLIENT_S_DN_Email  SSL_SERVER_S_DN_Email
  1318.                        SSL_CLIENT_I_DN        SSL_SERVER_I_DN
  1319.                        SSL_CLIENT_I_DN_C      SSL_SERVER_I_DN_C
  1320.                        SSL_CLIENT_I_DN_ST     SSL_SERVER_I_DN_ST
  1321.                        SSL_CLIENT_I_DN_L      SSL_SERVER_I_DN_L
  1322.                        SSL_CLIENT_I_DN_O      SSL_SERVER_I_DN_O
  1323.                        SSL_CLIENT_I_DN_OU     SSL_SERVER_I_DN_OU
  1324.                        SSL_CLIENT_I_DN_CN     SSL_SERVER_I_DN_CN
  1325.                        SSL_CLIENT_I_DN_T      SSL_SERVER_I_DN_T
  1326.                        SSL_CLIENT_I_DN_I      SSL_SERVER_I_DN_I
  1327.                        SSL_CLIENT_I_DN_G      SSL_SERVER_I_DN_G
  1328.                        SSL_CLIENT_I_DN_S      SSL_SERVER_I_DN_S
  1329.                        SSL_CLIENT_I_DN_D      SSL_SERVER_I_DN_D
  1330.                        SSL_CLIENT_I_DN_UID    SSL_SERVER_I_DN_UID
  1331.                        SSL_CLIENT_I_DN_Email  SSL_SERVER_I_DN_Email
  1332.                        SSL_CLIENT_A_SIG       SSL_SERVER_A_SIG
  1333.                        SSL_CLIENT_A_KEY       SSL_SERVER_A_KEY
  1334.                        SSL_CLIENT_CERT        SSL_SERVER_CERT
  1335.                        SSL_CLIENT_CERT_CHAIN<strong>n</strong>
  1336.                        SSL_CLIENT_VERIFY
  1337. </pre>
  1338.  
  1339. </div>
  1340. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1341. <div class="directive-section"><h2><a name="SSLRequireSSL" id="SSLRequireSSL">SSLRequireSSL</a> <a name="sslrequiressl" id="sslrequiressl">Directive</a></h2>
  1342. <table class="directive">
  1343. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Deny access when SSL is not used for the 
  1344. HTTP request</td></tr>
  1345. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLRequireSSL</code></td></tr>
  1346. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  1347. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  1348. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1349. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1350. </table>
  1351. <p>
  1352. This directive forbids access unless HTTP over SSL (i.e. HTTPS) is enabled for
  1353. the current connection. This is very handy inside the SSL-enabled virtual
  1354. host or directories for defending against configuration errors that expose
  1355. stuff that should be protected. When this directive is present all requests
  1356. are denied which are not using SSL.</p>
  1357. <div class="example"><h3>Example</h3><p><code>
  1358. SSLRequireSSL
  1359. </code></p></div>
  1360.  
  1361. </div>
  1362. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1363. <div class="directive-section"><h2><a name="SSLSessionCache" id="SSLSessionCache">SSLSessionCache</a> <a name="sslsessioncache" id="sslsessioncache">Directive</a></h2>
  1364. <table class="directive">
  1365. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of the global/inter-process SSL Session 
  1366. Cache</td></tr>
  1367. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionCache <em>type</em></code></td></tr>
  1368. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionCache none</code></td></tr>
  1369. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  1370. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1371. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1372. </table>
  1373. <p>
  1374. This configures the storage type of the global/inter-process SSL Session
  1375. Cache. This cache is an optional facility which speeds up parallel request
  1376. processing. For requests to the same server process (via HTTP keep-alive),
  1377. OpenSSL already caches the SSL session information locally. But because modern
  1378. clients request inlined images and other data via parallel requests (usually
  1379. up to four parallel requests are common) those requests are served by
  1380. <em>different</em> pre-forked server processes. Here an inter-process cache
  1381. helps to avoid unneccessary session handshakes.</p>
  1382. <p>
  1383. The following two storage <em>type</em>s are currently supported:</p>
  1384. <ul>
  1385. <li><code>none</code>
  1386.     <p>
  1387.     This is the default and just disables the global/inter-process Session
  1388.     Cache. There is no drawback in functionality, but a noticeable speed
  1389.     penalty can be observed.</p></li>
  1390. <li><code>dbm:/path/to/datafile</code>
  1391.     <p>
  1392.     This makes use of a DBM hashfile on the local disk to synchronize the
  1393.     local OpenSSL memory caches of the server processes. The slight increase
  1394.     in I/O on the server results in a visible request speedup for your
  1395.     clients, so this type of storage is generally recommended.</p></li>
  1396. <li><code>shm:/path/to/datafile</code>[<code>(</code><em>size</em><code>)</code>]
  1397.     <p>
  1398.     This makes use of a high-performance hash table (approx. <em>size</em> bytes
  1399.     in size) inside a shared memory segment in RAM (established via
  1400.     <code>/path/to/datafile</code>) to synchronize the local OpenSSL memory
  1401.     caches of the server processes. This storage type is not available on all
  1402.     platforms.</p></li>
  1403. </ul>
  1404. <div class="example"><h3>Examples</h3><p><code>
  1405. SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data<br />
  1406. SSLSessionCache shm:/usr/local/apache/logs/ssl_gcache_data(512000)
  1407. </code></p></div>
  1408.  
  1409. </div>
  1410. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1411. <div class="directive-section"><h2><a name="SSLSessionCacheTimeout" id="SSLSessionCacheTimeout">SSLSessionCacheTimeout</a> <a name="sslsessioncachetimeout" id="sslsessioncachetimeout">Directive</a></h2>
  1412. <table class="directive">
  1413. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of seconds before an SSL session expires
  1414. in the Session Cache</td></tr>
  1415. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLSessionCacheTimeout <em>seconds</em></code></td></tr>
  1416. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLSessionCacheTimeout 300</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>
  1420. </table>
  1421. <p>
  1422. This directive sets the timeout in seconds for the information stored in the
  1423. global/inter-process SSL Session Cache and the OpenSSL internal memory cache.
  1424. It can be set as low as 15 for testing, but should be set to higher
  1425. values like 300 in real life.</p>
  1426. <div class="example"><h3>Example</h3><p><code>
  1427. SSLSessionCacheTimeout 600
  1428. </code></p></div>
  1429.  
  1430. </div>
  1431. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1432. <div class="directive-section"><h2><a name="SSLVerifyClient" id="SSLVerifyClient">SSLVerifyClient</a> <a name="sslverifyclient" id="sslverifyclient">Directive</a></h2>
  1433. <table class="directive">
  1434. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of Client Certificate verification</td></tr>
  1435. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLVerifyClient <em>level</em></code></td></tr>
  1436. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLVerifyClient none</code></td></tr>
  1437. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  1438. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  1439. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1440. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1441. </table>
  1442. <p>
  1443. This directive sets the Certificate verification level for the Client
  1444. Authentication. Notice that this directive can be used both in per-server and
  1445. per-directory context. In per-server context it applies to the client
  1446. authentication process used in the standard SSL handshake when a connection is
  1447. established. In per-directory context it forces a SSL renegotation with the
  1448. reconfigured client verification level after the HTTP request was read but
  1449. before the HTTP response is sent.</p>
  1450. <p>
  1451. The following levels are available for <em>level</em>:</p>
  1452. <ul>
  1453. <li><strong>none</strong>:
  1454.      no client Certificate is required at all</li>
  1455. <li><strong>optional</strong>:
  1456.      the client <em>may</em> present a valid Certificate</li>
  1457. <li><strong>require</strong>:
  1458.      the client <em>has to</em> present a valid Certificate</li>
  1459. <li><strong>optional_no_ca</strong>:
  1460.      the client may present a valid Certificate<br />
  1461.      but it need not to be (successfully) verifiable.</li>
  1462. </ul>
  1463. <p>In practice only levels <strong>none</strong> and
  1464. <strong>require</strong> are really interesting, because level
  1465. <strong>optional</strong> doesn't work with all browsers and level
  1466. <strong>optional_no_ca</strong> is actually against the idea of
  1467. authentication (but can be used to establish SSL test pages, etc.)</p>
  1468. <div class="example"><h3>Example</h3><p><code>
  1469. SSLVerifyClient require
  1470. </code></p></div>
  1471.  
  1472. </div>
  1473. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1474. <div class="directive-section"><h2><a name="SSLVerifyDepth" id="SSLVerifyDepth">SSLVerifyDepth</a> <a name="sslverifydepth" id="sslverifydepth">Directive</a></h2>
  1475. <table class="directive">
  1476. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum depth of CA Certificates in Client 
  1477. Certificate verification</td></tr>
  1478. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SSLVerifyDepth <em>number</em></code></td></tr>
  1479. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SSLVerifyDepth 1</code></td></tr>
  1480. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  1481. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  1482. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  1483. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl</td></tr>
  1484. </table>
  1485. <p>
  1486. This directive sets how deeply mod_ssl should verify before deciding that the
  1487. clients don't have a valid certificate. Notice that this directive can be
  1488. used both in per-server and per-directory context. In per-server context it
  1489. applies to the client authentication process used in the standard SSL
  1490. handshake when a connection is established. In per-directory context it forces
  1491. a SSL renegotation with the reconfigured client verification depth after the
  1492. HTTP request was read but before the HTTP response is sent.</p>
  1493. <p>
  1494. The depth actually is the maximum number of intermediate certificate issuers,
  1495. i.e. the number of CA certificates which are max allowed to be followed while
  1496. verifying the client certificate. A depth of 0 means that self-signed client
  1497. certificates are accepted only, the default depth of 1 means the client
  1498. certificate can be self-signed or has to be signed by a CA which is directly
  1499. known to the server (i.e. the CA's certificate is under
  1500. <code class="directive"><a href="#sslcacertificatepath">SSLCACertificatePath</a></code>), etc.</p>
  1501. <div class="example"><h3>Example</h3><p><code>
  1502. SSLVerifyDepth 10
  1503. </code></p></div>
  1504.  
  1505. </div>
  1506. </div>
  1507. <div class="bottomlang">
  1508. <p><span>Available Languages: </span><a href="../en/mod/mod_ssl.html" title="English"> en </a></p>
  1509. </div><div id="footer">
  1510. <p class="apache">Copyright 1999-2004 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>
  1511. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  1512. </body></html>