autarkie 0.8.0

autarkie - instant grammar fuzzing using 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
125
126
127
128
129
130
131
132
133
134
135
136

use crate::fuzzer::context::{Context, MutationMetadata};
use crate::MutationType;
use crate::{Node, Visitor};
use core::marker::PhantomData;
use libafl::{
    corpus::HasCurrentCorpusId,
    executors::{Executor, HasObservers},
    observers::{AflppCmpValuesMetadata, CmpValues, ObserversTuple},
    stages::{colorization::TaintMetadata, Restartable, RetryCountRestartHelper, Stage},
    state::{HasCorpus, HasCurrentTestcase},
    Error, Evaluator, HasMetadata, HasNamedMetadata,
};
use libafl_bolts::AsSlice;
use libafl_bolts::{
    tuples::{Handle, MatchNameRef},
    Named,
};
use std::borrow::{Cow, ToOwned};
use std::cell::RefCell;
use std::collections::HashSet;
use std::collections::VecDeque;
use std::rc::Rc;

use libafl_targets::AflppCmpLogObserver;

/// Trace with tainted input
#[derive(Debug, Clone)]
pub struct CmpLogStage<'a, EM, TE, S, Z, I> {
    visitor: Rc<RefCell<Visitor>>,
    name: Cow<'static, str>,
    tracer_executor: TE,
    cmplog_observer_handle: Handle<AflppCmpLogObserver<'a>>,
    phantom: PhantomData<(EM, TE, S, Z, I)>,
}
/// The name for aflpp tracing stage
pub static AFLPP_CMPLOG_TRACING_STAGE_NAME: &str = "aflpptracing";

impl<EM, TE, S, Z, I> Named for CmpLogStage<'_, EM, TE, S, Z, I> {
    fn name(&self) -> &Cow<'static, str> {
        &self.name
    }
}

impl<E, EM, TE, S, Z, I> Stage<E, EM, S, Z> for CmpLogStage<'_, EM, TE, S, Z, I>
where
    I: Node + Clone,
    TE: HasObservers + Executor<EM, I, S, Z>,
    TE::Observers: MatchNameRef + ObserversTuple<I, S>,
    S: HasCorpus<I> + HasCurrentTestcase<I> + HasMetadata + HasNamedMetadata + HasCurrentCorpusId,
    Z: Evaluator<E, EM, I, S>,
{
    #[inline]
    fn perform(
        &mut self,
        fuzzer: &mut Z,
        executor: &mut E,
        state: &mut S,
        manager: &mut EM,
    ) -> Result<(), Error> {
        // First run with the un-mutated input
        let mut unmutated_input = state.current_input_cloned()?;

        if let Some(ob) = self
            .tracer_executor
            .observers_mut()
            .get_mut(&self.cmplog_observer_handle)
        {
            // This is not the original input,
            // Set it to false
            ob.set_original(true);
        }
        // I can't think of any use of this stage if you don't use AflppCmpLogObserver
        // but do nothing ofcourse

        self.tracer_executor
            .observers_mut()
            .pre_exec_all(state, &unmutated_input)?;

        let exit_kind =
            self.tracer_executor
                .run_target(fuzzer, state, manager, &unmutated_input)?;

        self.tracer_executor
            .observers_mut()
            .post_exec_all(state, &unmutated_input, &exit_kind)?;
        Ok(())
    }
}

impl<EM, TE, S, Z, I> Restartable<S> for CmpLogStage<'_, EM, TE, S, Z, I>
where
    S: HasMetadata + HasNamedMetadata + HasCurrentCorpusId,
{
    fn should_restart(&mut self, state: &mut S) -> Result<bool, Error> {
        // Tracing stage is always deterministic
        // don't restart
        RetryCountRestartHelper::no_retry(state, &self.name)
    }

    fn clear_progress(&mut self, state: &mut S) -> Result<(), Error> {
        // TODO: this may need better resumption? (Or is it always used with a forkserver?)
        RetryCountRestartHelper::clear_progress(state, &self.name)
    }
}

impl<'a, EM, TE, S, Z, I> CmpLogStage<'a, EM, TE, S, Z, I> {
    /// With cmplog observer
    pub fn new(
        visitor: Rc<RefCell<Visitor>>,
        tracer_executor: TE,
        observer_handle: Handle<AflppCmpLogObserver<'a>>,
    ) -> Self {
        let observer_name = observer_handle.name().clone();
        Self {
            visitor,
            name: Cow::Owned(
                AFLPP_CMPLOG_TRACING_STAGE_NAME.to_owned()
                    + ":"
                    + observer_name.into_owned().as_str(),
            ),
            cmplog_observer_handle: observer_handle,
            tracer_executor,
            phantom: PhantomData,
        }
    }

    /// Gets the underlying tracer executor
    pub fn executor(&self) -> &TE {
        &self.tracer_executor
    }

    /// Gets the underlying tracer executor (mut)
    pub fn executor_mut(&mut self) -> &mut TE {
        &mut self.tracer_executor
    }
}