Require signed uploads
By default, Affectra accepts any SBOM that a member or an API key uploads, signed or not. The signature policy changes that: when it is on, your organization accepts only SBOMs that are signed by one of its trusted publishers. Use it when the release record has to show that your own build pipeline made every document, for example as evidence for an audit.
Before you turn it on
Section titled “Before you turn it on”Every pipeline that uploads must sign, and the repository it runs in must be a trusted publisher. Otherwise its uploads fail as soon as you turn the policy on.
- Trust each repository that builds your products. See Upload SBOMs from GitHub Actions.
- Sign the SBOMs in those workflows. See Sign SBOMs.
- Upload a release from each pipeline. On the release’s SBOMs tab, the SBOM must show the badge signed. A badge signed, untrusted means the signature is valid, but the repository, workflow or ref is not one of your trusted publishers. Fix that first.
If a pipeline cannot sign, for example because it does not run in GitHub Actions, the policy is not for you yet. Its uploads would be refused.
Turn it on or off
Section titled “Turn it on or off”Only an admin can change the setting. See Trusted publishers for the list that the policy uses, and Roles for who may do what.
- Open Trusted publishers in the app.
- Under Signed SBOMs, select the checkbox Accept only SBOMs signed by a trusted repository.
- Confirm the question Refuse every SBOM upload that is not signed by one of these repositories?
To turn it off, clear the checkbox. Turning it off needs no confirmation. Every member can read the setting through the API, but a key cannot change it, even a key that can propose changes.
Affectra staff can change the setting for your organization, for example when you ask support to turn it off because a pipeline is blocked. When they do, the owners of your organization see it on the Members page, in the list of what Affectra staff changed.
What happens to uploads
Section titled “What happens to uploads”The policy is applied when an upload arrives, before anything is created. When it is on:
- An unsigned SBOM is refused with
403. The message is: This organization accepts only SBOMs signed by one of its trusted publishers. - An SBOM signed by someone who is not a trusted publisher is refused the same way. A valid signature is not enough: the run that signed it must be allowed by one of your trusted publishers. A repository that is trusted only for a GitHub environment never counts, because certificates do not name the environment.
- Build provenance is held to the same rule. Provenance that is not signed by a trusted publisher is refused with
403and the message This organization accepts only build provenance signed by one of its trusted publishers. - A refused upload creates nothing. It adds no SBOM, and no product, variant or release either.
- A signed upload from an API key works. The signature, not the key, says who built the document.
Turning the policy on does not remove or change SBOMs you already uploaded. They keep the badge they had.
The action fails the step with the message from Affectra. In a script, check for the status 403. See Upload SBOMs from other CI.
Check it works
Section titled “Check it works”Turn the policy on, then upload an SBOM from a pipeline you know is not signed, such as your own machine, with an API key. It must fail with 403. Then re-run a signed pipeline. It must succeed, and its SBOM must show signed.