Re: [ptxdist] [PATCH 5/5] doc: introduce ref_code_signing_helpers

[Michael Olbrich <m.olbrich@pengutronix.de>]

On Mon, Jun 08, 2020 at 10:53:05AM +0200, Bastian Krause wrote:
> Signed-off-by: Bastian Krause <bst@pengutronix.de>

This does not apply on master. The sections in doc/ref_manual.rst are now
separate pages. Can you please rebase.

Michael

> ---
>  doc/ref_code_signing_helpers.inc | 246 +++++++++++++++++++++++++++++++
>  doc/ref_manual.rst               |   1 +
>  2 files changed, 247 insertions(+)
>  create mode 100644 doc/ref_code_signing_helpers.inc
> 
> diff --git a/doc/ref_code_signing_helpers.inc b/doc/ref_code_signing_helpers.inc
> new file mode 100644
> index 000000000..cec5c9558
> --- /dev/null
> +++ b/doc/ref_code_signing_helpers.inc
> @@ -0,0 +1,246 @@
> +.. _code_signing_helper_functions:
> +
> +Code Signing Helper Functions
> +-----------------------------
> +
> +PTXdist provides various bash helper functions to be used in :ref:`code signing
> +providers <code_signing_providers>`.
> +These helpers set up SoftHSM, define roles, perform PKCS#11 URI handling as
> +well as key and certificate authority (CA) handling.
> +
> +PTXdist stores URIs and CAs using these helpers in
> +``$(PTXDIST_SYSROOT_HOST)/var/lib/keys/<signing-provider>/<role>/{uri,ca.pem}``.
> +
> +.. _cs_init_softhsm:
> +
> +cs_init_softhsm
> +~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_init_softhsm
> +
> +Initialize SoftHSM, and set the initial pins.
> +
> +Necessary package dependencies for code signing provider: ``HOST_SOFTHSM``
> +
> +.. _cs_define_role:
> +
> +cs_define_role
> +~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_define_role <role>
> +
> +Define new key role.
> +
> +A default PKCS#11 URI is set implicitly as convenience for SoftHSM use cases.
> +
> +.. _cs_set_uri:
> +
> +cs_set_uri
> +~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_set_uri <role> <URI>
> +
> +Set given PKCS#11 URI for role.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +
> +.. _cs_get_uri:
> +
> +cs_get_uri
> +~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_get_uri <role>
> +
> +Get PKCS#11 URI for role.
> +
> +Preconditions:
> +
> +- the URI must have been set (see :ref:`cs_set_uri`)
> +
> +cs_import_cert_from_der
> +~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_import_cert_from_der <role> <DER>
> +
> +Import certificate from a given DER file for role.
> +To be used with SoftHSM only.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +- SoftHSM must have been initialized (see :ref:`cs_init_softhsm`)
> +
> +Necessary package dependencies for code signing provider: ``HOST_SOFTHSM``
> +
> +cs_import_cert_from_pem
> +~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_import_cert_from_pem <role> <PEM>
> +
> +Import certificate from a given PEM file for role.
> +To be used with SoftHSM only.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +- SoftHSM must have been initialized (see :ref:`cs_init_softhsm`)
> +
> +Necessary package dependencies for code signing provider: ``HOST_SOFTHSM``, ``HOST_OPENSSL``
> +
> +cs_import_pubkey_from_pem
> +~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_import_pubkey_from_pem <role> <PEM>
> +
> +Import public key from a given PEM file for role.
> +To be used with SoftHSM only.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +- SoftHSM must have been initialized (see :ref:`cs_init_softhsm`)
> +
> +Necessary package dependencies for code signing provider: ``HOST_SOFTHSM``, ``HOST_OPENSSL``
> +
> +cs_import_privkey_from_pem
> +~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_import_privkey_from_pem <role> <PEM>
> +
> +Import private key from a given PEM file for role.
> +To be used with SoftHSM only.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +- SoftHSM must have been initialized (see :ref:`cs_init_softhsm`)
> +
> +Necessary package dependencies for code signing provider: ``HOST_SOFTHSM``, ``HOST_OPENSSL``
> +
> +cs_import_key_from_pem
> +~~~~~~~~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_import_key_from_pem <role> <PEM>
> +
> +Import private/public key pair from a given PEM file for role.
> +To be used with SoftHSM only.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +- SoftHSM must have been initialized (see :ref:`cs_init_softhsm`)
> +
> +Necessary package dependencies for code signing provider: ``HOST_SOFTHSM``, ``HOST_OPENSSL``
> +
> +.. _cs_get_ca:
> +
> +cs_get_ca
> +~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_get_ca <role>
> +
> +Get path to the CA in PEM format for role.
> +
> +Preconditions:
> +
> +- a certificate must have been appended to the CA
> +  (see :ref:`cs_append_ca_from_pem`, :ref:`cs_append_ca_from_der`,
> +  :ref:`cs_append_ca_from_uri`)
> +
> +.. _cs_append_ca_from_pem:
> +
> +cs_append_ca_from_pem
> +~~~~~~~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_append_ca_from_pem <role> <PEM>
> +
> +Append certificate from a given PEM file for role.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +
> +.. _cs_append_ca_from_der:
> +
> +cs_append_ca_from_der
> +~~~~~~~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_append_ca_from_der <role> <DER>
> +
> +Append certificate from a given DER file for role.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +
> +Necessary package dependencies for code signing provider: ``HOST_OPENSSL``
> +
> +.. _cs_append_ca_from_uri:
> +
> +cs_append_ca_from_uri
> +~~~~~~~~~~~~~~~~~~~~~
> +
> +Usage:
> +
> +.. code-block:: bash
> +
> +    cs_append_ca_from_uri <role> [<URI>]
> +
> +Append certificate from a given PKCS#11 URI for role.
> +If URI is omitted the already set URI for role is used.
> +
> +Preconditions:
> +
> +- the role must have been defined (see :ref:`cs_define_role`)
> +
> +Necessary package dependencies for code signing provider: ``HOST_OPENSSL``, ``HOST_EXTRACT_CERT``
> diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
> index 6541da3ea..e605e52a6 100644
> --- a/doc/ref_manual.rst
> +++ b/doc/ref_manual.rst
> @@ -4,6 +4,7 @@ PTXdist Reference
>  .. include:: ref_make_variables.inc
>  .. include:: ref_make_macros.inc
>  .. include:: ref_rule_file_layout.inc
> +.. include:: ref_code_signing_helpers.inc
>  
>  .. _ptxdist_parameter_reference:
>  
> -- 
> 2.27.0
> 
> 
> _______________________________________________
> ptxdist mailing list
> ptxdist@pengutronix.de
> To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de