mutatis 0.5.2

`mutatis` is a library for writing custom, structure-aware test-case mutators for fuzzers in Rust.
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use super::*;

/// The default mutator for `CString` values.
///
/// See the [`c_string()`] function to create new instances and for example
/// usage.
#[derive(Clone, Debug, Default)]
pub struct CStringMutator {
    _private: (),
}

/// Create a new mutator for `CString` values.
///
/// # Example
///
/// ```
/// # fn foo() -> mutatis::Result<()> {
/// use mutatis::{mutators as m, Mutate, Session};
/// use std::ffi::CString;
///
/// let mut value = CString::new("hello").unwrap();
///
/// let mut mutator = m::c_string();
///
/// let mut session = Session::new();
/// for _ in 0..5 {
///     session.mutate_with(&mut mutator, &mut value)?;
///     println!("value = {value:?}");
/// }
///
/// // Example output:
/// //
/// //     value = "he\xe5lo"
/// //     value = "he\x15lo"
/// //     value = "he\x15l"
/// //     value = "hel"
/// //     value = ""
/// # Ok(()) }
/// # foo().unwrap();
/// ```
pub fn c_string() -> CStringMutator {
    CStringMutator { _private: () }
}

/// Generate a random non-zero byte.
fn gen_nonzero_byte(ctx: &mut Context) -> u8 {
    let b = ctx.rng().gen_u8();
    if b == 0 {
        1
    } else {
        b
    }
}

impl Mutate<alloc::ffi::CString> for CStringMutator {
    #[inline]
    fn mutation_count(
        &self,
        value: &alloc::ffi::CString,
        shrink: bool,
    ) -> core::option::Option<u32> {
        let mut count = 0u32;
        // Mutate a random byte.
        count += !value.as_bytes().is_empty() as u32;
        // Insert a random non-zero byte.
        count += !shrink as u32;
        // Remove a random byte.
        count += !value.as_bytes().is_empty() as u32;
        Some(count)
    }

    #[inline]
    fn mutate(&mut self, c: &mut Candidates, value: &mut alloc::ffi::CString) -> Result<()> {
        let bytes = value.clone().into_bytes();

        // Mutate a random byte (ensuring it stays non-zero).
        if !bytes.is_empty() {
            c.mutation(|ctx| {
                let mut bytes = value.clone().into_bytes();
                let index = ctx.rng().gen_index(bytes.len()).unwrap();
                bytes[index] = gen_nonzero_byte(ctx);
                *value = alloc::ffi::CString::new(bytes).unwrap();
                Ok(())
            })?;
        }

        // Insert a random non-zero byte.
        if !c.shrink() {
            c.mutation(|ctx| {
                let mut bytes = value.clone().into_bytes();
                let index = ctx.rng().gen_index(bytes.len() + 1).unwrap();
                bytes.insert(index, gen_nonzero_byte(ctx));
                *value = alloc::ffi::CString::new(bytes).unwrap();
                Ok(())
            })?;
        }

        // Remove a random byte.
        if !bytes.is_empty() {
            c.mutation(|ctx| {
                let mut bytes = value.clone().into_bytes();
                let index = ctx.rng().gen_index(bytes.len()).unwrap();
                bytes.remove(index);
                *value = alloc::ffi::CString::new(bytes).unwrap();
                Ok(())
            })?;
        }

        Ok(())
    }
}

impl Generate<alloc::ffi::CString> for CStringMutator {
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<alloc::ffi::CString> {
        let len = ctx.rng().inner().gen_range(0..=20);
        let bytes: alloc::vec::Vec<u8> = (0..len).map(|_| gen_nonzero_byte(ctx)).collect();
        Ok(alloc::ffi::CString::new(bytes).unwrap())
    }
}

impl DefaultMutate for alloc::ffi::CString {
    type DefaultMutate = CStringMutator;
}