1 .\" Copyright (c) 2004 Apple Computer, 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 Computer, 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.
29 .\" $P4: //depot/projects/trustedbsd/openbsm/man/audit_control.5#17 $
36 .Nd "audit system parameters"
40 file contains several audit system parameters.
41 Each line of this file is of the form:
43 .D1 Ar parameter Ns : Ns Ar value
46 .Bl -tag -width indent
48 The directory where audit log files are stored.
49 There may be more than one of these entries.
50 Changes to this entry can only be enacted by restarting the
54 for a description of how to restart the audit system.
56 Specifies which audit event classes are audited for all users.
58 describes how to audit events for individual users.
59 See the information below for the format of the audit flags.
61 Contains the audit flags that define what classes of events are audited when
62 an action cannot be attributed to a specific user.
64 The minimum free space required on the file system audit logs are being written to.
65 When the free space falls below this limit a warning will be issued.
66 Not currently used as the value of 20 percent is chosen by the kernel.
68 A list of global audit policy flags specifying various behaviors, such as
69 fail stop, auditing of paths and arguments, etc.
71 Maximum trail size in bytes; if set to a non-0 value, the audit daemon will
72 rotate the audit trail file at around this size.
73 Sizes less than the minimum trail size (default of 512K) will be rejected as
75 If 0, trail files will not be automatically rotated based on file size.
78 Audit flags are a comma-delimited list of audit classes as defined in the
81 Event classes may be preceded by a prefix which changes their interpretation.
82 The following prefixes may be used for each class:
84 .Bl -tag -width indent -compact -offset indent
86 Record both successful and failed events.
88 Record successful events.
92 Record neither successful nor failed events.
94 Do not record successful events.
96 Do not record failed events.
98 .Sh AUDIT POLICY FLAGS
99 The policy flags field is a comma-delimited list of policy flags from the
102 .Bl -tag -width ".Cm zonename" -compact -offset indent
104 Allow processes to continue running even though events are not being audited.
105 If not set, processes will be suspended when the audit store space is
107 Currently, this is not a recoverable state.
109 Fail stop the system if unable to audit an event\[em]this consists of first
110 draining pending records to disk, and then halting the operating system.
112 Audit command line arguments to
115 Audit environmental variable arguments to
118 Include a unique audit sequence number token in generated audit records (not
123 Include supplementary groups list in generated audit records (not implemented
126 or Darwin; supplementary groups are never included in records on
129 Append a trailer token to each audit record (not implemented on
132 Darwin; trailers are always included in records on these systems).
134 Include secondary file paths in audit records (not implemented on
137 Darwin; secondary paths are never included in records on these systems).
139 Include a zone ID token with each audit record (not implemented on
144 audit records do not currently include the jail ID or name).
146 Enable auditing for each local zone (not implemented on
150 audit records are collected from all jails and placed in a single
151 global trail, and only limited audit controls are permitted within a jail).
154 It is recommended that installations set the
158 flag unless it is intended that audit logs exceeding available disk space
161 The following settings appear in the default
164 .Bd -literal -offset indent
175 parameter above specifies the system-wide mask corresponding to login/logout
179 parameter specifies that the system should neither fail stop nor suspend
180 processes when the audit store fills.
181 The trail file will not be automatically rotated by the audit daemon based on
184 .Bl -tag -width ".Pa /etc/security/audit_control" -compact
185 .It Pa /etc/security/audit_control
195 The OpenBSM implementation was created by McAfee Research, the security
196 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
197 It was subsequently adopted by the TrustedBSD Project as the foundation for
198 the OpenBSM distribution.
201 This software was created by McAfee Research, the security research division
202 of McAfee, Inc., under contract to Apple Computer Inc.
203 Additional authors include
208 The Basic Security Module (BSM) interface to audit records and audit event
209 stream format were defined by Sun Microsystems.