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