xref: /freebsd/usr.bin/proccontrol/proccontrol.1 (revision 6683132d54bd6d589889e43dabdc53d35e38a028)
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 June 28, 2019
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 kpti
70Controls the KPTI enable, AMD64 only.
71.El
72.Pp
73The
74.Ar control
75specifies if the selected
76.Ar mode
77should be enabled or disabled.
78Possible values are
79.Ar enable
80and
81.Ar disable ,
82with the default value being
83.Ar enable
84if not specified.
85See
86.Xr procctl 2
87for detailed description of each mode effects and interaction with other
88process control facilities.
89.Pp
90The
91.Fl q
92switch makes the utility query and print the current setting for
93the selected mode.
94The
95.Fl q
96requires the query target process specification with
97.Fl p .
98.Sh EXIT STATUS
99.Ex -std
100.Sh EXAMPLES
101.Bl -bullet
102.It
103To disable debuggers attachment to the process 1020, execute
104.Dl "proccontrol -m trace -s disable -p 1020"
105.It
106To execute the
107.Xr uniq 1
108program in a mode where capability access violations cause
109.Dv SIGTRAP
110delivery, do
111.Dl "proccontrol -m trapcap uniq"
112.It
113To query the current ASLR enablement mode for the running
114process 1020, do
115.Dl "proccontrol -m aslr -q -p 1020"
116.El
117.Sh SEE ALSO
118.Xr kill 2 ,
119.Xr procctl 2 ,
120.Xr ptrace 2
121.Sh HISTORY
122The
123.Nm
124command appeared in
125.Fx 10.0 .
126.Sh AUTHORS
127The
128.Nm
129command and this manual page were written by
130.An Konstantin Belousov Aq Mt kib@freebsd.org
131under sponsorship from The FreeBSD Foundation.
132