From: "Günther Noack" <gnoack@google.com>
To: Alejandro Colomar <alx@kernel.org>
Cc: "Mickaël Salaün" <mic@digikod.net>,
"Konstantin Meskhidze" <konstantin.meskhidze@huawei.com>,
linux-man@vger.kernel.org, "Günther Noack" <gnoack@google.com>
Subject: [PATCH v2 2/5] landlock_create_ruleset.2: Update docs for landlock_ruleset_attr
Date: Fri, 19 Jul 2024 13:37:59 +0000 [thread overview]
Message-ID: <20240719133801.3541732-4-gnoack@google.com> (raw)
In-Reply-To: <20240719133801.3541732-2-gnoack@google.com>
This updates the documentation for struct landlock_ruleset_attr
in line with the changed kernel documentation (see link below).
Cc: Alejandro Colomar <alx@kernel.org>
Link: https://lore.kernel.org/all/20240711165456.2148590-2-gnoack@google.com/
Reviewed-by: Mickaël Salaün <mic@digikod.net>
Signed-off-by: Günther Noack <gnoack@google.com>
---
man/man2/landlock_create_ruleset.2 | 34 ++++++++++++++++++++++++++++--
1 file changed, 32 insertions(+), 2 deletions(-)
diff --git a/man/man2/landlock_create_ruleset.2 b/man/man2/landlock_create_ruleset.2
index 871b91dcb..105e9b062 100644
--- a/man/man2/landlock_create_ruleset.2
+++ b/man/man2/landlock_create_ruleset.2
@@ -51,8 +51,38 @@ is a bitmask of handled filesystem actions
.B Filesystem actions
in
.BR landlock (7)).
-This enables simply restricting ambient rights
-(e.g., global filesystem access) and is needed for compatibility reasons.
+.IP
+This structure defines a set of
+.IR "handled access rights" ,
+a set of actions on different object types,
+which should be denied by default
+when the ruleset is enacted.
+Vice versa,
+access rights that are not specifically listed here
+are not going to be denied by this ruleset when it is enacted.
+.IP
+For historical reasons, the
+.B LANDLOCK_ACCESS_FS_REFER
+right is always denied by default,
+even when its bit is not set in
+.IR handled_access_fs .
+In order to add new rules with this access right,
+the bit must still be set explicitly
+(see
+.B Filesystem actions
+in
+.BR landlock (7)).
+.IP
+The explicit listing of
+.I handled access rights
+is required for backwards compatibility reasons.
+In most use cases,
+processes that use Landlock will
+.I handle
+a wide range or all access rights that they know about at build time
+(and that they have tested with a kernel that supported them all).
+.IP
+This structure can grow in future Landlock versions.
.P
.I size
must be specified as
--
2.45.2.1089.g2a221341d9-goog
next prev parent reply other threads:[~2024-07-19 13:38 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-19 13:37 [PATCH v2 0/5] landlock*: Bring documentation up to date Günther Noack
2024-07-19 13:37 ` [PATCH v2 1/5] landlock.7, landlock_*.2: wfix Günther Noack
2024-07-22 20:52 ` Alejandro Colomar
2024-07-19 13:37 ` Günther Noack [this message]
2024-07-22 20:49 ` [PATCH v2 2/5] landlock_create_ruleset.2: Update docs for landlock_ruleset_attr Alejandro Colomar
2024-07-19 13:38 ` [PATCH v2 3/5] landlock_add_rule.2: Document missing reason for EINVAL Günther Noack
2024-07-19 13:38 ` [PATCH v2 4/5] landlock.7, landlock_*.2: Document Landlock ABI version 4 Günther Noack
2024-07-22 21:00 ` Alejandro Colomar
2024-07-23 10:24 ` Günther Noack
2024-07-19 13:38 ` [PATCH v2 5/5] landlock.7: Document Landlock ABI version 5 (IOCTL) Günther Noack
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240719133801.3541732-4-gnoack@google.com \
--to=gnoack@google.com \
--cc=alx@kernel.org \
--cc=konstantin.meskhidze@huawei.com \
--cc=linux-man@vger.kernel.org \
--cc=mic@digikod.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox