granicus.if.org Git - apache/blob - docs/manual/mod/mod_ssl_ct.html.en

   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_ct - Apache HTTP Server Version 2.5</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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_ssl_ct</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_ssl_ct.html" title="English">&nbsp;en&nbsp;</a></p>
  28 </div>
  29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Implementation of Certificate Transparency (RFC 6962)
  30 </td></tr>
  31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>ssl_ct_module</td></tr>
  33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_ssl_ct.c</td></tr></table>
  34 <h3>Summary</h3>
  35
  36
  37 <p>This module provides an implementation of Certificate Transparency, in
  38 conjunction with <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> and command-line tools from the
  39 <a href="https://code.google.com/p/certificate-transparency/">certificate-transparency</a>
  40 open source project.  The goal of Certificate Transparency is to expose the
  41 use of server certificates which are trusted by browsers but were mistakenly
  42 or maliciously issued.  More information about Certificate Transparency is
  43 available at <a href="http://www.certificate-transparency.org/">
  44 http://www.certificate-transparency.org/</a>.  Key terminology used in
  45 this documentation:</p>
  46
  47 <dl>
  48   <dt>Certificate log</dt>
  49   <dd>A certificate log, referred to simply as <q>log</q> in this documentation,
  50   is a network service to which server certificates have been submitted.  A
  51   user agent can confirm that the certificate of a server which it accesses
  52   has been submitted to a log which it trusts, and that the log itself has
  53   not been tampered with.</dd>
  54
  55   <dt>Signed Certificate Timestamp (SCT)</dt>
  56   <dd>This is an acknowledgement from a log that it has accepted a valid
  57   certificate.  It is signed with the log's public key.  One or more SCTs
  58   is passed to clients during the handshake, either in the ServerHello
  59   (TLS extension), certificate extension, or in a stapled OCSP response.</dd>
  60 </dl>
  61
  62 <p>This implementation for Apache httpd provides these features for TLS
  63 servers and proxies:</p>
  64
  65 <ul>
  66   <li>Signed Certificate Timestamps (SCTs) can be obtained from logs
  67   automatically and, in conjunction with any statically configured SCTs, sent
  68   to aware clients in the ServerHello (during the handshake).</li>
  69   <li>SCTs can be received by the proxy from origin servers in the ServerHello,
  70   in a certificate extension, and/or within stapled OCSP responses; any SCTs
  71   received can be partially validated on-line and optionally queued for off-line
  72   audit.</li>
  73   <li>The proxy can be configured to disallow communication with an origin
  74   server which does not provide an SCT which passes on-line validation.</li>
  75 </ul>
  76
  77 <p>Configuration information about logs can be defined statically in the web
  78 server configuration or maintained in a SQLite3 database.  In the latter case,
  79 <code class="module"><a href="../mod/mod_ssl_ct.html">mod_ssl_ct</a></code> will reload the database periodically, so any
  80 site-specific infrastructure for maintaining and propagating log configuration
  81 information does not have to also restart httpd to make it take effect.</p>
  82
  83 <div class="note">This module is experimental for the following reasons:
  84 <ul>
  85   <li>Insufficient test and review</li>
  86   <li>Reliance on an unreleased version of OpenSSL (1.0.2, Beta 3 or later) for
  87   basic operation</li>
  88   <li>Incomplete <a href="#audit">off-line audit capability</a></li>
  89 </ul>
  90
  91 <p>Configuration mechanisms, format of data saved for off-line audit, and
  92 other characteristics are subject to change based on further feedback and
  93 testing.</p>
  94 </div>
  95 </div>
  96 <div id="quickview"><h3>Topics</h3>
  97 <ul id="topics">
  98 <li><img alt="" src="../images/down.gif" /> <a href="#server">Server processing overview</a></li>
  99 <li><img alt="" src="../images/down.gif" /> <a href="#proxy">Proxy processing overview</a></li>
 100 <li><img alt="" src="../images/down.gif" /> <a href="#logconf">Log configuration</a></li>
 101 <li><img alt="" src="../images/down.gif" /> <a href="#static">Storing SCTs in a form consumable by mod_ssl_ct</a></li>
 102 <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging CT status in the access log</a></li>
 103 <li><img alt="" src="../images/down.gif" /> <a href="#audit">Off-line audit for proxy</a></li>
 104 </ul><h3 class="directives">Directives</h3>
 105 <ul id="toc">
 106 <li><img alt="" src="../images/down.gif" /> <a href="#ctauditstorage">CTAuditStorage</a></li>
 107 <li><img alt="" src="../images/down.gif" /> <a href="#ctlogclient">CTLogClient</a></li>
 108 <li><img alt="" src="../images/down.gif" /> <a href="#ctlogconfigdb">CTLogConfigDB</a></li>
 109 <li><img alt="" src="../images/down.gif" /> <a href="#ctmaxsctage">CTMaxSCTAge</a></li>
 110 <li><img alt="" src="../images/down.gif" /> <a href="#ctproxyawareness">CTProxyAwareness</a></li>
 111 <li><img alt="" src="../images/down.gif" /> <a href="#ctsctstorage">CTSCTStorage</a></li>
 112 <li><img alt="" src="../images/down.gif" /> <a href="#ctserverhellosctlimit">CTServerHelloSCTLimit</a></li>
 113 <li><img alt="" src="../images/down.gif" /> <a href="#ctstaticlogconfig">CTStaticLogConfig</a></li>
 114 <li><img alt="" src="../images/down.gif" /> <a href="#ctstaticscts">CTStaticSCTs</a></li>
 115 </ul>
 116 <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
 117 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 118 <div class="section">
 119 <h2><a name="server" id="server">Server processing overview</a></h2>
 120
 121
 122   <p>Servers need to send SCTs to their clients.  SCTs in a certificate
 123   extension or stapled OCSP response will be sent without any special program
 124   logic.  This module handles sending SCTs configured by the administrator or
 125   received from configured logs.</p>
 126
 127   <p>The number of SCTs sent in the ServerHello (i.e., not including those in a
 128   certificate extension or stapled OCSP response) can be limited by the
 129   <code class="directive"><a href="#ctserverhellosctlimit">CTServerHelloSCTLimit</a></code>
 130   directive.</p>
 131
 132   <p>For each server certificate, a daemon process maintains an SCT list to be
 133   sent in the ServerHello, created from statically configured SCTs as well as
 134   those received from logs.  Logs marked as untrusted or with a maximum valid
 135   timestamp before the present time will be ignored.  Periodically the daemon
 136   will submit certificates to a log as necessary (due to changed log
 137   configuration or age) and rebuild the concatenation of SCTs.</p>
 138
 139   <p>The SCT list for a server certificate will be sent to any client that
 140   indicates awareness in the ClientHello when that particular server certificate
 141   is used.</p>
 142
 143 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 144 <div class="section">
 145 <h2><a name="proxy" id="proxy">Proxy processing overview</a></h2>
 146
 147
 148   <p>The proxy indicates Certificate Transparency awareness in the ClientHello
 149   by including the <em>signed_certificate_timestamp</em> extension.  It can
 150   recognize SCTs received in the ServerHello, in an extension in the certificate
 151   for an origin server, or in a stapled OCSP response.</p>
 152
 153   <p>On-line verification is attempted for each received SCT:</p>
 154
 155   <ul>
 156     <li>For any SCT, the timestamp can be checked to see if it is not yet valid
 157     based on the current time as well as any configured valid time interval for
 158     the log.</li>
 159     <li>For an SCT from a log for which a public key is configured, the server
 160     signature will be checked.</li>
 161   </ul>
 162
 163   <p>If verification fails for at least one SCT and verification was not
 164   successful for at least one SCT, the connection is aborted if
 165   <code class="directive"><a href="#ctproxyawareness">CTProxyAwareness</a></code> is set to
 166   <em>require</em>.</p>
 167
 168   <p>Additionally, the server certificate chain and SCTs are stored for off-line
 169   verification if the <code class="directive"><a href="#ctauditstorage">CTAuditStorage</a></code>
 170   directive is configured.</p>
 171
 172   <p>As an optimization, on-line verification and storing of data from the
 173   server is only performed the first time a web server child process receives
 174   the data.  This saves some processing time as well as disk space.  For typical
 175   reverse proxy setups, very little processing overhead will be required.</p>
 176
 177 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 178 <div class="section">
 179 <h2><a name="logconf" id="logconf">Log configuration</a></h2>
 180
 181
 182   <p>Servers and proxies use different information about logs for their processing.
 183   This <em>log configuration</em> can be set in two ways:</p>
 184
 185   <ul>
 186     <li>Create a log configuration database using <code class="program"><a href="../programs/ctlogconfig.html">ctlogconfig</a></code>,
 187     and configure the path to that database using the <code class="directive"><a href="#ctlogconfig">
 188     CTLogConfig</a></code> directive.  This method of configuration supports
 189     dynamic updates; <code class="module"><a href="../mod/mod_ssl_ct.html">mod_ssl_ct</a></code> will re-read the database at
 190     intervals.  Additionally, the off-line audit program <code>ctauditscts</code>
 191     can use this configuration to find the URL of logs.</li>
 192
 193     <li>Configure information about logs statically using the <code class="directive"><a href="#ctstaticlogconfig">CTStaticLogConfig</a></code> directive.  As with all other
 194     directives, the server must be restarted in order to pick up changes to the
 195     directives.</li>
 196   </ul>
 197
 198   <p>The information that can be configured about a log using either mechanism is
 199   described below:</p>
 200
 201   <dl>
 202     <dt>log id</dt>
 203     <dd>The log id is the SHA-256 hash of the log's public key, and is part of
 204     every SCT.  This is a convenient way to identify a particular log when
 205     configuring valid timestamp ranges or certain other information.</dd>
 206
 207     <dt>public key of the log</dt>
 208     <dd>A proxy must have the public key of the log in order to check the
 209     signature in SCTs it receives which were obtained from the log.
 210     <br />
 211     A server must have the public key of the log in order to submit certificates
 212     to it.</dd>
 213
 214     <dt>general trust/distrust setting</dt>
 215     <dd>This is a mechanism to distrust or restore trust in a particular log,
 216     for whatever reason (including simply avoiding interaction with the
 217     log in situations where it is off-line).</dd>
 218
 219     <dt>minimum and/or maximum valid timestamps</dt>
 220     <dd>When configured, the proxy will check that timestamps from SCTs
 221     are within the valid range.</dd>
 222
 223     <dt>log URL</dt>
 224     <dd>The URL of the log (for its API) is required by a server in order to
 225     submit server certificates to the log.  The server will submit
 226     each server certificate in order to obtain an SCT for each log with a
 227     configured URL, except when the log is also marked as distrusted or the
 228     current time is not within any configured valid timestamp range.
 229     <br />
 230     The log URL is also needed by off-line auditing of SCTs received by a
 231     proxy.</dd>
 232   </dl>
 233
 234   <p>Generally, only a small subset of this information is configured for a
 235   particular log.  Refer to the documentation for the <code class="directive"><a href="#ctstaticlogconfig">CTStaticLogConfig</a></code> directive and the
 236   <code class="program"><a href="../programs/ctlogconfig.html">ctlogconfig</a></code> command for more specific information.</p>
 237
 238 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 239 <div class="section">
 240 <h2><a name="static" id="static">Storing SCTs in a form consumable by mod_ssl_ct</a></h2>
 241
 242
 243   <p><code class="module"><a href="../mod/mod_ssl_ct.html">mod_ssl_ct</a></code> allows you to configure SCTs statically
 244   using the <code class="directive">CTStaticSCTs</code> directive.  These must be
 245   in binary form, ready to send to a client.</p>
 246
 247   <p>Sample code in the form of a Python script to build an SCT in the correct
 248   format from data received from a log can be found in
 249   <a href="https://github.com/tomrittervg/ct-tools">Tom Ritter's ct-tools
 250   repository</a>.  Refer to <code>write-sct.py</code></p>
 251 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 252 <div class="section">
 253 <h2><a name="logging" id="logging">Logging CT status in the access log</a></h2>
 254
 255
 256   <p>Proxy and server modes set the <code>SSL_CT_PROXY_STATUS</code> and
 257   <code>SSL_CT_CLIENT_STATUS</code> variables, respectively, to indicate
 258   if the corresponding peer is CT-aware.</p>
 259
 260   <p>Proxy mode sets the <code>SSL_CT_PROXY_SCT_SOURCES</code> variable to
 261   indicate whether and where SCTs were obtained (ServerHello, certificate
 262   extension, etc.).</p>
 263
 264   <p>These variables can be logged with the <code>%{<em>varname</em>}e</code>
 265   format of <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code>.</p>
 266 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 267 <div class="section">
 268 <h2><a name="audit" id="audit">Off-line audit for proxy</a></h2>
 269
 270
 271   <p>Experimental support for this is implemented in the <code>ctauditscts</code>
 272   command, which itself relies on the <code>verify_single_proof.py</code> tool in the
 273   <em>certificate-transparency</em> open source project.  <code>ctauditscts</code>
 274   can parse data for off-line audit (enabled with the <code class="directive"><a href="#ctauditstorage">
 275   CTAuditStorage</a></code> directive) and invoke <code>verify_single_proof.py</code>.
 276   </p>
 277
 278   <p>Here are rough notes for using <code>ctauditscts</code>:</p>
 279
 280   <ul>
 281     <li>Create a <em>virtualenv</em> using the <code>requirements.txt</code> file
 282     from the <em>certificate-transparency</em> project and run the following steps
 283     with that <em>virtualenv</em> activated.</li>
 284     <li>Set <code>PYTHONPATH</code> to include the <code>python</code>
 285     directory within the <em>certificate-transparency</em> tools.</li>
 286     <li>Set <code>PATH</code> to include the <code>python/ct/client/tools</code>
 287     directory.</li>
 288     <li>Run <code>ctauditscts</code>, passing the value of the
 289     <code class="directive">CTAuditStorage</code> directive and, optionally, the path to
 290     the log configuration database.  The latter will be used to look up log URLs
 291     by log id.</li>
 292   </ul>
 293
 294   <p>The data saved for audit can also be used by other programs; refer to the
 295   <code>ctauditscts</code> source code for details on processing the data.</p>
 296 </div>
 297 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 298 <div class="directive-section"><h2><a name="CTAuditStorage" id="CTAuditStorage">CTAuditStorage</a> <a name="ctauditstorage" id="ctauditstorage">Directive</a></h2>
 299 <table class="directive">
 300 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Existing directory where data for off-line audit will be stored</td></tr>
 301 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTAuditStorage <em>directory</em></code></td></tr>
 302 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 303 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 304 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 305 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 306 </table>
 307   <p>The <code class="directive">CTAuditStorage</code> directive sets the name of a
 308   directory where data will be stored for off-line audit.  If <em>directory</em>
 309   is not absolute then it is assumed to be relative to <code class="directive"><a href="../mod/core.html#defaultruntimedir">
 310   DefaultRuntimeDir</a></code>.</p>
 311
 312   <p>If this directive is not specified, data will not be stored for off-line
 313   audit.</p>
 314
 315   <p>The directory will contain files named <code><em>PID</em>.tmp</code> for
 316   active child processes and files named <code><em>PID</em>.out</code> for exited
 317   child processes.  These <code>.out</code> files are ready for off-line audit.
 318   The experimental command <code>ctauditscts</code> (in the httpd source tree, not
 319   currently installed) interfaces with <em>certificate-transparency</em> tools to
 320   perform the audit.</p>
 321
 322 </div>
 323 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 324 <div class="directive-section"><h2><a name="CTLogClient" id="CTLogClient">CTLogClient</a> <a name="ctlogclient" id="ctlogclient">Directive</a></h2>
 325 <table class="directive">
 326 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of certificate-transparency log client tool</td></tr>
 327 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTLogClient <em>executable</em></code></td></tr>
 328 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 329 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 330 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 331 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 332 </table>
 333   <p><em>executable</em> is the full path to the log client tool, which is
 334   normally file <code>cpp/client/ct</code> (or <code>ct.exe</code>) within the
 335   source tree of the
 336   <a href="https://code.google.com/p/certificate-transparency/">
 337   certificate-transparency</a> open source project.</p>
 338
 339   <p>An alternative implementation could be used to retrieve SCTs for a
 340   server certificate as long as the command-line interface is equivalent.</p>
 341
 342   <p>If this directive is not configured, server certificates cannot be
 343   submitted to logs in order to obtain SCTs; thus, only admin-managed
 344   SCTs or SCTs in certificate extensions will be provided to clients.</p>
 345
 346 </div>
 347 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 348 <div class="directive-section"><h2><a name="CTLogConfigDB" id="CTLogConfigDB">CTLogConfigDB</a> <a name="ctlogconfigdb" id="ctlogconfigdb">Directive</a></h2>
 349 <table class="directive">
 350 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Log configuration database supporting dynamic updates</td></tr>
 351 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTLogConfigDB <em>filename</em></code></td></tr>
 352 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 353 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 354 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 355 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 356 </table>
 357   <p>The <code class="directive">CTLogConfigDB</code> directive sets the name of a database
 358   containing configuration about known logs.  If <em>filename</em> is not absolute
 359   then it is assumed to be relative to
 360   <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p>
 361
 362   <p>Refer to the documentation for the <code class="program"><a href="../programs/ctlogconfig.html">ctlogconfig</a></code> program,
 363   which manages the database.</p>
 364
 365 </div>
 366 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 367 <div class="directive-section"><h2><a name="CTMaxSCTAge" id="CTMaxSCTAge">CTMaxSCTAge</a> <a name="ctmaxsctage" id="ctmaxsctage">Directive</a></h2>
 368 <table class="directive">
 369 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum age of SCT obtained from a log, before it will be
 370 refreshed</td></tr>
 371 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTMaxSCTAge <em>num-seconds</em></code></td></tr>
 372 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>1 day</code></td></tr>
 373 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 374 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 375 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 376 </table>
 377   <p>Server certificates with SCTs which are older than this maximum age will
 378   be resubmitted to configured logs.  Generally the log will return the same SCT
 379   as before, but that is subject to log operation.  SCTs will be refreshed as
 380   necessary during normal server operation, with new SCTs returned to clients
 381   as they become available.</p>
 382
 383 </div>
 384 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 385 <div class="directive-section"><h2><a name="CTProxyAwareness" id="CTProxyAwareness">CTProxyAwareness</a> <a name="ctproxyawareness" id="ctproxyawareness">Directive</a></h2>
 386 <table class="directive">
 387 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Level of CT awareness and enforcement for a proxy
 388 </td></tr>
 389 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTProxyAwareness <em>oblivious|aware|require</em></code></td></tr>
 390 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>aware</code></td></tr>
 391 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 392 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 393 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 394 </table>
 395   <p>This directive controls awareness and checks for valid SCTs for a
 396   proxy.  Several options are available:</p>
 397
 398   <dl>
 399     <dt>oblivious</dt>
 400     <dd>The proxy will neither ask for nor examine SCTs.  Certificate
 401     Transparency processing for the proxy is completely disabled.</dd>
 402
 403     <dt>aware</dt>
 404     <dd>The proxy will perform all appropriate Certificate Transparency
 405     processing, such as asking for and examining SCTs.  However, the
 406     proxy will not disallow communication if the origin server does
 407     not provide any valid SCTs.</dd>
 408
 409     <dt>require</dt>
 410     <dd>The proxy will abort communication with the origin server if it
 411     does not provide at least one SCT which passes on-line validation.</dd>
 412   </dl>
 413
 414
 415 </div>
 416 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 417 <div class="directive-section"><h2><a name="CTSCTStorage" id="CTSCTStorage">CTSCTStorage</a> <a name="ctsctstorage" id="ctsctstorage">Directive</a></h2>
 418 <table class="directive">
 419 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Existing directory where SCTs are managed</td></tr>
 420 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTSCTStorage <em>directory</em></code></td></tr>
 421 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 422 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 423 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 424 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 425 </table>
 426   <p>The <code class="directive">CTSCTStorage</code> directive sets the name of a
 427   directory where SCTs and SCT lists will will be stored.  If <em>directory</em>
 428   is not absolute then it is assumed to be relative to <code class="directive"><a href="../mod/core.html#defaultruntimedir">
 429   DefaultRuntimeDir</a></code>.</p>
 430
 431   <p>A subdirectory for each server certificate contains information relative
 432   to that certificate; the name of the subdirectory is the SHA-256 hash of the
 433   certificate.</p>
 434
 435   <p>The certificate-specific directory contains SCTs retrieved from configured
 436   logs, SCT lists prepared from statically configured SCTs and retrieved SCTs,
 437   and other information used for managing SCTs.</p>
 438
 439 </div>
 440 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 441 <div class="directive-section"><h2><a name="CTServerHelloSCTLimit" id="CTServerHelloSCTLimit">CTServerHelloSCTLimit</a> <a name="ctserverhellosctlimit" id="ctserverhellosctlimit">Directive</a></h2>
 442 <table class="directive">
 443 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limit on number of SCTs that can be returned in
 444 ServerHello</td></tr>
 445 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTServerHelloSCTLimit <em>limit</em></code></td></tr>
 446 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>100</code></td></tr>
 447 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 448 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 449 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 450 </table>
 451   <p>This directive can be used to limit the number of SCTs which can be
 452   returned by a TLS server in ServerHello, in case the number of configured
 453   logs and statically-defined SCTs is relatively high.</p>
 454
 455   <p>Typically only a few SCTs would be available, so this directive is only
 456   needed in special circumstances.</p>
 457
 458   <p>The directive does not take into account SCTs which may be provided in
 459   certificate extensions or in stapled OCSP responses.</p>
 460
 461 </div>
 462 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 463 <div class="directive-section"><h2><a name="CTStaticLogConfig" id="CTStaticLogConfig">CTStaticLogConfig</a> <a name="ctstaticlogconfig" id="ctstaticlogconfig">Directive</a></h2>
 464 <table class="directive">
 465 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Static configuration of information about a log</td></tr>
 466 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTStaticLogConfig <em>log-id|-</em> <em>public-key-file|-</em>
 467 <em>1|0|-</em> <em>min-timestamp|-</em> <em>max-timestamp|-</em>
 468 <em>log-URL|-</em></code></td></tr>
 469 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 470 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 471 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 472 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 473 </table>
 474   <p>This directive is used to configure information about a particular log.
 475   This directive is appropriate when configuration information changes rarely.
 476   If dynamic configuration updates must be supported, refer to the
 477   <code class="directive"><a href="#ctlogconfigdb">CTLogConfigDB</a></code> directive.</p>
 478
 479   <p>Each of the six fields must be specified, but usually only a small
 480   amount of information must be configured for each log; use <em>-</em> when no
 481   information is available for the field.  For example, in support of a
 482   server-only configuration (i.e., no proxy), the administrator might
 483   configure only the log URL to be used when submitting server certificates
 484   and obtaining a Signed Certificate Timestamp.</p>
 485
 486   <p>The fields are defined as follows:</p>
 487
 488   <dl>
 489     <dt><em>log-id</em></dt>
 490     <dd>This is the id of the log, which is the SHA-256 hash of the log's
 491     public key, provided in hexadecimal format.  This string is 64 characters
 492     in length.
 493     <br />
 494     This field should be omitted when <em>public-key-file</em> is provided.</dd>
 495
 496     <dt><em>public-key-file</em></dt>
 497     <dd>This is the name of a file containing the PEM encoding of the log's
 498     public key.  If the name is not absolute, then it is assumed to be relative
 499     to <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</dd>
 500
 501     <dt><em>trust/distrust</em></dt>
 502     <dd>Set this field to <em>1</em> to distrust this log, or to otherwise avoid
 503     using it for server certificate submission.  Set this to <em>-</em> or
 504     <em>0</em> (the default) to treat the log normally.</dd>
 505
 506     <dt><em>min-timestamp</em> and <em>max-timestamp</em></dt>
 507     <dd>A timestamp is a time as expressed in the number of milliseconds since the
 508     epoch, ignoring leap seconds.  This is the form of time used in Signed Certificate
 509     Timestamps.  This must be provided as a decimal number.
 510     <br />
 511     Specify <strong><code>-</code></strong> for one of the timestamps if it is unknown.
 512     For example, when configuring the minimum valid timestamp for a log which remains
 513     valid, specify <strong><code>-</code></strong> for <em>max-timestamp</em>.
 514     <br />
 515     SCTs received from this log by the proxy are invalid if the timestamp
 516     is older than <em>min-timestamp</em> or newer than <em>max-timestamp</em>.</dd>
 517
 518     <dt><em>log-URL</em></dt>
 519     <dd>This is the URL of the log, for use in submitting server certificates
 520     and in turn obtaining an SCT to be sent to clients.</dd>
 521   </dl>
 522
 523 <h3>See also</h3>
 524 <ul>
 525 <li><a href="#logconf">Log configuration</a> contains more general information
 526 about the fields which can be configured with this directive.</li>
 527 </ul>
 528 </div>
 529 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 530 <div class="directive-section"><h2><a name="CTStaticSCTs" id="CTStaticSCTs">CTStaticSCTs</a> <a name="ctstaticscts" id="ctstaticscts">Directive</a></h2>
 531 <table class="directive">
 532 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Static configuration of one or more SCTs for a server certificate
 533 </td></tr>
 534 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CTStaticSCTs <em>certificate-pem-file</em> <em>sct-directory</em></code></td></tr>
 535 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 536 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 537 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 538 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 539 </table>
 540   <p>This directive is used to statically define one or more SCTs corresponding
 541   to a server certificate.  This mechanism can be used instead of or in
 542   addition to dynamically obtaining SCTs from configured logs.  Any changes to
 543   the set of SCTs for a particular server certificate will be adopted dynamically
 544   without the need to restart the server.</p>
 545
 546   <p><em>certificate-pem-file</em> refers to the server certificate in PEM
 547   format.  If the name is not absolute, then it is assumed to be relative to
 548   <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p>
 549
 550   <p><em>sct-directory</em> should contain one or more files with extension
 551   <code>.sct</code>, representing one or more SCTs corresponding to the
 552   server certificate.  If <em>sct-directory</em> is not absolute, then it is
 553   assumed to be relative to <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p>
 554
 555   <p>If <em>sct-directory</em> is empty, no error will be raised.</p>
 556
 557   <p>This directive could be used to identify directories of SCTs maintained by
 558   other infrastructure, provided that they are saved in binary format with
 559   file extension <em>.sct</em></p>
 560
 561 </div>
 562 </div>
 563 <div class="bottomlang">
 564 <p><span>Available Languages: </span><a href="../en/mod/mod_ssl_ct.html" title="English">&nbsp;en&nbsp;</a></p>
 565 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 566 <script type="text/javascript"><!--//--><![CDATA[//><!--
 567 var comments_shortname = 'httpd';
 568 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_ssl_ct.html';
 569 (function(w, d) {
 570     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 571         d.write('<div id="comments_thread"><\/div>');
 572         var s = d.createElement('script');
 573         s.type = 'text/javascript';
 574         s.async = true;
 575         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 576         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 577     }
 578     else {
 579         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 580     }
 581 })(window, document);
 582 //--><!]]></script></div><div id="footer">
 583 <p class="apache">Copyright 2015 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>
 584 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 585 if (typeof(prettyPrint) !== 'undefined') {
 586     prettyPrint();
 587 }
 588 //--><!]]></script>
 589 </body></html>