xref: /netbsd-src/usr.sbin/paxctl/paxctl.8 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\"	$NetBSD: paxctl.8,v 1.16 2016/11/08 08:21:52 wiz Exp $
2.\"
3.\" Copyright 2006 Elad Efrat <elad@NetBSD.org>
4.\" Copyright 2008 Christos Zoulas <christos@NetBSD.org>
5.\" All rights reserved.
6.\"
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. The name of the author may not be used to endorse or promote products
13.\"    derived from this software without specific prior written permission.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd November 7, 2016
27.Dt PAXCTL 8
28.Os
29.Sh NAME
30.Nm paxctl
31.Nd list and modify PaX flags associated with an ELF program
32.Sh SYNOPSIS
33.Nm
34.Ar flags
35.Ar program ...
36.Sh DESCRIPTION
37The
38.Nm
39utility is used to list and manipulate PaX flags associated with an ELF
40program.
41The PaX flags signify to the loader the privilege protections to be applied
42to mapped memory pages, and fuller explanations of the specific protections
43can be found in the
44.Xr security 7
45manpage.
46.Pp
47Each flag can be prefixed either with a
48.Dq +
49or a
50.Dq -
51sign to add or remove the flag, respectively.
52.Pp
53The following flags are available:
54.Bl -tag -width flag
55.It a
56Explicitly disable PaX ASLR (Address Space Layout Randomization) for
57.Ar program .
58.It A
59Explicitly enable PaX ASLR for
60.Ar program .
61.It g
62Explicitly disable PaX Segvguard for
63.Ar program .
64.It G
65Explicitly enable PaX Segvguard for
66.Ar program .
67.It m
68Explicitly disable PaX MPROTECT
69.Po Xr mprotect 2
70restrictions
71.Pc
72for
73.Ar program .
74.It M
75Explicitly enable PaX MPROTECT
76.Po Xr mprotect 2
77restrictions
78.Pc
79for
80.Ar program .
81.El
82.Pp
83To view existing flags on a file, execute
84.Nm
85without any flags.
86.Sh SEE ALSO
87.Xr mprotect 2 ,
88.Xr sysctl 3 ,
89.Xr options 4 ,
90.Xr elf 5 ,
91.Xr security 7 ,
92.Xr sysctl 8 ,
93.Xr fileassoc 9
94.Sh HISTORY
95The
96.Nm
97utility first appeared in
98.Nx 4.0 .
99.Pp
100The
101.Nm
102utility is modeled after a tool of the same name available for Linux from the
103PaX project.
104.Sh AUTHORS
105.An Elad Efrat Aq Mt elad@NetBSD.org
106.An Christos Zoulas Aq Mt christos@NetBSD.org
107.Sh BUGS
108The
109.Nm
110utility currently uses
111.Xr elf 5
112.Dq note
113sections to mark executables as having PaX flags enabled.
114This will be done using
115.Xr fileassoc 9
116in the future so that we can control who does the marking and
117not altering the binary file signature.
118(Note this also means that
119at present any flags set do not survive binary file upgrades.)
120