diff options
author | Anthony G. Basile <blueness@gentoo.org> | 2011-09-18 12:01:01 -0400 |
---|---|---|
committer | Anthony G. Basile <blueness@gentoo.org> | 2011-09-18 12:01:01 -0400 |
commit | 823bca2775589539ab4c0d0f04e5401e1103f01f (patch) | |
tree | d37277e461b1b28df7f18dd84f7480906317922a /doc | |
parent | src/paxctl-ng.c: set PT_PAX flags (diff) | |
download | elfix-823bca2775589539ab4c0d0f04e5401e1103f01f.tar.gz elfix-823bca2775589539ab4c0d0f04e5401e1103f01f.tar.bz2 elfix-823bca2775589539ab4c0d0f04e5401e1103f01f.zip |
doc/make.sh: switched fix-gnustack.1 to pod generated
Diffstat (limited to 'doc')
-rw-r--r-- | doc/fix-gnustack.1 | 196 | ||||
-rw-r--r-- | doc/fix-gnustack.pod | 41 | ||||
-rwxr-xr-x | doc/make.sh | 14 | ||||
-rw-r--r-- | doc/paxctl-ng-design.txt | 2 |
4 files changed, 215 insertions, 38 deletions
diff --git a/doc/fix-gnustack.1 b/doc/fix-gnustack.1 index 79447bd..0b98b51 100644 --- a/doc/fix-gnustack.1 +++ b/doc/fix-gnustack.1 @@ -1,39 +1,161 @@ -.TH "fix-gnustack" "1" "14 April 2011" "fix-gnustack Manual" "Documentation for elfix" -.SH NAME -fix-gnustack \- Query or clear the ELF GNU_STACK executable flag -.SH SYNOPSIS -.B fix-gnustack -scans the program headers of ELF binaries or shared object libraries -and reports if a GNU_STACK entry is marked both writeable and executable. -On PaX hardened kernels where memory protection (MPROTECT) is enforced, -execution of binaries with WX GNU_STACKS, or binaries linking against -libraries with WX GNU_STACKS, is terminated by the kernel. When -.B fix-gnustack -is called without the -.B \-f -option, it simply reports the RWX (read/write/execute) flags on any GNU_STACK -found. When called with the -.B \-f -option, it clears the X flag if both W and X are found. -.RB [option]\ ELF -.SH DESCRIPTION -.B fix-gnustack -is a program which -.SH OPTIONS -.TP -.B \-f -Remove the X flag (fix). +.\" 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 "FIX-GNUSTACK 1" +.TH FIX-GNUSTACK 1 "2011-04-14" "elfix 0.1" "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" +fix\-gnustack \- Query or clear the ELF GNU_STACK executable flag +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBfix-gnustack\fR scans the program headers of \s-1ELF\s0 binaries or shared +object libraries and reports if a \s-1GNU_STACK\s0 entry is marked both +writeable and executable. On PaX hardened kernels where memory +protection (\s-1MPROTECT\s0) is enforced, execution of binaries with \s-1WX\s0 +\&\s-1GNU_STACKS\s0, or binaries linking against libraries with \s-1WX\s0 \s-1GNU_STACKS\s0, +is terminated by the kernel. When \fBfix-gnustack\fR is called without +the \fB\-f\fR option, it simply reports the \s-1RWX\s0 (read/write/execute) +flags on any \s-1GNU_STACK\s0 found. When called with the \fB\-f\fR option, +it clears the X flag if both W and X are found. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Remove the X flag, i.e., \*(L"fix\*(R" the executable. .SH "HOMEPAGE" -.PP -\m[blue]\fBhttp://dev\&.gentoo\&.org/\&~blueness/elfix\fR\m[] +.IX Header "HOMEPAGE" +http://dev.gentoo.org/~blueness/elfix .SH "REPORTING BUGS" -.PP -\m[blue]\fBhttp://bugs\&.gentoo\&.org\fR\m[] -.SH SEE ALSO -.BR scanelf (1), -.BR dumpelf (1), -.BR paxctl (1), -.BR pspax (1). -.SH AUTHORS -.B Anthony G. Basile -<blueness@gentoo.org> +.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), \fBpaxctl-ng\fR(1), \fBpspax\fR(1). +.SH "AUTHORS" +.IX Header "AUTHORS" +\&\fBAnthony G. Basile\fR <blueness@gentoo.org> diff --git a/doc/fix-gnustack.pod b/doc/fix-gnustack.pod new file mode 100644 index 0000000..3c6f6ba --- /dev/null +++ b/doc/fix-gnustack.pod @@ -0,0 +1,41 @@ +=head1 NAME + +B<fix-gnustack> - Query or clear the ELF GNU_STACK executable flag + +=head1 SYNOPSIS + +B<fix-gnustack> scans the program headers of ELF binaries or shared +object libraries and reports if a GNU_STACK entry is marked both +writeable and executable. On PaX hardened kernels where memory +protection (MPROTECT) is enforced, execution of binaries with WX +GNU_STACKS, or binaries linking against libraries with WX GNU_STACKS, +is terminated by the kernel. When B<fix-gnustack> is called without +the B<-f> option, it simply reports the RWX (read/write/execute) +flags on any GNU_STACK found. When called with the B<-f> option, +it clears the X flag if both W and X are found. + +=head1 OPTIONS + +=over + +=item B<-f> + +Remove the X flag, i.e., "fix" the executable. + +=back + +=head1 HOMEPAGE + +http://dev.gentoo.org/~blueness/elfix + +=head1 REPORTING BUGS + +Please report bugs at http://bugs.gentoo.org. + +=head1 SEE ALSO + +B<scanelf>(1), B<dumpelf>(1), B<paxctl>(1), B<paxctl-ng>(1), B<pspax>(1). + +=head1 AUTHORS + +B<Anthony G. Basile> <blueness@gentoo.org> diff --git a/doc/make.sh b/doc/make.sh new file mode 100755 index 0000000..fc81032 --- /dev/null +++ b/doc/make.sh @@ -0,0 +1,14 @@ +#!/bin/sh + +#Run this on developer side, and distribute troff +#in case the end user doesn't have pod2man + +rm -f fix-gnustack.1 + +pod2man \ + --official \ + --section="1" \ + --release="elfix 0.1" \ + --center="Documentation for elfix" \ + --date="2011-04-14" \ + fix-gnustack.pod > fix-gnustack.1 diff --git a/doc/paxctl-ng-design.txt b/doc/paxctl-ng-design.txt index 9d837cf..9de06a0 100644 --- a/doc/paxctl-ng-design.txt +++ b/doc/paxctl-ng-design.txt @@ -33,7 +33,7 @@ future, we propose the following standards to how pax markings are treated: 1) The kernel. The kernel will be patched to force respect of PT_PAX markings first, and only if these are missing, revert to EI_PAX. If both markings are -misssing, then the kernel will revert to enforcing maximum protection, meaning +missing, then the kernel will revert to enforcing maximum protection, meaning PAGEEXEC enabled SEGMEXEC enabled |