[rs-commit] r108 - /rs-manual/trunk/src/site/xhtml5/mod/mod_ca_simple.xhtml5
rs-commit at redwax.eu
rs-commit at redwax.eu
Wed Oct 23 00:01:27 CEST 2019
Author: minfrin at redwax.eu
Date: Wed Oct 23 00:01:26 2019
New Revision: 108
Log:
Link the module integration and hook implementation docs.
Modified:
rs-manual/trunk/src/site/xhtml5/mod/mod_ca_simple.xhtml5
Modified: rs-manual/trunk/src/site/xhtml5/mod/mod_ca_simple.xhtml5
==============================================================================
--- rs-manual/trunk/src/site/xhtml5/mod/mod_ca_simple.xhtml5 (original)
+++ rs-manual/trunk/src/site/xhtml5/mod/mod_ca_simple.xhtml5 Wed Oct 23 00:01:26 2019
@@ -93,10 +93,23 @@
<div class="content">
<p>When this hook is triggered, this module signs the certificate sign
request using a certificate and key on the local disk.</p>
- <p>Both the <a href="#CASimpleCertificate">CASimpleCertificate</a>
- directive and the <a href="#CASimpleKey">CASimpleKey</a>
- directive enables the <a href="mod_ca.html#ca_sign">Sign Request Hook</a>
- in <a href="mod_ca_simple.html">mod_ca_simple</a>.</p>
+ <p>
+ This module provides the following implementations of this hook.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_sign">Simple Sign Request</a>
+ </td>
+ <td>Signs the certificate sign request using a key stored on disk.</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>
+ This hook is called by the following
+ <a href="mod_ca.html#frontend">frontend modules</a>.
+ </p>
<table>
<tbody>
<tr>
@@ -139,32 +152,37 @@
<div class="content">
<p>When this hook is triggered, this module returns the intermediate certificate
chain used to sign certificate sign requests, if any and present.</p>
- <p>The <a href="#CASimpleCertificate">CASimpleCertificate</a>
- directive enables the <a href="mod_ca.html#ca_getchain">Get Chain Hook</a>
- in <a href="mod_ca_simple.html">mod_ca_simple</a>.</p>
- <table>
- <tbody>
- <tr>
- <td>
- <a href="mod_ca_disk.html#ca_getchain">mod_ca_disk</a>
- </td>
- <td>This hook returns the certificate chain, to be saved to disk
- by the <a href="mod_ca_disk.html#ca_getchain">mod_ca_disk</a> module.
- </td>
- </tr>
- <tr>
- <td>
- <a href="mod_ca_engine.html#ca_getchain">mod_ca_engine</a>
- </td>
- <td>This hook returns the certificate chain of a certificate provided by
- an OpenSSL provided crypto engine such as a smartcard.</td>
- </tr>
- <tr>
- <td>
- <a href="mod_ca_simple.html#ca_sign">mod_ca_simple</a>
- </td>
- <td>This hook returns the certificate chain of a certificate provided by
- a file on disk.</td>
+ <p>
+ This module provides the following implementations of this hook.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_getchain">Simple Get Chain</a>
+ </td>
+ <td>Returns the chain of certificates used to sign the request.</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>This hook is called by the following
+ <a href="mod_ca.html#backend">backend modules</a>.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_engine.html#hook-ca_engine_sign">mod_ca_engine</a>
+ </td>
+ <td>This hook signs a given certificate sign request using an
+ OpenSSL provided crypto engine such as a smartcard, using the
+ serial number returned by this module.</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_sign">mod_ca_simple</a>
+ </td>
+ <td>Signs the certificate sign request using a key stored on disk.</td>
</tr>
</tbody>
</table>
@@ -181,20 +199,35 @@
<p>When this hook is triggered, this module returns either a random
serial number, or the serial number present in the subject of the
certificate sign request.</p>
- <p>The <a href="#CASimpleSerialRandom">CASimpleSerialRandom</a>
- directive causes the <a href="mod_ca.html#ca_makeserial">Make Serial Hook</a>
- in <a href="mod_ca_simple.html">mod_ca_simple</a> to return a random serial
- number generated by the OpenSSL <code>BN_rand</code> function.</p>
- <p>The <a href="#CASimpleSerialSubject">CASimpleSerialSubject</a>
- directive causes the <a href="mod_ca.html#ca_makeserial">Make Serial Hook</a>
- in <a href="mod_ca_simple.html">mod_ca_simple</a> to return the serial
- number encoded in the subject of a certificate sign request, thus
- generating a certificate that cannot be reissued.</p>
- <table>
- <tbody>
- <tr>
- <td>
- <a href="mod_ca_engine.html#ca_makeserial">mod_ca_engine</a>
+ <p>
+ This module provides the following implementations of this hook.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_makeserial_subject">Simple Make Serial From Subject</a>
+ </td>
+ <td>Returns the serial number from that embedded within the subject of the
+ certificate sign request.</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_makeserial_random">Simple Make Random Serial</a>
+ </td>
+ <td>Returns a random serial number.</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>This hook is called by the following
+ <a href="mod_ca.html#frontend">frontend modules</a> and
+ <a href="mod_ca.html#backend">backend modules</a>.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_engine.html#hook-ca_engine_sign">mod_ca_engine</a>
</td>
<td>This hook signs a given certificate sign request using an
OpenSSL provided crypto engine such as a smartcard, using the
@@ -202,10 +235,9 @@
</tr>
<tr>
<td>
- <a href="mod_ca_simple.html#ca_makeserial">mod_ca_simple</a>
- </td>
- <td>This hook signs a given certificate sign request, using the
- serial number returned by this module.</td>
+ <a href="mod_ca_simple.html#hook-ca_simple_sign">mod_ca_simple</a>
+ </td>
+ <td>Signs the certificate sign request using a key stored on disk.</td>
</tr>
<tr>
<td>
@@ -227,17 +259,39 @@
<div class="content">
<p>When this hook is triggered, this module returns the time used to sign
certificate sign requests, derived from the system time.</p>
- <p>The <a href="#CASimpleTime">CASimpleTime</a>
- directive enables the <a href="mod_ca.html#ca_gettime">Get Time Hook</a>
- in <a href="mod_ca_simple.html">mod_ca_simple</a>.</p>
- <table>
- <tbody>
- <tr>
- <td>
- <a href="mod_ca_simple.html#ca_gettime">mod_ca_simple</a>
+ <p>
+ This module provides the following implementations of this hook.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_gettime">Simple Get Time</a>
</td>
<td>This hook returns the time to be used to sign a certificate sign
request, derived from the system time.</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>This hook is called by the following
+ <a href="mod_ca.html#frontend">frontend modules</a> and
+ <a href="mod_ca.html#backend">backend modules</a>.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_engine.html#hook-ca_engine_sign">mod_ca_engine</a>
+ </td>
+ <td>This hook signs a given certificate sign request using an
+ OpenSSL provided crypto engine such as a smartcard, using the
+ serial number returned by this module.</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_sign">mod_ca_simple</a>
+ </td>
+ <td>Signs the certificate sign request using a key stored on disk.</td>
</tr>
<tr>
<td>
@@ -267,9 +321,23 @@
<div class="content">
<p>When this hook is triggered, this module returns the root CA certificate
used to sign certificate sign requests.</p>
- <p>The <a href="#CASimpleCertificate">CASimpleCertificate</a>
- directive enables the <a href="mod_ca.html#ca_getca">Get Certificate Authority Hook</a>
- in <a href="mod_ca_simple.html">mod_ca_simple</a>.</p>
+ <p>
+ This module provides the following implementations of this hook.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_getca">Simple Get Certificate Authority</a>
+ </td>
+ <td>Returns the certificate authority certificate used to sign the request.</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>
+ This hook is called by the following
+ <a href="mod_ca.html#frontend">frontend modules</a>.
+ </p>
<table>
<tbody>
<tr>
@@ -298,9 +366,24 @@
<div class="content">
<p>When this hook is triggered, this module returns the next root CA certificate
that will in future be used to sign certificate sign requests.</p>
- <p>The <a href="#CASimpleNextCertificate">CASimpleNextCertificate</a>
- directive enables the <a href="mod_ca.html#ca_getnextca">Get Next Certificate Authority Hook</a>
- in <a href="mod_ca_simple.html">mod_ca_simple</a>.</p>
+ <p>
+ This module provides the following implementations of this hook.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_getnextca">Simple Get Next Certificate Authority</a>
+ </td>
+ <td>Returns the next certificate authority certificate that will be used to sign
+ future requests.</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>
+ This hook is called by the following
+ <a href="mod_ca.html#frontend">frontend modules</a>.
+ </p>
<table>
<tbody>
<tr>
@@ -331,10 +414,23 @@
<div class="content">
<p>When this hook is triggered, this module generates and returns a
key pair to be used to sign the certificate sign request.</p>
- <p>Either the <a href="#CASimpleAlgorithm">CASimpleAlgorithm</a>
- directive or the <a href="#CASimpleParamFile">CASimpleParamFile</a>
- directive enables the <a href="mod_ca.html#ca_makekey">Make Key Hook</a>
- in <a href="mod_ca_simple.html">mod_ca_simple</a>.</p>
+ <p>
+ This module provides the following implementations of this hook.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <td>
+ <a href="mod_ca_simple.html#hook-ca_simple_makekey">Simple Make Key</a>
+ </td>
+ <td>Returns a generated public/private key pair.</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>
+ This hook is called by the following
+ <a href="mod_ca.html#frontend">frontend modules</a>.
+ </p>
<table>
<tbody>
<tr>
More information about the rs-commit
mailing list