xref: /freebsd/contrib/openbsm/man/auditctl.2 (revision 63518eccca27064285cf2e680510ba9a4c3e2231)
1.\"-
2.\" Copyright (c) 2005-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.\" $P4: //depot/projects/trustedbsd/openbsm/man/auditctl.2#5 $
27.\"
28.Dd April 19, 2005
29.Dt AUDITCTL 2
30.Os
31.Sh NAME
32.Nm auditctl
33.Nd "Configure system audit parameters"
34.Sh SYNOPSIS
35.In bsm/audit.h
36.Ft int
37.Fn auditctl "const char *path"
38.Sh DESCRIPTION
39The
40.Fn auditctl
41system call directs the kernel to open a new audit trail log file.
42.Fn auditctl
43requires appropriate privilege.
44In the
45.Fx
46implementation,
47.Fn auditctl
48opens new files, but
49.Fn auditon
50is used to disable the audit log.
51In the Mac OS X implementation, passing
52.Va NULL
53to
54.Fn auditctl
55will disable the audit log.
56.Sh RETURN VALUES
57.Nm
58returns 0 on success, or returns -1 on failure, providing additional error
59information via
60.Va errno .
61.Sh SEE ALSO
62.Xr libbsm 3 ,
63.Xr auditd 8
64.Sh AUTHORS
65This software was created by McAfee Research, the security research division
66of McAfee, Inc., under contract to Apple Computer Inc.
67Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
68.Pp
69The Basic Security Module (BSM) interface to audit records and audit event
70stream format were defined by Sun Microsystems.
71.Pp
72This manual page was written by
73.An Robert Watson Aq rwatson@FreeBSD.org .
74.Sh HISTORY
75The OpenBSM implementation was created by McAfee Research, the security
76division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
77It was subsequently adopted by the TrustedBSD Project as the foundation for
78the OpenBSM distribution.
79