wolfBoot/docs
Aidan Garske b8254ba33f Document the STM32H5 fwTPM secure RAM budget and stack reservation 2026-09-17 13:06:11 +02:00
..
png
API.md Fix additional findings 2026-07-02 17:53:12 +02:00
CMake.md Minor docs update, code review changes, script modifications. 2025-11-24 13:04:06 -08:00
DICE.md Add wolfCOSE DICE attestation 2026-08-06 09:44:52 +02:00
FIPS.md Peer review fixes (thanks Jack) 2026-08-24 12:47:34 +02:00
HAL.md Peer review fixes. Added new WOLFBOOT_RESTORE_CLOCK option 2025-11-19 11:11:28 +01:00
Loader.md
MCXN947-DICE.md Add hardware-based DICE on mcxn 2026-05-21 20:49:20 +02:00
PQ.md Continue the ML-DSA renaming 2026-05-19 11:21:20 -07:00
README.md cm4: add wolfCrypt FIPS 140-3 support + CI, SDHCI unit test, review fixes 2026-08-24 12:47:34 +02:00
Renesas.md watchdog: add generic feed hook and RX driver 2026-07-30 15:32:31 +02:00
SBOM.md sbom: generate the keystore before checking the source list 2026-08-20 15:22:16 +02:00
STM32-TZ.md Add WOLFCRYPT_TZ_WOLFHSM TrustZone engine for STM32H5 2026-06-24 15:49:43 -07:00
Signing.md fdt: rewrite device tree parser with capacity bound and full validation 2026-09-02 10:48:52 +02:00
TPM.md Add support for auxillary algorithms and cert chain/TPM usage 2026-07-22 11:47:16 +02:00
Targets.md Add LS1028A eSDHC SD card disk boot support 2026-09-17 12:33:19 +02:00
Windows.md CMake Improvements 2025-11-18 17:44:43 -08:00
ata_security.md
azure_keyvault.md
compile.md update_disk: load signed image from a file when a filesystem is present 2026-09-02 10:47:33 +02:00
encrypted_partitions.md Support for CUSTOM_ENCRYPT_KEY that allows customer to supply their own implementation 2026-01-01 12:52:09 +01:00
firmware_image.md Add self-header feature with support for sim and AURIX TC3xx 2026-02-27 11:39:51 +01:00
firmware_update.md Add additional test coverage for monolithic self updates with asymmetric partition sizing 2026-08-19 17:47:48 +02:00
flash-OTP.md Fixes for STM32H5 TrustZone and PKCS11 store 2025-10-10 19:42:20 +02:00
flash_partitions.md add asymmetric partition sizing for monolithic updates 2026-08-19 17:47:48 +02:00
fwTPM.md Document the STM32H5 fwTPM secure RAM budget and stack reservation 2026-09-17 13:06:11 +02:00
hooks.md address review feedback 2026-03-05 10:14:04 +01:00
keystore.md Improve docs for USER_XXX variables to clarify intent 2025-12-10 07:43:32 +01:00
lib.md static library docs 2026-09-01 09:19:36 -06:00
measured_boot.md Improve measured boot support 2026-03-17 22:19:32 +01:00
remote_flash.md
wolfHAL.md remove wolfhal TARGET. Add WOLFHAL option 2026-06-10 17:12:25 +02:00
wolfHSM.md add documentation for exposed wolfHSM config values, plus some small doc fixes 2026-08-07 11:20:03 -06:00

README.md

wolfBoot Docs and Platform-Specific Details

See also: wolfBoot Product Overview and wolfBoot Manual.

  • API.md - Overview of wolfBoot public APIs and how to use them.
  • ata_security.md - ATA security features (lock/unlock, passwords) and wolfBoot integration.
  • azure_keyvault.md - Using Azure Key Vault for key management and signing with wolfBoot.
  • CMake.md - CMake-based build setup, presets, toolchains, and tips for building wolfBoot.
  • compile.md - How to build/compile wolfBoot (toolchains, options, typical steps).
  • encrypted_partitions.md - Creating and managing encrypted firmware/data partitions.
  • firmware_image.md - wolfBoot firmware image format, layout, and metadata.
  • firmware_update.md - Update flow: slots, verification, rollback, and recovery.
  • FIPS.md - Building wolfBoot with the wolfCrypt FIPS 140-3 module: approved algorithms, DRBG entropy, and in-core integrity sealing.
  • flash-OTP.md - Using One-Time Programmable (OTP) regions in flash for secure data.
  • flash_partitions.md - Flash partitioning schemes and configuration guidance.
  • HAL.md - Hardware Abstraction Layer notes and porting considerations.
  • hooks.md - User-defined hooks for injecting custom logic into the wolfBoot boot process.
  • keystore.md - Keystore design, key storage, and access strategies.
  • lib.md - Using wolfBoot as a library and linking/integration guidance.
  • Loader.md - Loader/secondary stage behavior and handoff to application.
  • measured_boot.md - Measured boot concepts and recording measurements (e.g., PCRs).
  • png/ - Folder of images/diagrams referenced by the documentation.
  • PQ.md - Post-quantum algorithms and PQC support in wolfBoot.
  • README.md - Overview and index of the documentation set.
  • remote_flash.md - Working with external/remote flash (SPI/QSPI, mapping, access).
  • Renesas.md - Notes and specifics for Renesas platforms/ports.
  • Signing.md - Keys, signatures, and the image signing workflow.
  • STM32-TZ.md - STM32 TrustZone (Armv8-M) setup and usage with wolfBoot.
  • STM32.md - STM32 platform notes, options, and integration tips.
  • Targets.md - Supported targets and platform-specific configuration.
  • TPM.md - TPM integration, measured boot, and attestation flows.
  • wolfHSM.md - Integrating wolfHSM with wolfBoot for secure key operations.