Skip to main content

​
Overview

ZeroPath’s SBOM service generates export-ready CycloneDX, SPDX, and VEX documents directly from the SCA inventory your scans already produced. Because SBOMs reuse the same normalized dependency graph that powers alerting, every artifact matches what developers see in the UI—no third-party scanners, no drift. Behind the scenes the SBOM service:
  1. Accepts a request tied to either a completed SCA scan or a specific code scan snapshot.
  2. Claims the job, ensuring only one worker processes it.
  3. Builds the SBOM from the chosen data source (preferably the SCA inventory).
  4. Uploads the JSON artifact to managed object storage and returns a pre-signed download URL.
  5. Tracks status, attempt count, and expiration so you can poll or receive webhook updates.

​
Request Flow

  1. Submit – choose the scan, desired format (CycloneDX or SPDX), and whether to include VEX data. Jobs can be created through the UI or API.
  2. Process – a worker locks the job, hydrates the dependency inventory, and generates the artifact. Automatic retries kick in if a worker dies mid-stream.
  3. Store – finished SBOMs are uploaded to ZeroPath’s artifact bucket with a time-limited retention policy (24 hours by default, configurable per tenant).
  4. Retrieve – the API returns a signed URL; optional webhooks fire when the job transitions to Succeeded or Failed.

​
Formats & VEX Support

  • CycloneDX JSON – best for tooling that expects component graphs, dependency relationships, and VEX attachments. When VEX is requested we include vulnerability status (affected, not_affected, fixed) plus severity and remediation guidance.
  • SPDX JSON – aligns with procurement/legal workflows. ZeroPath includes annotations for direct vs transitive dependencies, license declarations, and dependency relationships (DEPENDS_ON, DESCRIBES).
  • VEX – only available when the SBOM is sourced from the ZeroPath SCA inventory (that’s where we track vulnerability status). If a job targets a raw repository snapshot, VEX must be disabled.

​
Data Sources

​
Preferred: SCA inventory

  • Uses the canonical inventory built by the ZeroPath SCA service, so it includes direct/transitive classification, license data, application ownership, and previously validated vulnerability context.
  • SBOMs generated from inventory are deterministic—package IDs, ordering, and dependency edges match the UI and alerting systems exactly.
  • VEX data is available because the inventory knows which packages are affected, fixed, or not applicable.

​
Fallback: Repository snapshot

  • Used when a team requests an SBOM before a full SCA scan finishes.
  • ZeroPath clones the repository at the requested commit, parses manifests/lockfiles, and outputs the same CycloneDX/SPDX structure.
  • Because no historical inventory exists, these SBOMs focus on component/relationship data and omit VEX status.

​
Artifact Contents

Every JSON export includes:
  • Repository metadata (name, branch, commit SHA, scan timestamp).
  • One entry per manifest path (package-lock.json, requirements.txt, go.mod, pom.xml, Podfile, etc.).
  • Normalized ecosystems and Package URLs (PURL) for each dependency.
  • Direct vs transitive annotations plus a summary of the dependency path so teams know how a package entered the build.
  • License information per package, sourced from manifest fields and/or deps.dev.
  • Dependency relationships (CycloneDX dependencies, SPDX relationships).
  • Optional VEX blocks showing current status, ZeroPath vulnerability IDs, severity, and remediation hints.

​
Storage & Access

  • SBOMs are stored in ZeroPath-managed object storage with an automatic expiration policy (24 hours by default; can be extended for enterprise tenants).
  • Download links are pre-signed URLs that carry the same expiration. Pull the artifact into your own storage if you need longer retention.
  • Every job records organization, repository, requester, format, and expiration so you always know who generated which SBOM.

​
Adoption Guide

  1. Run at least one SCA scan – this unlocks inventory-backed SBOMs and VEX exports. Schedules keep inventories fresh without manual effort.
  2. Submit SBOM requests per release – kick off a job whenever you cut a release branch, tag, or artifact that needs provenance.
  3. Choose the right format – use CycloneDX + VEX for engineering/security workflows, SPDX for procurement/legal stakeholders, or both.
  4. Integrate delivery – plug pre-signed URLs into CI/CD approvals, artifact registries, or audit tickets so reviewers can fetch the document automatically.
  5. Mirror long-lived artifacts – if policy requires multi-year retention, copy the SBOM into your own storage before the link expires.

​
Troubleshooting Tips

  • “VEX requires SCA inventory” – rerun the job with a completed SCA scan selected or disable VEX for snapshot-based exports.
  • “Repository snapshot failed” – usually caused by missing SCM credentials or a deleted branch/tag. Re-run after fixing access or target a different commit.
  • Incomplete dependency list – verify the latest SCA scan finished successfully and that manifests were included (shown in the SCA tab). SBOMs mirror whatever the scan captured.
  • Jobs stuck in Pending – ensure SBOM workers are running for your workspace. Pending jobs will retry automatically, but contact support if they exceed the normal few-minute window.