SBOMs in Bitbucket Pipelines
One bitbucket-pipelines.yml that generates, scores and uploads an SBOM on every pull request, push to main and release tag. The token is a secured repository variable, masked in logs, and the CLI attaches the branch, commit and build number by itself.
Before you start
- Install the CLI on your machine and run
sbombox login. - Pick or create the project this repository uploads to.
sbombox projects listshows the IDs; the project ID is not a secret. - Create an API token for that project: in SBOMBox open the project, then Settings, then API tokens. Tokens are scoped to one project, so a leaked token cannot touch any other.
- In Bitbucket, open the repository's Repository settings, Repository variables. Add
SBOMBOX_TOKENwith Secured selected, andSBOMBOX_PROJECTwith your project ID. Secured values are masked in logs and cannot be read back.
Keyless sign-in, which needs no stored token, is available on GitHub Actions and GitLab CI only. On other systems the token is the credential, so treat it like any other deploy secret: limit who can read it and rotate it on your usual schedule.
Add the pipeline
Commit this bitbucket-pipelines.yml:
# bitbucket-pipelines.yml
image: python:3.12-slim
definitions:
steps:
- step: &sbom
name: SBOM
script:
- apt-get update -qq && apt-get install -y -qq curl >/dev/null
- curl -fsSL https://sbombox.com/install.sh | SBOMBOX_NO_MODIFY_PATH=1 sh
- export PATH="$HOME/.local/bin:$PATH"
- sbombox generate --output sbom.json
- sbombox score sbom.json --format detailed
# Upload before enforcing the gate, so failing runs are on record too.
- |
if [ -n "${SBOMBOX_TOKEN:-}" ]; then
sbombox push sbom.json ${BITBUCKET_TAG:+--version "$BITBUCKET_TAG"}
else
echo "No SBOMBOX_TOKEN (for example a pull request from a fork). Skipping upload."
fi
- sbombox score sbom.json --fail-under "${SBOMBOX_FAIL_UNDER:-7}"
artifacts:
- sbom.json
pipelines:
pull-requests:
'**':
- step: *sbom
branches:
main:
- step: *sbom
tags:
'v*':
- step: *sbom- The step is defined once and reused with a YAML anchor, so pull requests,
mainand tags run exactly the same checks. python:3.12-slimis pinned and small. It has nocurl, so the first line adds it. Any image withshandcurlworks; the installer fetches its own Python.SBOMBOX_FAIL_UNDERdefaults to 7 here. Set it as a repository variable to change it without editing the file.
What each run does
- Installs the CLI and a pinned, checksum-verified SBOM generator. Nothing needs root, and no system Python is needed.
- Generates the SBOM with the most accurate tool for the project: the package manager's own SBOM command when its lockfile is present (npm 9.5+, pnpm 11.1+, uv 0.9.11+), otherwise a native or universal generator. Dev dependencies are left out, so the SBOM describes what ships.
- Scores it from 0 to 10 and prints every check, so the log explains the score.
- Uploads it to the project, with the build number, repository, branch and commit detected from Bitbucket Pipelines automatically.
- Only then enforces the minimum score, so failing runs are on record too.
- Keeps
sbom.jsonwith the build as an artifact.
Uploads made with a token are recorded at provenance level P1: the branch, commit, build number and repository are attached as reported by the CI system. Keyless uploads from GitHub Actions and GitLab CI reach P2, where SBOMBox verifies the repository, commit and run itself.
Pull requests vs releases
pull-requests: '**'runs the step for every pull request, whatever its source branch.branches: mainkeeps the latest SBOM ofmainon record.tags: 'v*'runs for release tags. Bitbucket setsBITBUCKET_TAG, and the step uploads with that release label.- When no token is available, the upload is skipped with a message and the score gate still runs.
To check a compliance ruleset on releases, give the tags pipeline its own step that adds sbombox compliance sbom.json -p cra-readiness. See the end-to-end guide for the full flow.
Monorepos
Run one step per service in a parallel block. Each step scans its own directory and uploads to its own project, with one secured token per project:
pipelines:
pull-requests:
'**':
- parallel:
- step:
name: SBOM api
script:
- export SERVICE=api SBOMBOX_PROJECT="0193c0de-..." SBOMBOX_TOKEN="$SBOMBOX_TOKEN_API"
- apt-get update -qq && apt-get install -y -qq curl >/dev/null
- curl -fsSL https://sbombox.com/install.sh | SBOMBOX_NO_MODIFY_PATH=1 sh
- export PATH="$HOME/.local/bin:$PATH"
- sbombox generate --dir "services/$SERVICE" --output sbom-api.json
- sbombox push sbom-api.json
- sbombox score sbom-api.json --fail-under 7
artifacts:
- sbom-api.json
- step:
name: SBOM web
script:
- export SERVICE=web SBOMBOX_PROJECT="0193c0df-..." SBOMBOX_TOKEN="$SBOMBOX_TOKEN_WEB"
# ... same commands, with sbom-web.jsonTo report the services as one product, combine the uploads in SBOMBox. See Unify SBOMs.
Options
Set these as repository or workspace variables. Mark SBOMBOX_TOKEN as secured.
| Variable | Default | What it does |
|---|---|---|
SBOMBOX_TOKEN | - | Project API token. Store it as a secret, never in the repository. Without it the upload step is skipped. |
SBOMBOX_PROJECT | - | Project ID to upload to. Not a secret. |
SBOMBOX_FAIL_UNDER | 7 in these examples | Minimum quality score, 0-10. The job fails below it, after the upload. 0 turns the gate off. |
SBOMBOX_GENERATOR | SBOMBox chooses | Force which generator runs, comma-separated in order of preference, e.g. npm-sbom or cyclonedx-npm,syft. |
SBOMBOX_VERSION | current version | Installer: pin the CLI version, e.g. 0.2.0, for reproducible builds. Versions below the supported minimum are refused. |
SBOMBOX_GENERATORS | auto | Installer: generators to install - syft, cyclonedx-py, cyclonedx-npm, cdxgen, auto, all or none. Add cdxgen for Java and Gradle. |
SBOMBOX_SYFT_VERSION | v1.57.1 | Installer: the syft version to install. It is checked against its published SHA-256. |
SBOMBOX_NO_MODIFY_PATH | - | Installer: set to 1 so CI shell profiles are left alone. Add $HOME/.local/bin to PATH yourself, as the examples do. |
SBOMBOX_API_URL | https://api.sbombox.com | Self-hosted SBOMBox: the API address, for both the installer and the CLI. |
Put installer variables in front of sh on the install line, e.g. SBOMBOX_VERSION=0.2.0. Self-hosted runners that cannot reach sbombox.com can run a copy of the installer from an internal mirror; it still downloads its tools, so allow those downloads or mirror them too.
Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
No SBOMBOX_TOKEN ... Skipping upload. on your own branches | The variable is missing, misspelled, or defined in another repository or deployment environment. | Add it under Repository variables with exactly that name. |
curl: command not found | The image has no curl. | Keep the apt-get line, or use an image that includes curl. |
Authentication failed: No CI identity token available. Set SBOMBOX_TOKEN, or run sbombox login. (exit 5) | SBOMBOX_TOKEN is not reaching the upload step. | Check the secret's name and that it is exposed to this job, as described in Before you start. |
Upload failed: Authentication failed: ... (exit 5) | The token was revoked, or belongs to another project. | Create a new token for this project and replace the secret. |
No project specified. (exit 2) | SBOMBOX_PROJECT is not set. | Set it in the pipeline file or as a CI variable. |
Network error: ... (exit 3) | The runner cannot reach the SBOMBox API. | Allow outbound HTTPS to api.sbombox.com, or set SBOMBOX_API_URL for a self-hosted deployment. |
Could not detect project ecosystem in <dir>: no supported manifest or lockfile. (exit 4) | The scan ran in a directory without a manifest. | Pass the right directory with sbombox generate --dir <path>. In a monorepo, run one job per service. |
No lockfile for npm: transitive dependencies may be missing | The lockfile is not committed, so versions are guessed. | Commit the lockfile (package-lock.json, uv.lock, go.sum and so on). See Languages. |
Generation failed: No SBOM generator found for ecosystems [...] (exit 4) | No generator for this ecosystem is installed on the runner. | Run the installer in the same job, or add one with SBOMBOX_GENERATORS, e.g. cdxgen for Java. |
Generation failed: SBOMBOX_GENERATOR names unknown generator(s) ... (exit 4) | A typo in SBOMBOX_GENERATOR. | Use a name from the list the message prints. |
Score 6.4 is below threshold 7.0. (exit 1) | The quality gate failed. The SBOM was already uploaded, so the run is on record. | Run sbombox score sbom.json --format detailed to see the weakest checks, or lower SBOMBOX_FAIL_UNDER while you improve it. |
| Exit 6, upgrade required | The pinned CLI version is below the minimum SBOMBox accepts. | Raise or remove SBOMBOX_VERSION. |