ziggy 1.6.0

A multi-fuzzer management utility for all of your Rust fuzzing needs 🧑‍🎤
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

#![doc = include_str!("../README.md")]
#[cfg(feature = "afl")]
pub use afl::fuzz as afl_fuzz;
#[cfg(feature = "honggfuzz")]
pub use honggfuzz::fuzz as honggfuzz_fuzz;

// This is our inner harness handler function for the runner.
// We open the input file and feed the data to the harness closure.
#[doc(hidden)]
pub fn run_file<F>(mut closure: F)
where
    F: FnMut(&[u8]),
{
    use std::{env, fs::File, io::Read};
    let file_name: String = env::args().nth(1).expect("pass in a file name as argument");
    println!("Now running {file_name}");
    let mut buffer: Vec<u8> = Vec::new();
    let mut file = File::open(file_name).unwrap_or_else(|e| {
        eprintln!("Could not open file: {e}");
        std::process::exit(1);
    });
    file.read_to_end(&mut buffer).unwrap_or_else(|e| {
        eprintln!("Could not read file: {e}");
        std::process::exit(1);
    });
    closure(buffer.as_slice());
}

/// Fuzz a closure-like block of code by passing an object of arbitrary type.
///
/// It can handle different types of arguments for the harness closure, including Arbitrary.
///
/// See [our examples](https://github.com/srlabs/ziggy/tree/main/examples).
///
/// ```no_run
/// # fn main() {
///     ziggy::fuzz!(|data: &[u8]| {
///         if data.len() != 6 {return}
///         if data[0] != b'q' {return}
///         if data[1] != b'w' {return}
///         if data[2] != b'e' {return}
///         if data[3] != b'r' {return}
///         if data[4] != b't' {return}
///         if data[5] != b'y' {return}
///         panic!("BOOM")
///     });
/// # }
/// ```
#[macro_export]
macro_rules! inner_fuzz {
    (|$buf:ident| $body:block) => {
        $crate::run_file(|$buf| $body);
    };
    (|$buf:ident: &[u8]| $body:block) => {
        $crate::run_file(|$buf| $body);
    };
    (|$buf:ident: $dty: ty| $body:block) => {
        $crate::run_file(|$buf| {
            let $buf: $dty = {
                let mut data = ::arbitrary::Unstructured::new($buf);
                if let Ok(d) = ::arbitrary::Arbitrary::arbitrary(&mut data).map_err(|_| "") {
                    d
                } else {
                    return;
                }
            };
            $body
        });
    };
}

/// We need this wrapper
#[macro_export]
#[cfg(not(any(feature = "afl", feature = "honggfuzz")))]
macro_rules! fuzz {
    ( $($x:tt)* ) => {
        $crate::inner_fuzz!($($x)*);
    }
}

#[macro_export]
#[cfg(feature = "afl")]
macro_rules! fuzz {
      ( $($x:tt)* ) => {
        static USE_ARGS: std::sync::LazyLock<bool> = std::sync::LazyLock::new(|| std::env::args().len() > 1);
        if *USE_ARGS {
            $crate::inner_fuzz!($($x)*);
        } else {
            $crate::afl_fuzz!($($x)*);
        }
    };
}

#[macro_export]
#[cfg(all(feature = "honggfuzz", not(feature = "afl")))]
macro_rules! fuzz {
    ( $($x:tt)* ) => {
        loop {
            $crate::honggfuzz_fuzz!($($x)*);
        }
    };
}