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