xref: /freebsd/contrib/openbsm/man/auditctl.2 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1.\"-
2.\" Copyright (c) 2005-2006 Robert N. M. Watson
3.\" Copyright (c) 2008 Apple Inc.
4.\" All rights reserved.
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.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd April 19, 2005
28.Dt AUDITCTL 2
29.Os
30.Sh NAME
31.Nm auditctl
32.Nd "configure system audit parameters"
33.Sh SYNOPSIS
34.In bsm/audit.h
35.Ft int
36.Fn auditctl "const char *path"
37.Sh DESCRIPTION
38The
39.Fn auditctl
40system call directs the kernel to open a new audit trail log file.
41It requires an appropriate privilege.
42The
43.Fn auditctl
44system call
45opens new files, but
46.Xr auditon 2
47is used to disable the audit log.
48.Sh RETURN VALUES
49.Rv -std
50.Sh ERRORS
51The
52.Fn auditctl
53system call will fail if:
54.Bl -tag -width Er
55.It Bq Er EINVAL
56The path is invalid.
57.It Bq Er EPERM
58The process does not have sufficient permission to complete the
59operation.
60.El
61.Sh SEE ALSO
62.Xr auditon 2 ,
63.Xr libbsm 3 ,
64.Xr auditd 8
65.Sh HISTORY
66The OpenBSM implementation was created by McAfee Research, the security
67division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
68It was subsequently adopted by the TrustedBSD Project as the foundation for
69the OpenBSM distribution.
70.Sh AUTHORS
71.An -nosplit
72This software was created by McAfee Research, the security research division
73of McAfee, Inc., under contract to Apple Computer Inc.
74Additional authors include
75.An Wayne Salamon ,
76.An Robert Watson ,
77and SPARTA Inc.
78.Pp
79The Basic Security Module (BSM) interface to audit records and audit event
80stream format were defined by Sun Microsystems.
81.Pp
82This manual page was written by
83.An Robert Watson Aq rwatson@FreeBSD.org .
84