contrib/openbsm/bin/auditd/auditd.8

   1 .\" Copyright (c) 2004 Apple 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 .\"
   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 ANY
  18 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20 .\" DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24 .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $P4: //depot/projects/trustedbsd/openbsm/bin/auditd/auditd.8#19 $
  29 .\"
  30 .Dd December 11, 2008
  31 .Dt AUDITD 8
  32 .Os
  33 .Sh NAME
  34 .Nm auditd
  35 .Nd audit log management daemon
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl d | l
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 daemon responds to requests from the
  43 .Xr audit 8
  44 utility and notifications
  45 from the kernel.
  46 It manages the resulting audit log files and specified
  47 log file locations.
  48 .Pp
  49 The options are as follows:
  50 .Bl -tag -width indent
  51 .It Fl d
  52 Starts the daemon in debug mode \[em] it will not daemonize.
  53 .It Fl l
  54 This option is for when
  55 .Nm
  56 is configured to start on-demand using
  57 .Xr launchd 8 .
  58 .El
  59 .Pp
  60 Optionally, the audit review group "audit" may be created.
  61 Non-privileged
  62 users that are members of this group may read the audit trail log files.
  63 .Sh NOTE
  64 To assure uninterrupted audit support, the
  65 .Nm
  66 daemon should not be started and stopped manually.
  67 Instead, the
  68 .Xr audit 8
  69 command
  70 should be used to inform the daemon to change state/configuration after altering
  71 the
  72 .Pa audit_control
  73 file.
  74 .Pp
  75 If
  76 .Nm
  77 is started on-demand by
  78 .Xr launchd 8
  79 then auditing should only be started and stopped with
  80 .Xr audit 8 .
  81 .Pp
  82 On Mac OS X,
  83 .Nm
  84 uses the
  85 .Xr asl 3
  86 API for writing system log messages.
  87 Therefore, only the audit administrator
  88 and members of the audit review group will be able to read the
  89 system log entries.
  90 .Sh FILES
  91 .Bl -tag -width ".Pa /etc/security" -compact
  92 .It Pa /var/audit
  93 Default directory for storing audit log files.
  94 .Pp
  95 .It Pa /etc/security
  96 The directory containing the auditing configuration files
  97 .Xr audit_class 5 ,
  98 .Xr audit_control 5 ,
  99 .Xr audit_event 5 ,
 100 and
 101 .Xr audit_warn 5 .
 102 .El
 103 .Sh COMPATIBILITY
 104 The historical
 105 .Fl h
 106 and
 107 .Fl s
 108 flags are now configured using
 109 .Xr audit_control 5
 110 policy flags
 111 .Cm ahlt
 112 and
 113 .Cm cnt ,
 114 and are no longer available as arguments to
 115 .Nm .
 116 .Sh SEE ALSO
 117 .Xr asl 3 ,
 118 .Xr libauditd 3 ,
 119 .Xr audit 4 ,
 120 .Xr audit_class 5 ,
 121 .Xr audit_control 5 ,
 122 .Xr audit_event 5 ,
 123 .Xr audit_warn 5 ,
 124 .Xr audit 8 ,
 125 .Xr auditdistd 8 ,
 126 .Xr launchd 8
 127 .Sh HISTORY
 128 The OpenBSM implementation was created by McAfee Research, the security
 129 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
 130 It was subsequently adopted by the TrustedBSD Project as the foundation for
 131 the OpenBSM distribution.
 132 .Sh AUTHORS
 133 .An -nosplit
 134 This software was created by McAfee Research, the security research division
 135 of McAfee, Inc., under contract to Apple Computer Inc.
 136 Additional authors include
 137 .An Wayne Salamon ,
 138 .An Robert Watson ,
 139 and SPARTA Inc.
 140 .Pp
 141 The Basic Security Module (BSM) interface to audit records and audit event
 142 stream format were defined by Sun Microsystems.