SBOM
Mis on CycloneDX?
CycloneDX on avatud standard koostenimekirjade (bill of materials) jaoks, mida haldab OWASP Foundation ja mille Ecma International on avaldanud standardina ECMA-424. Kõige tuntum on see SBOM-i vormingu poolest: masinloetav loend tarkvara komponentidest, sellest, kuidas need üksteisest sõltuvad, ja sellest, mida nende haavatavuste kohta teatakse. Praegune versioon on CycloneDX 1.7 ning sama vorming kirjeldab ka teenuseid, riistvara, krüptograafiat ja masinõppemudeleid.
Uuendatud
CycloneDX lühidalt
| Haldaja | OWASP Foundationi CycloneDX-i projekt koos Ecma Internationali tehnilise komiteega 54 (TC54) |
|---|---|
| Standard | ECMA-424. 1. väljaanne (juuni 2024) on CycloneDX 1.6; 2. väljaanne (detsember 2025) on CycloneDX 1.7 |
| Praegune versioon | CycloneDX 1.7, avaldatud oktoobris 2025 |
| Kodeeringud | JSON, XML ja Protocol Buffers |
| Meediatüüp | application/vnd.cyclonedx+json, versiooniparameetriga, näiteks version=1.7 |
| Failinimed | bom.json, bom.xml, *.cdx.json, *.cdx.xml |
Esimene versioon, CycloneDX 1.0, ilmus 2018. aastal turvalisusele keskenduva koostenimekirjana. Ecma asutas TC54 tarneahela standardite jaoks 2023. aasta detsembris ja CycloneDX 1.6-st sai ECMA-424 2024. aasta juunis. Spetsifikatsiooni ülevaade ja ECMA-424 leht on peamised allikad.
Mida CycloneDX-i SBOM sisaldab
CycloneDX-i dokument on üks objekt, mida tavaliselt nimetatakse BOM-iks. Kohustuslikud on ainult kaks välja,
bomFormat (alati "CycloneDX") ja specVersion. Kõik muu on valikuline, mistõttu
võivad kaks kehtivat CycloneDX-i faili selle poolest, mida need tegelikult ütlevad, nii palju erineda.
| Element | Mida see sisaldab |
|---|---|
metadata |
Millal ja kuidas BOM loodi: ajatempel, tööriistad, autorid, elutsükli faas ja komponent, mida BOM kirjeldab |
components |
Iga teek, raamistik, konteiner, fail, püsivara, seade või mudel koos versiooni, identifikaatorite, räsiväärtuste ja litsentsidega |
services |
Välised teenused, mida tarkvara kasutab, näiteks API-d, koos nende otspunktide ja andmevoogudega |
dependencies |
Milline komponent või teenus millest sõltub, nii et puu saab uuesti üles ehitada, transitiivsed tasemed kaasa arvatud |
compositions |
Kui täielik on BOM-i iga osa: complete, incomplete, unknown või not specified |
vulnerabilities |
Teadaolevad haavatavused, nende hinnangud ja VEX-i puhul see, kas ja kuidas need toodet mõjutavad |
formulation |
Kuidas toode ehitati: selle taga olevad töövood, ülesanded ja keskkond |
annotations |
BOM-i teistele osadele lisatud kommentaarid ja märkused koos sellega, kes need tegi ja millal |
declarations, definitions, citations |
Kinnitused standarditele vastavuse kohta, standardid ise ja see, kust BOM-i andmed pärinevad |
Väli metadata.lifecycles ütleb, millal BOM loodi: design, pre-build, build, post-build,
operations, discovery või decommission. Sama toote buildi faasi SBOM ja buildi järgne skannimine võivad loetleda erinevaid
komponente, nii et kahe faili võrdlemisel on faas oluline.
CycloneDX-i BOM-i tüübid
Sama objektimudel katab enamat kui tarkvara. CycloneDX-i projekt loetleb järgmised võimekused:
| Tüüp | Kirjeldab |
|---|---|
| SBOM | Tarkvara komponendid ja nende sõltuvused |
| SaaSBOM | Majutatud rakenduse teenused, otspunktid ja andmevood |
| HBOM | Riistvarakomponendid |
| CBOM | Krüptograafilised varad: algoritmid, võtmed, sertifikaadid ja protokollid |
| ML-BOM | Masinõppemudelid ja nende taga olevad andmekogumid |
| OBOM ja MBOM | Töökeskkonnad ja toote tootmine |
| VEX, VDR ja BOV | Kas haavatavus mõjutab toodet (VEX), tarnija aruanne teadaolevatest haavatavustest (VDR) ja haavatavuste nimekiri (BOV) |
| CDXA | Kinnitused, et toode vastab standardile või nõudele |
Need on ühe vormingu kasutusviisid, mitte eraldi vormingud. Näiteks VEX-dokument on CycloneDX-i BOM, mille
vulnerabilities kirjetel on analüüsi olek ja mis viitavad SBOM-i komponentidele.
Identifikaatorid: purl, CPE ja räsiväärtused
Komponendi nimest ei piisa, et seda haavatavusega siduda, sest sama nimi võib eri ökosüsteemides tähendada eri pakette.
Selleks kannavad CycloneDX-i komponendid identifikaatoreid: paketi URL (purl), näiteks
pkg:npm/[email protected], CPE, SWID-silt, OmniBOR- ja SWHID-identifikaatorid ning krüptograafilised räsiväärtused.
Purl on see, mille järgi enamik tööriistu avatud lähtekoodiga pakette sobitab, ja sellest sai 2025. aasta detsembris omaette
Ecma standard, ECMA-427. Dokumendi sees võib igal elemendil olla ka bom-ref, kohalik ID, mille abil sõltuvuste,
koosseisude ja haavatavuste jaotised sellele viitavad.
CycloneDX-i JSON-näide
Väike, kuid täielik SBOM rakendusele acme-api, mis kasutab üht npm-i paketti, debug,
mis omakorda sõltub paketist ms. See valideerub CycloneDX 1.7 JSON-skeemi vastu.
{
"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"] }
]
}
-
serialNumberjaversionidentifitseerivad selle BOM-i. Iga uus loodud BOM saab uue seerianumbri; kui olemasolevat BOM-i muudetakse, jääb seerianumber samaks ja versioon suureneb ühe võrra. -
metadata.componenton toode, mida SBOM kirjeldab, ja sõltuvuspuu juur. -
dependenciesteeb paketistmstransitiivse sõltuvuse: rakendus ei küsinud seda kunagi, seda küsisdebug. TühidependsOnütleb, et komponendil pole sõltuvusi. Komponendi graafist väljajätmine tähendab, et selle sõltuvused on teadmata, mitte et neid pole. -
compositionsteatab, et sõltuvuspuuacme-apiall on täielik. Tööriist, mis ei näinud kõike, peaks selle asemel ütlemaincompletevõiunknown, et lugeja teaks puuduvat paketti mitte käsitleda olematuna.
Suurema faili koos räsiväärtuste, tarnijate ja sama rakenduse vastava SPDX-versiooniga leiate lehelt SBOM-i näited.
Kuidas luua CycloneDX-i SBOM-i
Selle tootmiseks on kolm viisi ja need kirjeldavad eri asju.
| Meetod | Kuidas see töötab | Mis jääb märkamata |
|---|---|---|
| Manifesti ja lukufaili skannimine | Loeb faile package-lock.json, requirements.txt, pom.xml ja muid sarnaseid |
Kõik, mis laaditi alla paketihaldurist mööda, näiteks installiskriptid, buildiskriptid ja baastõmmised |
| Tõmmise, failisüsteemi või binaarfaili analüüs | Uurib valmis konteineritõmmist, kataloogi või binaarfaili paketi metaandmete ja signatuuride leidmiseks | Komponendid, millest pole metaandmeid maha jäänud, ja kompileeritud kood, mida tuleb ära arvata |
| Buildi ajal salvestamine | Salvestab buildi töötamise ajal, mida build tegelikult alla laadis | Ainult see, mida salvestaja ei näe, ja hea salvestaja märgib selle puudulikuks (incomplete) |
Tasuta tööriistad, mis kirjutavad CycloneDX-i:
-
cdxgen, OWASP-i projekt, paljude keelte ja konteineritõmmiste jaoks:
cdxgen -o bom.json. Vaikimisi kirjutab see CycloneDX 1.7. -
CycloneDX-i ökosüsteemi pistikprogrammid, näiteks
@cyclonedx/cyclonedx-npm, cyclonedx-python, CycloneDX-i Maveni pistikprogramm ja cyclonedx-gomod, igaüks ühe paketihalduri jaoks:npx @cyclonedx/cyclonedx-npm --output-file bom.json. -
Syft Anchore'ilt konteineritõmmiste ja failisüsteemide jaoks:
syft <image> -o cyclonedx-json.
CycloneDX-i Tool Center loetleb palju rohkem. Kuidas need lähenemised praktikas võrdlevad, vaadake avatud lähtekoodiga SBOM-i generaatorid ja Dockeri tõmmiste SBOM-id.
Kuidas CycloneDX-i faili valideerida
Ametlik CycloneDX CLI kontrollib faili selle versiooni skeemi vastu:
cyclonedx validate --input-file bom.json --input-version v1_7 --fail-on-errors
Sama tööriist teisendab käsuga cyclonedx convert JSON-i, XML-i ja Protocol Buffersi vahel, spetsifikatsiooni
versioonide vahel ning SPDX JSON-iks. Skeemi valideerimine tõestab ainult, et fail on korrektselt vormistatud. See ei
ütle, kas mõni komponent puudub. Selleks kontrollige sisu sellise loendi vastu nagu
SBOM-i kvaliteedi kontroll-loend.
CycloneDX vs SPDX
SPDX on teine laialt kasutatav SBOM-i vorming, mida haldab Linux Foundation ja mis on avaldatud standardina ISO/IEC 5962:2021. See kasvas välja litsentsinõuetele vastavusest, CycloneDX aga sai alguse turvalisusest, mistõttu kannab CycloneDX haavatavusi ja VEX-i samas vormingus. Mõlemad kirjeldavad komponente, identifikaatoreid, litsentse ja seoseid, tööriistad teisendavad nende vahel ning ELi küberkerksuse määrus (Cyber Resilience Act, CRA) ei nimeta kumbagi. See, kumba toodate, sõltub tavaliselt sellest, mida teie kliendid ja tööriistad loevad. Täielik võrdlus on lehel CycloneDX vs SPDX.
Kuidas CRACI CycloneDX-i SBOM-e toodab
CRACI on GitHub Actionsi runner, mis salvestab iga paketi, mille iga töö oma töötamise ajal alla laadib, sõltuvuspuu igal sügavusel ja sealhulgas CI vahemäludest taastatud paketid. Seega oli iga SBOM-i komponent tegelikult buildis. Iga pakett kannab oma purl-i ja deklareeritud litsentsi ning iga töö SBOM-il on täielikkuse olek, mis ütleb, mida töö ei näinud. SBOM eksporditakse CycloneDX- või SPDX-vormingus koos transitiivsete sõltuvuste ja selle komponentidest leitud haavatavustega ning API tagastab selle CycloneDX 1.7 JSON-ina. Vaadake SBOM-i genereerimine buildi ajal või SBOM-i parimad tavad.
Millal CRACI ei ole lahendus
- Riistvara, krüptograafia või teenuste BOM-id. CRACI salvestab tarkvarapakette, mille build alla laadib. HBOM, CBOM või SaaSBOM vajab muid allikaid.
- Buildid väljaspool GitHub Actionsit. GitHub Actions on praegu ainus toetatud CI; teised CI-süsteemid on arenduskavas. Seni kasutage generaatorit, näiteks cdxgen.
- Tarkvara, mille saate binaarfailina. Kui te seda ise ei ehitanud, ei saa te selle buildi salvestada. Küsige tarnijalt SBOM-i või kasutage binaarfaili analüüsi.
CycloneDX: korduma kippuvad küsimused
Milleks CycloneDX-i kasutatakse?
Peamiselt SBOM-ide jaoks: tarkvara komponentide loetlemiseks, et saaksite jälgida haavatavusi ja litsentse ning jagada loendit klientidega. Sama vorming katab ka VEX-i, teenuseid, riistvara, krüptograafiat ja masinõppemudeleid.
Kes CycloneDX-i haldab?
CycloneDX-i projekti juhib OWASP Foundation ning Ecma Internationali tehniline komitee 54 avaldab selle standardina ECMA-424.
Milline on CycloneDX-i uusim versioon?
CycloneDX 1.7, avaldatud oktoobris 2025. See on ühtlasi ECMA-424 2. väljaanne, mis avaldati detsembris 2025. 1. väljaanne vastab versioonile CycloneDX 1.6.
Kas CycloneDX on JSON või XML?
Mõlemad ja lisaks Protocol Buffers. Kõige levinum on JSON, meediatüübiga application/vnd.cyclonedx+json ja failinimedega nagu bom.json või name.cdx.json.
Kas CycloneDX on parem kui SPDX?
Kumbki pole üldiselt parem. CycloneDX sai alguse turvalisusest ning kannab haavatavusi ja VEX-i natiivselt, SPDX sai alguse litsentsinõuetele vastavusest ja on ISO standard. Tootke seda, mida teie kliendid ja tööriistad loevad; teisendajad on olemas mõlemas suunas.
Kuidas kontrollida, et CycloneDX-i fail on kehtiv?
Käitage ametlikku CycloneDX CLI-d: cyclonedx validate --input-file bom.json --fail-on-errors. See kontrollib struktuuri skeemi vastu, mitte seda, kas mõni komponent puudub.
CycloneDX otse buildist
Salvestage iga pakett, mille teie GitHub Actionsi tööd alla laadivad, koos täielikkuse olekuga ja eksportige see CycloneDX- või SPDX-vormingus.
Broneerige demo