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

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