Add doc/revdep-pax.pod and remove EI_PAX docs from doc/paxctl*

1 files changed, 205 insertions, 0 deletions

diff --git a/doc/revdep-pax.1 b/doc/revdep-pax.1
new file mode 100644
index 0000000..944a57b
--- /dev/null
+++ b/doc/revdep-pax.1
@@ -0,0 +1,205 @@
+.\" 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 "REVDEP-PAX 1"
+.TH REVDEP-PAX 1 "2011-10-19" "elfix 0.2" "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"
+revdep\-pax \- find mismatching PaX markings between ELF objects and their libraries
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBrevdep-pax\fR \-f [\-v]
+.PP
+\&\fBrevdep-pax\fR \-r [\-v]
+.PP
+\&\fBrevdep-pax\fR \-b \s-1OBJECT\s0 [\-mv]
+.PP
+\&\fBrevdep-pax\fR \-s \s-1SONAME\s0 [\-mv]
+.PP
+\&\fBrevdep-pax\fR \-l \s-1LIBRARY\s0 [\-mv]
+.PP
+\&\fBrevdep-pax\fR [\-h]
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fBrevdep-pax\fR finds mismatching PaX markings between an \s-1ELF\s0 object and the
+libraries that object dynamically links against.  When executing an \s-1ELF\s0 binary
+that links against libraries, the PaX hardened kernel ignores the library
+markings and uses the executable markings for enforcing PaX restrictions.
+It is desireable in some circumstances to migrate back the library markings
+to the binaries.
+.PP
+revdep-pax can do its work by either starting from the object and mapping
+forwards to its libraries, or by starting from a library and mapping
+backwards to all the objects that link against it.  The library can either
+be specified by the \s-1SONAME\s0 as it is reported by \fBldd\fR(1), or by the full
+path to the \s-1LIBRARY\s0 file.  Symbolic links are dereferenced.  The user can
+optionally scan for all forward mappings on the system (\-f), for all reverse
+mappings (\-r), for forward mappings of just one \s-1OBJECT\s0 (\-b), for reverse
+mappings of just one \s-1SONAME\s0 (\-s) or one \s-1LIBRARY\s0 (\-l).  In verbose mode (\-v),
+all mappings are reported, not just mismatching ones, and in mark mode (\-m),
+the user is prompted whether to proceed with marking the found object so
+its PaX flags match its source.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-f\fR   Scan the system for all forward mappings" 4
+.IX Item "-f   Scan the system for all forward mappings"
+.PD 0
+.IP "" 4
+.IP "\fB\-r\fR   Scan the system for all reverse mappings" 4
+.IX Item "-r   Scan the system for all reverse mappings"
+.IP "" 4
+.IP "\fB\-b\fR   \s-1OBJECT\s0  Retrieve only the forward mappings for this \s-1ELF\s0 \s-1OBJECT\s0" 4
+.IX Item "-b   OBJECT  Retrieve only the forward mappings for this ELF OBJECT"
+.IP "" 4
+.IP "\fB\-s\fR   \s-1SONAME\s0  Retrieve only the reverse mappings for this \s-1SONAME\s0" 4
+.IX Item "-s   SONAME  Retrieve only the reverse mappings for this SONAME"
+.IP "" 4
+.IP "\fB\-l\fR   \s-1LIBRARY\s0 Retrieve only the reverse mappings for this \s-1LIBRARY\s0" 4
+.IX Item "-l   LIBRARY Retrieve only the reverse mappings for this LIBRARY"
+.IP "" 4
+.IP "\fB\-v\fR   Report all mappings, not just the mismatched ones" 4
+.IX Item "-v   Report all mappings, not just the mismatched ones"
+.IP "" 4
+.IP "\fB\-m\fR   Prompt the user to mark the found object with the PaX flags of the source" 4
+.IX Item "-m   Prompt the user to mark the found object with the PaX flags of the source"
+.IP "" 4
+.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), \fBldd\fR(1)
+.SH "AUTHORS"
+.IX Header "AUTHORS"
+\&\fBAnthony G. Basile\fR <blueness@gentoo.org>