xref: /freebsd/contrib/openbsm/man/audit_control.5 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\" Copyright (c) 2004 Apple Computer, Inc.
2.\" Copyright (c) 2006 Robert N. M. Watson
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
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.
16.\"
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.
28.\"
29.\" $P4: //depot/projects/trustedbsd/openbsm/man/audit_control.5#17 $
30.\"
31.Dd January 4, 2006
32.Dt AUDIT_CONTROL 5
33.Os
34.Sh NAME
35.Nm audit_control
36.Nd "audit system parameters"
37.Sh DESCRIPTION
38The
39.Nm
40file contains several audit system parameters.
41Each line of this file is of the form:
42.Pp
43.D1 Ar parameter Ns : Ns Ar value
44.Pp
45The parameters are:
46.Bl -tag -width indent
47.It Va dir
48The directory where audit log files are stored.
49There may be more than one of these entries.
50Changes to this entry can only be enacted by restarting the
51audit system.
52See
53.Xr audit 8
54for a description of how to restart the audit system.
55.It Va flags
56Specifies which audit event classes are audited for all users.
57.Xr audit_user 5
58describes how to audit events for individual users.
59See the information below for the format of the audit flags.
60.It Va naflags
61Contains the audit flags that define what classes of events are audited when
62an action cannot be attributed to a specific user.
63.It Va minfree
64The minimum free space required on the file system audit logs are being written to.
65When the free space falls below this limit a warning will be issued.
66Not currently used as the value of 20 percent is chosen by the kernel.
67.It Va policy
68A list of global audit policy flags specifying various behaviors, such as
69fail stop, auditing of paths and arguments, etc.
70.It Va filesz
71Maximum trail size in bytes; if set to a non-0 value, the audit daemon will
72rotate the audit trail file at around this size.
73Sizes less than the minimum trail size (default of 512K) will be rejected as
74invalid.
75If 0, trail files will not be automatically rotated based on file size.
76.El
77.Sh AUDIT FLAGS
78Audit flags are a comma-delimited list of audit classes as defined in the
79.Xr audit_class 5
80file.
81Event classes may be preceded by a prefix which changes their interpretation.
82The following prefixes may be used for each class:
83.Pp
84.Bl -tag -width indent -compact -offset indent
85.It (none)
86Record both successful and failed events.
87.It Li +
88Record successful events.
89.It Li -
90Record failed events.
91.It Li ^
92Record neither successful nor failed events.
93.It Li ^+
94Do not record successful events.
95.It Li ^-
96Do not record failed events.
97.El
98.Sh AUDIT POLICY FLAGS
99The policy flags field is a comma-delimited list of policy flags from the
100following list:
101.Pp
102.Bl -tag -width ".Cm zonename" -compact -offset indent
103.It Cm cnt
104Allow processes to continue running even though events are not being audited.
105If not set, processes will be suspended when the audit store space is
106exhausted.
107Currently, this is not a recoverable state.
108.It Cm ahlt
109Fail stop the system if unable to audit an event\[em]this consists of first
110draining pending records to disk, and then halting the operating system.
111.It Cm argv
112Audit command line arguments to
113.Xr execve 2 .
114.It Cm arge
115Audit environmental variable arguments to
116.Xr execve 2 .
117.It Cm seq
118Include a unique audit sequence number token in generated audit records (not
119implemented on
120.Fx
121or Darwin).
122.It Cm group
123Include supplementary groups list in generated audit records (not implemented
124on
125.Fx
126or Darwin; supplementary groups are never included in records on
127these systems).
128.It Cm trail
129Append a trailer token to each audit record (not implemented on
130.Fx
131or
132Darwin; trailers are always included in records on these systems).
133.It Cm path
134Include secondary file paths in audit records (not implemented on
135.Fx
136or
137Darwin; secondary paths are never included in records on these systems).
138.It Cm zonename
139Include a zone ID token with each audit record (not implemented on
140.Fx
141or
142Darwin;
143.Fx
144audit records do not currently include the jail ID or name).
145.It Cm perzone
146Enable auditing for each local zone (not implemented on
147.Fx
148or Darwin; on
149.Fx ,
150audit records are collected from all jails and placed in a single
151global trail, and only limited audit controls are permitted within a jail).
152.El
153.Pp
154It is recommended that installations set the
155.Cm cnt
156flag but not
157.Cm ahlt
158flag unless it is intended that audit logs exceeding available disk space
159halt the system.
160.Sh DEFAULT
161The following settings appear in the default
162.Nm
163file:
164.Bd -literal -offset indent
165dir:/var/audit
166flags:lo
167minfree:20
168naflags:lo
169policy:cnt
170filesz:0
171.Ed
172.Pp
173The
174.Va flags
175parameter above specifies the system-wide mask corresponding to login/logout
176events.
177The
178.Va policy
179parameter specifies that the system should neither fail stop nor suspend
180processes when the audit store fills.
181The trail file will not be automatically rotated by the audit daemon based on
182file size.
183.Sh FILES
184.Bl -tag -width ".Pa /etc/security/audit_control" -compact
185.It Pa /etc/security/audit_control
186.El
187.Sh SEE ALSO
188.Xr audit 4 ,
189.Xr audit_class 5 ,
190.Xr audit_event 5 ,
191.Xr audit_user 5 ,
192.Xr audit 8 ,
193.Xr auditd 8
194.Sh HISTORY
195The OpenBSM implementation was created by McAfee Research, the security
196division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
197It was subsequently adopted by the TrustedBSD Project as the foundation for
198the OpenBSM distribution.
199.Sh AUTHORS
200.An -nosplit
201This software was created by McAfee Research, the security research division
202of McAfee, Inc., under contract to Apple Computer Inc.
203Additional authors include
204.An Wayne Salamon ,
205.An Robert Watson ,
206and SPARTA Inc.
207.Pp
208The Basic Security Module (BSM) interface to audit records and audit event
209stream format were defined by Sun Microsystems.
210