2021-03-18 01:57:53

by Richard Guy Briggs

[permalink] [raw]
Subject: [PATCH v2 1/2] audit: document /proc/PID/loginuid

Describe the /proc/PID/loginuid interface in Documentation/ABI/stable that
was added 2005-02-01 by commit 1e2d1492e178 ("[PATCH] audit: handle
loginuid through proc")

Signed-off-by: Richard Guy Briggs <[email protected]>
---
Documentation/ABI/stable/procfs-audit_loginuid | 15 +++++++++++++++
1 file changed, 15 insertions(+)
create mode 100644 Documentation/ABI/stable/procfs-audit_loginuid

diff --git a/Documentation/ABI/stable/procfs-audit_loginuid b/Documentation/ABI/stable/procfs-audit_loginuid
new file mode 100644
index 000000000000..013bc1d74854
--- /dev/null
+++ b/Documentation/ABI/stable/procfs-audit_loginuid
@@ -0,0 +1,15 @@
+What: Audit Login UID
+Date: 2005-02-01
+KernelVersion: 2.6.11-rc2 1e2d1492e178 ("[PATCH] audit: handle loginuid through proc")
+Contact: [email protected]
+Format: %u (u32)
+Users: auditd, libaudit, audit-testsuite, login
+Description:
+ The /proc/$pid/loginuid pseudofile is written to set and
+ read to get the audit login UID of process $pid. If it is
+ unset, permissions are not needed to set it. The accessor must
+ have CAP_AUDIT_CONTROL in the initial user namespace to write
+ it if it has been set. It cannot be written again if
+ AUDIT_FEATURE_LOGINUID_IMMUTABLE is enabled. It cannot be
+ unset if AUDIT_FEATURE_ONLY_UNSET_LOGINUID is enabled.
+
--
2.27.0


2021-03-18 19:07:52

by Paul Moore

[permalink] [raw]
Subject: Re: [PATCH v2 1/2] audit: document /proc/PID/loginuid

On Wed, Mar 17, 2021 at 9:51 PM Richard Guy Briggs <[email protected]> wrote:
>
> Describe the /proc/PID/loginuid interface in Documentation/ABI/stable that
> was added 2005-02-01 by commit 1e2d1492e178 ("[PATCH] audit: handle
> loginuid through proc")
>
> Signed-off-by: Richard Guy Briggs <[email protected]>
> ---
> Documentation/ABI/stable/procfs-audit_loginuid | 15 +++++++++++++++
> 1 file changed, 15 insertions(+)
> create mode 100644 Documentation/ABI/stable/procfs-audit_loginuid
>
> diff --git a/Documentation/ABI/stable/procfs-audit_loginuid b/Documentation/ABI/stable/procfs-audit_loginuid
> new file mode 100644
> index 000000000000..013bc1d74854
> --- /dev/null
> +++ b/Documentation/ABI/stable/procfs-audit_loginuid
> @@ -0,0 +1,15 @@
> +What: Audit Login UID
> +Date: 2005-02-01
> +KernelVersion: 2.6.11-rc2 1e2d1492e178 ("[PATCH] audit: handle loginuid through proc")
> +Contact: [email protected]
> +Format: %u (u32)

Existing examples seem to just use the printf format specifier, e.g.
"%u", without the explicit type, e.g. "u32", which seems cleanest to
me. I would suggest changing this to just "Format: %u" to better fit
existing convention.

> +Users: auditd, libaudit, audit-testsuite, login

I didn't get an opportunity to reply to the previous thread before you
sent this, but I really don't like listing specific userspace
tools/libraries here. I recognize that you like the specificity, but
I do not, and I fear that it will become invalid over time either due
to deprecation of old packages or omission of new ones; the fact that
we are just now adding an entry from 2005 shows how this area of
Documentation can often be neglected.

Please replace this with something like "audit and login applications"
or something similar.

--
paul moore
http://www.paul-moore.com