Skip to content

Commit

Permalink
README: minor tweaks
Browse files Browse the repository at this point in the history
Mention the `trusted.overlay.metacopy` xattr since we talk about
`trusted.overlay.redirect`.

Explain more what we mean by fs-verity not verifying metadata.

Fix typo in mount options.
  • Loading branch information
jlebon committed Sep 29, 2024
1 parent e2afe90 commit a740dcb
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ reliably share memory.

Composefs also supports [fs-verity](https://www.kernel.org/doc/html/latest/filesystems/fsverity.html)
validation of the content files. When using this, the digest of the
content files is stored in the image, and composefs will validate that
content files is stored in the image in the `trusted.overlay.metacopy`
extended attributes which tell overlayfs to validate that
the content file it uses has a matching enabled fs-verity digest. This
means that the backing content cannot be changed in any way (by
mistake or by malice) without this being detected when the file is
Expand All @@ -89,8 +90,9 @@ You can also use fs-verity on the image file itself, and pass the
expected fs-verity digest as a mount option, which composefs will
validate. In this case we have full trust of both data and metadata of
the mounted file. This solves a weakness that fs-verity has when used
on its own, in that it can only verify file data, not
metadata.
on its own, in that it can only verify file data, not metadata (e.g.
inode bits like permissions and ownership, but also directory
structures).

## Usecase: container images

Expand Down Expand Up @@ -166,7 +168,7 @@ Mount options:
- `noverity`: Don't verfy fs-verity digests (useful for example if fs-verity is not supported on basedir).
- `digest`: A fs-verity sha256 digest that the image file must match. If set, `verity_check` defaults to 2.
- `upperdir`: Specify an upperdir for the overlayfs filesystem.
- `workdir`: Specify an upperdir for the overlayfs filesystem.
- `workdir`: Specify a workdir for the overlayfs filesystem.
- `idmap`: Specify a path to a user namespace that is used as an idmap.

## Language bindings
Expand Down

0 comments on commit a740dcb

Please sign in to comment.