No component carries a licence the team refuses
supply-chain/disallowed-licenses@v1
No component the bill of materials lists is licensed under one of the licences the team has decided it will not ship.
| Id | supply-chain/disallowed-licenses |
| Version | v1 |
| Category | supply-chain |
| Default severity | error |
| 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/disallowed-licenses@v1",
"severity": "error",
"with": {
"licenses": "AGPL-1.0,AGPL-3.0,SSPL-1.0,BUSL-1.1,CC-BY-NC,Commons-Clause,Elastic-2.0"
},
"exemptions": []
}
]
}
}Inputs
| Input | Description | Default | Environment variable |
|---|---|---|---|
licenses | Comma separated SPDX identifiers that are a violation. A component's licence matches when the identifier appears in it, so AGPL-3.0 covers AGPL-3.0-only and AGPL-3.0-or-later. | AGPL-1.0,AGPL-3.0,SSPL-1.0,BUSL-1.1,CC-BY-NC,Commons-Clause,Elastic-2.0 | GUARDRAIL_INPUT_LICENSES |
How to fix
Replace the components named in the violations, or record the exception deliberately by taking that licence off the list this guardrail is configured with.
A copyleft licence in a distributed artifact is a legal obligation rather than a preference: some require the source of the whole work to be offered to whoever receives the binary. Finding one at release is expensive; finding one in the pull request that added it is not.
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/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.supply-chain/sbom-standard-format. The bill of materials is written in a format anything else can read, and it declares which version of that format it is.