The bill of materials is in a standard format
supply-chain/sbom-standard-format@v1
The bill of materials is written in a format anything else can read, and it declares which version of that format it is.
| 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 gathers nothing itself. It depends on the collectors below, which the CLI runs once per build before any check, and reads what they found out of GUARDRAIL_FACTS. A collector that collects nothing skips this guardrail rather than failing it.
| Collector | Gathers | Inputs it is given |
|---|---|---|
sbom | The components a build says it ships, read from the bill of materials it already wrote, whether that is CycloneDX or SPDX, JSON, XML or tag-value, normalized into one list carrying the licence each component names. | none |
The inputs above are this guardrail's own, passed straight through. Configuring one in buildnote.json changes what is collected, and two guardrails configured the same way share the one collection.
Configuration
{
"guardrails": {
"failOn": "error",
"comment": true,
"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 that format it is written to. | true | GUARDRAIL_INPUT_REQUIRESPECVERSION |
How to fix
Write the bill of materials as CycloneDX or SPDX rather than as the scanner's own shape:
syft dir:. -o cyclonedx-json=bom.json
trivy fs --format cyclonedx --output bom.json .An inventory only has value if the thing that consumes it years from now can still read it, and that consumer is rarely the tool that wrote it. A format with no declared version is 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 the bill of materials lists name a licence that the inventory can answer what the artifact may be distributed under.supply-chain/disallowed-components. No component the bill of materials lists is one the team has decided it will not ship, whatever brought it in.supply-chain/disallowed-licenses. No component the bill of materials lists is licensed under one of the licences the team has decided it will not ship.supply-chain/no-critical-vulnerabilities. No dependency the build takes on carries 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 rather than reconstructed later.