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