GETAUDIT(2)

👑 GETAUDIT(2) — the getaudit girlies' guide 💅

okay so real talk, this is the getaudit / getaudit_addr page from section 2 of the manual (that's system calls, bestie — kernel territory 👀), and it's literally just about peeking at your audit session state. no cap.

---

✨ NAME ✨

getaudit, getaudit_addr — retrieve audit session state 🕵️‍♀️

---

🌸 SYNOPSIS 🌸

#include <bsm/audit.h>

int
getaudit(auditinfo_t *auditinfo);

int
getaudit_addr(auditinfo_addr_t *auditinfo_addr, u_int length);

---

💖 DESCRIPTION 💖

so the getaudit() system call grabs the active audit session state for the current process, and it drops it into the auditinfo_t that auditinfo points at 🎀. meanwhile getaudit_addr() gets you the extended state — via auditinfo_addr and length.

the auditinfo_t data structure is defined like this, bestie:

struct auditinfo {
        au_id_t        ai_auid;         /* Audit user ID */
        au_mask_t      ai_mask;         /* Audit masks */
        au_tid_t       ai_termid;       /* Terminal ID */
        au_asid_t      ai_asid;         /* Audit session ID */
        au_asflgs_t    ai_flags;        /* Audit session flags. */
};
typedef struct auditinfo        auditinfo_t;

the ai_auid variable holds the audit identifier, and like… this is the thing that gets recorded in the audit log for every single event the process caused. main character behaviour honestly 📝.

the au_mask_t data structure defines the bit mask for auditing successful and failed events, pulled out of the predefined list of event classes. it looks like:

struct au_mask {
        unsigned int    am_success;     /* success bits */
        unsigned int    am_failure;     /* failure bits */
};
typedef struct au_mask  au_mask_t;

the au_termid_t data structure defines the Terminal ID that gets recorded with every event the process causes. defined as:

struct au_tid {
        dev_t           port;
        u_int32_t       machine;
};
typedef struct au_tid   au_tid_t;

the ai_asid variable contains the audit session ID, and that one is recorded with every event the process causes too 🫶.

now, getaudit_addr() uses the expanded auditinfo_addr_t data structure and it supports Terminal IDs with larger addresses, like the ones used in IP version 6 🌈. it's defined as:

struct auditinfo_addr {
        au_id_t         ai_auid;        /* Audit user ID. */
        au_mask_t       ai_mask;        /* Audit masks. */
        au_tid_addr_t   ai_termid;      /* Terminal ID. */
        au_asid_t       ai_asid;        /* Audit session ID. */
};
typedef struct auditinfo_addr   auditinfo_addr_t;

and the au_tid_addr_t data structure — which includes a bigger address storage field plus an extra field holding the type of address stored — goes like:

struct au_tid_addr {
        dev_t           at_port;
        u_int32_t       at_type;
        u_int32_t       at_addr[4];
};
typedef struct au_tid_addr      au_tid_addr_t;

⚠️ heads up bestie: these system calls require an appropriate privilege to complete. no privilege, no vibes. 🔒

---

⭐ RETURN VALUES ⭐

the getaudit() and getaudit_addr() functions return the value 0 if successful 🎉; otherwise the value -1 is returned and the global variable errno is set to indicate the error. yeah. sad girl hours 😭.

---

💀 ERRORS 💀

the getaudit() function will fail if:

• [EFAULT] — a failure occurred while data transferred to or from the kernel failed 🙈
• [EINVAL] — an illegal argument was passed by a system call
• [EPERM] — the process does not have sufficient permission to complete the operation 🔒
• [EOVERFLOW] — the length argument indicates an overflow condition will occur
• [E2BIG] — the address is too big and, therefore, getaudit_addr() should be used instead 👀

---

🦋 SEE ALSO 🦋

audit(2), auditon(2), getauid(2), setaudit(2), setauid(2), libbsm(3)

---

🧚 HISTORY 🧚

the OpenBSM implementation was created by McAfee Research, the security division of McAfee Inc., under contract to Apple Computer Inc. in 2004 ⏳. it was subsequently adopted by the TrustedBSD Project as the foundation for the OpenBSM distribution. iconic lineage fr fr 👑

---

💜 AUTHORS 💜

this software was created by McAfee Research, the security research division of McAfee, Inc., under contract to Apple Computer Inc. additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.

the Basic Security Module (BSM) interface to audit records and audit event stream format were defined by Sun Microsystems ☀️.

this manual page was written by Robert Watson <rwatson@FreeBSD.org> 🫶.

---

and that's the whole page, bestie — brought to you by the Debian crew, dated March 14, 2018. go get that audit state 💅✨🎀