boreal 1.1.0

A library to evaluate YARA rules, used to scan bytes for textual and binary pattern
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

/// Scanning error
#[derive(Debug)]
pub enum ScanError {
    /// Scanning took too long and timed out.
    ///
    /// See [`crate::scanner::ScanParams::timeout_duration`] for more details.
    Timeout,

    /// Error when reading the file to scan.
    CannotReadFile(std::io::Error),

    /// Process scanning is not implemented on this operating system.
    UnsupportedProcessScan,

    /// Unknown process.
    UnknownProcess,

    /// Error when listing regions of a process before a scan.
    CannotListProcessRegions(std::io::Error),

    /// The scan callback asked for the scan to be aborted.
    ///
    /// See [`crate::scanner::ScanCallbackResult::Abort`].
    CallbackAbort,
}

impl std::fmt::Display for ScanError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Timeout => write!(f, "timeout"),
            Self::CannotReadFile(err) => write!(f, "cannot read file to scan: {err}"),
            Self::UnsupportedProcessScan => {
                write!(f, "process scanning is not implemented on this OS")
            }
            Self::UnknownProcess => {
                write!(f, "unknown process")
            }
            Self::CannotListProcessRegions(error) => {
                write!(f, "error listing memory regions of process: {error}")
            }
            Self::CallbackAbort => {
                write!(f, "scan aborted in callback")
            }
        }
    }
}

impl std::error::Error for ScanError {}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_helpers::test_type_traits_non_clonable;

    #[test]
    fn test_types_traits() {
        test_type_traits_non_clonable(ScanError::Timeout);
    }
}