audit: add documentation for /proc/PID/stable interfaces
v2 cover audit: add documentation for /proc/PID/stable interfaces
Add Documentation/ABI entries for audit interfaces in /proc/PID/ that have been stable for more than a decade.
Richard Guy Briggs (2):
audit: document /proc/PID/loginuid
audit: document /proc/PID/sessionid
.../ABI/stable/procfs-audit_loginuid | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 Documentation/ABI/stable/procfs-audit_loginuid
Signature · 6 lines
2.27.0 -- Linux-audit mailing list [email protected] https://listman.redhat.com/mailman/listinfo/linux-audit
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")
--- Documentation/ABI/stable/procfs-audit_loginuid | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 Documentation/ABI/stable/procfs-audit_loginuid
Documentation/ABI/stable/procfs-audit_loginuid new file +15 -0
@@ -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. +
Signature · 6 lines
2.27.0 -- Linux-audit mailing list [email protected] https://listman.redhat.com/mailman/listinfo/linux-audit
PATCH v2 2/2 audit: document /proc/PID/sessionid
In reply to Richard Guy BriggsDescribe the /proc/PID/loginuid interface in Documentation/ABI/stable that was added 2008-03-13 in commit 1e0bd7550ea9 ("[PATCH] export sessionid alongside the loginuid in procfs")
--- Documentation/ABI/stable/procfs-audit_loginuid | 12 ++++++++++++ 1 file changed, 12 insertions(+)
Documentation/ABI/stable/procfs-audit_loginuid +12 -0
@@ -13,3 +13,15 @@ Description: AUDIT_FEATURE_LOGINUID_IMMUTABLE is enabled. It cannot be unset if AUDIT_FEATURE_ONLY_UNSET_LOGINUID is enabled. + +What: Audit Login Session ID +Date: 2008-03-13 +KernelVersion: 2.6.25-rc7 1e0bd7550ea9 ("[PATCH] export sessionid alongside the loginuid in procfs") +Contact: [email protected] +Format: %u (u32) +Users: auditd, libaudit, audit-testsuite, login +Description: + The /proc/$pid/sessionid pseudofile is read to get the + audit login session ID of process $pid. It is set + automatically, serially assigned with each new login. +
Signature · 6 lines
2.27.0 -- Linux-audit mailing list [email protected] https://listman.redhat.com/mailman/listinfo/linux-audit
Re: [PATCH v2 1/2] audit: document /proc/PID/loginuid
In reply to Richard Guy BriggsQuoted 17 lines · Richard Guy Briggs
Describe the
/proc/PID/loginuidinterface inDocumentation/ABI/stablethat was added 2005-02-01 by commit1e2d1492e178("[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_loginuidDocumentation/ABI/stable/procfs-audit_loginuid new file +0
-0
Documentation/ABI/stable/procfs-audit_loginuid line 5
Quoted 5 lines
Documentation/ABI/stable/procfs-audit_loginuid new file +5
-0@@ -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.
Documentation/ABI/stable/procfs-audit_loginuid line 6
Quoted 1 line
Documentation/ABI/stable/procfs-audit_loginuid new file +1
-0+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
www.paul-moore.com
--
Linux-audit mailing list
[email protected]
https://listman.redhat.com/mailman/listinfo/linux-audit
Re: [PATCH v2 2/2] audit: document /proc/PID/sessionid
In reply to Richard Guy BriggsQuoted 9 lines · Richard Guy Briggs
Describe the
/proc/PID/loginuidinterface inDocumentation/ABI/stablethat was added 2008-03-13 in commit1e0bd7550ea9("[PATCH] export sessionid alongside the loginuid in procfs")Signed-off-by Richard Guy Briggs <[email protected]>--- Documentation/ABI/stable/procfs-audit_loginuid | 12 ++++++++++++ 1 file changed, 12 insertions(+)
The same comments from patch 1/2 apply here.
Quoted 20 lines
Documentation/ABI/stable/procfs-audit_loginuid +12
-0@@ -13,3 +13,15 @@ Description: AUDIT_FEATURE_LOGINUID_IMMUTABLE is enabled. It cannot be unset if AUDIT_FEATURE_ONLY_UNSET_LOGINUID is enabled. + +What: Audit Login Session ID +Date: 2008-03-13 +KernelVersion: 2.6.25-rc7 1e0bd7550ea9 ("[PATCH] export sessionid alongside the loginuid in procfs") +Contact: [email protected] +Format: %u (u32) +Users: auditd, libaudit, audit-testsuite, login +Description: + The /proc/$pid/sessionid pseudofile is read to get the + audit login session ID of process $pid. It is set + automatically, serially assigned with each new login. +
Signature · 7 lines
paul moore www.paul-moore.com -- Linux-audit mailing list [email protected] https://listman.redhat.com/mailman/listinfo/linux-audit