Skip to content

Commit b59fa40

Browse files
authored
Update README.md to include strict SBOM validation flag and supported CycloneDX versions information (#8)
fixes #3
1 parent b0e07a1 commit b59fa40

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88
## Table of Contents
99

1010
- [Overview](#overview)
11-
- [The importance of undetstanding supply chain attacks](#the-importance-of-undetstanding-supply-chain-attacks)
11+
- [The importance of understanding supply chain attacks](#the-importance-of-understanding-supply-chain-attacks)
1212
- [Installation](#installation)
13-
- [Example Usage](#example-usage)
1413
- [Application Arguments](#application-arguments)
14+
- [Example Usage](#example-usage)
1515
- [Troubleshooting](#troubleshooting)
16+
- [SBOM Validation](#sbom-validation)
17+
- [Supported CycloneDX versions](#supported-cyclonedx-versions)
1618
- [Credits](#credits)
1719

1820
## Overview
@@ -94,12 +96,23 @@ cat sbom_file.json | trustier -
9496

9597
## Troubleshooting
9698

97-
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:
99+
### SBOM Validation
100+
101+
During testing, we found there were some required fields needed in the SBOM in order to be considered valid. We
102+
utilized the validation logic provided in the CycloneDX dependencies we use in `trustier`. In version 0.1.1, we
103+
disabled validation by default, but if you wish to utilize strict validation then utilize the `--strict` flag.
104+
105+
Ensure at minimum you have the following fields in your components if you are using strict validation:
98106

99107
- `name`
100108
- `purl`
101109
- `type`
102110

111+
### Supported CycloneDX versions
112+
113+
`trustier` relies on [CycloneDX](https://github.com/CycloneDX/cyclonedx-rust-cargo/blob/main/cyclonedx-bom/README.md) to
114+
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.
115+
103116
**NOTE:** `trustier` does not support SPDX formatted SBOMS at this time.
104117

105118
## Credits

0 commit comments

Comments
 (0)