blob: d48b2ea606e12e4fa7324442a7b6dc5e8afe80e9 [file] [log] [blame]
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +00001/* vi: set sw=4 ts=4: */
2/*
Denis Vlasenko724d1962007-10-10 14:41:07 +00003 * Utility routines.
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +00004 *
Denis Vlasenko724d1962007-10-10 14:41:07 +00005 * Copyright (C) tons of folks. Tracking down who wrote what
6 * isn't something I'm going to worry about... If you wrote something
7 * here, please feel free to acknowledge your work.
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +00008 *
Denis Vlasenko724d1962007-10-10 14:41:07 +00009 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +020010 * Permission has been granted to redistribute this code under GPL.
Denis Vlasenko724d1962007-10-10 14:41:07 +000011 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +020012 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000013 */
Denis Vlasenko79cedcb2008-04-08 21:13:28 +000014/* We are trying to not use printf, this benefits the case when selected
15 * applets are really simple. Example:
16 *
17 * $ ./busybox
18 * ...
19 * Currently defined functions:
20 * basename, false, true
21 *
22 * $ size busybox
23 * text data bss dec hex filename
24 * 4473 52 72 4597 11f5 busybox
25 *
26 * FEATURE_INSTALLER or FEATURE_SUID will still link printf routines in. :(
27 */
Denys Vlasenkoc1947f12009-10-23 01:30:26 +020028#include "busybox.h"
Denys Vlasenko9be47022011-05-16 12:21:31 +020029
Denys Vlasenko8da415e2010-12-05 01:30:14 +010030#if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
Denys Vlasenko982e87f2013-07-30 11:52:58 +020031 || defined(__APPLE__) \
Denys Vlasenko8da415e2010-12-05 01:30:14 +010032 )
33# include <malloc.h> /* for mallopt */
34#endif
Denys Vlasenko9be47022011-05-16 12:21:31 +020035
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000036/* Declare <applet>_main() */
37#define PROTOTYPES
38#include "applets.h"
39#undef PROTOTYPES
40
Denis Vlasenko32b2a9f2008-02-22 22:43:22 +000041/* Include generated applet names, pointers to <applet>_main, etc */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +000042#include "applet_tables.h"
Denis Vlasenko468aea22008-04-01 14:47:57 +000043/* ...and if applet_tables generator says we have only one applet... */
44#ifdef SINGLE_APPLET_MAIN
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020045# undef ENABLE_FEATURE_INDIVIDUAL
46# define ENABLE_FEATURE_INDIVIDUAL 1
47# undef IF_FEATURE_INDIVIDUAL
48# define IF_FEATURE_INDIVIDUAL(...) __VA_ARGS__
Denis Vlasenko468aea22008-04-01 14:47:57 +000049#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000050
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020051#include "usage_compressed.h"
52
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +010053#if ENABLE_ASH_EMBEDDED_SCRIPTS
54# define DEFINE_script_names 1
55# include "embedded_scripts.h"
56#else
57# define NUM_SCRIPTS 0
58#endif
59#if NUM_SCRIPTS > 0
60# include "bb_archive.h"
61static const char packed_scripts[] ALIGN1 = { PACKED_SCRIPTS };
62#endif
Denys Vlasenkofe936242017-01-06 19:16:36 +010063
64/* "Do not compress usage text if uncompressed text is small
65 * and we don't include bunzip2 code for other reasons"
66 *
67 * Useful for mass one-applet rebuild (bunzip2 code is ~2.7k).
68 *
69 * Unlike BUNZIP2, if FEATURE_SEAMLESS_BZ2 is on, bunzip2 code is built but
70 * still may be unused if none of the selected applets calls open_zipped()
71 * or its friends; we test for (FEATURE_SEAMLESS_BZ2 && <APPLET>) instead.
72 * For example, only if TAR and FEATURE_SEAMLESS_BZ2 are both selected,
73 * then bunzip2 code will be linked in anyway, and disabling help compression
74 * would be not optimal:
75 */
76#if UNPACKED_USAGE_LENGTH < 4*1024 \
77 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_TAR) \
78 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MODPROBE) \
79 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_INSMOD) \
80 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_DEPMOD) \
81 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MAN) \
82 && !ENABLE_BUNZIP2 \
83 && !ENABLE_BZCAT
84# undef ENABLE_FEATURE_COMPRESS_USAGE
85# define ENABLE_FEATURE_COMPRESS_USAGE 0
86#endif
87
88
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +020089unsigned FAST_FUNC string_array_len(char **argv)
90{
91 char **start = argv;
92
93 while (*argv)
94 argv++;
95
96 return argv - start;
97}
98
99
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200100#if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
101static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
102#else
103# define usage_messages 0
Denys Vlasenko1fcbff22010-06-26 02:40:08 +0200104#endif
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200105
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000106#if ENABLE_FEATURE_COMPRESS_USAGE
107
Denys Vlasenko5c296de2010-07-03 14:28:35 +0200108static const char packed_usage[] ALIGN1 = { PACKED_USAGE };
Denys Vlasenkod184a722011-09-22 12:45:14 +0200109# include "bb_archive.h"
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000110static const char *unpack_usage_messages(void)
111{
112 char *outbuf = NULL;
113 bunzip_data *bd;
114 int i;
Denys Vlasenko38ccd6a2018-04-08 20:02:01 +0200115 jmp_buf jmpbuf;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000116
Denys Vlasenko38ccd6a2018-04-08 20:02:01 +0200117 /* Setup for I/O error handling via longjmp */
118 i = setjmp(jmpbuf);
119 if (i == 0) {
120 i = start_bunzip(&jmpbuf,
121 &bd,
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000122 /* src_fd: */ -1,
Denys Vlasenkocaddfc82010-10-28 23:08:53 +0200123 /* inbuf: */ packed_usage,
Denys Vlasenko38ccd6a2018-04-08 20:02:01 +0200124 /* len: */ sizeof(packed_usage)
125 );
126 }
127 /* read_bunzip can longjmp and end up here with i != 0
128 * on read data errors! Not trivial */
129 if (i == 0) {
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000130 /* Cannot use xmalloc: will leak bd in NOFORK case! */
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200131 outbuf = malloc_or_warn(sizeof(UNPACKED_USAGE));
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000132 if (outbuf)
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200133 read_bunzip(bd, outbuf, sizeof(UNPACKED_USAGE));
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000134 }
135 dealloc_bunzip(bd);
136 return outbuf;
137}
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200138# define dealloc_usage_messages(s) free(s)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000139
140#else
141
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200142# define unpack_usage_messages() usage_messages
143# define dealloc_usage_messages(s) ((void)(s))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000144
145#endif /* FEATURE_COMPRESS_USAGE */
146
147
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000148void FAST_FUNC bb_show_usage(void)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000149{
150 if (ENABLE_SHOW_USAGE) {
Denis Vlasenko468aea22008-04-01 14:47:57 +0000151#ifdef SINGLE_APPLET_STR
152 /* Imagine that this applet is "true". Dont suck in printf! */
Lauri Kasanen2b662c52010-11-13 23:16:05 +0100153 const char *usage_string = unpack_usage_messages();
Denis Vlasenko468aea22008-04-01 14:47:57 +0000154
Lauri Kasanen2b662c52010-11-13 23:16:05 +0100155 if (*usage_string == '\b') {
Denis Vlasenko42404082008-11-24 13:42:24 +0000156 full_write2_str("No help available.\n\n");
Denis Vlasenko468aea22008-04-01 14:47:57 +0000157 } else {
Denis Vlasenko42404082008-11-24 13:42:24 +0000158 full_write2_str("Usage: "SINGLE_APPLET_STR" ");
Lauri Kasanen2b662c52010-11-13 23:16:05 +0100159 full_write2_str(usage_string);
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000160 full_write2_str("\n\n");
Denis Vlasenko468aea22008-04-01 14:47:57 +0000161 }
Denys Vlasenko630dde12009-08-30 19:57:49 +0200162 if (ENABLE_FEATURE_CLEAN_UP)
163 dealloc_usage_messages((char*)usage_string);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000164#else
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000165 const char *p;
166 const char *usage_string = p = unpack_usage_messages();
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000167 int ap = find_applet_by_name(applet_name);
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000168
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000169 if (ap < 0) /* never happens, paranoia */
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000170 xfunc_die();
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000171 while (ap) {
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000172 while (*p++) continue;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000173 ap--;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000174 }
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000175 full_write2_str(bb_banner);
Denys Vlasenko630dde12009-08-30 19:57:49 +0200176 full_write2_str(" multi-call binary.\n");
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000177 if (*p == '\b')
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000178 full_write2_str("\nNo help available.\n\n");
179 else {
180 full_write2_str("\nUsage: ");
181 full_write2_str(applet_name);
Denys Vlasenko253f5552018-07-09 18:23:33 +0200182 if (p[0]) {
183 if (p[0] != '\n')
184 full_write2_str(" ");
185 full_write2_str(p);
186 }
Denys Vlasenko7f4a49a2015-05-25 14:30:52 +0200187 full_write2_str("\n");
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000188 }
Denys Vlasenko630dde12009-08-30 19:57:49 +0200189 if (ENABLE_FEATURE_CLEAN_UP)
190 dealloc_usage_messages((char*)usage_string);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000191#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000192 }
193 xfunc_die();
194}
195
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000196int FAST_FUNC find_applet_by_name(const char *name)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000197{
Ron Yorstonb2206172016-04-03 22:29:35 +0200198 unsigned i, max;
199 int j;
Denis Vlasenko745cd172007-11-29 03:31:20 +0000200 const char *p;
Ron Yorston610c4c32016-03-30 00:42:05 +0200201
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200202/* The commented-out word-at-a-time code is ~40% faster, but +160 bytes.
203 * "Faster" here saves ~0.5 microsecond of real time - not worth it.
204 */
205#if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
206 uint32_t n32;
207
208 /* Handle all names < 2 chars long early */
209 if (name[0] == '\0')
210 return -1; /* "" is not a valid applet name */
211 if (name[1] == '\0') {
212 if (!ENABLE_TEST)
213 return -1; /* 1-char name is not valid */
214 if (name[0] != ']')
215 return -1; /* 1-char name which isn't "[" is not valid */
216 /* applet "[" is always applet #0: */
217 return 0;
218 }
219#endif
220
Ron Yorston610c4c32016-03-30 00:42:05 +0200221 p = applet_names;
222 i = 0;
223#if KNOWN_APPNAME_OFFSETS <= 0
224 max = NUM_APPLETS;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000225#else
Ron Yorston610c4c32016-03-30 00:42:05 +0200226 max = NUM_APPLETS * KNOWN_APPNAME_OFFSETS;
227 for (j = ARRAY_SIZE(applet_nameofs)-1; j >= 0; j--) {
228 const char *pp = applet_names + applet_nameofs[j];
229 if (strcmp(name, pp) >= 0) {
230 //bb_error_msg("name:'%s' >= pp:'%s'", name, pp);
231 p = pp;
232 i = max - NUM_APPLETS;
233 break;
234 }
235 max -= NUM_APPLETS;
236 }
237 max /= (unsigned)KNOWN_APPNAME_OFFSETS;
238 i /= (unsigned)KNOWN_APPNAME_OFFSETS;
239 //bb_error_msg("name:'%s' starting from:'%s' i:%u max:%u", name, p, i, max);
240#endif
241
Denys Vlasenko1cf68e32016-04-02 22:57:17 +0200242 /* Open-coded linear search without strcmp/strlen calls for speed */
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200243
244#if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
245 /* skip "[\0" name, it's surely not it */
246 if (ENABLE_TEST && LONE_CHAR(p, '['))
247 i++, p += 2;
248 /* All remaining applet names in p[] are at least 2 chars long */
249 /* name[] is also at least 2 chars long */
250
251 n32 = (name[0] << 0) | (name[1] << 8) | (name[2] << 16);
252 while (i < max) {
253 uint32_t p32;
254 char ch;
255
256 /* Quickly check match of the first 3 bytes */
257 move_from_unaligned32(p32, p);
258 p += 3;
259 if ((p32 & 0x00ffffff) != n32) {
260 /* Most likely case: 3 first bytes do not match */
261 i++;
262 if ((p32 & 0x00ff0000) == '\0')
263 continue; // p[2] was NUL
264 p++;
265 if ((p32 & 0xff000000) == '\0')
266 continue; // p[3] was NUL
267 /* p[0..3] aren't matching and none is NUL, check the rest */
268 while (*p++ != '\0')
269 continue;
270 continue;
271 }
272
273 /* Unlikely branch: first 3 bytes ([0..2]) match */
274 if ((p32 & 0x00ff0000) == '\0') {
275 /* name is 2-byte long, it is full match */
276 //bb_error_msg("found:'%s' i:%u", name, i);
277 return i;
278 }
279 /* Check remaining bytes [3..NUL] */
280 ch = (p32 >> 24);
281 j = 3;
282 while (ch == name[j]) {
283 if (ch == '\0') {
284 //bb_error_msg("found:'%s' i:%u", name, i);
285 return i;
286 }
287 ch = *++p;
288 j++;
289 }
290 /* Not a match. Skip it, including NUL */
291 while (ch != '\0')
292 ch = *++p;
293 p++;
294 i++;
295 }
296 return -1;
297#else
Ron Yorston610c4c32016-03-30 00:42:05 +0200298 while (i < max) {
299 char ch;
300 j = 0;
301 /* Do we see "name\0" in applet_names[p] position? */
302 while ((ch = *p) == name[j]) {
303 if (ch == '\0') {
304 //bb_error_msg("found:'%s' i:%u", name, i);
305 return i; /* yes */
306 }
307 p++;
308 j++;
309 }
310 /* No.
311 * p => 1st non-matching char in applet_names[],
312 * skip to and including NUL.
313 */
314 while (ch != '\0')
315 ch = *++p;
316 p++;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000317 i++;
318 }
319 return -1;
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200320#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000321}
322
323
Denis Vlasenko68404f12008-03-17 09:00:54 +0000324void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000325 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenko468aea22008-04-01 14:47:57 +0000326 MAIN_EXTERNALLY_VISIBLE;
327void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000328 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000329{
330#ifdef __GLIBC__
331 (*(int **)&bb_errno) = __errno_location();
Denis Vlasenko574f2f42008-02-27 18:41:59 +0000332 barrier();
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000333#endif
Denis Vlasenko15cb4a42007-10-11 10:06:26 +0000334 applet_name = applet;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000335
Denys Vlasenko45b4ecc2014-08-11 20:33:18 +0200336 if (ENABLE_LOCALE_SUPPORT)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000337 setlocale(LC_ALL, "");
338
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000339#if ENABLE_FEATURE_INDIVIDUAL
340 /* Redundant for busybox (run_applet_and_exit covers that case)
341 * but needed for "individual applet" mode */
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200342 if (argv[1]
343 && !argv[2]
344 && strcmp(argv[1], "--help") == 0
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100345 && !is_prefixed_with(applet, "busybox")
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200346 ) {
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000347 /* Special case. POSIX says "test --help"
348 * should be no different from e.g. "test --foo". */
349 if (!ENABLE_TEST || strcmp(applet_name, "test") != 0)
350 bb_show_usage();
351 }
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000352#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000353}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000354
355/* The code below can well be in applets/applets.c, as it is used only
356 * for busybox binary, not "individual" binaries.
357 * However, keeping it here and linking it into libbusybox.so
358 * (together with remaining tiny applets/applets.o)
359 * makes it possible to avoid --whole-archive at link time.
360 * This makes (shared busybox) + libbusybox smaller.
361 * (--gc-sections would be even better....)
362 */
363
364const char *applet_name;
365#if !BB_MMU
366bool re_execed;
367#endif
368
Denis Vlasenko468aea22008-04-01 14:47:57 +0000369
Denis Vlasenko10f6fb12008-04-29 00:10:27 +0000370/* If not built as a single-applet executable... */
371#if !defined(SINGLE_APPLET_MAIN)
Denis Vlasenko468aea22008-04-01 14:47:57 +0000372
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000373IF_FEATURE_SUID(static uid_t ruid;) /* real uid */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000374
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100375# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000376
Denys Vlasenko9be47022011-05-16 12:21:31 +0200377static struct suid_config_t {
378 /* next ptr must be first: this struct needs to be llist-compatible */
379 struct suid_config_t *m_next;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200380 struct bb_uidgid_t m_ugid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200381 int m_applet;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000382 mode_t m_mode;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000383} *suid_config;
384
385static bool suid_cfg_readable;
386
Denys Vlasenkod83aff12011-05-16 13:53:19 +0200387/* libbb candidate */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000388static char *get_trimmed_slice(char *s, char *e)
389{
390 /* First, consider the value at e to be nul and back up until we
391 * reach a non-space char. Set the char after that (possibly at
392 * the original e) to nul. */
393 while (e-- > s) {
394 if (!isspace(*e)) {
395 break;
396 }
397 }
398 e[1] = '\0';
399
400 /* Next, advance past all leading space and return a ptr to the
401 * first non-space char; possibly the terminating nul. */
402 return skip_whitespace(s);
403}
404
Denis Vlasenko724d1962007-10-10 14:41:07 +0000405static void parse_config_file(void)
406{
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200407 /* Don't depend on the tools to combine strings. */
408 static const char config_file[] ALIGN1 = "/etc/busybox.conf";
409
Denys Vlasenko9be47022011-05-16 12:21:31 +0200410 struct suid_config_t *sct_head;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000411 int applet_no;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000412 FILE *f;
413 const char *errmsg;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000414 unsigned lc;
415 smallint section;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000416 struct stat st;
417
Denis Vlasenko724d1962007-10-10 14:41:07 +0000418 ruid = getuid();
419 if (ruid == 0) /* run by root - don't need to even read config file */
420 return;
421
422 if ((stat(config_file, &st) != 0) /* No config file? */
423 || !S_ISREG(st.st_mode) /* Not a regular file? */
424 || (st.st_uid != 0) /* Not owned by root? */
425 || (st.st_mode & (S_IWGRP | S_IWOTH)) /* Writable by non-root? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200426 || !(f = fopen_for_read(config_file)) /* Cannot open? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000427 ) {
428 return;
429 }
430
431 suid_cfg_readable = 1;
432 sct_head = NULL;
433 section = lc = 0;
434
435 while (1) {
Denys Vlasenko9be47022011-05-16 12:21:31 +0200436 char buffer[256];
437 char *s;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000438
Denys Vlasenko9be47022011-05-16 12:21:31 +0200439 if (!fgets(buffer, sizeof(buffer), f)) { /* Are we done? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200440 // Looks like bloat
441 //if (ferror(f)) { /* Make sure it wasn't a read error. */
442 // errmsg = "reading";
443 // goto pe_label;
444 //}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000445 fclose(f);
446 suid_config = sct_head; /* Success, so set the pointer. */
447 return;
448 }
449
Denys Vlasenko9be47022011-05-16 12:21:31 +0200450 s = buffer;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000451 lc++; /* Got a (partial) line. */
452
453 /* If a line is too long for our buffer, we consider it an error.
454 * The following test does mistreat one corner case though.
455 * If the final line of the file does not end with a newline and
456 * yet exactly fills the buffer, it will be treated as too long
457 * even though there isn't really a problem. But it isn't really
458 * worth adding code to deal with such an unlikely situation, and
459 * we do err on the side of caution. Besides, the line would be
460 * too long if it did end with a newline. */
461 if (!strchr(s, '\n') && !feof(f)) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200462 errmsg = "line too long";
463 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000464 }
465
466 /* Trim leading and trailing whitespace, ignoring comments, and
467 * check if the resulting string is empty. */
468 s = get_trimmed_slice(s, strchrnul(s, '#'));
469 if (!*s) {
470 continue;
471 }
472
473 /* Check for a section header. */
474
475 if (*s == '[') {
476 /* Unlike the old code, we ignore leading and trailing
477 * whitespace for the section name. We also require that
478 * there are no stray characters after the closing bracket. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200479 char *e = strchr(s, ']');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000480 if (!e /* Missing right bracket? */
481 || e[1] /* Trailing characters? */
482 || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
483 ) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200484 errmsg = "section header";
485 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000486 }
487 /* Right now we only have one section so just check it.
488 * If more sections are added in the future, please don't
489 * resort to cascading ifs with multiple strcasecmp calls.
490 * That kind of bloated code is all too common. A loop
491 * and a string table would be a better choice unless the
492 * number of sections is very small. */
493 if (strcasecmp(s, "SUID") == 0) {
494 section = 1;
495 continue;
496 }
497 section = -1; /* Unknown section so set to skip. */
498 continue;
499 }
500
501 /* Process sections. */
502
503 if (section == 1) { /* SUID */
504 /* Since we trimmed leading and trailing space above, we're
505 * now looking for strings of the form
506 * <key>[::space::]*=[::space::]*<value>
507 * where both key and value could contain inner whitespace. */
508
509 /* First get the key (an applet name in our case). */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200510 char *e = strchr(s, '=');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000511 if (e) {
512 s = get_trimmed_slice(s, e);
513 }
514 if (!e || !*s) { /* Missing '=' or empty key. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200515 errmsg = "keyword";
516 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000517 }
518
519 /* Ok, we have an applet name. Process the rhs if this
520 * applet is currently built in and ignore it otherwise.
521 * Note: this can hide config file bugs which only pop
522 * up when the busybox configuration is changed. */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000523 applet_no = find_applet_by_name(s);
524 if (applet_no >= 0) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200525 unsigned i;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200526 struct suid_config_t *sct;
527
Denis Vlasenko724d1962007-10-10 14:41:07 +0000528 /* Note: We currently don't check for duplicates!
529 * The last config line for each applet will be the
530 * one used since we insert at the head of the list.
531 * I suppose this could be considered a feature. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200532 sct = xzalloc(sizeof(*sct));
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000533 sct->m_applet = applet_no;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200534 /*sct->m_mode = 0;*/
Denis Vlasenko724d1962007-10-10 14:41:07 +0000535 sct->m_next = sct_head;
536 sct_head = sct;
537
538 /* Get the specified mode. */
539
540 e = skip_whitespace(e+1);
541
542 for (i = 0; i < 3; i++) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200543 /* There are 4 chars for each of user/group/other.
544 * "x-xx" instead of "x-" are to make
545 * "idx > 3" check catch invalid chars.
546 */
547 static const char mode_chars[] ALIGN1 = "Ssx-" "Ssx-" "x-xx";
548 static const unsigned short mode_mask[] ALIGN2 = {
549 S_ISUID, S_ISUID|S_IXUSR, S_IXUSR, 0, /* Ssx- */
550 S_ISGID, S_ISGID|S_IXGRP, S_IXGRP, 0, /* Ssx- */
551 S_IXOTH, 0 /* x- */
552 };
553 const char *q = strchrnul(mode_chars + 4*i, *e);
554 unsigned idx = q - (mode_chars + 4*i);
555 if (idx > 3) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200556 errmsg = "mode";
557 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000558 }
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200559 sct->m_mode |= mode_mask[q - mode_chars];
560 e++;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000561 }
562
Marek Polacekb0b88842011-04-16 17:33:43 +0200563 /* Now get the user/group info. */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000564
565 s = skip_whitespace(e);
Denys Vlasenko351fec32011-05-16 14:30:26 +0200566 /* Default is 0.0, else parse USER.GROUP: */
567 if (*s) {
568 /* We require whitespace between mode and USER.GROUP */
569 if ((s == e) || !(e = strchr(s, '.'))) {
570 errmsg = "uid.gid";
571 goto pe_label;
572 }
573 *e = ':'; /* get_uidgid needs USER:GROUP syntax */
Denys Vlasenko526d8582015-10-19 04:27:17 +0200574 if (get_uidgid(&sct->m_ugid, s) == 0) {
Denys Vlasenko351fec32011-05-16 14:30:26 +0200575 errmsg = "unknown user/group";
576 goto pe_label;
577 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000578 }
579 }
580 continue;
581 }
582
583 /* Unknown sections are ignored. */
584
585 /* Encountering configuration lines prior to seeing a
586 * section header is treated as an error. This is how
587 * the old code worked, but it may not be desirable.
588 * We may want to simply ignore such lines in case they
589 * are used in some future version of busybox. */
590 if (!section) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200591 errmsg = "keyword outside section";
592 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000593 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000594 } /* while (1) */
595
596 pe_label:
Denys Vlasenko9be47022011-05-16 12:21:31 +0200597 fclose(f);
Denys Vlasenko4566e172011-05-16 00:01:08 +0200598 bb_error_msg("parse error in %s, line %u: %s", config_file, lc, errmsg);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000599
Denis Vlasenko724d1962007-10-10 14:41:07 +0000600 /* Release any allocated memory before returning. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200601 llist_free((llist_t*)sct_head, NULL);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000602}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100603# else
Denis Vlasenko724d1962007-10-10 14:41:07 +0000604static inline void parse_config_file(void)
605{
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000606 IF_FEATURE_SUID(ruid = getuid();)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000607}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100608# endif /* FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000609
610
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100611# if ENABLE_FEATURE_SUID && NUM_APPLETS > 0
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100612# if ENABLE_FEATURE_SUID_CONFIG
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100613/* check if u is member of group g */
614static int ingroup(uid_t u, gid_t g)
615{
616 struct group *grp = getgrgid(g);
617 if (grp) {
618 char **mem;
619 for (mem = grp->gr_mem; *mem; mem++) {
620 struct passwd *pwd = getpwnam(*mem);
621 if (pwd && (pwd->pw_uid == u))
622 return 1;
623 }
624 }
625 return 0;
626}
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100627# endif
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100628
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000629static void check_suid(int applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000630{
631 gid_t rgid; /* real gid */
632
633 if (ruid == 0) /* set by parse_config_file() */
634 return; /* run by root - no need to check more */
635 rgid = getgid();
636
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100637# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000638 if (suid_cfg_readable) {
639 uid_t uid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200640 struct suid_config_t *sct;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000641 mode_t m;
642
643 for (sct = suid_config; sct; sct = sct->m_next) {
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000644 if (sct->m_applet == applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000645 goto found;
646 }
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000647 goto check_need_suid;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000648 found:
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200649 /* Is this user allowed to run this applet? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000650 m = sct->m_mode;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200651 if (sct->m_ugid.uid == ruid)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000652 /* same uid */
653 m >>= 6;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200654 else if ((sct->m_ugid.gid == rgid) || ingroup(ruid, sct->m_ugid.gid))
Denis Vlasenko724d1962007-10-10 14:41:07 +0000655 /* same group / in group */
656 m >>= 3;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200657 if (!(m & S_IXOTH)) /* is x bit not set? */
Denys Vlasenkod83aff12011-05-16 13:53:19 +0200658 bb_error_msg_and_die("you have no permission to run this applet");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000659
Denis Vlasenko724d1962007-10-10 14:41:07 +0000660 /* We set effective AND saved ids. If saved-id is not set
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200661 * like we do below, seteuid(0) can still later succeed! */
662
663 /* Are we directed to change gid
664 * (APPLET = *s* USER.GROUP or APPLET = *S* USER.GROUP)?
665 */
666 if (sct->m_mode & S_ISGID)
667 rgid = sct->m_ugid.gid;
668 /* else: we will set egid = rgid, thus dropping sgid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000669 if (setresgid(-1, rgid, rgid))
670 bb_perror_msg_and_die("setresgid");
671
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200672 /* Are we directed to change uid
673 * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
674 */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000675 uid = ruid;
676 if (sct->m_mode & S_ISUID)
Denys Vlasenko4566e172011-05-16 00:01:08 +0200677 uid = sct->m_ugid.uid;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200678 /* else: we will set euid = ruid, thus dropping suid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000679 if (setresuid(-1, uid, uid))
680 bb_perror_msg_and_die("setresuid");
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200681
Denys Vlasenko9be47022011-05-16 12:21:31 +0200682 goto ret;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000683 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100684# if !ENABLE_FEATURE_SUID_CONFIG_QUIET
Denis Vlasenko724d1962007-10-10 14:41:07 +0000685 {
686 static bool onetime = 0;
687
688 if (!onetime) {
689 onetime = 1;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200690 bb_error_msg("using fallback suid method");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000691 }
692 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100693# endif
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000694 check_need_suid:
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100695# endif
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100696 if (APPLET_SUID(applet_no) == BB_SUID_REQUIRE) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000697 /* Real uid is not 0. If euid isn't 0 too, suid bit
698 * is most probably not set on our executable */
699 if (geteuid())
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000700 bb_error_msg_and_die("must be suid to work properly");
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100701 } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
Denys Vlasenko12a4f9a2017-07-10 09:17:43 +0200702 /*
703 * Drop all privileges.
704 *
705 * Don't check for errors: in normal use, they are impossible,
706 * and in special cases, exiting is harmful. Example:
707 * 'unshare --user' when user's shell is also from busybox.
708 *
709 * 'unshare --user' creates a new user namespace without any
710 * uid mappings. Thus, busybox binary is setuid nobody:nogroup
711 * within the namespace, as that is the only user. However,
712 * since no uids are mapped, calls to setgid/setuid
713 * fail (even though they would do nothing).
714 */
715 setgid(rgid);
716 setuid(ruid);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000717 }
Denys Vlasenko9be47022011-05-16 12:21:31 +0200718# if ENABLE_FEATURE_SUID_CONFIG
Cristian Ionescu-Idbohrnea137aa2011-05-20 03:52:36 +0200719 ret: ;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200720 llist_free((llist_t*)suid_config, NULL);
721# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000722}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100723# else
724# define check_suid(x) ((void)0)
725# endif /* FEATURE_SUID */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000726
727
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100728# if ENABLE_FEATURE_INSTALLER
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400729static const char usr_bin [] ALIGN1 = "/usr/bin/";
730static const char usr_sbin[] ALIGN1 = "/usr/sbin/";
731static const char *const install_dir[] = {
732 &usr_bin [8], /* "/" */
733 &usr_bin [4], /* "/bin/" */
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200734 &usr_sbin[4] /* "/sbin/" */
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100735# if !ENABLE_INSTALL_NO_USR
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200736 ,usr_bin
737 ,usr_sbin
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100738# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400739};
740
Denis Vlasenko724d1962007-10-10 14:41:07 +0000741/* create (sym)links for each applet */
Denys Vlasenko3b405432009-07-15 00:35:34 +0200742static void install_links(const char *busybox, int use_symbolic_links,
743 char *custom_install_dir)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000744{
745 /* directory table
746 * this should be consistent w/ the enum,
747 * busybox.h::bb_install_loc_t, or else... */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000748 int (*lf)(const char *, const char *);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000749 char *fpc;
Denys Vlasenko4c201c02018-07-17 15:04:17 +0200750 const char *appname = applet_names;
Denis Vlasenko6b06cb82008-05-15 21:30:45 +0000751 unsigned i;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000752 int rc;
753
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000754 lf = link;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000755 if (use_symbolic_links)
756 lf = symlink;
757
Denis Vlasenko745cd172007-11-29 03:31:20 +0000758 for (i = 0; i < ARRAY_SIZE(applet_main); i++) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000759 fpc = concat_path_file(
Denys Vlasenko3b405432009-07-15 00:35:34 +0200760 custom_install_dir ? custom_install_dir : install_dir[APPLET_INSTALL_LOC(i)],
Ron Yorston610c4c32016-03-30 00:42:05 +0200761 appname);
Denis Vlasenko745cd172007-11-29 03:31:20 +0000762 // debug: bb_error_msg("%slinking %s to busybox",
763 // use_symbolic_links ? "sym" : "", fpc);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000764 rc = lf(busybox, fpc);
765 if (rc != 0 && errno != EEXIST) {
766 bb_simple_perror_msg(fpc);
767 }
768 free(fpc);
Ron Yorston610c4c32016-03-30 00:42:05 +0200769 while (*appname++ != '\0')
770 continue;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000771 }
772}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200773# elif ENABLE_BUSYBOX
Mike Frysingerf1999b52014-01-31 00:29:47 -0500774static void install_links(const char *busybox UNUSED_PARAM,
775 int use_symbolic_links UNUSED_PARAM,
776 char *custom_install_dir UNUSED_PARAM)
777{
778}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100779# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000780
Ron Yorston1b0dcc02016-07-05 14:07:50 +0100781static void run_applet_and_exit(const char *name, char **argv) NORETURN;
782
Denys Vlasenkof128bdb2017-07-29 00:59:24 +0200783# if ENABLE_BUSYBOX
784# if ENABLE_FEATURE_SH_STANDALONE && ENABLE_FEATURE_TAB_COMPLETION
785 /*
786 * Insert "busybox" into applet table as well.
787 * This makes standalone shell tab-complete this name too.
788 * (Otherwise having "busybox" in applet table is not necessary,
789 * there is other code which routes "busyboxANY_SUFFIX" name
790 * to busybox_main()).
791 */
792//usage:#define busybox_trivial_usage NOUSAGE_STR
793//usage:#define busybox_full_usage ""
794//applet:IF_BUSYBOX(IF_FEATURE_SH_STANDALONE(IF_FEATURE_TAB_COMPLETION(APPLET(busybox, BB_DIR_BIN, BB_SUID_MAYBE))))
795int busybox_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
796# else
797# define busybox_main(argc,argv) busybox_main(argv)
798static
799# endif
800int busybox_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000801{
802 if (!argv[1]) {
803 /* Called without arguments */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000804 const char *a;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200805 int col;
806 unsigned output_width;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000807 help:
Denys Vlasenkoa8a075a2017-01-11 10:52:24 +0100808 output_width = get_terminal_width(2);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000809
Denis Vlasenko21278df2008-06-25 12:15:46 +0000810 dup2(1, 2);
Denys Vlasenko630dde12009-08-30 19:57:49 +0200811 full_write2_str(bb_banner); /* reuse const string */
812 full_write2_str(" multi-call binary.\n"); /* reuse */
813 full_write2_str(
Aaro Koskinen7b729ed2015-04-02 00:55:17 +0300814 "BusyBox is copyrighted by many authors between 1998-2015.\n"
Bradley M. Kuhn0e941d52012-07-13 11:38:38 -0400815 "Licensed under GPLv2. See source distribution for detailed\n"
816 "copyright notices.\n"
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400817 "\n"
Denys Vlasenko02b8b9b2012-05-14 23:52:57 +0200818 "Usage: busybox [function [arguments]...]\n"
Denys Vlasenkoba888262012-03-22 11:15:06 +0100819 " or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
820 IF_FEATURE_INSTALLER(
821 " or: busybox --install [-s] [DIR]\n"
822 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400823 " or: function [arguments]...\n"
824 "\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100825 IF_NOT_FEATURE_SH_STANDALONE(
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400826 "\tBusyBox is a multi-call binary that combines many common Unix\n"
827 "\tutilities into a single executable. Most people will create a\n"
828 "\tlink to busybox for each function they wish to use and BusyBox\n"
829 "\twill act like whatever it was invoked as.\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100830 )
831 IF_FEATURE_SH_STANDALONE(
832 "\tBusyBox is a multi-call binary that combines many common Unix\n"
833 "\tutilities into a single executable. The shell in this build\n"
834 "\tis configured to run built-in utilities without $PATH search.\n"
835 "\tYou don't need to install a link to busybox for each utility.\n"
836 "\tTo run external program, use full path (/sbin/ip instead of ip).\n"
837 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400838 "\n"
839 "Currently defined functions:\n"
840 );
Denis Vlasenko724d1962007-10-10 14:41:07 +0000841 col = 0;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200842 /* prevent last comma to be in the very last pos */
843 output_width--;
Denys Vlasenko0575c992018-11-01 13:58:16 +0100844 a = applet_names;
845 {
846# if NUM_SCRIPTS > 0
847 int i;
848 for (i = 0; i < 2; i++, a = script_names)
849# endif
850 while (*a) {
851 int len2 = strlen(a) + 2;
852 if (col >= (int)output_width - len2) {
853 full_write2_str(",\n");
854 col = 0;
855 }
856 if (col == 0) {
857 col = 6;
858 full_write2_str("\t");
859 } else {
860 full_write2_str(", ");
861 }
862 full_write2_str(a);
863 col += len2;
864 a += len2 - 1;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000865 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000866 }
Denys Vlasenko7d877fc2016-11-28 01:29:28 +0100867 full_write2_str("\n");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000868 return 0;
869 }
870
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100871 if (is_prefixed_with(argv[1], "--list")) {
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400872 unsigned i = 0;
873 const char *a = applet_names;
874 dup2(1, 2);
875 while (*a) {
Denys Vlasenko8e950682016-05-31 02:42:49 +0200876# if ENABLE_FEATURE_INSTALLER
Denys Vlasenkoba888262012-03-22 11:15:06 +0100877 if (argv[1][6]) /* --list-full? */
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400878 full_write2_str(install_dir[APPLET_INSTALL_LOC(i)] + 1);
Denys Vlasenko8e950682016-05-31 02:42:49 +0200879# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400880 full_write2_str(a);
881 full_write2_str("\n");
882 i++;
Ron Yorston2b919582016-04-08 11:57:20 +0100883 while (*a++ != '\0')
884 continue;
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400885 }
886 return 0;
887 }
888
Denis Vlasenko724d1962007-10-10 14:41:07 +0000889 if (ENABLE_FEATURE_INSTALLER && strcmp(argv[1], "--install") == 0) {
Denys Vlasenko3b405432009-07-15 00:35:34 +0200890 int use_symbolic_links;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000891 const char *busybox;
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100892
Denis Vlasenko724d1962007-10-10 14:41:07 +0000893 busybox = xmalloc_readlink(bb_busybox_exec_path);
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100894 if (!busybox) {
895 /* bb_busybox_exec_path is usually "/proc/self/exe".
896 * In chroot, readlink("/proc/self/exe") usually fails.
897 * In such case, better use argv[0] as symlink target
898 * if it is a full path name.
899 */
Denys Vlasenko5c942712011-03-12 06:08:28 +0100900 if (argv[0][0] != '/')
901 bb_error_msg_and_die("'%s' is not an absolute path", argv[0]);
902 busybox = argv[0];
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100903 }
904 /* busybox --install [-s] [DIR]:
905 * -s: make symlinks
906 * DIR: directory to install links to
907 */
Denys Vlasenkoba888262012-03-22 11:15:06 +0100908 use_symbolic_links = (argv[2] && strcmp(argv[2], "-s") == 0 && ++argv);
Denys Vlasenko3b405432009-07-15 00:35:34 +0200909 install_links(busybox, use_symbolic_links, argv[2]);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000910 return 0;
911 }
912
913 if (strcmp(argv[1], "--help") == 0) {
914 /* "busybox --help [<applet>]" */
915 if (!argv[2])
916 goto help;
917 /* convert to "<applet> --help" */
918 argv[0] = argv[2];
919 argv[2] = NULL;
920 } else {
921 /* "busybox <applet> arg1 arg2 ..." */
922 argv++;
923 }
924 /* We support "busybox /a/path/to/applet args..." too. Allows for
925 * "#!/bin/busybox"-style wrappers */
926 applet_name = bb_get_last_path_component_nostrip(argv[0]);
927 run_applet_and_exit(applet_name, argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000928}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200929# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000930
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200931# if NUM_APPLETS > 0
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200932void FAST_FUNC run_applet_no_and_exit(int applet_no, const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000933{
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200934 int argc = string_array_len(argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000935
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200936 /*
937 * We do not use argv[0]: do not want to repeat massaging of
938 * "-/sbin/halt" -> "halt", for example.
939 */
940 applet_name = name;
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200941
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200942 /* Special case. POSIX says "test --help"
943 * should be no different from e.g. "test --foo".
944 * Thus for "test", we skip --help check.
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200945 * "true" and "false" are also special.
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200946 */
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200947 if (1
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200948# if defined APPLET_NO_test
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200949 && applet_no != APPLET_NO_test
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200950# endif
951# if defined APPLET_NO_true
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200952 && applet_no != APPLET_NO_true
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200953# endif
954# if defined APPLET_NO_false
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200955 && applet_no != APPLET_NO_false
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200956# endif
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200957 ) {
958 if (argc == 2 && strcmp(argv[1], "--help") == 0) {
959 /* Make "foo --help" exit with 0: */
960 xfunc_error_retval = 0;
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000961 bb_show_usage();
Denys Vlasenko5d783552013-01-17 11:02:21 +0100962 }
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000963 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000964 if (ENABLE_FEATURE_SUID)
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000965 check_suid(applet_no);
Denys Vlasenko215b0ca2016-08-19 18:23:56 +0200966 xfunc_error_retval = applet_main[applet_no](argc, argv);
967 /* Note: applet_main() may also not return (die on a xfunc or such) */
968 xfunc_die();
Denis Vlasenko724d1962007-10-10 14:41:07 +0000969}
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200970# endif /* NUM_APPLETS > 0 */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000971
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +0100972# if NUM_SCRIPTS > 0
Ron Yorston151de442018-11-01 11:04:47 +0100973int FAST_FUNC
974find_script_by_name(const char *name)
Denys Vlasenkoaa2959c2018-11-01 10:28:04 +0100975{
976 const char *s = script_names;
977 int i = 0;
978
979 while (*s) {
Ron Yorston151de442018-11-01 11:04:47 +0100980 if (strcmp(name, s) == 0)
Denys Vlasenkoaa2959c2018-11-01 10:28:04 +0100981 return i;
982 i++;
983 while (*s++ != '\0')
984 continue;
985 }
Ron Yorston151de442018-11-01 11:04:47 +0100986 return -0x10000; /* make it so that NUM_APPLETS + <error> is still < 0 */
Denys Vlasenkoaa2959c2018-11-01 10:28:04 +0100987}
988
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +0100989static char *
990unpack_scripts(void)
991{
992 char *outbuf = NULL;
993 bunzip_data *bd;
994 int i;
995 jmp_buf jmpbuf;
996
997 /* Setup for I/O error handling via longjmp */
998 i = setjmp(jmpbuf);
999 if (i == 0) {
1000 i = start_bunzip(&jmpbuf,
1001 &bd,
1002 /* src_fd: */ -1,
1003 /* inbuf: */ packed_scripts,
1004 /* len: */ sizeof(packed_scripts)
1005 );
1006 }
1007 /* read_bunzip can longjmp and end up here with i != 0
1008 * on read data errors! Not trivial */
1009 if (i == 0) {
1010 outbuf = xmalloc(UNPACKED_SCRIPTS_LENGTH);
1011 read_bunzip(bd, outbuf, UNPACKED_SCRIPTS_LENGTH);
1012 }
1013 dealloc_bunzip(bd);
1014 return outbuf;
1015}
1016
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001017char* FAST_FUNC
1018get_script_content(unsigned n)
1019{
1020 char *t = unpack_scripts();
1021 if (t) {
1022 while (n != 0) {
1023 while (*t++ != '\0')
1024 continue;
1025 n--;
1026 }
1027 }
1028 return t;
1029}
1030# endif /* NUM_SCRIPTS > 0 */
1031
1032# if ENABLE_BUSYBOX || NUM_APPLETS > 0 || NUM_SCRIPTS > 0
Ron Yorstonce824ae2016-06-07 12:12:07 +01001033static NORETURN void run_applet_and_exit(const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001034{
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001035# if ENABLE_BUSYBOX
Denys Vlasenko8dff01d2015-03-12 17:48:34 +01001036 if (is_prefixed_with(name, "busybox"))
Denys Vlasenkof128bdb2017-07-29 00:59:24 +02001037 exit(busybox_main(/*unused:*/ 0, argv));
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001038# endif
1039# if NUM_APPLETS > 0
Ron Yorston610c4c32016-03-30 00:42:05 +02001040 /* find_applet_by_name() search is more expensive, so goes second */
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001041 {
1042 int applet = find_applet_by_name(name);
1043 if (applet >= 0)
Denys Vlasenko69a5ec92017-07-07 19:08:56 +02001044 run_applet_no_and_exit(applet, name, argv);
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001045 }
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001046# endif
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001047# if NUM_SCRIPTS > 0
1048 {
1049 int script = find_script_by_name(name);
1050 if (script >= 0)
1051 exit(ash_main(-script - 1, argv));
1052 }
1053# endif
Ron Yorstonce824ae2016-06-07 12:12:07 +01001054
1055 /*bb_error_msg_and_die("applet not found"); - links in printf */
1056 full_write2_str(applet_name);
1057 full_write2_str(": applet not found\n");
1058 /* POSIX: "If a command is not found, the exit status shall be 127" */
1059 exit(127);
Denis Vlasenko724d1962007-10-10 14:41:07 +00001060}
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001061# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001062
Denis Vlasenko10f6fb12008-04-29 00:10:27 +00001063#endif /* !defined(SINGLE_APPLET_MAIN) */
Denis Vlasenko468aea22008-04-01 14:47:57 +00001064
1065
Denis Vlasenko724d1962007-10-10 14:41:07 +00001066#if ENABLE_BUILD_LIBBUSYBOX
Denis Vlasenko85c24712008-03-17 09:04:04 +00001067int lbb_main(char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001068#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001069int main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001070#endif
1071{
Denys Vlasenkobc14f4d2016-04-03 16:06:42 +02001072#if 0
1073 /* TODO: find a use for a block of memory between end of .bss
1074 * and end of page. For example, I'm getting "_end:0x812e698 2408 bytes"
1075 * - more than 2k of wasted memory (in this particular build)
1076 * *per each running process*!
1077 * (If your linker does not generate "_end" name, weak attribute
1078 * makes &_end == NULL, end_len == 0 here.)
1079 */
1080 extern char _end[] __attribute__((weak));
1081 unsigned end_len = (-(int)_end) & 0xfff;
1082 printf("_end:%p %u bytes\n", &_end, end_len);
1083#endif
1084
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001085 /* Tweak malloc for reduced memory consumption */
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001086#ifdef M_TRIM_THRESHOLD
1087 /* M_TRIM_THRESHOLD is the maximum amount of freed top-most memory
1088 * to keep before releasing to the OS
1089 * Default is way too big: 256k
1090 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001091 mallopt(M_TRIM_THRESHOLD, 8 * 1024);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001092#endif
1093#ifdef M_MMAP_THRESHOLD
1094 /* M_MMAP_THRESHOLD is the request size threshold for using mmap()
1095 * Default is too big: 256k
1096 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001097 mallopt(M_MMAP_THRESHOLD, 32 * 1024 - 256);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001098#endif
Denys Vlasenko7f0ebbc2016-10-03 17:42:53 +02001099#if 0 /*def M_TOP_PAD*/
1100 /* When the program break is increased, then M_TOP_PAD bytes are added
1101 * to the sbrk(2) request. When the heap is trimmed because of free(3),
1102 * this much free space is preserved at the top of the heap.
1103 * glibc default seems to be way too big: 128k, but need to verify.
1104 */
1105 mallopt(M_TOP_PAD, 8 * 1024);
1106#endif
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001107
Denis Vlasenko724d1962007-10-10 14:41:07 +00001108#if !BB_MMU
1109 /* NOMMU re-exec trick sets high-order bit in first byte of name */
1110 if (argv[0][0] & 0x80) {
1111 re_execed = 1;
1112 argv[0][0] &= 0x7f;
1113 }
1114#endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001115
1116#if defined(SINGLE_APPLET_MAIN)
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001117
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001118 /* Only one applet is selected in .config */
Denys Vlasenko8dff01d2015-03-12 17:48:34 +01001119 if (argv[1] && is_prefixed_with(argv[0], "busybox")) {
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001120 /* "busybox <applet> <params>" should still work as expected */
1121 argv++;
1122 }
1123 /* applet_names in this case is just "applet\0\0" */
1124 lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001125# if ENABLE_BUILD_LIBBUSYBOX
1126 return SINGLE_APPLET_MAIN(string_array_len(argv), argv);
1127# else
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001128 return SINGLE_APPLET_MAIN(argc, argv);
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001129# endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001130
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001131#elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
1132
1133 full_write2_str(bb_basename(argv[0]));
1134 full_write2_str(": no applets enabled\n");
1135 exit(127);
1136
1137#else
1138
1139 lbb_prepare("busybox" IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001140# if !ENABLE_BUSYBOX
Ron Yorstonba120812016-06-07 10:26:24 +01001141 if (argv[1] && is_prefixed_with(bb_basename(argv[0]), "busybox"))
1142 argv++;
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001143# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001144 applet_name = argv[0];
1145 if (applet_name[0] == '-')
1146 applet_name++;
1147 applet_name = bb_basename(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001148
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001149 /* If we are a result of execv("/proc/self/exe"), fix ugly comm of "exe" */
1150 if (ENABLE_FEATURE_SH_STANDALONE
1151 || ENABLE_FEATURE_PREFER_APPLETS
1152 || !BB_MMU
1153 ) {
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001154 if (NUM_APPLETS > 1)
1155 set_task_comm(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001156 }
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001157
Denis Vlasenko724d1962007-10-10 14:41:07 +00001158 parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +00001159 run_applet_and_exit(applet_name, argv);
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001160
Denis Vlasenko468aea22008-04-01 14:47:57 +00001161#endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001162}