2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2019 The FreeBSD Foundation.
6 * This software was developed by Bora Ozarslan under sponsorship from
7 * the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/param.h>
32 #include <sys/elf_common.h>
33 #include <sys/endian.h>
49 __FBSDID("$FreeBSD$");
51 static bool convert_to_feature_val(char *, uint32_t *);
52 static bool edit_file_features(Elf *, int, int, char *);
53 static bool get_file_features(Elf *, int, int, uint32_t *, uint64_t *);
54 static void print_features(void);
55 static bool print_file_features(Elf *, int, int, char *);
56 static void usage(void);
58 struct ControlFeatures {
64 static struct ControlFeatures featurelist[] = {
65 { "aslr", NT_FREEBSD_FCTL_ASLR_DISABLE, "Disable ASLR" },
66 { "protmax", NT_FREEBSD_FCTL_PROTMAX_DISABLE,
67 "Disable implicit PROT_MAX" },
68 { "stackgap", NT_FREEBSD_FCTL_STKGAP_DISABLE, "Disable stack gap" },
69 { "wxneeded", NT_FREEBSD_FCTL_WXNEEDED, "Requires W+X mappings" },
72 static struct option long_opts[] = {
73 { "help", no_argument, NULL, 'h' },
77 #if BYTE_ORDER == LITTLE_ENDIAN
78 #define SUPPORTED_ENDIAN ELFDATA2LSB
80 #define SUPPORTED_ENDIAN ELFDATA2MSB
84 main(int argc, char **argv)
91 bool editfeatures, lflag;
98 if (elf_version(EV_CURRENT) == EV_NONE)
99 errx(EXIT_FAILURE, "elf_version error");
101 while ((ch = getopt_long(argc, argv, "hle:", long_opts, NULL)) != -1) {
122 warnx("no file(s) specified");
130 if ((fd = open(argv[0],
131 editfeatures ? O_RDWR : O_RDONLY, 0)) < 0) {
132 warn("error opening file %s", argv[0]);
137 if ((elf = elf_begin(fd, ELF_C_READ, NULL)) == NULL) {
138 warnx("elf_begin failed: %s", elf_errmsg(-1));
143 if ((kind = elf_kind(elf)) != ELF_K_ELF) {
144 if (kind == ELF_K_AR)
145 warnx("file '%s' is an archive", argv[0]);
147 warnx("file '%s' is not an ELF file", argv[0]);
152 if (gelf_getehdr(elf, &ehdr) == NULL) {
153 warnx("gelf_getehdr: %s", elf_errmsg(-1));
158 * XXX need to support cross-endian operation, but for now
159 * exit on error rather than misbehaving.
161 if (ehdr.e_ident[EI_DATA] != SUPPORTED_ENDIAN) {
162 warnx("file endianness must match host");
168 if (!print_file_features(elf, ehdr.e_phnum, fd,
173 } else if (!edit_file_features(elf, ehdr.e_phnum, fd,
192 #define USAGE_MESSAGE \
194 Usage: %s [options] file...\n\
195 Set or display the control features for an ELF object.\n\n\
196 Supported options are:\n\
197 -l List known control features.\n\
198 -e [+-=]feature,list Edit features from a comma separated list.\n\
199 -h | --help Print a usage message and exit.\n"
205 fprintf(stderr, USAGE_MESSAGE, ELFTC_GETPROGNAME());
210 convert_to_feature_val(char *feature_str, uint32_t *feature_val)
218 operation = *feature_str;
220 len = nitems(featurelist);
221 while ((feature = strsep(&feature_str, ",")) != NULL) {
222 for (i = 0; i < len; ++i) {
223 if (strcmp(featurelist[i].alias, feature) == 0) {
224 input |= featurelist[i].value;
229 warnx("%s is not a valid feature", feature);
234 if (operation == '+') {
235 *feature_val |= input;
236 } else if (operation == '=') {
237 *feature_val = input;
238 } else if (operation == '-') {
239 *feature_val &= ~input;
241 warnx("'%c' not an operator - use '+', '-', '='",
249 edit_file_features(Elf *elf, int phcount, int fd, char *val)
254 if (!get_file_features(elf, phcount, fd, &features, &off)) {
255 warnx("NT_FREEBSD_FEATURE_CTL note not found");
259 if (!convert_to_feature_val(val, &features))
262 if (lseek(fd, off, SEEK_SET) == -1 ||
263 write(fd, &features, sizeof(features)) <
264 (ssize_t)sizeof(features)) {
265 warnx("error writing feature value");
276 printf("Known features are:\n");
277 for (i = 0; i < nitems(featurelist); ++i)
278 printf("%-16s%s\n", featurelist[i].alias,
279 featurelist[i].desc);
283 print_file_features(Elf *elf, int phcount, int fd, char *filename)
288 if (!get_file_features(elf, phcount, fd, &features, NULL)) {
292 printf("File '%s' features:\n", filename);
293 for (i = 0; i < nitems(featurelist); ++i) {
294 printf("%-16s'%s' is ", featurelist[i].alias,
295 featurelist[i].desc);
297 if ((featurelist[i].value & features) == 0)
306 get_file_features(Elf *elf, int phcount, int fd, uint32_t *features,
311 unsigned long read_total;
312 int namesz, descsz, i;
316 * Go through each program header to find one that is of type PT_NOTE
317 * and has a note for feature control.
319 for (i = 0; i < phcount; ++i) {
320 if (gelf_getphdr(elf, i, &phdr) == NULL) {
321 warnx("gelf_getphdr failed: %s", elf_errmsg(-1));
325 if (phdr.p_type != PT_NOTE)
328 if (lseek(fd, phdr.p_offset, SEEK_SET) < 0) {
329 warn("lseek() failed:");
334 while (read_total < phdr.p_filesz) {
335 if (read(fd, ¬e, sizeof(note)) <
336 (ssize_t)sizeof(note)) {
337 warnx("elf note header too short");
340 read_total += sizeof(note);
343 * XXX: Name and descriptor are 4 byte aligned, however,
344 * the size given doesn't include the padding.
346 namesz = roundup2(note.n_namesz, 4);
347 name = malloc(namesz);
349 warn("malloc() failed.");
352 descsz = roundup2(note.n_descsz, 4);
353 if (read(fd, name, namesz) < namesz) {
354 warnx("elf note name too short");
358 read_total += namesz;
360 if (note.n_namesz != 8 ||
361 strncmp("FreeBSD", name, 7) != 0 ||
362 note.n_type != NT_FREEBSD_FEATURE_CTL) {
363 /* Not the right note. Skip the description */
364 if (lseek(fd, descsz, SEEK_CUR) < 0) {
365 warn("lseek() failed.");
369 read_total += descsz;
374 if (note.n_descsz < sizeof(uint32_t)) {
375 warnx("Feature descriptor can't "
376 "be less than 4 bytes");
382 * XXX: For now we look at only 4 bytes of the
383 * descriptor. This should respect descsz.
385 if (note.n_descsz > sizeof(uint32_t))
386 warnx("Feature note is bigger than expected");
387 if (read(fd, features, sizeof(uint32_t)) <
388 (ssize_t)sizeof(uint32_t)) {
389 warnx("feature note data too short");
394 *off = phdr.p_offset + read_total;
400 warnx("NT_FREEBSD_FEATURE_CTL note not found");