Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explanation of CycloneDX Versions #8

Merged
merged 1 commit into from
Oct 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@
## Table of Contents

- [Overview](#overview)
- [The importance of undetstanding supply chain attacks](#the-importance-of-undetstanding-supply-chain-attacks)
- [The importance of understanding supply chain attacks](#the-importance-of-understanding-supply-chain-attacks)
- [Installation](#installation)
- [Example Usage](#example-usage)
- [Application Arguments](#application-arguments)
- [Example Usage](#example-usage)
- [Troubleshooting](#troubleshooting)
- [SBOM Validation](#sbom-validation)
- [Supported CycloneDX versions](#supported-cyclonedx-versions)
- [Credits](#credits)

## Overview
Expand Down Expand Up @@ -94,12 +96,23 @@ cat sbom_file.json | trustier -

## Troubleshooting

During testing, we found there were some required fields needed in the SBOM in order to be considered valid. Ensure at minimum you have the following fields in your components:
### SBOM Validation

During testing, we found there were some required fields needed in the SBOM in order to be considered valid. We
utilized the validation logic provided in the CycloneDX dependencies we use in `trustier`. In version 0.1.1, we
disabled validation by default, but if you wish to utilize strict validation then utilize the `--strict` flag.

Ensure at minimum you have the following fields in your components if you are using strict validation:

- `name`
- `purl`
- `type`

### Supported CycloneDX versions

`trustier` relies on [CycloneDX](https://github.com/CycloneDX/cyclonedx-rust-cargo/blob/main/cyclonedx-bom/README.md) to
load and work with SBOMs. This provides a limitation of only supporting versions 1.3, 1.4, and 1.5 of the CycloneDX specification at this time.

**NOTE:** `trustier` does not support SPDX formatted SBOMS at this time.

## Credits
Expand Down