libbb/appletlib.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Utility routines.
   4  *
   5  * 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.
   8  *
   9  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
  10  * Permission has been granted to redistribute this code under GPL.
  11  *
  12  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  13  */
  14 /* 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  */
  28 #include "busybox.h"
  29
  30 #if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
  31     || defined(__APPLE__) \
  32     )
  33 # include <malloc.h> /* for mallopt */
  34 #endif
  35
  36 /* Declare <applet>_main() */
  37 #define PROTOTYPES
  38 #include "applets.h"
  39 #undef PROTOTYPES
  40
  41 /* Include generated applet names, pointers to <applet>_main, etc */
  42 #include "applet_tables.h"
  43 /* ...and if applet_tables generator says we have only one applet... */
  44 #ifdef SINGLE_APPLET_MAIN
  45 # undef ENABLE_FEATURE_INDIVIDUAL
  46 # define ENABLE_FEATURE_INDIVIDUAL 1
  47 # undef IF_FEATURE_INDIVIDUAL
  48 # define IF_FEATURE_INDIVIDUAL(...) __VA_ARGS__
  49 #endif
  50
  51 #include "usage_compressed.h"
  52
  53 #if ENABLE_FEATURE_SH_EMBEDDED_SCRIPTS
  54 # define DEFINE_SCRIPT_DATA 1
  55 # include "embedded_scripts.h"
  56 #else
  57 # define NUM_SCRIPTS 0
  58 #endif
  59 #if NUM_SCRIPTS > 0
  60 # include "bb_archive.h"
  61 static const char packed_scripts[] ALIGN1 = { PACKED_SCRIPTS };
  62 #endif
  63
  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
  89 unsigned 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
 100 #if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
 101 static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
 102 #else
 103 # define usage_messages 0
 104 #endif
 105
 106 #if ENABLE_FEATURE_COMPRESS_USAGE
 107
 108 static const char packed_usage[] ALIGN1 = { PACKED_USAGE };
 109 # include "bb_archive.h"
 110 # define unpack_usage_messages() \
 111         unpack_bz2_data(packed_usage, sizeof(packed_usage), sizeof(UNPACKED_USAGE))
 112 # define dealloc_usage_messages(s) free(s)
 113
 114 #else
 115
 116 # define unpack_usage_messages() usage_messages
 117 # define dealloc_usage_messages(s) ((void)(s))
 118
 119 #endif /* FEATURE_COMPRESS_USAGE */
 120
 121
 122 void FAST_FUNC bb_show_usage(void)
 123 {
 124         if (ENABLE_SHOW_USAGE) {
 125 #ifdef SINGLE_APPLET_STR
 126                 /* Imagine that this applet is "true". Dont link in printf! */
 127                 const char *usage_string = unpack_usage_messages();
 128
 129                 if (usage_string) {
 130                         if (*usage_string == '\b') {
 131                                 full_write2_str("No help available\n");
 132                         } else {
 133                                 full_write2_str("Usage: "SINGLE_APPLET_STR" ");
 134                                 full_write2_str(usage_string);
 135                                 full_write2_str("\n");
 136                         }
 137                         if (ENABLE_FEATURE_CLEAN_UP)
 138                                 dealloc_usage_messages((char*)usage_string);
 139                 }
 140 #else
 141                 const char *p;
 142                 const char *usage_string = p = unpack_usage_messages();
 143                 int ap = find_applet_by_name(applet_name);
 144
 145                 if (ap < 0 || usage_string == NULL)
 146                         xfunc_die();
 147                 while (ap) {
 148                         while (*p++) continue;
 149                         ap--;
 150                 }
 151                 full_write2_str(bb_banner);
 152                 full_write2_str(" multi-call binary.\n"); /* common string */
 153                 if (*p == '\b')
 154                         full_write2_str("\nNo help available\n");
 155                 else {
 156                         full_write2_str("\nUsage: ");
 157                         full_write2_str(applet_name);
 158                         if (p[0]) {
 159                                 if (p[0] != '\n')
 160                                         full_write2_str(" ");
 161                                 full_write2_str(p);
 162                         }
 163                         full_write2_str("\n");
 164                 }
 165                 if (ENABLE_FEATURE_CLEAN_UP)
 166                         dealloc_usage_messages((char*)usage_string);
 167 #endif
 168         }
 169         xfunc_die();
 170 }
 171
 172 int FAST_FUNC find_applet_by_name(const char *name)
 173 {
 174         unsigned i, max;
 175         int j;
 176         const char *p;
 177
 178 /* 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
 197         p = applet_names;
 198         i = 0;
 199 #if KNOWN_APPNAME_OFFSETS <= 0
 200         max = NUM_APPLETS;
 201 #else
 202         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
 218         /* Open-coded linear search without strcmp/strlen calls for speed */
 219
 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
 274         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++;
 293                 i++;
 294         }
 295         return -1;
 296 #endif
 297 }
 298
 299
 300 void lbb_prepare(const char *applet
 301                 IF_FEATURE_INDIVIDUAL(, char **argv))
 302                                 MAIN_EXTERNALLY_VISIBLE;
 303 void lbb_prepare(const char *applet
 304                 IF_FEATURE_INDIVIDUAL(, char **argv))
 305 {
 306 #ifdef __GLIBC__
 307         (*(int **)not_const_pp(&bb_errno)) = __errno_location();
 308         barrier();
 309 #endif
 310         applet_name = applet;
 311
 312         if (ENABLE_LOCALE_SUPPORT)
 313                 setlocale(LC_ALL, "");
 314
 315 #if ENABLE_FEATURE_INDIVIDUAL
 316         /* Redundant for busybox (run_applet_and_exit covers that case)
 317          * but needed for "individual applet" mode */
 318         if (argv[1]
 319          && !argv[2]
 320          && strcmp(argv[1], "--help") == 0
 321          && !is_prefixed_with(applet, "busybox")
 322         ) {
 323                 /* 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         }
 328 #endif
 329 }
 330
 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
 340 const char *applet_name;
 341 #if !BB_MMU
 342 bool re_execed;
 343 #endif
 344
 345
 346 /* If not built as a single-applet executable... */
 347 #if !defined(SINGLE_APPLET_MAIN)
 348
 349 IF_FEATURE_SUID(static uid_t ruid;)  /* real uid */
 350
 351 # if ENABLE_FEATURE_SUID_CONFIG
 352
 353 static struct suid_config_t {
 354         /* next ptr must be first: this struct needs to be llist-compatible */
 355         struct suid_config_t *m_next;
 356         struct bb_uidgid_t m_ugid;
 357         int m_applet;
 358         mode_t m_mode;
 359 } *suid_config;
 360
 361 static bool suid_cfg_readable;
 362
 363 /* libbb candidate */
 364 static 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
 381 static void parse_config_file(void)
 382 {
 383         /* Don't depend on the tools to combine strings. */
 384         static const char config_file[] ALIGN1 = "/etc/busybox.conf";
 385
 386         struct suid_config_t *sct_head;
 387         int applet_no;
 388         FILE *f;
 389         const char *errmsg;
 390         unsigned lc;
 391         smallint section;
 392         struct stat st;
 393
 394         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? */
 402          || !(f = fopen_for_read(config_file))  /* Cannot open? */
 403         ) {
 404                 return;
 405         }
 406
 407         suid_cfg_readable = 1;
 408         sct_head = NULL;
 409         section = lc = 0;
 410
 411         while (1) {
 412                 char buffer[256];
 413                 char *s;
 414
 415                 if (!fgets(buffer, sizeof(buffer), f)) { /* Are we done? */
 416                         // Looks like bloat
 417                         //if (ferror(f)) {   /* Make sure it wasn't a read error. */
 418                         //      errmsg = "reading";
 419                         //      goto pe_label;
 420                         //}
 421                         fclose(f);
 422                         suid_config = sct_head; /* Success, so set the pointer. */
 423                         return;
 424                 }
 425
 426                 s = buffer;
 427                 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)) {
 438                         errmsg = "line too long";
 439                         goto pe_label;
 440                 }
 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. */
 455                         char *e = strchr(s, ']');
 456                         if (!e   /* Missing right bracket? */
 457                          || e[1] /* Trailing characters? */
 458                          || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
 459                         ) {
 460                                 errmsg = "section header";
 461                                 goto pe_label;
 462                         }
 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). */
 486                         char *e = strchr(s, '=');
 487                         if (e) {
 488                                 s = get_trimmed_slice(s, e);
 489                         }
 490                         if (!e || !*s) {        /* Missing '=' or empty key. */
 491                                 errmsg = "keyword";
 492                                 goto pe_label;
 493                         }
 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. */
 499                         applet_no = find_applet_by_name(s);
 500                         if (applet_no >= 0) {
 501                                 unsigned i;
 502                                 struct suid_config_t *sct;
 503
 504                                 /* 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. */
 508                                 sct = xzalloc(sizeof(*sct));
 509                                 sct->m_applet = applet_no;
 510                                 /*sct->m_mode = 0;*/
 511                                 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++) {
 519                                         /* 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) {
 532                                                 errmsg = "mode";
 533                                                 goto pe_label;
 534                                         }
 535                                         sct->m_mode |= mode_mask[q - mode_chars];
 536                                         e++;
 537                                 }
 538
 539                                 /* Now get the user/group info. */
 540
 541                                 s = skip_whitespace(e);
 542                                 /* 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 */
 550                                         if (get_uidgid(&sct->m_ugid, s) == 0) {
 551                                                 errmsg = "unknown user/group";
 552                                                 goto pe_label;
 553                                         }
 554                                 }
 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) {
 567                         errmsg = "keyword outside section";
 568                         goto pe_label;
 569                 }
 570         } /* while (1) */
 571
 572  pe_label:
 573         fclose(f);
 574         bb_error_msg("parse error in %s, line %u: %s", config_file, lc, errmsg);
 575
 576         /* Release any allocated memory before returning. */
 577         llist_free((llist_t*)sct_head, NULL);
 578 }
 579 # else
 580 static inline void parse_config_file(void)
 581 {
 582         IF_FEATURE_SUID(ruid = getuid();)
 583 }
 584 # endif /* FEATURE_SUID_CONFIG */
 585
 586
 587 # if ENABLE_FEATURE_SUID && NUM_APPLETS > 0
 588 #  if ENABLE_FEATURE_SUID_CONFIG
 589 /* check if u is member of group g */
 590 static 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 }
 603 #  endif
 604
 605 static void check_suid(int applet_no)
 606 {
 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
 613 #  if ENABLE_FEATURE_SUID_CONFIG
 614         if (suid_cfg_readable) {
 615                 uid_t uid;
 616                 struct suid_config_t *sct;
 617                 mode_t m;
 618
 619                 for (sct = suid_config; sct; sct = sct->m_next) {
 620                         if (sct->m_applet == applet_no)
 621                                 goto found;
 622                 }
 623                 goto check_need_suid;
 624  found:
 625                 /* Is this user allowed to run this applet? */
 626                 m = sct->m_mode;
 627                 if (sct->m_ugid.uid == ruid)
 628                         /* same uid */
 629                         m >>= 6;
 630                 else if ((sct->m_ugid.gid == rgid) || ingroup(ruid, sct->m_ugid.gid))
 631                         /* same group / in group */
 632                         m >>= 3;
 633                 if (!(m & S_IXOTH)) /* is x bit not set? */
 634                         bb_simple_error_msg_and_die("you have no permission to run this applet");
 635
 636                 /* We set effective AND saved ids. If saved-id is not set
 637                  * 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 */
 645                 if (setresgid(-1, rgid, rgid))
 646                         bb_simple_perror_msg_and_die("setresgid");
 647
 648                 /* Are we directed to change uid
 649                  * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
 650                  */
 651                 uid = ruid;
 652                 if (sct->m_mode & S_ISUID)
 653                         uid = sct->m_ugid.uid;
 654                 /* else: we will set euid = ruid, thus dropping suid effect */
 655                 if (setresuid(-1, uid, uid))
 656                         bb_simple_perror_msg_and_die("setresuid");
 657
 658                 goto ret;
 659         }
 660 #   if !ENABLE_FEATURE_SUID_CONFIG_QUIET
 661         {
 662                 static bool onetime = 0;
 663
 664                 if (!onetime) {
 665                         onetime = 1;
 666                         bb_simple_error_msg("using fallback suid method");
 667                 }
 668         }
 669 #   endif
 670  check_need_suid:
 671 #  endif
 672         if (APPLET_SUID(applet_no) == BB_SUID_REQUIRE) {
 673                 /* 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())
 676                         bb_simple_error_msg_and_die("must be suid to work properly");
 677         } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
 678                 /*
 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);
 693         }
 694 #  if ENABLE_FEATURE_SUID_CONFIG
 695  ret: ;
 696         llist_free((llist_t*)suid_config, NULL);
 697 #  endif
 698 }
 699 # else
 700 #  define check_suid(x) ((void)0)
 701 # endif /* FEATURE_SUID */
 702
 703
 704 # if ENABLE_FEATURE_INSTALLER
 705 static const char usr_bin [] ALIGN1 = "/usr/bin/";
 706 static const char usr_sbin[] ALIGN1 = "/usr/sbin/";
 707 static const char *const install_dir[] = {
 708         &usr_bin [8], /* "/" */
 709         &usr_bin [4], /* "/bin/" */
 710         &usr_sbin[4]  /* "/sbin/" */
 711 #  if !ENABLE_INSTALL_NO_USR
 712         ,usr_bin
 713         ,usr_sbin
 714 #  endif
 715 };
 716
 717 /* create (sym)links for each applet */
 718 static void install_links(const char *busybox, int use_symbolic_links,
 719                 char *custom_install_dir)
 720 {
 721         /* directory table
 722          * this should be consistent w/ the enum,
 723          * busybox.h::bb_install_loc_t, or else... */
 724         int (*lf)(const char *, const char *);
 725         char *fpc;
 726         const char *appname = applet_names;
 727         unsigned i;
 728         int rc;
 729
 730         lf = link;
 731         if (use_symbolic_links)
 732                 lf = symlink;
 733
 734         for (i = 0; i < ARRAY_SIZE(applet_main); i++) {
 735                 fpc = concat_path_file(
 736                                 custom_install_dir ? custom_install_dir : install_dir[APPLET_INSTALL_LOC(i)],
 737                                 appname);
 738                 // debug: bb_error_msg("%slinking %s to busybox",
 739                 //              use_symbolic_links ? "sym" : "", fpc);
 740                 rc = lf(busybox, fpc);
 741                 if (rc != 0 && errno != EEXIST) {
 742                         bb_simple_perror_msg(fpc);
 743                 }
 744                 free(fpc);
 745                 while (*appname++ != '\0')
 746                         continue;
 747         }
 748 }
 749 # elif ENABLE_BUSYBOX
 750 static void install_links(const char *busybox UNUSED_PARAM,
 751                 int use_symbolic_links UNUSED_PARAM,
 752                 char *custom_install_dir UNUSED_PARAM)
 753 {
 754 }
 755 # endif
 756
 757 # if ENABLE_BUSYBOX || NUM_APPLETS > 0
 758 static void run_applet_and_exit(const char *name, char **argv) NORETURN;
 759 #endif
 760
 761 # if NUM_SCRIPTS > 0
 762 static int find_script_by_name(const char *name)
 763 {
 764         int i;
 765         int applet = find_applet_by_name(name);
 766
 767         if (applet >= 0) {
 768                 for (i = 0; i < NUM_SCRIPTS; ++i)
 769                         if (applet_numbers[i] == applet)
 770                                 return i;
 771         }
 772         return -1;
 773 }
 774
 775 int scripted_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
 776 int scripted_main(int argc UNUSED_PARAM, char **argv)
 777 {
 778         int script = find_script_by_name(applet_name);
 779         if (script >= 0)
 780 #  if ENABLE_SHELL_ASH
 781                 exit(ash_main(-script - 1, argv));
 782 #  elif ENABLE_SHELL_HUSH
 783                 exit(hush_main(-script - 1, argv));
 784 #  else
 785                 return 1;
 786 #  endif
 787         return 0;
 788 }
 789
 790 char* FAST_FUNC
 791 get_script_content(unsigned n)
 792 {
 793         char *t = unpack_bz2_data(packed_scripts, sizeof(packed_scripts),
 794                                         UNPACKED_SCRIPTS_LENGTH);
 795         if (t) {
 796                 while (n != 0) {
 797                         while (*t++ != '\0')
 798                                 continue;
 799                         n--;
 800                 }
 801         }
 802         return t;
 803 }
 804 # endif /* NUM_SCRIPTS > 0 */
 805
 806 # if ENABLE_BUSYBOX
 807 #  if ENABLE_FEATURE_SH_STANDALONE && ENABLE_FEATURE_TAB_COMPLETION
 808     /*
 809      * Insert "busybox" into applet table as well.
 810      * This makes standalone shell tab-complete this name too.
 811      * (Otherwise having "busybox" in applet table is not necessary,
 812      * there is other code which routes "busyboxANY_SUFFIX" name
 813      * to busybox_main()).
 814      */
 815 //usage:#define busybox_trivial_usage NOUSAGE_STR
 816 //usage:#define busybox_full_usage ""
 817 //applet:IF_BUSYBOX(IF_FEATURE_SH_STANDALONE(IF_FEATURE_TAB_COMPLETION(APPLET(busybox, BB_DIR_BIN, BB_SUID_MAYBE))))
 818 int busybox_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
 819 #  else
 820 #   define busybox_main(argc,argv) busybox_main(argv)
 821 static
 822 #  endif
 823 int busybox_main(int argc UNUSED_PARAM, char **argv)
 824 {
 825         if (!argv[1]) {
 826                 /* Called without arguments */
 827                 const char *a;
 828                 int col;
 829                 unsigned output_width;
 830  help:
 831                 output_width = get_terminal_width(2);
 832
 833                 dup2(1, 2);
 834                 full_write2_str(bb_banner); /* reuse const string */
 835                 full_write2_str(" multi-call binary.\n"); /* reuse */
 836                 full_write2_str(
 837                         "BusyBox is copyrighted by many authors between 1998-2015.\n"
 838                         "Licensed under GPLv2. See source distribution for detailed\n"
 839                         "copyright notices.\n"
 840                         "\n"
 841                         "Usage: busybox [function [arguments]...]\n"
 842                         "   or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
 843 #  if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
 844                         "   or: busybox --show SCRIPT\n"
 845 #  endif
 846                         IF_FEATURE_INSTALLER(
 847                         "   or: busybox --install [-s] [DIR]\n"
 848                         )
 849                         "   or: function [arguments]...\n"
 850                         "\n"
 851                         IF_NOT_FEATURE_SH_STANDALONE(
 852                         "\tBusyBox is a multi-call binary that combines many common Unix\n"
 853                         "\tutilities into a single executable.  Most people will create a\n"
 854                         "\tlink to busybox for each function they wish to use and BusyBox\n"
 855                         "\twill act like whatever it was invoked as.\n"
 856                         )
 857                         IF_FEATURE_SH_STANDALONE(
 858                         "\tBusyBox is a multi-call binary that combines many common Unix\n"
 859                         "\tutilities into a single executable.  The shell in this build\n"
 860                         "\tis configured to run built-in utilities without $PATH search.\n"
 861                         "\tYou don't need to install a link to busybox for each utility.\n"
 862                         "\tTo run external program, use full path (/sbin/ip instead of ip).\n"
 863                         )
 864                         "\n"
 865                         "Currently defined functions:\n"
 866                 );
 867                 col = 0;
 868                 /* prevent last comma to be in the very last pos */
 869                 output_width--;
 870                 a = applet_names;
 871                 while (*a) {
 872                         int len2 = strlen(a) + 2;
 873                         if (col >= (int)output_width - len2) {
 874                                 full_write2_str(",\n");
 875                                 col = 0;
 876                         }
 877                         if (col == 0) {
 878                                 col = 6;
 879                                 full_write2_str("\t");
 880                         } else {
 881                                 full_write2_str(", ");
 882                         }
 883                         full_write2_str(a);
 884                         col += len2;
 885                         a += len2 - 1;
 886                 }
 887                 full_write2_str("\n");
 888                 return 0;
 889         }
 890
 891 #  if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
 892         if (strcmp(argv[1], "--show") == 0) {
 893                 int n;
 894                 if (!argv[2])
 895                         bb_error_msg_and_die(bb_msg_requires_arg, "--show");
 896                 n = find_script_by_name(argv[2]);
 897                 if (n < 0)
 898                         bb_error_msg_and_die("script '%s' not found", argv[2]);
 899                 full_write1_str(get_script_content(n));
 900                 return 0;
 901         }
 902 #  endif
 903
 904         if (is_prefixed_with(argv[1], "--list")) {
 905                 unsigned i = 0;
 906                 const char *a = applet_names;
 907                 dup2(1, 2);
 908                 while (*a) {
 909 #  if ENABLE_FEATURE_INSTALLER
 910                         if (argv[1][6]) /* --list-full? */
 911                                 full_write2_str(install_dir[APPLET_INSTALL_LOC(i)] + 1);
 912 #  endif
 913                         full_write2_str(a);
 914                         full_write2_str("\n");
 915                         i++;
 916                         while (*a++ != '\0')
 917                                 continue;
 918                 }
 919                 return 0;
 920         }
 921
 922         if (ENABLE_FEATURE_INSTALLER && strcmp(argv[1], "--install") == 0) {
 923                 int use_symbolic_links;
 924                 const char *busybox;
 925
 926                 busybox = xmalloc_readlink(bb_busybox_exec_path);
 927                 if (!busybox) {
 928                         /* bb_busybox_exec_path is usually "/proc/self/exe".
 929                          * In chroot, readlink("/proc/self/exe") usually fails.
 930                          * In such case, better use argv[0] as symlink target
 931                          * if it is a full path name.
 932                          */
 933                         if (argv[0][0] != '/')
 934                                 bb_error_msg_and_die("'%s' is not an absolute path", argv[0]);
 935                         busybox = argv[0];
 936                 }
 937                 /* busybox --install [-s] [DIR]:
 938                  * -s: make symlinks
 939                  * DIR: directory to install links to
 940                  */
 941                 use_symbolic_links = (argv[2] && strcmp(argv[2], "-s") == 0 && ++argv);
 942                 install_links(busybox, use_symbolic_links, argv[2]);
 943                 return 0;
 944         }
 945
 946         if (strcmp(argv[1], "--help") == 0) {
 947                 /* "busybox --help [<applet>]" */
 948                 if (!argv[2])
 949                         goto help;
 950                 /* convert to "<applet> --help" */
 951                 argv[0] = argv[2];
 952                 argv[2] = NULL;
 953         } else {
 954                 /* "busybox <applet> arg1 arg2 ..." */
 955                 argv++;
 956         }
 957         /* We support "busybox /a/path/to/applet args..." too. Allows for
 958          * "#!/bin/busybox"-style wrappers */
 959         applet_name = bb_get_last_path_component_nostrip(argv[0]);
 960         run_applet_and_exit(applet_name, argv);
 961 }
 962 # endif
 963
 964 # if NUM_APPLETS > 0
 965 void FAST_FUNC run_applet_no_and_exit(int applet_no, const char *name, char **argv)
 966 {
 967         int argc = string_array_len(argv);
 968
 969         /*
 970          * We do not use argv[0]: do not want to repeat massaging of
 971          * "-/sbin/halt" -> "halt", for example.
 972          */
 973         applet_name = name;
 974
 975         /* Special case. POSIX says "test --help"
 976          * should be no different from e.g. "test --foo".
 977          * Thus for "test", we skip --help check.
 978          * "true" and "false" are also special.
 979          */
 980         if (1
 981 #  if defined APPLET_NO_test
 982          && applet_no != APPLET_NO_test
 983 #  endif
 984 #  if defined APPLET_NO_true
 985          && applet_no != APPLET_NO_true
 986 #  endif
 987 #  if defined APPLET_NO_false
 988          && applet_no != APPLET_NO_false
 989 #  endif
 990         ) {
 991                 if (argc == 2 && strcmp(argv[1], "--help") == 0) {
 992                         /* Make "foo --help" exit with 0: */
 993                         xfunc_error_retval = 0;
 994                         bb_show_usage();
 995                 }
 996         }
 997         if (ENABLE_FEATURE_SUID)
 998                 check_suid(applet_no);
 999         xfunc_error_retval = applet_main[applet_no](argc, argv);
1000         /* Note: applet_main() may also not return (die on a xfunc or such) */
1001         xfunc_die();
1002 }
1003 # endif /* NUM_APPLETS > 0 */
1004
1005 # if ENABLE_BUSYBOX || NUM_APPLETS > 0
1006 static NORETURN void run_applet_and_exit(const char *name, char **argv)
1007 {
1008 #  if ENABLE_BUSYBOX
1009         if (is_prefixed_with(name, "busybox"))
1010                 exit(busybox_main(/*unused:*/ 0, argv));
1011 #  endif
1012 #  if NUM_APPLETS > 0
1013         /* find_applet_by_name() search is more expensive, so goes second */
1014         {
1015                 int applet = find_applet_by_name(name);
1016                 if (applet >= 0)
1017                         run_applet_no_and_exit(applet, name, argv);
1018         }
1019 #  endif
1020
1021         /*bb_error_msg_and_die("applet not found"); - links in printf */
1022         full_write2_str(applet_name);
1023         full_write2_str(": applet not found\n");
1024         /* POSIX: "If a command is not found, the exit status shall be 127" */
1025         exit(127);
1026 }
1027 # endif
1028
1029 #else /* defined(SINGLE_APPLET_MAIN) */
1030
1031 # if NUM_SCRIPTS > 0
1032 /* if SINGLE_APPLET_MAIN, these two functions are simpler: */
1033 int scripted_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
1034 int scripted_main(int argc UNUSED_PARAM, char **argv)
1035 {
1036 #  if ENABLE_SHELL_ASH
1037         int script = 0;
1038         exit(ash_main(-script - 1, argv));
1039 #  elif ENABLE_SHELL_HUSH
1040         int script = 0;
1041         exit(hush_main(-script - 1, argv));
1042 #  else
1043         return 1;
1044 #  endif
1045 }
1046 char* FAST_FUNC
1047 get_script_content(unsigned n UNUSED_PARAM)
1048 {
1049         char *t = unpack_bz2_data(packed_scripts, sizeof(packed_scripts),
1050                                         UNPACKED_SCRIPTS_LENGTH);
1051         return t;
1052 }
1053 # endif /* NUM_SCRIPTS > 0 */
1054
1055 #endif /* defined(SINGLE_APPLET_MAIN) */
1056
1057
1058 #if ENABLE_BUILD_LIBBUSYBOX
1059 int lbb_main(char **argv)
1060 #else
1061 int main(int argc UNUSED_PARAM, char **argv)
1062 #endif
1063 {
1064 #if 0
1065         /* TODO: find a use for a block of memory between end of .bss
1066          * and end of page. For example, I'm getting "_end:0x812e698 2408 bytes"
1067          * - more than 2k of wasted memory (in this particular build)
1068          * *per each running process*!
1069          * (If your linker does not generate "_end" name, weak attribute
1070          * makes &_end == NULL, end_len == 0 here.)
1071          */
1072         extern char _end[] __attribute__((weak));
1073         unsigned end_len = (-(int)_end) & 0xfff;
1074         printf("_end:%p %u bytes\n", &_end, end_len);
1075 #endif
1076
1077         /* Tweak malloc for reduced memory consumption */
1078 #ifdef M_TRIM_THRESHOLD
1079         /* M_TRIM_THRESHOLD is the maximum amount of freed top-most memory
1080          * to keep before releasing to the OS
1081          * Default is way too big: 256k
1082          */
1083         mallopt(M_TRIM_THRESHOLD, 8 * 1024);
1084 #endif
1085 #ifdef M_MMAP_THRESHOLD
1086         /* M_MMAP_THRESHOLD is the request size threshold for using mmap()
1087          * Default is too big: 256k
1088          */
1089         mallopt(M_MMAP_THRESHOLD, 32 * 1024 - 256);
1090 #endif
1091 #if 0 /*def M_TOP_PAD*/
1092         /* When the program break is increased, then M_TOP_PAD bytes are added
1093          * to the sbrk(2) request. When the heap is trimmed because of free(3),
1094          * this much free space is preserved at the top of the heap.
1095          * glibc default seems to be way too big: 128k, but need to verify.
1096          */
1097         mallopt(M_TOP_PAD, 8 * 1024);
1098 #endif
1099
1100 #if !BB_MMU
1101         /* NOMMU re-exec trick sets high-order bit in first byte of name */
1102         if (argv[0][0] & 0x80) {
1103                 re_execed = 1;
1104                 argv[0][0] &= 0x7f;
1105         }
1106 #endif
1107
1108 #if defined(SINGLE_APPLET_MAIN)
1109
1110         /* Only one applet is selected in .config */
1111         if (argv[1] && is_prefixed_with(argv[0], "busybox")) {
1112                 /* "busybox <applet> <params>" should still work as expected */
1113                 argv++;
1114         }
1115         /* applet_names in this case is just "applet\0\0" */
1116         lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
1117 # if ENABLE_BUILD_LIBBUSYBOX
1118         return SINGLE_APPLET_MAIN(string_array_len(argv), argv);
1119 # else
1120         return SINGLE_APPLET_MAIN(argc, argv);
1121 # endif
1122
1123 #elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
1124
1125         full_write2_str(bb_basename(argv[0]));
1126         full_write2_str(": no applets enabled\n");
1127         exit(127);
1128
1129 #else
1130
1131         lbb_prepare("busybox" IF_FEATURE_INDIVIDUAL(, argv));
1132 # if !ENABLE_BUSYBOX
1133         if (argv[1] && is_prefixed_with(bb_basename(argv[0]), "busybox"))
1134                 argv++;
1135 # endif
1136         applet_name = argv[0];
1137         if (applet_name[0] == '-')
1138                 applet_name++;
1139         applet_name = bb_basename(applet_name);
1140
1141         /* If we are a result of execv("/proc/self/exe"), fix ugly comm of "exe" */
1142         if (ENABLE_FEATURE_SH_STANDALONE
1143          || ENABLE_FEATURE_PREFER_APPLETS
1144          || !BB_MMU
1145         ) {
1146                 if (NUM_APPLETS > 1)
1147                         set_task_comm(applet_name);
1148         }
1149
1150         parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
1151         run_applet_and_exit(applet_name, argv);
1152
1153 #endif
1154 }