xref: /freebsd/contrib/openbsm/bin/auditd/auditd.8 (revision d056fa046c6a91b90cd98165face0e42a33a5173)
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#8 $
33.\"
34.Dd January 24, 2004
35.Dt AUDITD 8
36.Os
37.Sh NAME
38.Nm auditd
39.Nd audit log management daemon
40.Sh SYNOPSIS
41.Nm auditd
42.Op Fl dhs
43.Sh DESCRIPTION
44The
45.Nm
46daemon responds to requests from the audit(1) utility and notifications
47from the kernel.  It manages the resulting audit log files and specified
48log file locations.
49.Pp
50The options are as follows:
51.Bl -tag -width Ds
52.It Fl d
53Starts the daemon in debug mode - it will not daemonize.
54.It Fl h
55Specifies that if auditing cannot be performed as specified, the system should
56halt (panic).  Normally, the system will attempt to proceed - although individual
57processes may be stopped (see the -s option).
58.It Fl s
59Specifies that individual processes should stop rather than perform operations
60that may cause audit records to be lost due to log file full conditions
61.El
62.Sh NOTE
63.Pp
64To assure uninterrupted audit support, the
65.Nm auditd
66daemon should not be started and stopped manually.
67Instead, the
68.Xr audit 8
69command
70should be used to inform the daemon to change state/configuration after altering
71the
72.Pa audit_control
73file.
74.Pp
75.\" Sending a SIGHUP to a running
76.\" .Nm auditd
77.\" daemon will force it to exit.
78Sending a SIGTERM to a running
79.Nm auditd
80daemon will force it to exit.
81.Sh FILES
82.Bl -tag -width "/var/audit" -compact
83.It Pa /var/audit
84Default directory for storing audit log files.
85.El
86.Sh SEE ALSO
87.Xr audit 8
88.Sh AUTHORS
89This software was created by McAfee Research, the security research division
90of McAfee, Inc., under contract to Apple Computer Inc.
91Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
92.Pp
93The Basic Security Module (BSM) interface to audit records and audit event
94stream format were defined by Sun Microsystems.
95.Sh HISTORY
96The OpenBSM implementation was created by McAfee Research, the security
97division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
98It was subsequently adopted by the TrustedBSD Project as the foundation for
99the OpenBSM distribution.
100