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

use crate::csaf::types::csaf_datetime::CsafDateTime;
use crate::csaf::types::csaf_datetime::CsafDateTime::{Invalid, Valid};
use crate::csaf_traits::{
    CsafTrait, DocumentTrait, FirstKnownExploitationDatesTrait, TrackingTrait, VulnerabilityTrait, WithDate,
    WithOptionalDate,
};
use crate::validation::ValidationError;
use regex::Regex;
use std::sync::LazyLock;

static CSAF_RFC3339_REGEX: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(r"^((\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:(?:[0-4]\d|5[0-9])(?:\.\d+)?)(Z|[+-]\d{2}:\d{2}))$").unwrap()
});

/// Validates that all date/time fields in the CSAF document conform to the required format
/// (ISO 8601 format with time zone or UTC).
///
/// This function checks all date/time fields in the document, including tracking dates,
/// vulnerability disclosure/discovery dates, remediation dates, threat dates, etc.
pub fn test_6_1_37_date_and_time(doc: &impl CsafTrait) -> Result<(), Vec<ValidationError>> {
    let tracking = doc.get_document().get_tracking();

    // Check the initial release date
    check_datetime(
        &tracking.get_initial_release_date(),
        "/document/tracking/initial_release_date",
    )?;

    // Check the current release date
    check_datetime(
        &tracking.get_current_release_date(),
        "/document/tracking/current_release_date",
    )?;

    // Check the generator date if present
    if let Some(generator) = tracking.get_generator()
        && let Some(date) = generator.get_date()
    {
        check_datetime(&date, "/document/tracking/generator/date")?;
    }

    // Check revision history dates if present
    for (i_r, revision) in tracking.get_revision_history().iter().enumerate() {
        check_datetime(
            &revision.get_date(),
            &format!("/document/tracking/revision_history/{i_r}/date"),
        )?;
    }

    // Check vulnerability-related dates
    for (i_v, vuln) in doc.get_vulnerabilities().iter().enumerate() {
        // Check disclosure date if present
        if let Some(date) = vuln.get_disclosure_date() {
            check_datetime(&date, &format!("/vulnerabilities/{i_v}/disclosure_date"))?;
        }

        // Check the discovery date if present
        if let Some(date) = vuln.get_discovery_date() {
            check_datetime(&date, &format!("/vulnerabilities/{i_v}/discovery_date"))?;
        }

        // Check flags dates if present
        if let Some(flags) = vuln.get_flags() {
            for (i_f, flag) in flags.iter().enumerate() {
                if let Some(date) = flag.get_date() {
                    check_datetime(&date, &format!("/vulnerabilities/{i_v}/flags/{i_f}/date"))?;
                }
            }
        }

        // Check involvement dates if present
        if let Some(involvements) = vuln.get_involvements() {
            for (i_i, involvement) in involvements.iter().enumerate() {
                if let Some(date) = involvement.get_date() {
                    check_datetime(&date, &format!("/vulnerabilities/{i_v}/involvements/{i_i}/date"))?;
                }
            }
        }

        // Check remediation dates if present
        for (i_r, remediation) in vuln.get_remediations().iter().enumerate() {
            if let Some(date) = remediation.get_date() {
                check_datetime(&date, &format!("/vulnerabilities/{i_v}/remediations/{i_r}/date"))?;
            }
        }

        // Check threat dates if present
        for (i_t, threat) in vuln.get_threats().iter().enumerate() {
            if let Some(date) = threat.get_date() {
                check_datetime(&date, &format!("/vulnerabilities/{i_v}/threats/{i_t}/date"))?;
            }
        }

        if let Some(first_known_exploitation_dates) = vuln.get_first_known_exploitation_dates() {
            for (i_d, date) in first_known_exploitation_dates.iter().enumerate() {
                check_datetime(
                    &date.get_date(),
                    &format!("/vulnerabilities/{i_v}/first_known_exploitation_dates/{i_d}/date"),
                )?;
                check_datetime(
                    &date.get_exploitation_date(),
                    &format!("/vulnerabilities/{i_v}/first_known_exploitation_dates/{i_d}/exploitation_date"),
                )?;
            }
        }
    }

    Ok(())
}

fn create_invalid_format_error(date_time: &str, instance_path: &str) -> ValidationError {
    ValidationError {
        message: format!(
            "Invalid date-time string {date_time}, expected RFC3339-compliant format with non-empty timezone and no leap seconds"
        ),
        instance_path: instance_path.to_string(),
    }
}

fn create_parsing_error(date_time: &str, error: impl std::fmt::Display, instance_path: &str) -> ValidationError {
    ValidationError {
        message: format!("Date-time string {date_time} matched RFC3339 regex but failed chrono parsing: {error}"),
        instance_path: instance_path.to_string(),
    }
}

fn check_datetime(date_time: &CsafDateTime, instance_path: &str) -> Result<(), Vec<ValidationError>> {
    let date = match date_time {
        Valid(date) => date.get_raw_string(),
        Invalid(err) => err.get_raw_string(),
    };
    if CSAF_RFC3339_REGEX.is_match(date) {
        // Add chrono-based plausibility check
        match date_time {
            Valid(_) => Ok(()),
            Invalid(err) => Err(vec![create_parsing_error(date, err, instance_path)]),
        }
    } else {
        Err(vec![create_invalid_format_error(date, instance_path)])
    }
}

crate::test_validation::impl_validator!(csaf2_1, ValidatorForTest6_1_37, test_6_1_37_date_and_time);

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

    #[test]
    fn test_test_6_1_37() {
        // Only CSAF 2.1 has this test with 16 test cases (10 error cases, 6 success cases)
        TESTS_2_1.test_6_1_37.expect(
            Err(vec![create_invalid_format_error(
                "2024-01-24 10:00:00.000Z",
                "/document/tracking/initial_release_date",
            )]),
            Err(vec![create_invalid_format_error(
                "2024-01-24T10:00:00.000z",
                "/document/tracking/initial_release_date",
            )]),
            Err(vec![create_invalid_format_error(
                "2017-01-01T02:59:60+04:00",
                "/vulnerabilities/0/disclosure_date",
            )]),
            Err(vec![create_parsing_error(
                "2023-04-31T00:00:00+01:00",
                "Failed to parse '2023-04-31T00:00:00+01:00' as RFC3339 with reason 'input is out of range'",
                "/vulnerabilities/0/disclosure_date",
            )]),
            Err(vec![create_parsing_error(
                "2023-02-29T00:00:00+01:00",
                "Failed to parse '2023-02-29T00:00:00+01:00' as RFC3339 with reason 'input is out of range'",
                "/vulnerabilities/0/disclosure_date",
            )]),
            Err(vec![create_invalid_format_error(
                "2016-12-31T00:00:60+23:59",
                "/vulnerabilities/0/disclosure_date",
            )]),
            Err(vec![create_invalid_format_error(
                "2015-06-30T10:29:60-13:30",
                "/vulnerabilities/0/disclosure_date",
            )]),
            Err(vec![create_invalid_format_error(
                "2015-06-30T10:29:60-13:30",
                "/vulnerabilities/0/disclosure_date",
            )]),
            Err(vec![create_invalid_format_error(
                "2016-12-31T23:59:60.0123+00:00",
                "/vulnerabilities/0/disclosure_date",
            )]),
            Err(vec![create_invalid_format_error(
                "2024-01-24t10:00:00.000Z",
                "/vulnerabilities/0/first_known_exploitation_dates/0/date",
            )]),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
            Ok(()),
        );
    }
}