1.\" Copyright (c) 2004 Apple Computer, Inc. 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of 13.\" its contributors may be used to endorse or promote products derived 14.\" from this software without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR 20.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 24.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 25.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26.\" POSSIBILITY OF SUCH DAMAGE. 27.\" 28.\" $P4: //depot/projects/trustedbsd/openbsm/man/audit_control.5#11 $ 29.\" 30.Dd January 4, 2006 31.Dt AUDIT_CONTROL 5 32.Os 33.Sh NAME 34.Nm audit_control 35.Nd "contains audit system parameters" 36.Sh DESCRIPTION 37The 38.Nm 39file contains several audit system parameters. 40Each line of this file is of the form: 41.Pp 42.Dl parameter:value 43.Pp 44The parameters are: 45.Bl -tag -width Ds 46.It Pa dir 47The directory where audit log files are stored. 48There may be more than one of these entries. 49Changes to this entry can only be enacted by restarting the 50audit system. 51See 52.Xr audit 1 53for a description of how to restart the audit system. 54.It Va flags 55Specifies which audit event classes are audited for all users. 56.Xr audit_user 5 57describes how to audit events for individual users. 58See the information below for the format of the audit flags. 59.It Va naflags 60Contains the audit flags that define what classes of events are audited when 61an action cannot be attributed to a specific user. 62.It Va minfree 63The minimum free space required on the file system audit logs are being written to. 64When the free space falls below this limit a warning will be issued. 65Not currently used as the value of 20 percent is chosen by the kernel. 66.It Va policy 67A list of global audit policy flags specifying various behaviors, such as 68fail stop, auditing of paths and arguments, etc. 69.El 70.Sh AUDIT FLAGS 71Audit flags are a comma-delimited list of audit classes as defined in the 72.Pa audit_class 73file. 74See 75.Xr audit_class 5 76for details. 77Event classes may be preceded by a prefix which changes their interpretation. 78The following prefixes may be used for each class: 79.Pp 80.Bl -tag -width Ds -compact -offset indent 81.It + 82Record successful events 83.It - 84Record failed events 85.It ^ 86Record both successful and failed events 87.It ^+ 88Do not record successful events 89.It ^- 90Do not record failed events 91.El 92.Sh AUDIT POLICY FLAGS 93The policy flags field is a comma-delimited list of policy flags from the 94following list: 95.Pp 96.Bl -tag -width zonename -compact -offset indent 97.It cnt 98Allow processes to continue running even though events are not being audited. 99If not set, processes will be suspended when the audit store space is 100exhausted. 101Currently, this is not a recoverable state. 102.It ahlt 103Fail stop the system if unable to audit an event--this consists of first 104draining pending records to disk, and then halting the operating system. 105.It argv 106Audit command line arguments to 107.Xr execve 2 . 108.It arge 109Audit environmental variable arguments to 110.Xr execve 2 . 111.It seq 112Include a unique audit sequence number token in generated audit records (not 113implemented on FreeBSD or Darwin). 114.It group 115Include supplementary groups list in generated audit records (not implemented 116on FreeBSD or Darwin; supplementary groups are never included in records on 117these systems). 118.It trail 119Append a trailer token to each audit record (not implemented on FreeBSD or 120Darwin; trailers are always included in records on these systems). 121.It path 122Include secondary file paths in audit records (not implemented on FreeBSD or 123Darwin; secondary paths are never included in records on these systems). 124.It zonename 125Include a zone ID token with each audit record (not implemented on FreeBSD or 126Darwin; FreeBSD audit records do not currently include the jail ID or name.) 127.It perzone 128Enable auditing for each local zone (not implemented on FreeBSD or Darwin; on 129FreeBSD, audit records are collected from all jails and placed in a single 130global trail, and only limited audit controls are permitted within a jail.) 131.El 132.Pp 133It is recommended that installations set the 134.Dv cnt 135flag but not 136.Dv ahlt 137flag unless it is intended that audit logs exceeding available disk space 138halt the system. 139.Sh DEFAULT 140The following settings appear in the default 141.Nm 142file: 143.Bd -literal -offset indent 144dir:/var/audit 145flags:lo 146minfree:20 147naflags:lo 148policy:cnt 149.Ed 150.Pp 151The 152.Va flags 153parameter above specifies the system-wide mask corresponding to login/logout 154events. 155The 156.Va policy 157parameter specifies that the system should neither fail stop nor suspend 158processes when the audit store fills. 159will be audited. 160.Sh FILES 161.Bl -tag -width "/etc/security/audit_control" -compact 162.It Pa /etc/security/audit_control 163.El 164.Sh SEE ALSO 165.Xr audit_class 5 , 166.Xr audit_user 5 , 167.Xr audit 8 , 168.Xr auditd 8 169.Sh AUTHORS 170This software was created by McAfee Research, the security research division 171of McAfee, Inc., under contract to Apple Computer Inc. 172Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc. 173.Pp 174The Basic Security Module (BSM) interface to audit records and audit event 175stream format were defined by Sun Microsystems. 176.Sh HISTORY 177The OpenBSM implementation was created by McAfee Research, the security 178division of McAfee Inc., under contract to Apple Computer Inc. in 2004. 179It was subsequently adopted by the TrustedBSD Project as the foundation for 180the OpenBSM distribution. 181