2 .\" Copyright (c) 2005 Robert N. M. Watson
3 .\" Copyright (c) 2008 Apple Inc.
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd "retrieve audit session state"
37 .Fn getaudit "auditinfo_t *auditinfo"
39 .Fn getaudit_addr "auditinfo_addr_t *auditinfo_addr" "u_int length"
44 retrieves the active audit session state for the current process via the
51 retrieves extended state via
58 data structure is defined as follows:
59 .Bd -literal -offset indent
61 au_id_t ai_auid; /* Audit user ID */
62 au_mask_t ai_mask; /* Audit masks */
63 au_tid_t ai_termid; /* Terminal ID */
64 au_asid_t ai_asid; /* Audit session ID */
65 au_asflgs_t ai_flags; /* Audit session flags. */
67 typedef struct auditinfo auditinfo_t;
72 variable contains the audit identifier which is recorded in the audit log for
73 each event the process caused.
77 data structure defines the bit mask for auditing successful and failed events
78 out of the predefined list of event classes.
79 It is defined as follows:
80 .Bd -literal -offset indent
82 unsigned int am_success; /* success bits */
83 unsigned int am_failure; /* failure bits */
85 typedef struct au_mask au_mask_t;
90 data structure defines the Terminal ID recorded with every event caused by the
92 It is defined as follows:
93 .Bd -literal -offset indent
98 typedef struct au_tid au_tid_t;
103 variable contains the audit session ID which is recorded with every event
104 caused by the process.
111 data structure and supports Terminal IDs with larger addresses
112 such as those used in IP version 6.
113 It is defined as follows:
114 .Bd -literal -offset indent
115 struct auditinfo_addr {
116 au_id_t ai_auid; /* Audit user ID. */
117 au_mask_t ai_mask; /* Audit masks. */
118 au_tid_addr_t ai_termid; /* Terminal ID. */
119 au_asid_t ai_asid; /* Audit session ID. */
121 typedef struct auditinfo_addr auditinfo_addr_t;
126 data structure which includes a larger address storage field and an additional
127 field with the type of address stored:
128 .Bd -literal -offset indent
132 u_int32_t at_addr[4];
134 typedef struct au_tid_addr au_tid_addr_t;
137 These system calls require an appropriate privilege to complete.
139 .Rv -std getaudit getaudit_addr
143 function will fail if:
146 A failure occurred while data transferred to or from
149 Illegal argument was passed by a system call.
151 The process does not have sufficient permission to complete
156 argument indicates an overflow condition will occur.
158 The address is too big and, therefore,
160 should be used instead.
170 The OpenBSM implementation was created by McAfee Research, the security
171 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
172 It was subsequently adopted by the TrustedBSD Project as the foundation for
173 the OpenBSM distribution.
176 This software was created by McAfee Research, the security research division
177 of McAfee, Inc., under contract to Apple Computer Inc.
178 Additional authors include
183 The Basic Security Module (BSM) interface to audit records and audit event
184 stream format were defined by Sun Microsystems.
186 This manual page was written by
187 .An Robert Watson Aq rwatson@FreeBSD.org .