contrib/openbsm/man/audit_control.5

   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#13 $
  30 .\"
  31 .Dd January 4, 2006
  32 .Dt AUDIT_CONTROL 5
  33 .Os
  34 .Sh NAME
  35 .Nm audit_control
  36 .Nd "contains audit system parameters"
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 file contains several audit system parameters.
  41 Each line of this file is of the form:
  42 .Pp
  43 .Dl parameter:value
  44 .Pp
  45 The parameters are:
  46 .Bl -tag -width Ds
  47 .It Pa dir
  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
  51 audit system.
  52 See
  53 .Xr audit 1
  54 for a description of how to restart the audit system.
  55 .It Va flags
  56 Specifies which audit event classes are audited for all users.
  57 .Xr audit_user 5
  58 describes how to audit events for individual users.
  59 See the information below for the format of the audit flags.
  60 .It Va naflags
  61 Contains the audit flags that define what classes of events are audited when
  62 an action cannot be attributed to a specific user.
  63 .It Va minfree
  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.
  67 .It Va policy
  68 A list of global audit policy flags specifying various behaviors, such as
  69 fail stop, auditing of paths and arguments, etc.
  70 .It Va filesz
  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
  74 invalid.
  75 If 0, trail files will not be automatically rotated based on file size.
  76 .El
  77 .Sh AUDIT FLAGS
  78 Audit flags are a comma-delimited list of audit classes as defined in the
  79 .Pa audit_class
  80 file.
  81 See
  82 .Xr audit_class 5
  83 for details.
  84 Event classes may be preceded by a prefix which changes their interpretation.
  85 The following prefixes may be used for each class:
  86 .Pp
  87 .Bl -tag -width Ds -compact -offset indent
  88 .It (none)
  89 Record both successful and failed events
  90 .It +
  91 Record successful events
  92 .It -
  93 Record failed events
  94 .It ^
  95 Record neither successful nor failed events
  96 .It ^+
  97 Do not record successful events
  98 .It ^-
  99 Do not record failed events
 100 .El
 101 .Sh AUDIT POLICY FLAGS
 102 The policy flags field is a comma-delimited list of policy flags from the
 103 following list:
 104 .Pp
 105 .Bl -tag -width zonename -compact -offset indent
 106 .It cnt
 107 Allow processes to continue running even though events are not being audited.
 108 If not set, processes will be suspended when the audit store space is
 109 exhausted.
 110 Currently, this is not a recoverable state.
 111 .It ahlt
 112 Fail stop the system if unable to audit an event--this consists of first
 113 draining pending records to disk, and then halting the operating system.
 114 .It argv
 115 Audit command line arguments to
 116 .Xr execve 2 .
 117 .It arge
 118 Audit environmental variable arguments to
 119 .Xr execve 2 .
 120 .It seq
 121 Include a unique audit sequence number token in generated audit records (not
 122 implemented on FreeBSD or Darwin).
 123 .It group
 124 Include supplementary groups list in generated audit records (not implemented
 125 on FreeBSD or Darwin; supplementary groups are never included in records on
 126 these systems).
 127 .It trail
 128 Append a trailer token to each audit record (not implemented on FreeBSD or
 129 Darwin; trailers are always included in records on these systems).
 130 .It path
 131 Include secondary file paths in audit records (not implemented on FreeBSD or
 132 Darwin; secondary paths are never included in records on these systems).
 133 .It zonename
 134 Include a zone ID token with each audit record (not implemented on FreeBSD or
 135 Darwin; FreeBSD audit records do not currently include the jail ID or name.)
 136 .It perzone
 137 Enable auditing for each local zone (not implemented on FreeBSD or Darwin; on
 138 FreeBSD, audit records are collected from all jails and placed in a single
 139 global trail, and only limited audit controls are permitted within a jail.)
 140 .El
 141 .Pp
 142 It is recommended that installations set the
 143 .Dv cnt
 144 flag but not
 145 .Dv ahlt
 146 flag unless it is intended that audit logs exceeding available disk space
 147 halt the system.
 148 .Sh DEFAULT
 149 The following settings appear in the default
 150 .Nm
 151 file:
 152 .Bd -literal -offset indent
 153 dir:/var/audit
 154 flags:lo
 155 minfree:20
 156 naflags:lo
 157 policy:cnt
 158 filesz:0
 159 .Ed
 160 .Pp
 161 The
 162 .Va flags
 163 parameter above specifies the system-wide mask corresponding to login/logout
 164 events.
 165 The
 166 .Va policy
 167 parameter specifies that the system should neither fail stop nor suspend
 168 processes when the audit store fills.
 169 The trail file will not be automatically rotated by the audit daemon based on
 170 file size.
 171 .Sh FILES
 172 .Bl -tag -width "/etc/security/audit_control" -compact
 173 .It Pa /etc/security/audit_control
 174 .El
 175 .Sh SEE ALSO
 176 .Xr audit_class 5 ,
 177 .Xr audit_user 5 ,
 178 .Xr audit 8 ,
 179 .Xr auditd 8
 180 .Sh AUTHORS
 181 This software was created by McAfee Research, the security research division
 182 of McAfee, Inc., under contract to Apple Computer Inc.
 183 Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
 184 .Pp
 185 The Basic Security Module (BSM) interface to audit records and audit event
 186 stream format were defined by Sun Microsystems.
 187 .Sh HISTORY
 188 The OpenBSM implementation was created by McAfee Research, the security
 189 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
 190 It was subsequently adopted by the TrustedBSD Project as the foundation for
 191 the OpenBSM distribution.