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 enum { NUM_OPS = sizeof(ops) / sizeof(ops[0]) };
 150
 151 #if ENABLE_FEATURE_TEST_64
 152 typedef int64_t arith_t;
 153 #else
 154 typedef int arith_t;
 155 #endif
 156
 157 /* Cannot eliminate these static data (do the G trick)
 158  * because of bb_test usage from other applets */
 159 static char **t_wp;
 160 static struct t_op const *t_wp_op;
 161 static gid_t *group_array;
 162 static int ngroups;
 163 static jmp_buf leaving;
 164
 165 static enum token t_lex(char *s);
 166 static arith_t oexpr(enum token n);
 167 static arith_t aexpr(enum token n);
 168 static arith_t nexpr(enum token n);
 169 static int binop(void);
 170 static arith_t primary(enum token n);
 171 static int filstat(char *nm, enum token mode);
 172 static arith_t getn(const char *s);
 173 /* UNUSED
 174 static int newerf(const char *f1, const char *f2);
 175 static int olderf(const char *f1, const char *f2);
 176 static int equalf(const char *f1, const char *f2);
 177 */
 178 static int test_eaccess(char *path, int mode);
 179 static int is_a_group_member(gid_t gid);
 180 static void initialize_group_array(void);
 181
 182 int bb_test(int argc, char **argv)
 183 {
 184         int res;
 185         char *arg0;
 186
 187         arg0 = strrchr(argv[0], '/');
 188         if (!arg0++) arg0 = argv[0];
 189         if (arg0[0] == '[') {
 190                 if (!arg0[1]) { /* "[" ? */
 191                         --argc;
 192                         if (NOT_LONE_CHAR(argv[argc], ']')) {
 193                                 bb_error_msg("missing ]");
 194                                 return 2;
 195                         }
 196                         argv[argc] = NULL;
 197                 } else if (LONE_CHAR(arg0, '[') == 0) { /* "[[" ? */
 198                         --argc;
 199                         if (strcmp(argv[argc], "]]") != 0) {
 200                                 bb_error_msg("missing ]]");
 201                                 return 2;
 202                         }
 203                         argv[argc] = NULL;
 204                 }
 205         }
 206
 207         res = setjmp(leaving);
 208         if (res)
 209                 return res;
 210
 211         /* resetting ngroups is probably unnecessary.  it will
 212          * force a new call to getgroups(), which prevents using
 213          * group data fetched during a previous call.  but the
 214          * only way the group data could be stale is if there's
 215          * been an intervening call to setgroups(), and this
 216          * isn't likely in the case of a shell.  paranoia
 217          * prevails...
 218          */
 219         ngroups = 0;
 220
 221         /* Implement special cases from POSIX.2, section 4.62.4 */
 222         if (argc == 1)
 223                 return 1;
 224         if (argc == 2)
 225                 return *argv[1] == '\0';
 226 //assert(argc);
 227         if (LONE_CHAR(argv[1], '!')) {
 228                 bool _off;
 229                 if (argc == 3)
 230                         return *argv[2] != '\0';
 231                 _off = argc - 4;
 232                 t_lex(argv[2 + _off]);
 233                 if (t_wp_op && t_wp_op->op_type == BINOP) {
 234                         t_wp = &argv[1 + _off];
 235                         return binop() == 1;
 236                 }
 237         }
 238         t_wp = &argv[1];
 239         res = !oexpr(t_lex(*t_wp));
 240
 241         if (*t_wp != NULL && *++t_wp != NULL) {
 242                 bb_error_msg("%s: unknown operand", *t_wp);
 243                 return 2;
 244         }
 245         return res;
 246 }
 247
 248 static void syntax(const char *op, const char *msg) ATTRIBUTE_NORETURN;
 249 static void syntax(const char *op, const char *msg)
 250 {
 251         if (op && *op) {
 252                 bb_error_msg("%s: %s", op, msg);
 253         } else {
 254                 bb_error_msg("%s: %s"+4, msg);
 255         }
 256         longjmp(leaving, 2);
 257 }
 258
 259 static arith_t oexpr(enum token n)
 260 {
 261         arith_t res;
 262
 263         res = aexpr(n);
 264         if (t_lex(*++t_wp) == BOR) {
 265                 return oexpr(t_lex(*++t_wp)) || res;
 266         }
 267         t_wp--;
 268         return res;
 269 }
 270
 271 static arith_t aexpr(enum token n)
 272 {
 273         arith_t res;
 274
 275         res = nexpr(n);
 276         if (t_lex(*++t_wp) == BAND)
 277                 return aexpr(t_lex(*++t_wp)) && res;
 278         t_wp--;
 279         return res;
 280 }
 281
 282 static arith_t nexpr(enum token n)
 283 {
 284         if (n == UNOT)
 285                 return !nexpr(t_lex(*++t_wp));
 286         return primary(n);
 287 }
 288
 289 static arith_t primary(enum token n)
 290 {
 291         arith_t res;
 292
 293         if (n == EOI) {
 294                 syntax(NULL, "argument expected");
 295         }
 296         if (n == LPAREN) {
 297                 res = oexpr(t_lex(*++t_wp));
 298                 if (t_lex(*++t_wp) != RPAREN)
 299                         syntax(NULL, "closing paren expected");
 300                 return res;
 301         }
 302         if (t_wp_op && t_wp_op->op_type == UNOP) {
 303                 /* unary expression */
 304                 if (*++t_wp == NULL)
 305                         syntax(t_wp_op->op_text, "argument expected");
 306                 if (n == STREZ)
 307                         return t_wp[0][0] == '\0';
 308                 if (n == STRNZ)
 309                         return t_wp[0][0] != '\0';
 310                 if (n == FILTT)
 311                         return isatty(getn(*t_wp));
 312                 return filstat(*t_wp, n);
 313         }
 314
 315         t_lex(t_wp[1]);
 316         if (t_wp_op && t_wp_op->op_type == BINOP) {
 317                 return binop();
 318         }
 319
 320         return t_wp[0][0] != '\0';
 321 }
 322
 323 static int binop(void)
 324 {
 325         const char *opnd1, *opnd2;
 326         struct t_op const *op;
 327         arith_t val1, val2;
 328
 329         opnd1 = *t_wp;
 330         (void) t_lex(*++t_wp);
 331         op = t_wp_op;
 332
 333         opnd2 = *++t_wp;
 334         if (opnd2 == NULL)
 335                 syntax(op->op_text, "argument expected");
 336
 337         if (is_int_op(op->op_num)) {
 338                 val1 = getn(opnd1);
 339                 val2 = getn(opnd2);
 340                 if (op->op_num == INTEQ)
 341                         return val1 == val2;
 342                 if (op->op_num == INTNE)
 343                         return val1 != val2;
 344                 if (op->op_num == INTGE)
 345                         return val1 >= val2;
 346                 if (op->op_num == INTGT)
 347                         return val1 >  val2;
 348                 if (op->op_num == INTLE)
 349                         return val1 <= val2;
 350                 if (op->op_num == INTLT)
 351                         return val1 <  val2;
 352         }
 353         if (is_str_op(op->op_num)) {
 354                 val1 = strcmp(opnd1, opnd2);
 355                 if (op->op_num == STREQ)
 356                         return val1 == 0;
 357                 if (op->op_num == STRNE)
 358                         return val1 != 0;
 359                 if (op->op_num == STRLT)
 360                         return val1 < 0;
 361                 if (op->op_num == STRGT)
 362                         return val1 > 0;
 363         }
 364         /* We are sure that these three are by now the only binops we didn't check
 365          * yet, so we do not check if the class is correct:
 366          */
 367 /*      if (is_file_op(op->op_num)) */
 368         {
 369                 struct stat b1, b2;
 370
 371                 if (stat(opnd1, &b1) || stat(opnd2, &b2))
 372                         return 0; /* false, since at least one stat failed */
 373                 if (op->op_num == FILNT)
 374                         return b1.st_mtime > b2.st_mtime;
 375                 if (op->op_num == FILOT)
 376                         return b1.st_mtime < b2.st_mtime;
 377                 if (op->op_num == FILEQ)
 378                         return b1.st_dev == b2.st_dev && b1.st_ino == b2.st_ino;
 379         }
 380         return 1; /* NOTREACHED */
 381 }
 382
 383 static int filstat(char *nm, enum token mode)
 384 {
 385         struct stat s;
 386         int i;
 387
 388         if (mode == FILSYM) {
 389 #ifdef S_IFLNK
 390                 if (lstat(nm, &s) == 0) {
 391                         i = S_IFLNK;
 392                         goto filetype;
 393                 }
 394 #endif
 395                 return 0;
 396         }
 397
 398         if (stat(nm, &s) != 0)
 399                 return 0;
 400         if (mode == FILEXIST)
 401                 return 1;
 402         if (is_file_access(mode)) {
 403                 if (mode == FILRD)
 404                         i = R_OK;
 405                 if (mode == FILWR)
 406                         i = W_OK;
 407                 if (mode == FILEX)
 408                         i = X_OK;
 409                 return test_eaccess(nm, i) == 0;
 410         }
 411         if (is_file_type(mode)) {
 412                 if (mode == FILREG)
 413                         i = S_IFREG;
 414                 if (mode == FILDIR)
 415                         i = S_IFDIR;
 416                 if (mode == FILCDEV)
 417                         i = S_IFCHR;
 418                 if (mode == FILBDEV)
 419                         i = S_IFBLK;
 420                 if (mode == FILFIFO) {
 421 #ifdef S_IFIFO
 422                         i = S_IFIFO;
 423 #else
 424                         return 0;
 425 #endif
 426                 }
 427                 if (mode == FILSOCK) {
 428 #ifdef S_IFSOCK
 429                         i = S_IFSOCK;
 430 #else
 431                         return 0;
 432 #endif
 433                 }
 434  filetype:
 435                 return ((s.st_mode & S_IFMT) == i);
 436         }
 437         if (is_file_bit(mode)) {
 438                 if (mode == FILSUID)
 439                         i = S_ISUID;
 440                 if (mode == FILSGID)
 441                         i = S_ISGID;
 442                 if (mode == FILSTCK)
 443                         i = S_ISVTX;
 444                 return ((s.st_mode & i) != 0);
 445         }
 446         if (mode == FILGZ)
 447                 return s.st_size > 0L;
 448         if (mode == FILUID)
 449                 return s.st_uid == geteuid();
 450         if (mode == FILGID)
 451                 return s.st_gid == getegid();
 452         return 1; /* NOTREACHED */
 453 }
 454
 455 static enum token t_lex(char *s)
 456 {
 457         const struct t_op *op;
 458
 459         t_wp_op = NULL;
 460         if (s == NULL) {
 461                 return EOI;
 462         }
 463
 464         op = ops;
 465         do {
 466                 if (strcmp(s, op->op_text) == 0) {
 467                         t_wp_op = op;
 468                         return op->op_num;
 469                 }
 470                 op++;
 471         } while (op < ops + NUM_OPS);
 472
 473         return OPERAND;
 474 }
 475
 476 /* atoi with error detection */
 477 //XXX: FIXME: duplicate of existing libbb function?
 478 static arith_t getn(const char *s)
 479 {
 480         char *p;
 481 #if ENABLE_FEATURE_TEST_64
 482         long long r;
 483 #else
 484         long r;
 485 #endif
 486
 487         errno = 0;
 488 #if ENABLE_FEATURE_TEST_64
 489         r = strtoll(s, &p, 10);
 490 #else
 491         r = strtol(s, &p, 10);
 492 #endif
 493
 494         if (errno != 0)
 495                 syntax(s, "out of range");
 496
 497         if (*(skip_whitespace(p)))
 498                 syntax(s, "bad number");
 499
 500         return r;
 501 }
 502
 503 /* UNUSED
 504 static int newerf(const char *f1, const char *f2)
 505 {
 506         struct stat b1, b2;
 507
 508         return (stat(f1, &b1) == 0 &&
 509                         stat(f2, &b2) == 0 && b1.st_mtime > b2.st_mtime);
 510 }
 511
 512 static int olderf(const char *f1, const char *f2)
 513 {
 514         struct stat b1, b2;
 515
 516         return (stat(f1, &b1) == 0 &&
 517                         stat(f2, &b2) == 0 && b1.st_mtime < b2.st_mtime);
 518 }
 519
 520 static int equalf(const char *f1, const char *f2)
 521 {
 522         struct stat b1, b2;
 523
 524         return (stat(f1, &b1) == 0 &&
 525                         stat(f2, &b2) == 0 &&
 526                         b1.st_dev == b2.st_dev && b1.st_ino == b2.st_ino);
 527 }
 528 */
 529
 530 /* Do the same thing access(2) does, but use the effective uid and gid,
 531    and don't make the mistake of telling root that any file is
 532    executable. */
 533 static int test_eaccess(char *path, int mode)
 534 {
 535         struct stat st;
 536         unsigned int euid = geteuid();
 537
 538         if (stat(path, &st) < 0)
 539                 return -1;
 540
 541         if (euid == 0) {
 542                 /* Root can read or write any file. */
 543                 if (mode != X_OK)
 544                         return 0;
 545
 546                 /* Root can execute any file that has any one of the execute
 547                    bits set. */
 548                 if (st.st_mode & (S_IXUSR | S_IXGRP | S_IXOTH))
 549                         return 0;
 550         }
 551
 552         if (st.st_uid == euid)  /* owner */
 553                 mode <<= 6;
 554         else if (is_a_group_member(st.st_gid))
 555                 mode <<= 3;
 556
 557         if (st.st_mode & mode)
 558                 return 0;
 559
 560         return -1;
 561 }
 562
 563 static void initialize_group_array(void)
 564 {
 565         ngroups = getgroups(0, NULL);
 566         if (ngroups > 0) {
 567                 /* FIXME: ash tries so hard to not die on OOM,
 568                  * and we spoil it with just one xrealloc here */
 569                 /* We realloc, because bb_test can be entered repeatedly by shell.
 570                  * Testcase (ash): 'while true; do test -x some_file; done'
 571                  * and watch top. (some_file must have owner != you) */
 572                 group_array = xrealloc(group_array, ngroups * sizeof(gid_t));
 573                 getgroups(ngroups, group_array);
 574         }
 575 }
 576
 577 /* Return non-zero if GID is one that we have in our groups list. */
 578 //XXX: FIXME: duplicate of existing libbb function?
 579 // see toplevel TODO file:
 580 // possible code duplication ingroup() and is_a_group_member()
 581 static int is_a_group_member(gid_t gid)
 582 {
 583         int i;
 584
 585         /* Short-circuit if possible, maybe saving a call to getgroups(). */
 586         if (gid == getgid() || gid == getegid())
 587                 return 1;
 588
 589         if (ngroups == 0)
 590                 initialize_group_array();
 591
 592         /* Search through the list looking for GID. */
 593         for (i = 0; i < ngroups; i++)
 594                 if (gid == group_array[i])
 595                         return 1;
 596
 597         return 0;
 598 }
 599
 600
 601 /* applet entry point */
 602
 603 int test_main(int argc, char **argv);
 604 int test_main(int argc, char **argv)
 605 {
 606         return bb_test(argc, argv);
 607 }