blob: 542211255d4dd3dd50a9abb8859e3b0dd60c7e38 [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 Yorston59120c32021-01-29 13:22:48 +0000179 unsigned i;
Ron Yorstonb2206172016-04-03 22:29:35 +0200180 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;
Ron Yorston610c4c32016-03-30 00:42:05 +0200203#if KNOWN_APPNAME_OFFSETS <= 0
Ron Yorston59120c32021-01-29 13:22:48 +0000204 i = 0;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000205#else
Ron Yorston59120c32021-01-29 13:22:48 +0000206 i = NUM_APPLETS * (KNOWN_APPNAME_OFFSETS - 1);
Ron Yorston610c4c32016-03-30 00:42:05 +0200207 for (j = ARRAY_SIZE(applet_nameofs)-1; j >= 0; j--) {
208 const char *pp = applet_names + applet_nameofs[j];
209 if (strcmp(name, pp) >= 0) {
210 //bb_error_msg("name:'%s' >= pp:'%s'", name, pp);
211 p = pp;
Ron Yorston610c4c32016-03-30 00:42:05 +0200212 break;
213 }
Ron Yorston59120c32021-01-29 13:22:48 +0000214 i -= NUM_APPLETS;
Ron Yorston610c4c32016-03-30 00:42:05 +0200215 }
Ron Yorston610c4c32016-03-30 00:42:05 +0200216 i /= (unsigned)KNOWN_APPNAME_OFFSETS;
Ron Yorston59120c32021-01-29 13:22:48 +0000217 //bb_error_msg("name:'%s' starting from:'%s' i:%u", name, p, i);
Ron Yorston610c4c32016-03-30 00:42:05 +0200218#endif
219
Denys Vlasenko1cf68e32016-04-02 22:57:17 +0200220 /* Open-coded linear search without strcmp/strlen calls for speed */
Ron Yorston59120c32021-01-29 13:22:48 +0000221 while (*p) {
222 /* Do we see "name\0" at current position in applet_names? */
223 for (j = 0; *p == name[j]; ++j) {
224 if (*p++ == '\0') {
Ron Yorston610c4c32016-03-30 00:42:05 +0200225 //bb_error_msg("found:'%s' i:%u", name, i);
226 return i; /* yes */
227 }
Ron Yorston610c4c32016-03-30 00:42:05 +0200228 }
Ron Yorston59120c32021-01-29 13:22:48 +0000229 /* No. Have we gone too far, alphabetically? */
230 if (*p > name[j]) {
231 //bb_error_msg("break:'%s' i:%u", name, i);
232 break;
233 }
234 /* No. Move to the start of the next applet name. */
235 while (*p++ != '\0')
236 continue;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000237 i++;
238 }
239 return -1;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000240}
241
242
Denis Vlasenko68404f12008-03-17 09:00:54 +0000243void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000244 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenko468aea22008-04-01 14:47:57 +0000245 MAIN_EXTERNALLY_VISIBLE;
246void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000247 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000248{
Denys Vlasenkob1c7a662020-10-01 00:34:44 +0200249#ifdef bb_cached_errno_ptr
Denys Vlasenkoaaa07092020-10-01 01:44:26 +0200250 (*(int **)not_const_pp(&bb_errno)) = get_perrno();
Denis Vlasenko574f2f42008-02-27 18:41:59 +0000251 barrier();
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000252#endif
Denis Vlasenko15cb4a42007-10-11 10:06:26 +0000253 applet_name = applet;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000254
Denys Vlasenko45b4ecc2014-08-11 20:33:18 +0200255 if (ENABLE_LOCALE_SUPPORT)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000256 setlocale(LC_ALL, "");
257
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000258#if ENABLE_FEATURE_INDIVIDUAL
259 /* Redundant for busybox (run_applet_and_exit covers that case)
260 * but needed for "individual applet" mode */
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200261 if (argv[1]
262 && !argv[2]
263 && strcmp(argv[1], "--help") == 0
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100264 && !is_prefixed_with(applet, "busybox")
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200265 ) {
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000266 /* Special case. POSIX says "test --help"
267 * should be no different from e.g. "test --foo". */
268 if (!ENABLE_TEST || strcmp(applet_name, "test") != 0)
269 bb_show_usage();
270 }
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000271#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000272}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000273
274/* The code below can well be in applets/applets.c, as it is used only
275 * for busybox binary, not "individual" binaries.
276 * However, keeping it here and linking it into libbusybox.so
277 * (together with remaining tiny applets/applets.o)
278 * makes it possible to avoid --whole-archive at link time.
279 * This makes (shared busybox) + libbusybox smaller.
280 * (--gc-sections would be even better....)
281 */
282
283const char *applet_name;
284#if !BB_MMU
285bool re_execed;
286#endif
287
Denis Vlasenko468aea22008-04-01 14:47:57 +0000288
Denis Vlasenko10f6fb12008-04-29 00:10:27 +0000289/* If not built as a single-applet executable... */
290#if !defined(SINGLE_APPLET_MAIN)
Denis Vlasenko468aea22008-04-01 14:47:57 +0000291
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000292IF_FEATURE_SUID(static uid_t ruid;) /* real uid */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000293
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100294# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000295
Denys Vlasenko9be47022011-05-16 12:21:31 +0200296static struct suid_config_t {
297 /* next ptr must be first: this struct needs to be llist-compatible */
298 struct suid_config_t *m_next;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200299 struct bb_uidgid_t m_ugid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200300 int m_applet;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000301 mode_t m_mode;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000302} *suid_config;
303
304static bool suid_cfg_readable;
305
Denys Vlasenkod83aff12011-05-16 13:53:19 +0200306/* libbb candidate */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000307static char *get_trimmed_slice(char *s, char *e)
308{
309 /* First, consider the value at e to be nul and back up until we
310 * reach a non-space char. Set the char after that (possibly at
311 * the original e) to nul. */
312 while (e-- > s) {
313 if (!isspace(*e)) {
314 break;
315 }
316 }
317 e[1] = '\0';
318
319 /* Next, advance past all leading space and return a ptr to the
320 * first non-space char; possibly the terminating nul. */
321 return skip_whitespace(s);
322}
323
Denis Vlasenko724d1962007-10-10 14:41:07 +0000324static void parse_config_file(void)
325{
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200326 /* Don't depend on the tools to combine strings. */
327 static const char config_file[] ALIGN1 = "/etc/busybox.conf";
328
Denys Vlasenko9be47022011-05-16 12:21:31 +0200329 struct suid_config_t *sct_head;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000330 int applet_no;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000331 FILE *f;
332 const char *errmsg;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000333 unsigned lc;
334 smallint section;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000335 struct stat st;
336
Denis Vlasenko724d1962007-10-10 14:41:07 +0000337 ruid = getuid();
338 if (ruid == 0) /* run by root - don't need to even read config file */
339 return;
340
341 if ((stat(config_file, &st) != 0) /* No config file? */
342 || !S_ISREG(st.st_mode) /* Not a regular file? */
343 || (st.st_uid != 0) /* Not owned by root? */
344 || (st.st_mode & (S_IWGRP | S_IWOTH)) /* Writable by non-root? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200345 || !(f = fopen_for_read(config_file)) /* Cannot open? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000346 ) {
347 return;
348 }
349
350 suid_cfg_readable = 1;
351 sct_head = NULL;
352 section = lc = 0;
353
354 while (1) {
Denys Vlasenko9be47022011-05-16 12:21:31 +0200355 char buffer[256];
356 char *s;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000357
Denys Vlasenko9be47022011-05-16 12:21:31 +0200358 if (!fgets(buffer, sizeof(buffer), f)) { /* Are we done? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200359 // Looks like bloat
360 //if (ferror(f)) { /* Make sure it wasn't a read error. */
361 // errmsg = "reading";
362 // goto pe_label;
363 //}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000364 fclose(f);
365 suid_config = sct_head; /* Success, so set the pointer. */
366 return;
367 }
368
Denys Vlasenko9be47022011-05-16 12:21:31 +0200369 s = buffer;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000370 lc++; /* Got a (partial) line. */
371
372 /* If a line is too long for our buffer, we consider it an error.
373 * The following test does mistreat one corner case though.
374 * If the final line of the file does not end with a newline and
375 * yet exactly fills the buffer, it will be treated as too long
376 * even though there isn't really a problem. But it isn't really
377 * worth adding code to deal with such an unlikely situation, and
378 * we do err on the side of caution. Besides, the line would be
379 * too long if it did end with a newline. */
380 if (!strchr(s, '\n') && !feof(f)) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200381 errmsg = "line too long";
382 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000383 }
384
385 /* Trim leading and trailing whitespace, ignoring comments, and
386 * check if the resulting string is empty. */
387 s = get_trimmed_slice(s, strchrnul(s, '#'));
388 if (!*s) {
389 continue;
390 }
391
392 /* Check for a section header. */
393
394 if (*s == '[') {
395 /* Unlike the old code, we ignore leading and trailing
396 * whitespace for the section name. We also require that
397 * there are no stray characters after the closing bracket. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200398 char *e = strchr(s, ']');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000399 if (!e /* Missing right bracket? */
400 || e[1] /* Trailing characters? */
401 || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
402 ) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200403 errmsg = "section header";
404 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000405 }
406 /* Right now we only have one section so just check it.
407 * If more sections are added in the future, please don't
408 * resort to cascading ifs with multiple strcasecmp calls.
409 * That kind of bloated code is all too common. A loop
410 * and a string table would be a better choice unless the
411 * number of sections is very small. */
412 if (strcasecmp(s, "SUID") == 0) {
413 section = 1;
414 continue;
415 }
416 section = -1; /* Unknown section so set to skip. */
417 continue;
418 }
419
420 /* Process sections. */
421
422 if (section == 1) { /* SUID */
423 /* Since we trimmed leading and trailing space above, we're
424 * now looking for strings of the form
425 * <key>[::space::]*=[::space::]*<value>
426 * where both key and value could contain inner whitespace. */
427
428 /* First get the key (an applet name in our case). */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200429 char *e = strchr(s, '=');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000430 if (e) {
431 s = get_trimmed_slice(s, e);
432 }
433 if (!e || !*s) { /* Missing '=' or empty key. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200434 errmsg = "keyword";
435 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000436 }
437
438 /* Ok, we have an applet name. Process the rhs if this
439 * applet is currently built in and ignore it otherwise.
440 * Note: this can hide config file bugs which only pop
441 * up when the busybox configuration is changed. */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000442 applet_no = find_applet_by_name(s);
443 if (applet_no >= 0) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200444 unsigned i;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200445 struct suid_config_t *sct;
446
Denis Vlasenko724d1962007-10-10 14:41:07 +0000447 /* Note: We currently don't check for duplicates!
448 * The last config line for each applet will be the
449 * one used since we insert at the head of the list.
450 * I suppose this could be considered a feature. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200451 sct = xzalloc(sizeof(*sct));
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000452 sct->m_applet = applet_no;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200453 /*sct->m_mode = 0;*/
Denis Vlasenko724d1962007-10-10 14:41:07 +0000454 sct->m_next = sct_head;
455 sct_head = sct;
456
457 /* Get the specified mode. */
458
459 e = skip_whitespace(e+1);
460
461 for (i = 0; i < 3; i++) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200462 /* There are 4 chars for each of user/group/other.
463 * "x-xx" instead of "x-" are to make
464 * "idx > 3" check catch invalid chars.
465 */
466 static const char mode_chars[] ALIGN1 = "Ssx-" "Ssx-" "x-xx";
467 static const unsigned short mode_mask[] ALIGN2 = {
468 S_ISUID, S_ISUID|S_IXUSR, S_IXUSR, 0, /* Ssx- */
469 S_ISGID, S_ISGID|S_IXGRP, S_IXGRP, 0, /* Ssx- */
470 S_IXOTH, 0 /* x- */
471 };
472 const char *q = strchrnul(mode_chars + 4*i, *e);
473 unsigned idx = q - (mode_chars + 4*i);
474 if (idx > 3) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200475 errmsg = "mode";
476 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000477 }
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200478 sct->m_mode |= mode_mask[q - mode_chars];
479 e++;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000480 }
481
Marek Polacekb0b88842011-04-16 17:33:43 +0200482 /* Now get the user/group info. */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000483
484 s = skip_whitespace(e);
Denys Vlasenko351fec32011-05-16 14:30:26 +0200485 /* Default is 0.0, else parse USER.GROUP: */
486 if (*s) {
487 /* We require whitespace between mode and USER.GROUP */
488 if ((s == e) || !(e = strchr(s, '.'))) {
489 errmsg = "uid.gid";
490 goto pe_label;
491 }
492 *e = ':'; /* get_uidgid needs USER:GROUP syntax */
Denys Vlasenko526d8582015-10-19 04:27:17 +0200493 if (get_uidgid(&sct->m_ugid, s) == 0) {
Denys Vlasenko351fec32011-05-16 14:30:26 +0200494 errmsg = "unknown user/group";
495 goto pe_label;
496 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000497 }
498 }
499 continue;
500 }
501
502 /* Unknown sections are ignored. */
503
504 /* Encountering configuration lines prior to seeing a
505 * section header is treated as an error. This is how
506 * the old code worked, but it may not be desirable.
507 * We may want to simply ignore such lines in case they
508 * are used in some future version of busybox. */
509 if (!section) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200510 errmsg = "keyword outside section";
511 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000512 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000513 } /* while (1) */
514
515 pe_label:
Denys Vlasenko9be47022011-05-16 12:21:31 +0200516 fclose(f);
Denys Vlasenko4566e172011-05-16 00:01:08 +0200517 bb_error_msg("parse error in %s, line %u: %s", config_file, lc, errmsg);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000518
Denis Vlasenko724d1962007-10-10 14:41:07 +0000519 /* Release any allocated memory before returning. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200520 llist_free((llist_t*)sct_head, NULL);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000521}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100522# else
Denis Vlasenko724d1962007-10-10 14:41:07 +0000523static inline void parse_config_file(void)
524{
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000525 IF_FEATURE_SUID(ruid = getuid();)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000526}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100527# endif /* FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000528
529
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100530# if ENABLE_FEATURE_SUID && NUM_APPLETS > 0
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100531# if ENABLE_FEATURE_SUID_CONFIG
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100532/* check if u is member of group g */
533static int ingroup(uid_t u, gid_t g)
534{
535 struct group *grp = getgrgid(g);
536 if (grp) {
537 char **mem;
538 for (mem = grp->gr_mem; *mem; mem++) {
539 struct passwd *pwd = getpwnam(*mem);
540 if (pwd && (pwd->pw_uid == u))
541 return 1;
542 }
543 }
544 return 0;
545}
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100546# endif
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100547
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000548static void check_suid(int applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000549{
550 gid_t rgid; /* real gid */
551
552 if (ruid == 0) /* set by parse_config_file() */
553 return; /* run by root - no need to check more */
554 rgid = getgid();
555
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100556# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000557 if (suid_cfg_readable) {
558 uid_t uid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200559 struct suid_config_t *sct;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000560 mode_t m;
561
562 for (sct = suid_config; sct; sct = sct->m_next) {
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000563 if (sct->m_applet == applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000564 goto found;
565 }
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000566 goto check_need_suid;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000567 found:
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200568 /* Is this user allowed to run this applet? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000569 m = sct->m_mode;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200570 if (sct->m_ugid.uid == ruid)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000571 /* same uid */
572 m >>= 6;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200573 else if ((sct->m_ugid.gid == rgid) || ingroup(ruid, sct->m_ugid.gid))
Denis Vlasenko724d1962007-10-10 14:41:07 +0000574 /* same group / in group */
575 m >>= 3;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200576 if (!(m & S_IXOTH)) /* is x bit not set? */
James Byrne69374872019-07-02 11:35:03 +0200577 bb_simple_error_msg_and_die("you have no permission to run this applet");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000578
Denis Vlasenko724d1962007-10-10 14:41:07 +0000579 /* We set effective AND saved ids. If saved-id is not set
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200580 * like we do below, seteuid(0) can still later succeed! */
581
582 /* Are we directed to change gid
583 * (APPLET = *s* USER.GROUP or APPLET = *S* USER.GROUP)?
584 */
585 if (sct->m_mode & S_ISGID)
586 rgid = sct->m_ugid.gid;
587 /* else: we will set egid = rgid, thus dropping sgid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000588 if (setresgid(-1, rgid, rgid))
James Byrne69374872019-07-02 11:35:03 +0200589 bb_simple_perror_msg_and_die("setresgid");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000590
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200591 /* Are we directed to change uid
592 * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
593 */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000594 uid = ruid;
595 if (sct->m_mode & S_ISUID)
Denys Vlasenko4566e172011-05-16 00:01:08 +0200596 uid = sct->m_ugid.uid;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200597 /* else: we will set euid = ruid, thus dropping suid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000598 if (setresuid(-1, uid, uid))
James Byrne69374872019-07-02 11:35:03 +0200599 bb_simple_perror_msg_and_die("setresuid");
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200600
Denys Vlasenko9be47022011-05-16 12:21:31 +0200601 goto ret;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000602 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100603# if !ENABLE_FEATURE_SUID_CONFIG_QUIET
Denis Vlasenko724d1962007-10-10 14:41:07 +0000604 {
605 static bool onetime = 0;
606
607 if (!onetime) {
608 onetime = 1;
James Byrne69374872019-07-02 11:35:03 +0200609 bb_simple_error_msg("using fallback suid method");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000610 }
611 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100612# endif
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000613 check_need_suid:
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100614# endif
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100615 if (APPLET_SUID(applet_no) == BB_SUID_REQUIRE) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000616 /* Real uid is not 0. If euid isn't 0 too, suid bit
617 * is most probably not set on our executable */
618 if (geteuid())
James Byrne69374872019-07-02 11:35:03 +0200619 bb_simple_error_msg_and_die("must be suid to work properly");
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100620 } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
Denys Vlasenko12a4f9a2017-07-10 09:17:43 +0200621 /*
622 * Drop all privileges.
623 *
624 * Don't check for errors: in normal use, they are impossible,
625 * and in special cases, exiting is harmful. Example:
626 * 'unshare --user' when user's shell is also from busybox.
627 *
628 * 'unshare --user' creates a new user namespace without any
629 * uid mappings. Thus, busybox binary is setuid nobody:nogroup
630 * within the namespace, as that is the only user. However,
631 * since no uids are mapped, calls to setgid/setuid
632 * fail (even though they would do nothing).
633 */
634 setgid(rgid);
635 setuid(ruid);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000636 }
Denys Vlasenko9be47022011-05-16 12:21:31 +0200637# if ENABLE_FEATURE_SUID_CONFIG
Cristian Ionescu-Idbohrnea137aa2011-05-20 03:52:36 +0200638 ret: ;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200639 llist_free((llist_t*)suid_config, NULL);
640# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000641}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100642# else
643# define check_suid(x) ((void)0)
644# endif /* FEATURE_SUID */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000645
646
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100647# if ENABLE_FEATURE_INSTALLER
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400648static const char usr_bin [] ALIGN1 = "/usr/bin/";
649static const char usr_sbin[] ALIGN1 = "/usr/sbin/";
650static const char *const install_dir[] = {
651 &usr_bin [8], /* "/" */
652 &usr_bin [4], /* "/bin/" */
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200653 &usr_sbin[4] /* "/sbin/" */
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100654# if !ENABLE_INSTALL_NO_USR
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200655 ,usr_bin
656 ,usr_sbin
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100657# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400658};
659
Denis Vlasenko724d1962007-10-10 14:41:07 +0000660/* create (sym)links for each applet */
Denys Vlasenko3b405432009-07-15 00:35:34 +0200661static void install_links(const char *busybox, int use_symbolic_links,
662 char *custom_install_dir)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000663{
664 /* directory table
665 * this should be consistent w/ the enum,
666 * busybox.h::bb_install_loc_t, or else... */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000667 int (*lf)(const char *, const char *);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000668 char *fpc;
Denys Vlasenko4c201c02018-07-17 15:04:17 +0200669 const char *appname = applet_names;
Denis Vlasenko6b06cb82008-05-15 21:30:45 +0000670 unsigned i;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000671 int rc;
672
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000673 lf = link;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000674 if (use_symbolic_links)
675 lf = symlink;
676
Denis Vlasenko745cd172007-11-29 03:31:20 +0000677 for (i = 0; i < ARRAY_SIZE(applet_main); i++) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000678 fpc = concat_path_file(
Denys Vlasenko3b405432009-07-15 00:35:34 +0200679 custom_install_dir ? custom_install_dir : install_dir[APPLET_INSTALL_LOC(i)],
Ron Yorston610c4c32016-03-30 00:42:05 +0200680 appname);
Denis Vlasenko745cd172007-11-29 03:31:20 +0000681 // debug: bb_error_msg("%slinking %s to busybox",
682 // use_symbolic_links ? "sym" : "", fpc);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000683 rc = lf(busybox, fpc);
684 if (rc != 0 && errno != EEXIST) {
685 bb_simple_perror_msg(fpc);
686 }
687 free(fpc);
Ron Yorston610c4c32016-03-30 00:42:05 +0200688 while (*appname++ != '\0')
689 continue;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000690 }
691}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200692# elif ENABLE_BUSYBOX
Mike Frysingerf1999b52014-01-31 00:29:47 -0500693static void install_links(const char *busybox UNUSED_PARAM,
694 int use_symbolic_links UNUSED_PARAM,
695 char *custom_install_dir UNUSED_PARAM)
696{
697}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100698# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000699
Denys Vlasenko67e15292020-06-24 13:39:13 +0200700# if ENABLE_BUSYBOX || NUM_APPLETS > 0
Ron Yorston1b0dcc02016-07-05 14:07:50 +0100701static void run_applet_and_exit(const char *name, char **argv) NORETURN;
Denys Vlasenko67e15292020-06-24 13:39:13 +0200702#endif
Ron Yorston1b0dcc02016-07-05 14:07:50 +0100703
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100704# if NUM_SCRIPTS > 0
705static int find_script_by_name(const char *name)
706{
707 int i;
708 int applet = find_applet_by_name(name);
709
710 if (applet >= 0) {
711 for (i = 0; i < NUM_SCRIPTS; ++i)
712 if (applet_numbers[i] == applet)
713 return i;
714 }
715 return -1;
716}
717
Ron Yorston3193cb52019-03-30 07:47:12 +0000718int scripted_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100719int scripted_main(int argc UNUSED_PARAM, char **argv)
720{
721 int script = find_script_by_name(applet_name);
722 if (script >= 0)
Denys Vlasenko67e15292020-06-24 13:39:13 +0200723# if ENABLE_SHELL_ASH
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100724 exit(ash_main(-script - 1, argv));
Denys Vlasenko67e15292020-06-24 13:39:13 +0200725# elif ENABLE_SHELL_HUSH
Ron Yorston71df2d32018-11-27 14:34:25 +0000726 exit(hush_main(-script - 1, argv));
Denys Vlasenko67e15292020-06-24 13:39:13 +0200727# else
Ron Yorston71df2d32018-11-27 14:34:25 +0000728 return 1;
Denys Vlasenko67e15292020-06-24 13:39:13 +0200729# endif
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100730 return 0;
731}
732
733char* FAST_FUNC
734get_script_content(unsigned n)
735{
736 char *t = unpack_bz2_data(packed_scripts, sizeof(packed_scripts),
737 UNPACKED_SCRIPTS_LENGTH);
738 if (t) {
739 while (n != 0) {
740 while (*t++ != '\0')
741 continue;
742 n--;
743 }
744 }
745 return t;
746}
747# endif /* NUM_SCRIPTS > 0 */
748
Denys Vlasenkof128bdb2017-07-29 00:59:24 +0200749# if ENABLE_BUSYBOX
750# if ENABLE_FEATURE_SH_STANDALONE && ENABLE_FEATURE_TAB_COMPLETION
751 /*
752 * Insert "busybox" into applet table as well.
753 * This makes standalone shell tab-complete this name too.
754 * (Otherwise having "busybox" in applet table is not necessary,
755 * there is other code which routes "busyboxANY_SUFFIX" name
756 * to busybox_main()).
757 */
758//usage:#define busybox_trivial_usage NOUSAGE_STR
759//usage:#define busybox_full_usage ""
760//applet:IF_BUSYBOX(IF_FEATURE_SH_STANDALONE(IF_FEATURE_TAB_COMPLETION(APPLET(busybox, BB_DIR_BIN, BB_SUID_MAYBE))))
761int busybox_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
762# else
763# define busybox_main(argc,argv) busybox_main(argv)
764static
765# endif
766int busybox_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000767{
768 if (!argv[1]) {
769 /* Called without arguments */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000770 const char *a;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200771 int col;
772 unsigned output_width;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000773 help:
Denys Vlasenkoa8a075a2017-01-11 10:52:24 +0100774 output_width = get_terminal_width(2);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000775
Denis Vlasenko21278df2008-06-25 12:15:46 +0000776 dup2(1, 2);
Denys Vlasenko630dde12009-08-30 19:57:49 +0200777 full_write2_str(bb_banner); /* reuse const string */
778 full_write2_str(" multi-call binary.\n"); /* reuse */
779 full_write2_str(
Aaro Koskinen7b729ed2015-04-02 00:55:17 +0300780 "BusyBox is copyrighted by many authors between 1998-2015.\n"
Bradley M. Kuhn0e941d52012-07-13 11:38:38 -0400781 "Licensed under GPLv2. See source distribution for detailed\n"
782 "copyright notices.\n"
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400783 "\n"
Denys Vlasenko02b8b9b2012-05-14 23:52:57 +0200784 "Usage: busybox [function [arguments]...]\n"
Denys Vlasenkoba888262012-03-22 11:15:06 +0100785 " or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100786# if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
787 " or: busybox --show SCRIPT\n"
788# endif
Denys Vlasenkoba888262012-03-22 11:15:06 +0100789 IF_FEATURE_INSTALLER(
790 " or: busybox --install [-s] [DIR]\n"
791 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400792 " or: function [arguments]...\n"
793 "\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100794 IF_NOT_FEATURE_SH_STANDALONE(
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400795 "\tBusyBox is a multi-call binary that combines many common Unix\n"
796 "\tutilities into a single executable. Most people will create a\n"
797 "\tlink to busybox for each function they wish to use and BusyBox\n"
798 "\twill act like whatever it was invoked as.\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100799 )
800 IF_FEATURE_SH_STANDALONE(
801 "\tBusyBox is a multi-call binary that combines many common Unix\n"
802 "\tutilities into a single executable. The shell in this build\n"
803 "\tis configured to run built-in utilities without $PATH search.\n"
804 "\tYou don't need to install a link to busybox for each utility.\n"
805 "\tTo run external program, use full path (/sbin/ip instead of ip).\n"
806 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400807 "\n"
808 "Currently defined functions:\n"
809 );
Denis Vlasenko724d1962007-10-10 14:41:07 +0000810 col = 0;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200811 /* prevent last comma to be in the very last pos */
812 output_width--;
Denys Vlasenko0575c992018-11-01 13:58:16 +0100813 a = applet_names;
Ron Yorston37788982018-11-17 17:48:14 +0000814 while (*a) {
815 int len2 = strlen(a) + 2;
816 if (col >= (int)output_width - len2) {
817 full_write2_str(",\n");
818 col = 0;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000819 }
Ron Yorston37788982018-11-17 17:48:14 +0000820 if (col == 0) {
821 col = 6;
822 full_write2_str("\t");
823 } else {
824 full_write2_str(", ");
825 }
826 full_write2_str(a);
827 col += len2;
828 a += len2 - 1;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000829 }
Denys Vlasenko7d877fc2016-11-28 01:29:28 +0100830 full_write2_str("\n");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000831 return 0;
832 }
833
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100834# if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
835 if (strcmp(argv[1], "--show") == 0) {
836 int n;
837 if (!argv[2])
838 bb_error_msg_and_die(bb_msg_requires_arg, "--show");
839 n = find_script_by_name(argv[2]);
840 if (n < 0)
841 bb_error_msg_and_die("script '%s' not found", argv[2]);
842 full_write1_str(get_script_content(n));
843 return 0;
844 }
845# endif
846
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100847 if (is_prefixed_with(argv[1], "--list")) {
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400848 unsigned i = 0;
849 const char *a = applet_names;
850 dup2(1, 2);
851 while (*a) {
Denys Vlasenko8e950682016-05-31 02:42:49 +0200852# if ENABLE_FEATURE_INSTALLER
Denys Vlasenkoba888262012-03-22 11:15:06 +0100853 if (argv[1][6]) /* --list-full? */
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400854 full_write2_str(install_dir[APPLET_INSTALL_LOC(i)] + 1);
Denys Vlasenko8e950682016-05-31 02:42:49 +0200855# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400856 full_write2_str(a);
857 full_write2_str("\n");
858 i++;
Ron Yorston2b919582016-04-08 11:57:20 +0100859 while (*a++ != '\0')
860 continue;
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400861 }
862 return 0;
863 }
864
Denis Vlasenko724d1962007-10-10 14:41:07 +0000865 if (ENABLE_FEATURE_INSTALLER && strcmp(argv[1], "--install") == 0) {
Denys Vlasenko3b405432009-07-15 00:35:34 +0200866 int use_symbolic_links;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000867 const char *busybox;
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100868
Denis Vlasenko724d1962007-10-10 14:41:07 +0000869 busybox = xmalloc_readlink(bb_busybox_exec_path);
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100870 if (!busybox) {
871 /* bb_busybox_exec_path is usually "/proc/self/exe".
872 * In chroot, readlink("/proc/self/exe") usually fails.
873 * In such case, better use argv[0] as symlink target
874 * if it is a full path name.
875 */
Denys Vlasenko5c942712011-03-12 06:08:28 +0100876 if (argv[0][0] != '/')
877 bb_error_msg_and_die("'%s' is not an absolute path", argv[0]);
878 busybox = argv[0];
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100879 }
880 /* busybox --install [-s] [DIR]:
881 * -s: make symlinks
882 * DIR: directory to install links to
883 */
Denys Vlasenkoba888262012-03-22 11:15:06 +0100884 use_symbolic_links = (argv[2] && strcmp(argv[2], "-s") == 0 && ++argv);
Denys Vlasenko3b405432009-07-15 00:35:34 +0200885 install_links(busybox, use_symbolic_links, argv[2]);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000886 return 0;
887 }
888
889 if (strcmp(argv[1], "--help") == 0) {
890 /* "busybox --help [<applet>]" */
891 if (!argv[2])
892 goto help;
893 /* convert to "<applet> --help" */
894 argv[0] = argv[2];
895 argv[2] = NULL;
896 } else {
897 /* "busybox <applet> arg1 arg2 ..." */
898 argv++;
899 }
900 /* We support "busybox /a/path/to/applet args..." too. Allows for
901 * "#!/bin/busybox"-style wrappers */
902 applet_name = bb_get_last_path_component_nostrip(argv[0]);
903 run_applet_and_exit(applet_name, argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000904}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200905# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000906
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200907# if NUM_APPLETS > 0
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200908void FAST_FUNC run_applet_no_and_exit(int applet_no, const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000909{
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200910 int argc = string_array_len(argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000911
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200912 /*
913 * We do not use argv[0]: do not want to repeat massaging of
914 * "-/sbin/halt" -> "halt", for example.
915 */
916 applet_name = name;
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200917
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200918 /* Special case. POSIX says "test --help"
919 * should be no different from e.g. "test --foo".
920 * Thus for "test", we skip --help check.
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200921 * "true" and "false" are also special.
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200922 */
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200923 if (1
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200924# if defined APPLET_NO_test
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200925 && applet_no != APPLET_NO_test
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200926# endif
927# if defined APPLET_NO_true
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200928 && applet_no != APPLET_NO_true
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200929# endif
930# if defined APPLET_NO_false
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200931 && applet_no != APPLET_NO_false
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200932# endif
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200933 ) {
934 if (argc == 2 && strcmp(argv[1], "--help") == 0) {
935 /* Make "foo --help" exit with 0: */
936 xfunc_error_retval = 0;
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000937 bb_show_usage();
Denys Vlasenko5d783552013-01-17 11:02:21 +0100938 }
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000939 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000940 if (ENABLE_FEATURE_SUID)
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000941 check_suid(applet_no);
Denys Vlasenko215b0ca2016-08-19 18:23:56 +0200942 xfunc_error_retval = applet_main[applet_no](argc, argv);
943 /* Note: applet_main() may also not return (die on a xfunc or such) */
944 xfunc_die();
Denis Vlasenko724d1962007-10-10 14:41:07 +0000945}
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200946# endif /* NUM_APPLETS > 0 */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000947
Ron Yorston37788982018-11-17 17:48:14 +0000948# if ENABLE_BUSYBOX || NUM_APPLETS > 0
Ron Yorstonce824ae2016-06-07 12:12:07 +0100949static NORETURN void run_applet_and_exit(const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000950{
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100951# if ENABLE_BUSYBOX
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100952 if (is_prefixed_with(name, "busybox"))
Denys Vlasenkof128bdb2017-07-29 00:59:24 +0200953 exit(busybox_main(/*unused:*/ 0, argv));
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100954# endif
955# if NUM_APPLETS > 0
Ron Yorston610c4c32016-03-30 00:42:05 +0200956 /* find_applet_by_name() search is more expensive, so goes second */
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200957 {
958 int applet = find_applet_by_name(name);
959 if (applet >= 0)
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200960 run_applet_no_and_exit(applet, name, argv);
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200961 }
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100962# endif
Ron Yorstonce824ae2016-06-07 12:12:07 +0100963
964 /*bb_error_msg_and_die("applet not found"); - links in printf */
965 full_write2_str(applet_name);
966 full_write2_str(": applet not found\n");
967 /* POSIX: "If a command is not found, the exit status shall be 127" */
968 exit(127);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000969}
Denys Vlasenko7e8218f2016-11-18 21:42:44 +0100970# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000971
Denys Vlasenko67e15292020-06-24 13:39:13 +0200972#else /* defined(SINGLE_APPLET_MAIN) */
973
974# if NUM_SCRIPTS > 0
975/* if SINGLE_APPLET_MAIN, these two functions are simpler: */
976int scripted_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
977int scripted_main(int argc UNUSED_PARAM, char **argv)
978{
979# if ENABLE_SHELL_ASH
980 int script = 0;
981 exit(ash_main(-script - 1, argv));
982# elif ENABLE_SHELL_HUSH
983 int script = 0;
984 exit(hush_main(-script - 1, argv));
985# else
986 return 1;
987# endif
988}
989char* FAST_FUNC
990get_script_content(unsigned n UNUSED_PARAM)
991{
992 char *t = unpack_bz2_data(packed_scripts, sizeof(packed_scripts),
993 UNPACKED_SCRIPTS_LENGTH);
994 return t;
995}
996# endif /* NUM_SCRIPTS > 0 */
997
998#endif /* defined(SINGLE_APPLET_MAIN) */
Denis Vlasenko468aea22008-04-01 14:47:57 +0000999
1000
Denis Vlasenko724d1962007-10-10 14:41:07 +00001001#if ENABLE_BUILD_LIBBUSYBOX
Denis Vlasenko85c24712008-03-17 09:04:04 +00001002int lbb_main(char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001003#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001004int main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001005#endif
1006{
Denys Vlasenkobc14f4d2016-04-03 16:06:42 +02001007#if 0
1008 /* TODO: find a use for a block of memory between end of .bss
1009 * and end of page. For example, I'm getting "_end:0x812e698 2408 bytes"
1010 * - more than 2k of wasted memory (in this particular build)
1011 * *per each running process*!
1012 * (If your linker does not generate "_end" name, weak attribute
1013 * makes &_end == NULL, end_len == 0 here.)
1014 */
1015 extern char _end[] __attribute__((weak));
1016 unsigned end_len = (-(int)_end) & 0xfff;
1017 printf("_end:%p %u bytes\n", &_end, end_len);
1018#endif
1019
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001020 /* Tweak malloc for reduced memory consumption */
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001021#ifdef M_TRIM_THRESHOLD
1022 /* M_TRIM_THRESHOLD is the maximum amount of freed top-most memory
1023 * to keep before releasing to the OS
1024 * Default is way too big: 256k
1025 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001026 mallopt(M_TRIM_THRESHOLD, 8 * 1024);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001027#endif
1028#ifdef M_MMAP_THRESHOLD
1029 /* M_MMAP_THRESHOLD is the request size threshold for using mmap()
1030 * Default is too big: 256k
1031 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001032 mallopt(M_MMAP_THRESHOLD, 32 * 1024 - 256);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001033#endif
Denys Vlasenko7f0ebbc2016-10-03 17:42:53 +02001034#if 0 /*def M_TOP_PAD*/
1035 /* When the program break is increased, then M_TOP_PAD bytes are added
1036 * to the sbrk(2) request. When the heap is trimmed because of free(3),
1037 * this much free space is preserved at the top of the heap.
1038 * glibc default seems to be way too big: 128k, but need to verify.
1039 */
1040 mallopt(M_TOP_PAD, 8 * 1024);
1041#endif
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001042
Denis Vlasenko724d1962007-10-10 14:41:07 +00001043#if !BB_MMU
1044 /* NOMMU re-exec trick sets high-order bit in first byte of name */
1045 if (argv[0][0] & 0x80) {
1046 re_execed = 1;
1047 argv[0][0] &= 0x7f;
1048 }
1049#endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001050
1051#if defined(SINGLE_APPLET_MAIN)
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001052
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001053 /* Only one applet is selected in .config */
Denys Vlasenko8dff01d2015-03-12 17:48:34 +01001054 if (argv[1] && is_prefixed_with(argv[0], "busybox")) {
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001055 /* "busybox <applet> <params>" should still work as expected */
1056 argv++;
1057 }
1058 /* applet_names in this case is just "applet\0\0" */
1059 lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001060# if ENABLE_BUILD_LIBBUSYBOX
1061 return SINGLE_APPLET_MAIN(string_array_len(argv), argv);
1062# else
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001063 return SINGLE_APPLET_MAIN(argc, argv);
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001064# endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001065
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001066#elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
1067
1068 full_write2_str(bb_basename(argv[0]));
1069 full_write2_str(": no applets enabled\n");
1070 exit(127);
1071
1072#else
1073
1074 lbb_prepare("busybox" IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001075# if !ENABLE_BUSYBOX
Ron Yorstonba120812016-06-07 10:26:24 +01001076 if (argv[1] && is_prefixed_with(bb_basename(argv[0]), "busybox"))
1077 argv++;
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001078# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001079 applet_name = argv[0];
1080 if (applet_name[0] == '-')
1081 applet_name++;
1082 applet_name = bb_basename(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001083
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001084 /* If we are a result of execv("/proc/self/exe"), fix ugly comm of "exe" */
1085 if (ENABLE_FEATURE_SH_STANDALONE
1086 || ENABLE_FEATURE_PREFER_APPLETS
1087 || !BB_MMU
1088 ) {
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001089 if (NUM_APPLETS > 1)
1090 set_task_comm(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001091 }
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001092
Denis Vlasenko724d1962007-10-10 14:41:07 +00001093 parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +00001094 run_applet_and_exit(applet_name, argv);
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001095
Denis Vlasenko468aea22008-04-01 14:47:57 +00001096#endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001097}