|
| 1 | +# How to fetch SBOMs for Sourcegraph |
| 2 | + |
| 3 | +Sourcegraph publishes a Software Bill of Materials (SBOM) for each of its container images. The SBOMs for each Sourcegraph release are signed, and stored in our container registry alongside our published container images. |
| 4 | + |
| 5 | +To retrieve the SBOMs for a specific release, you can use the `src` command line interface for Sourcegraph: |
| 6 | + |
| 7 | +1. Install `src` by following the [Quickstart](../quickstart.mdx). |
| 8 | +2. Install `cosign` by following the [Installation Guide](https://docs.sigstore.dev/cosign/system_config/installation/). |
| 9 | +3. Identify the version of Sourcegraph your require SBOMs for. This may be a [recent release](../../CHANGELOG.mdx), or your instance's current version. |
| 10 | + 1. SBOMs are only available for Sourcegraph release 5.9.0 and later. |
| 11 | + 2. Find your instance's current version by checking your deployment, or by visiting the Settings page on your Sourcegraph instance and checking the version shown in the bottom left corner. |
| 12 | +  |
| 13 | +4. Run `src sbom fetch -v <version>` to fetch SBOMs for all containers in this release. `src` will automatically validate that all SBOMs were signed by Sourcegraph. |
| 14 | + ``` |
| 15 | + # Fetch SBOMs for Sourcegraph release 5.9.0 |
| 16 | + $ src sbom fetch -v 5.9.0 |
| 17 | +
|
| 18 | + Fetching SBOMs and validating signatures for all 39 images in the Sourcegraph 5.9.0 release... |
| 19 | +
|
| 20 | + ✅ sourcegraph/appliance |
| 21 | + ✅ sourcegraph/batcheshelper |
| 22 | + ✅ sourcegraph/bundled-executor |
| 23 | +
|
| 24 | + [...] |
| 25 | +
|
| 26 | + 🟢 Fetched verified SBOMs for 39 images |
| 27 | +
|
| 28 | + Fetched and validated SBOMs have been written to `sourcegraph-sboms/sourcegraph-5.9.0`. |
| 29 | +
|
| 30 | + Your Sourcegraph deployment may not use all of these images. Please check your deployment to confirm which images are used. |
| 31 | + ``` |
| 32 | +5. Once completed, you can find the set of validated SBOMs under `sourcegraph-sboms/sourcegraph-<version>/`. |
| 33 | + |
| 34 | +**Note:** `src sbom fetch` will retrieve SBOMs for **all** containers that make up a Sourcegraph release. Your Sourcegraph instance will use only a subset of these containers - please check your deployment to determine which SBOM files are relevant to your deployment. |
0 commit comments