Skip to main content

CycloneDX Buildroot SBOM generator

Project description

Build Status License
Website Slack Invite Group Discussion Twitter


CycloneDX Buildroot

This Buildroot python application generates CycloneDX Software Bill of Materials (SBOM) containing all direct dependencies of a Buildroot generated project.
OWASP CycloneDX is a full-stack Bill of Materials (BOM) standard that provides advanced supply chain capabilities for cyber risk reduction. Buildroot provides a build target named "legal-info" which produces a set of files including manifest.csv. The legal-info is a general "make" target for a Buildroot project.

Usage

By default, manifest.csv will be read from the current working directory and the resulting bom.json will also be created in the current working directory.
This can be overwritten as follows:

  
$ python3 generateBuildrootSBOM.py -i <path>/manifest.csv -n "My Project" -v "1.2.3.4" -m "company name" -c cpe.json
      Usage:  generateBom.cli [OPTIONS]
      Options:
        -i <path> - filename of the output from make legal-info, example: manifest.csv
        -o <path> - the bom file name to create
        -n name of the project or product SBOM <project name in quotes>
        -v your product SBOM version <project version in quotes>
        -m SBOM manufacturer name
        -c <path> - cpe file name from make show-info, example cpe.json

Diagram depicting where this project fits into the pipeline of secure development activities. Note that while the diagram depicts a linear sequence of activities, the entire sequence is typically cyclical. The end state of SBOM management receives the SBOM files for the product versions to properly manage the state of vulnerabilities over time.

CycloneDX logo

CycloneDX Schema Support

The following table provides information on the version of this module, the CycloneDX schema version supported, as well as the output format options. Use the latest possible version of this module that is compatible with the CycloneDX version supported by the target system.

Version Schema Version Format(s)
1.0x CycloneDX v1.4 XML/JSON

Copyright & License

CycloneDX Buildroot is Copyright (c) OWASP Foundation. All Rights Reserved.
Permission to modify and redistribute is granted under the terms of the Apache 2.0 license. See the LICENSE file for the full license.

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

CycloneDX_Buildroot-1.0.7.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

CycloneDX_Buildroot-1.0.7-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file CycloneDX_Buildroot-1.0.7.tar.gz.

File metadata

  • Download URL: CycloneDX_Buildroot-1.0.7.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for CycloneDX_Buildroot-1.0.7.tar.gz
Algorithm Hash digest
SHA256 740731952a6ac68bf838b85efe0d33864604878cfa787f8a15524a18384623e8
MD5 f5ca50908c75729af9614d7263c54fac
BLAKE2b-256 21100fae191f4a327a72b14f90213395249a65debe7f986cf89b4fd5b16ef6d9

See more details on using hashes here.

File details

Details for the file CycloneDX_Buildroot-1.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for CycloneDX_Buildroot-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 871941a905eca4ac4870dc18bbef358dc8894947e06b5a08bcef31ccaeefd9de
MD5 2ae0902e33d0eb0455c11d8e391aec07
BLAKE2b-256 aa739a4cb3dd1404d353afc43bbfac6b59cc3f3492ae9361404d285031768084

See more details on using hashes here.

Supported by

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