xref: /freebsd/usr.bin/proccontrol/proccontrol.1 (revision bc5304a006238115291e7568583632889dffbab9)
1.\" Copyright (c) 2019 The FreeBSD Foundation, Inc.
2.\" All rights reserved.
3.\"
4.\" This documentation was written by
5.\" Konstantin Belousov <kib@FreeBSD.org> under sponsorship
6.\" from the FreeBSD Foundation.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd July 2, 2021
32.Dt PROCCONTROL 1
33.Os
34.Sh NAME
35.Nm proccontrol
36.Nd Control some process execution aspects
37.Sh SYNOPSIS
38.Nm
39.Fl m Ar mode
40.Op Fl s Ar control
41.Op Fl q
42.Fl p Ar pid | command
43.Sh DESCRIPTION
44The
45.Nm
46command modifies the execution parameter of existing process
47specified by the
48.Ar pid
49argument, or starts execution of the new program
50.Ar command
51with the execution parameter set for it.
52.Pp
53Which execution parameter is changed, selected by the mandatory
54parameter
55.Ar mode .
56Possible values for
57.Ar mode
58are:
59.Bl -tag -width trapcap
60.It Ar aslr
61Control the Address Space Layout Randomization.
62Only applicable to the new process spawned.
63.It Ar trace
64Control the permission for debuggers to attach.
65Note that process is only allowed to enable tracing for itself,
66not for any other process.
67.It Ar trapcap
68Controls the signalling of capability mode access violations.
69.It Ar protmax
70Controls the implicit PROT_MAX application for
71.Xr mmap 2 .
72.It Ar nonewprivs
73Controls disabling the setuid and sgid bits for
74.Xr execve 2 .
75.It Ar kpti
76Controls the KPTI enable, AMD64 only.
77.It Ar la48
78Control limiting usermode process address space to 48 bits of address,
79AMD64 only, on machines capable of 57-bit addressing.
80.El
81.Pp
82The
83.Ar control
84specifies if the selected
85.Ar mode
86should be enabled or disabled.
87Possible values are
88.Ar enable
89and
90.Ar disable ,
91with the default value being
92.Ar enable
93if not specified.
94See
95.Xr procctl 2
96for detailed description of each mode effects and interaction with other
97process control facilities.
98.Pp
99The
100.Fl q
101switch makes the utility query and print the current setting for
102the selected mode.
103The
104.Fl q
105requires the query target process specification with
106.Fl p .
107.Sh EXIT STATUS
108.Ex -std
109.Sh EXAMPLES
110.Bl -bullet
111.It
112To disable debuggers attachment to the process 1020, execute
113.Dl "proccontrol -m trace -s disable -p 1020"
114.It
115To execute the
116.Xr uniq 1
117program in a mode where capability access violations cause
118.Dv SIGTRAP
119delivery, do
120.Dl "proccontrol -m trapcap uniq"
121.It
122To query the current ASLR enablement mode for the running
123process 1020, do
124.Dl "proccontrol -m aslr -q -p 1020"
125.El
126.Sh SEE ALSO
127.Xr kill 2 ,
128.Xr procctl 2 ,
129.Xr ptrace 2
130.Sh HISTORY
131The
132.Nm
133command appeared in
134.Fx 10.0 .
135.Sh AUTHORS
136The
137.Nm
138command and this manual page were written by
139.An Konstantin Belousov Aq Mt kib@freebsd.org
140under sponsorship from The FreeBSD Foundation.
141