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

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