xref: /freebsd/contrib/openbsm/man/auditctl.2 (revision 40a8ac8f62b535d30349faf28cf47106b7041b83)
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.\" $P4: //depot/projects/trustedbsd/openbsm/man/auditctl.2#9 $
28.\"
29.Dd April 19, 2005
30.Dt AUDITCTL 2
31.Os
32.Sh NAME
33.Nm auditctl
34.Nd "configure system audit parameters"
35.Sh SYNOPSIS
36.In bsm/audit.h
37.Ft int
38.Fn auditctl "const char *path"
39.Sh DESCRIPTION
40The
41.Fn auditctl
42system call directs the kernel to open a new audit trail log file.
43It requires an appropriate privilege.
44The
45.Fn auditctl
46system call
47opens new files, but
48.Xr auditon 2
49is used to disable the audit log.
50.Sh RETURN VALUES
51.Rv -std
52.Sh ERRORS
53The
54.Fn auditctl
55system call will fail if:
56.Bl -tag -width Er
57.It Bq Er EINVAL
58The path is invalid.
59.It Bq Er EPERM
60The process does not have sufficient permission to complete the
61operation.
62.El
63.Sh SEE ALSO
64.Xr auditon 2 ,
65.Xr libbsm 3 ,
66.Xr auditd 8
67.Sh HISTORY
68The OpenBSM implementation was created by McAfee Research, the security
69division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004.
70It was subsequently adopted by the TrustedBSD Project as the foundation for
71the OpenBSM distribution.
72.Sh AUTHORS
73.An -nosplit
74This software was created by McAfee Research, the security research division
75of McAfee, Inc., under contract to Apple Computer Inc.
76Additional authors include
77.An Wayne Salamon ,
78.An Robert Watson ,
79and SPARTA Inc.
80.Pp
81The Basic Security Module (BSM) interface to audit records and audit event
82stream format were defined by Sun Microsystems.
83.Pp
84This manual page was written by
85.An Robert Watson Aq rwatson@FreeBSD.org .
86