eclass/pax-utils.eclass: address bad pax flag combos, bug #445948
[proj/hardened-dev.git] / eclass / pax-utils.eclass
1 # Copyright 1999-2012 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/pax-utils.eclass,v 1.18 2012/04/06 18:03:54 blueness Exp $
4
5 # @ECLASS: pax-utils.eclass
6 # @MAINTAINER:
7 # The Gentoo Linux Hardened Team <hardened@gentoo.org>
8 # @AUTHOR:
9 # Original Author: Kevin F. Quinn <kevquinn@gentoo.org>
10 # Modifications for bug #365825, @ ECLASS markup: Anthony G. Basile <blueness@gentoo.org>
11 # Modifications for bug #431092: Anthony G. Basile <blueness@gentoo.org>
12 # @BLURB: functions to provide pax markings
13 # @DESCRIPTION:
14 #
15 # This eclass provides support for manipulating PaX markings on ELF binaries,
16 # whether the system is using legacy PT_PAX markings or the newer XATTR_PAX.
17 # The eclass wraps the use of paxctl-ng, paxctl, set/getattr and scanelf utilities,
18 # deciding which to use depending on what's installed on the build host, and
19 # whether we're working with PT_PAX, XATTR_PAX or both.
20 #
21 # To control what markings are made, set PAX_MARKINGS in /etc/portage/make.conf
22 # to contain either "PT", "XT" or "none".  The default is to attempt both
23 # PT_PAX and XATTR_PAX.
24
25 if [[ ${___ECLASS_ONCE_PAX_UTILS} != "recur -_+^+_- spank" ]] ; then
26 ___ECLASS_ONCE_PAX_UTILS="recur -_+^+_- spank"
27
28 # Default to PT markings.
29 PAX_MARKINGS=${PAX_MARKINGS:="PT XT"}
30
31 # @FUNCTION: pax-mark
32 # @USAGE: <flags> {<ELF files>}
33 # @RETURN: Shell true if we succeed, shell false otherwise
34 # @DESCRIPTION:
35 # Marks <ELF files> with provided PaX <flags>
36 #
37 # Flags are passed directly to the utilities unchanged
38 #
39 #       p: disable PAGEEXEC             P: enable PAGEEXEC
40 #       e: disable EMUTRMAP             E: enable EMUTRMAP
41 #       m: disable MPROTECT             M: enable MPROTECT
42 #       r: disable RANDMMAP             R: enable RANDMMAP
43 #       s: disable SEGMEXEC             S: enable SEGMEXEC
44 #
45 # Default flags are 'PeMRS', which are the most restrictive settings.  Refer
46 # to http://pax.grsecurity.net/ for details on what these flags are all about.
47 #
48 # Please confirm any relaxation of restrictions with the Gentoo Hardened team.
49 # Either ask on the gentoo-hardened mailing list, or CC/assign hardened@g.o on
50 # the bug report.
51
52
53 sanitize-flags() {
54                 # Only the actual pax flags and z are accepted
55                 #
56                 # 1. The leading '-' is irrelevant since it is santized out
57                 #
58                 # 2. Cc only make sense for paxctl, and even there these are
59                 #    not needed as we progressively try:
60                 #        paxctl -q${flags}
61                 #        paxctl -qc${flags}
62                 #        paxctl -qC${flags}
63                 #    So we sanitize them out.
64                 #
65                 # 3. z is allowed for the default
66                 #
67
68         local flags="$1"
69         local clean=""
70
71         [[ "${flags}" != "${flags/z/}" ]] && clean="${clean}z"
72
73         [[ "${flags}" != "${flags/P/}" ]] && clean="${clean}P"
74         [[ "${flags}" != "${flags/p/}" ]] && clean="${clean}p"
75         [[ "${flags}" != "${flags/E/}" ]] && clean="${clean}E"
76         [[ "${flags}" != "${flags/e/}" ]] && clean="${clean}e"
77         [[ "${flags}" != "${flags/M/}" ]] && clean="${clean}M"
78         [[ "${flags}" != "${flags/m/}" ]] && clean="${clean}m"
79         [[ "${flags}" != "${flags/R/}" ]] && clean="${clean}R"
80         [[ "${flags}" != "${flags/r/}" ]] && clean="${clean}r"
81         [[ "${flags}" != "${flags/S/}" ]] && clean="${clean}S"
82         [[ "${flags}" != "${flags/s/}" ]] && clean="${clean}s"
83
84         echo "$clean"
85 }
86
87
88 pax-mark() {
89
90         local f                                                         # loop over paxables
91         local flags                                                     # pax flags
92         local pt_fail=0 pt_failures=""          # record PT_PAX failures
93         local xt_fail=0 xt_failures=""          # record xattr PAX marking failures
94         local ret=0                                                     # overal return code of this function
95
96         flags="$(sanitize-flags $1)"
97         shift
98
99         if has PT ${PAX_MARKINGS}; then
100
101                 #First try paxctl -> this might try to create/convert program headers
102                 if type -p paxctl > /dev/null; then
103                         einfo "PT PaX marking -${flags} with paxctl"
104                         _pax_list_files einfo "$@"
105                         for f in "$@"; do
106                                 # First, try modifying the existing PAX_FLAGS header
107                                 paxctl -q${flags} "${f}" && continue
108                                 # Second, try stealing the (unused under PaX) PT_GNU_STACK header
109                                 paxctl -qc${flags} "${f}" && continue
110                                 # Third, creating a PT_PAX header (works on ET_EXEC)
111                                 paxctl -qC${flags} "${f}" && continue
112                                 pt_fail=1
113                                 pt_failures="${pt_failures} ${f}"
114                         done
115
116                 #Next try paxctl-ng -> this will not create/convert any program headers
117                 elif type -p paxctl-ng > /dev/null && paxctl-ng -L ; then
118                         einfo "PT PaX marking -${flags} with paxctl-ng"
119                         _pax_list_files einfo "$@"
120                         for f in "$@"; do
121                                 paxctl-ng -L -${flags} "${f}" && continue
122                                 pt_fail=1
123                                 pt_failures="${pt_failures} ${f}"
124                         done
125
126                 #Finally fall back on scanelf
127                 elif type -p scanelf > /dev/null && [[ ${PAX_MARKINGS} != "none" ]]; then
128                         einfo "Fallback PaX marking -${flags} with scanelf"
129                         _pax_list_files einfo "$@"
130                         scanelf -Xxz ${flags} "$@"
131
132                 #We failed to set PT_PAX flags
133                 elif [[ ${PAX_MARKINGS} != "none" ]]; then
134                         pt_failures="$*"
135                         pt_fail=1
136                 fi
137
138                 if [[ ${pt_fail} == 1 ]]; then
139                         ewarn "Failed to set XT_PAX markings -${flags} for:"
140                         _pax_list_files ewarn ${pt_failures}
141                         ret=1
142                 fi
143         fi
144
145         if has XT ${PAX_MARKINGS}; then
146
147                 # z = default. For XATTR_PAX, the default is no xattr field at all
148                 local dodefault=""
149                 if [[ "${flags}" != "${flags/z/}" ]]; then
150                         flags="${flags/z/}"
151                         dodefault="yes"
152                 fi
153
154                 #First try paxctl-ng
155                 if type -p paxctl-ng > /dev/null && paxctl-ng -l ; then
156                         einfo "XT PaX marking -${flags} with paxctl-ng"
157                         _pax_list_files einfo "$@"
158                         for f in "$@"; do
159                                 [[ ${dodefault} == "yes" ]] && paxctl-ng -d "${f}"
160                                 paxctl-ng -l -${flags} "${f}" && continue
161                                 xt_fail=1
162                                 xt_failures="${tx_failures} ${f}"
163                         done
164
165                 #Next try setfattr
166                 elif type -p setfattr > /dev/null; then
167                         einfo "XT PaX marking -${flags} with setfattr"
168                         _pax_list_files einfo "$@"
169                         for f in "$@"; do
170                                 [[ ${dodefault} == "yes" ]] && setfattr -x "user.pax.flags" "${f}"
171                                 setfattr -n "user.pax.flags" -v "${flags}" "${f}" && continue
172                                 xt_fail=1
173                                 xt_failures="${tx_failures} ${f}"
174                         done
175
176                 #We failed to set PT_PAX flags
177                 elif [[ ${PAX_MARKINGS} != "none" ]]; then
178                         pt_failures="$*"
179                         pt_fail=1
180                 fi
181
182                 if [[ ${xt_fail} == 1 ]]; then
183                         ewarn "Failed to set XT_PAX markings -${flags} for:"
184                         _pax_list_files ewarn ${xt_failures}
185                         ret=1
186                 fi
187         fi
188
189         [[ ${ret} == 1 ]] && ewarn "Executables may be killed by PaX kernels."
190
191         return ${ret}
192 }
193
194 # @FUNCTION: list-paxables
195 # @USAGE: {<files>}
196 # @RETURN: Subset of {<files>} which are ELF executables or shared objects
197 # @DESCRIPTION:
198 # Print to stdout all of the <files> that are suitable to have PaX flag
199 # markings, i.e., filter out the ELF executables or shared objects from a list
200 # of files.  This is useful for passing wild-card lists to pax-mark, although
201 # in general it is preferable for ebuilds to list precisely which ELFS are to
202 # be marked.  Often not all the ELF installed by a package need remarking.
203 # @EXAMPLE:
204 # pax-mark -m $(list-paxables ${S}/{,usr/}bin/*)
205 list-paxables() {
206         file "$@" 2> /dev/null | grep -E 'ELF.*(executable|shared object)' | sed -e 's/: .*$//'
207 }
208
209 # @FUNCTION: host-is-pax
210 # @RETURN: Shell true if the build process is PaX enabled, shell false otherwise
211 # @DESCRIPTION:
212 # This is intended for use where the build process must be modified conditionally
213 # depending on whether the host is PaX enabled or not.  It is not intedened to
214 # determine whether the final binaries need PaX markings.  Note: if procfs is
215 # not mounted on /proc, this returns shell false (e.g. Gentoo/FBSD).
216 host-is-pax() {
217         grep -qs ^PaX: /proc/self/status
218 }
219
220
221 # INTERNAL FUNCTIONS
222 # ------------------
223 #
224 # These functions are for use internally by the eclass - do not use
225 # them elsewhere as they are not supported (i.e. they may be removed
226 # or their function may change arbitratily).
227
228 # Display a list of things, one per line, indented a bit, using the
229 # display command in $1.
230 _pax_list_files() {
231         local f cmd
232         cmd=$1
233         shift
234         for f in "$@"; do
235                 ${cmd} "     ${f}"
236         done
237 }
238
239 fi