Skip to contentSkip to conversation

Secure IPL Support for SCSI Scheme of virtio-blk/virtio-scsi Devices

PATCH Superseded Zhuoying Cai 6 participants 92 messages Sep 17, 2025 – Nov 11, 2025

Subsystems (2)

v6 of 17 Superseded Latest is v17 →

lore
Share & tools
lore
#0 lore raw

v6 cover Secure IPL Support for SCSI Scheme of virtio-blk/virtio-scsi Devices

Changelog v5->v6

Add boot-certs to s390-ccw-virtio machine type option
- Renamed struct BootCertPath to BootCertificate
- Defined DummyBootCertificates struct for QMP to use BootCertificateList internally

crypto/x509-utils
- Used gnutls_x509_crt_export2() in qcrypto_x509_convert_cert_der()
- Allocated buffers with g_new for results in qcrypto_x509_convert_cert_der() and qcrypto_pkcs7_convert_sig_pem()
- Added check for qcrypto_to_gnutls_hash_alg_map bounds in qcrypto_x509_get_cert_key_id()
- Added qcrypto_x509_is_ecc_curve_p521() function to determine if an ECC public key algorithm uses P521 curve
- Fixed typo

hw/s390x/ipl: Create certificate store
- Made any configuration errors fatal when loading certificates into the cert store
- Removed key_id_size and hash_size from S390IPLCertificate and defined them as constants
- Do not reinitialize the cert store if it already exists
- Handled memory cleanup

s390x/diag: Implement DIAG 320 subcode 1
- Added QEMU_BUILD_BUG_MSG

s390x/diag: Implement DIAG 320 subcode 2
- Refactored build_vce_header() and created a new function for getting key type
- Added QEMU_BUILD_BUG_MSG

s390x/diag: Implement DIAG 508 subcode 1 for signature verification
- Updated Diag508SigVerifBlock

hw/s390x/ipl: Add IPIB flags to IPL Parameter Block
- Override IPLB length only when DIAG308_IPIB_FLAGS_IPLIR flag is set
- Dropped hw/s390x/ipl: Set iplb->len to maximum length of IPL Parameter Block patch

pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode
- Added validation for VCB and VCE before retrieving information in request_certificate()
- Replaced uint64_t *cert with uint8_t *cert in zipl_run_secure()

-----------------------------------------------------------------------

# Description

This patch series is an external requirement by Linux distribution partners to verify secure IPL process. Additional secure IPL checks are also included in this series to address security holes in the original secure IPL design to prevent malicious actors to boot modified or unsigned code despite secure IPL being enforced.

Secure IPL is enabled when the QEMU options for secure IPL are specified in the command line.

During this process, additional security checks are performed to ensure system integrity.

As components are loaded from disk, DIAG 508 subcode 2 performs signature verification if a signature entry is identified. Upon successful verification, DIAG 320 subcode 2 will request the corresponding certificate from QEMU key store to the BIOS.

Secure IPL will continue until all the components are loaded if no error occurs during True secure IPL mode or in Audit mode (see explanation below).

After that, an IPL Information report block (IIRB) is initialized immediately following an IPL Parameter Information Block. The IIRB is populated with information about the components, verification results and certificate data.

Finally, the guest system proceeds to boot.

Only List-Directed-IPL contains the relevant zIPL data structures to perform secure IPL. This patch series only adds support for the SCSI scheme of virtio-blk/virtio-scsi devices. Secure IPL for other device types will be considered as follow-up work at a later date.

** Note: "secure IPL" and "secure boot" are used interchangeably throughout the design. **

# True Secure IPL Mode and Audit Mode

## True Secure IPL Mode

When secure IPL is enabled and certificates are provided, all the secure IPL checks will performed. The boot process will abort if any error occurs during the secure IPL checks.

## Audit Mode

When the secure IPL option is not selected and certificates are provided, all the secure IPL checks will still be performed. However, the boot process will continue if any errors occur, with messages logged to the console during the secure IPL checks.

The audit mode is also considered as simulated secure IPL because it is less pervasive, and allows the guest to boot regardless of the secure checking results.

# How to Enable Secure IPL

## QEMU Build Notes

When building QEMU, enable the cryptographic libraries.

Run configure script in QEMU repository with either parameter:

	./configure … --enable-gnutls

## Create Certificates via certtool

Generate and use an RSA private key for signing.

	certtool --generate-privkey > key.pem

A self-signed certificate requires the organization name. Use the cert.info template to pre-fill values and avoid interactive prompts from certtool.

	cat > cert.info <<EOF
	cn = "My Name"
	expiration_days = 36500
	cert_signing_key
	EOF

	certtool --generate-self-signed \
		 --load-privkey key.pem \
		 --template cert.info \
		 --hash=SHA256 \
		 --outfile cert.pem

It is recommended to store the certificate(s) in the /…/qemu/certs directory for easy identification.

## Sign Kernel and Prepare zipl

All actions must be performed on a KVM guest.

Copy the sign-file script (located in Linux source repository), generated private key(s), and certificate(s) to guest's file system.

Sign guest image(s) and stage3 binary:

	./sign-file sha256 key.pem cert.pem /boot/vmlinuz-…

	./sign-file sha256 key.pem cert.pem /usr/lib/s390-tools/stage3.bin

Run zipl with secure boot enabled.

	zipl --secure 1 -V

Guest image(s) are now signed, stored on disk, and can be verified.

## New QEMU Command Options for Secure IPL

New parameters have been added to the s390-ccw-virtio machine type to enable Secure IPL and provide certificates for signature verification.

This parameter enables or disables Secure IPL/boot. If not specified, it defaults to off.

	qemu-system-s390x -machine s390-ccw-virtio,secure-boot=on|off

This parameter specifies one or more paths to boot certificates, used for signature verification. You can provide a single certificate file or a directory.

	qemu-system-s390x -machine s390-ccw-virtio, \
                                   boot-certs.0.path=/.../qemu/certs, \
                                   boot-certs.1.path=/another/path/cert.pem

Example:

	qemu-system-s390x -machine s390-ccw-virtio,
	                           secure-boot=on, \
	                           boot-certs.0.path=/.../qemu/certs, \
                                   boot-certs.1.path=/another/path/cert.pem

Secure IPL command options overview:

If neither the -secure-boot nor the -boot-certs options are specified, the guest will boot in normal mode, and no security checks will be conducted.

If the -secure-boot option is not specified or is set to off, and the -boot-certs option is provided, the guest will boot in audit mode. In this mode, all security checks are performed; however, any errors encountered will not interrupt the boot process.

If the -secure-boot option is set to on and the -boot-certs option is provided, the guest will boot in true secure IPL mode. In this mode, all security checks are performed, and any errors encountered will terminate the boot process.
- If the -boot-certs option is not provided in true secure IPL mode, the boot process will fail for the corresponding device.

## Constraints

- z16 CPU model

- certificates must be in X.509 PEM format

- only support for SCSI scheme of virtio-blk/virtio-scsi devices
- The boot process will terminate if secure boot is enabled without
specifying a boot device.
- If enabling secure boot with multiple boot devices, any
unsupported devices or non-eligible devices will cause the entire boot process terminating early with an error logged to the console.

- attempting to perform secure IPL outside of these constraints will result in a failure.

# DIAGNOSE 508 - KVM IPL Extensions

Signature verification is performed during IPL via DIAG 508. Component address, component length, signature address and signature length are obtained in the BIOS and pass to DIAG 508 subcode 2 to perform signature verification in QEMU. If verification succeeds, DIAG 508 subcode 2 (signature verification) will return the length and index of the certificate in the QemuCertificateStore that was used for verification.

## Data Structures

Diag508SignatureVerificationBlock (SVB) — stores addresses and lengths of the component and signature to be used for signature verification. Upon verification, an index and the length of the certificate used is stored.

------------------------------------------------------------------------

Changelog v4->v5

- Segmented documentation by introducing them alongside the patches that add the relevant functionality
- Removed hash-type restriction from S390IPLCertificateStore

Add boot-certs to s390-ccw-virtio machine type option
- Added boot-certs property to the s390-ccw-virtio machine type

    - Changed to use an array property for passing certificate instead
      of colo-delimited strings.
    e.g. boot-certs.0.path=/path/to/dir,
         boot-certs.1.path=/to/other/dir,
         boot-certs.2.path=/some/...

crypto/x509-utils
- Refactored fallback handling into a separated commit
- Removed QCryptoKeyidFlags and qcrypto_x509_get_keyid_len() function
- Removed qcrypto_x509_get_cert_version() and qcrypto_x509_get_signature_algorithm()
- Passed QCryptoHashAlgo to qcrypto_x509_get_cert_key_id() instead of QCryptoKeyidFlags
- Improved memory cleanup

hw/s390x/ipl: Create certificate store
- Fixed error handling and memory management
- Added condition to only accept files with ".pem" extension

s390x: Guest support for Certificate Store Facility (CS)
- Renamed "S390_FEAT_DIAG_320" to "S390_FEAT_CERT_STORE"
- Merged this patch with s390x/diag: Introduce DIAG 320 for certificate store facility patch

s390x/diag: Introduce DIAG 320 for certificate store facility
- Added bit zero to indicate subcode 0 is supported
- Set response code to 0x0102 when the subcode is not supported
- Added check to ensure subcode fits within one byte

s390x/diag: Implement DIAG 320 subcode 1
- Refactored and moved implementation to a helper function
- Added check to ensure VCSSB length is set to a minimum of 128 bytes from the userspace
- Removed max_vce_len field from the VCSSB data structure

s390x/diag: Implement DIAG 320 subcode 2
- Refactored and split functions for extracting certificate information
- Set VCE length to 72 if certificate is invalid
- Returned VCE even if the certificate is invalid

pc-bios/s390-ccw: Refactor zipl_run()
- Refactor zipl_run_normal() to reduce duplicate code

pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode
- Moved secure-boot related functions into secure-ipl.c/h files
- Rename zipl_handle_sig_entry() to zipl_load_signature()
- Refactored zipl_run_secure() to use switch cases for different entry types instead of a while loop
- Renamed ZiplBootMode enumerations with "ZIPL_BOOT_MODE" prefix
- Added meaningful file header to secure-ipl.c
- Renamed zipl_secure_print() to zipl_secure_handle()

Changelog v3->v4:

cyrpto/x590-utils
- Updated patch descriptions to summarize what each patch introduces.
- Restricted accepted certificate format on the QEMU command line to PEM only.
- Added internal conversion routines to handle PEM-to-DER and
DER-to-PEM as needed.
- Renamed crypto functions using the qcrypto_x509_ prefix.
- Replaced QAPI enums with plain C enums.
- Improved GNUTLS error propagation throughout the crypto API.
- Standardized error returns to -1 (instead of using errno values) for consistency.
- Removed unused helpers: qcrypto_check_x509_cert_fmt() and qcrypto_get_x509_hash_len().
- Added bounds checking before converting GNUTLS enums to internal crypto enums.
- Modified qcrypto_get_x509_cert_key_id() to dynamically allocate the result.
- Fixed a typo in the crypto API documentation.

hw/s390x/ipl: Create certificate store
- Removed max_size check when loading certificate.
- Removed check_path_type() and use the stat() & S_ISXXX checks inline where needed.
- Initialized all g_autofree variables.
- Refactored get_cert_paths()
- Used g_auto(GStrv) and g_autoptr(GPtrArray) for automatic cleanup.
- Renamed misleading variables and dropped unnecessary intermediates.
- Replaced check_path_type() with stat(), and treated failures as fatal.
- Treated empty path components as fatal configuration errors.
- Used GError with g_dir_open() and handled errors properly.
- Removed redundant casts and manual cleanup.
- Treated providing 65 or more certificates as a fatal error.
- Modified S390IPLCertificate
- Changed raw from char * to uint8_t * for API consistency.
- Added cert_der field to calculate certificate data buffer size for
DIAG 320 and format conversion.

s390x/diag
- Handled error propagation from crypto API correctly.
- Added g_autofree to variables to ensure proper memory cleanup.
- Initialized all g_autofree variables.

pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode
- Allocated certificate buffer based on calculated size instead of static MAX_CERT_SIZE.

pc-bios/s390-ccw: Add additional security checks for secure boot
- Refactored to improve readability.
- Handled SCLAB Single Component/No Unsigned Component flags.

docs: Add secure IPL documentation
- Updated documentation.
- Illustrated with gnutls ‘certtool’ instead of ‘openssl’ for consistency with other certificate creation docs.

- Updated cover letter with corresponding changes.

Changelog v2->v3:

- Fixed typos in patches
- Edited and corrected patch description
- Enabled secure IPL feature in TCG
- Split crypto subsystem changes from s390x subsystem changes
- Added API documentation for each helper function
- Removed qcrypto_get_x509_cert_fmt()
- Reworked qcrypto_check_x509_cert_fmt() to return 0 on success and
negative error code on errors
- Rephrased error messages when GNUTLS is not enabled
- Changed dev cycle reference from 9.2 to 10.1

hw/s390x/ipl: Create certificate store
- Passed *cert_buf to g_file_get_contents() directly in cert2buf()
- Returned NULL for early returns
- Added check to only allow maximum of 64 certificates in the certificate store

s390x: Guest support for Certificate Store Facility (CS)
- Renamed “diag320” to “cstore”

s390x/diag: Implement DIAG 320 subcode 1
- Removed QEMU_PACKED from VCStorageSizeBlock
- Removed unnecessary error check from subcode 1 implementation

s390x/diag: Implement DIAG 320 subcode 2
- Removed QEMU_PACKED from VCBlock and VCEngtry
- Reworked diag_320_is_cert_valid() to return 0 on success and negative error code on errors
- Set *key_id_data and *hash_data to NULL after g_free()
- Moved DIAG_320_SUBC_STORE_VC case block implementation to a separate function

s390x/diag: Implement DIAG 508 subcode 1 for signature verification
- Added a reserved field to Diag508CertificateStoreInfo
- Removed QEMU_PACKED from Diag508CertificateStoreInfo and Diag508SignatureVerificationBlock
- Applied g_autofree to svb, svb_comp and svb_sig varaibles
- Moved DIAG_508_SUBC_SIG_VERIF case block implementation to a separate function

pc-bios/s390-ccw: Refactor zipl_load_segment function
- Removed casting when calculating comp_len

pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode
- Used malloc() to allocate certificate buffer instead of statically allocating
- Reworked zipl_secure_print()

s390x: Guest support for Secure-IPL Code Loading Attributes Facility (SCLAF)
- Added check to make sure SIPL is enabled when SCLAF is enabled

docs: Add secure IPL documentation
- Split document into two parts:
- docs/specs/s390x-secure-ipl.rst (developer reference)
- docs/system/s390x/secure-ipl.rst (user guide)

Changelog v1->v2:

- Fixed typos in patches
- Edited cover letter
- Added secure IPL documentation

QEMU Command-Line Interface:
- Moved boot-certificates under the machine-type option for s390x-virtio-ccw
- Moved secure-boot under the machine-type option for s390x-virtio-ccw

hw/s390x/ipl: Create Certificate Store
- Defined internal GNUTLS-related APIs
- Added check to only accept certificates using SHA-256 hashing
- Recalculated data_buf_size to ensure word alignment
- Cleaned up memory allocation
- Refactored functions for clarity

s390x: Guest Support for Certificate Store Facility (CS)
- Updated patch description to clarify:
- Why Secure IPL is not available with Secure Execution
- Why this feature requires S390_FEAT_EXTENDED_LENGTH_SCCB
-Restricted features to z16 due to additional layers requiring z16

s390x/diag: Implement DIAG 320 Subcode 1
- Renamed VerificationCertificate prefix to VC
- Byte-swap written values for endianness correctness

s390x/diag: Implement DIAG 320 Subcode 2
- Edited commit message for clarity
- Defined internal GNUTLS-related APIs
- Renamed data structure variables
- Ensured length fields in VCE are word-aligned
- Handled the VC index 0 case
- General refactoring

s390x/diag: Implement DIAG 508 Subcode 2 for Signature Verification
- Defined subcode from 2 to 1
- Removed unused error codes
- Defined internal GNUTLS-related APIs
- Byte-swap read values

hw/s390x/ipl: Add IPIB Flags to IPL Parameter Block
- Moved DIAG308 flags to a new header file

s390x: Guest Support for Secure-IPL Facility
- Renamed SCLP variable from cbl to fac_ipl

pc-bios/s390-ccw: Add Signature Verification for Secure Boot (Audit Mode)
- Moved Secure IPL-related functions to pc-bios/s390-ccw/secure-ip.c|h
- Refactored code for clarity

Collin L. Walling (2):
s390x/diag: Introduce DIAG 508 for secure IPL operations s390x/diag: Implement DIAG 508 subcode 1 for signature verification

Zhuoying Cai (26):
Add boot-certs to s390-ccw-virtio machine type option crypto/x509-utils: Refactor with GNUTLS fallback crypto/x509-utils: Add helper functions for certificate store hw/s390x/ipl: Create certificate store
s390x/diag: Introduce DIAG 320 for Certificate Store Facility s390x/diag: Refactor address validation check from diag308_parm_check s390x/diag: Implement DIAG 320 subcode 1 crypto/x509-utils: Add helper functions for DIAG 320 subcode 2 s390x/diag: Implement DIAG 320 subcode 2 crypto/x509-utils: Add helper functions for DIAG 508 subcode 1 pc-bios/s390-ccw: Introduce IPL Information Report Block (IIRB) pc-bios/s390-ccw: Define memory for IPLB and convert IPLB to pointers hw/s390x/ipl: Add IPIB flags to IPL Parameter Block
s390x: Guest support for Secure-IPL Facility pc-bios/s390-ccw: Refactor zipl_run()
pc-bios/s390-ccw: Rework zipl_load_segment function pc-bios/s390-ccw: Add signature verification for secure IPL in audit
mode
s390x: Guest support for Secure-IPL Code Loading Attributes Facility

    (SCLAF)

pc-bios/s390-ccw: Add additional security checks for secure boot Add secure-boot to s390-ccw-virtio machine type option hw/s390x/ipl: Set IPIB flags for secure IPL pc-bios/s390-ccw: Handle true secure IPL mode pc-bios/s390-ccw: Handle secure boot with multiple boot devices hw/s390x/ipl: Handle secure boot without specifying a boot device docs/specs: Add secure IPL documentation docs/system/s390x: Add secure IPL documentation

 crypto/meson.build                  |   5 +-
 crypto/x509-utils.c                 | 423 +++++++++++++++
 docs/specs/s390x-secure-ipl.rst     | 165 ++++++
 docs/system/s390x/secure-ipl.rst    | 181 +++++++
 hw/s390x/cert-store.c               | 213 ++++++++
 hw/s390x/cert-store.h               |  39 ++
 hw/s390x/ipl.c                      |  62 +++
 hw/s390x/ipl.h                      |  27 +-
 hw/s390x/meson.build                |   1 +
 hw/s390x/s390-virtio-ccw.c          |  52 ++
 hw/s390x/sclp.c                     |   2 +
 include/crypto/x509-utils.h         | 131 +++++
 include/hw/s390x/ipl/diag308.h      |  34 ++
 include/hw/s390x/ipl/diag320.h      |  91 ++++
 include/hw/s390x/ipl/diag508.h      |  38 ++
 include/hw/s390x/ipl/qipl.h         |   7 +-
 include/hw/s390x/s390-virtio-ccw.h  |   3 +
 include/hw/s390x/sclp.h             |   4 +-
 pc-bios/s390-ccw/Makefile           |   3 +-
 pc-bios/s390-ccw/bootmap.c          | 107 +++-
 pc-bios/s390-ccw/bootmap.h          |  11 +
 pc-bios/s390-ccw/iplb.h             |  96 +++-
 pc-bios/s390-ccw/jump2ipl.c         |   6 +-
 pc-bios/s390-ccw/main.c             | 111 +++-
 pc-bios/s390-ccw/netmain.c          |   8 +-
 pc-bios/s390-ccw/s390-ccw.h         |  19 +
 pc-bios/s390-ccw/sclp.c             |  52 ++
 pc-bios/s390-ccw/sclp.h             |   7 +
 pc-bios/s390-ccw/secure-ipl.c       | 781 ++++++++++++++++++++++++++++
 pc-bios/s390-ccw/secure-ipl.h       | 212 ++++++++
 qapi/machine-s390x.json             |  22 +
 qapi/pragma.json                    |   1 +
 qemu-options.hx                     |  10 +-
 target/s390x/cpu_features.c         |   7 +
 target/s390x/cpu_features.h         |   1 +
 target/s390x/cpu_features_def.h.inc |   5 +
 target/s390x/cpu_models.c           |   7 +
 target/s390x/diag.c                 | 555 +++++++++++++++++++-
 target/s390x/gen-features.c         |   7 +
 target/s390x/kvm/kvm.c              |  34 ++
 target/s390x/s390x-internal.h       |   4 +
 target/s390x/tcg/misc_helper.c      |  14 +
 42 files changed, 3488 insertions(+), 70 deletions(-)
 create mode 100644 docs/specs/s390x-secure-ipl.rst
 create mode 100644 docs/system/s390x/secure-ipl.rst
 create mode 100644 hw/s390x/cert-store.c
 create mode 100644 hw/s390x/cert-store.h
 create mode 100644 include/hw/s390x/ipl/diag308.h
 create mode 100644 include/hw/s390x/ipl/diag320.h
 create mode 100644 include/hw/s390x/ipl/diag508.h
 create mode 100644 pc-bios/s390-ccw/secure-ipl.c
 create mode 100644 pc-bios/s390-ccw/secure-ipl.h
Signature · 1 line
2.50.1
#1 lore raw

PATCH v6 1/28 Add boot-certs to s390-ccw-virtio machine type option

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...
---
 docs/system/s390x/secure-ipl.rst   | 21 +++++++++++++++++++++
 hw/s390x/s390-virtio-ccw.c         | 30 ++++++++++++++++++++++++++++++
 include/hw/s390x/s390-virtio-ccw.h |  2 ++
 qapi/machine-s390x.json            | 22 ++++++++++++++++++++++
 qapi/pragma.json                   |  1 +
 qemu-options.hx                    |  6 +++++-
 6 files changed, 81 insertions(+), 1 deletion(-)
 create mode 100644 docs/system/s390x/secure-ipl.rst
docs/system/s390x/secure-ipl.rst new file +21 -0
new file mode 100644
index 0000000000..92c1bb2153
@@ -0,0 +1,21 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Secure IPL Command Line Options
+===============================
+
+The s390-ccw-virtio machine type supports secure IPL. These parameters allow users
+to provide certificates and enable secure IPL directly via the command line.
+
+Providing Certificates
+----------------------
+
+The certificate store can be populated by supplying a list of X.509 certificate file
+paths or directories containing certificate files on the command-line:
+
+Note: certificate files must have a .pem extension.
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio, \
+                               boot-certs.0.path=/.../qemu/certs, \
+                               boot-certs.1.path=/another/path/cert.pem ...
hw/s390x/s390-virtio-ccw.c +30 -0
index b1dc52807a..b825f4cce1 100644
@@ -45,6 +45,7 @@
 #include "target/s390x/kvm/pv.h"
 #include "migration/blocker.h"
 #include "qapi/visitor.h"
+#include "qapi/qapi-visit-machine-s390x.h"
 #include "hw/s390x/cpu-topology.h"
 #include "kvm/kvm_s390x.h"
 #include "hw/virtio/virtio-md-pci.h"
@@ -798,6 +799,30 @@ static void machine_set_loadparm(Object *obj, Visitor *v,
     g_free(val);
 }
 
+static void machine_get_boot_certs(Object *obj, Visitor *v,
+                                   const char *name, void *opaque,
+                                   Error **errp)
+{
+    S390CcwMachineState *ms = S390_CCW_MACHINE(obj);
+    BootCertificateList **certs = &ms->boot_certs;
+
+    visit_type_BootCertificateList(v, name, certs, errp);
+}
+
+static void machine_set_boot_certs(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
+{
+    S390CcwMachineState *ms = S390_CCW_MACHINE(obj);
+    BootCertificateList *cert_list = NULL;
+
+    visit_type_BootCertificateList(v, name, &cert_list, errp);
+    if (!cert_list) {
+        return;
+    }
+
+    ms->boot_certs = cert_list;
+}
+
 static void ccw_machine_class_init(ObjectClass *oc, const void *data)
 {
     MachineClass *mc = MACHINE_CLASS(oc);
@@ -851,6 +876,11 @@ static void ccw_machine_class_init(ObjectClass *oc, const void *data)
             "Up to 8 chars in set of [A-Za-z0-9. ] (lower case chars converted"
             " to upper case) to pass to machine loader, boot manager,"
             " and guest kernel");
+
+    object_class_property_add(oc, "boot-certs", "BootCertificateList",
+                              machine_get_boot_certs, machine_set_boot_certs, NULL, NULL);
+    object_class_property_set_description(oc, "boot-certs",
+            "provide paths to a directory and/or a certificate file for secure boot");
 }
 
 static inline void s390_machine_initfn(Object *obj)
include/hw/s390x/s390-virtio-ccw.h +2 -0
index 526078a4e2..334b67ef05 100644
@@ -14,6 +14,7 @@
 #include "hw/boards.h"
 #include "qom/object.h"
 #include "hw/s390x/sclp.h"
+#include "qapi/qapi-types-machine-s390x.h"
 
 #define TYPE_S390_CCW_MACHINE               "s390-ccw-machine"
 
@@ -31,6 +32,7 @@ struct S390CcwMachineState {
     uint8_t loadparm[8];
     uint64_t memory_limit;
     uint64_t max_pagesize;
+    BootCertificateList *boot_certs;
 
     SCLPDevice *sclp;
 };
qapi/machine-s390x.json +22 -0
index 966dbd61d2..51bf791fe6 100644
@@ -119,3 +119,25 @@
 { 'command': 'query-s390x-cpu-polarization', 'returns': 'CpuPolarizationInfo',
   'features': [ 'unstable' ]
 }
+
+##
+# @BootCertificate:
+#
+# Boot certificate for secure IPL.
+#
+# @path: path to an X.509 certificate file or a directory containing certificate files.
+#
+# Since: 10.2
+##
+{ 'struct': 'BootCertificate',
+  'data': {'path': 'str'} }
+
+##
+# @DummyBootCertificates:
+#
+# Not used by QMP; hack to let us use BootCertificateList internally.
+#
+# Since: 10.2
+##
+{ 'struct': 'DummyBootCertificates',
+  'data': {'unused-boot-certs': ['BootCertificate'] } }
qapi/pragma.json +1 -0
index 023a2ef7bc..66401837ad 100644
@@ -49,6 +49,7 @@
         'DisplayProtocol',
         'DriveBackupWrapper',
         'DummyBlockCoreForceArrays',
+        'DummyBootCertificates',
         'DummyForceArrays',
         'DummyVirtioForceArrays',
         'HotKeyMod',
qemu-options.hx +5 -1
index ab23f14d21..ac497eb3a0 100644
@@ -44,7 +44,8 @@ DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
 #endif
     "                memory-backend='backend-id' specifies explicitly provided backend for main RAM (default=none)\n"
     "                cxl-fmw.0.targets.0=firsttarget,cxl-fmw.0.targets.1=secondtarget,cxl-fmw.0.size=size[,cxl-fmw.0.interleave-granularity=granularity]\n"
-    "                smp-cache.0.cache=cachename,smp-cache.0.topology=topologylevel\n",
+    "                smp-cache.0.cache=cachename,smp-cache.0.topology=topologylevel\n"
+    "                boot-certs.0.path=/path/directory,boot-certs.1.path=/path/file provides paths to a directory and/or a certificate file\n",
     QEMU_ARCH_ALL)
 SRST
 ``-machine [type=]name[,prop=value[,...]]``
@@ -205,6 +206,9 @@ SRST
         ::
 
             -machine smp-cache.0.cache=l1d,smp-cache.0.topology=core,smp-cache.1.cache=l1i,smp-cache.1.topology=core
+
+    ``boot-certs.0.path=/path/directory,boot-certs.1.path=/path/file``
+        Provide paths to a directory and/or a certificate file on the host [s390x only].
 ERST
 
 DEF("M", HAS_ARG, QEMU_OPTION_M,
Signature · 1 line
2.50.1
#2 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

Quoted 11 lines · Zhuoying Cai

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...

Given we can specifiy a directory containing any number of certificate files, is the ability to specify multiple paths worth the additional complexity?

Quoted 1 line

[...]

Quoted 10 lines
qapi/machine-s390x.json +2 -0
index 966dbd61d2..51bf791fe6 100644
@@ -119,3 +119,25 @@
 { 'command': 'query-s390x-cpu-polarization', 'returns': 'CpuPolarizationInfo',
   'features': [ 'unstable' ]
 }
+
+##

qapi/machine-s390x.json line 133

Quoted 10 lines
qapi/machine-s390x.json +10 -0
+# @BootCertificate:
+#
+# Boot certificate for secure IPL.
+#
+# @path: path to an X.509 certificate file or a directory containing certificate files.
+#
+# Since: 10.2
+##
+{ 'struct': 'BootCertificate',
+  'data': {'path': 'str'} }

I'd call this BootCertificates (plural), because it can pull in any number, not just than one.

Quoted 22 lines
qapi/machine-s390x.json +10 -0
+
+##
+# @DummyBootCertificates:
+#
+# Not used by QMP; hack to let us use BootCertificateList internally.
+#
+# Since: 10.2
+##
+{ 'struct': 'DummyBootCertificates',
+  'data': {'unused-boot-certs': ['BootCertificate'] } }
qapi/pragma.json +1 -0
index 023a2ef7bc..66401837ad 100644
@@ -49,6 +49,7 @@
         'DisplayProtocol',
         'DriveBackupWrapper',
         'DummyBlockCoreForceArrays',
+        'DummyBootCertificates',
         'DummyForceArrays',
         'DummyVirtioForceArrays',
         'HotKeyMod',
#3 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

Quoted 9 lines · Markus Armbruster
Quoted 7 lines · Zhuoying Cai

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Quoted 8 lines
Quoted 4 lines

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...

Given we can specifiy a directory containing any number of certificate files, is the ability to specify multiple paths worth the additional complexity?

The typical scenario would be point to somewhere in /etc/pki for some globally provided certs, and then also point to somewhere local ($HOME) for custom extra certs. So IMHO it is reasonable to want multiple paths, to avoid copying around certs from different locations.

Quoted 43 lines
Quoted 2 lines

[...]

Quoted 10 lines
qapi/machine-s390x.json +2 -0
index 966dbd61d2..51bf791fe6 100644
@@ -119,3 +119,25 @@
 { 'command': 'query-s390x-cpu-polarization', 'returns': 'CpuPolarizationInfo',
   'features': [ 'unstable' ]
 }
+
+##

qapi/machine-s390x.json line 133

Quoted 10 lines
qapi/machine-s390x.json +10 -0
+# @BootCertificate:
+#
+# Boot certificate for secure IPL.
+#
+# @path: path to an X.509 certificate file or a directory containing certificate files.
+#
+# Since: 10.2
+##
+{ 'struct': 'BootCertificate',
+  'data': {'path': 'str'} }

I'd call this BootCertificates (plural), because it can pull in any number, not just than one.

Quoted 14 lines
qapi/machine-s390x.json +10 -0
+
+##
+# @DummyBootCertificates:
+#
+# Not used by QMP; hack to let us use BootCertificateList internally.
+#
+# Since: 10.2
+##
+{ 'struct': 'DummyBootCertificates',
+  'data': {'unused-boot-certs': ['BootCertificate'] } }
qapi/pragma.json +0 -0
index 023a2ef7bc..66401837ad 100644
Quoted 9 lines

qapi/pragma.json line 55

Quoted 8 lines
qapi/pragma.json +1 -0
@@ -49,6 +49,7 @@
         'DisplayProtocol',
         'DriveBackupWrapper',
         'DummyBlockCoreForceArrays',
+        'DummyBootCertificates',
         'DummyForceArrays',
         'DummyVirtioForceArrays',
         'HotKeyMod',

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#4 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

Quoted 19 lines · Daniel P. Berrangé
Quoted 9 lines · Markus Armbruster
Quoted 7 lines · Zhuoying Cai

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Quoted 8 lines
Quoted 4 lines

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...

Given we can specifiy a directory containing any number of certificate files, is the ability to specify multiple paths worth the additional complexity?

Quoted 5 lines

The typical scenario would be point to somewhere in /etc/pki for some globally provided certs, and then also point to somewhere local ($HOME) for custom extra certs. So IMHO it is reasonable to want multiple paths, to avoid copying around certs from different locations.

Thanks.

Preferably with BootCertificate renamed to BootCertificates

#5 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

Quoted 27 lines · Markus Armbruster
Quoted 19 lines · Daniel P. Berrangé
Quoted 9 lines · Markus Armbruster
Quoted 7 lines · Zhuoying Cai

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Quoted 8 lines
Quoted 4 lines

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...

Given we can specifiy a directory containing any number of certificate files, is the ability to specify multiple paths worth the additional complexity?

Quoted 5 lines

The typical scenario would be point to somewhere in /etc/pki for some globally provided certs, and then also point to somewhere local ($HOME) for custom extra certs. So IMHO it is reasonable to want multiple paths, to avoid copying around certs from different locations.

Quoted 5 lines

Thanks.

Preferably with BootCertificate renamed to BootCertificates

I'll rename it in the next version. Thanks for the review!

#6 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

In reply to Daniel P. Berrangé
Quoted 19 lines · Daniel P. Berrangé
Quoted 9 lines · Markus Armbruster
Quoted 7 lines · Zhuoying Cai

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Quoted 8 lines
Quoted 4 lines

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...

Given we can specifiy a directory containing any number of certificate files, is the ability to specify multiple paths worth the additional complexity?

Quoted 6 lines

The typical scenario would be point to somewhere in /etc/pki for some globally provided certs, and then also point to somewhere local ($HOME) for custom extra certs. So IMHO it is reasonable to want multiple paths, to avoid copying around certs from different locations.

Thank you for the comments.

Since Secure IPL on s390x is supported in QEMU, I would like to begin drafting the corresponding Libvirt interface and seek feedback before proceeding with the implementation.

While Libvirt already provides a secure boot interface
(https://libvirt.org/kbase/secureboot.html), it appears to be primarily intended for x86 systems, where secure boot is configured using the <firmware>, <loader>, and <nvram> tags.

	<os firmware='efi'>
      	    <firmware>
		<feature enabled='yes' name='enrolled-keys'/>
		<feature enabled='yes' name='secure-boot'/>
	    </firmware>
	    <loader secure='yes' type='pflash'>...</loader>
	    <nvram template='...'>...</nvram>
	</os>

For s390x, some of these existing tags may be reused, but additional elements will be needed.

Below is my initial proposal for the secure boot interface in Libvirt:

<!-- New s390-ccw-bios firmware value -->

	<os firmware='s390-ccw-bios'>
	    <type arch='s390x' machine='s390-ccw-virtio-9.2'>hvm</type>
	    <firmware>
                <!-- To enable secure boot -->
		<feature enabled='yes' name='secure-boot'/>
	    </firmware>
            <!-- To provide boot certificates for secure boot -->
	    <boot-certs path='/path/to/cert.pem' />
            <boot-certs path='/path/to/cert-dir' />
	    <boot dev='hd'/>
	</os>

I would be greatly appreciate any suggestions or feedback on this proposal, and I am open to refining the design to better align with existing Libvirt structures.

Best regards,
Joy

Quoted 55 lines
Quoted 43 lines
Quoted 2 lines

[...]

Quoted 10 lines
qapi/machine-s390x.json +2 -0
index 966dbd61d2..51bf791fe6 100644
@@ -119,3 +119,25 @@
 { 'command': 'query-s390x-cpu-polarization', 'returns': 'CpuPolarizationInfo',
   'features': [ 'unstable' ]
 }
+
+##

qapi/machine-s390x.json line 133

Quoted 10 lines
qapi/machine-s390x.json +10 -0
+# @BootCertificate:
+#
+# Boot certificate for secure IPL.
+#
+# @path: path to an X.509 certificate file or a directory containing certificate files.
+#
+# Since: 10.2
+##
+{ 'struct': 'BootCertificate',
+  'data': {'path': 'str'} }

I'd call this BootCertificates (plural), because it can pull in any number, not just than one.

Quoted 14 lines
qapi/machine-s390x.json +10 -0
+
+##
+# @DummyBootCertificates:
+#
+# Not used by QMP; hack to let us use BootCertificateList internally.
+#
+# Since: 10.2
+##
+{ 'struct': 'DummyBootCertificates',
+  'data': {'unused-boot-certs': ['BootCertificate'] } }
qapi/pragma.json +0 -0
index 023a2ef7bc..66401837ad 100644
Quoted 9 lines

qapi/pragma.json line 55

Quoted 8 lines
qapi/pragma.json +1 -0
@@ -49,6 +49,7 @@
         'DisplayProtocol',
         'DriveBackupWrapper',
         'DummyBlockCoreForceArrays',
+        'DummyBootCertificates',
         'DummyForceArrays',
         'DummyVirtioForceArrays',
         'HotKeyMod',

With regards,
Daniel

#7 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

Quoted 1 line · Zhuoying Cai

On 9/18/25 4:38 AM, Daniel P. Berrangé wrote:

[...]

Quoted 39 lines

Thank you for the comments.

Since Secure IPL on s390x is supported in QEMU, I would like to begin drafting the corresponding Libvirt interface and seek feedback before proceeding with the implementation.

While Libvirt already provides a secure boot interface
(https://libvirt.org/kbase/secureboot.html), it appears to be primarily intended for x86 systems, where secure boot is configured using the <firmware>, <loader>, and <nvram> tags.

	<os firmware='efi'>
      	    <firmware>
		<feature enabled='yes' name='enrolled-keys'/>
		<feature enabled='yes' name='secure-boot'/>
	    </firmware>
	    <loader secure='yes' type='pflash'>...</loader>
	    <nvram template='...'>...</nvram>
	</os>

For s390x, some of these existing tags may be reused, but additional elements will be needed.

Below is my initial proposal for the secure boot interface in Libvirt:

<!-- New s390-ccw-bios firmware value -->

	<os firmware='s390-ccw-bios'>
	    <type arch='s390x' machine='s390-ccw-virtio-9.2'>hvm</type>
	    <firmware>
                <!-- To enable secure boot -->
		<feature enabled='yes' name='secure-boot'/>
	    </firmware>
            <!-- To provide boot certificates for secure boot -->
	    <boot-certs path='/path/to/cert.pem' />
            <boot-certs path='/path/to/cert-dir' />
	    <boot dev='hd'/>
	</os>
Quoted 7 lines

I would be greatly appreciate any suggestions or feedback on this proposal, and I am open to refining the design to better align with existing Libvirt structures.

Best regards,
Joy

You should post an RFC to the libvirt list -- no code needed. I suggest posting what you wrote above while also giving an example of the QEMU commandline. Lastly, give a short background of what you've been working on and provide a link to these patches for a more detail.

CC those who have been involved in review as well as Boris, please. Thanks!

[...]

Signature · 2 lines
Regards,
  Collin
#8 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

Quoted 52 lines · Collin Walling
Quoted 1 line · Zhuoying Cai

On 9/18/25 4:38 AM, Daniel P. Berrangé wrote:

[...]

Quoted 39 lines

Thank you for the comments.

Since Secure IPL on s390x is supported in QEMU, I would like to begin drafting the corresponding Libvirt interface and seek feedback before proceeding with the implementation.

While Libvirt already provides a secure boot interface
(https://libvirt.org/kbase/secureboot.html), it appears to be primarily intended for x86 systems, where secure boot is configured using the <firmware>, <loader>, and <nvram> tags.

	<os firmware='efi'>
      	    <firmware>
		<feature enabled='yes' name='enrolled-keys'/>
		<feature enabled='yes' name='secure-boot'/>
	    </firmware>
	    <loader secure='yes' type='pflash'>...</loader>
	    <nvram template='...'>...</nvram>
	</os>

For s390x, some of these existing tags may be reused, but additional elements will be needed.

Below is my initial proposal for the secure boot interface in Libvirt:

<!-- New s390-ccw-bios firmware value -->

	<os firmware='s390-ccw-bios'>
	    <type arch='s390x' machine='s390-ccw-virtio-9.2'>hvm</type>
	    <firmware>
                <!-- To enable secure boot -->
		<feature enabled='yes' name='secure-boot'/>
	    </firmware>
            <!-- To provide boot certificates for secure boot -->
	    <boot-certs path='/path/to/cert.pem' />
            <boot-certs path='/path/to/cert-dir' />
	    <boot dev='hd'/>
	</os>
Quoted 7 lines

I would be greatly appreciate any suggestions or feedback on this proposal, and I am open to refining the design to better align with existing Libvirt structures.

Best regards,
Joy

Quoted 7 lines

You should post an RFC to the libvirt list -- no code needed. I suggest posting what you wrote above while also giving an example of the QEMU commandline. Lastly, give a short background of what you've been working on and provide a link to these patches for a more detail.

CC those who have been involved in review as well as Boris, please. Thanks!

Thank you for the suggestion!

I posted an RFC to the libvirt list
(https://lists.libvirt.org/archives/list/[email protected]/thread/DWCOPLUGJKYZ6BOCX3JWU2FJGFLG7DUF/).

Quoted 2 lines

[...]

#9 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

In reply to Zhuoying Cai
Quoted 40 lines · Zhuoying Cai

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...
---
  docs/system/s390x/secure-ipl.rst   | 21 +++++++++++++++++++++
  hw/s390x/s390-virtio-ccw.c         | 30 ++++++++++++++++++++++++++++++
  include/hw/s390x/s390-virtio-ccw.h |  2 ++
  qapi/machine-s390x.json            | 22 ++++++++++++++++++++++
  qapi/pragma.json                   |  1 +
  qemu-options.hx                    |  6 +++++-
  6 files changed, 81 insertions(+), 1 deletion(-)

create mode 100644 docs/system/s390x/secure-ipl.rst

docs/system/s390x/secure-ipl.rst new file +11 -0
new file mode 100644
index 0000000000..92c1bb2153
@@ -0,0 +1,21 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Secure IPL Command Line Options
+===============================
+
+The s390-ccw-virtio machine type supports secure IPL. These parameters allow users
+to provide certificates and enable secure IPL directly via the command line.
+
+Providing Certificates
+----------------------
+

docs/system/s390x/secure-ipl.rst line 21

Quoted 10 lines
docs/system/s390x/secure-ipl.rst new file +10 -0
+The certificate store can be populated by supplying a list of X.509 certificate file
+paths or directories containing certificate files on the command-line:
+
+Note: certificate files must have a .pem extension.
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio, \
+                               boot-certs.0.path=/.../qemu/certs, \
+                               boot-certs.1.path=/another/path/cert.pem ...

Using newlines/spaces between parameters does not work, so people cannot copy-n-paste this example to the shell.

So I think you either have to merge it into one line, or use multiple "-machine" statements, e.g.:

    qemu-system-s390x -M s390-ccw-virtio \
                      -M boot-certs.0.path=/.../qemu/certs \
                      -M boot-certs.1.path=/another/path/cert.pem ...

Thomas

#10 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

Quoted 55 lines · Thomas Huth
Quoted 40 lines · Zhuoying Cai

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...
---
  docs/system/s390x/secure-ipl.rst   | 21 +++++++++++++++++++++
  hw/s390x/s390-virtio-ccw.c         | 30 ++++++++++++++++++++++++++++++
  include/hw/s390x/s390-virtio-ccw.h |  2 ++
  qapi/machine-s390x.json            | 22 ++++++++++++++++++++++
  qapi/pragma.json                   |  1 +
  qemu-options.hx                    |  6 +++++-
  6 files changed, 81 insertions(+), 1 deletion(-)

create mode 100644 docs/system/s390x/secure-ipl.rst

docs/system/s390x/secure-ipl.rst new file +11 -0
new file mode 100644
index 0000000000..92c1bb2153
@@ -0,0 +1,21 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Secure IPL Command Line Options
+===============================
+
+The s390-ccw-virtio machine type supports secure IPL. These parameters allow users
+to provide certificates and enable secure IPL directly via the command line.
+
+Providing Certificates
+----------------------
+

docs/system/s390x/secure-ipl.rst line 21

Quoted 10 lines
docs/system/s390x/secure-ipl.rst new file +10 -0
+The certificate store can be populated by supplying a list of X.509 certificate file
+paths or directories containing certificate files on the command-line:
+
+Note: certificate files must have a .pem extension.
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio, \
+                               boot-certs.0.path=/.../qemu/certs, \
+                               boot-certs.1.path=/another/path/cert.pem ...

Using newlines/spaces between parameters does not work, so people cannot copy-n-paste this example to the shell.

Quoted 6 lines

So I think you either have to merge it into one line, or use multiple "-machine" statements, e.g.:

    qemu-system-s390x -M s390-ccw-virtio \
                      -M boot-certs.0.path=/.../qemu/certs \
                      -M boot-certs.1.path=/another/path/cert.pem ...

The inability to copy+paste is unfortunate, but IMHO the docs are better in the way they are already expressed. Repeating the -M arg in this way is not a natural way we'd expect people to configure QEMU, even if it happens to work in the case of -M/-machine.

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#11 lore raw

Re: [PATCH v6 01/28] Add boot-certs to s390-ccw-virtio machine type option

Quoted 59 lines · Daniel P. Berrangé
Quoted 58 lines · Thomas Huth
Quoted 40 lines · Zhuoying Cai

Introduce a new boot-certs machine type option for the s390-ccw-virtio machine. This allows users to specify one or more certificate file paths or directories to be used during secure boot.

Each entry is specified using the syntax:
boot-certs.<index>.path=/path/to/cert.pem

Multiple paths can be specify using array properties:

	boot-certs.0.path=/path/to/cert.pem,
	boot-certs.1.path=/path/to/cert-dir,
	boot-certs.2.path=/path/to/another-dir...
---
   docs/system/s390x/secure-ipl.rst   | 21 +++++++++++++++++++++
   hw/s390x/s390-virtio-ccw.c         | 30 ++++++++++++++++++++++++++++++
   include/hw/s390x/s390-virtio-ccw.h |  2 ++
   qapi/machine-s390x.json            | 22 ++++++++++++++++++++++
   qapi/pragma.json                   |  1 +
   qemu-options.hx                    |  6 +++++-
   6 files changed, 81 insertions(+), 1 deletion(-)

create mode 100644 docs/system/s390x/secure-ipl.rst

docs/system/s390x/secure-ipl.rst new file +11 -0
new file mode 100644
index 0000000000..92c1bb2153
@@ -0,0 +1,21 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Secure IPL Command Line Options
+===============================
+
+The s390-ccw-virtio machine type supports secure IPL. These parameters allow users
+to provide certificates and enable secure IPL directly via the command line.
+
+Providing Certificates
+----------------------
+

docs/system/s390x/secure-ipl.rst line 21

Quoted 10 lines
docs/system/s390x/secure-ipl.rst new file +10 -0
+The certificate store can be populated by supplying a list of X.509 certificate file
+paths or directories containing certificate files on the command-line:
+
+Note: certificate files must have a .pem extension.
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio, \
+                               boot-certs.0.path=/.../qemu/certs, \
+                               boot-certs.1.path=/another/path/cert.pem ...

Using newlines/spaces between parameters does not work, so people cannot copy-n-paste this example to the shell.

So I think you either have to merge it into one line, or use multiple "-machine" statements, e.g.:

Quoted 8 lines
Quoted 3 lines
     qemu-system-s390x -M s390-ccw-virtio \
                       -M boot-certs.0.path=/.../qemu/certs \
                       -M boot-certs.1.path=/another/path/cert.pem ...

The inability to copy+paste is unfortunate, but IMHO the docs are better in the way they are already expressed. Repeating the -M arg in this way is not a natural way we'd expect people to configure QEMU, even if it happens to work in the case of -M/-machine.

Then I'd vote to have it rather in one line instead.

Thomas

#12 lore raw

PATCH v6 2/28 crypto/x509-utils: Refactor with GNUTLS fallback

In reply to Zhuoying Cai

Always compile x509-utils.c and add a fallback when GNUTLS is unavailable.

---
 crypto/meson.build  |  5 +----
 crypto/x509-utils.c | 16 ++++++++++++++++
 2 files changed, 17 insertions(+), 4 deletions(-)
crypto/meson.build +1 -4
index 735635de1f..0614bfa914 100644
@@ -22,12 +22,9 @@ crypto_ss.add(files(
   'tlscredsx509.c',
   'tlssession.c',
   'rsakey.c',
+  'x509-utils.c',
 ))
 
-if gnutls.found()
-  crypto_ss.add(files('x509-utils.c'))
-endif
-
 if nettle.found()
   crypto_ss.add(nettle, files('hash-nettle.c', 'hmac-nettle.c', 'pbkdf-nettle.c'))
   if hogweed.found()
crypto/x509-utils.c +16 -0
index 39bb6d4d8c..6176a88653 100644
@@ -11,6 +11,8 @@
 #include "qemu/osdep.h"
 #include "qapi/error.h"
 #include "crypto/x509-utils.h"
+
+#ifdef CONFIG_GNUTLS
 #include <gnutls/gnutls.h>
 #include <gnutls/crypto.h>
 #include <gnutls/x509.h>
@@ -78,3 +80,17 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
     gnutls_x509_crt_deinit(crt);
     return ret;
 }
+
+#else /* ! CONFIG_GNUTLS */
+
+int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
+                                      QCryptoHashAlgo hash,
+                                      uint8_t *result,
+                                      size_t *resultlen,
+                                      Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to get fingerprint");
+    return -1;
+}
+
+#endif /* ! CONFIG_GNUTLS */
Signature · 1 line
2.50.1
Reviewed-by on v6 2/28
#13 lore raw

Re: [PATCH v6 02/28] crypto/x509-utils: Refactor with GNUTLS fallback

Quoted 58 lines · Zhuoying Cai

Always compile x509-utils.c and add a fallback when GNUTLS is unavailable.

---
  crypto/meson.build  |  5 +----
  crypto/x509-utils.c | 16 ++++++++++++++++
  2 files changed, 17 insertions(+), 4 deletions(-)
crypto/meson.build +1 -4
index 735635de1f..0614bfa914 100644
@@ -22,12 +22,9 @@ crypto_ss.add(files(
    'tlscredsx509.c',
    'tlssession.c',
    'rsakey.c',
+  'x509-utils.c',
  ))
 
-if gnutls.found()
-  crypto_ss.add(files('x509-utils.c'))
-endif
-
  if nettle.found()
    crypto_ss.add(nettle, files('hash-nettle.c', 'hmac-nettle.c', 'pbkdf-nettle.c'))
    if hogweed.found()
crypto/x509-utils.c +16 -0
index 39bb6d4d8c..6176a88653 100644
@@ -11,6 +11,8 @@
  #include "qemu/osdep.h"
  #include "qapi/error.h"
  #include "crypto/x509-utils.h"
+
+#ifdef CONFIG_GNUTLS
  #include <gnutls/gnutls.h>
  #include <gnutls/crypto.h>
  #include <gnutls/x509.h>
@@ -78,3 +80,17 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
      gnutls_x509_crt_deinit(crt);
      return ret;
  }
+
+#else /* ! CONFIG_GNUTLS */
+
+int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
+                                      QCryptoHashAlgo hash,
+                                      uint8_t *result,
+                                      size_t *resultlen,
+                                      Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to get fingerprint");
+    return -1;
+}
+
+#endif /* ! CONFIG_GNUTLS */
#14 lore raw

Re: [PATCH v6 02/28] crypto/x509-utils: Refactor with GNUTLS fallback

In reply to Zhuoying Cai
Quoted 2 lines · Zhuoying Cai

Always compile x509-utils.c and add a fallback when GNUTLS is unavailable.

Maybe add some rationale to the description, like "we are going to need these functions in the s390x code even if GNUTLS is not available" or so?

Thomas

Quoted 55 lines
---
  crypto/meson.build  |  5 +----
  crypto/x509-utils.c | 16 ++++++++++++++++
  2 files changed, 17 insertions(+), 4 deletions(-)
crypto/meson.build +1 -4
index 735635de1f..0614bfa914 100644
@@ -22,12 +22,9 @@ crypto_ss.add(files(
    'tlscredsx509.c',
    'tlssession.c',
    'rsakey.c',
+  'x509-utils.c',
  ))
 
-if gnutls.found()
-  crypto_ss.add(files('x509-utils.c'))
-endif
-
  if nettle.found()
    crypto_ss.add(nettle, files('hash-nettle.c', 'hmac-nettle.c', 'pbkdf-nettle.c'))
    if hogweed.found()
crypto/x509-utils.c +16 -0
index 39bb6d4d8c..6176a88653 100644
@@ -11,6 +11,8 @@
  #include "qemu/osdep.h"
  #include "qapi/error.h"
  #include "crypto/x509-utils.h"
+
+#ifdef CONFIG_GNUTLS
  #include <gnutls/gnutls.h>
  #include <gnutls/crypto.h>
  #include <gnutls/x509.h>
@@ -78,3 +80,17 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
      gnutls_x509_crt_deinit(crt);
      return ret;
  }
+
+#else /* ! CONFIG_GNUTLS */
+
+int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
+                                      QCryptoHashAlgo hash,
+                                      uint8_t *result,
+                                      size_t *resultlen,
+                                      Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to get fingerprint");
+    return -1;
+}
+
+#endif /* ! CONFIG_GNUTLS */
Reviewed-by Acked-by on v6 2/28
#15 lore raw

Re: [PATCH v6 02/28] crypto/x509-utils: Refactor with GNUTLS fallback

In reply to Zhuoying Cai
Quoted 8 lines · Zhuoying Cai

Always compile x509-utils.c and add a fallback when GNUTLS is unavailable.

---
 crypto/meson.build  |  5 +----
 crypto/x509-utils.c | 16 ++++++++++++++++
 2 files changed, 17 insertions(+), 4 deletions(-)

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#16 lore raw

PATCH v6 3/28 crypto/x509-utils: Add helper functions for certificate store

In reply to Zhuoying Cai

Introduce new helper functions for x509 certificate, which will be used by the certificate store:

qcrypto_x509_convert_cert_der() - converts a certificate from PEM to DER format

These functions provide support for certificate format conversion.

---
 crypto/x509-utils.c         | 50 +++++++++++++++++++++++++++++++++++++
 include/crypto/x509-utils.h | 20 +++++++++++++++
 2 files changed, 70 insertions(+)
crypto/x509-utils.c +50 -0
index 6176a88653..5d43b0ec96 100644
@@ -81,6 +81,47 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
     return ret;
 }
 
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result, size_t *resultlen,
+                                  Error **errp)
+{
+    int ret = -1;
+    int rc;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+    gnutls_datum_t datum_der = {.data = NULL, .size = 0};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_export2(crt, GNUTLS_X509_FMT_DER, &datum_der);
+    if (rc != 0) {
+        error_setg(errp, "Failed to convert certificate to DER format: %s",
+                   gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_new0(uint8_t, datum_der.size);
+    *resultlen = datum_der.size;
+    memcpy(*result, datum_der.data, datum_der.size);
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    gnutls_free(datum_der.data);
+    return ret;
+}
+
 #else /* ! CONFIG_GNUTLS */
 
 int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
@@ -93,4 +134,13 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
     return -1;
 }
 
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result,
+                                  size_t *resultlen,
+                                  Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to export X.509 certificate");
+    return -1;
+}
+
 #endif /* ! CONFIG_GNUTLS */
include/crypto/x509-utils.h +20 -0
index 1e99661a71..4239e3e55a 100644
@@ -19,4 +19,24 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
                                       size_t *resultlen,
                                       Error **errp);
 
+/**
+ * qcrypto_x509_convert_cert_der
+ * @cert: pointer to the raw certificate data in PEM format
+ * @size: size of the certificate
+ * @result: output location for the allocated buffer for the certificate in DER format
+            (the function allocates memory which must be freed by the caller)
+ * @resultlen: pointer to the size of the buffer
+               (will be updated with the actual size of the DER-encoded certificate)
+ * @errp: error pointer
+ *
+ * Convert the given @cert from PEM to DER format.
+ *
+ * Returns: 0 on success,
+ *         -1 on error.
+ */
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result,
+                                  size_t *resultlen,
+                                  Error **errp);
+
 #endif
Signature · 1 line
2.50.1
Reviewed-by on v6 3/28
#17 lore raw

Re: [PATCH v6 03/28] crypto/x509-utils: Add helper functions for certificate store

Quoted 108 lines · Zhuoying Cai

Introduce new helper functions for x509 certificate, which will be used by the certificate store:

qcrypto_x509_convert_cert_der() - converts a certificate from PEM to DER format

These functions provide support for certificate format conversion.

---
  crypto/x509-utils.c         | 50 +++++++++++++++++++++++++++++++++++++
  include/crypto/x509-utils.h | 20 +++++++++++++++
  2 files changed, 70 insertions(+)
crypto/x509-utils.c +50 -0
index 6176a88653..5d43b0ec96 100644
@@ -81,6 +81,47 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
      return ret;
  }
 
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result, size_t *resultlen,
+                                  Error **errp)
+{
+    int ret = -1;
+    int rc;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+    gnutls_datum_t datum_der = {.data = NULL, .size = 0};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_export2(crt, GNUTLS_X509_FMT_DER, &datum_der);
+    if (rc != 0) {
+        error_setg(errp, "Failed to convert certificate to DER format: %s",
+                   gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_new0(uint8_t, datum_der.size);
+    *resultlen = datum_der.size;
+    memcpy(*result, datum_der.data, datum_der.size);
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    gnutls_free(datum_der.data);
+    return ret;
+}
+
  #else /* ! CONFIG_GNUTLS */
 
  int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
@@ -93,4 +134,13 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
      return -1;
  }
 
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result,
+                                  size_t *resultlen,
+                                  Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to export X.509 certificate");
+    return -1;
+}
+
  #endif /* ! CONFIG_GNUTLS */
include/crypto/x509-utils.h +20 -0
index 1e99661a71..4239e3e55a 100644
@@ -19,4 +19,24 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
                                        size_t *resultlen,
                                        Error **errp);
 
+/**
+ * qcrypto_x509_convert_cert_der
+ * @cert: pointer to the raw certificate data in PEM format
+ * @size: size of the certificate
+ * @result: output location for the allocated buffer for the certificate in DER format
+            (the function allocates memory which must be freed by the caller)
+ * @resultlen: pointer to the size of the buffer
+               (will be updated with the actual size of the DER-encoded certificate)
+ * @errp: error pointer
+ *
+ * Convert the given @cert from PEM to DER format.
+ *
+ * Returns: 0 on success,
+ *         -1 on error.
+ */
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result,
+                                  size_t *resultlen,
+                                  Error **errp);
+
  #endif
#18 lore raw

Re: [PATCH v6 03/28] crypto/x509-utils: Add helper functions for certificate store

In reply to Zhuoying Cai
Quoted 84 lines · Zhuoying Cai

Introduce new helper functions for x509 certificate, which will be used by the certificate store:

qcrypto_x509_convert_cert_der() - converts a certificate from PEM to DER format

These functions provide support for certificate format conversion.

---
  crypto/x509-utils.c         | 50 +++++++++++++++++++++++++++++++++++++
  include/crypto/x509-utils.h | 20 +++++++++++++++
  2 files changed, 70 insertions(+)
crypto/x509-utils.c +50 -0
index 6176a88653..5d43b0ec96 100644
@@ -81,6 +81,47 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
      return ret;
  }
 
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result, size_t *resultlen,
+                                  Error **errp)
+{
+    int ret = -1;
+    int rc;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+    gnutls_datum_t datum_der = {.data = NULL, .size = 0};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_export2(crt, GNUTLS_X509_FMT_DER, &datum_der);
+    if (rc != 0) {
+        error_setg(errp, "Failed to convert certificate to DER format: %s",
+                   gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_new0(uint8_t, datum_der.size);
+    *resultlen = datum_der.size;
+    memcpy(*result, datum_der.data, datum_der.size);
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    gnutls_free(datum_der.data);
+    return ret;
+}
+
  #else /* ! CONFIG_GNUTLS */
 
  int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
@@ -93,4 +134,13 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
      return -1;
  }
 
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result,
+                                  size_t *resultlen,
+                                  Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to export X.509 certificate");
+    return -1;
+}
+
  #endif /* ! CONFIG_GNUTLS */
include/crypto/x509-utils.h +0 -0
index 1e99661a71..4239e3e55a 100644

include/crypto/x509-utils.h int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size, · line 27

Quoted 9 lines
include/crypto/x509-utils.h +6 -0
@@ -19,4 +19,24 @@ int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
                                        size_t *resultlen,
                                        Error **errp);
 
+/**
+ * qcrypto_x509_convert_cert_der
+ * @cert: pointer to the raw certificate data in PEM format
+ * @size: size of the certificate
+ * @result: output location for the allocated buffer for the certificate in DER format
+            (the function allocates memory which must be freed by the caller)

Please try to fit the comments into the 80 columns boundary.

Thanks,
Thomas

Quoted 15 lines
include/crypto/x509-utils.h +14 -0
+ * @resultlen: pointer to the size of the buffer
+               (will be updated with the actual size of the DER-encoded certificate)
+ * @errp: error pointer
+ *
+ * Convert the given @cert from PEM to DER format.
+ *
+ * Returns: 0 on success,
+ *         -1 on error.
+ */
+int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
+                                  uint8_t **result,
+                                  size_t *resultlen,
+                                  Error **errp);
+
  #endif
Reviewed-by Acked-by on v6 3/28
#19 lore raw

Re: [PATCH v6 03/28] crypto/x509-utils: Add helper functions for certificate store

In reply to Zhuoying Cai
Quoted 5 lines · Zhuoying Cai

Introduce new helper functions for x509 certificate, which will be used by the certificate store:

qcrypto_x509_convert_cert_der() - converts a certificate from PEM to DER format

Quoted 7 lines

These functions provide support for certificate format conversion.

---
 crypto/x509-utils.c         | 50 +++++++++++++++++++++++++++++++++++++
 include/crypto/x509-utils.h | 20 +++++++++++++++
 2 files changed, 70 insertions(+)

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#20 lore raw

PATCH v6 4/28 hw/s390x/ipl: Create certificate store

In reply to Zhuoying Cai

Create a certificate store for boot certificates used for secure IPL.

Load certificates from the boot-certs parameter of s390-ccw-virtio machine type option into the cert store.

Currently, only X.509 certificates in PEM format are supported, as the QEMU command line accepts certificates in PEM format only.

---
 docs/specs/s390x-secure-ipl.rst |  15 +++
 hw/s390x/cert-store.c           | 213 ++++++++++++++++++++++++++++++++
 hw/s390x/cert-store.h           |  39 ++++++
 hw/s390x/ipl.c                  |  19 +++
 hw/s390x/ipl.h                  |   3 +
 hw/s390x/meson.build            |   1 +
 include/hw/s390x/ipl/qipl.h     |   2 +
 7 files changed, 292 insertions(+)
 create mode 100644 docs/specs/s390x-secure-ipl.rst
 create mode 100644 hw/s390x/cert-store.c
 create mode 100644 hw/s390x/cert-store.h
docs/specs/s390x-secure-ipl.rst new file +15 -0
new file mode 100644
index 0000000000..9b1de5c604
@@ -0,0 +1,15 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+s390 Certificate Store and Functions
+====================================
+
+s390 Certificate Store
+----------------------
+
+A certificate store is implemented for s390-ccw guests to retain within
+memory all certificates provided by the user via the command-line, which
+are expected to be stored somewhere on the host's file system. The store
+will keep track of the number of certificates, their respective size,
+and a summation of the sizes.
+
+Note: A maximum of 64 certificates are allowed to be stored in the certificate store.
hw/s390x/cert-store.c new file +213 -0

213 lines not on this page · raw message

hw/s390x/cert-store.h new file +39 -0
new file mode 100644
index 0000000000..3f76a00277
@@ -0,0 +1,39 @@
+/*
+ * S390 certificate store
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Zhuoying Cai <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef HW_S390_CERT_STORE_H
+#define HW_S390_CERT_STORE_H
+
+#include "hw/s390x/ipl/qipl.h"
+#include "crypto/x509-utils.h"
+
+#define VC_NAME_LEN_BYTES  64
+
+#define CERT_KEY_ID_LEN    QCRYPTO_HASH_DIGEST_LEN_SHA256
+#define CERT_HASH_LEN      QCRYPTO_HASH_DIGEST_LEN_SHA256
+
+struct S390IPLCertificate {
+    uint8_t vc_name[VC_NAME_LEN_BYTES];
+    size_t  size;
+    size_t  der_size;
+    uint8_t *raw;
+};
+typedef struct S390IPLCertificate S390IPLCertificate;
+
+struct S390IPLCertificateStore {
+    uint16_t count;
+    size_t   max_cert_size;
+    size_t   total_bytes;
+    S390IPLCertificate certs[MAX_CERTIFICATES];
+} QEMU_PACKED;
+typedef struct S390IPLCertificateStore S390IPLCertificateStore;
+
+void s390_ipl_create_cert_store(S390IPLCertificateStore *cert_store);
+
+#endif
hw/s390x/ipl.c +19 -0
index 2f082396c7..917166ba31 100644
@@ -35,6 +35,7 @@
 #include "qemu/option.h"
 #include "qemu/ctype.h"
 #include "standard-headers/linux/virtio_ids.h"
+#include "cert-store.h"
 
 #define KERN_IMAGE_START                0x010000UL
 #define LINUX_MAGIC_ADDR                0x010008UL
@@ -422,6 +423,20 @@ void s390_ipl_convert_loadparm(char *ascii_lp, uint8_t *ebcdic_lp)
     }
 }
 
+S390IPLCertificateStore *s390_ipl_get_certificate_store(void)
+{
+    S390IPLState *ipl = get_ipl_device();
+
+    return &ipl->cert_store;
+}
+
+static bool s390_has_certificate(void)
+{
+    S390IPLState *ipl = get_ipl_device();
+
+    return ipl->cert_store.count > 0;
+}
+
 static bool s390_build_iplb(DeviceState *dev_st, IplParameterBlock *iplb)
 {
     CcwDevice *ccw_dev = NULL;
@@ -717,6 +732,10 @@ void s390_ipl_prepare_cpu(S390CPU *cpu)
 
     if (!ipl->kernel || ipl->iplb_valid) {
         cpu->env.psw.addr = ipl->bios_start_addr;
+        /* initialize cert store if it's empty */
+        if (!s390_has_certificate()) {
+            s390_ipl_create_cert_store(&ipl->cert_store);
+        }
         if (!ipl->iplb_valid) {
             ipl->iplb_valid = s390_init_all_iplbs(ipl);
         } else {
hw/s390x/ipl.h +3 -0
index 8f83c7da29..bee72dfbb3 100644
@@ -13,6 +13,7 @@
 #ifndef HW_S390_IPL_H
 #define HW_S390_IPL_H
 
+#include "cert-store.h"
 #include "cpu.h"
 #include "exec/target_page.h"
 #include "system/address-spaces.h"
@@ -35,6 +36,7 @@ int s390_ipl_pv_unpack(struct S390PVResponse *pv_resp);
 void s390_ipl_prepare_cpu(S390CPU *cpu);
 IplParameterBlock *s390_ipl_get_iplb(void);
 IplParameterBlock *s390_ipl_get_iplb_pv(void);
+S390IPLCertificateStore *s390_ipl_get_certificate_store(void);
 
 enum s390_reset {
     /* default is a reset not triggered by a CPU e.g. issued by QMP */
@@ -64,6 +66,7 @@ struct S390IPLState {
     IplParameterBlock iplb;
     IplParameterBlock iplb_pv;
     QemuIplParameters qipl;
+    S390IPLCertificateStore cert_store;
     uint64_t start_addr;
     uint64_t compat_start_addr;
     uint64_t bios_start_addr;
hw/s390x/meson.build +1 -0
index 8866012ddc..80d3d4a74d 100644
@@ -17,6 +17,7 @@ s390x_ss.add(files(
   'sclpcpu.c',
   'sclpquiesce.c',
   'tod.c',
+  'cert-store.c',
 ))
 s390x_ss.add(when: 'CONFIG_KVM', if_true: files(
   'tod-kvm.c',
include/hw/s390x/ipl/qipl.h +2 -0
index 6824391111..e505f44020 100644
@@ -20,6 +20,8 @@
 #define LOADPARM_LEN    8
 #define NO_LOADPARM "\0\0\0\0\0\0\0\0"
 
+#define MAX_CERTIFICATES  64
+
 /*
  * The QEMU IPL Parameters will be stored at absolute address
  * 204 (0xcc) which means it is 32-bit word aligned but not
Signature · 1 line
2.50.1
#21 lore raw

Re: [PATCH v6 04/28] hw/s390x/ipl: Create certificate store

<..snip..>

Quoted 30 lines
hw/s390x/cert-store.h new file +24 -0
new file mode 100644
index 0000000000..3f76a00277
@@ -0,0 +1,39 @@
+/*
+ * S390 certificate store
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Zhuoying Cai <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef HW_S390_CERT_STORE_H
+#define HW_S390_CERT_STORE_H
+
+#include "hw/s390x/ipl/qipl.h"
+#include "crypto/x509-utils.h"
+
+#define VC_NAME_LEN_BYTES  64
+
+#define CERT_KEY_ID_LEN    QCRYPTO_HASH_DIGEST_LEN_SHA256
+#define CERT_HASH_LEN      QCRYPTO_HASH_DIGEST_LEN_SHA256
+
+struct S390IPLCertificate {
+    uint8_t vc_name[VC_NAME_LEN_BYTES];
+    size_t  size;
+    size_t  der_size;

hw/s390x/cert-store.h line 34

Quoted 10 lines
hw/s390x/cert-store.h new file +10 -0
+    uint8_t *raw;
+};
+typedef struct S390IPLCertificate S390IPLCertificate;
+
+struct S390IPLCertificateStore {
+    uint16_t count;
+    size_t   max_cert_size;
+    size_t   total_bytes;
+    S390IPLCertificate certs[MAX_CERTIFICATES];
+} QEMU_PACKED;

I think the guidance is to avoid using QEMU_PACKED (see Thomas's reply to me https://lore.kernel.org/qemu-devel/[email protected]/). Also this is an internal QEMU structure and not an architecture specific one, so this shouldn't be packed, no?

The rest of the patch LGTM.

<...snip...>

#22 lore raw

Re: [PATCH v6 04/28] hw/s390x/ipl: Create certificate store

In reply to Zhuoying Cai
Quoted 33 lines · Zhuoying Cai

Create a certificate store for boot certificates used for secure IPL.

Load certificates from the boot-certs parameter of s390-ccw-virtio machine type option into the cert store.

Currently, only X.509 certificates in PEM format are supported, as the QEMU command line accepts certificates in PEM format only.

---
  docs/specs/s390x-secure-ipl.rst |  15 +++
  hw/s390x/cert-store.c           | 213 ++++++++++++++++++++++++++++++++
  hw/s390x/cert-store.h           |  39 ++++++
  hw/s390x/ipl.c                  |  19 +++
  hw/s390x/ipl.h                  |   3 +
  hw/s390x/meson.build            |   1 +
  include/hw/s390x/ipl/qipl.h     |   2 +
  7 files changed, 292 insertions(+)

create mode 100644 docs/specs/s390x-secure-ipl.rst create mode 100644 hw/s390x/cert-store.c create mode 100644 hw/s390x/cert-store.h

docs/specs/s390x-secure-ipl.rst new file +5 -0
new file mode 100644
index 0000000000..9b1de5c604
@@ -0,0 +1,15 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+s390 Certificate Store and Functions
+====================================
+

docs/specs/s390x-secure-ipl.rst line 15

Quoted 10 lines
docs/specs/s390x-secure-ipl.rst new file +10 -0
+s390 Certificate Store
+----------------------
+
+A certificate store is implemented for s390-ccw guests to retain within
+memory all certificates provided by the user via the command-line, which
+are expected to be stored somewhere on the host's file system. The store
+will keep track of the number of certificates, their respective size,
+and a summation of the sizes.
+
+Note: A maximum of 64 certificates are allowed to be stored in the certificate store.

fit into 80 columns, please.

Quoted 32 lines
hw/s390x/cert-store.c new file +26 -0
new file mode 100644
index 0000000000..318acfb1f6
@@ -0,0 +1,213 @@
+/*
+ * S390 certificate store implementation
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Zhuoying Cai <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#include "qemu/osdep.h"
+#include "cert-store.h"
+#include "qapi/error.h"
+#include "qemu/error-report.h"
+#include "qemu/option.h"
+#include "qemu/config-file.h"
+#include "hw/s390x/ebcdic.h"
+#include "hw/s390x/s390-virtio-ccw.h"
+#include "qemu/cutils.h"
+#include "crypto/x509-utils.h"
+#include "qapi/qapi-types-machine-s390x.h"
+
+static BootCertificateList *s390_get_boot_certs(void)
+{
+    return S390_CCW_MACHINE(qdev_get_machine())->boot_certs;
+}
+

hw/s390x/cert-store.c line 36

Quoted 10 lines
hw/s390x/cert-store.c new file +10 -0
+static size_t cert2buf(char *path, char **cert_buf)
+{
+    size_t size;
+
+    if (!g_file_get_contents(path, cert_buf, &size, NULL)) {
+        return 0;
+    }
+
+    return size;
+}

What's the advantage of these wrapper functions? You seem to only use them in one spot, so I'd rather inline the code where it's used ==> less lines of code in total, and easier to read.

Quoted 37 lines
hw/s390x/cert-store.c new file +37 -0
+static void update_cert_store(S390IPLCertificateStore *cert_store,
+                              S390IPLCertificate *cert)
+{
+    size_t data_buf_size;
+    size_t keyid_buf_size;
+    size_t hash_buf_size;
+    size_t cert_buf_size;
+
+    /* length field is word aligned for later DIAG use */
+    keyid_buf_size = ROUND_UP(CERT_KEY_ID_LEN, 4);
+    hash_buf_size = ROUND_UP(CERT_HASH_LEN, 4);
+    cert_buf_size = ROUND_UP(cert->der_size, 4);
+    data_buf_size = keyid_buf_size + hash_buf_size + cert_buf_size;
+
+    if (cert_store->max_cert_size < data_buf_size) {
+        cert_store->max_cert_size = data_buf_size;
+    }
+
+    cert_store->certs[cert_store->count] = *cert;
+    cert_store->total_bytes += data_buf_size;
+    cert_store->count++;
+}
+
+static GPtrArray *get_cert_paths(void)
+{
+    BootCertificateList *path_list = NULL;
+    BootCertificateList *list = NULL;
+    gchar *cert_path;
+    GDir *dir = NULL;
+    const gchar *filename;
+    g_autoptr(GError) err = NULL;
+    g_autoptr(GPtrArray) cert_path_builder = g_ptr_array_new_full(0, g_free);
+
+    path_list = s390_get_boot_certs();
+    if (path_list == NULL) {
+        return g_steal_pointer(&cert_path_builder);
+    }

hw/s390x/cert-store.c line 139

Quoted 10 lines
hw/s390x/cert-store.c new file +10 -0
+
+    for (list = path_list; list; list = list->next) {
+        cert_path = list->value->path;
+
+        if (g_strcmp0(cert_path, "") == 0) {
+            error_report("Empty path in certificate path list is not allowed");
+            goto fail;
+        }
+
+        struct stat st;

QEMU coding style (see docs/devel/style.rst):

"Mixed declarations (interleaving statements and declarations within blocks) are generally not allowed; declarations should be at the beginning of blocks."

Quoted 31 lines
hw/s390x/cert-store.c new file +31 -0
+        if (stat(cert_path, &st) != 0) {
+            error_report("Failed to stat path '%s': %s", cert_path, g_strerror(errno));
+            goto fail;
+        }
+
+        if (S_ISREG(st.st_mode)) {
+            if (!g_str_has_suffix(cert_path, ".pem")) {
+                error_report("Certificate file '%s' must have a .pem extension",
+                             cert_path);
+                goto fail;
+            }
+
+            g_ptr_array_add(cert_path_builder, g_strdup(cert_path));
+        } else if (S_ISDIR(st.st_mode)) {
+            dir = g_dir_open(cert_path, 0, &err);
+            if (dir == NULL) {
+                error_report("Failed to open directory '%s': %s",
+                             cert_path, err->message);
+                goto fail;
+            }
+
+            while ((filename = g_dir_read_name(dir))) {
+                if (g_str_has_suffix(filename, ".pem")) {
+                    g_ptr_array_add(cert_path_builder,
+                                    g_build_filename(cert_path, filename, NULL));
+                }
+            }
+
+            g_dir_close(dir);
+        } else {
+            error_report("Path '%s' is neither a file nor a directory", cert_path);

hw/s390x/cert-store.c line 180

Quoted 10 lines
hw/s390x/cert-store.c new file +10 -0
+            goto fail;
+        }
+    }
+
+    qapi_free_BootCertificateList(path_list);
+    return g_steal_pointer(&cert_path_builder);
+
+fail:
+    qapi_free_BootCertificateList(path_list);
+    exit(1);

Doing "goto fail"s and then a clean-up and exit(1) at the end of the function looks weird. I think I'd rather either use "exit(1)" instead of "goto fail" thorough the function, or use a return NULL here and do the exit(1) in the caller instead (and maybe pass an "Error **errp" to the function here, replace all error_report with error_setg and do the error_report in the caller instead). Otherwise this looks just unbalanced.

Quoted 6 lines
hw/s390x/cert-store.c new file +6 -0
+}
+
+void s390_ipl_create_cert_store(S390IPLCertificateStore *cert_store)
+{
+    GPtrArray *cert_path_builder;
+

hw/s390x/cert-store.c line 196

Quoted 10 lines
hw/s390x/cert-store.c new file +10 -0
+    cert_path_builder = get_cert_paths();
+    if (cert_path_builder->len == 0) {
+        g_ptr_array_free(cert_path_builder, TRUE);
+        return;
+    }
+
+    if (cert_path_builder->len > MAX_CERTIFICATES - 1) {
+        error_report("Cert store exceeds maximum of %d certificates", MAX_CERTIFICATES);
+        g_ptr_array_free(cert_path_builder, TRUE);
+        exit(1);

So there's a exit(1) here already ... that's another indication that it would be nicer to have the exit(1) from get_cert_paths() in this function here, too.

hw/s390x/cert-store.c line 203

Quoted 7 lines
hw/s390x/cert-store.c new file +7 -0
+    }
+
+    cert_store->max_cert_size = 0;
+    cert_store->total_bytes = 0;
+
+    for (int i = 0; i < cert_path_builder->len; i++) {
+        S390IPLCertificate *cert = init_cert((char *) cert_path_builder->pdata[i]);

I'd suggest to do the same with init_cert(), i.e. add an "Error **errp" to it's parameter list and do the error_report() here.

hw/s390x/cert-store.c line 213

Quoted 10 lines
hw/s390x/cert-store.c new file +10 -0
+        if (!cert) {
+            g_ptr_array_free(cert_path_builder, TRUE);
+            exit(1);
+        }
+
+        update_cert_store(cert_store, cert);
+    }
+
+    g_ptr_array_free(cert_path_builder, TRUE);
+}

Thomas

#23 lore raw

PATCH v6 5/28 s390x/diag: Introduce DIAG 320 for Certificate Store Facility

In reply to Zhuoying Cai

DIAGNOSE 320 is introduced to support Certificate Store (CS) Facility, which includes operations such as query certificate storage information and provide certificates in the certificate store.

Currently, only subcode 0 is supported with this patch, which is used to query the Installed Subcodes Mask (ISM).

This subcode is only supported when the CS facility is enabled.

Availability of CS facility is determined by byte 134 bit 5 of the SCLP Read Info block. Byte 134's facilities cannot be represented without the availability of the extended-length-SCCB, so add it as a check for consistency.

Note: secure IPL is not available for Secure Execution (SE) guests, as their images are already integrity protected, and an additional protection of the kernel by secure IPL is not necessary.

This feature is available starting with the gen16 CPU model.

---
 docs/specs/s390x-secure-ipl.rst     | 12 ++++++++
 include/hw/s390x/ipl/diag320.h      | 20 +++++++++++++
 target/s390x/cpu_features.c         |  1 +
 target/s390x/cpu_features_def.h.inc |  1 +
 target/s390x/cpu_models.c           |  2 ++
 target/s390x/diag.c                 | 44 +++++++++++++++++++++++++++++
 target/s390x/gen-features.c         |  3 ++
 target/s390x/kvm/kvm.c              | 16 +++++++++++
 target/s390x/s390x-internal.h       |  2 ++
 target/s390x/tcg/misc_helper.c      |  7 +++++
 10 files changed, 108 insertions(+)
 create mode 100644 include/hw/s390x/ipl/diag320.h
docs/specs/s390x-secure-ipl.rst +12 -0
index 9b1de5c604..30ddc81c2b 100644
@@ -13,3 +13,15 @@ will keep track of the number of certificates, their respective size,
 and a summation of the sizes.
 
 Note: A maximum of 64 certificates are allowed to be stored in the certificate store.
+
+DIAGNOSE function code 'X'320' - Certificate Store Facility
+-----------------------------------------------------------
+
+DIAGNOSE 'X'320' is used to provide support for userspace to directly
+query the s390 certificate store. Userspace may be the s390-ccw BIOS or
+the guest kernel.
+
+Subcode 0 - query installed subcodes
+    Returns a 256-bit installed subcodes mask (ISM) stored in the installed
+    subcodes block (ISB). This mask indicates which sucodes are currently
+    installed and available for use.
include/hw/s390x/ipl/diag320.h new file +20 -0
new file mode 100644
index 0000000000..aa04b699c6
@@ -0,0 +1,20 @@
+/*
+ * S/390 DIAGNOSE 320 definitions and structures
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Zhuoying Cai <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef S390X_DIAG320_H
+#define S390X_DIAG320_H
+
+#define DIAG_320_SUBC_QUERY_ISM     0
+
+#define DIAG_320_RC_OK              0x0001
+#define DIAG_320_RC_NOT_SUPPORTED   0x0102
+
+#define DIAG_320_ISM_QUERY_SUBCODES 0x80000000
+
+#endif
target/s390x/cpu_features.c +1 -0
index 4b5be6798e..436471f4b4 100644
@@ -147,6 +147,7 @@ void s390_fill_feat_block(const S390FeatBitmap features, S390FeatType type,
         break;
     case S390_FEAT_TYPE_SCLP_FAC134:
         clear_be_bit(s390_feat_def(S390_FEAT_DIAG_318)->bit, data);
+        clear_be_bit(s390_feat_def(S390_FEAT_CERT_STORE)->bit, data);
         break;
     default:
         return;
target/s390x/cpu_features_def.h.inc +1 -0
index c017bffcdc..941a69e013 100644
@@ -138,6 +138,7 @@ DEF_FEAT(SIE_IBS, "ibs", SCLP_CONF_CHAR_EXT, 10, "SIE: Interlock-and-broadcast-s
 
 /* Features exposed via SCLP SCCB Facilities byte 134 (bit numbers relative to byte-134) */
 DEF_FEAT(DIAG_318, "diag318", SCLP_FAC134, 0, "Control program name and version codes")
+DEF_FEAT(CERT_STORE, "cstore", SCLP_FAC134, 5, "Provide Certificate Store functions")
 
 /* Features exposed via SCLP CPU info. */
 DEF_FEAT(SIE_F2, "sief2", SCLP_CPU, 4, "SIE: interception format 2 (Virtual SIE)")
target/s390x/cpu_models.c +2 -0
index 954a7a99a9..6b8471700e 100644
@@ -248,6 +248,7 @@ bool s390_has_feat(S390Feat feat)
     if (s390_is_pv()) {
         switch (feat) {
         case S390_FEAT_DIAG_318:
+        case S390_FEAT_CERT_STORE:
         case S390_FEAT_HPMA2:
         case S390_FEAT_SIE_F2:
         case S390_FEAT_SIE_SKEY:
@@ -505,6 +506,7 @@ static void check_consistency(const S390CPUModel *model)
         { S390_FEAT_PTFF_STOUE, S390_FEAT_MULTIPLE_EPOCH },
         { S390_FEAT_AP_QUEUE_INTERRUPT_CONTROL, S390_FEAT_AP },
         { S390_FEAT_DIAG_318, S390_FEAT_EXTENDED_LENGTH_SCCB },
+        { S390_FEAT_CERT_STORE, S390_FEAT_EXTENDED_LENGTH_SCCB },
         { S390_FEAT_NNPA, S390_FEAT_VECTOR },
         { S390_FEAT_RDP, S390_FEAT_LOCAL_TLB_CLEARING },
         { S390_FEAT_UV_FEAT_AP, S390_FEAT_AP },
target/s390x/diag.c +44 -0

53 lines not on this page · raw message

target/s390x/gen-features.c +3 -0
index 8218e6470e..6c20c3a862 100644
@@ -720,6 +720,7 @@ static uint16_t full_GEN16_GA1[] = {
     S390_FEAT_PAIE,
     S390_FEAT_UV_FEAT_AP,
     S390_FEAT_UV_FEAT_AP_INTR,
+    S390_FEAT_CERT_STORE,
 };
 
 static uint16_t full_GEN17_GA1[] = {
@@ -919,6 +920,8 @@ static uint16_t qemu_MAX[] = {
     S390_FEAT_KIMD_SHA_512,
     S390_FEAT_KLMD_SHA_512,
     S390_FEAT_PRNO_TRNG,
+    S390_FEAT_EXTENDED_LENGTH_SCCB,
+    S390_FEAT_CERT_STORE,
 };
 
 /****** END FEATURE DEFS ******/
target/s390x/kvm/kvm.c +16 -0
index 8ee33924df..5510fc2fc5 100644
@@ -98,6 +98,7 @@
 #define DIAG_TIMEREVENT                 0x288
 #define DIAG_IPL                        0x308
 #define DIAG_SET_CONTROL_PROGRAM_CODES  0x318
+#define DIAG_CERT_STORE                 0x320
 #define DIAG_KVM_HYPERCALL              0x500
 #define DIAG_KVM_BREAKPOINT             0x501
 
@@ -1560,6 +1561,16 @@ static void handle_diag_318(S390CPU *cpu, struct kvm_run *run)
     }
 }
 
+static void kvm_handle_diag_320(S390CPU *cpu, struct kvm_run *run)
+{
+    uint64_t r1, r3;
+
+    r1 = (run->s390_sieic.ipa & 0x00f0) >> 4;
+    r3 = run->s390_sieic.ipa & 0x000f;
+
+    handle_diag_320(&cpu->env, r1, r3, RA_IGNORED);
+}
+
 #define DIAG_KVM_CODE_MASK 0x000000000000ffff
 
 static int handle_diag(S390CPU *cpu, struct kvm_run *run, uint32_t ipb)
@@ -1590,6 +1601,9 @@ static int handle_diag(S390CPU *cpu, struct kvm_run *run, uint32_t ipb)
     case DIAG_KVM_BREAKPOINT:
         r = handle_sw_breakpoint(cpu, run);
         break;
+    case DIAG_CERT_STORE:
+        kvm_handle_diag_320(cpu, run);
+        break;
     default:
         trace_kvm_insn_diag(func_code);
         kvm_s390_program_interrupt(cpu, PGM_SPECIFICATION);
@@ -2490,6 +2504,8 @@ bool kvm_s390_get_host_cpu_model(S390CPUModel *model, Error **errp)
         set_bit(S390_FEAT_DIAG_318, model->features);
     }
 
+    set_bit(S390_FEAT_CERT_STORE, model->features);
+
     /* Test for Ultravisor features that influence secure guest behavior */
     query_uv_feat_guest(model->features);
 
target/s390x/s390x-internal.h +2 -0
index 56cce2e7f5..ecff2d07a1 100644
@@ -391,6 +391,8 @@ int mmu_translate_real(CPUS390XState *env, target_ulong raddr, int rw,
 int handle_diag_288(CPUS390XState *env, uint64_t r1, uint64_t r3);
 void handle_diag_308(CPUS390XState *env, uint64_t r1, uint64_t r3,
                      uintptr_t ra);
+void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3,
+                     uintptr_t ra);
 
 
 /* translate.c */
target/s390x/tcg/misc_helper.c +7 -0
index f7101be574..412c34ed93 100644
@@ -142,6 +142,13 @@ void HELPER(diag)(CPUS390XState *env, uint32_t r1, uint32_t r3, uint32_t num)
         /* time bomb (watchdog) */
         r = handle_diag_288(env, r1, r3);
         break;
+    case 0x320:
+        /* cert store */
+        bql_lock();
+        handle_diag_320(env, r1, r3, GETPC());
+        bql_unlock();
+        r = 0;
+        break;
     default:
         r = -1;
         break;
Signature · 1 line
2.50.1
Reviewed-by on v6 5/28
#24 lore raw

Re: [PATCH v6 05/28] s390x/diag: Introduce DIAG 320 for Certificate Store Facility

Quoted 286 lines · Zhuoying Cai

DIAGNOSE 320 is introduced to support Certificate Store (CS) Facility, which includes operations such as query certificate storage information and provide certificates in the certificate store.

Currently, only subcode 0 is supported with this patch, which is used to query the Installed Subcodes Mask (ISM).

This subcode is only supported when the CS facility is enabled.

Availability of CS facility is determined by byte 134 bit 5 of the SCLP Read Info block. Byte 134's facilities cannot be represented without the availability of the extended-length-SCCB, so add it as a check for consistency.

Note: secure IPL is not available for Secure Execution (SE) guests, as their images are already integrity protected, and an additional protection of the kernel by secure IPL is not necessary.

This feature is available starting with the gen16 CPU model.

---
  docs/specs/s390x-secure-ipl.rst     | 12 ++++++++
  include/hw/s390x/ipl/diag320.h      | 20 +++++++++++++
  target/s390x/cpu_features.c         |  1 +
  target/s390x/cpu_features_def.h.inc |  1 +
  target/s390x/cpu_models.c           |  2 ++
  target/s390x/diag.c                 | 44 +++++++++++++++++++++++++++++
  target/s390x/gen-features.c         |  3 ++
  target/s390x/kvm/kvm.c              | 16 +++++++++++
  target/s390x/s390x-internal.h       |  2 ++
  target/s390x/tcg/misc_helper.c      |  7 +++++
  10 files changed, 108 insertions(+)

create mode 100644 include/hw/s390x/ipl/diag320.h

docs/specs/s390x-secure-ipl.rst +12 -0
index 9b1de5c604..30ddc81c2b 100644
@@ -13,3 +13,15 @@ will keep track of the number of certificates, their respective size,
  and a summation of the sizes.
 
  Note: A maximum of 64 certificates are allowed to be stored in the certificate store.
+
+DIAGNOSE function code 'X'320' - Certificate Store Facility
+-----------------------------------------------------------
+
+DIAGNOSE 'X'320' is used to provide support for userspace to directly
+query the s390 certificate store. Userspace may be the s390-ccw BIOS or
+the guest kernel.
+
+Subcode 0 - query installed subcodes
+    Returns a 256-bit installed subcodes mask (ISM) stored in the installed
+    subcodes block (ISB). This mask indicates which sucodes are currently
+    installed and available for use.
include/hw/s390x/ipl/diag320.h new file +20 -0
new file mode 100644
index 0000000000..aa04b699c6
@@ -0,0 +1,20 @@
+/*
+ * S/390 DIAGNOSE 320 definitions and structures
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Zhuoying Cai <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef S390X_DIAG320_H
+#define S390X_DIAG320_H
+
+#define DIAG_320_SUBC_QUERY_ISM     0
+
+#define DIAG_320_RC_OK              0x0001
+#define DIAG_320_RC_NOT_SUPPORTED   0x0102
+
+#define DIAG_320_ISM_QUERY_SUBCODES 0x80000000
+
+#endif
target/s390x/cpu_features.c +1 -0
index 4b5be6798e..436471f4b4 100644
@@ -147,6 +147,7 @@ void s390_fill_feat_block(const S390FeatBitmap features, S390FeatType type,
          break;
      case S390_FEAT_TYPE_SCLP_FAC134:
          clear_be_bit(s390_feat_def(S390_FEAT_DIAG_318)->bit, data);
+        clear_be_bit(s390_feat_def(S390_FEAT_CERT_STORE)->bit, data);
          break;
      default:
          return;
target/s390x/cpu_features_def.h.inc +1 -0
index c017bffcdc..941a69e013 100644
@@ -138,6 +138,7 @@ DEF_FEAT(SIE_IBS, "ibs", SCLP_CONF_CHAR_EXT, 10, "SIE: Interlock-and-broadcast-s
 
  /* Features exposed via SCLP SCCB Facilities byte 134 (bit numbers relative to byte-134) */
  DEF_FEAT(DIAG_318, "diag318", SCLP_FAC134, 0, "Control program name and version codes")
+DEF_FEAT(CERT_STORE, "cstore", SCLP_FAC134, 5, "Provide Certificate Store functions")
 
  /* Features exposed via SCLP CPU info. */
  DEF_FEAT(SIE_F2, "sief2", SCLP_CPU, 4, "SIE: interception format 2 (Virtual SIE)")
target/s390x/cpu_models.c +2 -0
index 954a7a99a9..6b8471700e 100644
@@ -248,6 +248,7 @@ bool s390_has_feat(S390Feat feat)
      if (s390_is_pv()) {
          switch (feat) {
          case S390_FEAT_DIAG_318:
+        case S390_FEAT_CERT_STORE:
          case S390_FEAT_HPMA2:
          case S390_FEAT_SIE_F2:
          case S390_FEAT_SIE_SKEY:
@@ -505,6 +506,7 @@ static void check_consistency(const S390CPUModel *model)
          { S390_FEAT_PTFF_STOUE, S390_FEAT_MULTIPLE_EPOCH },
          { S390_FEAT_AP_QUEUE_INTERRUPT_CONTROL, S390_FEAT_AP },
          { S390_FEAT_DIAG_318, S390_FEAT_EXTENDED_LENGTH_SCCB },
+        { S390_FEAT_CERT_STORE, S390_FEAT_EXTENDED_LENGTH_SCCB },
          { S390_FEAT_NNPA, S390_FEAT_VECTOR },
          { S390_FEAT_RDP, S390_FEAT_LOCAL_TLB_CLEARING },
          { S390_FEAT_UV_FEAT_AP, S390_FEAT_AP },
target/s390x/diag.c +44 -0
index cff9fbc4b0..a35d808fd7 100644
@@ -18,6 +18,7 @@
  #include "hw/watchdog/wdt_diag288.h"
  #include "system/cpus.h"
  #include "hw/s390x/ipl.h"
+#include "hw/s390x/ipl/diag320.h"
  #include "hw/s390x/s390-virtio-ccw.h"
  #include "system/kvm.h"
  #include "kvm/kvm_s390x.h"
@@ -191,3 +192,46 @@ out:
          break;
      }
  }
+
+void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
+{
+    S390CPU *cpu = env_archcpu(env);
+    uint64_t subcode = env->regs[r3];
+    uint64_t addr = env->regs[r1];
+
+    if (env->psw.mask & PSW_MASK_PSTATE) {
+        s390_program_interrupt(env, PGM_PRIVILEGED, ra);
+        return;
+    }
+
+    if (!s390_has_feat(S390_FEAT_CERT_STORE)) {
+        s390_program_interrupt(env, PGM_SPECIFICATION, ra);
+        return;
+    }
+
+    if ((subcode & ~0x000ffULL) || (r1 & 1)) {
+        s390_program_interrupt(env, PGM_SPECIFICATION, ra);
+        return;
+    }
+
+    switch (subcode) {
+    case DIAG_320_SUBC_QUERY_ISM:
+        /*
+         * The Installed Subcode Block (ISB) can be up 8 words in size,
+         * but the current set of subcodes can fit within a single word
+         * for now.
+         */
+        uint32_t ism_word0 = cpu_to_be32(DIAG_320_ISM_QUERY_SUBCODES);
+
+        if (s390_cpu_virt_mem_write(cpu, addr, r1, &ism_word0, sizeof(ism_word0))) {
+            s390_cpu_virt_mem_handle_exc(cpu, ra);
+            return;
+        }
+
+        env->regs[r1 + 1] = DIAG_320_RC_OK;
+        break;
+    default:
+        env->regs[r1 + 1] = DIAG_320_RC_NOT_SUPPORTED;
+        break;
+    }
+}
target/s390x/gen-features.c +3 -0
index 8218e6470e..6c20c3a862 100644
@@ -720,6 +720,7 @@ static uint16_t full_GEN16_GA1[] = {
      S390_FEAT_PAIE,
      S390_FEAT_UV_FEAT_AP,
      S390_FEAT_UV_FEAT_AP_INTR,
+    S390_FEAT_CERT_STORE,
  };
 
  static uint16_t full_GEN17_GA1[] = {
@@ -919,6 +920,8 @@ static uint16_t qemu_MAX[] = {
      S390_FEAT_KIMD_SHA_512,
      S390_FEAT_KLMD_SHA_512,
      S390_FEAT_PRNO_TRNG,
+    S390_FEAT_EXTENDED_LENGTH_SCCB,
+    S390_FEAT_CERT_STORE,
  };
 
  /****** END FEATURE DEFS ******/
target/s390x/kvm/kvm.c +16 -0
index 8ee33924df..5510fc2fc5 100644
@@ -98,6 +98,7 @@
  #define DIAG_TIMEREVENT                 0x288
  #define DIAG_IPL                        0x308
  #define DIAG_SET_CONTROL_PROGRAM_CODES  0x318
+#define DIAG_CERT_STORE                 0x320
  #define DIAG_KVM_HYPERCALL              0x500
  #define DIAG_KVM_BREAKPOINT             0x501
 
@@ -1560,6 +1561,16 @@ static void handle_diag_318(S390CPU *cpu, struct kvm_run *run)
      }
  }
 
+static void kvm_handle_diag_320(S390CPU *cpu, struct kvm_run *run)
+{
+    uint64_t r1, r3;
+
+    r1 = (run->s390_sieic.ipa & 0x00f0) >> 4;
+    r3 = run->s390_sieic.ipa & 0x000f;
+
+    handle_diag_320(&cpu->env, r1, r3, RA_IGNORED);
+}
+
  #define DIAG_KVM_CODE_MASK 0x000000000000ffff
 
  static int handle_diag(S390CPU *cpu, struct kvm_run *run, uint32_t ipb)
@@ -1590,6 +1601,9 @@ static int handle_diag(S390CPU *cpu, struct kvm_run *run, uint32_t ipb)
      case DIAG_KVM_BREAKPOINT:
          r = handle_sw_breakpoint(cpu, run);
          break;
+    case DIAG_CERT_STORE:
+        kvm_handle_diag_320(cpu, run);
+        break;
      default:
          trace_kvm_insn_diag(func_code);
          kvm_s390_program_interrupt(cpu, PGM_SPECIFICATION);
@@ -2490,6 +2504,8 @@ bool kvm_s390_get_host_cpu_model(S390CPUModel *model, Error **errp)
          set_bit(S390_FEAT_DIAG_318, model->features);
      }
 
+    set_bit(S390_FEAT_CERT_STORE, model->features);
+
      /* Test for Ultravisor features that influence secure guest behavior */
      query_uv_feat_guest(model->features);
 
target/s390x/s390x-internal.h +2 -0
index 56cce2e7f5..ecff2d07a1 100644
@@ -391,6 +391,8 @@ int mmu_translate_real(CPUS390XState *env, target_ulong raddr, int rw,
  int handle_diag_288(CPUS390XState *env, uint64_t r1, uint64_t r3);
  void handle_diag_308(CPUS390XState *env, uint64_t r1, uint64_t r3,
                       uintptr_t ra);
+void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3,
+                     uintptr_t ra);
 
 
  /* translate.c */
target/s390x/tcg/misc_helper.c +7 -0
index f7101be574..412c34ed93 100644
@@ -142,6 +142,13 @@ void HELPER(diag)(CPUS390XState *env, uint32_t r1, uint32_t r3, uint32_t num)
          /* time bomb (watchdog) */
          r = handle_diag_288(env, r1, r3);
          break;
+    case 0x320:
+        /* cert store */
+        bql_lock();
+        handle_diag_320(env, r1, r3, GETPC());
+        bql_unlock();
+        r = 0;
+        break;
      default:
          r = -1;
          break;
#25 lore raw

Re: [PATCH v6 05/28] s390x/diag: Introduce DIAG 320 for Certificate Store Facility

In reply to Zhuoying Cai
Quoted 46 lines · Zhuoying Cai

DIAGNOSE 320 is introduced to support Certificate Store (CS) Facility, which includes operations such as query certificate storage information and provide certificates in the certificate store.

Currently, only subcode 0 is supported with this patch, which is used to query the Installed Subcodes Mask (ISM).

This subcode is only supported when the CS facility is enabled.

Availability of CS facility is determined by byte 134 bit 5 of the SCLP Read Info block. Byte 134's facilities cannot be represented without the availability of the extended-length-SCCB, so add it as a check for consistency.

Note: secure IPL is not available for Secure Execution (SE) guests, as their images are already integrity protected, and an additional protection of the kernel by secure IPL is not necessary.

This feature is available starting with the gen16 CPU model.

---
  docs/specs/s390x-secure-ipl.rst     | 12 ++++++++
  include/hw/s390x/ipl/diag320.h      | 20 +++++++++++++
  target/s390x/cpu_features.c         |  1 +
  target/s390x/cpu_features_def.h.inc |  1 +
  target/s390x/cpu_models.c           |  2 ++
  target/s390x/diag.c                 | 44 +++++++++++++++++++++++++++++
  target/s390x/gen-features.c         |  3 ++
  target/s390x/kvm/kvm.c              | 16 +++++++++++
  target/s390x/s390x-internal.h       |  2 ++
  target/s390x/tcg/misc_helper.c      |  7 +++++
  10 files changed, 108 insertions(+)

create mode 100644 include/hw/s390x/ipl/diag320.h

docs/specs/s390x-secure-ipl.rst +1 -0
index 9b1de5c604..30ddc81c2b 100644
@@ -13,3 +13,15 @@ will keep track of the number of certificates, their respective size,
  and a summation of the sizes.
 
  Note: A maximum of 64 certificates are allowed to be stored in the certificate store.
+

docs/specs/s390x-secure-ipl.rst will keep track of the number of certificates, their respective size, · line 26

Quoted 10 lines
docs/specs/s390x-secure-ipl.rst +10 -0
+DIAGNOSE function code 'X'320' - Certificate Store Facility
+-----------------------------------------------------------
+
+DIAGNOSE 'X'320' is used to provide support for userspace to directly
+query the s390 certificate store. Userspace may be the s390-ccw BIOS or
+the guest kernel.
+
+Subcode 0 - query installed subcodes
+    Returns a 256-bit installed subcodes mask (ISM) stored in the installed
+    subcodes block (ISB). This mask indicates which sucodes are currently

s/sucodes/subcodes/

Apart from that, the patch looks fine to me.

Thomas

#26 lore raw

PATCH v6 6/28 s390x/diag: Refactor address validation check from diag308_parm_check

In reply to Zhuoying Cai

Create a function to validate the address parameter of DIAGNOSE.

Refactor the function for reuse in the next patch, which allows address validation in read or write operation of DIAGNOSE.

---
 hw/s390x/ipl.h      | 6 ++++++
 target/s390x/diag.c | 4 +---
 2 files changed, 7 insertions(+), 3 deletions(-)
hw/s390x/ipl.h +6 -0
index bee72dfbb3..e26fc1cd6a 100644
@@ -118,6 +118,12 @@ QEMU_BUILD_BUG_MSG(offsetof(S390IPLState, iplb) & 3, "alignment of iplb wrong");
 #define S390_IPLB_MIN_FCP_LEN 384
 #define S390_IPLB_MIN_QEMU_SCSI_LEN 200
 
+static inline bool diag_parm_addr_valid(uint64_t addr, size_t size, bool write)
+{
+    return address_space_access_valid(&address_space_memory, addr,
+                                      size, write, MEMTXATTRS_UNSPECIFIED);
+}
+
 static inline bool iplb_valid_len(IplParameterBlock *iplb)
 {
     return be32_to_cpu(iplb->len) <= sizeof(IplParameterBlock);
target/s390x/diag.c +1 -3
index a35d808fd7..e67ee57f01 100644
@@ -65,9 +65,7 @@ static int diag308_parm_check(CPUS390XState *env, uint64_t r1, uint64_t addr,
         s390_program_interrupt(env, PGM_SPECIFICATION, ra);
         return -1;
     }
-    if (!address_space_access_valid(&address_space_memory, addr,
-                                    sizeof(IplParameterBlock), write,
-                                    MEMTXATTRS_UNSPECIFIED)) {
+    if (!diag_parm_addr_valid(addr, sizeof(IplParameterBlock), write)) {
         s390_program_interrupt(env, PGM_ADDRESSING, ra);
         return -1;
     }
Signature · 1 line
2.50.1
Reviewed-by on v6 6/28
#27 lore raw

Re: [PATCH v6 06/28] s390x/diag: Refactor address validation check from diag308_parm_check

Quoted 43 lines · Zhuoying Cai

Create a function to validate the address parameter of DIAGNOSE.

Refactor the function for reuse in the next patch, which allows address validation in read or write operation of DIAGNOSE.

---
  hw/s390x/ipl.h      | 6 ++++++
  target/s390x/diag.c | 4 +---
  2 files changed, 7 insertions(+), 3 deletions(-)
hw/s390x/ipl.h +6 -0
index bee72dfbb3..e26fc1cd6a 100644
@@ -118,6 +118,12 @@ QEMU_BUILD_BUG_MSG(offsetof(S390IPLState, iplb) & 3, "alignment of iplb wrong");
  #define S390_IPLB_MIN_FCP_LEN 384
  #define S390_IPLB_MIN_QEMU_SCSI_LEN 200
 
+static inline bool diag_parm_addr_valid(uint64_t addr, size_t size, bool write)
+{
+    return address_space_access_valid(&address_space_memory, addr,
+                                      size, write, MEMTXATTRS_UNSPECIFIED);
+}
+
  static inline bool iplb_valid_len(IplParameterBlock *iplb)
  {
      return be32_to_cpu(iplb->len) <= sizeof(IplParameterBlock);
target/s390x/diag.c +1 -3
index a35d808fd7..e67ee57f01 100644
@@ -65,9 +65,7 @@ static int diag308_parm_check(CPUS390XState *env, uint64_t r1, uint64_t addr,
          s390_program_interrupt(env, PGM_SPECIFICATION, ra);
          return -1;
      }
-    if (!address_space_access_valid(&address_space_memory, addr,
-                                    sizeof(IplParameterBlock), write,
-                                    MEMTXATTRS_UNSPECIFIED)) {
+    if (!diag_parm_addr_valid(addr, sizeof(IplParameterBlock), write)) {
          s390_program_interrupt(env, PGM_ADDRESSING, ra);
          return -1;
      }
#28 lore raw

Re: [PATCH v6 06/28] s390x/diag: Refactor address validation check from diag308_parm_check

In reply to Zhuoying Cai
Quoted 16 lines · Zhuoying Cai

Create a function to validate the address parameter of DIAGNOSE.

Refactor the function for reuse in the next patch, which allows address validation in read or write operation of DIAGNOSE.

---
  hw/s390x/ipl.h      | 6 ++++++
  target/s390x/diag.c | 4 +---
  2 files changed, 7 insertions(+), 3 deletions(-)
hw/s390x/ipl.h +0 -0
index bee72dfbb3..e26fc1cd6a 100644

hw/s390x/ipl.h QEMU_BUILD_BUG_MSG(offsetof(S390IPLState, iplb) & 3, "alignment of iplb wrong"); · line 125

Quoted 8 lines
hw/s390x/ipl.h +5 -0
@@ -118,6 +118,12 @@ QEMU_BUILD_BUG_MSG(offsetof(S390IPLState, iplb) & 3, "alignment of iplb wrong");
  #define S390_IPLB_MIN_FCP_LEN 384
  #define S390_IPLB_MIN_QEMU_SCSI_LEN 200
 
+static inline bool diag_parm_addr_valid(uint64_t addr, size_t size, bool write)
+{
+    return address_space_access_valid(&address_space_memory, addr,
+                                      size, write, MEMTXATTRS_UNSPECIFIED);
+}

The function is only used in diag.c ... could you please move it to that file?

Thanks,
Thomas

Quoted 18 lines
hw/s390x/ipl.h +0 -0
  static inline bool iplb_valid_len(IplParameterBlock *iplb)
  {
      return be32_to_cpu(iplb->len) <= sizeof(IplParameterBlock);
target/s390x/diag.c +1 -3
index a35d808fd7..e67ee57f01 100644
@@ -65,9 +65,7 @@ static int diag308_parm_check(CPUS390XState *env, uint64_t r1, uint64_t addr,
          s390_program_interrupt(env, PGM_SPECIFICATION, ra);
          return -1;
      }
-    if (!address_space_access_valid(&address_space_memory, addr,
-                                    sizeof(IplParameterBlock), write,
-                                    MEMTXATTRS_UNSPECIFIED)) {
+    if (!diag_parm_addr_valid(addr, sizeof(IplParameterBlock), write)) {
          s390_program_interrupt(env, PGM_ADDRESSING, ra);
          return -1;
      }
#29 lore raw

PATCH v6 7/28 s390x/diag: Implement DIAG 320 subcode 1

In reply to Zhuoying Cai

DIAG 320 subcode 1 provides information needed to determine the amount of storage to store one or more certificates from the certificate store.

Upon successful completion, this subcode returns information of the current cert store, such as the number of certificates stored and allowed in the cert store, amount of space may need to be allocate to store a certificate, etc for verification-certificate blocks (VCBs).

The subcode value is denoted by setting the left-most bit of an 8-byte field.

The verification-certificate-storage-size block (VCSSB) contains the output data when the operation completes successfully. A VCSSB length of 4 indicates that no certificate are available in the cert store.

---
 docs/specs/s390x-secure-ipl.rst | 10 ++++++
 include/hw/s390x/ipl/diag320.h  | 22 ++++++++++++
 target/s390x/diag.c             | 59 ++++++++++++++++++++++++++++++++-
 3 files changed, 90 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +10 -0
index 30ddc81c2b..4217f19c84 100644
@@ -25,3 +25,13 @@ Subcode 0 - query installed subcodes
     Returns a 256-bit installed subcodes mask (ISM) stored in the installed
     subcodes block (ISB). This mask indicates which sucodes are currently
     installed and available for use.
+
+Subcode 1 - query verification certificate storage information
+    Provides the information required to determine the amount of memory needed to
+    store one or more verification-certificates (VCs) from the certificate store (CS).
+
+    Upon successful completion, this subcode returns various storage size values for
+    verification-certificate blocks (VCBs).
+
+    The output is returned in the verification-certificate-storage-size block (VCSSB).
+    A VCSSB length of 4 indicates that no certificates are available in the CS.
include/hw/s390x/ipl/diag320.h +22 -0
index aa04b699c6..6e4779c699 100644
@@ -11,10 +11,32 @@
 #define S390X_DIAG320_H
 
 #define DIAG_320_SUBC_QUERY_ISM     0
+#define DIAG_320_SUBC_QUERY_VCSI    1
 
 #define DIAG_320_RC_OK              0x0001
 #define DIAG_320_RC_NOT_SUPPORTED   0x0102
+#define DIAG_320_RC_INVAL_VCSSB_LEN 0x0202
 
 #define DIAG_320_ISM_QUERY_SUBCODES 0x80000000
+#define DIAG_320_ISM_QUERY_VCSI     0x40000000
+
+#define VCSSB_NO_VC     4
+#define VCSSB_MIN_LEN   128
+#define VCE_HEADER_LEN  128
+#define VCB_HEADER_LEN  64
+
+struct VCStorageSizeBlock {
+    uint32_t length;
+    uint8_t reserved0[3];
+    uint8_t version;
+    uint32_t reserved1[6];
+    uint16_t total_vc_ct;
+    uint16_t max_vc_ct;
+    uint32_t reserved3[11];
+    uint32_t max_single_vcb_len;
+    uint32_t total_vcb_len;
+    uint32_t reserved4[10];
+};
+typedef struct VCStorageSizeBlock VCStorageSizeBlock;
 
 #endif
target/s390x/diag.c +58 -1

82 lines not on this page · raw message

Signature · 1 line
2.50.1
Reviewed-by on v6 7/28
#30 lore raw

Re: [PATCH v6 07/28] s390x/diag: Implement DIAG 320 subcode 1

Quoted 168 lines · Zhuoying Cai

DIAG 320 subcode 1 provides information needed to determine the amount of storage to store one or more certificates from the certificate store.

Upon successful completion, this subcode returns information of the current cert store, such as the number of certificates stored and allowed in the cert store, amount of space may need to be allocate to store a certificate, etc for verification-certificate blocks (VCBs).

The subcode value is denoted by setting the left-most bit of an 8-byte field.

The verification-certificate-storage-size block (VCSSB) contains the output data when the operation completes successfully. A VCSSB length of 4 indicates that no certificate are available in the cert store.

---
  docs/specs/s390x-secure-ipl.rst | 10 ++++++
  include/hw/s390x/ipl/diag320.h  | 22 ++++++++++++
  target/s390x/diag.c             | 59 ++++++++++++++++++++++++++++++++-
  3 files changed, 90 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +10 -0
index 30ddc81c2b..4217f19c84 100644
@@ -25,3 +25,13 @@ Subcode 0 - query installed subcodes
      Returns a 256-bit installed subcodes mask (ISM) stored in the installed
      subcodes block (ISB). This mask indicates which sucodes are currently
      installed and available for use.
+
+Subcode 1 - query verification certificate storage information
+    Provides the information required to determine the amount of memory needed to
+    store one or more verification-certificates (VCs) from the certificate store (CS).
+
+    Upon successful completion, this subcode returns various storage size values for
+    verification-certificate blocks (VCBs).
+
+    The output is returned in the verification-certificate-storage-size block (VCSSB).
+    A VCSSB length of 4 indicates that no certificates are available in the CS.
include/hw/s390x/ipl/diag320.h +22 -0
index aa04b699c6..6e4779c699 100644
@@ -11,10 +11,32 @@
  #define S390X_DIAG320_H
 
  #define DIAG_320_SUBC_QUERY_ISM     0
+#define DIAG_320_SUBC_QUERY_VCSI    1
 
  #define DIAG_320_RC_OK              0x0001
  #define DIAG_320_RC_NOT_SUPPORTED   0x0102
+#define DIAG_320_RC_INVAL_VCSSB_LEN 0x0202
 
  #define DIAG_320_ISM_QUERY_SUBCODES 0x80000000
+#define DIAG_320_ISM_QUERY_VCSI     0x40000000
+
+#define VCSSB_NO_VC     4
+#define VCSSB_MIN_LEN   128
+#define VCE_HEADER_LEN  128
+#define VCB_HEADER_LEN  64
+
+struct VCStorageSizeBlock {
+    uint32_t length;
+    uint8_t reserved0[3];
+    uint8_t version;
+    uint32_t reserved1[6];
+    uint16_t total_vc_ct;
+    uint16_t max_vc_ct;
+    uint32_t reserved3[11];
+    uint32_t max_single_vcb_len;
+    uint32_t total_vcb_len;
+    uint32_t reserved4[10];
+};
+typedef struct VCStorageSizeBlock VCStorageSizeBlock;
 
  #endif
target/s390x/diag.c +58 -1
index e67ee57f01..4e6de483b8 100644
@@ -191,11 +191,50 @@ out:
      }
  }
 
+static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1,
+                                     uintptr_t ra, S390IPLCertificateStore *qcs)
+{
+    g_autofree VCStorageSizeBlock *vcssb = NULL;
+
+    vcssb = g_new0(VCStorageSizeBlock, 1);
+    if (s390_cpu_virt_mem_read(cpu, addr, r1, vcssb, sizeof(*vcssb))) {
+        s390_cpu_virt_mem_handle_exc(cpu, ra);
+        return -1;
+    }
+
+    if (be32_to_cpu(vcssb->length) < VCSSB_MIN_LEN) {
+        return DIAG_320_RC_INVAL_VCSSB_LEN;
+    }
+
+    if (!qcs->count) {
+        vcssb->length = cpu_to_be32(VCSSB_NO_VC);
+    } else {
+        vcssb->version = 0;
+        vcssb->total_vc_ct = cpu_to_be16(qcs->count);
+        vcssb->max_vc_ct = cpu_to_be16(MAX_CERTIFICATES);
+        vcssb->max_single_vcb_len = cpu_to_be32(VCB_HEADER_LEN + VCE_HEADER_LEN +
+                                                qcs->max_cert_size);
+        vcssb->total_vcb_len = cpu_to_be32(VCB_HEADER_LEN + qcs->count * VCE_HEADER_LEN +
+                                           qcs->total_bytes);
+    }
+
+    if (s390_cpu_virt_mem_write(cpu, addr, r1, vcssb, be32_to_cpu(vcssb->length))) {
+        s390_cpu_virt_mem_handle_exc(cpu, ra);
+        return -1;
+    }
+    return DIAG_320_RC_OK;
+}
+
+QEMU_BUILD_BUG_MSG(sizeof(VCStorageSizeBlock) != VCSSB_MIN_LEN,
+                   "size of VCStorageSizeBlock is wrong");
+
  void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
  {
      S390CPU *cpu = env_archcpu(env);
+    S390IPLCertificateStore *qcs = s390_ipl_get_certificate_store();
      uint64_t subcode = env->regs[r3];
      uint64_t addr = env->regs[r1];
+    int rc;
 
      if (env->psw.mask & PSW_MASK_PSTATE) {
          s390_program_interrupt(env, PGM_PRIVILEGED, ra);
@@ -219,7 +258,8 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
           * but the current set of subcodes can fit within a single word
           * for now.
           */
-        uint32_t ism_word0 = cpu_to_be32(DIAG_320_ISM_QUERY_SUBCODES);
+        uint32_t ism_word0 = cpu_to_be32(DIAG_320_ISM_QUERY_SUBCODES |
+                                         DIAG_320_ISM_QUERY_VCSI);
 
          if (s390_cpu_virt_mem_write(cpu, addr, r1, &ism_word0, sizeof(ism_word0))) {
              s390_cpu_virt_mem_handle_exc(cpu, ra);
@@ -228,6 +268,23 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
 
          env->regs[r1 + 1] = DIAG_320_RC_OK;
          break;
+    case DIAG_320_SUBC_QUERY_VCSI:
+        if (!diag_parm_addr_valid(addr, sizeof(VCStorageSizeBlock), true)) {
+            s390_program_interrupt(env, PGM_ADDRESSING, ra);
+            return;
+        }
+
+        if (addr & 0x7) {
+            s390_program_interrupt(env, PGM_ADDRESSING, ra);
+            return;
+        }
+
+        rc = handle_diag320_query_vcsi(cpu, addr, r1, ra, qcs);
+        if (rc == -1) {
+            return;
+        }
+        env->regs[r1 + 1] = rc;
+        break;
      default:
          env->regs[r1 + 1] = DIAG_320_RC_NOT_SUPPORTED;
          break;
#31 lore raw

Re: [PATCH v6 07/28] s390x/diag: Implement DIAG 320 subcode 1

In reply to Zhuoying Cai
Quoted 32 lines · Zhuoying Cai

DIAG 320 subcode 1 provides information needed to determine the amount of storage to store one or more certificates from the certificate store.

Upon successful completion, this subcode returns information of the current cert store, such as the number of certificates stored and allowed in the cert store, amount of space may need to be allocate to store a certificate, etc for verification-certificate blocks (VCBs).

The subcode value is denoted by setting the left-most bit of an 8-byte field.

The verification-certificate-storage-size block (VCSSB) contains the output data when the operation completes successfully. A VCSSB length of 4 indicates that no certificate are available in the cert store.

---
  docs/specs/s390x-secure-ipl.rst | 10 ++++++
  include/hw/s390x/ipl/diag320.h  | 22 ++++++++++++
  target/s390x/diag.c             | 59 ++++++++++++++++++++++++++++++++-
  3 files changed, 90 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +0 -0
index 30ddc81c2b..4217f19c84 100644
@@ -25,3 +25,13 @@ Subcode 0 - query installed subcodes
      Returns a 256-bit installed subcodes mask (ISM) stored in the installed
      subcodes block (ISB). This mask indicates which sucodes are currently
      installed and available for use.

docs/specs/s390x-secure-ipl.rst Subcode 0 - query installed subcodes · line 37

Quoted 10 lines
docs/specs/s390x-secure-ipl.rst +10 -0
+
+Subcode 1 - query verification certificate storage information
+    Provides the information required to determine the amount of memory needed to
+    store one or more verification-certificates (VCs) from the certificate store (CS).
+
+    Upon successful completion, this subcode returns various storage size values for
+    verification-certificate blocks (VCBs).
+
+    The output is returned in the verification-certificate-storage-size block (VCSSB).
+    A VCSSB length of 4 indicates that no certificates are available in the CS.

limit to 80 columns, please.

Thomas

#32 lore raw

PATCH v6 8/28 crypto/x509-utils: Add helper functions for DIAG 320 subcode 2

In reply to Zhuoying Cai

Introduce new helper functions to extract certificate metadata needed for DIAG 320 subcode 2:

qcrypto_x509_check_cert_times() - validates the certificate's validity period against the current time qcrypto_x509_get_pk_algorithm() - returns the public key algorithm used in the certificate qcrypto_x509_get_cert_key_id() - extracts the key ID from the certificate qcrypto_x509_is_ecc_curve_p521() - determines the ECC public key algorithm uses P-521 curve

These functions provide support for metadata extraction and validity checking for X.509 certificates.

---
 crypto/x509-utils.c         | 248 ++++++++++++++++++++++++++++++++++++
 include/crypto/x509-utils.h |  72 +++++++++++
 2 files changed, 320 insertions(+)
crypto/x509-utils.c +248 -0
index 5d43b0ec96..763eccb190 100644
@@ -27,6 +27,25 @@ static const int qcrypto_to_gnutls_hash_alg_map[QCRYPTO_HASH_ALGO__MAX] = {
     [QCRYPTO_HASH_ALGO_RIPEMD160] = GNUTLS_DIG_RMD160,
 };
 
+static const int gnutls_to_qcrypto_pk_alg_map[] = {
+    [GNUTLS_PK_RSA] = QCRYPTO_PK_ALGO_RSA,
+    [GNUTLS_PK_DSA] = QCRYPTO_PK_ALGO_DSA,
+    [GNUTLS_PK_ECDSA] = QCRYPTO_PK_ALGO_ECDSA,
+    [GNUTLS_PK_RSA_OAEP] = QCRYPTO_PK_ALGO_RSA_OAEP,
+    [GNUTLS_PK_EDDSA_ED25519] = QCRYPTO_PK_ALGO_ED25519,
+    [GNUTLS_PK_EDDSA_ED448] = QCRYPTO_PK_ALGO_ED448,
+};
+
+static const int qcrypto_to_gnutls_keyid_flags_map[] = {
+    [QCRYPTO_HASH_ALGO_MD5] = -1,
+    [QCRYPTO_HASH_ALGO_SHA1] = GNUTLS_KEYID_USE_SHA1,
+    [QCRYPTO_HASH_ALGO_SHA224] = -1,
+    [QCRYPTO_HASH_ALGO_SHA256] = GNUTLS_KEYID_USE_SHA256,
+    [QCRYPTO_HASH_ALGO_SHA384] = -1,
+    [QCRYPTO_HASH_ALGO_SHA512] = GNUTLS_KEYID_USE_SHA512,
+    [QCRYPTO_HASH_ALGO_RIPEMD160] = -1,
+};
+
 int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
                                       QCryptoHashAlgo alg,
                                       uint8_t *result,
@@ -122,6 +141,207 @@ cleanup:
     return ret;
 }
 
+int qcrypto_x509_check_cert_times(uint8_t *cert, size_t size, Error **errp)
+{
+    int rc;
+    int ret = -1;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+    time_t now = time(0);
+    time_t exp_time;
+    time_t act_time;
+
+    if (now == ((time_t)-1)) {
+        error_setg_errno(errp, errno, "Cannot get current time");
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    exp_time = gnutls_x509_crt_get_expiration_time(crt);
+    if (exp_time == ((time_t)-1)) {
+        error_setg(errp, "Failed to get certificate expiration time");
+        goto cleanup;
+    }
+    if (exp_time < now) {
+        error_setg(errp, "The certificate has expired");
+        goto cleanup;
+    }
+
+    act_time = gnutls_x509_crt_get_activation_time(crt);
+    if (act_time == ((time_t)-1)) {
+        error_setg(errp, "Failed to get certificate activation time");
+        goto cleanup;
+    }
+    if (act_time > now) {
+        error_setg(errp, "The certificate is not yet active");
+        goto cleanup;
+    }
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}
+
+int qcrypto_x509_get_pk_algorithm(uint8_t *cert, size_t size, Error **errp)
+{
+    int rc;
+    int ret = -1;
+    unsigned int bits;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_get_pk_algorithm(crt, &bits);
+    if (rc >= G_N_ELEMENTS(gnutls_to_qcrypto_pk_alg_map)) {
+        error_setg(errp, "Unknown public key algorithm %d", rc);
+        goto cleanup;
+    }
+
+    ret = gnutls_to_qcrypto_pk_alg_map[rc];
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}
+
+int qcrypto_x509_get_cert_key_id(uint8_t *cert, size_t size,
+                                 QCryptoHashAlgo hash_alg,
+                                 uint8_t **result,
+                                 size_t *resultlen,
+                                 Error **errp)
+{
+    int rc;
+    int ret = -1;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+
+    if (hash_alg >= G_N_ELEMENTS(qcrypto_to_gnutls_hash_alg_map)) {
+        error_setg(errp, "Unknown hash algorithm %d", hash_alg);
+        return ret;
+    }
+
+    if (qcrypto_to_gnutls_keyid_flags_map[hash_alg] == -1 ||
+        hash_alg >= G_N_ELEMENTS(qcrypto_to_gnutls_keyid_flags_map)) {
+        error_setg(errp, "Unsupported key id flag %d", hash_alg);
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *resultlen = gnutls_hash_get_len(qcrypto_to_gnutls_hash_alg_map[hash_alg]);
+    if (*resultlen == 0) {
+        error_setg(errp, "Failed to get hash algorithn length: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_malloc0(*resultlen);
+    if (gnutls_x509_crt_get_key_id(crt,
+                                   qcrypto_to_gnutls_keyid_flags_map[hash_alg],
+                                   *result, resultlen) != 0) {
+        error_setg(errp, "Failed to get key ID from certificate");
+        g_clear_pointer(result, g_free);
+        goto cleanup;
+    }
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}
+
+static int qcrypto_x509_get_ecc_curve(uint8_t *cert, size_t size, Error **errp)
+{
+    int rc;
+    int ret = -1;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+    gnutls_ecc_curve_t curve_id;
+    gnutls_datum_t x = {.data = NULL, .size = 0};
+    gnutls_datum_t y = {.data = NULL, .size = 0};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_get_pk_ecc_raw(crt, &curve_id, &x, &y);
+    if (rc != 0) {
+        error_setg(errp, "Failed to get ECC public key curve: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    ret = curve_id;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    gnutls_free(x.data);
+    gnutls_free(y.data);
+    return ret;
+}
+
+int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp)
+{
+    int curve_id;
+
+    curve_id = qcrypto_x509_get_ecc_curve(cert, size, errp);
+    if (curve_id == -1) {
+        return -1;
+    }
+
+    if (curve_id == GNUTLS_ECC_CURVE_INVALID) {
+        error_setg(errp, "Invalid ECC curve");
+        return -1;
+    }
+
+    if (curve_id == GNUTLS_ECC_CURVE_SECP521R1) {
+        return 1;
+    }
+
+    return 0;
+}
+
 #else /* ! CONFIG_GNUTLS */
 
 int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
@@ -143,4 +363,32 @@ int qcrypto_x509_convert_cert_der(uint8_t *cert, size_t size,
     return -1;
 }
 
+int qcrypto_x509_check_cert_times(uint8_t *cert, size_t size, Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to get certificate times");
+    return -1;
+}
+
+int qcrypto_x509_get_pk_algorithm(uint8_t *cert, size_t size, Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to get public key algorithm");
+    return -1;
+}
+
+int qcrypto_x509_get_cert_key_id(uint8_t *cert, size_t size,
+                                 QCryptoHashAlgo hash_alg,
+                                 uint8_t **result,
+                                 size_t *resultlen,
+                                 Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to get key ID");
+    return -1;
+}
+
+int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to determine ecc curve");
+    return -1;
+}
+
 #endif /* ! CONFIG_GNUTLS */
include/crypto/x509-utils.h +72 -0

82 lines not on this page · raw message

Signature · 1 line
2.50.1
#33 lore raw

Re: [PATCH v6 08/28] crypto/x509-utils: Add helper functions for DIAG 320 subcode 2

Quoted 2 lines · Zhuoying Cai

Introduce new helper functions to extract certificate metadata needed for DIAG 320 subcode 2:

Since we are adding generic helper functions to extract certificate metadata, maybe we should avoid mentioning about "DIAG 320 subcode 2"?

Thanks
Farhan

Quoted 11 lines

qcrypto_x509_check_cert_times() - validates the certificate's validity period against the current time qcrypto_x509_get_pk_algorithm() - returns the public key algorithm used in the certificate qcrypto_x509_get_cert_key_id() - extracts the key ID from the certificate qcrypto_x509_is_ecc_curve_p521() - determines the ECC public key algorithm uses P-521 curve

These functions provide support for metadata extraction and validity checking for X.509 certificates.

#34 lore raw

Re: [PATCH v6 08/28] crypto/x509-utils: Add helper functions for DIAG 320 subcode 2

In reply to Zhuoying Cai
Quoted 13 lines · Zhuoying Cai

Introduce new helper functions to extract certificate metadata needed for DIAG 320 subcode 2:

qcrypto_x509_check_cert_times() - validates the certificate's validity period against the current time qcrypto_x509_get_pk_algorithm() - returns the public key algorithm used in the certificate qcrypto_x509_get_cert_key_id() - extracts the key ID from the certificate qcrypto_x509_is_ecc_curve_p521() - determines the ECC public key algorithm uses P-521 curve

These functions provide support for metadata extraction and validity checking for X.509 certificates.

---

...

Quoted 12 lines
crypto/x509-utils.c +12 -0
+int qcrypto_x509_get_pk_algorithm(uint8_t *cert, size_t size, Error **errp)
+{
+    int rc;
+    int ret = -1;
+    unsigned int bits;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;

crypto/x509-utils.c cleanup: · line 219

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_get_pk_algorithm(crt, &bits);
+    if (rc >= G_N_ELEMENTS(gnutls_to_qcrypto_pk_alg_map)) {

gnutls_x509_crt_get_pk_algorithm can also return a negative value according to the documentation, so I think you should also check for "rc < 0" in addition here.

Quoted 19 lines
crypto/x509-utils.c +19 -0
+        error_setg(errp, "Unknown public key algorithm %d", rc);
+        goto cleanup;
+    }
+
+    ret = gnutls_to_qcrypto_pk_alg_map[rc];
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}
+
+int qcrypto_x509_get_cert_key_id(uint8_t *cert, size_t size,
+                                 QCryptoHashAlgo hash_alg,
+                                 uint8_t **result,
+                                 size_t *resultlen,
+                                 Error **errp)
+{
+    int rc;
+    int ret = -1;

crypto/x509-utils.c cleanup: · line 248

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+
+    if (hash_alg >= G_N_ELEMENTS(qcrypto_to_gnutls_hash_alg_map)) {
+        error_setg(errp, "Unknown hash algorithm %d", hash_alg);
+        return ret;
+    }
+
+    if (qcrypto_to_gnutls_keyid_flags_map[hash_alg] == -1 ||
+        hash_alg >= G_N_ELEMENTS(qcrypto_to_gnutls_keyid_flags_map)) {

Since "||" conditions are evaluated from left to right, please check for the boundary first before using hash_alg as index into the array (i.e. swapt the two sides of the "||").

Quoted 37 lines
crypto/x509-utils.c +37 -0
+        error_setg(errp, "Unsupported key id flag %d", hash_alg);
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *resultlen = gnutls_hash_get_len(qcrypto_to_gnutls_hash_alg_map[hash_alg]);
+    if (*resultlen == 0) {
+        error_setg(errp, "Failed to get hash algorithn length: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_malloc0(*resultlen);
+    if (gnutls_x509_crt_get_key_id(crt,
+                                   qcrypto_to_gnutls_keyid_flags_map[hash_alg],
+                                   *result, resultlen) != 0) {
+        error_setg(errp, "Failed to get key ID from certificate");
+        g_clear_pointer(result, g_free);
+        goto cleanup;
+    }
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}

...

Quoted 10 lines
crypto/x509-utils.c +10 -0
+int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp)
+{
+    int curve_id;
+
+    curve_id = qcrypto_x509_get_ecc_curve(cert, size, errp);
+    if (curve_id == -1) {
+        return -1;
+    }
+
+    if (curve_id == GNUTLS_ECC_CURVE_INVALID) {

crypto/x509-utils.c cleanup: · line 343

Quoted 10 lines
crypto/x509-utils.c +10 -0
+        error_setg(errp, "Invalid ECC curve");
+        return -1;
+    }
+
+    if (curve_id == GNUTLS_ECC_CURVE_SECP521R1) {
+        return 1;
+    }
+
+    return 0;
+}

Bikeshedding, but IMHO, if you name a function "..._is_something", I'd prefer if it returns a bool, and not an "int". Otherwise this might get confusing if you read something like this later in the code:

   if (qcrypto_x509_is_ecc_curve_p521(...)) {
   }

The caller could use errp to distinguish between the error case and a simple "false" as answer to the question.
Thomas

#35 lore raw

Re: [PATCH v6 08/28] crypto/x509-utils: Add helper functions for DIAG 320 subcode 2

Quoted 139 lines · Thomas Huth
Quoted 13 lines · Zhuoying Cai

Introduce new helper functions to extract certificate metadata needed for DIAG 320 subcode 2:

qcrypto_x509_check_cert_times() - validates the certificate's validity period against the current time qcrypto_x509_get_pk_algorithm() - returns the public key algorithm used in the certificate qcrypto_x509_get_cert_key_id() - extracts the key ID from the certificate qcrypto_x509_is_ecc_curve_p521() - determines the ECC public key algorithm uses P-521 curve

These functions provide support for metadata extraction and validity checking for X.509 certificates.

---

...

Quoted 12 lines
crypto/x509-utils.c +12 -0
+int qcrypto_x509_get_pk_algorithm(uint8_t *cert, size_t size, Error **errp)
+{
+    int rc;
+    int ret = -1;
+    unsigned int bits;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;

crypto/x509-utils.c cleanup: · line 219

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_get_pk_algorithm(crt, &bits);
+    if (rc >= G_N_ELEMENTS(gnutls_to_qcrypto_pk_alg_map)) {

gnutls_x509_crt_get_pk_algorithm can also return a negative value according to the documentation, so I think you should also check for "rc < 0" in addition here.

Quoted 19 lines
crypto/x509-utils.c +19 -0
+        error_setg(errp, "Unknown public key algorithm %d", rc);
+        goto cleanup;
+    }
+
+    ret = gnutls_to_qcrypto_pk_alg_map[rc];
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}
+
+int qcrypto_x509_get_cert_key_id(uint8_t *cert, size_t size,
+                                 QCryptoHashAlgo hash_alg,
+                                 uint8_t **result,
+                                 size_t *resultlen,
+                                 Error **errp)
+{
+    int rc;
+    int ret = -1;

crypto/x509-utils.c cleanup: · line 248

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+
+    if (hash_alg >= G_N_ELEMENTS(qcrypto_to_gnutls_hash_alg_map)) {
+        error_setg(errp, "Unknown hash algorithm %d", hash_alg);
+        return ret;
+    }
+
+    if (qcrypto_to_gnutls_keyid_flags_map[hash_alg] == -1 ||
+        hash_alg >= G_N_ELEMENTS(qcrypto_to_gnutls_keyid_flags_map)) {

Since "||" conditions are evaluated from left to right, please check for the boundary first before using hash_alg as index into the array (i.e. swapt the two sides of the "||").

Quoted 37 lines
crypto/x509-utils.c +37 -0
+        error_setg(errp, "Unsupported key id flag %d", hash_alg);
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *resultlen = gnutls_hash_get_len(qcrypto_to_gnutls_hash_alg_map[hash_alg]);
+    if (*resultlen == 0) {
+        error_setg(errp, "Failed to get hash algorithn length: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_malloc0(*resultlen);
+    if (gnutls_x509_crt_get_key_id(crt,
+                                   qcrypto_to_gnutls_keyid_flags_map[hash_alg],
+                                   *result, resultlen) != 0) {
+        error_setg(errp, "Failed to get key ID from certificate");
+        g_clear_pointer(result, g_free);
+        goto cleanup;
+    }
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}

...

Quoted 10 lines
crypto/x509-utils.c +10 -0
+int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp)
+{
+    int curve_id;
+
+    curve_id = qcrypto_x509_get_ecc_curve(cert, size, errp);
+    if (curve_id == -1) {
+        return -1;
+    }
+
+    if (curve_id == GNUTLS_ECC_CURVE_INVALID) {

crypto/x509-utils.c cleanup: · line 343

Quoted 10 lines
crypto/x509-utils.c +10 -0
+        error_setg(errp, "Invalid ECC curve");
+        return -1;
+    }
+
+    if (curve_id == GNUTLS_ECC_CURVE_SECP521R1) {
+        return 1;
+    }
+
+    return 0;
+}

Bikeshedding, but IMHO, if you name a function "..._is_something", I'd prefer if it returns a bool, and not an "int". Otherwise this might get confusing if you read something like this later in the code:

Quoted 5 lines
   if (qcrypto_x509_is_ecc_curve_p521(...)) {
   }

The caller could use errp to distinguish between the error case and a simple "false" as answer to the question.

Overloading one 'false' return value to mean both success & failure is an anti-pattern IMHO. We have 3 separate return values we need for this function, so using -1/0/1 is the right approach.

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#36 lore raw

Re: [PATCH v6 08/28] crypto/x509-utils: Add helper functions for DIAG 320 subcode 2

Quoted 143 lines · Daniel P. Berrangé
Quoted 142 lines · Thomas Huth
Quoted 13 lines · Zhuoying Cai

Introduce new helper functions to extract certificate metadata needed for DIAG 320 subcode 2:

qcrypto_x509_check_cert_times() - validates the certificate's validity period against the current time qcrypto_x509_get_pk_algorithm() - returns the public key algorithm used in the certificate qcrypto_x509_get_cert_key_id() - extracts the key ID from the certificate qcrypto_x509_is_ecc_curve_p521() - determines the ECC public key algorithm uses P-521 curve

These functions provide support for metadata extraction and validity checking for X.509 certificates.

---

...

Quoted 12 lines
crypto/x509-utils.c +12 -0
+int qcrypto_x509_get_pk_algorithm(uint8_t *cert, size_t size, Error **errp)
+{
+    int rc;
+    int ret = -1;
+    unsigned int bits;
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;

crypto/x509-utils.c cleanup: · line 219

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_get_pk_algorithm(crt, &bits);
+    if (rc >= G_N_ELEMENTS(gnutls_to_qcrypto_pk_alg_map)) {

gnutls_x509_crt_get_pk_algorithm can also return a negative value according to the documentation, so I think you should also check for "rc < 0" in addition here.

Quoted 19 lines
crypto/x509-utils.c +19 -0
+        error_setg(errp, "Unknown public key algorithm %d", rc);
+        goto cleanup;
+    }
+
+    ret = gnutls_to_qcrypto_pk_alg_map[rc];
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}
+
+int qcrypto_x509_get_cert_key_id(uint8_t *cert, size_t size,
+                                 QCryptoHashAlgo hash_alg,
+                                 uint8_t **result,
+                                 size_t *resultlen,
+                                 Error **errp)
+{
+    int rc;
+    int ret = -1;

crypto/x509-utils.c cleanup: · line 248

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    gnutls_x509_crt_t crt;
+    gnutls_datum_t datum = {.data = cert, .size = size};
+
+    if (hash_alg >= G_N_ELEMENTS(qcrypto_to_gnutls_hash_alg_map)) {
+        error_setg(errp, "Unknown hash algorithm %d", hash_alg);
+        return ret;
+    }
+
+    if (qcrypto_to_gnutls_keyid_flags_map[hash_alg] == -1 ||
+        hash_alg >= G_N_ELEMENTS(qcrypto_to_gnutls_keyid_flags_map)) {

Since "||" conditions are evaluated from left to right, please check for the boundary first before using hash_alg as index into the array (i.e. swapt the two sides of the "||").

Quoted 37 lines
crypto/x509-utils.c +37 -0
+        error_setg(errp, "Unsupported key id flag %d", hash_alg);
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        return ret;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *resultlen = gnutls_hash_get_len(qcrypto_to_gnutls_hash_alg_map[hash_alg]);
+    if (*resultlen == 0) {
+        error_setg(errp, "Failed to get hash algorithn length: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_malloc0(*resultlen);
+    if (gnutls_x509_crt_get_key_id(crt,
+                                   qcrypto_to_gnutls_keyid_flags_map[hash_alg],
+                                   *result, resultlen) != 0) {
+        error_setg(errp, "Failed to get key ID from certificate");
+        g_clear_pointer(result, g_free);
+        goto cleanup;
+    }
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    return ret;
+}

...

Quoted 10 lines
crypto/x509-utils.c +10 -0
+int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp)
+{
+    int curve_id;
+
+    curve_id = qcrypto_x509_get_ecc_curve(cert, size, errp);
+    if (curve_id == -1) {
+        return -1;
+    }
+
+    if (curve_id == GNUTLS_ECC_CURVE_INVALID) {

crypto/x509-utils.c cleanup: · line 343

Quoted 10 lines
crypto/x509-utils.c +10 -0
+        error_setg(errp, "Invalid ECC curve");
+        return -1;
+    }
+
+    if (curve_id == GNUTLS_ECC_CURVE_SECP521R1) {
+        return 1;
+    }
+
+    return 0;
+}

Bikeshedding, but IMHO, if you name a function "..._is_something", I'd prefer if it returns a bool, and not an "int". Otherwise this might get confusing if you read something like this later in the code:

    if (qcrypto_x509_is_ecc_curve_p521(...)) {
    }
Quoted 6 lines
Quoted 2 lines

The caller could use errp to distinguish between the error case and a simple "false" as answer to the question.

Overloading one 'false' return value to mean both success & failure is an anti-pattern IMHO. We have 3 separate return values we need for this function, so using -1/0/1 is the right approach.

In that case, please rename the function to something like "qcrypto_x509_check_ecc_curve_p521" or so ... it's IMHO getting too confusing otherwise.

Thomas

#37 lore raw

PATCH v6 9/28 s390x/diag: Implement DIAG 320 subcode 2

In reply to Zhuoying Cai

DIAG 320 subcode 2 provides verification-certificates (VCs) that are in the certificate store. Only X509 certificates in DER format and SHA-256 hash type are recognized.

The subcode value is denoted by setting the second-left-most bit of an 8-byte field.

The Verification Certificate Block (VCB) contains the output data when the operation completes successfully. It includes a common header followed by zero or more Verification Certificate Entries (VCEs), depending on the VCB input length and the VC range (from the first VC index to the last VC index) in the certificate store.

Each VCE contains information about a certificate retrieved from the S390IPLCertificateStore, such as the certificate name, key type, key ID length, hash length, and the raw certificate data.
The key ID and hash are extracted from the raw certificate by the crypto API.

Note: SHA2-256 VC hash type is required for retrieving the hash (fingerprint) of the certificate.

---
 docs/specs/s390x-secure-ipl.rst |  13 ++
 include/hw/s390x/ipl/diag320.h  |  49 +++++
 target/s390x/diag.c             | 312 +++++++++++++++++++++++++++++++-
 3 files changed, 373 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +13 -0
index 4217f19c84..e28f0b40d7 100644
@@ -35,3 +35,16 @@ Subcode 1 - query verification certificate storage information
 
     The output is returned in the verification-certificate-storage-size block (VCSSB).
     A VCSSB length of 4 indicates that no certificates are available in the CS.
+
+Subcode 2 - store verification certificates
+    Provides VCs that are in the certificate store.
+
+    The output is provided in a VCB, which includes a common header followed by zero
+    or more verification-certificate entries (VCEs).
+
+    The first-VC index and last-VC index fields of VCB specify the range of VCs
+    to be stored by subcode 2. Stored count and remained count fields specify the
+    number of VCs stored and could not be stored in the VCB due to insufficient
+    storage specified in the VCB input length field.
+
+    VCE contains various information of a VC from the CS.
include/hw/s390x/ipl/diag320.h +49 -0

72 lines not on this page · raw message

target/s390x/diag.c +311 -1

344 lines not on this page · raw message

Signature · 1 line
2.50.1
#38 lore raw

Re: [PATCH v6 09/28] s390x/diag: Implement DIAG 320 subcode 2

Quoted 203 lines · Zhuoying Cai

DIAG 320 subcode 2 provides verification-certificates (VCs) that are in the certificate store. Only X509 certificates in DER format and SHA-256 hash type are recognized.

The subcode value is denoted by setting the second-left-most bit of an 8-byte field.

The Verification Certificate Block (VCB) contains the output data when the operation completes successfully. It includes a common header followed by zero or more Verification Certificate Entries (VCEs), depending on the VCB input length and the VC range (from the first VC index to the last VC index) in the certificate store.

Each VCE contains information about a certificate retrieved from the S390IPLCertificateStore, such as the certificate name, key type, key ID length, hash length, and the raw certificate data.
The key ID and hash are extracted from the raw certificate by the crypto API.

Note: SHA2-256 VC hash type is required for retrieving the hash (fingerprint) of the certificate.

---
  docs/specs/s390x-secure-ipl.rst |  13 ++
  include/hw/s390x/ipl/diag320.h  |  49 +++++
  target/s390x/diag.c             | 312 +++++++++++++++++++++++++++++++-
  3 files changed, 373 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +13 -0
index 4217f19c84..e28f0b40d7 100644
@@ -35,3 +35,16 @@ Subcode 1 - query verification certificate storage information
 
      The output is returned in the verification-certificate-storage-size block (VCSSB).
      A VCSSB length of 4 indicates that no certificates are available in the CS.
+
+Subcode 2 - store verification certificates
+    Provides VCs that are in the certificate store.
+
+    The output is provided in a VCB, which includes a common header followed by zero
+    or more verification-certificate entries (VCEs).
+
+    The first-VC index and last-VC index fields of VCB specify the range of VCs
+    to be stored by subcode 2. Stored count and remained count fields specify the
+    number of VCs stored and could not be stored in the VCB due to insufficient
+    storage specified in the VCB input length field.
+
+    VCE contains various information of a VC from the CS.
include/hw/s390x/ipl/diag320.h +49 -0
index 6e4779c699..2af14b9f01 100644
@@ -12,19 +12,30 @@
 
  #define DIAG_320_SUBC_QUERY_ISM     0
  #define DIAG_320_SUBC_QUERY_VCSI    1
+#define DIAG_320_SUBC_STORE_VC      2
 
  #define DIAG_320_RC_OK              0x0001
  #define DIAG_320_RC_NOT_SUPPORTED   0x0102
  #define DIAG_320_RC_INVAL_VCSSB_LEN 0x0202
+#define DIAG_320_RC_INVAL_VCB_LEN   0x0204
+#define DIAG_320_RC_BAD_RANGE       0x0302
 
  #define DIAG_320_ISM_QUERY_SUBCODES 0x80000000
  #define DIAG_320_ISM_QUERY_VCSI     0x40000000
+#define DIAG_320_ISM_STORE_VC       0x20000000
 
  #define VCSSB_NO_VC     4
  #define VCSSB_MIN_LEN   128
  #define VCE_HEADER_LEN  128
+#define VCE_INVALID_LEN 72
  #define VCB_HEADER_LEN  64
 
+#define DIAG_320_VCE_FLAGS_VALID                0x80
+#define DIAG_320_VCE_KEYTYPE_SELF_DESCRIBING    0
+#define DIAG_320_VCE_KEYTYPE_ECDSA_P521         1
+#define DIAG_320_VCE_FORMAT_X509_DER            1
+#define DIAG_320_VCE_HASHTYPE_SHA2_256          1
+
  struct VCStorageSizeBlock {
      uint32_t length;
      uint8_t reserved0[3];
@@ -39,4 +50,42 @@ struct VCStorageSizeBlock {
  };
  typedef struct VCStorageSizeBlock VCStorageSizeBlock;
 
+struct VCBlock {
+    uint32_t in_len;
+    uint32_t reserved0;
+    uint16_t first_vc_index;
+    uint16_t last_vc_index;
+    uint32_t reserved1[5];
+    uint32_t out_len;
+    uint8_t reserved2[3];
+    uint8_t version;
+    uint16_t stored_ct;
+    uint16_t remain_ct;
+    uint32_t reserved3[5];
+    uint8_t vce_buf[];
+};
+typedef struct VCBlock VCBlock;
+
+struct VCEntry {
+    uint32_t len;
+    uint8_t flags;
+    uint8_t key_type;
+    uint16_t cert_idx;
+    uint32_t name[16];
+    uint8_t format;
+    uint8_t reserved0;
+    uint16_t keyid_len;
+    uint8_t reserved1;
+    uint8_t hash_type;
+    uint16_t hash_len;
+    uint32_t reserved2;
+    uint32_t cert_len;
+    uint32_t reserved3[2];
+    uint16_t hash_offset;
+    uint16_t cert_offset;
+    uint32_t reserved4[7];
+    uint8_t cert_buf[];
+};
+typedef struct VCEntry VCEntry;
+
  #endif
target/s390x/diag.c +54 -0
index 4e6de483b8..d5f6c54df3 100644
@@ -17,6 +17,7 @@
  #include "s390x-internal.h"
  #include "hw/watchdog/wdt_diag288.h"
  #include "system/cpus.h"
+#include "hw/s390x/cert-store.h"
  #include "hw/s390x/ipl.h"
  #include "hw/s390x/ipl/diag320.h"
  #include "hw/s390x/s390-virtio-ccw.h"
@@ -24,6 +25,7 @@
  #include "kvm/kvm_s390x.h"
  #include "target/s390x/kvm/pv.h"
  #include "qemu/error-report.h"
+#include "crypto/x509-utils.h"
 
 
  int handle_diag_288(CPUS390XState *env, uint64_t r1, uint64_t r3)
@@ -225,8 +227,308 @@ static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1,
      return DIAG_320_RC_OK;
  }
 
+static bool is_cert_valid(S390IPLCertificate cert)
+{
+    int rc;
+    Error *err = NULL;
+
+    rc = qcrypto_x509_check_cert_times(cert.raw, cert.size, &err);
+    if (rc != 0) {
+        error_report_err(err);
+        return false;
+    }
+
+    return true;
+}
+
+static void handle_key_id(VCEntry *vce, S390IPLCertificate cert)
+{
+    int rc;
+    g_autofree unsigned char *key_id_data = NULL;
+    size_t key_id_len;
+    Error *err = NULL;
+
+    key_id_len = CERT_KEY_ID_LEN;
+    /* key id and key id len */
+    rc = qcrypto_x509_get_cert_key_id(cert.raw, cert.size,
+                                      QCRYPTO_HASH_ALGO_SHA256,
+                                      &key_id_data, &key_id_len, &err);
+    if (rc < 0) {
+        error_report_err(err);
+        return;
+    }
+    vce->keyid_len = cpu_to_be16(key_id_len);
+
+    memcpy(vce->cert_buf, key_id_data, key_id_len);
+}
+
+static int handle_hash(VCEntry *vce, S390IPLCertificate cert, uint16_t keyid_field_len)
+{
+    int rc;
+    uint16_t hash_offset;
+    g_autofree void *hash_data = NULL;
+    size_t hash_len;
+    Error *err = NULL;
+
+    hash_len = CERT_HASH_LEN;
+    /* hash and hash len */
+    hash_data = g_malloc0(hash_len);
+    rc = qcrypto_get_x509_cert_fingerprint(cert.raw, cert.size,
+                                           QCRYPTO_HASH_ALGO_SHA256,
+                                           hash_data, &hash_len, &err);
+    if (rc < 0) {
+        error_report_err(err);
+        return -1;

target/s390x/diag.c static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1, · line 291

Quoted 10 lines
target/s390x/diag.c +10 -0
+    }
+    vce->hash_len = cpu_to_be16(hash_len);
+
+    /* hash type */
+    vce->hash_type = DIAG_320_VCE_HASHTYPE_SHA2_256;
+
+    hash_offset = VCE_HEADER_LEN + keyid_field_len;
+    vce->hash_offset = cpu_to_be16(hash_offset);
+
+    memcpy((uint8_t *)vce + hash_offset, hash_data, hash_len);

Do we need any check here to make sure we are not going out of the bounds of vce buffer?

Quoted 14 lines
target/s390x/diag.c +14 -0
+
+    return 0;
+}
+
+static int handle_cert(VCEntry *vce, S390IPLCertificate cert, uint16_t hash_field_len)
+{
+    int rc;
+    uint16_t cert_offset;
+    g_autofree uint8_t *cert_der = NULL;
+    Error *err = NULL;
+
+    /* certificate in DER format */
+    rc = qcrypto_x509_convert_cert_der(cert.raw, cert.size,
+                                       &cert_der, &cert.der_size, &err);

target/s390x/diag.c static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1, · line 315

Quoted 10 lines
target/s390x/diag.c +10 -0
+    if (rc < 0) {
+        error_report_err(err);
+        return -1;
+    }
+    vce->format = DIAG_320_VCE_FORMAT_X509_DER;
+    vce->cert_len = cpu_to_be32(cert.der_size);
+    cert_offset = be16_to_cpu(vce->hash_offset) + hash_field_len;
+    vce->cert_offset = cpu_to_be16(cert_offset);
+
+    memcpy((uint8_t *)vce + cert_offset, cert_der, cert.der_size);

Similar to above, do we need any check here to make sure we are not going out of the bounds of vce buffer?

Quoted 67 lines
target/s390x/diag.c +67 -0
+
+    return 0;
+}
+
+static int get_key_type(S390IPLCertificate cert)
+{
+    int algo;
+    int rc;
+    Error *err = NULL;
+
+    /* public key algorithm */
+    algo = qcrypto_x509_get_pk_algorithm(cert.raw, cert.size, &err);
+    if (algo < 0) {
+        error_report_err(err);
+        return -1;
+    }
+
+    if (algo == QCRYPTO_PK_ALGO_ECDSA) {
+        rc = qcrypto_x509_is_ecc_curve_p521(cert.raw, cert.size, &err);
+        if (rc == -1) {
+            error_report_err(err);
+            return -1;
+        }
+
+        return (rc == 1) ? DIAG_320_VCE_KEYTYPE_ECDSA_P521 :
+                           DIAG_320_VCE_KEYTYPE_SELF_DESCRIBING;
+    }
+
+    return DIAG_320_VCE_KEYTYPE_SELF_DESCRIBING;
+}
+
+static int build_vce_header(VCEntry *vce, S390IPLCertificate cert, int idx)
+{
+    int key_type;
+
+    vce->len = cpu_to_be32(VCE_HEADER_LEN);
+    vce->cert_idx = cpu_to_be16(idx + 1);
+    strncpy((char *)vce->name, (char *)cert.vc_name, VC_NAME_LEN_BYTES);
+
+    key_type = get_key_type(cert);
+    if (key_type == -1) {
+        return -1;
+    }
+    vce->key_type = key_type;
+
+    return 0;
+}
+
+static int build_vce_data(VCEntry *vce, S390IPLCertificate cert)
+{
+    uint16_t keyid_field_len;
+    uint16_t hash_field_len;
+    uint32_t cert_field_len;
+    int rc;
+
+    handle_key_id(vce, cert);
+    /* vce key id field length - can be 0 if failed to retrieve */
+    keyid_field_len = ROUND_UP(be16_to_cpu(vce->keyid_len), 4);
+
+    rc = handle_hash(vce, cert, keyid_field_len);
+    if (rc) {
+        return -1;
+    }
+    hash_field_len = ROUND_UP(be16_to_cpu(vce->hash_len), 4);
+
+    rc = handle_cert(vce, cert, hash_field_len);
+    if (rc || !is_cert_valid(cert)) {

target/s390x/diag.c static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1, · line 392

Quoted 10 lines
target/s390x/diag.c +10 -0
+        return -1;
+    }
+    /* vce certificate field length */
+    cert_field_len = ROUND_UP(be32_to_cpu(vce->cert_len), 4);
+
+    /* The certificate is valid and VCE contains the certificate */
+    vce->flags |= DIAG_320_VCE_FLAGS_VALID;
+
+    /* Update vce length to reflect the acutal size used by vce */
+    vce->len += cpu_to_be32(keyid_field_len + hash_field_len + cert_field_len);

Should we validate the final vce->len calculated is <= vce_len?

Quoted 11 lines
target/s390x/diag.c +11 -0
+
+    return 0;
+}
+
+static VCEntry *diag_320_build_vce(S390IPLCertificate cert, uint32_t vce_len, int idx)
+{
+    g_autofree VCEntry *vce = NULL;
+    int rc;
+
+    /*
+     * Construct VCE

target/s390x/diag.c static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1, · line 413

Quoted 10 lines
target/s390x/diag.c +10 -0
+     * Allocate enough memory for all certificate data (key id, hash and certificate).
+     * Unused area following the VCE field contains zeros.
+     */
+    vce = g_malloc0(vce_len);
+    rc = build_vce_header(vce, cert, idx);
+    if (rc) {
+        vce->len = cpu_to_be32(VCE_INVALID_LEN);
+        goto out;
+    }
+    vce->len = cpu_to_be32(VCE_HEADER_LEN);

This is redundant as we already set vce->len to VCE_HEADER_LEN on successful call to build_vce_header. I think rather vce->len should be set to vce_len to make bounds checking easier in the helper functions.

Quoted 145 lines
target/s390x/diag.c +125 -1
+
+    rc = build_vce_data(vce, cert);
+    if (rc) {
+        vce->len = cpu_to_be32(VCE_INVALID_LEN);
+    }
+
+out:
+    return g_steal_pointer(&vce);
+}
+
+static int handle_diag320_store_vc(S390CPU *cpu, uint64_t addr, uint64_t r1, uintptr_t ra,
+                                   S390IPLCertificateStore *qcs)
+{
+    g_autofree VCBlock *vcb = NULL;
+    size_t vce_offset;
+    size_t remaining_space;
+    uint32_t vce_len;
+    uint16_t first_vc_index;
+    uint16_t last_vc_index;
+    uint32_t in_len;
+
+    vcb = g_new0(VCBlock, 1);
+    if (s390_cpu_virt_mem_read(cpu, addr, r1, vcb, sizeof(*vcb))) {
+        s390_cpu_virt_mem_handle_exc(cpu, ra);
+        return -1;
+    }
+
+    in_len = be32_to_cpu(vcb->in_len);
+    first_vc_index = be16_to_cpu(vcb->first_vc_index);
+    last_vc_index = be16_to_cpu(vcb->last_vc_index);
+
+    if (in_len % TARGET_PAGE_SIZE != 0) {
+        return DIAG_320_RC_INVAL_VCB_LEN;
+    }
+
+    if (first_vc_index > last_vc_index) {
+        return DIAG_320_RC_BAD_RANGE;
+    }
+
+    vcb->out_len = VCB_HEADER_LEN;
+
+    if (first_vc_index == 0) {
+        /*
+         * Zero is a valid index for the first and last VC index.
+         * Zero index results in the VCB header and zero certificates returned.
+         */
+        if (last_vc_index == 0) {
+            goto out;
+        }
+
+        /* DIAG320 certificate store remains a one origin for cert entries */
+        vcb->first_vc_index = 1;
+        first_vc_index = 1;
+    }
+
+    vce_offset = VCB_HEADER_LEN;
+    remaining_space = in_len - VCB_HEADER_LEN;
+
+    for (int i = first_vc_index - 1; i < last_vc_index && i < qcs->count; i++) {
+        VCEntry *vce;
+        S390IPLCertificate cert = qcs->certs[i];
+        /*
+         * Each VCE is word aligned.
+         * Each variable length field within the VCE is also word aligned.
+         */
+        vce_len = VCE_HEADER_LEN +
+                  ROUND_UP(CERT_KEY_ID_LEN, 4) +
+                  ROUND_UP(CERT_HASH_LEN, 4) +
+                  ROUND_UP(cert.der_size, 4);
+
+        /*
+         * If there is no more space to store the cert,
+         * set the remaining verification cert count and
+         * break early.
+         */
+        if (remaining_space < vce_len) {
+            vcb->remain_ct = cpu_to_be16(last_vc_index - i);
+            break;
+        }
+
+        vce = diag_320_build_vce(cert, vce_len, i);
+
+        /* Write VCE */
+        if (s390_cpu_virt_mem_write(cpu, addr + vce_offset, r1,
+                                    vce, be32_to_cpu(vce->len))) {
+            s390_cpu_virt_mem_handle_exc(cpu, ra);
+            g_free(vce);
+            return -1;
+        }
+
+        vce_offset += be32_to_cpu(vce->len);
+        vcb->out_len += be32_to_cpu(vce->len);
+        remaining_space -= be32_to_cpu(vce->len);
+        vcb->stored_ct++;
+
+        g_free(vce);
+    }
+    vcb->stored_ct = cpu_to_be16(vcb->stored_ct);
+
+out:
+    vcb->out_len = cpu_to_be32(vcb->out_len);
+    /*
+     * Write VCB header
+     * All VCEs have been populated with the latest information
+     * and write VCB header last.
+     */
+    if (s390_cpu_virt_mem_write(cpu, addr, r1, vcb, VCB_HEADER_LEN)) {
+        s390_cpu_virt_mem_handle_exc(cpu, ra);
+        return -1;
+    }
+
+    return DIAG_320_RC_OK;
+}
+
  QEMU_BUILD_BUG_MSG(sizeof(VCStorageSizeBlock) != VCSSB_MIN_LEN,
                     "size of VCStorageSizeBlock is wrong");
+QEMU_BUILD_BUG_MSG(sizeof(VCBlock) != VCB_HEADER_LEN, "size of VCBlock is wrong");
+QEMU_BUILD_BUG_MSG(sizeof(VCEntry) != VCE_HEADER_LEN, "size of VCEntry is wrong");
 
  void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
  {
@@ -259,7 +561,8 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
           * for now.
           */
          uint32_t ism_word0 = cpu_to_be32(DIAG_320_ISM_QUERY_SUBCODES |
-                                         DIAG_320_ISM_QUERY_VCSI);
+                                         DIAG_320_ISM_QUERY_VCSI |
+                                         DIAG_320_ISM_STORE_VC);
 
          if (s390_cpu_virt_mem_write(cpu, addr, r1, &ism_word0, sizeof(ism_word0))) {
              s390_cpu_virt_mem_handle_exc(cpu, ra);
@@ -285,6 +588,13 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
          }
          env->regs[r1 + 1] = rc;
          break;
+    case DIAG_320_SUBC_STORE_VC:
+        rc = handle_diag320_store_vc(cpu, addr, r1, ra, qcs);
+        if (rc == -1) {
+            return;
+        }
+        env->regs[r1 + 1] = rc;
+        break;
      default:
          env->regs[r1 + 1] = DIAG_320_RC_NOT_SUPPORTED;
          break;
#39 lore raw

Re: [PATCH v6 09/28] s390x/diag: Implement DIAG 320 subcode 2

Quoted 347 lines · Farhan Ali
Quoted 203 lines · Zhuoying Cai

DIAG 320 subcode 2 provides verification-certificates (VCs) that are in the certificate store. Only X509 certificates in DER format and SHA-256 hash type are recognized.

The subcode value is denoted by setting the second-left-most bit of an 8-byte field.

The Verification Certificate Block (VCB) contains the output data when the operation completes successfully. It includes a common header followed by zero or more Verification Certificate Entries (VCEs), depending on the VCB input length and the VC range (from the first VC index to the last VC index) in the certificate store.

Each VCE contains information about a certificate retrieved from the S390IPLCertificateStore, such as the certificate name, key type, key ID length, hash length, and the raw certificate data.
The key ID and hash are extracted from the raw certificate by the crypto API.

Note: SHA2-256 VC hash type is required for retrieving the hash (fingerprint) of the certificate.

---
  docs/specs/s390x-secure-ipl.rst |  13 ++
  include/hw/s390x/ipl/diag320.h  |  49 +++++
  target/s390x/diag.c             | 312 +++++++++++++++++++++++++++++++-
  3 files changed, 373 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +13 -0
index 4217f19c84..e28f0b40d7 100644
@@ -35,3 +35,16 @@ Subcode 1 - query verification certificate storage information
 
      The output is returned in the verification-certificate-storage-size block (VCSSB).
      A VCSSB length of 4 indicates that no certificates are available in the CS.
+
+Subcode 2 - store verification certificates
+    Provides VCs that are in the certificate store.
+
+    The output is provided in a VCB, which includes a common header followed by zero
+    or more verification-certificate entries (VCEs).
+
+    The first-VC index and last-VC index fields of VCB specify the range of VCs
+    to be stored by subcode 2. Stored count and remained count fields specify the
+    number of VCs stored and could not be stored in the VCB due to insufficient
+    storage specified in the VCB input length field.
+
+    VCE contains various information of a VC from the CS.
include/hw/s390x/ipl/diag320.h +49 -0
index 6e4779c699..2af14b9f01 100644
@@ -12,19 +12,30 @@
 
  #define DIAG_320_SUBC_QUERY_ISM     0
  #define DIAG_320_SUBC_QUERY_VCSI    1
+#define DIAG_320_SUBC_STORE_VC      2
 
  #define DIAG_320_RC_OK              0x0001
  #define DIAG_320_RC_NOT_SUPPORTED   0x0102
  #define DIAG_320_RC_INVAL_VCSSB_LEN 0x0202
+#define DIAG_320_RC_INVAL_VCB_LEN   0x0204
+#define DIAG_320_RC_BAD_RANGE       0x0302
 
  #define DIAG_320_ISM_QUERY_SUBCODES 0x80000000
  #define DIAG_320_ISM_QUERY_VCSI     0x40000000
+#define DIAG_320_ISM_STORE_VC       0x20000000
 
  #define VCSSB_NO_VC     4
  #define VCSSB_MIN_LEN   128
  #define VCE_HEADER_LEN  128
+#define VCE_INVALID_LEN 72
  #define VCB_HEADER_LEN  64
 
+#define DIAG_320_VCE_FLAGS_VALID                0x80
+#define DIAG_320_VCE_KEYTYPE_SELF_DESCRIBING    0
+#define DIAG_320_VCE_KEYTYPE_ECDSA_P521         1
+#define DIAG_320_VCE_FORMAT_X509_DER            1
+#define DIAG_320_VCE_HASHTYPE_SHA2_256          1
+
  struct VCStorageSizeBlock {
      uint32_t length;
      uint8_t reserved0[3];
@@ -39,4 +50,42 @@ struct VCStorageSizeBlock {
  };
  typedef struct VCStorageSizeBlock VCStorageSizeBlock;
 
+struct VCBlock {
+    uint32_t in_len;
+    uint32_t reserved0;
+    uint16_t first_vc_index;
+    uint16_t last_vc_index;
+    uint32_t reserved1[5];
+    uint32_t out_len;
+    uint8_t reserved2[3];
+    uint8_t version;
+    uint16_t stored_ct;
+    uint16_t remain_ct;
+    uint32_t reserved3[5];
+    uint8_t vce_buf[];
+};
+typedef struct VCBlock VCBlock;
+
+struct VCEntry {
+    uint32_t len;
+    uint8_t flags;
+    uint8_t key_type;
+    uint16_t cert_idx;
+    uint32_t name[16];
+    uint8_t format;
+    uint8_t reserved0;
+    uint16_t keyid_len;
+    uint8_t reserved1;
+    uint8_t hash_type;
+    uint16_t hash_len;
+    uint32_t reserved2;
+    uint32_t cert_len;
+    uint32_t reserved3[2];
+    uint16_t hash_offset;
+    uint16_t cert_offset;
+    uint32_t reserved4[7];
+    uint8_t cert_buf[];
+};
+typedef struct VCEntry VCEntry;
+
  #endif
target/s390x/diag.c +54 -0
index 4e6de483b8..d5f6c54df3 100644
@@ -17,6 +17,7 @@
  #include "s390x-internal.h"
  #include "hw/watchdog/wdt_diag288.h"
  #include "system/cpus.h"
+#include "hw/s390x/cert-store.h"
  #include "hw/s390x/ipl.h"
  #include "hw/s390x/ipl/diag320.h"
  #include "hw/s390x/s390-virtio-ccw.h"
@@ -24,6 +25,7 @@
  #include "kvm/kvm_s390x.h"
  #include "target/s390x/kvm/pv.h"
  #include "qemu/error-report.h"
+#include "crypto/x509-utils.h"
 
 
  int handle_diag_288(CPUS390XState *env, uint64_t r1, uint64_t r3)
@@ -225,8 +227,308 @@ static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1,
      return DIAG_320_RC_OK;
  }
 
+static bool is_cert_valid(S390IPLCertificate cert)
+{
+    int rc;
+    Error *err = NULL;
+
+    rc = qcrypto_x509_check_cert_times(cert.raw, cert.size, &err);
+    if (rc != 0) {
+        error_report_err(err);
+        return false;
+    }
+
+    return true;
+}
+
+static void handle_key_id(VCEntry *vce, S390IPLCertificate cert)
+{
+    int rc;
+    g_autofree unsigned char *key_id_data = NULL;
+    size_t key_id_len;
+    Error *err = NULL;
+
+    key_id_len = CERT_KEY_ID_LEN;
+    /* key id and key id len */
+    rc = qcrypto_x509_get_cert_key_id(cert.raw, cert.size,
+                                      QCRYPTO_HASH_ALGO_SHA256,
+                                      &key_id_data, &key_id_len, &err);
+    if (rc < 0) {
+        error_report_err(err);
+        return;
+    }
+    vce->keyid_len = cpu_to_be16(key_id_len);
+
+    memcpy(vce->cert_buf, key_id_data, key_id_len);
+}
+
+static int handle_hash(VCEntry *vce, S390IPLCertificate cert, uint16_t keyid_field_len)
+{
+    int rc;
+    uint16_t hash_offset;
+    g_autofree void *hash_data = NULL;
+    size_t hash_len;
+    Error *err = NULL;
+
+    hash_len = CERT_HASH_LEN;
+    /* hash and hash len */
+    hash_data = g_malloc0(hash_len);
+    rc = qcrypto_get_x509_cert_fingerprint(cert.raw, cert.size,
+                                           QCRYPTO_HASH_ALGO_SHA256,
+                                           hash_data, &hash_len, &err);
+    if (rc < 0) {
+        error_report_err(err);
+        return -1;

target/s390x/diag.c static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1, · line 291

Quoted 10 lines
target/s390x/diag.c +10 -0
+    }
+    vce->hash_len = cpu_to_be16(hash_len);
+
+    /* hash type */
+    vce->hash_type = DIAG_320_VCE_HASHTYPE_SHA2_256;
+
+    hash_offset = VCE_HEADER_LEN + keyid_field_len;
+    vce->hash_offset = cpu_to_be16(hash_offset);
+
+    memcpy((uint8_t *)vce + hash_offset, hash_data, hash_len);

Do we need any check here to make sure we are not going out of the bounds of vce buffer?

Quoted 14 lines
target/s390x/diag.c +14 -0
+
+    return 0;
+}
+
+static int handle_cert(VCEntry *vce, S390IPLCertificate cert, uint16_t hash_field_len)
+{
+    int rc;
+    uint16_t cert_offset;
+    g_autofree uint8_t *cert_der = NULL;
+    Error *err = NULL;
+
+    /* certificate in DER format */
+    rc = qcrypto_x509_convert_cert_der(cert.raw, cert.size,
+                                       &cert_der, &cert.der_size, &err);

target/s390x/diag.c static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1, · line 315

Quoted 10 lines
target/s390x/diag.c +10 -0
+    if (rc < 0) {
+        error_report_err(err);
+        return -1;
+    }
+    vce->format = DIAG_320_VCE_FORMAT_X509_DER;
+    vce->cert_len = cpu_to_be32(cert.der_size);
+    cert_offset = be16_to_cpu(vce->hash_offset) + hash_field_len;
+    vce->cert_offset = cpu_to_be16(cert_offset);
+
+    memcpy((uint8_t *)vce + cert_offset, cert_der, cert.der_size);

Similar to above, do we need any check here to make sure we are not going out of the bounds of vce buffer?

Quoted 67 lines
target/s390x/diag.c +67 -0
+
+    return 0;
+}
+
+static int get_key_type(S390IPLCertificate cert)
+{
+    int algo;
+    int rc;
+    Error *err = NULL;
+
+    /* public key algorithm */
+    algo = qcrypto_x509_get_pk_algorithm(cert.raw, cert.size, &err);
+    if (algo < 0) {
+        error_report_err(err);
+        return -1;
+    }
+
+    if (algo == QCRYPTO_PK_ALGO_ECDSA) {
+        rc = qcrypto_x509_is_ecc_curve_p521(cert.raw, cert.size, &err);
+        if (rc == -1) {
+            error_report_err(err);
+            return -1;
+        }
+
+        return (rc == 1) ? DIAG_320_VCE_KEYTYPE_ECDSA_P521 :
+                           DIAG_320_VCE_KEYTYPE_SELF_DESCRIBING;
+    }
+
+    return DIAG_320_VCE_KEYTYPE_SELF_DESCRIBING;
+}
+
+static int build_vce_header(VCEntry *vce, S390IPLCertificate cert, int idx)
+{
+    int key_type;
+
+    vce->len = cpu_to_be32(VCE_HEADER_LEN);
+    vce->cert_idx = cpu_to_be16(idx + 1);
+    strncpy((char *)vce->name, (char *)cert.vc_name, VC_NAME_LEN_BYTES);
+
+    key_type = get_key_type(cert);
+    if (key_type == -1) {
+        return -1;
+    }
+    vce->key_type = key_type;
+
+    return 0;
+}
+
+static int build_vce_data(VCEntry *vce, S390IPLCertificate cert)
+{
+    uint16_t keyid_field_len;
+    uint16_t hash_field_len;
+    uint32_t cert_field_len;
+    int rc;
+
+    handle_key_id(vce, cert);
+    /* vce key id field length - can be 0 if failed to retrieve */
+    keyid_field_len = ROUND_UP(be16_to_cpu(vce->keyid_len), 4);
+
+    rc = handle_hash(vce, cert, keyid_field_len);
+    if (rc) {
+        return -1;
+    }
+    hash_field_len = ROUND_UP(be16_to_cpu(vce->hash_len), 4);
+
+    rc = handle_cert(vce, cert, hash_field_len);
+    if (rc || !is_cert_valid(cert)) {

target/s390x/diag.c static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1, · line 392

Quoted 10 lines
target/s390x/diag.c +10 -0
+        return -1;
+    }
+    /* vce certificate field length */
+    cert_field_len = ROUND_UP(be32_to_cpu(vce->cert_len), 4);
+
+    /* The certificate is valid and VCE contains the certificate */
+    vce->flags |= DIAG_320_VCE_FLAGS_VALID;
+
+    /* Update vce length to reflect the acutal size used by vce */
+    vce->len += cpu_to_be32(keyid_field_len + hash_field_len + cert_field_len);

Should we validate the final vce->len calculated is <= vce_len?

Quoted 17 lines
target/s390x/diag.c +17 -0
+
+    return 0;
+}
+
+static VCEntry *diag_320_build_vce(S390IPLCertificate cert, uint32_t vce_len, int idx)
+{
+    g_autofree VCEntry *vce = NULL;
+    int rc;
+
+    /*
+     * Construct VCE
+     * Allocate enough memory for all certificate data (key id, hash and certificate).
+     * Unused area following the VCE field contains zeros.
+     */
+    vce = g_malloc0(vce_len);
+    rc = build_vce_header(vce, cert, idx);
+    if (rc) {
Quoted 9 lines

target/s390x/diag.c static int handle_diag320_query_vcsi(S390CPU *cpu, uint64_t addr, uint64_t r1, · line 413

Quoted 4 lines
target/s390x/diag.c +4 -0
+        vce->len = cpu_to_be32(VCE_INVALID_LEN);
+        goto out;
+    }
+    vce->len = cpu_to_be32(VCE_HEADER_LEN);

This is redundant as we already set vce->len to VCE_HEADER_LEN on successful call to build_vce_header. I think rather vce->len should be set to vce_len to make bounds checking easier in the helper functions.

Thanks for the feedback and for spotting the redundant code.

I'll add bounds checking in the next version.

Quoted 145 lines
Quoted 145 lines
target/s390x/diag.c +125 -1
+
+    rc = build_vce_data(vce, cert);
+    if (rc) {
+        vce->len = cpu_to_be32(VCE_INVALID_LEN);
+    }
+
+out:
+    return g_steal_pointer(&vce);
+}
+
+static int handle_diag320_store_vc(S390CPU *cpu, uint64_t addr, uint64_t r1, uintptr_t ra,
+                                   S390IPLCertificateStore *qcs)
+{
+    g_autofree VCBlock *vcb = NULL;
+    size_t vce_offset;
+    size_t remaining_space;
+    uint32_t vce_len;
+    uint16_t first_vc_index;
+    uint16_t last_vc_index;
+    uint32_t in_len;
+
+    vcb = g_new0(VCBlock, 1);
+    if (s390_cpu_virt_mem_read(cpu, addr, r1, vcb, sizeof(*vcb))) {
+        s390_cpu_virt_mem_handle_exc(cpu, ra);
+        return -1;
+    }
+
+    in_len = be32_to_cpu(vcb->in_len);
+    first_vc_index = be16_to_cpu(vcb->first_vc_index);
+    last_vc_index = be16_to_cpu(vcb->last_vc_index);
+
+    if (in_len % TARGET_PAGE_SIZE != 0) {
+        return DIAG_320_RC_INVAL_VCB_LEN;
+    }
+
+    if (first_vc_index > last_vc_index) {
+        return DIAG_320_RC_BAD_RANGE;
+    }
+
+    vcb->out_len = VCB_HEADER_LEN;
+
+    if (first_vc_index == 0) {
+        /*
+         * Zero is a valid index for the first and last VC index.
+         * Zero index results in the VCB header and zero certificates returned.
+         */
+        if (last_vc_index == 0) {
+            goto out;
+        }
+
+        /* DIAG320 certificate store remains a one origin for cert entries */
+        vcb->first_vc_index = 1;
+        first_vc_index = 1;
+    }
+
+    vce_offset = VCB_HEADER_LEN;
+    remaining_space = in_len - VCB_HEADER_LEN;
+
+    for (int i = first_vc_index - 1; i < last_vc_index && i < qcs->count; i++) {
+        VCEntry *vce;
+        S390IPLCertificate cert = qcs->certs[i];
+        /*
+         * Each VCE is word aligned.
+         * Each variable length field within the VCE is also word aligned.
+         */
+        vce_len = VCE_HEADER_LEN +
+                  ROUND_UP(CERT_KEY_ID_LEN, 4) +
+                  ROUND_UP(CERT_HASH_LEN, 4) +
+                  ROUND_UP(cert.der_size, 4);
+
+        /*
+         * If there is no more space to store the cert,
+         * set the remaining verification cert count and
+         * break early.
+         */
+        if (remaining_space < vce_len) {
+            vcb->remain_ct = cpu_to_be16(last_vc_index - i);
+            break;
+        }
+
+        vce = diag_320_build_vce(cert, vce_len, i);
+
+        /* Write VCE */
+        if (s390_cpu_virt_mem_write(cpu, addr + vce_offset, r1,
+                                    vce, be32_to_cpu(vce->len))) {
+            s390_cpu_virt_mem_handle_exc(cpu, ra);
+            g_free(vce);
+            return -1;
+        }
+
+        vce_offset += be32_to_cpu(vce->len);
+        vcb->out_len += be32_to_cpu(vce->len);
+        remaining_space -= be32_to_cpu(vce->len);
+        vcb->stored_ct++;
+
+        g_free(vce);
+    }
+    vcb->stored_ct = cpu_to_be16(vcb->stored_ct);
+
+out:
+    vcb->out_len = cpu_to_be32(vcb->out_len);
+    /*
+     * Write VCB header
+     * All VCEs have been populated with the latest information
+     * and write VCB header last.
+     */
+    if (s390_cpu_virt_mem_write(cpu, addr, r1, vcb, VCB_HEADER_LEN)) {
+        s390_cpu_virt_mem_handle_exc(cpu, ra);
+        return -1;
+    }
+
+    return DIAG_320_RC_OK;
+}
+
  QEMU_BUILD_BUG_MSG(sizeof(VCStorageSizeBlock) != VCSSB_MIN_LEN,
                     "size of VCStorageSizeBlock is wrong");
+QEMU_BUILD_BUG_MSG(sizeof(VCBlock) != VCB_HEADER_LEN, "size of VCBlock is wrong");
+QEMU_BUILD_BUG_MSG(sizeof(VCEntry) != VCE_HEADER_LEN, "size of VCEntry is wrong");
 
  void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
  {
@@ -259,7 +561,8 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
           * for now.
           */
          uint32_t ism_word0 = cpu_to_be32(DIAG_320_ISM_QUERY_SUBCODES |
-                                         DIAG_320_ISM_QUERY_VCSI);
+                                         DIAG_320_ISM_QUERY_VCSI |
+                                         DIAG_320_ISM_STORE_VC);
 
          if (s390_cpu_virt_mem_write(cpu, addr, r1, &ism_word0, sizeof(ism_word0))) {
              s390_cpu_virt_mem_handle_exc(cpu, ra);
@@ -285,6 +588,13 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
          }
          env->regs[r1 + 1] = rc;
          break;
+    case DIAG_320_SUBC_STORE_VC:
+        rc = handle_diag320_store_vc(cpu, addr, r1, ra, qcs);
+        if (rc == -1) {
+            return;
+        }
+        env->regs[r1 + 1] = rc;
+        break;
      default:
          env->regs[r1 + 1] = DIAG_320_RC_NOT_SUPPORTED;
          break;
#40 lore raw

PATCH v6 10/28 s390x/diag: Introduce DIAG 508 for secure IPL operations

In reply to Zhuoying Cai

From: Collin Walling <[email protected]>

In order to support secure IPL (aka secure boot) for the s390-ccw BIOS, a new s390 DIAGNOSE instruction is introduced to leverage QEMU for handling operations such as signature verification and certificate retrieval.

Currently, only subcode 0 is supported with this patch, which is used to query a bitmap of which subcodes are supported.

---
 docs/specs/s390x-secure-ipl.rst | 18 ++++++++++++++++++
 include/hw/s390x/ipl/diag508.h  | 15 +++++++++++++++
 target/s390x/diag.c             | 27 +++++++++++++++++++++++++++
 target/s390x/kvm/kvm.c          | 14 ++++++++++++++
 target/s390x/s390x-internal.h   |  2 ++
 target/s390x/tcg/misc_helper.c  |  7 +++++++
 6 files changed, 83 insertions(+)
 create mode 100644 include/hw/s390x/ipl/diag508.h
docs/specs/s390x-secure-ipl.rst +18 -0
index e28f0b40d7..0919425e9a 100644
@@ -48,3 +48,21 @@ Subcode 2 - store verification certificates
     storage specified in the VCB input length field.
 
     VCE contains various information of a VC from the CS.
+
+
+Secure IPL Data Structures, Facilities, and Functions
+=====================================================
+
+DIAGNOSE function code 'X'508' - KVM IPL extensions
+---------------------------------------------------
+
+DIAGNOSE 'X'508' is reserved for KVM guest use in order to facilitate
+communication of additional IPL operations that cannot be handled by userspace,
+such as signature verification for secure IPL.
+
+If the function code specifies 0x508, KVM IPL extension functions are performed.
+These functions are meant to provide extended functionality for s390 guest boot
+that requires assistance from QEMU.
+
+Subcode 0 - query installed subcodes
+    Returns a 64-bit mask indicating which subcodes are supported.
include/hw/s390x/ipl/diag508.h new file +15 -0
new file mode 100644
index 0000000000..6281ad8299
@@ -0,0 +1,15 @@
+/*
+ * S/390 DIAGNOSE 508 definitions and structures
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Collin Walling <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef S390X_DIAG508_H
+#define S390X_DIAG508_H
+
+#define DIAG_508_SUBC_QUERY_SUBC    0x0000
+
+#endif
target/s390x/diag.c +27 -0
index d5f6c54df3..ee64257dbc 100644
@@ -20,6 +20,7 @@
 #include "hw/s390x/cert-store.h"
 #include "hw/s390x/ipl.h"
 #include "hw/s390x/ipl/diag320.h"
+#include "hw/s390x/ipl/diag508.h"
 #include "hw/s390x/s390-virtio-ccw.h"
 #include "system/kvm.h"
 #include "kvm/kvm_s390x.h"
@@ -600,3 +601,29 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
         break;
     }
 }
+
+void handle_diag_508(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
+{
+    uint64_t subcode = env->regs[r3];
+    int rc;
+
+    if (env->psw.mask & PSW_MASK_PSTATE) {
+        s390_program_interrupt(env, PGM_PRIVILEGED, ra);
+        return;
+    }
+
+    if ((subcode & ~0x0ffffULL) || (r1 & 1)) {
+        s390_program_interrupt(env, PGM_SPECIFICATION, ra);
+        return;
+    }
+
+    switch (subcode) {
+    case DIAG_508_SUBC_QUERY_SUBC:
+        rc = 0;
+        break;
+    default:
+        s390_program_interrupt(env, PGM_SPECIFICATION, ra);
+        return;
+    }
+    env->regs[r1 + 1] = rc;
+}
target/s390x/kvm/kvm.c +14 -0
index 5510fc2fc5..ae6cd3d506 100644
@@ -101,6 +101,7 @@
 #define DIAG_CERT_STORE                 0x320
 #define DIAG_KVM_HYPERCALL              0x500
 #define DIAG_KVM_BREAKPOINT             0x501
+#define DIAG_SECURE_IPL                 0x508
 
 #define ICPT_INSTRUCTION                0x04
 #define ICPT_PROGRAM                    0x08
@@ -1571,6 +1572,16 @@ static void kvm_handle_diag_320(S390CPU *cpu, struct kvm_run *run)
     handle_diag_320(&cpu->env, r1, r3, RA_IGNORED);
 }
 
+static void kvm_handle_diag_508(S390CPU *cpu, struct kvm_run *run)
+{
+    uint64_t r1, r3;
+
+    r1 = (run->s390_sieic.ipa & 0x00f0) >> 4;
+    r3 = run->s390_sieic.ipa & 0x000f;
+
+    handle_diag_508(&cpu->env, r1, r3, RA_IGNORED);
+}
+
 #define DIAG_KVM_CODE_MASK 0x000000000000ffff
 
 static int handle_diag(S390CPU *cpu, struct kvm_run *run, uint32_t ipb)
@@ -1604,6 +1615,9 @@ static int handle_diag(S390CPU *cpu, struct kvm_run *run, uint32_t ipb)
     case DIAG_CERT_STORE:
         kvm_handle_diag_320(cpu, run);
         break;
+    case DIAG_SECURE_IPL:
+        kvm_handle_diag_508(cpu, run);
+        break;
     default:
         trace_kvm_insn_diag(func_code);
         kvm_s390_program_interrupt(cpu, PGM_SPECIFICATION);
target/s390x/s390x-internal.h +2 -0
index ecff2d07a1..7cca8a67de 100644
@@ -393,6 +393,8 @@ void handle_diag_308(CPUS390XState *env, uint64_t r1, uint64_t r3,
                      uintptr_t ra);
 void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3,
                      uintptr_t ra);
+void handle_diag_508(CPUS390XState *env, uint64_t r1, uint64_t r3,
+                     uintptr_t ra);
 
 
 /* translate.c */
target/s390x/tcg/misc_helper.c +7 -0
index 412c34ed93..ddbf495118 100644
@@ -149,6 +149,13 @@ void HELPER(diag)(CPUS390XState *env, uint32_t r1, uint32_t r3, uint32_t num)
         bql_unlock();
         r = 0;
         break;
+    case 0x508:
+        /* secure ipl operations */
+        bql_lock();
+        handle_diag_508(env, r1, r3, GETPC());
+        bql_unlock();
+        r = 0;
+        break;
     default:
         r = -1;
         break;
Signature · 1 line
2.50.1
Reviewed-by on v6 10/28
#41 lore raw

Re: [PATCH v6 10/28] s390x/diag: Introduce DIAG 508 for secure IPL operations

Quoted 180 lines · Zhuoying Cai

From: Collin Walling <[email protected]>

In order to support secure IPL (aka secure boot) for the s390-ccw BIOS, a new s390 DIAGNOSE instruction is introduced to leverage QEMU for handling operations such as signature verification and certificate retrieval.

Currently, only subcode 0 is supported with this patch, which is used to query a bitmap of which subcodes are supported.

---
  docs/specs/s390x-secure-ipl.rst | 18 ++++++++++++++++++
  include/hw/s390x/ipl/diag508.h  | 15 +++++++++++++++
  target/s390x/diag.c             | 27 +++++++++++++++++++++++++++
  target/s390x/kvm/kvm.c          | 14 ++++++++++++++
  target/s390x/s390x-internal.h   |  2 ++
  target/s390x/tcg/misc_helper.c  |  7 +++++++
  6 files changed, 83 insertions(+)

create mode 100644 include/hw/s390x/ipl/diag508.h

docs/specs/s390x-secure-ipl.rst +18 -0
index e28f0b40d7..0919425e9a 100644
@@ -48,3 +48,21 @@ Subcode 2 - store verification certificates
      storage specified in the VCB input length field.
 
      VCE contains various information of a VC from the CS.
+
+
+Secure IPL Data Structures, Facilities, and Functions
+=====================================================
+
+DIAGNOSE function code 'X'508' - KVM IPL extensions
+---------------------------------------------------
+
+DIAGNOSE 'X'508' is reserved for KVM guest use in order to facilitate
+communication of additional IPL operations that cannot be handled by userspace,
+such as signature verification for secure IPL.
+
+If the function code specifies 0x508, KVM IPL extension functions are performed.
+These functions are meant to provide extended functionality for s390 guest boot
+that requires assistance from QEMU.
+
+Subcode 0 - query installed subcodes
+    Returns a 64-bit mask indicating which subcodes are supported.
include/hw/s390x/ipl/diag508.h new file +15 -0
new file mode 100644
index 0000000000..6281ad8299
@@ -0,0 +1,15 @@
+/*
+ * S/390 DIAGNOSE 508 definitions and structures
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Collin Walling <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef S390X_DIAG508_H
+#define S390X_DIAG508_H
+
+#define DIAG_508_SUBC_QUERY_SUBC    0x0000
+
+#endif
target/s390x/diag.c +27 -0
index d5f6c54df3..ee64257dbc 100644
@@ -20,6 +20,7 @@
  #include "hw/s390x/cert-store.h"
  #include "hw/s390x/ipl.h"
  #include "hw/s390x/ipl/diag320.h"
+#include "hw/s390x/ipl/diag508.h"
  #include "hw/s390x/s390-virtio-ccw.h"
  #include "system/kvm.h"
  #include "kvm/kvm_s390x.h"
@@ -600,3 +601,29 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
          break;
      }
  }
+
+void handle_diag_508(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
+{
+    uint64_t subcode = env->regs[r3];
+    int rc;
+
+    if (env->psw.mask & PSW_MASK_PSTATE) {
+        s390_program_interrupt(env, PGM_PRIVILEGED, ra);
+        return;
+    }
+
+    if ((subcode & ~0x0ffffULL) || (r1 & 1)) {
+        s390_program_interrupt(env, PGM_SPECIFICATION, ra);
+        return;
+    }
+
+    switch (subcode) {
+    case DIAG_508_SUBC_QUERY_SUBC:
+        rc = 0;
+        break;
+    default:
+        s390_program_interrupt(env, PGM_SPECIFICATION, ra);
+        return;
+    }
+    env->regs[r1 + 1] = rc;
+}
target/s390x/kvm/kvm.c +14 -0
index 5510fc2fc5..ae6cd3d506 100644
@@ -101,6 +101,7 @@
  #define DIAG_CERT_STORE                 0x320
  #define DIAG_KVM_HYPERCALL              0x500
  #define DIAG_KVM_BREAKPOINT             0x501
+#define DIAG_SECURE_IPL                 0x508
 
  #define ICPT_INSTRUCTION                0x04
  #define ICPT_PROGRAM                    0x08
@@ -1571,6 +1572,16 @@ static void kvm_handle_diag_320(S390CPU *cpu, struct kvm_run *run)
      handle_diag_320(&cpu->env, r1, r3, RA_IGNORED);
  }
 
+static void kvm_handle_diag_508(S390CPU *cpu, struct kvm_run *run)
+{
+    uint64_t r1, r3;
+
+    r1 = (run->s390_sieic.ipa & 0x00f0) >> 4;
+    r3 = run->s390_sieic.ipa & 0x000f;
+
+    handle_diag_508(&cpu->env, r1, r3, RA_IGNORED);
+}
+
  #define DIAG_KVM_CODE_MASK 0x000000000000ffff
 
  static int handle_diag(S390CPU *cpu, struct kvm_run *run, uint32_t ipb)
@@ -1604,6 +1615,9 @@ static int handle_diag(S390CPU *cpu, struct kvm_run *run, uint32_t ipb)
      case DIAG_CERT_STORE:
          kvm_handle_diag_320(cpu, run);
          break;
+    case DIAG_SECURE_IPL:
+        kvm_handle_diag_508(cpu, run);
+        break;
      default:
          trace_kvm_insn_diag(func_code);
          kvm_s390_program_interrupt(cpu, PGM_SPECIFICATION);
target/s390x/s390x-internal.h +2 -0
index ecff2d07a1..7cca8a67de 100644
@@ -393,6 +393,8 @@ void handle_diag_308(CPUS390XState *env, uint64_t r1, uint64_t r3,
                       uintptr_t ra);
  void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3,
                       uintptr_t ra);
+void handle_diag_508(CPUS390XState *env, uint64_t r1, uint64_t r3,
+                     uintptr_t ra);
 
 
  /* translate.c */
target/s390x/tcg/misc_helper.c +7 -0
index 412c34ed93..ddbf495118 100644
@@ -149,6 +149,13 @@ void HELPER(diag)(CPUS390XState *env, uint32_t r1, uint32_t r3, uint32_t num)
          bql_unlock();
          r = 0;
          break;
+    case 0x508:
+        /* secure ipl operations */
+        bql_lock();
+        handle_diag_508(env, r1, r3, GETPC());
+        bql_unlock();
+        r = 0;
+        break;
      default:
          r = -1;
          break;
#42 lore raw

Re: [PATCH v6 10/28] s390x/diag: Introduce DIAG 508 for secure IPL operations

In reply to Zhuoying Cai
Quoted 37 lines · Zhuoying Cai

From: Collin Walling <[email protected]>

In order to support secure IPL (aka secure boot) for the s390-ccw BIOS, a new s390 DIAGNOSE instruction is introduced to leverage QEMU for handling operations such as signature verification and certificate retrieval.

Currently, only subcode 0 is supported with this patch, which is used to query a bitmap of which subcodes are supported.

---
  docs/specs/s390x-secure-ipl.rst | 18 ++++++++++++++++++
  include/hw/s390x/ipl/diag508.h  | 15 +++++++++++++++
  target/s390x/diag.c             | 27 +++++++++++++++++++++++++++
  target/s390x/kvm/kvm.c          | 14 ++++++++++++++
  target/s390x/s390x-internal.h   |  2 ++
  target/s390x/tcg/misc_helper.c  |  7 +++++++
  6 files changed, 83 insertions(+)

create mode 100644 include/hw/s390x/ipl/diag508.h

docs/specs/s390x-secure-ipl.rst +8 -0
index e28f0b40d7..0919425e9a 100644
@@ -48,3 +48,21 @@ Subcode 2 - store verification certificates
      storage specified in the VCB input length field.
 
      VCE contains various information of a VC from the CS.
+
+
+Secure IPL Data Structures, Facilities, and Functions
+=====================================================
+
+DIAGNOSE function code 'X'508' - KVM IPL extensions
+---------------------------------------------------
+

docs/specs/s390x-secure-ipl.rst Subcode 2 - store verification certificates · line 68

Quoted 10 lines
docs/specs/s390x-secure-ipl.rst +10 -0
+DIAGNOSE 'X'508' is reserved for KVM guest use in order to facilitate
+communication of additional IPL operations that cannot be handled by userspace,
+such as signature verification for secure IPL.
+
+If the function code specifies 0x508, KVM IPL extension functions are performed.
+These functions are meant to provide extended functionality for s390 guest boot
+that requires assistance from QEMU.
+
+Subcode 0 - query installed subcodes
+    Returns a 64-bit mask indicating which subcodes are supported.

Technically, this works also without KVM, right? In that case, I'd maybe avoid the term "KVM" here, and just talk about "IPL extensions" and "guest", to avoid the confusion about whether this feature can be used with TCG, too, or not.

Thomas

#43 lore raw

Re: [PATCH v6 10/28] s390x/diag: Introduce DIAG 508 for secure IPL operations

Quoted 54 lines · Thomas Huth
Quoted 37 lines · Zhuoying Cai

From: Collin Walling <[email protected]>

In order to support secure IPL (aka secure boot) for the s390-ccw BIOS, a new s390 DIAGNOSE instruction is introduced to leverage QEMU for handling operations such as signature verification and certificate retrieval.

Currently, only subcode 0 is supported with this patch, which is used to query a bitmap of which subcodes are supported.

---
  docs/specs/s390x-secure-ipl.rst | 18 ++++++++++++++++++
  include/hw/s390x/ipl/diag508.h  | 15 +++++++++++++++
  target/s390x/diag.c             | 27 +++++++++++++++++++++++++++
  target/s390x/kvm/kvm.c          | 14 ++++++++++++++
  target/s390x/s390x-internal.h   |  2 ++
  target/s390x/tcg/misc_helper.c  |  7 +++++++
  6 files changed, 83 insertions(+)

create mode 100644 include/hw/s390x/ipl/diag508.h

docs/specs/s390x-secure-ipl.rst +8 -0
index e28f0b40d7..0919425e9a 100644
@@ -48,3 +48,21 @@ Subcode 2 - store verification certificates
      storage specified in the VCB input length field.
 
      VCE contains various information of a VC from the CS.
+
+
+Secure IPL Data Structures, Facilities, and Functions
+=====================================================
+
+DIAGNOSE function code 'X'508' - KVM IPL extensions
+---------------------------------------------------
+

docs/specs/s390x-secure-ipl.rst Subcode 2 - store verification certificates · line 68

Quoted 10 lines
docs/specs/s390x-secure-ipl.rst +10 -0
+DIAGNOSE 'X'508' is reserved for KVM guest use in order to facilitate
+communication of additional IPL operations that cannot be handled by userspace,
+such as signature verification for secure IPL.
+
+If the function code specifies 0x508, KVM IPL extension functions are performed.
+These functions are meant to provide extended functionality for s390 guest boot
+that requires assistance from QEMU.
+
+Subcode 0 - query installed subcodes
+    Returns a 64-bit mask indicating which subcodes are supported.

Technically, this works also without KVM, right? In that case, I'd maybe avoid the term "KVM" here, and just talk about "IPL extensions" and "guest", to avoid the confusion about whether this feature can be used with TCG, too, or not.

Quoted 3 lines

Thomas

Fair enough. None of the secure IPL code leverages KVM, so we can reword the document a bit.

Signature · 2 lines
Regards,
  Collin
#44 lore raw

PATCH v6 11/28 crypto/x509-utils: Add helper functions for DIAG 508 subcode 1

In reply to Zhuoying Cai

Introduce helper functions to support signature verification required by DIAG 508 subcode 1:

qcrypto_pkcs7_convert_sig_pem() – converts a signature from DER to PEM format qcrypto_x509_verify_sig() – verifies the provided data against the given signature

These functions enable basic signature verification support.

---
 crypto/x509-utils.c         | 109 ++++++++++++++++++++++++++++++++++++
 include/crypto/x509-utils.h |  39 +++++++++++++
 2 files changed, 148 insertions(+)
crypto/x509-utils.c +109 -0
index 763eccb190..8f3c895d7c 100644
@@ -16,6 +16,7 @@
 #include <gnutls/gnutls.h>
 #include <gnutls/crypto.h>
 #include <gnutls/x509.h>
+#include <gnutls/pkcs7.h>
 
 static const int qcrypto_to_gnutls_hash_alg_map[QCRYPTO_HASH_ALGO__MAX] = {
     [QCRYPTO_HASH_ALGO_MD5] = GNUTLS_DIG_MD5,
@@ -342,6 +343,97 @@ int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp)
     return 0;
 }
 
+int qcrypto_pkcs7_convert_sig_pem(uint8_t *sig, size_t sig_size,
+                                  uint8_t **result, size_t *resultlen,
+                                  Error **errp)
+{
+    int ret = -1;
+    int rc;
+    gnutls_pkcs7_t signature;
+    gnutls_datum_t sig_datum_der = {.data = sig, .size = sig_size};
+    gnutls_datum_t sig_datum_pem = {.data = NULL, .size = 0};
+
+    rc = gnutls_pkcs7_init(&signature);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initalize pkcs7 data: %s", gnutls_strerror(rc));
+        return ret;
+     }
+
+    rc = gnutls_pkcs7_import(signature, &sig_datum_der, GNUTLS_X509_FMT_DER);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import signature: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_pkcs7_export2(signature, GNUTLS_X509_FMT_PEM, &sig_datum_pem);
+    if (rc != 0) {
+        error_setg(errp, "Failed to convert signature to PEM format: %s",
+                   gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_new0(uint8_t, sig_datum_pem.size);
+    *resultlen = sig_datum_pem.size;
+    memcpy(*result, sig_datum_pem.data, sig_datum_pem.size);
+
+    ret = 0;
+
+cleanup:
+    gnutls_pkcs7_deinit(signature);
+    gnutls_free(sig_datum_pem.data);
+    return ret;
+}
+
+int qcrypto_x509_verify_sig(uint8_t *cert, size_t cert_size,
+                            uint8_t *comp, size_t comp_size,
+                            uint8_t *sig, size_t sig_size, Error **errp)
+{
+    int rc;
+    int ret = -1;
+    gnutls_x509_crt_t crt = NULL;
+    gnutls_pkcs7_t signature = NULL;
+    gnutls_datum_t cert_datum = {.data = cert, .size = cert_size};
+    gnutls_datum_t data_datum = {.data = comp, .size = comp_size};
+    gnutls_datum_t sig_datum = {.data = sig, .size = sig_size};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_x509_crt_import(crt, &cert_datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_pkcs7_init(&signature);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initalize pkcs7 data: %s", gnutls_strerror(rc));
+        goto cleanup;
+     }
+
+    rc = gnutls_pkcs7_import(signature, &sig_datum , GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import signature: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_pkcs7_verify_direct(signature, crt, 0, &data_datum, 0);
+    if (rc != 0) {
+        error_setg(errp, "Failed to verify signature: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    gnutls_pkcs7_deinit(signature);
+    return ret;
+}
+
 #else /* ! CONFIG_GNUTLS */
 
 int qcrypto_get_x509_cert_fingerprint(uint8_t *cert, size_t size,
@@ -391,4 +483,21 @@ int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp)
     return -1;
 }
 
+int qcrypto_pkcs7_convert_sig_pem(uint8_t *sig, size_t sig_size,
+                                  uint8_t **result,
+                                  size_t *resultlen,
+                                  Error **errp)
+{
+    error_setg(errp, "GNUTLS is required to export pkcs7 signature");
+    return -1;
+}
+
+int qcrypto_x509_verify_sig(uint8_t *cert, size_t cert_size,
+                            uint8_t *comp, size_t comp_size,
+                            uint8_t *sig, size_t sig_size, Error **errp)
+{
+    error_setg(errp, "GNUTLS is required for signature-verification support");
+    return -1;
+}
+
 #endif /* ! CONFIG_GNUTLS */
include/crypto/x509-utils.h +39 -0
index 6fc8d982b7..43a3dbb7a9 100644
@@ -111,4 +111,43 @@ int qcrypto_x509_get_cert_key_id(uint8_t *cert, size_t size,
  */
 int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp);
 
+/**
+ * qcrypto_pkcs7_convert_sig_pem
+ * @sig: pointer to the PKCS#7 signature in DER format
+ * @sig_size: size of the signature
+ * @result: output location for the allocated buffer for the signature in PEM format
+            (the function allocates memory which must be freed by the caller)
+ * @resultlen: pointer to the size of the buffer
+               (will be updated with the actual size of the PEM-encoded signature)
+ * @errp: error pointer
+ *
+ * Convert given PKCS#7 @sig from DER to PEM format.
+ *
+ * Returns: 0 if PEM-encoded signature was successfully stored in @result,
+ *         -1 on error.
+ */
+int qcrypto_pkcs7_convert_sig_pem(uint8_t *sig, size_t sig_size,
+                                  uint8_t **result,
+                                  size_t *resultlen,
+                                  Error **errp);
+
+/**
+ * qcrypto_x509_verify_sig
+ * @cert: pointer to the raw certificate data
+ * @cert_size: size of the certificate
+ * @comp: pointer to the component to be verified
+ * @comp_size: size of the component
+ * @sig: pointer to the signature
+ * @sig_size: size of the signature
+ * @errp: error pointer
+ *
+ * Verify the provided @comp against the @sig and @cert.
+ *
+ * Returns: 0 on success,
+ *         -1 on error.
+ */
+int qcrypto_x509_verify_sig(uint8_t *cert, size_t cert_size,
+                            uint8_t *comp, size_t comp_size,
+                            uint8_t *sig, size_t sig_size, Error **errp);
+
 #endif
Signature · 1 line
2.50.1
#45 lore raw

Re: [PATCH v6 11/28] crypto/x509-utils: Add helper functions for DIAG 508 subcode 1

Quoted 35 lines · Zhuoying Cai

Introduce helper functions to support signature verification required by DIAG 508 subcode 1:

qcrypto_pkcs7_convert_sig_pem() – converts a signature from DER to PEM format qcrypto_x509_verify_sig() – verifies the provided data against the given signature

These functions enable basic signature verification support.

---
  crypto/x509-utils.c         | 109 ++++++++++++++++++++++++++++++++++++
  include/crypto/x509-utils.h |  39 +++++++++++++
  2 files changed, 148 insertions(+)
crypto/x509-utils.c +6 -0
index 763eccb190..8f3c895d7c 100644
@@ -16,6 +16,7 @@
  #include <gnutls/gnutls.h>
  #include <gnutls/crypto.h>
  #include <gnutls/x509.h>
+#include <gnutls/pkcs7.h>
 
  static const int qcrypto_to_gnutls_hash_alg_map[QCRYPTO_HASH_ALGO__MAX] = {
      [QCRYPTO_HASH_ALGO_MD5] = GNUTLS_DIG_MD5,
@@ -342,6 +343,97 @@ int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp)
      return 0;
  }
 
+int qcrypto_pkcs7_convert_sig_pem(uint8_t *sig, size_t sig_size,
+                                  uint8_t **result, size_t *resultlen,
+                                  Error **errp)
+{
+    int ret = -1;

crypto/x509-utils.c int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp) · line 360

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    int rc;
+    gnutls_pkcs7_t signature;
+    gnutls_datum_t sig_datum_der = {.data = sig, .size = sig_size};
+    gnutls_datum_t sig_datum_pem = {.data = NULL, .size = 0};
+
+    rc = gnutls_pkcs7_init(&signature);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initalize pkcs7 data: %s", gnutls_strerror(rc));
+        return ret;
+     }

Indentation of the "}" is off by one.

Quoted 6 lines
crypto/x509-utils.c +6 -0
+    rc = gnutls_pkcs7_import(signature, &sig_datum_der, GNUTLS_X509_FMT_DER);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import signature: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+

crypto/x509-utils.c int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp) · line 377

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    rc = gnutls_pkcs7_export2(signature, GNUTLS_X509_FMT_PEM, &sig_datum_pem);
+    if (rc != 0) {
+        error_setg(errp, "Failed to convert signature to PEM format: %s",
+                   gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    *result = g_new0(uint8_t, sig_datum_pem.size);
+    *resultlen = sig_datum_pem.size;
+    memcpy(*result, sig_datum_pem.data, sig_datum_pem.size);

I think you could replace the g_new0 + memcpy with a g_memdup2() here.

Quoted 14 lines
crypto/x509-utils.c +14 -0
+    ret = 0;
+
+cleanup:
+    gnutls_pkcs7_deinit(signature);
+    gnutls_free(sig_datum_pem.data);
+    return ret;
+}
+
+int qcrypto_x509_verify_sig(uint8_t *cert, size_t cert_size,
+                            uint8_t *comp, size_t comp_size,
+                            uint8_t *sig, size_t sig_size, Error **errp)
+{
+    int rc;
+    int ret = -1;

crypto/x509-utils.c int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp) · line 402

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    gnutls_x509_crt_t crt = NULL;
+    gnutls_pkcs7_t signature = NULL;
+    gnutls_datum_t cert_datum = {.data = cert, .size = cert_size};
+    gnutls_datum_t data_datum = {.data = comp, .size = comp_size};
+    gnutls_datum_t sig_datum = {.data = sig, .size = sig_size};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        goto cleanup;

So if you go to cleanup here, signature is still NULL ...

Quoted 21 lines
crypto/x509-utils.c +21 -0
+    }
+
+    rc = gnutls_x509_crt_import(crt, &cert_datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_pkcs7_init(&signature);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initalize pkcs7 data: %s", gnutls_strerror(rc));
+        goto cleanup;
+     }
+
+    rc = gnutls_pkcs7_import(signature, &sig_datum , GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import signature: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_pkcs7_verify_direct(signature, crt, 0, &data_datum, 0);

crypto/x509-utils.c int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp) · line 433

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    if (rc != 0) {
+        error_setg(errp, "Failed to verify signature: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    ret = 0;
+
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    gnutls_pkcs7_deinit(signature);

... did you check whether gnutls_pkcs7_deinit() is able to deal with NULL pointers? The man-page does not mention it ... so just to be on the save side, maybe it would be better to have to cleanup labels, and only do the gnutls_pkcs7_deinit() if it has been initialized before?

crypto/x509-utils.c int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp) · line 433

Quoted 2 lines
crypto/x509-utils.c +2 -0
+    return ret;
+}

Thomas

#46 lore raw

Re: [PATCH v6 11/28] crypto/x509-utils: Add helper functions for DIAG 508 subcode 1

Quoted 68 lines · Thomas Huth
Quoted 26 lines · Zhuoying Cai

Introduce helper functions to support signature verification required by DIAG 508 subcode 1:

qcrypto_pkcs7_convert_sig_pem() – converts a signature from DER to PEM format qcrypto_x509_verify_sig() – verifies the provided data against the given signature

These functions enable basic signature verification support.

---
  crypto/x509-utils.c         | 109 ++++++++++++++++++++++++++++++++++++
  include/crypto/x509-utils.h |  39 +++++++++++++
  2 files changed, 148 insertions(+)
crypto/x509-utils.c +6 -0
index 763eccb190..8f3c895d7c 100644
 
 
+int qcrypto_x509_verify_sig(uint8_t *cert, size_t cert_size,
+                            uint8_t *comp, size_t comp_size,
+                            uint8_t *sig, size_t sig_size, Error **errp)
+{
+    int rc;
+    int ret = -1;

crypto/x509-utils.c int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp) · line 402

Quoted 10 lines
crypto/x509-utils.c +10 -0
+    gnutls_x509_crt_t crt = NULL;
+    gnutls_pkcs7_t signature = NULL;
+    gnutls_datum_t cert_datum = {.data = cert, .size = cert_size};
+    gnutls_datum_t data_datum = {.data = comp, .size = comp_size};
+    gnutls_datum_t sig_datum = {.data = sig, .size = sig_size};
+
+    rc = gnutls_x509_crt_init(&crt);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initialize certificate: %s", gnutls_strerror(rc));
+        goto cleanup;

So if you go to cleanup here, signature is still NULL ...

Quoted 28 lines
crypto/x509-utils.c +28 -0
+    }
+
+    rc = gnutls_x509_crt_import(crt, &cert_datum, GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import certificate: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_pkcs7_init(&signature);
+    if (rc < 0) {
+        error_setg(errp, "Failed to initalize pkcs7 data: %s", gnutls_strerror(rc));
+        goto cleanup;
+     }
+
+    rc = gnutls_pkcs7_import(signature, &sig_datum , GNUTLS_X509_FMT_PEM);
+    if (rc != 0) {
+        error_setg(errp, "Failed to import signature: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    rc = gnutls_pkcs7_verify_direct(signature, crt, 0, &data_datum, 0);
+    if (rc != 0) {
+        error_setg(errp, "Failed to verify signature: %s", gnutls_strerror(rc));
+        goto cleanup;
+    }
+
+    ret = 0;
+
Quoted 8 lines

crypto/x509-utils.c int qcrypto_x509_is_ecc_curve_p521(uint8_t *cert, size_t size, Error **errp) · line 433

Quoted 3 lines
crypto/x509-utils.c +3 -0
+cleanup:
+    gnutls_x509_crt_deinit(crt);
+    gnutls_pkcs7_deinit(signature);

... did you check whether gnutls_pkcs7_deinit() is able to deal with NULL pointers? The man-page does not mention it ... so just to be on the save side, maybe it would be better to have to cleanup labels, and only do the gnutls_pkcs7_deinit() if it has been initialized before?

All gnutls APIs for free'ing objects accept NULL and act as a no-op, so we're ok.

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#47 lore raw

PATCH v6 12/28 s390x/diag: Implement DIAG 508 subcode 1 for signature verification

In reply to Zhuoying Cai

From: Collin Walling <[email protected]>

DIAG 508 subcode 1 performs signature-verification on signed components. A signed component may be a Linux kernel image, or any other signed binary. **Verification of initrd is not supported.**

The instruction call expects two item-pairs: an address of a device component, an address of the analogous signature file (in PKCS#7 DER format), and their respective lengths. All of this data should be encapsulated within a Diag508SigVerifBlock.

The DIAG handler will read from the provided addresses to retrieve the necessary data, parse the signature file, then perform the signature-verification. Because there is no way to correlate a specific certificate to a component, each certificate in the store is tried until either verification succeeds, or all certs have been exhausted.

The subcode value is denoted by setting the second-to-left-most bit of a 2-byte field.

A return code of 1 indicates success, and the index and length of the corresponding certificate will be set in the Diag508SigVerifBlock. The following values indicate failure:

	0x0102: certificate not available
	0x0202: component data is invalid
	0x0302: signature is not in PKCS#7 format
	0x0402: signature-verification failed
	0x0502: length of Diag508SigVerifBlock is invalid
---
 docs/specs/s390x-secure-ipl.rst |   5 ++
 include/hw/s390x/ipl/diag508.h  |  23 +++++++
 target/s390x/diag.c             | 115 +++++++++++++++++++++++++++++++-
 3 files changed, 142 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +5 -0
index 0919425e9a..eec368d17b 100644
@@ -66,3 +66,8 @@ that requires assistance from QEMU.
 
 Subcode 0 - query installed subcodes
     Returns a 64-bit mask indicating which subcodes are supported.
+
+Subcode 1 - perform signature verification
+    Perform signature-verification on a signed component, using certificates
+    from the certificate store and leveraging qcrypto libraries to perform
+    this operation.
include/hw/s390x/ipl/diag508.h +23 -0
index 6281ad8299..ad401cc867 100644
@@ -11,5 +11,28 @@
 #define S390X_DIAG508_H
 
 #define DIAG_508_SUBC_QUERY_SUBC    0x0000
+#define DIAG_508_SUBC_SIG_VERIF     0x8000
+
+#define DIAG_508_RC_OK              0x0001
+#define DIAG_508_RC_NO_CERTS        0x0102
+#define DIAG_508_RC_INVAL_COMP_DATA 0x0202
+#define DIAG_508_RC_INVAL_PKCS7_SIG 0x0302
+#define DIAG_508_RC_FAIL_VERIF      0x0402
+#define DIAG_508_RC_INVAL_LEN       0x0502
+
+struct Diag508SigVerifBlock {
+    uint32_t length;
+    uint8_t reserved0[3];
+    uint8_t version;
+    uint32_t reserved[2];
+    uint8_t cert_store_index;
+    uint8_t reserved1[7];
+    uint64_t cert_len;
+    uint64_t comp_len;
+    uint64_t comp_addr;
+    uint64_t sig_len;
+    uint64_t sig_addr;
+};
+typedef struct Diag508SigVerifBlock Diag508SigVerifBlock;
 
 #endif
target/s390x/diag.c +114 -1

130 lines not on this page · raw message

Signature · 1 line
2.50.1
#48 lore raw

Re: [PATCH v6 12/28] s390x/diag: Implement DIAG 508 subcode 1 for signature verification

Quoted 90 lines · Zhuoying Cai

From: Collin Walling <[email protected]>

DIAG 508 subcode 1 performs signature-verification on signed components. A signed component may be a Linux kernel image, or any other signed binary. **Verification of initrd is not supported.**

The instruction call expects two item-pairs: an address of a device component, an address of the analogous signature file (in PKCS#7 DER format), and their respective lengths. All of this data should be encapsulated within a Diag508SigVerifBlock.

The DIAG handler will read from the provided addresses to retrieve the necessary data, parse the signature file, then perform the signature-verification. Because there is no way to correlate a specific certificate to a component, each certificate in the store is tried until either verification succeeds, or all certs have been exhausted.

The subcode value is denoted by setting the second-to-left-most bit of a 2-byte field.

A return code of 1 indicates success, and the index and length of the corresponding certificate will be set in the Diag508SigVerifBlock. The following values indicate failure:

	0x0102: certificate not available
	0x0202: component data is invalid
	0x0302: signature is not in PKCS#7 format
	0x0402: signature-verification failed
	0x0502: length of Diag508SigVerifBlock is invalid
---
  docs/specs/s390x-secure-ipl.rst |   5 ++
  include/hw/s390x/ipl/diag508.h  |  23 +++++++
  target/s390x/diag.c             | 115 +++++++++++++++++++++++++++++++-
  3 files changed, 142 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +5 -0
index 0919425e9a..eec368d17b 100644
@@ -66,3 +66,8 @@ that requires assistance from QEMU.
 
  Subcode 0 - query installed subcodes
      Returns a 64-bit mask indicating which subcodes are supported.
+
+Subcode 1 - perform signature verification
+    Perform signature-verification on a signed component, using certificates
+    from the certificate store and leveraging qcrypto libraries to perform
+    this operation.
include/hw/s390x/ipl/diag508.h +23 -0
index 6281ad8299..ad401cc867 100644
@@ -11,5 +11,28 @@
  #define S390X_DIAG508_H
 
  #define DIAG_508_SUBC_QUERY_SUBC    0x0000
+#define DIAG_508_SUBC_SIG_VERIF     0x8000
+
+#define DIAG_508_RC_OK              0x0001
+#define DIAG_508_RC_NO_CERTS        0x0102
+#define DIAG_508_RC_INVAL_COMP_DATA 0x0202
+#define DIAG_508_RC_INVAL_PKCS7_SIG 0x0302
+#define DIAG_508_RC_FAIL_VERIF      0x0402
+#define DIAG_508_RC_INVAL_LEN       0x0502
+
+struct Diag508SigVerifBlock {
+    uint32_t length;
+    uint8_t reserved0[3];
+    uint8_t version;
+    uint32_t reserved[2];
+    uint8_t cert_store_index;
+    uint8_t reserved1[7];
+    uint64_t cert_len;
+    uint64_t comp_len;
+    uint64_t comp_addr;
+    uint64_t sig_len;
+    uint64_t sig_addr;
+};
+typedef struct Diag508SigVerifBlock Diag508SigVerifBlock;
 
  #endif
target/s390x/diag.c +0 -0
index ee64257dbc..379fb8f2b4 100644

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 607

Quoted 6 lines
target/s390x/diag.c +3 -0
@@ -602,9 +602,112 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
      }
  }
 
+static int diag_508_verify_sig(uint8_t *cert, size_t cert_size,
+                              uint8_t *comp, size_t comp_size,
+                              uint8_t *sig, size_t sig_size)

Nit we could change the function definition from an int to bool, this would make reading easier.

Quoted 77 lines
target/s390x/diag.c +77 -0
+{
+    g_autofree uint8_t *sig_pem = NULL;
+    size_t sig_size_pem;
+    int rc;
+
+    /*
+     * PKCS#7 signature with DER format
+     * Convert to PEM format for signature verification
+     */
+    rc = qcrypto_pkcs7_convert_sig_pem(sig, sig_size, &sig_pem, &sig_size_pem, NULL);
+    if (rc < 0) {
+        return -1;
+    }
+
+    rc = qcrypto_x509_verify_sig(cert, cert_size,
+                                 comp, comp_size,
+                                 sig_pem, sig_size_pem, NULL);
+    if (rc < 0) {
+        return -1;
+    }
+
+    return 0;
+}
+
+static int handle_diag508_sig_verif(uint64_t addr, size_t svb_size,
+                                    S390IPLCertificateStore *qcs)
+{
+    int rc;
+    int verified;
+    uint32_t svb_len;
+    uint64_t comp_len, comp_addr;
+    uint64_t sig_len, sig_addr;
+    g_autofree uint8_t *svb_comp = NULL;
+    g_autofree uint8_t *svb_sig = NULL;
+    g_autofree Diag508SigVerifBlock *svb = NULL;
+
+    if (!qcs || !qcs->count) {
+        return DIAG_508_RC_NO_CERTS;
+    }
+
+    svb = g_new0(Diag508SigVerifBlock, 1);
+    cpu_physical_memory_read(addr, svb, svb_size);
+
+    svb_len = be32_to_cpu(svb->length);
+    if (svb_len != svb_size) {
+        return DIAG_508_RC_INVAL_LEN;
+    }
+
+    comp_len = be64_to_cpu(svb->comp_len);
+    comp_addr = be64_to_cpu(svb->comp_addr);
+    sig_len = be64_to_cpu(svb->sig_len);
+    sig_addr = be64_to_cpu(svb->sig_addr);
+
+    if (!comp_len || !comp_addr) {
+        return DIAG_508_RC_INVAL_COMP_DATA;
+    }
+
+    if (!sig_len || !sig_addr) {
+        return DIAG_508_RC_INVAL_PKCS7_SIG;
+    }
+
+    svb_comp = g_malloc0(comp_len);
+    cpu_physical_memory_read(comp_addr, svb_comp, comp_len);
+
+    svb_sig = g_malloc0(sig_len);
+    cpu_physical_memory_read(sig_addr, svb_sig, sig_len);
+
+    rc = DIAG_508_RC_FAIL_VERIF;
+    /*
+     * It is uncertain which certificate contains
+     * the analogous key to verify the signed data
+     *
+     * Ignore errors from signature format convertion and verification,
+     * because currently in the certificate lookup process.
+     *
+     * Any error is treated as a verification failure,
+     * and the final result (verified or not) will be reported later.

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 694

Quoted 10 lines
target/s390x/diag.c +10 -0
+     */
+    for (int i = 0; i < qcs->count; i++) {
+        verified = diag_508_verify_sig(qcs->certs[i].raw,
+                                       qcs->certs[i].size,
+                                       svb_comp, comp_len,
+                                       svb_sig, sig_len);
+        if (verified == 0) {
+            svb->cert_store_index = i;
+            svb->cert_len = cpu_to_be64(qcs->certs[i].der_size);
+            cpu_physical_memory_write(addr, svb, be32_to_cpu(svb_size));

Converting svb_size looks incorrect, shouldn't we just write svb_size bytes?

Thanks
Farhan

#49 lore raw

Re: [PATCH v6 12/28] s390x/diag: Implement DIAG 508 subcode 1 for signature verification

In reply to Zhuoying Cai
Quoted 146 lines · Zhuoying Cai

From: Collin Walling <[email protected]>

DIAG 508 subcode 1 performs signature-verification on signed components. A signed component may be a Linux kernel image, or any other signed binary. **Verification of initrd is not supported.**

The instruction call expects two item-pairs: an address of a device component, an address of the analogous signature file (in PKCS#7 DER format), and their respective lengths. All of this data should be encapsulated within a Diag508SigVerifBlock.

The DIAG handler will read from the provided addresses to retrieve the necessary data, parse the signature file, then perform the signature-verification. Because there is no way to correlate a specific certificate to a component, each certificate in the store is tried until either verification succeeds, or all certs have been exhausted.

The subcode value is denoted by setting the second-to-left-most bit of a 2-byte field.

A return code of 1 indicates success, and the index and length of the corresponding certificate will be set in the Diag508SigVerifBlock. The following values indicate failure:

	0x0102: certificate not available
	0x0202: component data is invalid
	0x0302: signature is not in PKCS#7 format
	0x0402: signature-verification failed
	0x0502: length of Diag508SigVerifBlock is invalid
---
  docs/specs/s390x-secure-ipl.rst |   5 ++
  include/hw/s390x/ipl/diag508.h  |  23 +++++++
  target/s390x/diag.c             | 115 +++++++++++++++++++++++++++++++-
  3 files changed, 142 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +5 -0
index 0919425e9a..eec368d17b 100644
@@ -66,3 +66,8 @@ that requires assistance from QEMU.
 
  Subcode 0 - query installed subcodes
      Returns a 64-bit mask indicating which subcodes are supported.
+
+Subcode 1 - perform signature verification
+    Perform signature-verification on a signed component, using certificates
+    from the certificate store and leveraging qcrypto libraries to perform
+    this operation.
include/hw/s390x/ipl/diag508.h +23 -0
index 6281ad8299..ad401cc867 100644
@@ -11,5 +11,28 @@
  #define S390X_DIAG508_H
 
  #define DIAG_508_SUBC_QUERY_SUBC    0x0000
+#define DIAG_508_SUBC_SIG_VERIF     0x8000
+
+#define DIAG_508_RC_OK              0x0001
+#define DIAG_508_RC_NO_CERTS        0x0102
+#define DIAG_508_RC_INVAL_COMP_DATA 0x0202
+#define DIAG_508_RC_INVAL_PKCS7_SIG 0x0302
+#define DIAG_508_RC_FAIL_VERIF      0x0402
+#define DIAG_508_RC_INVAL_LEN       0x0502
+
+struct Diag508SigVerifBlock {
+    uint32_t length;
+    uint8_t reserved0[3];
+    uint8_t version;
+    uint32_t reserved[2];
+    uint8_t cert_store_index;
+    uint8_t reserved1[7];
+    uint64_t cert_len;
+    uint64_t comp_len;
+    uint64_t comp_addr;
+    uint64_t sig_len;
+    uint64_t sig_addr;
+};
+typedef struct Diag508SigVerifBlock Diag508SigVerifBlock;
 
  #endif
target/s390x/diag.c +53 -0
index ee64257dbc..379fb8f2b4 100644
@@ -602,9 +602,112 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
      }
  }
 
+static int diag_508_verify_sig(uint8_t *cert, size_t cert_size,
+                              uint8_t *comp, size_t comp_size,
+                              uint8_t *sig, size_t sig_size)
+{
+    g_autofree uint8_t *sig_pem = NULL;
+    size_t sig_size_pem;
+    int rc;
+
+    /*
+     * PKCS#7 signature with DER format
+     * Convert to PEM format for signature verification
+     */
+    rc = qcrypto_pkcs7_convert_sig_pem(sig, sig_size, &sig_pem, &sig_size_pem, NULL);
+    if (rc < 0) {
+        return -1;
+    }
+
+    rc = qcrypto_x509_verify_sig(cert, cert_size,
+                                 comp, comp_size,
+                                 sig_pem, sig_size_pem, NULL);
+    if (rc < 0) {
+        return -1;
+    }
+
+    return 0;
+}
+
+static int handle_diag508_sig_verif(uint64_t addr, size_t svb_size,
+                                    S390IPLCertificateStore *qcs)
+{
+    int rc;
+    int verified;
+    uint32_t svb_len;
+    uint64_t comp_len, comp_addr;
+    uint64_t sig_len, sig_addr;
+    g_autofree uint8_t *svb_comp = NULL;
+    g_autofree uint8_t *svb_sig = NULL;
+    g_autofree Diag508SigVerifBlock *svb = NULL;
+
+    if (!qcs || !qcs->count) {
+        return DIAG_508_RC_NO_CERTS;
+    }
+
+    svb = g_new0(Diag508SigVerifBlock, 1);
+    cpu_physical_memory_read(addr, svb, svb_size);
+
+    svb_len = be32_to_cpu(svb->length);
+    if (svb_len != svb_size) {
+        return DIAG_508_RC_INVAL_LEN;
+    }
+
+    comp_len = be64_to_cpu(svb->comp_len);
+    comp_addr = be64_to_cpu(svb->comp_addr);

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 667

Quoted 10 lines
target/s390x/diag.c +10 -0
+    sig_len = be64_to_cpu(svb->sig_len);
+    sig_addr = be64_to_cpu(svb->sig_addr);
+
+    if (!comp_len || !comp_addr) {
+        return DIAG_508_RC_INVAL_COMP_DATA;
+    }
+
+    if (!sig_len || !sig_addr) {
+        return DIAG_508_RC_INVAL_PKCS7_SIG;
+    }

I think there should also be something like an upper limit for comp_len and sign_len here. Otherwise a malicious guest could force QEMU into allocating giga- or terabytes of memory here to cause out-of-memory situations in the host.

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 681

Quoted 13 lines
target/s390x/diag.c +13 -0
+    svb_comp = g_malloc0(comp_len);
+    cpu_physical_memory_read(comp_addr, svb_comp, comp_len);
+
+    svb_sig = g_malloc0(sig_len);
+    cpu_physical_memory_read(sig_addr, svb_sig, sig_len);
+
+    rc = DIAG_508_RC_FAIL_VERIF;
+    /*
+     * It is uncertain which certificate contains
+     * the analogous key to verify the signed data
+     *
+     * Ignore errors from signature format convertion and verification,
+     * because currently in the certificate lookup process.

The second half of above sentence looks incomplete?

Quoted 10 lines
target/s390x/diag.c +10 -0
+     *
+     * Any error is treated as a verification failure,
+     * and the final result (verified or not) will be reported later.
+     */
+    for (int i = 0; i < qcs->count; i++) {
+        verified = diag_508_verify_sig(qcs->certs[i].raw,
+                                       qcs->certs[i].size,
+                                       svb_comp, comp_len,
+                                       svb_sig, sig_len);
+        if (verified == 0) {

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 701

Quoted 10 lines
target/s390x/diag.c +10 -0
+            svb->cert_store_index = i;
+            svb->cert_len = cpu_to_be64(qcs->certs[i].der_size);
+            cpu_physical_memory_write(addr, svb, be32_to_cpu(svb_size));
+            rc = DIAG_508_RC_OK;
+            break;
+       }
+    }
+
+    return rc;
+}

Thomas

#50 lore raw

Re: [PATCH v6 12/28] s390x/diag: Implement DIAG 508 subcode 1 for signature verification

Quoted 34 lines · Thomas Huth
Quoted 33 lines · Zhuoying Cai

From: Collin Walling <[email protected]>

DIAG 508 subcode 1 performs signature-verification on signed components. A signed component may be a Linux kernel image, or any other signed binary. **Verification of initrd is not supported.**

The instruction call expects two item-pairs: an address of a device component, an address of the analogous signature file (in PKCS#7 DER format), and their respective lengths. All of this data should be encapsulated within a Diag508SigVerifBlock.

The DIAG handler will read from the provided addresses to retrieve the necessary data, parse the signature file, then perform the signature-verification. Because there is no way to correlate a specific certificate to a component, each certificate in the store is tried until either verification succeeds, or all certs have been exhausted.

The subcode value is denoted by setting the second-to-left-most bit of a 2-byte field.

A return code of 1 indicates success, and the index and length of the corresponding certificate will be set in the Diag508SigVerifBlock. The following values indicate failure:

	0x0102: certificate not available
	0x0202: component data is invalid
	0x0302: signature is not in PKCS#7 format
	0x0402: signature-verification failed
	0x0502: length of Diag508SigVerifBlock is invalid

[...]

Quoted 33 lines
Quoted 33 lines
target/s390x/diag.c +33 -0
+
+static int handle_diag508_sig_verif(uint64_t addr, size_t svb_size,
+                                    S390IPLCertificateStore *qcs)
+{
+    int rc;
+    int verified;
+    uint32_t svb_len;
+    uint64_t comp_len, comp_addr;
+    uint64_t sig_len, sig_addr;
+    g_autofree uint8_t *svb_comp = NULL;
+    g_autofree uint8_t *svb_sig = NULL;
+    g_autofree Diag508SigVerifBlock *svb = NULL;
+
+    if (!qcs || !qcs->count) {
+        return DIAG_508_RC_NO_CERTS;
+    }
+
+    svb = g_new0(Diag508SigVerifBlock, 1);
+    cpu_physical_memory_read(addr, svb, svb_size);
+
+    svb_len = be32_to_cpu(svb->length);
+    if (svb_len != svb_size) {
+        return DIAG_508_RC_INVAL_LEN;
+    }
+
+    comp_len = be64_to_cpu(svb->comp_len);
+    comp_addr = be64_to_cpu(svb->comp_addr);
+    sig_len = be64_to_cpu(svb->sig_len);
+    sig_addr = be64_to_cpu(svb->sig_addr);
+
+    if (!comp_len || !comp_addr) {
+        return DIAG_508_RC_INVAL_COMP_DATA;
+    }
Quoted 9 lines

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 667

Quoted 4 lines
target/s390x/diag.c +4 -0
+
+    if (!sig_len || !sig_addr) {
+        return DIAG_508_RC_INVAL_PKCS7_SIG;
+    }

I think there should also be something like an upper limit for comp_len and sign_len here. Otherwise a malicious guest could force QEMU into allocating giga- or terabytes of memory here to cause out-of-memory situations in the host.

Thank you for the suggestion. I agree that setting an upper limit would help prevent unreasonable memory requests. I think it makes sense to choose a reasonable value so we don't have to adjust it too often, but I'm not entirely sure how to determine an appropriate upper bound.

Re: sig_len - the signature length can vary depending on the cryptographic algorithm, and I don't believe there's a strict limit. (FYI, in a somewhat similar situation, we haven't enforced a maximum size on certificate files when loading them into memory, since they're assumed to be trusted, as Daniel previously suggested -
https://lists.gnu.org/archive/html/qemu-s390x/2025-06/msg00049.html).

If we'd like to set an upper limit for sig_len, the largest signature I've tested is 1165 bytes, signed with an RSA certificate using an 8192-bit key. Would 4096 be a reasonable upper bound?

Re: comp_len - the size of the guest kernel I'm currently using is 14,184,448 (0xD87000). When I built a kernel with make allyesconfig, the size can reach 261,005,383 (0xF8EA047). Based on this value, would 262,000,000 (0xF9DCD80) an appropriate upper limit?

Quoted 39 lines

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 681

Quoted 13 lines
target/s390x/diag.c +13 -0
+    svb_comp = g_malloc0(comp_len);
+    cpu_physical_memory_read(comp_addr, svb_comp, comp_len);
+
+    svb_sig = g_malloc0(sig_len);
+    cpu_physical_memory_read(sig_addr, svb_sig, sig_len);
+
+    rc = DIAG_508_RC_FAIL_VERIF;
+    /*
+     * It is uncertain which certificate contains
+     * the analogous key to verify the signed data
+     *
+     * Ignore errors from signature format convertion and verification,
+     * because currently in the certificate lookup process.

The second half of above sentence looks incomplete?

Quoted 10 lines
target/s390x/diag.c +10 -0
+     *
+     * Any error is treated as a verification failure,
+     * and the final result (verified or not) will be reported later.
+     */
+    for (int i = 0; i < qcs->count; i++) {
+        verified = diag_508_verify_sig(qcs->certs[i].raw,
+                                       qcs->certs[i].size,
+                                       svb_comp, comp_len,
+                                       svb_sig, sig_len);
+        if (verified == 0) {

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 701

Quoted 10 lines
target/s390x/diag.c +10 -0
+            svb->cert_store_index = i;
+            svb->cert_len = cpu_to_be64(qcs->certs[i].der_size);
+            cpu_physical_memory_write(addr, svb, be32_to_cpu(svb_size));
+            rc = DIAG_508_RC_OK;
+            break;
+       }
+    }
+
+    return rc;
+}

Thomas

#51 lore raw

Re: [PATCH v6 12/28] s390x/diag: Implement DIAG 508 subcode 1 for signature verification

Quoted 93 lines · Zhuoying Cai
Quoted 34 lines · Thomas Huth
Quoted 33 lines · Zhuoying Cai

From: Collin Walling <[email protected]>

DIAG 508 subcode 1 performs signature-verification on signed components. A signed component may be a Linux kernel image, or any other signed binary. **Verification of initrd is not supported.**

The instruction call expects two item-pairs: an address of a device component, an address of the analogous signature file (in PKCS#7 DER format), and their respective lengths. All of this data should be encapsulated within a Diag508SigVerifBlock.

The DIAG handler will read from the provided addresses to retrieve the necessary data, parse the signature file, then perform the signature-verification. Because there is no way to correlate a specific certificate to a component, each certificate in the store is tried until either verification succeeds, or all certs have been exhausted.

The subcode value is denoted by setting the second-to-left-most bit of a 2-byte field.

A return code of 1 indicates success, and the index and length of the corresponding certificate will be set in the Diag508SigVerifBlock. The following values indicate failure:

	0x0102: certificate not available
	0x0202: component data is invalid
	0x0302: signature is not in PKCS#7 format
	0x0402: signature-verification failed
	0x0502: length of Diag508SigVerifBlock is invalid

[...]

Quoted 33 lines
Quoted 33 lines
target/s390x/diag.c +33 -0
+
+static int handle_diag508_sig_verif(uint64_t addr, size_t svb_size,
+                                    S390IPLCertificateStore *qcs)
+{
+    int rc;
+    int verified;
+    uint32_t svb_len;
+    uint64_t comp_len, comp_addr;
+    uint64_t sig_len, sig_addr;
+    g_autofree uint8_t *svb_comp = NULL;
+    g_autofree uint8_t *svb_sig = NULL;
+    g_autofree Diag508SigVerifBlock *svb = NULL;
+
+    if (!qcs || !qcs->count) {
+        return DIAG_508_RC_NO_CERTS;
+    }
+
+    svb = g_new0(Diag508SigVerifBlock, 1);
+    cpu_physical_memory_read(addr, svb, svb_size);
+
+    svb_len = be32_to_cpu(svb->length);
+    if (svb_len != svb_size) {
+        return DIAG_508_RC_INVAL_LEN;
+    }
+
+    comp_len = be64_to_cpu(svb->comp_len);
+    comp_addr = be64_to_cpu(svb->comp_addr);
+    sig_len = be64_to_cpu(svb->sig_len);
+    sig_addr = be64_to_cpu(svb->sig_addr);
+
+    if (!comp_len || !comp_addr) {
+        return DIAG_508_RC_INVAL_COMP_DATA;
+    }
Quoted 9 lines

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 667

Quoted 4 lines
target/s390x/diag.c +4 -0
+
+    if (!sig_len || !sig_addr) {
+        return DIAG_508_RC_INVAL_PKCS7_SIG;
+    }

I think there should also be something like an upper limit for comp_len and sign_len here. Otherwise a malicious guest could force QEMU into allocating giga- or terabytes of memory here to cause out-of-memory situations in the host.

Thank you for the suggestion. I agree that setting an upper limit would help prevent unreasonable memory requests. I think it makes sense to choose a reasonable value so we don't have to adjust it too often, but I'm not entirely sure how to determine an appropriate upper bound.

Re: sig_len - the signature length can vary depending on the cryptographic algorithm, and I don't believe there's a strict limit. (FYI, in a somewhat similar situation, we haven't enforced a maximum size on certificate files when loading them into memory, since they're assumed to be trusted, as Daniel previously suggested -
https://lists.gnu.org/archive/html/qemu-s390x/2025-06/msg00049.html).

Quoted 3 lines

If we'd like to set an upper limit for sig_len, the largest signature I've tested is 1165 bytes, signed with an RSA certificate using an 8192-bit key. Would 4096 be a reasonable upper bound?

Sounds reasonable, yes.

Quoted 4 lines

Re: comp_len - the size of the guest kernel I'm currently using is 14,184,448 (0xD87000). When I built a kernel with make allyesconfig, the size can reach 261,005,383 (0xF8EA047). Based on this value, would 262,000,000 (0xF9DCD80) an appropriate upper limit?

Make it 0x10000000 = 268435456 Bytes, that feels like a round boundary ;-)

Thomas

#52 lore raw

Re: [PATCH v6 12/28] s390x/diag: Implement DIAG 508 subcode 1 for signature verification

In reply to Zhuoying Cai

On 9/17/25 19:21, Zhuoying Cai wrote:

Just some nits below based on how far along this patch has come.

Quoted 5 lines

From: Collin Walling <[email protected]>

DIAG 508 subcode 1 performs signature-verification on signed components. A signed component may be a Linux kernel image, or any other signed binary. **Verification of initrd is not supported.**

The initrd case should be included in the document as well for subcode 1.

Quoted 13 lines

The instruction call expects two item-pairs: an address of a device component, an address of the analogous signature file (in PKCS#7 DER format), and their respective lengths. All of this data should be encapsulated within a Diag508SigVerifBlock.

The DIAG handler will read from the provided addresses to retrieve the necessary data, parse the signature file, then perform the signature-verification. Because there is no way to correlate a specific certificate to a component, each certificate in the store is tried until either verification succeeds, or all certs have been exhausted.

Quoted 3 lines

The subcode value is denoted by setting the second-to-left-most bit of a 2-byte field.

Remove the sentence above. As for the info below, it should also be included in the document under subcode 1.

Quoted 5 lines

A return code of 1 indicates success, and the index and length of the corresponding certificate will be set in the Diag508SigVerifBlock. The following values indicate failure:

	0x0102: certificate not available

Change to: no certificates are available in the store

Quoted 97 lines
	0x0202: component data is invalid
	0x0302: signature is not in PKCS#7 format
	0x0402: signature-verification failed
	0x0502: length of Diag508SigVerifBlock is invalid
---
 docs/specs/s390x-secure-ipl.rst |   5 ++
 include/hw/s390x/ipl/diag508.h  |  23 +++++++
 target/s390x/diag.c             | 115 +++++++++++++++++++++++++++++++-
 3 files changed, 142 insertions(+), 1 deletion(-)
docs/specs/s390x-secure-ipl.rst +5 -0
index 0919425e9a..eec368d17b 100644
@@ -66,3 +66,8 @@ that requires assistance from QEMU.
 
 Subcode 0 - query installed subcodes
     Returns a 64-bit mask indicating which subcodes are supported.
+
+Subcode 1 - perform signature verification
+    Perform signature-verification on a signed component, using certificates
+    from the certificate store and leveraging qcrypto libraries to perform
+    this operation.
include/hw/s390x/ipl/diag508.h +23 -0
index 6281ad8299..ad401cc867 100644
@@ -11,5 +11,28 @@
 #define S390X_DIAG508_H
 
 #define DIAG_508_SUBC_QUERY_SUBC    0x0000
+#define DIAG_508_SUBC_SIG_VERIF     0x8000
+
+#define DIAG_508_RC_OK              0x0001
+#define DIAG_508_RC_NO_CERTS        0x0102
+#define DIAG_508_RC_INVAL_COMP_DATA 0x0202
+#define DIAG_508_RC_INVAL_PKCS7_SIG 0x0302
+#define DIAG_508_RC_FAIL_VERIF      0x0402
+#define DIAG_508_RC_INVAL_LEN       0x0502
+
+struct Diag508SigVerifBlock {
+    uint32_t length;
+    uint8_t reserved0[3];
+    uint8_t version;
+    uint32_t reserved[2];
+    uint8_t cert_store_index;
+    uint8_t reserved1[7];
+    uint64_t cert_len;
+    uint64_t comp_len;
+    uint64_t comp_addr;
+    uint64_t sig_len;
+    uint64_t sig_addr;
+};
+typedef struct Diag508SigVerifBlock Diag508SigVerifBlock;
 
 #endif
target/s390x/diag.c +27 -0
index ee64257dbc..379fb8f2b4 100644
@@ -602,9 +602,112 @@ void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
     }
 }
 
+static int diag_508_verify_sig(uint8_t *cert, size_t cert_size,
+                              uint8_t *comp, size_t comp_size,
+                              uint8_t *sig, size_t sig_size)
+{
+    g_autofree uint8_t *sig_pem = NULL;
+    size_t sig_size_pem;
+    int rc;
+
+    /*
+     * PKCS#7 signature with DER format
+     * Convert to PEM format for signature verification
+     */
+    rc = qcrypto_pkcs7_convert_sig_pem(sig, sig_size, &sig_pem, &sig_size_pem, NULL);
+    if (rc < 0) {
+        return -1;
+    }
+
+    rc = qcrypto_x509_verify_sig(cert, cert_size,
+                                 comp, comp_size,
+                                 sig_pem, sig_size_pem, NULL);
+    if (rc < 0) {
+        return -1;
+    }
+
+    return 0;
+}
+

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 641

Quoted 10 lines
target/s390x/diag.c +10 -0
+static int handle_diag508_sig_verif(uint64_t addr, size_t svb_size,
+                                    S390IPLCertificateStore *qcs)
+{
+    int rc;
+    int verified;
+    uint32_t svb_len;
+    uint64_t comp_len, comp_addr;
+    uint64_t sig_len, sig_addr;
+    g_autofree uint8_t *svb_comp = NULL;
+    g_autofree uint8_t *svb_sig = NULL;

nit: maybe just call these comp and sig?

Quoted 34 lines
target/s390x/diag.c +34 -0
+    g_autofree Diag508SigVerifBlock *svb = NULL;
+
+    if (!qcs || !qcs->count) {
+        return DIAG_508_RC_NO_CERTS;
+    }
+
+    svb = g_new0(Diag508SigVerifBlock, 1);
+    cpu_physical_memory_read(addr, svb, svb_size);
+
+    svb_len = be32_to_cpu(svb->length);
+    if (svb_len != svb_size) {
+        return DIAG_508_RC_INVAL_LEN;
+    }
+
+    comp_len = be64_to_cpu(svb->comp_len);
+    comp_addr = be64_to_cpu(svb->comp_addr);
+    sig_len = be64_to_cpu(svb->sig_len);
+    sig_addr = be64_to_cpu(svb->sig_addr);
+
+    if (!comp_len || !comp_addr) {
+        return DIAG_508_RC_INVAL_COMP_DATA;
+    }
+
+    if (!sig_len || !sig_addr) {
+        return DIAG_508_RC_INVAL_PKCS7_SIG;
+    }
+
+    svb_comp = g_malloc0(comp_len);
+    cpu_physical_memory_read(comp_addr, svb_comp, comp_len);
+
+    svb_sig = g_malloc0(sig_len);
+    cpu_physical_memory_read(sig_addr, svb_sig, sig_len);
+
+    rc = DIAG_508_RC_FAIL_VERIF;

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 685

Quoted 10 lines
target/s390x/diag.c +10 -0
+    /*
+     * It is uncertain which certificate contains
+     * the analogous key to verify the signed data
+     *
+     * Ignore errors from signature format convertion and verification,
+     * because currently in the certificate lookup process.
+     *
+     * Any error is treated as a verification failure,
+     * and the final result (verified or not) will be reported later.
+     */

I think these comments may now be rendered redundant, now with the for-loop significantly simplified since it was originally put in place. You can remove them.

As for mentioning how errors are handled, you could put that comment in diag_508_verify_sig since that's where the errors are being ignored.

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 695

Quoted 10 lines
target/s390x/diag.c +10 -0
+    for (int i = 0; i < qcs->count; i++) {
+        verified = diag_508_verify_sig(qcs->certs[i].raw,
+                                       qcs->certs[i].size,
+                                       svb_comp, comp_len,
+                                       svb_sig, sig_len);
+        if (verified == 0) {
+            svb->cert_store_index = i;
+            svb->cert_len = cpu_to_be64(qcs->certs[i].der_size);
+            cpu_physical_memory_write(addr, svb, be32_to_cpu(svb_size));
+            rc = DIAG_508_RC_OK;

Could just return DIAG_508_RC_OK...

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 700

Quoted 5 lines
target/s390x/diag.c +5 -0
+            break;
+       }
+    }
+
+    return rc;

...and here return DIAG_508_RC_FAIL_VERIF

Then get rid of rc.

target/s390x/diag.c void handle_diag_320(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 708

Quoted 8 lines
target/s390x/diag.c +6 -0
+}
+
+QEMU_BUILD_BUG_MSG(sizeof(Diag508SigVerifBlock) != 64,
+                   "size of Diag508SigVerifBlock is wrong");
+
 void handle_diag_508(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
 {
+    S390IPLCertificateStore *qcs = s390_ipl_get_certificate_store();

Move this line into handle_diag508_sig_verif() and remove the qcs param from the function.

Quoted 6 lines
target/s390x/diag.c +1 -0
     uint64_t subcode = env->regs[r3];
+    uint64_t addr = env->regs[r1];
     int rc;
 
     if (env->psw.mask & PSW_MASK_PSTATE) {

target/s390x/diag.c void handle_diag_508(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra) · line 728

Quoted 8 lines
target/s390x/diag.c +4 -1
@@ -619,7 +722,17 @@ void handle_diag_508(CPUS390XState *env, uint64_t r1, uint64_t r3, uintptr_t ra)
 
     switch (subcode) {
     case DIAG_508_SUBC_QUERY_SUBC:
-        rc = 0;
+        rc = DIAG_508_SUBC_SIG_VERIF;
+        break;
+    case DIAG_508_SUBC_SIG_VERIF:
+        size_t svb_size = sizeof(Diag508SigVerifBlock);

Since svb_size is only passed to the functions below, maybe just use sizeof inline and then you can remove another param from handle_diag508_sig_verif()? It should fit nicely now that the struct is less verbose.

Quoted 10 lines
target/s390x/diag.c +7 -0
+
+        if (!diag_parm_addr_valid(addr, sizeof(Diag508SigVerifBlock), true)) {
+            s390_program_interrupt(env, PGM_ADDRESSING, ra);
+            return;
+        }
+
+        rc = handle_diag508_sig_verif(addr, svb_size, qcs);
         break;
     default:
         s390_program_interrupt(env, PGM_SPECIFICATION, ra);
Signature · 2 lines
Regards,
  Collin
#53 lore raw

PATCH v6 13/28 pc-bios/s390-ccw: Introduce IPL Information Report Block (IIRB)

In reply to Zhuoying Cai

The IPL information report block (IIRB) contains information used to locate IPL records and to report the results of signature verification of one or more secure components of the load device.

IIRB is stored immediately following the IPL Parameter Block. Results on component verification in any case (failure or success) are stored.

---
 docs/specs/s390x-secure-ipl.rst | 14 ++++++++
 pc-bios/s390-ccw/iplb.h         | 62 +++++++++++++++++++++++++++++++++
 2 files changed, 76 insertions(+)
docs/specs/s390x-secure-ipl.rst +14 -0
index eec368d17b..760a066084 100644
@@ -71,3 +71,17 @@ Subcode 1 - perform signature verification
     Perform signature-verification on a signed component, using certificates
     from the certificate store and leveraging qcrypto libraries to perform
     this operation.
+
+
+IPL Information Report Block
+----------------------------
+
+The IPL Parameter Block (IPLPB), utilized for IPL operation, is extended with an
+IPL Information Report Block (IIRB), which contains the results from secure IPL
+operations such as:
+
+* component data
+* verification results
+* certificate data
+
+The guest kernel will inspect the IIRB and build the keyring.
pc-bios/s390-ccw/iplb.h +62 -0

68 lines not on this page · raw message

Signature · 1 line
2.50.1
#54 lore raw

Re: [PATCH v6 13/28] pc-bios/s390-ccw: Introduce IPL Information Report Block (IIRB)

Quoted 98 lines · Zhuoying Cai

The IPL information report block (IIRB) contains information used to locate IPL records and to report the results of signature verification of one or more secure components of the load device.

IIRB is stored immediately following the IPL Parameter Block. Results on component verification in any case (failure or success) are stored.

---
  docs/specs/s390x-secure-ipl.rst | 14 ++++++++
  pc-bios/s390-ccw/iplb.h         | 62 +++++++++++++++++++++++++++++++++
  2 files changed, 76 insertions(+)
docs/specs/s390x-secure-ipl.rst +14 -0
index eec368d17b..760a066084 100644
@@ -71,3 +71,17 @@ Subcode 1 - perform signature verification
      Perform signature-verification on a signed component, using certificates
      from the certificate store and leveraging qcrypto libraries to perform
      this operation.
+
+
+IPL Information Report Block
+----------------------------
+
+The IPL Parameter Block (IPLPB), utilized for IPL operation, is extended with an
+IPL Information Report Block (IIRB), which contains the results from secure IPL
+operations such as:
+
+* component data
+* verification results
+* certificate data
+
+The guest kernel will inspect the IIRB and build the keyring.
pc-bios/s390-ccw/iplb.h +55 -0
index 08f259ff31..bdbc733e16 100644
@@ -23,6 +23,68 @@ extern QemuIplParameters qipl;
  extern IplParameterBlock iplb __attribute__((__aligned__(PAGE_SIZE)));
  extern bool have_iplb;
 
+struct IplInfoReportBlockHeader {
+    uint32_t len;
+    uint8_t  iirb_flags;
+    uint8_t  reserved1[2];
+    uint8_t  version;
+    uint8_t  reserved2[8];
+} __attribute__ ((packed));
+typedef struct IplInfoReportBlockHeader IplInfoReportBlockHeader;
+
+struct IplInfoBlockHeader {
+    uint32_t len;
+    uint8_t  ibt;
+    uint8_t  reserved1[3];
+    uint8_t  reserved2[8];
+} __attribute__ ((packed));
+typedef struct IplInfoBlockHeader IplInfoBlockHeader;
+
+enum IplIbt {
+    IPL_IBT_CERTIFICATES = 1,
+    IPL_IBT_COMPONENTS = 2,
+};
+
+struct IplSignatureCertificateEntry {
+    uint64_t addr;
+    uint64_t len;
+} __attribute__ ((packed));
+typedef struct IplSignatureCertificateEntry IplSignatureCertificateEntry;
+
+struct IplSignatureCertificateList {
+    IplInfoBlockHeader            ipl_info_header;
+    IplSignatureCertificateEntry  cert_entries[MAX_CERTIFICATES];
+} __attribute__ ((packed));
+typedef struct IplSignatureCertificateList IplSignatureCertificateList;
+
+#define S390_IPL_COMPONENT_FLAG_SC  0x80
+#define S390_IPL_COMPONENT_FLAG_CSV 0x40
+
+struct IplDeviceComponentEntry {
+    uint64_t addr;
+    uint64_t len;
+    uint8_t  flags;
+    uint8_t  reserved1[5];
+    uint16_t cert_index;
+    uint8_t  reserved2[8];
+} __attribute__ ((packed));
+typedef struct IplDeviceComponentEntry IplDeviceComponentEntry;
+
+struct IplDeviceComponentList {
+    IplInfoBlockHeader       ipl_info_header;
+    IplDeviceComponentEntry  device_entries[MAX_CERTIFICATES];
+} __attribute__ ((packed));
+typedef struct IplDeviceComponentList IplDeviceComponentList;
+
+#define COMP_LIST_MAX   sizeof(IplDeviceComponentList)
+#define CERT_LIST_MAX   sizeof(IplSignatureCertificateList)

pc-bios/s390-ccw/iplb.h extern QemuIplParameters qipl; · line 90

Quoted 10 lines
pc-bios/s390-ccw/iplb.h +7 -0
+
+struct IplInfoReportBlock {
+    IplInfoReportBlockHeader     hdr;
+    uint8_t                      info_blks[COMP_LIST_MAX + CERT_LIST_MAX];
+} __attribute__ ((packed));
+typedef struct IplInfoReportBlock IplInfoReportBlock;
+
  #define S390_IPL_TYPE_FCP 0x00
  #define S390_IPL_TYPE_CCW 0x02
  #define S390_IPL_TYPE_QEMU_SCSI 0xff

We should avoid packing the structure and just add QEMU_BUILD_BUG_MSG. Overall the patch LGTM. Thanks Farhan

#55 lore raw

PATCH v6 14/28 pc-bios/s390-ccw: Define memory for IPLB and convert IPLB to pointers

In reply to Zhuoying Cai

Define a memory space for both IPL Parameter Block (IPLB) and IPL Information Report Block (IIRB) since IIRB is stored immediately following IPLB.

Convert IPLB to pointer and it points to the start of the defined memory space. IIRB points to the end of IPLB.

---
 pc-bios/s390-ccw/iplb.h     | 12 ++++++++++--
 pc-bios/s390-ccw/jump2ipl.c |  6 +++---
 pc-bios/s390-ccw/main.c     | 34 +++++++++++++++++++---------------
 pc-bios/s390-ccw/netmain.c  |  8 ++++----
 4 files changed, 36 insertions(+), 24 deletions(-)
pc-bios/s390-ccw/iplb.h +10 -2
index bdbc733e16..11302e004d 100644
@@ -20,7 +20,7 @@
 #include <string.h>
 
 extern QemuIplParameters qipl;
-extern IplParameterBlock iplb __attribute__((__aligned__(PAGE_SIZE)));
+extern IplParameterBlock *iplb;
 extern bool have_iplb;
 
 struct IplInfoReportBlockHeader {
@@ -85,6 +85,14 @@ struct IplInfoReportBlock {
 } __attribute__ ((packed));
 typedef struct IplInfoReportBlock IplInfoReportBlock;
 
+struct IplBlocks {
+    IplParameterBlock   iplb;
+    IplInfoReportBlock  iirb;
+} __attribute__ ((packed));
+typedef struct IplBlocks IplBlocks;
+
+extern IplBlocks ipl_data __attribute__((__aligned__(PAGE_SIZE)));
+
 #define S390_IPL_TYPE_FCP 0x00
 #define S390_IPL_TYPE_CCW 0x02
 #define S390_IPL_TYPE_QEMU_SCSI 0xff
@@ -127,7 +135,7 @@ static inline bool load_next_iplb(void)
 
     qipl.index++;
     next_iplb = (IplParameterBlock *) qipl.next_iplb;
-    memcpy(&iplb, next_iplb, sizeof(IplParameterBlock));
+    memcpy(iplb, next_iplb, sizeof(IplParameterBlock));
 
     qipl.chain_len--;
     qipl.next_iplb = qipl.next_iplb + sizeof(IplParameterBlock);
pc-bios/s390-ccw/jump2ipl.c +3 -3
index 86321d0f46..fa2ca5cbe1 100644
@@ -43,11 +43,11 @@ int jump_to_IPL_code(uint64_t address)
      * The IPLB for QEMU SCSI type devices must be rebuilt during re-ipl. The
      * iplb.devno is set to the boot position of the target SCSI device.
      */
-    if (iplb.pbt == S390_IPL_TYPE_QEMU_SCSI) {
-        iplb.devno = qipl.index;
+    if (iplb->pbt == S390_IPL_TYPE_QEMU_SCSI) {
+        iplb->devno = qipl.index;
     }
 
-    if (have_iplb && !set_iplb(&iplb)) {
+    if (have_iplb && !set_iplb(iplb)) {
         panic("Failed to set IPLB");
     }
 
pc-bios/s390-ccw/main.c +19 -15
index 76bf743900..c9328f1c51 100644
@@ -22,7 +22,9 @@
 static SubChannelId blk_schid = { .one = 1 };
 static char loadparm_str[LOADPARM_LEN + 1];
 QemuIplParameters qipl;
-IplParameterBlock iplb __attribute__((__aligned__(PAGE_SIZE)));
+/* Ensure that IPLB and IIRB are page aligned and sequential in memory */
+IplBlocks ipl_data;
+IplParameterBlock *iplb;
 bool have_iplb;
 static uint16_t cutype;
 LowCore *lowcore; /* Yes, this *is* a pointer to address 0 */
@@ -51,7 +53,7 @@ void write_subsystem_identification(void)
 void write_iplb_location(void)
 {
     if (cutype == CU_TYPE_VIRTIO && virtio_get_device_type() != VIRTIO_ID_NET) {
-        lowcore->ptr_iplb = ptr2u32(&iplb);
+        lowcore->ptr_iplb = ptr2u32(iplb);
     }
 }
 
@@ -162,7 +164,7 @@ static void menu_setup(void)
         return;
     }
 
-    switch (iplb.pbt) {
+    switch (iplb->pbt) {
     case S390_IPL_TYPE_CCW:
     case S390_IPL_TYPE_QEMU_SCSI:
         menu_set_parms(qipl.qipl_flags & BOOT_MENU_FLAG_MASK,
@@ -191,8 +193,8 @@ static void boot_setup(void)
 {
     char lpmsg[] = "LOADPARM=[________]\n";
 
-    if (have_iplb && memcmp(iplb.loadparm, NO_LOADPARM, LOADPARM_LEN) != 0) {
-        ebcdic_to_ascii((char *) iplb.loadparm, loadparm_str, LOADPARM_LEN);
+    if (have_iplb && memcmp(iplb->loadparm, NO_LOADPARM, LOADPARM_LEN) != 0) {
+        ebcdic_to_ascii((char *) iplb->loadparm, loadparm_str, LOADPARM_LEN);
     } else {
         sclp_get_loadparm_ascii(loadparm_str);
     }
@@ -216,21 +218,21 @@ static bool find_boot_device(void)
     VDev *vdev = virtio_get_device();
     bool found = false;
 
-    switch (iplb.pbt) {
+    switch (iplb->pbt) {
     case S390_IPL_TYPE_CCW:
         vdev->scsi_device_selected = false;
-        debug_print_int("device no. ", iplb.ccw.devno);
-        blk_schid.ssid = iplb.ccw.ssid & 0x3;
+        debug_print_int("device no. ", iplb->ccw.devno);
+        blk_schid.ssid = iplb->ccw.ssid & 0x3;
         debug_print_int("ssid ", blk_schid.ssid);
-        found = find_subch(iplb.ccw.devno);
+        found = find_subch(iplb->ccw.devno);
         break;
     case S390_IPL_TYPE_QEMU_SCSI:
         vdev->scsi_device_selected = true;
-        vdev->selected_scsi_device.channel = iplb.scsi.channel;
-        vdev->selected_scsi_device.target = iplb.scsi.target;
-        vdev->selected_scsi_device.lun = iplb.scsi.lun;
-        blk_schid.ssid = iplb.scsi.ssid & 0x3;
-        found = find_subch(iplb.scsi.devno);
+        vdev->selected_scsi_device.channel = iplb->scsi.channel;
+        vdev->selected_scsi_device.target = iplb->scsi.target;
+        vdev->selected_scsi_device.lun = iplb->scsi.lun;
+        blk_schid.ssid = iplb->scsi.ssid & 0x3;
+        found = find_subch(iplb->scsi.devno);
         break;
     default:
         puts("Unsupported IPLB");
@@ -311,10 +313,12 @@ static void probe_boot_device(void)
 
 void main(void)
 {
+    iplb = &ipl_data.iplb;
+
     copy_qipl();
     sclp_setup();
     css_setup();
-    have_iplb = store_iplb(&iplb);
+    have_iplb = store_iplb(iplb);
     if (!have_iplb) {
         boot_setup();
         probe_boot_device();
pc-bios/s390-ccw/netmain.c +4 -4
index a9521dff41..457fbc3095 100644
@@ -528,11 +528,11 @@ static bool virtio_setup(void)
      */
     enable_mss_facility();
 
-    if (have_iplb || store_iplb(&iplb)) {
-        IPL_assert(iplb.pbt == S390_IPL_TYPE_CCW, "IPL_TYPE_CCW expected");
-        dev_no = iplb.ccw.devno;
+    if (have_iplb || store_iplb(iplb)) {
+        IPL_assert(iplb->pbt == S390_IPL_TYPE_CCW, "IPL_TYPE_CCW expected");
+        dev_no = iplb->ccw.devno;
         debug_print_int("device no. ", dev_no);
-        net_schid.ssid = iplb.ccw.ssid & 0x3;
+        net_schid.ssid = iplb->ccw.ssid & 0x3;
         debug_print_int("ssid ", net_schid.ssid);
         found = find_net_dev(&schib, dev_no);
     } else {
Signature · 1 line
2.50.1
#56 lore raw

Re: [PATCH v6 14/28] pc-bios/s390-ccw: Define memory for IPLB and convert IPLB to pointers

Quoted 29 lines · Zhuoying Cai

Define a memory space for both IPL Parameter Block (IPLB) and IPL Information Report Block (IIRB) since IIRB is stored immediately following IPLB.

Convert IPLB to pointer and it points to the start of the defined memory space. IIRB points to the end of IPLB.

---
  pc-bios/s390-ccw/iplb.h     | 12 ++++++++++--
  pc-bios/s390-ccw/jump2ipl.c |  6 +++---
  pc-bios/s390-ccw/main.c     | 34 +++++++++++++++++++---------------
  pc-bios/s390-ccw/netmain.c  |  8 ++++----
  4 files changed, 36 insertions(+), 24 deletions(-)
pc-bios/s390-ccw/iplb.h +1 -1
index bdbc733e16..11302e004d 100644
@@ -20,7 +20,7 @@
  #include <string.h>
 
  extern QemuIplParameters qipl;
-extern IplParameterBlock iplb __attribute__((__aligned__(PAGE_SIZE)));
+extern IplParameterBlock *iplb;
  extern bool have_iplb;
 
  struct IplInfoReportBlockHeader {

pc-bios/s390-ccw/iplb.h struct IplInfoReportBlock { · line 94

Quoted 10 lines
pc-bios/s390-ccw/iplb.h +7 -0
@@ -85,6 +85,14 @@ struct IplInfoReportBlock {
  } __attribute__ ((packed));
  typedef struct IplInfoReportBlock IplInfoReportBlock;
 
+struct IplBlocks {
+    IplParameterBlock   iplb;
+    IplInfoReportBlock  iirb;
+} __attribute__ ((packed));
+typedef struct IplBlocks IplBlocks;
+
+extern IplBlocks ipl_data __attribute__((__aligned__(PAGE_SIZE)));

I think it makes more sense to specify the attribute in the .c file instead of using it here in the header.

Thomas

Quoted 140 lines
pc-bios/s390-ccw/iplb.h +1 -1
  #define S390_IPL_TYPE_FCP 0x00
  #define S390_IPL_TYPE_CCW 0x02
  #define S390_IPL_TYPE_QEMU_SCSI 0xff
@@ -127,7 +135,7 @@ static inline bool load_next_iplb(void)
 
      qipl.index++;
      next_iplb = (IplParameterBlock *) qipl.next_iplb;
-    memcpy(&iplb, next_iplb, sizeof(IplParameterBlock));
+    memcpy(iplb, next_iplb, sizeof(IplParameterBlock));
 
      qipl.chain_len--;
      qipl.next_iplb = qipl.next_iplb + sizeof(IplParameterBlock);
pc-bios/s390-ccw/jump2ipl.c +3 -3
index 86321d0f46..fa2ca5cbe1 100644
@@ -43,11 +43,11 @@ int jump_to_IPL_code(uint64_t address)
       * The IPLB for QEMU SCSI type devices must be rebuilt during re-ipl. The
       * iplb.devno is set to the boot position of the target SCSI device.
       */
-    if (iplb.pbt == S390_IPL_TYPE_QEMU_SCSI) {
-        iplb.devno = qipl.index;
+    if (iplb->pbt == S390_IPL_TYPE_QEMU_SCSI) {
+        iplb->devno = qipl.index;
      }
 
-    if (have_iplb && !set_iplb(&iplb)) {
+    if (have_iplb && !set_iplb(iplb)) {
          panic("Failed to set IPLB");
      }
 
pc-bios/s390-ccw/main.c +19 -15
index 76bf743900..c9328f1c51 100644
@@ -22,7 +22,9 @@
  static SubChannelId blk_schid = { .one = 1 };
  static char loadparm_str[LOADPARM_LEN + 1];
  QemuIplParameters qipl;
-IplParameterBlock iplb __attribute__((__aligned__(PAGE_SIZE)));
+/* Ensure that IPLB and IIRB are page aligned and sequential in memory */
+IplBlocks ipl_data;
+IplParameterBlock *iplb;
  bool have_iplb;
  static uint16_t cutype;
  LowCore *lowcore; /* Yes, this *is* a pointer to address 0 */
@@ -51,7 +53,7 @@ void write_subsystem_identification(void)
  void write_iplb_location(void)
  {
      if (cutype == CU_TYPE_VIRTIO && virtio_get_device_type() != VIRTIO_ID_NET) {
-        lowcore->ptr_iplb = ptr2u32(&iplb);
+        lowcore->ptr_iplb = ptr2u32(iplb);
      }
  }
 
@@ -162,7 +164,7 @@ static void menu_setup(void)
          return;
      }
 
-    switch (iplb.pbt) {
+    switch (iplb->pbt) {
      case S390_IPL_TYPE_CCW:
      case S390_IPL_TYPE_QEMU_SCSI:
          menu_set_parms(qipl.qipl_flags & BOOT_MENU_FLAG_MASK,
@@ -191,8 +193,8 @@ static void boot_setup(void)
  {
      char lpmsg[] = "LOADPARM=[________]\n";
 
-    if (have_iplb && memcmp(iplb.loadparm, NO_LOADPARM, LOADPARM_LEN) != 0) {
-        ebcdic_to_ascii((char *) iplb.loadparm, loadparm_str, LOADPARM_LEN);
+    if (have_iplb && memcmp(iplb->loadparm, NO_LOADPARM, LOADPARM_LEN) != 0) {
+        ebcdic_to_ascii((char *) iplb->loadparm, loadparm_str, LOADPARM_LEN);
      } else {
          sclp_get_loadparm_ascii(loadparm_str);
      }
@@ -216,21 +218,21 @@ static bool find_boot_device(void)
      VDev *vdev = virtio_get_device();
      bool found = false;
 
-    switch (iplb.pbt) {
+    switch (iplb->pbt) {
      case S390_IPL_TYPE_CCW:
          vdev->scsi_device_selected = false;
-        debug_print_int("device no. ", iplb.ccw.devno);
-        blk_schid.ssid = iplb.ccw.ssid & 0x3;
+        debug_print_int("device no. ", iplb->ccw.devno);
+        blk_schid.ssid = iplb->ccw.ssid & 0x3;
          debug_print_int("ssid ", blk_schid.ssid);
-        found = find_subch(iplb.ccw.devno);
+        found = find_subch(iplb->ccw.devno);
          break;
      case S390_IPL_TYPE_QEMU_SCSI:
          vdev->scsi_device_selected = true;
-        vdev->selected_scsi_device.channel = iplb.scsi.channel;
-        vdev->selected_scsi_device.target = iplb.scsi.target;
-        vdev->selected_scsi_device.lun = iplb.scsi.lun;
-        blk_schid.ssid = iplb.scsi.ssid & 0x3;
-        found = find_subch(iplb.scsi.devno);
+        vdev->selected_scsi_device.channel = iplb->scsi.channel;
+        vdev->selected_scsi_device.target = iplb->scsi.target;
+        vdev->selected_scsi_device.lun = iplb->scsi.lun;
+        blk_schid.ssid = iplb->scsi.ssid & 0x3;
+        found = find_subch(iplb->scsi.devno);
          break;
      default:
          puts("Unsupported IPLB");
@@ -311,10 +313,12 @@ static void probe_boot_device(void)
 
  void main(void)
  {
+    iplb = &ipl_data.iplb;
+
      copy_qipl();
      sclp_setup();
      css_setup();
-    have_iplb = store_iplb(&iplb);
+    have_iplb = store_iplb(iplb);
      if (!have_iplb) {
          boot_setup();
          probe_boot_device();
pc-bios/s390-ccw/netmain.c +4 -4
index a9521dff41..457fbc3095 100644
@@ -528,11 +528,11 @@ static bool virtio_setup(void)
       */
      enable_mss_facility();
 
-    if (have_iplb || store_iplb(&iplb)) {
-        IPL_assert(iplb.pbt == S390_IPL_TYPE_CCW, "IPL_TYPE_CCW expected");
-        dev_no = iplb.ccw.devno;
+    if (have_iplb || store_iplb(iplb)) {
+        IPL_assert(iplb->pbt == S390_IPL_TYPE_CCW, "IPL_TYPE_CCW expected");
+        dev_no = iplb->ccw.devno;
          debug_print_int("device no. ", dev_no);
-        net_schid.ssid = iplb.ccw.ssid & 0x3;
+        net_schid.ssid = iplb->ccw.ssid & 0x3;
          debug_print_int("ssid ", net_schid.ssid);
          found = find_net_dev(&schib, dev_no);
      } else {
#57 lore raw

PATCH v6 15/28 hw/s390x/ipl: Add IPIB flags to IPL Parameter Block

In reply to Zhuoying Cai

Add IPIB flags to IPL Parameter Block to determine if IPL needs to perform securely and if IPL Information Report Block (IIRB) exists.

Move DIAG308 flags to a separated header file and add flags for secure IPL.

Secure boot in audit mode will perform if certificate(s) exist in the key store. IIRB will exist and results of verification will be stored in IIRB.

To ensure proper alignment of the IIRB and prevent overlap, set iplb->len to the maximum length of the IPLB, allowing alignment constraints to be determined based on its size.

---
 hw/s390x/ipl.c                 | 17 +++++++++++++++++
 hw/s390x/ipl.h                 | 18 +-----------------
 include/hw/s390x/ipl/diag308.h | 34 ++++++++++++++++++++++++++++++++++
 include/hw/s390x/ipl/qipl.h    |  5 ++++-
 4 files changed, 56 insertions(+), 18 deletions(-)
 create mode 100644 include/hw/s390x/ipl/diag308.h
hw/s390x/ipl.c +17 -0
index 917166ba31..c1360905c4 100644
@@ -494,6 +494,23 @@ static bool s390_build_iplb(DeviceState *dev_st, IplParameterBlock *iplb)
         s390_ipl_convert_loadparm((char *)lp, iplb->loadparm);
         iplb->flags |= DIAG308_FLAGS_LP_VALID;
 
+        /*
+         * Secure boot in audit mode will perform
+         * if certificate(s) exist in the key store.
+         *
+         * IPL Information Report Block (IIRB) will exist
+         * for secure boot in audit mode.
+         *
+         * Results of secure boot will be stored in IIRB.
+         */
+        if (s390_has_certificate()) {
+            iplb->hdr_flags |= DIAG308_IPIB_FLAGS_IPLIR;
+        }
+
+        if (iplb->hdr_flags & DIAG308_IPIB_FLAGS_IPLIR) {
+            iplb->len = cpu_to_be32(S390_IPLB_MAX_LEN);
+        }
+
         return true;
     }
 
hw/s390x/ipl.h +1 -17
index e26fc1cd6a..01922d80c4 100644
@@ -23,7 +23,6 @@
 #include "qom/object.h"
 #include "target/s390x/kvm/pv.h"
 
-#define DIAG308_FLAGS_LP_VALID 0x80
 #define MAX_BOOT_DEVS 8 /* Max number of devices that may have a bootindex */
 
 void s390_ipl_convert_loadparm(char *ascii_lp, uint8_t *ebcdic_lp);
@@ -91,22 +90,6 @@ struct S390IPLState {
 };
 QEMU_BUILD_BUG_MSG(offsetof(S390IPLState, iplb) & 3, "alignment of iplb wrong");
 
-#define DIAG_308_RC_OK              0x0001
-#define DIAG_308_RC_NO_CONF         0x0102
-#define DIAG_308_RC_INVALID         0x0402
-#define DIAG_308_RC_NO_PV_CONF      0x0902
-#define DIAG_308_RC_INVAL_FOR_PV    0x0a02
-
-#define DIAG308_RESET_MOD_CLR       0
-#define DIAG308_RESET_LOAD_NORM     1
-#define DIAG308_LOAD_CLEAR          3
-#define DIAG308_LOAD_NORMAL_DUMP    4
-#define DIAG308_SET                 5
-#define DIAG308_STORE               6
-#define DIAG308_PV_SET              8
-#define DIAG308_PV_STORE            9
-#define DIAG308_PV_START            10
-
 #define S390_IPL_TYPE_FCP 0x00
 #define S390_IPL_TYPE_CCW 0x02
 #define S390_IPL_TYPE_PV 0x05
@@ -117,6 +100,7 @@ QEMU_BUILD_BUG_MSG(offsetof(S390IPLState, iplb) & 3, "alignment of iplb wrong");
 #define S390_IPLB_MIN_CCW_LEN 200
 #define S390_IPLB_MIN_FCP_LEN 384
 #define S390_IPLB_MIN_QEMU_SCSI_LEN 200
+#define S390_IPLB_MAX_LEN 4096
 
 static inline bool diag_parm_addr_valid(uint64_t addr, size_t size, bool write)
 {
include/hw/s390x/ipl/diag308.h new file +34 -0
new file mode 100644
index 0000000000..6e62f29215
@@ -0,0 +1,34 @@
+/*
+ * S/390 DIAGNOSE 308 definitions and structures
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Zhuoying Cai <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef S390X_DIAG308_H
+#define S390X_DIAG308_H
+
+#define DIAG_308_RC_OK              0x0001
+#define DIAG_308_RC_NO_CONF         0x0102
+#define DIAG_308_RC_INVALID         0x0402
+#define DIAG_308_RC_NO_PV_CONF      0x0902
+#define DIAG_308_RC_INVAL_FOR_PV    0x0a02
+
+#define DIAG308_RESET_MOD_CLR       0
+#define DIAG308_RESET_LOAD_NORM     1
+#define DIAG308_LOAD_CLEAR          3
+#define DIAG308_LOAD_NORMAL_DUMP    4
+#define DIAG308_SET                 5
+#define DIAG308_STORE               6
+#define DIAG308_PV_SET              8
+#define DIAG308_PV_STORE            9
+#define DIAG308_PV_START            10
+
+#define DIAG308_FLAGS_LP_VALID 0x80
+
+#define DIAG308_IPIB_FLAGS_SIPL 0x40
+#define DIAG308_IPIB_FLAGS_IPLIR 0x20
+
+#endif
include/hw/s390x/ipl/qipl.h +4 -1
index e505f44020..5c2bf3051c 100644
@@ -12,6 +12,8 @@
 #ifndef S390X_QIPL_H
 #define S390X_QIPL_H
 
+#include "diag308.h"
+
 /* Boot Menu flags */
 #define QIPL_FLAG_BM_OPTS_CMD   0x80
 #define QIPL_FLAG_BM_OPTS_ZIPL  0x40
@@ -103,7 +105,8 @@ typedef struct IplBlockQemuScsi IplBlockQemuScsi;
 union IplParameterBlock {
     struct {
         uint32_t len;
-        uint8_t  reserved0[3];
+        uint8_t  hdr_flags;
+        uint8_t  reserved0[2];
         uint8_t  version;
         uint32_t blk0_len;
         uint8_t  pbt;
Signature · 1 line
2.50.1
#58 lore raw

Re: [PATCH v6 15/28] hw/s390x/ipl: Add IPIB flags to IPL Parameter Block

Quoted 37 lines · Zhuoying Cai

Add IPIB flags to IPL Parameter Block to determine if IPL needs to perform securely and if IPL Information Report Block (IIRB) exists.

Move DIAG308 flags to a separated header file and add flags for secure IPL.

Secure boot in audit mode will perform if certificate(s) exist in the key store. IIRB will exist and results of verification will be stored in IIRB.

To ensure proper alignment of the IIRB and prevent overlap, set iplb->len to the maximum length of the IPLB, allowing alignment constraints to be determined based on its size.

---
  hw/s390x/ipl.c                 | 17 +++++++++++++++++
  hw/s390x/ipl.h                 | 18 +-----------------
  include/hw/s390x/ipl/diag308.h | 34 ++++++++++++++++++++++++++++++++++
  include/hw/s390x/ipl/qipl.h    |  5 ++++-
  4 files changed, 56 insertions(+), 18 deletions(-)

create mode 100644 include/hw/s390x/ipl/diag308.h

hw/s390x/ipl.c +7 -0
index 917166ba31..c1360905c4 100644
@@ -494,6 +494,23 @@ static bool s390_build_iplb(DeviceState *dev_st, IplParameterBlock *iplb)
          s390_ipl_convert_loadparm((char *)lp, iplb->loadparm);
          iplb->flags |= DIAG308_FLAGS_LP_VALID;
 
+        /*
+         * Secure boot in audit mode will perform
+         * if certificate(s) exist in the key store.
+         *
+         * IPL Information Report Block (IIRB) will exist
+         * for secure boot in audit mode.
+         *

hw/s390x/ipl.c static bool s390_build_iplb(DeviceState *dev_st, IplParameterBlock *iplb) · line 513

Quoted 10 lines
hw/s390x/ipl.c +10 -0
+         * Results of secure boot will be stored in IIRB.
+         */
+        if (s390_has_certificate()) {
+            iplb->hdr_flags |= DIAG308_IPIB_FLAGS_IPLIR;
+        }
+
+        if (iplb->hdr_flags & DIAG308_IPIB_FLAGS_IPLIR) {
+            iplb->len = cpu_to_be32(S390_IPLB_MAX_LEN);
+        }
+

Can we move the setting of iplb->len to if block that checks for certificates? I am not if we really need the if block as we only set the hdr_flags to DIAG308_IPIB_FLAGS_IPLIR only when we have certificates?

Thanks Farhan

#59 lore raw

PATCH v6 16/28 s390x: Guest support for Secure-IPL Facility

In reply to Zhuoying Cai

Introduce Secure-IPL (SIPL) facility.

Use fac_ipl to represent bytes 136 and 137 for IPL device facilities of the SCLP Read Info block.

Availability of SIPL facility is determined by byte 136 bit 1 of the SCLP Read Info block. Byte 136's facilities cannot be represented without the availability of the extended-length-SCCB, so add it as a check for consistency.

Secure IPL is not available for guests under protected virtualization.

This feature is available starting with the gen16 CPU model.

---
 hw/s390x/sclp.c                     | 2 ++
 include/hw/s390x/sclp.h             | 4 +++-
 target/s390x/cpu_features.c         | 4 ++++
 target/s390x/cpu_features.h         | 1 +
 target/s390x/cpu_features_def.h.inc | 3 +++
 target/s390x/cpu_models.c           | 2 ++
 target/s390x/gen-features.c         | 2 ++
 target/s390x/kvm/kvm.c              | 3 +++
 8 files changed, 20 insertions(+), 1 deletion(-)
hw/s390x/sclp.c +2 -0
index 9718564fa4..69d3328a3d 100644
@@ -145,6 +145,8 @@ static void read_SCP_info(SCLPDevice *sclp, SCCB *sccb)
     if (s390_has_feat(S390_FEAT_EXTENDED_LENGTH_SCCB)) {
         s390_get_feat_block(S390_FEAT_TYPE_SCLP_FAC134,
                             &read_info->fac134);
+        s390_get_feat_block(S390_FEAT_TYPE_SCLP_FAC_IPL,
+                            read_info->fac_ipl);
     }
 
     read_info->facilities = cpu_to_be64(SCLP_HAS_CPU_INFO |
include/hw/s390x/sclp.h +3 -1
index d32f6180e0..bfd330c340 100644
@@ -136,7 +136,9 @@ typedef struct ReadInfo {
     uint32_t hmfai;
     uint8_t  _reserved7[134 - 128];     /* 128-133 */
     uint8_t  fac134;
-    uint8_t  _reserved8[144 - 135];     /* 135-143 */
+    uint8_t  _reserved8;
+    uint8_t  fac_ipl[2];                /* 136-137 */
+    uint8_t  _reserved9[144 - 137];     /* 138-143 */
     struct CPUEntry entries[];
     /*
      * When the Extended-Length SCCB (ELS) feature is enabled the
target/s390x/cpu_features.c +4 -0
index 436471f4b4..200bd8c15b 100644
@@ -119,6 +119,7 @@ void s390_fill_feat_block(const S390FeatBitmap features, S390FeatType type,
      * Some facilities are not available for CPUs in protected mode:
      * - All SIE facilities because SIE is not available
      * - DIAG318
+     * - Secure IPL Facility
      *
      * As VMs can move in and out of protected mode the CPU model
      * doesn't protect us from that problem because it is only
@@ -149,6 +150,9 @@ void s390_fill_feat_block(const S390FeatBitmap features, S390FeatType type,
         clear_be_bit(s390_feat_def(S390_FEAT_DIAG_318)->bit, data);
         clear_be_bit(s390_feat_def(S390_FEAT_CERT_STORE)->bit, data);
         break;
+    case S390_FEAT_TYPE_SCLP_FAC_IPL:
+        clear_be_bit(s390_feat_def(S390_FEAT_SIPL)->bit, data);
+        break;
     default:
         return;
     }
target/s390x/cpu_features.h +1 -0
index 5635839d03..b038198555 100644
@@ -24,6 +24,7 @@ typedef enum {
     S390_FEAT_TYPE_SCLP_CONF_CHAR,
     S390_FEAT_TYPE_SCLP_CONF_CHAR_EXT,
     S390_FEAT_TYPE_SCLP_FAC134,
+    S390_FEAT_TYPE_SCLP_FAC_IPL,
     S390_FEAT_TYPE_SCLP_CPU,
     S390_FEAT_TYPE_MISC,
     S390_FEAT_TYPE_PLO,
target/s390x/cpu_features_def.h.inc +3 -0
index 941a69e013..55eef618b8 100644
@@ -140,6 +140,9 @@ DEF_FEAT(SIE_IBS, "ibs", SCLP_CONF_CHAR_EXT, 10, "SIE: Interlock-and-broadcast-s
 DEF_FEAT(DIAG_318, "diag318", SCLP_FAC134, 0, "Control program name and version codes")
 DEF_FEAT(CERT_STORE, "cstore", SCLP_FAC134, 5, "Provide Certificate Store functions")
 
+/* Features exposed via SCLP SCCB Facilities byte 136 - 137 (bit numbers relative to byte-136) */
+DEF_FEAT(SIPL, "sipl", SCLP_FAC_IPL, 1, "Secure-IPL facility")
+
 /* Features exposed via SCLP CPU info. */
 DEF_FEAT(SIE_F2, "sief2", SCLP_CPU, 4, "SIE: interception format 2 (Virtual SIE)")
 DEF_FEAT(SIE_SKEY, "skey", SCLP_CPU, 5, "SIE: Storage-key facility")
target/s390x/cpu_models.c +2 -0
index 6b8471700e..f99536ef9a 100644
@@ -263,6 +263,7 @@ bool s390_has_feat(S390Feat feat)
         case S390_FEAT_SIE_CMMA:
         case S390_FEAT_SIE_PFMFI:
         case S390_FEAT_SIE_IBS:
+        case S390_FEAT_SIPL:
         case S390_FEAT_CONFIGURATION_TOPOLOGY:
             return false;
             break;
@@ -507,6 +508,7 @@ static void check_consistency(const S390CPUModel *model)
         { S390_FEAT_AP_QUEUE_INTERRUPT_CONTROL, S390_FEAT_AP },
         { S390_FEAT_DIAG_318, S390_FEAT_EXTENDED_LENGTH_SCCB },
         { S390_FEAT_CERT_STORE, S390_FEAT_EXTENDED_LENGTH_SCCB },
+        { S390_FEAT_SIPL, S390_FEAT_EXTENDED_LENGTH_SCCB },
         { S390_FEAT_NNPA, S390_FEAT_VECTOR },
         { S390_FEAT_RDP, S390_FEAT_LOCAL_TLB_CLEARING },
         { S390_FEAT_UV_FEAT_AP, S390_FEAT_AP },
target/s390x/gen-features.c +2 -0
index 6c20c3a862..bd2060ab93 100644
@@ -721,6 +721,7 @@ static uint16_t full_GEN16_GA1[] = {
     S390_FEAT_UV_FEAT_AP,
     S390_FEAT_UV_FEAT_AP_INTR,
     S390_FEAT_CERT_STORE,
+    S390_FEAT_SIPL,
 };
 
 static uint16_t full_GEN17_GA1[] = {
@@ -922,6 +923,7 @@ static uint16_t qemu_MAX[] = {
     S390_FEAT_PRNO_TRNG,
     S390_FEAT_EXTENDED_LENGTH_SCCB,
     S390_FEAT_CERT_STORE,
+    S390_FEAT_SIPL,
 };
 
 /****** END FEATURE DEFS ******/
target/s390x/kvm/kvm.c +3 -0
index ae6cd3d506..31bd574dec 100644
@@ -2520,6 +2520,9 @@ bool kvm_s390_get_host_cpu_model(S390CPUModel *model, Error **errp)
 
     set_bit(S390_FEAT_CERT_STORE, model->features);
 
+    /* Some Secure IPL facilities are emulated by QEMU */
+    set_bit(S390_FEAT_SIPL, model->features);
+
     /* Test for Ultravisor features that influence secure guest behavior */
     query_uv_feat_guest(model->features);
 
Signature · 1 line
2.50.1
#60 lore raw

PATCH v6 17/28 pc-bios/s390-ccw: Refactor zipl_run()

In reply to Zhuoying Cai

Refactor to enhance readability before enabling secure IPL in later patches.

---
 pc-bios/s390-ccw/bootmap.c | 49 ++++++++++++++++++++++++--------------
 1 file changed, 31 insertions(+), 18 deletions(-)
pc-bios/s390-ccw/bootmap.c +31 -18
index 0f8baa0198..ff0fa78cf0 100644
@@ -674,6 +674,35 @@ static int zipl_load_segment(ComponentEntry *entry)
     return 0;
 }
 
+static int zipl_run_normal(ComponentEntry **entry_ptr, uint8_t *tmp_sec)
+{
+    ComponentEntry *entry = *entry_ptr;
+
+    while (entry->component_type == ZIPL_COMP_ENTRY_LOAD ||
+           entry->component_type == ZIPL_COMP_ENTRY_SIGNATURE) {
+
+        /* Secure boot is off, so we skip signature entries */
+        if (entry->component_type == ZIPL_COMP_ENTRY_SIGNATURE) {
+            entry++;
+            continue;
+        }
+
+        if (zipl_load_segment(entry)) {
+            return -1;
+        }
+
+        entry++;
+
+        if ((uint8_t *)&entry[1] > tmp_sec + MAX_SECTOR_SIZE) {
+            puts("Wrong entry value");
+            return -EINVAL;
+        }
+    }
+
+    *entry_ptr = entry;
+    return 0;
+}
+
 /* Run a zipl program */
 static int zipl_run(ScsiBlockPtr *pte)
 {
@@ -700,25 +729,9 @@ static int zipl_run(ScsiBlockPtr *pte)
 
     /* Load image(s) into RAM */
     entry = (ComponentEntry *)(&header[1]);
-    while (entry->component_type == ZIPL_COMP_ENTRY_LOAD ||
-           entry->component_type == ZIPL_COMP_ENTRY_SIGNATURE) {
-
-        /* We don't support secure boot yet, so we skip signature entries */
-        if (entry->component_type == ZIPL_COMP_ENTRY_SIGNATURE) {
-            entry++;
-            continue;
-        }
 
-        if (zipl_load_segment(entry)) {
-            return -1;
-        }
-
-        entry++;
-
-        if ((uint8_t *)(&entry[1]) > (tmp_sec + MAX_SECTOR_SIZE)) {
-            puts("Wrong entry value");
-            return -EINVAL;
-        }
+    if (zipl_run_normal(&entry, tmp_sec)) {
+        return -1;
     }
 
     if (entry->component_type != ZIPL_COMP_ENTRY_EXEC) {
Signature · 1 line
2.50.1
#61 lore raw

Re: [PATCH v6 17/28] pc-bios/s390-ccw: Refactor zipl_run()

Quoted 60 lines · Zhuoying Cai

Refactor to enhance readability before enabling secure IPL in later patches.

---
  pc-bios/s390-ccw/bootmap.c | 49 ++++++++++++++++++++++++--------------
  1 file changed, 31 insertions(+), 18 deletions(-)
pc-bios/s390-ccw/bootmap.c +29 -8
index 0f8baa0198..ff0fa78cf0 100644
@@ -674,6 +674,35 @@ static int zipl_load_segment(ComponentEntry *entry)
      return 0;
  }
 
+static int zipl_run_normal(ComponentEntry **entry_ptr, uint8_t *tmp_sec)
+{
+    ComponentEntry *entry = *entry_ptr;
+
+    while (entry->component_type == ZIPL_COMP_ENTRY_LOAD ||
+           entry->component_type == ZIPL_COMP_ENTRY_SIGNATURE) {
+
+        /* Secure boot is off, so we skip signature entries */
+        if (entry->component_type == ZIPL_COMP_ENTRY_SIGNATURE) {
+            entry++;
+            continue;
+        }
+
+        if (zipl_load_segment(entry)) {
+            return -1;
+        }
+
+        entry++;
+
+        if ((uint8_t *)&entry[1] > tmp_sec + MAX_SECTOR_SIZE) {
+            puts("Wrong entry value");
+            return -EINVAL;
+        }
+    }
+
+    *entry_ptr = entry;
+    return 0;
+}
+
  /* Run a zipl program */
  static int zipl_run(ScsiBlockPtr *pte)
  {
@@ -700,25 +729,9 @@ static int zipl_run(ScsiBlockPtr *pte)
 
      /* Load image(s) into RAM */
      entry = (ComponentEntry *)(&header[1]);
-    while (entry->component_type == ZIPL_COMP_ENTRY_LOAD ||
-           entry->component_type == ZIPL_COMP_ENTRY_SIGNATURE) {
-
-        /* We don't support secure boot yet, so we skip signature entries */
-        if (entry->component_type == ZIPL_COMP_ENTRY_SIGNATURE) {
-            entry++;
-            continue;
-        }

pc-bios/s390-ccw/bootmap.c static int zipl_run(ScsiBlockPtr *pte) · line 720

Quoted 10 lines
pc-bios/s390-ccw/bootmap.c +0 -9
 
-        if (zipl_load_segment(entry)) {
-            return -1;
-        }
-
-        entry++;
-
-        if ((uint8_t *)(&entry[1]) > (tmp_sec + MAX_SECTOR_SIZE)) {
-            puts("Wrong entry value");
-            return -EINVAL;

So in this case the code returned -EINVAL ...

pc-bios/s390-ccw/bootmap.c static int zipl_run(ScsiBlockPtr *pte) · line 734

Quoted 3 lines
pc-bios/s390-ccw/bootmap.c +2 -1
-        }
+    if (zipl_run_normal(&entry, tmp_sec)) {
+        return -1;

... but now it's always returning -1.

It likely does not make much difference in this case here, but it's certainly better style to preserve the error value.

Thomas

Quoted 3 lines
pc-bios/s390-ccw/bootmap.c +0 -0
      }
 
      if (entry->component_type != ZIPL_COMP_ENTRY_EXEC) {
#62 lore raw

PATCH v6 18/28 pc-bios/s390-ccw: Rework zipl_load_segment function

In reply to Zhuoying Cai

Make the address variable a parameter of zipl_load_segment and return segment length.

Modify this function to allow the caller to specify a memory address where segment data should be loaded into.

seg_len variable is necessary to store the calculated segment length and is used during signature verification. Return the length on success, or a negative return code on failure.

---
 pc-bios/s390-ccw/bootmap.c | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)
pc-bios/s390-ccw/bootmap.c +10 -5
index ff0fa78cf0..4f54c643ff 100644
@@ -613,19 +613,22 @@ static int ipl_eckd(void)
  * IPL a SCSI disk
  */
 
-static int zipl_load_segment(ComponentEntry *entry)
+/*
+ * Returns: length of the segment on sucess,
+ *          negative value on error.
+ */
+static int zipl_load_segment(ComponentEntry *entry, uint64_t address)
 {
     const int max_entries = (MAX_SECTOR_SIZE / sizeof(ScsiBlockPtr));
     ScsiBlockPtr *bprs = (void *)sec;
     const int bprs_size = sizeof(sec);
     block_number_t blockno;
-    uint64_t address;
     int i;
     char err_msg[] = "zIPL failed to read BPRS at 0xZZZZZZZZZZZZZZZZ";
     char *blk_no = &err_msg[30]; /* where to print blockno in (those ZZs) */
+    int seg_len = 0;
 
     blockno = entry->data.blockno;
-    address = entry->compdat.load_addr;
 
     debug_print_int("loading segment at block", blockno);
     debug_print_int("addr", address);
@@ -668,10 +671,12 @@ static int zipl_load_segment(ComponentEntry *entry)
                 puts("zIPL load segment failed");
                 return -EIO;
             }
+
+            seg_len += bprs->size * (bprs[i].blockct + 1);
         }
     } while (blockno);
 
-    return 0;
+    return seg_len;
 }
 
 static int zipl_run_normal(ComponentEntry **entry_ptr, uint8_t *tmp_sec)
@@ -687,7 +692,7 @@ static int zipl_run_normal(ComponentEntry **entry_ptr, uint8_t *tmp_sec)
             continue;
         }
 
-        if (zipl_load_segment(entry)) {
+        if (zipl_load_segment(entry, entry->compdat.load_addr) < 0) {
             return -1;
         }
 
Signature · 1 line
2.50.1
Reviewed-by on v6 18/28
#63 lore raw

Re: [PATCH v6 18/28] pc-bios/s390-ccw: Rework zipl_load_segment function

Quoted 6 lines · Zhuoying Cai

Make the address variable a parameter of zipl_load_segment and return segment length.

Modify this function to allow the caller to specify a memory address where segment data should be loaded into.

Quoted 6 lines

seg_len variable is necessary to store the calculated segment length and is used during signature verification. Return the length on success, or a negative return code on failure.

---

#64 lore raw

PATCH v6 19/28 pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode

In reply to Zhuoying Cai

Enable secure IPL in audit mode, which performs signature verification, but any error does not terminate the boot process. Only warnings will be logged to the console instead.

Add a comp_len variable to store the length of a segment in zipl_load_segment. comp_len variable is necessary to store the calculated segment length and is used during signature verification. Return the length on success, or a negative return code on failure.

Secure IPL in audit mode requires at least one certificate provided in the key store along with necessary facilities (Secure IPL Facility, Certificate Store Facility and secure IPL extension support).

Note: Secure IPL in audit mode is implemented for the SCSI scheme of virtio-blk/virtio-scsi devices.

---
 docs/system/s390x/secure-ipl.rst |  36 +++
 pc-bios/s390-ccw/Makefile        |   3 +-
 pc-bios/s390-ccw/bootmap.c       |  39 +++-
 pc-bios/s390-ccw/bootmap.h       |  11 +
 pc-bios/s390-ccw/main.c          |   9 +
 pc-bios/s390-ccw/s390-ccw.h      |  15 ++
 pc-bios/s390-ccw/sclp.c          |  44 ++++
 pc-bios/s390-ccw/sclp.h          |   6 +
 pc-bios/s390-ccw/secure-ipl.c    | 371 +++++++++++++++++++++++++++++++
 pc-bios/s390-ccw/secure-ipl.h    |  99 +++++++++
 10 files changed, 630 insertions(+), 3 deletions(-)
 create mode 100644 pc-bios/s390-ccw/secure-ipl.c
 create mode 100644 pc-bios/s390-ccw/secure-ipl.h
docs/system/s390x/secure-ipl.rst +36 -0
index 92c1bb2153..701594b9de 100644
@@ -19,3 +19,39 @@ Note: certificate files must have a .pem extension.
     qemu-system-s390x -machine s390-ccw-virtio, \
                                boot-certs.0.path=/.../qemu/certs, \
                                boot-certs.1.path=/another/path/cert.pem ...
+
+
+IPL Modes
+=========
+
+The concept of IPL Modes are introduced to differentiate between the IPL configurations.
+These modes are mutually exclusive and enabled based on the ``boot-certs`` option on the
+QEMU command line.
+
+Normal Mode
+-----------
+
+The absence of certificates will attempt to IPL a guest without secure IPL operations.
+No checks are performed, and no warnings/errors are reported. This is the default mode.
+
+Configuration:
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio ...
+
+Audit Mode
+----------
+
+With *only* the presence of certificates in the store, it is assumed that secure
+boot operations should be performed with errors reported as warnings. As such,
+the secure IPL operations will be performed, and any errors that stem from these
+operations will report a warning via the SCLP console.
+
+Configuration:
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio, \
+                               boot-certs.0.path=/.../qemu/certs, \
+                               boot-certs.1.path=/another/path/cert.pem ...
pc-bios/s390-ccw/Makefile +2 -1
index a0f24c94a8..603761a857 100644
@@ -34,7 +34,8 @@ QEMU_DGFLAGS = -MMD -MP -MT $@ -MF $(@D)/$(*F).d
 .PHONY : all clean build-all distclean
 
 OBJECTS = start.o main.o bootmap.o jump2ipl.o sclp.o menu.o netmain.o \
-	  virtio.o virtio-net.o virtio-scsi.o virtio-blkdev.o cio.o dasd-ipl.o
+	  virtio.o virtio-net.o virtio-scsi.o virtio-blkdev.o cio.o dasd-ipl.o \
+	  secure-ipl.o
 
 SLOF_DIR := $(SRC_PATH)/../../roms/SLOF
 
pc-bios/s390-ccw/bootmap.c +37 -2
index 4f54c643ff..3922e7cdde 100644
@@ -15,6 +15,7 @@
 #include "bootmap.h"
 #include "virtio.h"
 #include "bswap.h"
+#include "secure-ipl.h"
 
 #ifdef DEBUG
 /* #define DEBUG_FALLBACK */
@@ -617,7 +618,7 @@ static int ipl_eckd(void)
  * Returns: length of the segment on sucess,
  *          negative value on error.
  */
-static int zipl_load_segment(ComponentEntry *entry, uint64_t address)
+int zipl_load_segment(ComponentEntry *entry, uint64_t address)
 {
     const int max_entries = (MAX_SECTOR_SIZE / sizeof(ScsiBlockPtr));
     ScsiBlockPtr *bprs = (void *)sec;
@@ -735,7 +736,19 @@ static int zipl_run(ScsiBlockPtr *pte)
     /* Load image(s) into RAM */
     entry = (ComponentEntry *)(&header[1]);
 
-    if (zipl_run_normal(&entry, tmp_sec)) {
+    switch (boot_mode) {
+    case ZIPL_BOOT_MODE_SECURE_AUDIT:
+        if (zipl_run_secure(&entry, tmp_sec)) {
+            return -1;
+        }
+        break;
+    case ZIPL_BOOT_MODE_NORMAL:
+        if (zipl_run_normal(&entry, tmp_sec)) {
+            return -1;
+        }
+        break;
+    default:
+        puts("Unknown boot mode");
         return -1;
     }
 
@@ -1101,17 +1114,35 @@ static int zipl_load_vscsi(void)
  * IPL starts here
  */
 
+ZiplBootMode zipl_mode(uint8_t hdr_flags)
+{
+    bool sipl_set = hdr_flags & DIAG308_IPIB_FLAGS_SIPL;
+    bool iplir_set = hdr_flags & DIAG308_IPIB_FLAGS_IPLIR;
+
+    if (!sipl_set && iplir_set) {
+        return ZIPL_BOOT_MODE_SECURE_AUDIT;
+    }
+
+    return ZIPL_BOOT_MODE_NORMAL;
+}
+
 void zipl_load(void)
 {
     VDev *vdev = virtio_get_device();
 
     if (vdev->is_cdrom) {
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+            panic("Secure boot from ISO image is not supported!");
+        }
         ipl_iso_el_torito();
         puts("Failed to IPL this ISO image!");
         return;
     }
 
     if (virtio_get_device_type() == VIRTIO_ID_NET) {
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+            panic("Virtio net boot device does not support secure boot!");
+        }
         netmain();
         puts("Failed to IPL from this network!");
         return;
@@ -1122,6 +1153,10 @@ void zipl_load(void)
         return;
     }
 
+    if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+        panic("ECKD boot device does not support secure boot!");
+    }
+
     switch (virtio_get_device_type()) {
     case VIRTIO_ID_BLOCK:
         zipl_load_vblk();
pc-bios/s390-ccw/bootmap.h +11 -0
index 95943441d3..90fd530256 100644
@@ -88,9 +88,18 @@ typedef struct BootMapTable {
     BootMapPointer entry[];
 } __attribute__ ((packed)) BootMapTable;
 
+#define DER_SIGNATURE_FORMAT 1
+
+typedef struct SignatureInformation {
+    uint8_t format;
+    uint8_t reserved[3];
+    uint32_t sig_len;
+} __attribute__((packed)) SignatureInformation;
+
 typedef union ComponentEntryData {
     uint64_t load_psw;
     uint64_t load_addr;
+    SignatureInformation sig_info;
 } ComponentEntryData;
 
 typedef struct ComponentEntry {
@@ -113,6 +122,8 @@ typedef struct ScsiMbr {
     ScsiBlockPtr pt;   /* block pointer to program table */
 } __attribute__ ((packed)) ScsiMbr;
 
+int zipl_load_segment(ComponentEntry *entry, uint64_t address);
+
 #define ZIPL_MAGIC              "zIPL"
 #define ZIPL_MAGIC_EBCDIC       "\xa9\xc9\xd7\xd3"
 #define IPL1_MAGIC "\xc9\xd7\xd3\xf1" /* == "IPL1" in EBCDIC */
pc-bios/s390-ccw/main.c +9 -0
index c9328f1c51..668660e64d 100644
@@ -28,6 +28,7 @@ IplParameterBlock *iplb;
 bool have_iplb;
 static uint16_t cutype;
 LowCore *lowcore; /* Yes, this *is* a pointer to address 0 */
+ZiplBootMode boot_mode;
 
 #define LOADPARM_PROMPT "PROMPT  "
 #define LOADPARM_EMPTY  "        "
@@ -272,9 +273,17 @@ static int virtio_setup(void)
 
 static void ipl_boot_device(void)
 {
+    if (boot_mode == ZIPL_BOOT_MODE_UNSPECIFIED) {
+        boot_mode = zipl_mode(iplb->hdr_flags);
+    }
+
     switch (cutype) {
     case CU_TYPE_DASD_3990:
     case CU_TYPE_DASD_2107:
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+            panic("Passthrough (vfio) device does not support secure boot!");
+        }
+
         dasd_ipl(blk_schid, cutype);
         break;
     case CU_TYPE_VIRTIO:
pc-bios/s390-ccw/s390-ccw.h +15 -0
index b1dc35cded..c2ba40d067 100644
@@ -39,6 +39,9 @@ typedef unsigned long long u64;
 #define MIN_NON_ZERO(a, b) ((a) == 0 ? (b) : \
                             ((b) == 0 ? (a) : (MIN(a, b))))
 #endif
+#ifndef ROUND_UP
+#define ROUND_UP(n, d) (((n) + (d) - 1) & -(0 ? (n) : (d)))
+#endif
 
 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
 
@@ -64,6 +67,8 @@ void sclp_print(const char *string);
 void sclp_set_write_mask(uint32_t receive_mask, uint32_t send_mask);
 void sclp_setup(void);
 void sclp_get_loadparm_ascii(char *loadparm);
+bool sclp_is_diag320_on(void);
+bool sclp_is_sipl_on(void);
 int sclp_read(char *str, size_t count);
 
 /* virtio.c */
@@ -76,6 +81,16 @@ int virtio_read(unsigned long sector, void *load_addr);
 /* bootmap.c */
 void zipl_load(void);
 
+typedef enum ZiplBootMode {
+    ZIPL_BOOT_MODE_UNSPECIFIED = 0,
+    ZIPL_BOOT_MODE_NORMAL = 1,
+    ZIPL_BOOT_MODE_SECURE_AUDIT = 2,
+} ZiplBootMode;
+
+extern ZiplBootMode boot_mode;
+
+ZiplBootMode zipl_mode(uint8_t hdr_flags);
+
 /* jump2ipl.c */
 void write_reset_psw(uint64_t psw);
 int jump_to_IPL_code(uint64_t address);
pc-bios/s390-ccw/sclp.c +44 -0

50 lines not on this page · raw message

pc-bios/s390-ccw/sclp.h +6 -0
index 64b53cad29..cf147f4634 100644
@@ -50,6 +50,8 @@ typedef struct SCCBHeader {
 } __attribute__((packed)) SCCBHeader;
 
 #define SCCB_DATA_LEN (SCCB_SIZE - sizeof(SCCBHeader))
+#define SCCB_FAC134_DIAG320_BIT 0x4
+#define SCCB_FAC_IPL_SIPL_BIT 0x4000
 
 typedef struct ReadInfo {
     SCCBHeader h;
@@ -57,6 +59,10 @@ typedef struct ReadInfo {
     uint8_t rnsize;
     uint8_t reserved[13];
     uint8_t loadparm[LOADPARM_LEN];
+    uint8_t reserved1[102];
+    uint8_t fac134;
+    uint8_t reserved2;
+    uint16_t fac_ipl;
 } __attribute__((packed)) ReadInfo;
 
 typedef struct SCCB {
pc-bios/s390-ccw/secure-ipl.c new file +371 -0

371 lines not on this page · raw message

pc-bios/s390-ccw/secure-ipl.h new file +99 -0

99 lines not on this page · raw message

Signature · 1 line
2.50.1
#65 lore raw

Re: [PATCH v6 19/28] pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode

Quoted 37 lines · Zhuoying Cai

Enable secure IPL in audit mode, which performs signature verification, but any error does not terminate the boot process. Only warnings will be logged to the console instead.

Add a comp_len variable to store the length of a segment in zipl_load_segment. comp_len variable is necessary to store the calculated segment length and is used during signature verification. Return the length on success, or a negative return code on failure.

Secure IPL in audit mode requires at least one certificate provided in the key store along with necessary facilities (Secure IPL Facility, Certificate Store Facility and secure IPL extension support).

Note: Secure IPL in audit mode is implemented for the SCSI scheme of virtio-blk/virtio-scsi devices.

---
  docs/system/s390x/secure-ipl.rst |  36 +++
  pc-bios/s390-ccw/Makefile        |   3 +-
  pc-bios/s390-ccw/bootmap.c       |  39 +++-
  pc-bios/s390-ccw/bootmap.h       |  11 +
  pc-bios/s390-ccw/main.c          |   9 +
  pc-bios/s390-ccw/s390-ccw.h      |  15 ++
  pc-bios/s390-ccw/sclp.c          |  44 ++++
  pc-bios/s390-ccw/sclp.h          |   6 +
  pc-bios/s390-ccw/secure-ipl.c    | 371 +++++++++++++++++++++++++++++++
  pc-bios/s390-ccw/secure-ipl.h    |  99 +++++++++
  10 files changed, 630 insertions(+), 3 deletions(-)

create mode 100644 pc-bios/s390-ccw/secure-ipl.c create mode 100644 pc-bios/s390-ccw/secure-ipl.h

docs/system/s390x/secure-ipl.rst +0 -0
index 92c1bb2153..701594b9de 100644

docs/system/s390x/secure-ipl.rst Note: certificate files must have a .pem extension. · line 27

Quoted 9 lines
docs/system/s390x/secure-ipl.rst +6 -0
@@ -19,3 +19,39 @@ Note: certificate files must have a .pem extension.
      qemu-system-s390x -machine s390-ccw-virtio, \
                                 boot-certs.0.path=/.../qemu/certs, \
                                 boot-certs.1.path=/another/path/cert.pem ...
+
+
+IPL Modes
+=========
+
+The concept of IPL Modes are introduced to differentiate between the IPL configurations.

This is not a commit description, but documentation that persists, so "are introduced" sounds wrong here.

Maybe rather something like:

Multiple IPL modes are available to differentiate between the various IPL configurations.

?

Quoted 12 lines
docs/system/s390x/secure-ipl.rst +12 -0
+These modes are mutually exclusive and enabled based on the ``boot-certs`` option on the
+QEMU command line.
+
+Normal Mode
+-----------
+
+The absence of certificates will attempt to IPL a guest without secure IPL operations.
+No checks are performed, and no warnings/errors are reported. This is the default mode.
+
+Configuration:
+
+.. code-block:: shell

docs/system/s390x/secure-ipl.rst Note: certificate files must have a .pem extension. · line 49

Quoted 10 lines
docs/system/s390x/secure-ipl.rst +10 -0
+
+    qemu-system-s390x -machine s390-ccw-virtio ...
+
+Audit Mode
+----------
+
+With *only* the presence of certificates in the store, it is assumed that secure
+boot operations should be performed with errors reported as warnings. As such,
+the secure IPL operations will be performed, and any errors that stem from these
+operations will report a warning via the SCLP console.

"errors ... will report a warning" sounds weird. maybe rather: "errors ... will result in a warning" ?

...

Quoted 5 lines
pc-bios/s390-ccw/bootmap.h +0 -0
index 95943441d3..90fd530256 100644

pc-bios/s390-ccw/bootmap.h typedef struct BootMapTable { · line 97

Quoted 10 lines
pc-bios/s390-ccw/bootmap.h +7 -0
@@ -88,9 +88,18 @@ typedef struct BootMapTable {
      BootMapPointer entry[];
  } __attribute__ ((packed)) BootMapTable;
 
+#define DER_SIGNATURE_FORMAT 1
+
+typedef struct SignatureInformation {
+    uint8_t format;
+    uint8_t reserved[3];
+    uint32_t sig_len;
+} __attribute__((packed)) SignatureInformation;

Everything is naturally aligned, no need to use packed here.

Thomas

#66 lore raw

Re: [PATCH v6 19/28] pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode

In reply to Zhuoying Cai
Quoted 200 lines · Zhuoying Cai

Enable secure IPL in audit mode, which performs signature verification, but any error does not terminate the boot process. Only warnings will be logged to the console instead.

Add a comp_len variable to store the length of a segment in zipl_load_segment. comp_len variable is necessary to store the calculated segment length and is used during signature verification. Return the length on success, or a negative return code on failure.

Secure IPL in audit mode requires at least one certificate provided in the key store along with necessary facilities (Secure IPL Facility, Certificate Store Facility and secure IPL extension support).

Note: Secure IPL in audit mode is implemented for the SCSI scheme of virtio-blk/virtio-scsi devices.

---
  docs/system/s390x/secure-ipl.rst |  36 +++
  pc-bios/s390-ccw/Makefile        |   3 +-
  pc-bios/s390-ccw/bootmap.c       |  39 +++-
  pc-bios/s390-ccw/bootmap.h       |  11 +
  pc-bios/s390-ccw/main.c          |   9 +
  pc-bios/s390-ccw/s390-ccw.h      |  15 ++
  pc-bios/s390-ccw/sclp.c          |  44 ++++
  pc-bios/s390-ccw/sclp.h          |   6 +
  pc-bios/s390-ccw/secure-ipl.c    | 371 +++++++++++++++++++++++++++++++
  pc-bios/s390-ccw/secure-ipl.h    |  99 +++++++++
  10 files changed, 630 insertions(+), 3 deletions(-)

create mode 100644 pc-bios/s390-ccw/secure-ipl.c create mode 100644 pc-bios/s390-ccw/secure-ipl.h

docs/system/s390x/secure-ipl.rst +36 -0
index 92c1bb2153..701594b9de 100644
@@ -19,3 +19,39 @@ Note: certificate files must have a .pem extension.
      qemu-system-s390x -machine s390-ccw-virtio, \
                                 boot-certs.0.path=/.../qemu/certs, \
                                 boot-certs.1.path=/another/path/cert.pem ...
+
+
+IPL Modes
+=========
+
+The concept of IPL Modes are introduced to differentiate between the IPL configurations.
+These modes are mutually exclusive and enabled based on the ``boot-certs`` option on the
+QEMU command line.
+
+Normal Mode
+-----------
+
+The absence of certificates will attempt to IPL a guest without secure IPL operations.
+No checks are performed, and no warnings/errors are reported. This is the default mode.
+
+Configuration:
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio ...
+
+Audit Mode
+----------
+
+With *only* the presence of certificates in the store, it is assumed that secure
+boot operations should be performed with errors reported as warnings. As such,
+the secure IPL operations will be performed, and any errors that stem from these
+operations will report a warning via the SCLP console.
+
+Configuration:
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio, \
+                               boot-certs.0.path=/.../qemu/certs, \
+                               boot-certs.1.path=/another/path/cert.pem ...
pc-bios/s390-ccw/Makefile +2 -1
index a0f24c94a8..603761a857 100644
@@ -34,7 +34,8 @@ QEMU_DGFLAGS = -MMD -MP -MT $@ -MF $(@D)/$(*F).d
  .PHONY : all clean build-all distclean
 
  OBJECTS = start.o main.o bootmap.o jump2ipl.o sclp.o menu.o netmain.o \
-	  virtio.o virtio-net.o virtio-scsi.o virtio-blkdev.o cio.o dasd-ipl.o
+	  virtio.o virtio-net.o virtio-scsi.o virtio-blkdev.o cio.o dasd-ipl.o \
+	  secure-ipl.o
 
  SLOF_DIR := $(SRC_PATH)/../../roms/SLOF
 
pc-bios/s390-ccw/bootmap.c +1 -0
index 4f54c643ff..3922e7cdde 100644
@@ -15,6 +15,7 @@
  #include "bootmap.h"
  #include "virtio.h"
  #include "bswap.h"
+#include "secure-ipl.h" #ifdef DEBUG /* #define DEBUG_FALLBACK */ @@ -617,7 +618,7 @@ static 

int ipl_eckd(void) * Returns: length of the segment on sucess, * negative value on error. */ -static int zipl_load_segment(ComponentEntry *entry, uint64_t address) +int zipl_load_segment(ComponentEntry *entry, uint64_t address) { const int max_entries = (MAX_SECTOR_SIZE / sizeof(ScsiBlockPtr)); ScsiBlockPtr *bprs = (void *)sec; @@ -735,7 +736,19 @@ static int zipl_run(ScsiBlockPtr *pte) /* Load image(s) into RAM */ entry = (ComponentEntry *)(&header[1]); - if (zipl_run_normal(&entry, tmp_sec)) { + switch (boot_mode) { + case ZIPL_BOOT_MODE_SECURE_AUDIT:
+ if (zipl_run_secure(&entry, tmp_sec)) { + return -1; + } + break; +
case ZIPL_BOOT_MODE_NORMAL: + if (zipl_run_normal(&entry, tmp_sec)) {

+ return -1; + } + break; + default: + puts("Unknown boot mode");
          return -1;
      }
pc-bios/s390-ccw/bootmap.c +22 -0
@@ -1101,17 +1114,35 @@ static int zipl_load_vscsi(void)
   * IPL starts here
   */
 
+ZiplBootMode zipl_mode(uint8_t hdr_flags)
+{
+    bool sipl_set = hdr_flags & DIAG308_IPIB_FLAGS_SIPL;
+    bool iplir_set = hdr_flags & DIAG308_IPIB_FLAGS_IPLIR;
+
+    if (!sipl_set && iplir_set) {
+        return ZIPL_BOOT_MODE_SECURE_AUDIT;
+    }
+
+    return ZIPL_BOOT_MODE_NORMAL;
+}
+
  void zipl_load(void)
  {
      VDev *vdev = virtio_get_device();
 
      if (vdev->is_cdrom) {
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+            panic("Secure boot from ISO image is not supported!");
+        }
          ipl_iso_el_torito();
          puts("Failed to IPL this ISO image!");
          return;
      }
 
      if (virtio_get_device_type() == VIRTIO_ID_NET) {
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+            panic("Virtio net boot device does not support secure boot!");
+        }
          netmain();
          puts("Failed to IPL from this network!");
          return;
@@ -1122,6 +1153,10 @@ void zipl_load(void)
          return;
      }
 
+    if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+        panic("ECKD boot device does not support secure boot!");
+    }
+
      switch (virtio_get_device_type()) {
      case VIRTIO_ID_BLOCK:
          zipl_load_vblk();
pc-bios/s390-ccw/bootmap.h +11 -0
index 95943441d3..90fd530256 100644
@@ -88,9 +88,18 @@ typedef struct BootMapTable {
      BootMapPointer entry[];
  } __attribute__ ((packed)) BootMapTable;
 
+#define DER_SIGNATURE_FORMAT 1
+
+typedef struct SignatureInformation {
+    uint8_t format;
+    uint8_t reserved[3];
+    uint32_t sig_len;
+} __attribute__((packed)) SignatureInformation;
+
  typedef union ComponentEntryData {
      uint64_t load_psw;
      uint64_t load_addr;
+    SignatureInformation sig_info;
  } ComponentEntryData;
 
  typedef struct ComponentEntry {
@@ -113,6 +122,8 @@ typedef struct ScsiMbr {
      ScsiBlockPtr pt;   /* block pointer to program table */
  } __attribute__ ((packed)) ScsiMbr;
 
+int zipl_load_segment(ComponentEntry *entry, uint64_t address);
+
  #define ZIPL_MAGIC              "zIPL"
  #define ZIPL_MAGIC_EBCDIC       "\xa9\xc9\xd7\xd3"
  #define IPL1_MAGIC "\xc9\xd7\xd3\xf1" /* == "IPL1" in EBCDIC */
pc-bios/s390-ccw/main.c +1 -0
index c9328f1c51..668660e64d 100644
@@ -28,6 +28,7 @@ IplParameterBlock *iplb;
  bool have_iplb;
  static uint16_t cutype;
  LowCore *lowcore; /* Yes, this *is* a pointer to address 0 */
+ZiplBootMode boot_mode;
 
  #define LOADPARM_PROMPT "PROMPT  "
  #define LOADPARM_EMPTY  "        "
@@ -272,9 +273,17 @@ static int virtio_setup(void)
 
  static void ipl_boot_device(void)

pc-bios/s390-ccw/main.c static int virtio_setup(void) · line 284

Quoted 10 lines
pc-bios/s390-ccw/main.c +6 -0
  {
+    if (boot_mode == ZIPL_BOOT_MODE_UNSPECIFIED) {
+        boot_mode = zipl_mode(iplb->hdr_flags);
+    }
+
      switch (cutype) {
      case CU_TYPE_DASD_3990:
      case CU_TYPE_DASD_2107:
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+            panic("Passthrough (vfio) device does not support secure boot!");

Nit: We could be more specific here and mention "Passthrough (vfio) CCW device...". I know we don't support any other vfio device for booting today but just makes it clear what kind of passthrough device we are dealing with.

Quoted 150 lines
pc-bios/s390-ccw/main.c +2 -0
+        }
+
          dasd_ipl(blk_schid, cutype);
          break;
      case CU_TYPE_VIRTIO:
pc-bios/s390-ccw/s390-ccw.h +15 -0
index b1dc35cded..c2ba40d067 100644
@@ -39,6 +39,9 @@ typedef unsigned long long u64;
  #define MIN_NON_ZERO(a, b) ((a) == 0 ? (b) : \
                              ((b) == 0 ? (a) : (MIN(a, b))))
  #endif
+#ifndef ROUND_UP
+#define ROUND_UP(n, d) (((n) + (d) - 1) & -(0 ? (n) : (d)))
+#endif
 
  #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
 
@@ -64,6 +67,8 @@ void sclp_print(const char *string);
  void sclp_set_write_mask(uint32_t receive_mask, uint32_t send_mask);
  void sclp_setup(void);
  void sclp_get_loadparm_ascii(char *loadparm);
+bool sclp_is_diag320_on(void);
+bool sclp_is_sipl_on(void);
  int sclp_read(char *str, size_t count);
 
  /* virtio.c */
@@ -76,6 +81,16 @@ int virtio_read(unsigned long sector, void *load_addr);
  /* bootmap.c */
  void zipl_load(void);
 
+typedef enum ZiplBootMode {
+    ZIPL_BOOT_MODE_UNSPECIFIED = 0,
+    ZIPL_BOOT_MODE_NORMAL = 1,
+    ZIPL_BOOT_MODE_SECURE_AUDIT = 2,
+} ZiplBootMode;
+
+extern ZiplBootMode boot_mode;
+
+ZiplBootMode zipl_mode(uint8_t hdr_flags);
+
  /* jump2ipl.c */
  void write_reset_psw(uint64_t psw);
  int jump_to_IPL_code(uint64_t address);
pc-bios/s390-ccw/sclp.c +44 -0
index 4a07de018d..0b03c3164f 100644
@@ -113,6 +113,50 @@ void sclp_get_loadparm_ascii(char *loadparm)
      }
  }
 
+static void sclp_get_fac134(uint8_t *fac134)
+{
+
+    ReadInfo *sccb = (void *)_sccb;
+
+    memset((char *)_sccb, 0, sizeof(ReadInfo));
+    sccb->h.length = SCCB_SIZE;
+    if (!sclp_service_call(SCLP_CMDW_READ_SCP_INFO, sccb)) {
+        *fac134 = sccb->fac134;
+    }
+}
+
+bool sclp_is_diag320_on(void)
+{
+    uint8_t fac134 = 0;
+
+    sclp_get_fac134(&fac134);
+    return fac134 & SCCB_FAC134_DIAG320_BIT;
+}
+
+/*
+ * Get fac_ipl (byte 136 and byte 137 of the SCLP Read Info block)
+ * for IPL device facilities.
+ */
+static void sclp_get_fac_ipl(uint16_t *fac_ipl)
+{
+
+    ReadInfo *sccb = (void *)_sccb;
+
+    memset((char *)_sccb, 0, sizeof(ReadInfo));
+    sccb->h.length = SCCB_SIZE;
+    if (!sclp_service_call(SCLP_CMDW_READ_SCP_INFO, sccb)) {
+        *fac_ipl = sccb->fac_ipl;
+    }
+}
+
+bool sclp_is_sipl_on(void)
+{
+    uint16_t fac_ipl = 0;
+
+    sclp_get_fac_ipl(&fac_ipl);
+    return fac_ipl & SCCB_FAC_IPL_SIPL_BIT;
+}
+
  int sclp_read(char *str, size_t count)
  {
      ReadEventData *sccb = (void *)_sccb;
pc-bios/s390-ccw/sclp.h +6 -0
index 64b53cad29..cf147f4634 100644
@@ -50,6 +50,8 @@ typedef struct SCCBHeader {
  } __attribute__((packed)) SCCBHeader;
 
  #define SCCB_DATA_LEN (SCCB_SIZE - sizeof(SCCBHeader))
+#define SCCB_FAC134_DIAG320_BIT 0x4
+#define SCCB_FAC_IPL_SIPL_BIT 0x4000
 
  typedef struct ReadInfo {
      SCCBHeader h;
@@ -57,6 +59,10 @@ typedef struct ReadInfo {
      uint8_t rnsize;
      uint8_t reserved[13];
      uint8_t loadparm[LOADPARM_LEN];
+    uint8_t reserved1[102];
+    uint8_t fac134;
+    uint8_t reserved2;
+    uint16_t fac_ipl;
  } __attribute__((packed)) ReadInfo;
 
  typedef struct SCCB {
pc-bios/s390-ccw/secure-ipl.c new file +20 -0
new file mode 100644
index 0000000000..8eab19cb09
@@ -0,0 +1,371 @@
+/*
+ * S/390 Secure IPL
+ *
+ * Functions to support IPL in secure boot mode (DIAG 320, DIAG 508,
+ * signature verification, and certificate handling).
+ *
+ * For secure IPL overview: docs/system/s390x/secure-ipl.rst
+ * For secure IPL technical: docs/specs/s390x-secure-ipl.rst
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Zhuoying Cai<[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#include <stdlib.h>
+#include <string.h>
+#include <stdio.h>
+#include "bootmap.h"
+#include "s390-ccw.h"

pc-bios/s390-ccw/secure-ipl.c line 30

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c new file +10 -0
+#include "secure-ipl.h"
+
+uint8_t vcssb_data[VCSSB_MIN_LEN] __attribute__((__aligned__(PAGE_SIZE)));
+
+VCStorageSizeBlock *zipl_secure_get_vcssb(void)
+{
+    VCStorageSizeBlock *vcssb;
+    int rc;
+
+    if (!(sclp_is_diag320_on() && is_cert_store_facility_supported())) {

Should we fail if either diag320 or certificate store is not available? Might make the check simpler

Quoted 43 lines
pc-bios/s390-ccw/secure-ipl.c new file +43 -0
+        puts("Certificate Store Facility is not supported by the hypervisor!");
+        return NULL;
+    }
+
+    vcssb = (VCStorageSizeBlock *)vcssb_data;
+    /* avoid retrieving vcssb multiple times */
+    if (vcssb->length >= VCSSB_MIN_LEN) {
+        return vcssb;
+    }
+
+    vcssb->length = VCSSB_MIN_LEN;
+    rc = diag320(vcssb, DIAG_320_SUBC_QUERY_VCSI);
+    if (rc != DIAG_320_RC_OK) {
+        return NULL;
+    }
+
+    return vcssb;
+}
+
+static uint32_t get_certs_length(void)
+{
+    VCStorageSizeBlock *vcssb;
+    uint32_t len;
+
+    vcssb = zipl_secure_get_vcssb();
+    if (vcssb == NULL) {
+        return 0;
+    }
+
+    len = vcssb->total_vcb_len - VCB_HEADER_LEN - vcssb->total_vc_ct * VCE_HEADER_LEN;
+
+    return len;
+}
+
+static uint32_t request_certificate(uint8_t *cert, uint8_t index)
+{
+    VCStorageSizeBlock *vcssb;
+    VCBlock *vcb;
+    VCEntry *vce;
+    uint64_t rc = 0;
+    uint32_t cert_len = 0;
+
+    /* Get Verification Certificate Storage Size block with DIAG320 subcode 1 */

pc-bios/s390-ccw/secure-ipl.c line 83

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c new file +10 -0
+    vcssb = zipl_secure_get_vcssb();
+    if (vcssb == NULL) {
+        return 0;
+    }
+
+    /*
+     * Request single entry
+     * Fill input fields of single-entry VCB
+     */
+    vcb = malloc(MAX_SECTOR_SIZE * 4);

Why are we using MAX_SECTOR _SIZE? Shouldn't we use max_single_vcb_len to allocate the memory for vcb?

pc-bios/s390-ccw/secure-ipl.c line 89

Quoted 6 lines
pc-bios/s390-ccw/secure-ipl.c new file +6 -0
+    vcb->in_len = ROUND_UP(vcssb->max_single_vcb_len, PAGE_SIZE);
+    vcb->first_vc_index = index + 1;
+    vcb->last_vc_index = index + 1;
+
+    rc = diag320(vcb, DIAG_320_SUBC_STORE_VC);
+    if (rc == DIAG_320_RC_OK) {

Nit: We could just check if rc != DIAG_320_RC_OK and goto out. This way we avoid a bigger if block.

Quoted 146 lines
pc-bios/s390-ccw/secure-ipl.c new file +146 -0
+        if (vcb->out_len == VCB_HEADER_LEN) {
+            puts("No certificate entry");
+            goto out;
+        }
+        if (vcb->remain_ct != 0) {
+            puts("Not enough memory to store all requested certificates");
+            goto out;
+        }
+
+        vce = (VCEntry *)vcb->vce_buf;
+        if (!is_vce_cert_valid(vce->flags, vce->len)) {
+            puts("Invalid certificate");
+            goto out;
+        }
+
+        cert_len = vce->cert_len;
+        memcpy(cert, (uint8_t *)vce + vce->cert_offset, vce->cert_len);
+    }
+
+out:
+    free(vcb);
+    return cert_len;
+}
+
+static void cert_list_add(IplSignatureCertificateList *certs, int cert_index,
+                          uint8_t *cert, uint64_t cert_len)
+{
+    if (cert_index > MAX_CERTIFICATES - 1) {
+        printf("Warning: Ignoring cert entry [%d] because it's over %d entires\n",
+                cert_index + 1, MAX_CERTIFICATES);
+        return;
+    }
+
+    certs->cert_entries[cert_index].addr = (uint64_t)cert;
+    certs->cert_entries[cert_index].len = cert_len;
+    certs->ipl_info_header.len += sizeof(certs->cert_entries[cert_index]);
+}
+
+static void comp_list_add(IplDeviceComponentList *comps, int comp_index,
+                          int cert_index, uint64_t comp_addr,
+                          uint64_t comp_len, uint8_t flags)
+{
+    if (comp_index > MAX_CERTIFICATES - 1) {
+        printf("Warning: Ignoring comp entry [%d] because it's over %d entires\n",
+                comp_index + 1, MAX_CERTIFICATES);
+        return;
+    }
+
+    comps->device_entries[comp_index].addr = comp_addr;
+    comps->device_entries[comp_index].len = comp_len;
+    comps->device_entries[comp_index].flags = flags;
+    comps->device_entries[comp_index].cert_index = cert_index;
+    comps->ipl_info_header.len += sizeof(comps->device_entries[comp_index]);
+}
+
+static int update_iirb(IplDeviceComponentList *comps, IplSignatureCertificateList *certs)
+{
+    IplInfoReportBlock *iirb;
+    IplDeviceComponentList *iirb_comps;
+    IplSignatureCertificateList *iirb_certs;
+    uint32_t iirb_hdr_len;
+    uint32_t comps_len;
+    uint32_t certs_len;
+
+    if (iplb->len % 8 != 0) {
+        panic("IPL parameter block length field value is not multiple of 8 bytes");
+    }
+
+    iirb_hdr_len = sizeof(IplInfoReportBlockHeader);
+    comps_len = comps->ipl_info_header.len;
+    certs_len = certs->ipl_info_header.len;
+    if ((comps_len + certs_len + iirb_hdr_len) > sizeof(IplInfoReportBlock)) {
+        puts("Not enough space to hold all components and certificates in IIRB");
+        return -1;
+    }
+
+    /* IIRB immediately follows IPLB */
+    iirb = &ipl_data.iirb;
+    iirb->hdr.len = iirb_hdr_len;
+
+    /* Copy IPL device component list after IIRB Header */
+    iirb_comps = (IplDeviceComponentList *) iirb->info_blks;
+    memcpy(iirb_comps, comps, comps_len);
+
+    /* Update IIRB length */
+    iirb->hdr.len += comps_len;
+
+    /* Copy IPL sig cert list after IPL device component list */
+    iirb_certs = (IplSignatureCertificateList *) (iirb->info_blks +
+                                                  iirb_comps->ipl_info_header.len);
+    memcpy(iirb_certs, certs, certs_len);
+
+    /* Update IIRB length */
+    iirb->hdr.len += certs_len;
+
+    return 0;
+}
+
+static bool secure_ipl_supported(void)
+{
+    if (!sclp_is_sipl_on()) {
+        puts("Secure IPL Facility is not supported by the hypervisor!");
+        return false;
+    }
+
+    if (!is_secure_ipl_extension_supported()) {
+        puts("Secure IPL extensions are not supported by the hypervisor!");
+        return false;
+    }
+
+    if (!(sclp_is_diag320_on() && is_cert_store_facility_supported())) {
+        puts("Certificate Store Facility is not supported by the hypervisor!");
+        return false;
+    }
+
+    return true;
+}
+
+static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateList *certs)
+{
+    comps->ipl_info_header.ibt = IPL_IBT_COMPONENTS;
+    comps->ipl_info_header.len = sizeof(comps->ipl_info_header);
+
+    certs->ipl_info_header.ibt = IPL_IBT_CERTIFICATES;
+    certs->ipl_info_header.len = sizeof(certs->ipl_info_header);
+}
+
+static uint32_t zipl_load_signature(ComponentEntry *entry, uint64_t sig_sec)
+{
+    uint32_t sig_len;
+
+    if (zipl_load_segment(entry, sig_sec) < 0) {
+        return -1;
+    }
+
+    if (entry->compdat.sig_info.format != DER_SIGNATURE_FORMAT) {
+        puts("Signature is not in DER format");
+        return -1;
+    }
+    sig_len = entry->compdat.sig_info.sig_len;
+
+    return sig_len;
+}
+
+static int handle_certificate(int *cert_table, uint8_t **cert,
+                             uint64_t cert_len, uint8_t cert_idx,

pc-bios/s390-ccw/secure-ipl.c line 245

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c new file +10 -0
+                             IplSignatureCertificateList *certs, int cert_index)
+{
+    bool unused;
+
+    unused = cert_table[cert_idx] == -1;
+    if (unused) {
+        if (request_certificate(*cert, cert_idx)) {
+            cert_list_add(certs, cert_index, *cert, cert_len);
+            cert_table[cert_idx] = cert_index;
+            *cert += cert_len;

It's hard to understand why we increment *cert in this function by just looking at the function. But this function is called in the loop in zipl_run_secure, could we move this entire function in zipl_run_secure?

Quoted 16 lines
pc-bios/s390-ccw/secure-ipl.c new file +16 -0
+        } else {
+            puts("Could not get certificate");
+            return -1;
+        }
+
+        /* increment cert_index for the next cert entry */
+        return ++cert_index;
+    }
+
+    return cert_index;
+}
+
+int zipl_run_secure(ComponentEntry **entry_ptr, uint8_t *tmp_sec)
+{
+    IplDeviceComponentList comps;
+    IplSignatureCertificateList certs;

pc-bios/s390-ccw/secure-ipl.c line 271

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c new file +10 -0
+    ComponentEntry *entry = *entry_ptr;
+    uint8_t *cert = NULL;
+    uint64_t *sig = NULL;
+    int cert_index = 0;
+    int comp_index = 0;
+    uint64_t comp_addr;
+    int comp_len;
+    uint32_t sig_len = 0;
+    uint64_t cert_len = -1;
+    uint8_t cert_idx = -1;

Why do we have 2 variables (cert_idx, cert_index) that are named similar? Can we rename cert_index to cert_table_idx?

Quoted 140 lines
pc-bios/s390-ccw/secure-ipl.c new file +100 -0
+    bool verified;
+    uint32_t certs_len;
+    /*
+     * Store indices of cert entry that have already used for signature verification
+     * to prevent allocating the same certificate multiple times.
+     * cert_table index: index of certificate from qemu cert store used for verification
+     * cert_table value: index of cert entry in cert list that contains the certificate
+     */
+    int cert_table[MAX_CERTIFICATES] = { [0 ... MAX_CERTIFICATES - 1] = -1};
+    int signed_count = 0;
+
+    if (!secure_ipl_supported()) {
+        return -1;
+    }
+
+    init_lists(&comps, &certs);
+    certs_len = get_certs_length();
+    cert = malloc(certs_len);
+    sig = malloc(MAX_SECTOR_SIZE);
+
+    while (entry->component_type != ZIPL_COMP_ENTRY_EXEC) {
+        switch (entry->component_type) {
+        case ZIPL_COMP_ENTRY_SIGNATURE:
+            if (sig_len) {
+                goto out;
+            }
+
+            sig_len = zipl_load_signature(entry, (uint64_t)sig);
+            if (sig_len < 0) {
+                goto out;
+            }
+            break;
+        case ZIPL_COMP_ENTRY_LOAD:
+            comp_addr = entry->compdat.load_addr;
+            comp_len = zipl_load_segment(entry, comp_addr);
+            if (comp_len < 0) {
+                goto out;
+            }
+
+            if (!sig_len) {
+                break;
+            }
+
+            verified = verify_signature(comp_len, comp_addr, sig_len, (uint64_t)sig,
+                                        &cert_len, &cert_idx);
+
+            if (verified) {
+                cert_index = handle_certificate(cert_table, &cert, cert_len, cert_idx,
+                                                &certs, cert_index);
+                if (cert_index == -1) {
+                    goto out;
+                }
+
+                puts("Verified component");
+                comp_list_add(&comps, comp_index, cert_table[cert_idx],
+                              comp_addr, comp_len,
+                              S390_IPL_COMPONENT_FLAG_SC | S390_IPL_COMPONENT_FLAG_CSV);
+            } else {
+                comp_list_add(&comps, comp_index, -1,
+                              comp_addr, comp_len,
+                              S390_IPL_COMPONENT_FLAG_SC);
+                zipl_secure_handle("Could not verify component");
+            }
+
+            comp_index++;
+            signed_count += 1;
+            /* After a signature is used another new one can be accepted */
+            sig_len = 0;
+            break;
+        default:
+            puts("Unknown component entry type");
+            return -1;
+        }
+
+        entry++;
+
+        if ((uint8_t *)(&entry[1]) > tmp_sec + MAX_SECTOR_SIZE) {
+            puts("Wrong entry value");
+            return -EINVAL;
+        }
+    }
+
+    if (signed_count == 0) {
+        zipl_secure_handle("Secure boot is on, but components are not signed");
+    }
+
+    if (update_iirb(&comps, &certs)) {
+        zipl_secure_handle("Failed to write IPL Information Report Block");
+    }
+
+    *entry_ptr = entry;
+    free(sig);
+
+    return 0;
+out:
+    free(cert);
+    free(sig);
+
+    return -1;
+}
pc-bios/s390-ccw/secure-ipl.h new file +34 -0
new file mode 100644
index 0000000000..a264a44349
@@ -0,0 +1,99 @@
+/*
+ * S/390 Secure IPL
+ *
+ * Copyright 2025 IBM Corp.
+ * Author(s): Zhuoying Cai<[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef _PC_BIOS_S390_CCW_SECURE_IPL_H
+#define _PC_BIOS_S390_CCW_SECURE_IPL_H
+
+#include <diag320.h>
+#include <diag508.h>
+
+VCStorageSizeBlock *zipl_secure_get_vcssb(void);
+int zipl_run_secure(ComponentEntry **entry_ptr, uint8_t *tmp_sec);
+
+static inline void zipl_secure_handle(const char *message)
+{
+    switch (boot_mode) {
+    case ZIPL_BOOT_MODE_SECURE_AUDIT:
+        IPL_check(false, message);
+        break;
+    default:
+        break;
+    }
+}
+
+static inline uint64_t diag320(void *data, unsigned long subcode)
+{
+    register unsigned long addr asm("0") = (unsigned long)data;
+    register unsigned long rc asm("1") = 0;
+

pc-bios/s390-ccw/secure-ipl.h line 44

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.h new file +10 -0
+    asm volatile ("diag %0,%2,0x320\n"
+                  : "+d" (addr), "+d" (rc)
+                  : "d" (subcode)
+                  : "memory", "cc");
+    return rc;
+}
+
+static inline bool is_vce_cert_valid(uint8_t vce_flags, uint32_t vce_len)
+{
+    return (vce_flags & DIAG_320_VCE_FLAGS_VALID) && (vce_len > VCE_INVALID_LEN);

Shouldn't just checking the vce_flag be enough?

Quoted 55 lines
pc-bios/s390-ccw/secure-ipl.h new file +55 -0
+}
+
+static inline bool is_cert_store_facility_supported(void)
+{
+    uint32_t d320_ism;
+
+    diag320(&d320_ism, DIAG_320_SUBC_QUERY_ISM);
+    return (d320_ism & DIAG_320_ISM_QUERY_SUBCODES) &&
+           (d320_ism & DIAG_320_ISM_QUERY_VCSI) &&
+           (d320_ism & DIAG_320_ISM_STORE_VC);
+}
+
+static inline uint64_t _diag508(void *data, unsigned long subcode)
+{
+    register unsigned long addr asm("0") = (unsigned long)data;
+    register unsigned long rc asm("1") = 0;
+
+    asm volatile ("diag %0,%2,0x508\n"
+                  : "+d" (addr), "+d" (rc)
+                  : "d" (subcode)
+                  : "memory", "cc");
+    return rc;
+}
+
+static inline bool is_secure_ipl_extension_supported(void)
+{
+    uint64_t d508_subcodes;
+
+    d508_subcodes = _diag508(NULL, DIAG_508_SUBC_QUERY_SUBC);
+    return d508_subcodes & DIAG_508_SUBC_SIG_VERIF;
+}
+
+static inline bool verify_signature(uint64_t comp_len, uint64_t comp_addr,
+                                    uint64_t sig_len, uint64_t sig_addr,
+                                    uint64_t *cert_len, uint8_t *cert_idx)
+{
+    Diag508SigVerifBlock svb;
+
+    svb.length = sizeof(Diag508SigVerifBlock);
+    svb.version = 0;
+    svb.comp_len = comp_len;
+    svb.comp_addr = comp_addr;
+    svb.sig_len = sig_len;
+    svb.sig_addr = sig_addr;
+
+    if (_diag508(&svb, DIAG_508_SUBC_SIG_VERIF) == DIAG_508_RC_OK) {
+        *cert_len = svb.cert_len;
+        *cert_idx = svb.cert_store_index;
+        return true;
+    }
+
+    return false;
+}
+
+#endif /* _PC_BIOS_S390_CCW_SECURE_IPL_H */
#67 lore raw

Re: [PATCH v6 19/28] pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode

Quoted 34 lines · Farhan Ali
Quoted 32 lines · Zhuoying Cai

Enable secure IPL in audit mode, which performs signature verification, but any error does not terminate the boot process. Only warnings will be logged to the console instead.

Add a comp_len variable to store the length of a segment in zipl_load_segment. comp_len variable is necessary to store the calculated segment length and is used during signature verification. Return the length on success, or a negative return code on failure.

Secure IPL in audit mode requires at least one certificate provided in the key store along with necessary facilities (Secure IPL Facility, Certificate Store Facility and secure IPL extension support).

Note: Secure IPL in audit mode is implemented for the SCSI scheme of virtio-blk/virtio-scsi devices.

---
  docs/system/s390x/secure-ipl.rst |  36 +++
  pc-bios/s390-ccw/Makefile        |   3 +-
  pc-bios/s390-ccw/bootmap.c       |  39 +++-
  pc-bios/s390-ccw/bootmap.h       |  11 +
  pc-bios/s390-ccw/main.c          |   9 +
  pc-bios/s390-ccw/s390-ccw.h      |  15 ++
  pc-bios/s390-ccw/sclp.c          |  44 ++++
  pc-bios/s390-ccw/sclp.h          |   6 +
  pc-bios/s390-ccw/secure-ipl.c    | 371 +++++++++++++++++++++++++++++++
  pc-bios/s390-ccw/secure-ipl.h    |  99 +++++++++
  10 files changed, 630 insertions(+), 3 deletions(-)

create mode 100644 pc-bios/s390-ccw/secure-ipl.c create mode 100644 pc-bios/s390-ccw/secure-ipl.h

[...]

Quoted 9 lines
Quoted 9 lines
pc-bios/s390-ccw/secure-ipl.c new file +9 -0
+
+static int handle_certificate(int *cert_table, uint8_t **cert,
+                             uint64_t cert_len, uint8_t cert_idx,
+                             IplSignatureCertificateList *certs, int cert_index)
+{
+    bool unused;
+
+    unused = cert_table[cert_idx] == -1;
+    if (unused) {
Quoted 10 lines

pc-bios/s390-ccw/secure-ipl.c line 245

Quoted 4 lines
pc-bios/s390-ccw/secure-ipl.c new file +4 -0
+        if (request_certificate(*cert, cert_idx)) {
+            cert_list_add(certs, cert_index, *cert, cert_len);
+            cert_table[cert_idx] = cert_index;
+            *cert += cert_len;

It's hard to understand why we increment *cert in this function by just looking at the function. But this function is called in the loop in zipl_run_secure, could we move this entire function in zipl_run_secure?

Thanks for the suggestion.

I'm concerned that moving this function into zipl_run_secure() could make it harder to read, since it's already quite large. I'd prefer to keep this function separate because it handles all certificate related operations here and add comments to clarify why *cert is incremented. I'd be happy to hear additional thoughts.

Quoted 131 lines
Quoted 16 lines
pc-bios/s390-ccw/secure-ipl.c new file +16 -0
+        } else {
+            puts("Could not get certificate");
+            return -1;
+        }
+
+        /* increment cert_index for the next cert entry */
+        return ++cert_index;
+    }
+
+    return cert_index;
+}
+
+int zipl_run_secure(ComponentEntry **entry_ptr, uint8_t *tmp_sec)
+{
+    IplDeviceComponentList comps;
+    IplSignatureCertificateList certs;

pc-bios/s390-ccw/secure-ipl.c line 271

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c new file +10 -0
+    ComponentEntry *entry = *entry_ptr;
+    uint8_t *cert = NULL;
+    uint64_t *sig = NULL;
+    int cert_index = 0;
+    int comp_index = 0;
+    uint64_t comp_addr;
+    int comp_len;
+    uint32_t sig_len = 0;
+    uint64_t cert_len = -1;
+    uint8_t cert_idx = -1;

Why do we have 2 variables (cert_idx, cert_index) that are named similar? Can we rename cert_index to cert_table_idx?

Quoted 100 lines
pc-bios/s390-ccw/secure-ipl.c new file +100 -0
+    bool verified;
+    uint32_t certs_len;
+    /*
+     * Store indices of cert entry that have already used for signature verification
+     * to prevent allocating the same certificate multiple times.
+     * cert_table index: index of certificate from qemu cert store used for verification
+     * cert_table value: index of cert entry in cert list that contains the certificate
+     */
+    int cert_table[MAX_CERTIFICATES] = { [0 ... MAX_CERTIFICATES - 1] = -1};
+    int signed_count = 0;
+
+    if (!secure_ipl_supported()) {
+        return -1;
+    }
+
+    init_lists(&comps, &certs);
+    certs_len = get_certs_length();
+    cert = malloc(certs_len);
+    sig = malloc(MAX_SECTOR_SIZE);
+
+    while (entry->component_type != ZIPL_COMP_ENTRY_EXEC) {
+        switch (entry->component_type) {
+        case ZIPL_COMP_ENTRY_SIGNATURE:
+            if (sig_len) {
+                goto out;
+            }
+
+            sig_len = zipl_load_signature(entry, (uint64_t)sig);
+            if (sig_len < 0) {
+                goto out;
+            }
+            break;
+        case ZIPL_COMP_ENTRY_LOAD:
+            comp_addr = entry->compdat.load_addr;
+            comp_len = zipl_load_segment(entry, comp_addr);
+            if (comp_len < 0) {
+                goto out;
+            }
+
+            if (!sig_len) {
+                break;
+            }
+
+            verified = verify_signature(comp_len, comp_addr, sig_len, (uint64_t)sig,
+                                        &cert_len, &cert_idx);
+
+            if (verified) {
+                cert_index = handle_certificate(cert_table, &cert, cert_len, cert_idx,
+                                                &certs, cert_index);
+                if (cert_index == -1) {
+                    goto out;
+                }
+
+                puts("Verified component");
+                comp_list_add(&comps, comp_index, cert_table[cert_idx],
+                              comp_addr, comp_len,
+                              S390_IPL_COMPONENT_FLAG_SC | S390_IPL_COMPONENT_FLAG_CSV);
+            } else {
+                comp_list_add(&comps, comp_index, -1,
+                              comp_addr, comp_len,
+                              S390_IPL_COMPONENT_FLAG_SC);
+                zipl_secure_handle("Could not verify component");
+            }
+
+            comp_index++;
+            signed_count += 1;
+            /* After a signature is used another new one can be accepted */
+            sig_len = 0;
+            break;
+        default:
+            puts("Unknown component entry type");
+            return -1;
+        }
+
+        entry++;
+
+        if ((uint8_t *)(&entry[1]) > tmp_sec + MAX_SECTOR_SIZE) {
+            puts("Wrong entry value");
+            return -EINVAL;
+        }
+    }
+
+    if (signed_count == 0) {
+        zipl_secure_handle("Secure boot is on, but components are not signed");
+    }
+
+    if (update_iirb(&comps, &certs)) {
+        zipl_secure_handle("Failed to write IPL Information Report Block");
+    }
+
+    *entry_ptr = entry;
+    free(sig);
+
+    return 0;
+out:
+    free(cert);
+    free(sig);
+
+    return -1;
+}

[...]

#68 lore raw

Re: [PATCH v6 19/28] pc-bios/s390-ccw: Add signature verification for secure IPL in audit mode

Quoted 18 lines · Zhuoying Cai
Quoted 8 lines
Quoted 8 lines
pc-bios/s390-ccw/secure-ipl.c new file +8 -0
+
+static int handle_certificate(int *cert_table, uint8_t **cert,
+                             uint64_t cert_len, uint8_t cert_idx,
+                             IplSignatureCertificateList *certs, int cert_index)
+{
+    bool unused;
+
+    unused = cert_table[cert_idx] == -1;
Quoted 10 lines

pc-bios/s390-ccw/secure-ipl.c line 245

Quoted 5 lines
pc-bios/s390-ccw/secure-ipl.c new file +5 -0
+    if (unused) {
+        if (request_certificate(*cert, cert_idx)) {
+            cert_list_add(certs, cert_index, *cert, cert_len);
+            cert_table[cert_idx] = cert_index;
+            *cert += cert_len;

It's hard to understand why we increment *cert in this function by just looking at the function. But this function is called in the loop in zipl_run_secure, could we move this entire function in zipl_run_secure?

Quoted 7 lines

Thanks for the suggestion.

I'm concerned that moving this function into zipl_run_secure() could make it harder to read, since it's already quite large. I'd prefer to keep this function separate because it handles all certificate related operations here and add comments to clarify why *cert is incremented. I'd be happy to hear additional thoughts.

Maybe we could simplify this by at least moving the increment (both cert_index and *cert) to zipl_run_secure() if this function succeeds? That way it will be easier to follow in the loop itself?

Thanks

Farhan

Quoted 11 lines
Quoted 11 lines
Quoted 11 lines
pc-bios/s390-ccw/secure-ipl.c new file +11 -0
+        } else {
+            puts("Could not get certificate");
+            return -1;
+        }
+
+        /* increment cert_index for the next cert entry */
+        return ++cert_index;
+    }
+
+    return cert_index;
+}
#69 lore raw

PATCH v6 20/28 s390x: Guest support for Secure-IPL Code Loading Attributes Facility (SCLAF)

In reply to Zhuoying Cai

The secure-IPL-code-loading-attributes facility (SCLAF) provides additional security during secure IPL.

Availability of SCLAF is determined by byte 136 bit 3 of the SCLP Read Info block.

This feature is available starting with the gen16 CPU model.

---
 docs/specs/s390x-secure-ipl.rst     | 25 +++++++++++++++++++++++++
 target/s390x/cpu_features.c         |  2 ++
 target/s390x/cpu_features_def.h.inc |  1 +
 target/s390x/cpu_models.c           |  3 +++
 target/s390x/gen-features.c         |  2 ++
 target/s390x/kvm/kvm.c              |  1 +
 6 files changed, 34 insertions(+)
docs/specs/s390x-secure-ipl.rst +25 -0
index 760a066084..a19b976e25 100644
@@ -85,3 +85,28 @@ operations such as:
 * certificate data
 
 The guest kernel will inspect the IIRB and build the keyring.
+
+
+Secure Code Loading Attributes Facility
+---------------------------------
+
+The Secure Code Loading Attributes Facility (SCLAF) enhances system security during the
+IPL by enforcing additional verification rules.
+
+When SCLAF is available, its behavior depends on the IPL mode. It introduces verification
+of both signed and unsigned components to help ensure that only authorized code is loaded
+during the IPL process. Any errors detected by SCLAF are reported in the IIRB.
+
+Unsigned components are restricted to load addresses at or above absolute storage address
+``0x2000``.
+
+Signed components must include a Secure Code Loading Attribute Block (SCLAB), which is
+appended at the very end of the component. The SCLAB defines security attributes for
+handling the signed code. Specifically, it may:
+
+* Provide direction on how to process the rest of the component.
+
+* Provide further validation of information on where to load the signed binary code
+  from the load device.
+
+* Specify where to start the execution of the loaded OS code.
target/s390x/cpu_features.c +2 -0
index 200bd8c15b..29ea3bfec2 100644
@@ -120,6 +120,7 @@ void s390_fill_feat_block(const S390FeatBitmap features, S390FeatType type,
      * - All SIE facilities because SIE is not available
      * - DIAG318
      * - Secure IPL Facility
+     * - Secure IPL Code Loading Attributes Facility
      *
      * As VMs can move in and out of protected mode the CPU model
      * doesn't protect us from that problem because it is only
@@ -152,6 +153,7 @@ void s390_fill_feat_block(const S390FeatBitmap features, S390FeatType type,
         break;
     case S390_FEAT_TYPE_SCLP_FAC_IPL:
         clear_be_bit(s390_feat_def(S390_FEAT_SIPL)->bit, data);
+        clear_be_bit(s390_feat_def(S390_FEAT_SCLAF)->bit, data);
         break;
     default:
         return;
target/s390x/cpu_features_def.h.inc +1 -0
index 55eef618b8..ecfca0faef 100644
@@ -142,6 +142,7 @@ DEF_FEAT(CERT_STORE, "cstore", SCLP_FAC134, 5, "Provide Certificate Store functi
 
 /* Features exposed via SCLP SCCB Facilities byte 136 - 137 (bit numbers relative to byte-136) */
 DEF_FEAT(SIPL, "sipl", SCLP_FAC_IPL, 1, "Secure-IPL facility")
+DEF_FEAT(SCLAF, "sclaf", SCLP_FAC_IPL, 3, "Secure-IPL-code-loading-attributes facility")
 
 /* Features exposed via SCLP CPU info. */
 DEF_FEAT(SIE_F2, "sief2", SCLP_CPU, 4, "SIE: interception format 2 (Virtual SIE)")
target/s390x/cpu_models.c +3 -0
index f99536ef9a..7d214b5f72 100644
@@ -264,6 +264,7 @@ bool s390_has_feat(S390Feat feat)
         case S390_FEAT_SIE_PFMFI:
         case S390_FEAT_SIE_IBS:
         case S390_FEAT_SIPL:
+        case S390_FEAT_SCLAF:
         case S390_FEAT_CONFIGURATION_TOPOLOGY:
             return false;
             break;
@@ -509,6 +510,8 @@ static void check_consistency(const S390CPUModel *model)
         { S390_FEAT_DIAG_318, S390_FEAT_EXTENDED_LENGTH_SCCB },
         { S390_FEAT_CERT_STORE, S390_FEAT_EXTENDED_LENGTH_SCCB },
         { S390_FEAT_SIPL, S390_FEAT_EXTENDED_LENGTH_SCCB },
+        { S390_FEAT_SCLAF, S390_FEAT_EXTENDED_LENGTH_SCCB },
+        { S390_FEAT_SCLAF, S390_FEAT_SIPL },
         { S390_FEAT_NNPA, S390_FEAT_VECTOR },
         { S390_FEAT_RDP, S390_FEAT_LOCAL_TLB_CLEARING },
         { S390_FEAT_UV_FEAT_AP, S390_FEAT_AP },
target/s390x/gen-features.c +2 -0
index bd2060ab93..c3e0c6ceff 100644
@@ -722,6 +722,7 @@ static uint16_t full_GEN16_GA1[] = {
     S390_FEAT_UV_FEAT_AP_INTR,
     S390_FEAT_CERT_STORE,
     S390_FEAT_SIPL,
+    S390_FEAT_SCLAF,
 };
 
 static uint16_t full_GEN17_GA1[] = {
@@ -924,6 +925,7 @@ static uint16_t qemu_MAX[] = {
     S390_FEAT_EXTENDED_LENGTH_SCCB,
     S390_FEAT_CERT_STORE,
     S390_FEAT_SIPL,
+    S390_FEAT_SCLAF,
 };
 
 /****** END FEATURE DEFS ******/
target/s390x/kvm/kvm.c +1 -0
index 31bd574dec..2ed11fab52 100644
@@ -2522,6 +2522,7 @@ bool kvm_s390_get_host_cpu_model(S390CPUModel *model, Error **errp)
 
     /* Some Secure IPL facilities are emulated by QEMU */
     set_bit(S390_FEAT_SIPL, model->features);
+    set_bit(S390_FEAT_SCLAF, model->features);
 
     /* Test for Ultravisor features that influence secure guest behavior */
     query_uv_feat_guest(model->features);
Signature · 1 line
2.50.1
#70 lore raw

Re: [PATCH v6 20/28] s390x: Guest support for Secure-IPL Code Loading Attributes Facility (SCLAF)

Quoted 24 lines · Zhuoying Cai

The secure-IPL-code-loading-attributes facility (SCLAF) provides additional security during secure IPL.

Availability of SCLAF is determined by byte 136 bit 3 of the SCLP Read Info block.

This feature is available starting with the gen16 CPU model.

---
  docs/specs/s390x-secure-ipl.rst     | 25 +++++++++++++++++++++++++
  target/s390x/cpu_features.c         |  2 ++
  target/s390x/cpu_features_def.h.inc |  1 +
  target/s390x/cpu_models.c           |  3 +++
  target/s390x/gen-features.c         |  2 ++
  target/s390x/kvm/kvm.c              |  1 +
  6 files changed, 34 insertions(+)
docs/specs/s390x-secure-ipl.rst +0 -0
index 760a066084..a19b976e25 100644

docs/specs/s390x-secure-ipl.rst operations such as: · line 94

Quoted 10 lines
docs/specs/s390x-secure-ipl.rst +7 -0
@@ -85,3 +85,28 @@ operations such as:
  * certificate data
 
  The guest kernel will inspect the IIRB and build the keyring.
+
+
+Secure Code Loading Attributes Facility
+---------------------------------
+
+The Secure Code Loading Attributes Facility (SCLAF) enhances system security during the
+IPL by enforcing additional verification rules.

Please wrap your text so that it fits into 80 columns. (Not sure why checkpatch.pl is not warning here...?)

Quoted 7 lines
docs/specs/s390x-secure-ipl.rst +6 -0
+When SCLAF is available, its behavior depends on the IPL mode. It introduces verification
+of both signed and unsigned components to help ensure that only authorized code is loaded
+during the IPL process. Any errors detected by SCLAF are reported in the IIRB.
 
+Unsigned components are restricted to load addresses at or above absolute storage address
+``0x2000``.
+

docs/specs/s390x-secure-ipl.rst operations such as: · line 112

Quoted 10 lines
docs/specs/s390x-secure-ipl.rst +10 -0
+Signed components must include a Secure Code Loading Attribute Block (SCLAB), which is
+appended at the very end of the component. The SCLAB defines security attributes for
+handling the signed code. Specifically, it may:
+
+* Provide direction on how to process the rest of the component.
+
+* Provide further validation of information on where to load the signed binary code
+  from the load device.
+
+* Specify where to start the execution of the loaded OS code.

Do you maybe want to mention any tool from s390-tools that helps with this task (assuming that there is one)? (or should that rather not be part of the specs here?)

...

Quoted 13 lines
target/s390x/gen-features.c +1 -0
index bd2060ab93..c3e0c6ceff 100644
@@ -722,6 +722,7 @@ static uint16_t full_GEN16_GA1[] = {
      S390_FEAT_UV_FEAT_AP_INTR,
      S390_FEAT_CERT_STORE,
      S390_FEAT_SIPL,
+    S390_FEAT_SCLAF,
  };
 
  static uint16_t full_GEN17_GA1[] = {

target/s390x/gen-features.c static uint16_t qemu_MAX[] = { · line 929

Quoted 5 lines
target/s390x/gen-features.c +1 -0
@@ -924,6 +925,7 @@ static uint16_t qemu_MAX[] = {
      S390_FEAT_EXTENDED_LENGTH_SCCB,
      S390_FEAT_CERT_STORE,
      S390_FEAT_SIPL,
+    S390_FEAT_SCLAF,
  };

In the cover letter you wrote "All actions must be performed on a KVM guest" ... so does this feature depend on KVM or not? If you cannot use the feature with TCG, I think you should not add this to the "qemu_MAX" CPU model?

Thomas

#71 lore raw

Re: [PATCH v6 20/28] s390x: Guest support for Secure-IPL Code Loading Attributes Facility (SCLAF)

Quoted 13 lines · Thomas Huth

On 18/09/2025 01.21, Zhuoying Cai wrote:
...

Quoted 11 lines
target/s390x/gen-features.c +1 -0
index bd2060ab93..c3e0c6ceff 100644
@@ -722,6 +722,7 @@ static uint16_t full_GEN16_GA1[] = {
       S390_FEAT_UV_FEAT_AP_INTR,
       S390_FEAT_CERT_STORE,
       S390_FEAT_SIPL,
+    S390_FEAT_SCLAF,
   };
 
Quoted 9 lines

target/s390x/gen-features.c static uint16_t qemu_MAX[] = { · line 929

Quoted 7 lines
target/s390x/gen-features.c +1 -0
   static uint16_t full_GEN17_GA1[] = {
@@ -924,6 +925,7 @@ static uint16_t qemu_MAX[] = {
       S390_FEAT_EXTENDED_LENGTH_SCCB,
       S390_FEAT_CERT_STORE,
       S390_FEAT_SIPL,
+    S390_FEAT_SCLAF,
   };

In the cover letter you wrote "All actions must be performed on a KVM guest" ... so does this feature depend on KVM or not? If you cannot use the feature with TCG, I think you should not add this to the "qemu_MAX" CPU model?

Ok, after reading through a bunch of patches now, it seems like this feature also works with TCG, right? So the modification to qemu_MAX should stay, never mind me previous comment here, I was just confused by the term "KVM guest" in the cover letter.

Thomas

#72 lore raw

PATCH v6 21/28 pc-bios/s390-ccw: Add additional security checks for secure boot

In reply to Zhuoying Cai

Add additional checks to ensure that components do not overlap with signed components when loaded into memory.

Add additional checks to ensure the load addresses of unsigned components are greater than or equal to 0x2000.

When the secure IPL code loading attributes facility (SCLAF) is installed, all signed components must contain a secure code loading attributes block (SCLAB).

The SCLAB provides further validation of information on where to load the signed binary code from the load device, and where to start the execution of the loaded OS code.

When SCLAF is installed, its content must be evaluated during secure IPL. However, a missing SCLAB will not be reported in audit mode. The SCALB checking will be skipped in this case.

Add IPL Information Error Indicators (IIEI) and Component Error Indicators (CEI) for IPL Information Report Block (IIRB).

When SCLAF is installed, additional secure boot checks are performed during zipl and store results of verification into IIRB.

---
 pc-bios/s390-ccw/iplb.h       |  26 ++-
 pc-bios/s390-ccw/s390-ccw.h   |   1 +
 pc-bios/s390-ccw/sclp.c       |   8 +
 pc-bios/s390-ccw/sclp.h       |   1 +
 pc-bios/s390-ccw/secure-ipl.c | 412 +++++++++++++++++++++++++++++++++-
 pc-bios/s390-ccw/secure-ipl.h | 110 +++++++++
 6 files changed, 553 insertions(+), 5 deletions(-)
pc-bios/s390-ccw/iplb.h +24 -2
index 11302e004d..41cec91a68 100644
@@ -32,11 +32,19 @@ struct IplInfoReportBlockHeader {
 } __attribute__ ((packed));
 typedef struct IplInfoReportBlockHeader IplInfoReportBlockHeader;
 
+#define S390_IPL_INFO_IIEI_NO_SIGNED_COMP      0x8000 /* bit 0 */
+#define S390_IPL_INFO_IIEI_NO_SCLAB            0x4000 /* bit 1 */
+#define S390_IPL_INFO_IIEI_NO_GLOBAL_SCLAB     0x2000 /* bit 2 */
+#define S390_IPL_INFO_IIEI_MORE_GLOBAL_SCLAB   0x1000 /* bit 3 */
+#define S390_IPL_INFO_IIEI_FOUND_UNSIGNED_COMP 0x800 /* bit 4 */
+#define S390_IPL_INFO_IIEI_MORE_SIGNED_COMP    0x400 /* bit 5 */
+
 struct IplInfoBlockHeader {
     uint32_t len;
     uint8_t  ibt;
     uint8_t  reserved1[3];
-    uint8_t  reserved2[8];
+    uint16_t iiei;
+    uint8_t  reserved2[6];
 } __attribute__ ((packed));
 typedef struct IplInfoBlockHeader IplInfoBlockHeader;
 
@@ -60,13 +68,27 @@ typedef struct IplSignatureCertificateList IplSignatureCertificateList;
 #define S390_IPL_COMPONENT_FLAG_SC  0x80
 #define S390_IPL_COMPONENT_FLAG_CSV 0x40
 
+#define S390_IPL_COMPONENT_CEI_INVALID_SCLAB             0x80000000 /* bit 0 */
+#define S390_IPL_COMPONENT_CEI_INVALID_SCLAB_LEN         0x40000000 /* bit 1 */
+#define S390_IPL_COMPONENT_CEI_INVALID_SCLAB_FORMAT      0x20000000 /* bit 2 */
+#define S390_IPL_COMPONENT_CEI_UNMATCHED_SCLAB_LOAD_ADDR 0x10000000 /* bit 3 */
+#define S390_IPL_COMPONENT_CEI_UNMATCHED_SCLAB_LOAD_PSW  0x8000000  /* bit 4 */
+#define S390_IPL_COMPONENT_CEI_INVALID_LOAD_PSW          0x4000000  /* bit 5 */
+#define S390_IPL_COMPONENT_CEI_NUC_NOT_IN_GLOBAL_SCLA    0x2000000  /* bit 6 */
+#define S390_IPL_COMPONENT_CEI_SCLAB_OLA_NOT_ONE         0x1000000  /* bit 7 */
+#define S390_IPL_COMPONENT_CEI_SC_NOT_IN_GLOBAL_SCLAB    0x800000   /* bit 8 */
+#define S390_IPL_COMPONENT_CEI_SCLAB_LOAD_ADDR_NOT_ZERO  0x400000   /* bit 9 */
+#define S390_IPL_COMPONENT_CEI_SCLAB_LOAD_PSW_NOT_ZERO   0x200000   /* bit 10 */
+#define S390_IPL_COMPONENT_CEI_INVALID_UNSIGNED_ADDR     0x100000   /* bit 11 */
+
 struct IplDeviceComponentEntry {
     uint64_t addr;
     uint64_t len;
     uint8_t  flags;
     uint8_t  reserved1[5];
     uint16_t cert_index;
-    uint8_t  reserved2[8];
+    uint32_t cei;
+    uint8_t  reserved2[4];
 } __attribute__ ((packed));
 typedef struct IplDeviceComponentEntry IplDeviceComponentEntry;
 
pc-bios/s390-ccw/s390-ccw.h +1 -0
index c2ba40d067..6d51d07c90 100644
@@ -69,6 +69,7 @@ void sclp_setup(void);
 void sclp_get_loadparm_ascii(char *loadparm);
 bool sclp_is_diag320_on(void);
 bool sclp_is_sipl_on(void);
+bool sclp_is_sclaf_on(void);
 int sclp_read(char *str, size_t count);
 
 /* virtio.c */
pc-bios/s390-ccw/sclp.c +8 -0
index 0b03c3164f..16f973dde8 100644
@@ -157,6 +157,14 @@ bool sclp_is_sipl_on(void)
     return fac_ipl & SCCB_FAC_IPL_SIPL_BIT;
 }
 
+bool sclp_is_sclaf_on(void)
+{
+    uint16_t fac_ipl = 0;
+
+    sclp_get_fac_ipl(&fac_ipl);
+    return fac_ipl & SCCB_FAC_IPL_SCLAF_BIT;
+}
+
 int sclp_read(char *str, size_t count)
 {
     ReadEventData *sccb = (void *)_sccb;
pc-bios/s390-ccw/sclp.h +1 -0
index cf147f4634..3441020d6b 100644
@@ -52,6 +52,7 @@ typedef struct SCCBHeader {
 #define SCCB_DATA_LEN (SCCB_SIZE - sizeof(SCCBHeader))
 #define SCCB_FAC134_DIAG320_BIT 0x4
 #define SCCB_FAC_IPL_SIPL_BIT 0x4000
+#define SCCB_FAC_IPL_SCLAF_BIT 0x1000
 
 typedef struct ReadInfo {
     SCCBHeader h;
pc-bios/s390-ccw/secure-ipl.c +409 -3

447 lines not on this page · raw message

pc-bios/s390-ccw/secure-ipl.h +110 -0

122 lines not on this page · raw message

Signature · 1 line
2.50.1
#73 lore raw

Re: [PATCH v6 21/28] pc-bios/s390-ccw: Add additional security checks for secure boot

Quoted 26 lines · Zhuoying Cai

Add additional checks to ensure that components do not overlap with signed components when loaded into memory.

Add additional checks to ensure the load addresses of unsigned components are greater than or equal to 0x2000.

When the secure IPL code loading attributes facility (SCLAF) is installed, all signed components must contain a secure code loading attributes block (SCLAB).

The SCLAB provides further validation of information on where to load the signed binary code from the load device, and where to start the execution of the loaded OS code.

When SCLAF is installed, its content must be evaluated during secure IPL. However, a missing SCLAB will not be reported in audit mode. The SCALB checking will be skipped in this case.

Add IPL Information Error Indicators (IIEI) and Component Error Indicators (CEI) for IPL Information Report Block (IIRB).

When SCLAF is installed, additional secure boot checks are performed during zipl and store results of verification into IIRB.

---

...

pc-bios/s390-ccw/secure-ipl.c static bool secure_ipl_supported(void) · line 206

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +2 -0
index 8eab19cb09..cd798c1198 100644
@@ -202,6 +202,12 @@ static bool secure_ipl_supported(void)
          return false;
      }
 
+    if (!sclp_is_sclaf_on()) {
+        puts("Secure IPL Code Loading Attributes Facility is not supported by" \

No need for the backslash here.

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 223

Quoted 12 lines
pc-bios/s390-ccw/secure-ipl.c +5 -0
+             " the hypervisor!");
+        return false;
+    }
+
      return true;
  }
 
@@ -214,6 +220,393 @@ static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis
      certs->ipl_info_header.len = sizeof(certs->ipl_info_header);
  }
 
+static bool is_comp_overlap(SecureIplCompAddrRange *comp_addr_range, int addr_range_index,

I'd suggest to move the second parameter to a separate line, to keep the line length below 80 columns.

Quoted 9 lines
pc-bios/s390-ccw/secure-ipl.c +9 -0
+                            uint64_t start_addr, uint64_t end_addr)
+{
+    /* neither a signed nor an unsigned component can overlap with a signed component */
+    for (int i = 0; i < addr_range_index; i++) {
+        if ((comp_addr_range[i].start_addr <= end_addr &&
+            start_addr <= comp_addr_range[i].end_addr) &&
+            comp_addr_range[i].is_signed) {
+            return true;
+       }

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 242

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+    }
+
+    return false;
+}
+
+static void comp_addr_range_add(SecureIplCompAddrRange *comp_addr_range,
+                                int addr_range_index, bool is_signed,
+                                uint64_t start_addr, uint64_t end_addr)
+{
+    if (addr_range_index > MAX_CERTIFICATES - 1) {

That error goes completely unnoticed. Should there be a log / warning here?

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+        return;
+    }
+
+    comp_addr_range[addr_range_index].is_signed = is_signed;
+    comp_addr_range[addr_range_index].start_addr = start_addr;
+    comp_addr_range[addr_range_index].end_addr = end_addr;
+}
+
+static void check_unsigned_addr(uint64_t load_addr, IplDeviceComponentList *comps,
+                                int comp_index)

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 262

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+{
+    uint32_t flag;
+    const char *msg;
+    bool valid;
+
+    valid = validate_unsigned_addr(load_addr);
+    if (!valid) {
+        flag = S390_IPL_COMPONENT_CEI_INVALID_UNSIGNED_ADDR;
+        msg = "Load address is less than 0x2000";
+        set_cei_with_log(comps, comp_index, flag, msg);

I'd maybe rather pass the string directly as parameter, without the detour through the "msg" variable.

Quoted 36 lines
pc-bios/s390-ccw/secure-ipl.c +36 -0
+    }
+}
+
+static void addr_overlap_check(SecureIplCompAddrRange *comp_addr_range,
+                               int *addr_range_index,
+                               uint64_t start_addr, uint64_t end_addr, bool is_signed)
+{
+    bool overlap;
+
+    overlap = is_comp_overlap(comp_addr_range, *addr_range_index,
+                              start_addr, end_addr);
+    if (!overlap) {
+        comp_addr_range_add(comp_addr_range, *addr_range_index, is_signed,
+                            start_addr, end_addr);
+        *addr_range_index += 1;
+    } else {
+        zipl_secure_handle("Component addresses overlap");
+    }
+}
+
+static bool check_sclab_presence(uint8_t *sclab_magic,
+                                 IplDeviceComponentList *comps, int comp_index)
+{
+    if (!validate_sclab_magic(sclab_magic)) {
+        comps->device_entries[comp_index].cei |= S390_IPL_COMPONENT_CEI_INVALID_SCLAB;
+
+        /* a missing SCLAB will not be reported in audit mode */
+        return false;
+    }
+
+    return true;
+}
+
+static void check_sclab_length(uint16_t sclab_len,
+                               IplDeviceComponentList *comps, int comp_index)
+{

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 308

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+    const char *msg;
+    uint32_t flag;
+    bool valid;
+
+    valid = validate_sclab_length(sclab_len);
+    if (!valid) {
+        flag = S390_IPL_COMPONENT_CEI_INVALID_SCLAB_LEN |
+               S390_IPL_COMPONENT_CEI_INVALID_SCLAB;
+        msg = "Invalid SCLAB length";
+        set_cei_with_log(comps, comp_index, flag, msg);

Again, pass string directly, without msg variable?

Quoted 5 lines
pc-bios/s390-ccw/secure-ipl.c +5 -0
+    }
+}
+
+static void check_sclab_format(uint8_t sclab_format,
+                               IplDeviceComponentList *comps, int comp_index)

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 323

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+{
+    const char *msg;
+    uint32_t flag;
+    bool valid;
+
+    valid = validate_sclab_format(sclab_format);
+    if (!valid) {
+        flag = S390_IPL_COMPONENT_CEI_INVALID_SCLAB_FORMAT;
+        msg = "Format-0 SCLAB is not being use";
+        set_cei_with_log(comps, comp_index, flag, msg);

dito

Quoted 17 lines
pc-bios/s390-ccw/secure-ipl.c +17 -0
+    }
+}
+
+static void check_sclab_opsw(SecureCodeLoadingAttributesBlock *sclab,
+                             SecureIplSclabInfo *sclab_info,
+                             IplDeviceComponentList *comps, int comp_index)
+{
+    const char *msg;
+    uint32_t flag;
+    bool is_opsw_set;
+    bool valid;
+
+    is_opsw_set = is_sclab_flag_set(sclab->flags, S390_SECURE_IPL_SCLAB_FLAG_OPSW);
+    if (!is_opsw_set) {
+        valid = validate_sclab_opsw_zero(sclab->load_psw);
+        if (!valid) {
+            flag = S390_IPL_COMPONENT_CEI_SCLAB_LOAD_PSW_NOT_ZERO;

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 350

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+            msg = "Load PSW is not zero when Override PSW bit is zero";
+            set_cei_with_log(comps, comp_index, flag, msg);
+        }
+    } else {
+        /* OPSW = 1 indicating global SCLAB */
+        valid = validate_sclab_opsw_one(sclab->flags);
+        if (!valid) {
+            flag = S390_IPL_COMPONENT_CEI_SCLAB_OLA_NOT_ONE;
+            msg = "Override Load Address bit is not set to one in the global SCLAB";
+            set_cei_with_log(comps, comp_index, flag, msg);

Is it ok here to continue with the code below, even if it was not valid? Or should there be a return statement here?

Quoted 13 lines
pc-bios/s390-ccw/secure-ipl.c +13 -0
+        }
+
+        sclab_info->global_count += 1;
+        if (sclab_info->global_count == 1) {
+            sclab_info->load_psw = sclab->load_psw;
+            sclab_info->flags = sclab->flags;
+        }
+    }
+}
+
+static void check_sclab_ola(SecureCodeLoadingAttributesBlock *sclab,
+                            uint64_t load_addr, IplDeviceComponentList *comps,
+                            int comp_index)

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 373

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+{
+    const char *msg;
+    uint32_t flag;
+    bool is_ola_set;
+    bool valid;
+
+    is_ola_set = is_sclab_flag_set(sclab->flags, S390_SECURE_IPL_SCLAB_FLAG_OLA);
+    if (!is_ola_set) {
+        valid = validate_sclab_ola_zero(sclab->load_addr);
+        if (!(valid)) {

No need for the inner braces here.

Quoted 43 lines
pc-bios/s390-ccw/secure-ipl.c +43 -0
+            flag = S390_IPL_COMPONENT_CEI_SCLAB_LOAD_ADDR_NOT_ZERO;
+            msg = "Load Address is not zero when Override Load Address bit is zero";
+            set_cei_with_log(comps, comp_index, flag, msg);
+        }
+
+    } else {
+        valid = validate_sclab_ola_one(sclab->load_addr, load_addr);
+        if (!valid) {
+            flag = S390_IPL_COMPONENT_CEI_UNMATCHED_SCLAB_LOAD_ADDR;
+            msg = "Load Address does not match with component load address";
+            set_cei_with_log(comps, comp_index, flag, msg);
+        }
+    }
+}
+
+static void check_sclab_nuc(uint16_t sclab_flags, IplDeviceComponentList *comps,
+                            int comp_index)
+{
+    const char *msg;
+    uint32_t flag;
+    bool is_nuc_set;
+    bool is_global_sclab;
+
+    is_nuc_set = is_sclab_flag_set(sclab_flags, S390_SECURE_IPL_SCLAB_FLAG_NUC);
+    is_global_sclab = is_sclab_flag_set(sclab_flags, S390_SECURE_IPL_SCLAB_FLAG_OPSW);
+    if (is_nuc_set && !is_global_sclab) {
+        flag = S390_IPL_COMPONENT_CEI_NUC_NOT_IN_GLOBAL_SCLA;
+        msg = "No Unsigned Components bit is set, but not in the global SCLAB";
+        set_cei_with_log(comps, comp_index, flag, msg);
+    }
+}
+
+static void check_sclab_sc(uint16_t sclab_flags, IplDeviceComponentList *comps,
+                           int comp_index)
+{
+    const char *msg;
+    uint32_t flag;
+    bool is_sc_set;
+    bool is_global_sclab;
+
+    is_sc_set = is_sclab_flag_set(sclab_flags, S390_SECURE_IPL_SCLAB_FLAG_SC);
+    is_global_sclab = is_sclab_flag_set(sclab_flags, S390_SECURE_IPL_SCLAB_FLAG_OPSW);
+    if (is_sc_set && !is_global_sclab) {

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 426

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+        flag = S390_IPL_COMPONENT_CEI_SC_NOT_IN_GLOBAL_SCLAB;
+        msg = "Single Component bit is set, but not in the global SCLAB";
+        set_cei_with_log(comps, comp_index, flag, msg);
+    }
+}
+
+static bool is_psw_valid(uint64_t psw, SecureIplCompAddrRange *comp_addr_range,
+                         int range_index)
+{
+    uint32_t addr = psw & 0x3FFFFFFF;

Shouldn't that be 0x7fffffff instead?

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 432

Quoted 5 lines
pc-bios/s390-ccw/secure-ipl.c +5 -0
+    /* PSW points within a signed binary code component */
+    for (int i = 0; i < range_index; i++) {
+        if (comp_addr_range[i].is_signed &&
+            addr >= comp_addr_range[i].start_addr &&
+            addr <= comp_addr_range[i].end_addr) {

is it still OK if the address points to the end_addr? Or should that be end_addr - 2 instead (since an opcode has at least two bytes)?

Quoted 6 lines
pc-bios/s390-ccw/secure-ipl.c +6 -0
+            return true;
+       }
+    }
+
+    return false;
+}

...

Quoted 50 lines
pc-bios/s390-ccw/secure-ipl.c +48 -0
+static inline bool is_sclab_flag_set(uint16_t sclab_flags, uint16_t flag)
+{
+    return (sclab_flags & flag) != 0;
+}
+
+static inline bool validate_unsigned_addr(uint64_t comp_load_addr)
+{
+    /* usigned load address must be greater than or equal to 0x2000 */
+    return comp_load_addr >= 0x2000;
+}
+
+static inline bool validate_sclab_magic(uint8_t *sclab_magic)
+{
+    /* identifies the presence of SCLAB */
+    return magic_match(sclab_magic, ZIPL_MAGIC);
+}
+
+static inline bool validate_sclab_length(uint16_t sclab_len)
+{
+    /* minimum SCLAB length is 32 bytes */
+    return sclab_len >= 32;
+}
+
+static inline bool validate_sclab_format(uint8_t sclab_format)
+{
+    /* SCLAB format must set to zero, indicating a format-0 SCLAB being used */
+    return sclab_format == 0;
+}
+
+static inline bool validate_sclab_ola_zero(uint64_t sclab_load_addr)
+{
+    /* Load address field in SCLAB must contain zeros */
+    return sclab_load_addr == 0;
+}
+
+static inline bool validate_sclab_ola_one(uint64_t sclab_load_addr,
+                                          uint64_t comp_load_addr)
+{
+   /* Load address field must match storage address of the component */
+   return sclab_load_addr == comp_load_addr;
+}
+
+static inline bool validate_sclab_opsw_zero(uint64_t sclab_load_psw)
+{
+    /* Load PSW field in SCLAB must contain zeros */
+    return sclab_load_psw == 0;
+}
 
+static inline bool validate_sclab_opsw_one(uint16_t sclab_flags)

pc-bios/s390-ccw/secure-ipl.c

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+{
+   /* OLA must set to one */
+   return is_sclab_flag_set(sclab_flags, S390_SECURE_IPL_SCLAB_FLAG_OLA);
+}
+
+static inline bool validate_lpsw(uint64_t sclab_load_psw, uint64_t comp_load_psw)
+{
+    /* compare load PSW with the PSW specified in component */
+    return sclab_load_psw == comp_load_psw;
+}

Most of these inline functions just compare something with 0 or other values here, and you only use them in one spot of the code ... So you need 5 lines of code for something that could be done in two lines of code at the calling sites instead, i.e. this looks like unnecessary code to me. Please inline the comparisons (together with the comment that you've got here) in the calling sites to get rid of this code bloat.

Thanks,
Thomas

#74 lore raw

Re: [PATCH v6 21/28] pc-bios/s390-ccw: Add additional security checks for secure boot

Thank you for all the feedback! I'll address the comments in the next version.

Quoted 32 lines · Thomas Huth
Quoted 26 lines · Zhuoying Cai

Add additional checks to ensure that components do not overlap with signed components when loaded into memory.

Add additional checks to ensure the load addresses of unsigned components are greater than or equal to 0x2000.

When the secure IPL code loading attributes facility (SCLAF) is installed, all signed components must contain a secure code loading attributes block (SCLAB).

The SCLAB provides further validation of information on where to load the signed binary code from the load device, and where to start the execution of the loaded OS code.

When SCLAF is installed, its content must be evaluated during secure IPL. However, a missing SCLAB will not be reported in audit mode. The SCALB checking will be skipped in this case.

Add IPL Information Error Indicators (IIEI) and Component Error Indicators (CEI) for IPL Information Report Block (IIRB).

When SCLAF is installed, additional secure boot checks are performed during zipl and store results of verification into IIRB.

---

...

Quoted 4 lines
pc-bios/s390-ccw/secure-ipl.c +0 -0
index 8eab19cb09..cd798c1198 100644

[ ... ]

Quoted 8 lines

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 426

Quoted 5 lines
pc-bios/s390-ccw/secure-ipl.c +5 -0
+
+static bool is_psw_valid(uint64_t psw, SecureIplCompAddrRange *comp_addr_range,
+                         int range_index)
+{
+    uint32_t addr = psw & 0x3FFFFFFF;

Shouldn't that be 0x7fffffff instead?

Thanks for pointing it out. It should be 0x7fffffff.

Quoted 9 lines

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 432

Quoted 5 lines
pc-bios/s390-ccw/secure-ipl.c +5 -0
+    /* PSW points within a signed binary code component */
+    for (int i = 0; i < range_index; i++) {
+        if (comp_addr_range[i].is_signed &&
+            addr >= comp_addr_range[i].start_addr &&
+            addr <= comp_addr_range[i].end_addr) {

is it still OK if the address points to the end_addr? Or should that be end_addr - 2 instead (since an opcode has at least two bytes)?

Using end_addr - 2 seems correct, since it accounts for the minimum instruction length.

Just to clarify: using end_addr - 2 should ensure that at least a 2-byte instruction fits. Should longer instructions (e.g., 4 and 6 bytes) be a concern in this context?

Quoted 78 lines
Quoted 6 lines
pc-bios/s390-ccw/secure-ipl.c +6 -0
+            return true;
+       }
+    }
+
+    return false;
+}

...

Quoted 50 lines
pc-bios/s390-ccw/secure-ipl.c +48 -0
+static inline bool is_sclab_flag_set(uint16_t sclab_flags, uint16_t flag)
+{
+    return (sclab_flags & flag) != 0;
+}
+
+static inline bool validate_unsigned_addr(uint64_t comp_load_addr)
+{
+    /* usigned load address must be greater than or equal to 0x2000 */
+    return comp_load_addr >= 0x2000;
+}
+
+static inline bool validate_sclab_magic(uint8_t *sclab_magic)
+{
+    /* identifies the presence of SCLAB */
+    return magic_match(sclab_magic, ZIPL_MAGIC);
+}
+
+static inline bool validate_sclab_length(uint16_t sclab_len)
+{
+    /* minimum SCLAB length is 32 bytes */
+    return sclab_len >= 32;
+}
+
+static inline bool validate_sclab_format(uint8_t sclab_format)
+{
+    /* SCLAB format must set to zero, indicating a format-0 SCLAB being used */
+    return sclab_format == 0;
+}
+
+static inline bool validate_sclab_ola_zero(uint64_t sclab_load_addr)
+{
+    /* Load address field in SCLAB must contain zeros */
+    return sclab_load_addr == 0;
+}
+
+static inline bool validate_sclab_ola_one(uint64_t sclab_load_addr,
+                                          uint64_t comp_load_addr)
+{
+   /* Load address field must match storage address of the component */
+   return sclab_load_addr == comp_load_addr;
+}
+
+static inline bool validate_sclab_opsw_zero(uint64_t sclab_load_psw)
+{
+    /* Load PSW field in SCLAB must contain zeros */
+    return sclab_load_psw == 0;
+}
 
+static inline bool validate_sclab_opsw_one(uint16_t sclab_flags)

pc-bios/s390-ccw/secure-ipl.c

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +10 -0
+{
+   /* OLA must set to one */
+   return is_sclab_flag_set(sclab_flags, S390_SECURE_IPL_SCLAB_FLAG_OLA);
+}
+
+static inline bool validate_lpsw(uint64_t sclab_load_psw, uint64_t comp_load_psw)
+{
+    /* compare load PSW with the PSW specified in component */
+    return sclab_load_psw == comp_load_psw;
+}

Most of these inline functions just compare something with 0 or other values here, and you only use them in one spot of the code ... So you need 5 lines of code for something that could be done in two lines of code at the calling sites instead, i.e. this looks like unnecessary code to me. Please inline the comparisons (together with the comment that you've got here) in the calling sites to get rid of this code bloat.

Thanks,
Thomas

#75 lore raw

Re: [PATCH v6 21/28] pc-bios/s390-ccw: Add additional security checks for secure boot

Quoted 5 lines · Zhuoying Cai

Thank you for all the feedback! I'll address the comments in the next version.

Quoted 1 line · Thomas Huth

On 18/09/2025 01.21, Zhuoying Cai wrote:

...

Quoted 10 lines
Quoted 9 lines

pc-bios/s390-ccw/secure-ipl.c static void init_lists(IplDeviceComponentList *comps, IplSignatureCertificateLis · line 432

Quoted 5 lines
pc-bios/s390-ccw/secure-ipl.c +5 -0
+    /* PSW points within a signed binary code component */
+    for (int i = 0; i < range_index; i++) {
+        if (comp_addr_range[i].is_signed &&
+            addr >= comp_addr_range[i].start_addr &&
+            addr <= comp_addr_range[i].end_addr) {

is it still OK if the address points to the end_addr? Or should that be end_addr - 2 instead (since an opcode has at least two bytes)?

Quoted 6 lines

Using end_addr - 2 seems correct, since it accounts for the minimum instruction length.

Just to clarify: using end_addr - 2 should ensure that at least a 2-byte instruction fits. Should longer instructions (e.g., 4 and 6 bytes) be a concern in this context?

No clue ... but I guess it should be fine if the instruction at least starts in the signed area?

Thomas

#76 lore raw

PATCH v6 22/28 Add secure-boot to s390-ccw-virtio machine type option

In reply to Zhuoying Cai

Add secure-boot as a parameter of s390-ccw-virtio machine type option.

The secure-boot=on|off parameter is implemented to enable secure IPL.

By default, secure-boot is set to false if not specified in the command line.

---
 docs/system/s390x/secure-ipl.rst   | 20 ++++++++++++++++----
 hw/s390x/s390-virtio-ccw.c         | 22 ++++++++++++++++++++++
 include/hw/s390x/s390-virtio-ccw.h |  1 +
 qemu-options.hx                    |  6 +++++-
 4 files changed, 44 insertions(+), 5 deletions(-)
docs/system/s390x/secure-ipl.rst +16 -4
index 701594b9de..205de8bc02 100644
@@ -20,19 +20,31 @@ Note: certificate files must have a .pem extension.
                                boot-certs.0.path=/.../qemu/certs, \
                                boot-certs.1.path=/another/path/cert.pem ...
 
+Enabling Secure IPL
+-------------------
+
+Secure IPL is enabled by explicitly setting ``secure-boot=on``; if not specified,
+secure boot is considered off.
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio,secure-boot=on|off
+
 
 IPL Modes
 =========
 
 The concept of IPL Modes are introduced to differentiate between the IPL configurations.
-These modes are mutually exclusive and enabled based on the ``boot-certs`` option on the
-QEMU command line.
+These modes are mutually exclusive and enabled based on specific combinations of
+the ``secure-boot`` and ``boot-certs`` options on the QEMU command line.
 
 Normal Mode
 -----------
 
-The absence of certificates will attempt to IPL a guest without secure IPL operations.
-No checks are performed, and no warnings/errors are reported. This is the default mode.
+The absence of both certificates and the ``secure-boot`` option will attempt to
+IPL a guest without secure IPL operations. No checks are performed, and no
+warnings/errors are reported.  This is the default mode, and can be explicitly
+enabled with ``secure-boot=off``.
 
 Configuration:
 
hw/s390x/s390-virtio-ccw.c +22 -0
index b825f4cce1..5c15908b8f 100644
@@ -823,6 +823,21 @@ static void machine_set_boot_certs(Object *obj, Visitor *v, const char *name,
     ms->boot_certs = cert_list;
 }
 
+static inline bool machine_get_secure_boot(Object *obj, Error **errp)
+{
+    S390CcwMachineState *ms = S390_CCW_MACHINE(obj);
+
+    return ms->secure_boot;
+}
+
+static inline void machine_set_secure_boot(Object *obj, bool value,
+                                            Error **errp)
+{
+    S390CcwMachineState *ms = S390_CCW_MACHINE(obj);
+
+    ms->secure_boot = value;
+}
+
 static void ccw_machine_class_init(ObjectClass *oc, const void *data)
 {
     MachineClass *mc = MACHINE_CLASS(oc);
@@ -881,6 +896,13 @@ static void ccw_machine_class_init(ObjectClass *oc, const void *data)
                               machine_get_boot_certs, machine_set_boot_certs, NULL, NULL);
     object_class_property_set_description(oc, "boot-certs",
             "provide paths to a directory and/or a certificate file for secure boot");
+
+    object_class_property_add_bool(oc, "secure-boot",
+                                   machine_get_secure_boot,
+                                   machine_set_secure_boot);
+    object_class_property_set_description(oc, "secure-boot",
+            "enable/disable secure boot");
+
 }
 
 static inline void s390_machine_initfn(Object *obj)
include/hw/s390x/s390-virtio-ccw.h +1 -0
index 334b67ef05..1dba5ab37e 100644
@@ -33,6 +33,7 @@ struct S390CcwMachineState {
     uint64_t memory_limit;
     uint64_t max_pagesize;
     BootCertificateList *boot_certs;
+    bool secure_boot;
 
     SCLPDevice *sclp;
 };
qemu-options.hx +5 -1
index ac497eb3a0..5d9cd0d0f1 100644
@@ -45,7 +45,8 @@ DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
     "                memory-backend='backend-id' specifies explicitly provided backend for main RAM (default=none)\n"
     "                cxl-fmw.0.targets.0=firsttarget,cxl-fmw.0.targets.1=secondtarget,cxl-fmw.0.size=size[,cxl-fmw.0.interleave-granularity=granularity]\n"
     "                smp-cache.0.cache=cachename,smp-cache.0.topology=topologylevel\n"
-    "                boot-certs.0.path=/path/directory,boot-certs.1.path=/path/file provides paths to a directory and/or a certificate file\n",
+    "                boot-certs.0.path=/path/directory,boot-certs.1.path=/path/file provides paths to a directory and/or a certificate file\n"
+    "                secure-boot=on|off enable/disable secure boot (default=off) \n",
     QEMU_ARCH_ALL)
 SRST
 ``-machine [type=]name[,prop=value[,...]]``
@@ -209,6 +210,9 @@ SRST
 
     ``boot-certs.0.path=/path/directory,boot-certs.1.path=/path/file``
         Provide paths to a directory and/or a certificate file on the host [s390x only].
+
+    ``secure-boot=on|off``
+        Enables or disables secure boot on s390-ccw guest. The default is off.
 ERST
 
 DEF("M", HAS_ARG, QEMU_OPTION_M,
Signature · 1 line
2.50.1
#77 lore raw

Re: [PATCH v6 22/28] Add secure-boot to s390-ccw-virtio machine type option

Quoted 9 lines · Zhuoying Cai

Add secure-boot as a parameter of s390-ccw-virtio machine type option.

The secure-boot=on|off parameter is implemented to enable secure IPL.

By default, secure-boot is set to false if not specified in the command line.

---

...

include/hw/s390x/s390-virtio-ccw.h struct S390CcwMachineState { · line 36

Quoted 9 lines
include/hw/s390x/s390-virtio-ccw.h +1 -0
index 334b67ef05..1dba5ab37e 100644
@@ -33,6 +33,7 @@ struct S390CcwMachineState {
      uint64_t memory_limit;
      uint64_t max_pagesize;
      BootCertificateList *boot_certs;
+    bool secure_boot;

Could you please move it next to the other "bool" variables in this struct? (to avoid additional padding)

Thanks,
Thomas

#78 lore raw

PATCH v6 23/28 hw/s390x/ipl: Set IPIB flags for secure IPL

In reply to Zhuoying Cai

If -secure-boot on is specified on the command line option, indicating true secure IPL enabled, set Secure-IPL bit and IPL-Information-Report bit on in IPIB Flags field, and trigger true secure IPL in the S390 BIOS.

Any error that occurs during true secure IPL will cause the IPL to terminate.

---
 hw/s390x/ipl.c | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)
hw/s390x/ipl.c +17 -1
index c1360905c4..42b25513a2 100644
@@ -437,6 +437,11 @@ static bool s390_has_certificate(void)
     return ipl->cert_store.count > 0;
 }
 
+static bool s390_secure_boot_enabled(void)
+{
+    return S390_CCW_MACHINE(qdev_get_machine())->secure_boot;
+}
+
 static bool s390_build_iplb(DeviceState *dev_st, IplParameterBlock *iplb)
 {
     CcwDevice *ccw_dev = NULL;
@@ -494,6 +499,17 @@ static bool s390_build_iplb(DeviceState *dev_st, IplParameterBlock *iplb)
         s390_ipl_convert_loadparm((char *)lp, iplb->loadparm);
         iplb->flags |= DIAG308_FLAGS_LP_VALID;
 
+        /*
+         * If secure-boot is enabled, then toggle the secure IPL flags to trigger
+         * secure boot in the s390 BIOS.
+         *
+         * Boot process will terminate if any error occurs during secure boot.
+         *
+         * If SIPL is on, IPLIR must also be on.
+         */
+        if (s390_secure_boot_enabled()) {
+            iplb->hdr_flags |= (DIAG308_IPIB_FLAGS_SIPL | DIAG308_IPIB_FLAGS_IPLIR);
+        }
         /*
          * Secure boot in audit mode will perform
          * if certificate(s) exist in the key store.
@@ -503,7 +519,7 @@ static bool s390_build_iplb(DeviceState *dev_st, IplParameterBlock *iplb)
          *
          * Results of secure boot will be stored in IIRB.
          */
-        if (s390_has_certificate()) {
+        else if (s390_has_certificate()) {
             iplb->hdr_flags |= DIAG308_IPIB_FLAGS_IPLIR;
         }
 
Signature · 1 line
2.50.1
#79 lore raw

PATCH v6 24/28 pc-bios/s390-ccw: Handle true secure IPL mode

In reply to Zhuoying Cai

When secure boot is enabled (-secure-boot on) and certificate(s) are provided, the boot operates in True Secure IPL mode.

Any verification error during True Secure IPL mode will cause the entire boot process to terminate.

Secure IPL in audit mode requires at least one certificate provided in the key store along with necessary facilities. If secure boot is enabled but no certificate is provided, the boot process will also terminate, as this is not a valid secure boot configuration.

Note: True Secure IPL mode is implemented for the SCSI scheme of virtio-blk/virtio-scsi devices.

---
 docs/system/s390x/secure-ipl.rst | 16 ++++++++++++++++
 pc-bios/s390-ccw/bootmap.c       | 19 ++++++++++++++++---
 pc-bios/s390-ccw/main.c          |  7 ++++++-
 pc-bios/s390-ccw/s390-ccw.h      |  2 ++
 pc-bios/s390-ccw/secure-ipl.c    |  4 ++++
 pc-bios/s390-ccw/secure-ipl.h    |  3 +++
 6 files changed, 47 insertions(+), 4 deletions(-)
docs/system/s390x/secure-ipl.rst +16 -0
index 205de8bc02..579b7b4993 100644
@@ -67,3 +67,19 @@ Configuration:
     qemu-system-s390x -machine s390-ccw-virtio, \
                                boot-certs.0.path=/.../qemu/certs, \
                                boot-certs.1.path=/another/path/cert.pem ...
+
+Secure Mode
+-----------
+
+With *both* the presence of certificates in the store and the ``secure-boot=on``
+option, it is understood that secure boot should be performed with errors
+reported and boot will abort.
+
+Configuration:
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio, \
+                               secure-boot=on, \
+                               boot-certs.0.path=/.../qemu/certs, \
+                               boot-certs.1.path=/another/path/cert.pem ...
pc-bios/s390-ccw/bootmap.c +16 -3
index 3922e7cdde..3ab89b91fb 100644
@@ -737,6 +737,9 @@ static int zipl_run(ScsiBlockPtr *pte)
     entry = (ComponentEntry *)(&header[1]);
 
     switch (boot_mode) {
+    case ZIPL_BOOT_MODE_INVALID:
+        return -1;
+    case ZIPL_BOOT_MODE_SECURE:
     case ZIPL_BOOT_MODE_SECURE_AUDIT:
         if (zipl_run_secure(&entry, tmp_sec)) {
             return -1;
@@ -1118,9 +1121,16 @@ ZiplBootMode zipl_mode(uint8_t hdr_flags)
 {
     bool sipl_set = hdr_flags & DIAG308_IPIB_FLAGS_SIPL;
     bool iplir_set = hdr_flags & DIAG308_IPIB_FLAGS_IPLIR;
+    VCStorageSizeBlock *vcssb;
 
     if (!sipl_set && iplir_set) {
         return ZIPL_BOOT_MODE_SECURE_AUDIT;
+    } else if (sipl_set && iplir_set) {
+        vcssb = zipl_secure_get_vcssb();
+        if (vcssb == NULL || vcssb->length == VCSSB_NO_VC) {
+            return ZIPL_BOOT_MODE_INVALID;
+        }
+        return ZIPL_BOOT_MODE_SECURE;
     }
 
     return ZIPL_BOOT_MODE_NORMAL;
@@ -1131,7 +1141,8 @@ void zipl_load(void)
     VDev *vdev = virtio_get_device();
 
     if (vdev->is_cdrom) {
-        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
+            boot_mode == ZIPL_BOOT_MODE_SECURE) {
             panic("Secure boot from ISO image is not supported!");
         }
         ipl_iso_el_torito();
@@ -1140,7 +1151,8 @@ void zipl_load(void)
     }
 
     if (virtio_get_device_type() == VIRTIO_ID_NET) {
-        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
+            boot_mode == ZIPL_BOOT_MODE_SECURE) {
             panic("Virtio net boot device does not support secure boot!");
         }
         netmain();
@@ -1153,7 +1165,8 @@ void zipl_load(void)
         return;
     }
 
-    if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+    if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
+        boot_mode == ZIPL_BOOT_MODE_SECURE) {
         panic("ECKD boot device does not support secure boot!");
     }
 
pc-bios/s390-ccw/main.c +6 -1
index 668660e64d..c5b425209a 100644
@@ -277,10 +277,15 @@ static void ipl_boot_device(void)
         boot_mode = zipl_mode(iplb->hdr_flags);
     }
 
+    if (boot_mode == ZIPL_BOOT_MODE_INVALID) {
+        panic("Need at least one certificate for secure boot!");
+    }
+
     switch (cutype) {
     case CU_TYPE_DASD_3990:
     case CU_TYPE_DASD_2107:
-        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT) {
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
+            boot_mode == ZIPL_BOOT_MODE_SECURE) {
             panic("Passthrough (vfio) device does not support secure boot!");
         }
 
pc-bios/s390-ccw/s390-ccw.h +2 -0
index 6d51d07c90..389cc8ea7c 100644
@@ -83,9 +83,11 @@ int virtio_read(unsigned long sector, void *load_addr);
 void zipl_load(void);
 
 typedef enum ZiplBootMode {
+    ZIPL_BOOT_MODE_INVALID = -1,
     ZIPL_BOOT_MODE_UNSPECIFIED = 0,
     ZIPL_BOOT_MODE_NORMAL = 1,
     ZIPL_BOOT_MODE_SECURE_AUDIT = 2,
+    ZIPL_BOOT_MODE_SECURE = 3,
 } ZiplBootMode;
 
 extern ZiplBootMode boot_mode;
pc-bios/s390-ccw/secure-ipl.c +4 -0
index cd798c1198..92e3e1e021 100644
@@ -287,6 +287,10 @@ static bool check_sclab_presence(uint8_t *sclab_magic,
         comps->device_entries[comp_index].cei |= S390_IPL_COMPONENT_CEI_INVALID_SCLAB;
 
         /* a missing SCLAB will not be reported in audit mode */
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE) {
+            zipl_secure_handle("Magic is not matched. SCLAB does not exist");
+         }
+
         return false;
     }
 
pc-bios/s390-ccw/secure-ipl.h +3 -0
index 87aa6e1465..d7786158c4 100644
@@ -58,6 +58,9 @@ static inline void zipl_secure_handle(const char *message)
     case ZIPL_BOOT_MODE_SECURE_AUDIT:
         IPL_check(false, message);
         break;
+    case ZIPL_BOOT_MODE_SECURE:
+        IPL_assert(false, message);
+        break;
     default:
         break;
     }
Signature · 1 line
2.50.1
#80 lore raw

Re: [PATCH v6 24/28] pc-bios/s390-ccw: Handle true secure IPL mode

Quoted 29 lines · Zhuoying Cai

When secure boot is enabled (-secure-boot on) and certificate(s) are provided, the boot operates in True Secure IPL mode.

Any verification error during True Secure IPL mode will cause the entire boot process to terminate.

Secure IPL in audit mode requires at least one certificate provided in the key store along with necessary facilities. If secure boot is enabled but no certificate is provided, the boot process will also terminate, as this is not a valid secure boot configuration.

Note: True Secure IPL mode is implemented for the SCSI scheme of virtio-blk/virtio-scsi devices.

---
  docs/system/s390x/secure-ipl.rst | 16 ++++++++++++++++
  pc-bios/s390-ccw/bootmap.c       | 19 ++++++++++++++++---
  pc-bios/s390-ccw/main.c          |  7 ++++++-
  pc-bios/s390-ccw/s390-ccw.h      |  2 ++
  pc-bios/s390-ccw/secure-ipl.c    |  4 ++++
  pc-bios/s390-ccw/secure-ipl.h    |  3 +++
  6 files changed, 47 insertions(+), 4 deletions(-)
docs/system/s390x/secure-ipl.rst +0 -0
index 205de8bc02..579b7b4993 100644

docs/system/s390x/secure-ipl.rst Configuration: · line 75

Quoted 9 lines
docs/system/s390x/secure-ipl.rst +6 -0
@@ -67,3 +67,19 @@ Configuration:
      qemu-system-s390x -machine s390-ccw-virtio, \
                                 boot-certs.0.path=/.../qemu/certs, \
                                 boot-certs.1.path=/another/path/cert.pem ...
+
+Secure Mode
+-----------
+
+With *both* the presence of certificates in the store and the ``secure-boot=on``
+option, it is understood that secure boot should be performed with errors

"it is understood" sounds weird to me here ... maybe rather:

If both, certificates are provided and the ``secure-boot=on`` option has been set, a secure boot is performed with error reporting enabled, and the boot process will abort on any error.

?

Quoted 10 lines
docs/system/s390x/secure-ipl.rst +10 -0
+reported and boot will abort.
+
+Configuration:
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio, \
+                               secure-boot=on, \
+                               boot-certs.0.path=/.../qemu/certs, \
+                               boot-certs.1.path=/another/path/cert.pem ...

...

pc-bios/s390-ccw/secure-ipl.c static bool check_sclab_presence(uint8_t *sclab_magic, · line 291

Quoted 10 lines
pc-bios/s390-ccw/secure-ipl.c +2 -0
index cd798c1198..92e3e1e021 100644
@@ -287,6 +287,10 @@ static bool check_sclab_presence(uint8_t *sclab_magic,
          comps->device_entries[comp_index].cei |= S390_IPL_COMPONENT_CEI_INVALID_SCLAB;
 
          /* a missing SCLAB will not be reported in audit mode */
+        if (boot_mode == ZIPL_BOOT_MODE_SECURE) {
+            zipl_secure_handle("Magic is not matched. SCLAB does not exist");

I'm not a native speaker, but maybe rather "Magic does not match" ?

pc-bios/s390-ccw/secure-ipl.c static bool check_sclab_presence(uint8_t *sclab_magic, · line 292

Quoted 1 line
pc-bios/s390-ccw/secure-ipl.c +1 -0
+         }

Indentation of the } is off by 1 here.

pc-bios/s390-ccw/secure-ipl.h static inline void zipl_secure_handle(const char *message) · line 62

Quoted 13 lines
pc-bios/s390-ccw/secure-ipl.c +0 -0
          return false;
      }
 
pc-bios/s390-ccw/secure-ipl.h +2 -0
index 87aa6e1465..d7786158c4 100644
@@ -58,6 +58,9 @@ static inline void zipl_secure_handle(const char *message)
      case ZIPL_BOOT_MODE_SECURE_AUDIT:
          IPL_check(false, message);
          break;
+    case ZIPL_BOOT_MODE_SECURE:
+        IPL_assert(false, message);

Using IPL_assert() with false looks weird. Why not simply panic(message) instead?

pc-bios/s390-ccw/secure-ipl.h static inline void zipl_secure_handle(const char *message) · line 66

Quoted 4 lines
pc-bios/s390-ccw/secure-ipl.h +1 -0
+        break;
      default:
          break;
      }

Thomas

#81 lore raw

PATCH v6 25/28 pc-bios/s390-ccw: Handle secure boot with multiple boot devices

In reply to Zhuoying Cai

The current approach to enable secure boot relies on providing secure-boot and boot-certs parameters of s390-ccw-virtio machine type option, which apply to all boot devices.

With the possibility of multiple boot devices, secure boot expects all provided devices to be supported and eligible (e.g., virtio-blk/virtio-scsi using the SCSI scheme).

If multiple boot devices are provided and include an unsupported (e.g., ECKD, VFIO) or a non-eligible (e.g., Net) device, the boot process will terminate with an error logged to the console.

---
 pc-bios/s390-ccw/bootmap.c  | 31 ++++++++-------
 pc-bios/s390-ccw/main.c     | 75 ++++++++++++++++++++++++++++++++++---
 pc-bios/s390-ccw/s390-ccw.h |  1 +
 3 files changed, 88 insertions(+), 19 deletions(-)
pc-bios/s390-ccw/bootmap.c +18 -13
index 3ab89b91fb..8297f22c3c 100644
@@ -1136,25 +1136,35 @@ ZiplBootMode zipl_mode(uint8_t hdr_flags)
     return ZIPL_BOOT_MODE_NORMAL;
 }
 
+int zipl_check_scsi_mbr_magic(void)
+{
+    ScsiMbr *mbr = (void *)sec;
+
+    /* Grab the MBR */
+    memset(sec, FREE_SPACE_FILLER, sizeof(sec));
+    if (virtio_read(0, mbr)) {
+        puts("Cannot read block 0");
+        return -EIO;
+    }
+
+    if (!magic_match(mbr->magic, ZIPL_MAGIC)) {
+        return -1;
+    }
+
+    return 0;
+}
+
 void zipl_load(void)
 {
     VDev *vdev = virtio_get_device();
 
     if (vdev->is_cdrom) {
-        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
-            boot_mode == ZIPL_BOOT_MODE_SECURE) {
-            panic("Secure boot from ISO image is not supported!");
-        }
         ipl_iso_el_torito();
         puts("Failed to IPL this ISO image!");
         return;
     }
 
     if (virtio_get_device_type() == VIRTIO_ID_NET) {
-        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
-            boot_mode == ZIPL_BOOT_MODE_SECURE) {
-            panic("Virtio net boot device does not support secure boot!");
-        }
         netmain();
         puts("Failed to IPL from this network!");
         return;
@@ -1165,11 +1175,6 @@ void zipl_load(void)
         return;
     }
 
-    if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
-        boot_mode == ZIPL_BOOT_MODE_SECURE) {
-        panic("ECKD boot device does not support secure boot!");
-    }
-
     switch (virtio_get_device_type()) {
     case VIRTIO_ID_BLOCK:
         zipl_load_vblk();
pc-bios/s390-ccw/main.c +69 -6

97 lines not on this page · raw message

pc-bios/s390-ccw/s390-ccw.h +1 -0
index 389cc8ea7c..3009104686 100644
@@ -93,6 +93,7 @@ typedef enum ZiplBootMode {
 extern ZiplBootMode boot_mode;
 
 ZiplBootMode zipl_mode(uint8_t hdr_flags);
+int zipl_check_scsi_mbr_magic(void);
 
 /* jump2ipl.c */
 void write_reset_psw(uint64_t psw);
Signature · 1 line
2.50.1
#82 lore raw

Re: [PATCH v6 25/28] pc-bios/s390-ccw: Handle secure boot with multiple boot devices

Quoted 133 lines · Zhuoying Cai

The current approach to enable secure boot relies on providing secure-boot and boot-certs parameters of s390-ccw-virtio machine type option, which apply to all boot devices.

With the possibility of multiple boot devices, secure boot expects all provided devices to be supported and eligible (e.g., virtio-blk/virtio-scsi using the SCSI scheme).

If multiple boot devices are provided and include an unsupported (e.g., ECKD, VFIO) or a non-eligible (e.g., Net) device, the boot process will terminate with an error logged to the console.

---
  pc-bios/s390-ccw/bootmap.c  | 31 ++++++++-------
  pc-bios/s390-ccw/main.c     | 75 ++++++++++++++++++++++++++++++++++---
  pc-bios/s390-ccw/s390-ccw.h |  1 +
  3 files changed, 88 insertions(+), 19 deletions(-)
pc-bios/s390-ccw/bootmap.c +18 -13
index 3ab89b91fb..8297f22c3c 100644
@@ -1136,25 +1136,35 @@ ZiplBootMode zipl_mode(uint8_t hdr_flags)
      return ZIPL_BOOT_MODE_NORMAL;
  }
 
+int zipl_check_scsi_mbr_magic(void)
+{
+    ScsiMbr *mbr = (void *)sec;
+
+    /* Grab the MBR */
+    memset(sec, FREE_SPACE_FILLER, sizeof(sec));
+    if (virtio_read(0, mbr)) {
+        puts("Cannot read block 0");
+        return -EIO;
+    }
+
+    if (!magic_match(mbr->magic, ZIPL_MAGIC)) {
+        return -1;
+    }
+
+    return 0;
+}
+
  void zipl_load(void)
  {
      VDev *vdev = virtio_get_device();
 
      if (vdev->is_cdrom) {
-        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
-            boot_mode == ZIPL_BOOT_MODE_SECURE) {
-            panic("Secure boot from ISO image is not supported!");
-        }
          ipl_iso_el_torito();
          puts("Failed to IPL this ISO image!");
          return;
      }
 
      if (virtio_get_device_type() == VIRTIO_ID_NET) {
-        if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
-            boot_mode == ZIPL_BOOT_MODE_SECURE) {
-            panic("Virtio net boot device does not support secure boot!");
-        }
          netmain();
          puts("Failed to IPL from this network!");
          return;
@@ -1165,11 +1175,6 @@ void zipl_load(void)
          return;
      }
 
-    if (boot_mode == ZIPL_BOOT_MODE_SECURE_AUDIT ||
-        boot_mode == ZIPL_BOOT_MODE_SECURE) {
-        panic("ECKD boot device does not support secure boot!");
-    }
-
      switch (virtio_get_device_type()) {
      case VIRTIO_ID_BLOCK:
          zipl_load_vblk();
pc-bios/s390-ccw/main.c +37 -1
index c5b425209a..228b52a37e 100644
@@ -271,8 +271,43 @@ static int virtio_setup(void)
      return ret;
  }
 
-static void ipl_boot_device(void)
+static void validate_secure_boot_device(void)
+{
+    switch (cutype) {
+    case CU_TYPE_DASD_3990:
+    case CU_TYPE_DASD_2107:
+        panic("Passthrough (vfio) device does not support secure boot!");
+        break;
+    case CU_TYPE_VIRTIO:
+        if (virtio_setup() == 0) {
+            VDev *vdev = virtio_get_device();
+
+            if (vdev->is_cdrom) {
+                panic("Secure boot from ISO image is not supported!");
+            }
+
+            if (virtio_get_device_type() == VIRTIO_ID_NET) {
+                panic("Virtio net boot device does not support secure boot!");
+            }
+
+            if (zipl_check_scsi_mbr_magic()) {
+                panic("ECKD boot device does not support secure boot!");
+            }
+        }
+        break;
+    default:
+        panic("Secure boot from unexpected device type is not supported!");
+    }
+
+    printf("SCSI boot device supports secure boot.\n");
+}
+
+static void check_secure_boot_support(void)
  {
+    bool have_iplb_copy;
+    IplParameterBlock *iplb_copy;
+    QemuIplParameters *qipl_copy;
+
      if (boot_mode == ZIPL_BOOT_MODE_UNSPECIFIED) {
          boot_mode = zipl_mode(iplb->hdr_flags);
      }
@@ -281,14 +316,40 @@ static void ipl_boot_device(void)
          panic("Need at least one certificate for secure boot!");
      }
 
+    if (boot_mode == ZIPL_BOOT_MODE_NORMAL) {

pc-bios/s390-ccw/main.c static void ipl_boot_device(void) · line 329

Quoted 10 lines
pc-bios/s390-ccw/main.c +10 -0
+        return;
+    }
+
+    /*
+     * Store copies of have_iplb, iplb and qipl.
+     * They will be updated in load_next_iplb().
+     */
+    have_iplb_copy = have_iplb;
+    iplb_copy = malloc(sizeof(IplParameterBlock));
+    qipl_copy = malloc(sizeof(QemuIplParameters));

While IplParameterBlock is huge (4k), a malloc is justified for that. But QemuIplParameters is just a bunch of bytes (28 if I counted correctly), so I think it would be nicer to use a stack variable for that instead.

Thomas

Quoted 16 lines
pc-bios/s390-ccw/main.c +16 -0
+    memcpy(qipl_copy, &qipl, sizeof(QemuIplParameters));
+    memcpy(iplb_copy, iplb, sizeof(IplParameterBlock));
+
+    while (have_iplb_copy) {
+        if (have_iplb_copy && find_boot_device()) {
+            validate_secure_boot_device();
+        }
+        have_iplb_copy = load_next_iplb();
+    }
+
+    memcpy(&qipl, qipl_copy, sizeof(QemuIplParameters));
+    memcpy(iplb, iplb_copy, sizeof(IplParameterBlock));
+
+    free(qipl_copy);
+    free(iplb_copy);
+}
#83 lore raw

PATCH v6 26/28 hw/s390x/ipl: Handle secure boot without specifying a boot device

In reply to Zhuoying Cai

If secure boot in audit mode or True Secure IPL mode is enabled without specifying a boot device, the boot process will terminate with an error.

---
 hw/s390x/ipl.c | 10 ++++++++++
 1 file changed, 10 insertions(+)
hw/s390x/ipl.c +10 -0
index 42b25513a2..5edbc2451b 100644
@@ -771,6 +771,16 @@ void s390_ipl_prepare_cpu(S390CPU *cpu)
         }
         if (!ipl->iplb_valid) {
             ipl->iplb_valid = s390_init_all_iplbs(ipl);
+
+            /*
+             * Secure IPL without specifying a boot device.
+             * IPLB is not generated if no boot device is defined.
+             */
+            if ((s390_has_certificate() || s390_secure_boot_enabled()) &&
+                !ipl->iplb_valid) {
+                error_report("No boot device defined for Secure IPL");
+                exit(1);
+            }
         } else {
             ipl->qipl.chain_len = 0;
         }
Signature · 1 line
2.50.1
#84 lore raw

PATCH v6 27/28 docs/specs: Add secure IPL documentation

In reply to Zhuoying Cai

Add documentation for secure IPL

---
 docs/specs/s390x-secure-ipl.rst | 53 +++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
docs/specs/s390x-secure-ipl.rst +53 -0
index a19b976e25..8238fad30a 100644
@@ -1,5 +1,58 @@
 .. SPDX-License-Identifier: GPL-2.0-or-later
 
+s390 Secure IPL
+===============
+
+Secure IPL (a.k.a. secure boot) enables s390-ccw virtual machines to
+leverage qcrypto libraries and z/Architecture emulations to verify the
+integrity of signed kernels. The qcrypto libraries are used to perform
+certificate validation and signature-verification, whereas the
+z/Architecture emulations are used to ensure secure IPL data has not
+been tampered with, convey data between QEMU and userspace, and set up
+the relevant secure IPL data structures with verification results.
+
+To find out more about using this feature, see ``docs/system/s390x/secure-ipl.rst``.
+
+Note that "userspace" will refer to the s390-ccw BIOS unless stated
+otherwise.
+
+Both QEMU and userspace work in tandem to perform secure IPL. The Secure
+Loading Attributes Facility (SCLAF) is used to check the Secure Code
+Loading Attribute Block (SCLAB) and ensure that secure IPL data has not
+been tampered with. DIAGNOSE 'X'320' is invoked by userspace to query
+the certificate store info and retrieve specific certificates from QEMU.
+DIAGNOSE 'X'508' is used by userspace to leverage qcrypto libraries to
+perform signature-verification in QEMU. Lastly, userspace generates and
+appends an IPL Information Report Block (IIRB) at the end of the IPL
+Parameter Block, which is used by the kernel to store signed and
+verified entries.
+
+The logical steps are as follows:
+
+- Userspace reads data payload from disk (e.g. stage3 boot loader, kernel)
+- Userspace checks the validity of the SCLAB
+- Userspace invokes DIAG 508 subcode 1 and provides it the payload
+- QEMU handles DIAG 508 request by reading the payload and retrieving the
+  certificate store
+- QEMU DIAG 508 utilizes qcrypto libraries to perform signature-verification on
+  the payload, attempting with each cert in the store (until success or exhausted)
+- QEMU DIAG 508 returns:
+
+  - success: index of cert used to verify payload
+  - failure: error code
+
+- Userspace responds to this operation:
+
+  - success: retrieves cert from store via DIAG 320 using returned index
+  - failure: reports with warning (audit mode), aborts with error (secure mode)
+
+- Userspace appends IIRB at the end of the IPLB
+- Userspace kicks off IPL
+
+More information regarding the respective DIAGNOSE commands and IPL data
+structures are outlined within this document.
+
+
 s390 Certificate Store and Functions
 ====================================
 
Signature · 1 line
2.50.1
#85 lore raw

Re: [PATCH v6 27/28] docs/specs: Add secure IPL documentation

Quoted 40 lines · Zhuoying Cai

Add documentation for secure IPL

---
  docs/specs/s390x-secure-ipl.rst | 53 +++++++++++++++++++++++++++++++++
  1 file changed, 53 insertions(+)
docs/specs/s390x-secure-ipl.rst +26 -0
index a19b976e25..8238fad30a 100644
@@ -1,5 +1,58 @@
  .. SPDX-License-Identifier: GPL-2.0-or-later
 
+s390 Secure IPL
+===============
+
+Secure IPL (a.k.a. secure boot) enables s390-ccw virtual machines to
+leverage qcrypto libraries and z/Architecture emulations to verify the
+integrity of signed kernels. The qcrypto libraries are used to perform
+certificate validation and signature-verification, whereas the
+z/Architecture emulations are used to ensure secure IPL data has not
+been tampered with, convey data between QEMU and userspace, and set up
+the relevant secure IPL data structures with verification results.
+
+To find out more about using this feature, see ``docs/system/s390x/secure-ipl.rst``.
+
+Note that "userspace" will refer to the s390-ccw BIOS unless stated
+otherwise.
+
+Both QEMU and userspace work in tandem to perform secure IPL. The Secure
+Loading Attributes Facility (SCLAF) is used to check the Secure Code
+Loading Attribute Block (SCLAB) and ensure that secure IPL data has not
+been tampered with. DIAGNOSE 'X'320' is invoked by userspace to query
+the certificate store info and retrieve specific certificates from QEMU.
+DIAGNOSE 'X'508' is used by userspace to leverage qcrypto libraries to
+perform signature-verification in QEMU. Lastly, userspace generates and
+appends an IPL Information Report Block (IIRB) at the end of the IPL
+Parameter Block, which is used by the kernel to store signed and
+verified entries.

docs/specs/s390x-secure-ipl.rst line 38

Quoted 10 lines
docs/specs/s390x-secure-ipl.rst +10 -0
+
+The logical steps are as follows:
+
+- Userspace reads data payload from disk (e.g. stage3 boot loader, kernel)
+- Userspace checks the validity of the SCLAB
+- Userspace invokes DIAG 508 subcode 1 and provides it the payload
+- QEMU handles DIAG 508 request by reading the payload and retrieving the
+  certificate store
+- QEMU DIAG 508 utilizes qcrypto libraries to perform signature-verification on
+  the payload, attempting with each cert in the store (until success or exhausted)

80 columns, please.

Thanks,
Thomas

#86 lore raw

PATCH v6 28/28 docs/system/s390x: Add secure IPL documentation

In reply to Zhuoying Cai

Add documentation for secure IPL

---
 docs/system/s390x/secure-ipl.rst | 96 ++++++++++++++++++++++++++++++++
 1 file changed, 96 insertions(+)
docs/system/s390x/secure-ipl.rst +96 -0
index 579b7b4993..110dea9fdd 100644
@@ -1,5 +1,21 @@
 .. SPDX-License-Identifier: GPL-2.0-or-later
 
+s390 Secure IPL
+===============
+
+Secure IPL, also known as secure boot, enables s390-ccw virtual machines to
+verify the integrity of guest kernels.
+
+For technical details of this feature, see ``docs/specs/s390x-secure-ipl.rst``.
+
+This document explains how to use secure IPL with s390x in QEMU. It covers
+new command line options for providing certificates and enabling secure IPL,
+the different IPL modes (Normal, Audit, and Secure), and system requirements.
+
+A quickstart guide is provided to demonstrate how to generate certificates,
+sign images, and start a guest in Secure Mode.
+
+
 Secure IPL Command Line Options
 ===============================
 
@@ -83,3 +99,83 @@ Configuration:
                                secure-boot=on, \
                                boot-certs.0.path=/.../qemu/certs, \
                                boot-certs.1.path=/another/path/cert.pem ...
+
+
+Constraints
+===========
+
+The following constraints apply when attempting to secure IPL an s390 guest:
+
+- z16 CPU model
+- certificates must be in X.509 PEM format
+- only support for SCSI scheme of virtio-blk/virtio-scsi devices
+- a boot device must be specified
+- any unsupported devices (e.g., ECKD and VFIO) or non-eligible devices (e.g.,
+  Net) will cause the entire boot process terminating early with an error
+  logged to the console.
+
+
+Secure IPL Quickstart
+=====================
+
+Build QEMU with gnutls enabled
+-------------------------------
+
+.. code-block:: shell
+
+    ./configure … --enable-gnutls
+
+Generate certificate (e.g. via certtool)
+----------------------------------------
+
+A private key is required before generating a certificate. This key must be kept secure
+and confidential.
+
+Use an RSA private key for signing.
+
+.. code-block:: shell
+
+    certtool --generate-privkey > key.pem
+
+A self-signed certificate requires the organization name. Use the ``cert.info`` template
+to pre-fill values and avoid interactive prompts from certtool.
+
+.. code-block:: shell
+
+    cat > cert.info <<EOF
+    cn = "My Name"
+    expiration_days = 36500
+    cert_signing_key
+    EOF
+
+    certtool --generate-self-signed \
+             --load-privkey key.pem \
+             --template cert.info \
+             --hash=SHA256 \
+             --outfile cert.pem
+
+Sign Images (e.g. via sign-file)
+--------------------------------
+
+- signing must be performed on a KVM guest filesystem
+- sign-file script used in the example below is located within the kernel source
+  repo
+
+.. code-block:: shell
+
+    ./sign-file sha256 key.pem cert.pem /boot/vmlinuz-…
+    ./sign-file sha256 key.pem cert.pem /usr/lib/s390-tools/stage3.bin
+
+Run zipl with secure boot enabled
+---------------------------------
+
+.. code-block:: shell
+
+    zipl --secure 1 -V
+
+Start Guest with Cmd Options
+----------------------------
+
+.. code-block:: shell
+
+    qemu-system-s390x -machine s390-ccw-virtio,secure-boot=on,boot-certs.0.path=cert.pem ...
Signature · 1 line
2.50.1
#87 lore raw

Re: [PATCH v6 28/28] docs/system/s390x: Add secure IPL documentation

Quoted 59 lines · Zhuoying Cai

Add documentation for secure IPL

---
  docs/system/s390x/secure-ipl.rst | 96 ++++++++++++++++++++++++++++++++
  1 file changed, 96 insertions(+)
docs/system/s390x/secure-ipl.rst +37 -0
index 579b7b4993..110dea9fdd 100644
@@ -1,5 +1,21 @@
  .. SPDX-License-Identifier: GPL-2.0-or-later
 
+s390 Secure IPL
+===============
+
+Secure IPL, also known as secure boot, enables s390-ccw virtual machines to
+verify the integrity of guest kernels.
+
+For technical details of this feature, see ``docs/specs/s390x-secure-ipl.rst``.
+
+This document explains how to use secure IPL with s390x in QEMU. It covers
+new command line options for providing certificates and enabling secure IPL,
+the different IPL modes (Normal, Audit, and Secure), and system requirements.
+
+A quickstart guide is provided to demonstrate how to generate certificates,
+sign images, and start a guest in Secure Mode.
+
+
  Secure IPL Command Line Options
  ===============================
 
@@ -83,3 +99,83 @@ Configuration:
                                 secure-boot=on, \
                                 boot-certs.0.path=/.../qemu/certs, \
                                 boot-certs.1.path=/another/path/cert.pem ...
+
+
+Constraints
+===========
+
+The following constraints apply when attempting to secure IPL an s390 guest:
+
+- z16 CPU model
+- certificates must be in X.509 PEM format
+- only support for SCSI scheme of virtio-blk/virtio-scsi devices
+- a boot device must be specified
+- any unsupported devices (e.g., ECKD and VFIO) or non-eligible devices (e.g.,
+  Net) will cause the entire boot process terminating early with an error
+  logged to the console.
+
+
+Secure IPL Quickstart
+=====================
+
+Build QEMU with gnutls enabled
+-------------------------------

docs/system/s390x/secure-ipl.rst Configuration: · line 132

Quoted 10 lines
docs/system/s390x/secure-ipl.rst +10 -0
+
+.. code-block:: shell
+
+    ./configure … --enable-gnutls
+
+Generate certificate (e.g. via certtool)
+----------------------------------------
+
+A private key is required before generating a certificate. This key must be kept secure
+and confidential.

Please try to keep line length below 80 columns. Longer lines are ok if it makes code more readable (or maybe necessary, as in "code-block" sections later in this patch), but that's not the case here. See also "Line width" in docs/devel/style.rst.

docs/system/s390x/secure-ipl.rst Configuration: · line 141

Quoted 8 lines
docs/system/s390x/secure-ipl.rst +8 -0
+Use an RSA private key for signing.
+
+.. code-block:: shell
+
+    certtool --generate-privkey > key.pem
+
+A self-signed certificate requires the organization name. Use the ``cert.info`` template
+to pre-fill values and avoid interactive prompts from certtool.

dito.

Thanks,
Thomas

#88 lore raw
In reply to Zhuoying Cai

On 18/09/2025 01.21, Zhuoying Cai wrote:
...

Quoted 43 lines
  crypto/meson.build                  |   5 +-
  crypto/x509-utils.c                 | 423 +++++++++++++++
  docs/specs/s390x-secure-ipl.rst     | 165 ++++++
  docs/system/s390x/secure-ipl.rst    | 181 +++++++
  hw/s390x/cert-store.c               | 213 ++++++++
  hw/s390x/cert-store.h               |  39 ++
  hw/s390x/ipl.c                      |  62 +++
  hw/s390x/ipl.h                      |  27 +-
  hw/s390x/meson.build                |   1 +
  hw/s390x/s390-virtio-ccw.c          |  52 ++
  hw/s390x/sclp.c                     |   2 +
  include/crypto/x509-utils.h         | 131 +++++
  include/hw/s390x/ipl/diag308.h      |  34 ++
  include/hw/s390x/ipl/diag320.h      |  91 ++++
  include/hw/s390x/ipl/diag508.h      |  38 ++
  include/hw/s390x/ipl/qipl.h         |   7 +-
  include/hw/s390x/s390-virtio-ccw.h  |   3 +
  include/hw/s390x/sclp.h             |   4 +-
  pc-bios/s390-ccw/Makefile           |   3 +-
  pc-bios/s390-ccw/bootmap.c          | 107 +++-
  pc-bios/s390-ccw/bootmap.h          |  11 +
  pc-bios/s390-ccw/iplb.h             |  96 +++-
  pc-bios/s390-ccw/jump2ipl.c         |   6 +-
  pc-bios/s390-ccw/main.c             | 111 +++-
  pc-bios/s390-ccw/netmain.c          |   8 +-
  pc-bios/s390-ccw/s390-ccw.h         |  19 +
  pc-bios/s390-ccw/sclp.c             |  52 ++
  pc-bios/s390-ccw/sclp.h             |   7 +
  pc-bios/s390-ccw/secure-ipl.c       | 781 ++++++++++++++++++++++++++++
  pc-bios/s390-ccw/secure-ipl.h       | 212 ++++++++
  qapi/machine-s390x.json             |  22 +
  qapi/pragma.json                    |   1 +
  qemu-options.hx                     |  10 +-
  target/s390x/cpu_features.c         |   7 +
  target/s390x/cpu_features.h         |   1 +
  target/s390x/cpu_features_def.h.inc |   5 +
  target/s390x/cpu_models.c           |   7 +
  target/s390x/diag.c                 | 555 +++++++++++++++++++-
  target/s390x/gen-features.c         |   7 +
  target/s390x/kvm/kvm.c              |  34 ++
  target/s390x/s390x-internal.h       |   4 +
  target/s390x/tcg/misc_helper.c      |  14 +
  42 files changed, 3488 insertions(+), 70 deletions(-)
Quoted 9 lines

create mode 100644 docs/specs/s390x-secure-ipl.rst create mode 100644 docs/system/s390x/secure-ipl.rst create mode 100644 hw/s390x/cert-store.c create mode 100644 hw/s390x/cert-store.h create mode 100644 include/hw/s390x/ipl/diag308.h create mode 100644 include/hw/s390x/ipl/diag320.h create mode 100644 include/hw/s390x/ipl/diag508.h create mode 100644 pc-bios/s390-ccw/secure-ipl.c create mode 100644 pc-bios/s390-ccw/secure-ipl.h

Hi,

looking at the file list, there does not seem to be any test in this series ... could you please add some functional tests to make sure that the feature is working as expected?

Thanks,
Thomas

#89 lore raw
Quoted 55 lines · Thomas Huth

On 18/09/2025 01.21, Zhuoying Cai wrote:
...

Quoted 43 lines
  crypto/meson.build                  |   5 +-
  crypto/x509-utils.c                 | 423 +++++++++++++++
  docs/specs/s390x-secure-ipl.rst     | 165 ++++++
  docs/system/s390x/secure-ipl.rst    | 181 +++++++
  hw/s390x/cert-store.c               | 213 ++++++++
  hw/s390x/cert-store.h               |  39 ++
  hw/s390x/ipl.c                      |  62 +++
  hw/s390x/ipl.h                      |  27 +-
  hw/s390x/meson.build                |   1 +
  hw/s390x/s390-virtio-ccw.c          |  52 ++
  hw/s390x/sclp.c                     |   2 +
  include/crypto/x509-utils.h         | 131 +++++
  include/hw/s390x/ipl/diag308.h      |  34 ++
  include/hw/s390x/ipl/diag320.h      |  91 ++++
  include/hw/s390x/ipl/diag508.h      |  38 ++
  include/hw/s390x/ipl/qipl.h         |   7 +-
  include/hw/s390x/s390-virtio-ccw.h  |   3 +
  include/hw/s390x/sclp.h             |   4 +-
  pc-bios/s390-ccw/Makefile           |   3 +-
  pc-bios/s390-ccw/bootmap.c          | 107 +++-
  pc-bios/s390-ccw/bootmap.h          |  11 +
  pc-bios/s390-ccw/iplb.h             |  96 +++-
  pc-bios/s390-ccw/jump2ipl.c         |   6 +-
  pc-bios/s390-ccw/main.c             | 111 +++-
  pc-bios/s390-ccw/netmain.c          |   8 +-
  pc-bios/s390-ccw/s390-ccw.h         |  19 +
  pc-bios/s390-ccw/sclp.c             |  52 ++
  pc-bios/s390-ccw/sclp.h             |   7 +
  pc-bios/s390-ccw/secure-ipl.c       | 781 ++++++++++++++++++++++++++++
  pc-bios/s390-ccw/secure-ipl.h       | 212 ++++++++
  qapi/machine-s390x.json             |  22 +
  qapi/pragma.json                    |   1 +
  qemu-options.hx                     |  10 +-
  target/s390x/cpu_features.c         |   7 +
  target/s390x/cpu_features.h         |   1 +
  target/s390x/cpu_features_def.h.inc |   5 +
  target/s390x/cpu_models.c           |   7 +
  target/s390x/diag.c                 | 555 +++++++++++++++++++-
  target/s390x/gen-features.c         |   7 +
  target/s390x/kvm/kvm.c              |  34 ++
  target/s390x/s390x-internal.h       |   4 +
  target/s390x/tcg/misc_helper.c      |  14 +
  42 files changed, 3488 insertions(+), 70 deletions(-)
Quoted 9 lines

create mode 100644 docs/specs/s390x-secure-ipl.rst create mode 100644 docs/system/s390x/secure-ipl.rst create mode 100644 hw/s390x/cert-store.c create mode 100644 hw/s390x/cert-store.h create mode 100644 include/hw/s390x/ipl/diag308.h create mode 100644 include/hw/s390x/ipl/diag320.h create mode 100644 include/hw/s390x/ipl/diag508.h create mode 100644 pc-bios/s390-ccw/secure-ipl.c create mode 100644 pc-bios/s390-ccw/secure-ipl.h

Quoted 9 lines

Hi,

looking at the file list, there does not seem to be any test in this series ... could you please add some functional tests to make sure that the feature is working as expected?

Thanks,
Thomas

Hi Thomas,

I’m currently working on the functional tests for secure IPL and have encountered a few blockers, so I wanted to reach out for some guidance.

The main challenge is determining how to provide signed components and signatures within the tests. In a manual secure IPL setup, we would generate certificates, use the sign-file script to sign the components (stage3 binary and kernel), and prepare zipl inside the guest. Additionally, the signed components would include Secure Code Loading Attribute Blocks (SCLABs) appended for further validation. These steps are difficult to reproduce in a functional test environment.

Our current idea is to create a bootable image using the SCSI scheme with a minimal boot map that includes fake signed components with hard-coded signatures (and SCLABs if feasible), similar to the approach used in prepare_image() in tests/qtest/cdrom-test.c. However, this approach is more complex than expected, and we are unsure how viable it is.

Do you have any suggestions on our current plan or other recommendations for how we might approach testing secure IPL? I’d appreciate your guidance.

Thank you,
Joy

#90 lore raw
Quoted 73 lines · Zhuoying Cai
Quoted 55 lines · Thomas Huth

On 18/09/2025 01.21, Zhuoying Cai wrote:
...

Quoted 43 lines
   crypto/meson.build                  |   5 +-
   crypto/x509-utils.c                 | 423 +++++++++++++++
   docs/specs/s390x-secure-ipl.rst     | 165 ++++++
   docs/system/s390x/secure-ipl.rst    | 181 +++++++
   hw/s390x/cert-store.c               | 213 ++++++++
   hw/s390x/cert-store.h               |  39 ++
   hw/s390x/ipl.c                      |  62 +++
   hw/s390x/ipl.h                      |  27 +-
   hw/s390x/meson.build                |   1 +
   hw/s390x/s390-virtio-ccw.c          |  52 ++
   hw/s390x/sclp.c                     |   2 +
   include/crypto/x509-utils.h         | 131 +++++
   include/hw/s390x/ipl/diag308.h      |  34 ++
   include/hw/s390x/ipl/diag320.h      |  91 ++++
   include/hw/s390x/ipl/diag508.h      |  38 ++
   include/hw/s390x/ipl/qipl.h         |   7 +-
   include/hw/s390x/s390-virtio-ccw.h  |   3 +
   include/hw/s390x/sclp.h             |   4 +-
   pc-bios/s390-ccw/Makefile           |   3 +-
   pc-bios/s390-ccw/bootmap.c          | 107 +++-
   pc-bios/s390-ccw/bootmap.h          |  11 +
   pc-bios/s390-ccw/iplb.h             |  96 +++-
   pc-bios/s390-ccw/jump2ipl.c         |   6 +-
   pc-bios/s390-ccw/main.c             | 111 +++-
   pc-bios/s390-ccw/netmain.c          |   8 +-
   pc-bios/s390-ccw/s390-ccw.h         |  19 +
   pc-bios/s390-ccw/sclp.c             |  52 ++
   pc-bios/s390-ccw/sclp.h             |   7 +
   pc-bios/s390-ccw/secure-ipl.c       | 781 ++++++++++++++++++++++++++++
   pc-bios/s390-ccw/secure-ipl.h       | 212 ++++++++
   qapi/machine-s390x.json             |  22 +
   qapi/pragma.json                    |   1 +
   qemu-options.hx                     |  10 +-
   target/s390x/cpu_features.c         |   7 +
   target/s390x/cpu_features.h         |   1 +
   target/s390x/cpu_features_def.h.inc |   5 +
   target/s390x/cpu_models.c           |   7 +
   target/s390x/diag.c                 | 555 +++++++++++++++++++-
   target/s390x/gen-features.c         |   7 +
   target/s390x/kvm/kvm.c              |  34 ++
   target/s390x/s390x-internal.h       |   4 +
   target/s390x/tcg/misc_helper.c      |  14 +
   42 files changed, 3488 insertions(+), 70 deletions(-)
Quoted 9 lines

create mode 100644 docs/specs/s390x-secure-ipl.rst create mode 100644 docs/system/s390x/secure-ipl.rst create mode 100644 hw/s390x/cert-store.c create mode 100644 hw/s390x/cert-store.h create mode 100644 include/hw/s390x/ipl/diag308.h create mode 100644 include/hw/s390x/ipl/diag320.h create mode 100644 include/hw/s390x/ipl/diag508.h create mode 100644 pc-bios/s390-ccw/secure-ipl.c create mode 100644 pc-bios/s390-ccw/secure-ipl.h

Quoted 5 lines
   Hi,

looking at the file list, there does not seem to be any test in this series ... could you please add some functional tests to make sure that the feature is working as expected?

I’m currently working on the functional tests for secure IPL and have encountered a few blockers, so I wanted to reach out for some guidance.

The main challenge is determining how to provide signed components and signatures within the tests. In a manual secure IPL setup, we would generate certificates, use the sign-file script to sign the components (stage3 binary and kernel), and prepare zipl inside the guest. Additionally, the signed components would include Secure Code Loading Attribute Blocks (SCLABs) appended for further validation. These steps are difficult to reproduce in a functional test environment.

Quoted 8 lines

Our current idea is to create a bootable image using the SCSI scheme with a minimal boot map that includes fake signed components with hard-coded signatures (and SCLABs if feasible), similar to the approach used in prepare_image() in tests/qtest/cdrom-test.c. However, this approach is more complex than expected, and we are unsure how viable it is.

Do you have any suggestions on our current plan or other recommendations for how we might approach testing secure IPL? I’d appreciate your guidance.

Hi,

would it be possible that you create a real small qcow2 image (e.g. with buildroot.org), make sure that it gets the right signatures, upload the image to your github account (or somewhere else), and then add a functional test to tests/functional/s390x that downloads the image and tests the boot process with it? I think that would likely be the best solution...?

HTH,
Thomas

#91 lore raw
Quoted 85 lines · Thomas Huth
Quoted 73 lines · Zhuoying Cai
Quoted 55 lines · Thomas Huth

On 18/09/2025 01.21, Zhuoying Cai wrote:
...

Quoted 43 lines
   crypto/meson.build                  |   5 +-
   crypto/x509-utils.c                 | 423 +++++++++++++++
   docs/specs/s390x-secure-ipl.rst     | 165 ++++++
   docs/system/s390x/secure-ipl.rst    | 181 +++++++
   hw/s390x/cert-store.c               | 213 ++++++++
   hw/s390x/cert-store.h               |  39 ++
   hw/s390x/ipl.c                      |  62 +++
   hw/s390x/ipl.h                      |  27 +-
   hw/s390x/meson.build                |   1 +
   hw/s390x/s390-virtio-ccw.c          |  52 ++
   hw/s390x/sclp.c                     |   2 +
   include/crypto/x509-utils.h         | 131 +++++
   include/hw/s390x/ipl/diag308.h      |  34 ++
   include/hw/s390x/ipl/diag320.h      |  91 ++++
   include/hw/s390x/ipl/diag508.h      |  38 ++
   include/hw/s390x/ipl/qipl.h         |   7 +-
   include/hw/s390x/s390-virtio-ccw.h  |   3 +
   include/hw/s390x/sclp.h             |   4 +-
   pc-bios/s390-ccw/Makefile           |   3 +-
   pc-bios/s390-ccw/bootmap.c          | 107 +++-
   pc-bios/s390-ccw/bootmap.h          |  11 +
   pc-bios/s390-ccw/iplb.h             |  96 +++-
   pc-bios/s390-ccw/jump2ipl.c         |   6 +-
   pc-bios/s390-ccw/main.c             | 111 +++-
   pc-bios/s390-ccw/netmain.c          |   8 +-
   pc-bios/s390-ccw/s390-ccw.h         |  19 +
   pc-bios/s390-ccw/sclp.c             |  52 ++
   pc-bios/s390-ccw/sclp.h             |   7 +
   pc-bios/s390-ccw/secure-ipl.c       | 781 ++++++++++++++++++++++++++++
   pc-bios/s390-ccw/secure-ipl.h       | 212 ++++++++
   qapi/machine-s390x.json             |  22 +
   qapi/pragma.json                    |   1 +
   qemu-options.hx                     |  10 +-
   target/s390x/cpu_features.c         |   7 +
   target/s390x/cpu_features.h         |   1 +
   target/s390x/cpu_features_def.h.inc |   5 +
   target/s390x/cpu_models.c           |   7 +
   target/s390x/diag.c                 | 555 +++++++++++++++++++-
   target/s390x/gen-features.c         |   7 +
   target/s390x/kvm/kvm.c              |  34 ++
   target/s390x/s390x-internal.h       |   4 +
   target/s390x/tcg/misc_helper.c      |  14 +
   42 files changed, 3488 insertions(+), 70 deletions(-)
Quoted 9 lines

create mode 100644 docs/specs/s390x-secure-ipl.rst create mode 100644 docs/system/s390x/secure-ipl.rst create mode 100644 hw/s390x/cert-store.c create mode 100644 hw/s390x/cert-store.h create mode 100644 include/hw/s390x/ipl/diag308.h create mode 100644 include/hw/s390x/ipl/diag320.h create mode 100644 include/hw/s390x/ipl/diag508.h create mode 100644 pc-bios/s390-ccw/secure-ipl.c create mode 100644 pc-bios/s390-ccw/secure-ipl.h

Quoted 5 lines
   Hi,

looking at the file list, there does not seem to be any test in this series ... could you please add some functional tests to make sure that the feature is working as expected?

I’m currently working on the functional tests for secure IPL and have encountered a few blockers, so I wanted to reach out for some guidance.

The main challenge is determining how to provide signed components and signatures within the tests. In a manual secure IPL setup, we would generate certificates, use the sign-file script to sign the components (stage3 binary and kernel), and prepare zipl inside the guest. Additionally, the signed components would include Secure Code Loading Attribute Blocks (SCLABs) appended for further validation. These steps are difficult to reproduce in a functional test environment.

Quoted 8 lines

Our current idea is to create a bootable image using the SCSI scheme with a minimal boot map that includes fake signed components with hard-coded signatures (and SCLABs if feasible), similar to the approach used in prepare_image() in tests/qtest/cdrom-test.c. However, this approach is more complex than expected, and we are unsure how viable it is.

Do you have any suggestions on our current plan or other recommendations for how we might approach testing secure IPL? I’d appreciate your guidance.

Hi,

Quoted 9 lines

would it be possible that you create a real small qcow2 image (e.g. with buildroot.org), make sure that it gets the right signatures, upload the image to your github account (or somewhere else), and then add a functional test to tests/functional/s390x that downloads the image and tests the boot process with it? I think that would likely be the best solution...?

HTH,
Thomas

I'll look into this approach. Thank you for the suggestion!