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

use crate::validation::ValidationError;

/// Trait for test validation logic.
///
/// Implement this trait to provide validation logic for specific test cases.
/// The trait is generic over the document type to allow validators to work
/// with different CSAF versions.
pub trait TestValidator<Doc> {
    /// Validate a CSAF document according to this test's requirements.
    ///
    /// # Arguments
    /// * `doc` - The CSAF document to validate
    ///
    /// # Returns
    /// * `Ok(())` if validation passes
    /// * `Err(Vec<ValidationError>)` if validation fails
    fn validate(&self, doc: &Doc) -> Result<(), Vec<ValidationError>>;
}

/// Macro to generate the boilerplate `TestValidator<CommonSecurityAdvisoryFramework>` impl blocks
/// for validation tests.
///
/// # Usage
///
/// For tests that apply to both CSAF 2.0 and 2.1:
/// ```ignore
/// impl_validator!(ValidatorForTest6_1_1, validate_missing_product_id);
/// ```
///
/// For tests that only apply to CSAF 2.0:
/// ```ignore
/// impl_validator!(csaf2_0, ValidatorForTest6_2_10, test_6_2_10_missing_tlp_label);
/// ```
///
/// For tests that only apply to CSAF 2.1:
/// ```ignore
/// impl_validator!(csaf2_1, ValidatorForTest6_1_41, test_6_1_41_missing_sharing_group_name);
/// ```
macro_rules! impl_validator {
    ($validator:ident, $validate_fn:path) => {
        $crate::test_validation::impl_validator!(csaf2_0, $validator, $validate_fn);
        $crate::test_validation::impl_validator!(csaf2_1, $validator, $validate_fn);
    };
    (csaf2_0, $validator:ident, $validate_fn:path) => {
        impl crate::test_validation::TestValidator<crate::schema::csaf2_0::schema::CommonSecurityAdvisoryFramework>
            for crate::csaf2_0::testcases::$validator
        {
            fn validate(
                &self,
                doc: &crate::schema::csaf2_0::schema::CommonSecurityAdvisoryFramework,
            ) -> Result<(), Vec<crate::validation::ValidationError>> {
                $validate_fn(doc)
            }
        }
    };
    (csaf2_1, $validator:ident, $validate_fn:path) => {
        impl crate::test_validation::TestValidator<crate::schema::csaf2_1::schema::CommonSecurityAdvisoryFramework>
            for crate::csaf2_1::testcases::$validator
        {
            fn validate(
                &self,
                doc: &crate::schema::csaf2_1::schema::CommonSecurityAdvisoryFramework,
            ) -> Result<(), Vec<crate::validation::ValidationError>> {
                $validate_fn(doc)
            }
        }
    };
}

pub(crate) use impl_validator;

/// Macro to generate the boilerplate `TestValidator<RawDocument<CommonSecurityAdvisoryFramework>>`
/// impl blocks for validation tests that operate on raw JSON.
///
/// # Usage
///
/// For tests that apply to both CSAF 2.0 and 2.1:
/// ```ignore
/// impl_raw_json_validator!(ValidatorForTest6_2_13, test_6_2_13_sorting);
/// ```
///
/// For tests that only apply to CSAF 2.0:
/// ```ignore
/// impl_raw_json_validator!(csaf2_0, ValidatorForTest, some_validate_fn);
/// ```
///
/// For tests that only apply to CSAF 2.1:
/// ```ignore
/// impl_raw_json_validator!(csaf2_1, ValidatorForTest, some_validate_fn);
/// ```
macro_rules! impl_raw_json_validator {
    ($validator:ident, $validate_fn:path) => {
        $crate::test_validation::impl_raw_json_validator!(csaf2_0, $validator, $validate_fn);
        $crate::test_validation::impl_raw_json_validator!(csaf2_1, $validator, $validate_fn);
    };
    (csaf2_0, $validator:ident, $validate_fn:path) => {
        impl
            crate::test_validation::TestValidator<
                crate::csaf::raw::RawDocument<crate::schema::csaf2_0::schema::CommonSecurityAdvisoryFramework>,
            > for crate::csaf2_0::testcases::$validator
        {
            fn validate(
                &self,
                document: &crate::csaf::raw::RawDocument<
                    crate::schema::csaf2_0::schema::CommonSecurityAdvisoryFramework,
                >,
            ) -> Result<(), Vec<crate::validation::ValidationError>> {
                $validate_fn(document.get_json())
            }
        }
    };
    (csaf2_1, $validator:ident, $validate_fn:path) => {
        impl
            crate::test_validation::TestValidator<
                crate::csaf::raw::RawDocument<crate::schema::csaf2_1::schema::CommonSecurityAdvisoryFramework>,
            > for crate::csaf2_1::testcases::$validator
        {
            fn validate(
                &self,
                document: &crate::csaf::raw::RawDocument<
                    crate::schema::csaf2_1::schema::CommonSecurityAdvisoryFramework,
                >,
            ) -> Result<(), Vec<crate::validation::ValidationError>> {
                $validate_fn(document.get_json())
            }
        }
    };
}

pub(crate) use impl_raw_json_validator;