xref: /freebsd/usr.sbin/setaudit/setaudit.8 (revision 1238610a27d5bc0914f524296ff587d86eec4c52)
1.\" Copyright (c) 2018-2022 Mateusz Piotrowski <0mp@FreeBSD.org>
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.Dd March 21, 2018
24.Dt SETAUDIT 8
25.Os
26.Sh NAME
27.Nm setaudit
28.Nd "specify audit configurations on a process"
29.Sh SYNOPSIS
30.Nm
31.Op Fl 46U
32.Op Fl a Ar auid
33.Op Fl m Ar mask
34.Op Fl s Ar source
35.Op Fl p Ar port
36.Ar command ...
37.Sh DESCRIPTION
38.Nm
39is a tool to specify audit configurations on a process.
40.Pp
41The following options are available:
42.Bl -tag -width ".Fl d Ar argument"
43.It Fl 4
44Use IPv4.
45.It Fl 6
46Use IPv6.
47.It Fl U
48Update audit session state rather than overwriting it.
49By default,
50.Nm
51will overwrite the entire audit session state using the specified
52parameters.
53If
54.Fl U
55is specified, only the parameters given on the command line will be
56updated, leaving the rest unchanged.
57.It Fl a Ar auid
58Audit user ID or user name.
59.It Fl m Ar mask
60String representation of an audit mask.
61.It Fl s Ar source
62IPv4 or IPv6 address of a Terminal ID.
63.It Fl p Ar port
64Port of a Terminal ID.
65.Xr
66.El
67.Sh EXAMPLES
68Enable all exe related audit events performed by
69.Ar command
70and its child processes:
71.Pp
72.Dl # setaudit -m ex command
73.Sh SEE ALSO
74.Xr getaudit 2 ,
75.Xr setaudit 2 ,
76.Xr au_mask 3 ,
77.Xr libbsm 3 ,
78.Xr audit_user 5 ,
79.Xr audit 8
80.Sh HISTORY
81The
82.Nm
83utility was written by
84.An Christian S.J. Peron Aq Mt csjp@FreeBSD.org .
85.Sh AUTHORS
86This
87manual page was written by
88.An Mateusz Piotrowski Aq Mt 0mp@FreeBSD.org .
89