Add documentation for the new <boot-certs> element under <os>, including an XML example and a description of its child <path> elements. The feature is QEMU/s390x-only and available since 12.9.0.
Signed-off-by: Zhuoying Cai <[email protected]> --- docs/formatdomain.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index e4eb2d9ba3..17b8e0431d 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -194,6 +194,18 @@ harddisk, cdrom, network) determining where to obtain/find the boot image. </os> ... + <!-- QEMU s390x with boot certificates --> + ... + <os> + <type arch='s390x' machine='s390-ccw-virtio'>hvm</type> + <boot-certs> + <path>/path/to/cert1.pem</path> + <path>/path/to/cert2.pem</path> + </boot-certs> + <boot dev='hd'/> + </os> + ... + ``firmware`` The ``firmware`` attribute allows management applications to automatically fill ``<loader/>`` and ``<nvram/>`` or ``<varstore/>`` elements and possibly @@ -328,6 +340,18 @@ harddisk, cdrom, network) determining where to obtain/find the boot image. it possible to keep UEFI authenticated variables safe from tampering without requiring the use of SMM emulation. +``boot-certs`` + The optional ``boot-certs`` element contains one or more ``path`` child + elements, each specifying an absolute path to a host X.509 certificate + (in PEM format) or a directory containing certificates. Each path is + passed directly to QEMU's ``boot-certs`` machine property; QEMU itself + determines whether the path refers to a file or a directory and locates + the certificates accordingly. These certificates are used by the s390x + CCW firmware for Secure Boot signature verification. When only + ``boot-certs`` is provided, audit mode is enabled: verification failures + are reported as non-disruptive warnings. + :since:`Since 12.9.0 (QEMU only)` + ``boot`` The ``dev`` attribute takes one of the values "fd", "hd", "cdrom" or "network" and is used to specify the next boot device to consider. The -- 2.56.0
