landlock: Document fallocate(2) as another truncation corner case
Subsystems (3)
Günther Noack
reviewerPATCH 1/1 landlock: Document fallocate(2) as another truncation corner case
Reinforce the already stated policy that LANDLOCK_ACCESS_FS_TRUNCATE should always go hand in hand with LANDLOCK_ACCESS_FS_WRITE_FILE, as their meanings and enforcement overlap in counterintuitive ways.
On many common file systems, fallocate(2) offers a way to shorten files as long as the file is opened for writing, side-stepping the LANDLOCK_ACCESS_FS_TRUNCATE right.
--- Documentation/userspace-api/landlock.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)
Documentation/userspace-api/landlock.rst +6 -2
@@ -378,8 +378,8 @@ Truncating files The operations covered by ``LANDLOCK_ACCESS_FS_WRITE_FILE`` and ``LANDLOCK_ACCESS_FS_TRUNCATE`` both change the contents of a file and sometimes -overlap in non-intuitive ways. It is recommended to always specify both of -these together. +overlap in non-intuitive ways. It is strongly recommended to always specify +both of these together (either granting both, or granting none). A particularly surprising example is :manpage:`creat(2)`. The name suggests that this system call requires the rights to create and write files. However,
@@ -391,6 +391,10 @@ It should also be noted that truncating files does not require the system call, this can also be done through :manpage:`open(2)` with the flags ``O_RDONLY | O_TRUNC``. +At the same time, on some filesystems, :manpage:`fallocate(2)` offers a way to +shorten file contents with ``FALLOC_FL_COLLAPSE_RANGE`` when the file is opened +for writing, sidestepping the ``LANDLOCK_ACCESS_FS_TRUNCATE`` right. + The truncate right is associated with the opened file (see below). Rights associated with file descriptors
Signature · 1 line
2.53.0.1185.g05d4b7b318-goog
Mickaël Salaün
maintainerQuoted 30 lines · Günther Noack
Reinforce the already stated policy that
LANDLOCK_ACCESS_FS_TRUNCATEshould always go hand in hand withLANDLOCK_ACCESS_FS_WRITE_FILE, as their meanings and enforcement overlap in counterintuitive ways.On many common file systems, fallocate(2) offers a way to shorten files as long as the file is opened for writing, side-stepping the
LANDLOCK_ACCESS_FS_TRUNCATEright.Assisted-by Gemini-CLI:gemini-3.1Signed-off-by Günther Noack <[email protected]>--- Documentation/userspace-api/landlock.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)Documentation/userspace-api/landlock.rst +2
-2@@ -378,8 +378,8 @@ Truncating files The operations covered by ``LANDLOCK_ACCESS_FS_WRITE_FILE`` and ``LANDLOCK_ACCESS_FS_TRUNCATE`` both change the contents of a file and sometimes -overlap in non-intuitive ways. It is recommended to always specify both of -these together. +overlap in non-intuitive ways. It is strongly recommended to always specify +both of these together (either granting both, or granting none). A particularly surprising example is :manpage:`creat(2)`. The name suggests that this system call requires the rights to create and write files. However,
Documentation/userspace-api/landlock.rst It should also be noted that truncating files does not require the · line 396
Quoted 6 lines
Documentation/userspace-api/landlock.rst +3
-0@@ -391,6 +391,10 @@ It should also be noted that truncating files does not require the system call, this can also be done through :manpage:`open(2)` with the flags ``O_RDONLY | O_TRUNC``. +At the same time, on some filesystems, :manpage:`fallocate(2)` offers a way to +shorten file contents with ``FALLOC_FL_COLLAPSE_RANGE`` when the file is opened +for writing, sidestepping the ``LANDLOCK_ACCESS_FS_TRUNCATE`` right.
Interesting, which filesystems? Shouldn't it be fixed in the code instead?
Quoted 8 lines
Documentation/userspace-api/landlock.rst +1
-0+ The truncate right is associated with the opened file (see below). Rights associated with file descriptorsSignature · 1 line
2.53.0.1185.g05d4b7b318-goog
Günther Noack
reviewerQuoted 34 lines · Mickaël Salaün
Quoted 33 lines · Günther Noack
Reinforce the already stated policy that
LANDLOCK_ACCESS_FS_TRUNCATEshould always go hand in hand withLANDLOCK_ACCESS_FS_WRITE_FILE, as their meanings and enforcement overlap in counterintuitive ways.On many common file systems, fallocate(2) offers a way to shorten files as long as the file is opened for writing, side-stepping the
LANDLOCK_ACCESS_FS_TRUNCATEright.Assisted-by Gemini-CLI:gemini-3.1Signed-off-by Günther Noack <[email protected]>--- Documentation/userspace-api/landlock.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)Documentation/userspace-api/landlock.rst +2
-2@@ -378,8 +378,8 @@ Truncating files The operations covered by ``LANDLOCK_ACCESS_FS_WRITE_FILE`` and ``LANDLOCK_ACCESS_FS_TRUNCATE`` both change the contents of a file and sometimes -overlap in non-intuitive ways. It is recommended to always specify both of -these together. +overlap in non-intuitive ways. It is strongly recommended to always specify +both of these together (either granting both, or granting none). A particularly surprising example is :manpage:`creat(2)`. The name suggests that this system call requires the rights to create and write files. However,@@ -391,6 +391,10 @@ It should also be noted that truncating files does not require the system call, this can also be done through :manpage:`open(2)` with the flags ``O_RDONLY | O_TRUNC``.
Quoted 6 lines
Documentation/userspace-api/landlock.rst It should also be noted that truncating files does not require the · line 396
Quoted 3 lines
Documentation/userspace-api/landlock.rst +3
-0+At the same time, on some filesystems, :manpage:`fallocate(2)` offers a way to +shorten file contents with ``FALLOC_FL_COLLAPSE_RANGE`` when the file is opened +for writing, sidestepping the ``LANDLOCK_ACCESS_FS_TRUNCATE`` right.Interesting, which filesystems? Shouldn't it be fixed in the code instead?
It works on ext4, and I also see mentions of FALLOC_FL_COLLAPSE_RANGE in XFS, F2FS, SMB and NTFS3.
I should mention, it is not *exactly* the same as a truncation, but you can remove a chunk of the file from the middle, which also leads to a shorter file. For example, assuming a block size of 1024:
1. Make a file with 2*1024 bytes: 1024*'A', then 1024*'B'
2. fallocate(collapse range, 0, 1024)
Resulting file is 1024*'B', and the file is shortened to 1024 bytes.
So this is not *exactly* a truncation. (The man page says that an attempt to remove the end of a file results in EINVAL, so you have to take it from the middle, and it needs to align with block boundaries.)
But it's quite similar, also shortens the file, and it does not require the Landlock truncation access right.
I agree, another way would potentially be to call the LSM ftruncate hook. I suspect this would stay compatible with other LSMs, because the LSM ftruncate hook is a relatively recent addition (but have not checked in detail).
The implementation of fallocate is vfs_fallocate() in fs/open.c - I only had a tentative look now; it checks that the file->f_mode is open for writing and calls security_file_permission() with MAY_WRITE.
I always saw LANDLOCK_ACCESS_FS_WRITE_FILE and LANDLOCK_ACCESS_FS_TRUNCATE as rights that should always go together, so I suspect that it does not make a big difference in practice, and that is why I am suggesting to just document it more clearly for now.
—Günther
Mickaël Salaün
maintainerQuoted 66 lines · Günther Noack
Quoted 34 lines · Mickaël Salaün
Quoted 33 lines · Günther Noack
Reinforce the already stated policy that
LANDLOCK_ACCESS_FS_TRUNCATEshould always go hand in hand withLANDLOCK_ACCESS_FS_WRITE_FILE, as their meanings and enforcement overlap in counterintuitive ways.On many common file systems, fallocate(2) offers a way to shorten files as long as the file is opened for writing, side-stepping the
LANDLOCK_ACCESS_FS_TRUNCATEright.Assisted-by Gemini-CLI:gemini-3.1Signed-off-by Günther Noack <[email protected]>--- Documentation/userspace-api/landlock.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)Documentation/userspace-api/landlock.rst +2
-2@@ -378,8 +378,8 @@ Truncating files The operations covered by ``LANDLOCK_ACCESS_FS_WRITE_FILE`` and ``LANDLOCK_ACCESS_FS_TRUNCATE`` both change the contents of a file and sometimes -overlap in non-intuitive ways. It is recommended to always specify both of -these together. +overlap in non-intuitive ways. It is strongly recommended to always specify +both of these together (either granting both, or granting none). A particularly surprising example is :manpage:`creat(2)`. The name suggests that this system call requires the rights to create and write files. However,@@ -391,6 +391,10 @@ It should also be noted that truncating files does not require the system call, this can also be done through :manpage:`open(2)` with the flags ``O_RDONLY | O_TRUNC``.Quoted 6 lines
Documentation/userspace-api/landlock.rst It should also be noted that truncating files does not require the · line 396
Quoted 3 lines
Documentation/userspace-api/landlock.rst +3
-0+At the same time, on some filesystems, :manpage:`fallocate(2)` offers a way to +shorten file contents with ``FALLOC_FL_COLLAPSE_RANGE`` when the file is opened +for writing, sidestepping the ``LANDLOCK_ACCESS_FS_TRUNCATE`` right.Interesting, which filesystems? Shouldn't it be fixed in the code instead?
It works on ext4, and I also see mentions of
FALLOC_FL_COLLAPSE_RANGEin XFS, F2FS, SMB and NTFS3.I should mention, it is not *exactly* the same as a truncation, but you can remove a chunk of the file from the middle, which also leads to a shorter file. For example, assuming a block size of 1024:
1. Make a file with 2*1024 bytes: 1024*'A', then 1024*'B'
2.fallocate(collapse range, 0, 1024)Resulting file is 1024*'B', and the file is shortened to 1024 bytes.
So this is not *exactly* a truncation. (The man page says that an attempt to remove the end of a file results in EINVAL, so you have to take it from the middle, and it needs to align with block boundaries.)
But it's quite similar, also shortens the file, and it does not require the Landlock truncation access right.
I agree, another way would potentially be to call the LSM ftruncate hook. I suspect this would stay compatible with other LSMs, because the LSM ftruncate hook is a relatively recent addition (but have not checked in detail).
Quoted 8 lines
The implementation of fallocate is
vfs_fallocate()infs/open.c- I only had a tentative look now; it checks that thefile->f_modeis open for writing and callssecurity_file_permission()withMAY_WRITE.I always saw
LANDLOCK_ACCESS_FS_WRITE_FILEandLANDLOCK_ACCESS_FS_TRUNCATEas rights that should always go together, so I suspect that it does not make a big difference in practice, and that is why I am suggesting to just document it more clearly for now.
OK, I agree, I'll take this patch. Thanks!
Quoted 3 lines
—Günther