bitvex 0.2.6

Automate CRA compliance: generate OpenVEX reports from Yocto SBOMs by filtering CVEs with kernel config and device tree analysis
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
use bitvex::cli::{Args, Command};
use bitvex::epss;
use bitvex::filters;
use bitvex::osv;
use bitvex::output;
use bitvex::rules;
use bitvex::sbom;
use bitvex::vex;

use anyhow::{Context, Result};
use clap::Parser;
use tracing::{info, warn};

use filters::device_tree::parse_device_tree;
use filters::kernel_config::parse_kernel_config;
use filters::native::filter_native_packages;
use sbom::parse_spdx_sbom;
use vex::{VexStatus, generate_openvex};

#[tokio::main]
async fn main() -> Result<()> {
    let args = Args::parse();

    let level = if args.verbose { "debug" } else { "info" };
    tracing_subscriber::fmt()
        .with_env_filter(
            tracing_subscriber::EnvFilter::try_from_default_env()
                .unwrap_or_else(|_| tracing_subscriber::EnvFilter::new(level)),
        )
        .init();

    match args.command {
        Some(Command::Diff { old, new, output }) => {
            return cmd_diff(&old, &new, output.as_deref());
        }
        Some(Command::DownloadDb {
            db_path,
            ecosystems,
            profile,
            yes,
        }) => {
            return cmd_download_db(
                db_path.as_deref(),
                ecosystems.as_deref(),
                profile.as_ref(),
                yes,
            )
            .await;
        }
        Some(Command::DownloadEpssDb { db_path, yes }) => {
            return cmd_download_epss_db(db_path.as_deref(), yes).await;
        }
        None => {}
    }

    cmd_scan(&args).await
}

fn cmd_diff(
    old: &std::path::Path,
    new: &std::path::Path,
    output: Option<&std::path::Path>,
) -> Result<()> {
    info!("Comparing SBOMs");
    let diff = sbom::diff::diff_sboms(old, new)?;

    sbom::diff::print_diff_summary(&diff);

    if let Some(out_path) = output {
        let json = serde_json::to_string_pretty(&diff)?;
        std::fs::write(out_path, &json)
            .with_context(|| format!("Failed to write diff: {}", out_path.display()))?;
        info!("Diff written to {}", out_path.display());
    }

    Ok(())
}

async fn cmd_download_db(
    db_path: Option<&std::path::Path>,
    ecosystems: Option<&[String]>,
    profile: Option<&bitvex::cli::DownloadProfile>,
    yes: bool,
) -> Result<()> {
    let path = db_path
        .map(|p| p.to_path_buf())
        .unwrap_or_else(osv::db::default_db_path);

    let eco_list = osv::db::resolve_ecosystems(ecosystems, profile);

    osv::db::download_databases(&path, &eco_list, yes).await
}

async fn cmd_download_epss_db(db_path: Option<&std::path::Path>, yes: bool) -> Result<()> {
    let path = db_path
        .map(|p| p.to_path_buf())
        .unwrap_or_else(epss::offline::default_epss_db_path);

    epss::offline::download_epss_db(&path, yes).await
}

async fn cmd_scan(args: &Args) -> Result<()> {
    info!("BitVex v{} starting", env!("CARGO_PKG_VERSION"));

    // 1. Parse SBOM (required)
    let sbom_path = args
        .sbom
        .as_ref()
        .context("--sbom is required for scan mode")?;

    info!("Parsing SBOM: {}", sbom_path.display());
    let sbom_data = std::fs::read(sbom_path)
        .with_context(|| format!("Failed to read SBOM: {}", sbom_path.display()))?;

    // SPDX version detection
    if let Ok(doc) = serde_json::from_slice::<serde_json::Value>(&sbom_data) {
        if let Some(version) = doc.get("spdxVersion").and_then(|v| v.as_str()) {
            if version.starts_with("SPDX-3") {
                warn!(
                    "SPDX 3.0 detected ({}) - limited support. Only basic package extraction.",
                    version
                );
            }
        }
    }

    let packages = parse_spdx_sbom(&sbom_data)?;
    info!("Found {} packages in SBOM", packages.len());

    if packages.is_empty() {
        warn!("No packages found in SBOM, nothing to do");
        return Ok(());
    }

    // 2. Parse kernel config (optional)
    let kernel_configs: Vec<_> = args
        .kernel_config
        .iter()
        .map(|path| {
            info!("Parsing kernel config: {}", path.display());
            parse_kernel_config(path)
        })
        .collect::<Result<Vec<_>>>()?;

    // 3. Parse U-Boot config (optional)
    let uboot_config = if let Some(ref uboot_path) = args.uboot_config {
        info!("Parsing U-Boot config: {}", uboot_path.display());
        Some(parse_kernel_config(uboot_path)?)
    } else {
        None
    };

    // 4. Parse device tree (optional)
    let dts_nodes = if let Some(ref dt_path) = args.device_tree {
        info!("Parsing device tree: {}", dt_path.display());
        Some(parse_device_tree(dt_path)?)
    } else {
        None
    };

    // 5. Load rules if provided
    let rules_config = if let Some(ref rules_path) = args.rules {
        Some(rules::load_rules(rules_path)?)
    } else {
        None
    };

    // 6. Pre-OSV filter: native packages
    let native_indices: Vec<usize> = packages
        .iter()
        .enumerate()
        .filter(|(_, p)| filters::native::is_native_package(&p.name))
        .map(|(i, _)| i)
        .collect();

    let non_native_packages: Vec<_> = packages
        .iter()
        .enumerate()
        .filter(|(i, _)| !native_indices.contains(i))
        .map(|(_, p)| p.clone())
        .collect();

    info!(
        "Querying OSV for {} non-native packages (skipping {} native)",
        non_native_packages.len(),
        native_indices.len()
    );

    // 7. Download DB if requested and using offline mode
    if args.offline && args.download_db {
        let db_path = args
            .db_path
            .clone()
            .unwrap_or_else(osv::db::default_db_path);

        let eco_list = osv::db::resolve_ecosystems(None, args.profile.as_ref());

        osv::db::download_databases(&db_path, &eco_list, args.yes).await?;
    }

    // 8. Query OSV (online or offline)
    let osv_results = if args.offline {
        let db_path = args
            .db_path
            .clone()
            .unwrap_or_else(osv::db::default_db_path);
        let provider = osv::offline::OfflineOsvProvider::new(&db_path)?;
        provider.query_batch(&non_native_packages)?
    } else {
        let client = osv::OsvClient::new()?;
        client.query_batch(&non_native_packages).await?
    };

    // 9. Query EPSS if enabled
    let epss_scores = if args.epss {
        // Collect all CVE IDs: from direct IDs and from aliases
        let mut all_cve_ids: Vec<String> = Vec::new();
        for result in &osv_results {
            for vuln in &result.vulns {
                if vuln.id.starts_with("CVE-") {
                    all_cve_ids.push(vuln.id.clone());
                }
                // Also add CVE aliases
                for alias in &vuln.aliases {
                    if alias.starts_with("CVE-") && !all_cve_ids.contains(alias) {
                        all_cve_ids.push(alias.clone());
                    }
                }
            }
        }
        all_cve_ids.sort();
        all_cve_ids.dedup();

        info!("Found {} unique CVE IDs for EPSS lookup", all_cve_ids.len());

        if all_cve_ids.is_empty() {
            Vec::new()
        } else if args.epss_offline {
            let epss_path = args
                .epss_db_path
                .clone()
                .unwrap_or_else(epss::offline::default_epss_db_path);
            let provider = epss::OfflineEpssProvider::new(&epss_path)?;
            provider.query_batch(&all_cve_ids)
        } else {
            let client = epss::EpssClient::new()?;
            client.query_batch(&all_cve_ids).await?
        }
    } else {
        Vec::new()
    };

    // 10. Apply rules engine first (if provided)
    let (rules_statements, rules_filtered_indices) = if let Some(ref config) = rules_config {
        filters::rules::apply_rules(&osv_results, config)
    } else {
        (Vec::new(), Vec::new())
    };

    // 11. Apply hardware filters on remaining
    let remaining_after_rules: Vec<_> = osv_results
        .iter()
        .enumerate()
        .filter(|(i, _)| !rules_filtered_indices.contains(i))
        .map(|(_, r)| r.clone())
        .collect();

    // Kernel config filter
    let (kernel_statements, kernel_filtered_local) = if !kernel_configs.is_empty() {
        let merged = merge_kernel_configs(&kernel_configs);
        let (stmts, filtered) =
            filters::kernel_config::filter_by_kernel_config(&remaining_after_rules, &merged);
        (stmts, filtered)
    } else {
        (Vec::new(), Vec::new())
    };

    let remaining_after_kernel: Vec<_> = remaining_after_rules
        .iter()
        .enumerate()
        .filter(|(i, _)| !kernel_filtered_local.contains(i))
        .map(|(_, r)| r.clone())
        .collect();

    // U-Boot config filter
    let (uboot_statements, uboot_filtered_local) = if let Some(ref uboot_cfg) = uboot_config {
        filters::kernel_config::filter_by_kernel_config(&remaining_after_kernel, uboot_cfg)
    } else {
        (Vec::new(), Vec::new())
    };

    let remaining_after_uboot: Vec<_> = remaining_after_kernel
        .iter()
        .enumerate()
        .filter(|(i, _)| !uboot_filtered_local.contains(i))
        .map(|(_, r)| r.clone())
        .collect();

    // Device tree filter
    let (dts_statements, dts_filtered_local) = if let Some(ref dts) = dts_nodes {
        filters::device_tree::filter_by_device_tree(&remaining_after_uboot, dts)
    } else {
        (Vec::new(), Vec::new())
    };

    // 12. Build native statements
    let native_osv_results: Vec<_> = packages
        .iter()
        .enumerate()
        .filter(|(i, _)| native_indices.contains(i))
        .map(|(_, p)| osv::OsvResult {
            package: p.clone(),
            vulns: vec![],
        })
        .collect();

    let (native_statements, _) = filter_native_packages(&native_osv_results);

    // 13. Remaining packages get affected status (with EPSS if available)
    let remaining_indices: Vec<usize> = remaining_after_uboot
        .iter()
        .enumerate()
        .filter(|(_, r)| {
            if let Some(ref dts) = dts_nodes {
                let pkg_lower = r.package.name.to_lowercase();
                let disabled_names: Vec<String> = dts
                    .iter()
                    .filter(|n| n.status == filters::device_tree::NodeStatus::Disabled)
                    .filter_map(|n| n.compatible.clone())
                    .collect();
                !disabled_names.iter().any(|compat| {
                    let cl = compat.to_lowercase();
                    pkg_lower.contains(&cl) || cl.contains(&pkg_lower)
                })
            } else {
                true
            }
        })
        .map(|(i, _)| i)
        .collect();

    let mut all_statements = Vec::new();
    all_statements.extend(native_statements);
    all_statements.extend(rules_statements);
    all_statements.extend(kernel_statements);
    all_statements.extend(uboot_statements);
    all_statements.extend(dts_statements);

    let mut _low_priority_count = 0usize;

    for &i in &remaining_indices {
        let result = &remaining_after_uboot[i];
        for vuln in &result.vulns {
            let purl = result
                .package
                .purl
                .clone()
                .unwrap_or_else(|| format!("pkg:generic/{}", result.package.name));

            // Check EPSS threshold (try direct match, then via CVE alias)
            let epss_score = epss_scores.iter().find(|e| e.cve == vuln.id).or_else(|| {
                vuln.aliases
                    .iter()
                    .find(|a| a.starts_with("CVE-"))
                    .and_then(|cve| epss_scores.iter().find(|e| &e.cve == cve))
            });
            let is_low_priority = epss_score
                .map(|e| e.epss < args.epss_threshold)
                .unwrap_or(false);

            if is_low_priority {
                _low_priority_count += 1;
            }

            let epss_note = epss_score
                .map(|e| {
                    format!(
                        " [EPSS: {:.1}%, Pctl: {:.1}%]",
                        e.epss * 100.0,
                        e.percentile * 100.0
                    )
                })
                .unwrap_or_default();

            all_statements.push(vex::VexStatement {
                vulnerability_name: vuln.id.clone(),
                product_purl: purl,
                status: VexStatus::Affected,
                justification: None,
                impact_statement: Some(format!(
                    "Vulnerability {} affects package {} version {}.{}",
                    vuln.id,
                    result.package.name,
                    result.package.version.as_deref().unwrap_or("unknown"),
                    epss_note,
                )),
            });
        }
    }

    info!("Total VEX statements: {}", all_statements.len());

    // 14. Generate OpenVEX document
    let author = rules_config
        .as_ref()
        .and_then(|c| c.author.as_ref().map(|a| a.name.as_str()))
        .unwrap_or(&args.author);

    let vex_doc = generate_openvex(&all_statements, author);
    let vex_json = serde_json::to_string_pretty(&vex_doc)?;

    std::fs::write(&args.output, &vex_json)
        .with_context(|| format!("Failed to write output: {}", args.output.display()))?;
    info!("OpenVEX report written to: {}", args.output.display());

    // 15. Print console summary
    let kernel_filtered_total = kernel_filtered_local.len() + uboot_filtered_local.len();
    let dts_filtered_total = dts_filtered_local.len();

    // Build vuln_id -> CVE alias map for EPSS lookup
    let mut vuln_cve_map: std::collections::HashMap<String, String> =
        std::collections::HashMap::new();
    for result in &osv_results {
        for vuln in &result.vulns {
            if !vuln.id.starts_with("CVE-") {
                for alias in &vuln.aliases {
                    if alias.starts_with("CVE-") {
                        vuln_cve_map.insert(vuln.id.clone(), alias.clone());
                        break;
                    }
                }
            }
        }
    }

    output::print_summary(&output::SummaryData {
        total_packages: packages.len(),
        native_filtered: native_indices.len(),
        kernel_filtered: kernel_filtered_total,
        dts_filtered: dts_filtered_total,
        statements: &all_statements,
        epss_scores: &epss_scores,
        epss_enabled: args.epss,
        vuln_cve_map: &vuln_cve_map,
    });

    // 16. CI/CD exit codes
    let affected_count = all_statements
        .iter()
        .filter(|s| s.status == VexStatus::Affected)
        .count();

    if args.fail_on_any && affected_count > 0 {
        eprintln!("FAIL: {} CVEs require attention", affected_count);
        std::process::exit(1);
    }

    if args.fail_on_critical {
        let critical = epss_scores.iter().any(|e| e.epss > 0.9);
        if critical {
            eprintln!("FAIL: Critical CVEs detected (EPSS > 0.9)");
            std::process::exit(1);
        }
    }

    if args.fail_on_high {
        let high = epss_scores.iter().any(|e| e.epss > 0.7);
        if high {
            eprintln!("FAIL: High-risk CVEs detected (EPSS > 0.7)");
            std::process::exit(1);
        }
    }

    Ok(())
}

fn merge_kernel_configs(
    configs: &[std::collections::HashMap<String, filters::kernel_config::ConfigValue>],
) -> std::collections::HashMap<String, filters::kernel_config::ConfigValue> {
    use std::collections::HashMap;
    let mut merged = HashMap::new();
    for config in configs {
        for (key, value) in config {
            merged.insert(key.clone(), value.clone());
        }
    }
    merged
}