Skip to main content

Crate sbom_model

Crate sbom_model 

Source
Expand description

§sbom-model

format-agnostic data model for software bills of materials.

this crate provides the core types used across the sbom-diff workspace. it defines a unified representation that abstracts over specific formats like cyclonedx and spdx.

§usage

use sbom_model::{Sbom, Component, ComponentId};

// create a component
let mut component = Component::new("serde".into(), Some("1.0.0".into()));
component.licenses.insert("MIT".into());
component.licenses.insert("Apache-2.0".into());

// create an sbom and add the component
let mut sbom = Sbom::default();
sbom.components.insert(component.id.clone(), component);

// normalize for deterministic comparison
sbom.normalize();

§component identification

components are identified by ComponentId, which prefers package urls (purls) when available:

use sbom_model::ComponentId;

// with a purl (preferred)
let id = ComponentId::new(Some("pkg:npm/left-pad@1.3.0"), &[]);
assert_eq!(id.as_str(), "pkg:npm/left-pad@1.3.0");

// without a purl: falls back to deterministic hash
let id = ComponentId::new(None, &[("name", "foo"), ("version", "1.0")]);
assert!(id.as_str().starts_with("h:"));

§query api

the Sbom struct provides methods to query the dependency graph:

use sbom_model::Sbom;

fn example(sbom: &Sbom) {
    // find root components (not depended on by anything)
    let roots = sbom.roots();

    // get direct dependencies of a component
    let deps = sbom.deps(&roots[0]);

    // get reverse dependencies (who depends on this?)
    let rdeps = sbom.rdeps(&roots[0]);

    // get all transitive dependencies
    let all_deps = sbom.transitive_deps(&roots[0]);

    // aggregate queries
    let ecosystems = sbom.ecosystems();  // e.g. {"npm", "cargo"}
    let licenses = sbom.licenses();       // e.g. {"MIT", "Apache-2.0"}
    let missing = sbom.missing_hashes();  // components without checksums
}

§normalization

sbom.normalize() prepares an sbom for deterministic comparison:

  • sorts components by id
  • lowercases hash algorithms and values
  • strips volatile metadata (timestamps, tool versions)

Structs§

Component
A software component (package, library, or application).
ComponentId
Stable identifier for a component.
Metadata
SBOM document metadata.
Sbom
Format-agnostic SBOM (Software Bill of Materials) representation.

Functions§

ecosystem_from_purl
Extracts the ecosystem (package type) from a purl string.
parse_license_expression
Extracts individual license IDs from an SPDX expression.