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.3.tar.gz (44.2 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.3-py3-none-any.whl (47.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ossbomer-0.1.3.tar.gz
  • Upload date:
  • Size: 44.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for ossbomer-0.1.3.tar.gz
Algorithm Hash digest
SHA256 fd52b6b811cec7375d2c87c062349b62fa5e9ffa4e0d00ab6f189c00d5ba83e5
MD5 97f78644fac6bae387c57bee2d6919d5
BLAKE2b-256 1f0d99de5cced3a410adbc28eecb46df00726b3928ab76b8f6995f7210dccfaf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ossbomer-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 47.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for ossbomer-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2098aeedcd9bbbcca57d4639ca5ae63b96a65ee715681504b30b13505990841a
MD5 619c2347c97398e4be1ad8f16b23d48b
BLAKE2b-256 645c12c268b51b4caa0035fd86bf47fdd347a84223628925c85e727c68d703bb

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