csaf-rs 0.5.0

A parser for the CSAF standard written in Rust
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

use crate::csaf::types::csaf_document_category::CsafDocumentCategory;
use crate::csaf_traits::{CsafTrait, DocumentTrait, ProductStatusTrait, VulnerabilityTrait};
use crate::validation::ValidationError;
use crate::validations::utils::document_category_test_config::DocumentCategoryTestConfig;

fn create_missing_affected_products_error(
    document_category: &CsafDocumentCategory,
    vulnerability_index: usize,
) -> ValidationError {
    ValidationError {
        message: format!(
            "Document with category '{document_category}' must have a '/vulnerabilities[]/product_status/known_affected' element"
        ),
        instance_path: format!("/vulnerabilities[{vulnerability_index}]/product_status/known_affected"),
    }
}

/// 6.1.27.12 Affected Products
///
/// This test only applies to documents with `/document/category` with value `csaf_security_advisory`.
///
/// For each item in `/vulnerabilities[]` it MUST be tested that the element `product_status/known_affected` exists.
pub fn test_6_1_27_12_affected_products(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    let doc_category = doc.get_document().get_category();

    if !PROFILE_TEST_CONFIG.matches_category_with_csaf_version(doc.get_document().get_csaf_version(), &doc_category) {
        return Ok(()); // ToDo generate skipped https://github.com/csaf-rs/csaf/issues/409
    }

    let mut errors: Vec<ValidationError> = Vec::new();
    let vulnerabilities = doc.get_vulnerabilities();
    for (v_i, vulnerability) in vulnerabilities.iter().enumerate() {
        if vulnerability
            .get_product_status()
            .and_then(|ps| ps.get_known_affected())
            .is_none()
        {
            errors.push(create_missing_affected_products_error(&doc_category, v_i));
        }
    }

    if !errors.is_empty() { Err(errors) } else { Ok(()) }
}

const PROFILE_TEST_CONFIG: DocumentCategoryTestConfig =
    DocumentCategoryTestConfig::new().shared(&[CsafDocumentCategory::CsafSecurityAdvisory]);

crate::test_validation::impl_validator!(csaf2_1, ValidatorForTest6_1_27_12, test_6_1_27_12_affected_products);

#[cfg(test)]
mod tests {
    use super::*;
    use crate::csaf2_1::testcases::TESTS_2_1;

    #[test]
    fn test_test_6_1_27_12() {
        let case_security_advisory_missing_affected = Err(vec![create_missing_affected_products_error(
            &CsafDocumentCategory::CsafSecurityAdvisory,
            0,
        )]);
        let case_security_advisory_two_vulnerabilities_missing_affected = Err(vec![
            create_missing_affected_products_error(&CsafDocumentCategory::CsafSecurityAdvisory, 0),
            create_missing_affected_products_error(&CsafDocumentCategory::CsafSecurityAdvisory, 1),
        ]);

        TESTS_2_1.test_6_1_27_12.expect(
            case_security_advisory_missing_affected.clone(),
            case_security_advisory_missing_affected,
            case_security_advisory_two_vulnerabilities_missing_affected,
            Ok(()),
            Ok(()),
        );
    }
}