The bill of materials names a licence for what it lists
supply-chain/components-licensed@v1
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.
| Id | supply-chain/components-licensed |
| 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/components-licensed@v1",
"severity": "warning",
"with": {
"minPercent": "95"
},
"exemptions": []
}
]
}
}Inputs
| Input | Description | Default | Environment variable |
|---|---|---|---|
minPercent | Percentage of components that must name at least one licence. | 95 | GUARDRAIL_INPUT_MINPERCENT |
How to fix
Generate the bill of materials from the resolved dependency graph, not from the manifest, so the generator has the metadata it needs to read licences:
syft dir:. -o cyclonedx-json=bom.jsonA component with no licence listed isn't unlicensed; nobody looked its licence up. This matters the first time someone asks whether the artifact can ship to a customer, because that question has to be answered for every component, and "unknown" isn't an acceptable answer.
More in supply-chain
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.supply-chain/sbom-standard-format. The bill of materials uses a standard format other tools can read, and declares which version of that format it follows.