GETAUDIT(2)

💅 GETAUDIT(2) — like, the system calls manual, bestie 💖

okay so picture this: it's the System Calls Manual chapter, and we're about to get deep into audit session state. strap in 🎀

---

✨ NAME ✨

getaudit, getaudit_addr — retrieve audit session state

like, they go get the audit session state for you. that's the whole vibe. 🦋

---

🌸 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 retrieves the active audit session state for the current process, and it does that via the auditinfo_t that auditinfo points at. meanwhile getaudit_addr() retrieves the extended state via auditinfo_addr and length. two sisters, different jobs, both iconic. 👑

the auditinfo_t data structure is defined like this:

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 */
};
typedef struct auditinfo        auditinfo_t;

the ai_auid variable contains the audit identifier which gets recorded in the audit log for each event the process caused. it's giving "your permanent record" ngl 😭

the au_mask_t data structure defines the bit mask for auditing successful and failed events out of the predefined list of event classes. here's the tea:

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 caused by the process. look at her:

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, which is recorded with every event caused by the process. main character identifier fr fr ✨

okay now the getaudit_addr() system call — she uses the expanded auditinfo_addr_t data structure and supports Terminal IDs with larger addresses, such as those used in IP version 6. glow-up confirmed 💅

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 larger address storage field plus an additional field with the type of address stored:

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 🔥

getaudit() and getaudit_addr() return the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error. classic. 😌

---

💀 ERRORS 💀

the getaudit() function will fail if:

• [EFAULT] — a failure occurred while data transferred to or from the kernel failed. rude, honestly.
• [EINVAL] — illegal argument was passed by a system call. not her fault, she's just the messenger 🙈
• [EPERM] — the process does not have sufficient permission to complete the operation. permission denied, bestie, it happens to the best of us.
• [EOVERFLOW] — the length argument indicates an overflow condition will occur.
• [E2BIG] — the address is too big and, therefore, getaudit_addr() should be used instead. read the room, use the other one. 💀

---

👀 SEE ALSO 👀

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

go read those next, iykyk 🌈

---

🧚 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. a whole origin story, honestly. 🌟

---

🍓 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. respect the elders. 👑

this manual page was written by Robert Watson <rwatson@FreeBSD.org>. ty for your service king 🫶

---

and that's the whole page, bestie! 💜 this lil masterpiece is from the Debian edition, dated October 19, 2008 — yes she's an icon and yes she's been iconic since '08. periodt. ✨🎀