The bill of materials is in a standard format
supply-chain/sbom-standard-format@v1
The bill of materials uses a standard format other tools can read, and declares which version of that format it follows.
| Id | supply-chain/sbom-standard-format |
| Version | v1 |
| Category | supply-chain |
| Default severity | warning |
| Interpreter | python3 |
| Timeout | 30 seconds |
| Violations tolerated | 0 |
| Collects | sbom |
Collectors
This guardrail doesn't gather anything itself. It relies on the collectors below, which the CLI runs once per build before any check, and reads what they found from GUARDRAIL_FACTS. If a collector collects nothing, this guardrail is skipped, not failed.
| Collector | Gathers | Inputs it is given |
|---|---|---|
sbom | The components a build says it ships, read from the bill of materials it already wrote (CycloneDX or SPDX, in JSON, XML or tag-value) and normalized into one list with the licence each component names. | none |
The inputs above are this guardrail's own inputs, passed straight through to the collector. Setting one in buildnote.json changes what is collected, and two guardrails configured the same way share a single collection.
Configuration
{
"guardrails": {
"failOn": "error",
"checks": [
{
"use": "supply-chain/sbom-standard-format@v1",
"severity": "warning",
"with": {
"formats": "cyclonedx,spdx",
"requireSpecVersion": "true"
},
"exemptions": []
}
]
}
}Inputs
| Input | Description | Default | Environment variable |
|---|---|---|---|
formats | Comma separated formats that are accepted. | cyclonedx,spdx | GUARDRAIL_INPUT_FORMATS |
requireSpecVersion | Whether the document must declare which version of the format it follows. | true | GUARDRAIL_INPUT_REQUIRESPECVERSION |
How to fix
Write the bill of materials as CycloneDX or SPDX, not in the scanner's own format:
syft dir:. -o cyclonedx-json=bom.json
trivy fs --format cyclonedx --output bom.json .An inventory is only useful if whatever consumes it, possibly years later, can still read it, and that consumer is rarely the tool that wrote it. A format with no declared version causes the same problem one step later: nothing can tell which fields it was allowed to leave out.
More in supply-chain
supply-chain/components-licensed. Enough of the components in the bill of materials name a licence for the inventory to tell you what the artifact may be distributed under.supply-chain/disallowed-components. No component in the bill of materials is one the team has decided it won't ship, however it got there.supply-chain/disallowed-licenses. No component in the bill of materials uses a licence the team has decided it won't ship.supply-chain/no-critical-vulnerabilities. No dependency of the build has an open finding at or above the severity the team gates on.supply-chain/sbom-present. An SBOM was produced for this build, so the components that went into the artifact are recorded at build time instead of reconstructed later.