xref: /freebsd/contrib/openbsm/bin/auditfilterd/auditfilterd.8 (revision b626f5a73a48f44a31a200291b141e1da408a2ff)
1.\"-
2.\" Copyright (c) 2006 Robert N. M. Watson
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
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.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd October 3, 2006
27.Dt AUDITFILTERD 8
28.Os
29.Sh NAME
30.Nm auditfilterd
31.Nd audit filter daemon
32.Sh SYNOPSIS
33.Nm
34.Op Fl d
35.Op Fl c Ar conffile
36.Op Fl p Ar pipefile
37.Op Fl t Ar trailfile
38.Sh DESCRIPTION
39The
40.Nm
41daemon is an extensible audit event monitoring daemon, allowing pluggable
42modules to track audit events from a live audit source.
43It is configured using the audit_filter configuration file.
44The source can either be a pipe or a file.
45.Pp
46The options are as follows:
47.Bl -tag -width indent
48.It Fl c Ar conffile
49Specify an alternative configuration file.
50.It Fl d
51Starts the daemon in debug mode \[em] it will not daemonize.
52.It Fl p Ar pipefile
53Specify a pipe as an alternative source of audit event records.
54Default is
55.Pa /dev/auditpipe .
56.It Fl t Ar trailfile
57Specify a file as an alternative source of audit event records.
58.El
59.Sh FILES
60.Bl -tag -width ".Pa /etc/security/audit_filterd" -compact
61.It Pa /etc/security/audit_filterd
62Default configuration file for
63.Nm .
64.It Pa /dev/auditpipe
65Default audit record source for
66.Nm .
67.El
68.Sh SEE ALSO
69.Xr audit 8 ,
70.Xr auditd 8
71.Sh HISTORY
72The OpenBSM implementation was created by McAfee Research, the security
73division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
74It was subsequently adopted by the TrustedBSD Project as the foundation for
75the OpenBSM distribution.
76.Sh AUTHORS
77The
78.Nm
79daemon and audit filter APIs were created by
80.An Robert Watson .
81.Sh BUGS
82.Nm
83is experimental, and should not be relied on in production.
84APIs and services it offers can and will change in future OpenBSM releases.
85