# SBOMTrend
SBOMTrend analyses a directory of SBOM (Software Bill of Materials) in either
[SPDX](https://www.spdx.org) and [CycloneDX](https://www.cyclonedx.org) formats.
It analyses all SBOM files within a directory and identifies license and version changes, for each file.
It is intended to be used as part of a continuous integration system to enable accurate records of SBOMs to be maintained, typically through the
build development phase, and also to support subsequent audit needs to determine if a particular component has been used.
## Installation
To install use the following command:
`pip install sbomtrend`
Alternatively, just clone the repo and install dependencies using the following command:
`pip install -U -r requirements.txt`
The tool requires Python 3 (3.8+). It is recommended to use a virtual python environment especially
if you are using different versions of python. `virtualenv` is a tool for setting up virtual python environments which
allows you to have all the dependencies for the tool set up in a single environment, or have different environments set
up for testing using different versions of Python.
## Usage
```
usage: sbomtrend [-h] [-d DIRECTORY] [-m MODULE] [--exclude-license] [--debug] [-o OUTPUT_FILE] [-V]
SBOMTrend analyses a set of Software Bill of Materials within a directory and detects the changes in the components.
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
Input:
-d DIRECTORY, --directory DIRECTORY
Directory to be scanned
-m MODULE, --module MODULE
identity of component
--exclude-license suppress detecting the license of components
Output:
--debug add debug information
-o OUTPUT_FILE, --output-file OUTPUT_FILE
output filename (default: output to stdout)
```
## Operation
The `--directory` option is used to identify the directory to be scanned. If this option is not specified, the current directory is assumed.
The `--module` option can be used to restrict the reporting to a specific component. The default is to report for all components.
The tool reports the versions and licenses for each component in each SBOM. License reporting can be suppressed using the `--exclude-license` option.
The `--output-file` option is used to control the destination of the output generated by the tool. The
default is to report to the console but can be stored in a file (specified using `--output-file` option).
**Example**
The following command will report the changes
```bash
# sbomtrend -d <directory> --module rich
```
Produces the following output (output is clearly dependent on the contents if the SBOMs!)
```bash
Name rich
Count 46
Versions 16
Version {'13.0.0': 1, '13.0.1': 1, '13.1.0': 1, '13.2.0': 1, '13.3.1': 5, '13.3.2': 4, '13.3.3': 2, '13.3.4': 2, '13.3.5': 4, '13.4.1': 1, '13.4.2': 5, '13.5.0': 1, '13.5.2': 4, '13.5.3': 2, '13.6.0': 7, '13.7.0': 5}
Licenses 1
License {'MIT': 46}
```
The following command will report the version changes and store the result in a JSON file.
```bash
# sbomtrend -d <directory> --module rich -o <output file> --exclude-license
```
The resulting file will be
```json
{
"rich": {
"name": "rich",
"count": 46,
"version": {
"13.3.4": 2,
"13.0.0": 1,
"13.5.2": 4,
"13.4.1": 1,
"13.7.0": 5,
"13.3.5": 4,
"13.3.1": 5,
"13.5.0": 1,
"13.6.0": 7,
"13.4.2": 5,
"13.1.0": 1,
"13.3.3": 2,
"13.3.2": 4,
"13.5.3": 2,
"13.0.1": 1,
"13.2.0": 1
}
}
}
```
## Licence
Licenced under the Apache 2.0 Licence.
## Limitations
This tool is meant to support software development and security audit functions. The usefulness of the tool is dependent on the SBOM data
which is provided to the tool. Unfortunately, the tool is unable to determine the validity or completeness of such a SBOM file; users of the tool
are therefore reminded that they should assert the quality of any data which is provided to the tool.
When processing and validating licenses, the application will use a set of synonyms to attempt to map some license identifiers to the correct [SPDX License Identifiers](https://spdx.org/licenses/). However, the
user of the tool is reminded that they should assert the quality of any data which is provided by the tool particularly where the license identifier has been modified.
## Feedback and Contributions
Bugs and feature requests can be made via GitHub Issues.
Raw data
{
"_id": null,
"home_page": "https://github.com/anthonyharrison/sbomtrend",
"name": "sbomtrend",
"maintainer": "Anthony Harrison",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "anthony.p.harrison@gmail.com",
"keywords": "security,tools,SBOM,DevSecOps,SPDX,CycloneDX",
"author": "Anthony Harrison",
"author_email": "anthony.p.harrison@gmail.com",
"download_url": "",
"platform": null,
"description": "# SBOMTrend\n\nSBOMTrend analyses a directory of SBOM (Software Bill of Materials) in either\n[SPDX](https://www.spdx.org) and [CycloneDX](https://www.cyclonedx.org) formats.\nIt analyses all SBOM files within a directory and identifies license and version changes, for each file.\n\nIt is intended to be used as part of a continuous integration system to enable accurate records of SBOMs to be maintained, typically through the\nbuild development phase, and also to support subsequent audit needs to determine if a particular component has been used.\n\n## Installation\n\nTo install use the following command:\n\n`pip install sbomtrend`\n\nAlternatively, just clone the repo and install dependencies using the following command:\n\n`pip install -U -r requirements.txt`\n\nThe tool requires Python 3 (3.8+). It is recommended to use a virtual python environment especially\nif you are using different versions of python. `virtualenv` is a tool for setting up virtual python environments which\nallows you to have all the dependencies for the tool set up in a single environment, or have different environments set\nup for testing using different versions of Python.\n\n\n## Usage\n\n```\nusage: sbomtrend [-h] [-d DIRECTORY] [-m MODULE] [--exclude-license] [--debug] [-o OUTPUT_FILE] [-V]\n\nSBOMTrend analyses a set of Software Bill of Materials within a directory and detects the changes in the components.\n\noptions:\n -h, --help show this help message and exit\n -V, --version show program's version number and exit\n\nInput:\n -d DIRECTORY, --directory DIRECTORY\n Directory to be scanned\n -m MODULE, --module MODULE\n identity of component\n --exclude-license suppress detecting the license of components\n\nOutput:\n --debug add debug information\n -o OUTPUT_FILE, --output-file OUTPUT_FILE\n output filename (default: output to stdout)\n```\n\t\t\t\t\t\n## Operation\n\nThe `--directory` option is used to identify the directory to be scanned. If this option is not specified, the current directory is assumed.\n\nThe `--module` option can be used to restrict the reporting to a specific component. The default is to report for all components.\n\nThe tool reports the versions and licenses for each component in each SBOM. License reporting can be suppressed using the `--exclude-license` option.\n\nThe `--output-file` option is used to control the destination of the output generated by the tool. The\ndefault is to report to the console but can be stored in a file (specified using `--output-file` option).\n\n**Example**\n\nThe following command will report the changes\n\n```bash\n# sbomtrend -d <directory> --module rich\n```\n\nProduces the following output (output is clearly dependent on the contents if the SBOMs!)\n\n```bash\nName rich\nCount 46\nVersions 16\nVersion {'13.0.0': 1, '13.0.1': 1, '13.1.0': 1, '13.2.0': 1, '13.3.1': 5, '13.3.2': 4, '13.3.3': 2, '13.3.4': 2, '13.3.5': 4, '13.4.1': 1, '13.4.2': 5, '13.5.0': 1, '13.5.2': 4, '13.5.3': 2, '13.6.0': 7, '13.7.0': 5}\nLicenses 1\nLicense {'MIT': 46}\n```\n\nThe following command will report the version changes and store the result in a JSON file.\n\n```bash\n# sbomtrend -d <directory> --module rich -o <output file> --exclude-license\n```\n\nThe resulting file will be\n\n```json\n{\n \"rich\": {\n \"name\": \"rich\",\n \"count\": 46,\n \"version\": {\n \"13.3.4\": 2,\n \"13.0.0\": 1,\n \"13.5.2\": 4,\n \"13.4.1\": 1,\n \"13.7.0\": 5,\n \"13.3.5\": 4,\n \"13.3.1\": 5,\n \"13.5.0\": 1,\n \"13.6.0\": 7,\n \"13.4.2\": 5,\n \"13.1.0\": 1,\n \"13.3.3\": 2,\n \"13.3.2\": 4,\n \"13.5.3\": 2,\n \"13.0.1\": 1,\n \"13.2.0\": 1\n }\n }\n}\n```\n\n## Licence\n\nLicenced under the Apache 2.0 Licence.\n\n## Limitations\n\nThis tool is meant to support software development and security audit functions. The usefulness of the tool is dependent on the SBOM data\nwhich is provided to the tool. Unfortunately, the tool is unable to determine the validity or completeness of such a SBOM file; users of the tool\nare therefore reminded that they should assert the quality of any data which is provided to the tool.\n\nWhen processing and validating licenses, the application will use a set of synonyms to attempt to map some license identifiers to the correct [SPDX License Identifiers](https://spdx.org/licenses/). However, the\nuser of the tool is reminded that they should assert the quality of any data which is provided by the tool particularly where the license identifier has been modified.\n\n## Feedback and Contributions\n\nBugs and feature requests can be made via GitHub Issues.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Analyse set of SBOMs to identify changes in components",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/anthonyharrison/sbomtrend"
},
"split_keywords": [
"security",
"tools",
"sbom",
"devsecops",
"spdx",
"cyclonedx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "584190bba5385c90ab21fdb1c5aa76a7f44c206dc10a6ef5cbb3ef47f665bb0b",
"md5": "d2cdb25b28118a1aba17db89023cac57",
"sha256": "f977981481f69b7513cdeb42c5dcfbfa3e461c8cba79ca522d3f1796ba4dd712"
},
"downloads": -1,
"filename": "sbomtrend-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2cdb25b28118a1aba17db89023cac57",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 9722,
"upload_time": "2024-01-05T19:06:42",
"upload_time_iso_8601": "2024-01-05T19:06:42.533671Z",
"url": "https://files.pythonhosted.org/packages/58/41/90bba5385c90ab21fdb1c5aa76a7f44c206dc10a6ef5cbb3ef47f665bb0b/sbomtrend-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-05 19:06:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "anthonyharrison",
"github_project": "sbomtrend",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "sbomtrend"
}
JSON
