blob: 319bcc2632be25998bc80bce9802300d7d9e270d [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 Vlasenkofe936242017-01-06 19:16:36 +010053
54/* "Do not compress usage text if uncompressed text is small
55 * and we don't include bunzip2 code for other reasons"
56 *
57 * Useful for mass one-applet rebuild (bunzip2 code is ~2.7k).
58 *
59 * Unlike BUNZIP2, if FEATURE_SEAMLESS_BZ2 is on, bunzip2 code is built but
60 * still may be unused if none of the selected applets calls open_zipped()
61 * or its friends; we test for (FEATURE_SEAMLESS_BZ2 && <APPLET>) instead.
62 * For example, only if TAR and FEATURE_SEAMLESS_BZ2 are both selected,
63 * then bunzip2 code will be linked in anyway, and disabling help compression
64 * would be not optimal:
65 */
66#if UNPACKED_USAGE_LENGTH < 4*1024 \
67 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_TAR) \
68 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MODPROBE) \
69 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_INSMOD) \
70 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_DEPMOD) \
71 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MAN) \
72 && !ENABLE_BUNZIP2 \
73 && !ENABLE_BZCAT
74# undef ENABLE_FEATURE_COMPRESS_USAGE
75# define ENABLE_FEATURE_COMPRESS_USAGE 0
76#endif
77
78
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +020079unsigned FAST_FUNC string_array_len(char **argv)
80{
81 char **start = argv;
82
83 while (*argv)
84 argv++;
85
86 return argv - start;
87}
88
89
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020090#if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
91static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
92#else
93# define usage_messages 0
Denys Vlasenko1fcbff22010-06-26 02:40:08 +020094#endif
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020095
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000096#if ENABLE_FEATURE_COMPRESS_USAGE
97
Denys Vlasenko5c296de2010-07-03 14:28:35 +020098static const char packed_usage[] ALIGN1 = { PACKED_USAGE };
Denys Vlasenkod184a722011-09-22 12:45:14 +020099# include "bb_archive.h"
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000100static const char *unpack_usage_messages(void)
101{
102 char *outbuf = NULL;
103 bunzip_data *bd;
104 int i;
Denys Vlasenko38ccd6a2018-04-08 20:02:01 +0200105 jmp_buf jmpbuf;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000106
Denys Vlasenko38ccd6a2018-04-08 20:02:01 +0200107 /* Setup for I/O error handling via longjmp */
108 i = setjmp(jmpbuf);
109 if (i == 0) {
110 i = start_bunzip(&jmpbuf,
111 &bd,
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000112 /* src_fd: */ -1,
Denys Vlasenkocaddfc82010-10-28 23:08:53 +0200113 /* inbuf: */ packed_usage,
Denys Vlasenko38ccd6a2018-04-08 20:02:01 +0200114 /* len: */ sizeof(packed_usage)
115 );
116 }
117 /* read_bunzip can longjmp and end up here with i != 0
118 * on read data errors! Not trivial */
119 if (i == 0) {
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000120 /* Cannot use xmalloc: will leak bd in NOFORK case! */
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200121 outbuf = malloc_or_warn(sizeof(UNPACKED_USAGE));
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000122 if (outbuf)
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200123 read_bunzip(bd, outbuf, sizeof(UNPACKED_USAGE));
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000124 }
125 dealloc_bunzip(bd);
126 return outbuf;
127}
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200128# define dealloc_usage_messages(s) free(s)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000129
130#else
131
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200132# define unpack_usage_messages() usage_messages
133# define dealloc_usage_messages(s) ((void)(s))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000134
135#endif /* FEATURE_COMPRESS_USAGE */
136
137
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000138void FAST_FUNC bb_show_usage(void)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000139{
140 if (ENABLE_SHOW_USAGE) {
Denis Vlasenko468aea22008-04-01 14:47:57 +0000141#ifdef SINGLE_APPLET_STR
142 /* Imagine that this applet is "true". Dont suck in printf! */
Lauri Kasanen2b662c52010-11-13 23:16:05 +0100143 const char *usage_string = unpack_usage_messages();
Denis Vlasenko468aea22008-04-01 14:47:57 +0000144
Lauri Kasanen2b662c52010-11-13 23:16:05 +0100145 if (*usage_string == '\b') {
Denis Vlasenko42404082008-11-24 13:42:24 +0000146 full_write2_str("No help available.\n\n");
Denis Vlasenko468aea22008-04-01 14:47:57 +0000147 } else {
Denis Vlasenko42404082008-11-24 13:42:24 +0000148 full_write2_str("Usage: "SINGLE_APPLET_STR" ");
Lauri Kasanen2b662c52010-11-13 23:16:05 +0100149 full_write2_str(usage_string);
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000150 full_write2_str("\n\n");
Denis Vlasenko468aea22008-04-01 14:47:57 +0000151 }
Denys Vlasenko630dde12009-08-30 19:57:49 +0200152 if (ENABLE_FEATURE_CLEAN_UP)
153 dealloc_usage_messages((char*)usage_string);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000154#else
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000155 const char *p;
156 const char *usage_string = p = unpack_usage_messages();
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000157 int ap = find_applet_by_name(applet_name);
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000158
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000159 if (ap < 0) /* never happens, paranoia */
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000160 xfunc_die();
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000161 while (ap) {
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000162 while (*p++) continue;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000163 ap--;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000164 }
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000165 full_write2_str(bb_banner);
Denys Vlasenko630dde12009-08-30 19:57:49 +0200166 full_write2_str(" multi-call binary.\n");
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000167 if (*p == '\b')
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000168 full_write2_str("\nNo help available.\n\n");
169 else {
170 full_write2_str("\nUsage: ");
171 full_write2_str(applet_name);
Denys Vlasenko253f5552018-07-09 18:23:33 +0200172 if (p[0]) {
173 if (p[0] != '\n')
174 full_write2_str(" ");
175 full_write2_str(p);
176 }
Denys Vlasenko7f4a49a2015-05-25 14:30:52 +0200177 full_write2_str("\n");
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000178 }
Denys Vlasenko630dde12009-08-30 19:57:49 +0200179 if (ENABLE_FEATURE_CLEAN_UP)
180 dealloc_usage_messages((char*)usage_string);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000181#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000182 }
183 xfunc_die();
184}
185
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000186int FAST_FUNC find_applet_by_name(const char *name)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000187{
Ron Yorstonb2206172016-04-03 22:29:35 +0200188 unsigned i, max;
189 int j;
Denis Vlasenko745cd172007-11-29 03:31:20 +0000190 const char *p;
Ron Yorston610c4c32016-03-30 00:42:05 +0200191
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200192/* The commented-out word-at-a-time code is ~40% faster, but +160 bytes.
193 * "Faster" here saves ~0.5 microsecond of real time - not worth it.
194 */
195#if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
196 uint32_t n32;
197
198 /* Handle all names < 2 chars long early */
199 if (name[0] == '\0')
200 return -1; /* "" is not a valid applet name */
201 if (name[1] == '\0') {
202 if (!ENABLE_TEST)
203 return -1; /* 1-char name is not valid */
204 if (name[0] != ']')
205 return -1; /* 1-char name which isn't "[" is not valid */
206 /* applet "[" is always applet #0: */
207 return 0;
208 }
209#endif
210
Ron Yorston610c4c32016-03-30 00:42:05 +0200211 p = applet_names;
212 i = 0;
213#if KNOWN_APPNAME_OFFSETS <= 0
214 max = NUM_APPLETS;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000215#else
Ron Yorston610c4c32016-03-30 00:42:05 +0200216 max = NUM_APPLETS * KNOWN_APPNAME_OFFSETS;
217 for (j = ARRAY_SIZE(applet_nameofs)-1; j >= 0; j--) {
218 const char *pp = applet_names + applet_nameofs[j];
219 if (strcmp(name, pp) >= 0) {
220 //bb_error_msg("name:'%s' >= pp:'%s'", name, pp);
221 p = pp;
222 i = max - NUM_APPLETS;
223 break;
224 }
225 max -= NUM_APPLETS;
226 }
227 max /= (unsigned)KNOWN_APPNAME_OFFSETS;
228 i /= (unsigned)KNOWN_APPNAME_OFFSETS;
229 //bb_error_msg("name:'%s' starting from:'%s' i:%u max:%u", name, p, i, max);
230#endif
231
Denys Vlasenko1cf68e32016-04-02 22:57:17 +0200232 /* Open-coded linear search without strcmp/strlen calls for speed */
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200233
234#if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
235 /* skip "[\0" name, it's surely not it */
236 if (ENABLE_TEST && LONE_CHAR(p, '['))
237 i++, p += 2;
238 /* All remaining applet names in p[] are at least 2 chars long */
239 /* name[] is also at least 2 chars long */
240
241 n32 = (name[0] << 0) | (name[1] << 8) | (name[2] << 16);
242 while (i < max) {
243 uint32_t p32;
244 char ch;
245
246 /* Quickly check match of the first 3 bytes */
247 move_from_unaligned32(p32, p);
248 p += 3;
249 if ((p32 & 0x00ffffff) != n32) {
250 /* Most likely case: 3 first bytes do not match */
251 i++;
252 if ((p32 & 0x00ff0000) == '\0')
253 continue; // p[2] was NUL
254 p++;
255 if ((p32 & 0xff000000) == '\0')
256 continue; // p[3] was NUL
257 /* p[0..3] aren't matching and none is NUL, check the rest */
258 while (*p++ != '\0')
259 continue;
260 continue;
261 }
262
263 /* Unlikely branch: first 3 bytes ([0..2]) match */
264 if ((p32 & 0x00ff0000) == '\0') {
265 /* name is 2-byte long, it is full match */
266 //bb_error_msg("found:'%s' i:%u", name, i);
267 return i;
268 }
269 /* Check remaining bytes [3..NUL] */
270 ch = (p32 >> 24);
271 j = 3;
272 while (ch == name[j]) {
273 if (ch == '\0') {
274 //bb_error_msg("found:'%s' i:%u", name, i);
275 return i;
276 }
277 ch = *++p;
278 j++;
279 }
280 /* Not a match. Skip it, including NUL */
281 while (ch != '\0')
282 ch = *++p;
283 p++;
284 i++;
285 }
286 return -1;
287#else
Ron Yorston610c4c32016-03-30 00:42:05 +0200288 while (i < max) {
289 char ch;
290 j = 0;
291 /* Do we see "name\0" in applet_names[p] position? */
292 while ((ch = *p) == name[j]) {
293 if (ch == '\0') {
294 //bb_error_msg("found:'%s' i:%u", name, i);
295 return i; /* yes */
296 }
297 p++;
298 j++;
299 }
300 /* No.
301 * p => 1st non-matching char in applet_names[],
302 * skip to and including NUL.
303 */
304 while (ch != '\0')
305 ch = *++p;
306 p++;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000307 i++;
308 }
309 return -1;
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200310#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000311}
312
313
Denis Vlasenko68404f12008-03-17 09:00:54 +0000314void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000315 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenko468aea22008-04-01 14:47:57 +0000316 MAIN_EXTERNALLY_VISIBLE;
317void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000318 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000319{
320#ifdef __GLIBC__
321 (*(int **)&bb_errno) = __errno_location();
Denis Vlasenko574f2f42008-02-27 18:41:59 +0000322 barrier();
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000323#endif
Denis Vlasenko15cb4a42007-10-11 10:06:26 +0000324 applet_name = applet;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000325
Denys Vlasenko45b4ecc2014-08-11 20:33:18 +0200326 if (ENABLE_LOCALE_SUPPORT)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000327 setlocale(LC_ALL, "");
328
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000329#if ENABLE_FEATURE_INDIVIDUAL
330 /* Redundant for busybox (run_applet_and_exit covers that case)
331 * but needed for "individual applet" mode */
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200332 if (argv[1]
333 && !argv[2]
334 && strcmp(argv[1], "--help") == 0
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100335 && !is_prefixed_with(applet, "busybox")
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200336 ) {
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000337 /* Special case. POSIX says "test --help"
338 * should be no different from e.g. "test --foo". */
339 if (!ENABLE_TEST || strcmp(applet_name, "test") != 0)
340 bb_show_usage();
341 }
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000342#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000343}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000344
345/* The code below can well be in applets/applets.c, as it is used only
346 * for busybox binary, not "individual" binaries.
347 * However, keeping it here and linking it into libbusybox.so
348 * (together with remaining tiny applets/applets.o)
349 * makes it possible to avoid --whole-archive at link time.
350 * This makes (shared busybox) + libbusybox smaller.
351 * (--gc-sections would be even better....)
352 */
353
354const char *applet_name;
355#if !BB_MMU
356bool re_execed;
357#endif
358
Denis Vlasenko468aea22008-04-01 14:47:57 +0000359
Denis Vlasenko10f6fb12008-04-29 00:10:27 +0000360/* If not built as a single-applet executable... */
361#if !defined(SINGLE_APPLET_MAIN)
Denis Vlasenko468aea22008-04-01 14:47:57 +0000362
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000363IF_FEATURE_SUID(static uid_t ruid;) /* real uid */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000364
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100365# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000366
Denys Vlasenko9be47022011-05-16 12:21:31 +0200367static struct suid_config_t {
368 /* next ptr must be first: this struct needs to be llist-compatible */
369 struct suid_config_t *m_next;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200370 struct bb_uidgid_t m_ugid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200371 int m_applet;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000372 mode_t m_mode;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000373} *suid_config;
374
375static bool suid_cfg_readable;
376
Denys Vlasenkod83aff12011-05-16 13:53:19 +0200377/* libbb candidate */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000378static char *get_trimmed_slice(char *s, char *e)
379{
380 /* First, consider the value at e to be nul and back up until we
381 * reach a non-space char. Set the char after that (possibly at
382 * the original e) to nul. */
383 while (e-- > s) {
384 if (!isspace(*e)) {
385 break;
386 }
387 }
388 e[1] = '\0';
389
390 /* Next, advance past all leading space and return a ptr to the
391 * first non-space char; possibly the terminating nul. */
392 return skip_whitespace(s);
393}
394
Denis Vlasenko724d1962007-10-10 14:41:07 +0000395static void parse_config_file(void)
396{
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200397 /* Don't depend on the tools to combine strings. */
398 static const char config_file[] ALIGN1 = "/etc/busybox.conf";
399
Denys Vlasenko9be47022011-05-16 12:21:31 +0200400 struct suid_config_t *sct_head;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000401 int applet_no;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000402 FILE *f;
403 const char *errmsg;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000404 unsigned lc;
405 smallint section;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000406 struct stat st;
407
Denis Vlasenko724d1962007-10-10 14:41:07 +0000408 ruid = getuid();
409 if (ruid == 0) /* run by root - don't need to even read config file */
410 return;
411
412 if ((stat(config_file, &st) != 0) /* No config file? */
413 || !S_ISREG(st.st_mode) /* Not a regular file? */
414 || (st.st_uid != 0) /* Not owned by root? */
415 || (st.st_mode & (S_IWGRP | S_IWOTH)) /* Writable by non-root? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200416 || !(f = fopen_for_read(config_file)) /* Cannot open? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000417 ) {
418 return;
419 }
420
421 suid_cfg_readable = 1;
422 sct_head = NULL;
423 section = lc = 0;
424
425 while (1) {
Denys Vlasenko9be47022011-05-16 12:21:31 +0200426 char buffer[256];
427 char *s;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000428
Denys Vlasenko9be47022011-05-16 12:21:31 +0200429 if (!fgets(buffer, sizeof(buffer), f)) { /* Are we done? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200430 // Looks like bloat
431 //if (ferror(f)) { /* Make sure it wasn't a read error. */
432 // errmsg = "reading";
433 // goto pe_label;
434 //}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000435 fclose(f);
436 suid_config = sct_head; /* Success, so set the pointer. */
437 return;
438 }
439
Denys Vlasenko9be47022011-05-16 12:21:31 +0200440 s = buffer;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000441 lc++; /* Got a (partial) line. */
442
443 /* If a line is too long for our buffer, we consider it an error.
444 * The following test does mistreat one corner case though.
445 * If the final line of the file does not end with a newline and
446 * yet exactly fills the buffer, it will be treated as too long
447 * even though there isn't really a problem. But it isn't really
448 * worth adding code to deal with such an unlikely situation, and
449 * we do err on the side of caution. Besides, the line would be
450 * too long if it did end with a newline. */
451 if (!strchr(s, '\n') && !feof(f)) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200452 errmsg = "line too long";
453 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000454 }
455
456 /* Trim leading and trailing whitespace, ignoring comments, and
457 * check if the resulting string is empty. */
458 s = get_trimmed_slice(s, strchrnul(s, '#'));
459 if (!*s) {
460 continue;
461 }
462
463 /* Check for a section header. */
464
465 if (*s == '[') {
466 /* Unlike the old code, we ignore leading and trailing
467 * whitespace for the section name. We also require that
468 * there are no stray characters after the closing bracket. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200469 char *e = strchr(s, ']');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000470 if (!e /* Missing right bracket? */
471 || e[1] /* Trailing characters? */
472 || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
473 ) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200474 errmsg = "section header";
475 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000476 }
477 /* Right now we only have one section so just check it.
478 * If more sections are added in the future, please don't
479 * resort to cascading ifs with multiple strcasecmp calls.
480 * That kind of bloated code is all too common. A loop
481 * and a string table would be a better choice unless the
482 * number of sections is very small. */
483 if (strcasecmp(s, "SUID") == 0) {
484 section = 1;
485 continue;
486 }
487 section = -1; /* Unknown section so set to skip. */
488 continue;
489 }
490
491 /* Process sections. */
492
493 if (section == 1) { /* SUID */
494 /* Since we trimmed leading and trailing space above, we're
495 * now looking for strings of the form
496 * <key>[::space::]*=[::space::]*<value>
497 * where both key and value could contain inner whitespace. */
498
499 /* First get the key (an applet name in our case). */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200500 char *e = strchr(s, '=');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000501 if (e) {
502 s = get_trimmed_slice(s, e);
503 }
504 if (!e || !*s) { /* Missing '=' or empty key. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200505 errmsg = "keyword";
506 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000507 }
508
509 /* Ok, we have an applet name. Process the rhs if this
510 * applet is currently built in and ignore it otherwise.
511 * Note: this can hide config file bugs which only pop
512 * up when the busybox configuration is changed. */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000513 applet_no = find_applet_by_name(s);
514 if (applet_no >= 0) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200515 unsigned i;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200516 struct suid_config_t *sct;
517
Denis Vlasenko724d1962007-10-10 14:41:07 +0000518 /* Note: We currently don't check for duplicates!
519 * The last config line for each applet will be the
520 * one used since we insert at the head of the list.
521 * I suppose this could be considered a feature. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200522 sct = xzalloc(sizeof(*sct));
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000523 sct->m_applet = applet_no;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200524 /*sct->m_mode = 0;*/
Denis Vlasenko724d1962007-10-10 14:41:07 +0000525 sct->m_next = sct_head;
526 sct_head = sct;
527
528 /* Get the specified mode. */
529
530 e = skip_whitespace(e+1);
531
532 for (i = 0; i < 3; i++) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200533 /* There are 4 chars for each of user/group/other.
534 * "x-xx" instead of "x-" are to make
535 * "idx > 3" check catch invalid chars.
536 */
537 static const char mode_chars[] ALIGN1 = "Ssx-" "Ssx-" "x-xx";
538 static const unsigned short mode_mask[] ALIGN2 = {
539 S_ISUID, S_ISUID|S_IXUSR, S_IXUSR, 0, /* Ssx- */
540 S_ISGID, S_ISGID|S_IXGRP, S_IXGRP, 0, /* Ssx- */
541 S_IXOTH, 0 /* x- */
542 };
543 const char *q = strchrnul(mode_chars + 4*i, *e);
544 unsigned idx = q - (mode_chars + 4*i);
545 if (idx > 3) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200546 errmsg = "mode";
547 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000548 }
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200549 sct->m_mode |= mode_mask[q - mode_chars];
550 e++;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000551 }
552
Marek Polacekb0b88842011-04-16 17:33:43 +0200553 /* Now get the user/group info. */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000554
555 s = skip_whitespace(e);
Denys Vlasenko351fec32011-05-16 14:30:26 +0200556 /* Default is 0.0, else parse USER.GROUP: */
557 if (*s) {
558 /* We require whitespace between mode and USER.GROUP */
559 if ((s == e) || !(e = strchr(s, '.'))) {
560 errmsg = "uid.gid";
561 goto pe_label;
562 }
563 *e = ':'; /* get_uidgid needs USER:GROUP syntax */
Denys Vlasenko526d8582015-10-19 04:27:17 +0200564 if (get_uidgid(&sct->m_ugid, s) == 0) {
Denys Vlasenko351fec32011-05-16 14:30:26 +0200565 errmsg = "unknown user/group";
566 goto pe_label;
567 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000568 }
569 }
570 continue;
571 }
572
573 /* Unknown sections are ignored. */
574
575 /* Encountering configuration lines prior to seeing a
576 * section header is treated as an error. This is how
577 * the old code worked, but it may not be desirable.
578 * We may want to simply ignore such lines in case they
579 * are used in some future version of busybox. */
580 if (!section) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200581 errmsg = "keyword outside section";
582 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000583 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000584 } /* while (1) */
585
586 pe_label:
Denys Vlasenko9be47022011-05-16 12:21:31 +0200587 fclose(f);
Denys Vlasenko4566e172011-05-16 00:01:08 +0200588 bb_error_msg("parse error in %s, line %u: %s", config_file, lc, errmsg);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000589
Denis Vlasenko724d1962007-10-10 14:41:07 +0000590 /* Release any allocated memory before returning. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200591 llist_free((llist_t*)sct_head, NULL);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000592}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100593# else
Denis Vlasenko724d1962007-10-10 14:41:07 +0000594static inline void parse_config_file(void)
595{
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000596 IF_FEATURE_SUID(ruid = getuid();)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000597}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100598# endif /* FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000599
600
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100601# if ENABLE_FEATURE_SUID && NUM_APPLETS > 0
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100602# if ENABLE_FEATURE_SUID_CONFIG
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100603/* check if u is member of group g */
604static int ingroup(uid_t u, gid_t g)
605{
606 struct group *grp = getgrgid(g);
607 if (grp) {
608 char **mem;
609 for (mem = grp->gr_mem; *mem; mem++) {
610 struct passwd *pwd = getpwnam(*mem);
611 if (pwd && (pwd->pw_uid == u))
612 return 1;
613 }
614 }
615 return 0;
616}
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100617# endif
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100618
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000619static void check_suid(int applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000620{
621 gid_t rgid; /* real gid */
622
623 if (ruid == 0) /* set by parse_config_file() */
624 return; /* run by root - no need to check more */
625 rgid = getgid();
626
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100627# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000628 if (suid_cfg_readable) {
629 uid_t uid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200630 struct suid_config_t *sct;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000631 mode_t m;
632
633 for (sct = suid_config; sct; sct = sct->m_next) {
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000634 if (sct->m_applet == applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000635 goto found;
636 }
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000637 goto check_need_suid;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000638 found:
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200639 /* Is this user allowed to run this applet? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000640 m = sct->m_mode;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200641 if (sct->m_ugid.uid == ruid)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000642 /* same uid */
643 m >>= 6;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200644 else if ((sct->m_ugid.gid == rgid) || ingroup(ruid, sct->m_ugid.gid))
Denis Vlasenko724d1962007-10-10 14:41:07 +0000645 /* same group / in group */
646 m >>= 3;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200647 if (!(m & S_IXOTH)) /* is x bit not set? */
Denys Vlasenkod83aff12011-05-16 13:53:19 +0200648 bb_error_msg_and_die("you have no permission to run this applet");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000649
Denis Vlasenko724d1962007-10-10 14:41:07 +0000650 /* We set effective AND saved ids. If saved-id is not set
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200651 * like we do below, seteuid(0) can still later succeed! */
652
653 /* Are we directed to change gid
654 * (APPLET = *s* USER.GROUP or APPLET = *S* USER.GROUP)?
655 */
656 if (sct->m_mode & S_ISGID)
657 rgid = sct->m_ugid.gid;
658 /* else: we will set egid = rgid, thus dropping sgid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000659 if (setresgid(-1, rgid, rgid))
660 bb_perror_msg_and_die("setresgid");
661
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200662 /* Are we directed to change uid
663 * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
664 */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000665 uid = ruid;
666 if (sct->m_mode & S_ISUID)
Denys Vlasenko4566e172011-05-16 00:01:08 +0200667 uid = sct->m_ugid.uid;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200668 /* else: we will set euid = ruid, thus dropping suid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000669 if (setresuid(-1, uid, uid))
670 bb_perror_msg_and_die("setresuid");
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200671
Denys Vlasenko9be47022011-05-16 12:21:31 +0200672 goto ret;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000673 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100674# if !ENABLE_FEATURE_SUID_CONFIG_QUIET
Denis Vlasenko724d1962007-10-10 14:41:07 +0000675 {
676 static bool onetime = 0;
677
678 if (!onetime) {
679 onetime = 1;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200680 bb_error_msg("using fallback suid method");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000681 }
682 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100683# endif
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000684 check_need_suid:
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100685# endif
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100686 if (APPLET_SUID(applet_no) == BB_SUID_REQUIRE) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000687 /* Real uid is not 0. If euid isn't 0 too, suid bit
688 * is most probably not set on our executable */
689 if (geteuid())
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000690 bb_error_msg_and_die("must be suid to work properly");
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100691 } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
Denys Vlasenko12a4f9a2017-07-10 09:17:43 +0200692 /*
693 * Drop all privileges.
694 *
695 * Don't check for errors: in normal use, they are impossible,
696 * and in special cases, exiting is harmful. Example:
697 * 'unshare --user' when user's shell is also from busybox.
698 *
699 * 'unshare --user' creates a new user namespace without any
700 * uid mappings. Thus, busybox binary is setuid nobody:nogroup
701 * within the namespace, as that is the only user. However,
702 * since no uids are mapped, calls to setgid/setuid
703 * fail (even though they would do nothing).
704 */
705 setgid(rgid);
706 setuid(ruid);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000707 }
Denys Vlasenko9be47022011-05-16 12:21:31 +0200708# if ENABLE_FEATURE_SUID_CONFIG
Cristian Ionescu-Idbohrnea137aa2011-05-20 03:52:36 +0200709 ret: ;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200710 llist_free((llist_t*)suid_config, NULL);
711# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000712}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100713# else
714# define check_suid(x) ((void)0)
715# endif /* FEATURE_SUID */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000716
717
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100718# if ENABLE_FEATURE_INSTALLER
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400719static const char usr_bin [] ALIGN1 = "/usr/bin/";
720static const char usr_sbin[] ALIGN1 = "/usr/sbin/";
721static const char *const install_dir[] = {
722 &usr_bin [8], /* "/" */
723 &usr_bin [4], /* "/bin/" */
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200724 &usr_sbin[4] /* "/sbin/" */
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100725# if !ENABLE_INSTALL_NO_USR
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200726 ,usr_bin
727 ,usr_sbin
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100728# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400729};
730
Denis Vlasenko724d1962007-10-10 14:41:07 +0000731/* create (sym)links for each applet */
Denys Vlasenko3b405432009-07-15 00:35:34 +0200732static void install_links(const char *busybox, int use_symbolic_links,
733 char *custom_install_dir)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000734{
735 /* directory table
736 * this should be consistent w/ the enum,
737 * busybox.h::bb_install_loc_t, or else... */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000738 int (*lf)(const char *, const char *);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000739 char *fpc;
Denys Vlasenko4c201c02018-07-17 15:04:17 +0200740 const char *appname = applet_names;
Denis Vlasenko6b06cb82008-05-15 21:30:45 +0000741 unsigned i;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000742 int rc;
743
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000744 lf = link;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000745 if (use_symbolic_links)
746 lf = symlink;
747
Denis Vlasenko745cd172007-11-29 03:31:20 +0000748 for (i = 0; i < ARRAY_SIZE(applet_main); i++) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000749 fpc = concat_path_file(
Denys Vlasenko3b405432009-07-15 00:35:34 +0200750 custom_install_dir ? custom_install_dir : install_dir[APPLET_INSTALL_LOC(i)],
Ron Yorston610c4c32016-03-30 00:42:05 +0200751 appname);
Denis Vlasenko745cd172007-11-29 03:31:20 +0000752 // debug: bb_error_msg("%slinking %s to busybox",
753 // use_symbolic_links ? "sym" : "", fpc);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000754 rc = lf(busybox, fpc);
755 if (rc != 0 && errno != EEXIST) {
756 bb_simple_perror_msg(fpc);
757 }
758 free(fpc);
Ron Yorston610c4c32016-03-30 00:42:05 +0200759 while (*appname++ != '\0')
760 continue;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000761 }
762}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200763# elif ENABLE_BUSYBOX
Mike Frysingerf1999b52014-01-31 00:29:47 -0500764static void install_links(const char *busybox UNUSED_PARAM,
765 int use_symbolic_links UNUSED_PARAM,
766 char *custom_install_dir UNUSED_PARAM)
767{
768}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100769# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000770
Ron Yorston1b0dcc02016-07-05 14:07:50 +0100771static void run_applet_and_exit(const char *name, char **argv) NORETURN;
772
Denys Vlasenkof128bdb2017-07-29 00:59:24 +0200773# if ENABLE_BUSYBOX
774# if ENABLE_FEATURE_SH_STANDALONE && ENABLE_FEATURE_TAB_COMPLETION
775 /*
776 * Insert "busybox" into applet table as well.
777 * This makes standalone shell tab-complete this name too.
778 * (Otherwise having "busybox" in applet table is not necessary,
779 * there is other code which routes "busyboxANY_SUFFIX" name
780 * to busybox_main()).
781 */
782//usage:#define busybox_trivial_usage NOUSAGE_STR
783//usage:#define busybox_full_usage ""
784//applet:IF_BUSYBOX(IF_FEATURE_SH_STANDALONE(IF_FEATURE_TAB_COMPLETION(APPLET(busybox, BB_DIR_BIN, BB_SUID_MAYBE))))
785int busybox_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
786# else
787# define busybox_main(argc,argv) busybox_main(argv)
788static
789# endif
790int busybox_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000791{
792 if (!argv[1]) {
793 /* Called without arguments */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000794 const char *a;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200795 int col;
796 unsigned output_width;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000797 help:
Denys Vlasenkoa8a075a2017-01-11 10:52:24 +0100798 output_width = get_terminal_width(2);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000799
Denis Vlasenko21278df2008-06-25 12:15:46 +0000800 dup2(1, 2);
Denys Vlasenko630dde12009-08-30 19:57:49 +0200801 full_write2_str(bb_banner); /* reuse const string */
802 full_write2_str(" multi-call binary.\n"); /* reuse */
803 full_write2_str(
Aaro Koskinen7b729ed2015-04-02 00:55:17 +0300804 "BusyBox is copyrighted by many authors between 1998-2015.\n"
Bradley M. Kuhn0e941d52012-07-13 11:38:38 -0400805 "Licensed under GPLv2. See source distribution for detailed\n"
806 "copyright notices.\n"
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400807 "\n"
Denys Vlasenko02b8b9b2012-05-14 23:52:57 +0200808 "Usage: busybox [function [arguments]...]\n"
Denys Vlasenkoba888262012-03-22 11:15:06 +0100809 " or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
810 IF_FEATURE_INSTALLER(
811 " or: busybox --install [-s] [DIR]\n"
812 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400813 " or: function [arguments]...\n"
814 "\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100815 IF_NOT_FEATURE_SH_STANDALONE(
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400816 "\tBusyBox is a multi-call binary that combines many common Unix\n"
817 "\tutilities into a single executable. Most people will create a\n"
818 "\tlink to busybox for each function they wish to use and BusyBox\n"
819 "\twill act like whatever it was invoked as.\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100820 )
821 IF_FEATURE_SH_STANDALONE(
822 "\tBusyBox is a multi-call binary that combines many common Unix\n"
823 "\tutilities into a single executable. The shell in this build\n"
824 "\tis configured to run built-in utilities without $PATH search.\n"
825 "\tYou don't need to install a link to busybox for each utility.\n"
826 "\tTo run external program, use full path (/sbin/ip instead of ip).\n"
827 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400828 "\n"
829 "Currently defined functions:\n"
830 );
Denis Vlasenko724d1962007-10-10 14:41:07 +0000831 col = 0;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000832 a = applet_names;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200833 /* prevent last comma to be in the very last pos */
834 output_width--;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000835 while (*a) {
Denys Vlasenko0149f022009-05-19 18:01:42 +0200836 int len2 = strlen(a) + 2;
837 if (col >= (int)output_width - len2) {
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000838 full_write2_str(",\n");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000839 col = 0;
840 }
Denys Vlasenko0149f022009-05-19 18:01:42 +0200841 if (col == 0) {
842 col = 6;
843 full_write2_str("\t");
844 } else {
845 full_write2_str(", ");
846 }
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000847 full_write2_str(a);
Denys Vlasenko0149f022009-05-19 18:01:42 +0200848 col += len2;
849 a += len2 - 1;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000850 }
Denys Vlasenko7d877fc2016-11-28 01:29:28 +0100851 full_write2_str("\n");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000852 return 0;
853 }
854
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100855 if (is_prefixed_with(argv[1], "--list")) {
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400856 unsigned i = 0;
857 const char *a = applet_names;
858 dup2(1, 2);
859 while (*a) {
Denys Vlasenko8e950682016-05-31 02:42:49 +0200860# if ENABLE_FEATURE_INSTALLER
Denys Vlasenkoba888262012-03-22 11:15:06 +0100861 if (argv[1][6]) /* --list-full? */
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400862 full_write2_str(install_dir[APPLET_INSTALL_LOC(i)] + 1);
Denys Vlasenko8e950682016-05-31 02:42:49 +0200863# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400864 full_write2_str(a);
865 full_write2_str("\n");
866 i++;
Ron Yorston2b919582016-04-08 11:57:20 +0100867 while (*a++ != '\0')
868 continue;
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400869 }
870 return 0;
871 }
872
Denis Vlasenko724d1962007-10-10 14:41:07 +0000873 if (ENABLE_FEATURE_INSTALLER && strcmp(argv[1], "--install") == 0) {
Denys Vlasenko3b405432009-07-15 00:35:34 +0200874 int use_symbolic_links;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000875 const char *busybox;
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100876
Denis Vlasenko724d1962007-10-10 14:41:07 +0000877 busybox = xmalloc_readlink(bb_busybox_exec_path);
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100878 if (!busybox) {
879 /* bb_busybox_exec_path is usually "/proc/self/exe".
880 * In chroot, readlink("/proc/self/exe") usually fails.
881 * In such case, better use argv[0] as symlink target
882 * if it is a full path name.
883 */
Denys Vlasenko5c942712011-03-12 06:08:28 +0100884 if (argv[0][0] != '/')
885 bb_error_msg_and_die("'%s' is not an absolute path", argv[0]);
886 busybox = argv[0];
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100887 }
888 /* busybox --install [-s] [DIR]:
889 * -s: make symlinks
890 * DIR: directory to install links to
891 */
Denys Vlasenkoba888262012-03-22 11:15:06 +0100892 use_symbolic_links = (argv[2] && strcmp(argv[2], "-s") == 0 && ++argv);
Denys Vlasenko3b405432009-07-15 00:35:34 +0200893 install_links(busybox, use_symbolic_links, argv[2]);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000894 return 0;
895 }
896
897 if (strcmp(argv[1], "--help") == 0) {
898 /* "busybox --help [<applet>]" */
899 if (!argv[2])
900 goto help;
901 /* convert to "<applet> --help" */
902 argv[0] = argv[2];
903 argv[2] = NULL;
904 } else {
905 /* "busybox <applet> arg1 arg2 ..." */
906 argv++;
907 }
908 /* We support "busybox /a/path/to/applet args..." too. Allows for
909 * "#!/bin/busybox"-style wrappers */
910 applet_name = bb_get_last_path_component_nostrip(argv[0]);
911 run_applet_and_exit(applet_name, argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000912}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200913# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000914
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200915# if NUM_APPLETS > 0
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200916void FAST_FUNC run_applet_no_and_exit(int applet_no, const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000917{
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200918 int argc = string_array_len(argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000919
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200920 /*
921 * We do not use argv[0]: do not want to repeat massaging of
922 * "-/sbin/halt" -> "halt", for example.
923 */
924 applet_name = name;
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200925
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200926 /* Special case. POSIX says "test --help"
927 * should be no different from e.g. "test --foo".
928 * Thus for "test", we skip --help check.
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200929 * "true" and "false" are also special.
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200930 */
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200931 if (1
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200932# if defined APPLET_NO_test
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200933 && applet_no != APPLET_NO_test
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200934# endif
935# if defined APPLET_NO_true
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200936 && applet_no != APPLET_NO_true
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200937# endif
938# if defined APPLET_NO_false
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200939 && applet_no != APPLET_NO_false
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200940# endif
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200941 ) {
942 if (argc == 2 && strcmp(argv[1], "--help") == 0) {
943 /* Make "foo --help" exit with 0: */
944 xfunc_error_retval = 0;
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000945 bb_show_usage();
Denys Vlasenko5d783552013-01-17 11:02:21 +0100946 }
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000947 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000948 if (ENABLE_FEATURE_SUID)
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000949 check_suid(applet_no);
Denys Vlasenko215b0ca2016-08-19 18:23:56 +0200950 xfunc_error_retval = applet_main[applet_no](argc, argv);
951 /* Note: applet_main() may also not return (die on a xfunc or such) */
952 xfunc_die();
Denis Vlasenko724d1962007-10-10 14:41:07 +0000953}
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200954# endif /* NUM_APPLETS > 0 */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000955
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100956# if ENABLE_BUSYBOX || NUM_APPLETS > 0
Ron Yorstonce824ae2016-06-07 12:12:07 +0100957static NORETURN void run_applet_and_exit(const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000958{
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100959# if ENABLE_BUSYBOX
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100960 if (is_prefixed_with(name, "busybox"))
Denys Vlasenkof128bdb2017-07-29 00:59:24 +0200961 exit(busybox_main(/*unused:*/ 0, argv));
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100962# endif
963# if NUM_APPLETS > 0
Ron Yorston610c4c32016-03-30 00:42:05 +0200964 /* find_applet_by_name() search is more expensive, so goes second */
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200965 {
966 int applet = find_applet_by_name(name);
967 if (applet >= 0)
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200968 run_applet_no_and_exit(applet, name, argv);
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200969 }
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100970# endif
Ron Yorstonce824ae2016-06-07 12:12:07 +0100971
972 /*bb_error_msg_and_die("applet not found"); - links in printf */
973 full_write2_str(applet_name);
974 full_write2_str(": applet not found\n");
975 /* POSIX: "If a command is not found, the exit status shall be 127" */
976 exit(127);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000977}
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100978# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000979
Denis Vlasenko10f6fb12008-04-29 00:10:27 +0000980#endif /* !defined(SINGLE_APPLET_MAIN) */
Denis Vlasenko468aea22008-04-01 14:47:57 +0000981
982
Denis Vlasenko724d1962007-10-10 14:41:07 +0000983#if ENABLE_BUILD_LIBBUSYBOX
Denis Vlasenko85c24712008-03-17 09:04:04 +0000984int lbb_main(char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000985#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000986int main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000987#endif
988{
Denys Vlasenkobc14f4d2016-04-03 16:06:42 +0200989#if 0
990 /* TODO: find a use for a block of memory between end of .bss
991 * and end of page. For example, I'm getting "_end:0x812e698 2408 bytes"
992 * - more than 2k of wasted memory (in this particular build)
993 * *per each running process*!
994 * (If your linker does not generate "_end" name, weak attribute
995 * makes &_end == NULL, end_len == 0 here.)
996 */
997 extern char _end[] __attribute__((weak));
998 unsigned end_len = (-(int)_end) & 0xfff;
999 printf("_end:%p %u bytes\n", &_end, end_len);
1000#endif
1001
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001002 /* Tweak malloc for reduced memory consumption */
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001003#ifdef M_TRIM_THRESHOLD
1004 /* M_TRIM_THRESHOLD is the maximum amount of freed top-most memory
1005 * to keep before releasing to the OS
1006 * Default is way too big: 256k
1007 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001008 mallopt(M_TRIM_THRESHOLD, 8 * 1024);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001009#endif
1010#ifdef M_MMAP_THRESHOLD
1011 /* M_MMAP_THRESHOLD is the request size threshold for using mmap()
1012 * Default is too big: 256k
1013 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001014 mallopt(M_MMAP_THRESHOLD, 32 * 1024 - 256);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001015#endif
Denys Vlasenko7f0ebbc2016-10-03 17:42:53 +02001016#if 0 /*def M_TOP_PAD*/
1017 /* When the program break is increased, then M_TOP_PAD bytes are added
1018 * to the sbrk(2) request. When the heap is trimmed because of free(3),
1019 * this much free space is preserved at the top of the heap.
1020 * glibc default seems to be way too big: 128k, but need to verify.
1021 */
1022 mallopt(M_TOP_PAD, 8 * 1024);
1023#endif
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001024
Denis Vlasenko724d1962007-10-10 14:41:07 +00001025#if !BB_MMU
1026 /* NOMMU re-exec trick sets high-order bit in first byte of name */
1027 if (argv[0][0] & 0x80) {
1028 re_execed = 1;
1029 argv[0][0] &= 0x7f;
1030 }
1031#endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001032
1033#if defined(SINGLE_APPLET_MAIN)
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001034
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001035 /* Only one applet is selected in .config */
Denys Vlasenko8dff01d2015-03-12 17:48:34 +01001036 if (argv[1] && is_prefixed_with(argv[0], "busybox")) {
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001037 /* "busybox <applet> <params>" should still work as expected */
1038 argv++;
1039 }
1040 /* applet_names in this case is just "applet\0\0" */
1041 lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001042# if ENABLE_BUILD_LIBBUSYBOX
1043 return SINGLE_APPLET_MAIN(string_array_len(argv), argv);
1044# else
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001045 return SINGLE_APPLET_MAIN(argc, argv);
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001046# endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001047
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001048#elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
1049
1050 full_write2_str(bb_basename(argv[0]));
1051 full_write2_str(": no applets enabled\n");
1052 exit(127);
1053
1054#else
1055
1056 lbb_prepare("busybox" IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001057# if !ENABLE_BUSYBOX
Ron Yorstonba120812016-06-07 10:26:24 +01001058 if (argv[1] && is_prefixed_with(bb_basename(argv[0]), "busybox"))
1059 argv++;
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001060# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001061 applet_name = argv[0];
1062 if (applet_name[0] == '-')
1063 applet_name++;
1064 applet_name = bb_basename(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001065
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001066 /* If we are a result of execv("/proc/self/exe"), fix ugly comm of "exe" */
1067 if (ENABLE_FEATURE_SH_STANDALONE
1068 || ENABLE_FEATURE_PREFER_APPLETS
1069 || !BB_MMU
1070 ) {
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001071 if (NUM_APPLETS > 1)
1072 set_task_comm(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001073 }
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001074
Denis Vlasenko724d1962007-10-10 14:41:07 +00001075 parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +00001076 run_applet_and_exit(applet_name, argv);
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001077
Denis Vlasenko468aea22008-04-01 14:47:57 +00001078#endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001079}