contrib/openbsm/bin/auditd/auditd.8

   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 .\"
   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 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#13 $
  29 .\"
  30 .Dd October 2, 2006
  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
  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 .El
  54 .Sh NOTE
  55 To assure uninterrupted audit support, the
  56 .Nm
  57 daemon should not be started and stopped manually.
  58 Instead, the
  59 .Xr audit 8
  60 command
  61 should be used to inform the daemon to change state/configuration after altering
  62 the
  63 .Pa audit_control
  64 file.
  65 .Pp
  66 .\" Sending a
  67 .\" .Dv SIGHUP
  68 .\" to a running
  69 .\" .Nm
  70 .\" daemon will force it to exit.
  71 Sending a
  72 .Dv SIGTERM
  73 to a running
  74 .Nm
  75 daemon will force it to exit.
  76 .Sh FILES
  77 .Bl -tag -width ".Pa /var/audit" -compact
  78 .It Pa /var/audit
  79 Default directory for storing audit log files.
  80 .El
  81 .Sh COMPATIBILITY
  82 The historical
  83 .Fl h
  84 and
  85 .Fl s
  86 flags are now configured using
  87 .Xr audit_control 5
  88 policy flags
  89 .Cm ahlt
  90 and
  91 .Cm cnt ,
  92 and are no longer available as arguments to
  93 .Nm .
  94 .Sh SEE ALSO
  95 .Xr audit 4 ,
  96 .Xr audit_control 5 ,
  97 .Xr audit 8
  98 .Sh HISTORY
  99 The OpenBSM implementation was created by McAfee Research, the security
 100 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
 101 It was subsequently adopted by the TrustedBSD Project as the foundation for
 102 the OpenBSM distribution.
 103 .Sh AUTHORS
 104 .An -nosplit
 105 This software was created by McAfee Research, the security research division
 106 of McAfee, Inc., under contract to Apple Computer Inc.
 107 Additional authors include
 108 .An Wayne Salamon ,
 109 .An Robert Watson ,
 110 and SPARTA Inc.
 111 .Pp
 112 The Basic Security Module (BSM) interface to audit records and audit event
 113 stream format were defined by Sun Microsystems.