SBOM
Hva er CycloneDX?
CycloneDX er en åpen standard for materiallister (bills of materials), drevet av OWASP Foundation og publisert av Ecma International som ECMA-424. Den er best kjent som et SBOM-format: en maskinlesbar liste over komponentene i en programvare, hvordan de avhenger av hverandre og hva som er kjent om sårbarhetene deres. Gjeldende versjon er CycloneDX 1.7, og det samme formatet beskriver også tjenester, maskinvare, kryptografi og maskinlæringsmodeller.
Oppdatert
CycloneDX i korte trekk
| Vedlikeholdes av | CycloneDX-prosjektet i OWASP Foundation, sammen med Ecma International Technical Committee 54 (TC54) |
|---|---|
| Standard | ECMA-424. 1. utgave (juni 2024) er CycloneDX 1.6; 2. utgave (desember 2025) er CycloneDX 1.7 |
| Gjeldende versjon | CycloneDX 1.7, utgitt i oktober 2025 |
| Kodinger | JSON, XML og Protocol Buffers |
| Medietype | application/vnd.cyclonedx+json, med en versjonsparameter som version=1.7 |
| Filnavn | bom.json, bom.xml, *.cdx.json, *.cdx.xml |
Den første versjonen, CycloneDX 1.0, kom i 2018 som en sikkerhetsfokusert materialliste. Ecma opprettet TC54 for standarder for leverandørkjeden i desember 2023, og CycloneDX 1.6 ble ECMA-424 i juni 2024. Spesifikasjonsoversikten og ECMA-424-siden er primærkildene.
Hva en CycloneDX-SBOM inneholder
Et CycloneDX-dokument er ett objekt, som regel kalt en BOM. Bare to felt er påkrevd, bomFormat (alltid
"CycloneDX") og specVersion. Alt annet er valgfritt, og derfor kan to gyldige CycloneDX-filer
skille seg så mye i hva de faktisk forteller deg.
| Element | Hva det inneholder |
|---|---|
metadata |
Når og hvordan BOM-en ble laget: tidsstempel, verktøy, forfattere, livssyklusfasen og komponenten BOM-en beskriver |
components |
Hvert bibliotek, rammeverk, hver container, fil, fastvare, enhet eller modell, med versjon, identifikatorer, hasher og lisenser |
services |
Eksterne tjenester programvaren kaller, for eksempel API-er, med endepunkter og dataflyt |
dependencies |
Hvilken komponent eller tjeneste som avhenger av hvilken, så treet kan gjenoppbygges, transitive nivåer inkludert |
compositions |
Hvor fullstendig hver del av BOM-en er: complete, incomplete, unknown eller not specified |
vulnerabilities |
Kjente sårbarheter, alvorlighetsgraderingen deres og, for VEX, om og hvordan de påvirker produktet |
formulation |
Hvordan produktet ble bygget: workflowene, oppgavene og miljøet bak det |
annotations |
Kommentarer og notater knyttet til andre deler av BOM-en, med hvem som laget dem og når |
declarations, definitions, citations |
Attesteringer av samsvar med standarder, selve standardene og hvor dataene i BOM-en kom fra |
Feltet metadata.lifecycles sier når BOM-en ble laget: design, pre-build, build, post-build, operations,
discovery eller decommission. En SBOM fra byggefasen og en skanning etter bygget av samme produkt kan liste ulike
komponenter, så fasen betyr noe når du sammenligner to filer.
BOM-typer i CycloneDX
Den samme objektmodellen dekker mer enn programvare. CycloneDX-prosjektet lister disse bruksområdene:
| Type | Beskriver |
|---|---|
| SBOM | Programvarekomponenter og avhengighetene deres |
| SaaSBOM | Tjenester, endepunkter og dataflyt i en hostet applikasjon |
| HBOM | Maskinvarekomponenter |
| CBOM | Kryptografiske ressurser: algoritmer, nøkler, sertifikater og protokoller |
| ML-BOM | Maskinlæringsmodeller og datasettene bak dem |
| OBOM og MBOM | Driftsmiljøer, og produksjonen av et produkt |
| VEX, VDR og BOV | Om en sårbarhet påvirker et produkt (VEX), en leverandørs rapport om kjente sårbarheter (VDR) og en liste over sårbarheter (BOV) |
| CDXA | Attesteringer av at et produkt oppfyller en standard eller et krav |
Dette er bruksområder for ett format, ikke separate formater. Et VEX-dokument er for eksempel en CycloneDX-BOM der
oppføringene under vulnerabilities har en analysestatus og peker på komponenter i en SBOM.
Identifikatorer: purl, CPE og hasher
Navnet på en komponent er ikke nok til å matche den mot en sårbarhet, fordi samme navn kan bety ulike pakker i ulike
økosystemer. CycloneDX-komponenter har identifikatorer for dette: en
package URL (purl) som pkg:npm/[email protected], en CPE, en SWID-tagg,
OmniBOR- og SWHID-identifikatorer og kryptografiske hasher. Purl er den de fleste verktøy matcher på for pakker med
åpen kildekode, og den ble en egen Ecma-standard, ECMA-427, i desember 2025. Inne i dokumentet kan hvert element også
ha en bom-ref, en lokal ID som seksjonene for avhengigheter, komposisjoner og sårbarheter bruker til å
peke på det.
Et JSON-eksempel på CycloneDX
En liten, men fullstendig SBOM for en applikasjon, acme-api, som bruker én npm-pakke, debug,
som igjen avhenger av ms. Den validerer mot JSON-skjemaet for CycloneDX 1.7.
{
"bomFormat": "CycloneDX",
"specVersion": "1.7",
"serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79",
"version": 1,
"metadata": {
"timestamp": "2026-11-16T09:30:00Z",
"lifecycles": [{ "phase": "build" }],
"component": {
"type": "application",
"bom-ref": "acme-api",
"name": "acme-api",
"version": "1.4.0"
}
},
"components": [
{
"type": "library",
"bom-ref": "pkg:npm/[email protected]",
"name": "debug",
"version": "4.4.0",
"purl": "pkg:npm/[email protected]",
"licenses": [{ "license": { "id": "MIT" } }]
},
{
"type": "library",
"bom-ref": "pkg:npm/[email protected]",
"name": "ms",
"version": "2.1.3",
"purl": "pkg:npm/[email protected]",
"licenses": [{ "license": { "id": "MIT" } }]
}
],
"dependencies": [
{ "ref": "acme-api", "dependsOn": ["pkg:npm/[email protected]"] },
{ "ref": "pkg:npm/[email protected]", "dependsOn": ["pkg:npm/[email protected]"] },
{ "ref": "pkg:npm/[email protected]", "dependsOn": [] }
],
"compositions": [
{ "aggregate": "complete", "dependencies": ["acme-api"] }
]
}
-
serialNumberogversionidentifiserer denne BOM-en. Hver nygenererte BOM får et nytt serienummer; når en eksisterende BOM endres, beholder den serienummeret, og versjonen øker med én. -
metadata.componenter produktet SBOM-en beskriver, og roten i avhengighetstreet. -
dependenciesgjørmstil en transitiv avhengighet: Applikasjonen ba aldri om den, det gjordedebug. En tomdependsOnsier at komponenten ikke har avhengigheter. Å utelate en komponent fra grafen betyr at avhengighetene er ukjente, ikke at den ikke har noen. -
compositionsslår fast at avhengighetstreet underacme-apier fullstendig. Et verktøy som ikke kunne se alt, bør heller siincompleteellerunknown, så en leser vet at en manglende pakke ikke skal tolkes som fraværende.
For en større fil med hasher, leverandører og en tilsvarende SPDX-versjon av samme applikasjon, se SBOM-eksempler.
Slik genererer du en CycloneDX-SBOM
Det finnes tre måter å lage en på, og de beskriver ulike ting.
| Metode | Slik fungerer den | Hva den går glipp av |
|---|---|---|
| Skanning av manifest og lockfile | Leser package-lock.json, requirements.txt, pom.xml og lignende filer |
Alt som hentes utenom pakkebehandleren, for eksempel installasjonsskript, byggeskript og base-images |
| Analyse av image, filsystem eller binærfil | Undersøker et ferdig container-image, en katalog eller en binærfil for pakkemetadata og signaturer | Komponenter som ikke har etterlatt metadata, og kompilert kode den må gjette seg til |
| Registrering under bygget | Registrerer hva bygget faktisk hentet mens det kjører | Bare det registreringen ikke kan se, noe en god registrering oppgir som ufullstendig |
Gratis verktøy som skriver CycloneDX:
-
cdxgen, et OWASP-prosjekt, for mange språk og container-images:
cdxgen -o bom.json. Det skriver CycloneDX 1.7 som standard. -
CycloneDX-økosystemets plugins, som
@cyclonedx/cyclonedx-npm, cyclonedx-python, CycloneDX Maven-pluginen og cyclonedx-gomod, hver for én pakkebehandler:npx @cyclonedx/cyclonedx-npm --output-file bom.json. -
Syft, fra Anchore, for container-images og filsystemer:
syft <image> -o cyclonedx-json.
CycloneDX Tool Center lister mange flere. For hvordan disse tilnærmingene sammenlignes i praksis, se SBOM-generatorer med åpen kildekode og SBOM-er for Docker-images.
Slik validerer du en CycloneDX-fil
Den offisielle CycloneDX CLI sjekker en fil mot skjemaet for versjonen dens:
cyclonedx validate --input-file bom.json --input-version v1_7 --fail-on-errors
Det samme verktøyet konverterer mellom JSON, XML og Protocol Buffers, mellom spesifikasjonsversjoner og til SPDX JSON,
med cyclonedx convert. Skjemavalidering beviser bare at filen er velformet. Den kan ikke fortelle deg om en
komponent mangler. For det må du sjekke innholdet mot en liste som
sjekklisten for SBOM-kvalitet.
CycloneDX vs. SPDX
SPDX er det andre mye brukte SBOM-formatet, driftet av Linux Foundation og publisert som ISO/IEC 5962:2021. Det vokste ut av lisensetterlevelse, mens CycloneDX startet med sikkerhet, og derfor har CycloneDX sårbarheter og VEX i samme format. Begge beskriver komponenter, identifikatorer, lisenser og relasjoner, verktøy konverterer mellom dem, og EUs Cyber Resilience Act nevner ingen av dem. Hvilket du lager, avhenger som regel av hva kundene og verktøyene dine leser. Den fullstendige sammenligningen finner du i CycloneDX vs. SPDX.
Slik lager CRACI CycloneDX-SBOM-er
CRACI er en GitHub Actions-runner som registrerer hver pakke hver jobb henter mens den kjører, på alle nivåer i avhengighetstreet og inkludert pakker gjenopprettet fra CI-cacher. Dermed var hver komponent i SBOM-en faktisk med i bygget. Hver pakke har sin purl og deklarerte lisens, og hver jobbs SBOM har en fullstendighetsstatus som sier hva jobben ikke kunne se. SBOM-en eksporteres som CycloneDX eller SPDX, med de transitive avhengighetene og sårbarhetene som er funnet i komponentene, og API-et returnerer den som CycloneDX 1.7 JSON. Se SBOM-generering under bygget eller beste praksis for SBOM.
Når CRACI ikke er svaret
- BOM-er for maskinvare, kryptografi eller tjenester. CRACI registrerer programvarepakker et bygg henter. En HBOM, CBOM eller SaaSBOM krever andre kilder.
- Bygg utenfor GitHub Actions. GitHub Actions er det eneste støttede CI-systemet i dag; andre CI-systemer står på veikartet. Bruk en generator som cdxgen i mellomtiden.
- Programvare du mottar som binærfil. Har du ikke bygget den, kan du ikke registrere bygget. Be leverandøren om en SBOM, eller bruk binæranalyse.
CycloneDX: ofte stilte spørsmål
Hva brukes CycloneDX til?
Mest til SBOM-er: å liste komponentene i en programvare så du kan spore sårbarheter og lisenser og dele listen med kunder. Det samme formatet dekker også VEX, tjenester, maskinvare, kryptografi og maskinlæringsmodeller.
Hvem vedlikeholder CycloneDX?
OWASP Foundation driver CycloneDX-prosjektet, og Technical Committee 54 i Ecma International publiserer det som standarden ECMA-424.
Hva er siste versjon av CycloneDX?
CycloneDX 1.7, utgitt i oktober 2025. Det er også 2. utgave av ECMA-424, publisert i desember 2025. 1. utgave tilsvarer CycloneDX 1.6.
Er CycloneDX JSON eller XML?
Begge deler, og Protocol Buffers i tillegg. JSON er vanligst, med medietypen application/vnd.cyclonedx+json og filnavn som bom.json eller name.cdx.json.
Er CycloneDX bedre enn SPDX?
Ingen av dem er generelt bedre. CycloneDX startet med sikkerhet og har sårbarheter og VEX innebygd, SPDX startet med lisensetterlevelse og er en ISO-standard. Lag det kundene og verktøyene dine leser; det finnes konverterere begge veier.
Hvordan sjekker jeg at en CycloneDX-fil er gyldig?
Kjør den offisielle CycloneDX CLI: cyclonedx validate --input-file bom.json --fail-on-errors. Den sjekker strukturen mot skjemaet, ikke om noen komponent mangler.
CycloneDX fra selve bygget
Registrer hver pakke GitHub Actions-jobbene dine henter, med en fullstendighetsstatus, og eksporter den som CycloneDX eller SPDX.
Book en demo