Skip to contentSkip to conversation

statx: expose the fs-verity bit

PATCH Applied Eric Biggers 4 participants 18 messages Oct 29, 2019 – Nov 13, 2019

Subsystems (8)
lore
Share & tools
lore

Eric Biggers

author maintainer
#0 lore raw

cover statx: expose the fs-verity bit

This patchset exposes the verity bit (a.k.a. FS_VERITY_FL) via statx().

This is useful because it allows applications to check whether a file is a verity file without opening it. Opening a verity file can be expensive because the fsverity_info is set up on open, which involves parsing metadata and optionally verifying a cryptographic signature.

This is analogous to how various other bits are exposed through both FS_IOC_GETFLAGS and statx(), e.g. the encrypt bit.

This patchset applies to v5.4-rc5.

Eric Biggers (4):
statx: define STATX_ATTR_VERITY
ext4: support STATX_ATTR_VERITY
f2fs: support STATX_ATTR_VERITY
docs: fs-verity: mention statx() support

 Documentation/filesystems/fsverity.rst | 8 ++++++++
 fs/ext4/inode.c                        | 5 ++++-
 fs/f2fs/file.c                         | 5 ++++-
 include/linux/stat.h                   | 3 ++-
 include/uapi/linux/stat.h              | 2 +-
 5 files changed, 19 insertions(+), 4 deletions(-)
Signature · 1 line
2.24.0.rc1.363.gb1bccd3e3d-goog
author maintainer
#1 lore raw

PATCH 1/4 statx: define STATX_ATTR_VERITY

From: Eric Biggers <[email protected]>

Add a statx attribute bit STATX_ATTR_VERITY which will be set if the file has fs-verity enabled. This is the statx() equivalent of FS_VERITY_FL which is returned by FS_IOC_GETFLAGS.

This is useful because it allows applications to check whether a file is a verity file without opening it. Opening a verity file can be expensive because the fsverity_info is set up on open, which involves parsing metadata and optionally verifying a cryptographic signature.

This is analogous to how various other bits are exposed through both FS_IOC_GETFLAGS and statx(), e.g. the encrypt bit.

---
 include/linux/stat.h      | 3 ++-
 include/uapi/linux/stat.h | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)
include/linux/stat.h +2 -1
index 765573dc17d659..528c4baad09146 100644
@@ -33,7 +33,8 @@ struct kstat {
 	 STATX_ATTR_IMMUTABLE |				\
 	 STATX_ATTR_APPEND |				\
 	 STATX_ATTR_NODUMP |				\
-	 STATX_ATTR_ENCRYPTED				\
+	 STATX_ATTR_ENCRYPTED |				\
+	 STATX_ATTR_VERITY				\
 	 )/* Attrs corresponding to FS_*_FL flags */
 	u64		ino;
 	dev_t		dev;
include/uapi/linux/stat.h +1 -1
index 7b35e98d3c58b1..ad80a5c885d598 100644
@@ -167,8 +167,8 @@ struct statx {
 #define STATX_ATTR_APPEND		0x00000020 /* [I] File is append-only */
 #define STATX_ATTR_NODUMP		0x00000040 /* [I] File is not to be dumped */
 #define STATX_ATTR_ENCRYPTED		0x00000800 /* [I] File requires key to decrypt in fs */
-
 #define STATX_ATTR_AUTOMOUNT		0x00001000 /* Dir: Automount trigger */
+#define STATX_ATTR_VERITY		0x00100000 /* [I] Verity protected file */
 
 
 #endif /* _UAPI_LINUX_STAT_H */
Signature · 1 line
2.24.0.rc1.363.gb1bccd3e3d-goog
author maintainer
#12 lore raw

PATCH 2/4 ext4: support STATX_ATTR_VERITY

In reply to Eric Biggers

From: Eric Biggers <[email protected]>

Set the STATX_ATTR_VERITY bit when the statx() system call is used on a verity file on ext4.

---
 fs/ext4/inode.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
fs/ext4/inode.c +4 -1
index 516faa280ceda8..a7ca6517798008 100644
@@ -5717,12 +5717,15 @@ int ext4_getattr(const struct path *path, struct kstat *stat,
 		stat->attributes |= STATX_ATTR_IMMUTABLE;
 	if (flags & EXT4_NODUMP_FL)
 		stat->attributes |= STATX_ATTR_NODUMP;
+	if (flags & EXT4_VERITY_FL)
+		stat->attributes |= STATX_ATTR_VERITY;
 
 	stat->attributes_mask |= (STATX_ATTR_APPEND |
 				  STATX_ATTR_COMPRESSED |
 				  STATX_ATTR_ENCRYPTED |
 				  STATX_ATTR_IMMUTABLE |
-				  STATX_ATTR_NODUMP);
+				  STATX_ATTR_NODUMP |
+				  STATX_ATTR_VERITY);
 
 	generic_fillattr(inode, stat);
 	return 0;
Signature · 1 line
2.24.0.rc1.363.gb1bccd3e3d-goog
author maintainer
#14 lore raw

PATCH 3/4 f2fs: support STATX_ATTR_VERITY

In reply to Eric Biggers

From: Eric Biggers <[email protected]>

Set the STATX_ATTR_VERITY bit when the statx() system call is used on a verity file on f2fs.

---
 fs/f2fs/file.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
fs/f2fs/file.c +4 -1
index 29bc0a542759a2..6a2e5b7d8fc74c 100644
@@ -726,11 +726,14 @@ int f2fs_getattr(const struct path *path, struct kstat *stat,
 		stat->attributes |= STATX_ATTR_IMMUTABLE;
 	if (flags & F2FS_NODUMP_FL)
 		stat->attributes |= STATX_ATTR_NODUMP;
+	if (IS_VERITY(inode))
+		stat->attributes |= STATX_ATTR_VERITY;
 
 	stat->attributes_mask |= (STATX_ATTR_APPEND |
 				  STATX_ATTR_ENCRYPTED |
 				  STATX_ATTR_IMMUTABLE |
-				  STATX_ATTR_NODUMP);
+				  STATX_ATTR_NODUMP |
+				  STATX_ATTR_VERITY);
 
 	generic_fillattr(inode, stat);
 
Signature · 1 line
2.24.0.rc1.363.gb1bccd3e3d-goog
author maintainer
#15 lore raw

PATCH 4/4 docs: fs-verity: mention statx() support

In reply to Eric Biggers

From: Eric Biggers <[email protected]>

Document that the statx() system call can now be used to check whether a file is a verity file.

---
 Documentation/filesystems/fsverity.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/filesystems/fsverity.rst +8 -0
index 42a0b6dd9e0b68..3355377a24398d 100644
@@ -226,6 +226,14 @@ To do so, check for FS_VERITY_FL (0x00100000) in the returned flags.
 The verity flag is not settable via FS_IOC_SETFLAGS.  You must use
 FS_IOC_ENABLE_VERITY instead, since parameters must be provided.
 
+statx
+-----
+
+Since Linux v5.5, the statx() system call sets STATX_ATTR_VERITY if
+the file has fs-verity enabled.  This can perform better than
+FS_IOC_GETFLAGS and FS_IOC_MEASURE_VERITY because it doesn't require
+opening the file, and opening verity files can be expensive.
+
 Accessing verity files
 ======================
 
Signature · 1 line
2.24.0.rc1.363.gb1bccd3e3d-goog
Reviewed-by on v1 1/4
#2 lore raw

Re: [PATCH 1/4] statx: define STATX_ATTR_VERITY

In reply to Eric Biggers
Quoted 12 lines · Eric Biggers

From: Eric Biggers <[email protected]>

Add a statx attribute bit STATX_ATTR_VERITY which will be set if the file has fs-verity enabled. This is the statx() equivalent of FS_VERITY_FL which is returned by FS_IOC_GETFLAGS.

This is useful because it allows applications to check whether a file is a verity file without opening it. Opening a verity file can be expensive because the fsverity_info is set up on open, which involves parsing metadata and optionally verifying a cryptographic signature.

Quoted 4 lines

This is analogous to how various other bits are exposed through both FS_IOC_GETFLAGS and statx(), e.g. the encrypt bit.

Quoted 34 lines

---
include/linux/stat.h | 3 ++-
include/uapi/linux/stat.h | 2 +-

2 files changed, 3 insertions(+), 2 deletions(-)
include/linux/stat.h +2 -1
index 765573dc17d659..528c4baad09146 100644
@@ -33,7 +33,8 @@ struct kstat {
 	 STATX_ATTR_IMMUTABLE |				\
 	 STATX_ATTR_APPEND |				\
 	 STATX_ATTR_NODUMP |				\
-	 STATX_ATTR_ENCRYPTED				\
+	 STATX_ATTR_ENCRYPTED |				\
+	 STATX_ATTR_VERITY				\
 	 )/* Attrs corresponding to FS_*_FL flags */
 	u64		ino;
 	dev_t		dev;
include/uapi/linux/stat.h +1 -2
index 7b35e98d3c58b1..ad80a5c885d598 100644
@@ -167,8 +167,8 @@ struct statx {
 #define STATX_ATTR_APPEND		0x00000020 /* [I] File is append-only */
 #define STATX_ATTR_NODUMP		0x00000040 /* [I] File is not to be dumped */
 #define STATX_ATTR_ENCRYPTED		0x00000800 /* [I] File requires key to decrypt in fs */
-
 #define STATX_ATTR_AUTOMOUNT		0x00001000 /* Dir: Automount trigger */
+#define STATX_ATTR_VERITY		0x00100000 /* [I] Verity protected file */
 
 
 #endif /* _UAPI_LINUX_STAT_H */
--
Quoted 2 lines

2.24.0.rc1.363.gb1bccd3e3d-goog

Cheers, Andreas

Reviewed-by on v1 2/4
#13 lore raw

Re: [PATCH 2/4] ext4: support STATX_ATTR_VERITY

In reply to Eric Biggers
Quoted 9 lines · Eric Biggers

From: Eric Biggers <[email protected]>

Set the STATX_ATTR_VERITY bit when the statx() system call is used on a verity file on ext4.

Quoted 26 lines

---
fs/ext4/inode.c | 5 ++++-

1 file changed, 4 insertions(+), 1 deletion(-)
fs/ext4/inode.c +4 -2
index 516faa280ceda8..a7ca6517798008 100644
@@ -5717,12 +5717,15 @@ int ext4_getattr(const struct path *path, struct kstat *stat,
 		stat->attributes |= STATX_ATTR_IMMUTABLE;
 	if (flags & EXT4_NODUMP_FL)
 		stat->attributes |= STATX_ATTR_NODUMP;
+	if (flags & EXT4_VERITY_FL)
+		stat->attributes |= STATX_ATTR_VERITY;
 
 	stat->attributes_mask |= (STATX_ATTR_APPEND |
 				  STATX_ATTR_COMPRESSED |
 				  STATX_ATTR_ENCRYPTED |
 				  STATX_ATTR_IMMUTABLE |
-				  STATX_ATTR_NODUMP);
+				  STATX_ATTR_NODUMP |
+				  STATX_ATTR_VERITY);
 
 	generic_fillattr(inode, stat);
 	return 0;
--
Quoted 2 lines

2.24.0.rc1.363.gb1bccd3e3d-goog

Cheers, Andreas

author maintainer
#16 lore raw
In reply to Eric Biggers
Quoted 18 lines · Eric Biggers

This patchset exposes the verity bit (a.k.a. FS_VERITY_FL) via statx().

This is useful because it allows applications to check whether a file is a verity file without opening it. Opening a verity file can be expensive because the fsverity_info is set up on open, which involves parsing metadata and optionally verifying a cryptographic signature.

This is analogous to how various other bits are exposed through both FS_IOC_GETFLAGS and statx(), e.g. the encrypt bit.

This patchset applies to v5.4-rc5.

Eric Biggers (4):
statx: define STATX_ATTR_VERITY
ext4: support STATX_ATTR_VERITY
f2fs: support STATX_ATTR_VERITY
docs: fs-verity: mention statx() support

Quoted 7 lines
 Documentation/filesystems/fsverity.rst | 8 ++++++++
 fs/ext4/inode.c                        | 5 ++++-
 fs/f2fs/file.c                         | 5 ++++-
 include/linux/stat.h                   | 3 ++-
 include/uapi/linux/stat.h              | 2 +-
 5 files changed, 19 insertions(+), 4 deletions(-)

Any more comments on this?

- Eric

Acked-by on v1 1/4
#3 lore raw

Re: [PATCH 1/4] statx: define STATX_ATTR_VERITY

In reply to Eric Biggers
Quoted 39 lines · Eric Biggers

From: Eric Biggers <[email protected]>

Add a statx attribute bit STATX_ATTR_VERITY which will be set if the file has fs-verity enabled. This is the statx() equivalent of FS_VERITY_FL which is returned by FS_IOC_GETFLAGS.

This is useful because it allows applications to check whether a file is a verity file without opening it. Opening a verity file can be expensive because the fsverity_info is set up on open, which involves parsing metadata and optionally verifying a cryptographic signature.

This is analogous to how various other bits are exposed through both FS_IOC_GETFLAGS and statx(), e.g. the encrypt bit.

---
 include/linux/stat.h      | 3 ++-
 include/uapi/linux/stat.h | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)
include/linux/stat.h +2 -1
index 765573dc17d659..528c4baad09146 100644
@@ -33,7 +33,8 @@ struct kstat {
 	 STATX_ATTR_IMMUTABLE |				\
 	 STATX_ATTR_APPEND |				\
 	 STATX_ATTR_NODUMP |				\
-	 STATX_ATTR_ENCRYPTED				\
+	 STATX_ATTR_ENCRYPTED |				\
+	 STATX_ATTR_VERITY				\
 	 )/* Attrs corresponding to FS_*_FL flags */
 	u64		ino;
 	dev_t		dev;
include/uapi/linux/stat.h +0 -0
index 7b35e98d3c58b1..ad80a5c885d598 100644

include/uapi/linux/stat.h struct statx { · line 171

Quoted 6 lines
include/uapi/linux/stat.h +1 -1
@@ -167,8 +167,8 @@ struct statx {
 #define STATX_ATTR_APPEND		0x00000020 /* [I] File is append-only */
 #define STATX_ATTR_NODUMP		0x00000040 /* [I] File is not to be dumped */
 #define STATX_ATTR_ENCRYPTED		0x00000800 /* [I] File requires key to decrypt in fs */
-
 #define STATX_ATTR_AUTOMOUNT		0x00001000 /* Dir: Automount trigger */
+#define STATX_ATTR_VERITY		0x00100000 /* [I] Verity protected file */

Any reason why this wasn't 0x2000?

If there's a manpage update that goes with this, then...

--D

Quoted 6 lines
include/uapi/linux/stat.h +0 -0
 #endif /* _UAPI_LINUX_STAT_H */
Signature · 1 line
2.24.0.rc1.363.gb1bccd3e3d-goog
#4 lore raw

Re: [PATCH 1/4] statx: define STATX_ATTR_VERITY

Quoted 41 lines · Darrick J. Wong
Quoted 39 lines · Eric Biggers

From: Eric Biggers <[email protected]>

Add a statx attribute bit STATX_ATTR_VERITY which will be set if the file has fs-verity enabled. This is the statx() equivalent of FS_VERITY_FL which is returned by FS_IOC_GETFLAGS.

This is useful because it allows applications to check whether a file is a verity file without opening it. Opening a verity file can be expensive because the fsverity_info is set up on open, which involves parsing metadata and optionally verifying a cryptographic signature.

This is analogous to how various other bits are exposed through both FS_IOC_GETFLAGS and statx(), e.g. the encrypt bit.

---
include/linux/stat.h | 3 ++-
include/uapi/linux/stat.h | 2 +-

2 files changed, 3 insertions(+), 2 deletions(-)
include/linux/stat.h +2 -1
index 765573dc17d659..528c4baad09146 100644
@@ -33,7 +33,8 @@ struct kstat {
 	 STATX_ATTR_IMMUTABLE |				\
 	 STATX_ATTR_APPEND |				\
 	 STATX_ATTR_NODUMP |				\
-	 STATX_ATTR_ENCRYPTED				\
+	 STATX_ATTR_ENCRYPTED |				\
+	 STATX_ATTR_VERITY				\
 	 )/* Attrs corresponding to FS_*_FL flags */
 	u64		ino;
 	dev_t		dev;
include/uapi/linux/stat.h +0 -0
index 7b35e98d3c58b1..ad80a5c885d598 100644
@@ -167,8 +167,8 @@ struct statx {
Quoted 8 lines

include/uapi/linux/stat.h struct statx { · line 171

Quoted 6 lines
include/uapi/linux/stat.h +1 -1
 #define STATX_ATTR_APPEND		0x00000020 /* [I] File is append-only */
 #define STATX_ATTR_NODUMP		0x00000040 /* [I] File is not to be dumped */
 #define STATX_ATTR_ENCRYPTED		0x00000800 /* [I] File requires key to decrypt in fs */
-
 #define STATX_ATTR_AUTOMOUNT		0x00001000 /* Dir: Automount trigger */
+#define STATX_ATTR_VERITY		0x00100000 /* [I] Verity protected file */

Any reason why this wasn't 0x2000?

A few lines earlier in this file it states:

* Note that the flags marked [I] correspond to generic FS_IOC_FLAGS
* semantically. Where possible, the numerical value is picked to
* correspond also.

Cheers, Andreas

author maintainer
#5 lore raw

RFC PATCH 1/1 statx.2: document STATX_ATTR_VERITY

In reply to Darrick J. Wong

From: Eric Biggers <[email protected]>

Document the verity attribute for statx().

---
 man2/statx.2 | 4 ++++
 1 file changed, 4 insertions(+)

RFC since the kernel patches are currently under review. The kernel patches can be found here:
https://lkml.kernel.org/linux-fscrypt/[email protected]/T/#u

man2/statx.2 +4 -0
index d2f1b07b8..713bd1260 100644
@@ -461,6 +461,10 @@ See
 .TP
 .B STATX_ATTR_ENCRYPTED
 A key is required for the file to be encrypted by the filesystem.
+.TP
+.B STATX_ATTR_VERITY
+The file has fs-verity enabled.  It cannot be written to, and all reads from it
+will be verified against a Merkle tree.
 .SH RETURN VALUE
 On success, zero is returned.
 On error, \-1 is returned, and
Signature · 1 line
2.24.0.rc1.363.gb1bccd3e3d-goog
author maintainer
#11 lore raw

Re: [PATCH 1/4] statx: define STATX_ATTR_VERITY

In reply to Darrick J. Wong
Quoted 40 lines · Darrick J. Wong
Quoted 39 lines · Eric Biggers

From: Eric Biggers <[email protected]>

Add a statx attribute bit STATX_ATTR_VERITY which will be set if the file has fs-verity enabled. This is the statx() equivalent of FS_VERITY_FL which is returned by FS_IOC_GETFLAGS.

This is useful because it allows applications to check whether a file is a verity file without opening it. Opening a verity file can be expensive because the fsverity_info is set up on open, which involves parsing metadata and optionally verifying a cryptographic signature.

This is analogous to how various other bits are exposed through both FS_IOC_GETFLAGS and statx(), e.g. the encrypt bit.

---
 include/linux/stat.h      | 3 ++-
 include/uapi/linux/stat.h | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)
include/linux/stat.h +2 -1
index 765573dc17d659..528c4baad09146 100644
@@ -33,7 +33,8 @@ struct kstat {
 	 STATX_ATTR_IMMUTABLE |				\
 	 STATX_ATTR_APPEND |				\
 	 STATX_ATTR_NODUMP |				\
-	 STATX_ATTR_ENCRYPTED				\
+	 STATX_ATTR_ENCRYPTED |				\
+	 STATX_ATTR_VERITY				\
 	 )/* Attrs corresponding to FS_*_FL flags */
 	u64		ino;
 	dev_t		dev;
include/uapi/linux/stat.h +0 -0
index 7b35e98d3c58b1..ad80a5c885d598 100644
@@ -167,8 +167,8 @@ struct statx {
Quoted 8 lines

include/uapi/linux/stat.h struct statx { · line 171

Quoted 6 lines
include/uapi/linux/stat.h +1 -1
 #define STATX_ATTR_APPEND		0x00000020 /* [I] File is append-only */
 #define STATX_ATTR_NODUMP		0x00000040 /* [I] File is not to be dumped */
 #define STATX_ATTR_ENCRYPTED		0x00000800 /* [I] File requires key to decrypt in fs */
-
 #define STATX_ATTR_AUTOMOUNT		0x00001000 /* Dir: Automount trigger */
+#define STATX_ATTR_VERITY		0x00100000 /* [I] Verity protected file */

Any reason why this wasn't 0x2000?

Yes, as Andreas pointed out, the value is chosen to match the corresponding FS_IOC_GETFLAGS bit, like the other bits above marked [I].

Quoted 4 lines

If there's a manpage update that goes with this, then...

It's pretty trivial to add it to the statx(2) man page. I've sent out a patch for comment:
https://lkml.kernel.org/linux-fscrypt/[email protected]/

- Eric

#6 lore raw

Re: [man-pages RFC PATCH] statx.2: document STATX_ATTR_VERITY

In reply to Eric Biggers
Quoted 18 lines · Eric Biggers

From: Eric Biggers <[email protected]>

Document the verity attribute for statx().

---
 man2/statx.2 | 4 ++++
 1 file changed, 4 insertions(+)

RFC since the kernel patches are currently under review. The kernel patches can be found here:
https://lkml.kernel.org/linux-fscrypt/[email protected]/T/#u

man2/statx.2 +0 -0
index d2f1b07b8..713bd1260 100644

man2/statx.2 See · line 467

Quoted 7 lines
man2/statx.2 +4 -0
@@ -461,6 +461,10 @@ See
 .TP
 .B STATX_ATTR_ENCRYPTED
 A key is required for the file to be encrypted by the filesystem.
+.TP
+.B STATX_ATTR_VERITY
+The file has fs-verity enabled.  It cannot be written to, and all reads from it
+will be verified against a Merkle tree.

mkerrisk might ask you to start the new sentence on a separate line, but otherwise looks good to me. :)

--D

Quoted 6 lines
man2/statx.2 +0 -0
 .SH RETURN VALUE
 On success, zero is returned.
 On error, \-1 is returned, and
Signature · 1 line
2.24.0.rc1.363.gb1bccd3e3d-goog
#7 lore raw

Re: [man-pages RFC PATCH] statx.2: document STATX_ATTR_VERITY

In reply to Eric Biggers

Am 07.11.2019 23:02, schrieb Eric Biggers:

Quoted 18 lines

From: Eric Biggers <[email protected]>

Document the verity attribute for statx().

---
 man2/statx.2 | 4 ++++
 1 file changed, 4 insertions(+)

RFC since the kernel patches are currently under review. The kernel patches can be found here:
https://lkml.kernel.org/linux-fscrypt/[email protected]/T/#u

man2/statx.2 +0 -0
index d2f1b07b8..713bd1260 100644

man2/statx.2 See · line 467

Quoted 7 lines
man2/statx.2 +4 -0
@@ -461,6 +461,10 @@ See
 .TP
 .B STATX_ATTR_ENCRYPTED
 A key is required for the file to be encrypted by the filesystem.
+.TP
+.B STATX_ATTR_VERITY
+The file has fs-verity enabled.  It cannot be written to, and all reads from it
+will be verified against a Merkle tree.

Using "Merkle tree" opens a can of worm and what will happen when the methode will change ? Does it matter at all ? i would suggest "filesystem" here.

re,
wh

Quoted 3 lines
man2/statx.2 +0 -0
 .SH RETURN VALUE
 On success, zero is returned.
 On error, \-1 is returned, and
author maintainer
#8 lore raw

Re: [man-pages RFC PATCH] statx.2: document STATX_ATTR_VERITY

Quoted 16 lines · walter harms

Am 07.11.2019 23:02, schrieb Eric Biggers:

Quoted 13 lines

From: Eric Biggers <[email protected]>

Document the verity attribute for statx().

---
 man2/statx.2 | 4 ++++
 1 file changed, 4 insertions(+)

RFC since the kernel patches are currently under review. The kernel patches can be found here:
https://lkml.kernel.org/linux-fscrypt/[email protected]/T/#u

Quoted 16 lines

man2/statx.2 See · line 467

Quoted 12 lines
man2/statx.2 +4 -0
index d2f1b07b8..713bd1260 100644
@@ -461,6 +461,10 @@ See
 .TP
 .B STATX_ATTR_ENCRYPTED
 A key is required for the file to be encrypted by the filesystem.
+.TP
+.B STATX_ATTR_VERITY
+The file has fs-verity enabled.  It cannot be written to, and all reads from it
+will be verified against a Merkle tree.

Using "Merkle tree" opens a can of worm and what will happen when the methode will change ? Does it matter at all ? i would suggest "filesystem" here.

Fundamentally, fs-verity guarantees that all data read is verified against a cryptographic hash that covers the entire file. I think it will be helpful to convey that here, e.g. to avoid confusion with non-cryptographic, individual block checksums supported by filesystems like btrfs and zfs.

Now, the only sane way to implement this model is with a Merkle tree, and this is part of the fs-verity UAPI (via the file hash), so that's where I'm coming from here. Perhaps the phrase "Merkle tree" could be interpreted too strictly, though, so it would be better to emphasize the more abstract model. How about the following?:

The file has fs-verity enabled. It cannot be written to, and all reads from it will be verified against a cryptographic hash that covers the entire file, e.g. via a Merkle tree.

- Eric

#9 lore raw

Re: [man-pages RFC PATCH] statx.2: document STATX_ATTR_VERITY

Am 08.11.2019 20:35, schrieb Eric Biggers:

Quoted 45 lines · walter harms
Quoted 16 lines

Am 07.11.2019 23:02, schrieb Eric Biggers:

Quoted 13 lines

From: Eric Biggers <[email protected]>

Document the verity attribute for statx().

---
 man2/statx.2 | 4 ++++
 1 file changed, 4 insertions(+)

RFC since the kernel patches are currently under review. The kernel patches can be found here:
https://lkml.kernel.org/linux-fscrypt/[email protected]/T/#u

Quoted 16 lines

man2/statx.2 See · line 467

Quoted 12 lines
man2/statx.2 +4 -0
index d2f1b07b8..713bd1260 100644
@@ -461,6 +461,10 @@ See
 .TP
 .B STATX_ATTR_ENCRYPTED
 A key is required for the file to be encrypted by the filesystem.
+.TP
+.B STATX_ATTR_VERITY
+The file has fs-verity enabled.  It cannot be written to, and all reads from it
+will be verified against a Merkle tree.

Using "Merkle tree" opens a can of worm and what will happen when the methode will change ? Does it matter at all ? i would suggest "filesystem" here.

Fundamentally, fs-verity guarantees that all data read is verified against a cryptographic hash that covers the entire file. I think it will be helpful to convey that here, e.g. to avoid confusion with non-cryptographic, individual block checksums supported by filesystems like btrfs and zfs.

Now, the only sane way to implement this model is with a Merkle tree, and this is part of the fs-verity UAPI (via the file hash), so that's where I'm coming from here. Perhaps the phrase "Merkle tree" could be interpreted too strictly, though, so it would be better to emphasize the more abstract model. How about the following?:

Quoted 4 lines

The file has fs-verity enabled. It cannot be written to, and all reads from it will be verified against a cryptographic hash that covers the entire file, e.g. via a Merkle tree.

"feels" better,. but from a programmers perspective it is important at what level this is actually done. To see my point look at the line before. "encrypted by the filesystem" mean i have to read the documentation of the fs first so if encryption is supported at all. Or do i think to complicated ?

jm2c,
re
wh

author maintainer Applied
#17 lore raw
In reply to Eric Biggers
Quoted 18 lines · Eric Biggers

This patchset exposes the verity bit (a.k.a. FS_VERITY_FL) via statx().

This is useful because it allows applications to check whether a file is a verity file without opening it. Opening a verity file can be expensive because the fsverity_info is set up on open, which involves parsing metadata and optionally verifying a cryptographic signature.

This is analogous to how various other bits are exposed through both FS_IOC_GETFLAGS and statx(), e.g. the encrypt bit.

This patchset applies to v5.4-rc5.

Eric Biggers (4):
statx: define STATX_ATTR_VERITY
ext4: support STATX_ATTR_VERITY
f2fs: support STATX_ATTR_VERITY
docs: fs-verity: mention statx() support

Quoted 6 lines
 Documentation/filesystems/fsverity.rst | 8 ++++++++
 fs/ext4/inode.c                        | 5 ++++-
 fs/f2fs/file.c                         | 5 ++++-
 include/linux/stat.h                   | 3 ++-
 include/uapi/linux/stat.h              | 2 +-
 5 files changed, 19 insertions(+), 4 deletions(-)

Applied to fscrypt.git#fsverity for 5.5.

- Eric

author maintainer
#10 lore raw

Re: [man-pages RFC PATCH] statx.2: document STATX_ATTR_VERITY

In reply to walter harms
Quoted 51 lines · walter harms

Am 08.11.2019 20:35, schrieb Eric Biggers:

Quoted 45 lines · walter harms
Quoted 16 lines

Am 07.11.2019 23:02, schrieb Eric Biggers:

Quoted 13 lines

From: Eric Biggers <[email protected]>

Document the verity attribute for statx().

---
 man2/statx.2 | 4 ++++
 1 file changed, 4 insertions(+)

RFC since the kernel patches are currently under review. The kernel patches can be found here:
https://lkml.kernel.org/linux-fscrypt/[email protected]/T/#u

Quoted 16 lines

man2/statx.2 See · line 467

Quoted 12 lines
man2/statx.2 +4 -0
index d2f1b07b8..713bd1260 100644
@@ -461,6 +461,10 @@ See
 .TP
 .B STATX_ATTR_ENCRYPTED
 A key is required for the file to be encrypted by the filesystem.
+.TP
+.B STATX_ATTR_VERITY
+The file has fs-verity enabled.  It cannot be written to, and all reads from it
+will be verified against a Merkle tree.

Using "Merkle tree" opens a can of worm and what will happen when the methode will change ? Does it matter at all ? i would suggest "filesystem" here.

Fundamentally, fs-verity guarantees that all data read is verified against a cryptographic hash that covers the entire file. I think it will be helpful to convey that here, e.g. to avoid confusion with non-cryptographic, individual block checksums supported by filesystems like btrfs and zfs.

Now, the only sane way to implement this model is with a Merkle tree, and this is part of the fs-verity UAPI (via the file hash), so that's where I'm coming from here. Perhaps the phrase "Merkle tree" could be interpreted too strictly, though, so it would be better to emphasize the more abstract model. How about the following?:

Quoted 4 lines

The file has fs-verity enabled. It cannot be written to, and all reads from it will be verified against a cryptographic hash that covers the entire file, e.g. via a Merkle tree.

Quoted 5 lines

"feels" better,. but from a programmers perspective it is important at what level this is actually done. To see my point look at the line before. "encrypted by the filesystem" mean i have to read the documentation of the fs first so if encryption is supported at all. Or do i think to complicated ?

It's filesystem-specific whether encryption and verity are supported. I'm not sure what your concern is, as statx() won't return the bits if the filesystem doesn't support them.

Also note, if someone really wants the details about fscrypt and fsverity, they really should read the documentation we maintain in the kernel tree [1][2].

[1] https://www.kernel.org/doc/html/latest/filesystems/fscrypt.html
[2] https://www.kernel.org/doc/html/latest/filesystems/fsverity.html

- Eric