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