Skip to main content

Create a software bill of materials from the direct dependencies of a Buildroot generated project

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.8.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

cyclonedx_buildroot-1.0.8-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file cyclonedx_buildroot-1.0.8.tar.gz.

File metadata

  • Download URL: cyclonedx_buildroot-1.0.8.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.1

File hashes

Hashes for cyclonedx_buildroot-1.0.8.tar.gz
Algorithm Hash digest
SHA256 05dd53000bd1abf87e61d247e9ba3f98f17d4d12bcb0afbd725231379005cd11
MD5 4217b165dfc00d7e9fea011ac78b6197
BLAKE2b-256 d59e1abaedc18123e17b77c23fe67f59904c37bb3fdd14f70d109acb301cc807

See more details on using hashes here.

File details

Details for the file cyclonedx_buildroot-1.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for cyclonedx_buildroot-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 65cc1d11bc92d5235279aa041d294bee2b7637269f526695d0e95766383d09a1
MD5 9c21c4230821c79eecd160c46a907fa0
BLAKE2b-256 8d91c17a97836b3ffb71071329eef7fd8645466fe6596cd9bb2da5d2a84f758f

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