source: zzuf/trunk/src/zzuf.c @ 1613

Last change on this file since 1613 was 1613, checked in by Sam Hocevar, 14 years ago
  • If no argument is given, just fuzz standard input.
  • Property svn:keywords set to Id
File size: 19.6 KB
Line 
1/*
2 *  zzuf - general purpose fuzzer
3 *  Copyright (c) 2002, 2007 Sam Hocevar <sam@zoy.org>
4 *                All Rights Reserved
5 *
6 *  $Id: zzuf.c 1613 2007-01-07 18:18:50Z sam $
7 *
8 *  This program is free software. It comes without any warranty, to
9 *  the extent permitted by applicable law. You can redistribute it
10 *  and/or modify it under the terms of the Do What The Fuck You Want
11 *  To Public License, Version 2, as published by Sam Hocevar. See
12 *  http://sam.zoy.org/wtfpl/COPYING for more details.
13 */
14
15/*
16 *  main.c: main program
17 */
18
19#include "config.h"
20
21#if defined HAVE_STDINT_H
22#   include <stdint.h>
23#elif defined HAVE_INTTYPES_H
24#   include <inttypes.h>
25#endif
26#if defined(HAVE_GETOPT_H)
27#   include <getopt.h>
28#endif
29#include <stdio.h>
30#include <stdlib.h>
31#include <unistd.h>
32#include <regex.h>
33#include <string.h>
34#include <errno.h>
35#include <signal.h>
36#include <sys/time.h>
37#include <time.h>
38#include <sys/wait.h>
39
40#include "libzzuf.h"
41#include "random.h"
42#include "chars.h"
43#include "fd.h"
44#include "fuzz.h"
45
46static void spawn_child(char **);
47static void clean_children(void);
48static void read_children(void);
49
50static char *merge_regex(char *, char *);
51static char *merge_file(char *, char *);
52static void set_environment(char const *);
53static void version(void);
54#if defined(HAVE_GETOPT_H)
55static void usage(void);
56#endif
57
58/* Global tables */
59int   _zz_protect[256];
60int   _zz_refuse[256];
61
62static struct child_list
63{
64    enum status
65    {
66        STATUS_FREE,
67        STATUS_RUNNING,
68        STATUS_SIGTERM,
69        STATUS_SIGKILL,
70        STATUS_EOF,
71    } status;
72
73    pid_t pid;
74    int fd[3]; /* 0 is debug, 1 is stderr, 2 is stdout */
75    int bytes, seed;
76    time_t date;
77} *child_list;
78static int maxforks = 1, child_count = 0, maxcrashes = 1, crashes = 0;
79
80static int seed = 0;
81static int endseed = 1;
82static int quiet = 0;
83static int maxbytes = -1;
84static double maxtime = -1.0;
85
86#define ZZUF_FD_SET(fd, p_fdset, maxfd) \
87    if(fd >= 0) \
88    { \
89        FD_SET(fd, p_fdset); \
90        if(fd > maxfd) \
91            maxfd = fd; \
92    }
93
94#define ZZUF_FD_ISSET(fd, p_fdset) \
95    ((fd >= 0) && (FD_ISSET(fd, p_fdset)))
96
97int main(int argc, char *argv[])
98{
99    char **newargv;
100    char *parser, *include, *exclude, *protect, *refuse;
101    int i, cmdline = 0;
102
103    include = exclude = protect = refuse = NULL;
104
105#if defined(HAVE_GETOPT_H)
106    for(;;)
107    {
108#   ifdef HAVE_GETOPT_LONG
109#       define MOREINFO "Try `%s --help' for more information.\n"
110        int option_index = 0;
111        static struct option long_options[] =
112        {
113            /* Long option, needs arg, flag, short option */
114            { "max-bytes",   1, NULL, 'B' },
115            { "cmdline",     0, NULL, 'c' },
116            { "max-crashes", 1, NULL, 'C' },
117            { "debug",       0, NULL, 'd' },
118            { "exclude",     1, NULL, 'E' },
119            { "max-forks",   1, NULL, 'F' },
120            { "stdin",       0, NULL, 'i' },
121            { "include",     1, NULL, 'I' },
122            { "network",     0, NULL, 'n' },
123            { "protect",     1, NULL, 'P' },
124            { "quiet",       0, NULL, 'q' },
125            { "ratio",       1, NULL, 'r' },
126            { "refuse",      1, NULL, 'R' },
127            { "seed",        1, NULL, 's' },
128            { "signal",      0, NULL, 'S' },
129            { "max-time",    1, NULL, 'T' },
130            { "help",        0, NULL, 'h' },
131            { "version",     0, NULL, 'v' },
132        };
133        int c = getopt_long(argc, argv, "B:cC:dE:F:iI:nP:qr:R:s:ST:hv",
134                            long_options, &option_index);
135#   else
136#       define MOREINFO "Try `%s -h' for more information.\n"
137        int c = getopt(argc, argv, "B:cC:dE:F:iI:nP:qr:R:s:ST:hv");
138#   endif
139        if(c == -1)
140            break;
141
142        switch(c)
143        {
144        case 'B': /* --max-bytes */
145            maxbytes = atoi(optarg);
146            break;
147        case 'c': /* --cmdline */
148            cmdline = 1;
149            break;
150        case 'C': /* --max-crashes */
151            maxcrashes = atoi(optarg);
152            if(maxcrashes <= 0)
153                maxcrashes = 0;
154            break;
155        case 'd': /* --debug */
156            setenv("ZZUF_DEBUG", "1", 1);
157            break;
158        case 'E': /* --exclude */
159            exclude = merge_regex(exclude, optarg);
160            if(!exclude)
161            {
162                printf("%s: invalid regex -- `%s'\n", argv[0], optarg);
163                return EXIT_FAILURE;
164            }
165            break;
166        case 'F': /* --max-forks */
167            maxforks = atoi(optarg) > 1 ? atoi(optarg) : 1;
168            break;
169        case 'i': /* --stdin */
170            setenv("ZZUF_STDIN", "1", 1);
171            break;
172        case 'I': /* --include */
173            include = merge_regex(include, optarg);
174            if(!include)
175            {
176                printf("%s: invalid regex -- `%s'\n", argv[0], optarg);
177                return EXIT_FAILURE;
178            }
179            break;
180        case 'n': /* --network */
181            setenv("ZZUF_NETWORK", "1", 1);
182            break;
183        case 'P': /* --protect */
184            protect = optarg;
185            break;
186        case 'q': /* --quiet */
187            quiet = 1;
188            break;
189        case 'r': /* --ratio */
190            setenv("ZZUF_RATIO", optarg, 1);
191            _zz_setratio(atof(optarg));
192            break;
193        case 'R': /* --refuse */
194            refuse = optarg;
195            break;
196        case 's': /* --seed */
197            parser = strchr(optarg, ':');
198            _zz_setseed(seed = atol(optarg));
199            endseed = parser ? atoi(parser + 1) : seed + 1;
200            break;
201        case 'S': /* --signal */
202            setenv("ZZUF_SIGNAL", "1", 1);
203            break;
204        case 'T': /* --max-time */
205            maxtime = atof(optarg);
206            break;
207        case 'h': /* --help */
208            usage();
209            return 0;
210        case 'v': /* --version */
211            version();
212            return 0;
213        default:
214            printf("%s: invalid option -- %c\n", argv[0], c);
215            printf(MOREINFO, argv[0]);
216            return EXIT_FAILURE;
217        }
218    }
219#else
220#   define MOREINFO "Usage: %s message...\n"
221    int optind = 1;
222#endif
223
224    /* If asked to read from the standard input */
225    if(optind >= argc)
226    {
227        if(endseed != seed + 1)
228        {
229            printf("%s: seed ranges are incompatible with stdin fuzzing\n",
230                   argv[0]);
231            printf(MOREINFO, argv[0]);
232            return EXIT_FAILURE;
233        }
234
235        if(protect)
236            _zz_readchars(_zz_protect, protect);
237        if(refuse)
238            _zz_readchars(_zz_refuse, protect);
239
240        _zz_fd_init();
241        _zz_register(0);
242
243        for(;;)
244        {
245            uint8_t buf[12];
246            int ret = fread(buf, 1, 12, stdin);
247            if(ret <= 0)
248                break;
249
250            _zz_fuzz(0, buf, ret);
251            _zz_addpos(0, ret);
252
253            fwrite(buf, 1, ret, stdout);
254        }
255
256        _zz_unregister(0);
257        _zz_fd_fini();
258
259        return EXIT_SUCCESS;
260    }
261
262    if(cmdline)
263    {
264        int dashdash = 0;
265
266        for(i = optind + 1; i < argc; i++)
267        {
268            if(dashdash)
269                include = merge_file(include, argv[i]);
270            else if(!strcmp("--", argv[i]))
271                dashdash = 1;
272            else if(argv[i][0] != '-')
273                include = merge_file(include, argv[i]);
274        }
275    }
276
277    if(include)
278        setenv("ZZUF_INCLUDE", include, 1);
279    if(exclude)
280        setenv("ZZUF_EXCLUDE", exclude, 1);
281    if(protect)
282        setenv("ZZUF_PROTECT", protect, 1);
283    if(refuse)
284        setenv("ZZUF_REFUSE", refuse, 1);
285
286    /* Allocate memory for children handling */
287    child_list = malloc(maxforks * sizeof(struct child_list));
288    for(i = 0; i < maxforks; i++)
289        child_list[i].status = STATUS_FREE;
290    child_count = 0;
291
292    /* Preload libzzuf.so */
293    set_environment(argv[0]);
294
295    /* Create new argv */
296    newargv = malloc((argc - optind + 1) * sizeof(char *));
297    memcpy(newargv, argv + optind, (argc - optind) * sizeof(char *));
298    newargv[argc - optind] = (char *)NULL;
299
300    /* Main loop */
301    while(child_count || seed < endseed)
302    {
303        /* Spawn one new child, if necessary */
304        if(child_count < maxforks && seed < endseed &&
305                             (maxcrashes && crashes < maxcrashes))
306            spawn_child(newargv);
307
308        /* Cleanup dead or dying children */
309        clean_children();
310
311        /* Read data from children */
312        read_children();
313
314        if(maxcrashes && crashes >= maxcrashes && child_count == 0)
315            break;
316    }
317
318    /* Clean up */
319    free(newargv);
320    free(child_list);
321
322    return EXIT_SUCCESS;   
323}
324
325static char *merge_file(char *regex, char *file)
326{
327    char *newfile = malloc(1 + 2 * strlen(file) + 1 + 1), *tmp = newfile;
328
329    *tmp++ = '^';
330    while(*file)
331    {
332        if(strchr("^.[$()|*+?{\\", *file))
333            *tmp++ = '\\';
334        *tmp++ = *file++;
335    }
336    *tmp++ = '$';
337    *tmp++ = '\0';
338
339    tmp = merge_regex(regex, newfile);
340    free(newfile);
341    return tmp;
342}
343
344static char *merge_regex(char *regex, char *string)
345{
346    regex_t optre;
347
348    if(regex)
349    {
350        regex = realloc(regex, strlen(regex) + strlen(string) + 1 + 1);
351        sprintf(regex + strlen(regex) - 1, "|%s)", string);
352    }
353    else
354    {
355        regex = malloc(1 + strlen(string) + 1 + 1);
356        sprintf(regex, "(%s)", string);
357    }
358
359    if(regcomp(&optre, regex, REG_EXTENDED) != 0)
360    {
361        free(regex);
362        return NULL;
363    }
364    regfree(&optre);
365
366    return regex;
367}
368
369static void spawn_child(char **argv)
370{
371    static int const files[] = { DEBUG_FILENO, STDERR_FILENO, STDOUT_FILENO };
372    char buf[BUFSIZ];
373    int fd[3][2];
374    pid_t pid;
375    int i, j;
376
377    /* Find an empty slot */
378    for(i = 0; i < maxforks; i++)
379        if(child_list[i].status == STATUS_FREE)
380            break;
381
382    /* Prepare communication pipe */
383    for(j = 0; j < 3; j++)
384        if(pipe(fd[j]) == -1)
385        {
386            perror("pipe");
387            return;
388        }
389
390    /* Fork and launch child */
391    pid = fork();
392    switch(pid)
393    {
394        case -1:
395            perror("fork");
396            return;
397        case 0:
398            /* We’re the child */
399            for(j = 0; j < 3; j++)
400            {
401                close(fd[j][0]);
402                dup2(fd[j][1], files[j]);
403                close(fd[j][1]);
404            }
405
406            /* Set environment variables */
407            sprintf(buf, "%i", seed);
408            setenv("ZZUF_SEED", buf, 1);
409
410            /* Run our process */
411            if(execvp(argv[0], argv))
412            {
413                perror(argv[0]);
414                exit(EXIT_FAILURE);
415            }
416            break;
417        default:
418            /* We’re the parent, acknowledge spawn */
419            child_list[i].date = time(NULL);
420            child_list[i].pid = pid;
421            for(j = 0; j < 3; j++)
422            {
423                close(fd[j][1]);
424                child_list[i].fd[j] = fd[j][0];
425            }
426            child_list[i].bytes = 0;
427            child_list[i].seed = seed;
428            child_list[i].status = STATUS_RUNNING;
429            child_count++;
430            seed++;
431            break;
432    }
433}
434
435static void clean_children(void)
436{
437    time_t now = time(NULL);
438    int i, j;
439
440    /* Terminate children if necessary */
441    for(i = 0; i < maxforks; i++)
442    {
443        if(child_list[i].status == STATUS_RUNNING
444            && maxbytes >= 0 && child_list[i].bytes > maxbytes)
445        {
446            fprintf(stdout, "zzuf[seed=%i]: data exceeded, sending SIGTERM\n",
447                    child_list[i].seed);
448            kill(child_list[i].pid, SIGTERM);
449            child_list[i].date = now;
450            child_list[i].status = STATUS_SIGTERM;
451        }
452
453        if(child_list[i].status == STATUS_RUNNING
454            && maxtime >= 0.0
455            && difftime(now, child_list[i].date) > maxtime)
456        {
457            fprintf(stdout, "zzuf[seed=%i]: time exceeded, sending SIGTERM\n",
458                    child_list[i].seed);
459            kill(child_list[i].pid, SIGTERM);
460            child_list[i].date = now;
461            child_list[i].status = STATUS_SIGTERM;
462        }
463    }
464
465    /* Kill children if necessary */
466    for(i = 0; i < maxforks; i++)
467    {
468        if(child_list[i].status == STATUS_SIGTERM
469            && difftime(now, child_list[i].date) > 2.0)
470        {
471            fprintf(stdout, "zzuf[seed=%i]: not responding, sending SIGKILL\n",
472                    child_list[i].seed);
473            kill(child_list[i].pid, SIGKILL);
474            child_list[i].status = STATUS_SIGKILL;
475        }
476    }
477
478    /* Collect dead children */
479    for(i = 0; i < maxforks; i++)
480    {
481        int status;
482        pid_t pid;
483
484        if(child_list[i].status != STATUS_SIGKILL
485            && child_list[i].status != STATUS_SIGTERM
486            && child_list[i].status != STATUS_EOF)
487            continue;
488
489        pid = waitpid(child_list[i].pid, &status, WNOHANG);
490        if(pid <= 0)
491            continue;
492
493        if(WIFEXITED(status) && WEXITSTATUS(status))
494        {
495            fprintf(stdout, "zzuf[seed=%i]: exit %i\n",
496                    child_list[i].seed, WEXITSTATUS(status));
497            crashes++;
498        }
499        else if(WIFSIGNALED(status))
500        {
501            fprintf(stdout, "zzuf[seed=%i]: signal %i\n",
502                    child_list[i].seed, WTERMSIG(status));
503            crashes++;
504        }
505
506        for(j = 0; j < 3; j++)
507            if(child_list[i].fd[j] >= 0)
508                close(child_list[i].fd[j]);
509
510        child_list[i].status = STATUS_FREE;
511        child_count--;
512    }
513
514    fflush(stdout);
515}
516
517static void read_children(void)
518{
519    struct timeval tv;
520    fd_set fdset;
521    int i, j, ret, maxfd = 0;
522
523    /* Read data from all sockets */
524    FD_ZERO(&fdset);
525    for(i = 0; i < maxforks; i++)
526    {
527        if(child_list[i].status != STATUS_RUNNING)
528            continue;
529
530        for(j = 0; j < 3; j++)
531            ZZUF_FD_SET(child_list[i].fd[j], &fdset, maxfd);
532    }
533    tv.tv_sec = 0;
534    tv.tv_usec = 1000;
535
536    ret = select(maxfd + 1, &fdset, NULL, NULL, &tv);
537    if(ret < 0)
538        perror("select");
539    if(ret <= 0)
540        return;
541
542    /* XXX: cute (i, j) iterating hack */
543    for(i = 0, j = 0; i < maxforks; i += (j == 2), j = (j + 1) % 3)
544    {
545        char buf[BUFSIZ];
546
547        if(child_list[i].status != STATUS_RUNNING)
548            continue;
549
550        if(!ZZUF_FD_ISSET(child_list[i].fd[j], &fdset))
551            continue;
552
553        ret = read(child_list[i].fd[j], buf, BUFSIZ - 1);
554        if(ret > 0)
555        {
556            /* We got data */
557            if(j != 0)
558                child_list[i].bytes += ret;
559            if(!quiet || j == 0)
560                write((j < 2) ? STDERR_FILENO : STDOUT_FILENO, buf, ret);
561        }
562        else if(ret == 0)
563        {
564            /* End of file reached */
565            close(child_list[i].fd[j]);
566            child_list[i].fd[j] = -1;
567
568            if(child_list[i].fd[0] == -1 && child_list[i].fd[1] == -1
569               && child_list[i].fd[2] == -1)
570                child_list[i].status = STATUS_EOF;
571        }
572    }
573}
574
575static void set_environment(char const *progpath)
576{
577    char *libpath, *tmp;
578    int len = strlen(progpath);
579#ifdef __APPLE__
580#   define FILENAME "libzzuf.dylib"
581#   define PRELOAD "DYLD_INSERT_LIBRARIES"
582    setenv("DYLD_FORCE_FLAT_NAMESPACE", "1", 1);
583#else
584#   define FILENAME "libzzuf.so"
585#   define PRELOAD "LD_PRELOAD"
586#endif
587
588    libpath = malloc(len + strlen("/.libs/" FILENAME) + 1);
589    strcpy(libpath, progpath);
590    tmp = strrchr(libpath, '/');
591    strcpy(tmp ? tmp + 1 : libpath, ".libs/" FILENAME);
592    if(access(libpath, R_OK) == 0)
593        setenv(PRELOAD, libpath, 1);
594    else
595        setenv(PRELOAD, LIBDIR "/" FILENAME, 1);
596    free(libpath);
597}
598
599static void version(void)
600{
601    printf("zzuf %s\n", VERSION);
602    printf("Copyright (C) 2002, 2007 Sam Hocevar <sam@zoy.org>\n");
603    printf("This is free software.  You may redistribute copies of it under the\n");
604    printf("terms of the Do What The Fuck You Want To Public License, Version 2\n");
605    printf("<http://sam.zoy.org/wtfpl/>.\n");
606    printf("There is NO WARRANTY, to the extent permitted by law.\n");
607    printf("\n");
608    printf("Written by Sam Hocevar. Report bugs to <sam@zoy.org>.\n");
609}
610
611#if defined(HAVE_GETOPT_H)
612static void usage(void)
613{
614    printf("Usage: zzuf [-cdinqS] [-r ratio] [-s seed | -s start:stop]\n");
615    printf("                      [-F forks] [-C crashes] [-B bytes] [-T seconds]\n");
616    printf("                      [-P protect] [-R refuse]\n");
617    printf("                      [-I include] [-E exclude] COMMAND [ARGS]...\n");
618#   ifdef HAVE_GETOPT_LONG
619    printf("       zzuf -h | --help\n");
620    printf("       zzuf -v | --version\n");
621#   else
622    printf("       zzuf -h\n");
623    printf("       zzuf -v\n");
624#   endif
625    printf("Run COMMAND and randomly fuzz its input.\n");
626    printf("\n");
627    printf("Mandatory arguments to long options are mandatory for short options too.\n");
628#   ifdef HAVE_GETOPT_LONG
629    printf("  -B, --max-bytes <n>      kill children that output more than <n> bytes\n");
630    printf("  -c, --cmdline            only fuzz files specified in the command line\n");
631    printf("  -C, --max-crashes <n>    stop after <n> children have crashed (default 1)\n");
632    printf("  -d, --debug              print debug messages\n");
633    printf("  -E, --exclude <regex>    do not fuzz files matching <regex>\n");
634    printf("  -F, --max-forks <n>      number of concurrent children (default 1)\n");
635    printf("  -i, --stdin              fuzz standard input\n");
636    printf("  -I, --include <regex>    only fuzz files matching <regex>\n");
637    printf("  -n, --network            fuzz network input\n");
638    printf("  -P, --protect <list>     protect bytes and characters in <list>\n");
639    printf("  -q, --quiet              do not print children's messages\n");
640    printf("  -r, --ratio <ratio>      bit fuzzing ratio (default 0.004)\n");
641    printf("  -R, --refuse <list>      refuse bytes and characters in <list>\n");
642    printf("  -s, --seed <seed>        random seed (default 0)\n");
643    printf("      --seed <start:stop>  specify a seed range\n");
644    printf("  -S, --signal             prevent children from diverting crashing signals\n");
645    printf("  -T, --max-time <n>       kill children that run for more than <n> seconds\n");
646    printf("  -h, --help               display this help and exit\n");
647    printf("  -v, --version            output version information and exit\n");
648#   else
649    printf("  -B <n>           kill children that output more than <n> bytes\n");
650    printf("  -c               only fuzz files specified in the command line\n");
651    printf("  -C <n>           stop after <n> children have crashed (default 1)\n");
652    printf("  -d               print debug messages\n");
653    printf("  -E <regex>       do not fuzz files matching <regex>\n");
654    printf("  -F <n>           number of concurrent forks (default 1)\n");
655    printf("  -i               fuzz standard input\n");
656    printf("  -I <regex>       only fuzz files matching <regex>\n");
657    printf("  -n               fuzz network input\n");
658    printf("  -P <list>        protect bytes and characters in <list>\n");
659    printf("  -q               do not print the fuzzed application's messages\n");
660    printf("  -r <ratio>       bit fuzzing ratio (default 0.004)\n");
661    printf("  -R <list>        refuse bytes and characters in <list>\n");
662    printf("  -s <seed>        random seed (default 0)\n");
663    printf("     <start:stop>  specify a seed range\n");
664    printf("  -S               prevent children from diverting crashing signals\n");
665    printf("  -T <n>           kill children that run for more than <n> seconds\n");
666    printf("  -h               display this help and exit\n");
667    printf("  -v               output version information and exit\n");
668#   endif
669    printf("\n");
670    printf("Written by Sam Hocevar. Report bugs to <sam@zoy.org>.\n");
671}
672#endif
673
Note: See TracBrowser for help on using the repository browser.