--- name: "setaudit" section: "2" platform: "macos" package: "xnu" version: "12377.121.6" release: "macOS 26.5" platforms: ["freebsd", "macos"] url: "https://new.carta.tech/setaudit_addr" --- # setaudit(2) set audit session state Part of [setaudit\_addr(2)](/setaudit_addr/2.md). ## NAME **setaudit\_addr**, **setaudit(NOW** **DEPRECATED)** – set audit session state ## SYNOPSIS **#include \** **#include \** *int*\ **setaudit\_addr**(*auditinfo\_addr\_t \*auditinfo\_addr*, *u\_int length*); ## SYNOPSIS (NOW DEPRECATED) ⟨bsm/audit.h⟩ *int* **setaudit**(*auditinfo\_t \*auditinfo*) ## DESCRIPTION The **setaudit\_addr**() system call uses the *auditinfo\_addr\_t* data structure for the *auditinfo\_addr* argument which supports Terminal IDs with large addresses such as those used in IP version 6. It is defined as follows: ``` 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. */ u_int64_t ai_flags; /* Audit session flags */ }; typedef struct auditinfo_addr auditinfo_addr_t; ``` The *ai\_auid* variable contains the audit identifier which is recorded in the audit log for each event the process caused. The value of AU\_DEFAUDITID (-1) should not be used. The exception is if the value of audit identifier is known at the start of the session but will be determined and set later. Until *ai\_auid* is set to something other than AU\_DEFAUDITID any audit events generated by the system with be filtered by the non-attributed audit mask. The *au\_mask\_t* data structure defines the bit mask for auditing successful and failed events out of the predefined list of event classes. It is defined as follows: ``` struct au_mask { unsigned int am_success; /* success bits */ unsigned int am_failure; /* failure bits */ }; typedef struct au_mask au_mask_t; ``` The *au\_tid\_addr\_t* data structure includes a larger address storage field and 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; ``` The *ai\_asid* variable contains the audit session ID which is recorded with every event caused by the process. It can be any value in the range 1 to PID\_MAX (99999). If the value of AU\_ASSIGN\_ASID is used for *ai\_asid* a unique session ID will be generated by the kernel. The audit session ID will be returned in the *ai\_asid* field on success. The *ai\_flags* field is opaque to the kernel and can be used to store flags associated with the audit session. Please see the ⟨*bsm/audit\_session.h*⟩ header file for more information and flag definitions for this platform. The *setaudit\_addr* system call require an appropriate privilege to complete. This system call should only be called once at the start of a new session and not again during the same session to update the session information. There are some exceptions, however. The *ai\_auid* field may be updated later if initially set to the value of AU\_DEFAUDITID (-1). Likewise, the *ai\_termid* fields may be updated later if the *at\_type* field in *au\_tid\_addr* is set to AU\_IPv4 and the other *ai\_tid\_addr* fields are all set to zero. Creating a new session is done by setting the *ai\_asid* field to an unique session value or AU\_ASSIGN\_ASID. These system calls will fail when attempting to change the *ai\_auid* or *ai\_termid* fields once set to something other than the default values. The *ai\_flags* field may be updated only according to local access control policy but this is usually accomplished with [auditon(2)](/auditon/2.md) using the A\_SETSFLAGS command. The audit preselection masks may be changed at any time but are usually updated with [auditon(2)](/auditon/2.md) The **setaudit**() system call (NOW DEPRECATED) sets the active audit session state for the current process via the *auditinfo\_t* pointed to by *auditinfo*. The **setaudit\_addr**() system call sets extended state via *auditinfo\_addr* and *length*. The *auditinfo\_t* data structure (NOW DEPRECATED) is defined as follows: ``` 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 *au\_termid\_t* data structure (NOW DEPRECATED) defines the Terminal ID recorded with every event caused by the process. It is defined as follows: ``` struct au_tid { dev_t port; u_int32_t machine; }; typedef struct au_tid au_tid_t; ``` ## RETURN VALUES The **setaudit\_addr()** function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error. ## ERRORS - \[EFAULT\] A failure occurred while data transferred to or from the kernel failed. - \[EINVAL\] Illegal argument was passed by a system call. - \[EPERM\] The process does not have sufficient permission to complete the operation. ## SEE ALSO [audit(2)](/audit/2.md), [auditon(2)](/auditon/2.md), [getaudit(2)](/getaudit/2.md), [getauid(2)](/getauid/2.md), [setauid(2)](/setauid/2.md), [libbsm(3)](/libbsm/3.md) ## 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. **setaudit\_addr**() replaced **setaudit**() in Mac OS X 10.7 to support longer terminal addresses such as those used by IP version 6. **setaudit**() is now deprecated and **setaudit\_addr**() should be used instead. ## 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 Stacey Son ⟨sson@FreeBSD.org⟩.