sbom_tools/model/
vulnerability.rs

1//! Vulnerability data structures.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5use std::fmt;
6
7/// Reference to a vulnerability affecting a component
8#[derive(Debug, Clone, Serialize, Deserialize)]
9pub struct VulnerabilityRef {
10    /// Vulnerability identifier (CVE, GHSA, etc.)
11    pub id: String,
12    /// Source database
13    pub source: VulnerabilitySource,
14    /// Severity level
15    pub severity: Option<Severity>,
16    /// CVSS scores
17    pub cvss: Vec<CvssScore>,
18    /// Affected version ranges
19    pub affected_versions: Vec<String>,
20    /// Remediation information
21    pub remediation: Option<Remediation>,
22    /// Description
23    pub description: Option<String>,
24    /// CWE identifiers
25    pub cwes: Vec<String>,
26    /// Published date
27    pub published: Option<DateTime<Utc>>,
28    /// Last modified date
29    pub modified: Option<DateTime<Utc>>,
30    /// Whether this CVE is in CISA's Known Exploited Vulnerabilities catalog
31    pub is_kev: bool,
32    /// KEV-specific metadata if applicable
33    pub kev_info: Option<KevInfo>,
34    /// Per-vulnerability VEX status (from external VEX documents or embedded analysis)
35    #[serde(default, skip_serializing_if = "Option::is_none")]
36    pub vex_status: Option<VexStatus>,
37}
38
39/// CISA Known Exploited Vulnerabilities (KEV) catalog information
40#[derive(Debug, Clone, Serialize, Deserialize)]
41pub struct KevInfo {
42    /// Date added to KEV catalog
43    pub date_added: DateTime<Utc>,
44    /// Due date for remediation (per CISA directive)
45    pub due_date: DateTime<Utc>,
46    /// Whether known to be used in ransomware campaigns
47    pub known_ransomware_use: bool,
48    /// Required action description
49    pub required_action: String,
50    /// Vendor/project name
51    pub vendor_project: Option<String>,
52    /// Product name
53    pub product: Option<String>,
54}
55
56impl KevInfo {
57    /// Create new KEV info
58    #[must_use]
59    pub const fn new(
60        date_added: DateTime<Utc>,
61        due_date: DateTime<Utc>,
62        required_action: String,
63    ) -> Self {
64        Self {
65            date_added,
66            due_date,
67            known_ransomware_use: false,
68            required_action,
69            vendor_project: None,
70            product: None,
71        }
72    }
73
74    /// Check if remediation is overdue
75    #[must_use]
76    pub fn is_overdue(&self) -> bool {
77        Utc::now() > self.due_date
78    }
79
80    /// Days until due date (negative if overdue)
81    #[must_use]
82    pub fn days_until_due(&self) -> i64 {
83        (self.due_date - Utc::now()).num_days()
84    }
85}
86
87impl VulnerabilityRef {
88    /// Create a new vulnerability reference
89    #[must_use]
90    pub const fn new(id: String, source: VulnerabilitySource) -> Self {
91        Self {
92            id,
93            source,
94            severity: None,
95            cvss: Vec::new(),
96            affected_versions: Vec::new(),
97            remediation: None,
98            description: None,
99            cwes: Vec::new(),
100            published: None,
101            modified: None,
102            is_kev: false,
103            kev_info: None,
104            vex_status: None,
105        }
106    }
107
108    /// Check if this vulnerability is actively exploited (KEV)
109    #[must_use]
110    pub const fn is_actively_exploited(&self) -> bool {
111        self.is_kev
112    }
113
114    /// Check if this is a ransomware-related KEV entry
115    #[must_use]
116    pub fn is_ransomware_related(&self) -> bool {
117        self.kev_info
118            .as_ref()
119            .is_some_and(|k| k.known_ransomware_use)
120    }
121
122    /// Set per-vulnerability VEX status
123    #[must_use]
124    pub fn with_vex_status(mut self, vex: VexStatus) -> Self {
125        self.vex_status = Some(vex);
126        self
127    }
128
129    /// Get the highest CVSS score
130    #[must_use]
131    pub fn max_cvss_score(&self) -> Option<f32> {
132        self.cvss
133            .iter()
134            .map(|c| c.base_score)
135            .max_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal))
136    }
137}
138
139impl PartialEq for VulnerabilityRef {
140    fn eq(&self, other: &Self) -> bool {
141        self.id == other.id && self.source == other.source
142    }
143}
144
145impl Eq for VulnerabilityRef {}
146
147impl std::hash::Hash for VulnerabilityRef {
148    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
149        self.id.hash(state);
150        self.source.hash(state);
151    }
152}
153
154/// Vulnerability database source
155#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
156pub enum VulnerabilitySource {
157    Nvd,
158    Ghsa,
159    Osv,
160    Snyk,
161    Sonatype,
162    VulnDb,
163    Cve,
164    Other(String),
165}
166
167impl fmt::Display for VulnerabilitySource {
168    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
169        match self {
170            Self::Nvd => write!(f, "NVD"),
171            Self::Ghsa => write!(f, "GHSA"),
172            Self::Osv => write!(f, "OSV"),
173            Self::Snyk => write!(f, "Snyk"),
174            Self::Sonatype => write!(f, "Sonatype"),
175            Self::VulnDb => write!(f, "VulnDB"),
176            Self::Cve => write!(f, "CVE"),
177            Self::Other(s) => write!(f, "{s}"),
178        }
179    }
180}
181
182/// Severity level
183#[derive(Debug, Clone, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
184#[non_exhaustive]
185pub enum Severity {
186    Critical,
187    High,
188    Medium,
189    Low,
190    Info,
191    None,
192    #[default]
193    Unknown,
194}
195
196impl Severity {
197    /// Create severity from CVSS score
198    #[must_use]
199    pub fn from_cvss(score: f32) -> Self {
200        match score {
201            s if s >= 9.0 => Self::Critical,
202            s if s >= 7.0 => Self::High,
203            s if s >= 4.0 => Self::Medium,
204            s if s >= 0.1 => Self::Low,
205            0.0 => Self::None,
206            _ => Self::Unknown,
207        }
208    }
209
210    /// Get numeric priority (lower is more severe)
211    #[must_use]
212    pub const fn priority(&self) -> u8 {
213        match self {
214            Self::Critical => 0,
215            Self::High => 1,
216            Self::Medium => 2,
217            Self::Low => 3,
218            Self::Info => 4,
219            Self::None => 5,
220            Self::Unknown => 6,
221        }
222    }
223}
224
225impl fmt::Display for Severity {
226    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
227        match self {
228            Self::Critical => write!(f, "Critical"),
229            Self::High => write!(f, "High"),
230            Self::Medium => write!(f, "Medium"),
231            Self::Low => write!(f, "Low"),
232            Self::Info => write!(f, "Info"),
233            Self::None => write!(f, "None"),
234            Self::Unknown => write!(f, "Unknown"),
235        }
236    }
237}
238
239/// CVSS score information
240#[derive(Debug, Clone, Serialize, Deserialize)]
241pub struct CvssScore {
242    /// CVSS version
243    pub version: CvssVersion,
244    /// Base score (0.0 - 10.0)
245    pub base_score: f32,
246    /// Attack vector
247    pub vector: Option<String>,
248    /// Exploitability score
249    pub exploitability_score: Option<f32>,
250    /// Impact score
251    pub impact_score: Option<f32>,
252}
253
254impl CvssScore {
255    /// Create a new CVSS score
256    #[must_use]
257    pub const fn new(version: CvssVersion, base_score: f32) -> Self {
258        Self {
259            version,
260            base_score,
261            vector: None,
262            exploitability_score: None,
263            impact_score: None,
264        }
265    }
266}
267
268/// CVSS version
269#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
270pub enum CvssVersion {
271    V2,
272    V3,
273    V31,
274    V4,
275}
276
277impl fmt::Display for CvssVersion {
278    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
279        match self {
280            Self::V2 => write!(f, "2.0"),
281            Self::V3 => write!(f, "3.0"),
282            Self::V31 => write!(f, "3.1"),
283            Self::V4 => write!(f, "4.0"),
284        }
285    }
286}
287
288/// Remediation information
289#[derive(Debug, Clone, Serialize, Deserialize)]
290pub struct Remediation {
291    /// Remediation type
292    pub remediation_type: RemediationType,
293    /// Description
294    pub description: Option<String>,
295    /// Fixed version
296    pub fixed_version: Option<String>,
297}
298
299/// Remediation type
300#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
301pub enum RemediationType {
302    Patch,
303    Upgrade,
304    Workaround,
305    Mitigation,
306    None,
307}
308
309impl fmt::Display for RemediationType {
310    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
311        match self {
312            Self::Patch => write!(f, "Patch"),
313            Self::Upgrade => write!(f, "Upgrade"),
314            Self::Workaround => write!(f, "Workaround"),
315            Self::Mitigation => write!(f, "Mitigation"),
316            Self::None => write!(f, "None"),
317        }
318    }
319}
320
321/// VEX (Vulnerability Exploitability eXchange) status
322#[derive(Debug, Clone, Serialize, Deserialize)]
323pub struct VexStatus {
324    /// VEX state
325    pub status: VexState,
326    /// Justification for the status
327    pub justification: Option<VexJustification>,
328    /// Action statement
329    pub action_statement: Option<String>,
330    /// Impact statement
331    pub impact_statement: Option<String>,
332    /// Response actions
333    #[serde(default, skip_serializing_if = "Vec::is_empty")]
334    pub responses: Vec<VexResponse>,
335    /// Details
336    pub detail: Option<String>,
337}
338
339impl VexStatus {
340    /// Create a new VEX status
341    #[must_use]
342    pub const fn new(status: VexState) -> Self {
343        Self {
344            status,
345            justification: None,
346            action_statement: None,
347            impact_statement: None,
348            responses: Vec::new(),
349            detail: None,
350        }
351    }
352}
353
354/// VEX state
355#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
356pub enum VexState {
357    Affected,
358    NotAffected,
359    Fixed,
360    UnderInvestigation,
361}
362
363impl fmt::Display for VexState {
364    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
365        match self {
366            Self::Affected => write!(f, "Affected"),
367            Self::NotAffected => write!(f, "Not Affected"),
368            Self::Fixed => write!(f, "Fixed"),
369            Self::UnderInvestigation => write!(f, "Under Investigation"),
370        }
371    }
372}
373
374/// VEX justification for `not_affected` status
375#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
376pub enum VexJustification {
377    ComponentNotPresent,
378    VulnerableCodeNotPresent,
379    VulnerableCodeNotInExecutePath,
380    VulnerableCodeCannotBeControlledByAdversary,
381    InlineMitigationsAlreadyExist,
382}
383
384impl fmt::Display for VexJustification {
385    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
386        match self {
387            Self::ComponentNotPresent => write!(f, "Component not present"),
388            Self::VulnerableCodeNotPresent => write!(f, "Vulnerable code not present"),
389            Self::VulnerableCodeNotInExecutePath => {
390                write!(f, "Vulnerable code not in execute path")
391            }
392            Self::VulnerableCodeCannotBeControlledByAdversary => {
393                write!(f, "Vulnerable code cannot be controlled by adversary")
394            }
395            Self::InlineMitigationsAlreadyExist => {
396                write!(f, "Inline mitigations already exist")
397            }
398        }
399    }
400}
401
402/// VEX response type
403#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
404pub enum VexResponse {
405    CanNotFix,
406    WillNotFix,
407    Update,
408    Rollback,
409    Workaround,
410}
411
412impl fmt::Display for VexResponse {
413    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
414        match self {
415            Self::CanNotFix => write!(f, "Can Not Fix"),
416            Self::WillNotFix => write!(f, "Will Not Fix"),
417            Self::Update => write!(f, "Update"),
418            Self::Rollback => write!(f, "Rollback"),
419            Self::Workaround => write!(f, "Workaround"),
420        }
421    }
422}
sbom_tools/model/vulnerability.rs

sbom_tools/model/
vulnerability.rs
