wolfBoot/docs
Thomas Cook 3b1ef9d6bc Address copilot pr comments. 2026-03-18 11:53:26 +01:00
..
png
API.md
CMake.md Minor docs update, code review changes, script modifications. 2025-11-24 13:04:06 -08:00
DICE.md Add support for DICE attestation + PSA attestation 2026-02-06 18:36:47 +01:00
HAL.md
Loader.md
PQ.md Improve docs, add targets and tests per https://github.com/wolfSSL/wolfBoot/pull/598#pullrequestreview-3492319645 2025-11-21 17:54:14 -08:00
README.md Add generic hook framework with provision for pre-init, post-init, and 2026-03-05 10:14:04 +01:00
Renesas.md
STM32-TZ.md Add support for DICE attestation + PSA attestation 2026-02-06 18:36:47 +01:00
Signing.md Add self-header feature with support for sim and AURIX TC3xx 2026-02-27 11:39:51 +01:00
TPM.md Improve measured boot support 2026-03-17 22:19:32 +01:00
Targets.md Address copilot pr comments. 2026-03-18 11:53:26 +01:00
Windows.md
ata_security.md
azure_keyvault.md
compile.md zephyr integration as TEE. 2026-01-07 08:27:58 +01: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 fix typo in readme 2026-03-06 17:05:45 +01:00
flash-OTP.md
flash_partitions.md Add self-header feature with support for sim and AURIX TC3xx 2026-02-27 11:39:51 +01: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 Fix typos 2026-03-05 10:16:09 +01:00
measured_boot.md Improve measured boot support 2026-03-17 22:19:32 +01:00
remote_flash.md
wolfHSM.md

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.
  • 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.