xref: /freebsd/usr.sbin/crunch/crunchide/exec_elf32.c (revision 6c925b9c81036a86db387f75a32b423420eadf6c)
1 /*
2  * Copyright (c) 1997 Christopher G. Demetriou.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  * 3. All advertising materials mentioning features or use of this software
13  *    must display the following acknowledgement:
14  *      This product includes software developed by Christopher G. Demetriou
15  *	for the NetBSD Project.
16  * 4. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #include <sys/cdefs.h>
32 #ifndef lint
33 #if 0
34 __RCSID("$NetBSD: exec_elf32.c,v 1.6 1999/09/20 04:12:16 christos Exp $");
35 #endif
36 #endif
37 __FBSDID("$FreeBSD$");
38 
39 #ifndef ELFSIZE
40 #define ELFSIZE         32
41 #endif
42 
43 #include <sys/types.h>
44 #include <sys/endian.h>
45 #include <sys/stat.h>
46 
47 #include <errno.h>
48 #include <limits.h>
49 #include <stddef.h>
50 #include <stdio.h>
51 #include <stdlib.h>
52 #include <string.h>
53 #include <unistd.h>
54 
55 #include "extern.h"
56 
57 #if (defined(NLIST_ELF32) && (ELFSIZE == 32)) || \
58     (defined(NLIST_ELF64) && (ELFSIZE == 64))
59 
60 #define	__ELF_WORD_SIZE ELFSIZE
61 #if (ELFSIZE == 32)
62 #include <sys/elf32.h>
63 #define	xewtoh(x)	((data == ELFDATA2MSB) ? be32toh(x) : le32toh(x))
64 #define	htoxew(x)	((data == ELFDATA2MSB) ? htobe32(x) : htole32(x))
65 #define	wewtoh(x)	((data == ELFDATA2MSB) ? be32toh(x) : le32toh(x))
66 #define	htowew(x)	((data == ELFDATA2MSB) ? htobe32(x) : htole32(x))
67 #elif (ELFSIZE == 64)
68 #include <sys/elf64.h>
69 #define	xewtoh(x)	((data == ELFDATA2MSB) ? be64toh(x) : le64toh(x))
70 #define	htoxew(x)	((data == ELFDATA2MSB) ? htobe64(x) : htole64(x))
71 /* elf64 Elf64_Word are 32 bits */
72 #define	wewtoh(x)	((data == ELFDATA2MSB) ? be32toh(x) : le32toh(x))
73 #define	htowew(x)	((data == ELFDATA2MSB) ? htobe32(x) : htole32(x))
74 #endif
75 #include <sys/elf_generic.h>
76 
77 #define CONCAT(x,y)     __CONCAT(x,y)
78 #define ELFNAME(x)      CONCAT(elf,CONCAT(ELFSIZE,CONCAT(_,x)))
79 #define ELFNAME2(x,y)   CONCAT(x,CONCAT(_elf,CONCAT(ELFSIZE,CONCAT(_,y))))
80 #define ELFNAMEEND(x)   CONCAT(x,CONCAT(_elf,ELFSIZE))
81 #define ELFDEFNNAME(x)  CONCAT(ELF,CONCAT(ELFSIZE,CONCAT(_,x)))
82 #ifndef ELFCLASS
83 #define ELFCLASS	CONCAT(ELFCLASS,ELFSIZE)
84 #endif
85 
86 #define	xe16toh(x)	((data == ELFDATA2MSB) ? be16toh(x) : le16toh(x))
87 #define	xe32toh(x)	((data == ELFDATA2MSB) ? be32toh(x) : le32toh(x))
88 #define	htoxe32(x)	((data == ELFDATA2MSB) ? htobe32(x) : htole32(x))
89 
90 struct shlayout {
91 	Elf_Shdr *shdr;
92 	void *bufp;
93 };
94 
95 static ssize_t
96 xreadatoff(int fd, void *buf, off_t off, size_t size, const char *fn)
97 {
98 	ssize_t rv;
99 
100 	if (lseek(fd, off, SEEK_SET) != off) {
101 		perror(fn);
102 		return -1;
103 	}
104 	if ((size_t)(rv = read(fd, buf, size)) != size) {
105 		fprintf(stderr, "%s: read error: %s\n", fn,
106 		    rv == -1 ? strerror(errno) : "short read");
107 		return -1;
108 	}
109 	return size;
110 }
111 
112 static ssize_t
113 xwriteatoff(int fd, void *buf, off_t off, size_t size, const char *fn)
114 {
115 	ssize_t rv;
116 
117 	if (lseek(fd, off, SEEK_SET) != off) {
118 		perror(fn);
119 		return -1;
120 	}
121 	if ((size_t)(rv = write(fd, buf, size)) != size) {
122 		fprintf(stderr, "%s: write error: %s\n", fn,
123 		    rv == -1 ? strerror(errno) : "short write");
124 		return -1;
125 	}
126 	return size;
127 }
128 
129 static void *
130 xmalloc(size_t size, const char *fn, const char *use)
131 {
132 	void *rv;
133 
134 	rv = malloc(size);
135 	if (rv == NULL)
136 		fprintf(stderr, "%s: out of memory (allocating for %s)\n",
137 		    fn, use);
138 	return (rv);
139 }
140 
141 static void *
142 xrealloc(void *ptr, size_t size, const char *fn, const char *use)
143 {
144 	void *rv;
145 
146 	rv = realloc(ptr, size);
147 	if (rv == NULL) {
148 		free(ptr);
149 		fprintf(stderr, "%s: out of memory (reallocating for %s)\n",
150 		    fn, use);
151 	}
152 	return (rv);
153 }
154 
155 int
156 ELFNAMEEND(check)(int fd, const char *fn)
157 {
158 	Elf_Ehdr eh;
159 	struct stat sb;
160 	unsigned char data;
161 
162 	/*
163 	 * Check the header to maek sure it's an ELF file (of the
164 	 * appropriate size).
165 	 */
166 	if (fstat(fd, &sb) == -1)
167 		return 0;
168 	if (sb.st_size < (off_t)(sizeof eh))
169 		return 0;
170 	if (read(fd, &eh, sizeof eh) != sizeof eh)
171 		return 0;
172 
173 	if (IS_ELF(eh) == 0 || eh.e_ident[EI_CLASS] != ELFCLASS)
174                 return 0;
175 
176 	data = eh.e_ident[EI_DATA];
177 
178 	switch (xe16toh(eh.e_machine)) {
179 	case EM_386: break;
180 	case EM_ALPHA: break;
181 #ifndef EM_AARCH64
182 #define	EM_AARCH64	183
183 #endif
184 	case EM_AARCH64: break;
185 	case EM_ARM: break;
186 	case EM_MIPS: break;
187 	case /* EM_MIPS_RS3_LE */ EM_MIPS_RS4_BE: break;
188 	case EM_PPC: break;
189 	case EM_PPC64: break;
190 #ifndef EM_RISCV
191 #define	EM_RISCV	243
192 #endif
193 	case EM_RISCV: break;
194 	case EM_SPARCV9: break;
195 	case EM_X86_64: break;
196 /*        ELFDEFNNAME(MACHDEP_ID_CASES) */
197 
198         default:
199                 return 0;
200         }
201 
202 	return 1;
203 }
204 
205 /*
206  * This function 'hides' (some of) ELF executable file's symbols.
207  * It hides them by renaming them to "_$$hide$$ <filename> <symbolname>".
208  * Symbols in the global keep list, or which are marked as being undefined,
209  * are left alone.
210  *
211  * An old version of this code shuffled various tables around, turning
212  * global symbols to be hidden into local symbols.  That lost on the
213  * mips, because CALL16 relocs must reference global symbols, and, if
214  * those symbols were being hidden, they were no longer global.
215  *
216  * The new renaming behaviour doesn't take global symbols out of the
217  * namespace.  However, it's ... unlikely that there will ever be
218  * any collisions in practice because of the new method.
219  */
220 int
221 ELFNAMEEND(hide)(int fd, const char *fn)
222 {
223 	Elf_Ehdr ehdr;
224 	struct shlayout *layoutp = NULL;
225 	Elf_Shdr *shdrp = NULL, *symtabshdr, *strtabshdr, *shstrtabshdr;
226 	Elf_Shdr shdrshdr;
227 	Elf_Sym *symtabp = NULL;
228 	char *shstrtabp = NULL, *strtabp = NULL;
229 	Elf_Size nsyms, ewi;
230 	Elf_Off off;
231 	ssize_t shdrsize;
232 	int rv, i, weird, l, m, r, strtabidx;
233 	size_t nstrtab_size, nstrtab_nextoff, fn_size, size;
234 	char *nstrtabp = NULL;
235 	unsigned char data;
236 	const char *weirdreason = NULL;
237 	void *buf;
238 	Elf_Half shnum;
239 
240 	rv = 0;
241 	if (xreadatoff(fd, &ehdr, 0, sizeof ehdr, fn) != sizeof ehdr)
242 		goto bad;
243 
244 	data = ehdr.e_ident[EI_DATA];
245 	shnum = xe16toh(ehdr.e_shnum);
246 
247 	shdrsize = shnum * xe16toh(ehdr.e_shentsize);
248 	if ((shdrp = xmalloc(shdrsize, fn, "section header table")) == NULL)
249 		goto bad;
250 	if (xreadatoff(fd, shdrp, xewtoh(ehdr.e_shoff), shdrsize, fn) !=
251 	    shdrsize)
252 		goto bad;
253 
254 	symtabshdr = strtabshdr = shstrtabshdr = NULL;
255 	weird = 0;
256 	for (i = 0; i < shnum; i++) {
257 		switch (xe32toh(shdrp[i].sh_type)) {
258 		case SHT_SYMTAB:
259 			if (symtabshdr != NULL) {
260 				weird = 1;
261 				weirdreason = "multiple symbol tables";
262 			}
263 			symtabshdr = &shdrp[i];
264 			strtabshdr = &shdrp[xe32toh(shdrp[i].sh_link)];
265 			break;
266 		case SHT_STRTAB:
267 			if (i == xe16toh(ehdr.e_shstrndx))
268 				shstrtabshdr = &shdrp[i];
269 			break;
270 		}
271 	}
272 	if (symtabshdr == NULL)
273 		goto out;
274 	if (strtabshdr == NULL) {
275 		weird = 1;
276 		weirdreason = "string table does not exist";
277 	}
278 	if (shstrtabshdr == NULL) {
279 		weird = 1;
280 		weirdreason = "section header string table does not exist";
281 	}
282 	if (strtabshdr == shstrtabshdr) {
283 		weird = 1;
284 		weirdreason = "combined strtab and shstrtab not supported";
285 	}
286 	if (weirdreason == NULL)
287 		weirdreason = "unsupported";
288 	if (weird) {
289 		fprintf(stderr, "%s: weird executable (%s)\n", fn, weirdreason);
290 		goto bad;
291 	}
292 
293 	/*
294 	 * sort section layout table by offset
295 	 */
296 	layoutp = xmalloc((shnum + 1) * sizeof(struct shlayout),
297 	    fn, "layout table");
298 	if (layoutp == NULL)
299 		goto bad;
300 
301 	/* add a pseudo entry to represent the section header table */
302 	shdrshdr.sh_offset = ehdr.e_shoff;
303 	shdrshdr.sh_size = htoxew(shdrsize);
304 	shdrshdr.sh_addralign = htoxew(ELFSIZE / 8);
305 	layoutp[shnum].shdr = &shdrshdr;
306 
307 	/* insert and sort normal section headers */
308 	for (i = shnum; i-- != 0;) {
309 		l = i + 1;
310 		r = shnum;
311 		while (l <= r) {
312 			m = ( l + r) / 2;
313 			if (xewtoh(shdrp[i].sh_offset) >
314 			    xewtoh(layoutp[m].shdr->sh_offset))
315 				l = m + 1;
316 			else
317 				r = m - 1;
318 		}
319 
320 		if (r != i) {
321 			memmove(&layoutp[i], &layoutp[i + 1],
322 			    sizeof(struct shlayout) * (r - i));
323 		}
324 
325 		layoutp[r].shdr = &shdrp[i];
326 		layoutp[r].bufp = NULL;
327 	}
328 	++shnum;
329 
330 	/*
331 	 * load up everything we need
332 	 */
333 
334 	/* load section string table for debug use */
335 	if ((size = xewtoh(shstrtabshdr->sh_size)) == 0)
336 		goto bad;
337 	if ((shstrtabp = xmalloc(size, fn, "section string table")) == NULL)
338 		goto bad;
339 	if ((size_t)xreadatoff(fd, shstrtabp, xewtoh(shstrtabshdr->sh_offset),
340 	    size, fn) != size)
341 		goto bad;
342 	if (shstrtabp[size - 1] != '\0')
343 		goto bad;
344 
345 	/* we need symtab, strtab, and everything behind strtab */
346 	strtabidx = INT_MAX;
347 	for (i = 0; i < shnum; i++) {
348 		if (layoutp[i].shdr == &shdrshdr) {
349 			/* not load section header again */
350 			layoutp[i].bufp = shdrp;
351 			continue;
352 		}
353 		if (layoutp[i].shdr == shstrtabshdr) {
354 			/* not load section string table again */
355 			layoutp[i].bufp = shstrtabp;
356 			continue;
357 		}
358 
359 		if (layoutp[i].shdr == strtabshdr)
360 			strtabidx = i;
361 		if (layoutp[i].shdr == symtabshdr || i >= strtabidx) {
362 			off = xewtoh(layoutp[i].shdr->sh_offset);
363 			if ((size = xewtoh(layoutp[i].shdr->sh_size)) == 0)
364 				goto bad;
365 			layoutp[i].bufp = xmalloc(size, fn,
366 			    shstrtabp + xewtoh(layoutp[i].shdr->sh_name));
367 			if (layoutp[i].bufp == NULL)
368 				goto bad;
369 			if ((size_t)xreadatoff(fd, layoutp[i].bufp, off, size, fn) !=
370 			    size)
371 				goto bad;
372 
373 			/* set symbol table and string table */
374 			if (layoutp[i].shdr == symtabshdr) {
375 				symtabp = layoutp[i].bufp;
376 			} else if (layoutp[i].shdr == strtabshdr) {
377 				strtabp = layoutp[i].bufp;
378 				if (strtabp[size - 1] != '\0')
379 					goto bad;
380 			}
381 		}
382 	}
383 
384 	nstrtab_size = 256;
385 	nstrtabp = xmalloc(nstrtab_size, fn, "new string table");
386 	if (nstrtabp == NULL)
387 		goto bad;
388 	nstrtab_nextoff = 0;
389 
390 	fn_size = strlen(fn);
391 
392 	/* Prepare data structures for symbol movement. */
393 	nsyms = xewtoh(symtabshdr->sh_size) / xewtoh(symtabshdr->sh_entsize);
394 
395 	/* move symbols, making them local */
396 	for (ewi = 0; ewi < nsyms; ewi++) {
397 		Elf_Sym *sp = &symtabp[ewi];
398 		const char *symname = strtabp + xe32toh(sp->st_name);
399 		size_t newent_len;
400 		/*
401 		 * make sure there's size for the next entry, even if it's
402 		 * as large as it can be.
403 		 *
404 		 * "_$$hide$$ <filename> <symname><NUL>" ->
405 		 *    9 + 3 + sizes of fn and sym name
406 		 */
407 		while ((nstrtab_size - nstrtab_nextoff) <
408 		    strlen(symname) + fn_size + 12) {
409 			nstrtab_size *= 2;
410 			nstrtabp = xrealloc(nstrtabp, nstrtab_size, fn,
411 			    "new string table");
412 			if (nstrtabp == NULL)
413 				goto bad;
414 		}
415 
416 		sp->st_name = htowew(nstrtab_nextoff);
417 
418 		/* if it's a keeper or is undefined, don't rename it. */
419 		if (in_keep_list(symname) ||
420 		    (xe16toh(sp->st_shndx) == SHN_UNDEF)) {
421 			newent_len = sprintf(nstrtabp + nstrtab_nextoff,
422 			    "%s", symname) + 1;
423 		} else {
424 			newent_len = sprintf(nstrtabp + nstrtab_nextoff,
425 			    "_$$hide$$ %s %s", fn, symname) + 1;
426 		}
427 		nstrtab_nextoff += newent_len;
428 	}
429 	strtabshdr->sh_size = htoxew(nstrtab_nextoff);
430 
431 	/*
432 	 * update section header table in ascending order of offset
433 	 */
434 	for (i = strtabidx + 1; i < shnum; i++) {
435 		Elf_Off off, align;
436 		off = xewtoh(layoutp[i - 1].shdr->sh_offset) +
437 		    xewtoh(layoutp[i - 1].shdr->sh_size);
438 		align = xewtoh(layoutp[i].shdr->sh_addralign);
439 		off = (off + (align - 1)) & ~(align - 1);
440 		layoutp[i].shdr->sh_offset = htoxew(off);
441 	}
442 
443 	/*
444 	 * write data to the file in descending order of offset
445 	 */
446 	for (i = shnum; i-- != 0;) {
447 		if (layoutp[i].shdr == strtabshdr) {
448 			/* new string table */
449 			buf = nstrtabp;
450 		} else
451 			buf = layoutp[i].bufp;
452 
453 		if (layoutp[i].shdr == &shdrshdr ||
454 		    layoutp[i].shdr == symtabshdr || i >= strtabidx) {
455 			if (buf == NULL)
456 				goto bad;
457 
458 			/*
459 			 * update the offset of section header table in elf
460 			 * header if needed.
461 			 */
462 			if (layoutp[i].shdr == &shdrshdr &&
463 			    ehdr.e_shoff != shdrshdr.sh_offset) {
464 				ehdr.e_shoff = shdrshdr.sh_offset;
465 				off = offsetof(Elf_Ehdr, e_shoff);
466 				size = sizeof(Elf_Off);
467 				if ((size_t)xwriteatoff(fd, &ehdr.e_shoff, off, size,
468 				    fn) != size)
469 					goto bad;
470 			}
471 
472 			off = xewtoh(layoutp[i].shdr->sh_offset);
473 			size = xewtoh(layoutp[i].shdr->sh_size);
474 			if ((size_t)xwriteatoff(fd, buf, off, size, fn) != size)
475 				goto bad;
476 		}
477 	}
478 
479 out:
480 	if (layoutp != NULL) {
481 		for (i = 0; i < shnum; i++) {
482 			if (layoutp[i].bufp != NULL)
483 				free(layoutp[i].bufp);
484 		}
485 		free(layoutp);
486 	}
487 	free(nstrtabp);
488 	return (rv);
489 
490 bad:
491 	rv = 1;
492 	goto out;
493 }
494 
495 #endif /* include this size of ELF */
496