Skip to contentSkip to conversation

audit: add documentation for /proc/PID/stable interfaces

PATCH Superseded Richard Guy Briggs 2 participants 6 messages Mar 11, 2021 – Mar 17, 2021

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

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 · 1 line
2.27.0
#1 lore raw

PATCH 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
new file mode 100664
index 000000000000..fae63bef2970
@@ -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:		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 · 1 line
2.27.0
#2 lore raw

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

Quoted 9 lines · Richard Guy Briggs

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

After ~15 years, it might be time ;)

Documentation/ABI/stable/procfs-audit_loginuid line 5

Quoted 11 lines
Documentation/ABI/stable/procfs-audit_loginuid new file +5 -0
new file mode 100664
index 000000000000..fae63bef2970
@@ -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:                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?

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

Documentation/ABI/stable/procfs-audit_loginuid line 8

Quoted 2 lines
Documentation/ABI/stable/procfs-audit_loginuid new file +2 -0
+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 ...".

Quoted 6 lines
Documentation/ABI/stable/procfs-audit_loginuid new file +6 -0
+               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 · 2 lines
paul moore
www.paul-moore.com
#3 lore raw

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

Quoted 13 lines · Paul Moore
Quoted 9 lines · Richard Guy Briggs

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

After ~15 years, it might be time ;)

Quoted 14 lines

Documentation/ABI/stable/procfs-audit_loginuid line 5

Quoted 11 lines
Documentation/ABI/stable/procfs-audit_loginuid new file +5 -0
new file mode 100664
index 000000000000..fae63bef2970
@@ -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:                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?

Yes, they do. I'm wondering if they should read instead "%u" since the internal kernel representation isn't as important as what format (number base) is expected and presented.

Quoted 5 lines

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

In other examples, users range from a description to an email address, to a URI, to a repository name or address, to a package name, to specific files. I'd prefer to be as specific as reasonably possible without going into gory detail.

Quoted 6 lines

Documentation/ABI/stable/procfs-audit_loginuid line 8

Quoted 2 lines
Documentation/ABI/stable/procfs-audit_loginuid new file +2 -0
+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 ...".

This would be the Oxford comma debate, and has a sronger preference by USA-ians that Brits. It can help disambiguate meaning in a list of three or more items.

Quoted 8 lines

Documentation/ABI/stable/procfs-audit_loginuid line 14

Quoted 6 lines
Documentation/ABI/stable/procfs-audit_loginuid new file +6 -0
+               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

- RGB

--
Richard Guy Briggs <[email protected]>
Sr. S/W Engineer, Kernel Security, Base Operating Systems Remote, Ottawa, Red Hat Canada
IRC: rgb, SunRaycer
Voice: +1.647.777.2635, Internal: (81) 32635

--
Linux-audit mailing list
[email protected]
https://listman.redhat.com/mailman/listinfo/linux-audit

#4 lore raw

PATCH 2/2 audit: document /proc/PID/sessionid

In reply to Richard Guy Briggs

Describe 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
index fae63bef2970..175ee6ec3695 100644
@@ -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:		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
#5 lore raw

Re: [PATCH 2/2] audit: document /proc/PID/sessionid

Quoted 15 lines · Richard Guy Briggs

Describe 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 +0 -0
index fae63bef2970..175ee6ec3695 100644

Documentation/ABI/stable/procfs-audit_loginuid Description: · line 22

Quoted 10 lines
Documentation/ABI/stable/procfs-audit_loginuid +7 -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:                u32
+Users:         auditd, libaudit, audit-testsuite, login

This should be obvious, but just to be safe - my comment from patch 1/2 also applies here.

Quoted 4 lines
Documentation/ABI/stable/procfs-audit_loginuid +4 -0
+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