uv-sbom 2.0.1

SBOM generation tool for uv projects - Generate CycloneDX SBOMs from uv.lock files
Documentation 
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

use super::vulnerability::Severity;

/// Represents a resolution entry for a single vulnerable transitive dependency
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct ResolutionEntry {
    /// Name of the vulnerable transitive package
    vulnerable_package: String,
    /// Current installed version of the vulnerable package
    current_version: String,
    /// Version that fixes the vulnerability (from OSV)
    fixed_version: Option<String>,
    /// Severity of the vulnerability
    severity: Severity,
    /// Vulnerability ID (e.g., CVE-2024-XXXXX)
    vulnerability_id: String,
    /// List of direct dependencies that introduce this vulnerable package
    introduced_by: Vec<IntroducedBy>,
}

impl ResolutionEntry {
    #[allow(dead_code)]
    pub fn new(
        vulnerable_package: String,
        current_version: String,
        fixed_version: Option<String>,
        severity: Severity,
        vulnerability_id: String,
        introduced_by: Vec<IntroducedBy>,
    ) -> Self {
        Self {
            vulnerable_package,
            current_version,
            fixed_version,
            severity,
            vulnerability_id,
            introduced_by,
        }
    }

    #[allow(dead_code)]
    pub fn vulnerable_package(&self) -> &str {
        &self.vulnerable_package
    }

    #[allow(dead_code)]
    pub fn current_version(&self) -> &str {
        &self.current_version
    }

    #[allow(dead_code)]
    pub fn fixed_version(&self) -> Option<&str> {
        self.fixed_version.as_deref()
    }

    #[allow(dead_code)]
    pub fn severity(&self) -> Severity {
        self.severity
    }

    #[allow(dead_code)]
    pub fn vulnerability_id(&self) -> &str {
        &self.vulnerability_id
    }

    #[allow(dead_code)]
    pub fn introduced_by(&self) -> &[IntroducedBy] {
        &self.introduced_by
    }
}

/// Represents a direct dependency that introduces a vulnerable transitive dep
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct IntroducedBy {
    /// Name of the direct dependency
    package_name: String,
    /// Current version of the direct dependency
    version: String,
}

impl IntroducedBy {
    #[allow(dead_code)]
    pub fn new(package_name: String, version: String) -> Self {
        Self {
            package_name,
            version,
        }
    }

    #[allow(dead_code)]
    pub fn package_name(&self) -> &str {
        &self.package_name
    }

    #[allow(dead_code)]
    pub fn version(&self) -> &str {
        &self.version
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_introduced_by_new() {
        let entry = IntroducedBy::new("requests".to_string(), "2.28.0".to_string());

        assert_eq!(entry.package_name(), "requests");
        assert_eq!(entry.version(), "2.28.0");
    }

    #[test]
    fn test_resolution_entry_new() {
        let introduced = vec![
            IntroducedBy::new("requests".to_string(), "2.28.0".to_string()),
            IntroducedBy::new("httpx".to_string(), "0.23.0".to_string()),
        ];

        let entry = ResolutionEntry::new(
            "urllib3".to_string(),
            "1.26.5".to_string(),
            Some("1.26.18".to_string()),
            Severity::High,
            "CVE-2023-43804".to_string(),
            introduced,
        );

        assert_eq!(entry.vulnerable_package(), "urllib3");
        assert_eq!(entry.current_version(), "1.26.5");
        assert_eq!(entry.fixed_version(), Some("1.26.18"));
        assert_eq!(entry.severity(), Severity::High);
        assert_eq!(entry.vulnerability_id(), "CVE-2023-43804");
        assert_eq!(entry.introduced_by().len(), 2);
        assert_eq!(entry.introduced_by()[0].package_name(), "requests");
        assert_eq!(entry.introduced_by()[1].package_name(), "httpx");
    }

    #[test]
    fn test_resolution_entry_without_fixed_version() {
        let entry = ResolutionEntry::new(
            "vulnerable-pkg".to_string(),
            "0.1.0".to_string(),
            None,
            Severity::Critical,
            "CVE-2024-0001".to_string(),
            vec![IntroducedBy::new(
                "parent-pkg".to_string(),
                "1.0.0".to_string(),
            )],
        );

        assert_eq!(entry.fixed_version(), None);
        assert_eq!(entry.severity(), Severity::Critical);
    }

    #[test]
    fn test_resolution_entry_empty_introduced_by() {
        let entry = ResolutionEntry::new(
            "some-pkg".to_string(),
            "1.0.0".to_string(),
            Some("1.0.1".to_string()),
            Severity::Medium,
            "GHSA-xxxx-yyyy-zzzz".to_string(),
            vec![],
        );

        assert!(entry.introduced_by().is_empty());
    }
}