contrib/openbsm/man/audit_control.5

   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#9 $
  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
  37 The
  38 .Nm
  39 file contains several audit system parameters.
  40 Each line of this file is of the form:
  41 .Pp
  42 .Dl parameter:value
  43 .Pp
  44 The parameters are:
  45 .Bl -tag -width Ds
  46 .It Pa dir
  47 The directory where audit log files are stored.
  48 There may be more than one of these entries.
  49 Changes to this entry can only be enacted by restarting the
  50 audit system.
  51 See
  52 .Xr audit 1
  53 for a description of how to restart the audit system.
  54 .It Va flags
  55 Specifies which audit event classes are audited for all users.
  56 .Xr audit_user 5
  57 describes how to audit events for individual users.
  58 See the information below for the format of the audit flags.
  59 .It Va naflags
  60 Contains the audit flags that define what classes of events are audited when
  61 an action cannot be attributed to a specific user.
  62 .It Va minfree
  63 The minimum free space required on the file system audit logs are being written to.
  64 When the free space falls below this limit a warning will be issued.
  65 Not currently used as the value of 20 percent is chosen by the kernel.
  66 .El
  67 .Sh AUDIT FLAGS
  68 Audit flags are a comma-delimited list of audit classes as defined in the
  69 .Pa audit_class
  70 file.
  71 See
  72 .Xr audit_class 5
  73 for details.
  74 Event classes may be preceded by a prefix which changes their interpretation.
  75 The following prefixes may be used for each class:
  76 .Pp
  77 .Bl -tag -width Ds -compact -offset indent
  78 .It +
  79 Record successful events
  80 .It -
  81 Record failed events
  82 .It ^
  83 Record both successful and failed events
  84 .It ^+
  85 Do not record successful events
  86 .It ^-
  87 Do not record failed events
  88 .El
  89 .Sh DEFAULT
  90 The following settings appear in the default
  91 .Nm
  92 file:
  93 .Bd -literal -offset indent
  94 dir:/var/audit
  95 flags:lo
  96 minfree:20
  97 naflags:lo
  98 .Ed
  99 .Pp
 100 The
 101 .Va flags
 102 parameter above specifies the system-wide mask corresponding to login/logout
 103 events.
 104 .Sh FILES
 105 .Bl -tag -width "/etc/security/audit_control" -compact
 106 .It Pa /etc/security/audit_control
 107 .El
 108 .Sh SEE ALSO
 109 .Xr audit_class 5 ,
 110 .Xr audit_user 5 ,
 111 .Xr audit 8 ,
 112 .Xr auditd 8
 113 .Sh AUTHORS
 114 This software was created by McAfee Research, the security research division
 115 of McAfee, Inc., under contract to Apple Computer Inc.
 116 Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
 117 .Pp
 118 The Basic Security Module (BSM) interface to audit records and audit event
 119 stream format were defined by Sun Microsystems.
 120 .Sh HISTORY
 121 The OpenBSM implementation was created by McAfee Research, the security
 122 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
 123 It was subsequently adopted by the TrustedBSD Project as the foundation for
 124 the OpenBSM distribution.