path: root/doc/paxctl-ng.1

.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PAXCTL-NG 1"
.TH PAXCTL-NG 1 "2011-08-18" "elfix 0.3" "Documentation for elfix"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
paxctl\-ng \- get or set the PaX flags for both PT_PAX and XATTR_PAX markings
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBpaxctl-ng\fR [\-PpEeMmRrXxSs] [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-Z [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-z [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-C [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-c [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-d [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-F [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-f [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-L [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR \-l [\-v] \s-1ELF\s0
.PP
\&\fBpaxctl-ng\fR [\-h]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpaxctl-ng\fR is used to get or set the PaX flags on \s-1ELF\s0 executables which determine
the memory restrictions on process(es) spawned from them.  \fBpaxctl-ng\fR manages
two types of markings, either the older style \s-1PT_PAX\s0 markings which put the flags
in an \s-1ELF\s0 program header named \s-1PT_PAX\s0, or the newer style \s-1XATTR_PAX\s0 markings which
put the flags in an extended attribute field called \*(L"user.pax\*(R" on the filesystem.
Whenever possible, \fBpaxctl-ng\fR will set both \s-1PT_PAX\s0 and \s-1XATTR_PAX\s0 to the same flags.
.PP
There are drawbacks to both \s-1PT_PAX\s0 and \s-1XATTR_PAX\s0 markings.  \s-1PT_PAX\s0 will not work on
\&\s-1ELF\s0 binaries which do not already have a \s-1PT_PAX\s0 program header.  Unlike the original
tool, \fBpaxctl\fR, which would try to add this header or convert a \s-1GNU_STACK\s0 header,
\&\fBpaxctl-ng\fR does not edit the \s-1ELF\s0 in any way, beyond setting the PaX flags if and
only if the \s-1PT_PAX\s0 program header already exists.  Some \s-1ELF\s0 binaries break when
they are edited.  Since, \fBpaxctl-ng\fR will never to so, it is always safe to run
it on such binaries.
.PP
Alternatively, \s-1XATTR_PAX\s0 requires a filesystem support Extended Attributes.  Most
modern filesystems do so, but not all.  Furthermore, one must be careful when
moving \s-1ELF\s0 objects to ensure that the target filesystem or archive supports
Extended Attributes, otherwise they are lost, unlike \s-1PT_PAX\s0 markings which
are carried within the binary itself.
.PP
\&\fBpaxctl-ng\fR is opportunistic without taking control away from the user.  If both
a \s-1PT_PAX\s0 program header and an Extended Attribute field \*(L"user.pax\*(R" exist, then
both fields will be equally updated when the user modifies flags; unless the
\&\fB\-L\fR or \fB\-l\fR flags are given, in which case the markings are limiting to just
\&\s-1PT_PAX\s0 or \s-1XATTR_PAX\s0, respectively.  If only one marking is possible, then only that
marking will be updated.  Under no circumstances will \fBpaxctl-ng\fR create a \s-1PT_PAX\s0
program header as \fBpaxctl\fR does.  It will only attempt to create an \s-1XATTR_PAX\s0 Extended
Attribute field if it is instructed to do so with the \fB\-C\fR or \fB\-c\fR flags, and it
will attempt to synchronize the \s-1PT_PAX\s0 and \s-1XATTR_PAX\s0 markings if given the \fB\-F\fR or
\&\fB\-f\fR flags.  Finally, if the user wished, he can remvoe the Extended Attribute
field \*(L"user.pax\*(R" by running \fBpaxctl-ng\fR with the \fB\-d\fR flag.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-P\fR or \fB\-p\fR   Enable or disable \s-1PAGEEXEC\s0" 4
.IX Item "-P or -p   Enable or disable PAGEEXEC"
.PD 0
.IP "\fB\-S\fR or \fB\-s\fR   Enable or disable \s-1SEGMEXEC\s0" 4
.IX Item "-S or -s   Enable or disable SEGMEXEC"
.IP "\fB\-M\fR or \fB\-m\fR   Enable or disable \s-1MPROTECT\s0" 4
.IX Item "-M or -m   Enable or disable MPROTECT"
.IP "\fB\-E\fR or \fB\-e\fR   Enable or disable \s-1EMUTRAMP\s0" 4
.IX Item "-E or -e   Enable or disable EMUTRAMP"
.IP "\fB\-R\fR or \fB\-r\fR   Enable or disable \s-1RANDMMAP\s0" 4
.IX Item "-R or -r   Enable or disable RANDMMAP"
.IP "\fB\-X\fR or \fB\-x\fR   Enable or disable \s-1RANDEXEC\s0" 4
.IX Item "-X or -x   Enable or disable RANDEXEC"
.IP "" 4
.PD
If both enabling and disabling flags are set for one item, 
eg. \-Pp for \s-1PAGEEXEC\s0, then the default setting \- is used.
.IP "\fB\-Z\fR Set most secure settings (PSMeRx)" 4
.IX Item "-Z Set most secure settings (PSMeRx)"
.PD 0
.IP "\fB\-z\fR Set default setting (\-\-\-\-\-\-)" 4
.IX Item "-z Set default setting (------)"
.IP "\fB\-C\fR Create \s-1XATTR_PAX\s0 xattr with the most secure PaX settings" 4
.IX Item "-C Create XATTR_PAX xattr with the most secure PaX settings"
.IP "\fB\-c\fR Create \s-1XP_PAX\s0 xattr with the default PaX settings" 4
.IX Item "-c Create XP_PAX xattr with the default PaX settings"
.IP "\fB\-d\fR Delete \s-1XP_PAX\s0 xattr" 4
.IX Item "-d Delete XP_PAX xattr"
.IP "\fB\-F\fR Copy \s-1PT_PAX\s0 flags to \s-1XATTR_PAX\s0, if possible" 4
.IX Item "-F Copy PT_PAX flags to XATTR_PAX, if possible"
.IP "\fB\-f\fR Copy \s-1XATTR_PAX\s0 flags to \s-1PT_PAX\s0, if possible" 4
.IX Item "-f Copy XATTR_PAX flags to PT_PAX, if possible"
.IP "\fB\-L\fR Only set \s-1PT_APX\s0 flags, if both are possible" 4
.IX Item "-L Only set PT_APX flags, if both are possible"
.IP "\fB\-l\fR Only set \s-1XATTR_PAX\s0 flags, if both are possible" 4
.IX Item "-l Only set XATTR_PAX flags, if both are possible"
.IP "\fB\-v\fR View the flags" 4
.IX Item "-v View the flags"
.IP "\fB\-h\fR Print out a short help message and exit." 4
.IX Item "-h Print out a short help message and exit."
.PD
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
http://dev.gentoo.org/~blueness/elfix
.SH "REPORTING BUGS"
.IX Header "REPORTING BUGS"
Please report bugs at http://bugs.gentoo.org.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBscanelf\fR(1), \fBdumpelf\fR(1), \fBpaxctl\fR(1), \fBpspax\fR(1), \fBfix-gnustack\fR(1).
.SH "AUTHORS"
.IX Header "AUTHORS"
\&\fBAnthony G. Basile\fR <blueness@gentoo.org>