coreutils/test.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * test implementation for busybox
   4  *
   5  * Copyright (c) by a whole pile of folks:
   6  *
   7  *     test(1); version 7-like  --  author Erik Baalbergen
   8  *     modified by Eric Gisin to be used as built-in.
   9  *     modified by Arnold Robbins to add SVR3 compatibility
  10  *     (-x -c -b -p -u -g -k) plus Korn's -L -nt -ot -ef and new -S (socket).
  11  *     modified by J.T. Conklin for NetBSD.
  12  *     modified by Herbert Xu to be used as built-in in ash.
  13  *     modified by Erik Andersen <andersen@codepoet.org> to be used
  14  *     in busybox.
  15  *     modified by Bernhard Fischer to be useable (i.e. a bit less bloaty).
  16  *
  17  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
  18  *
  19  * Original copyright notice states:
  20  *     "This program is in the Public Domain."
  21  */
  22
  23 #include "libbb.h"
  24 #include <setjmp.h>
  25
  26 /* This is a NOEXEC applet. Be very careful! */
  27
  28
  29 /* test(1) accepts the following grammar:
  30         oexpr   ::= aexpr | aexpr "-o" oexpr ;
  31         aexpr   ::= nexpr | nexpr "-a" aexpr ;
  32         nexpr   ::= primary | "!" primary
  33         primary ::= unary-operator operand
  34                 | operand binary-operator operand
  35                 | operand
  36                 | "(" oexpr ")"
  37                 ;
  38         unary-operator ::= "-r"|"-w"|"-x"|"-f"|"-d"|"-c"|"-b"|"-p"|
  39                 "-u"|"-g"|"-k"|"-s"|"-t"|"-z"|"-n"|"-o"|"-O"|"-G"|"-L"|"-S";
  40
  41         binary-operator ::= "="|"=="|"!="|"-eq"|"-ne"|"-ge"|"-gt"|"-le"|"-lt"|
  42                         "-nt"|"-ot"|"-ef";
  43         operand ::= <any legal UNIX file name>
  44 */
  45
  46 enum token {
  47         EOI,
  48         FILRD,
  49         FILWR,
  50         FILEX,
  51         FILEXIST,
  52         FILREG,
  53         FILDIR,
  54         FILCDEV,
  55         FILBDEV,
  56         FILFIFO,
  57         FILSOCK,
  58         FILSYM,
  59         FILGZ,
  60         FILTT,
  61         FILSUID,
  62         FILSGID,
  63         FILSTCK,
  64         FILNT,
  65         FILOT,
  66         FILEQ,
  67         FILUID,
  68         FILGID,
  69         STREZ,
  70         STRNZ,
  71         STREQ,
  72         STRNE,
  73         STRLT,
  74         STRGT,
  75         INTEQ,
  76         INTNE,
  77         INTGE,
  78         INTGT,
  79         INTLE,
  80         INTLT,
  81         UNOT,
  82         BAND,
  83         BOR,
  84         LPAREN,
  85         RPAREN,
  86         OPERAND
  87 };
  88 #define is_int_op(a) (((unsigned char)((a) - INTEQ)) <= 5)
  89 #define is_str_op(a) (((unsigned char)((a) - STREZ)) <= 5)
  90 #define is_file_op(a) (((unsigned char)((a) - FILNT)) <= 2)
  91 #define is_file_access(a) (((unsigned char)((a) - FILRD)) <= 2)
  92 #define is_file_type(a) (((unsigned char)((a) - FILREG)) <= 5)
  93 #define is_file_bit(a) (((unsigned char)((a) - FILSUID)) <= 2)
  94 enum token_types {
  95         UNOP,
  96         BINOP,
  97         BUNOP,
  98         BBINOP,
  99         PAREN
 100 };
 101
 102 static const struct t_op {
 103         char op_text[4];
 104         unsigned char op_num, op_type;
 105 } ops[] = {
 106         { "-r", FILRD   , UNOP   },
 107         { "-w", FILWR   , UNOP   },
 108         { "-x", FILEX   , UNOP   },
 109         { "-e", FILEXIST, UNOP   },
 110         { "-f", FILREG  , UNOP   },
 111         { "-d", FILDIR  , UNOP   },
 112         { "-c", FILCDEV , UNOP   },
 113         { "-b", FILBDEV , UNOP   },
 114         { "-p", FILFIFO , UNOP   },
 115         { "-u", FILSUID , UNOP   },
 116         { "-g", FILSGID , UNOP   },
 117         { "-k", FILSTCK , UNOP   },
 118         { "-s", FILGZ   , UNOP   },
 119         { "-t", FILTT   , UNOP   },
 120         { "-z", STREZ   , UNOP   },
 121         { "-n", STRNZ   , UNOP   },
 122         { "-h", FILSYM  , UNOP   },    /* for backwards compat */
 123
 124         { "-O" , FILUID , UNOP   },
 125         { "-G" , FILGID , UNOP   },
 126         { "-L" , FILSYM , UNOP   },
 127         { "-S" , FILSOCK, UNOP   },
 128         { "="  , STREQ  , BINOP  },
 129         { "==" , STREQ  , BINOP  },
 130         { "!=" , STRNE  , BINOP  },
 131         { "<"  , STRLT  , BINOP  },
 132         { ">"  , STRGT  , BINOP  },
 133         { "-eq", INTEQ  , BINOP  },
 134         { "-ne", INTNE  , BINOP  },
 135         { "-ge", INTGE  , BINOP  },
 136         { "-gt", INTGT  , BINOP  },
 137         { "-le", INTLE  , BINOP  },
 138         { "-lt", INTLT  , BINOP  },
 139         { "-nt", FILNT  , BINOP  },
 140         { "-ot", FILOT  , BINOP  },
 141         { "-ef", FILEQ  , BINOP  },
 142         { "!"  , UNOT   , BUNOP  },
 143         { "-a" , BAND   , BBINOP },
 144         { "-o" , BOR    , BBINOP },
 145         { "("  , LPAREN , PAREN  },
 146         { ")"  , RPAREN , PAREN  },
 147 };
 148
 149
 150 #if ENABLE_FEATURE_TEST_64
 151 typedef int64_t arith_t;
 152 #else
 153 typedef int arith_t;
 154 #endif
 155
 156 /* Cannot eliminate these static data (do the G trick)
 157  * because of test_main usage from other applets */
 158 static char **t_wp;
 159 static struct t_op const *t_wp_op;
 160 static gid_t *group_array;
 161 static int ngroups;
 162 static jmp_buf leaving;
 163
 164 static enum token t_lex(char *s);
 165 static arith_t oexpr(enum token n);
 166 static arith_t aexpr(enum token n);
 167 static arith_t nexpr(enum token n);
 168 static int binop(void);
 169 static arith_t primary(enum token n);
 170 static int filstat(char *nm, enum token mode);
 171 static arith_t getn(const char *s);
 172 /* UNUSED
 173 static int newerf(const char *f1, const char *f2);
 174 static int olderf(const char *f1, const char *f2);
 175 static int equalf(const char *f1, const char *f2);
 176 */
 177 static int test_eaccess(char *path, int mode);
 178 static int is_a_group_member(gid_t gid);
 179 static void initialize_group_array(void);
 180
 181 int test_main(int argc, char **argv)
 182 {
 183         int res;
 184         char *arg0;
 185         bool _off;
 186
 187         arg0 = strrchr(argv[0], '/');
 188         if (!arg0++) arg0 = argv[0];
 189         if (arg0[0] == '[') {
 190                 --argc;
 191                 if (!arg0[1]) { /* "[" ? */
 192                         if (NOT_LONE_CHAR(argv[argc], ']')) {
 193                                 bb_error_msg("missing ]");
 194                                 return 2;
 195                         }
 196                 } else { /* assuming "[[" */
 197                         if (strcmp(argv[argc], "]]") != 0) {
 198                                 bb_error_msg("missing ]]");
 199                                 return 2;
 200                         }
 201                 }
 202                 argv[argc] = NULL;
 203         }
 204
 205         res = setjmp(leaving);
 206         if (res)
 207                 return res;
 208
 209         /* resetting ngroups is probably unnecessary.  it will
 210          * force a new call to getgroups(), which prevents using
 211          * group data fetched during a previous call.  but the
 212          * only way the group data could be stale is if there's
 213          * been an intervening call to setgroups(), and this
 214          * isn't likely in the case of a shell.  paranoia
 215          * prevails...
 216          */
 217         ngroups = 0;
 218
 219         /* Implement special cases from POSIX.2, section 4.62.4 */
 220         if (argc == 1)
 221                 return 1;
 222         if (argc == 2)
 223                 return *argv[1] == '\0';
 224 //assert(argc);
 225         /* remember if we saw argc==4 which wants *no* '!' test */
 226         _off = argc - 4;
 227         if (_off ?
 228                 (LONE_CHAR(argv[1], '!'))
 229                 : (argv[1][0] != '!' || argv[1][1] != '\0'))
 230         {
 231                 if (argc == 3)
 232                         return *argv[2] != '\0';
 233
 234                 t_lex(argv[2 + _off]);
 235                 if (t_wp_op && t_wp_op->op_type == BINOP) {
 236                         t_wp = &argv[1 + _off];
 237                         return binop() == _off;
 238                 }
 239         }
 240         t_wp = &argv[1];
 241         res = !oexpr(t_lex(*t_wp));
 242
 243         if (*t_wp != NULL && *++t_wp != NULL) {
 244                 bb_error_msg("%s: unknown operand", *t_wp);
 245                 return 2;
 246         }
 247         return res;
 248 }
 249
 250 static void syntax(const char *op, const char *msg) ATTRIBUTE_NORETURN;
 251 static void syntax(const char *op, const char *msg)
 252 {
 253         if (op && *op) {
 254                 bb_error_msg("%s: %s", op, msg);
 255         } else {
 256                 bb_error_msg("%s: %s"+4, msg);
 257         }
 258         longjmp(leaving, 2);
 259 }
 260
 261 static arith_t oexpr(enum token n)
 262 {
 263         arith_t res;
 264
 265         res = aexpr(n);
 266         if (t_lex(*++t_wp) == BOR) {
 267                 return oexpr(t_lex(*++t_wp)) || res;
 268         }
 269         t_wp--;
 270         return res;
 271 }
 272
 273 static arith_t aexpr(enum token n)
 274 {
 275         arith_t res;
 276
 277         res = nexpr(n);
 278         if (t_lex(*++t_wp) == BAND)
 279                 return aexpr(t_lex(*++t_wp)) && res;
 280         t_wp--;
 281         return res;
 282 }
 283
 284 static arith_t nexpr(enum token n)
 285 {
 286         if (n == UNOT)
 287                 return !nexpr(t_lex(*++t_wp));
 288         return primary(n);
 289 }
 290
 291 static arith_t primary(enum token n)
 292 {
 293         arith_t res;
 294
 295         if (n == EOI) {
 296                 syntax(NULL, "argument expected");
 297         }
 298         if (n == LPAREN) {
 299                 res = oexpr(t_lex(*++t_wp));
 300                 if (t_lex(*++t_wp) != RPAREN)
 301                         syntax(NULL, "closing paren expected");
 302                 return res;
 303         }
 304         if (t_wp_op && t_wp_op->op_type == UNOP) {
 305                 /* unary expression */
 306                 if (*++t_wp == NULL)
 307                         syntax(t_wp_op->op_text, "argument expected");
 308                 if (n == STREZ)
 309                         return t_wp[0][0] == '\0';
 310                 if (n == STRNZ)
 311                         return t_wp[0][0] != '\0';
 312                 if (n == FILTT)
 313                         return isatty(getn(*t_wp));
 314                 return filstat(*t_wp, n);
 315         }
 316
 317         t_lex(t_wp[1]);
 318         if (t_wp_op && t_wp_op->op_type == BINOP) {
 319                 return binop();
 320         }
 321
 322         return t_wp[0][0] != '\0';
 323 }
 324
 325 static int binop(void)
 326 {
 327         const char *opnd1, *opnd2;
 328         struct t_op const *op;
 329         arith_t val1, val2;
 330
 331         opnd1 = *t_wp;
 332         (void) t_lex(*++t_wp);
 333         op = t_wp_op;
 334
 335         opnd2 = *++t_wp;
 336         if (opnd2 == NULL)
 337                 syntax(op->op_text, "argument expected");
 338
 339         if (is_int_op(op->op_num)) {
 340                 val1 = getn(opnd1);
 341                 val2 = getn(opnd2);
 342                 if (op->op_num == INTEQ)
 343                         return val1 == val2;
 344                 if (op->op_num == INTNE)
 345                         return val1 != val2;
 346                 if (op->op_num == INTGE)
 347                         return val1 >= val2;
 348                 if (op->op_num == INTGT)
 349                         return val1 >  val2;
 350                 if (op->op_num == INTLE)
 351                         return val1 <= val2;
 352                 if (op->op_num == INTLT)
 353                         return val1 <  val2;
 354         }
 355         if (is_str_op(op->op_num)) {
 356                 val1 = strcmp(opnd1, opnd2);
 357                 if (op->op_num == STREQ)
 358                         return val1 == 0;
 359                 if (op->op_num == STRNE)
 360                         return val1 != 0;
 361                 if (op->op_num == STRLT)
 362                         return val1 < 0;
 363                 if (op->op_num == STRGT)
 364                         return val1 > 0;
 365         }
 366         /* We are sure that these three are by now the only binops we didn't check
 367          * yet, so we do not check if the class is correct:
 368          */
 369 /*      if (is_file_op(op->op_num)) */
 370         {
 371                 struct stat b1, b2;
 372
 373                 if (stat(opnd1, &b1) || stat(opnd2, &b2))
 374                         return 0; /* false, since at least one stat failed */
 375                 if (op->op_num == FILNT)
 376                         return b1.st_mtime > b2.st_mtime;
 377                 if (op->op_num == FILOT)
 378                         return b1.st_mtime < b2.st_mtime;
 379                 if (op->op_num == FILEQ)
 380                         return b1.st_dev == b2.st_dev && b1.st_ino == b2.st_ino;
 381         }
 382         return 1; /* NOTREACHED */
 383 }
 384
 385 static int filstat(char *nm, enum token mode)
 386 {
 387         struct stat s;
 388         int i = i; /* gcc 3.x thinks it can be used uninitialized */
 389
 390         if (mode == FILSYM) {
 391 #ifdef S_IFLNK
 392                 if (lstat(nm, &s) == 0) {
 393                         i = S_IFLNK;
 394                         goto filetype;
 395                 }
 396 #endif
 397                 return 0;
 398         }
 399
 400         if (stat(nm, &s) != 0)
 401                 return 0;
 402         if (mode == FILEXIST)
 403                 return 1;
 404         if (is_file_access(mode)) {
 405                 if (mode == FILRD)
 406                         i = R_OK;
 407                 if (mode == FILWR)
 408                         i = W_OK;
 409                 if (mode == FILEX)
 410                         i = X_OK;
 411                 return test_eaccess(nm, i) == 0;
 412         }
 413         if (is_file_type(mode)) {
 414                 if (mode == FILREG)
 415                         i = S_IFREG;
 416                 if (mode == FILDIR)
 417                         i = S_IFDIR;
 418                 if (mode == FILCDEV)
 419                         i = S_IFCHR;
 420                 if (mode == FILBDEV)
 421                         i = S_IFBLK;
 422                 if (mode == FILFIFO) {
 423 #ifdef S_IFIFO
 424                         i = S_IFIFO;
 425 #else
 426                         return 0;
 427 #endif
 428                 }
 429                 if (mode == FILSOCK) {
 430 #ifdef S_IFSOCK
 431                         i = S_IFSOCK;
 432 #else
 433                         return 0;
 434 #endif
 435                 }
 436  filetype:
 437                 return ((s.st_mode & S_IFMT) == i);
 438         }
 439         if (is_file_bit(mode)) {
 440                 if (mode == FILSUID)
 441                         i = S_ISUID;
 442                 if (mode == FILSGID)
 443                         i = S_ISGID;
 444                 if (mode == FILSTCK)
 445                         i = S_ISVTX;
 446                 return ((s.st_mode & i) != 0);
 447         }
 448         if (mode == FILGZ)
 449                 return s.st_size > 0L;
 450         if (mode == FILUID)
 451                 return s.st_uid == geteuid();
 452         if (mode == FILGID)
 453                 return s.st_gid == getegid();
 454         return 1; /* NOTREACHED */
 455 }
 456
 457 static enum token t_lex(char *s)
 458 {
 459         const struct t_op *op;
 460
 461         t_wp_op = NULL;
 462         if (s == NULL) {
 463                 return EOI;
 464         }
 465
 466         op = ops;
 467         do {
 468                 if (strcmp(s, op->op_text) == 0) {
 469                         t_wp_op = op;
 470                         return op->op_num;
 471                 }
 472                 op++;
 473         } while (op < ops + ARRAY_SIZE(ops));
 474
 475         return OPERAND;
 476 }
 477
 478 /* atoi with error detection */
 479 //XXX: FIXME: duplicate of existing libbb function?
 480 static arith_t getn(const char *s)
 481 {
 482         char *p;
 483 #if ENABLE_FEATURE_TEST_64
 484         long long r;
 485 #else
 486         long r;
 487 #endif
 488
 489         errno = 0;
 490 #if ENABLE_FEATURE_TEST_64
 491         r = strtoll(s, &p, 10);
 492 #else
 493         r = strtol(s, &p, 10);
 494 #endif
 495
 496         if (errno != 0)
 497                 syntax(s, "out of range");
 498
 499         if (*(skip_whitespace(p)))
 500                 syntax(s, "bad number");
 501
 502         return r;
 503 }
 504
 505 /* UNUSED
 506 static int newerf(const char *f1, const char *f2)
 507 {
 508         struct stat b1, b2;
 509
 510         return (stat(f1, &b1) == 0 &&
 511                         stat(f2, &b2) == 0 && b1.st_mtime > b2.st_mtime);
 512 }
 513
 514 static int olderf(const char *f1, const char *f2)
 515 {
 516         struct stat b1, b2;
 517
 518         return (stat(f1, &b1) == 0 &&
 519                         stat(f2, &b2) == 0 && b1.st_mtime < b2.st_mtime);
 520 }
 521
 522 static int equalf(const char *f1, const char *f2)
 523 {
 524         struct stat b1, b2;
 525
 526         return (stat(f1, &b1) == 0 &&
 527                         stat(f2, &b2) == 0 &&
 528                         b1.st_dev == b2.st_dev && b1.st_ino == b2.st_ino);
 529 }
 530 */
 531
 532 /* Do the same thing access(2) does, but use the effective uid and gid,
 533    and don't make the mistake of telling root that any file is
 534    executable. */
 535 static int test_eaccess(char *path, int mode)
 536 {
 537         struct stat st;
 538         unsigned int euid = geteuid();
 539
 540         if (stat(path, &st) < 0)
 541                 return -1;
 542
 543         if (euid == 0) {
 544                 /* Root can read or write any file. */
 545                 if (mode != X_OK)
 546                         return 0;
 547
 548                 /* Root can execute any file that has any one of the execute
 549                    bits set. */
 550                 if (st.st_mode & (S_IXUSR | S_IXGRP | S_IXOTH))
 551                         return 0;
 552         }
 553
 554         if (st.st_uid == euid)  /* owner */
 555                 mode <<= 6;
 556         else if (is_a_group_member(st.st_gid))
 557                 mode <<= 3;
 558
 559         if (st.st_mode & mode)
 560                 return 0;
 561
 562         return -1;
 563 }
 564
 565 static void initialize_group_array(void)
 566 {
 567         ngroups = getgroups(0, NULL);
 568         if (ngroups > 0) {
 569                 /* FIXME: ash tries so hard to not die on OOM,
 570                  * and we spoil it with just one xrealloc here */
 571                 /* We realloc, because test_main can be entered repeatedly by shell.
 572                  * Testcase (ash): 'while true; do test -x some_file; done'
 573                  * and watch top. (some_file must have owner != you) */
 574                 group_array = xrealloc(group_array, ngroups * sizeof(gid_t));
 575                 getgroups(ngroups, group_array);
 576         }
 577 }
 578
 579 /* Return non-zero if GID is one that we have in our groups list. */
 580 //XXX: FIXME: duplicate of existing libbb function?
 581 // see toplevel TODO file:
 582 // possible code duplication ingroup() and is_a_group_member()
 583 static int is_a_group_member(gid_t gid)
 584 {
 585         int i;
 586
 587         /* Short-circuit if possible, maybe saving a call to getgroups(). */
 588         if (gid == getgid() || gid == getegid())
 589                 return 1;
 590
 591         if (ngroups == 0)
 592                 initialize_group_array();
 593
 594         /* Search through the list looking for GID. */
 595         for (i = 0; i < ngroups; i++)
 596                 if (gid == group_array[i])
 597                         return 1;
 598
 599         return 0;
 600 }