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
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

use clap::Parser;

use crate::application::dto::OutputFormat;
use crate::i18n::Locale;
use crate::sbom_generation::domain::vulnerability::Severity;

/// Generate SBOMs for Python projects managed by uv
#[derive(Parser, Debug)]
#[command(name = "uv-sbom")]
#[command(version)]
#[command(about = "Generate SBOMs for Python projects managed by uv", long_about = None)]
pub struct Args {
    /// Output format: json or markdown
    #[arg(short, long, default_value = "json")]
    pub format: OutputFormat,

    /// Path to the project directory (defaults to current directory)
    #[arg(short, long)]
    pub path: Option<String>,

    /// Output file path (if not specified, outputs to stdout)
    #[arg(short, long)]
    pub output: Option<String>,

    /// Exclude packages matching patterns (supports wildcards: *)
    /// Can be specified multiple times: -e "pkg-a" -e "debug-*"
    #[arg(short, long = "exclude", value_name = "PATTERN")]
    pub exclude: Vec<String>,

    /// Validate configuration without performing network operations or generating output
    #[arg(long)]
    pub dry_run: bool,

    /// [DEPRECATED] CVE checking is now enabled by default. This flag has no effect.
    /// Use --no-check-cve to opt out. This flag will be removed in a future release.
    #[arg(long, hide = false)]
    pub check_cve: bool,

    /// Disable CVE vulnerability checking (enabled by default)
    /// Vulnerability data provided by OSV (https://osv.dev) under CC-BY 4.0
    #[arg(long)]
    pub no_check_cve: bool,

    /// Severity threshold for vulnerability check (low/medium/high/critical)
    #[arg(long, value_parser = parse_severity_threshold, group = "threshold", conflicts_with = "no_check_cve")]
    pub severity_threshold: Option<Severity>,

    /// CVSS threshold for vulnerability check (0.0-10.0)
    #[arg(long, value_parser = parse_cvss_threshold, group = "threshold", conflicts_with = "no_check_cve")]
    pub cvss_threshold: Option<f32>,

    /// Suggest upgrade paths for vulnerable transitive dependencies
    #[arg(long, conflicts_with = "no_check_cve")]
    pub suggest_fix: bool,

    /// Verify PyPI links exist before generating hyperlinks (requires network access, Markdown format only)
    #[arg(long)]
    pub verify_links: bool,

    /// Explicit config file path (overrides auto-discovery)
    #[arg(short = 'c', long = "config", value_name = "PATH")]
    pub config: Option<String>,

    /// CVE IDs to ignore (can be specified multiple times)
    #[arg(short = 'i', long = "ignore-cve", value_name = "CVE_ID")]
    pub ignore_cve: Vec<String>,

    /// Check license compliance against a policy (Markdown format only)
    #[arg(long)]
    pub check_license: bool,

    /// Allowed license patterns (comma-separated, requires --check-license)
    /// Supports wildcards: "MIT,Apache-2.0,BSD-*"
    #[arg(long, value_delimiter = ',', requires = "check_license")]
    pub license_allow: Vec<String>,

    /// Denied license patterns (comma-separated, requires --check-license)
    /// Supports wildcards: "GPL-*,AGPL-*"
    #[arg(long, value_delimiter = ',', requires = "check_license")]
    pub license_deny: Vec<String>,

    /// Generate a uv-sbom.config.yml template file
    #[arg(long)]
    pub init: bool,

    /// Output language for human-readable formats: en (default) or ja
    #[arg(long, default_value = "en", value_parser = parse_lang)]
    pub lang: Locale,
}

fn parse_lang(s: &str) -> Result<Locale, String> {
    Locale::from_str(s)
        .ok_or_else(|| format!("Invalid language: '{}'. Supported languages: en, ja", s))
}

fn parse_severity_threshold(s: &str) -> Result<Severity, String> {
    match s.to_lowercase().as_str() {
        "low" => Ok(Severity::Low),
        "medium" => Ok(Severity::Medium),
        "high" => Ok(Severity::High),
        "critical" => Ok(Severity::Critical),
        _ => Err(format!(
            "Invalid severity: {}. Valid values: low, medium, high, critical",
            s
        )),
    }
}

fn parse_cvss_threshold(s: &str) -> Result<f32, String> {
    let threshold: f32 = s
        .parse()
        .map_err(|_| "CVSS threshold must be a number".to_string())?;

    if !(0.0..=10.0).contains(&threshold) {
        return Err("CVSS threshold must be between 0.0 and 10.0".to_string());
    }
    Ok(threshold)
}

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

    #[test]
    fn test_parse_lang_valid() {
        assert_eq!(parse_lang("en").unwrap(), Locale::En);
        assert_eq!(parse_lang("ja").unwrap(), Locale::Ja);
    }

    #[test]
    fn test_parse_lang_invalid() {
        let result = parse_lang("fr");
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .contains("Invalid language: 'fr'. Supported languages: en, ja"));

        let result = parse_lang("EN");
        assert!(result.is_err());

        let result = parse_lang("");
        assert!(result.is_err());
    }

    #[test]
    fn test_parse_severity_threshold_valid() {
        assert_eq!(parse_severity_threshold("low").unwrap(), Severity::Low);
        assert_eq!(
            parse_severity_threshold("medium").unwrap(),
            Severity::Medium
        );
        assert_eq!(parse_severity_threshold("high").unwrap(), Severity::High);
        assert_eq!(
            parse_severity_threshold("critical").unwrap(),
            Severity::Critical
        );
    }

    #[test]
    fn test_parse_severity_threshold_case_insensitive() {
        assert_eq!(parse_severity_threshold("LOW").unwrap(), Severity::Low);
        assert_eq!(
            parse_severity_threshold("Medium").unwrap(),
            Severity::Medium
        );
        assert_eq!(parse_severity_threshold("HIGH").unwrap(), Severity::High);
        assert_eq!(
            parse_severity_threshold("CRITICAL").unwrap(),
            Severity::Critical
        );
    }

    #[test]
    fn test_parse_severity_threshold_invalid() {
        let result = parse_severity_threshold("none");
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("Invalid severity"));

        let result = parse_severity_threshold("unknown");
        assert!(result.is_err());
    }

    #[test]
    fn test_parse_cvss_threshold_valid() {
        assert_eq!(parse_cvss_threshold("0.0").unwrap(), 0.0);
        assert_eq!(parse_cvss_threshold("5.5").unwrap(), 5.5);
        assert_eq!(parse_cvss_threshold("10.0").unwrap(), 10.0);
        assert_eq!(parse_cvss_threshold("7").unwrap(), 7.0);
    }

    #[test]
    fn test_parse_cvss_threshold_invalid_range() {
        let result = parse_cvss_threshold("-1.0");
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("between 0.0 and 10.0"));

        let result = parse_cvss_threshold("11.0");
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("between 0.0 and 10.0"));
    }

    #[test]
    fn test_parse_cvss_threshold_invalid_format() {
        let result = parse_cvss_threshold("abc");
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("must be a number"));
    }
}