[PATCH 1/2] audit: document /proc/PID/loginuid

[Paul Moore]

On Thu, Mar 11, 2021 at 11:41 AM Richard Guy Briggs <rgb at redhat.com> 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 <rgb at redhat.com>
> ---
>  Documentation/ABI/stable/procfs-audit_loginuid | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
>  create mode 100644 Documentation/ABI/stable/procfs-audit_loginuid

After ~15 years, it might be time ;)

> diff --git a/Documentation/ABI/stable/procfs-audit_loginuid b/Documentation/ABI/stable/procfs-audit_loginuid
> new file mode 100664
> index 000000000000..fae63bef2970
> --- /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:       linux-audit at redhat.com
> +Format:                u32

I haven't applied the patch, but I'm going to assume that the "u32"
lines up correctly with the rest of the entries, right?

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

I think these entries are a bit too specific as I expect the kernel to
outlive most userspace libraries and applications.  I would suggest
"audit and login applications" or something similar.

> +Description:
> +               The /proc/$pid/loginuid pseudofile is written to set and

I'm really in no position to critique someone's English grammar, but
if we're talking about changes I might add a comma after "set", "...
is written to set, and read to get ...".

> +               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.

-- 
paul moore
www.paul-moore.com