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
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313

use crate::csaf::types::csaf_vuln_metric::CsafVulnerabilityMetric;
use crate::csaf_traits::{ContentTrait, CsafTrait, MetricTrait, VulnerabilityTrait};
use crate::validation::ValidationError;
use std::collections::HashMap;

/// Maps product ids to a per-metric-type, per-source list of JSON paths.
type ProductMetricMap = HashMap<String, ProductCsafVulnerabilityMetricMap>;
/// Maps a metric type (e.g., CVSS v3.1) to a per-source list of JSON paths.
type ProductCsafVulnerabilityMetricMap = HashMap<CsafVulnerabilityMetric, ProductCsafVulnerabilityMetricSourceMap>;
/// Maps a source (None for CSAF 2.0 or if None is provided) to a list of JSON paths.
type ProductCsafVulnerabilityMetricSourceMap = HashMap<Option<String>, Vec<String>>;

/// Gather all CVSS metric entries for a vulnerability into a nested map keyed by
/// product id → metric type → source → JSON paths.
///
/// More details can be found in [`ProductMetricMap`], [`ProductCsafVulnerabilityMetricMap`] and [`ProductCsafVulnerabilityMetricSourceMap`].
///
/// Returns `Some(ProductMetricMap)` if the vulnerability contained any CVSS scores, `None` if not.
fn aggregate_product_cvss_metrics(
    vulnerability: &impl VulnerabilityTrait,
    vulnerability_index: usize,
) -> Option<ProductMetricMap> {
    // return None if there are no metrics
    let metrics = vulnerability.get_metrics()?;

    let mut product_metrics: Option<ProductMetricMap> = None;
    for (metric_index, metric) in metrics.iter().enumerate() {
        let content = metric.get_content();
        let metric_json_path = content.get_content_json_path(vulnerability_index, metric_index);
        let present_cvss_metric_types = content.get_cvss_metric_types();
        let source = metric.get_source().map(|s| s.to_owned());
        for product_id in metric.get_products() {
            for metric_type in &present_cvss_metric_types {
                product_metrics
                    .get_or_insert_default()
                    .entry(product_id.to_owned())
                    .or_default()
                    .entry(metric_type.to_owned())
                    .or_default()
                    .entry(source.clone())
                    .or_default()
                    .push(metric_json_path.clone());
            }
        }
    }
    product_metrics
}

/// Test 6.1.7 Multiple Scores with Same Version per Product
///
/// For each item in `/vulnerabilities` it MUST be tested that the same Product ID
/// is not a member of more than one CVSS vector with the same version and same source.
pub fn test_6_1_07_multiple_same_scores_per_product(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    let mut errors: Option<Vec<ValidationError>> = None;
    for (vulnerability_index, vulnerability) in doc.get_vulnerabilities().iter().enumerate() {
        let product_metrics = aggregate_product_cvss_metrics(vulnerability, vulnerability_index);
        // if there are any cvss metrics
        if let Some(product_metrics) = product_metrics {
            // traverse the metrics map
            for (product_id, cvss_metrics_map) in &product_metrics {
                for (metric_type, source_map) in cvss_metrics_map {
                    for (source, paths) in source_map {
                        // generate an error if the same metric, with same or no source, applies to the same product id
                        if paths.len() > 1 {
                            for path in paths {
                                errors.get_or_insert_default().push(create_validation_error(
                                    metric_type,
                                    product_id,
                                    path.to_owned(),
                                    source.clone(),
                                ));
                            }
                        }
                    }
                }
            }
        }
    }
    errors.map_or(Ok(()), Err)
}

crate::test_validation::impl_validator!(ValidatorForTest6_1_7, test_6_1_07_multiple_same_scores_per_product);

fn create_validation_error(
    score_type: &CsafVulnerabilityMetric,
    product_id: &str,
    path: String,
    source: Option<String>,
) -> ValidationError {
    let source_info = source.map_or("by author".to_string(), |s| format!("for source: {s}"));
    ValidationError {
        message: format!("Multiple {score_type} scores are given for {product_id} {source_info}."),
        instance_path: format!("{}/{}", path, score_type.get_metric_prop_name()),
    }
}

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

    #[test]
    fn test_test_6_1_07() {
        // Case 01: two scores, same product, both CVSS v3.1
        let case_01_duplicate_cvss_v3_1_csaf_20 = Err(vec![
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.1".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/scores/0".to_string(),
                None,
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.1".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/scores/1".to_string(),
                None,
            ),
        ]);
        let case_01_duplicate_cvss_v3_1_csaf_21 = Err(vec![
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.1".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/0/content".to_string(),
                None,
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.1".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/1/content".to_string(),
                None,
            ),
        ]);
        // Case 02: two scores, same product, both CVSS v3.0
        let case_02_duplicate_cvss_v3_0_csaf_21 = Err(vec![
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.0".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/0/content".to_string(),
                None,
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.0".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/1/content".to_string(),
                None,
            ),
        ]);
        // Case 03: two scores, some product, both CVSS v2
        let case_03_duplicate_cvss_v2_csaf_21 = Err(vec![
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV2("2.0".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/0/content".to_string(),
                None,
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV2("2.0".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/1/content".to_string(),
                None,
            ),
        ]);
        // Case 04: two scores, some product, both CVSS v4
        let case_04_duplicate_cvss_v4_csaf_21 = Err(vec![
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV4("4.0".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/0/content".to_string(),
                None,
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV4("4.0".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/1/content".to_string(),
                None,
            ),
        ]);
        // Case 05: two products, CVSS v2, v3.0, v3.1, v4 scores, with sources
        let case_05_duplicate_cvss_mixed_versions_with_sources = Err(vec![
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.1".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/0/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.1".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/1/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.0".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/1/metrics/1/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.0".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/1/metrics/2/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV2("2.0".to_string()),
                "CSAFPID-9080701",
                "/vulnerabilities/2/metrics/0/content".to_string(),
                Some("https://www.example.net/awesome-research-blog-post".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV2("2.0".to_string()),
                "CSAFPID-9080701",
                "/vulnerabilities/2/metrics/1/content".to_string(),
                Some("https://www.example.net/awesome-research-blog-post".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV4("4.0".to_string()),
                "CSAFPID-9080701",
                "/vulnerabilities/3/metrics/0/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV4("4.0".to_string()),
                "CSAFPID-9080701",
                "/vulnerabilities/3/metrics/1/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
        ]);
        // Case 06: two products, invalid CVSS versions, also with sources
        let case_06_duplicate_cvss_invalid_versions_with_sources = Err(vec![
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.2".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/0/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.2".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/0/metrics/1/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.4".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/1/metrics/1/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV3("3.4".to_string()),
                "CSAFPID-9080700",
                "/vulnerabilities/1/metrics/2/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV2("2.5".to_string()),
                "CSAFPID-9080701",
                "/vulnerabilities/2/metrics/0/content".to_string(),
                Some("https://www.example.net/awesome-research-blog-post".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV2("2.5".to_string()),
                "CSAFPID-9080701",
                "/vulnerabilities/2/metrics/1/content".to_string(),
                Some("https://www.example.net/awesome-research-blog-post".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV4("4.0.1".to_string()),
                "CSAFPID-9080701",
                "/vulnerabilities/3/metrics/0/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
            create_validation_error(
                &CsafVulnerabilityMetric::CvssV4("4.0.1".to_string()),
                "CSAFPID-9080701",
                "/vulnerabilities/3/metrics/1/content".to_string(),
                Some("https://www.example.com/.well-known/csaf/clear/2024/esa-2024-0001.json".to_string()),
            ),
        ]);

        // Case 11: 2 vulns, 2 CVSS v3.1 scores, same product
        // Case 12: 1 product, CVSS v2 and CVSS v3.1 score
        // Case 13: 2 vulns, 2 CVSS v3.0 scores, same product
        // Case 14: 2 vulns, 2 CVSS v2 scores, same product
        // Case 15: 2 vulns, 2 CVSS v4 scores, same product
        // Case 16: 1 vuln, CVSS v2, v3.1, v4, same product
        // Case 17: 1 vuln, CVSS v2, v3.0, v4, same product
        // Case 18: like 05, but valid

        TESTS_2_0
            .test_6_1_7
            .expect(case_01_duplicate_cvss_v3_1_csaf_20, Ok(()), Ok(()));

        TESTS_2_1.test_6_1_7.expect(
            case_01_duplicate_cvss_v3_1_csaf_21,
            case_02_duplicate_cvss_v3_0_csaf_21,
            case_03_duplicate_cvss_v2_csaf_21,
            case_04_duplicate_cvss_v4_csaf_21,
            case_05_duplicate_cvss_mixed_versions_with_sources,
            case_06_duplicate_cvss_invalid_versions_with_sources,
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
        );
    }
}