contrib/openbsm/bin/audit/audit.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/audit/audit.8#10 $
  29 .\"
  30 .Dd October 2, 2006
  31 .Dt AUDIT 8
  32 .Os
  33 .Sh NAME
  34 .Nm audit
  35 .Nd audit management utility
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Fl 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 n
  47 Forces the audit system to close the existing audit log file and rotate to
  48 a new log file in a location specified in the audit control file.
  49 .It Fl s
  50 Specifies that the audit system should [re]synchronize its
  51 configuration from the audit control file.
  52 A new log file will be created.
  53 .It Fl t
  54 Specifies that the audit system should terminate.
  55 Log files are closed
  56 and renamed to indicate the time of the shutdown.
  57 .El
  58 .Sh NOTES
  59 The
  60 .Xr auditd 8
  61 daemon must already be running.
  62 .Sh FILES
  63 .Bl -tag -width ".Pa /etc/security/audit_control" -compact
  64 .It Pa /etc/security/audit_control
  65 Audit policy file used to configure the auditing system.
  66 .El
  67 .Sh SEE ALSO
  68 .Xr audit 4 ,
  69 .Xr audit_control 5 ,
  70 .Xr auditd 8
  71 .Sh HISTORY
  72 The OpenBSM implementation was created by McAfee Research, the security
  73 division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
  74 It was subsequently adopted by the TrustedBSD Project as the foundation for
  75 the OpenBSM distribution.
  76 .Sh AUTHORS
  77 .An -nosplit
  78 This software was created by McAfee Research, the security research division
  79 of McAfee, Inc., under contract to Apple Computer Inc.
  80 Additional authors include
  81 .An Wayne Salamon ,
  82 .An Robert Watson ,
  83 and SPARTA Inc.
  84 .Pp
  85 The Basic Security Module (BSM) interface to audit records and audit event
  86 stream format were defined by Sun Microsystems.