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