canfuzz 0.6.0

A coverage-guided fuzzing framework for Internet Computer canisters, built on `libafl` and `pocket-ic`
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

//! Feedback for instruction count maximization.
//!
//! [`InstructionCountFeedback`] marks an input as "interesting" when it increases the
//! maximum observed instruction count, guiding the fuzzer toward inputs that consume
//! more IC instructions.

use crate::custom::observer::instruction_count::{
    INSTRUCTION_COUNT_OBSERVER_NAME, InstructionCountObserver,
};
use crate::libafl::executors::ExitKind;
use crate::libafl::feedbacks::{Feedback, StateInitializer};
use crate::libafl::state::HasExecutions;
use crate::libafl::{Error, HasNamedMetadata};
use serde::Serialize;
use std::borrow::Cow;

use crate::libafl_bolts::Named;
use crate::libafl_bolts::tuples::MatchNameRef;
use crate::libafl_bolts::tuples::{Handle, MatchName};

/// A libafl feedback that considers an input interesting when it achieves a new maximum
/// instruction count, as reported by the [`InstructionCountObserver`].
#[derive(Serialize, Clone, Debug)]
pub struct InstructionCountFeedback<'a> {
    handle: Handle<InstructionCountObserver<'a>>,
}

impl InstructionCountFeedback<'_> {
    #[must_use]
    pub fn new() -> Self {
        Self {
            handle: Handle::new(Cow::Borrowed(INSTRUCTION_COUNT_OBSERVER_NAME)),
        }
    }
}

impl Default for InstructionCountFeedback<'_> {
    fn default() -> Self {
        Self::new()
    }
}

impl Named for InstructionCountFeedback<'_> {
    #[inline]
    fn name(&self) -> &Cow<'static, str> {
        self.handle.name()
    }
}

impl<S> StateInitializer<S> for InstructionCountFeedback<'_> {
    fn init_state(&mut self, _state: &mut S) -> Result<(), Error> {
        Ok(())
    }
}

impl<EM, I, OT, S> Feedback<EM, I, OT, S> for InstructionCountFeedback<'_>
where
    S: HasNamedMetadata + HasExecutions,
    OT: MatchName,
{
    #[allow(clippy::wrong_self_convention)]
    fn is_interesting(
        &mut self,
        _state: &mut S,
        _manager: &mut EM,
        _input: &I,
        observers: &OT,
        _exit_kind: &ExitKind,
    ) -> Result<bool, Error> {
        let observer: &InstructionCountObserver = observers.get(&self.handle).unwrap();
        Ok(observer.get_ref().increased)
    }

    fn append_metadata(
        &mut self,
        _state: &mut S,
        _manager: &mut EM,
        _observers: &OT,
        _testcase: &mut crate::libafl::corpus::Testcase<I>,
    ) -> Result<(), Error> {
        Ok(())
    }
}