csaf-rs 0.5.1

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
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

use crate::csaf::types::csaf_document_category::CsafDocumentCategory;
use crate::csaf_traits::{CsafTrait, CsafVersion, DocumentTrait};
use crate::validation::ValidationError;

/// 6.1.26 Prohibited Document Category Name
pub fn test_6_1_26_prohibited_document_category(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    let doc_version = doc.get_document().get_csaf_version();
    let doc_category = doc.get_document().get_category();

    validate_document_category(&doc_category, doc_version)
}

#[inline]
fn validate_document_category(
    doc_category: &CsafDocumentCategory,
    doc_version: CsafVersion,
) -> Result<(), Vec<ValidationError>> {
    // skip test for known profiles and categories
    if doc_category.is_known_profile(doc_version) {
        return Ok(());
    }

    // throw error, as only known profiles are allowed to start with "csaf_"
    if doc_category.starts_with_csaf_underscore() {
        return Err(vec![test_6_1_26_err_generator_starts_with_csaf(
            doc_category,
            doc_version,
        )]);
    }

    // normalize and compare against known profiles
    let normalized_doc_category = doc_category.normalize();
    for (normalized_known_category, known_category) in CsafDocumentCategory::known_profiles_normalized(doc_version) {
        if normalized_doc_category == normalized_known_category {
            return Err(vec![test_6_1_26_err_generator_too_similar(
                doc_category,
                &known_category,
            )]);
        }
    }

    Ok(())
}

fn test_6_1_26_err_generator_starts_with_csaf(
    doc_category: &CsafDocumentCategory,
    version: CsafVersion,
) -> ValidationError {
    ValidationError {
        message: format!(
            "Document category '{doc_category}' is prohibited. Only the following values starting with 'csaf_' (or similar) are allowed: {}",
            CsafDocumentCategory::known_profile_concat(version)
        ),
        instance_path: "/document/category".to_string(),
    }
}

fn test_6_1_26_err_generator_too_similar(
    doc_category: &CsafDocumentCategory,
    known_category: &CsafDocumentCategory,
) -> ValidationError {
    ValidationError {
        message: format!(
            "Document category '{doc_category}' is prohibited. It is too similar to the known category: {known_category}",
        ),
        instance_path: "/document/category".to_string(),
    }
}

crate::test_validation::impl_validator!(ValidatorForTest6_1_26, test_6_1_26_prohibited_document_category);

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

    #[test]
    fn test_test_6_1_26() {
        // Shared test cases
        let case_01_shared = Err(vec![test_6_1_26_err_generator_too_similar(
            &CsafDocumentCategory::from("Security_Incident_Response"),
            &CsafDocumentCategory::CsafSecurityIncidentResponse,
        )]);

        // CSAF 2.0 specific test cases
        let case_02_csaf20 = Err(vec![test_6_1_26_err_generator_starts_with_csaf(
            &CsafDocumentCategory::from("csaf_BASE"),
            CsafVersion::X20,
        )]);
        let case_03_csaf20 = Err(vec![test_6_1_26_err_generator_starts_with_csaf(
            &CsafDocumentCategory::from("Csaf_VeX"),
            CsafVersion::X20,
        )]);
        let case_04_csaf20 = Err(vec![test_6_1_26_err_generator_too_similar(
            &CsafDocumentCategory::from("csafsecurityadvisory"),
            &CsafDocumentCategory::CsafSecurityAdvisory,
        )]);

        // CSAF 2.1 specific test cases
        let case_02_csaf21 = Err(vec![test_6_1_26_err_generator_too_similar(
            &CsafDocumentCategory::from("Deprecated Security Advisory"),
            &CsafDocumentCategory::CsafDeprecatedSecurityAdvisory,
        )]);
        let case_03_csaf21 = Err(vec![test_6_1_26_err_generator_too_similar(
            &CsafDocumentCategory::from("withdrawn"),
            &CsafDocumentCategory::CsafWithdrawn,
        )]);
        let case_04_csaf21 = Err(vec![test_6_1_26_err_generator_too_similar(
            &CsafDocumentCategory::from("superseded"),
            &CsafDocumentCategory::CsafSuperseded,
        )]);
        let case_05_csaf21 = Err(vec![test_6_1_26_err_generator_too_similar(
            &CsafDocumentCategory::from("csafvex"),
            &CsafDocumentCategory::CsafVex,
        )]);
        let case_06_csaf21 = Err(vec![test_6_1_26_err_generator_too_similar(
            &CsafDocumentCategory::from("CSafDeprecatedSecurity—Advisory"),
            &CsafDocumentCategory::CsafDeprecatedSecurityAdvisory,
        )]);
        let case_07_csaf21 = Err(vec![test_6_1_26_err_generator_starts_with_csaf(
            &CsafDocumentCategory::from("CsaF_VeX"),
            CsafVersion::X21,
        )]);
        let case_08_csaf21 = Err(vec![test_6_1_26_err_generator_starts_with_csaf(
            &CsafDocumentCategory::from("csaf_BASE"),
            CsafVersion::X21,
        )]);

        // Supplementary test cases
        // CSAF 2.1 categories that should fail on CSAF 2.0
        let deprecated_sec_advisory_csaf20 = Err(vec![test_6_1_26_err_generator_starts_with_csaf(
            &CsafDocumentCategory::from("csaf_deprecated_security_advisory"),
            CsafVersion::X20,
        )]);
        let withdrawn_csaf20 = Err(vec![test_6_1_26_err_generator_starts_with_csaf(
            &CsafDocumentCategory::from("csaf_withdrawn"),
            CsafVersion::X20,
        )]);
        let superseded_csaf20 = Err(vec![test_6_1_26_err_generator_starts_with_csaf(
            &CsafDocumentCategory::from("csaf_superseded"),
            CsafVersion::X20,
        )]);

        TESTS_2_0.test_6_1_26.expect(
            case_01_shared.clone(),
            case_02_csaf20,
            case_03_csaf20,
            case_04_csaf20,
            deprecated_sec_advisory_csaf20,
            withdrawn_csaf20,
            superseded_csaf20,
            Ok(()),
            Ok(()),
        );
        TESTS_2_1.test_6_1_26.expect(
            case_01_shared,
            case_02_csaf21,
            case_03_csaf21,
            case_04_csaf21,
            case_05_csaf21,
            case_06_csaf21,
            case_07_csaf21,
            case_08_csaf21,
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
        );
    }

    // Additional unit tests from the editorial version of CSAF 2.1
    #[test]
    fn test_validate_document_category_v21() {
        let version = CsafVersion::X21;
        assert!(validate_document_category(&CsafDocumentCategory::from("Csaf_a"), version).is_err());
        assert!(validate_document_category(&CsafDocumentCategory::from("csafvex"), version).is_err());
        assert!(validate_document_category(&CsafDocumentCategory::from("Informational Advisory"), version).is_err());
        assert!(validate_document_category(&CsafDocumentCategory::from("Security      Advisory"), version).is_err());
        assert!(
            validate_document_category(&CsafDocumentCategory::from("security-incident-response"), version).is_err()
        );
        assert!(validate_document_category(&CsafDocumentCategory::from("Superseded"), version).is_err());
        assert!(validate_document_category(&CsafDocumentCategory::from("V_eX"), version).is_err());
        assert!(validate_document_category(&CsafDocumentCategory::from("veX"), version).is_err());
    }
}