src/box.c

   1 /*
   2  *      A Simple Testing Sandbox
   3  *
   4  *      (c) 2001 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 #define _LARGEFILE64_SOURCE
   8 #define _GNU_SOURCE
   9
  10 #include <errno.h>
  11 #include <stdio.h>
  12 #include <fcntl.h>
  13 #include <stdlib.h>
  14 #include <string.h>
  15 #include <stdarg.h>
  16 #include <unistd.h>
  17 #include <getopt.h>
  18 #include <time.h>
  19 #include <sys/wait.h>
  20 #include <sys/user.h>
  21 #include <sys/time.h>
  22 #include <sys/ptrace.h>
  23 #include <sys/signal.h>
  24 #include <sys/sysinfo.h>
  25 #include <sys/syscall.h>
  26 #include <sys/resource.h>
  27
  28 #define NONRET __attribute__((noreturn))
  29 #define UNUSED __attribute__((unused))
  30
  31 static int filter_syscalls;             /* 0=off, 1=liberal, 2=totalitarian */
  32 static int timeout;
  33 static int pass_environ;
  34 static int use_wall_clock;
  35 static int file_access;
  36 static int verbose;
  37 static int memory_limit;
  38 static int allow_times;
  39 static char *redir_stdin, *redir_stdout;
  40 static char *set_cwd;
  41
  42 static pid_t box_pid;
  43 static int is_ptraced;
  44 static volatile int timer_tick;
  45 static time_t start_time;
  46 static int ticks_per_sec;
  47
  48 #if defined(__GLIBC__) && __GLIBC__ == 2 && __GLIBC_MINOR__ > 0
  49 /* glibc 2.1 or newer -> has lseek64 */
  50 #define long_seek(f,o,w) lseek64(f,o,w)
  51 #else
  52 /* Touching clandestine places in glibc */
  53 extern loff_t llseek(int fd, loff_t pos, int whence);
  54 #define long_seek(f,o,w) llseek(f,o,w)
  55 #endif
  56
  57 static void NONRET
  58 box_exit(void)
  59 {
  60   if (box_pid > 0)
  61     {
  62       if (is_ptraced)
  63         ptrace(PTRACE_KILL, box_pid);
  64       kill(-box_pid, SIGKILL);
  65       kill(box_pid, SIGKILL);
  66     }
  67   exit(1);
  68 }
  69
  70 static void NONRET __attribute__((format(printf,1,2)))
  71 die(char *msg, ...)
  72 {
  73   va_list args;
  74   va_start(args, msg);
  75   vfprintf(stderr, msg, args);
  76   fputc('\n', stderr);
  77   box_exit();
  78 }
  79
  80 static void __attribute__((format(printf,1,2)))
  81 log(char *msg, ...)
  82 {
  83   va_list args;
  84   va_start(args, msg);
  85   if (verbose)
  86     {
  87       vfprintf(stderr, msg, args);
  88       fflush(stderr);
  89     }
  90   va_end(args);
  91 }
  92
  93 static void
  94 valid_filename(unsigned long addr)
  95 {
  96   char namebuf[4096], *p, *end;
  97   static int mem_fd;
  98
  99   if (!file_access)
 100     die("File access forbidden.");
 101   if (file_access >= 9)
 102     return;
 103
 104   if (!mem_fd)
 105     {
 106       sprintf(namebuf, "/proc/%d/mem", (int) box_pid);
 107       mem_fd = open(namebuf, O_RDONLY);
 108       if (mem_fd < 0)
 109         die("open(%s): %m", namebuf);
 110     }
 111   p = end = namebuf;
 112   do
 113     {
 114       if (p >= end)
 115         {
 116           int remains = PAGE_SIZE - (addr & (PAGE_SIZE-1));
 117           int l = namebuf + sizeof(namebuf) - end;
 118           if (l > remains)
 119             l = remains;
 120           if (!l)
 121             die("Access to file with name too long.");
 122           if (long_seek(mem_fd, addr, SEEK_SET) < 0)
 123             die("long_seek(mem): %m");
 124           remains = read(mem_fd, end, l);
 125           if (remains < 0)
 126             die("read(mem): %m");
 127           if (!remains)
 128             die("Access to file with name out of memory.");
 129           end += l;
 130           addr += l;
 131         }
 132     }
 133   while (*p++);
 134
 135   log("[%s] ", namebuf);
 136   if (file_access >= 3)
 137     return;
 138   if (!strchr(namebuf, '/') && strcmp(namebuf, ".."))
 139     return;
 140   if (file_access >= 2)
 141     {
 142       if ((!strncmp(namebuf, "/etc/", 5) ||
 143            !strncmp(namebuf, "/lib/", 5) ||
 144            !strncmp(namebuf, "/usr/lib/", 9))
 145           && !strstr(namebuf, ".."))
 146         return;
 147       if (!strcmp(namebuf, "/dev/null") ||
 148           !strcmp(namebuf, "/dev/zero") ||
 149           !strcmp(namebuf, "/proc/meminfo") ||
 150           !strcmp(namebuf, "/proc/self/stat") ||
 151           !strncmp(namebuf, "/usr/share/zoneinfo/", 20))
 152         return;
 153     }
 154   die("Forbidden access to file `%s'.", namebuf);
 155 }
 156
 157 static int
 158 valid_syscall(struct user *u)
 159 {
 160   switch (u->regs.orig_eax)
 161     {
 162     case SYS_execve:
 163       {
 164         static int exec_counter;
 165         return !exec_counter++;
 166       }
 167     case SYS_open:
 168     case SYS_creat:
 169     case SYS_unlink:
 170     case SYS_oldstat:
 171     case SYS_access:
 172     case SYS_oldlstat:
 173     case SYS_truncate:
 174     case SYS_stat:
 175     case SYS_lstat:
 176     case SYS_truncate64:
 177     case SYS_stat64:
 178     case SYS_lstat64:
 179       valid_filename(u->regs.ebx);
 180       return 1;
 181     case SYS_exit:
 182     case SYS_read:
 183     case SYS_write:
 184     case SYS_close:
 185     case SYS_lseek:
 186     case SYS_getpid:
 187     case SYS_getuid:
 188     case SYS_oldfstat:
 189     case SYS_dup:
 190     case SYS_brk:
 191     case SYS_getgid:
 192     case SYS_geteuid:
 193     case SYS_getegid:
 194     case SYS_dup2:
 195     case SYS_ftruncate:
 196     case SYS_fstat:
 197     case SYS_personality:
 198     case SYS__llseek:
 199     case SYS_readv:
 200     case SYS_writev:
 201     case SYS_getresuid:
 202     case SYS_pread:
 203     case SYS_pwrite:
 204     case SYS_ftruncate64:
 205     case SYS_fstat64:
 206     case SYS_fcntl:
 207     case SYS_fcntl64:
 208     case SYS_mmap:
 209     case SYS_munmap:
 210     case SYS_ioctl:
 211     case SYS_uname:
 212     case 252:
 213       return 1;
 214     case SYS_time:
 215     case SYS_alarm:
 216     case SYS_pause:
 217     case SYS_signal:
 218     case SYS_fchmod:
 219     case SYS_sigaction:
 220     case SYS_sgetmask:
 221     case SYS_ssetmask:
 222     case SYS_sigsuspend:
 223     case SYS_sigpending:
 224     case SYS_getrlimit:
 225     case SYS_getrusage:
 226     case SYS_gettimeofday:
 227     case SYS_select:
 228     case SYS_readdir:
 229     case SYS_setitimer:
 230     case SYS_getitimer:
 231     case SYS_sigreturn:
 232     case SYS_mprotect:
 233     case SYS_sigprocmask:
 234     case SYS_getdents:
 235     case SYS_getdents64:
 236     case SYS__newselect:
 237     case SYS_fdatasync:
 238     case SYS_mremap:
 239     case SYS_poll:
 240     case SYS_getcwd:
 241     case SYS_nanosleep:
 242     case SYS_rt_sigreturn:
 243     case SYS_rt_sigaction:
 244     case SYS_rt_sigprocmask:
 245     case SYS_rt_sigpending:
 246     case SYS_rt_sigtimedwait:
 247     case SYS_rt_sigqueueinfo:
 248     case SYS_rt_sigsuspend:
 249     case SYS_mmap2:
 250     case SYS__sysctl:
 251       return (filter_syscalls == 1);
 252     case SYS_times:
 253       return allow_times;
 254     default:
 255       return 0;
 256     }
 257 }
 258
 259 static void
 260 signal_alarm(int unused UNUSED)
 261 {
 262   /* Time limit checks are synchronous, so we only schedule them there. */
 263   timer_tick = 1;
 264   alarm(1);
 265 }
 266
 267 static void
 268 signal_int(int unused UNUSED)
 269 {
 270   /* Interrupts are fatal, so no synchronization requirements. */
 271   die("Interrupted.");
 272 }
 273
 274 static void
 275 check_timeout(void)
 276 {
 277   int sec;
 278
 279   if (use_wall_clock)
 280     sec = time(NULL) - start_time;
 281   else
 282     {
 283       char buf[4096], *x;
 284       int c, utime, stime;
 285       static int proc_status_fd;
 286       if (!proc_status_fd)
 287         {
 288           sprintf(buf, "/proc/%d/stat", (int) box_pid);
 289           proc_status_fd = open(buf, O_RDONLY);
 290           if (proc_status_fd < 0)
 291             die("open(%s): %m", buf);
 292         }
 293       lseek(proc_status_fd, 0, SEEK_SET);
 294       if ((c = read(proc_status_fd, buf, sizeof(buf)-1)) < 0)
 295         die("read on /proc/$pid/stat: %m");
 296       if (c >= (int) sizeof(buf) - 1)
 297         die("/proc/$pid/stat too long");
 298       buf[c] = 0;
 299       x = buf;
 300       while (*x && *x != ' ')
 301         x++;
 302       while (*x == ' ')
 303         x++;
 304       if (*x++ != '(')
 305         die("proc syntax error 1");
 306       while (*x && (*x != ')' || x[1] != ' '))
 307         x++;
 308       while (*x == ')' || *x == ' ')
 309         x++;
 310       if (sscanf(x, "%*c %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d %d %d", &utime, &stime) != 2)
 311         die("proc syntax error 2");
 312       sec = (utime + stime)/ticks_per_sec;
 313     }
 314   if (verbose > 1)
 315     fprintf(stderr, "[timecheck: %d seconds]\n", sec);
 316   if (sec > timeout)
 317     die("Time limit exceeded.");
 318 }
 319
 320 static void
 321 boxkeeper(void)
 322 {
 323   int syscall_count = 0;
 324   struct sigaction sa;
 325
 326   is_ptraced = 1;
 327   bzero(&sa, sizeof(sa));
 328   sa.sa_handler = signal_int;
 329   sigaction(SIGINT, &sa, NULL);
 330   start_time = time(NULL);
 331   ticks_per_sec = sysconf(_SC_CLK_TCK);
 332   if (ticks_per_sec <= 0)
 333     die("Invalid ticks_per_sec!");
 334   if (timeout)
 335     {
 336       sa.sa_handler = signal_alarm;
 337       sigaction(SIGALRM, &sa, NULL);
 338       alarm(1);
 339     }
 340   for(;;)
 341     {
 342       struct rusage rus;
 343       int stat;
 344       pid_t p;
 345       if (timer_tick)
 346         {
 347           check_timeout();
 348           timer_tick = 0;
 349         }
 350       p = wait4(box_pid, &stat, WUNTRACED, &rus);
 351       if (p < 0)
 352         {
 353           if (errno == EINTR)
 354             continue;
 355           die("wait4: %m");
 356         }
 357       if (p != box_pid)
 358         die("wait4: unknown pid %d exited!", p);
 359       if (WIFEXITED(stat))
 360         {
 361           struct timeval total;
 362           int wall;
 363           box_pid = 0;
 364           if (WEXITSTATUS(stat))
 365             die("Exited with error status %d.", WEXITSTATUS(stat));
 366           timeradd(&rus.ru_utime, &rus.ru_stime, &total);
 367           wall = time(NULL) - start_time;
 368           if ((use_wall_clock ? wall : total.tv_sec) > timeout)
 369             die("Time limit exceeded (after exit).");
 370           fprintf(stderr, "OK (%d sec real, %d sec wall, %d syscalls)\n", (int) total.tv_sec, wall, syscall_count);
 371           exit(0);
 372         }
 373       if (WIFSIGNALED(stat))
 374         {
 375           box_pid = 0;
 376           die("Caught fatal signal %d.", WTERMSIG(stat));
 377         }
 378       if (WIFSTOPPED(stat))
 379         {
 380           int sig = WSTOPSIG(stat);
 381           if (sig == SIGTRAP)
 382             {
 383               struct user u;
 384               static int stop_count = -1;
 385               if (ptrace(PTRACE_GETREGS, box_pid, NULL, &u) < 0)
 386                 die("ptrace(PTRACE_GETREGS): %m");
 387               stop_count++;
 388               if (!stop_count)                  /* Traceme request */
 389                 log(">> Traceme request caught\n");
 390               else if (stop_count & 1)          /* Syscall entry */
 391                 {
 392                   log(">> Syscall %3ld (%08lx,%08lx,%08lx) ", u.regs.orig_eax, u.regs.ebx, u.regs.ecx, u.regs.edx);
 393                   syscall_count++;
 394                   if (!valid_syscall(&u))
 395                     {
 396                       /*
 397                        * Unfortunately, PTRACE_KILL kills _after_ the syscall completes,
 398                        * so we have to change it to something harmless (e.g., an undefined
 399                        * syscall) and make the program continue.
 400                        */
 401                       unsigned int sys = u.regs.orig_eax;
 402                       u.regs.orig_eax = 0xffffffff;
 403                       if (ptrace(PTRACE_SETREGS, box_pid, NULL, &u) < 0)
 404                         die("ptrace(PTRACE_SETREGS): %m");
 405                       die("Forbidden syscall %d.", sys);
 406                     }
 407                 }
 408               else                                      /* Syscall return */
 409                 log("= %ld\n", u.regs.eax);
 410               ptrace(PTRACE_SYSCALL, box_pid, 0, 0);
 411             }
 412           else if (sig != SIGSTOP && sig != SIGXCPU && sig != SIGXFSZ)
 413             {
 414               log(">> Signal %d\n", sig);
 415               ptrace(PTRACE_SYSCALL, box_pid, 0, sig);
 416             }
 417           else
 418             die("Received signal %d.", sig);
 419         }
 420       else
 421         die("wait4: unknown status %x, giving up!", stat);
 422     }
 423 }
 424
 425 static void
 426 box_inside(int argc, char **argv)
 427 {
 428   struct rlimit rl;
 429   char *args[argc+1];
 430   char *env[1] = { NULL };
 431
 432   memcpy(args, argv, argc * sizeof(char *));
 433   args[argc] = NULL;
 434   if (redir_stdin)
 435     {
 436       close(0);
 437       if (open(redir_stdin, O_RDONLY) != 0)
 438         die("open(\"%s\"): %m", redir_stdin);
 439     }
 440   if (redir_stdout)
 441     {
 442       close(1);
 443       if (open(redir_stdout, O_WRONLY | O_CREAT | O_TRUNC, 0666) != 1)
 444         die("open(\"%s\"): %m", redir_stdout);
 445     }
 446   if (set_cwd && chdir(set_cwd))
 447     die("chdir: %m");
 448   dup2(1, 2);
 449   setpgrp();
 450   if (memory_limit)
 451     {
 452       rl.rlim_cur = rl.rlim_max = memory_limit * 1024;
 453       if (setrlimit(RLIMIT_AS, &rl) < 0)
 454         die("setrlimit: %m");
 455     }
 456   rl.rlim_cur = rl.rlim_max = 64;
 457   if (setrlimit(RLIMIT_NOFILE, &rl) < 0)
 458     die("setrlimit: %m");
 459   if (filter_syscalls && ptrace(PTRACE_TRACEME) < 0)
 460     die("ptrace(PTRACE_TRACEME): %m");
 461   execve(args[0], args, (pass_environ ? environ : env));
 462   die("execve(\"%s\"): %m", args[0]);
 463 }
 464
 465 static void
 466 usage(void)
 467 {
 468   fprintf(stderr, "Invalid arguments!\n");
 469   printf("\
 470 Usage: box [<options>] -- <command> <arguments>\n\
 471 \n\
 472 Options:\n\
 473 -a <level>\tSet file access level (0=none, 1=cwd, 2=/etc,/lib,..., 3=whole fs, 9=no checks; needs -f)\n\
 474 -c <dir>\tChange directory to <dir> first\n\
 475 -e\t\tPass full environment of parent process\n\
 476 -f\t\tFilter system calls (-ff=very restricted)\n\
 477 -i <file>\tRedirect stdin from <file>\n\
 478 -m <size>\tLimit address space to <size> KB\n\
 479 -o <file>\tRedirect stdout to <file>\n\
 480 -t <time>\tStop after <time> seconds\n\
 481 -T\t\tAllow syscalls for measuring run time\n\
 482 -v\t\tBe verbose\n\
 483 -w\t\tMeasure wall clock time instead of run time\n\
 484 ");
 485   exit(1);
 486 }
 487
 488 int
 489 main(int argc, char **argv)
 490 {
 491   int c;
 492   uid_t uid;
 493
 494   while ((c = getopt(argc, argv, "a:c:efi:m:o:t:Tvw")) >= 0)
 495     switch (c)
 496       {
 497       case 'a':
 498         file_access = atol(optarg);
 499         break;
 500       case 'c':
 501         set_cwd = optarg;
 502         break;
 503       case 'e':
 504         pass_environ = 1;
 505         break;
 506       case 'f':
 507         filter_syscalls++;
 508         break;
 509       case 'i':
 510         redir_stdin = optarg;
 511         break;
 512       case 'm':
 513         memory_limit = atol(optarg);
 514         break;
 515       case 'o':
 516         redir_stdout = optarg;
 517         break;
 518       case 't':
 519         timeout = atol(optarg);
 520         break;
 521       case 'T':
 522         allow_times++;
 523         break;
 524       case 'v':
 525         verbose++;
 526         break;
 527       case 'w':
 528         use_wall_clock = 1;
 529         break;
 530       default:
 531         usage();
 532       }
 533   if (optind >= argc)
 534     usage();
 535
 536   uid = geteuid();
 537   if (setreuid(uid, uid) < 0)
 538     die("setreuid: %m");
 539   box_pid = fork();
 540   if (box_pid < 0)
 541     die("fork: %m");
 542   if (!box_pid)
 543     box_inside(argc-optind, argv+optind);
 544   else
 545     boxkeeper();
 546   die("Internal error: fell over edge of the world");
 547 }