bitvex 0.2.5

Automate CRA compliance: generate OpenVEX reports from Yocto SBOMs by filtering CVEs with kernel config and device tree analysis
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use tracing::debug;

use crate::osv::OsvResult;
use crate::rules::{Rule, RulesConfig, rule_matches};
use crate::vex::VexStatement;

pub fn apply_rules(results: &[OsvResult], config: &RulesConfig) -> (Vec<VexStatement>, Vec<usize>) {
    let mut statements = Vec::new();
    let mut filtered_indices = Vec::new();

    for (i, result) in results.iter().enumerate() {
        for vuln in &result.vulns {
            for rule in &config.rules {
                if rule_matches(
                    rule,
                    &vuln.id,
                    &result.package.name,
                    result.package.version.as_deref(),
                ) {
                    let statement = build_statement_from_rule(vuln, result, rule);
                    debug!(
                        "Rule '{}' matched: {} on {} -> {}",
                        rule.name,
                        vuln.id,
                        result.package.name,
                        rule.status.as_str()
                    );
                    statements.push(statement);

                    if rule.status == RuleStatus::NotAffected {
                        filtered_indices.push(i);
                    }

                    break;
                }
            }
        }
    }

    (statements, filtered_indices)
}

use crate::rules::RuleStatus;

fn build_statement_from_rule(
    vuln: &crate::osv::OsvVuln,
    result: &OsvResult,
    rule: &Rule,
) -> VexStatement {
    let purl = result
        .package
        .purl
        .clone()
        .unwrap_or_else(|| format!("pkg:generic/{}", result.package.name));

    VexStatement {
        vulnerability_name: vuln.id.clone(),
        product_purl: purl,
        status: rule.status.to_vex_status(),
        justification: rule.justification.clone(),
        impact_statement: rule.impact_statement.clone().or_else(|| {
            Some(format!(
                "Rule '{}': vulnerability {} on package {}.",
                rule.name, vuln.id, result.package.name
            ))
        }),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::osv::OsvVuln;
    use crate::rules::RuleStatus;
    use crate::sbom::SbomPackage;
    use crate::vex::VexStatus;

    fn make_result(name: &str, version: &str, vuln_id: &str) -> OsvResult {
        OsvResult {
            package: SbomPackage {
                _spdx_id: format!("SPDXRef-{}", name),
                name: name.into(),
                version: Some(version.into()),
                purl: Some(format!("pkg:generic/{}@{}", name, version)),
            },
            vulns: vec![OsvVuln {
                id: vuln_id.into(),
                _modified: "2024-01-01T00:00:00Z".into(),
            }],
        }
    }

    #[test]
    fn test_rules_filter_specific_cve() {
        let results = vec![make_result("openssl", "3.0.13", "CVE-2024-1234")];
        let config = RulesConfig {
            author: None,
            rules: vec![Rule {
                name: "ignore CVE".into(),
                cve: Some("CVE-2024-1234".into()),
                cve_pattern: None,
                package: Some("openssl".into()),
                version: None,
                status: RuleStatus::NotAffected,
                justification: Some("vulnerable_code_not_present".into()),
                impact_statement: Some("Parcheado".into()),
            }],
        };

        let (statements, filtered) = apply_rules(&results, &config);
        assert_eq!(statements.len(), 1);
        assert_eq!(statements[0].status, VexStatus::NotAffected);
        assert_eq!(filtered.len(), 1);
    }

    #[test]
    fn test_rules_does_not_match_wrong_cve() {
        let results = vec![make_result("openssl", "3.0.13", "CVE-2024-9999")];
        let config = RulesConfig {
            author: None,
            rules: vec![Rule {
                name: "ignore CVE".into(),
                cve: Some("CVE-2024-1234".into()),
                cve_pattern: None,
                package: None,
                version: None,
                status: RuleStatus::NotAffected,
                justification: None,
                impact_statement: None,
            }],
        };

        let (statements, _) = apply_rules(&results, &config);
        assert_eq!(statements.len(), 0);
    }

    #[test]
    fn test_rules_glob_pattern() {
        let results = vec![make_result("glibc", "2.37", "CVE-2024-5678")];
        let config = RulesConfig {
            author: None,
            rules: vec![Rule {
                name: "all 2024 CVEs".into(),
                cve: None,
                cve_pattern: Some("CVE-2024-*".into()),
                package: None,
                version: None,
                status: RuleStatus::UnderInvestigation,
                justification: None,
                impact_statement: None,
            }],
        };

        let (statements, _) = apply_rules(&results, &config);
        assert_eq!(statements.len(), 1);
        assert_eq!(statements[0].status, VexStatus::UnderInvestigation);
    }
}