blob: 9fa17cfa1b2c2314870807760c5ab2ebb423616e [file] [log] [blame]
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +00001/* vi: set sw=4 ts=4: */
2/*
Denis Vlasenko724d1962007-10-10 14:41:07 +00003 * Utility routines.
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +00004 *
Denis Vlasenko724d1962007-10-10 14:41:07 +00005 * Copyright (C) tons of folks. Tracking down who wrote what
6 * isn't something I'm going to worry about... If you wrote something
7 * here, please feel free to acknowledge your work.
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +00008 *
Denis Vlasenko724d1962007-10-10 14:41:07 +00009 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +020010 * Permission has been granted to redistribute this code under GPL.
Denis Vlasenko724d1962007-10-10 14:41:07 +000011 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +020012 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000013 */
Denis Vlasenko79cedcb2008-04-08 21:13:28 +000014/* We are trying to not use printf, this benefits the case when selected
15 * applets are really simple. Example:
16 *
17 * $ ./busybox
18 * ...
19 * Currently defined functions:
20 * basename, false, true
21 *
22 * $ size busybox
23 * text data bss dec hex filename
24 * 4473 52 72 4597 11f5 busybox
25 *
26 * FEATURE_INSTALLER or FEATURE_SUID will still link printf routines in. :(
27 */
Denys Vlasenkoc1947f12009-10-23 01:30:26 +020028#include "busybox.h"
Denys Vlasenko9be47022011-05-16 12:21:31 +020029
Denys Vlasenko8da415e2010-12-05 01:30:14 +010030#if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
Denys Vlasenko982e87f2013-07-30 11:52:58 +020031 || defined(__APPLE__) \
Denys Vlasenko8da415e2010-12-05 01:30:14 +010032 )
33# include <malloc.h> /* for mallopt */
34#endif
Denys Vlasenko9be47022011-05-16 12:21:31 +020035
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000036/* Declare <applet>_main() */
37#define PROTOTYPES
38#include "applets.h"
39#undef PROTOTYPES
40
Denis Vlasenko32b2a9f2008-02-22 22:43:22 +000041/* Include generated applet names, pointers to <applet>_main, etc */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +000042#include "applet_tables.h"
Denis Vlasenko468aea22008-04-01 14:47:57 +000043/* ...and if applet_tables generator says we have only one applet... */
44#ifdef SINGLE_APPLET_MAIN
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020045# undef ENABLE_FEATURE_INDIVIDUAL
46# define ENABLE_FEATURE_INDIVIDUAL 1
47# undef IF_FEATURE_INDIVIDUAL
48# define IF_FEATURE_INDIVIDUAL(...) __VA_ARGS__
Denis Vlasenko468aea22008-04-01 14:47:57 +000049#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +000050
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020051#include "usage_compressed.h"
52
Ron Yorston71df2d32018-11-27 14:34:25 +000053#if ENABLE_FEATURE_SH_EMBEDDED_SCRIPTS
Ron Yorston37788982018-11-17 17:48:14 +000054# define DEFINE_SCRIPT_DATA 1
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +010055# include "embedded_scripts.h"
56#else
57# define NUM_SCRIPTS 0
58#endif
59#if NUM_SCRIPTS > 0
60# include "bb_archive.h"
61static const char packed_scripts[] ALIGN1 = { PACKED_SCRIPTS };
62#endif
Denys Vlasenkofe936242017-01-06 19:16:36 +010063
64/* "Do not compress usage text if uncompressed text is small
65 * and we don't include bunzip2 code for other reasons"
66 *
67 * Useful for mass one-applet rebuild (bunzip2 code is ~2.7k).
68 *
69 * Unlike BUNZIP2, if FEATURE_SEAMLESS_BZ2 is on, bunzip2 code is built but
70 * still may be unused if none of the selected applets calls open_zipped()
71 * or its friends; we test for (FEATURE_SEAMLESS_BZ2 && <APPLET>) instead.
72 * For example, only if TAR and FEATURE_SEAMLESS_BZ2 are both selected,
73 * then bunzip2 code will be linked in anyway, and disabling help compression
74 * would be not optimal:
75 */
76#if UNPACKED_USAGE_LENGTH < 4*1024 \
77 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_TAR) \
78 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MODPROBE) \
79 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_INSMOD) \
80 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_DEPMOD) \
81 && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MAN) \
82 && !ENABLE_BUNZIP2 \
83 && !ENABLE_BZCAT
84# undef ENABLE_FEATURE_COMPRESS_USAGE
85# define ENABLE_FEATURE_COMPRESS_USAGE 0
86#endif
87
88
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +020089unsigned FAST_FUNC string_array_len(char **argv)
90{
91 char **start = argv;
92
93 while (*argv)
94 argv++;
95
96 return argv - start;
97}
98
99
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200100#if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
101static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
102#else
103# define usage_messages 0
Denys Vlasenko1fcbff22010-06-26 02:40:08 +0200104#endif
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200105
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000106#if ENABLE_FEATURE_COMPRESS_USAGE
107
Denys Vlasenko5c296de2010-07-03 14:28:35 +0200108static const char packed_usage[] ALIGN1 = { PACKED_USAGE };
Denys Vlasenkod184a722011-09-22 12:45:14 +0200109# include "bb_archive.h"
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100110# define unpack_usage_messages() \
111 unpack_bz2_data(packed_usage, sizeof(packed_usage), sizeof(UNPACKED_USAGE))
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200112# define dealloc_usage_messages(s) free(s)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000113
114#else
115
Denys Vlasenko0e5ba082010-06-05 23:11:07 +0200116# define unpack_usage_messages() usage_messages
117# define dealloc_usage_messages(s) ((void)(s))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000118
119#endif /* FEATURE_COMPRESS_USAGE */
120
121
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000122void FAST_FUNC bb_show_usage(void)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000123{
124 if (ENABLE_SHOW_USAGE) {
Denis Vlasenko468aea22008-04-01 14:47:57 +0000125#ifdef SINGLE_APPLET_STR
Denys Vlasenkoff653552019-01-01 16:54:30 +0100126 /* Imagine that this applet is "true". Dont link in printf! */
Lauri Kasanen2b662c52010-11-13 23:16:05 +0100127 const char *usage_string = unpack_usage_messages();
Denis Vlasenko468aea22008-04-01 14:47:57 +0000128
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100129 if (usage_string) {
130 if (*usage_string == '\b') {
Denys Vlasenkoff653552019-01-01 16:54:30 +0100131 full_write2_str("No help available\n");
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100132 } else {
133 full_write2_str("Usage: "SINGLE_APPLET_STR" ");
134 full_write2_str(usage_string);
Denys Vlasenkoff653552019-01-01 16:54:30 +0100135 full_write2_str("\n");
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100136 }
137 if (ENABLE_FEATURE_CLEAN_UP)
138 dealloc_usage_messages((char*)usage_string);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000139 }
Denis Vlasenko468aea22008-04-01 14:47:57 +0000140#else
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000141 const char *p;
142 const char *usage_string = p = unpack_usage_messages();
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000143 int ap = find_applet_by_name(applet_name);
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000144
Ron Yorstonc339c7f2018-11-02 14:14:31 +0100145 if (ap < 0 || usage_string == NULL)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000146 xfunc_die();
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000147 while (ap) {
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000148 while (*p++) continue;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000149 ap--;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000150 }
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000151 full_write2_str(bb_banner);
Denys Vlasenkoff653552019-01-01 16:54:30 +0100152 full_write2_str(" multi-call binary.\n"); /* common string */
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000153 if (*p == '\b')
Denys Vlasenkoff653552019-01-01 16:54:30 +0100154 full_write2_str("\nNo help available\n");
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000155 else {
156 full_write2_str("\nUsage: ");
157 full_write2_str(applet_name);
Denys Vlasenko253f5552018-07-09 18:23:33 +0200158 if (p[0]) {
159 if (p[0] != '\n')
160 full_write2_str(" ");
161 full_write2_str(p);
162 }
Denys Vlasenko7f4a49a2015-05-25 14:30:52 +0200163 full_write2_str("\n");
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000164 }
Denys Vlasenko630dde12009-08-30 19:57:49 +0200165 if (ENABLE_FEATURE_CLEAN_UP)
166 dealloc_usage_messages((char*)usage_string);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000167#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000168 }
169 xfunc_die();
170}
171
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000172int FAST_FUNC find_applet_by_name(const char *name)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000173{
Ron Yorstonb2206172016-04-03 22:29:35 +0200174 unsigned i, max;
175 int j;
Denis Vlasenko745cd172007-11-29 03:31:20 +0000176 const char *p;
Ron Yorston610c4c32016-03-30 00:42:05 +0200177
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200178/* The commented-out word-at-a-time code is ~40% faster, but +160 bytes.
179 * "Faster" here saves ~0.5 microsecond of real time - not worth it.
180 */
181#if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
182 uint32_t n32;
183
184 /* Handle all names < 2 chars long early */
185 if (name[0] == '\0')
186 return -1; /* "" is not a valid applet name */
187 if (name[1] == '\0') {
188 if (!ENABLE_TEST)
189 return -1; /* 1-char name is not valid */
190 if (name[0] != ']')
191 return -1; /* 1-char name which isn't "[" is not valid */
192 /* applet "[" is always applet #0: */
193 return 0;
194 }
195#endif
196
Ron Yorston610c4c32016-03-30 00:42:05 +0200197 p = applet_names;
198 i = 0;
199#if KNOWN_APPNAME_OFFSETS <= 0
200 max = NUM_APPLETS;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000201#else
Ron Yorston610c4c32016-03-30 00:42:05 +0200202 max = NUM_APPLETS * KNOWN_APPNAME_OFFSETS;
203 for (j = ARRAY_SIZE(applet_nameofs)-1; j >= 0; j--) {
204 const char *pp = applet_names + applet_nameofs[j];
205 if (strcmp(name, pp) >= 0) {
206 //bb_error_msg("name:'%s' >= pp:'%s'", name, pp);
207 p = pp;
208 i = max - NUM_APPLETS;
209 break;
210 }
211 max -= NUM_APPLETS;
212 }
213 max /= (unsigned)KNOWN_APPNAME_OFFSETS;
214 i /= (unsigned)KNOWN_APPNAME_OFFSETS;
215 //bb_error_msg("name:'%s' starting from:'%s' i:%u max:%u", name, p, i, max);
216#endif
217
Denys Vlasenko1cf68e32016-04-02 22:57:17 +0200218 /* Open-coded linear search without strcmp/strlen calls for speed */
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200219
220#if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
221 /* skip "[\0" name, it's surely not it */
222 if (ENABLE_TEST && LONE_CHAR(p, '['))
223 i++, p += 2;
224 /* All remaining applet names in p[] are at least 2 chars long */
225 /* name[] is also at least 2 chars long */
226
227 n32 = (name[0] << 0) | (name[1] << 8) | (name[2] << 16);
228 while (i < max) {
229 uint32_t p32;
230 char ch;
231
232 /* Quickly check match of the first 3 bytes */
233 move_from_unaligned32(p32, p);
234 p += 3;
235 if ((p32 & 0x00ffffff) != n32) {
236 /* Most likely case: 3 first bytes do not match */
237 i++;
238 if ((p32 & 0x00ff0000) == '\0')
239 continue; // p[2] was NUL
240 p++;
241 if ((p32 & 0xff000000) == '\0')
242 continue; // p[3] was NUL
243 /* p[0..3] aren't matching and none is NUL, check the rest */
244 while (*p++ != '\0')
245 continue;
246 continue;
247 }
248
249 /* Unlikely branch: first 3 bytes ([0..2]) match */
250 if ((p32 & 0x00ff0000) == '\0') {
251 /* name is 2-byte long, it is full match */
252 //bb_error_msg("found:'%s' i:%u", name, i);
253 return i;
254 }
255 /* Check remaining bytes [3..NUL] */
256 ch = (p32 >> 24);
257 j = 3;
258 while (ch == name[j]) {
259 if (ch == '\0') {
260 //bb_error_msg("found:'%s' i:%u", name, i);
261 return i;
262 }
263 ch = *++p;
264 j++;
265 }
266 /* Not a match. Skip it, including NUL */
267 while (ch != '\0')
268 ch = *++p;
269 p++;
270 i++;
271 }
272 return -1;
273#else
Ron Yorston610c4c32016-03-30 00:42:05 +0200274 while (i < max) {
275 char ch;
276 j = 0;
277 /* Do we see "name\0" in applet_names[p] position? */
278 while ((ch = *p) == name[j]) {
279 if (ch == '\0') {
280 //bb_error_msg("found:'%s' i:%u", name, i);
281 return i; /* yes */
282 }
283 p++;
284 j++;
285 }
286 /* No.
287 * p => 1st non-matching char in applet_names[],
288 * skip to and including NUL.
289 */
290 while (ch != '\0')
291 ch = *++p;
292 p++;
Denis Vlasenko79cedcb2008-04-08 21:13:28 +0000293 i++;
294 }
295 return -1;
Denys Vlasenkoa93e4fd2016-04-02 22:54:23 +0200296#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000297}
298
299
Denis Vlasenko68404f12008-03-17 09:00:54 +0000300void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000301 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenko468aea22008-04-01 14:47:57 +0000302 MAIN_EXTERNALLY_VISIBLE;
303void lbb_prepare(const char *applet
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000304 IF_FEATURE_INDIVIDUAL(, char **argv))
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000305{
306#ifdef __GLIBC__
307 (*(int **)&bb_errno) = __errno_location();
Denis Vlasenko574f2f42008-02-27 18:41:59 +0000308 barrier();
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000309#endif
Denis Vlasenko15cb4a42007-10-11 10:06:26 +0000310 applet_name = applet;
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000311
Denys Vlasenko45b4ecc2014-08-11 20:33:18 +0200312 if (ENABLE_LOCALE_SUPPORT)
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000313 setlocale(LC_ALL, "");
314
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000315#if ENABLE_FEATURE_INDIVIDUAL
316 /* Redundant for busybox (run_applet_and_exit covers that case)
317 * but needed for "individual applet" mode */
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200318 if (argv[1]
319 && !argv[2]
320 && strcmp(argv[1], "--help") == 0
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100321 && !is_prefixed_with(applet, "busybox")
Denys Vlasenko9297dbc2010-07-05 21:37:12 +0200322 ) {
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000323 /* Special case. POSIX says "test --help"
324 * should be no different from e.g. "test --foo". */
325 if (!ENABLE_TEST || strcmp(applet_name, "test") != 0)
326 bb_show_usage();
327 }
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000328#endif
Denis Vlasenkoac7d0e32007-10-08 19:32:12 +0000329}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000330
331/* The code below can well be in applets/applets.c, as it is used only
332 * for busybox binary, not "individual" binaries.
333 * However, keeping it here and linking it into libbusybox.so
334 * (together with remaining tiny applets/applets.o)
335 * makes it possible to avoid --whole-archive at link time.
336 * This makes (shared busybox) + libbusybox smaller.
337 * (--gc-sections would be even better....)
338 */
339
340const char *applet_name;
341#if !BB_MMU
342bool re_execed;
343#endif
344
Denis Vlasenko468aea22008-04-01 14:47:57 +0000345
Denis Vlasenko10f6fb12008-04-29 00:10:27 +0000346/* If not built as a single-applet executable... */
347#if !defined(SINGLE_APPLET_MAIN)
Denis Vlasenko468aea22008-04-01 14:47:57 +0000348
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000349IF_FEATURE_SUID(static uid_t ruid;) /* real uid */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000350
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100351# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000352
Denys Vlasenko9be47022011-05-16 12:21:31 +0200353static struct suid_config_t {
354 /* next ptr must be first: this struct needs to be llist-compatible */
355 struct suid_config_t *m_next;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200356 struct bb_uidgid_t m_ugid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200357 int m_applet;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000358 mode_t m_mode;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000359} *suid_config;
360
361static bool suid_cfg_readable;
362
Denys Vlasenkod83aff12011-05-16 13:53:19 +0200363/* libbb candidate */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000364static char *get_trimmed_slice(char *s, char *e)
365{
366 /* First, consider the value at e to be nul and back up until we
367 * reach a non-space char. Set the char after that (possibly at
368 * the original e) to nul. */
369 while (e-- > s) {
370 if (!isspace(*e)) {
371 break;
372 }
373 }
374 e[1] = '\0';
375
376 /* Next, advance past all leading space and return a ptr to the
377 * first non-space char; possibly the terminating nul. */
378 return skip_whitespace(s);
379}
380
Denis Vlasenko724d1962007-10-10 14:41:07 +0000381static void parse_config_file(void)
382{
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200383 /* Don't depend on the tools to combine strings. */
384 static const char config_file[] ALIGN1 = "/etc/busybox.conf";
385
Denys Vlasenko9be47022011-05-16 12:21:31 +0200386 struct suid_config_t *sct_head;
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000387 int applet_no;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000388 FILE *f;
389 const char *errmsg;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000390 unsigned lc;
391 smallint section;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000392 struct stat st;
393
Denis Vlasenko724d1962007-10-10 14:41:07 +0000394 ruid = getuid();
395 if (ruid == 0) /* run by root - don't need to even read config file */
396 return;
397
398 if ((stat(config_file, &st) != 0) /* No config file? */
399 || !S_ISREG(st.st_mode) /* Not a regular file? */
400 || (st.st_uid != 0) /* Not owned by root? */
401 || (st.st_mode & (S_IWGRP | S_IWOTH)) /* Writable by non-root? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200402 || !(f = fopen_for_read(config_file)) /* Cannot open? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000403 ) {
404 return;
405 }
406
407 suid_cfg_readable = 1;
408 sct_head = NULL;
409 section = lc = 0;
410
411 while (1) {
Denys Vlasenko9be47022011-05-16 12:21:31 +0200412 char buffer[256];
413 char *s;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000414
Denys Vlasenko9be47022011-05-16 12:21:31 +0200415 if (!fgets(buffer, sizeof(buffer), f)) { /* Are we done? */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200416 // Looks like bloat
417 //if (ferror(f)) { /* Make sure it wasn't a read error. */
418 // errmsg = "reading";
419 // goto pe_label;
420 //}
Denis Vlasenko724d1962007-10-10 14:41:07 +0000421 fclose(f);
422 suid_config = sct_head; /* Success, so set the pointer. */
423 return;
424 }
425
Denys Vlasenko9be47022011-05-16 12:21:31 +0200426 s = buffer;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000427 lc++; /* Got a (partial) line. */
428
429 /* If a line is too long for our buffer, we consider it an error.
430 * The following test does mistreat one corner case though.
431 * If the final line of the file does not end with a newline and
432 * yet exactly fills the buffer, it will be treated as too long
433 * even though there isn't really a problem. But it isn't really
434 * worth adding code to deal with such an unlikely situation, and
435 * we do err on the side of caution. Besides, the line would be
436 * too long if it did end with a newline. */
437 if (!strchr(s, '\n') && !feof(f)) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200438 errmsg = "line too long";
439 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000440 }
441
442 /* Trim leading and trailing whitespace, ignoring comments, and
443 * check if the resulting string is empty. */
444 s = get_trimmed_slice(s, strchrnul(s, '#'));
445 if (!*s) {
446 continue;
447 }
448
449 /* Check for a section header. */
450
451 if (*s == '[') {
452 /* Unlike the old code, we ignore leading and trailing
453 * whitespace for the section name. We also require that
454 * there are no stray characters after the closing bracket. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200455 char *e = strchr(s, ']');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000456 if (!e /* Missing right bracket? */
457 || e[1] /* Trailing characters? */
458 || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
459 ) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200460 errmsg = "section header";
461 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000462 }
463 /* Right now we only have one section so just check it.
464 * If more sections are added in the future, please don't
465 * resort to cascading ifs with multiple strcasecmp calls.
466 * That kind of bloated code is all too common. A loop
467 * and a string table would be a better choice unless the
468 * number of sections is very small. */
469 if (strcasecmp(s, "SUID") == 0) {
470 section = 1;
471 continue;
472 }
473 section = -1; /* Unknown section so set to skip. */
474 continue;
475 }
476
477 /* Process sections. */
478
479 if (section == 1) { /* SUID */
480 /* Since we trimmed leading and trailing space above, we're
481 * now looking for strings of the form
482 * <key>[::space::]*=[::space::]*<value>
483 * where both key and value could contain inner whitespace. */
484
485 /* First get the key (an applet name in our case). */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200486 char *e = strchr(s, '=');
Denis Vlasenko724d1962007-10-10 14:41:07 +0000487 if (e) {
488 s = get_trimmed_slice(s, e);
489 }
490 if (!e || !*s) { /* Missing '=' or empty key. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200491 errmsg = "keyword";
492 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000493 }
494
495 /* Ok, we have an applet name. Process the rhs if this
496 * applet is currently built in and ignore it otherwise.
497 * Note: this can hide config file bugs which only pop
498 * up when the busybox configuration is changed. */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000499 applet_no = find_applet_by_name(s);
500 if (applet_no >= 0) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200501 unsigned i;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200502 struct suid_config_t *sct;
503
Denis Vlasenko724d1962007-10-10 14:41:07 +0000504 /* Note: We currently don't check for duplicates!
505 * The last config line for each applet will be the
506 * one used since we insert at the head of the list.
507 * I suppose this could be considered a feature. */
Denys Vlasenko4566e172011-05-16 00:01:08 +0200508 sct = xzalloc(sizeof(*sct));
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000509 sct->m_applet = applet_no;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200510 /*sct->m_mode = 0;*/
Denis Vlasenko724d1962007-10-10 14:41:07 +0000511 sct->m_next = sct_head;
512 sct_head = sct;
513
514 /* Get the specified mode. */
515
516 e = skip_whitespace(e+1);
517
518 for (i = 0; i < 3; i++) {
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200519 /* There are 4 chars for each of user/group/other.
520 * "x-xx" instead of "x-" are to make
521 * "idx > 3" check catch invalid chars.
522 */
523 static const char mode_chars[] ALIGN1 = "Ssx-" "Ssx-" "x-xx";
524 static const unsigned short mode_mask[] ALIGN2 = {
525 S_ISUID, S_ISUID|S_IXUSR, S_IXUSR, 0, /* Ssx- */
526 S_ISGID, S_ISGID|S_IXGRP, S_IXGRP, 0, /* Ssx- */
527 S_IXOTH, 0 /* x- */
528 };
529 const char *q = strchrnul(mode_chars + 4*i, *e);
530 unsigned idx = q - (mode_chars + 4*i);
531 if (idx > 3) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200532 errmsg = "mode";
533 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000534 }
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200535 sct->m_mode |= mode_mask[q - mode_chars];
536 e++;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000537 }
538
Marek Polacekb0b88842011-04-16 17:33:43 +0200539 /* Now get the user/group info. */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000540
541 s = skip_whitespace(e);
Denys Vlasenko351fec32011-05-16 14:30:26 +0200542 /* Default is 0.0, else parse USER.GROUP: */
543 if (*s) {
544 /* We require whitespace between mode and USER.GROUP */
545 if ((s == e) || !(e = strchr(s, '.'))) {
546 errmsg = "uid.gid";
547 goto pe_label;
548 }
549 *e = ':'; /* get_uidgid needs USER:GROUP syntax */
Denys Vlasenko526d8582015-10-19 04:27:17 +0200550 if (get_uidgid(&sct->m_ugid, s) == 0) {
Denys Vlasenko351fec32011-05-16 14:30:26 +0200551 errmsg = "unknown user/group";
552 goto pe_label;
553 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000554 }
555 }
556 continue;
557 }
558
559 /* Unknown sections are ignored. */
560
561 /* Encountering configuration lines prior to seeing a
562 * section header is treated as an error. This is how
563 * the old code worked, but it may not be desirable.
564 * We may want to simply ignore such lines in case they
565 * are used in some future version of busybox. */
566 if (!section) {
Denys Vlasenko4566e172011-05-16 00:01:08 +0200567 errmsg = "keyword outside section";
568 goto pe_label;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000569 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000570 } /* while (1) */
571
572 pe_label:
Denys Vlasenko9be47022011-05-16 12:21:31 +0200573 fclose(f);
Denys Vlasenko4566e172011-05-16 00:01:08 +0200574 bb_error_msg("parse error in %s, line %u: %s", config_file, lc, errmsg);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000575
Denis Vlasenko724d1962007-10-10 14:41:07 +0000576 /* Release any allocated memory before returning. */
Denys Vlasenko9be47022011-05-16 12:21:31 +0200577 llist_free((llist_t*)sct_head, NULL);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000578}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100579# else
Denis Vlasenko724d1962007-10-10 14:41:07 +0000580static inline void parse_config_file(void)
581{
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000582 IF_FEATURE_SUID(ruid = getuid();)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000583}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100584# endif /* FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000585
586
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100587# if ENABLE_FEATURE_SUID && NUM_APPLETS > 0
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100588# if ENABLE_FEATURE_SUID_CONFIG
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100589/* check if u is member of group g */
590static int ingroup(uid_t u, gid_t g)
591{
592 struct group *grp = getgrgid(g);
593 if (grp) {
594 char **mem;
595 for (mem = grp->gr_mem; *mem; mem++) {
596 struct passwd *pwd = getpwnam(*mem);
597 if (pwd && (pwd->pw_uid == u))
598 return 1;
599 }
600 }
601 return 0;
602}
Cristian Ionescu-Idbohrnf1d76b62017-01-02 11:17:09 +0100603# endif
Denys Vlasenko9cc3d3a2016-12-23 02:42:26 +0100604
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000605static void check_suid(int applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000606{
607 gid_t rgid; /* real gid */
608
609 if (ruid == 0) /* set by parse_config_file() */
610 return; /* run by root - no need to check more */
611 rgid = getgid();
612
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100613# if ENABLE_FEATURE_SUID_CONFIG
Denis Vlasenko724d1962007-10-10 14:41:07 +0000614 if (suid_cfg_readable) {
615 uid_t uid;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200616 struct suid_config_t *sct;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000617 mode_t m;
618
619 for (sct = suid_config; sct; sct = sct->m_next) {
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000620 if (sct->m_applet == applet_no)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000621 goto found;
622 }
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000623 goto check_need_suid;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000624 found:
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200625 /* Is this user allowed to run this applet? */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000626 m = sct->m_mode;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200627 if (sct->m_ugid.uid == ruid)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000628 /* same uid */
629 m >>= 6;
Denys Vlasenko4566e172011-05-16 00:01:08 +0200630 else if ((sct->m_ugid.gid == rgid) || ingroup(ruid, sct->m_ugid.gid))
Denis Vlasenko724d1962007-10-10 14:41:07 +0000631 /* same group / in group */
632 m >>= 3;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200633 if (!(m & S_IXOTH)) /* is x bit not set? */
James Byrne69374872019-07-02 11:35:03 +0200634 bb_simple_error_msg_and_die("you have no permission to run this applet");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000635
Denis Vlasenko724d1962007-10-10 14:41:07 +0000636 /* We set effective AND saved ids. If saved-id is not set
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200637 * like we do below, seteuid(0) can still later succeed! */
638
639 /* Are we directed to change gid
640 * (APPLET = *s* USER.GROUP or APPLET = *S* USER.GROUP)?
641 */
642 if (sct->m_mode & S_ISGID)
643 rgid = sct->m_ugid.gid;
644 /* else: we will set egid = rgid, thus dropping sgid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000645 if (setresgid(-1, rgid, rgid))
James Byrne69374872019-07-02 11:35:03 +0200646 bb_simple_perror_msg_and_die("setresgid");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000647
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200648 /* Are we directed to change uid
649 * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
650 */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000651 uid = ruid;
652 if (sct->m_mode & S_ISUID)
Denys Vlasenko4566e172011-05-16 00:01:08 +0200653 uid = sct->m_ugid.uid;
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200654 /* else: we will set euid = ruid, thus dropping suid effect */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000655 if (setresuid(-1, uid, uid))
James Byrne69374872019-07-02 11:35:03 +0200656 bb_simple_perror_msg_and_die("setresuid");
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200657
Denys Vlasenko9be47022011-05-16 12:21:31 +0200658 goto ret;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000659 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100660# if !ENABLE_FEATURE_SUID_CONFIG_QUIET
Denis Vlasenko724d1962007-10-10 14:41:07 +0000661 {
662 static bool onetime = 0;
663
664 if (!onetime) {
665 onetime = 1;
James Byrne69374872019-07-02 11:35:03 +0200666 bb_simple_error_msg("using fallback suid method");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000667 }
668 }
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100669# endif
Denis Vlasenko15ca51e2007-10-29 19:25:45 +0000670 check_need_suid:
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100671# endif
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100672 if (APPLET_SUID(applet_no) == BB_SUID_REQUIRE) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000673 /* Real uid is not 0. If euid isn't 0 too, suid bit
674 * is most probably not set on our executable */
675 if (geteuid())
James Byrne69374872019-07-02 11:35:03 +0200676 bb_simple_error_msg_and_die("must be suid to work properly");
Denys Vlasenkob9f2d9f2011-01-18 13:58:01 +0100677 } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
Denys Vlasenko12a4f9a2017-07-10 09:17:43 +0200678 /*
679 * Drop all privileges.
680 *
681 * Don't check for errors: in normal use, they are impossible,
682 * and in special cases, exiting is harmful. Example:
683 * 'unshare --user' when user's shell is also from busybox.
684 *
685 * 'unshare --user' creates a new user namespace without any
686 * uid mappings. Thus, busybox binary is setuid nobody:nogroup
687 * within the namespace, as that is the only user. However,
688 * since no uids are mapped, calls to setgid/setuid
689 * fail (even though they would do nothing).
690 */
691 setgid(rgid);
692 setuid(ruid);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000693 }
Denys Vlasenko9be47022011-05-16 12:21:31 +0200694# if ENABLE_FEATURE_SUID_CONFIG
Cristian Ionescu-Idbohrnea137aa2011-05-20 03:52:36 +0200695 ret: ;
Denys Vlasenko9be47022011-05-16 12:21:31 +0200696 llist_free((llist_t*)suid_config, NULL);
697# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000698}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100699# else
700# define check_suid(x) ((void)0)
701# endif /* FEATURE_SUID */
Denis Vlasenko724d1962007-10-10 14:41:07 +0000702
703
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100704# if ENABLE_FEATURE_INSTALLER
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400705static const char usr_bin [] ALIGN1 = "/usr/bin/";
706static const char usr_sbin[] ALIGN1 = "/usr/sbin/";
707static const char *const install_dir[] = {
708 &usr_bin [8], /* "/" */
709 &usr_bin [4], /* "/bin/" */
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200710 &usr_sbin[4] /* "/sbin/" */
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100711# if !ENABLE_INSTALL_NO_USR
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200712 ,usr_bin
713 ,usr_sbin
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100714# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400715};
716
Denis Vlasenko724d1962007-10-10 14:41:07 +0000717/* create (sym)links for each applet */
Denys Vlasenko3b405432009-07-15 00:35:34 +0200718static void install_links(const char *busybox, int use_symbolic_links,
719 char *custom_install_dir)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000720{
721 /* directory table
722 * this should be consistent w/ the enum,
723 * busybox.h::bb_install_loc_t, or else... */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000724 int (*lf)(const char *, const char *);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000725 char *fpc;
Denys Vlasenko4c201c02018-07-17 15:04:17 +0200726 const char *appname = applet_names;
Denis Vlasenko6b06cb82008-05-15 21:30:45 +0000727 unsigned i;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000728 int rc;
729
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000730 lf = link;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000731 if (use_symbolic_links)
732 lf = symlink;
733
Denis Vlasenko745cd172007-11-29 03:31:20 +0000734 for (i = 0; i < ARRAY_SIZE(applet_main); i++) {
Denis Vlasenko724d1962007-10-10 14:41:07 +0000735 fpc = concat_path_file(
Denys Vlasenko3b405432009-07-15 00:35:34 +0200736 custom_install_dir ? custom_install_dir : install_dir[APPLET_INSTALL_LOC(i)],
Ron Yorston610c4c32016-03-30 00:42:05 +0200737 appname);
Denis Vlasenko745cd172007-11-29 03:31:20 +0000738 // debug: bb_error_msg("%slinking %s to busybox",
739 // use_symbolic_links ? "sym" : "", fpc);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000740 rc = lf(busybox, fpc);
741 if (rc != 0 && errno != EEXIST) {
742 bb_simple_perror_msg(fpc);
743 }
744 free(fpc);
Ron Yorston610c4c32016-03-30 00:42:05 +0200745 while (*appname++ != '\0')
746 continue;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000747 }
748}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200749# elif ENABLE_BUSYBOX
Mike Frysingerf1999b52014-01-31 00:29:47 -0500750static void install_links(const char *busybox UNUSED_PARAM,
751 int use_symbolic_links UNUSED_PARAM,
752 char *custom_install_dir UNUSED_PARAM)
753{
754}
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +0100755# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000756
Ron Yorston1b0dcc02016-07-05 14:07:50 +0100757static void run_applet_and_exit(const char *name, char **argv) NORETURN;
758
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100759# if NUM_SCRIPTS > 0
760static int find_script_by_name(const char *name)
761{
762 int i;
763 int applet = find_applet_by_name(name);
764
765 if (applet >= 0) {
766 for (i = 0; i < NUM_SCRIPTS; ++i)
767 if (applet_numbers[i] == applet)
768 return i;
769 }
770 return -1;
771}
772
Ron Yorston3193cb52019-03-30 07:47:12 +0000773int scripted_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100774int scripted_main(int argc UNUSED_PARAM, char **argv)
775{
776 int script = find_script_by_name(applet_name);
777 if (script >= 0)
Ron Yorston71df2d32018-11-27 14:34:25 +0000778#if ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100779 exit(ash_main(-script - 1, argv));
Ron Yorston71df2d32018-11-27 14:34:25 +0000780#elif ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH
781 exit(hush_main(-script - 1, argv));
782#else
783 return 1;
784#endif
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100785 return 0;
786}
787
788char* FAST_FUNC
789get_script_content(unsigned n)
790{
791 char *t = unpack_bz2_data(packed_scripts, sizeof(packed_scripts),
792 UNPACKED_SCRIPTS_LENGTH);
793 if (t) {
794 while (n != 0) {
795 while (*t++ != '\0')
796 continue;
797 n--;
798 }
799 }
800 return t;
801}
802# endif /* NUM_SCRIPTS > 0 */
803
Denys Vlasenkof128bdb2017-07-29 00:59:24 +0200804# if ENABLE_BUSYBOX
805# if ENABLE_FEATURE_SH_STANDALONE && ENABLE_FEATURE_TAB_COMPLETION
806 /*
807 * Insert "busybox" into applet table as well.
808 * This makes standalone shell tab-complete this name too.
809 * (Otherwise having "busybox" in applet table is not necessary,
810 * there is other code which routes "busyboxANY_SUFFIX" name
811 * to busybox_main()).
812 */
813//usage:#define busybox_trivial_usage NOUSAGE_STR
814//usage:#define busybox_full_usage ""
815//applet:IF_BUSYBOX(IF_FEATURE_SH_STANDALONE(IF_FEATURE_TAB_COMPLETION(APPLET(busybox, BB_DIR_BIN, BB_SUID_MAYBE))))
816int busybox_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
817# else
818# define busybox_main(argc,argv) busybox_main(argv)
819static
820# endif
821int busybox_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000822{
823 if (!argv[1]) {
824 /* Called without arguments */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000825 const char *a;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200826 int col;
827 unsigned output_width;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000828 help:
Denys Vlasenkoa8a075a2017-01-11 10:52:24 +0100829 output_width = get_terminal_width(2);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000830
Denis Vlasenko21278df2008-06-25 12:15:46 +0000831 dup2(1, 2);
Denys Vlasenko630dde12009-08-30 19:57:49 +0200832 full_write2_str(bb_banner); /* reuse const string */
833 full_write2_str(" multi-call binary.\n"); /* reuse */
834 full_write2_str(
Aaro Koskinen7b729ed2015-04-02 00:55:17 +0300835 "BusyBox is copyrighted by many authors between 1998-2015.\n"
Bradley M. Kuhn0e941d52012-07-13 11:38:38 -0400836 "Licensed under GPLv2. See source distribution for detailed\n"
837 "copyright notices.\n"
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400838 "\n"
Denys Vlasenko02b8b9b2012-05-14 23:52:57 +0200839 "Usage: busybox [function [arguments]...]\n"
Denys Vlasenkoba888262012-03-22 11:15:06 +0100840 " or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100841# if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
842 " or: busybox --show SCRIPT\n"
843# endif
Denys Vlasenkoba888262012-03-22 11:15:06 +0100844 IF_FEATURE_INSTALLER(
845 " or: busybox --install [-s] [DIR]\n"
846 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400847 " or: function [arguments]...\n"
848 "\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100849 IF_NOT_FEATURE_SH_STANDALONE(
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400850 "\tBusyBox is a multi-call binary that combines many common Unix\n"
851 "\tutilities into a single executable. Most people will create a\n"
852 "\tlink to busybox for each function they wish to use and BusyBox\n"
853 "\twill act like whatever it was invoked as.\n"
Ron Yorstonae57af62015-05-30 17:13:52 +0100854 )
855 IF_FEATURE_SH_STANDALONE(
856 "\tBusyBox is a multi-call binary that combines many common Unix\n"
857 "\tutilities into a single executable. The shell in this build\n"
858 "\tis configured to run built-in utilities without $PATH search.\n"
859 "\tYou don't need to install a link to busybox for each utility.\n"
860 "\tTo run external program, use full path (/sbin/ip instead of ip).\n"
861 )
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400862 "\n"
863 "Currently defined functions:\n"
864 );
Denis Vlasenko724d1962007-10-10 14:41:07 +0000865 col = 0;
Denys Vlasenko0149f022009-05-19 18:01:42 +0200866 /* prevent last comma to be in the very last pos */
867 output_width--;
Denys Vlasenko0575c992018-11-01 13:58:16 +0100868 a = applet_names;
Ron Yorston37788982018-11-17 17:48:14 +0000869 while (*a) {
870 int len2 = strlen(a) + 2;
871 if (col >= (int)output_width - len2) {
872 full_write2_str(",\n");
873 col = 0;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000874 }
Ron Yorston37788982018-11-17 17:48:14 +0000875 if (col == 0) {
876 col = 6;
877 full_write2_str("\t");
878 } else {
879 full_write2_str(", ");
880 }
881 full_write2_str(a);
882 col += len2;
883 a += len2 - 1;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000884 }
Denys Vlasenko7d877fc2016-11-28 01:29:28 +0100885 full_write2_str("\n");
Denis Vlasenko724d1962007-10-10 14:41:07 +0000886 return 0;
887 }
888
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100889# if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
890 if (strcmp(argv[1], "--show") == 0) {
891 int n;
892 if (!argv[2])
893 bb_error_msg_and_die(bb_msg_requires_arg, "--show");
894 n = find_script_by_name(argv[2]);
895 if (n < 0)
896 bb_error_msg_and_die("script '%s' not found", argv[2]);
897 full_write1_str(get_script_content(n));
898 return 0;
899 }
900# endif
901
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100902 if (is_prefixed_with(argv[1], "--list")) {
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400903 unsigned i = 0;
904 const char *a = applet_names;
905 dup2(1, 2);
906 while (*a) {
Denys Vlasenko8e950682016-05-31 02:42:49 +0200907# if ENABLE_FEATURE_INSTALLER
Denys Vlasenkoba888262012-03-22 11:15:06 +0100908 if (argv[1][6]) /* --list-full? */
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400909 full_write2_str(install_dir[APPLET_INSTALL_LOC(i)] + 1);
Denys Vlasenko8e950682016-05-31 02:42:49 +0200910# endif
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400911 full_write2_str(a);
912 full_write2_str("\n");
913 i++;
Ron Yorston2b919582016-04-08 11:57:20 +0100914 while (*a++ != '\0')
915 continue;
Denys Vlasenko5a7c7202010-04-20 21:02:57 -0400916 }
917 return 0;
918 }
919
Denis Vlasenko724d1962007-10-10 14:41:07 +0000920 if (ENABLE_FEATURE_INSTALLER && strcmp(argv[1], "--install") == 0) {
Denys Vlasenko3b405432009-07-15 00:35:34 +0200921 int use_symbolic_links;
Denis Vlasenko724d1962007-10-10 14:41:07 +0000922 const char *busybox;
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100923
Denis Vlasenko724d1962007-10-10 14:41:07 +0000924 busybox = xmalloc_readlink(bb_busybox_exec_path);
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100925 if (!busybox) {
926 /* bb_busybox_exec_path is usually "/proc/self/exe".
927 * In chroot, readlink("/proc/self/exe") usually fails.
928 * In such case, better use argv[0] as symlink target
929 * if it is a full path name.
930 */
Denys Vlasenko5c942712011-03-12 06:08:28 +0100931 if (argv[0][0] != '/')
932 bb_error_msg_and_die("'%s' is not an absolute path", argv[0]);
933 busybox = argv[0];
Denys Vlasenko4a2a86d2011-03-06 06:02:31 +0100934 }
935 /* busybox --install [-s] [DIR]:
936 * -s: make symlinks
937 * DIR: directory to install links to
938 */
Denys Vlasenkoba888262012-03-22 11:15:06 +0100939 use_symbolic_links = (argv[2] && strcmp(argv[2], "-s") == 0 && ++argv);
Denys Vlasenko3b405432009-07-15 00:35:34 +0200940 install_links(busybox, use_symbolic_links, argv[2]);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000941 return 0;
942 }
943
944 if (strcmp(argv[1], "--help") == 0) {
945 /* "busybox --help [<applet>]" */
946 if (!argv[2])
947 goto help;
948 /* convert to "<applet> --help" */
949 argv[0] = argv[2];
950 argv[2] = NULL;
951 } else {
952 /* "busybox <applet> arg1 arg2 ..." */
953 argv++;
954 }
955 /* We support "busybox /a/path/to/applet args..." too. Allows for
956 * "#!/bin/busybox"-style wrappers */
957 applet_name = bb_get_last_path_component_nostrip(argv[0]);
958 run_applet_and_exit(applet_name, argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000959}
Denys Vlasenko8e950682016-05-31 02:42:49 +0200960# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +0000961
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200962# if NUM_APPLETS > 0
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200963void FAST_FUNC run_applet_no_and_exit(int applet_no, const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +0000964{
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200965 int argc = string_array_len(argv);
Denis Vlasenko724d1962007-10-10 14:41:07 +0000966
Denys Vlasenko69a5ec92017-07-07 19:08:56 +0200967 /*
968 * We do not use argv[0]: do not want to repeat massaging of
969 * "-/sbin/halt" -> "halt", for example.
970 */
971 applet_name = name;
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200972
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200973 /* Special case. POSIX says "test --help"
974 * should be no different from e.g. "test --foo".
975 * Thus for "test", we skip --help check.
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200976 * "true" and "false" are also special.
Denys Vlasenkocd7a38a2014-09-18 00:47:05 +0200977 */
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200978 if (1
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200979# if defined APPLET_NO_test
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200980 && applet_no != APPLET_NO_test
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200981# endif
982# if defined APPLET_NO_true
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200983 && applet_no != APPLET_NO_true
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200984# endif
985# if defined APPLET_NO_false
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200986 && applet_no != APPLET_NO_false
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +0200987# endif
Denys Vlasenkode5edad2015-04-21 16:00:41 +0200988 ) {
989 if (argc == 2 && strcmp(argv[1], "--help") == 0) {
990 /* Make "foo --help" exit with 0: */
991 xfunc_error_retval = 0;
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000992 bb_show_usage();
Denys Vlasenko5d783552013-01-17 11:02:21 +0100993 }
Denis Vlasenkobd28f6b2008-07-19 08:15:13 +0000994 }
Denis Vlasenko724d1962007-10-10 14:41:07 +0000995 if (ENABLE_FEATURE_SUID)
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000996 check_suid(applet_no);
Denys Vlasenko215b0ca2016-08-19 18:23:56 +0200997 xfunc_error_retval = applet_main[applet_no](argc, argv);
998 /* Note: applet_main() may also not return (die on a xfunc or such) */
999 xfunc_die();
Denis Vlasenko724d1962007-10-10 14:41:07 +00001000}
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001001# endif /* NUM_APPLETS > 0 */
Denis Vlasenko724d1962007-10-10 14:41:07 +00001002
Ron Yorston37788982018-11-17 17:48:14 +00001003# if ENABLE_BUSYBOX || NUM_APPLETS > 0
Ron Yorstonce824ae2016-06-07 12:12:07 +01001004static NORETURN void run_applet_and_exit(const char *name, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001005{
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001006# if ENABLE_BUSYBOX
Denys Vlasenko8dff01d2015-03-12 17:48:34 +01001007 if (is_prefixed_with(name, "busybox"))
Denys Vlasenkof128bdb2017-07-29 00:59:24 +02001008 exit(busybox_main(/*unused:*/ 0, argv));
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001009# endif
1010# if NUM_APPLETS > 0
Ron Yorston610c4c32016-03-30 00:42:05 +02001011 /* find_applet_by_name() search is more expensive, so goes second */
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001012 {
1013 int applet = find_applet_by_name(name);
1014 if (applet >= 0)
Denys Vlasenko69a5ec92017-07-07 19:08:56 +02001015 run_applet_no_and_exit(applet, name, argv);
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001016 }
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001017# endif
Ron Yorstonce824ae2016-06-07 12:12:07 +01001018
1019 /*bb_error_msg_and_die("applet not found"); - links in printf */
1020 full_write2_str(applet_name);
1021 full_write2_str(": applet not found\n");
1022 /* POSIX: "If a command is not found, the exit status shall be 127" */
1023 exit(127);
Denis Vlasenko724d1962007-10-10 14:41:07 +00001024}
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001025# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001026
Denis Vlasenko10f6fb12008-04-29 00:10:27 +00001027#endif /* !defined(SINGLE_APPLET_MAIN) */
Denis Vlasenko468aea22008-04-01 14:47:57 +00001028
1029
Denis Vlasenko724d1962007-10-10 14:41:07 +00001030#if ENABLE_BUILD_LIBBUSYBOX
Denis Vlasenko85c24712008-03-17 09:04:04 +00001031int lbb_main(char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001032#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001033int main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko724d1962007-10-10 14:41:07 +00001034#endif
1035{
Denys Vlasenkobc14f4d2016-04-03 16:06:42 +02001036#if 0
1037 /* TODO: find a use for a block of memory between end of .bss
1038 * and end of page. For example, I'm getting "_end:0x812e698 2408 bytes"
1039 * - more than 2k of wasted memory (in this particular build)
1040 * *per each running process*!
1041 * (If your linker does not generate "_end" name, weak attribute
1042 * makes &_end == NULL, end_len == 0 here.)
1043 */
1044 extern char _end[] __attribute__((weak));
1045 unsigned end_len = (-(int)_end) & 0xfff;
1046 printf("_end:%p %u bytes\n", &_end, end_len);
1047#endif
1048
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001049 /* Tweak malloc for reduced memory consumption */
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001050#ifdef M_TRIM_THRESHOLD
1051 /* M_TRIM_THRESHOLD is the maximum amount of freed top-most memory
1052 * to keep before releasing to the OS
1053 * Default is way too big: 256k
1054 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001055 mallopt(M_TRIM_THRESHOLD, 8 * 1024);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001056#endif
1057#ifdef M_MMAP_THRESHOLD
1058 /* M_MMAP_THRESHOLD is the request size threshold for using mmap()
1059 * Default is too big: 256k
1060 */
Denys Vlasenkofe86d6b2011-06-03 21:39:42 +02001061 mallopt(M_MMAP_THRESHOLD, 32 * 1024 - 256);
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001062#endif
Denys Vlasenko7f0ebbc2016-10-03 17:42:53 +02001063#if 0 /*def M_TOP_PAD*/
1064 /* When the program break is increased, then M_TOP_PAD bytes are added
1065 * to the sbrk(2) request. When the heap is trimmed because of free(3),
1066 * this much free space is preserved at the top of the heap.
1067 * glibc default seems to be way too big: 128k, but need to verify.
1068 */
1069 mallopt(M_TOP_PAD, 8 * 1024);
1070#endif
Denys Vlasenko1f7c1672009-09-06 02:12:28 +02001071
Denis Vlasenko724d1962007-10-10 14:41:07 +00001072#if !BB_MMU
1073 /* NOMMU re-exec trick sets high-order bit in first byte of name */
1074 if (argv[0][0] & 0x80) {
1075 re_execed = 1;
1076 argv[0][0] &= 0x7f;
1077 }
1078#endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001079
1080#if defined(SINGLE_APPLET_MAIN)
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001081
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001082 /* Only one applet is selected in .config */
Denys Vlasenko8dff01d2015-03-12 17:48:34 +01001083 if (argv[1] && is_prefixed_with(argv[0], "busybox")) {
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001084 /* "busybox <applet> <params>" should still work as expected */
1085 argv++;
1086 }
1087 /* applet_names in this case is just "applet\0\0" */
1088 lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001089# if ENABLE_BUILD_LIBBUSYBOX
1090 return SINGLE_APPLET_MAIN(string_array_len(argv), argv);
1091# else
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001092 return SINGLE_APPLET_MAIN(argc, argv);
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +02001093# endif
Denys Vlasenko8f0af3b2010-11-29 02:55:35 +01001094
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001095#elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
1096
1097 full_write2_str(bb_basename(argv[0]));
1098 full_write2_str(": no applets enabled\n");
1099 exit(127);
1100
1101#else
1102
1103 lbb_prepare("busybox" IF_FEATURE_INDIVIDUAL(, argv));
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001104# if !ENABLE_BUSYBOX
Ron Yorstonba120812016-06-07 10:26:24 +01001105 if (argv[1] && is_prefixed_with(bb_basename(argv[0]), "busybox"))
1106 argv++;
Denys Vlasenkof4f8fe82016-07-05 21:43:28 +02001107# endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001108 applet_name = argv[0];
1109 if (applet_name[0] == '-')
1110 applet_name++;
1111 applet_name = bb_basename(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001112
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001113 /* If we are a result of execv("/proc/self/exe"), fix ugly comm of "exe" */
1114 if (ENABLE_FEATURE_SH_STANDALONE
1115 || ENABLE_FEATURE_PREFER_APPLETS
1116 || !BB_MMU
1117 ) {
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001118 if (NUM_APPLETS > 1)
1119 set_task_comm(applet_name);
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001120 }
Denys Vlasenko147d2ce2017-07-29 02:19:01 +02001121
Denis Vlasenko724d1962007-10-10 14:41:07 +00001122 parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
Denis Vlasenko724d1962007-10-10 14:41:07 +00001123 run_applet_and_exit(applet_name, argv);
Denys Vlasenko7e8218f2016-11-18 21:42:44 +01001124
Denis Vlasenko468aea22008-04-01 14:47:57 +00001125#endif
Denis Vlasenko724d1962007-10-10 14:41:07 +00001126}