port/stmicro/stm32h5-tz-wolfhsm: convenience wrapper + CI to whTest_ClientConfig

Author: aidangarske

.github/workflows/trustzone-emulator-tests.yml

@@ -122,48 +122,40 @@ jobs:
       - name: Clean and build test with wolfHSM (stm32h5)
         run: |
           make clean distclean
-          cp config/examples/stm32h5-tz-wolfhsm.config .config
+          cd port/stmicro/stm32h5-tz-wolfhsm
           make
+          test -f out/wolfboot.bin
+          test -f out/image_v1_signed.bin
+          test -f out/manifest.env
 
       - name: Prepare wolfHSM persistence directory
         run: |
           rm -rf /tmp/m33mu-wolfhsm-persist
           mkdir -p /tmp/m33mu-wolfhsm-persist
-          rm -f /tmp/m33mu-wolfhsm-first.log /tmp/m33mu-wolfhsm-second.log
 
-      - name: Run wolfHSM first boot (stm32h5)
+      - name: Run wolfHSM whTest_ClientConfig (stm32h5)
         run: |
           cd /tmp/m33mu-wolfhsm-persist
           m33mu "$GITHUB_WORKSPACE/wolfboot.bin" \
             "$GITHUB_WORKSPACE/test-app/image_v1_signed.bin:0x60000" \
-            --persist --uart-stdout --timeout 120 --expect-bkpt 0x7d \
-            | tee /tmp/m33mu-wolfhsm-first.log
-
-      - name: Verify wolfHSM first boot (stm32h5)
-        run: |
-          grep -q "wolfHSM CommInit ok" /tmp/m33mu-wolfhsm-first.log
-          grep -q "wolfHSM RNG ok:" /tmp/m33mu-wolfhsm-first.log
-          grep -q "wolfHSM SHA256 ok" /tmp/m33mu-wolfhsm-first.log
-          grep -q "wolfHSM AES ok" /tmp/m33mu-wolfhsm-first.log
-          grep -q "wolfHSM first boot path, committing key to NVM" /tmp/m33mu-wolfhsm-first.log
-          grep -q "wolfHSM NSC tests passed" /tmp/m33mu-wolfhsm-first.log
-          grep -q "\\[BKPT\\] imm=0x7d" /tmp/m33mu-wolfhsm-first.log
-          grep -q "\\[EXPECT BKPT\\] Success" /tmp/m33mu-wolfhsm-first.log
-
-      - name: Run wolfHSM second boot (stm32h5)
-        run: |
-          cd /tmp/m33mu-wolfhsm-persist
-          m33mu "$GITHUB_WORKSPACE/wolfboot.bin" \
-            "$GITHUB_WORKSPACE/test-app/image_v1_signed.bin:0x60000" \
-            --persist --uart-stdout --timeout 120 --expect-bkpt 0x7f \
-            | tee /tmp/m33mu-wolfhsm-second.log
-
-      - name: Verify wolfHSM second boot (stm32h5)
-        run: |
-          grep -q "wolfHSM second boot path, restored persisted key" /tmp/m33mu-wolfhsm-second.log
-          grep -q "wolfHSM NSC tests passed" /tmp/m33mu-wolfhsm-second.log
-          grep -q "\\[BKPT\\] imm=0x7f" /tmp/m33mu-wolfhsm-second.log
-          grep -q "\\[EXPECT BKPT\\] Success" /tmp/m33mu-wolfhsm-second.log
+            --persist --uart-stdout --timeout 600 --expect-bkpt 0x7d \
+            --quit-on-faults \
+            | tee /tmp/m33mu-wolfhsm.log
+
+      - name: Verify wolfHSM whTest_ClientConfig (stm32h5)
+        run: |
+          # Final success marker - the test itself reports PASSED.
+          grep -q "wolfHSM whTest_ClientConfig PASSED" /tmp/m33mu-wolfhsm.log
+          # Spot-check that the major test phases each landed.
+          grep -q "RNG DEVID=0x5748534D SUCCESS"       /tmp/m33mu-wolfhsm.log
+          grep -q "AES GCM DEVID=0x5748534D SUCCESS"   /tmp/m33mu-wolfhsm.log
+          grep -q "RSA SUCCESS"                        /tmp/m33mu-wolfhsm.log
+          grep -q "ECC ephemeral ECDH SUCCESS"         /tmp/m33mu-wolfhsm.log
+          grep -q "SHA256 DEVID=0x5748534D SUCCESS"    /tmp/m33mu-wolfhsm.log
+          grep -q "HKDF SUCCESS"                       /tmp/m33mu-wolfhsm.log
+          # App reached the success BKPT and m33mu trapped on it.
+          grep -q "\\[BKPT\\] imm=0x7d"                /tmp/m33mu-wolfhsm.log
+          grep -q "\\[EXPECT BKPT\\] Success"          /tmp/m33mu-wolfhsm.log
 
       - name: Clean and build test with DICE attestation + OTP (stm32h5)
         run: |

include/user_settings.h

@@ -516,6 +516,10 @@ extern int tolower(int c);
         defined(WOLFBOOT_SIGN_ML_DSA)) && \
         !defined(WOLFBOOT_ENABLE_WOLFHSM_SERVER)
         #define WC_NO_RNG
+        /* wolfssl rejects WC_NO_RNG with the default blinding macros.
+         * wolfBoot is verify-only, no blinding is meaningful with a
+         * disabled RNG. */
+        #define WC_BLINDING_NO_RNG_ACKNOWLEDGE_WEAKNESS
     #endif
     #define WC_NO_HASHDRBG
     #define NO_AES_CBC
@@ -569,6 +573,9 @@ extern int tolower(int c);
        defined(WOLFBOOT_SIGN_ML_DSA)) &&          \
       !defined(WOLFBOOT_ENABLE_WOLFHSM_SERVER)
 #   define WC_NO_RNG
+    /* wolfssl rejects WC_NO_RNG with the default blinding macros. wolfBoot
+     * is verify-only, no blinding is meaningful with a disabled RNG. */
+#   define WC_BLINDING_NO_RNG_ACKNOWLEDGE_WEAKNESS
 #   endif
 #   define WC_NO_HASHDRBG
 #   define NO_DEV_RANDOM
@@ -774,8 +781,53 @@ extern int tolower(int c);
 #   undef  HAVE_ANONYMOUS_INLINE_AGGREGATES
 #   define HAVE_ANONYMOUS_INLINE_AGGREGATES 1
 #   define WOLFSSL_KEY_GEN
-#endif /* WOLFBOOT_ENABLE_WOLFHSM_CLIENT || WOLFBOOT_ENABLE_WOLFHSM_SERVER ||
-          WOLFCRYPT_TZ_WOLFHSM */
+#endif
+
+/* Crypto algorithms exercised by the wolfHSM client test suite over
+ * the NSC bridge. These are SECURE-SIDE only - the wolfHSM server
+ * needs AES/HKDF/SHA384/512 to handle the test requests. Gated out
+ * of the wolfHSM client build (which has NO_AES) and out of host
+ * unit tests (UNIT_TEST), neither of which want AES dragged in. */
+#if (defined(WOLFBOOT_ENABLE_WOLFHSM_SERVER) || \
+     defined(WOLFCRYPT_TZ_WOLFHSM)) && !defined(UNIT_TEST)
+    /* Earlier guards in this file set NO_AES and NO_HMAC for the
+     * verify-only bootloader path. The wolfHSM server needs both AES
+     * and HMAC (HKDF builds on HMAC), so drop them here. */
+#   undef NO_AES
+#   undef NO_HMAC
+#   ifndef WOLFSSL_AES_DIRECT
+#       define WOLFSSL_AES_DIRECT
+#   endif
+#   ifndef HAVE_HKDF
+#       define HAVE_HKDF
+#   endif
+#   ifndef WOLFSSL_AES_COUNTER
+#       define WOLFSSL_AES_COUNTER
+#   endif
+#   ifndef HAVE_AESCTR
+#       define HAVE_AESCTR
+#   endif
+#   ifndef WOLFSSL_AES_GCM
+#       define WOLFSSL_AES_GCM
+#   endif
+#   ifndef HAVE_AESGCM
+#       define HAVE_AESGCM
+#   endif
+#   ifndef GCM_TABLE_4BIT
+#       define GCM_TABLE_4BIT
+#   endif
+    /* Match NS-side WC_MAX_DIGEST_SIZE. NS test-app/wcs/user_settings.h
+     * enables WOLFSSL_SHA3 which sets WC_MAX_DIGEST_SIZE = 64. Without
+     * SHA384/SHA512 on the secure side, WC_MAX_DIGEST_SIZE caps at
+     * SHA256's 32 and wc_ecc_sign_hash (ecc.c:7281) rejects legitimately
+     * oversized hashes (e.g. ECDSA truncation tests) with BAD_LENGTH_E. */
+#   ifndef WOLFSSL_SHA384
+#       define WOLFSSL_SHA384
+#   endif
+#   ifndef WOLFSSL_SHA512
+#       define WOLFSSL_SHA512
+#   endif
+#endif /* WOLFBOOT_ENABLE_WOLFHSM_SERVER || WOLFCRYPT_TZ_WOLFHSM, !UNIT_TEST */
 
 #if defined(WOLFBOOT_ENABLE_WOLFHSM_SERVER) && \
     defined(WOLFBOOT_CERT_CHAIN_VERIFY)

lib/wolfHSM

@@ -1456,7 +1456,16 @@ ifeq ($(WOLFHSM_SERVER),1)
   WOLFCRYPT_OBJS += \
     $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/cryptocb.o \
     $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/coding.o \
-    $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/random.o
+    $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/random.o \
+    $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/hmac.o \
+    $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/aes.o \
+    $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/wc_encrypt.o
+  # SHA-384/512 are used by the wolfHSM crypto handlers (HKDF, larger
+  # ECDSA hash sizes, etc.). Always link sha512.o except when ED25519
+  # is the signature algorithm, which already pulls it in.
+  ifneq ($(SIGN),ED25519)
+    WOLFCRYPT_OBJS += $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/sha512.o
+  endif
 
   ifeq ($(SIGN),ML_DSA)
     WOLFCRYPT_OBJS += $(MATH_OBJS)

lib/wolfssl

@@ -0,0 +1,118 @@
+# Makefile - top-level wrapper for the wolfHSM TrustZone demo on STM32H5
+#
+# Copyright (C) 2026 wolfSSL Inc.
+#
+# This file is part of wolfBoot.
+#
+# wolfBoot is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# wolfBoot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# This Makefile is a convenience wrapper around the top-level wolfBoot
+# build. It stages the stm32h5-tz-wolfhsm config, builds the secure
+# wolfBoot image (with the wolfHSM server linked in) and the non-secure
+# test application (which connects to the server via the ARMv8-M NSC
+# bridge and runs whTest_ClientConfig), and stages both binaries here
+# for flashing.
+#
+# Quick start:
+#   make                  # build wolfboot.bin + test app, stage in ./out/
+#   ./load.sh             # flash to a NUCLEO-H563ZI and open a serial console
+#   make emu              # run the m33mu emulator over the built binaries
+#   make clean            # drop staged artifacts (keeps the wolfBoot tree)
+#   make distclean        # also wipe wolfBoot build state
+
+PORT_DIR        := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+WOLFBOOT_ROOT   := $(abspath $(PORT_DIR)/../../..)
+CONFIG_EXAMPLE  := $(WOLFBOOT_ROOT)/config/examples/stm32h5-tz-wolfhsm.config
+CONFIG_TARGET   := $(WOLFBOOT_ROOT)/.config
+OUT_DIR         := $(PORT_DIR)/out
+
+# Default to the lib/wolfHSM submodule (matches wolfBoot's own
+# Makefile). Override with `make WOLFBOOT_LIB_WOLFHSM=...` to point
+# at a different wolfHSM checkout.
+WOLFBOOT_LIB_WOLFHSM ?= $(WOLFBOOT_ROOT)/lib/wolfHSM
+
+WOLFBOOT_BIN    := $(WOLFBOOT_ROOT)/wolfboot.bin
+TEST_APP_BIN    := $(WOLFBOOT_ROOT)/test-app/image_v1_signed.bin
+
+# Address the test app must be flashed to. Read from the staged .config
+# so it stays in sync with what wolfBoot itself was built against.
+BOOT_ADDR       := 0x08060000
+
+# Forward extra options to the wolfBoot top-level make. Example:
+#   make WOLFBOOT_MAKE_FLAGS='V=1'
+WOLFBOOT_MAKE_FLAGS ?=
+
+.PHONY: all build stage clean distclean emu flash help
+
+all: build stage
+
+# Stage the config and run the wolfBoot top-level build. wolfBoot itself
+# emits wolfboot.bin (secure image) and test-app/image_v1_signed.bin
+# (the non-secure test application). With WOLFCRYPT_TZ_WOLFHSM=1 in the
+# staged config, the non-secure app calls cmd_wolfhsm_test(), which
+# initialises the wolfHSM client over the NSC bridge and runs the
+# wolfHSM client test suite against the in-secure-world server.
+#
+# We `cd` into WOLFBOOT_ROOT rather than using `$(MAKE) -C ...` because
+# the wolfBoot sign step shells out with `./tools/keytools/sign`, which
+# resolves against the original process cwd. From a sub-directory the
+# relative path fails; cd-ing keeps the resolution correct.
+build: stage-config
+	@echo "==> wolfBoot build (stm32h5-tz-wolfhsm)"
+	@echo "==> WOLFBOOT_LIB_WOLFHSM=$(WOLFBOOT_LIB_WOLFHSM)"
+	cd $(WOLFBOOT_ROOT) && $(MAKE) wolfboot.bin WOLFBOOT_LIB_WOLFHSM=$(WOLFBOOT_LIB_WOLFHSM) $(WOLFBOOT_MAKE_FLAGS)
+	cd $(WOLFBOOT_ROOT) && $(MAKE) test-app/image_v1_signed.bin WOLFBOOT_LIB_WOLFHSM=$(WOLFBOOT_LIB_WOLFHSM) $(WOLFBOOT_MAKE_FLAGS)
+
+# Force-overwrite .config every build so a stale config from a
+# previous CI step (PKCS11, fwTPM, DICE) cannot bleed through.
+.PHONY: stage-config
+stage-config:
+	@echo "==> Staging config: $(CONFIG_EXAMPLE) -> $(CONFIG_TARGET)"
+	cp $(CONFIG_EXAMPLE) $(CONFIG_TARGET)
+
+# Copy the produced binaries into ./out so this directory is the single
+# place the user has to look. Also drop the boot address into a small
+# manifest so load.sh and CI scripts do not have to re-parse .config.
+stage: build
+	@mkdir -p $(OUT_DIR)
+	cp $(WOLFBOOT_BIN) $(OUT_DIR)/wolfboot.bin
+	cp $(TEST_APP_BIN) $(OUT_DIR)/image_v1_signed.bin
+	@echo "BOOT_ADDR=$(BOOT_ADDR)" > $(OUT_DIR)/manifest.env
+	@echo "WOLFBOOT_BIN=$(OUT_DIR)/wolfboot.bin" >> $(OUT_DIR)/manifest.env
+	@echo "TEST_APP_BIN=$(OUT_DIR)/image_v1_signed.bin" >> $(OUT_DIR)/manifest.env
+	@echo "==> Staged in $(OUT_DIR):"
+	@ls -l $(OUT_DIR)
+
+# Convenience: invoke load.sh from anywhere.
+flash: stage
+	$(PORT_DIR)/load.sh
+
+# Run the wolfBoot m33mu emulator harness over the produced binaries.
+# This uses wolfBoot's own emulator script so the test path is identical
+# to what runs in CI.
+emu: stage
+	cd $(WOLFBOOT_ROOT)/test-app/emu-test-apps && \
+	    TARGET=stm32h5 ./test.sh
+
+clean:
+	rm -rf $(OUT_DIR)
+
+distclean: clean
+	cd $(WOLFBOOT_ROOT) && $(MAKE) clean distclean
+	rm -f $(CONFIG_TARGET)
+
+help:
+	@echo "Targets:"
+	@echo "  make            Build wolfboot.bin + signed test app, stage in ./out"
+	@echo "  make flash      Build (if needed) and flash via load.sh"
+	@echo "  make emu        Build (if needed) and run wolfBoot m33mu harness"
+	@echo "  make clean      Drop ./out"
+	@echo "  make distclean  Also clean the wolfBoot tree and drop .config"