1.\" Copyright (c) 2004 Apple 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 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#20 $ 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 host 61Specify the hostname or IP address to be used when setting the local 62systems's audit host information. 63This hostname will be converted into an IP or IPv6 address and will 64be included in the header of each audit record. 65Due to the possibility of transient errors coupled with the 66security issues in the DNS protocol itself, the use of DNS 67should be avoided. 68Instead, it is strongly recommended that the hostname be 69specified in the /etc/hosts file. 70For more information see 71.Xr hosts 5 . 72.It Va naflags 73Contains the audit flags that define what classes of events are audited when 74an action cannot be attributed to a specific user. 75.It Va minfree 76The minimum free space required on the file system audit logs are being written to. 77When the free space falls below this limit a warning will be issued. 78If no value for the minimum free space is set, the default of 20 percent is 79applied by the kernel. 80.It Va policy 81A list of global audit policy flags specifying various behaviors, such as 82fail stop, auditing of paths and arguments, etc. 83.It Va filesz 84Maximum trail size in bytes; if set to a non-0 value, the audit daemon will 85rotate the audit trail file at around this size. 86Sizes less than the minimum trail size (default of 512K) will be rejected as 87invalid. 88If 0, trail files will not be automatically rotated based on file size. 89.El 90.Sh AUDIT FLAGS 91Audit flags are a comma-delimited list of audit classes as defined in the 92.Xr audit_class 5 93file. 94Event classes may be preceded by a prefix which changes their interpretation. 95The following prefixes may be used for each class: 96.Pp 97.Bl -tag -width indent -compact -offset indent 98.It (none) 99Record both successful and failed events. 100.It Li + 101Record successful events. 102.It Li - 103Record failed events. 104.It Li ^ 105Record neither successful nor failed events. 106.It Li ^+ 107Do not record successful events. 108.It Li ^- 109Do not record failed events. 110.El 111.Sh AUDIT POLICY FLAGS 112The policy flags field is a comma-delimited list of policy flags from the 113following list: 114.Pp 115.Bl -tag -width ".Cm zonename" -compact -offset indent 116.It Cm cnt 117Allow processes to continue running even though events are not being audited. 118If not set, processes will be suspended when the audit store space is 119exhausted. 120Currently, this is not a recoverable state. 121.It Cm ahlt 122Fail stop the system if unable to audit an event\[em]this consists of first 123draining pending records to disk, and then halting the operating system. 124.It Cm argv 125Audit command line arguments to 126.Xr execve 2 . 127.It Cm arge 128Audit environmental variable arguments to 129.Xr execve 2 . 130.It Cm seq 131Include a unique audit sequence number token in generated audit records (not 132implemented on 133.Fx 134or Darwin). 135.It Cm group 136Include supplementary groups list in generated audit records (not implemented 137on 138.Fx 139or Darwin; supplementary groups are never included in records on 140these systems). 141.It Cm trail 142Append a trailer token to each audit record (not implemented on 143.Fx 144or 145Darwin; trailers are always included in records on these systems). 146.It Cm path 147Include secondary file paths in audit records (not implemented on 148.Fx 149or 150Darwin; secondary paths are never included in records on these systems). 151.It Cm zonename 152Include a zone ID token with each audit record (not implemented on 153.Fx 154or 155Darwin; 156.Fx 157audit records do not currently include the jail ID or name). 158.It Cm perzone 159Enable auditing for each local zone (not implemented on 160.Fx 161or Darwin; on 162.Fx , 163audit records are collected from all jails and placed in a single 164global trail, and only limited audit controls are permitted within a jail). 165.El 166.Pp 167It is recommended that installations set the 168.Cm cnt 169flag but not 170.Cm ahlt 171flag unless it is intended that audit logs exceeding available disk space 172halt the system. 173.Sh DEFAULT 174The following settings appear in the default 175.Nm 176file: 177.Bd -literal -offset indent 178dir:/var/audit 179flags:lo 180minfree:20 181naflags:lo 182policy:cnt 183filesz:0 184.Ed 185.Pp 186The 187.Va flags 188parameter above specifies the system-wide mask corresponding to login/logout 189events. 190The 191.Va policy 192parameter specifies that the system should neither fail stop nor suspend 193processes when the audit store fills. 194The trail file will not be automatically rotated by the audit daemon based on 195file size. 196.Sh FILES 197.Bl -tag -width ".Pa /etc/security/audit_control" -compact 198.It Pa /etc/security/audit_control 199.El 200.Sh SEE ALSO 201.Xr auditon 2 , 202.Xr audit 4 , 203.Xr audit_class 5 , 204.Xr audit_event 5 , 205.Xr audit_user 5 , 206.Xr audit 8 , 207.Xr auditd 8 208.Sh HISTORY 209The OpenBSM implementation was created by McAfee Research, the security 210division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004. 211It was subsequently adopted by the TrustedBSD Project as the foundation for 212the OpenBSM distribution. 213.Sh AUTHORS 214.An -nosplit 215This software was created by McAfee Research, the security research division 216of McAfee, Inc., under contract to Apple Computer Inc. 217Additional authors include 218.An Wayne Salamon , 219.An Robert Watson , 220and SPARTA Inc. 221.Pp 222The Basic Security Module (BSM) interface to audit records and audit event 223stream format were defined by Sun Microsystems. 224