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.1.tar.gz (42.5 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.1-py3-none-any.whl (45.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ossbomer-0.1.1.tar.gz
  • Upload date:
  • Size: 42.5 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.1.tar.gz
Algorithm Hash digest
SHA256 b3743c7a8ca379d18653013bc1645ca7f200561dfbd328165ee9a0cba769fd44
MD5 9cd1b2fe02272107c08b548959ec9d03
BLAKE2b-256 fb73356052593954d8378d7a66ebcae74c9d766c0097e6602444e889058e82f5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ossbomer-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 45.6 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 998d609d19225e4ba2b407c3a8684cbf0cba13b0bbb226252702acbc95f84bf9
MD5 06acb4e290d012cb543d5fb425dc8a0c
BLAKE2b-256 0ddd263862dae07cb76cf43ce82fdcc6b1822037b7d8c1e94b711f48e1ab5ee2

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