Skip to main content

End-to-end SBOM generation and vulnerability intelligence pipeline

Project description

sbom-sentinel

CI PyPI

SBOM generation and vulnerability intelligence pipeline.

Wraps Syft and Grype behind a four-command CLI, enriches results with the CISA Known Exploited Vulnerabilities (KEV) catalog, and produces a timestamped Markdown report.

Installation

Requires Syft and Grype on PATH.

pip install sbom-sentinel

Quick Start

Run the full pipeline (SBOM + scan + report) in one command:

sbom-sentinel run --target ./myapp --name myapp --fail-on high
sbom-sentinel run --target docker:nginx:latest --name nginx --fail-on high
sbom-sentinel run --target https://github.com/org/repo --name repo --fail-on high

Or run each stage individually:

sbom-sentinel sbom --target ./myapp --name myapp
sbom-sentinel scan --sbom sbom_output/myapp_*.spdx.json --name myapp --fail-on high
sbom-sentinel report --scan results/json/myapp_*.json --name myapp

Generate an HTML report instead of Markdown:

sbom-sentinel run --target ./myapp --name myapp --report-format html

Features

  • SPDX-JSON SBOMs from local directories, container images, or Git URLs
  • Vulnerability scanning via Grype with severity gating (--fail-on)
  • CISA KEV enrichment with date-stamped local cache
  • OpenVEX / CSAF suppression with KEV conflict detection
  • Markdown or standalone HTML reports
  • JSON or SARIF scan output for GitHub Code Scanning
  • Verbose mode (-v) for diagnostic output

Commands

Command Description
sbom Generate an SPDX-JSON SBOM via Syft
scan Scan an SBOM for vulnerabilities via Grype
report Generate a Markdown or HTML report with KEV enrichment
run Run the full pipeline (sbom + scan + report, or scan + report from an existing SBOM)

Pass --help to any command for the full option reference.

VEX suppression

Pass an OpenVEX or CSAF document to suppress findings marked not_affected. Any suppressed CVE that also appears in CISA KEV is flagged as a conflict requiring manual review.

sbom-sentinel run --sbom sbom.spdx.json --name myapp --vex statements.vex.json

Exit Codes

Code Meaning
0 Success
1 Runtime error -- tool not found, scan threshold met, timeout, or parse failure
2 Usage error -- missing required option or invalid argument

Development

git clone https://github.com/Dashtid/sbom-sentinel.git
cd sbom-sentinel
uv sync
uv run pytest
uv run ruff check .
uv run mypy sbom_sentinel

See CONTRIBUTING.md for full guidelines.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sbom_sentinel-0.2.0.tar.gz (62.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sbom_sentinel-0.2.0-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file sbom_sentinel-0.2.0.tar.gz.

File metadata

  • Download URL: sbom_sentinel-0.2.0.tar.gz
  • Upload date:
  • Size: 62.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for sbom_sentinel-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9a6eb48d08a4888d1c0dc687e7a95965c9d06aba584ab1f85a4d1eead069ffca
MD5 5c5a63544fe2c1916425ddeffd95d381
BLAKE2b-256 958b129beabb16c036d2b9ed90aac2cfec5a3a5fac12750914fb936dc5b9a3dd

See more details on using hashes here.

File details

Details for the file sbom_sentinel-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: sbom_sentinel-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for sbom_sentinel-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 312fe64debea465de81f84d4cede8461b4252f44ec54e1190b0f448998a9e298
MD5 09aaa8282582869b7124997c11553d1d
BLAKE2b-256 40af405154f3e21c6317cc12358213acc12aaee7b745abba5ddb1598f142e892

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page