contrib/openbsm/bin/audit/audit.8

   1 .\" Copyright (c) 2004-2009 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/audit/audit.8#16 $
  29 .\"
  30 .Dd January 29, 2009
  31 .Dt AUDIT 8
  32 .Os
  33 .Sh NAME
  34 .Nm audit
  35 .Nd audit management utility
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Fl e | i | n | s | t
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 utility controls the state of the audit system.
  43 One of the following flags is required as an argument to
  44 .Nm :
  45 .Bl -tag -width indent
  46 .It Fl e
  47 Forces the audit system to immediately remove audit log files that
  48 meet the expiration criteria specified in the audit control file without
  49 doing a log rotation.
  50 .It Fl i
  51 Initializes and starts auditing.
  52 This option is currently for Mac OS X only
  53 and requires
  54 .Xr auditd 8
  55 to be configured to run under
  56 .Xr launchd 8 .
  57 .It Fl n
  58 Forces the audit system to close the existing audit log file and rotate to
  59 a new log file in a location specified in the audit control file.
  60 Also, audit log files that meet the expiration criteria specified in the
  61 audit control file will be removed.
  62 .It Fl s
  63 Specifies that the audit system should [re]synchronize its
  64 configuration from the audit control file.
  65 A new log file will be created.
  66 .It Fl t
  67 Specifies that the audit system should terminate.
  68 Log files are closed
  69 and renamed to indicate the time of the shutdown.
  70 .El
  71 .Sh NOTES
  72 The
  73 .Xr auditd 8
  74 daemon must already be running.
  75 Optionally, it can be configured to be started
  76 on-demand by
  77 .Xr launchd 8
  78 (Mac OS X only).
  79 The
  80 .Nm
  81 utility requires audit administrator privileges for successful operation.
  82 .Sh FILES
  83 .Bl -tag -width ".Pa /etc/security/audit_control" -compact
  84 .It Pa /etc/security/audit_control
  85 Audit policy file used to configure the auditing system.
  86 .El
  87 .Sh SEE ALSO
  88 .Xr audit 4 ,
  89 .Xr audit_control 5 ,
  90 .Xr auditd 8 ,
  91 .Xr launchd 8
  92 .Sh HISTORY
  93 The OpenBSM implementation was created by McAfee Research, the security
  94 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
  95 It was subsequently adopted by the TrustedBSD Project as the foundation for
  96 the OpenBSM distribution.
  97 .Sh AUTHORS
  98 .An -nosplit
  99 This software was created by McAfee Research, the security research division
 100 of McAfee, Inc., under contract to Apple Computer Inc.
 101 Additional authors include
 102 .An Wayne Salamon ,
 103 .An Robert Watson ,
 104 and SPARTA Inc.
 105 .Pp
 106 The Basic Security Module (BSM) interface to audit records and audit event
 107 stream format were defined by Sun Microsystems.