[rs-commit] r100 - in /rs-manual/trunk/src/site: resources/images/ xhtml5/mod/

[rs-commit at redwax.eu]

Author: minfrin at redwax.eu
Date: Sun Oct 20 19:56:45 2019
New Revision: 100

Log:
Add hook implementation docs for mod_ca_engine.

Added:
    rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getca.png   (with props)
    rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getchain.png   (with props)
    rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getnextca.png   (with props)
    rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_sign.png   (with props)
Modified:
    rs-manual/trunk/src/site/xhtml5/mod/mod_ca_engine.xhtml5

Added: rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getca.png
==============================================================================
Binary file - no diff available.

Propchange: rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getca.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getchain.png
==============================================================================
Binary file - no diff available.

Propchange: rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getchain.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getnextca.png
==============================================================================
Binary file - no diff available.

Propchange: rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_getnextca.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_sign.png
==============================================================================
Binary file - no diff available.

Propchange: rs-manual/trunk/src/site/resources/images/mod_ca_engine-ca_engine_sign.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: rs-manual/trunk/src/site/xhtml5/mod/mod_ca_engine.xhtml5
==============================================================================
--- rs-manual/trunk/src/site/xhtml5/mod/mod_ca_engine.xhtml5	(original)
+++ rs-manual/trunk/src/site/xhtml5/mod/mod_ca_engine.xhtml5	Sun Oct 20 19:56:45 2019
@@ -330,6 +330,109 @@
 
 
       <section class="wrapper style1 align-center"
+        id="hook-reference">
+        <div class="inner">
+          <h2>Hook Implementation Reference</h2>
+          <p>
+            The following backend hook implementations are provided by this module.
+          </p>
+          <div class="index align-left">
+
+            <section id="hook-ca_engine_sign">
+              <header>
+                <h3><a href="mod_ca.html#ca_sign">Engine Sign Request</a></h3>
+              </header>
+              <div class="content">
+                <p>
+                  <img class="image right" src="../images/mod_ca_engine-ca_engine_sign.png" />
+                  Signs the certificate sign request using a key stored on an HSM or smartcard.
+                </p>
+
+                <p>
+                  Both the <a href="#directive-CAEngineCertificate">CAEngineCertificate</a>
+                  directive and the <a href="#directive-CAEngineKey">CASimpleKey</a>
+                  directive are needed to enable the hook implementation.
+                </p>
+
+                <p>
+                  Each certificate is signed by default for 365 days. This can be controlled by the
+                  <a href="#directive-CAEngineDays">CAEngineDays</a> directive. The
+                  <a href="#directive-CAEngineExtension">CAEngineExtension</a> directive
+                  allows certificate extensions to be added to the certificate.
+                </p>
+
+              </div>
+            </section>
+
+            <section id="hook-ca_engine_getca">
+              <header>
+                <h3><a href="mod_ca.html#ca_getca">Engine Get Certificate Authority</a></h3>
+              </header>
+              <div class="content">
+
+                <p>
+                  <img class="image right" src="../images/mod_ca_engine-ca_engine_getca.png" />
+                  Returns the certificate authority certificate used to sign the request.
+                </p>
+
+                <p>
+                  The certificate authority certificate is parsed from
+                  the <a href="#directive-CAEngineCertificate">CAEngineCertificate</a>
+                  directive and returned when requested. This is the last certificate
+                  specified in the file.
+                </p>
+
+              </div>
+            </section>
+
+            <section id="hook-ca_engine_getnextca">
+              <header>
+                <h3><a href="mod_ca.html#ca_getnextca">Engine Get Next Certificate Authority</a></h3>
+              </header>
+              <div class="content">
+
+                <p>
+                  <img class="image right" src="../images/mod_ca_engine-ca_engine_getnextca.png" />
+                  Returns the next certificate authority certificate that will be used to sign
+                  future requests.
+                </p>
+
+                <p>
+                  The next certificate authority certificate is parsed from
+                  the <a href="#directive-CAEngineNextCertificate">CAEngineNextCertificate</a>
+                  directive and returned when requested.
+                </p>
+
+              </div>
+            </section>
+
+            <section id="hook-ca_engine_getchain">
+              <header>
+                <h3><a href="mod_ca.html#ca_getchain">Engine Get Chain</a></h3>
+              </header>
+              <div class="content">
+
+                <p>
+                  <img class="image right" src="../images/mod_ca_engine-ca_engine_getchain.png" />
+                  Returns the chain of certificates used to sign the request.
+                </p>
+
+                <p>
+                  The certificate chain is parsed from
+                  the <a href="#directive-CAEngineCertificate">CAEngineCertificate</a>
+                  directive and returned when requested. These are all certificates apart from
+                  the last certificate specified in the file.
+                </p>
+
+              </div>
+            </section>
+
+          </div>
+        </div>
+      </section>
+
+
+      <section class="wrapper style1 align-center"
         id="directive-reference">
         <div class="inner">
           <h2>Directive Reference</h2>