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 .\" $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
  44 The
  45 .Nm
  46 command modifies the execution parameter of existing process
  47 specified by the
  48 .Ar pid
  49 argument, or starts execution of the new program
  50 .Ar command
  51 with the execution parameter set for it.
  52 .Pp
  53 Which execution parameter is changed, selected by the mandatory
  54 parameter
  55 .Ar mode .
  56 Possible values for
  57 .Ar mode
  58 are:
  59 .Bl -tag -width trapcap
  60 .It Ar aslr
  61 Control the Address Space Layout Randomization.
  62 Only applicable to the new process spawned.
  63 .It Ar trace
  64 Control the permission for debuggers to attach.
  65 Note that process is only allowed to enable tracing for itself,
  66 not for any other process.
  67 .It Ar trapcap
  68 Controls the signalling of capability mode access violations.
  69 .It Ar protmax
  70 Controls the implicit PROT_MAX application for
  71 .Xr mmap 2 .
  72 .It Ar kpti
  73 Controls the KPTI enable, AMD64 only.
  74 .El
  75 .Pp
  76 The
  77 .Ar control
  78 specifies if the selected
  79 .Ar mode
  80 should be enabled or disabled.
  81 Possible values are
  82 .Ar enable
  83 and
  84 .Ar disable ,
  85 with the default value being
  86 .Ar enable
  87 if not specified.
  88 See
  89 .Xr procctl 2
  90 for detailed description of each mode effects and interaction with other
  91 process control facilities.
  92 .Pp
  93 The
  94 .Fl q
  95 switch makes the utility query and print the current setting for
  96 the selected mode.
  97 The
  98 .Fl q
  99 requires the query target process specification with
 100 .Fl p .
 101 .Sh EXIT STATUS
 102 .Ex -std
 103 .Sh EXAMPLES
 104 .Bl -bullet
 105 .It
 106 To disable debuggers attachment to the process 1020, execute
 107 .Dl "proccontrol -m trace -s disable -p 1020"
 108 .It
 109 To execute the
 110 .Xr uniq 1
 111 program in a mode where capability access violations cause
 112 .Dv SIGTRAP
 113 delivery, do
 114 .Dl "proccontrol -m trapcap uniq"
 115 .It
 116 To query the current ASLR enablement mode for the running
 117 process 1020, do
 118 .Dl "proccontrol -m aslr -q -p 1020"
 119 .El
 120 .Sh SEE ALSO
 121 .Xr kill 2 ,
 122 .Xr procctl 2 ,
 123 .Xr ptrace 2
 124 .Sh HISTORY
 125 The
 126 .Nm
 127 command appeared in
 128 .Fx 10.0 .
 129 .Sh AUTHORS
 130 The
 131 .Nm
 132 command and this manual page were written by
 133 .An Konstantin Belousov Aq Mt kib@freebsd.org
 134 under sponsorship from The FreeBSD Foundation.