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

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