blob: 5f59f1273f45014c825b910bedd205642699604a [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 Vlasenkoaaa07092020-10-01 01:44:26 +020028
29/* Define this accessor before we #define "errno" our way */
30#include <errno.h>
31static inline int *get_perrno(void) { return &errno; }
32
Denys Vlasenkoc1947f12009-10-23 01:30:26 +020033#include "busybox.h"
Denys Vlasenko9be47022011-05-16 12:21:31 +020034
Denys Vlasenko8da415e2010-12-05 01:30:14 +010035#if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
Denys Vlasenko982e87f2013-07-30 11:52:58 +020036 || defined(__APPLE__) \
Denys Vlasenko8da415e2010-12-05 01:30:14 +010037 )
38# include <malloc.h> /* for mallopt */
39#endif
Denys Vlasenko9be47022011-05-16 12:21:31 +020040
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000041/* Declare <applet>_main() */
42#define PROTOTYPES
43#include "applets.h"
44#undef PROTOTYPES
45
Denis Vlasenko32b2a9f2008-02-22 22:43:22 +000046/* Include generated applet names, pointers to <applet>_main, etc */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +000047#include "applet_tables.h"
Denis Vlasenko468aea22008-04-01 14:47:57 +000048/* ...and if applet_tables generator says we have only one applet... */
49#ifdef SINGLE_APPLET_MAIN
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020050# undef ENABLE_FEATURE_INDIVIDUAL
51# define ENABLE_FEATURE_INDIVIDUAL 1
52# undef IF_FEATURE_INDIVIDUAL
53# define IF_FEATURE_INDIVIDUAL(...) __VA_ARGS__
Denis Vlasenko468aea22008-04-01 14:47:57 +000054#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000055
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020056#include "usage_compressed.h"
57
Ron Yorston71df2d32018-11-27 14:34:25 +000058#if ENABLE_FEATURE_SH_EMBEDDED_SCRIPTS
Ron Yorston37788982018-11-17 17:48:14 +000059# define DEFINE_SCRIPT_DATA 1
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +010060# include "embedded_scripts.h"
61#else
62# define NUM_SCRIPTS 0
63#endif
64#if NUM_SCRIPTS > 0
65# include "bb_archive.h"
66static const char packed_scripts[] ALIGN1 = { PACKED_SCRIPTS };
67#endif
Denys Vlasenkofe936242017-01-06 19:16:36 +010068
69/* "Do not compress usage text if uncompressed text is small
70 * and we don't include bunzip2 code for other reasons"
71 *
72 * Useful for mass one-applet rebuild (bunzip2 code is ~2.7k).
73 *
74 * Unlike BUNZIP2, if FEATURE_SEAMLESS_BZ2 is on, bunzip2 code is built but
75 * still may be unused if none of the selected applets calls open_zipped()
76 * or its friends; we test for (FEATURE_SEAMLESS_BZ2 && <APPLET>) instead.
77 * For example, only if TAR and FEATURE_SEAMLESS_BZ2 are both selected,
78 * then bunzip2 code will be linked in anyway, and disabling help compression
79 * would be not optimal:
80 */
81#if UNPACKED_USAGE_LENGTH < 4*1024 \
82 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_TAR) \
83 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MODPROBE) \
84 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_INSMOD) \
85 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_DEPMOD) \
86 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MAN) \
87 && !ENABLE_BUNZIP2 \
88 && !ENABLE_BZCAT
89# undef ENABLE_FEATURE_COMPRESS_USAGE
90# define ENABLE_FEATURE_COMPRESS_USAGE 0
91#endif
92
93
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +020094unsigned FAST_FUNC string_array_len(char **argv)
95{
96 char **start = argv;
97
98 while (*argv)
99 argv++;
100
101 return argv - start;
102}
103
104
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200105#if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
106static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
107#else
108# define usage_messages 0
Denys Vlasenko1fcbff22010-06-26 02:40:08 +0200109#endif
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200110
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000111#if ENABLE_FEATURE_COMPRESS_USAGE
112
Denys Vlasenko5c296de2010-07-03 14:28:35 +0200113static const char packed_usage[] ALIGN1 = { PACKED_USAGE };
Denys Vlasenkod184a722011-09-22 12:45:14 +0200114# include "bb_archive.h"
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100115# define unpack_usage_messages() \
116 unpack_bz2_data(packed_usage, sizeof(packed_usage), sizeof(UNPACKED_USAGE))
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200117# define dealloc_usage_messages(s) free(s)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000118
119#else
120
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200121# define unpack_usage_messages() usage_messages
122# define dealloc_usage_messages(s) ((void)(s))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000123
124#endif /* FEATURE_COMPRESS_USAGE */
125
126
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000127void FAST_FUNC bb_show_usage(void)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000128{
129 if (ENABLE_SHOW_USAGE) {
Denis Vlasenko468aea22008-04-01 14:47:57 +0000130#ifdef SINGLE_APPLET_STR
Denys Vlasenkoff653552019-01-01 16:54:30 +0100131 /* Imagine that this applet is "true". Dont link in printf! */
Lauri Kasanen2b662c52010-11-13 23:16:05 +0100132 const char *usage_string = unpack_usage_messages();
Denis Vlasenko468aea22008-04-01 14:47:57 +0000133
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100134 if (usage_string) {
135 if (*usage_string == '\b') {
Denys Vlasenkoff653552019-01-01 16:54:30 +0100136 full_write2_str("No help available\n");
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100137 } else {
138 full_write2_str("Usage: "SINGLE_APPLET_STR" ");
139 full_write2_str(usage_string);
Denys Vlasenkoff653552019-01-01 16:54:30 +0100140 full_write2_str("\n");
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100141 }
142 if (ENABLE_FEATURE_CLEAN_UP)
143 dealloc_usage_messages((char*)usage_string);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000144 }
Denis Vlasenko468aea22008-04-01 14:47:57 +0000145#else
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000146 const char *p;
147 const char *usage_string = p = unpack_usage_messages();
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000148 int ap = find_applet_by_name(applet_name);
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000149
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100150 if (ap < 0 || usage_string == NULL)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000151 xfunc_die();
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000152 while (ap) {
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000153 while (*p++) continue;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000154 ap--;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000155 }
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000156 full_write2_str(bb_banner);
Denys Vlasenkoff653552019-01-01 16:54:30 +0100157 full_write2_str(" multi-call binary.\n"); /* common string */
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000158 if (*p == '\b')
Denys Vlasenkoff653552019-01-01 16:54:30 +0100159 full_write2_str("\nNo help available\n");
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000160 else {
161 full_write2_str("\nUsage: ");
162 full_write2_str(applet_name);
Denys Vlasenko253f5552018-07-09 18:23:33 +0200163 if (p[0]) {
164 if (p[0] != '\n')
165 full_write2_str(" ");
166 full_write2_str(p);
167 }
Denys Vlasenko7f4a49a2015-05-25 14:30:52 +0200168 full_write2_str("\n");
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000169 }
Denys Vlasenko630dde12009-08-30 19:57:49 +0200170 if (ENABLE_FEATURE_CLEAN_UP)
171 dealloc_usage_messages((char*)usage_string);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000172#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000173 }
174 xfunc_die();
175}
176
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000177int FAST_FUNC find_applet_by_name(const char *name)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000178{
Ron Yorstonb2206172016-04-03 22:29:35 +0200179 unsigned i, max;
180 int j;
Denis Vlasenko745cd172007-11-29 03:31:20 +0000181 const char *p;
Ron Yorston610c4c32016-03-30 00:42:05 +0200182
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200183/* The commented-out word-at-a-time code is ~40% faster, but +160 bytes.
184 * "Faster" here saves ~0.5 microsecond of real time - not worth it.
185 */
186#if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
187 uint32_t n32;
188
189 /* Handle all names < 2 chars long early */
190 if (name[0] == '\0')
191 return -1; /* "" is not a valid applet name */
192 if (name[1] == '\0') {
193 if (!ENABLE_TEST)
194 return -1; /* 1-char name is not valid */
195 if (name[0] != ']')
196 return -1; /* 1-char name which isn't "[" is not valid */
197 /* applet "[" is always applet #0: */
198 return 0;
199 }
200#endif
201
Ron Yorston610c4c32016-03-30 00:42:05 +0200202 p = applet_names;
203 i = 0;
204#if KNOWN_APPNAME_OFFSETS <= 0
205 max = NUM_APPLETS;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000206#else
Ron Yorston610c4c32016-03-30 00:42:05 +0200207 max = NUM_APPLETS * KNOWN_APPNAME_OFFSETS;
208 for (j = ARRAY_SIZE(applet_nameofs)-1; j >= 0; j--) {
209 const char *pp = applet_names + applet_nameofs[j];
210 if (strcmp(name, pp) >= 0) {
211 //bb_error_msg("name:'%s' >= pp:'%s'", name, pp);
212 p = pp;
213 i = max - NUM_APPLETS;
214 break;
215 }
216 max -= NUM_APPLETS;
217 }
218 max /= (unsigned)KNOWN_APPNAME_OFFSETS;
219 i /= (unsigned)KNOWN_APPNAME_OFFSETS;
220 //bb_error_msg("name:'%s' starting from:'%s' i:%u max:%u", name, p, i, max);
221#endif
222
Denys Vlasenko1cf68e32016-04-02 22:57:17 +0200223 /* Open-coded linear search without strcmp/strlen calls for speed */
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200224
225#if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
226 /* skip "[\0" name, it's surely not it */
227 if (ENABLE_TEST && LONE_CHAR(p, '['))
228 i++, p += 2;
229 /* All remaining applet names in p[] are at least 2 chars long */
230 /* name[] is also at least 2 chars long */
231
232 n32 = (name[0] << 0) | (name[1] << 8) | (name[2] << 16);
233 while (i < max) {
234 uint32_t p32;
235 char ch;
236
237 /* Quickly check match of the first 3 bytes */
238 move_from_unaligned32(p32, p);
239 p += 3;
240 if ((p32 & 0x00ffffff) != n32) {
241 /* Most likely case: 3 first bytes do not match */
242 i++;
243 if ((p32 & 0x00ff0000) == '\0')
244 continue; // p[2] was NUL
245 p++;
246 if ((p32 & 0xff000000) == '\0')
247 continue; // p[3] was NUL
248 /* p[0..3] aren't matching and none is NUL, check the rest */
249 while (*p++ != '\0')
250 continue;
251 continue;
252 }
253
254 /* Unlikely branch: first 3 bytes ([0..2]) match */
255 if ((p32 & 0x00ff0000) == '\0') {
256 /* name is 2-byte long, it is full match */
257 //bb_error_msg("found:'%s' i:%u", name, i);
258 return i;
259 }
260 /* Check remaining bytes [3..NUL] */
261 ch = (p32 >> 24);
262 j = 3;
263 while (ch == name[j]) {
264 if (ch == '\0') {
265 //bb_error_msg("found:'%s' i:%u", name, i);
266 return i;
267 }
268 ch = *++p;
269 j++;
270 }
271 /* Not a match. Skip it, including NUL */
272 while (ch != '\0')
273 ch = *++p;
274 p++;
275 i++;
276 }
277 return -1;
278#else
Ron Yorston610c4c32016-03-30 00:42:05 +0200279 while (i < max) {
280 char ch;
281 j = 0;
282 /* Do we see "name\0" in applet_names[p] position? */
283 while ((ch = *p) == name[j]) {
284 if (ch == '\0') {
285 //bb_error_msg("found:'%s' i:%u", name, i);
286 return i; /* yes */
287 }
288 p++;
289 j++;
290 }
291 /* No.
292 * p => 1st non-matching char in applet_names[],
293 * skip to and including NUL.
294 */
295 while (ch != '\0')
296 ch = *++p;
297 p++;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000298 i++;
299 }
300 return -1;
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200301#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000302}
303
304
Denis Vlasenko68404f12008-03-17 09:00:54 +0000305void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000306 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenko468aea22008-04-01 14:47:57 +0000307 MAIN_EXTERNALLY_VISIBLE;
308void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000309 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000310{
Denys Vlasenkob1c7a662020-10-01 00:34:44 +0200311#ifdef bb_cached_errno_ptr
Denys Vlasenkoaaa07092020-10-01 01:44:26 +0200312 (*(int **)not_const_pp(&bb_errno)) = get_perrno();
Denis Vlasenko574f2f42008-02-27 18:41:59 +0000313 barrier();
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000314#endif
Denis Vlasenko15cb4a42007-10-11 10:06:26 +0000315 applet_name = applet;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000316
Denys Vlasenko45b4ecc2014-08-11 20:33:18 +0200317 if (ENABLE_LOCALE_SUPPORT)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000318 setlocale(LC_ALL, "");
319
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000320#if ENABLE_FEATURE_INDIVIDUAL
321 /* Redundant for busybox (run_applet_and_exit covers that case)
322 * but needed for "individual applet" mode */
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200323 if (argv[1]
324 && !argv[2]
325 && strcmp(argv[1], "--help") == 0
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100326 && !is_prefixed_with(applet, "busybox")
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200327 ) {
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000328 /* Special case. POSIX says "test --help"
329 * should be no different from e.g. "test --foo". */
330 if (!ENABLE_TEST || strcmp(applet_name, "test") != 0)
331 bb_show_usage();
332 }
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000333#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000334}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000335
336/* The code below can well be in applets/applets.c, as it is used only
337 * for busybox binary, not "individual" binaries.
338 * However, keeping it here and linking it into libbusybox.so
339 * (together with remaining tiny applets/applets.o)
340 * makes it possible to avoid --whole-archive at link time.
341 * This makes (shared busybox) + libbusybox smaller.
342 * (--gc-sections would be even better....)
343 */
344
345const char *applet_name;
346#if !BB_MMU
347bool re_execed;
348#endif
349
Denis Vlasenko468aea22008-04-01 14:47:57 +0000350
Denis Vlasenko10f6fb12008-04-29 00:10:27 +0000351/* If not built as a single-applet executable... */
352#if !defined(SINGLE_APPLET_MAIN)
Denis Vlasenko468aea22008-04-01 14:47:57 +0000353
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000354IF_FEATURE_SUID(static uid_t ruid;) /* real uid */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000355
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100356# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000357
Denys Vlasenko9be47022011-05-16 12:21:31 +0200358static struct suid_config_t {
359 /* next ptr must be first: this struct needs to be llist-compatible */
360 struct suid_config_t *m_next;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200361 struct bb_uidgid_t m_ugid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200362 int m_applet;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000363 mode_t m_mode;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000364} *suid_config;
365
366static bool suid_cfg_readable;
367
Denys Vlasenkod83aff12011-05-16 13:53:19 +0200368/* libbb candidate */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000369static char *get_trimmed_slice(char *s, char *e)
370{
371 /* First, consider the value at e to be nul and back up until we
372 * reach a non-space char. Set the char after that (possibly at
373 * the original e) to nul. */
374 while (e-- > s) {
375 if (!isspace(*e)) {
376 break;
377 }
378 }
379 e[1] = '\0';
380
381 /* Next, advance past all leading space and return a ptr to the
382 * first non-space char; possibly the terminating nul. */
383 return skip_whitespace(s);
384}
385
Denis Vlasenko724d1962007-10-10 14:41:07 +0000386static void parse_config_file(void)
387{
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200388 /* Don't depend on the tools to combine strings. */
389 static const char config_file[] ALIGN1 = "/etc/busybox.conf";
390
Denys Vlasenko9be47022011-05-16 12:21:31 +0200391 struct suid_config_t *sct_head;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000392 int applet_no;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000393 FILE *f;
394 const char *errmsg;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000395 unsigned lc;
396 smallint section;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000397 struct stat st;
398
Denis Vlasenko724d1962007-10-10 14:41:07 +0000399 ruid = getuid();
400 if (ruid == 0) /* run by root - don't need to even read config file */
401 return;
402
403 if ((stat(config_file, &st) != 0) /* No config file? */
404 || !S_ISREG(st.st_mode) /* Not a regular file? */
405 || (st.st_uid != 0) /* Not owned by root? */
406 || (st.st_mode & (S_IWGRP | S_IWOTH)) /* Writable by non-root? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200407 || !(f = fopen_for_read(config_file)) /* Cannot open? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000408 ) {
409 return;
410 }
411
412 suid_cfg_readable = 1;
413 sct_head = NULL;
414 section = lc = 0;
415
416 while (1) {
Denys Vlasenko9be47022011-05-16 12:21:31 +0200417 char buffer[256];
418 char *s;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000419
Denys Vlasenko9be47022011-05-16 12:21:31 +0200420 if (!fgets(buffer, sizeof(buffer), f)) { /* Are we done? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200421 // Looks like bloat
422 //if (ferror(f)) { /* Make sure it wasn't a read error. */
423 // errmsg = "reading";
424 // goto pe_label;
425 //}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000426 fclose(f);
427 suid_config = sct_head; /* Success, so set the pointer. */
428 return;
429 }
430
Denys Vlasenko9be47022011-05-16 12:21:31 +0200431 s = buffer;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000432 lc++; /* Got a (partial) line. */
433
434 /* If a line is too long for our buffer, we consider it an error.
435 * The following test does mistreat one corner case though.
436 * If the final line of the file does not end with a newline and
437 * yet exactly fills the buffer, it will be treated as too long
438 * even though there isn't really a problem. But it isn't really
439 * worth adding code to deal with such an unlikely situation, and
440 * we do err on the side of caution. Besides, the line would be
441 * too long if it did end with a newline. */
442 if (!strchr(s, '\n') && !feof(f)) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200443 errmsg = "line too long";
444 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000445 }
446
447 /* Trim leading and trailing whitespace, ignoring comments, and
448 * check if the resulting string is empty. */
449 s = get_trimmed_slice(s, strchrnul(s, '#'));
450 if (!*s) {
451 continue;
452 }
453
454 /* Check for a section header. */
455
456 if (*s == '[') {
457 /* Unlike the old code, we ignore leading and trailing
458 * whitespace for the section name. We also require that
459 * there are no stray characters after the closing bracket. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200460 char *e = strchr(s, ']');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000461 if (!e /* Missing right bracket? */
462 || e[1] /* Trailing characters? */
463 || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
464 ) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200465 errmsg = "section header";
466 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000467 }
468 /* Right now we only have one section so just check it.
469 * If more sections are added in the future, please don't
470 * resort to cascading ifs with multiple strcasecmp calls.
471 * That kind of bloated code is all too common. A loop
472 * and a string table would be a better choice unless the
473 * number of sections is very small. */
474 if (strcasecmp(s, "SUID") == 0) {
475 section = 1;
476 continue;
477 }
478 section = -1; /* Unknown section so set to skip. */
479 continue;
480 }
481
482 /* Process sections. */
483
484 if (section == 1) { /* SUID */
485 /* Since we trimmed leading and trailing space above, we're
486 * now looking for strings of the form
487 * <key>[::space::]*=[::space::]*<value>
488 * where both key and value could contain inner whitespace. */
489
490 /* First get the key (an applet name in our case). */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200491 char *e = strchr(s, '=');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000492 if (e) {
493 s = get_trimmed_slice(s, e);
494 }
495 if (!e || !*s) { /* Missing '=' or empty key. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200496 errmsg = "keyword";
497 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000498 }
499
500 /* Ok, we have an applet name. Process the rhs if this
501 * applet is currently built in and ignore it otherwise.
502 * Note: this can hide config file bugs which only pop
503 * up when the busybox configuration is changed. */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000504 applet_no = find_applet_by_name(s);
505 if (applet_no >= 0) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200506 unsigned i;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200507 struct suid_config_t *sct;
508
Denis Vlasenko724d1962007-10-10 14:41:07 +0000509 /* Note: We currently don't check for duplicates!
510 * The last config line for each applet will be the
511 * one used since we insert at the head of the list.
512 * I suppose this could be considered a feature. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200513 sct = xzalloc(sizeof(*sct));
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000514 sct->m_applet = applet_no;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200515 /*sct->m_mode = 0;*/
Denis Vlasenko724d1962007-10-10 14:41:07 +0000516 sct->m_next = sct_head;
517 sct_head = sct;
518
519 /* Get the specified mode. */
520
521 e = skip_whitespace(e+1);
522
523 for (i = 0; i < 3; i++) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200524 /* There are 4 chars for each of user/group/other.
525 * "x-xx" instead of "x-" are to make
526 * "idx > 3" check catch invalid chars.
527 */
528 static const char mode_chars[] ALIGN1 = "Ssx-" "Ssx-" "x-xx";
529 static const unsigned short mode_mask[] ALIGN2 = {
530 S_ISUID, S_ISUID|S_IXUSR, S_IXUSR, 0, /* Ssx- */
531 S_ISGID, S_ISGID|S_IXGRP, S_IXGRP, 0, /* Ssx- */
532 S_IXOTH, 0 /* x- */
533 };
534 const char *q = strchrnul(mode_chars + 4*i, *e);
535 unsigned idx = q - (mode_chars + 4*i);
536 if (idx > 3) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200537 errmsg = "mode";
538 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000539 }
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200540 sct->m_mode |= mode_mask[q - mode_chars];
541 e++;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000542 }
543
Marek Polacekb0b88842011-04-16 17:33:43 +0200544 /* Now get the user/group info. */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000545
546 s = skip_whitespace(e);
Denys Vlasenko351fec32011-05-16 14:30:26 +0200547 /* Default is 0.0, else parse USER.GROUP: */
548 if (*s) {
549 /* We require whitespace between mode and USER.GROUP */
550 if ((s == e) || !(e = strchr(s, '.'))) {
551 errmsg = "uid.gid";
552 goto pe_label;
553 }
554 *e = ':'; /* get_uidgid needs USER:GROUP syntax */
Denys Vlasenko526d8582015-10-19 04:27:17 +0200555 if (get_uidgid(&sct->m_ugid, s) == 0) {
Denys Vlasenko351fec32011-05-16 14:30:26 +0200556 errmsg = "unknown user/group";
557 goto pe_label;
558 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000559 }
560 }
561 continue;
562 }
563
564 /* Unknown sections are ignored. */
565
566 /* Encountering configuration lines prior to seeing a
567 * section header is treated as an error. This is how
568 * the old code worked, but it may not be desirable.
569 * We may want to simply ignore such lines in case they
570 * are used in some future version of busybox. */
571 if (!section) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200572 errmsg = "keyword outside section";
573 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000574 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000575 } /* while (1) */
576
577 pe_label:
Denys Vlasenko9be47022011-05-16 12:21:31 +0200578 fclose(f);
Denys Vlasenko4566e172011-05-16 00:01:08 +0200579 bb_error_msg("parse error in %s, line %u: %s", config_file, lc, errmsg);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000580
Denis Vlasenko724d1962007-10-10 14:41:07 +0000581 /* Release any allocated memory before returning. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200582 llist_free((llist_t*)sct_head, NULL);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000583}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100584# else
Denis Vlasenko724d1962007-10-10 14:41:07 +0000585static inline void parse_config_file(void)
586{
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000587 IF_FEATURE_SUID(ruid = getuid();)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000588}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100589# endif /* FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000590
591
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100592# if ENABLE_FEATURE_SUID && NUM_APPLETS > 0
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100593# if ENABLE_FEATURE_SUID_CONFIG
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100594/* check if u is member of group g */
595static int ingroup(uid_t u, gid_t g)
596{
597 struct group *grp = getgrgid(g);
598 if (grp) {
599 char **mem;
600 for (mem = grp->gr_mem; *mem; mem++) {
601 struct passwd *pwd = getpwnam(*mem);
602 if (pwd && (pwd->pw_uid == u))
603 return 1;
604 }
605 }
606 return 0;
607}
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100608# endif
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100609
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000610static void check_suid(int applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000611{
612 gid_t rgid; /* real gid */
613
614 if (ruid == 0) /* set by parse_config_file() */
615 return; /* run by root - no need to check more */
616 rgid = getgid();
617
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100618# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000619 if (suid_cfg_readable) {
620 uid_t uid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200621 struct suid_config_t *sct;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000622 mode_t m;
623
624 for (sct = suid_config; sct; sct = sct->m_next) {
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000625 if (sct->m_applet == applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000626 goto found;
627 }
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000628 goto check_need_suid;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000629 found:
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200630 /* Is this user allowed to run this applet? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000631 m = sct->m_mode;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200632 if (sct->m_ugid.uid == ruid)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000633 /* same uid */
634 m >>= 6;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200635 else if ((sct->m_ugid.gid == rgid) || ingroup(ruid, sct->m_ugid.gid))
Denis Vlasenko724d1962007-10-10 14:41:07 +0000636 /* same group / in group */
637 m >>= 3;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200638 if (!(m & S_IXOTH)) /* is x bit not set? */
James Byrne69374872019-07-02 11:35:03 +0200639 bb_simple_error_msg_and_die("you have no permission to run this applet");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000640
Denis Vlasenko724d1962007-10-10 14:41:07 +0000641 /* We set effective AND saved ids. If saved-id is not set
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200642 * like we do below, seteuid(0) can still later succeed! */
643
644 /* Are we directed to change gid
645 * (APPLET = *s* USER.GROUP or APPLET = *S* USER.GROUP)?
646 */
647 if (sct->m_mode & S_ISGID)
648 rgid = sct->m_ugid.gid;
649 /* else: we will set egid = rgid, thus dropping sgid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000650 if (setresgid(-1, rgid, rgid))
James Byrne69374872019-07-02 11:35:03 +0200651 bb_simple_perror_msg_and_die("setresgid");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000652
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200653 /* Are we directed to change uid
654 * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
655 */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000656 uid = ruid;
657 if (sct->m_mode & S_ISUID)
Denys Vlasenko4566e172011-05-16 00:01:08 +0200658 uid = sct->m_ugid.uid;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200659 /* else: we will set euid = ruid, thus dropping suid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000660 if (setresuid(-1, uid, uid))
James Byrne69374872019-07-02 11:35:03 +0200661 bb_simple_perror_msg_and_die("setresuid");
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200662
Denys Vlasenko9be47022011-05-16 12:21:31 +0200663 goto ret;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000664 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100665# if !ENABLE_FEATURE_SUID_CONFIG_QUIET
Denis Vlasenko724d1962007-10-10 14:41:07 +0000666 {
667 static bool onetime = 0;
668
669 if (!onetime) {
670 onetime = 1;
James Byrne69374872019-07-02 11:35:03 +0200671 bb_simple_error_msg("using fallback suid method");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000672 }
673 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100674# endif
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000675 check_need_suid:
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100676# endif
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100677 if (APPLET_SUID(applet_no) == BB_SUID_REQUIRE) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000678 /* Real uid is not 0. If euid isn't 0 too, suid bit
679 * is most probably not set on our executable */
680 if (geteuid())
James Byrne69374872019-07-02 11:35:03 +0200681 bb_simple_error_msg_and_die("must be suid to work properly");
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100682 } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
Denys Vlasenko12a4f9a2017-07-10 09:17:43 +0200683 /*
684 * Drop all privileges.
685 *
686 * Don't check for errors: in normal use, they are impossible,
687 * and in special cases, exiting is harmful. Example:
688 * 'unshare --user' when user's shell is also from busybox.
689 *
690 * 'unshare --user' creates a new user namespace without any
691 * uid mappings. Thus, busybox binary is setuid nobody:nogroup
692 * within the namespace, as that is the only user. However,
693 * since no uids are mapped, calls to setgid/setuid
694 * fail (even though they would do nothing).
695 */
696 setgid(rgid);
697 setuid(ruid);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000698 }
Denys Vlasenko9be47022011-05-16 12:21:31 +0200699# if ENABLE_FEATURE_SUID_CONFIG
Cristian Ionescu-Idbohrnea137aa2011-05-20 03:52:36 +0200700 ret: ;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200701 llist_free((llist_t*)suid_config, NULL);
702# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000703}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100704# else
705# define check_suid(x) ((void)0)
706# endif /* FEATURE_SUID */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000707
708
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100709# if ENABLE_FEATURE_INSTALLER
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400710static const char usr_bin [] ALIGN1 = "/usr/bin/";
711static const char usr_sbin[] ALIGN1 = "/usr/sbin/";
712static const char *const install_dir[] = {
713 &usr_bin [8], /* "/" */
714 &usr_bin [4], /* "/bin/" */
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200715 &usr_sbin[4] /* "/sbin/" */
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100716# if !ENABLE_INSTALL_NO_USR
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200717 ,usr_bin
718 ,usr_sbin
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100719# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400720};
721
Denis Vlasenko724d1962007-10-10 14:41:07 +0000722/* create (sym)links for each applet */
Denys Vlasenko3b405432009-07-15 00:35:34 +0200723static void install_links(const char *busybox, int use_symbolic_links,
724 char *custom_install_dir)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000725{
726 /* directory table
727 * this should be consistent w/ the enum,
728 * busybox.h::bb_install_loc_t, or else... */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000729 int (*lf)(const char *, const char *);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000730 char *fpc;
Denys Vlasenko4c201c02018-07-17 15:04:17 +0200731 const char *appname = applet_names;
Denis Vlasenko6b06cb82008-05-15 21:30:45 +0000732 unsigned i;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000733 int rc;
734
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000735 lf = link;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000736 if (use_symbolic_links)
737 lf = symlink;
738
Denis Vlasenko745cd172007-11-29 03:31:20 +0000739 for (i = 0; i < ARRAY_SIZE(applet_main); i++) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000740 fpc = concat_path_file(
Denys Vlasenko3b405432009-07-15 00:35:34 +0200741 custom_install_dir ? custom_install_dir : install_dir[APPLET_INSTALL_LOC(i)],
Ron Yorston610c4c32016-03-30 00:42:05 +0200742 appname);
Denis Vlasenko745cd172007-11-29 03:31:20 +0000743 // debug: bb_error_msg("%slinking %s to busybox",
744 // use_symbolic_links ? "sym" : "", fpc);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000745 rc = lf(busybox, fpc);
746 if (rc != 0 && errno != EEXIST) {
747 bb_simple_perror_msg(fpc);
748 }
749 free(fpc);
Ron Yorston610c4c32016-03-30 00:42:05 +0200750 while (*appname++ != '\0')
751 continue;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000752 }
753}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200754# elif ENABLE_BUSYBOX
Mike Frysingerf1999b52014-01-31 00:29:47 -0500755static void install_links(const char *busybox UNUSED_PARAM,
756 int use_symbolic_links UNUSED_PARAM,
757 char *custom_install_dir UNUSED_PARAM)
758{
759}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100760# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000761
Denys Vlasenko67e15292020-06-24 13:39:13 +0200762# if ENABLE_BUSYBOX || NUM_APPLETS > 0
Ron Yorston1b0dcc02016-07-05 14:07:50 +0100763static void run_applet_and_exit(const char *name, char **argv) NORETURN;
Denys Vlasenko67e15292020-06-24 13:39:13 +0200764#endif
Ron Yorston1b0dcc02016-07-05 14:07:50 +0100765
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100766# if NUM_SCRIPTS > 0
767static int find_script_by_name(const char *name)
768{
769 int i;
770 int applet = find_applet_by_name(name);
771
772 if (applet >= 0) {
773 for (i = 0; i < NUM_SCRIPTS; ++i)
774 if (applet_numbers[i] == applet)
775 return i;
776 }
777 return -1;
778}
779
Ron Yorston3193cb52019-03-30 07:47:12 +0000780int scripted_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100781int scripted_main(int argc UNUSED_PARAM, char **argv)
782{
783 int script = find_script_by_name(applet_name);
784 if (script >= 0)
Denys Vlasenko67e15292020-06-24 13:39:13 +0200785# if ENABLE_SHELL_ASH
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100786 exit(ash_main(-script - 1, argv));
Denys Vlasenko67e15292020-06-24 13:39:13 +0200787# elif ENABLE_SHELL_HUSH
Ron Yorston71df2d32018-11-27 14:34:25 +0000788 exit(hush_main(-script - 1, argv));
Denys Vlasenko67e15292020-06-24 13:39:13 +0200789# else
Ron Yorston71df2d32018-11-27 14:34:25 +0000790 return 1;
Denys Vlasenko67e15292020-06-24 13:39:13 +0200791# endif
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100792 return 0;
793}
794
795char* FAST_FUNC
796get_script_content(unsigned n)
797{
798 char *t = unpack_bz2_data(packed_scripts, sizeof(packed_scripts),
799 UNPACKED_SCRIPTS_LENGTH);
800 if (t) {
801 while (n != 0) {
802 while (*t++ != '\0')
803 continue;
804 n--;
805 }
806 }
807 return t;
808}
809# endif /* NUM_SCRIPTS > 0 */
810
Denys Vlasenkof128bdb2017-07-29 00:59:24 +0200811# if ENABLE_BUSYBOX
812# if ENABLE_FEATURE_SH_STANDALONE && ENABLE_FEATURE_TAB_COMPLETION
813 /*
814 * Insert "busybox" into applet table as well.
815 * This makes standalone shell tab-complete this name too.
816 * (Otherwise having "busybox" in applet table is not necessary,
817 * there is other code which routes "busyboxANY_SUFFIX" name
818 * to busybox_main()).
819 */
820//usage:#define busybox_trivial_usage NOUSAGE_STR
821//usage:#define busybox_full_usage ""
822//applet:IF_BUSYBOX(IF_FEATURE_SH_STANDALONE(IF_FEATURE_TAB_COMPLETION(APPLET(busybox, BB_DIR_BIN, BB_SUID_MAYBE))))
823int busybox_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
824# else
825# define busybox_main(argc,argv) busybox_main(argv)
826static
827# endif
828int busybox_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000829{
830 if (!argv[1]) {
831 /* Called without arguments */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000832 const char *a;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200833 int col;
834 unsigned output_width;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000835 help:
Denys Vlasenkoa8a075a2017-01-11 10:52:24 +0100836 output_width = get_terminal_width(2);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000837
Denis Vlasenko21278df2008-06-25 12:15:46 +0000838 dup2(1, 2);
Denys Vlasenko630dde12009-08-30 19:57:49 +0200839 full_write2_str(bb_banner); /* reuse const string */
840 full_write2_str(" multi-call binary.\n"); /* reuse */
841 full_write2_str(
Aaro Koskinen7b729ed2015-04-02 00:55:17 +0300842 "BusyBox is copyrighted by many authors between 1998-2015.\n"
Bradley M. Kuhn0e941d52012-07-13 11:38:38 -0400843 "Licensed under GPLv2. See source distribution for detailed\n"
844 "copyright notices.\n"
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400845 "\n"
Denys Vlasenko02b8b9b2012-05-14 23:52:57 +0200846 "Usage: busybox [function [arguments]...]\n"
Denys Vlasenkoba888262012-03-22 11:15:06 +0100847 " or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100848# if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
849 " or: busybox --show SCRIPT\n"
850# endif
Denys Vlasenkoba888262012-03-22 11:15:06 +0100851 IF_FEATURE_INSTALLER(
852 " or: busybox --install [-s] [DIR]\n"
853 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400854 " or: function [arguments]...\n"
855 "\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100856 IF_NOT_FEATURE_SH_STANDALONE(
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400857 "\tBusyBox is a multi-call binary that combines many common Unix\n"
858 "\tutilities into a single executable. Most people will create a\n"
859 "\tlink to busybox for each function they wish to use and BusyBox\n"
860 "\twill act like whatever it was invoked as.\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100861 )
862 IF_FEATURE_SH_STANDALONE(
863 "\tBusyBox is a multi-call binary that combines many common Unix\n"
864 "\tutilities into a single executable. The shell in this build\n"
865 "\tis configured to run built-in utilities without $PATH search.\n"
866 "\tYou don't need to install a link to busybox for each utility.\n"
867 "\tTo run external program, use full path (/sbin/ip instead of ip).\n"
868 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400869 "\n"
870 "Currently defined functions:\n"
871 );
Denis Vlasenko724d1962007-10-10 14:41:07 +0000872 col = 0;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200873 /* prevent last comma to be in the very last pos */
874 output_width--;
Denys Vlasenko0575c992018-11-01 13:58:16 +0100875 a = applet_names;
Ron Yorston37788982018-11-17 17:48:14 +0000876 while (*a) {
877 int len2 = strlen(a) + 2;
878 if (col >= (int)output_width - len2) {
879 full_write2_str(",\n");
880 col = 0;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000881 }
Ron Yorston37788982018-11-17 17:48:14 +0000882 if (col == 0) {
883 col = 6;
884 full_write2_str("\t");
885 } else {
886 full_write2_str(", ");
887 }
888 full_write2_str(a);
889 col += len2;
890 a += len2 - 1;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000891 }
Denys Vlasenko7d877fc2016-11-28 01:29:28 +0100892 full_write2_str("\n");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000893 return 0;
894 }
895
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100896# if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
897 if (strcmp(argv[1], "--show") == 0) {
898 int n;
899 if (!argv[2])
900 bb_error_msg_and_die(bb_msg_requires_arg, "--show");
901 n = find_script_by_name(argv[2]);
902 if (n < 0)
903 bb_error_msg_and_die("script '%s' not found", argv[2]);
904 full_write1_str(get_script_content(n));
905 return 0;
906 }
907# endif
908
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100909 if (is_prefixed_with(argv[1], "--list")) {
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400910 unsigned i = 0;
911 const char *a = applet_names;
912 dup2(1, 2);
913 while (*a) {
Denys Vlasenko8e950682016-05-31 02:42:49 +0200914# if ENABLE_FEATURE_INSTALLER
Denys Vlasenkoba888262012-03-22 11:15:06 +0100915 if (argv[1][6]) /* --list-full? */
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400916 full_write2_str(install_dir[APPLET_INSTALL_LOC(i)] + 1);
Denys Vlasenko8e950682016-05-31 02:42:49 +0200917# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400918 full_write2_str(a);
919 full_write2_str("\n");
920 i++;
Ron Yorston2b919582016-04-08 11:57:20 +0100921 while (*a++ != '\0')
922 continue;
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400923 }
924 return 0;
925 }
926
Denis Vlasenko724d1962007-10-10 14:41:07 +0000927 if (ENABLE_FEATURE_INSTALLER && strcmp(argv[1], "--install") == 0) {
Denys Vlasenko3b405432009-07-15 00:35:34 +0200928 int use_symbolic_links;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000929 const char *busybox;
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100930
Denis Vlasenko724d1962007-10-10 14:41:07 +0000931 busybox = xmalloc_readlink(bb_busybox_exec_path);
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100932 if (!busybox) {
933 /* bb_busybox_exec_path is usually "/proc/self/exe".
934 * In chroot, readlink("/proc/self/exe") usually fails.
935 * In such case, better use argv[0] as symlink target
936 * if it is a full path name.
937 */
Denys Vlasenko5c942712011-03-12 06:08:28 +0100938 if (argv[0][0] != '/')
939 bb_error_msg_and_die("'%s' is not an absolute path", argv[0]);
940 busybox = argv[0];
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100941 }
942 /* busybox --install [-s] [DIR]:
943 * -s: make symlinks
944 * DIR: directory to install links to
945 */
Denys Vlasenkoba888262012-03-22 11:15:06 +0100946 use_symbolic_links = (argv[2] && strcmp(argv[2], "-s") == 0 && ++argv);
Denys Vlasenko3b405432009-07-15 00:35:34 +0200947 install_links(busybox, use_symbolic_links, argv[2]);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000948 return 0;
949 }
950
951 if (strcmp(argv[1], "--help") == 0) {
952 /* "busybox --help [<applet>]" */
953 if (!argv[2])
954 goto help;
955 /* convert to "<applet> --help" */
956 argv[0] = argv[2];
957 argv[2] = NULL;
958 } else {
959 /* "busybox <applet> arg1 arg2 ..." */
960 argv++;
961 }
962 /* We support "busybox /a/path/to/applet args..." too. Allows for
963 * "#!/bin/busybox"-style wrappers */
964 applet_name = bb_get_last_path_component_nostrip(argv[0]);
965 run_applet_and_exit(applet_name, argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000966}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200967# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000968
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200969# if NUM_APPLETS > 0
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200970void FAST_FUNC run_applet_no_and_exit(int applet_no, const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000971{
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200972 int argc = string_array_len(argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000973
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200974 /*
975 * We do not use argv[0]: do not want to repeat massaging of
976 * "-/sbin/halt" -> "halt", for example.
977 */
978 applet_name = name;
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200979
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200980 /* Special case. POSIX says "test --help"
981 * should be no different from e.g. "test --foo".
982 * Thus for "test", we skip --help check.
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200983 * "true" and "false" are also special.
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200984 */
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200985 if (1
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200986# if defined APPLET_NO_test
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200987 && applet_no != APPLET_NO_test
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200988# endif
989# if defined APPLET_NO_true
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200990 && applet_no != APPLET_NO_true
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200991# endif
992# if defined APPLET_NO_false
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200993 && applet_no != APPLET_NO_false
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200994# endif
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200995 ) {
996 if (argc == 2 && strcmp(argv[1], "--help") == 0) {
997 /* Make "foo --help" exit with 0: */
998 xfunc_error_retval = 0;
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000999 bb_show_usage();
Denys Vlasenko5d783552013-01-17 11:02:21 +01001000 }
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +00001001 }
Denis Vlasenko724d1962007-10-10 14:41:07 +00001002 if (ENABLE_FEATURE_SUID)
Denis Vlasenko1aa7e472007-11-28 06:49:03 +00001003 check_suid(applet_no);
Denys Vlasenko215b0ca2016-08-19 18:23:56 +02001004 xfunc_error_retval = applet_main[applet_no](argc, argv);
1005 /* Note: applet_main() may also not return (die on a xfunc or such) */
1006 xfunc_die();
Denis Vlasenko724d1962007-10-10 14:41:07 +00001007}
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001008# endif /* NUM_APPLETS > 0 */
Denis Vlasenko724d1962007-10-10 14:41:07 +00001009
Ron Yorston37788982018-11-17 17:48:14 +00001010# if ENABLE_BUSYBOX || NUM_APPLETS > 0
Ron Yorstonce824ae2016-06-07 12:12:07 +01001011static NORETURN void run_applet_and_exit(const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001012{
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001013# if ENABLE_BUSYBOX
Denys Vlasenko8dff01d2015-03-12 17:48:34 +01001014 if (is_prefixed_with(name, "busybox"))
Denys Vlasenkof128bdb2017-07-29 00:59:24 +02001015 exit(busybox_main(/*unused:*/ 0, argv));
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001016# endif
1017# if NUM_APPLETS > 0
Ron Yorston610c4c32016-03-30 00:42:05 +02001018 /* find_applet_by_name() search is more expensive, so goes second */
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001019 {
1020 int applet = find_applet_by_name(name);
1021 if (applet >= 0)
Denys Vlasenko69a5ec92017-07-07 19:08:56 +02001022 run_applet_no_and_exit(applet, name, argv);
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001023 }
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001024# endif
Ron Yorstonce824ae2016-06-07 12:12:07 +01001025
1026 /*bb_error_msg_and_die("applet not found"); - links in printf */
1027 full_write2_str(applet_name);
1028 full_write2_str(": applet not found\n");
1029 /* POSIX: "If a command is not found, the exit status shall be 127" */
1030 exit(127);
Denis Vlasenko724d1962007-10-10 14:41:07 +00001031}
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001032# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001033
Denys Vlasenko67e15292020-06-24 13:39:13 +02001034#else /* defined(SINGLE_APPLET_MAIN) */
1035
1036# if NUM_SCRIPTS > 0
1037/* if SINGLE_APPLET_MAIN, these two functions are simpler: */
1038int scripted_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
1039int scripted_main(int argc UNUSED_PARAM, char **argv)
1040{
1041# if ENABLE_SHELL_ASH
1042 int script = 0;
1043 exit(ash_main(-script - 1, argv));
1044# elif ENABLE_SHELL_HUSH
1045 int script = 0;
1046 exit(hush_main(-script - 1, argv));
1047# else
1048 return 1;
1049# endif
1050}
1051char* FAST_FUNC
1052get_script_content(unsigned n UNUSED_PARAM)
1053{
1054 char *t = unpack_bz2_data(packed_scripts, sizeof(packed_scripts),
1055 UNPACKED_SCRIPTS_LENGTH);
1056 return t;
1057}
1058# endif /* NUM_SCRIPTS > 0 */
1059
1060#endif /* defined(SINGLE_APPLET_MAIN) */
Denis Vlasenko468aea22008-04-01 14:47:57 +00001061
1062
Denis Vlasenko724d1962007-10-10 14:41:07 +00001063#if ENABLE_BUILD_LIBBUSYBOX
Denis Vlasenko85c24712008-03-17 09:04:04 +00001064int lbb_main(char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001065#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001066int main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001067#endif
1068{
Denys Vlasenkobc14f4d2016-04-03 16:06:42 +02001069#if 0
1070 /* TODO: find a use for a block of memory between end of .bss
1071 * and end of page. For example, I'm getting "_end:0x812e698 2408 bytes"
1072 * - more than 2k of wasted memory (in this particular build)
1073 * *per each running process*!
1074 * (If your linker does not generate "_end" name, weak attribute
1075 * makes &_end == NULL, end_len == 0 here.)
1076 */
1077 extern char _end[] __attribute__((weak));
1078 unsigned end_len = (-(int)_end) & 0xfff;
1079 printf("_end:%p %u bytes\n", &_end, end_len);
1080#endif
1081
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001082 /* Tweak malloc for reduced memory consumption */
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001083#ifdef M_TRIM_THRESHOLD
1084 /* M_TRIM_THRESHOLD is the maximum amount of freed top-most memory
1085 * to keep before releasing to the OS
1086 * Default is way too big: 256k
1087 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001088 mallopt(M_TRIM_THRESHOLD, 8 * 1024);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001089#endif
1090#ifdef M_MMAP_THRESHOLD
1091 /* M_MMAP_THRESHOLD is the request size threshold for using mmap()
1092 * Default is too big: 256k
1093 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001094 mallopt(M_MMAP_THRESHOLD, 32 * 1024 - 256);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001095#endif
Denys Vlasenko7f0ebbc2016-10-03 17:42:53 +02001096#if 0 /*def M_TOP_PAD*/
1097 /* When the program break is increased, then M_TOP_PAD bytes are added
1098 * to the sbrk(2) request. When the heap is trimmed because of free(3),
1099 * this much free space is preserved at the top of the heap.
1100 * glibc default seems to be way too big: 128k, but need to verify.
1101 */
1102 mallopt(M_TOP_PAD, 8 * 1024);
1103#endif
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001104
Denis Vlasenko724d1962007-10-10 14:41:07 +00001105#if !BB_MMU
1106 /* NOMMU re-exec trick sets high-order bit in first byte of name */
1107 if (argv[0][0] & 0x80) {
1108 re_execed = 1;
1109 argv[0][0] &= 0x7f;
1110 }
1111#endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001112
1113#if defined(SINGLE_APPLET_MAIN)
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001114
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001115 /* Only one applet is selected in .config */
Denys Vlasenko8dff01d2015-03-12 17:48:34 +01001116 if (argv[1] && is_prefixed_with(argv[0], "busybox")) {
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001117 /* "busybox <applet> <params>" should still work as expected */
1118 argv++;
1119 }
1120 /* applet_names in this case is just "applet\0\0" */
1121 lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001122# if ENABLE_BUILD_LIBBUSYBOX
1123 return SINGLE_APPLET_MAIN(string_array_len(argv), argv);
1124# else
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001125 return SINGLE_APPLET_MAIN(argc, argv);
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001126# endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001127
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001128#elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
1129
1130 full_write2_str(bb_basename(argv[0]));
1131 full_write2_str(": no applets enabled\n");
1132 exit(127);
1133
1134#else
1135
1136 lbb_prepare("busybox" IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001137# if !ENABLE_BUSYBOX
Ron Yorstonba120812016-06-07 10:26:24 +01001138 if (argv[1] && is_prefixed_with(bb_basename(argv[0]), "busybox"))
1139 argv++;
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001140# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001141 applet_name = argv[0];
1142 if (applet_name[0] == '-')
1143 applet_name++;
1144 applet_name = bb_basename(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001145
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001146 /* If we are a result of execv("/proc/self/exe"), fix ugly comm of "exe" */
1147 if (ENABLE_FEATURE_SH_STANDALONE
1148 || ENABLE_FEATURE_PREFER_APPLETS
1149 || !BB_MMU
1150 ) {
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001151 if (NUM_APPLETS > 1)
1152 set_task_comm(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001153 }
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001154
Denis Vlasenko724d1962007-10-10 14:41:07 +00001155 parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +00001156 run_applet_and_exit(applet_name, argv);
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001157
Denis Vlasenko468aea22008-04-01 14:47:57 +00001158#endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001159}