Skip to content

Commit 212df80

Browse files
allisonkarlitskayaebiggers
authored andcommitted
Documentation: add a usecase for FS_IOC_READ_VERITY_METADATA
Mention another potential usecase for FS_IOC_READ_VERITY_METADATA: creating filesystem images which contain fs-verity-enabled files, without having to redo all of the work in userspace. Signed-off-by: Allison Karlitskaya <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Eric Biggers <[email protected]>
1 parent 0ad2507 commit 212df80

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

Documentation/filesystems/fsverity.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -248,11 +248,17 @@ FS_IOC_READ_VERITY_METADATA
248248
The FS_IOC_READ_VERITY_METADATA ioctl reads verity metadata from a
249249
verity file. This ioctl is available since Linux v5.12.
250250

251-
This ioctl allows writing a server program that takes a verity file
252-
and serves it to a client program, such that the client can do its own
253-
fs-verity compatible verification of the file. This only makes sense
254-
if the client doesn't trust the server and if the server needs to
255-
provide the storage for the client.
251+
This ioctl is useful for cases where the verity verification should be
252+
performed somewhere other than the currently running kernel.
253+
254+
One example is a server program that takes a verity file and serves it
255+
to a client program, such that the client can do its own fs-verity
256+
compatible verification of the file. This only makes sense if the
257+
client doesn't trust the server and if the server needs to provide the
258+
storage for the client.
259+
260+
Another example is copying verity metadata when creating filesystem
261+
images in userspace (such as with ``mkfs.ext4 -d``).
256262

257263
This is a fairly specialized use case, and most fs-verity users won't
258264
need this ioctl.

0 commit comments

Comments
 (0)