]> mj.ucw.cz Git - eval.git/blob - box/box.c
Box: Record in the meta-file whether the process has been killed
[eval.git] / box / box.c
1 /*
2  *      A Simple Sandbox for MO-Eval
3  *
4  *      (c) 2001--2008 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 #define ARRAY_SIZE(a) (int)(sizeof(a)/sizeof(a[0]))
31
32 static int filter_syscalls;             /* 0=off, 1=liberal, 2=totalitarian */
33 static int timeout;                     /* milliseconds */
34 static int wall_timeout;
35 static int extra_timeout;
36 static int pass_environ;
37 static int file_access;
38 static int verbose;
39 static int memory_limit;
40 static char *redir_stdin, *redir_stdout, *redir_stderr;
41 static char *set_cwd;
42
43 static pid_t box_pid;
44 static int is_ptraced;
45 static volatile int timer_tick;
46 static struct timeval start_time;
47 static int ticks_per_sec;
48 static int exec_seen;
49 static int partial_line;
50
51 static int mem_peak_kb;
52 static int total_ms, wall_ms;
53
54 static void die(char *msg, ...) NONRET;
55 static void sample_mem_peak(void);
56
57 /*** Meta-files ***/
58
59 static FILE *metafile;
60
61 static void
62 meta_open(const char *name)
63 {
64   if (!strcmp(name, "-"))
65     {
66       metafile = stdout;
67       return;
68     }
69   metafile = fopen(name, "w");
70   if (!metafile)
71     die("Failed to open metafile '%s'",name);
72 }
73
74 static void
75 meta_close(void)
76 {
77   if (metafile && metafile != stdout)
78     fclose(metafile);
79 }
80
81 static void __attribute__((format(printf,1,2)))
82 meta_printf(const char *fmt, ...)
83 {
84   if (!metafile)
85     return;
86
87   va_list args;
88   va_start(args, fmt);
89   vfprintf(metafile, fmt, args);
90   va_end(args);
91 }
92
93 static void
94 final_stats(struct rusage *rus)
95 {
96   struct timeval total, now, wall;
97   timeradd(&rus->ru_utime, &rus->ru_stime, &total);
98   total_ms = total.tv_sec*1000 + total.tv_usec/1000;
99   gettimeofday(&now, NULL);
100   timersub(&now, &start_time, &wall);
101   wall_ms = wall.tv_sec*1000 + wall.tv_usec/1000;
102
103   meta_printf("time:%d.%03d\n", total_ms/1000, total_ms%1000);
104   meta_printf("time-wall:%d.%03d\n", wall_ms/1000, wall_ms%1000);
105   meta_printf("mem:%llu\n", (unsigned long long) mem_peak_kb * 1024);
106 }
107
108 /*** Messages and exits ***/
109
110 static void NONRET
111 box_exit(int rc)
112 {
113   if (box_pid > 0)
114     {
115       sample_mem_peak();
116       if (is_ptraced)
117         ptrace(PTRACE_KILL, box_pid);
118       kill(-box_pid, SIGKILL);
119       kill(box_pid, SIGKILL);
120       meta_printf("killed:1\n");
121
122       struct rusage rus;
123       int stat;
124       int p = wait4(box_pid, &stat, 0, &rus);
125       if (p < 0)
126         fprintf(stderr, "UGH: Lost track of the process\n");
127       else
128         final_stats(&rus);
129     }
130   meta_close();
131   exit(rc);
132 }
133
134 static void
135 flush_line(void)
136 {
137   if (partial_line)
138     fputc('\n', stderr);
139   partial_line = 0;
140 }
141
142 /* Report an error of the sandbox itself */
143 static void NONRET __attribute__((format(printf,1,2)))
144 die(char *msg, ...)
145 {
146   va_list args;
147   va_start(args, msg);
148   flush_line();
149   char buf[1024];
150   vsnprintf(buf, sizeof(buf), msg, args);
151   meta_printf("status:XX\nmessage:%s\n", buf);
152   fputs(buf, stderr);
153   fputc('\n', stderr);
154   box_exit(2);
155 }
156
157 /* Report an error of the program inside the sandbox */
158 static void NONRET __attribute__((format(printf,1,2)))
159 err(char *msg, ...)
160 {
161   va_list args;
162   va_start(args, msg);
163   flush_line();
164   if (msg[0] && msg[1] && msg[2] == ':' && msg[3] == ' ')
165     {
166       meta_printf("status:%c%c\n", msg[0], msg[1]);
167       msg += 4;
168     }
169   char buf[1024];
170   vsnprintf(buf, sizeof(buf), msg, args);
171   meta_printf("message:%s\n", buf);
172   fputs(buf, stderr);
173   fputc('\n', stderr);
174   box_exit(1);
175 }
176
177 /* Write a message, but only if in verbose mode */
178 static void __attribute__((format(printf,1,2)))
179 msg(char *msg, ...)
180 {
181   va_list args;
182   va_start(args, msg);
183   if (verbose)
184     {
185       int len = strlen(msg);
186       if (len > 0)
187         partial_line = (msg[len-1] != '\n');
188       vfprintf(stderr, msg, args);
189       fflush(stderr);
190     }
191   va_end(args);
192 }
193
194 static void *
195 xmalloc(size_t size)
196 {
197   void *p = malloc(size);
198   if (!p)
199     die("Out of memory");
200   return p;
201 }
202
203 /*** Syscall rules ***/
204
205 static const char * const syscall_names[] = {
206 #include "box/syscall-table.h"
207 };
208 #define NUM_SYSCALLS ARRAY_SIZE(syscall_names)
209 #define NUM_ACTIONS (NUM_SYSCALLS+64)
210
211 enum action {
212   A_DEFAULT,            // Use the default action
213   A_NO,                 // Always forbid
214   A_YES,                // Always permit
215   A_FILENAME,           // Permit if arg1 is a known filename
216   A_ACTION_MASK = 15,
217   A_NO_RETVAL = 32,     // Does not return a value
218   A_SAMPLE_MEM = 64,    // Sample memory usage before the syscall
219   A_LIBERAL = 128,      // Valid only in liberal mode
220   // Must fit in a unsigned char
221 };
222
223 static unsigned char syscall_action[NUM_ACTIONS] = {
224 #define S(x) [__NR_##x]
225
226     // Syscalls permitted for specific file names
227     S(open) = A_FILENAME,
228     S(creat) = A_FILENAME,
229     S(unlink) = A_FILENAME,
230     S(oldstat) = A_FILENAME,
231     S(access) = A_FILENAME,                     
232     S(oldlstat) = A_FILENAME,                   
233     S(truncate) = A_FILENAME,
234     S(stat) = A_FILENAME,
235     S(lstat) = A_FILENAME,
236     S(truncate64) = A_FILENAME,
237     S(stat64) = A_FILENAME,
238     S(lstat64) = A_FILENAME,
239     S(readlink) = A_FILENAME,
240
241     // Syscalls permitted always
242     S(exit) = A_YES | A_SAMPLE_MEM,
243     S(read) = A_YES,
244     S(write) = A_YES,
245     S(close) = A_YES,
246     S(lseek) = A_YES,
247     S(getpid) = A_YES,
248     S(getuid) = A_YES,
249     S(oldfstat) = A_YES,
250     S(dup) = A_YES,
251     S(brk) = A_YES,
252     S(getgid) = A_YES,
253     S(geteuid) = A_YES,
254     S(getegid) = A_YES,
255     S(dup2) = A_YES,
256     S(ftruncate) = A_YES,
257     S(fstat) = A_YES,
258     S(personality) = A_YES,
259     S(_llseek) = A_YES,
260     S(readv) = A_YES,
261     S(writev) = A_YES,
262     S(getresuid) = A_YES,
263 #ifdef __NR_pread64
264     S(pread64) = A_YES,
265     S(pwrite64) = A_YES,
266 #else
267     S(pread) = A_YES,
268     S(pwrite) = A_YES,
269 #endif
270     S(ftruncate64) = A_YES,
271     S(fstat64) = A_YES,
272     S(fcntl) = A_YES,
273     S(fcntl64) = A_YES,
274     S(mmap) = A_YES,
275     S(mmap2) = A_YES,
276     S(munmap) = A_YES,
277     S(ioctl) = A_YES,
278     S(uname) = A_YES,
279     S(gettid) = A_YES,
280     S(set_thread_area) = A_YES,
281     S(get_thread_area) = A_YES,
282     S(set_tid_address) = A_YES,
283     S(exit_group) = A_YES | A_SAMPLE_MEM,
284
285     // Syscalls permitted only in liberal mode
286     S(time) = A_YES | A_LIBERAL,
287     S(alarm) = A_YES | A_LIBERAL,
288     S(pause) = A_YES | A_LIBERAL,
289     S(signal) = A_YES | A_LIBERAL,
290     S(fchmod) = A_YES | A_LIBERAL,
291     S(sigaction) = A_YES | A_LIBERAL,
292     S(sgetmask) = A_YES | A_LIBERAL,
293     S(ssetmask) = A_YES | A_LIBERAL,
294     S(sigsuspend) = A_YES | A_LIBERAL,
295     S(sigpending) = A_YES | A_LIBERAL,
296     S(getrlimit) = A_YES | A_LIBERAL,
297     S(getrusage) = A_YES | A_LIBERAL,
298     S(ugetrlimit) = A_YES | A_LIBERAL,
299     S(gettimeofday) = A_YES | A_LIBERAL,
300     S(select) = A_YES | A_LIBERAL,
301     S(readdir) = A_YES | A_LIBERAL,
302     S(setitimer) = A_YES | A_LIBERAL,
303     S(getitimer) = A_YES | A_LIBERAL,
304     S(sigreturn) = A_YES | A_LIBERAL | A_NO_RETVAL,
305     S(mprotect) = A_YES | A_LIBERAL,
306     S(sigprocmask) = A_YES | A_LIBERAL,
307     S(getdents) = A_YES | A_LIBERAL,
308     S(getdents64) = A_YES | A_LIBERAL,
309     S(_newselect) = A_YES | A_LIBERAL,
310     S(fdatasync) = A_YES | A_LIBERAL,
311     S(mremap) = A_YES | A_LIBERAL,
312     S(poll) = A_YES | A_LIBERAL,
313     S(getcwd) = A_YES | A_LIBERAL,
314     S(nanosleep) = A_YES | A_LIBERAL,
315     S(rt_sigreturn) = A_YES | A_LIBERAL | A_NO_RETVAL,
316     S(rt_sigaction) = A_YES | A_LIBERAL,
317     S(rt_sigprocmask) = A_YES | A_LIBERAL,
318     S(rt_sigpending) = A_YES | A_LIBERAL,
319     S(rt_sigtimedwait) = A_YES | A_LIBERAL,
320     S(rt_sigqueueinfo) = A_YES | A_LIBERAL,
321     S(rt_sigsuspend) = A_YES | A_LIBERAL,
322     S(_sysctl) = A_YES | A_LIBERAL,
323 #undef S
324 };
325
326 static const char *
327 syscall_name(unsigned int id, char *buf)
328 {
329   if (id < NUM_SYSCALLS && syscall_names[id])
330     return syscall_names[id];
331   else
332     {
333       sprintf(buf, "#%d", id);
334       return buf;
335     }
336 }
337
338 static int
339 syscall_by_name(char *name)
340 {
341   for (unsigned int i=0; i<NUM_SYSCALLS; i++)
342     if (syscall_names[i] && !strcmp(syscall_names[i], name))
343       return i;
344   if (name[0] == '#')
345     name++;
346   if (!*name)
347     return -1;
348   char *ep;
349   unsigned long l = strtoul(name, &ep, 0);
350   if (*ep)
351     return -1;
352   if (l >= NUM_ACTIONS)
353     return NUM_ACTIONS;
354   return l;
355 }
356
357 static int
358 set_syscall_action(char *a)
359 {
360   char *sep = strchr(a, '=');
361   enum action act = A_YES;
362   if (sep)
363     {
364       *sep++ = 0;
365       if (!strcmp(sep, "yes"))
366         act = A_YES;
367       else if (!strcmp(sep, "no"))
368         act = A_NO;
369       else if (!strcmp(sep, "file"))
370         act = A_FILENAME;
371       else
372         return 0;
373     }
374
375   int sys = syscall_by_name(a);
376   if (sys < 0)
377     die("Unknown syscall `%s'", a);
378   if (sys >= NUM_ACTIONS)
379     die("Syscall `%s' out of range", a);
380   syscall_action[sys] = act;
381   return 1;
382 }
383
384 /*** Path rules ***/
385
386 struct path_rule {
387   char *path;
388   enum action action;
389   struct path_rule *next;
390 };
391
392 static struct path_rule default_path_rules[] = {
393   { "/etc/", A_YES },
394   { "/lib/", A_YES },
395   { "/usr/lib/", A_YES },
396   { "/opt/lib/", A_YES },
397   { "/usr/share/zoneinfo/", A_YES },
398   { "/usr/share/locale/", A_YES },
399   { "/dev/null", A_YES },
400   { "/dev/zero", A_YES },
401   { "/proc/meminfo", A_YES },
402   { "/proc/self/stat", A_YES },
403   { "/proc/self/exe", A_YES },                  // Needed by FPC 2.0.x runtime
404 };
405
406 static struct path_rule *user_path_rules;
407 static struct path_rule **last_path_rule = &user_path_rules;
408
409 static int
410 set_path_action(char *a)
411 {
412   char *sep = strchr(a, '=');
413   enum action act = A_YES;
414   if (sep)
415     {
416       *sep++ = 0;
417       if (!strcmp(sep, "yes"))
418         act = A_YES;
419       else if (!strcmp(sep, "no"))
420         act = A_NO;
421       else
422         return 0;
423     }
424
425   struct path_rule *r = xmalloc(sizeof(*r) + strlen(a) + 1);
426   r->path = (char *)(r+1);
427   strcpy(r->path, a);
428   r->action = act;
429   r->next = NULL;
430   *last_path_rule = r;
431   last_path_rule = &r->next;
432   return 1;
433 }
434
435 static enum action
436 match_path_rule(struct path_rule *r, char *path)
437 {
438   char *rr = r->path;
439   while (*rr)
440     if (*rr++ != *path++)
441       {
442         if (rr[-1] == '/' && !path[-1])
443           break;
444         return A_DEFAULT;
445       }
446   if (rr > r->path && rr[-1] != '/' && *path)
447     return A_DEFAULT;
448   return r->action;
449 }
450
451 /*** Environment rules ***/
452
453 struct env_rule {
454   char *var;                    // Variable to match
455   char *val;                    // ""=clear, NULL=inherit
456   int var_len;
457   struct env_rule *next;
458 };
459
460 static struct env_rule *first_env_rule;
461 static struct env_rule **last_env_rule = &first_env_rule;
462
463 static struct env_rule default_env_rules[] = {
464   { "LIBC_FATAL_STDERR_", "1" }
465 };
466
467 static int
468 set_env_action(char *a0)
469 {
470   struct env_rule *r = xmalloc(sizeof(*r) + strlen(a0) + 1);
471   char *a = (char *)(r+1);
472   strcpy(a, a0);
473
474   char *sep = strchr(a, '=');
475   if (sep == a)
476     return 0;
477   r->var = a;
478   if (sep)
479     {
480       *sep++ = 0;
481       r->val = sep;
482     }
483   else
484     r->val = NULL;
485   *last_env_rule = r;
486   last_env_rule = &r->next;
487   r->next = NULL;
488   return 1;
489 }
490
491 static int
492 match_env_var(char *env_entry, struct env_rule *r)
493 {
494   if (strncmp(env_entry, r->var, r->var_len))
495     return 0;
496   return (env_entry[r->var_len] == '=');
497 }
498
499 static void
500 apply_env_rule(char **env, int *env_sizep, struct env_rule *r)
501 {
502   // First remove the variable if already set
503   int pos = 0;
504   while (pos < *env_sizep && !match_env_var(env[pos], r))
505     pos++;
506   if (pos < *env_sizep)
507     {
508       (*env_sizep)--;
509       env[pos] = env[*env_sizep];
510       env[*env_sizep] = NULL;
511     }
512
513   // What is the new value?
514   char *new;
515   if (r->val)
516     {
517       if (!r->val[0])
518         return;
519       new = xmalloc(r->var_len + 1 + strlen(r->val) + 1);
520       sprintf(new, "%s=%s", r->var, r->val);
521     }
522   else
523     {
524       pos = 0;
525       while (environ[pos] && !match_env_var(environ[pos], r))
526         pos++;
527       if (!(new = environ[pos]))
528         return;
529     }
530
531   // Add it at the end of the array
532   env[(*env_sizep)++] = new;
533   env[*env_sizep] = NULL;
534 }
535
536 static char **
537 setup_environment(void)
538 {
539   // Link built-in rules with user rules
540   for (int i=ARRAY_SIZE(default_env_rules)-1; i >= 0; i--)
541     {
542       default_env_rules[i].next = first_env_rule;
543       first_env_rule = &default_env_rules[i];
544     }
545
546   // Scan the original environment
547   char **orig_env = environ;
548   int orig_size = 0;
549   while (orig_env[orig_size])
550     orig_size++;
551
552   // For each rule, reserve one more slot and calculate length
553   int num_rules = 0;
554   for (struct env_rule *r = first_env_rule; r; r=r->next)
555     {
556       num_rules++;
557       r->var_len = strlen(r->var);
558     }
559
560   // Create a new environment
561   char **env = xmalloc((orig_size + num_rules + 1) * sizeof(char *));
562   int size;
563   if (pass_environ)
564     {
565       memcpy(env, environ, orig_size * sizeof(char *));
566       size = orig_size;
567     }
568   else
569     size = 0;
570   env[size] = NULL;
571
572   // Apply the rules one by one
573   for (struct env_rule *r = first_env_rule; r; r=r->next)
574     apply_env_rule(env, &size, r);
575
576   // Return the new env and pass some gossip
577   if (verbose > 1)
578     {
579       fprintf(stderr, "Passing environment:\n");
580       for (int i=0; env[i]; i++)
581         fprintf(stderr, "\t%s\n", env[i]);
582     }
583   return env;
584 }
585
586 /*** Syscall checks ***/
587
588 static void
589 valid_filename(unsigned long addr)
590 {
591   char namebuf[4096], *p, *end;
592   static int mem_fd;
593
594   if (!file_access)
595     err("FA: File access forbidden");
596   if (file_access >= 9)
597     return;
598
599   if (!mem_fd)
600     {
601       sprintf(namebuf, "/proc/%d/mem", (int) box_pid);
602       mem_fd = open(namebuf, O_RDONLY);
603       if (mem_fd < 0)
604         die("open(%s): %m", namebuf);
605     }
606   p = end = namebuf;
607   do
608     {
609       if (p >= end)
610         {
611           int remains = PAGE_SIZE - (addr & (PAGE_SIZE-1));
612           int l = namebuf + sizeof(namebuf) - end;
613           if (l > remains)
614             l = remains;
615           if (!l)
616             err("FA: Access to file with name too long");
617           if (lseek64(mem_fd, addr, SEEK_SET) < 0)
618             die("lseek64(mem): %m");
619           remains = read(mem_fd, end, l);
620           if (remains < 0)
621             die("read(mem): %m");
622           if (!remains)
623             err("FA: Access to file with name out of memory");
624           end += l;
625           addr += l;
626         }
627     }
628   while (*p++);
629
630   msg("[%s] ", namebuf);
631   if (file_access >= 3)
632     return;
633
634   // Everything in current directory is permitted
635   if (!strchr(namebuf, '/') && strcmp(namebuf, ".."))
636     return;
637
638   // ".." anywhere in the path is forbidden
639   enum action act = A_DEFAULT;
640   if (strstr(namebuf, ".."))
641     act = A_NO;
642
643   // Scan user rules
644   for (struct path_rule *r = user_path_rules; r && !act; r=r->next)
645     act = match_path_rule(r, namebuf);
646
647   // Scan built-in rules
648   if (file_access >= 2)
649     for (int i=0; i<ARRAY_SIZE(default_path_rules) && !act; i++)
650       act = match_path_rule(&default_path_rules[i], namebuf);
651
652   if (act != A_YES)
653     err("FA: Forbidden access to file `%s'", namebuf);
654 }
655
656 // Check syscall. If invalid, return -1, otherwise return the action mask.
657 static int
658 valid_syscall(struct user *u)
659 {
660   unsigned int sys = u->regs.orig_eax;
661   unsigned int act = (sys < NUM_ACTIONS) ? syscall_action[sys] : A_DEFAULT;
662
663   if (act & A_LIBERAL)
664     {
665       if (filter_syscalls != 1)
666         act = A_DEFAULT;
667     }
668
669   switch (act & A_ACTION_MASK)
670     {
671     case A_YES:
672       return act;
673     case A_NO:
674       return -1;
675     case A_FILENAME:
676       valid_filename(u->regs.ebx);
677       return act;
678     default: ;
679     }
680
681   switch (sys)
682     {
683     case __NR_kill:
684       if (u->regs.ebx == box_pid)
685         {
686           meta_printf("exitsig:%d\n", (int)u->regs.ecx);
687           err("SG: Committed suicide by signal %d", (int)u->regs.ecx);
688         }
689       return -1;
690     case __NR_tgkill:
691       if (u->regs.ebx == box_pid && u->regs.ecx == box_pid)
692         {
693           meta_printf("exitsig:%d\n", (int)u->regs.edx);
694           err("SG: Committed suicide by signal %d", (int)u->regs.edx);
695         }
696       return -1;
697     default:
698       return -1;
699     }
700 }
701
702 static void
703 signal_alarm(int unused UNUSED)
704 {
705   /* Time limit checks are synchronous, so we only schedule them there. */
706   timer_tick = 1;
707   alarm(1);
708 }
709
710 static void
711 signal_int(int unused UNUSED)
712 {
713   /* Interrupts are fatal, so no synchronization requirements. */
714   meta_printf("exitsig:%d\n", SIGINT);
715   err("SG: Interrupted");
716 }
717
718 #define PROC_BUF_SIZE 4096
719 static void
720 read_proc_file(char *buf, char *name, int *fdp)
721 {
722   int c;
723
724   if (!*fdp)
725     {
726       sprintf(buf, "/proc/%d/%s", (int) box_pid, name);
727       *fdp = open(buf, O_RDONLY);
728       if (*fdp < 0)
729         die("open(%s): %m", buf);
730     }
731   lseek(*fdp, 0, SEEK_SET);
732   if ((c = read(*fdp, buf, PROC_BUF_SIZE-1)) < 0)
733     die("read on /proc/$pid/%s: %m", name);
734   if (c >= PROC_BUF_SIZE-1)
735     die("/proc/$pid/%s too long", name);
736   buf[c] = 0;
737 }
738
739 static void
740 check_timeout(void)
741 {
742   if (wall_timeout)
743     {
744       struct timeval now, wall;
745       int wall_ms;
746       gettimeofday(&now, NULL);
747       timersub(&now, &start_time, &wall);
748       wall_ms = wall.tv_sec*1000 + wall.tv_usec/1000;
749       if (wall_ms > wall_timeout)
750         err("TO: Time limit exceeded (wall clock)");
751       if (verbose > 1)
752         fprintf(stderr, "[wall time check: %d msec]\n", wall_ms);
753     }
754   if (timeout)
755     {
756       char buf[PROC_BUF_SIZE], *x;
757       int utime, stime, ms;
758       static int proc_stat_fd;
759       read_proc_file(buf, "stat", &proc_stat_fd);
760       x = buf;
761       while (*x && *x != ' ')
762         x++;
763       while (*x == ' ')
764         x++;
765       if (*x++ != '(')
766         die("proc stat syntax error 1");
767       while (*x && (*x != ')' || x[1] != ' '))
768         x++;
769       while (*x == ')' || *x == ' ')
770         x++;
771       if (sscanf(x, "%*c %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d %d %d", &utime, &stime) != 2)
772         die("proc stat syntax error 2");
773       ms = (utime + stime) * 1000 / ticks_per_sec;
774       if (verbose > 1)
775         fprintf(stderr, "[time check: %d msec]\n", ms);
776       if (ms > timeout && ms > extra_timeout)
777         err("TO: Time limit exceeded");
778     }
779 }
780
781 static void
782 sample_mem_peak(void)
783 {
784   /*
785    *  We want to find out the peak memory usage of the process, which is
786    *  maintained by the kernel, but unforunately it gets lost when the
787    *  process exits (it is not reported in struct rusage). Therefore we
788    *  have to sample it whenever we suspect that the process is about
789    *  to exit.
790    */
791   char buf[PROC_BUF_SIZE], *x;
792   static int proc_status_fd;
793   read_proc_file(buf, "status", &proc_status_fd);
794
795   x = buf;
796   while (*x)
797     {
798       char *key = x;
799       while (*x && *x != ':' && *x != '\n')
800         x++;
801       if (!*x || *x == '\n')
802         break;
803       *x++ = 0;
804       while (*x == ' ' || *x == '\t')
805         x++;
806
807       char *val = x;
808       while (*x && *x != '\n')
809         x++;
810       if (!*x)
811         break;
812       *x++ = 0;
813
814       if (!strcmp(key, "VmPeak"))
815         {
816           int peak = atoi(val);
817           if (peak > mem_peak_kb)
818             mem_peak_kb = peak;
819         }
820     }
821
822   if (verbose > 1)
823     msg("[mem-peak: %u KB]\n", mem_peak_kb);
824 }
825
826 static void
827 boxkeeper(void)
828 {
829   int syscall_count = 0;
830   struct sigaction sa;
831
832   is_ptraced = 1;
833   bzero(&sa, sizeof(sa));
834   sa.sa_handler = signal_int;
835   sigaction(SIGINT, &sa, NULL);
836   gettimeofday(&start_time, NULL);
837   ticks_per_sec = sysconf(_SC_CLK_TCK);
838   if (ticks_per_sec <= 0)
839     die("Invalid ticks_per_sec!");
840   if (timeout || wall_timeout)
841     {
842       sa.sa_handler = signal_alarm;
843       sigaction(SIGALRM, &sa, NULL);
844       alarm(1);
845     }
846   for(;;)
847     {
848       struct rusage rus;
849       int stat;
850       pid_t p;
851       if (timer_tick)
852         {
853           check_timeout();
854           timer_tick = 0;
855         }
856       p = wait4(box_pid, &stat, WUNTRACED, &rus);
857       if (p < 0)
858         {
859           if (errno == EINTR)
860             continue;
861           die("wait4: %m");
862         }
863       if (p != box_pid)
864         die("wait4: unknown pid %d exited!", p);
865       if (WIFEXITED(stat))
866         {
867           box_pid = 0;
868           final_stats(&rus);
869           if (WEXITSTATUS(stat))
870             {
871               if (syscall_count)
872                 {
873                   meta_printf("exitcode:%d\n", WEXITSTATUS(stat));
874                   err("RE: Exited with error status %d", WEXITSTATUS(stat));
875                 }
876               else
877                 {
878                   // Internal error happened inside the child process and it has been already reported.
879                   box_exit(2);
880                 }
881             }
882           if (timeout && total_ms > timeout)
883             err("TO: Time limit exceeded");
884           if (wall_timeout && wall_ms > wall_timeout)
885             err("TO: Time limit exceeded (wall clock)");
886           flush_line();
887           fprintf(stderr, "OK (%d.%03d sec real, %d.%03d sec wall, %d MB, %d syscalls)\n",
888               total_ms/1000, total_ms%1000,
889               wall_ms/1000, wall_ms%1000,
890               (mem_peak_kb + 1023) / 1024,
891               syscall_count);
892           box_exit(0);
893         }
894       if (WIFSIGNALED(stat))
895         {
896           box_pid = 0;
897           meta_printf("exitsig:%d\n", WTERMSIG(stat));
898           final_stats(&rus);
899           err("SG: Caught fatal signal %d%s", WTERMSIG(stat), (syscall_count ? "" : " during startup"));
900         }
901       if (WIFSTOPPED(stat))
902         {
903           int sig = WSTOPSIG(stat);
904           if (sig == SIGTRAP)
905             {
906               if (verbose > 2)
907                 msg("[ptrace status %08x] ", stat);
908               static int stop_count;
909               if (!stop_count++)                /* Traceme request */
910                 msg(">> Traceme request caught\n");
911               else
912                 err("SG: Breakpoint");
913               ptrace(PTRACE_SYSCALL, box_pid, 0, 0);
914             }
915           else if (sig == (SIGTRAP | 0x80))
916             {
917               if (verbose > 2)
918                 msg("[ptrace status %08x] ", stat);
919               struct user u;
920               static unsigned int sys_tick, last_sys, last_act;
921               if (ptrace(PTRACE_GETREGS, box_pid, NULL, &u) < 0)
922                 die("ptrace(PTRACE_GETREGS): %m");
923               unsigned int sys = u.regs.orig_eax;
924               if (++sys_tick & 1)               /* Syscall entry */
925                 {
926                   char namebuf[32];
927                   int act;
928                   msg(">> Syscall %-12s (%08lx,%08lx,%08lx) ", syscall_name(sys, namebuf), u.regs.ebx, u.regs.ecx, u.regs.edx);
929                   if (!exec_seen)
930                     {
931                       msg("[master] ");
932                       if (sys == __NR_execve)
933                         exec_seen = 1;
934                     }
935                   else if ((act = valid_syscall(&u)) >= 0)
936                     {
937                       last_act = act;
938                       syscall_count++;
939                       if (act & A_SAMPLE_MEM)
940                         sample_mem_peak();
941                     }
942                   else
943                     {
944                       /*
945                        * Unfortunately, PTRACE_KILL kills _after_ the syscall completes,
946                        * so we have to change it to something harmless (e.g., an undefined
947                        * syscall) and make the program continue.
948                        */
949                       u.regs.orig_eax = 0xffffffff;
950                       if (ptrace(PTRACE_SETREGS, box_pid, NULL, &u) < 0)
951                         die("ptrace(PTRACE_SETREGS): %m");
952                       err("FO: Forbidden syscall %s", syscall_name(sys, namebuf));
953                     }
954                   last_sys = sys;
955                 }
956               else                                      /* Syscall return */
957                 {
958                   if (sys == 0xffffffff)
959                     {
960                       /* Some syscalls (sigreturn et al.) do not return a value */
961                       if (!(last_act & A_NO_RETVAL))
962                         err("XX: Syscall does not return, but it should");
963                     }
964                   else
965                     {
966                       if (sys != last_sys)
967                         err("XX: Mismatched syscall entry/exit");
968                     }
969                   if (last_act & A_NO_RETVAL)
970                     msg("= ?\n");
971                   else
972                     msg("= %ld\n", u.regs.eax);
973                 }
974               ptrace(PTRACE_SYSCALL, box_pid, 0, 0);
975             }
976           else if (sig == SIGSTOP)
977             {
978               msg(">> SIGSTOP\n");
979               if (ptrace(PTRACE_SETOPTIONS, box_pid, NULL, (void *) PTRACE_O_TRACESYSGOOD) < 0)
980                 die("ptrace(PTRACE_SETOPTIONS): %m");
981               ptrace(PTRACE_SYSCALL, box_pid, 0, 0);
982             }
983           else if (sig != SIGXCPU && sig != SIGXFSZ)
984             {
985               msg(">> Signal %d\n", sig);
986               sample_mem_peak();                        /* Signal might be fatal, so update mem-peak */
987               ptrace(PTRACE_SYSCALL, box_pid, 0, sig);
988             }
989           else
990             {
991               meta_printf("exitsig:%d", sig);
992               err("SG: Received signal %d", sig);
993             }
994         }
995       else
996         die("wait4: unknown status %x, giving up!", stat);
997     }
998 }
999
1000 static void
1001 box_inside(int argc, char **argv)
1002 {
1003   struct rlimit rl;
1004   char *args[argc+1];
1005
1006   memcpy(args, argv, argc * sizeof(char *));
1007   args[argc] = NULL;
1008   if (set_cwd && chdir(set_cwd))
1009     die("chdir: %m");
1010   if (redir_stdin)
1011     {
1012       close(0);
1013       if (open(redir_stdin, O_RDONLY) != 0)
1014         die("open(\"%s\"): %m", redir_stdin);
1015     }
1016   if (redir_stdout)
1017     {
1018       close(1);
1019       if (open(redir_stdout, O_WRONLY | O_CREAT | O_TRUNC, 0666) != 1)
1020         die("open(\"%s\"): %m", redir_stdout);
1021     }
1022   if (redir_stderr)
1023     {
1024       close(2);
1025       if (open(redir_stderr, O_WRONLY | O_CREAT | O_TRUNC, 0666) != 2)
1026         die("open(\"%s\"): %m", redir_stderr);
1027     }
1028   else
1029     dup2(1, 2);
1030   setpgrp();
1031   if (memory_limit)
1032     {
1033       rl.rlim_cur = rl.rlim_max = memory_limit * 1024;
1034       if (setrlimit(RLIMIT_AS, &rl) < 0)
1035         die("setrlimit: %m");
1036     }
1037   rl.rlim_cur = rl.rlim_max = 64;
1038   if (setrlimit(RLIMIT_NOFILE, &rl) < 0)
1039     die("setrlimit: %m");
1040   char **env = setup_environment();
1041   if (filter_syscalls)
1042     {
1043       if (ptrace(PTRACE_TRACEME) < 0)
1044         die("ptrace(PTRACE_TRACEME): %m");
1045       /* Trick: Make sure that we are stopped until the boxkeeper wakes up. */
1046       raise(SIGSTOP);
1047     }
1048   execve(args[0], args, env);
1049   die("execve(\"%s\"): %m", args[0]);
1050 }
1051
1052 static void
1053 usage(void)
1054 {
1055   fprintf(stderr, "Invalid arguments!\n");
1056   printf("\
1057 Usage: box [<options>] -- <command> <arguments>\n\
1058 \n\
1059 Options:\n\
1060 -a <level>\tSet file access level (0=none, 1=cwd, 2=/etc,/lib,..., 3=whole fs, 9=no checks; needs -f)\n\
1061 -c <dir>\tChange directory to <dir> first\n\
1062 -e\t\tInherit full environment of the parent process\n\
1063 -E <var>\tInherit the environment variable <var> from the parent process\n\
1064 -E <var>=<val>\tSet the environment variable <var> to <val>; unset it if <var> is empty\n\
1065 -f\t\tFilter system calls (-ff=very restricted)\n\
1066 -i <file>\tRedirect stdin from <file>\n\
1067 -m <size>\tLimit address space to <size> KB\n\
1068 -M <file>\tOutput process information to <file> (name:value)\n\
1069 -o <file>\tRedirect stdout to <file>\n\
1070 -p <path>\tPermit access to the specified path (or subtree if it ends with a `/')\n\
1071 -p <path>=<act>\tDefine action for the specified path (<act>=yes/no)\n\
1072 -r <file>\tRedirect stderr to <file>\n\
1073 -s <sys>\tPermit the specified syscall (be careful)\n\
1074 -s <sys>=<act>\tDefine action for the specified syscall (<act>=yes/no/file)\n\
1075 -t <time>\tSet run time limit (seconds, fractions allowed)\n\
1076 -T\t\tAllow syscalls for measuring run time\n\
1077 -v\t\tBe verbose (use multiple times for even more verbosity)\n\
1078 -w <time>\tSet wall clock time limit (seconds, fractions allowed)\n\
1079 -x <time>\tSet extra timeout, before which a timing-out program is not yet killed,\n\
1080 \t\tso that its real execution time is reported (seconds, fractions allowed)\n\
1081 ");
1082   exit(2);
1083 }
1084
1085 int
1086 main(int argc, char **argv)
1087 {
1088   int c;
1089   uid_t uid;
1090
1091   while ((c = getopt(argc, argv, "a:c:eE:fi:m:M:o:p:r:s:t:Tvw:x:")) >= 0)
1092     switch (c)
1093       {
1094       case 'a':
1095         file_access = atol(optarg);
1096         break;
1097       case 'c':
1098         set_cwd = optarg;
1099         break;
1100       case 'e':
1101         pass_environ = 1;
1102         break;
1103       case 'E':
1104         if (!set_env_action(optarg))
1105           usage();
1106         break;
1107       case 'f':
1108         filter_syscalls++;
1109         break;
1110       case 'i':
1111         redir_stdin = optarg;
1112         break;
1113       case 'm':
1114         memory_limit = atol(optarg);
1115         break;
1116       case 'M':
1117         meta_open(optarg);
1118         break;
1119       case 'o':
1120         redir_stdout = optarg;
1121         break;
1122       case 'p':
1123         if (!set_path_action(optarg))
1124           usage();
1125         break;
1126       case 'r':
1127         redir_stderr = optarg;
1128         break;
1129       case 's':
1130         if (!set_syscall_action(optarg))
1131           usage();
1132         break;
1133       case 't':
1134         timeout = 1000*atof(optarg);
1135         break;
1136       case 'T':
1137         syscall_action[__NR_times] = A_YES;
1138         break;
1139       case 'v':
1140         verbose++;
1141         break;
1142       case 'w':
1143         wall_timeout = 1000*atof(optarg);
1144         break;
1145       case 'x':
1146         extra_timeout = 1000*atof(optarg);
1147         break;
1148       default:
1149         usage();
1150       }
1151   if (optind >= argc)
1152     usage();
1153
1154   uid = geteuid();
1155   if (setreuid(uid, uid) < 0)
1156     die("setreuid: %m");
1157   box_pid = fork();
1158   if (box_pid < 0)
1159     die("fork: %m");
1160   if (!box_pid)
1161     box_inside(argc-optind, argv+optind);
1162   else
1163     boxkeeper();
1164   die("Internal error: fell over edge of the world");
1165 }