applets/applets.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 the GPL.
  11  *
  12  * Licensed under GPLv2 or later, see file License in this tarball for details.
  13  */
  14
  15 #include "busybox.h"
  16 #include <unistd.h>
  17 #include <string.h>
  18 #include <assert.h>
  19
  20 #if ENABLE_STATIC && __GLIBC__
  21 #warning Static linking against glibc produces buggy executables
  22 #warning (glibc doesn't cope well with ld --gc-sections).
  23 #warning See http://sources.redhat.com/bugzilla/show_bug.cgi?id=3400
  24 #warning Note that glibc is utterly unsuitable for static linking anyway.
  25 #endif
  26
  27 #if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
  28 static const char usage_messages[] =
  29 #define MAKE_USAGE
  30 #include "usage.h"
  31 #include "applets.h"
  32 ;
  33 #undef MAKE_USAGE
  34 #else
  35 #define usage_messages 0
  36 #endif /* ENABLE_SHOW_USAGE */
  37
  38 #undef APPLET
  39 #undef APPLET_NOUSAGE
  40 #undef PROTOTYPES
  41 #include "applets.h"
  42
  43 static struct BB_applet *applet_using;
  44
  45 /* The -1 arises because of the {0,NULL,0,-1} entry above. */
  46 const size_t NUM_APPLETS = (sizeof (applets) / sizeof (struct BB_applet) - 1);
  47
  48
  49 #ifdef CONFIG_FEATURE_SUID_CONFIG
  50
  51 #include <ctype.h>
  52
  53 #define CONFIG_FILE "/etc/busybox.conf"
  54
  55 /* applets [] is const, so we have to define this "override" structure */
  56 static struct BB_suid_config
  57 {
  58         struct BB_applet *m_applet;
  59
  60         uid_t m_uid;
  61         gid_t m_gid;
  62         mode_t m_mode;
  63
  64         struct BB_suid_config *m_next;
  65 } *suid_config;
  66
  67 static int suid_cfg_readable;
  68
  69 /* check if u is member of group g */
  70 static int ingroup(uid_t u, gid_t g)
  71 {
  72         struct group *grp = getgrgid(g);
  73
  74         if (grp) {
  75                 char **mem;
  76
  77                 for (mem = grp->gr_mem; *mem; mem++) {
  78                         struct passwd *pwd = getpwnam(*mem);
  79
  80                         if (pwd && (pwd->pw_uid == u))
  81                                 return 1;
  82                 }
  83         }
  84         return 0;
  85 }
  86
  87 /* This should probably be a libbb routine.  In that case,
  88  * I'd probably rename it to something like bb_trimmed_slice.
  89  */
  90 static char *get_trimmed_slice(char *s, char *e)
  91 {
  92         /* First, consider the value at e to be nul and back up until we
  93          * reach a non-space char.  Set the char after that (possibly at
  94          * the original e) to nul. */
  95         while (e-- > s) {
  96                 if (!isspace(*e)) {
  97                         break;
  98                 }
  99         }
 100         e[1] = 0;
 101
 102         /* Next, advance past all leading space and return a ptr to the
 103          * first non-space char; possibly the terminating nul. */
 104         return skip_whitespace(s);
 105 }
 106
 107
 108 #define parse_error(x)  { err=x; goto pe_label; }
 109
 110 /* Don't depend on the tools to combine strings. */
 111 static const char config_file[] = CONFIG_FILE;
 112
 113 /* There are 4 chars + 1 nul for each of user/group/other. */
 114 static const char mode_chars[] = "Ssx-\0Ssx-\0Ttx-";
 115
 116 /* We don't supply a value for the nul, so an index adjustment is
 117  * necessary below.  Also, we use unsigned short here to save some
 118  * space even though these are really mode_t values. */
 119 static const unsigned short mode_mask[] = {
 120         /*  SST         sst                 xxx   --- */
 121         S_ISUID,    S_ISUID|S_IXUSR,    S_IXUSR,    0,  /* user */
 122         S_ISGID,    S_ISGID|S_IXGRP,    S_IXGRP,    0,  /* group */
 123         0,          S_IXOTH,            S_IXOTH,    0   /* other */
 124 };
 125
 126 static void parse_config_file(void)
 127 {
 128         struct BB_suid_config *sct_head;
 129         struct BB_suid_config *sct;
 130         struct BB_applet *applet;
 131         FILE *f;
 132         char *err;
 133         char *s;
 134         char *e;
 135         int i, lc, section;
 136         char buffer[256];
 137         struct stat st;
 138
 139         assert(!suid_config);           /* Should be set to NULL by bss init. */
 140
 141         if ((stat(config_file, &st) != 0)                       /* No config file? */
 142                 || !S_ISREG(st.st_mode)                                 /* Not a regular file? */
 143                 || (st.st_uid != 0)                                             /* Not owned by root? */
 144                 || (st.st_mode & (S_IWGRP | S_IWOTH))   /* Writable by non-root? */
 145                 || !(f = fopen(config_file, "r"))               /* Cannot open? */
 146                 ) {
 147                 return;
 148         }
 149
 150         suid_cfg_readable = 1;
 151         sct_head = NULL;
 152         section = lc = 0;
 153
 154         do {
 155                 s = buffer;
 156
 157                 if (!fgets(s, sizeof(buffer), f)) { /* Are we done? */
 158                         if (ferror(f)) {   /* Make sure it wasn't a read error. */
 159                                 parse_error("reading");
 160                         }
 161                         fclose(f);
 162                         suid_config = sct_head; /* Success, so set the pointer. */
 163                         return;
 164                 }
 165
 166                 lc++;                                   /* Got a (partial) line. */
 167
 168                 /* If a line is too long for our buffer, we consider it an error.
 169                  * The following test does mistreat one corner case though.
 170                  * If the final line of the file does not end with a newline and
 171                  * yet exactly fills the buffer, it will be treated as too long
 172                  * even though there isn't really a problem.  But it isn't really
 173                  * worth adding code to deal with such an unlikely situation, and
 174                  * we do err on the side of caution.  Besides, the line would be
 175                  * too long if it did end with a newline. */
 176                 if (!strchr(s, '\n') && !feof(f)) {
 177                         parse_error("line too long");
 178                 }
 179
 180                 /* Trim leading and trailing whitespace, ignoring comments, and
 181                  * check if the resulting string is empty. */
 182                 if (!*(s = get_trimmed_slice(s, strchrnul(s, '#')))) {
 183                         continue;
 184                 }
 185
 186                 /* Check for a section header. */
 187
 188                 if (*s == '[') {
 189                         /* Unlike the old code, we ignore leading and trailing
 190                          * whitespace for the section name.  We also require that
 191                          * there are no stray characters after the closing bracket. */
 192                         if (!(e = strchr(s, ']'))       /* Missing right bracket? */
 193                                 || e[1]                                 /* Trailing characters? */
 194                                 || !*(s = get_trimmed_slice(s+1, e)) /* Missing name? */
 195                                 ) {
 196                                 parse_error("section header");
 197                         }
 198                         /* Right now we only have one section so just check it.
 199                          * If more sections are added in the future, please don't
 200                          * resort to cascading ifs with multiple strcasecmp calls.
 201                          * That kind of bloated code is all too common.  A loop
 202                          * and a string table would be a better choice unless the
 203                          * number of sections is very small. */
 204                         if (strcasecmp(s, "SUID") == 0) {
 205                                 section = 1;
 206                                 continue;
 207                         }
 208                         section = -1;   /* Unknown section so set to skip. */
 209                         continue;
 210                 }
 211
 212                 /* Process sections. */
 213
 214                 if (section == 1) {             /* SUID */
 215                         /* Since we trimmed leading and trailing space above, we're
 216                          * now looking for strings of the form
 217                          *    <key>[::space::]*=[::space::]*<value>
 218                          * where both key and value could contain inner whitespace. */
 219
 220                         /* First get the key (an applet name in our case). */
 221                         if (!!(e = strchr(s, '='))) {
 222                                 s = get_trimmed_slice(s, e);
 223                         }
 224                         if (!e || !*s) {        /* Missing '=' or empty key. */
 225                                 parse_error("keyword");
 226                         }
 227
 228                         /* Ok, we have an applet name.  Process the rhs if this
 229                          * applet is currently built in and ignore it otherwise.
 230                          * Note: This can hide config file bugs which only pop
 231                          * up when the busybox configuration is changed. */
 232                         if ((applet = find_applet_by_name(s))) {
 233                                 /* Note: We currently don't check for duplicates!
 234                                  * The last config line for each applet will be the
 235                                  * one used since we insert at the head of the list.
 236                                  * I suppose this could be considered a feature. */
 237                                 sct = xmalloc(sizeof(struct BB_suid_config));
 238                                 sct->m_applet = applet;
 239                                 sct->m_mode = 0;
 240                                 sct->m_next = sct_head;
 241                                 sct_head = sct;
 242
 243                                 /* Get the specified mode. */
 244
 245                                 e = skip_whitespace(e+1);
 246
 247                                 for (i=0 ; i < 3 ; i++) {
 248                                         const char *q;
 249                                         if (!*(q = strchrnul(mode_chars + 5*i, *e++))) {
 250                                                 parse_error("mode");
 251                                         }
 252                                         /* Adjust by -i to account for nul. */
 253                                         sct->m_mode |= mode_mask[(q - mode_chars) - i];
 254                                 }
 255
 256                                 /* Now get the the user/group info. */
 257
 258                                 s = skip_whitespace(e);
 259
 260                                 /* Note: We require whitespace between the mode and the
 261                                  * user/group info. */
 262                                 if ((s == e) || !(e = strchr(s, '.'))) {
 263                                         parse_error("<uid>.<gid>");
 264                                 }
 265                                 *e++ = 0;
 266
 267                                 /* We can't use get_ug_id here since it would exit()
 268                                  * if a uid or gid was not found.  Oh well... */
 269                                 {
 270                                         char *e2;
 271
 272                                         sct->m_uid = strtoul(s, &e2, 10);
 273                                         if (*e2 || (s == e2)) {
 274                                                 struct passwd *pwd = getpwnam(s);
 275                                                 if (!pwd) {
 276                                                         parse_error("user");
 277                                                 }
 278                                                 sct->m_uid = pwd->pw_uid;
 279                                         }
 280
 281                                         sct->m_gid = strtoul(e, &e2, 10);
 282                                         if (*e2 || (e == e2)) {
 283                                                 struct group *grp;
 284                                                 if (!(grp = getgrnam(e))) {
 285                                                         parse_error("group");
 286                                                 }
 287                                                 sct->m_gid = grp->gr_gid;
 288                                         }
 289                                 }
 290                         }
 291                         continue;
 292                 }
 293
 294                 /* Unknown sections are ignored. */
 295
 296                 /* Encountering configuration lines prior to seeing a
 297                  * section header is treated as an error.  This is how
 298                  * the old code worked, but it may not be desirable.
 299                  * We may want to simply ignore such lines in case they
 300                  * are used in some future version of busybox. */
 301                 if (!section) {
 302                         parse_error("keyword outside section");
 303                 }
 304
 305         } while (1);
 306
 307  pe_label:
 308         fprintf(stderr, "Parse error in %s, line %d: %s\n",
 309                         config_file, lc, err);
 310
 311         fclose(f);
 312         /* Release any allocated memory before returning. */
 313         while (sct_head) {
 314                 sct = sct_head->m_next;
 315                 free(sct_head);
 316                 sct_head = sct;
 317         }
 318         return;
 319 }
 320
 321 #else
 322 #define parse_config_file()
 323 #endif /* CONFIG_FEATURE_SUID_CONFIG */
 324
 325 #ifdef CONFIG_FEATURE_SUID
 326 static void check_suid(struct BB_applet *applet)
 327 {
 328         uid_t ruid = getuid();               /* real [ug]id */
 329         uid_t rgid = getgid();
 330
 331 #ifdef CONFIG_FEATURE_SUID_CONFIG
 332         if (suid_cfg_readable) {
 333                 struct BB_suid_config *sct;
 334
 335                 for (sct = suid_config; sct; sct = sct->m_next) {
 336                         if (sct->m_applet == applet)
 337                                 break;
 338                 }
 339                 if (sct) {
 340                         mode_t m = sct->m_mode;
 341
 342                         if (sct->m_uid == ruid)       /* same uid */
 343                                 m >>= 6;
 344                         else if ((sct->m_gid == rgid) || ingroup(ruid, sct->m_gid))  /* same group / in group */
 345                                 m >>= 3;
 346
 347                         if (!(m & S_IXOTH))           /* is x bit not set ? */
 348                                 bb_error_msg_and_die("you have no permission to run this applet!");
 349
 350                         if ((sct->m_mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP)) {     /* *both* have to be set for sgid */
 351                                 xsetgid(sct->m_gid);
 352                         } else xsetgid(rgid);                /* no sgid -> drop */
 353
 354                         if (sct->m_mode & S_ISUID) xsetuid(sct->m_uid);
 355                         else xsetuid(ruid);                  /* no suid -> drop */
 356                 } else {
 357                         /* default: drop all privileges */
 358                         xsetgid(rgid);
 359                         xsetuid(ruid);
 360                 }
 361                 return;
 362         } else {
 363 #ifndef CONFIG_FEATURE_SUID_CONFIG_QUIET
 364                 static int onetime = 0;
 365
 366                 if (!onetime) {
 367                         onetime = 1;
 368                         fprintf(stderr, "Using fallback suid method\n");
 369                 }
 370 #endif
 371         }
 372 #endif
 373
 374         if (applet->need_suid == _BB_SUID_ALWAYS) {
 375                 if (geteuid()) bb_error_msg_and_die("applet requires root privileges!");
 376         } else if (applet->need_suid == _BB_SUID_NEVER) {
 377                 xsetgid(rgid);                          /* drop all privileges */
 378                 xsetuid(ruid);
 379         }
 380 }
 381 #else
 382 #define check_suid(x)
 383 #endif /* CONFIG_FEATURE_SUID */
 384
 385
 386
 387 #ifdef CONFIG_FEATURE_COMPRESS_USAGE
 388
 389 #include "usage_compressed.h"
 390 #include "unarchive.h"
 391
 392 static const char *unpack_usage_messages(void)
 393 {
 394         int input[2], output[2], pid;
 395         char *buf;
 396
 397         if(pipe(input) < 0 || pipe(output) < 0)
 398                 exit(1);
 399
 400         pid = fork();
 401         switch (pid) {
 402         case -1: /* error */
 403                 exit(1);
 404         case 0: /* child */
 405                 close(input[1]);
 406                 close(output[0]);
 407                 uncompressStream(input[0], output[1]);
 408                 exit(0);
 409         }
 410         /* parent */
 411
 412         close(input[0]);
 413         close(output[1]);
 414         pid = fork();
 415         switch (pid) {
 416         case -1: /* error */
 417                 exit(1);
 418         case 0: /* child */
 419                 full_write(input[1], packed_usage, sizeof(packed_usage));
 420                 exit(0);
 421         }
 422         /* parent */
 423         close(input[1]);
 424
 425         buf = xmalloc(SIZEOF_usage_messages);
 426         full_read(output[0], buf, SIZEOF_usage_messages);
 427         return buf;
 428 }
 429
 430 #else
 431 #define unpack_usage_messages() usage_messages
 432 #endif /* ENABLE_FEATURE_COMPRESS_USAGE */
 433
 434 void bb_show_usage(void)
 435 {
 436         if (ENABLE_SHOW_USAGE) {
 437                 const char *format_string;
 438                 const char *usage_string = unpack_usage_messages();
 439                 int i;
 440
 441                 for (i = applet_using - applets; i > 0;)
 442                         if (!*usage_string++) --i;
 443
 444                 format_string = "%s\n\nUsage: %s %s\n\n";
 445                 if (*usage_string == '\b')
 446                         format_string = "%s\n\nNo help available.\n\n";
 447                 fprintf (stderr, format_string, bb_msg_full_version,
 448                         applet_using->name, usage_string);
 449         }
 450
 451         exit(xfunc_error_retval);
 452 }
 453
 454 static int applet_name_compare(const void *name, const void *vapplet)
 455 {
 456         const struct BB_applet *applet = vapplet;
 457
 458         return strcmp(name, applet->name);
 459 }
 460
 461 extern const size_t NUM_APPLETS;
 462
 463 struct BB_applet *find_applet_by_name(const char *name)
 464 {
 465         return bsearch(name, applets, NUM_APPLETS, sizeof(struct BB_applet),
 466                                 applet_name_compare);
 467 }
 468
 469 void run_applet_by_name(const char *name, int argc, char **argv)
 470 {
 471         if (ENABLE_FEATURE_SUID_CONFIG) parse_config_file();
 472
 473         if (!strncmp(name, "busybox", 7)) busybox_main(argc, argv);
 474         /* Do a binary search to find the applet entry given the name. */
 475         applet_using = find_applet_by_name(name);
 476         if (applet_using) {
 477                 applet_name = applet_using->name;
 478                 if(argc==2 && !strcmp(argv[1], "--help")) bb_show_usage();
 479                 if(ENABLE_FEATURE_SUID) check_suid(applet_using);
 480                 exit((*(applet_using->main))(argc, argv));
 481         }
 482 }