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
  15 /* We are trying to not use printf, this benefits the case when selected
  16  * applets are really simple. Example:
  17  *
  18  * $ ./busybox
  19  * ...
  20  * Currently defined functions:
  21  *         basename, false, true
  22  *
  23  * $ size busybox
  24  *    text    data     bss     dec     hex filename
  25  *    4473      52      72    4597    11f5 busybox
  26  *
  27  * FEATURE_INSTALLER or FEATURE_SUID will still link printf routines in. :(
  28  */
  29 #include "busybox.h"
  30
  31 #if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
  32     || defined(__APPLE__) \
  33     )
  34 # include <malloc.h> /* for mallopt */
  35 #endif
  36
  37
  38 /* Declare <applet>_main() */
  39 #define PROTOTYPES
  40 #include "applets.h"
  41 #undef PROTOTYPES
  42
  43 /* Include generated applet names, pointers to <applet>_main, etc */
  44 #include "applet_tables.h"
  45 /* ...and if applet_tables generator says we have only one applet... */
  46 #ifdef SINGLE_APPLET_MAIN
  47 # undef ENABLE_FEATURE_INDIVIDUAL
  48 # define ENABLE_FEATURE_INDIVIDUAL 1
  49 # undef IF_FEATURE_INDIVIDUAL
  50 # define IF_FEATURE_INDIVIDUAL(...) __VA_ARGS__
  51 #endif
  52
  53 #include "usage_compressed.h"
  54
  55
  56 /* "Do not compress usage text if uncompressed text is small
  57  *  and we don't include bunzip2 code for other reasons"
  58  *
  59  * Useful for mass one-applet rebuild (bunzip2 code is ~2.7k).
  60  *
  61  * Unlike BUNZIP2, if FEATURE_SEAMLESS_BZ2 is on, bunzip2 code is built but
  62  * still may be unused if none of the selected applets calls open_zipped()
  63  * or its friends; we test for (FEATURE_SEAMLESS_BZ2 && <APPLET>) instead.
  64  * For example, only if TAR and FEATURE_SEAMLESS_BZ2 are both selected,
  65  * then bunzip2 code will be linked in anyway, and disabling help compression
  66  * would be not optimal:
  67  */
  68 #if UNPACKED_USAGE_LENGTH < 4*1024 \
  69  && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_TAR) \
  70  && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MODPROBE) \
  71  && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_INSMOD) \
  72  && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_DEPMOD) \
  73  && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MAN) \
  74  && !ENABLE_BUNZIP2 \
  75  && !ENABLE_BZCAT
  76 # undef  ENABLE_FEATURE_COMPRESS_USAGE
  77 # define ENABLE_FEATURE_COMPRESS_USAGE 0
  78 #endif
  79
  80
  81 #if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
  82 static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
  83 #else
  84 # define usage_messages 0
  85 #endif
  86
  87 #if ENABLE_FEATURE_COMPRESS_USAGE
  88
  89 static const char packed_usage[] ALIGN1 = { PACKED_USAGE };
  90 # include "bb_archive.h"
  91 static const char *unpack_usage_messages(void)
  92 {
  93         char *outbuf = NULL;
  94         bunzip_data *bd;
  95         int i;
  96
  97         i = start_bunzip(&bd,
  98                         /* src_fd: */ -1,
  99                         /* inbuf:  */ packed_usage,
 100                         /* len:    */ sizeof(packed_usage));
 101         /* read_bunzip can longjmp to start_bunzip, and ultimately
 102          * end up here with i != 0 on read data errors! Not trivial */
 103         if (!i) {
 104                 /* Cannot use xmalloc: will leak bd in NOFORK case! */
 105                 outbuf = malloc_or_warn(sizeof(UNPACKED_USAGE));
 106                 if (outbuf)
 107                         read_bunzip(bd, outbuf, sizeof(UNPACKED_USAGE));
 108         }
 109         dealloc_bunzip(bd);
 110         return outbuf;
 111 }
 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 suck in printf! */
 127                 const char *usage_string = unpack_usage_messages();
 128
 129                 if (*usage_string == '\b') {
 130                         full_write2_str("No help available.\n\n");
 131                 } else {
 132                         full_write2_str("Usage: "SINGLE_APPLET_STR" ");
 133                         full_write2_str(usage_string);
 134                         full_write2_str("\n\n");
 135                 }
 136                 if (ENABLE_FEATURE_CLEAN_UP)
 137                         dealloc_usage_messages((char*)usage_string);
 138 #else
 139                 const char *p;
 140                 const char *usage_string = p = unpack_usage_messages();
 141                 int ap = find_applet_by_name(applet_name);
 142
 143                 if (ap < 0) /* never happens, paranoia */
 144                         xfunc_die();
 145                 while (ap) {
 146                         while (*p++) continue;
 147                         ap--;
 148                 }
 149                 full_write2_str(bb_banner);
 150                 full_write2_str(" multi-call binary.\n");
 151                 if (*p == '\b')
 152                         full_write2_str("\nNo help available.\n\n");
 153                 else {
 154                         full_write2_str("\nUsage: ");
 155                         full_write2_str(applet_name);
 156                         full_write2_str(" ");
 157                         full_write2_str(p);
 158                         full_write2_str("\n");
 159                 }
 160                 if (ENABLE_FEATURE_CLEAN_UP)
 161                         dealloc_usage_messages((char*)usage_string);
 162 #endif
 163         }
 164         xfunc_die();
 165 }
 166
 167 int FAST_FUNC find_applet_by_name(const char *name)
 168 {
 169         unsigned i, max;
 170         int j;
 171         const char *p;
 172
 173 /* The commented-out word-at-a-time code is ~40% faster, but +160 bytes.
 174  * "Faster" here saves ~0.5 microsecond of real time - not worth it.
 175  */
 176 #if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
 177         uint32_t n32;
 178
 179         /* Handle all names < 2 chars long early */
 180         if (name[0] == '\0')
 181                 return -1; /* "" is not a valid applet name */
 182         if (name[1] == '\0') {
 183                 if (!ENABLE_TEST)
 184                         return -1; /* 1-char name is not valid */
 185                 if (name[0] != ']')
 186                         return -1; /* 1-char name which isn't "[" is not valid */
 187                 /* applet "[" is always applet #0: */
 188                 return 0;
 189         }
 190 #endif
 191
 192         p = applet_names;
 193         i = 0;
 194 #if KNOWN_APPNAME_OFFSETS <= 0
 195         max = NUM_APPLETS;
 196 #else
 197         max = NUM_APPLETS * KNOWN_APPNAME_OFFSETS;
 198         for (j = ARRAY_SIZE(applet_nameofs)-1; j >= 0; j--) {
 199                 const char *pp = applet_names + applet_nameofs[j];
 200                 if (strcmp(name, pp) >= 0) {
 201                         //bb_error_msg("name:'%s' >= pp:'%s'", name, pp);
 202                         p = pp;
 203                         i = max - NUM_APPLETS;
 204                         break;
 205                 }
 206                 max -= NUM_APPLETS;
 207         }
 208         max /= (unsigned)KNOWN_APPNAME_OFFSETS;
 209         i /= (unsigned)KNOWN_APPNAME_OFFSETS;
 210         //bb_error_msg("name:'%s' starting from:'%s' i:%u max:%u", name, p, i, max);
 211 #endif
 212
 213         /* Open-coded linear search without strcmp/strlen calls for speed */
 214
 215 #if 0 /*BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN*/
 216         /* skip "[\0" name, it's surely not it */
 217         if (ENABLE_TEST && LONE_CHAR(p, '['))
 218                 i++, p += 2;
 219         /* All remaining applet names in p[] are at least 2 chars long */
 220         /* name[] is also at least 2 chars long */
 221
 222         n32 = (name[0] << 0) | (name[1] << 8) | (name[2] << 16);
 223         while (i < max) {
 224                 uint32_t p32;
 225                 char ch;
 226
 227                 /* Quickly check match of the first 3 bytes */
 228                 move_from_unaligned32(p32, p);
 229                 p += 3;
 230                 if ((p32 & 0x00ffffff) != n32) {
 231                         /* Most likely case: 3 first bytes do not match */
 232                         i++;
 233                         if ((p32 & 0x00ff0000) == '\0')
 234                                 continue; // p[2] was NUL
 235                         p++;
 236                         if ((p32 & 0xff000000) == '\0')
 237                                 continue; // p[3] was NUL
 238                         /* p[0..3] aren't matching and none is NUL, check the rest */
 239                         while (*p++ != '\0')
 240                                 continue;
 241                         continue;
 242                 }
 243
 244                 /* Unlikely branch: first 3 bytes ([0..2]) match */
 245                 if ((p32 & 0x00ff0000) == '\0') {
 246                         /* name is 2-byte long, it is full match */
 247                         //bb_error_msg("found:'%s' i:%u", name, i);
 248                         return i;
 249                 }
 250                 /* Check remaining bytes [3..NUL] */
 251                 ch = (p32 >> 24);
 252                 j = 3;
 253                 while (ch == name[j]) {
 254                         if (ch == '\0') {
 255                                 //bb_error_msg("found:'%s' i:%u", name, i);
 256                                 return i;
 257                         }
 258                         ch = *++p;
 259                         j++;
 260                 }
 261                 /* Not a match. Skip it, including NUL */
 262                 while (ch != '\0')
 263                         ch = *++p;
 264                 p++;
 265                 i++;
 266         }
 267         return -1;
 268 #else
 269         while (i < max) {
 270                 char ch;
 271                 j = 0;
 272                 /* Do we see "name\0" in applet_names[p] position? */
 273                 while ((ch = *p) == name[j]) {
 274                         if (ch == '\0') {
 275                                 //bb_error_msg("found:'%s' i:%u", name, i);
 276                                 return i; /* yes */
 277                         }
 278                         p++;
 279                         j++;
 280                 }
 281                 /* No.
 282                  * p => 1st non-matching char in applet_names[],
 283                  * skip to and including NUL.
 284                  */
 285                 while (ch != '\0')
 286                         ch = *++p;
 287                 p++;
 288                 i++;
 289         }
 290         return -1;
 291 #endif
 292 }
 293
 294
 295 void lbb_prepare(const char *applet
 296                 IF_FEATURE_INDIVIDUAL(, char **argv))
 297                                 MAIN_EXTERNALLY_VISIBLE;
 298 void lbb_prepare(const char *applet
 299                 IF_FEATURE_INDIVIDUAL(, char **argv))
 300 {
 301 #ifdef __GLIBC__
 302         (*(int **)&bb_errno) = __errno_location();
 303         barrier();
 304 #endif
 305         applet_name = applet;
 306
 307         if (ENABLE_LOCALE_SUPPORT)
 308                 setlocale(LC_ALL, "");
 309
 310 #if ENABLE_FEATURE_INDIVIDUAL
 311         /* Redundant for busybox (run_applet_and_exit covers that case)
 312          * but needed for "individual applet" mode */
 313         if (argv[1]
 314          && !argv[2]
 315          && strcmp(argv[1], "--help") == 0
 316          && !is_prefixed_with(applet, "busybox")
 317         ) {
 318                 /* Special case. POSIX says "test --help"
 319                  * should be no different from e.g. "test --foo".  */
 320                 if (!ENABLE_TEST || strcmp(applet_name, "test") != 0)
 321                         bb_show_usage();
 322         }
 323 #endif
 324 }
 325
 326 /* The code below can well be in applets/applets.c, as it is used only
 327  * for busybox binary, not "individual" binaries.
 328  * However, keeping it here and linking it into libbusybox.so
 329  * (together with remaining tiny applets/applets.o)
 330  * makes it possible to avoid --whole-archive at link time.
 331  * This makes (shared busybox) + libbusybox smaller.
 332  * (--gc-sections would be even better....)
 333  */
 334
 335 const char *applet_name;
 336 #if !BB_MMU
 337 bool re_execed;
 338 #endif
 339
 340
 341 /* If not built as a single-applet executable... */
 342 #if !defined(SINGLE_APPLET_MAIN)
 343
 344 IF_FEATURE_SUID(static uid_t ruid;)  /* real uid */
 345
 346 # if ENABLE_FEATURE_SUID_CONFIG
 347
 348 static struct suid_config_t {
 349         /* next ptr must be first: this struct needs to be llist-compatible */
 350         struct suid_config_t *m_next;
 351         struct bb_uidgid_t m_ugid;
 352         int m_applet;
 353         mode_t m_mode;
 354 } *suid_config;
 355
 356 static bool suid_cfg_readable;
 357
 358 /* libbb candidate */
 359 static char *get_trimmed_slice(char *s, char *e)
 360 {
 361         /* First, consider the value at e to be nul and back up until we
 362          * reach a non-space char.  Set the char after that (possibly at
 363          * the original e) to nul. */
 364         while (e-- > s) {
 365                 if (!isspace(*e)) {
 366                         break;
 367                 }
 368         }
 369         e[1] = '\0';
 370
 371         /* Next, advance past all leading space and return a ptr to the
 372          * first non-space char; possibly the terminating nul. */
 373         return skip_whitespace(s);
 374 }
 375
 376 static void parse_config_file(void)
 377 {
 378         /* Don't depend on the tools to combine strings. */
 379         static const char config_file[] ALIGN1 = "/etc/busybox.conf";
 380
 381         struct suid_config_t *sct_head;
 382         int applet_no;
 383         FILE *f;
 384         const char *errmsg;
 385         unsigned lc;
 386         smallint section;
 387         struct stat st;
 388
 389         ruid = getuid();
 390         if (ruid == 0) /* run by root - don't need to even read config file */
 391                 return;
 392
 393         if ((stat(config_file, &st) != 0)       /* No config file? */
 394          || !S_ISREG(st.st_mode)                /* Not a regular file? */
 395          || (st.st_uid != 0)                    /* Not owned by root? */
 396          || (st.st_mode & (S_IWGRP | S_IWOTH))  /* Writable by non-root? */
 397          || !(f = fopen_for_read(config_file))  /* Cannot open? */
 398         ) {
 399                 return;
 400         }
 401
 402         suid_cfg_readable = 1;
 403         sct_head = NULL;
 404         section = lc = 0;
 405
 406         while (1) {
 407                 char buffer[256];
 408                 char *s;
 409
 410                 if (!fgets(buffer, sizeof(buffer), f)) { /* Are we done? */
 411                         // Looks like bloat
 412                         //if (ferror(f)) {   /* Make sure it wasn't a read error. */
 413                         //      errmsg = "reading";
 414                         //      goto pe_label;
 415                         //}
 416                         fclose(f);
 417                         suid_config = sct_head; /* Success, so set the pointer. */
 418                         return;
 419                 }
 420
 421                 s = buffer;
 422                 lc++;                                   /* Got a (partial) line. */
 423
 424                 /* If a line is too long for our buffer, we consider it an error.
 425                  * The following test does mistreat one corner case though.
 426                  * If the final line of the file does not end with a newline and
 427                  * yet exactly fills the buffer, it will be treated as too long
 428                  * even though there isn't really a problem.  But it isn't really
 429                  * worth adding code to deal with such an unlikely situation, and
 430                  * we do err on the side of caution.  Besides, the line would be
 431                  * too long if it did end with a newline. */
 432                 if (!strchr(s, '\n') && !feof(f)) {
 433                         errmsg = "line too long";
 434                         goto pe_label;
 435                 }
 436
 437                 /* Trim leading and trailing whitespace, ignoring comments, and
 438                  * check if the resulting string is empty. */
 439                 s = get_trimmed_slice(s, strchrnul(s, '#'));
 440                 if (!*s) {
 441                         continue;
 442                 }
 443
 444                 /* Check for a section header. */
 445
 446                 if (*s == '[') {
 447                         /* Unlike the old code, we ignore leading and trailing
 448                          * whitespace for the section name.  We also require that
 449                          * there are no stray characters after the closing bracket. */
 450                         char *e = strchr(s, ']');
 451                         if (!e   /* Missing right bracket? */
 452                          || e[1] /* Trailing characters? */
 453                          || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
 454                         ) {
 455                                 errmsg = "section header";
 456                                 goto pe_label;
 457                         }
 458                         /* Right now we only have one section so just check it.
 459                          * If more sections are added in the future, please don't
 460                          * resort to cascading ifs with multiple strcasecmp calls.
 461                          * That kind of bloated code is all too common.  A loop
 462                          * and a string table would be a better choice unless the
 463                          * number of sections is very small. */
 464                         if (strcasecmp(s, "SUID") == 0) {
 465                                 section = 1;
 466                                 continue;
 467                         }
 468                         section = -1;   /* Unknown section so set to skip. */
 469                         continue;
 470                 }
 471
 472                 /* Process sections. */
 473
 474                 if (section == 1) {             /* SUID */
 475                         /* Since we trimmed leading and trailing space above, we're
 476                          * now looking for strings of the form
 477                          *    <key>[::space::]*=[::space::]*<value>
 478                          * where both key and value could contain inner whitespace. */
 479
 480                         /* First get the key (an applet name in our case). */
 481                         char *e = strchr(s, '=');
 482                         if (e) {
 483                                 s = get_trimmed_slice(s, e);
 484                         }
 485                         if (!e || !*s) {        /* Missing '=' or empty key. */
 486                                 errmsg = "keyword";
 487                                 goto pe_label;
 488                         }
 489
 490                         /* Ok, we have an applet name.  Process the rhs if this
 491                          * applet is currently built in and ignore it otherwise.
 492                          * Note: this can hide config file bugs which only pop
 493                          * up when the busybox configuration is changed. */
 494                         applet_no = find_applet_by_name(s);
 495                         if (applet_no >= 0) {
 496                                 unsigned i;
 497                                 struct suid_config_t *sct;
 498
 499                                 /* Note: We currently don't check for duplicates!
 500                                  * The last config line for each applet will be the
 501                                  * one used since we insert at the head of the list.
 502                                  * I suppose this could be considered a feature. */
 503                                 sct = xzalloc(sizeof(*sct));
 504                                 sct->m_applet = applet_no;
 505                                 /*sct->m_mode = 0;*/
 506                                 sct->m_next = sct_head;
 507                                 sct_head = sct;
 508
 509                                 /* Get the specified mode. */
 510
 511                                 e = skip_whitespace(e+1);
 512
 513                                 for (i = 0; i < 3; i++) {
 514                                         /* There are 4 chars for each of user/group/other.
 515                                          * "x-xx" instead of "x-" are to make
 516                                          * "idx > 3" check catch invalid chars.
 517                                          */
 518                                         static const char mode_chars[] ALIGN1 = "Ssx-" "Ssx-" "x-xx";
 519                                         static const unsigned short mode_mask[] ALIGN2 = {
 520                                                 S_ISUID, S_ISUID|S_IXUSR, S_IXUSR, 0, /* Ssx- */
 521                                                 S_ISGID, S_ISGID|S_IXGRP, S_IXGRP, 0, /* Ssx- */
 522                                                                           S_IXOTH, 0  /*   x- */
 523                                         };
 524                                         const char *q = strchrnul(mode_chars + 4*i, *e);
 525                                         unsigned idx = q - (mode_chars + 4*i);
 526                                         if (idx > 3) {
 527                                                 errmsg = "mode";
 528                                                 goto pe_label;
 529                                         }
 530                                         sct->m_mode |= mode_mask[q - mode_chars];
 531                                         e++;
 532                                 }
 533
 534                                 /* Now get the user/group info. */
 535
 536                                 s = skip_whitespace(e);
 537                                 /* Default is 0.0, else parse USER.GROUP: */
 538                                 if (*s) {
 539                                         /* We require whitespace between mode and USER.GROUP */
 540                                         if ((s == e) || !(e = strchr(s, '.'))) {
 541                                                 errmsg = "uid.gid";
 542                                                 goto pe_label;
 543                                         }
 544                                         *e = ':'; /* get_uidgid needs USER:GROUP syntax */
 545                                         if (get_uidgid(&sct->m_ugid, s) == 0) {
 546                                                 errmsg = "unknown user/group";
 547                                                 goto pe_label;
 548                                         }
 549                                 }
 550                         }
 551                         continue;
 552                 }
 553
 554                 /* Unknown sections are ignored. */
 555
 556                 /* Encountering configuration lines prior to seeing a
 557                  * section header is treated as an error.  This is how
 558                  * the old code worked, but it may not be desirable.
 559                  * We may want to simply ignore such lines in case they
 560                  * are used in some future version of busybox. */
 561                 if (!section) {
 562                         errmsg = "keyword outside section";
 563                         goto pe_label;
 564                 }
 565         } /* while (1) */
 566
 567  pe_label:
 568         fclose(f);
 569         bb_error_msg("parse error in %s, line %u: %s", config_file, lc, errmsg);
 570
 571         /* Release any allocated memory before returning. */
 572         llist_free((llist_t*)sct_head, NULL);
 573 }
 574 # else
 575 static inline void parse_config_file(void)
 576 {
 577         IF_FEATURE_SUID(ruid = getuid();)
 578 }
 579 # endif /* FEATURE_SUID_CONFIG */
 580
 581
 582 # if ENABLE_FEATURE_SUID && NUM_APPLETS > 0
 583 #  if ENABLE_FEATURE_SUID_CONFIG
 584 /* check if u is member of group g */
 585 static int ingroup(uid_t u, gid_t g)
 586 {
 587         struct group *grp = getgrgid(g);
 588         if (grp) {
 589                 char **mem;
 590                 for (mem = grp->gr_mem; *mem; mem++) {
 591                         struct passwd *pwd = getpwnam(*mem);
 592                         if (pwd && (pwd->pw_uid == u))
 593                                 return 1;
 594                 }
 595         }
 596         return 0;
 597 }
 598 #  endif
 599
 600 static void check_suid(int applet_no)
 601 {
 602         gid_t rgid;  /* real gid */
 603
 604         if (ruid == 0) /* set by parse_config_file() */
 605                 return; /* run by root - no need to check more */
 606         rgid = getgid();
 607
 608 #  if ENABLE_FEATURE_SUID_CONFIG
 609         if (suid_cfg_readable) {
 610                 uid_t uid;
 611                 struct suid_config_t *sct;
 612                 mode_t m;
 613
 614                 for (sct = suid_config; sct; sct = sct->m_next) {
 615                         if (sct->m_applet == applet_no)
 616                                 goto found;
 617                 }
 618                 goto check_need_suid;
 619  found:
 620                 /* Is this user allowed to run this applet? */
 621                 m = sct->m_mode;
 622                 if (sct->m_ugid.uid == ruid)
 623                         /* same uid */
 624                         m >>= 6;
 625                 else if ((sct->m_ugid.gid == rgid) || ingroup(ruid, sct->m_ugid.gid))
 626                         /* same group / in group */
 627                         m >>= 3;
 628                 if (!(m & S_IXOTH)) /* is x bit not set? */
 629                         bb_error_msg_and_die("you have no permission to run this applet");
 630
 631                 /* We set effective AND saved ids. If saved-id is not set
 632                  * like we do below, seteuid(0) can still later succeed! */
 633
 634                 /* Are we directed to change gid
 635                  * (APPLET = *s* USER.GROUP or APPLET = *S* USER.GROUP)?
 636                  */
 637                 if (sct->m_mode & S_ISGID)
 638                         rgid = sct->m_ugid.gid;
 639                 /* else: we will set egid = rgid, thus dropping sgid effect */
 640                 if (setresgid(-1, rgid, rgid))
 641                         bb_perror_msg_and_die("setresgid");
 642
 643                 /* Are we directed to change uid
 644                  * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
 645                  */
 646                 uid = ruid;
 647                 if (sct->m_mode & S_ISUID)
 648                         uid = sct->m_ugid.uid;
 649                 /* else: we will set euid = ruid, thus dropping suid effect */
 650                 if (setresuid(-1, uid, uid))
 651                         bb_perror_msg_and_die("setresuid");
 652
 653                 goto ret;
 654         }
 655 #   if !ENABLE_FEATURE_SUID_CONFIG_QUIET
 656         {
 657                 static bool onetime = 0;
 658
 659                 if (!onetime) {
 660                         onetime = 1;
 661                         bb_error_msg("using fallback suid method");
 662                 }
 663         }
 664 #   endif
 665  check_need_suid:
 666 #  endif
 667         if (APPLET_SUID(applet_no) == BB_SUID_REQUIRE) {
 668                 /* Real uid is not 0. If euid isn't 0 too, suid bit
 669                  * is most probably not set on our executable */
 670                 if (geteuid())
 671                         bb_error_msg_and_die("must be suid to work properly");
 672         } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
 673                 xsetgid(rgid);  /* drop all privileges */
 674                 xsetuid(ruid);
 675         }
 676 #  if ENABLE_FEATURE_SUID_CONFIG
 677  ret: ;
 678         llist_free((llist_t*)suid_config, NULL);
 679 #  endif
 680 }
 681 # else
 682 #  define check_suid(x) ((void)0)
 683 # endif /* FEATURE_SUID */
 684
 685
 686 # if ENABLE_FEATURE_INSTALLER
 687 static const char usr_bin [] ALIGN1 = "/usr/bin/";
 688 static const char usr_sbin[] ALIGN1 = "/usr/sbin/";
 689 static const char *const install_dir[] = {
 690         &usr_bin [8], /* "/" */
 691         &usr_bin [4], /* "/bin/" */
 692         &usr_sbin[4]  /* "/sbin/" */
 693 #  if !ENABLE_INSTALL_NO_USR
 694         ,usr_bin
 695         ,usr_sbin
 696 #  endif
 697 };
 698
 699 /* create (sym)links for each applet */
 700 static void install_links(const char *busybox, int use_symbolic_links,
 701                 char *custom_install_dir)
 702 {
 703         /* directory table
 704          * this should be consistent w/ the enum,
 705          * busybox.h::bb_install_loc_t, or else... */
 706         int (*lf)(const char *, const char *);
 707         char *fpc;
 708         const char *appname = applet_names;
 709         unsigned i;
 710         int rc;
 711
 712         lf = link;
 713         if (use_symbolic_links)
 714                 lf = symlink;
 715
 716         for (i = 0; i < ARRAY_SIZE(applet_main); i++) {
 717                 fpc = concat_path_file(
 718                                 custom_install_dir ? custom_install_dir : install_dir[APPLET_INSTALL_LOC(i)],
 719                                 appname);
 720                 // debug: bb_error_msg("%slinking %s to busybox",
 721                 //              use_symbolic_links ? "sym" : "", fpc);
 722                 rc = lf(busybox, fpc);
 723                 if (rc != 0 && errno != EEXIST) {
 724                         bb_simple_perror_msg(fpc);
 725                 }
 726                 free(fpc);
 727                 while (*appname++ != '\0')
 728                         continue;
 729         }
 730 }
 731 # elif ENABLE_BUSYBOX
 732 static void install_links(const char *busybox UNUSED_PARAM,
 733                 int use_symbolic_links UNUSED_PARAM,
 734                 char *custom_install_dir UNUSED_PARAM)
 735 {
 736 }
 737 # endif
 738
 739 # if ENABLE_BUSYBOX
 740 static void run_applet_and_exit(const char *name, char **argv) NORETURN;
 741
 742 /* If we were called as "busybox..." */
 743 static int busybox_main(char **argv)
 744 {
 745         if (!argv[1]) {
 746                 /* Called without arguments */
 747                 const char *a;
 748                 int col;
 749                 unsigned output_width;
 750  help:
 751                 output_width = 80;
 752                 if (ENABLE_FEATURE_AUTOWIDTH) {
 753                         /* Obtain the terminal width */
 754                         output_width = get_terminal_width(2);
 755                 }
 756
 757                 dup2(1, 2);
 758                 full_write2_str(bb_banner); /* reuse const string */
 759                 full_write2_str(" multi-call binary.\n"); /* reuse */
 760                 full_write2_str(
 761                         "BusyBox is copyrighted by many authors between 1998-2015.\n"
 762                         "Licensed under GPLv2. See source distribution for detailed\n"
 763                         "copyright notices.\n"
 764                         "\n"
 765                         "Usage: busybox [function [arguments]...]\n"
 766                         "   or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
 767                         IF_FEATURE_INSTALLER(
 768                         "   or: busybox --install [-s] [DIR]\n"
 769                         )
 770                         "   or: function [arguments]...\n"
 771                         "\n"
 772                         IF_NOT_FEATURE_SH_STANDALONE(
 773                         "\tBusyBox is a multi-call binary that combines many common Unix\n"
 774                         "\tutilities into a single executable.  Most people will create a\n"
 775                         "\tlink to busybox for each function they wish to use and BusyBox\n"
 776                         "\twill act like whatever it was invoked as.\n"
 777                         )
 778                         IF_FEATURE_SH_STANDALONE(
 779                         "\tBusyBox is a multi-call binary that combines many common Unix\n"
 780                         "\tutilities into a single executable.  The shell in this build\n"
 781                         "\tis configured to run built-in utilities without $PATH search.\n"
 782                         "\tYou don't need to install a link to busybox for each utility.\n"
 783                         "\tTo run external program, use full path (/sbin/ip instead of ip).\n"
 784                         )
 785                         "\n"
 786                         "Currently defined functions:\n"
 787                 );
 788                 col = 0;
 789                 a = applet_names;
 790                 /* prevent last comma to be in the very last pos */
 791                 output_width--;
 792                 while (*a) {
 793                         int len2 = strlen(a) + 2;
 794                         if (col >= (int)output_width - len2) {
 795                                 full_write2_str(",\n");
 796                                 col = 0;
 797                         }
 798                         if (col == 0) {
 799                                 col = 6;
 800                                 full_write2_str("\t");
 801                         } else {
 802                                 full_write2_str(", ");
 803                         }
 804                         full_write2_str(a);
 805                         col += len2;
 806                         a += len2 - 1;
 807                 }
 808                 full_write2_str("\n");
 809                 return 0;
 810         }
 811
 812         if (is_prefixed_with(argv[1], "--list")) {
 813                 unsigned i = 0;
 814                 const char *a = applet_names;
 815                 dup2(1, 2);
 816                 while (*a) {
 817 #  if ENABLE_FEATURE_INSTALLER
 818                         if (argv[1][6]) /* --list-full? */
 819                                 full_write2_str(install_dir[APPLET_INSTALL_LOC(i)] + 1);
 820 #  endif
 821                         full_write2_str(a);
 822                         full_write2_str("\n");
 823                         i++;
 824                         while (*a++ != '\0')
 825                                 continue;
 826                 }
 827                 return 0;
 828         }
 829
 830         if (ENABLE_FEATURE_INSTALLER && strcmp(argv[1], "--install") == 0) {
 831                 int use_symbolic_links;
 832                 const char *busybox;
 833
 834                 busybox = xmalloc_readlink(bb_busybox_exec_path);
 835                 if (!busybox) {
 836                         /* bb_busybox_exec_path is usually "/proc/self/exe".
 837                          * In chroot, readlink("/proc/self/exe") usually fails.
 838                          * In such case, better use argv[0] as symlink target
 839                          * if it is a full path name.
 840                          */
 841                         if (argv[0][0] != '/')
 842                                 bb_error_msg_and_die("'%s' is not an absolute path", argv[0]);
 843                         busybox = argv[0];
 844                 }
 845                 /* busybox --install [-s] [DIR]:
 846                  * -s: make symlinks
 847                  * DIR: directory to install links to
 848                  */
 849                 use_symbolic_links = (argv[2] && strcmp(argv[2], "-s") == 0 && ++argv);
 850                 install_links(busybox, use_symbolic_links, argv[2]);
 851                 return 0;
 852         }
 853
 854         if (strcmp(argv[1], "--help") == 0) {
 855                 /* "busybox --help [<applet>]" */
 856                 if (!argv[2])
 857                         goto help;
 858                 /* convert to "<applet> --help" */
 859                 argv[0] = argv[2];
 860                 argv[2] = NULL;
 861         } else {
 862                 /* "busybox <applet> arg1 arg2 ..." */
 863                 argv++;
 864         }
 865         /* We support "busybox /a/path/to/applet args..." too. Allows for
 866          * "#!/bin/busybox"-style wrappers */
 867         applet_name = bb_get_last_path_component_nostrip(argv[0]);
 868         run_applet_and_exit(applet_name, argv);
 869 }
 870 # endif
 871
 872 # if NUM_APPLETS > 0
 873 void FAST_FUNC run_applet_no_and_exit(int applet_no, char **argv)
 874 {
 875         int argc = 1;
 876
 877         while (argv[argc])
 878                 argc++;
 879
 880         /* Reinit some shared global data */
 881         xfunc_error_retval = EXIT_FAILURE;
 882         applet_name = bb_get_last_path_component_nostrip(argv[0]);
 883
 884         /* Special case. POSIX says "test --help"
 885          * should be no different from e.g. "test --foo".
 886          * Thus for "test", we skip --help check.
 887          * "true" and "false" are also special.
 888          */
 889         if (1
 890 #  if defined APPLET_NO_test
 891          && applet_no != APPLET_NO_test
 892 #  endif
 893 #  if defined APPLET_NO_true
 894          && applet_no != APPLET_NO_true
 895 #  endif
 896 #  if defined APPLET_NO_false
 897          && applet_no != APPLET_NO_false
 898 #  endif
 899         ) {
 900                 if (argc == 2 && strcmp(argv[1], "--help") == 0) {
 901                         /* Make "foo --help" exit with 0: */
 902                         xfunc_error_retval = 0;
 903                         bb_show_usage();
 904                 }
 905         }
 906         if (ENABLE_FEATURE_SUID)
 907                 check_suid(applet_no);
 908         xfunc_error_retval = applet_main[applet_no](argc, argv);
 909         /* Note: applet_main() may also not return (die on a xfunc or such) */
 910         xfunc_die();
 911 }
 912 # endif /* NUM_APPLETS > 0 */
 913
 914 # if ENABLE_BUSYBOX || NUM_APPLETS > 0
 915 static NORETURN void run_applet_and_exit(const char *name, char **argv)
 916 {
 917 #  if ENABLE_BUSYBOX
 918         if (is_prefixed_with(name, "busybox"))
 919                 exit(busybox_main(argv));
 920 #  endif
 921 #  if NUM_APPLETS > 0
 922         /* find_applet_by_name() search is more expensive, so goes second */
 923         {
 924                 int applet = find_applet_by_name(name);
 925                 if (applet >= 0)
 926                         run_applet_no_and_exit(applet, argv);
 927         }
 928 #  endif
 929
 930         /*bb_error_msg_and_die("applet not found"); - links in printf */
 931         full_write2_str(applet_name);
 932         full_write2_str(": applet not found\n");
 933         /* POSIX: "If a command is not found, the exit status shall be 127" */
 934         exit(127);
 935 }
 936 # endif
 937
 938 #endif /* !defined(SINGLE_APPLET_MAIN) */
 939
 940
 941 #if ENABLE_BUILD_LIBBUSYBOX
 942 int lbb_main(char **argv)
 943 #else
 944 int main(int argc UNUSED_PARAM, char **argv)
 945 #endif
 946 {
 947 #if 0
 948         /* TODO: find a use for a block of memory between end of .bss
 949          * and end of page. For example, I'm getting "_end:0x812e698 2408 bytes"
 950          * - more than 2k of wasted memory (in this particular build)
 951          * *per each running process*!
 952          * (If your linker does not generate "_end" name, weak attribute
 953          * makes &_end == NULL, end_len == 0 here.)
 954          */
 955         extern char _end[] __attribute__((weak));
 956         unsigned end_len = (-(int)_end) & 0xfff;
 957         printf("_end:%p %u bytes\n", &_end, end_len);
 958 #endif
 959
 960         /* Tweak malloc for reduced memory consumption */
 961 #ifdef M_TRIM_THRESHOLD
 962         /* M_TRIM_THRESHOLD is the maximum amount of freed top-most memory
 963          * to keep before releasing to the OS
 964          * Default is way too big: 256k
 965          */
 966         mallopt(M_TRIM_THRESHOLD, 8 * 1024);
 967 #endif
 968 #ifdef M_MMAP_THRESHOLD
 969         /* M_MMAP_THRESHOLD is the request size threshold for using mmap()
 970          * Default is too big: 256k
 971          */
 972         mallopt(M_MMAP_THRESHOLD, 32 * 1024 - 256);
 973 #endif
 974 #if 0 /*def M_TOP_PAD*/
 975         /* When the program break is increased, then M_TOP_PAD bytes are added
 976          * to the sbrk(2) request. When the heap is trimmed because of free(3),
 977          * this much free space is preserved at the top of the heap.
 978          * glibc default seems to be way too big: 128k, but need to verify.
 979          */
 980         mallopt(M_TOP_PAD, 8 * 1024);
 981 #endif
 982
 983 #if !BB_MMU
 984         /* NOMMU re-exec trick sets high-order bit in first byte of name */
 985         if (argv[0][0] & 0x80) {
 986                 re_execed = 1;
 987                 argv[0][0] &= 0x7f;
 988         }
 989 #endif
 990
 991 #if defined(SINGLE_APPLET_MAIN)
 992
 993         /* Only one applet is selected in .config */
 994         if (argv[1] && is_prefixed_with(argv[0], "busybox")) {
 995                 /* "busybox <applet> <params>" should still work as expected */
 996                 argv++;
 997         }
 998         /* applet_names in this case is just "applet\0\0" */
 999         lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
1000         return SINGLE_APPLET_MAIN(argc, argv);
1001
1002 #elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
1003
1004         full_write2_str(bb_basename(argv[0]));
1005         full_write2_str(": no applets enabled\n");
1006         exit(127);
1007
1008 #else
1009
1010         lbb_prepare("busybox" IF_FEATURE_INDIVIDUAL(, argv));
1011 # if !ENABLE_BUSYBOX
1012         if (argv[1] && is_prefixed_with(bb_basename(argv[0]), "busybox"))
1013                 argv++;
1014 # endif
1015         applet_name = argv[0];
1016         if (applet_name[0] == '-')
1017                 applet_name++;
1018         applet_name = bb_basename(applet_name);
1019         parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
1020         run_applet_and_exit(applet_name, argv);
1021
1022 #endif
1023 }