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