1 .\" Copyright (c) 2004-2009 Apple Inc.
2 .\" Copyright (c) 2006 Robert N. M. Watson
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. Neither the name of Apple Inc. ("Apple") nor the names of
14 .\" its contributors may be used to endorse or promote products derived
15 .\" from this software without specific prior written permission.
17 .\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
21 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 .\" POSSIBILITY OF SUCH DAMAGE.
34 .Nd "audit system parameters"
38 file contains several audit system parameters.
39 Each line of this file is of the form:
41 .D1 Ar parameter Ns : Ns Ar value
44 .Bl -tag -width indent
46 The directory where audit log files are stored.
47 There may be more than one of these entries.
48 Changes to this entry can only be enacted by restarting the
52 for a description of how to restart the audit system.
59 will be creating hardlinks to all trail files in
62 Those hardlinks will be consumed by the
66 Specifies which audit event classes are audited for all users.
68 describes how to audit events for individual users.
69 See the information below for the format of the audit flags.
71 Specify the hostname or IP address to be used when setting the local
72 systems's audit host information.
73 This hostname will be converted into an IP or IPv6 address and will
74 be included in the header of each audit record.
75 Due to the possibility of transient errors coupled with the
76 security issues in the DNS protocol itself, the use of DNS
78 Instead, it is strongly recommended that the hostname be
79 specified in the /etc/hosts file.
80 For more information see
83 Contains the audit flags that define what classes of events are audited when
84 an action cannot be attributed to a specific user.
86 The minimum free space required on the file system audit logs are being written to.
87 When the free space falls below this limit a warning will be issued.
88 If no value for the minimum free space is set, the default of 20 percent is
89 applied by the kernel.
91 A list of global audit policy flags specifying various behaviors, such as
92 fail stop, auditing of paths and arguments, etc.
94 Maximum trail size in bytes; if set to a non-0 value, the audit daemon will
95 rotate the audit trail file at around this size.
96 Sizes less than the minimum trail size (default of 512K) will be rejected as
98 If 0, trail files will not be automatically rotated based on file size.
99 For convenience, the trail size may be expressed with suffix letters:
100 B (Bytes), K (Kilobytes), M (Megabytes), or G (Gigabytes).
101 For example, 2M is the same as 2097152.
103 Specifies when audit log files will expire and be removed.
104 This may be after a time period has passed since the file was last
105 written to or when the aggregate of all the trail files have reached a
106 specified size or a combination of both.
107 If no expire-after parameter is given then audit log files will not
108 expire and be removed by the audit control system.
109 See the information below for the format of the expiration
113 Audit flags are a comma-delimited list of audit classes as defined in the
116 Event classes may be preceded by a prefix which changes their interpretation.
117 The following prefixes may be used for each class:
119 .Bl -tag -width indent -compact -offset indent
121 Record both successful and failed events.
123 Record successful events.
125 Record failed events.
127 Record neither successful nor failed events.
129 Do not record successful events.
131 Do not record failed events.
133 .Sh AUDIT POLICY FLAGS
134 The policy flags field is a comma-delimited list of policy flags from the
137 .Bl -tag -width ".Cm zonename" -compact -offset indent
139 Allow processes to continue running even though events are not being audited.
140 If not set, processes will be suspended when the audit store space is
142 Currently, this is not a recoverable state.
144 Fail stop the system if unable to audit an event\[em]this consists of first
145 draining pending records to disk, and then halting the operating system.
147 Audit command line arguments to
150 Audit environmental variable arguments to
153 Include a unique audit sequence number token in generated audit records (not
158 Include supplementary groups list in generated audit records (not implemented
161 or Darwin; supplementary groups are never included in records on
164 Append a trailer token to each audit record (not implemented on
167 Darwin; trailers are always included in records on these systems).
169 Include secondary file paths in audit records (not implemented on
172 Darwin; secondary paths are never included in records on these systems).
174 Include a zone ID token with each audit record (not implemented on
179 audit records do not currently include the jail ID or name).
181 Enable auditing for each local zone (not implemented on
185 audit records are collected from all jails and placed in a single
186 global trail, and only limited audit controls are permitted within a jail).
189 It is recommended that installations set the
193 flag unless it is intended that audit logs exceeding available disk space
195 .Sh AUDIT LOG EXPIRATION SPECIFICATION
196 The expiration specification can be one value or two values with the
197 logical conjunction of AND/OR between them.
198 Values for the audit log file age are numbers with the following
201 .Bl -tag -width "(space) or" -compact -offset indent
203 Log file age in seconds.
205 Log file age in hours.
207 Log file age in days.
209 Log file age in years.
212 Values for the disk space used are numbers with the following suffixes:
214 .Bl -tag -width "(space) or" -compact -offset indent
217 Disk space used in Bytes.
219 Disk space used in Kilobytes.
221 Disk space used in Megabytes.
223 Disk space used in Gigabytes.
226 The suffixes on the values are case sensitive.
227 If both an age and disk space value are used they are separated by
228 AND or OR and both values are used to determine when audit
230 In the case of AND, both the age and disk space conditions must be met
231 before the log file is removed.
232 In the case of OR, either condition may expire the log file.
234 .Bd -literal -offset indent
235 expire-after: 60d AND 1G
238 will expire files that are older than 60 days but only if 1
239 gigabyte of disk space total is being used by the audit logs.
241 The following settings appear in the default
244 .Bd -literal -offset indent
256 parameter above specifies the system-wide mask corresponding to login/logout
257 as well as authentication and authorization events.
260 parameter specifies that the system should neither fail stop nor suspend
261 processes when the audit store fills and that command line arguments should
265 The trail file will be automatically rotated by the audit daemon when the
266 file size reaches approximately 2MB.
267 Trail files will expire when their aggregate size exceeds 10MB.
269 .Bl -tag -width ".Pa /etc/security/audit_control" -compact
270 .It Pa /etc/security/audit_control
281 The OpenBSM implementation was created by McAfee Research, the security
282 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
283 It was subsequently adopted by the TrustedBSD Project as the foundation for
284 the OpenBSM distribution.
287 This software was created by McAfee Research, the security research division
288 of McAfee, Inc., under contract to Apple Computer Inc.
289 Additional authors include
294 The Basic Security Module (BSM) interface to audit records and audit event
295 stream format were defined by Sun Microsystems.