usr.bin/proccontrol/proccontrol.1

   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 .Dd October 5, 2023
  30 .Dt PROCCONTROL 1
  31 .Os
  32 .Sh NAME
  33 .Nm proccontrol
  34 .Nd Control some process execution aspects
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Fl m Ar mode
  38 .Op Fl s Ar control
  39 .Op Fl q
  40 .Fl p Ar pid | command
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 command modifies the execution parameter of existing process
  45 specified by the
  46 .Ar pid
  47 argument, or starts execution of the new program
  48 .Ar command
  49 with the execution parameter set for it.
  50 .Pp
  51 Which execution parameter is changed, selected by the mandatory
  52 parameter
  53 .Ar mode .
  54 Possible values for
  55 .Ar mode
  56 are:
  57 .Bl -tag -width trapcap
  58 .It Ar aslr
  59 Control the Address Space Layout Randomization.
  60 Only applicable to the new process spawned.
  61 .It Ar trace
  62 Control the permission for debuggers to attach.
  63 Note that process is only allowed to enable tracing for itself,
  64 not for any other process.
  65 .It Ar trapcap
  66 Controls the signalling of capability mode access violations.
  67 .It Ar protmax
  68 Controls the implicit PROT_MAX application for
  69 .Xr mmap 2 .
  70 .It Ar nonewprivs
  71 Controls disabling the setuid and sgid bits for
  72 .Xr execve 2 .
  73 .It Ar wxmap
  74 Controls the write exclusive execute mode for mappings.
  75 .It Ar kpti
  76 Controls the KPTI enable, AMD64 only.
  77 .It Ar la48
  78 Control limiting usermode process address space to 48 bits of address,
  79 AMD64 only, on machines capable of 57-bit addressing.
  80 .El
  81 .Pp
  82 The
  83 .Ar control
  84 specifies if the selected
  85 .Ar mode
  86 should be enabled or disabled.
  87 Possible values are
  88 .Ar enable
  89 and
  90 .Ar disable ,
  91 with the default value being
  92 .Ar enable
  93 if not specified.
  94 See
  95 .Xr procctl 2
  96 for detailed description of each mode effects and interaction with other
  97 process control facilities.
  98 .Pp
  99 The
 100 .Fl q
 101 switch makes the utility query and print the current setting for
 102 the selected mode.
 103 The
 104 .Fl q
 105 requires the query target process specification with
 106 .Fl p .
 107 .Sh EXIT STATUS
 108 .Ex -std
 109 .Sh EXAMPLES
 110 .Bl -bullet
 111 .It
 112 To disable debuggers attachment to the process 1020, execute
 113 .Dl "proccontrol -m trace -s disable -p 1020"
 114 .It
 115 To execute the
 116 .Xr uniq 1
 117 program in a mode where capability access violations cause
 118 .Dv SIGTRAP
 119 delivery, do
 120 .Dl "proccontrol -m trapcap uniq"
 121 .It
 122 To query the current ASLR enablement mode for the running
 123 process 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 .Xr mitigations 7
 131 .Sh HISTORY
 132 The
 133 .Nm
 134 command appeared in
 135 .Fx 10.0 .
 136 .Sh AUTHORS
 137 The
 138 .Nm
 139 command and this manual page were written by
 140 .An Konstantin Belousov Aq Mt kib@freebsd.org
 141 under sponsorship from The FreeBSD Foundation.