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

use crate::csaf_traits::{BranchTrait, CategoryOfTheBranch, CsafTrait, ProductTreeTrait, build_leaf_instance_path};
use crate::validation::ValidationError;

fn format_category_path(categories: &[CategoryOfTheBranch]) -> String {
    categories
        .iter()
        .map(|c| c.to_string())
        .collect::<Vec<_>>()
        .join(" -> ")
}

fn create_branch_categories_error(
    full_path: &[CategoryOfTheBranch],
    relevant_categories: &[CategoryOfTheBranch],
    instance_path: String,
) -> ValidationError {
    let full_display = format_category_path(full_path);
    let found_display = if relevant_categories.is_empty() {
        "(none)".to_string()
    } else {
        format_category_path(relevant_categories)
    };
    ValidationError {
        message: format!(
            "Branch path to product does not follow the recommended sequence of the categories 'vendor' -> 'product_name' -> 'product_version'. Along the categories of this path '{full_display}', the following sequence was found: '{found_display}'"
        ),
        instance_path,
    }
}

/// Required category sequence for branch paths.
const REQUIRED_CATEGORIES_ORDER: [CategoryOfTheBranch; 3] = [
    CategoryOfTheBranch::Vendor,
    CategoryOfTheBranch::ProductName,
    CategoryOfTheBranch::ProductVersion,
];

/// 6.3.9 Branch Categories
///
/// For each element of type `/$defs/full_product_name_t` in `/product_tree/branches` it must be tested
/// that ancestor nodes along the path exist which use the following branch categories
/// `vendor` -> `product_name` -> `product_version` in that order starting with the product tree node.
///
/// Other branch categories can be used before, after or between the aforementioned branch categories
/// without making the test invalid.
pub fn test_6_3_9_branch_categories(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    let mut errors: Option<Vec<ValidationError>> = None;

    let Some(product_tree) = doc.get_product_tree() else {
        return Ok(()); // this will be a Passed::NoData later (#409)
    };

    // get all paths from root to leaves in the product tree
    let leaf_paths = product_tree.collect_leaf_paths();

    // for every path to a leaf node
    for (path, indices) in leaf_paths {
        // filter to only the categories relevant to this rule, preserving order
        let mut relevant: Vec<CategoryOfTheBranch> = path
            .iter()
            .map(|b| b.get_category())
            .filter(|c| REQUIRED_CATEGORIES_ORDER.contains(c))
            .collect();
        // then deduplicate so that consecutive occurrences of the same relevant category
        // (e.g. vendor, vendor, product_name, product_version) do not trigger a false positive
        relevant.dedup();

        // Check whether the filtered list matches the required sequence exactly
        if !relevant.iter().eq(REQUIRED_CATEGORIES_ORDER.iter()) {
            // collect all categories only when needed for the error message
            let all_categories: Vec<CategoryOfTheBranch> = path.iter().map(|b| b.get_category()).collect();
            errors.get_or_insert_default().push(create_branch_categories_error(
                &all_categories,
                &relevant,
                build_leaf_instance_path(&indices),
            ));
        }
    }

    errors.map_or(Ok(()), Err)
}

crate::test_validation::impl_validator!(ValidatorForTest6_3_9, test_6_3_9_branch_categories);

#[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_3_9() {
        let case_01_missing_product_version = Err(vec![create_branch_categories_error(
            &[
                CategoryOfTheBranch::Vendor,
                CategoryOfTheBranch::ProductName,
                CategoryOfTheBranch::PatchLevel,
            ],
            &[CategoryOfTheBranch::Vendor, CategoryOfTheBranch::ProductName],
            "/product_tree/branches/0/branches/0/branches/0/product".to_string(),
        )]);

        let case_02_missing_vendor = Err(vec![
            create_branch_categories_error(
                &[
                    CategoryOfTheBranch::ProductFamily,
                    CategoryOfTheBranch::ProductName,
                    CategoryOfTheBranch::ProductVersion,
                ],
                &[CategoryOfTheBranch::ProductName, CategoryOfTheBranch::ProductVersion],
                "/product_tree/branches/0/branches/0/branches/0/product".to_string(),
            ),
            create_branch_categories_error(
                &[
                    CategoryOfTheBranch::ProductFamily,
                    CategoryOfTheBranch::ProductName,
                    CategoryOfTheBranch::ProductVersion,
                ],
                &[CategoryOfTheBranch::ProductName, CategoryOfTheBranch::ProductVersion],
                "/product_tree/branches/0/branches/0/branches/1/product".to_string(),
            ),
        ]);

        let case_03_missing_vendor_wrong_order = Err(vec![
            create_branch_categories_error(
                &[
                    CategoryOfTheBranch::ProductFamily,
                    CategoryOfTheBranch::ProductVersion,
                    CategoryOfTheBranch::ProductName,
                ],
                &[CategoryOfTheBranch::ProductVersion, CategoryOfTheBranch::ProductName],
                "/product_tree/branches/0/branches/0/branches/0/product".to_string(),
            ),
            create_branch_categories_error(
                &[
                    CategoryOfTheBranch::ProductFamily,
                    CategoryOfTheBranch::ProductVersion,
                    CategoryOfTheBranch::ProductName,
                ],
                &[CategoryOfTheBranch::ProductVersion, CategoryOfTheBranch::ProductName],
                "/product_tree/branches/0/branches/0/branches/1/product".to_string(),
            ),
        ]);

        let case_04_categories: &[CategoryOfTheBranch] = &[
            CategoryOfTheBranch::Vendor,
            CategoryOfTheBranch::ProductVersion,
            CategoryOfTheBranch::ProductName,
        ];
        let case_04_wrong_order = Err(vec![
            create_branch_categories_error(
                case_04_categories,
                case_04_categories,
                "/product_tree/branches/0/branches/0/branches/0/product".to_string(),
            ),
            create_branch_categories_error(
                case_04_categories,
                case_04_categories,
                "/product_tree/branches/0/branches/0/branches/1/product".to_string(),
            ),
        ]);

        let case_05_full: &[CategoryOfTheBranch] = &[
            CategoryOfTheBranch::HostName,
            CategoryOfTheBranch::Vendor,
            CategoryOfTheBranch::ProductVersion,
            CategoryOfTheBranch::Language,
            CategoryOfTheBranch::ProductName,
            CategoryOfTheBranch::Architecture,
            CategoryOfTheBranch::ServicePack,
            CategoryOfTheBranch::PatchLevel,
        ];
        let case_05_relevant = &[
            CategoryOfTheBranch::Vendor,
            CategoryOfTheBranch::ProductVersion,
            CategoryOfTheBranch::ProductName,
        ];
        let case_05_wrong_order_deep_tree = Err(vec![
            create_branch_categories_error(
                case_05_full,
                case_05_relevant,
                "/product_tree/branches/0/branches/0/branches/0/branches/0/branches/0/branches/0/branches/0/branches/0/product".to_string(),
            ),
            create_branch_categories_error(
                case_05_full,
                case_05_relevant,
                "/product_tree/branches/0/branches/0/branches/0/branches/0/branches/0/branches/1/branches/0/branches/0/product".to_string(),
            ),
        ]);

        let case_06_missing_vendor_name_version = Err(vec![
            create_branch_categories_error(
                &[
                    CategoryOfTheBranch::HostName,
                    CategoryOfTheBranch::Architecture,
                    CategoryOfTheBranch::Language,
                ],
                &[],
                "/product_tree/branches/0/branches/0/branches/0/product".to_string(),
            ),
            create_branch_categories_error(
                &[
                    CategoryOfTheBranch::HostName,
                    CategoryOfTheBranch::Architecture,
                    CategoryOfTheBranch::ServicePack,
                    CategoryOfTheBranch::PatchLevel,
                ],
                &[],
                "/product_tree/branches/0/branches/1/branches/0/branches/0/product".to_string(),
            ),
        ]);

        let case_s01_stacked_wrong_order = Err(vec![create_branch_categories_error(
            &[
                CategoryOfTheBranch::Vendor,
                CategoryOfTheBranch::ProductName,
                CategoryOfTheBranch::Vendor,
                CategoryOfTheBranch::ProductVersion,
            ],
            &[
                CategoryOfTheBranch::Vendor,
                CategoryOfTheBranch::ProductName,
                CategoryOfTheBranch::Vendor,
                CategoryOfTheBranch::ProductVersion,
            ],
            "/product_tree/branches/0/branches/0/branches/0/branches/0/product".to_string(),
        )]);

        // Case 11: Minimal passing example (vendor -> name -> version)
        // Case 12: vendor -> family -> name -> split to 2x version
        // Case 13: vendor -> family -> split to 2x name -> version
        // Case 14: vendor -> split to 2x name -> version
        // Case 15: Deep tree, split after 2x after name
        // Case S11: Stacked categories vendor x2, product_name x2, product_version x2

        TESTS_2_0.test_6_3_9.expect(
            case_01_missing_product_version.clone(),
            case_02_missing_vendor.clone(),
            case_03_missing_vendor_wrong_order.clone(),
            case_04_wrong_order.clone(),
            case_05_wrong_order_deep_tree.clone(),
            case_06_missing_vendor_name_version.clone(),
            case_s01_stacked_wrong_order.clone(),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
        );

        TESTS_2_1.test_6_3_9.expect(
            case_01_missing_product_version,
            case_02_missing_vendor,
            case_03_missing_vendor_wrong_order,
            case_04_wrong_order,
            case_05_wrong_order_deep_tree,
            case_06_missing_vendor_name_version,
            case_s01_stacked_wrong_order,
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
        );
    }
}