wolfBoot/docs
Sameeh Jubran 6d141bdafd sbom: pin the vendored wolfGlass copy to a revision that resolves
tools/sbom/.wolfglass-rev named 1bfcf4f1a293ba09f0ff6d67904dca09ee8eb6d7,
which exists in no repository. The vendored content is wolfGlass
d34a906638444b6990218a49927bcebafc5a539b: tools/wolfglass-sync --check
against that revision reports every file identical and only the pin
itself as drift.

A bare SHA with nothing checking it is also how a 1803-line vendored
generator drifts from the copy wolfSSL controls, or carries a local
patch, without anything noticing. Add a job that checks wolfGlass out at
the pinned revision and runs its own tools/wolfglass-sync --check, which
compares every vendored file against share/ and the pin against HEAD. An
unresolvable revision now fails that job rather than sitting in the tree.

A fork PR has no token to read wolfGlass with, so the job reports a
notice and passes there; the run on wolfSSL/wolfBoot is the gate.

Signed-off-by: Sameeh Jubran <sameeh@wolfssl.com>
2026-08-20 15:22:16 +02:00
..
png
API.md Fix additional findings 2026-07-02 17:53:12 +02:00
CMake.md
DICE.md Add wolfCOSE DICE attestation 2026-08-06 09:44:52 +02:00
HAL.md
Loader.md
MCXN947-DICE.md Add hardware-based DICE on mcxn 2026-05-21 20:49:20 +02:00
PQ.md
README.md
Renesas.md watchdog: add generic feed hook and RX driver 2026-07-30 15:32:31 +02:00
SBOM.md sbom: pin the vendored wolfGlass copy to a revision that resolves 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 Authenticate raw device tree via signed HDR_DEVICE_TREE_DIGEST TLV (Fenrir #7998) 2026-08-13 08:39:22 +02:00
TPM.md Add support for auxillary algorithms and cert chain/TPM usage 2026-07-22 11:47:16 +02:00
Targets.md Merge pull request #862 from danielinux/fenrir-fixes-2026-08-18 2026-08-18 12:12:50 -07:00
Windows.md
ata_security.md
azure_keyvault.md
compile.md add asymmetric partition sizing for monolithic updates 2026-08-19 17:47:48 +02:00
encrypted_partitions.md
firmware_image.md
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
flash_partitions.md add asymmetric partition sizing for monolithic updates 2026-08-19 17:47:48 +02:00
fwTPM.md
hooks.md
keystore.md
lib.md add asymmetric partition sizing for monolithic updates 2026-08-19 17:47:48 +02:00
measured_boot.md
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.
  • 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.