[1/6] chattr.1: document the verity attribute
diff mbox series

Message ID 20191118014852.390686-2-ebiggers@kernel.org
State New
Headers show
Series
  • chattr.1 updates
Related show

Commit Message

Eric Biggers Nov. 18, 2019, 1:48 a.m. UTC
From: Eric Biggers <ebiggers@google.com>

Document the verity file attribute ('V').

Signed-off-by: Eric Biggers <ebiggers@google.com>
---
 misc/chattr.1.in | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

Patch
diff mbox series

diff --git a/misc/chattr.1.in b/misc/chattr.1.in
index 1c9e8964..2122a13e 100644
--- a/misc/chattr.1.in
+++ b/misc/chattr.1.in
@@ -52,7 +52,8 @@  The following attributes are read-only, and may be listed by
 but not modified by chattr:
 encrypted (E),
 indexed directory (I),
-and inline data (N).
+inline data (N),
+and verity (V).
 .PP
 Not all flags are supported or utilized by all filesystems; refer to
 filesystem-specific man pages such as
@@ -189,6 +190,15 @@  saved.  This allows the user to ask for its undeletion.  Note: please
 make sure to read the bugs and limitations section at the end of this
 document.
 .PP
+A file with the 'V' attribute set has fs-verity enabled.  It cannot be
+written to, and the filesystem will automatically verify all data read
+from it against a cryptographic hash that covers the entire file's
+contents, e.g. via a Merkle tree.  This makes it possible to efficiently
+authenticate the file.  This attribute may not be set or reset using
+.BR chattr (1),
+although it can be displayed by
+.BR lsattr (1).
+.PP
 .SH AUTHOR
 .B chattr
 was written by Remy Card <Remy.Card@linux.org>.  It is currently being