xref: /freebsd/contrib/openbsm/bin/auditd/auditd.8 (revision 282a3889ebf826db9839be296ff1dd903f6d6d6e)
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/auditd/auditd.8#12 $
33.\"
34.Dd October 2, 2006
35.Dt AUDITD 8
36.Os
37.Sh NAME
38.Nm auditd
39.Nd audit log management daemon
40.Sh SYNOPSIS
41.Nm
42.Op Fl d
43.Sh DESCRIPTION
44The
45.Nm
46daemon responds to requests from the
47.Xr audit 8
48utility and notifications
49from the kernel.
50It manages the resulting audit log files and specified
51log file locations.
52.Pp
53The options are as follows:
54.Bl -tag -width indent
55.It Fl d
56Starts the daemon in debug mode \[em] it will not daemonize.
57.El
58.Sh NOTE
59To assure uninterrupted audit support, the
60.Nm
61daemon should not be started and stopped manually.
62Instead, the
63.Xr audit 8
64command
65should be used to inform the daemon to change state/configuration after altering
66the
67.Pa audit_control
68file.
69.Pp
70.\" Sending a
71.\" .Dv SIGHUP
72.\" to a running
73.\" .Nm
74.\" daemon will force it to exit.
75Sending a
76.Dv SIGTERM
77to a running
78.Nm
79daemon will force it to exit.
80.Sh FILES
81.Bl -tag -width ".Pa /var/audit" -compact
82.It Pa /var/audit
83Default directory for storing audit log files.
84.El
85.Sh COMPATIBILITY
86The historical
87.Fl h
88and
89.Fl s
90flags are now configured using
91.Xr audit_control 5
92policy flags
93.Cm ahlt
94and
95.Cm cnt ,
96and are no longer available as arguments to
97.Nm .
98.Sh SEE ALSO
99.Xr audit 4 ,
100.Xr audit_control 5 ,
101.Xr audit 8
102.Sh HISTORY
103The OpenBSM implementation was created by McAfee Research, the security
104division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
105It was subsequently adopted by the TrustedBSD Project as the foundation for
106the OpenBSM distribution.
107.Sh AUTHORS
108.An -nosplit
109This software was created by McAfee Research, the security research division
110of McAfee, Inc., under contract to Apple Computer Inc.
111Additional authors include
112.An Wayne Salamon ,
113.An Robert Watson ,
114and SPARTA Inc.
115.Pp
116The Basic Security Module (BSM) interface to audit records and audit event
117stream format were defined by Sun Microsystems.
118