xref: /freebsd/contrib/openbsm/bin/audit/audit.8 (revision 1b05b2d9e7e6b47eb3c82b281dbaacb4f5e7fb0c)
1.\" Copyright (c) 2004 Apple Computer, Inc.
2.\" All rights reserved.
3.\"
4.\" @APPLE_BSD_LICENSE_HEADER_START@
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\"
10.\" 1.  Redistributions of source code must retain the above copyright
11.\"     notice, this list of conditions and the following disclaimer.
12.\" 2.  Redistributions in binary form must reproduce the above copyright
13.\"     notice, this list of conditions and the following disclaimer in the
14.\"     documentation and/or other materials provided with the distribution.
15.\" 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16.\"     its contributors may be used to endorse or promote products derived
17.\"     from this software without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22.\" DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\" @APPLE_BSD_LICENSE_HEADER_END@
31.\"
32.\" $P4: //depot/projects/trustedbsd/openbsm/bin/audit/audit.8#4 $
33.\"
34.Dd Jan 24, 2004
35.Dt AUDIT 8
36.Os
37.Sh NAME
38.Nm audit
39.Nd audit management utility
40.Sh SYNOPSIS
41.Nm audit
42.Op Fl nst
43.Op Ar file
44.Sh DESCRIPTION
45The
46.Nm
47utility controls the state of the audit system.
48The optional
49.Ar file
50operand specifies the location of the audit control input file (default
51.Pa /etc/security/audit_control ).
52.Pp
53The options are as follows:
54.Bl -tag -width Ds
55.It Fl n
56Forces the audit system to close the existing audit log file and rotate to
57a new log file in a location specified in the audit control file.
58.It Fl s
59Specifies that the audit system should [re]synchronize its
60configuration from the audit control file.
61A new log file will be created.
62.It Fl t
63Specifies that the audit system should terminate.
64Log files are closed
65and renamed to indicate the time of the shutdown.
66.El
67.Sh NOTES
68The auditd(8) daemon must already be running.
69.Sh FILES
70.Bl -tag -width "/etc/security/audit_control" -compact
71.It Pa /etc/security/audit_control
72Default audit policy file used to configure the auditing system.
73.El
74.Sh SEE ALSO
75.Xr auditd 8
76.Xr audit_control 5
77.Sh AUTHORS
78This software was created by McAfee Research, the security research division
79of McAfee, Inc., under contract to Apple Computer Inc.
80Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
81.Pp
82The Basic Security Module (BSM) interface to audit records and audit event
83stream format were defined by Sun Microsystems.
84.Sh HISTORY
85The OpenBSM implementation was created by McAfee Research, the security
86division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
87It was subsequently adopted by the TrustedBSD Project as the foundation for
88the OpenBSM distribution.
89