SBOM
Kuidas genereerida SBOM-i GitHub Actionsis
GitHub Actionsi konveierist saab SBOM-i neljal viisil ja need kirjeldavad eri asju: repositooriumi, kettal olevaid faile, kummagi allkirjastatud koopiat või seda, mida build tegelikult alla laadis. Valige selle järgi, mida SBOM peab tõendama. Iga allpool kirjeldatud lähenemisega on kaasas YAML või käsud selle käitamiseks.
Uuendatud
Neli lähenemist
| Võimekus | Lähenemine | Mida SBOM kirjeldab | Töö |
|---|---|---|---|
| Sõltuvusgraafi eksport | GitHubi graaf | Repositooriumi manifestid ja lukufailid vaikeharus | Pole |
| Generaatori samm | Syft, Trivy, cdxgen | Failid või tõmmis, mis on sammu käitamise ajal selle ees | Üks samm töö kohta |
| Kinnitus (attestation) | actions/attest | Mis tahes SBOM, mille sellele annate, allkirjastatud ja artefaktiga seotud | Üks samm pärast genereerimist |
| Salvestamine buildi ajal | CRACI | Mida töö käitamise ajal alla laadis, koos täielikkuse olekuga | Muutke runs-on |
1. Eksportige sõltuvusgraaf
GitHub koostab repositooriumi manifestidest ja lukufailidest sõltuvusgraafi ja saab selle eksportida SPDX SBOM-ina. See ei vaja töövoo muutmist: avage repositooriumi vahekaart Insights, valige Dependency graph ja klõpsake Export SBOM. See kirjeldab repositooriumi vaikeharus, mitte konkreetset buildi, nii et tööriistu ja pakette, mida töövoog installib, selles pole.
Skriptimiseks kasutage REST API-t. GET /repos/{owner}/{repo}/dependency-graph/sbom tagastab SPDX JSON-i ühe päringuga, kuid GitHub sulgeb selle pärast 13. novembrit 2026. Asendus on asünkroonne: tellige aruanne ja seejärel laadige alla selle tagastatud sbom_url. See URL vastab SBOM-i genereerimise ajal koodiga 202 ja suunab seejärel SPDX JSON-failile, mida GitHub säilitab kuni nädala.
# Export the dependency graph as SPDX JSON (closing down after November 13, 2026)
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer $GITHUB_TOKEN" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/repos/OWNER/REPO/dependency-graph/sbom
# The replacement: request a report; the response carries an sbom_url
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer $GITHUB_TOKEN" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/repos/OWNER/REPO/dependency-graph/sbom/generate-report 2. Lisage generaatori samm
Töövoo samm käitab generaatorit tööruumi või tõmmise peal. anchore/sbom-action käitab Syfti: vaikimisi skannib see tööruumi kausta ja väljastab SPDX JSON-i, selle asemel saab see skannida ka konteineritõmmist ning see laadib SBOM-i üles töövoo artefaktina ja lisab selle väljalasetele. Selle README nõuab õigust contents: write ning lisaks actions: read, kui see lisab SBOM-i väljalaskele:
name: sbom
on:
push:
branches: [main]
release:
types: [published]
jobs:
sbom:
runs-on: ubuntu-latest
permissions:
contents: write # upload the SBOM
actions: read # attach it to a release
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v7
with:
node-version: 24
- run: npm ci
# Scan the workspace after the install step
- uses: anchore/sbom-action@v0
with:
path: .
format: cyclonedx-json format võtab väärtuse spdx, spdx-json, cyclonedx või cyclonedx-json. Tõmmise skannimiseks asendage path sisendiga image, näiteks image: ghcr.io/OWNER/app:1.0. BuildKiti enda tõmmise-SBOM-ide kohta vaadake Dockeri SBOM.
Trivyt ja cdxgeni saab käitada samamoodi, tavaliste run sammudena. cdxgen kirjutab CycloneDX-i; alates versioonist 13 on selle npm-i pakett @cdxgen/cdxgen:
steps:
- uses: actions/checkout@v7
- run: npm ci
- run: npm install -g @cdxgen/cdxgen --ignore-scripts
- run: cdxgen -o bom.json .
- uses: actions/upload-artifact@v7
with:
name: sbom
path: bom.json Ajastus on oluline. Käitage samm pärast sõltuvuste installimist, muidu see neid ei näe. Isegi siis näeb generaator ainult enda ees olevaid faile: pakett, mille skript alla laadis, kasutas ja kustutas, või väljaspool paketihaldurit installitud tööriist võib puududa.
3. Allkirjastage see kinnitusena
GitHubi artifact attestations seovad SBOM-i artefaktiga, mida see kirjeldab, ja allkirjastavad selle Sigstore'iga. actions/attest@v4 võtab SPDX- või CycloneDX JSON-i vastu sisendi sbom-path kaudu, kuni 16 MB. Ilma sisendita sbom-path loob see selle asemel SLSA buildi päritoluteabe. actions/attest-sbom aegub actions/attesti kasuks, mida see nüüd ümbritseb. Töö vajab allkirjastamissertifikaadi saamiseks õigust id-token: write ja tulemuse salvestamiseks õigust attestations: write:
jobs:
build:
runs-on: ubuntu-latest
permissions:
id-token: write # sign with a Sigstore certificate
contents: read
attestations: write # store the attestation
steps:
- uses: actions/checkout@v7
- run: make build # writes dist/my-app
- uses: anchore/sbom-action@v0
with:
path: .
format: spdx-json
output-file: sbom.spdx.json
upload-artifact: false
- uses: actions/attest@v4
with:
subject-path: dist/my-app
sbom-path: sbom.spdx.json Konteineritõmmise puhul andke subject-name ja subject-digest sisendi subject-path asemel, määrake push-to-registry: true ja lisage packages: write. Artifact attestations töötavad avalikes repositooriumides kõigis praegustes GitHubi plaanides; privaatsed ja sisemised repositooriumid vajavad GitHub Enterprise Cloudi.
Seejärel kontrollib GitHub CLI, kes SBOM-i lõi ja millise artefakti jaoks. SBOM-i kinnitused vajavad lippu --predicate-type; SBOM-i enda nägemiseks lisage --format json. Tõmmise puhul kasutage failitee asemel oci:// koos tõmmise nimega.
gh attestation verify dist/my-app \
-R OWNER/REPO \
--predicate-type https://spdx.dev/Document/v2.3 Kinnitus tõendab, kes SBOM-i lõi ja millise artefakti jaoks. See ei muuda SBOM-i täielikumaks.
4. Salvestage see buildi ajal
CRACI salvestab SBOM-i töö käitamise ajal. Muudate runs-on väärtuseks craci:
jobs:
build:
runs-on: craci # was: ubuntu-latest Seejärel salvestab runneris olev pakette tundev puhverserver iga paketi, mille töö alla laadis, sealhulgas CI vahemäludest taastatud paketid ja varjatud sõltuvused, mida ükski lukufail ei loetle, näiteks installiskriptide alla laaditud koodi. Pole generaatori sammu, mida paigutada, nii et ajastuse küsimus kaob. Iga SBOM CycloneDX- või SPDX-vormingus märgib oma täielikkuse iga töö ja vahemälu kohta ning API tagastab SBOM-id, võrgujäljed ja päritoluteabe. Seadistus, sealhulgas CRACI GitHub App ja võrguseaded, on kirjas CRACI dokumentatsioonis ja iga täielikkuse oleku tähendus lehel job and cache SBOM completeness.
Millist kasutada
- Kiire ülevaade repositooriumist: sõltuvusgraafi eksport.
- Konteineritõmmise SBOM: generaatori samm tõmmise peal.
- Tõend selle kohta, kes millise artefakti jaoks SBOM-i lõi: kinnitus kumma tahes peal.
- Kirje sellest, mida build tegelikult kasutas, haavatavustele reageerimiseks või ELi küberkerksuse määruse (Cyber Resilience Act, CRA) jaoks: salvestamine buildi ajal. Vaadake SBOM-i tööriistad võrdluses.
SBOM-id GitHub Actionsis: korduma kippuvad küsimused
Kuidas genereerida SBOM-i GitHub Actionsis?
Lisage pärast installisammu generaatori samm. Lühim on anchore/sbom-action@v0, mis käitab Syfti tööruumi peal ja laadib SPDX JSON SBOM-i üles töövoo artefaktina. Allkirjastatud SBOM-i saamiseks andke fail actions/attest@v4-le sisendiga sbom-path.
Kas GitHub genereerib SBOM-i automaatselt?
GitHub saab repositooriumi sõltuvusgraafi eksportida SPDX SBOM-ina vahekaardilt Insights või REST API kaudu. See kirjeldab repositooriumi manifeste ja lukufaile, mitte konkreetset buildi, nii et see ei näita tööriistu ega pakette, mida töövoog alla laadib.
Milline action genereerib SBOM-i GitHub Actionsis?
anchore/sbom-action käitab Syfti. Vaikimisi skannib see tööruumi kausta ja väljastab SPDX JSON-i; selle asemel saab see skannida konteineritõmmist, laadib SBOM-i üles töövoo artefaktina ja lisab selle väljalasetele.
Milliseid õigusi SBOM-i töövoog vajab?
anchore/sbom-action nõuab õigust contents: write ning lisaks actions: read, et lisada SBOM väljalaskele. Allkirjastamine actions/attest abil vajab õigusi id-token: write ja attestations: write ning packages: write, kui kinnitus lükatakse konteineriregistrisse.
Kuidas allkirjastada SBOM-i GitHub Actionsis?
Kasutage GitHubi artifact attestations'it. actions/attest allkirjastab SPDX või CycloneDX JSON SBOM-i Sigstore'iga ja seob selle artefaktiga; kontrollige seda käsuga gh attestation verify. actions/attest-sbom aegub actions/attesti kasuks, mida see nüüd ümbritseb.
Kuidas genereerida konteineritõmmise SBOM-i GitHub Actionsis?
Andke tõmmis anchore/sbom-actionile sisendiga image sisendi path asemel. Selle allkirjastamiseks andke actions/attest-le tõmmise nimi ja räsi sisendite subject-name ja subject-digest kaudu, määrake push-to-registry: true ja kontrollige käsuga gh attestation verify oci://IMAGE.
Kas töövoog peaks looma SPDX-i või CycloneDX-i?
Seda, mida ootab tööriist, mis SBOM-i loeb. Sõltuvusgraafi eksport on ainult SPDX ja cdxgen kirjutab CycloneDX-i. anchore/sbom-action kirjutab kumbagi ja actions/attest võtab vastu kumbagi. Vaadake CycloneDX vs SPDX.
Kas SBOM-i samm peaks töötama enne või pärast buildi?
Pärast sõltuvuste installimist, muidu jääb see neist ilma. Isegi siis näeb see seda, mis on kettal, mitte seda, mille töö alla laadis ja eemaldas, ega seda, mille skript tõi. Buildi ajal salvestamine väldib ajastuse küsimust.
Salvestage SBOM ühest oma buildist
Muutke ühe töö runs-on väärtust, käitage seda CRACI-s ja võrrelge salvestatud SBOM-i sellega, mille teie praegune samm loob.
Broneerige demo