yara 0.32.0

Rust bindings for VirusTotal/yara
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

use std::fmt;

pub use yara_sys::CompileErrorLevel;
pub use yara_sys::Error as YaraErrorKind;

use std::error::Error as StdError;

use thiserror::Error as ThisError;

/// A wrapper around the kinds of errors that can happen in the library.
#[derive(Debug, ThisError)]
pub enum Error {
    /// An IO error.
    #[error("{0}")]
    Io(#[from] IoError),
    /// A general Yara error.
    ///
    /// See [`YaraError`] and [`yara_sys::Error`].
    #[error("{0}")]
    Yara(#[from] YaraError),
    /// A rule compilation error.
    #[error("{0}")]
    Compile(#[from] CompileErrors),
}

#[derive(Debug, ThisError)]
#[error("{context}: {inner}")]
pub struct IoError {
    context: IoErrorKind,
    #[source]
    inner: std::io::Error,
}

impl IoError {
    pub fn new(inner: std::io::Error, context: IoErrorKind) -> Self {
        IoError { context, inner }
    }

    pub fn kind(&self) -> &IoErrorKind {
        &self.context
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, ThisError)]
pub enum IoErrorKind {
    #[error("Error while opening scan file")]
    OpenScanFile,
    #[error("Error while opening rules file")]
    OpenRulesFile,
    #[error("Error while reading rules stream")]
    ReadingRules,
    #[error("Error while writing rules stream")]
    WritingRules,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, ThisError)]
#[error("{kind}")]
pub struct YaraError {
    pub kind: YaraErrorKind,
}

impl From<YaraErrorKind> for YaraError {
    fn from(error: YaraErrorKind) -> Self {
        YaraError { kind: error }
    }
}

/// The errors and warning returned during the rules compilation.
#[derive(Debug)]
pub struct CompileErrors {
    errors: Vec<CompileError>,
}

impl CompileErrors {
    pub fn new(errors: Vec<CompileError>) -> Self {
        CompileErrors { errors }
    }

    /// Iterate over the errors.
    pub fn iter(&self) -> impl Iterator<Item = &CompileError> {
        self.errors.iter()
    }
}

impl StdError for CompileErrors {
    /// Returns the first compile error.
    fn source(&self) -> Option<&(dyn StdError + 'static)> {
        self.iter()
            .find(|e| e.level == CompileErrorLevel::Error)
            .map(|e| e as &dyn StdError)
    }
}

impl fmt::Display for CompileErrors {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        for error in &self.errors {
            writeln!(f, "{error}")?;
        }

        Ok(())
    }
}

#[derive(Debug, ThisError)]
pub struct CompileError {
    pub level: CompileErrorLevel,
    pub filename: Option<String>,
    pub line: usize,
    pub message: String,
}

impl fmt::Display for CompileError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "Compile {} ",
            match self.level {
                CompileErrorLevel::Error => "error",
                CompileErrorLevel::Warning => "warning",
            }
        )?;
        if let Some(filename) = &self.filename {
            write!(f, "in {filename} ")?;
        }
        write!(f, "at line {}: {}", self.line, self.message)
    }
}