libafl_nyx 0.16.0

libafl using nyx, only avaliable on linux
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

extern crate alloc;

use alloc::borrow::Cow;

use typed_builder::TypedBuilder;

const DEFAULT_INPUT_BUFFER_SIZE: usize = 1024 * 1024;
const DEFAULT_AUX_BUFFER_SIZE: usize = 4096;
const DEFAULT_TIMEOUT_SECS: u8 = 2;
const DEFAULT_TIMEOUT_MICRO_SECS: u32 = 0;
const DEFAULT_SNAP_MODE: bool = true;

#[derive(Debug, Clone, TypedBuilder)]
pub struct NyxSettings {
    /// The CPU core for the Nyx process.
    ///
    /// Depending on the value of `parent_cpu_id`, the created Nyx process
    /// will be one of the following types:
    /// * Standalone: `parent_cpu_id.is_none()`.
    /// * Parent: `parent_cpu_id.is_some_and(|parent_cpu_id| parent_cpu_id == cpu_id)`.
    /// * Child: `parent_cpu_id.is_some_and(|parent_cpu_id| parent_cpu_id != cpu_id)`.
    pub cpu_id: usize,

    /// The CPU core for the Nyx parent process. The parent process
    /// creates the fuzzing snapshot that can then be used by the child
    /// processes.
    ///
    /// Not specifying this will start the Nyx process in standalone mode.
    pub parent_cpu_id: Option<usize>,

    /// Reload the VM by using the fuzzing snapshot. You probably want
    /// this to be `true`.
    #[builder(default = DEFAULT_SNAP_MODE)]
    pub snap_mode: bool,

    /// The input buffer size (in bytes) used to pass the input to the
    /// QEMU-Nyx VM.
    ///
    /// Default is `1MB`.
    #[builder(default = DEFAULT_INPUT_BUFFER_SIZE)]
    pub input_buffer_size: usize,

    /// The timeout for a single execution in seconds (until the
    /// hypervisor restore snapshot call).
    #[builder(default = DEFAULT_TIMEOUT_SECS)]
    pub timeout_secs: u8,

    /// The output buffer size (in bytes) used to record the stdout/stderr messages
    /// Must be a multiple of 4KB!!!
    #[builder(default = DEFAULT_AUX_BUFFER_SIZE)]
    pub aux_buffer_size: usize,

    /// Additional timeout in microseconds that gets added to
    /// `timeout_secs`.
    #[builder(default = DEFAULT_TIMEOUT_MICRO_SECS)]
    pub timeout_micro_secs: u32,

    /// The workdir path for the Nyx process.
    ///
    /// Defaults to reading the value from the config in the share directory if `None`.
    #[builder(default = None, setter(strip_option))]
    pub workdir_path: Option<Cow<'static, str>>,
}