fit: dm-verity support
v3 cover fit: dm-verity support
This series adds dm-verity support to U-Boot's FIT image infrastructure. It is the first logical subset of the larger OpenWrt boot method series posted as an RFC in February 2026 [1], extracted here for independent review and merging.
OpenWrt's firmware model embeds a read-only squashfs or erofs root filesystem directly inside a uImage.FIT container as a FILESYSTEM-type loadable FIT image. At boot the kernel maps this sub-image directly from the underlying block device via the fitblk driver (/dev/fit0, /dev/fit1, ...), the goal is that the bootloader never even copies it to RAM.
dm-verity enables the kernel to verify the integrity of those mapped filesystems at read time, with a Merkle hash tree stored contiguously in the same sub-image just after the data. Two kernel command-line parameters are required:
dm-mod.create= -- the device-mapper target table for the verity device
dm-mod.waitfor= -- a comma-separated list of block devices to wait for
before dm-init sets up the targets (needed when fitblk probes late, e.g. because it depends on NVMEM calibration data)
The FIT dm-verity node schema was upstreamed into the flat-image-tree specification [2], which this implementation tries to follow exactly.
The runtime feature is guarded behind CONFIG_FIT_VERITY. If not enabled the resulting binary size remains unchanged. If enabled the binary size increases by about 3kB.
[1] previous submissions:
RFC: https://www.mail-archive.com/[email protected]/msg565945.html v1: https://www.mail-archive.com/[email protected]/msg569472.html v2: https://www.mail-archive.com/[email protected]/msg570599.html [2] flat-image-tree dm-verity node spec: https://github.com/open-source-firmware/flat-image-tree/commit/795fd5fd7f0121d0cb03efb1900aafc61c704771
v3: address comments by Heinrich Schuchardt and Simon Glass
* use unsigned int instead of int for data-block-size and hash-block-size
* replace printf() with log_err() for the "broken dm-verity metadata" diagnostic
* use FIT_VERITY_*_PROP, FIT_TYPE_PROP and FIT_LOADABLE_PROP constants in the unit test instead of literal strings
* extend the mkimage block-count overflow check to also cover hash_start_block (matters when hash-block-size < data-block-size)
* doc: clarify that hash-start-block only equals num-data-blocks when data-block-size == hash-block-size
* pytest: drop unused 'struct' import and the home-rolled have_veritysetup() helper in favour of @pytest.mark.requiredtool('veritysetup')
v2: address comments by Simon Glass
* use is_power_of_2() for pre-boot sanity check
* let fit_verity_build_cmdline() return 0 on success
* add comment explaining why bootm_start() calls fit_verity_free()
* use existing hex2bin() (and adapt it to be usable for host-tools)
* fix stale comment still including superblock despite veritysetup being called with --no-superblock
* add power-of-two check for data-block-size and hash-block-size to mkimage
* don't ignore return value of fdt_delprop()
* various documentation fixes, minimal example
* add pytest for mkimage part
* add run-time unit test for cmdline generation part
Daniel Golle (7):
image: fit: add dm-verity property name constants
boot: fit: support generating DM verity cmdline parameters
include: hexdump: make hex2bin() usable from host tools
tools: mkimage: add dm-verity Merkle-tree generation
doc: fit: add dm-verity boot parameter documentation
test: boot: add runtime unit test for fit_verity_build_cmdline()
test: py: add mkimage dm-verity round-trip test
boot/Kconfig | 20 ++ boot/bootm.c | 13 ++ boot/image-board.c | 5 + boot/image-fit.c | 337 +++++++++++++++++++++++++++++ doc/usage/fit/dm-verity.rst | 284 +++++++++++++++++++++++++ doc/usage/fit/index.rst | 1 + include/hexdump.h | 8 +- include/image.h | 97 ++++++++- test/boot/Makefile | 1 + test/boot/fit_verity.c | 306 +++++++++++++++++++++++++++ test/cmd_ut.c | 2 + test/py/tests/test_fit_verity.py | 145 +++++++++++++ tools/fit_image.c | 116 +++++++++- tools/image-host.c | 350 ++++++++++++++++++++++++++++++- 14 files changed, 1672 insertions(+), 13 deletions(-) create mode 100644 doc/usage/fit/dm-verity.rst create mode 100644 test/boot/fit_verity.c create mode 100644 test/py/tests/test_fit_verity.py
Signature · 1 line
2.54.0
PATCH v3 1/7 image: fit: add dm-verity property name constants
Add FIT_VERITY_NODENAME and the complete set of FIT_VERITY_*_PROP constants for the dm-verity child node of filesystem-type images, plus the five optional boolean error-handling property names aligned with the flat-image-tree specification.
---
v3: no changes
v2: no changes
include/image.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
include/image.h +17 -0
@@ -1079,6 +1079,23 @@ int booti_setup(ulong image, ulong *relocated_addr, ulong *size,#define FIT_CIPHER_NODENAME "cipher"#define FIT_ALGO_PROP "algo" +/* dm-verity node */ +#define FIT_VERITY_NODENAME "dm-verity" +#define FIT_VERITY_ALGO_PROP "algo" +#define FIT_VERITY_DBS_PROP "data-block-size" +#define FIT_VERITY_HBS_PROP "hash-block-size" +#define FIT_VERITY_NBLK_PROP "num-data-blocks" +#define FIT_VERITY_HBLK_PROP "hash-start-block" +#define FIT_VERITY_DIGEST_PROP "digest" +#define FIT_VERITY_SALT_PROP "salt" + +/* dm-verity error-handling modes (optional boolean property names) */ +#define FIT_VERITY_OPT_RESTART "restart-on-corruption" +#define FIT_VERITY_OPT_PANIC "panic-on-corruption" +#define FIT_VERITY_OPT_RERR "restart-on-error" +#define FIT_VERITY_OPT_PERR "panic-on-error" +#define FIT_VERITY_OPT_ONCE "check-at-most-once" +/* image node */ #define FIT_DATA_PROP "data"#define FIT_DATA_POSITION_PROP "data-position"
Signature · 1 line
2.54.0
PATCH v3 2/7 boot: fit: support generating DM verity cmdline parameters
In reply to Daniel GolleAdd fit_verity_build_cmdline(): when a FILESYSTEM loadable carries a dm-verity subnode, construct the dm-mod.create= kernel cmdline parameter from the verity metadata (block-size, data-blocks, algo, root-hash, salt) and append it to bootargs.
Also add dm-mod.waitfor=/dev/fit0[,/dev/fitN] for each dm-verity device so the kernel waits for the underlying FIT block device to appear before setting up device-mapper targets. This is needed when the block driver probes late, e.g. because it depends on NVMEM calibration data.
The dm-verity target references /dev/fitN where N is the loadable's index in the configuration -- matching the order Linux's FIT block driver assigns block devices. hash-start-block is read directly from the FIT dm-verity node; mkimage ensures its value equals num-data-blocks by invoking veritysetup with --no-superblock.
---
v3:
* use unsigned int for data_block_size and hash_block_size
* replace printf() with log_err() for the "broken dm-verity metadata"
v2:
* use is_power_of_2() for pre-boot sanity check
* let fit_verity_build_cmdline() return 0 on success
* add comment explaining why bootm_start() calls fit_verity_free()
boot/Kconfig | 20 +++ boot/bootm.c | 13 ++ boot/image-board.c | 5 + boot/image-fit.c | 337 +++++++++++++++++++++++++++++++++++++++++++++ include/image.h | 80 ++++++++++- 5 files changed, 454 insertions(+), 1 deletion(-)
boot/Kconfig +20 -0
@@ -142,6 +142,26 @@ config FIT_CIPHER Enable the feature of data ciphering/unciphering in the tool mkimage and in the u-boot support of the FIT image. +config FIT_VERITY + bool "dm-verity boot parameter generation from FIT metadata" + depends on FIT && OF_LIBFDT + help + When a FIT configuration contains loadable sub-images of type + IH_TYPE_FILESYSTEM with a dm-verity subnode, this option enables + building the dm-mod.create= and dm-mod.waitfor= kernel + command-line parameters from the verity metadata + (data-block-size, hash-block-size, num-data-blocks, + hash-start-block, algorithm, digest, salt) stored in the FIT. + + The generated parameters reference /dev/fitN block devices that + Linux's uImage.FIT block driver assigns to loadable sub-images. + + During FIT parsing (BOOTM_STATE_FINDOTHER), verity cmdline + fragments are stored in struct bootm_headers and automatically + appended to the bootargs environment variable during + BOOTM_STATE_OS_PREP. This works from both the bootm command + and BOOTSTD bootmeths. + config FIT_VERBOSE bool "Show verbose messages when FIT images fail" help
boot/bootm.c +13 -0
@@ -243,6 +243,13 @@ static int boot_get_kernel(const char *addr_fit, struct bootm_headers *images,static int bootm_start (void ) { +/* +* Free dm-verity allocations from a prior boot attempt before +* zeroing the structure. The pointers are guaranteed to be valid +* or NULL: .bss is zero-initialised, and memset() below zeroes +* them again after every boot. +*/ +fit_verity_free (&images);memset ((void *)&images,0 ,sizeof (images)); images.verify =env_get_yesno ("verify" );
@@ -1071,6 +1078,12 @@ int bootm_run_states(struct bootm_info *bmi, int states)/* For Linux OS do all substitutions at console processing */ if (images->os.os ==IH_OS_LINUX ) flags =BOOTM_CL_ALL ; + ret =fit_verity_apply_bootargs (images); +if (ret) { +printf ("dm-verity bootargs failed (err=%d)\n" , ret); + ret =CMD_RET_FAILURE ; + goto err; + } ret =bootm_process_cmdline_env (flags);if (ret) {printf ("Cmdline setup failed (err=%d)\n" , ret);
boot/image-board.c +5 -0
@@ -810,6 +810,11 @@ int boot_get_loadable(struct bootm_headers *images)fit_loadable_process (img_type, img_data, img_len); } + + fit_img_result =fit_verity_build_cmdline (buf, conf_noffset, + images); +if (fit_img_result <0 ) +return fit_img_result;break ;default :printf ("The given image format is not supported (corrupt?)\n" );
boot/image-fit.c +337 -0
360 lines not on this page · raw message
include/image.h +79 -1
92 lines not on this page · raw message
Signature · 1 line
2.54.0
PATCH v3 3/7 include: hexdump: make hex2bin() usable from host tools
In reply to Daniel GolleMake hexdump.h work in host-tool builds by using 'uint8_t' instead of 'u8', and including either user-space libc <ctype.h> for host-tools or <linux/ctype.h> when building U-Boot itself.
---
v3: no changes
v2: new patch
include/hexdump.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)
include/hexdump.h +6 -2
@@ -7,7 +7,11 @@#ifndef HEXDUMP_H #define HEXDUMP_H +#ifdef USE_HOSTCC +#include <ctype.h> +#else #include <linux/ctype.h> +#endif #include <linux/types.h> enum dump_prefix_t {
@@ -20,7 +24,7 @@ extern const char hex_asc[];#define hex_asc_lo (x) hex_asc[((x) & 0x0f)]#define hex_asc_hi (x) hex_asc[((x) & 0xf0) >> 4] -static inline char *hex_byte_pack (char *buf,u8 byte) +static inline char *hex_byte_pack (char *buf,uint8_t byte) { *buf++ =hex_asc_hi (byte); *buf++ =hex_asc_lo (byte);
@@ -52,7 +56,7 @@ static inline int hex_to_bin(char ch)* * Return 0 on success, -1 in case of bad input. */ -static inline int hex2bin (u8 *dst,const char *src,size_t count) +static inline int hex2bin (uint8_t *dst,const char *src,size_t count) {while (count--) {int hi =hex_to_bin (*src++);
Signature · 1 line
2.54.0
PATCH v3 4/7 tools: mkimage: add dm-verity Merkle-tree generation
In reply to Daniel GolleWhen mkimage encounters a dm-verity subnode inside a component image node it now automatically invokes veritysetup(8) with --no-superblock to generate the Merkle hash tree, screen-scrapes the Root hash and Salt from the tool output, and writes the computed properties back into the FIT blob.
The user only needs to specify algorithm, data-block-size, and hash-block-size in the ITS; mkimage fills in digest, salt, num-data-blocks, and hash-start-block. Because --no-superblock is used, hash-start-block equals num-data-blocks with no off-by-one.
The image data property is replaced with the expanded content (original data followed directly by the hash tree) so that subsequent hash and signature subnodes operate on the complete image.
fit_image_add_verification_data() is restructured into two passes:
dm-verity first (may grow data), then hashes and signatures.
---
v3: extend the block-count overflow check to also cover hash_start_block
(matters when hash-block-size < data-block-size)
v2:
* use existing hex2bin() instead of open-coding it
* fix stale comment still mentioning the verity superblock
* add power-of-two check for data-block-size and hash-block-size
* don't ignore return value of fdt_delprop()
tools/fit_image.c | 116 ++++++++++++++- tools/image-host.c | 350 ++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 456 insertions(+), 10 deletions(-)
tools/fit_image.c +110 -6
@@ -40,10 +40,10 @@ static int fit_estimate_hash_sig_size(struct image_tool_params *params, const chreturn -EIO ;/* -* Walk the FIT image, looking for nodes named hash* and -* signature*. Since the interesting nodes are subnodes of an -* image or configuration node, we are only interested in -* those at depth exactly 3. +* Walk the FIT image, looking for nodes named hash*, +* signature*, and dm-verity. Since the interesting nodes are +* subnodes of an image or configuration node, we are only +* interested in those at depth exactly 3. * * The estimate for a hash node is based on a sha512 digest * being 64 bytes, with another 64 bytes added to account for
@@ -55,6 +55,10 @@ static int fit_estimate_hash_sig_size(struct image_tool_params *params, const ch* account for fdt overhead and the various other properties * (hashed-nodes etc.) that will also be filled in. * +* For a dm-verity node the small metadata properties (digest, +* salt, two u32s and a temp-file path) are written into the +* FDT by fit_image_process_verity(). +* * One could try to be more precise in the estimates by * looking at the "algo" property and, in the case of * configuration signatures, the sign-images property. Also,
@@ -76,6 +80,18 @@ static int fit_estimate_hash_sig_size(struct image_tool_params *params, const chif (signing && !strncmp (name,FIT_SIG_NODENAME ,strlen (FIT_SIG_NODENAME ))) estimate +=1024 ; + +if (!strcmp (name,FIT_VERITY_NODENAME )) { +if (!params->external_data) { +fprintf (stderr, +"%s: dm-verity requires external data (-E)\n" , + params->cmdname); +munmap (fdt, sbuf.st_size); +close (fd); +return -EINVAL ; + } + estimate +=256 ; + } }munmap (fdt, sbuf.st_size);
@@ -470,6 +486,67 @@ static int fit_write_images(struct image_tool_params *params, char *fdt)return 0 ; } +/** +* fit_copy_image_data() - copy image data, using verity temp file if present +* @fdt: FIT blob +* @node: image node offset +* @buf: destination buffer +* @buf_ptr: write offset within @buf +* @data: embedded image data (used when no verity temp file exists) +* @lenp: in/out: on entry, length of @data; on exit, bytes written +* +* When fit_image_process_verity() has run, a temp-file path is stored in +* the dm-verity subnode. Read that file (original data + hash tree) into +* @buf instead of copying the embedded data property. +* +* Return: 0 on success, -EIO on error +*/ +static int fit_copy_image_data (void *fdt,int node,void *buf, +int buf_ptr,const void *data,int *lenp) +{ +const char *vfile; +char vfile_buf[256 ]; +struct stat vst; +int vfd, ret; +int vn; + + vn =fdt_subnode_offset (fdt, node,FIT_VERITY_NODENAME ); + vfile =NULL ; +if (vn >=0 ) + vfile =fdt_getprop (fdt, vn,"verity-data-file" ,NULL ); +if (!vfile) { +memcpy (buf + buf_ptr, data, *lenp); +return 0 ; + } + +/* Copy path -- FDT shifts after delprop */ +snprintf (vfile_buf,sizeof (vfile_buf),"%s" , vfile); + ret =fdt_delprop (fdt, vn,"verity-data-file" ); +if (ret) { +fprintf (stderr,"Can't remove verity-data-file property: %s\n" , +fdt_strerror (ret)); +return -EPERM ; + } + +if (stat (vfile_buf, &vst)) { +fprintf (stderr,"Can't stat verity data: %s\n" , +strerror (errno)); +return -EIO ; + } + vfd =open (vfile_buf,O_RDONLY ); +if (vfd <0 ||read (vfd, buf + buf_ptr, vst.st_size) != vst.st_size) { +fprintf (stderr,"Can't read verity data: %s\n" , +strerror (errno)); +if (vfd >=0 ) +close (vfd); +return -EIO ; + } +close (vfd); + *lenp = vst.st_size; +unlink (vfile_buf); +return 0 ; +} +/** * fit_write_configs() - Write out a list of configurations to the FIT *
@@ -653,6 +730,11 @@ static int fit_extract_data(struct image_tool_params *params, const char *fname)int node;int align_size =0 ;int len =0 ; +int verity_extra =0 ; +int orig_len; +int vn; +const char *vf; +struct stat vst; fd =mmap_fdt (params->cmdname, fname,0 , &fdt, &sbuf, false, false);if (fd <0 )
@@ -686,11 +768,30 @@ static int fit_extract_data(struct image_tool_params *params, const char *fname) align_size +=4 ; } +/* +* When dm-verity is active the external data for an image is +* larger than the embedded data property (original + hash tree). +* Walk images once more to account for the difference. +*/ +fdt_for_each_subnode (node, fdt, images) { + vn =fdt_subnode_offset (fdt, node,FIT_VERITY_NODENAME ); + orig_len =0 ; + +if (vn <0 ) +continue ; + vf =fdt_getprop (fdt, vn,"verity-data-file" ,NULL ); +if (!vf) +continue ; +fdt_getprop (fdt, node,FIT_DATA_PROP , &orig_len); +if (!stat (vf, &vst) && vst.st_size > orig_len) + verity_extra += vst.st_size - orig_len; + } +/* * Allocate space to hold the image data we will extract, * extral space allocate for image alignment to prevent overflow. */ - buf =calloc (1 , fit_size + align_size); + buf =calloc (1 , fit_size + align_size + verity_extra);if (!buf) { ret = -ENOMEM ; goto err_munmap;
@@ -721,7 +822,10 @@ static int fit_extract_data(struct image_tool_params *params, const char *fname) data =fdt_getprop (fdt, node,FIT_DATA_PROP , &len);if (!data)continue ; -memcpy (buf + buf_ptr, data, len); + + ret =fit_copy_image_data (fdt, node, buf, buf_ptr, data, &len); +if (ret) + goto err_munmap;debug ("Extracting data size %x\n" , len); ret =fdt_delprop (fdt, node,FIT_DATA_PROP );
tools/image-host.c +345 -4
397 lines not on this page · raw message
Signature · 1 line
2.54.0
PATCH v3 5/7 doc: fit: add dm-verity boot parameter documentation
In reply to Daniel GolleAdd documentation for CONFIG_FIT_VERITY which allows U-Boot to construct dm-mod.create= and dm-mod.waitfor= kernel command-line parameters from dm-verity metadata embedded in FIT filesystem sub-images.
The new document covers the relationship between FIT loadable indices and the /dev/fitN block devices that the Linux uImage.FIT block driver creates, provides a complete .its example with a dm-verity-protected SquashFS root filesystem, describes all required and optional dm-verity subnode properties and explains how mkimage generates the verity metadata automatically.
dm-verity is only supported for external-data FIT images (mkimage -E); mkimage aborts with an error if the flag is omitted.
---
v3: clarify that hash-start-block only equals num-data-blocks when
data-block-size == hash-block-size; in the general case it is data_size / hash-block-size
v2: trim minimal .its example to user-provided properties only and
remove stale references to a verity superblock
doc/usage/fit/dm-verity.rst | 284 ++++++++++++++++++++++++++++++++++++ doc/usage/fit/index.rst | 1 + 2 files changed, 285 insertions(+) create mode 100644 doc/usage/fit/dm-verity.rst
doc/usage/fit/dm-verity.rst new file +284 -0
@@ -0,0 +1,284 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +FIT dm-verity Boot Parameters +============================= + +Introduction +------------ + +Linux's dm-verity device-mapper target provides transparent integrity +checking of block devices using a Merkle tree. It is commonly used to +protect read-only root filesystems such as SquashFS images. + +When a FIT image packages the root filesystem as a loadable sub-image of +type ``filesystem`` (``IH_TYPE_FILESYSTEM``), the verity metadata can be +stored alongside the image data in a ``dm-verity`` subnode. U-Boot reads +this metadata at boot time and generates the kernel command-line parameters +that Linux needs to activate the verity target, eliminating the need for +an initramfs or userspace helper to set up dm-verity. + +This feature is enabled by ``CONFIG_FIT_VERITY`` (see ``boot/Kconfig``). + +Prerequisites +------------- + +* **Linux uImage.FIT block driver** – the kernel must include the FIT block + driver that exposes loadable sub-images as ``/dev/fit0``, ``/dev/fit1``, + etc. The driver assigns device numbers in the order loadables appear in + the FIT configuration. + +* **dm-verity support in the kernel** – ``CONFIG_DM_VERITY`` must be + enabled so the kernel can process the ``dm-mod.create=`` parameter. + +* **CONFIG_FIT_VERITY** enabled in U-Boot. + +How it works +------------ + +The implementation is split into a **build** phase and an **apply** phase, +both of which run automatically within the ``bootm`` state machine. No boot +method needs to call verity functions explicitly. + +**Build phase** (``BOOTM_STATE_FINDOTHER`` → ``boot_get_loadable()``) + +1. After all loadable sub-images have been loaded, + ``fit_verity_build_cmdline()`` iterates the configuration's + ``loadables`` list. + +2. For each loadable that is an ``IH_TYPE_FILESYSTEM`` image **and** + contains a ``dm-verity`` child node, a dm-verity target specification is + built by the helper ``fit_verity_build_target()``. + +3. The dm-verity target references ``/dev/fitN``, where *N* is the + zero-based index of the loadable in the configuration. This matches the + numbering used by the Linux FIT block driver. + +4. The resulting fragments are stored in ``struct bootm_headers``: + + ``images->dm_mod_create`` + The full dm-verity target table. Multiple targets are separated by ``;``. + + ``images->dm_mod_waitfor`` + Comma-separated list of ``/dev/fitN`` devices so the kernel waits for + the underlying FIT block devices to appear before activating + device-mapper. + +**Apply phase** (``BOOTM_STATE_OS_PREP``) + +5. Just before ``bootm_process_cmdline_env()`` processes the ``bootargs`` + environment variable, ``fit_verity_apply_bootargs()`` appends the + ``dm-mod.create=`` and ``dm-mod.waitfor=`` parameters. + +**Bootmeth integration** + + Because the fragments are stored in ``struct bootm_headers``, a boot + method can check ``fit_verity_active(images)`` between bootm state + invocations. A typical pattern splits ``bootm_run_states()`` into two + calls -- one for ``START|FINDOS|FINDOTHER|LOADOS`` and one for + ``OS_PREP|OS_GO`` -- and inspects ``fit_verity_active()`` in + between to decide whether to add a ``root=`` parameter pointing at the + dm-verity device. + +FIT image source (.its) example +------------------------------- + +Below is a minimal ``.its`` file showing a kernel and a dm-verity-protected +root filesystem packaged as a FIT. Only the three user-provided properties +(``algo``, ``data-block-size``, ``hash-block-size``) are included; ``mkimage`` +computes and fills in ``digest``, ``salt``, ``num-data-blocks``, and +``hash-start-block`` automatically (see `Generating verity metadata`_ below):: + + /dts-v1/; + + / { + description = "Kernel + dm-verity rootfs"; + #address-cells = <1>; + + images { + kernel { + description = "Linux kernel"; + data = /incbin/("./Image.gz"); + type = "kernel"; + arch = "arm64"; + os = "linux"; + compression = "gzip"; + load = <0x44000000>; + entry = <0x44000000>; + hash-1 { + algo = "sha256"; + }; + }; + + fdt { + description = "Device tree blob"; + data = /incbin/("./board.dtb"); + type = "flat_dt"; + arch = "arm64"; + compression = "none"; + hash-1 { + algo = "sha256"; + }; + }; + + rootfs { + description = "SquashFS root filesystem"; + data = /incbin/("./rootfs.squashfs"); + type = "filesystem"; + arch = "arm64"; + compression = "none"; + hash-1 { + algo = "sha256"; + }; + + dm-verity { + algo = "sha256"; + data-block-size = <4096>; + hash-block-size = <4096>; + }; + }; + }; + + configurations { + default = "config-1"; + config-1 { + description = "Boot with dm-verity rootfs"; + kernel = "kernel"; + fdt = "fdt"; + loadables = "rootfs"; + }; + }; + }; + +With this configuration U-Boot produces a kernel command line similar to:: + + dm-mod.create="rootfs,,, ro,0 <data_sectors> verity 1 \ + /dev/fit0 /dev/fit0 4096 4096 3762 3762 sha256 \ + 8e6791637f93cbb81fc45299e203cbe85ca2e47a38f5051bddeece92d7b1c9f9 \ + aa7b11f8db8fe2e5bfd4eca1d18a22b5de7ea39d2e1b93bb7272ce0c6ca3cc8e" \ + dm-mod.waitfor=/dev/fit0 + +dm-verity subnode properties +---------------------------- + +User-provided properties (required in the ``.its``): + +.. list-table:: + :header-rows: 1 + :widths: 20 15 65 + + * - Property + - Type + - Description + * - ``algo`` + - string + - Hash algorithm name, e.g. ``"sha256"``. + * - ``data-block-size`` + - u32 + - Data block size in bytes (>= 512, typically 4096). + * - ``hash-block-size`` + - u32 + - Hash block size in bytes (>= 512, typically 4096). + +Computed properties (filled in by ``mkimage``): + +.. list-table:: + :header-rows: 1 + :widths: 20 15 65 + + * - Property + - Type + - Description + * - ``num-data-blocks`` + - u32 + - Number of data blocks in the filesystem image (computed from the + image size and ``data-block-size``). + * - ``hash-start-block`` + - u32 + - Offset in ``hash-block-size``-sized blocks from the start of the + sub-image to the root block of the hash tree. + * - ``digest`` + - byte array + - Root hash of the Merkle tree, stored as raw bytes. Length must match + the output size of ``algo``. + * - ``salt`` + - byte array + - Salt used when computing the Merkle tree, stored as raw bytes. + +These values are the same ones produced by ``veritysetup format`` and can +typically be obtained from its output. +The ``digest`` and ``salt`` byte arrays correspond to the hex-encoded +``Root hash`` and ``Salt`` printed by ``veritysetup format``. + +Optional boolean properties (when present, they are collected and appended +as dm-verity optional parameters with hyphens converted to underscores): + +.. list-table:: + :header-rows: 1 + :widths: 30 70 + + * - Property + - Description + * - ``restart-on-corruption`` + - Restart the system on data corruption. + * - ``panic-on-corruption`` + - Panic the system on data corruption. + * - ``restart-on-error`` + - Restart the system on I/O error. + * - ``panic-on-error`` + - Panic the system on I/O error. + * - ``check-at-most-once`` + - Verify data blocks only on first read. + + +Generating verity metadata +-------------------------- + +``mkimage`` automates the entire process. When it encounters a +``dm-verity`` subnode, it: + +1. Writes the embedded image data to a temporary file. +2. Runs ``veritysetup format`` with the user-supplied algorithm and + block sizes. +3. Parses ``Root hash`` and ``Salt`` from ``veritysetup`` stdout. +4. Reads back the expanded file (original data + Merkle hash tree) and + replaces the image's ``data`` property. +5. Writes the computed ``digest``, ``salt``, ``num-data-blocks``, and + ``hash-start-block`` properties into the ``dm-verity`` subnode. + +Images with ``dm-verity`` subnodes **must** use external data layout +(``mkimage -E``). ``mkimage`` will abort with an error if ``-E`` is +not specified. + +Usage:: + + # Create the filesystem image + mksquashfs rootfs/ rootfs.squashfs -comp xz + + # Build the FIT (dm-verity is computed automatically) + mkimage -E -f image.its image.itb + +``veritysetup`` (from the cryptsetup_ package) must be installed on +the build host. + +.. _cryptsetup: https://gitlab.com/cryptsetup/cryptsetup + +.. note:: + + ``veritysetup format`` is invoked with ``--no-superblock``, so no + on-disk superblock is written between the data and hash regions. + The Merkle hash tree is appended directly to the image data within + the FIT external data section. ``hash-start-block`` is therefore + computed as ``data_size / hash-block-size`` (the offset of the hash + region in units of ``hash-block-size``). When ``data-block-size`` + equals ``hash-block-size`` this happens to equal ``num-data-blocks``. + +Kconfig +------- + +``CONFIG_FIT_VERITY`` + Depends on ``CONFIG_FIT`` and ``CONFIG_OF_LIBFDT``. + When enabled, ``fit_verity_build_cmdline()`` and + ``fit_verity_apply_bootargs()`` are compiled into the boot path. + When disabled, the functions are static inlines returning 0, so there + is no code-size impact. Works with both the ``bootm`` command and + BOOTSTD boot methods.
doc/usage/fit/index.rst +1 -0
@@ -11,6 +11,7 @@ images that it reads and boots. Documentation about FIT is available in :maxdepth: 1 beaglebone_vboot + dm-verity howto kernel_fdt kernel_fdts_compressed
Signature · 1 line
2.54.0
PATCH v3 6/7 test: boot: add runtime unit test for fit_verity_build_cmdline()
In reply to Daniel GolleAdd test/boot/fit_verity.c with four tests that construct FIT blobs in memory and exercise fit_verity_build_cmdline().
---
v3: replace literal property name strings with the FIT_VERITY_*_PROP
v2: new patch
test/boot/Makefile | 1 + test/boot/fit_verity.c | 306 +++++++++++++++++++++++++++++++++++++++++ test/cmd_ut.c | 2 + 3 files changed, 309 insertions(+) create mode 100644 test/boot/fit_verity.c
test/boot/Makefile +1 -0
@@ -15,6 +15,7 @@ endif ifdef CONFIG_SANDBOX obj-$(CONFIG_$(PHASE_)CMDLINE) += bootm.o endif +obj-$(CONFIG_$(PHASE_)FIT_VERITY) += fit_verity.o obj-$(CONFIG_MEASURED_BOOT) += measurement.o ifdef CONFIG_OF_LIVE
test/boot/fit_verity.c new file +306 -0
306 lines not on this page · raw message
test/cmd_ut.c +2 -0
@@ -59,6 +59,7 @@ SUITE_DECL(env);SUITE_DECL (exit);SUITE_DECL (fdt);SUITE_DECL (fdt_overlay); +SUITE_DECL (fit_verity);SUITE_DECL (font);SUITE_DECL (hush);SUITE_DECL (lib);
@@ -86,6 +87,7 @@ static struct suite suites[] = {SUITE (exit,"shell exit and variables" ),SUITE (fdt,"fdt command" ),SUITE (fdt_overlay,"device tree overlays" ), +SUITE (fit_verity,"FIT dm-verity cmdline generation" ),SUITE (font,"font command" ),SUITE (hush,"hush behaviour" ), SUITE(lib, "library functions"),
Signature · 1 line
2.54.0
Re: [PATCH v3 6/7] test: boot: add runtime unit test for fit_verity_build_cmdline()
Quoted 11 lines · Daniel Golle
test: boot: add runtime unit test for
fit_verity_build_cmdline()Add
test/boot/fit_verity.cwith four tests that construct FIT blobs in memory and exercisefit_verity_build_cmdline().Signed-off-by Daniel Golle <[email protected]>test/boot/Makefile | 1 +
test/boot/fit_verity.c | 306 +++++++++++++++++++++++++++++++++++++++++++++++++ test/cmd_ut.c | 2 + 3 files changed, 309 insertions(+)
PATCH v3 7/7 test: py: add mkimage dm-verity round-trip test
In reply to Daniel GolleAdd test/py/tests/test_fit_verity.py with two tests.
Both tests are skipped if veritysetup is not installed on the host.
---
v3: drop unused 'struct' import and the home-rolled have_veritysetup()
helper; use @pytest.mark.requiredtool('veritysetup') instead
v2: new patch
test/py/tests/test_fit_verity.py | 145 +++++++++++++++++++++++++++++++ 1 file changed, 145 insertions(+) create mode 100644 test/py/tests/test_fit_verity.py
test/py/tests/test_fit_verity.py new file +145 -0
@@ -0,0 +1,145 @@ +# SPDX-License-Identifier: GPL-2.0+ +# +# Copyright 2026 Daniel Golle <[email protected]> + +""" +Test mkimage dm-verity Merkle-tree generation + +Build a minimal .its with a dm-verity subnode (user-provided properties only), +run mkimage -E, and verify that the computed properties (digest, salt, +num-data-blocks, hash-start-block) are written into the resulting FIT. + +This test does not run the sandbox. It only exercises the host tool 'mkimage'. +Requires 'veritysetup' from the cryptsetup package on the build host. +""" + +import os +import pytest +import utils + +ITS_TEMPLATE = """\ +/dts-v1/; + +/ { + description = "dm-verity test"; + #address-cells = <1>; + + images { + rootfs { + description = "test filesystem"; + data = /incbin/("./rootfs.bin"); + type = "filesystem"; + arch = "sandbox"; + compression = "none"; + + dm-verity { + algo = "sha256"; + data-block-size = <4096>; + hash-block-size = <4096>; + }; + }; + }; + + configurations { + default = "conf-1"; + conf-1 { + description = "test config"; + loadables = "rootfs"; + }; + }; +}; +""" + [email protected]('dtc') [email protected]('fdtget') [email protected]('veritysetup') +def test_mkimage_verity(ubman): + """Test that mkimage computes dm-verity properties correctly.""" + + mkimage = ubman.config.build_dir + '/tools/mkimage' + tempdir = os.path.join(ubman.config.result_dir, 'verity') + os.makedirs(tempdir, exist_ok=True) + + rootfs_file = os.path.join(tempdir, 'rootfs.bin') + its_file = os.path.join(tempdir, 'image.its') + fit_file = os.path.join(tempdir, 'image.itb') + + # Create a dummy filesystem image: 64 x 4096-byte blocks of 0xa5 + block_size = 4096 + num_blocks = 64 + with open(rootfs_file, 'wb') as f: + f.write(bytes([0xa5]) * block_size * num_blocks) + + with open(its_file, 'w') as f: + f.write(ITS_TEMPLATE) + + # Build the FIT with external data (required for dm-verity) + dtc_args = f'-I dts -O dtb -i {tempdir}' + utils.run_and_log(ubman, + [mkimage, '-E', '-D', dtc_args, '-f', its_file, fit_file]) + + # Helper to read FIT properties via fdtget + def fdt_get(node, prop): + val = utils.run_and_log( + ubman, f'fdtget {fit_file} {node} {prop}') + return val.strip() + + def fdt_get_hex(node, prop): + """Read a byte-array property as hex string.""" + val = utils.run_and_log( + ubman, f'fdtget -tbx {fit_file} {node} {prop}') + return ''.join(b.zfill(2) for b in val.strip().split()) + + verity_path = '/images/rootfs/dm-verity' + + # Verify mkimage filled in the computed properties + algo = fdt_get(verity_path, 'algo') + assert algo == 'sha256', f'algo mismatch: {algo}' + + dbs = int(fdt_get(verity_path, 'data-block-size')) + assert dbs == block_size, f'data-block-size mismatch: {dbs}' + + hbs = int(fdt_get(verity_path, 'hash-block-size')) + assert hbs == block_size, f'hash-block-size mismatch: {hbs}' + + nblk = int(fdt_get(verity_path, 'num-data-blocks')) + assert nblk == num_blocks, f'num-data-blocks mismatch: {nblk} != {num_blocks}' + + hblk = int(fdt_get(verity_path, 'hash-start-block')) + # With --no-superblock, hash-start-block == num-data-blocks + assert hblk == num_blocks, f'hash-start-block mismatch: {hblk} != {num_blocks}' + + # digest and salt should be non-empty hex strings (sha256 = 32 bytes = 64 hex chars) + digest = fdt_get_hex(verity_path, 'digest') + assert len(digest) == 64, f'digest length mismatch: {len(digest)} (expected 64)' + # Should not be all zeros + assert digest != '0' * 64, 'digest is all zeros' + + salt = fdt_get_hex(verity_path, 'salt') + assert len(salt) == 64, f'salt length mismatch: {len(salt)} (expected 64)' + + [email protected]('dtc') [email protected]('veritysetup') +def test_mkimage_verity_requires_external(ubman): + """Test that mkimage rejects dm-verity without -E flag.""" + + mkimage = ubman.config.build_dir + '/tools/mkimage' + tempdir = os.path.join(ubman.config.result_dir, 'verity_no_ext') + os.makedirs(tempdir, exist_ok=True) + + rootfs_file = os.path.join(tempdir, 'rootfs.bin') + its_file = os.path.join(tempdir, 'image.its') + fit_file = os.path.join(tempdir, 'image.itb') + + with open(rootfs_file, 'wb') as f: + f.write(bytes([0xa5]) * 4096 * 8) + + with open(its_file, 'w') as f: + f.write(ITS_TEMPLATE) + + # Without -E, mkimage should fail for dm-verity images + dtc_args = f'-I dts -O dtb -i {tempdir}' + with pytest.raises(Exception): + utils.run_and_log(ubman, + [mkimage, '-D', dtc_args, '-f', its_file, fit_file])
Signature · 1 line
2.54.0
Re: [PATCH v3 7/7] test: py: add mkimage dm-verity round-trip test
Hi Daniel,
Quoted 10 lines · Daniel Golle
test: py: add mkimage dm-verity round-trip test
Add
test/py/tests/test_fit_verity.pywith two tests.Both tests are skipped if veritysetup is not installed on the host.
Signed-off-by Daniel Golle <[email protected]>
test/py/tests/test_fit_verity.py| 145 +++++++++++++++++++++++++++++++++++++++1 file changed, 145 insertions(+)
A few improvements below
test/py/tests/test_fit_verity.py line 5
Quoted 7 lines
test/py/tests/test_fit_verity.py +5
-0@@ -0,0 +1,145 @@ + # Without -E, mkimage should fail for dm-verity images + dtc_args = f'-I dts -O dtb -i {tempdir}' + with pytest.raises(Exception): + utils.run_and_log(ubman, + [mkimage, '-D', dtc_args, '-f', its_file, fit_file])
pytest.raises(Exception) is too broad - it will swallow any failure (FileNotFoundError, an mkimage segfault, etc.) and the test will appear to pass. Please use utils.run_and_log_expect_exception() with the specific retcode and a fragment of the expected diagnostic ('dm-verity requires external data') so we verify mkimage rejected the image for the right reason.
test/py/tests/test_fit_verity.py line 5
Quoted 7 lines
test/py/tests/test_fit_verity.py +5
-0@@ -0,0 +1,145 @@ + dm-verity { + algo = 'sha256'; + data-block-size = <4096>; + hash-block-size = <4096>; + };
Since v3 extends the block-count overflow check to cover hash-block-size < data-block-size, and patch 5 calls out that hash-start-block only equals num-data-blocks when the two sizes are equal, how about a second positive case with mismatched sizes (e.g. data 4096, hash 1024) so hash-start-block != num-data-blocks is actually exercised.
test/py/tests/test_fit_verity.py line 4
Quoted 6 lines
test/py/tests/test_fit_verity.py +4
-0@@ -0,0 +1,145 @@ + # Build the FIT with external data (required for dm-verity) + dtc_args = f'-I dts -O dtb -i {tempdir}' + utils.run_and_log(ubman, + [mkimage, '-E', '-D', dtc_args, '-f', its_file, fit_file])
The test confirms mkimage writes back the four computed properties, but never that the digest is correct for the data, so a regression that produced a stable but wrong digest would still pass. Can you run 'veritysetup verify' against the external data and assert the digests match?
Regards,
Simon
Quoted 22 lines · Daniel Golle
This series adds dm-verity support to U-Boot's FIT image infrastructure. It is the first logical subset of the larger OpenWrt boot method series posted as an RFC in February 2026 [1], extracted here for independent review and merging.
OpenWrt's firmware model embeds a read-only squashfs or erofs root filesystem directly inside a uImage.FIT container as a FILESYSTEM-type loadable FIT image. At boot the kernel maps this sub-image directly from the underlying block device via the fitblk driver (
/dev/fit0,/dev/fit1, ...), the goal is that the bootloader never even copies it to RAM.dm-verity enables the kernel to verify the integrity of those mapped filesystems at read time, with a Merkle hash tree stored contiguously in the same sub-image just after the data. Two kernel command-line parameters are required:
dm-mod.create= -- the device-mapper target table for the verity device
dm-mod.waitfor= -- a comma-separated list of block devices to wait for
before dm-init sets up the targets (needed when fitblk probes late, e.g. because it depends on NVMEM calibration data)
Quoted 6 lines
The FIT dm-verity node schema was upstreamed into the flat-image-tree specification [2], which this implementation tries to follow exactly.
The runtime feature is guarded behind
CONFIG_FIT_VERITY. If not enabled the resulting binary size remains unchanged. If enabled the binary size increases by about 3kB.
So one thing is that sandbox needs to enable this, so that CI can run the tests (and we can see the tests run, and there's no new warnings, etc). That can be a follow-up and not a full respin, pending other feedback.
Signature · 1 line
Tom