Skip to main content

SBOMs quality validator for Open Source License Compliance.

Project description

OSSBOMER is a CLI tool designed to validate Software Bill of Materials (SBOMs) for quality, compliance, and metadata integrity. It supports SPDX and CycloneDX formats.

Features

  • License Validation: Checks components in the SBOM for blocked, weak-copyleft, or unknown licenses.

  • PURL Validation: Flags problematic Package URLs (PURLs) based on exact matches or regex patterns.

  • Schema Validation: Ensures SBOMs conform to their respective schema (SPDX or CycloneDX) and NTIA requirements.

  • Metadata Validation: Verifies the presence of essential metadata such as SPDX IDs and creation timestamps.

  • Dataset Management: - Updates license rules and package signatures from remote sources. - Provides an inventory of dataset versions.

Installation

  1. Clone the repository:

    git clone https://github.com/your-org/ossbomer.git
    cd ossbomer
  2. Install the package:

    pip install .
  3. Verify the installation:

    ossbomer --help

Usage

Validate an SBOM

Validate an SBOM for quality and compliance:

ossbomer validate <path-to-sbom>

Example

ossbomer validate samples/example-sbom.json

Output

* Checking licenses...
Blocked license detected for component 'insecure-package': GPL-3.0
* Checking PURLs...
Warning: Problematic PURL detected - pkg:deb/example-package@1.0.0?distro=debian
* Validating schema and metadata...
* Validation complete!

Update Datasets

Update license rules and package signatures from remote sources:

ossbomer update

Output

Datasets updated successfully!

Show Version

Display the current version of OSSBOMER:

ossbomer version

View Dataset Inventory

Display an inventory of dataset files and their versions:

ossbomer inventory

License

OSSBOMER is licensed under the Apache-2.0 License. See the LICENSE file for details.

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

ossbomer-0.1.2.tar.gz (43.9 kB view details)

Uploaded Source

Built Distribution

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

ossbomer-0.1.2-py3-none-any.whl (47.1 kB view details)

Uploaded Python 3

File details

Details for the file ossbomer-0.1.2.tar.gz.

File metadata

  • Download URL: ossbomer-0.1.2.tar.gz
  • Upload date:
  • Size: 43.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.7

File hashes

Hashes for ossbomer-0.1.2.tar.gz
Algorithm Hash digest
SHA256 27303bb53b7ff40abc11dfb89ea09546e47979101f2a0536b97a368bfaaee50b
MD5 60c59774b51454a5b06f2cf357ab4e38
BLAKE2b-256 7705781d8f3020db0f8f8be1c2e0e201ffa8ce98c4e393de464db28280acd0ce

See more details on using hashes here.

File details

Details for the file ossbomer-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: ossbomer-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 47.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.7

File hashes

Hashes for ossbomer-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 071bbdb062bdcc665b40d76be3bc486774d1c7914d4128a80786d694aa91f404
MD5 45e33a1225972893abe3dd4f97acca09
BLAKE2b-256 f06b92b007b88273ba640445a265262dba5e5941b9f9b676b4216c9ab4070a48

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