]> granicus.if.org Git - apache/blobdiff - docs/manual/mod/mod_ssl_ct.html.en
Merge in APR[-util] macros from branches/trunk-buildconf-noapr
[apache] / docs / manual / mod / mod_ssl_ct.html.en
index 838c3f0612d802d9cb3cff7dfc89281d9288f841..3bbe9df2d708591b987af728b67af930abc6e2b5 100644 (file)
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
+<!--
         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
               This file is generated from xml source: DO NOT EDIT
         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
@@ -17,7 +19,7 @@
 <div id="page-header">
 <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>
 <p class="apache">Apache HTTP Server Version 2.5</p>
-<img alt="" src="../images/feather.gif" /></div>
+<img alt="" src="../images/feather.png" /></div>
 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
 <div id="path">
 <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>
@@ -34,7 +36,7 @@
 <h3>Summary</h3>
 
 
-<p>This module provides an implementation of Certificate Transparency, in 
+<p>This module provides an implementation of Certificate Transparency, in
 conjunction with <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> and command-line tools from the
 <a href="https://code.google.com/p/certificate-transparency/">certificate-transparency</a>
 open source project.  The goal of Certificate Transparency is to expose the
@@ -63,11 +65,11 @@ this documentation:</p>
 servers and proxies:</p>
 
 <ul>
-  <li>Signed Certificate Timestamps (SCTs) can be obtained from logs 
+  <li>Signed Certificate Timestamps (SCTs) can be obtained from logs
   automatically and, in conjunction with any statically configured SCTs, sent
   to aware clients in the ServerHello (during the handshake).</li>
   <li>SCTs can be received by the proxy from origin servers in the ServerHello,
-  in a certificate extension, and/or within stapled OCSP responses; any SCTs 
+  in a certificate extension, and/or within stapled OCSP responses; any SCTs
   received can be partially validated on-line and optionally queued for off-line
   audit.</li>
   <li>The proxy can be configured to disallow communication with an origin
@@ -93,7 +95,15 @@ other characteristics are subject to change based on further feedback and
 testing.</p>
 </div>
 </div>
-<div id="quickview"><h3 class="directives">Directives</h3>
+<div id="quickview"><h3>Topics</h3>
+<ul id="topics">
+<li><img alt="" src="../images/down.gif" /> <a href="#server">Server processing overview</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#proxy">Proxy processing overview</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#logconf">Log configuration</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#static">Storing SCTs in a form consumable by mod_ssl_ct</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging CT status in the access log</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#audit">Off-line audit for proxy</a></li>
+</ul><h3 class="directives">Directives</h3>
 <ul id="toc">
 <li><img alt="" src="../images/down.gif" /> <a href="#ctauditstorage">CTAuditStorage</a></li>
 <li><img alt="" src="../images/down.gif" /> <a href="#ctlogclient">CTLogClient</a></li>
@@ -105,14 +115,9 @@ testing.</p>
 <li><img alt="" src="../images/down.gif" /> <a href="#ctstaticlogconfig">CTStaticLogConfig</a></li>
 <li><img alt="" src="../images/down.gif" /> <a href="#ctstaticscts">CTStaticSCTs</a></li>
 </ul>
-<h3>Topics</h3>
-<ul id="topics">
-<li><img alt="" src="../images/down.gif" /> <a href="#server">Server processing overview</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#proxy">Proxy processing overview</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#logconf">Log configuration</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging CT status in the access log</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#audit">Off-line audit for proxy</a></li>
-</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
+<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_ssl_ct">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_ssl_ct">Report a bug</a></li></ul><h3>See also</h3>
+<ul class="seealso">
+<li><a href="#comments_section">Comments</a></li></ul></div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="section">
 <h2><a name="server" id="server">Server processing overview</a></h2>
@@ -160,7 +165,7 @@ testing.</p>
   </ul>
 
   <p>If verification fails for at least one SCT and verification was not
-  successful for at least one SCT, the connection is aborted if 
+  successful for at least one SCT, the connection is aborted if
   <code class="directive"><a href="#ctproxyawareness">CTProxyAwareness</a></code> is set to
   <em>require</em>.</p>
 
@@ -222,7 +227,7 @@ testing.</p>
     <dt>log URL</dt>
     <dd>The URL of the log (for its API) is required by a server in order to
     submit server certificates to the log.  The server will submit
-    each server certificate in order to obtain an SCT for each log with a 
+    each server certificate in order to obtain an SCT for each log with a
     configured URL, except when the log is also marked as distrusted or the
     current time is not within any configured valid timestamp range.
     <br />
@@ -231,18 +236,32 @@ testing.</p>
   </dl>
 
   <p>Generally, only a small subset of this information is configured for a
-  particular log.  Refer to the documentation for the <code class="directive"><a href="#ctstaticlogconfig">CTStaticLogConfig</a></code> directive and the 
+  particular log.  Refer to the documentation for the <code class="directive"><a href="#ctstaticlogconfig">CTStaticLogConfig</a></code> directive and the
   <code class="program"><a href="../programs/ctlogconfig.html">ctlogconfig</a></code> command for more specific information.</p>
 
 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="section">
+<h2><a name="static" id="static">Storing SCTs in a form consumable by mod_ssl_ct</a></h2>
+  
+
+  <p><code class="module"><a href="../mod/mod_ssl_ct.html">mod_ssl_ct</a></code> allows you to configure SCTs statically
+  using the <code class="directive">CTStaticSCTs</code> directive.  These must be
+  in binary form, ready to send to a client.</p>
+
+  <p>Sample code in the form of a Python script to build an SCT in the correct
+  format from data received from a log can be found in
+  <a href="https://github.com/tomrittervg/ct-tools">Tom Ritter's ct-tools
+  repository</a>.  Refer to <code>write-sct.py</code></p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
 <h2><a name="logging" id="logging">Logging CT status in the access log</a></h2>
   
 
-  <p>Both proxy and server modes set the <code>SSL_CT_PEER_STATUS</code>
-  variable to indicate if the peer is CT-aware.</p>
+  <p>Proxy and server modes set the <code>SSL_CT_PROXY_STATUS</code> and
+  <code>SSL_CT_CLIENT_STATUS</code> variables, respectively, to indicate
+  if the corresponding peer is CT-aware.</p>
 
-  <p>Proxy mode sets the <code>SSL_PROXY_SCT_SOURCES</code> variable to
+  <p>Proxy mode sets the <code>SSL_CT_PROXY_SCT_SOURCES</code> variable to
   indicate whether and where SCTs were obtained (ServerHello, certificate
   extension, etc.).</p>
 
@@ -299,7 +318,7 @@ testing.</p>
 
   <p>The directory will contain files named <code><em>PID</em>.tmp</code> for
   active child processes and files named <code><em>PID</em>.out</code> for exited
-  child processes.  These <code>.out</code> files are ready for off-line audit. 
+  child processes.  These <code>.out</code> files are ready for off-line audit.
   The experimental command <code>ctauditscts</code> (in the httpd source tree, not
   currently installed) interfaces with <em>certificate-transparency</em> tools to
   perform the audit.</p>
@@ -409,7 +428,7 @@ refreshed</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ssl_ct</td></tr>
 </table>
   <p>The <code class="directive">CTSCTStorage</code> directive sets the name of a
-  directory where SCTs and SCT lists will will be stored.  If <em>directory</em>
+  directory where SCTs and SCT lists will be stored.  If <em>directory</em>
   is not absolute then it is assumed to be relative to <code class="directive"><a href="../mod/core.html#defaultruntimedir">
   DefaultRuntimeDir</a></code>.</p>
 
@@ -417,7 +436,7 @@ refreshed</td></tr>
   to that certificate; the name of the subdirectory is the SHA-256 hash of the
   certificate.</p>
 
-  <p>The certificate-specific directory contains SCTs retrieved from configured 
+  <p>The certificate-specific directory contains SCTs retrieved from configured
   logs, SCT lists prepared from statically configured SCTs and retrieved SCTs,
   and other information used for managing SCTs.</p>
 
@@ -458,7 +477,7 @@ ServerHello</td></tr>
 </table>
   <p>This directive is used to configure information about a particular log.
   This directive is appropriate when configuration information changes rarely.
-  If dynamic configuration updates must be supported, refer to the 
+  If dynamic configuration updates must be supported, refer to the
   <code class="directive"><a href="#ctlogconfigdb">CTLogConfigDB</a></code> directive.</p>
 
   <p>Each of the six fields must be specified, but usually only a small
@@ -494,7 +513,7 @@ ServerHello</td></tr>
     Timestamps.  This must be provided as a decimal number.
     <br />
     Specify <strong><code>-</code></strong> for one of the timestamps if it is unknown.
-    For example, when configuring the minimum valid timestamp for a log which remains 
+    For example, when configuring the minimum valid timestamp for a log which remains
     valid, specify <strong><code>-</code></strong> for <em>max-timestamp</em>.
     <br />
     SCTs received from this log by the proxy are invalid if the timestamp
@@ -534,7 +553,7 @@ about the fields which can be configured with this directive.</li>
 
   <p><em>sct-directory</em> should contain one or more files with extension
   <code>.sct</code>, representing one or more SCTs corresponding to the
-  server certificate.  If <em>sct-directory</em> is not absolute, then it is 
+  server certificate.  If <em>sct-directory</em> is not absolute, then it is
   assumed to be relative to <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p>
 
   <p>If <em>sct-directory</em> is empty, no error will be raised.</p>
@@ -565,7 +584,7 @@ var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_ssl_ct.htm
     }
 })(window, document);
 //--><!]]></script></div><div id="footer">
-<p class="apache">Copyright 2014 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>
+<p class="apache">Copyright 2017 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>
 <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[//><!--
 if (typeof(prettyPrint) !== 'undefined') {
     prettyPrint();