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