SBOM
Vad är CycloneDX?
CycloneDX är en öppen standard för materialförteckningar (bills of materials), som drivs av OWASP Foundation och publiceras av Ecma International som ECMA-424. Den är mest känd som ett SBOM-format: en maskinläsbar lista över komponenterna i en programvara, hur de beror på varandra och vad som är känt om deras sårbarheter. Den aktuella versionen är CycloneDX 1.7, och samma format beskriver även tjänster, hårdvara, kryptografi och maskininlärningsmodeller.
Uppdaterad
CycloneDX i korthet
| Underhålls av | OWASP Foundations CycloneDX-projekt, tillsammans med Ecma Internationals tekniska kommitté 54 (TC54) |
|---|---|
| Standard | ECMA-424. Första utgåvan (juni 2024) är CycloneDX 1.6; andra utgåvan (december 2025) är CycloneDX 1.7 |
| Aktuell version | CycloneDX 1.7, släppt i oktober 2025 |
| Kodningar | JSON, XML och Protocol Buffers |
| Mediatyp | application/vnd.cyclonedx+json, med en versionsparameter som version=1.7 |
| Filnamn | bom.json, bom.xml, *.cdx.json, *.cdx.xml |
Den första versionen, CycloneDX 1.0, kom 2018 som en säkerhetsinriktad materialförteckning. Ecma inrättade TC54 för standarder för leveranskedjan i december 2023, och CycloneDX 1.6 blev ECMA-424 i juni 2024. Specifikationsöversikten och ECMA-424-sidan är de primära referenserna.
Vad en CycloneDX-SBOM innehåller
Ett CycloneDX-dokument är ett enda objekt, oftast kallat en BOM. Bara två fält är obligatoriska, bomFormat (alltid
"CycloneDX") och specVersion. Allt annat är valfritt, och därför kan två giltiga CycloneDX-filer
skilja sig så mycket i vad de faktiskt berättar.
| Element | Vad det innehåller |
|---|---|
metadata |
När och hur BOM:en togs fram: tidsstämpel, verktyg, upphovspersoner, livscykelfasen och komponenten som BOM:en beskriver |
components |
Varje bibliotek, ramverk, container, fil, firmware, enhet eller modell, med version, identifierare, hashvärden och licenser |
services |
Externa tjänster som programvaran anropar, till exempel API:er, med deras slutpunkter och dataflöden |
dependencies |
Vilken komponent eller tjänst som beror på vilken, så att trädet kan återskapas, transitiva led inräknade |
compositions |
Hur komplett varje del av BOM:en är: komplett, ofullständig, okänd eller inte angiven |
vulnerabilities |
Kända sårbarheter, deras bedömningar och, för VEX, om och hur de påverkar produkten |
formulation |
Hur produkten byggdes: arbetsflödena, uppgifterna och miljön bakom den |
annotations |
Kommentarer och anteckningar kopplade till andra delar av BOM:en, med vem som gjorde dem och när |
declarations, definitions, citations |
Intyg om överensstämmelse med standarder, själva standarderna och var data i BOM:en kommer ifrån |
Fältet metadata.lifecycles anger när BOM:en togs fram: design, pre-build, build, post-build,
operations, discovery eller decommission. En SBOM från byggfasen och en skanning efter bygget av samma produkt kan lista olika
komponenter, så fasen spelar roll när du jämför två filer.
BOM-typer i CycloneDX
Samma objektmodell täcker mer än programvara. CycloneDX-projektet listar dessa funktioner:
| Typ | Beskriver |
|---|---|
| SBOM | Programvarukomponenter och deras beroenden |
| SaaSBOM | Tjänster, slutpunkter och dataflöden i en hostad applikation |
| HBOM | Hårdvarukomponenter |
| CBOM | Kryptografiska tillgångar: algoritmer, nycklar, certifikat och protokoll |
| ML-BOM | Maskininlärningsmodeller och dataseten bakom dem |
| OBOM och MBOM | Driftmiljöer och tillverkningen av en produkt |
| VEX, VDR och BOV | Om en sårbarhet påverkar en produkt (VEX), en leverantörs rapport om kända sårbarheter (VDR) och en sårbarhetsförteckning (bill of vulnerabilities) |
| CDXA | Intyg om att en produkt uppfyller en standard eller ett krav |
Det här är användningar av ett och samma format, inte separata format. Ett VEX-dokument är till exempel en CycloneDX-BOM vars
vulnerabilities-poster har en analysstatus och pekar på komponenter i en SBOM.
Identifierare: purl, CPE och hashvärden
En komponents namn räcker inte för att matcha den mot en sårbarhet, eftersom samma namn kan betyda olika paket i
olika ekosystem. CycloneDX-komponenter har identifierare för det: en
package URL (purl) som pkg:npm/[email protected], en CPE, en SWID-tagg,
OmniBOR- och SWHID-identifierare samt kryptografiska hashvärden. Purl är den som de flesta verktyg matchar på för paket med öppen källkod,
och den blev en egen Ecma-standard, ECMA-427, i december 2025. Inne i dokumentet kan varje element också ha en
bom-ref, ett lokalt ID som avsnitten för beroenden, sammansättningar och sårbarheter använder för att peka på det.
Ett JSON-exempel i CycloneDX
En liten men komplett SBOM för en applikation, acme-api, som använder ett npm-paket, debug,
som i sin tur beror på ms. Den validerar mot JSON-schemat för 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"] }
]
}
-
serialNumberochversionidentifierar den här BOM:en. Varje nygenererad BOM får ett nytt serienummer; när en befintlig BOM ändras behåller den serienumret och versionen ökar med ett. -
metadata.componentär produkten som SBOM:en beskriver och roten i beroendeträdet. -
dependenciesgörmstill ett transitivt beroende: applikationen bad aldrig om det, det gjordedebug. En tomdependsOnsäger att komponenten saknar beroenden. Att utelämna en komponent ur grafen betyder att dess beroenden är okända, inte att den saknar beroenden. -
compositionsanger att beroendeträdet underacme-apiär komplett. Ett verktyg som inte kunde se allt bör i stället angeincompleteellerunknown, så att läsaren vet att ett saknat paket inte ska tolkas som frånvarande.
För en större fil med hashvärden, leverantörer och en motsvarande SPDX-version av samma applikation, se SBOM-exempel.
Så tar du fram en CycloneDX-SBOM
Det finns tre sätt att ta fram en, och de beskriver olika saker.
| Metod | Hur den fungerar | Vad den missar |
|---|---|---|
| Skanning av manifest och lockfiler | Läser package-lock.json, requirements.txt, pom.xml och liknande filer |
Allt som hämtas utanför pakethanteraren, till exempel installationsskript, byggskript och basavbilder |
| Analys av avbild, filsystem eller binär | Undersöker en färdig containeravbild, katalog eller binär efter paketmetadata och signaturer | Komponenter som inte lämnat någon metadata efter sig, och kompilerad kod som den måste gissa sig till |
| Registrering under bygget | Registrerar vad bygget faktiskt hämtade medan det körs | Bara det som registreringen inte kan se, vilket en bra registrering anger som ofullständigt |
Gratis verktyg som skriver CycloneDX:
-
cdxgen, ett OWASP-projekt, för många språk och containeravbilder:
cdxgen -o bom.json. Det skriver CycloneDX 1.7 som standard. -
CycloneDX-tilläggen för olika ekosystem, som
@cyclonedx/cyclonedx-npm, cyclonedx-python, CycloneDX Maven-pluginet och cyclonedx-gomod, vart och ett för en pakethanterare:npx @cyclonedx/cyclonedx-npm --output-file bom.json. -
Syft, från Anchore, för containeravbilder och filsystem:
syft <image> -o cyclonedx-json.
CycloneDX Tool Center listar många fler. För hur de här metoderna står sig mot varandra i praktiken, se SBOM-generatorer med öppen källkod och SBOM:er för Docker-avbilder.
Så validerar du en CycloneDX-fil
Det officiella CycloneDX CLI kontrollerar en fil mot schemat för dess version:
cyclonedx validate --input-file bom.json --input-version v1_7 --fail-on-errors
Samma verktyg konverterar mellan JSON, XML och Protocol Buffers, mellan specifikationsversioner och till SPDX JSON, med
cyclonedx convert. Schemavalidering bevisar bara att filen är korrekt formad. Den kan inte säga om en
komponent saknas. För det, kontrollera innehållet mot en lista som
kvalitetschecklistan för SBOM:er.
CycloneDX vs SPDX
SPDX är det andra vanliga SBOM-formatet, som drivs av Linux Foundation och publiceras som ISO/IEC 5962:2021. Det växte fram ur licensefterlevnad, medan CycloneDX utgick från säkerhet, och därför bär CycloneDX sårbarheter och VEX i samma format. Båda beskriver komponenter, identifierare, licenser och relationer, verktyg konverterar mellan dem, och EU:s Cyber Resilience Act nämner inget av dem. Vilket du tar fram beror oftast på vad dina kunder och verktyg läser. Hela jämförelsen finns i CycloneDX vs SPDX.
Så tar CRACI fram CycloneDX-SBOM:er
CRACI är en GitHub Actions-runner som registrerar varje paket som varje jobb hämtar medan det körs, i alla led av beroendeträdet och inklusive paket som återställs från CI-cachar. Varje komponent i SBOM:en fanns alltså faktiskt i bygget. Varje paket har sin purl och sin deklarerade licens, och varje jobbs SBOM har en fullständighetsstatus som anger vad jobbet inte kunde se. SBOM:en exporteras i CycloneDX eller SPDX, med de transitiva beroendena och de sårbarheter som hittats i dess komponenter, och API:t returnerar den som CycloneDX 1.7 JSON. Se SBOM-generering under bygget eller bästa praxis för SBOM:er.
När CRACI inte är svaret
- BOM:er för hårdvara, kryptografi eller tjänster. CRACI registrerar programvarupaket som ett bygge hämtar. En HBOM, CBOM eller SaaSBOM behöver andra källor.
- Byggen utanför GitHub Actions. GitHub Actions är det enda CI-system som stöds i dag; andra CI-system finns på roadmapen. Använd en generator som cdxgen under tiden.
- Programvara du får som en binär. Om du inte byggde den kan du inte registrera dess bygge. Be leverantören om en SBOM, eller använd binäranalys.
CycloneDX: vanliga frågor
Vad används CycloneDX till?
Främst till SBOM:er: att lista komponenterna i en programvara så att du kan följa sårbarheter och licenser och dela listan med kunder. Samma format täcker också VEX, tjänster, hårdvara, kryptografi och maskininlärningsmodeller.
Vem underhåller CycloneDX?
OWASP Foundation driver CycloneDX-projektet, och Ecma Internationals tekniska kommitté 54 publicerar det som standarden ECMA-424.
Vilken är den senaste versionen av CycloneDX?
CycloneDX 1.7, släppt i oktober 2025. Den är också andra utgåvan av ECMA-424, publicerad i december 2025. Första utgåvan motsvarar CycloneDX 1.6.
Är CycloneDX JSON eller XML?
Både och, och även Protocol Buffers. JSON är vanligast, med mediatypen application/vnd.cyclonedx+json och filnamn som bom.json eller name.cdx.json.
Är CycloneDX bättre än SPDX?
Inget av dem är bättre generellt. CycloneDX utgick från säkerhet och bär sårbarheter och VEX inbyggt, SPDX från licensefterlevnad och är en ISO-standard. Ta fram det som dina kunder och verktyg läser; det finns konverterare åt båda hållen.
Hur kontrollerar jag att en CycloneDX-fil är giltig?
Kör det officiella CycloneDX CLI: cyclonedx validate --input-file bom.json --fail-on-errors. Det kontrollerar strukturen mot schemat, inte om någon komponent saknas.
CycloneDX direkt från bygget
Registrera varje paket som dina GitHub Actions-jobb hämtar, med en fullständighetsstatus, och exportera det i CycloneDX eller SPDX.
Boka en demo