SBOM
Konteinerite ja Dockeri SBOM-id: kuidas neid genereerida ja mis neist puudub
Dockeri tõmmise SBOM-i saate ühe käsuga: buildi ajal BuildKitiga või hiljem Docker Scouti või Syftiga. Igaüks neist loeb tõmmisest leitud pakettide metaandmeid. See on õige kirje sellest, mida tõmmis sisaldab, niivõrd kui metaandmed ulatuvad. See ei ole kirje sellest, kuidas tõmmis ehitati.
Uuendatud
Kuidas genereerida Dockeri tõmmise SBOM-i
Levinud viise on kolm. BuildKit saab SBOM-i kirjutada tõmmise ehitamise ajal ja lisada selle tõmmisele kinnitusena (attestation). Docker Scout ja Syft genereerivad selle juba olemasolevast tõmmisest, kohalikust või registris olevast.
Buildi ajal BuildKitiga
Lisage lipp --sbom=true või selle pikk vorm --attest type=sbom käsule docker buildx build. BuildKit käitab tulemusel oma Syfti skanneripluginat ja lisab SBOM-i tõmmisele SPDX JSON-dokumendina. Ehitage local eksportijaga, et SBOM üle vaadata enne, kui midagi üles laadite:
# Build the image, attach an SBOM attestation and push it
docker buildx build --sbom=true -t registry.example.com/app:1.0 --push .
# The long form of the same option
docker buildx build --attest type=sbom -t registry.example.com/app:1.0 --push .
# Check the SBOM before pushing: write the build result to ./out
docker buildx build --sbom=true --output type=local,dest=out .
# out/sbom.spdx.json is the SBOM Tõmmisele lisatud SBOM-i lugemine
docker buildx imagetools inspect loeb kinnituse registrist tagasi. Kõik SBOM-iga seotu on selle Go malli väljal .SBOM:
# Print the SPDX document attached to the image
docker buildx imagetools inspect registry.example.com/app:1.0 \
--format "{{ json .SBOM.SPDX }}"
# List each package and its version
docker buildx imagetools inspect registry.example.com/app:1.0 \
--format "{{ range .SBOM.SPDX.packages }}{{ .name }}@{{ .versionInfo }}{{ println }}{{ end }}" Olemasolevast tõmmisest Docker Scoutiga
docker scout sbom kasutab tõmmise SBOM-i kinnitust, kui see on olemas. Kui seda pole, indekseerib see tõmmise sisu ise. Vaikimisi trükib see JSON-i ja kirjutab faili lipuga --output:
# List the packages in an image
docker scout sbom --format list registry.example.com/app:1.0
# Write an SPDX or CycloneDX SBOM to a file
docker scout sbom --format spdx --output app.spdx.json registry.example.com/app:1.0
docker scout sbom --format cyclonedx --output app.cdx.json registry.example.com/app:1.0 Olemasolevast tõmmisest Syftiga
Syft on avatud lähtekoodiga skanner, millele BuildKiti plugin on ehitatud. Suunake see tõmmisele ja valige vorming lipuga -o. Lisage =file, et kirjutada iga vorming eraldi faili:
# CycloneDX JSON to the terminal
syft registry.example.com/app:1.0 -o cyclonedx-json
# Both formats, each to its own file
syft registry.example.com/app:1.0 -o spdx-json=app.spdx.json -o cyclonedx-json=app.cdx.json SPDX või CycloneDX?
BuildKiti kinnitused on alati SPDX-vormingus. Docker Scout kirjutab SPDX-i või CycloneDX-i ja Syft mõlemat, teiste vormingute seas. Mõlemad standardid loetlevad paketid, versioonid, litsentsid ja paketi-URL-id, nii et valiku määrab tavaliselt tööriist, mis SBOM-i järgmisena loeb. Erinevused leiate lehelt CycloneDX vs SPDX.
Kuidas tõmmiseskanner SBOM-i koostab
Kõik need tööriistad töötavad ühtmoodi. Nad pakivad tõmmise kihid lahti ja loevad leitud pakettide metaandmeid: operatsioonisüsteemi paketiandmebaasi ja metaandmeid, mida keelte paketihaldurid maha jätavad. Iga pakett, mida nad suudavad tuvastada, saab SBOM-i kirjeks, sealhulgas baastõmmisest pärit paketid.
Kaasake buildi etapid ja buildi kontekst
Vaikimisi skannib BuildKit ainult viimast etappi. Mitmeetapilises buildis ei ole varasemates etappides kasutatud kompilaatorid, buildi tööriistad ja paketid lõplikus tõmmises, seega pole neid ka selle SBOM-is. Dockeri SBOM-i kinnituste dokumentatsioon kirjeldab kaht buildi argumenti, mis skannimist laiendavad. BUILDKIT_SBOM_SCAN_STAGE lisab etapi ja BUILDKIT_SBOM_SCAN_CONTEXT lisab buildi konteksti:
# syntax=docker/dockerfile:1
# Scan the build context as well as the image
ARG BUILDKIT_SBOM_SCAN_CONTEXT=true
FROM golang:1.25 AS build
# Include this build stage in the SBOM
ARG BUILDKIT_SBOM_SCAN_STAGE=true
WORKDIR /src
COPY . .
RUN go build -o /out/app .
FROM scratch
COPY --from=build /out/app /app
ENTRYPOINT ["/app"] Mõlemad tuleb Dockerfile'is deklareerida käsuga ARG. Ainult lipuga --build-arg määramisel pole mõju, kuigi --build-arg saab Dockerfile'is deklareeritud väärtuse üle kirjutada. local eksportijaga saab iga skannitud etapp oma faili, näiteks sbom-build.spdx.json faili sbom.spdx.json kõrval.
Mida skannimine ikka ei näe
Etappide skannimine sulgeb ühe lünga. Skanner loeb siiski faile ja osa sellest, mida build kasutab, ei jäta maha ühtki faili või vähemalt mitte sellist, mida see suudaks tuvastada:
- Paketi metaandmeteta failid. Käsuga
curlalla laaditud binaarfail,RUN-sammus lahti pakitud tarball või sisse kopeeritud vendoreeritud kood. Mõni binaarfail kannab buildi teavet, mida skanner suudab lugeda, näiteks Go binaarfailid; paljud ei kanna. - Mida build alla laadis ja kustutas. Pakett või installer, mille
RUN-samm samas kihis alla laadib, kasutab ja eemaldab, ei jäta failisüsteemi midagi, mida ükski skanner saaks lugeda, olgu see viimane etapp või mitte. - Kuidas asjad sisse said. Skannimisest saadud SBOM loetleb, mis on olemas. See ei ütle, millisest registrist või hostist pakett tuli ega milline samm selle alla laadis.
- Etapid, mida te ei märkinud. Etappide skannimine tuleb sisse lülitada, etapi kaupa või globaalselt. Argumendita etapp jääb ikka välja.
- Skannimise seaded. See, mis tulemusse ilmub, sõltub skanneri käitamise viisist. Ühes projektis otsustab üksainus Syfti lipp, kas npm-i paketid tulemusse üldse ilmuvad.
Sama probleemi kohta Yocto buildides vaadake lehte miks SBOM-i skannerid ei näe, mis on Yocto buildides.
SBOM-id Kubernetese jaoks
Kubernetese klaster käitab konteineritõmmiseid, seega on Kubernetese SBOM klastris käitatavate tõmmiste SBOM-ide kogum koos klastri enda komponentidega. Genereerige iga tõmmise SBOM selle ehitamisel ja lisage see registris tõmmisele, nii et kõik, mis juurutatakse, kannab oma inventuuri kaasas. Praegu töötava kohta loetlevad klastriskannerid, näiteks Trivy Kubernetese režiim, kasutusel olevad tõmmised ja skannivad neid kohapeal. Tõmmiste puhul, mida te ise ei ehitanud, on see skannimine kõik, mis teil on. Tõmmiste puhul, mille te ehitasite, on buildi SBOM parem kirje.
Miks see on oluline
Kompromiteeritud buildi tööriist või baastõmmis mõjutab seda, mida tarnite, isegi kui see lõplikus tõmmises kunagi ei ilmu. Ja metaandmeteta binaarfail võib kanda haavatavust, millele ükski SBOM-i kirje ei viita. Kui turvateade ilmub, peate teadma nii seda, mis tõmmise ehitamisse läks, kui ka seda, mis selles on.
Salvestage ka build
Tõmmise SBOM vastab küsimusele, mis on tõmmise sees. Buildi kirje vastab küsimusele, mida build kaasa tõi: baastõmmised, mille see alla laadis, ja paketid, mille iga samm tõi, sealhulgas varjatud sõltuvused, mida ükski lukufail ei loetle. CRACI salvestab selle teie GitHub Actionsi töö ajal runneris oleva pakette tundva puhverserveri kaudu ning API tagastab töö SBOM-id, võrgujäljed ja päritoluteabe. Kasutage tõmmise SBOM-i selle jaoks, mida tarnite, ja buildi kirjet selle jaoks, kuidas see valmis.
Vaadake SBOM-i tööriistad võrdluses, buildi ajal salvestatud SBOM-id ja kuidas genereerida SBOM-i GitHub Actionsis.
Dockeri SBOM-id: korduma kippuvad küsimused
Kuidas genereerida Dockeri tõmmise SBOM-i?
Levinud viise on kolm. Lisage lipp --sbom=true käsule docker buildx build ja BuildKit lisab tõmmisele SPDX SBOM-i. Käitage olemasoleval tõmmisel docker scout sbom. Või käitage Syfti, näiteks syft IMAGE -o cyclonedx-json. Kõik kolm loevad tõmmisest leitud pakette.
Mis on SBOM-i skanner?
Tööriist, mis loeb faile, näiteks lähtekoodikataloogi, lukufaili või konteineritõmmist, ja kirjutab SBOM-i pakettidest, mida see suudab tuvastada. Syft, Trivy, Docker Scout ja BuildKiti Syfti plugin on SBOM-i skannerid. Need kirjeldavad nende ees olevaid faile, mitte buildi, mis need tootis.
Millises SBOM-i vormingus Docker väljundit annab?
BuildKiti kinnitused on tõmmisele lisatud SPDX JSON-dokumendid. Docker Scout saab trükkida paketiloendi või kirjutada SPDX-i või CycloneDX-i. Syft kirjutab mõlemat ja rohkemgi. Valige vorming, mida SBOM-i kasutav tööriist ootab.
Kuidas skanner Dockeri tõmmisest SBOM-i koostab?
See pakib tõmmise kihid lahti ja loeb leitud pakettide metaandmeid: operatsioonisüsteemi paketiandmebaasi ja keelte paketifaile, näiteks installitud npm-i või Pythoni pakettide metaandmeid. Iga pakett, mida see suudab tuvastada, saab SBOM-i kirjeks.
Miks võib tõmmise SBOM-ist komponent puududa?
Sest see saab loetleda ainult seda, mida suudab loetavates failides tuvastada. curliga alla laaditud binaarfail ei kanna paketi metaandmeid, buildi sammu alla laaditud ja kustutatud pakett ei jäta midagi lugeda ning varasemad buildi etapid jäävad välja, kui te etappide skannimist sisse ei lülita.
Kas tõmmise SBOM on ikkagi kasulik?
Jah. See on õige kirje sellest, mis on teie tarnitava tõmmise sees, sealhulgas baastõmmise paketid. See lihtsalt ei kirjelda, kuidas tõmmis ehitati, seega siduge see buildi kirjega, kui see on oluline.
Kuidas saada Kubernetese klastri SBOM-i?
Koguge klastris käitatavate tõmmiste SBOM-id. Genereerige see iga ehitatava tõmmise jaoks ja lisage registrisse ning kasutage tõmmiste puhul, mida te ise ei ehitanud, klastriskannerit, näiteks Trivy Kubernetese režiimi.
Vaadake, mida teie tõmmise build kaasa tõi
Käitage üks tõmmise build CRACI-s ja pange selle kirje allalaaditud baastõmmistest ja pakettidest oma skanneri tõmmise SBOM-i kõrvale.
Broneerige demo