From 39737a28259dbe10a214eab9cfbc8172a6bfebb7 Mon Sep 17 00:00:00 2001 From: Sambhav Kothari Date: Tue, 8 Mar 2022 17:09:55 +0000 Subject: [PATCH] Update cyclonedx to v1.4 (#820) --- cmd/attest.go | 6 +- go.mod | 2 +- go.sum | 8 +- .../decoder_test.go | 2 +- .../encoder.go | 2 +- .../encoder_test.go | 2 +- .../format.go | 2 +- .../test-fixtures/image-simple/Dockerfile | 0 .../test-fixtures/image-simple/file-1.txt | 0 .../test-fixtures/image-simple/file-2.txt | 0 .../TestCycloneDxDirectoryEncoder.golden | 9 +- .../snapshot/TestCycloneDxImageEncoder.golden | 12 +- .../stereoscope-fixture-image-simple.golden | Bin 15360 -> 15360 bytes .../decoder_test.go | 2 +- .../encoder.go | 2 +- .../encoder_test.go | 2 +- .../format.go | 2 +- .../test-fixtures/image-simple/Dockerfile | 0 .../test-fixtures/image-simple/file-1.txt | 0 .../test-fixtures/image-simple/file-2.txt | 0 .../TestCycloneDxDirectoryEncoder.golden | 5 +- .../snapshot/TestCycloneDxImageEncoder.golden | 10 +- .../stereoscope-fixture-image-simple.golden | Bin 15360 -> 15360 bytes schema/cyclonedx/Makefile | 2 +- schema/cyclonedx/bom-1.3.schema.json | 1054 ---- schema/cyclonedx/cyclonedx.json | 1697 ++++++ schema/cyclonedx/cyclonedx.xsd | 874 ++- schema/cyclonedx/spdx.xsd | 4710 +++++++++-------- syft/formats.go | 16 +- syft/formats_test.go | 21 +- test/integration/encode_decode_cycle_test.go | 13 +- 31 files changed, 5002 insertions(+), 3453 deletions(-) rename internal/formats/{cyclonedx13json => cyclonedxjson}/decoder_test.go (98%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/encoder.go (94%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/encoder_test.go (98%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/format.go (94%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/test-fixtures/image-simple/Dockerfile (100%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/test-fixtures/image-simple/file-1.txt (100%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/test-fixtures/image-simple/file-2.txt (100%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden (92%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden (88%) rename internal/formats/{cyclonedx13json => cyclonedxjson}/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden (78%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/decoder_test.go (98%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/encoder.go (94%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/encoder_test.go (98%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/format.go (94%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/test-fixtures/image-simple/Dockerfile (100%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/test-fixtures/image-simple/file-1.txt (100%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/test-fixtures/image-simple/file-2.txt (100%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden (91%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden (81%) rename internal/formats/{cyclonedx13xml => cyclonedxxml}/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden (78%) delete mode 100644 schema/cyclonedx/bom-1.3.schema.json create mode 100644 schema/cyclonedx/cyclonedx.json diff --git a/cmd/attest.go b/cmd/attest.go index 8cb4e88b2..b2e0e9ff3 100644 --- a/cmd/attest.go +++ b/cmd/attest.go @@ -9,7 +9,7 @@ import ( "os" "strings" - "github.com/anchore/syft/internal/formats/cyclonedx13json" + "github.com/anchore/syft/internal/formats/cyclonedxjson" "github.com/anchore/syft/internal/formats/spdx22json" "github.com/anchore/syft/internal/formats/syftjson" @@ -56,7 +56,7 @@ const ( var attestFormats = []sbom.FormatID{ syftjson.ID, spdx22json.ID, - cyclonedx13json.ID, + cyclonedxjson.ID, } var ( @@ -227,7 +227,7 @@ func formatPredicateType(format sbom.Format) string { switch format.ID() { case spdx22json.ID: return in_toto.PredicateSPDX - case cyclonedx13json.ID: + case cyclonedxjson.ID: // Tentative see https://github.com/in-toto/attestation/issues/82 return "https://cyclonedx.org/bom" case syftjson.ID: diff --git a/go.mod b/go.mod index c5a5406da..f01375d68 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/anchore/syft go 1.17 require ( - github.com/CycloneDX/cyclonedx-go v0.4.0 + github.com/CycloneDX/cyclonedx-go v0.5.0 github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d github.com/acobaugh/osrelease v0.1.0 github.com/adrg/xdg v0.2.1 diff --git a/go.sum b/go.sum index 53f85381d..90b755a1a 100644 --- a/go.sum +++ b/go.sum @@ -186,8 +186,8 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03 github.com/BurntSushi/toml v0.4.1 h1:GaI7EiDXDRfa8VshkTj7Fym7ha+y8/XxIgD2okUIjLw= github.com/BurntSushi/toml v0.4.1/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ= github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= -github.com/CycloneDX/cyclonedx-go v0.4.0 h1:Wz4QZ9B4RXGWIWTypVLEOVJgOdFfy5mcS5PGNzUkZxU= -github.com/CycloneDX/cyclonedx-go v0.4.0/go.mod h1:rmRcf//gT7PIzovatusbWi377xqCg1FS4jyST0GH20E= +github.com/CycloneDX/cyclonedx-go v0.5.0 h1:RWCnu2OrWUTF5C9DA3L0qVziUD2HlxSUWcL2OXlxfqE= +github.com/CycloneDX/cyclonedx-go v0.5.0/go.mod h1:nQXAzrejxO39b14JFz2SvsUElegYfwBDowIzqjdUMk4= github.com/DataDog/datadog-go v3.2.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ= github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24/go.mod h1:4UJr5HIiMZrwgkSPdsjy2uOQExX/WEILpIrO9UPGuXs= github.com/GoogleCloudPlatform/cloudsql-proxy v0.0.0-20191009163259-e802c2cb94ae/go.mod h1:mjwGPas4yKduTyubHvD1Atl9r1rUq8DfVy+gkVvZ+oo= @@ -436,8 +436,8 @@ github.com/bmizerany/perks v0.0.0-20141205001514-d9a9656a3a4b/go.mod h1:ac9efd0D github.com/bombsimon/wsl/v3 v3.3.0/go.mod h1:st10JtZYLE4D5sC7b8xV4zTKZwAQjCH/Hy2Pm1FNZIc= github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA= github.com/bradleyfalzon/ghinstallation/v2 v2.0.3/go.mod h1:tlgi+JWCXnKFx/Y4WtnDbZEINo31N5bcvnCoqieefmk= -github.com/bradleyjkemp/cupaloy/v2 v2.6.0 h1:knToPYa2xtfg42U3I6punFEjaGFKWQRXJwj0JTv4mTs= -github.com/bradleyjkemp/cupaloy/v2 v2.6.0/go.mod h1:bm7JXdkRd4BHJk9HpwqAI8BoAY1lps46Enkdqw6aRX0= +github.com/bradleyjkemp/cupaloy/v2 v2.7.0 h1:AT0vOjO68RcLyenLCHOGZzSNiuto7ziqzq6Q1/3xzMQ= +github.com/bradleyjkemp/cupaloy/v2 v2.7.0/go.mod h1:bm7JXdkRd4BHJk9HpwqAI8BoAY1lps46Enkdqw6aRX0= github.com/breml/bidichk v0.1.1/go.mod h1:zbfeitpevDUGI7V91Uzzuwrn4Vls8MoBMrwtt78jmso= github.com/bshuster-repo/logrus-logstash-hook v0.4.1/go.mod h1:zsTqEiSzDgAa/8GZR7E1qaXrhYNDKBYy5/dWPTIflbk= github.com/buger/jsonparser v0.0.0-20180808090653-f4dd9f5a6b44/go.mod h1:bbYlZJ7hK1yFx9hf58LP0zeX7UjIGs20ufpu3evjr+s= diff --git a/internal/formats/cyclonedx13json/decoder_test.go b/internal/formats/cyclonedxjson/decoder_test.go similarity index 98% rename from internal/formats/cyclonedx13json/decoder_test.go rename to internal/formats/cyclonedxjson/decoder_test.go index b1d038913..e561ff137 100644 --- a/internal/formats/cyclonedx13json/decoder_test.go +++ b/internal/formats/cyclonedxjson/decoder_test.go @@ -1,4 +1,4 @@ -package cyclonedx13json +package cyclonedxjson import ( "fmt" diff --git a/internal/formats/cyclonedx13json/encoder.go b/internal/formats/cyclonedxjson/encoder.go similarity index 94% rename from internal/formats/cyclonedx13json/encoder.go rename to internal/formats/cyclonedxjson/encoder.go index b405a2ca2..aa8302915 100644 --- a/internal/formats/cyclonedx13json/encoder.go +++ b/internal/formats/cyclonedxjson/encoder.go @@ -1,4 +1,4 @@ -package cyclonedx13json +package cyclonedxjson import ( "io" diff --git a/internal/formats/cyclonedx13json/encoder_test.go b/internal/formats/cyclonedxjson/encoder_test.go similarity index 98% rename from internal/formats/cyclonedx13json/encoder_test.go rename to internal/formats/cyclonedxjson/encoder_test.go index f971a5b07..06ad8293c 100644 --- a/internal/formats/cyclonedx13json/encoder_test.go +++ b/internal/formats/cyclonedxjson/encoder_test.go @@ -1,4 +1,4 @@ -package cyclonedx13json +package cyclonedxjson import ( "flag" diff --git a/internal/formats/cyclonedx13json/format.go b/internal/formats/cyclonedxjson/format.go similarity index 94% rename from internal/formats/cyclonedx13json/format.go rename to internal/formats/cyclonedxjson/format.go index d33c703dc..980212091 100644 --- a/internal/formats/cyclonedx13json/format.go +++ b/internal/formats/cyclonedxjson/format.go @@ -1,4 +1,4 @@ -package cyclonedx13json +package cyclonedxjson import ( "github.com/CycloneDX/cyclonedx-go" diff --git a/internal/formats/cyclonedx13json/test-fixtures/image-simple/Dockerfile b/internal/formats/cyclonedxjson/test-fixtures/image-simple/Dockerfile similarity index 100% rename from internal/formats/cyclonedx13json/test-fixtures/image-simple/Dockerfile rename to internal/formats/cyclonedxjson/test-fixtures/image-simple/Dockerfile diff --git a/internal/formats/cyclonedx13json/test-fixtures/image-simple/file-1.txt b/internal/formats/cyclonedxjson/test-fixtures/image-simple/file-1.txt similarity index 100% rename from internal/formats/cyclonedx13json/test-fixtures/image-simple/file-1.txt rename to internal/formats/cyclonedxjson/test-fixtures/image-simple/file-1.txt diff --git a/internal/formats/cyclonedx13json/test-fixtures/image-simple/file-2.txt b/internal/formats/cyclonedxjson/test-fixtures/image-simple/file-2.txt similarity index 100% rename from internal/formats/cyclonedx13json/test-fixtures/image-simple/file-2.txt rename to internal/formats/cyclonedxjson/test-fixtures/image-simple/file-2.txt diff --git a/internal/formats/cyclonedx13json/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden b/internal/formats/cyclonedxjson/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden similarity index 92% rename from internal/formats/cyclonedx13json/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden rename to internal/formats/cyclonedxjson/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden index 9b39e40d7..3063fdd1c 100644 --- a/internal/formats/cyclonedx13json/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden +++ b/internal/formats/cyclonedxjson/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden @@ -1,10 +1,10 @@ { "bomFormat": "CycloneDX", - "specVersion": "1.3", - "serialNumber": "urn:uuid:195a66a2-6d39-472e-b62b-0cafb9bfedd4", + "specVersion": "1.4", + "serialNumber": "urn:uuid:498e659b-0758-4a7f-816e-91bee18df634", "version": 1, "metadata": { - "timestamp": "2022-02-25T12:54:25-05:00", + "timestamp": "2022-03-08T12:30:39Z", "tools": [ { "vendor": "anchore", @@ -15,8 +15,7 @@ "component": { "bom-ref": "163686ac6e30c752", "type": "file", - "name": "/some/path", - "version": "" + "name": "/some/path" } }, "components": [ diff --git a/internal/formats/cyclonedx13json/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden b/internal/formats/cyclonedxjson/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden similarity index 88% rename from internal/formats/cyclonedx13json/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden rename to internal/formats/cyclonedxjson/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden index 0295718a2..62f5871eb 100644 --- a/internal/formats/cyclonedx13json/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden +++ b/internal/formats/cyclonedxjson/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden @@ -1,10 +1,10 @@ { "bomFormat": "CycloneDX", - "specVersion": "1.3", - "serialNumber": "urn:uuid:78116a1b-b709-4734-8411-d0e339308edd", + "specVersion": "1.4", + "serialNumber": "urn:uuid:342c3d2c-d26e-47b6-94d6-92fbf41da945", "version": 1, "metadata": { - "timestamp": "2022-02-25T12:54:25-05:00", + "timestamp": "2022-03-08T12:30:39Z", "tools": [ { "vendor": "anchore", @@ -13,7 +13,7 @@ } ], "component": { - "bom-ref": "4f9453fd20e0cf80", + "bom-ref": "711095b1cdf90cce", "type": "container", "name": "user-image-input", "version": "sha256:2731251dc34951c0e50fcc643b4c5f74922dad1a5d98f302b504cf46cd5d9368" @@ -52,7 +52,7 @@ }, { "name": "syft:location:0:layerID", - "value": "sha256:41e7295da66c405eb3a4df29188dcf80f622f9304d487033a86d4a22e3f01abe" + "value": "sha256:16e64541f2ddf59a90391ce7bb8af90313f7d373f2105d88f3d3267b72e0ebab" }, { "name": "syft:location:0:path", @@ -81,7 +81,7 @@ }, { "name": "syft:location:0:layerID", - "value": "sha256:68a2c166dcb3acf6b7303e995ca1fe7d794bd3b5852a0b4048f9c96b796086aa" + "value": "sha256:de6c235f76ea24c8503ec08891445b5d6a8bdf8249117ed8d8b0b6fb3ebe4f67" }, { "name": "syft:location:0:path", diff --git a/internal/formats/cyclonedx13json/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden b/internal/formats/cyclonedxjson/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden similarity index 78% rename from internal/formats/cyclonedx13json/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden rename to internal/formats/cyclonedxjson/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden index afbd18d5a138193f379091613e3f16239e26ca8a..c483fa49b75941b2cfb6a6819ff94a681f25ee41 100644 GIT binary patch literal 15360 zcmeHOZExE)5ccQ&3Xl7m*nFpCU>~xkKnoO0(Pka6pa>|wBwB6BkmRC4kpI4u>^N?+ zMoXlq8A`!`M3Fq5?szos;UhwsawN7!<0N9G_Y)S?;cIte-{TyY9lK0QOTOY|x)t4uE(r~oYv^93}xDgRNrVqJ4kRoa}tuWXv3 znb-5u?V;_xd{y1O=?dt&X?a{-Y_E@&F8f+eQ##5FD6wh(GW(2X*=j!DLoXKaM(fMh z3w^dx^g}*hEnInB^JiXsO0%=WbffLdtST;+d76P<>%K?XZ>w~^74=3ZZocV$wTE)J zMDsLTeL+_(vD9~USI1B1`oa~HdJXl>qb2_N-Sr<)M1}bOra^nGDD#E$>D=v;N%f`b zQSgqa7XM>R<#ztZoQyCbip${t9TPs;Wp$pG<9Yy$&viMjr)ZZ|<&!-w2o4qq76=vy z7I-EWkXR;>QJOjuMLGc>kW#?ll#rO}NXN`L>ZPLE8N%UAW9PMHF&D;L?a342f1pFa z|ArVMo&Enb_#X}V{}A3EjYz=%hB5RreM;x}?~eb~8$a9pZ@vFR2n+cCAR}gj|8*S( z0NyQi0jXo(SR#eZ$9+O;ERoO|VKdGq91|839x%oGFvb4`#(IL@9vr{=b-F5x={z@j zJ}r|po9&dh#hZ%e*18Cn=;LER+9?d!hoZE)Fz0FIOtmU%7+5c?qS?n;^+;|qdNe}ryWq0_0 zkoJZ3-w>nc5`81Bxyc_JHcU^M+E+}OItlxV7z0$88x~PZ<`4VURbBwE=j5`b6XQ%W zP8+yj%~3i{pdUIoJZyHp*VKpcbh{L8s1V~{#z{@t`IJ_mrpXtJHM((qb7FJz$rbhb zY4RDPtGzZgc2SFeRijyf@2IgZKTr+GhIbOuJyhg*<$+#wiK>fbowhc7of2Njrrw{X z7V1t=d9JCDGa{Yjf)fuEZ!cmUW58LAQ%MqO4+X-!vP>~g2^KbrJhO~Sl_=`4OLPKK zH?k!Nsqw!zH3zYITz_;%c#rJBV1ZzP JV1eE(@DIZvjQs!r literal 15360 zcmeHOZBN@s5YFfO6*=EmlFYu^8|gl91*w&)qiVUHbO@pKdKY{oc4Rvh2=U)zZH~k(Dwgt z41w16|8JRRE3RpU{S!f#{XYT5z5TC%buG;w~C*sQ8$#W6R+g`fo( zp2U{RL~#SoM%1xTOUj&5nhR$LKIg$|&M^4UCNUDj4u-N!VRdDjg#jf!LVKVNNjL;G z6wv29Vj(4z{8M+$vr4C#El%*vrKiF0DtMolRi?)l7lS?a@-cR}EB{s6V%D--Roa|= zsgg7chE9)4yA#~jx4&*y(Pf2Xw8|7P;P9EgwqH?RFp$LD{yf%4m( zqqY6F&;Np?FwAb1=C44cDeYM;u~zG4Egwf%1-|3`_C z{`tQR2XLGJBd?kNlMnNM$p6^No9UnY{eN|qmfboD*gezbZ5nVJcb=caBj6G62zUfu z69FYyq!pElktm8oDHSlVU?VN!SVUpOVhO^5AtKgD&rDoQRBRNBj5ZOde*66&p?rD& z2gn8W&;M=Q7gxa}q=q{-O~YGR6HjA-(^69~7APz=Y32KwKNz`Gd4U|9qpMZJDC3e) zp_*;zY=)B9f? z2(EWlE@XkZ^uG&f-oxKp$gKR#g&-s5-kx$NDDu2=$Wplqs>?}DU1@f0C0@>I+DO;HFu%Tjn-;VHr!RN}JOUnp I9|nQ{0PKm6EdT%j diff --git a/internal/formats/cyclonedx13xml/decoder_test.go b/internal/formats/cyclonedxxml/decoder_test.go similarity index 98% rename from internal/formats/cyclonedx13xml/decoder_test.go rename to internal/formats/cyclonedxxml/decoder_test.go index 30f5c1bf1..7a6643339 100644 --- a/internal/formats/cyclonedx13xml/decoder_test.go +++ b/internal/formats/cyclonedxxml/decoder_test.go @@ -1,4 +1,4 @@ -package cyclonedx13xml +package cyclonedxxml import ( "fmt" diff --git a/internal/formats/cyclonedx13xml/encoder.go b/internal/formats/cyclonedxxml/encoder.go similarity index 94% rename from internal/formats/cyclonedx13xml/encoder.go rename to internal/formats/cyclonedxxml/encoder.go index 95a54c301..315fcd0c2 100644 --- a/internal/formats/cyclonedx13xml/encoder.go +++ b/internal/formats/cyclonedxxml/encoder.go @@ -1,4 +1,4 @@ -package cyclonedx13xml +package cyclonedxxml import ( "io" diff --git a/internal/formats/cyclonedx13xml/encoder_test.go b/internal/formats/cyclonedxxml/encoder_test.go similarity index 98% rename from internal/formats/cyclonedx13xml/encoder_test.go rename to internal/formats/cyclonedxxml/encoder_test.go index b2c68701b..5c4129aa7 100644 --- a/internal/formats/cyclonedx13xml/encoder_test.go +++ b/internal/formats/cyclonedxxml/encoder_test.go @@ -1,4 +1,4 @@ -package cyclonedx13xml +package cyclonedxxml import ( "flag" diff --git a/internal/formats/cyclonedx13xml/format.go b/internal/formats/cyclonedxxml/format.go similarity index 94% rename from internal/formats/cyclonedx13xml/format.go rename to internal/formats/cyclonedxxml/format.go index 24a8fe3dc..07ac3ad29 100644 --- a/internal/formats/cyclonedx13xml/format.go +++ b/internal/formats/cyclonedxxml/format.go @@ -1,4 +1,4 @@ -package cyclonedx13xml +package cyclonedxxml import ( "github.com/CycloneDX/cyclonedx-go" diff --git a/internal/formats/cyclonedx13xml/test-fixtures/image-simple/Dockerfile b/internal/formats/cyclonedxxml/test-fixtures/image-simple/Dockerfile similarity index 100% rename from internal/formats/cyclonedx13xml/test-fixtures/image-simple/Dockerfile rename to internal/formats/cyclonedxxml/test-fixtures/image-simple/Dockerfile diff --git a/internal/formats/cyclonedx13xml/test-fixtures/image-simple/file-1.txt b/internal/formats/cyclonedxxml/test-fixtures/image-simple/file-1.txt similarity index 100% rename from internal/formats/cyclonedx13xml/test-fixtures/image-simple/file-1.txt rename to internal/formats/cyclonedxxml/test-fixtures/image-simple/file-1.txt diff --git a/internal/formats/cyclonedx13xml/test-fixtures/image-simple/file-2.txt b/internal/formats/cyclonedxxml/test-fixtures/image-simple/file-2.txt similarity index 100% rename from internal/formats/cyclonedx13xml/test-fixtures/image-simple/file-2.txt rename to internal/formats/cyclonedxxml/test-fixtures/image-simple/file-2.txt diff --git a/internal/formats/cyclonedx13xml/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden b/internal/formats/cyclonedxxml/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden similarity index 91% rename from internal/formats/cyclonedx13xml/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden rename to internal/formats/cyclonedxxml/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden index 233d71875..3e416a26e 100644 --- a/internal/formats/cyclonedx13xml/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden +++ b/internal/formats/cyclonedxxml/test-fixtures/snapshot/TestCycloneDxDirectoryEncoder.golden @@ -1,7 +1,7 @@ - + - 2022-02-25T12:54:44-05:00 + 2022-03-08T12:30:33Z anchore @@ -11,7 +11,6 @@ /some/path - diff --git a/internal/formats/cyclonedx13xml/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden b/internal/formats/cyclonedxxml/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden similarity index 81% rename from internal/formats/cyclonedx13xml/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden rename to internal/formats/cyclonedxxml/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden index 221b2b6e9..5d1b9dae4 100644 --- a/internal/formats/cyclonedx13xml/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden +++ b/internal/formats/cyclonedxxml/test-fixtures/snapshot/TestCycloneDxImageEncoder.golden @@ -1,7 +1,7 @@ - + - 2022-02-25T12:54:44-05:00 + 2022-03-08T12:30:33Z anchore @@ -9,7 +9,7 @@ [not provided] - + user-image-input sha256:2731251dc34951c0e50fcc643b4c5f74922dad1a5d98f302b504cf46cd5d9368 @@ -30,7 +30,7 @@ python PythonPackageMetadata python - sha256:41e7295da66c405eb3a4df29188dcf80f622f9304d487033a86d4a22e3f01abe + sha256:16e64541f2ddf59a90391ce7bb8af90313f7d373f2105d88f3d3267b72e0ebab /somefile-1.txt @@ -43,7 +43,7 @@ the-cataloger-2 DpkgMetadata deb - sha256:68a2c166dcb3acf6b7303e995ca1fe7d794bd3b5852a0b4048f9c96b796086aa + sha256:de6c235f76ea24c8503ec08891445b5d6a8bdf8249117ed8d8b0b6fb3ebe4f67 /somefile-2.txt 0 diff --git a/internal/formats/cyclonedx13xml/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden b/internal/formats/cyclonedxxml/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden similarity index 78% rename from internal/formats/cyclonedx13xml/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden rename to internal/formats/cyclonedxxml/test-fixtures/snapshot/stereoscope-fixture-image-simple.golden index afbd18d5a138193f379091613e3f16239e26ca8a..c483fa49b75941b2cfb6a6819ff94a681f25ee41 100644 GIT binary patch literal 15360 zcmeHOZExE)5ccQ&3Xl7m*nFpCU>~xkKnoO0(Pka6pa>|wBwB6BkmRC4kpI4u>^N?+ zMoXlq8A`!`M3Fq5?szos;UhwsawN7!<0N9G_Y)S?;cIte-{TyY9lK0QOTOY|x)t4uE(r~oYv^93}xDgRNrVqJ4kRoa}tuWXv3 znb-5u?V;_xd{y1O=?dt&X?a{-Y_E@&F8f+eQ##5FD6wh(GW(2X*=j!DLoXKaM(fMh z3w^dx^g}*hEnInB^JiXsO0%=WbffLdtST;+d76P<>%K?XZ>w~^74=3ZZocV$wTE)J zMDsLTeL+_(vD9~USI1B1`oa~HdJXl>qb2_N-Sr<)M1}bOra^nGDD#E$>D=v;N%f`b zQSgqa7XM>R<#ztZoQyCbip${t9TPs;Wp$pG<9Yy$&viMjr)ZZ|<&!-w2o4qq76=vy z7I-EWkXR;>QJOjuMLGc>kW#?ll#rO}NXN`L>ZPLE8N%UAW9PMHF&D;L?a342f1pFa z|ArVMo&Enb_#X}V{}A3EjYz=%hB5RreM;x}?~eb~8$a9pZ@vFR2n+cCAR}gj|8*S( z0NyQi0jXo(SR#eZ$9+O;ERoO|VKdGq91|839x%oGFvb4`#(IL@9vr{=b-F5x={z@j zJ}r|po9&dh#hZ%e*18Cn=;LER+9?d!hoZE)Fz0FIOtmU%7+5c?qS?n;^+;|qdNe}ryWq0_0 zkoJZ3-w>nc5`81Bxyc_JHcU^M+E+}OItlxV7z0$88x~PZ<`4VURbBwE=j5`b6XQ%W zP8+yj%~3i{pdUIoJZyHp*VKpcbh{L8s1V~{#z{@t`IJ_mrpXtJHM((qb7FJz$rbhb zY4RDPtGzZgc2SFeRijyf@2IgZKTr+GhIbOuJyhg*<$+#wiK>fbowhc7of2Njrrw{X z7V1t=d9JCDGa{Yjf)fuEZ!cmUW58LAQ%MqO4+X-!vP>~g2^KbrJhO~Sl_=`4OLPKK zH?k!Nsqw!zH3zYITz_;%c#rJBV1ZzP JV1eE(@DIZvjQs!r literal 15360 zcmeHOZBN@s5YFfO6*=EmlFYu^8|gl91*w&)qiVUHbO@pKdKY{oc4Rvh2=U)zZH~k(Dwgt z41w16|8JRRE3RpU{S!f#{XYT5z5TC%buG;w~C*sQ8$#W6R+g`fo( zp2U{RL~#SoM%1xTOUj&5nhR$LKIg$|&M^4UCNUDj4u-N!VRdDjg#jf!LVKVNNjL;G z6wv29Vj(4z{8M+$vr4C#El%*vrKiF0DtMolRi?)l7lS?a@-cR}EB{s6V%D--Roa|= zsgg7chE9)4yA#~jx4&*y(Pf2Xw8|7P;P9EgwqH?RFp$LD{yf%4m( zqqY6F&;Np?FwAb1=C44cDeYM;u~zG4Egwf%1-|3`_C z{`tQR2XLGJBd?kNlMnNM$p6^No9UnY{eN|qmfboD*gezbZ5nVJcb=caBj6G62zUfu z69FYyq!pElktm8oDHSlVU?VN!SVUpOVhO^5AtKgD&rDoQRBRNBj5ZOde*66&p?rD& z2gn8W&;M=Q7gxa}q=q{-O~YGR6HjA-(^69~7APz=Y32KwKNz`Gd4U|9qpMZJDC3e) zp_*;zY=)B9f? z2(EWlE@XkZ^uG&f-oxKp$gKR#g&-s5-kx$NDDu2=$Wplqs>?}DU1@f0C0@>I+DO;HFu%Tjn-;VHr!RN}JOUnp I9|nQ{0PKm6EdT%j diff --git a/schema/cyclonedx/Makefile b/schema/cyclonedx/Makefile index d65c14678..3831cad2e 100644 --- a/schema/cyclonedx/Makefile +++ b/schema/cyclonedx/Makefile @@ -4,4 +4,4 @@ validate-schema: go run ../../main.go ubuntu:latest -vv -o cyclonedx > bom.xml xmllint --noout --schema ./cyclonedx.xsd bom.xml go run ../../main.go ubuntu:latest -vv -o cyclonedx-json > bom.json - ../../.tmp/yajsv -s bom-1.3.schema.json bom.json + ../../.tmp/yajsv -s cyclonedx.json bom.json diff --git a/schema/cyclonedx/bom-1.3.schema.json b/schema/cyclonedx/bom-1.3.schema.json deleted file mode 100644 index fdec97367..000000000 --- a/schema/cyclonedx/bom-1.3.schema.json +++ /dev/null @@ -1,1054 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "http://cyclonedx.org/schema/bom-1.3.schema.json", - "type": "object", - "title": "CycloneDX Software Bill-of-Material Specification", - "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.", - "required": [ - "bomFormat", - "specVersion", - "version" - ], - "properties": { - "bomFormat": { - "$id": "#/properties/bomFormat", - "type": "string", - "title": "BOM Format", - "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces.", - "enum": [ - "CycloneDX" - ] - }, - "specVersion": { - "$id": "#/properties/specVersion", - "type": "string", - "title": "CycloneDX Specification Version", - "description": "The version of the CycloneDX specification a BOM is written to (starting at version 1.2)", - "examples": ["1.3"] - }, - "serialNumber": { - "$id": "#/properties/serialNumber", - "type": "string", - "title": "BOM Serial Number", - "description": "Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.", - "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"], - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - }, - "version": { - "$id": "#/properties/version", - "type": "integer", - "title": "BOM Version", - "description": "The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.", - "default": 1, - "examples": [1] - }, - "metadata": { - "$id": "#/properties/metadata", - "$ref": "#/definitions/metadata", - "title": "BOM Metadata", - "description": "Provides additional information about a BOM." - }, - "components": { - "$id": "#/properties/components", - "type": "array", - "items": {"$ref": "#/definitions/component"}, - "uniqueItems": true, - "title": "Components" - }, - "services": { - "$id": "#/properties/services", - "type": "array", - "items": {"$ref": "#/definitions/service"}, - "uniqueItems": true, - "title": "Services" - }, - "externalReferences": { - "$id": "#/properties/externalReferences", - "type": "array", - "items": {"$ref": "#/definitions/externalReference"}, - "title": "External References", - "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM." - }, - "dependencies": { - "$id": "#/properties/dependencies", - "type": "array", - "items": {"$ref": "#/definitions/dependency"}, - "uniqueItems": true, - "title": "Dependencies", - "description": "Provides the ability to document dependency relationships." - }, - "compositions": { - "$id": "#/properties/compositions", - "type": "array", - "items": {"$ref": "#/definitions/compositions"}, - "uniqueItems": true, - "title": "Compositions", - "description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness." - } - }, - "definitions": { - "metadata": { - "type": "object", - "title": "BOM Metadata Object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "title": "Timestamp", - "description": "The date and time (timestamp) when the document was created." - }, - "tools": { - "type": "array", - "title": "Creation Tools", - "description": "The tool(s) used in the creation of the BOM.", - "items": {"$ref": "#/definitions/tool"} - }, - "authors" :{ - "type": "array", - "title": "Authors", - "description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.", - "items": {"$ref": "#/definitions/organizationalContact"} - }, - "component": { - "title": "Component", - "description": "The component that the BOM describes.", - "$ref": "#/definitions/component" - }, - "manufacture": { - "title": "Manufacture", - "description": "The organization that manufactured the component that the BOM describes.", - "$ref": "#/definitions/organizationalEntity" - }, - "supplier": { - "title": "Supplier", - "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.", - "$ref": "#/definitions/organizationalEntity" - }, - "licenses": { - "type": "array", - "title": "BOM License(s)", - "items": {"$ref": "#/definitions/licenseChoice"} - }, - "properties": { - "type": "array", - "title": "Properties", - "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.", - "items": {"$ref": "#/definitions/property"} - } - } - }, - "tool": { - "type": "object", - "title": "Tool", - "description": "The tool used to create the BOM.", - "properties": { - "vendor": { - "type": "string", - "title": "Tool Vendor", - "description": "The date and time (timestamp) when the document was created." - }, - "name": { - "type": "string", - "title": "Tool Name", - "description": "The date and time (timestamp) when the document was created." - }, - "version": { - "type": "string", - "title": "Tool Version", - "description": "The date and time (timestamp) when the document was created." - }, - "hashes": { - "$id": "#/properties/hashes", - "type": "array", - "items": {"$ref": "#/definitions/hash"}, - "title": "Hashes", - "description": "The hashes of the tool (if applicable)." - } - } - }, - "organizationalEntity": { - "type": "object", - "title": "Organizational Entity Object", - "description": "", - "properties": { - "name": { - "type": "string", - "title": "Name", - "description": "The name of the organization", - "examples": [ - "Example Inc." - ] - }, - "url": { - "type": "array", - "items": { - "type": "string", - "format": "iri-reference" - }, - "title": "URL", - "description": "The URL of the organization. Multiple URLs are allowed.", - "examples": ["https://example.com"] - }, - "contact": { - "type": "array", - "title": "Contact", - "description": "A contact at the organization. Multiple contacts are allowed.", - "items": {"$ref": "#/definitions/organizationalContact"} - } - } - }, - "organizationalContact": { - "type": "object", - "title": "Organizational Contact Object", - "description": "", - "properties": { - "name": { - "type": "string", - "title": "Name", - "description": "The name of a contact", - "examples": ["Contact name"] - }, - "email": { - "type": "string", - "title": "Email Address", - "description": "The email address of the contact.", - "examples": ["firstname.lastname@example.com"] - }, - "phone": { - "type": "string", - "title": "Phone", - "description": "The phone number of the contact.", - "examples": ["800-555-1212"] - } - } - }, - "component": { - "type": "object", - "title": "Component Object", - "required": [ - "type", - "name", - "version" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "application", - "framework", - "library", - "container", - "operating-system", - "device", - "firmware", - "file" - ], - "title": "Component Type", - "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.", - "examples": ["library"] - }, - "mime-type": { - "type": "string", - "title": "Mime-Type", - "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.", - "examples": ["image/jpeg"], - "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$" - }, - "bom-ref": { - "type": "string", - "title": "BOM Reference", - "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref should be unique." - }, - "supplier": { - "title": "Component Supplier", - "description": " The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.", - "$ref": "#/definitions/organizationalEntity" - }, - "author": { - "type": "string", - "title": "Component Author", - "description": "The person(s) or organization(s) that authored the component", - "examples": ["Acme Inc"] - }, - "publisher": { - "type": "string", - "title": "Component Publisher", - "description": "The person(s) or organization(s) that published the component", - "examples": ["Acme Inc"] - }, - "group": { - "type": "string", - "title": "Component Group", - "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.", - "examples": ["com.acme"] - }, - "name": { - "type": "string", - "title": "Component Name", - "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery", - "examples": ["tomcat-catalina"] - }, - "version": { - "type": "string", - "title": "Component Version", - "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.", - "examples": ["9.0.14"] - }, - "description": { - "type": "string", - "title": "Component Description", - "description": "Specifies a description for the component" - }, - "scope": { - "type": "string", - "enum": [ - "required", - "optional", - "excluded" - ], - "title": "Component Scope", - "description": "Specifies the scope of the component. If scope is not specified, 'required' scope should be assumed by the consumer of the BOM", - "default": "required" - }, - "hashes": { - "type": "array", - "title": "Component Hashes", - "items": {"$ref": "#/definitions/hash"} - }, - "licenses": { - "type": "array", - "items": {"$ref": "#/definitions/licenseChoice"}, - "title": "Component License(s)" - }, - "copyright": { - "type": "string", - "title": "Component Copyright", - "description": "An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.", - "examples": ["Acme Inc"] - }, - "cpe": { - "type": "string", - "title": "Component Common Platform Enumeration (CPE)", - "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe", - "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"] - }, - "purl": { - "type": "string", - "title": "Component Package URL (purl)", - "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"] - }, - "swid": { - "$ref": "#/definitions/swid", - "title": "SWID Tag", - "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags." - }, - "modified": { - "type": "boolean", - "title": "Component Modified From Original", - "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating is the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original." - }, - "pedigree": { - "type": "object", - "title": "Component Pedigree", - "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.", - "properties": { - "ancestors": { - "type": "array", - "title": "Ancestors", - "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.", - "items": {"$ref": "#/definitions/component"} - }, - "descendants": { - "type": "array", - "title": "Descendants", - "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.", - "items": {"$ref": "#/definitions/component"} - }, - "variants": { - "type": "array", - "title": "Variants", - "description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.", - "items": {"$ref": "#/definitions/component"} - }, - "commits": { - "type": "array", - "title": "Commits", - "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.", - "items": {"$ref": "#/definitions/commit"} - }, - "patches": { - "type": "array", - "title": "Patches", - "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.", - "items": {"$ref": "#/definitions/patch"} - }, - "notes": { - "type": "string", - "title": "Notes", - "description": "Notes, observations, and other non-structured commentary describing the components pedigree." - } - } - }, - "externalReferences": { - "type": "array", - "items": {"$ref": "#/definitions/externalReference"}, - "title": "External References" - }, - "components": { - "$id": "#/properties/components", - "type": "array", - "items": {"$ref": "#/definitions/component"}, - "uniqueItems": true, - "title": "Components" - }, - "evidence": { - "$ref": "#/definitions/componentEvidence", - "title": "Evidence", - "description": "Provides the ability to document evidence collected through various forms of extraction or analysis." - }, - "properties": { - "type": "array", - "title": "Properties", - "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.", - "items": {"$ref": "#/definitions/property"} - } - } - }, - "swid": { - "type": "object", - "title": "SWID Tag", - "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.", - "required": [ - "tagId", - "name" - ], - "properties": { - "tagId": { - "type": "string", - "title": "Tag ID", - "description": "Maps to the tagId of a SoftwareIdentity." - }, - "name": { - "type": "string", - "title": "Name", - "description": "Maps to the name of a SoftwareIdentity." - }, - "version": { - "type": "string", - "title": "Version", - "default": "0.0", - "description": "Maps to the version of a SoftwareIdentity." - }, - "tagVersion": { - "type": "integer", - "title": "Tag Version", - "default": 0, - "description": "Maps to the tagVersion of a SoftwareIdentity." - }, - "patch": { - "type": "boolean", - "title": "Patch", - "default": false, - "description": "Maps to the patch of a SoftwareIdentity." - }, - "text": { - "title": "Attachment text", - "description": "Specifies the metadata and content of the SWID tag.", - "$ref": "#/definitions/attachment" - }, - "url": { - "type": "string", - "title": "URL", - "description": "The URL to the SWID file.", - "format": "iri-reference" - } - } - }, - "attachment": { - "type": "object", - "title": "Attachment", - "description": "Specifies the metadata and content for an attachment.", - "required": [ - "content" - ], - "properties": { - "contentType": { - "type": "string", - "title": "Content-Type", - "description": "Specifies the content type of the text. Defaults to text/plain if not specified.", - "default": "text/plain" - }, - "encoding": { - "type": "string", - "title": "Encoding", - "description": "Specifies the optional encoding the text is represented in.", - "enum": [ - "base64" - ] - }, - "content": { - "type": "string", - "title": "Attachment Text", - "description": "The attachment data" - } - } - }, - "hash": { - "type": "object", - "title": "Hash Objects", - "required": [ - "alg", - "content" - ], - "properties": { - "alg": { - "$ref": "#/definitions/hash-alg" - }, - "content": { - "$ref": "#/definitions/hash-content" - } - } - }, - "hash-alg": { - "type": "string", - "enum": [ - "MD5", - "SHA-1", - "SHA-256", - "SHA-384", - "SHA-512", - "SHA3-256", - "SHA3-384", - "SHA3-512", - "BLAKE2b-256", - "BLAKE2b-384", - "BLAKE2b-512", - "BLAKE3" - ], - "title": "Hash Algorithm" - }, - "hash-content": { - "type": "string", - "title": "Hash Content (value)", - "examples": ["3942447fac867ae5cdb3229b658f4d48"], - "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$" - }, - "license": { - "type": "object", - "title": "License Object", - "oneOf": [ - { - "required": ["id"] - }, - { - "required": ["name"] - } - ], - "properties": { - "id": { - "$ref": "spdx.schema.json", - "title": "License ID (SPDX)", - "description": "A valid SPDX license ID", - "examples": ["Apache-2.0"] - }, - "name": { - "type": "string", - "title": "License Name", - "description": "If SPDX does not define the license used, this field may be used to provide the license name", - "examples": ["Acme Software License"] - }, - "text": { - "title": "License text", - "description": "An optional way to include the textual content of a license.", - "$ref": "#/definitions/attachment" - }, - "url": { - "type": "string", - "title": "License URL", - "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness", - "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"], - "format": "iri-reference" - } - } - }, - "licenseChoice": { - "type": "object", - "title": "License(s)", - "properties": { - "license": { - "$ref": "#/definitions/license" - }, - "expression": { - "type": "string", - "title": "SPDX License Expression", - "examples": [ - "Apache-2.0 AND (MIT OR GPL-2.0-only)", - "GPL-3.0-only WITH Classpath-exception-2.0" - ] - } - }, - "oneOf":[ - { - "required": ["license"] - }, - { - "required": ["expression"] - } - ] - }, - "commit": { - "type": "object", - "title": "Commit", - "description": "Specifies an individual commit", - "properties": { - "uid": { - "type": "string", - "title": "UID", - "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes." - }, - "url": { - "type": "string", - "title": "URL", - "description": "The URL to the commit. This URL will typically point to a commit in a version control system.", - "format": "iri-reference" - }, - "author": { - "title": "Author", - "description": "The author who created the changes in the commit", - "$ref": "#/definitions/identifiableAction" - }, - "committer": { - "title": "Committer", - "description": "The person who committed or pushed the commit", - "$ref": "#/definitions/identifiableAction" - }, - "message": { - "type": "string", - "title": "Message", - "description": "The text description of the contents of the commit" - } - } - }, - "patch": { - "type": "object", - "title": "Patch", - "description": "Specifies an individual patch", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "unofficial", - "monkey", - "backport", - "cherry-pick" - ], - "title": "Type", - "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality" - }, - "diff": { - "title": "Diff", - "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff", - "$ref": "#/definitions/diff" - }, - "resolves": { - "type": "array", - "items": {"$ref": "#/definitions/issue"}, - "title": "Resolves", - "description": "A collection of issues the patch resolves" - } - } - }, - "diff": { - "type": "object", - "title": "Diff", - "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff", - "properties": { - "text": { - "title": "Diff text", - "description": "Specifies the optional text of the diff", - "$ref": "#/definitions/attachment" - }, - "url": { - "type": "string", - "title": "URL", - "description": "Specifies the URL to the diff", - "format": "iri-reference" - } - } - }, - "issue": { - "type": "object", - "title": "Diff", - "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "defect", - "enhancement", - "security" - ], - "title": "Type", - "description": "Specifies the type of issue" - }, - "id": { - "type": "string", - "title": "ID", - "description": "The identifier of the issue assigned by the source of the issue" - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the issue" - }, - "description": { - "type": "string", - "title": "Description", - "description": "A description of the issue" - }, - "source": { - "type": "object", - "title": "Source", - "description": "The source of the issue where it is documented", - "properties": { - "name": { - "type": "string", - "title": "Name", - "description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'" - }, - "url": { - "type": "string", - "title": "URL", - "description": "The url of the issue documentation as provided by the source", - "format": "iri-reference" - } - } - }, - "references": { - "type": "array", - "items": { - "type": "string", - "format": "iri-reference" - }, - "title": "References", - "description": "A collection of URL's for reference. Multiple URLs are allowed.", - "examples": ["https://example.com"] - } - } - }, - "identifiableAction": { - "type": "object", - "title": "Identifiable Action", - "description": "Specifies an individual commit", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "title": "Timestamp", - "description": "The timestamp in which the action occurred" - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the individual who performed the action" - }, - "email": { - "type": "string", - "format": "idn-email", - "title": "E-mail", - "description": "The email address of the individual who performed the action" - } - } - }, - "externalReference": { - "type": "object", - "title": "External Reference", - "description": "Specifies an individual external reference", - "required": [ - "url", - "type" - ], - "properties": { - "url": { - "type": "string", - "title": "URL", - "description": "The URL to the external reference", - "format": "iri-reference" - }, - "comment": { - "type": "string", - "title": "Comment", - "description": "An optional comment describing the external reference" - }, - "type": { - "type": "string", - "title": "Type", - "description": "Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the \"other\" type.", - "enum": [ - "vcs", - "issue-tracker", - "website", - "advisories", - "bom", - "mailing-list", - "social", - "chat", - "documentation", - "support", - "distribution", - "license", - "build-meta", - "build-system", - "other" - ] - }, - "hashes": { - "$id": "#/properties/hashes", - "type": "array", - "items": {"$ref": "#/definitions/hash"}, - "title": "Hashes", - "description": "The hashes of the external reference (if applicable)." - } - } - }, - "dependency": { - "type": "object", - "title": "Dependency", - "description": "Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.", - "required": [ - "ref" - ], - "properties": { - "ref": { - "type": "string", - "title": "Reference", - "description": "References a component by the components bom-ref attribute" - }, - "dependsOn": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "string" - }, - "title": "Depends On", - "description": "The bom-ref identifiers of the components that are dependencies of this dependency object." - } - } - }, - "service": { - "type": "object", - "title": "Service Object", - "required": [ - "name" - ], - "properties": { - "bom-ref": { - "type": "string", - "title": "BOM Reference", - "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref should be unique." - }, - "provider": { - "title": "Provider", - "description": "The organization that provides the service.", - "$ref": "#/definitions/organizationalEntity" - }, - "group": { - "type": "string", - "title": "Service Group", - "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.", - "examples": ["com.acme"] - }, - "name": { - "type": "string", - "title": "Service Name", - "description": "The name of the service. This will often be a shortened, single name of the service.", - "examples": ["ticker-service"] - }, - "version": { - "type": "string", - "title": "Service Version", - "description": "The service version.", - "examples": ["1.0.0"] - }, - "description": { - "type": "string", - "title": "Service Description", - "description": "Specifies a description for the service" - }, - "endpoints": { - "type": "array", - "items": { - "type": "string", - "format": "iri-reference" - }, - "title": "Endpoints", - "description": "The endpoint URIs of the service. Multiple endpoints are allowed.", - "examples": ["https://example.com/api/v1/ticker"] - }, - "authenticated": { - "type": "boolean", - "title": "Authentication Required", - "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication." - }, - "x-trust-boundary": { - "type": "boolean", - "title": "Crosses Trust Boundary", - "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed." - }, - "data": { - "type": "array", - "items": {"$ref": "#/definitions/dataClassification"}, - "title": "Data Classification", - "description": "Specifies the data classification." - }, - "licenses": { - "type": "array", - "items": {"$ref": "#/definitions/licenseChoice"}, - "title": "Component License(s)" - }, - "externalReferences": { - "type": "array", - "items": {"$ref": "#/definitions/externalReference"}, - "title": "External References" - }, - "services": { - "$id": "#/properties/services", - "type": "array", - "items": {"$ref": "#/definitions/service"}, - "uniqueItems": true, - "title": "Services" - }, - "properties": { - "type": "array", - "title": "Properties", - "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.", - "items": {"$ref": "#/definitions/property"} - } - } - }, - "dataClassification": { - "type": "object", - "title": "Hash Objects", - "required": [ - "flow", - "classification" - ], - "properties": { - "flow": { - "$ref": "#/definitions/dataFlow" - }, - "classification": { - "type": "string" - } - } - }, - "dataFlow": { - "type": "string", - "enum": [ - "inbound", - "outbound", - "bi-directional", - "unknown" - ], - "title": "Data flow direction" - }, - - "copyright": { - "type": "object", - "title": "Copyright", - "required": [ - "text" - ], - "properties": { - "text": { - "type": "string", - "title": "Copyright Text" - } - } - }, - - "componentEvidence": { - "type": "object", - "title": "Evidence", - "description": "Provides the ability to document evidence collected through various forms of extraction or analysis.", - "properties": { - "licenses": { - "type": "array", - "items": {"$ref": "#/definitions/licenseChoice"}, - "title": "Component License(s)" - }, - "copyright": { - "type": "array", - "items": {"$ref": "#/definitions/copyright"}, - "title": "Copyright" - } - } - }, - "compositions": { - "type": "object", - "title": "Compositions", - "required": [ - "aggregate" - ], - "properties": { - "aggregate": { - "$ref": "#/definitions/aggregateType", - "title": "Aggregate", - "description": "Specifies an aggregate type that describe how complete a relationship is." - }, - "assemblies": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "string" - }, - "title": "BOM references", - "description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only." - }, - "dependencies": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "string" - }, - "title": "BOM references", - "description": "The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only." - } - } - }, - "aggregateType": { - "type": "string", - "default": "not_specified", - "enum": [ - "complete", - "incomplete", - "incomplete_first_party_only", - "incomplete_third_party_only", - "unknown", - "not_specified" - ] - }, - "property": { - "type": "object", - "title": "Lightweight name-value pair", - "properties": { - "name": { - "type": "string", - "title": "Name", - "description": "The name of the property. Duplicate names are allowed, each potentially having a different value." - }, - "value": { - "type": "string", - "title": "Value", - "description": "The value of the property." - } - } - } - } -} diff --git a/schema/cyclonedx/cyclonedx.json b/schema/cyclonedx/cyclonedx.json new file mode 100644 index 000000000..dafd88452 --- /dev/null +++ b/schema/cyclonedx/cyclonedx.json @@ -0,0 +1,1697 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "http://cyclonedx.org/schema/bom-1.4.schema.json", + "type": "object", + "title": "CycloneDX Software Bill of Materials Standard", + "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.", + "required": [ + "bomFormat", + "specVersion", + "version" + ], + "additionalProperties": false, + "properties": { + "$schema": { + "type": "string", + "enum": [ + "http://cyclonedx.org/schema/bom-1.4.schema.json" + ] + }, + "bomFormat": { + "type": "string", + "title": "BOM Format", + "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces. This value MUST be \"CycloneDX\".", + "enum": [ + "CycloneDX" + ] + }, + "specVersion": { + "type": "string", + "title": "CycloneDX Specification Version", + "description": "The version of the CycloneDX specification a BOM conforms to (starting at version 1.2).", + "examples": ["1.4"] + }, + "serialNumber": { + "type": "string", + "title": "BOM Serial Number", + "description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122. Use of serial numbers are RECOMMENDED.", + "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"], + "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + }, + "version": { + "type": "integer", + "title": "BOM Version", + "description": "Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.", + "default": 1, + "examples": [1] + }, + "metadata": { + "$ref": "#/definitions/metadata", + "title": "BOM Metadata", + "description": "Provides additional information about a BOM." + }, + "components": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/component"}, + "uniqueItems": true, + "title": "Components", + "description": "A list of software and hardware components." + }, + "services": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/service"}, + "uniqueItems": true, + "title": "Services", + "description": "A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services." + }, + "externalReferences": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/externalReference"}, + "title": "External References", + "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM." + }, + "dependencies": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/dependency"}, + "uniqueItems": true, + "title": "Dependencies", + "description": "Provides the ability to document dependency relationships." + }, + "compositions": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/compositions"}, + "uniqueItems": true, + "title": "Compositions", + "description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness." + }, + "vulnerabilities": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/vulnerability"}, + "uniqueItems": true, + "title": "Vulnerabilities", + "description": "Vulnerabilities identified in components or services." + }, + "signature": { + "$ref": "#/definitions/signature", + "title": "Signature", + "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)." + } + }, + "definitions": { + "refType": { + "$comment": "Identifier-DataType for interlinked elements.", + "type": "string" + }, + "metadata": { + "type": "object", + "title": "BOM Metadata Object", + "additionalProperties": false, + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "title": "Timestamp", + "description": "The date and time (timestamp) when the BOM was created." + }, + "tools": { + "type": "array", + "title": "Creation Tools", + "description": "The tool(s) used in the creation of the BOM.", + "additionalItems": false, + "items": {"$ref": "#/definitions/tool"} + }, + "authors" :{ + "type": "array", + "title": "Authors", + "description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.", + "additionalItems": false, + "items": {"$ref": "#/definitions/organizationalContact"} + }, + "component": { + "title": "Component", + "description": "The component that the BOM describes.", + "$ref": "#/definitions/component" + }, + "manufacture": { + "title": "Manufacture", + "description": "The organization that manufactured the component that the BOM describes.", + "$ref": "#/definitions/organizationalEntity" + }, + "supplier": { + "title": "Supplier", + "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.", + "$ref": "#/definitions/organizationalEntity" + }, + "licenses": { + "type": "array", + "title": "BOM License(s)", + "additionalItems": false, + "items": {"$ref": "#/definitions/licenseChoice"} + }, + "properties": { + "type": "array", + "title": "Properties", + "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.", + "additionalItems": false, + "items": {"$ref": "#/definitions/property"} + } + } + }, + "tool": { + "type": "object", + "title": "Tool", + "description": "Information about the automated or manual tool used", + "additionalProperties": false, + "properties": { + "vendor": { + "type": "string", + "title": "Tool Vendor", + "description": "The name of the vendor who created the tool" + }, + "name": { + "type": "string", + "title": "Tool Name", + "description": "The name of the tool" + }, + "version": { + "type": "string", + "title": "Tool Version", + "description": "The version of the tool" + }, + "hashes": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/hash"}, + "title": "Hashes", + "description": "The hashes of the tool (if applicable)." + }, + "externalReferences": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/externalReference"}, + "title": "External References", + "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM." + } + } + }, + "organizationalEntity": { + "type": "object", + "title": "Organizational Entity Object", + "description": "", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The name of the organization", + "examples": [ + "Example Inc." + ] + }, + "url": { + "type": "array", + "items": { + "type": "string", + "format": "iri-reference" + }, + "title": "URL", + "description": "The URL of the organization. Multiple URLs are allowed.", + "examples": ["https://example.com"] + }, + "contact": { + "type": "array", + "title": "Contact", + "description": "A contact at the organization. Multiple contacts are allowed.", + "additionalItems": false, + "items": {"$ref": "#/definitions/organizationalContact"} + } + } + }, + "organizationalContact": { + "type": "object", + "title": "Organizational Contact Object", + "description": "", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The name of a contact", + "examples": ["Contact name"] + }, + "email": { + "type": "string", + "format": "idn-email", + "title": "Email Address", + "description": "The email address of the contact.", + "examples": ["firstname.lastname@example.com"] + }, + "phone": { + "type": "string", + "title": "Phone", + "description": "The phone number of the contact.", + "examples": ["800-555-1212"] + } + } + }, + "component": { + "type": "object", + "title": "Component Object", + "required": [ + "type", + "name" + ], + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "application", + "framework", + "library", + "container", + "operating-system", + "device", + "firmware", + "file" + ], + "title": "Component Type", + "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component. Types include:\n\n* __application__ = A software application. Refer to [https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software) for information about applications.\n* __framework__ = A software framework. Refer to [https://en.wikipedia.org/wiki/Software_framework](https://en.wikipedia.org/wiki/Software_framework) for information on how frameworks vary slightly from libraries.\n* __library__ = A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing))\n for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is RECOMMENDED.\n* __container__ = A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization)\n* __operating-system__ = A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system)\n* __device__ = A hardware device such as a processor, or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself, and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device.\n* __firmware__ = A special type of software that provides low-level control over a devices hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware)\n* __file__ = A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.", + "examples": ["library"] + }, + "mime-type": { + "type": "string", + "title": "Mime-Type", + "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.", + "examples": ["image/jpeg"], + "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$" + }, + "bom-ref": { + "$ref": "#/definitions/refType", + "title": "BOM Reference", + "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be unique within the BOM." + }, + "supplier": { + "title": "Component Supplier", + "description": " The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.", + "$ref": "#/definitions/organizationalEntity" + }, + "author": { + "type": "string", + "title": "Component Author", + "description": "The person(s) or organization(s) that authored the component", + "examples": ["Acme Inc"] + }, + "publisher": { + "type": "string", + "title": "Component Publisher", + "description": "The person(s) or organization(s) that published the component", + "examples": ["Acme Inc"] + }, + "group": { + "type": "string", + "title": "Component Group", + "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.", + "examples": ["com.acme"] + }, + "name": { + "type": "string", + "title": "Component Name", + "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery", + "examples": ["tomcat-catalina"] + }, + "version": { + "type": "string", + "title": "Component Version", + "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.", + "examples": ["9.0.14"] + }, + "description": { + "type": "string", + "title": "Component Description", + "description": "Specifies a description for the component" + }, + "scope": { + "type": "string", + "enum": [ + "required", + "optional", + "excluded" + ], + "title": "Component Scope", + "description": "Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.", + "default": "required" + }, + "hashes": { + "type": "array", + "title": "Component Hashes", + "additionalItems": false, + "items": {"$ref": "#/definitions/hash"} + }, + "licenses": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/licenseChoice"}, + "title": "Component License(s)" + }, + "copyright": { + "type": "string", + "title": "Component Copyright", + "description": "A copyright notice informing users of the underlying claims to copyright ownership in a published work.", + "examples": ["Acme Inc"] + }, + "cpe": { + "type": "string", + "title": "Component Common Platform Enumeration (CPE)", + "description": "Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See [https://nvd.nist.gov/products/cpe](https://nvd.nist.gov/products/cpe)", + "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"] + }, + "purl": { + "type": "string", + "title": "Component Package URL (purl)", + "description": "Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec)", + "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"] + }, + "swid": { + "$ref": "#/definitions/swid", + "title": "SWID Tag", + "description": "Specifies metadata and content for [ISO-IEC 19770-2 Software Identification (SWID) Tags](https://www.iso.org/standard/65666.html)." + }, + "modified": { + "type": "boolean", + "title": "Component Modified From Original", + "description": "[Deprecated] - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original." + }, + "pedigree": { + "type": "object", + "title": "Component Pedigree", + "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.", + "additionalProperties": false, + "properties": { + "ancestors": { + "type": "array", + "title": "Ancestors", + "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.", + "additionalItems": false, + "items": {"$ref": "#/definitions/component"} + }, + "descendants": { + "type": "array", + "title": "Descendants", + "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.", + "additionalItems": false, + "items": {"$ref": "#/definitions/component"} + }, + "variants": { + "type": "array", + "title": "Variants", + "description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.", + "additionalItems": false, + "items": {"$ref": "#/definitions/component"} + }, + "commits": { + "type": "array", + "title": "Commits", + "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.", + "additionalItems": false, + "items": {"$ref": "#/definitions/commit"} + }, + "patches": { + "type": "array", + "title": "Patches", + "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.", + "additionalItems": false, + "items": {"$ref": "#/definitions/patch"} + }, + "notes": { + "type": "string", + "title": "Notes", + "description": "Notes, observations, and other non-structured commentary describing the components pedigree." + } + } + }, + "externalReferences": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/externalReference"}, + "title": "External References", + "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM." + }, + "components": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/component"}, + "uniqueItems": true, + "title": "Components", + "description": "A list of software and hardware components included in the parent component. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains." + }, + "evidence": { + "$ref": "#/definitions/componentEvidence", + "title": "Evidence", + "description": "Provides the ability to document evidence collected through various forms of extraction or analysis." + }, + "releaseNotes": { + "$ref": "#/definitions/releaseNotes", + "title": "Release notes", + "description": "Specifies optional release notes." + }, + "properties": { + "type": "array", + "title": "Properties", + "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.", + "additionalItems": false, + "items": {"$ref": "#/definitions/property"} + }, + "signature": { + "$ref": "#/definitions/signature", + "title": "Signature", + "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)." + } + } + }, + "swid": { + "type": "object", + "title": "SWID Tag", + "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.", + "required": [ + "tagId", + "name" + ], + "additionalProperties": false, + "properties": { + "tagId": { + "type": "string", + "title": "Tag ID", + "description": "Maps to the tagId of a SoftwareIdentity." + }, + "name": { + "type": "string", + "title": "Name", + "description": "Maps to the name of a SoftwareIdentity." + }, + "version": { + "type": "string", + "title": "Version", + "default": "0.0", + "description": "Maps to the version of a SoftwareIdentity." + }, + "tagVersion": { + "type": "integer", + "title": "Tag Version", + "default": 0, + "description": "Maps to the tagVersion of a SoftwareIdentity." + }, + "patch": { + "type": "boolean", + "title": "Patch", + "default": false, + "description": "Maps to the patch of a SoftwareIdentity." + }, + "text": { + "title": "Attachment text", + "description": "Specifies the metadata and content of the SWID tag.", + "$ref": "#/definitions/attachment" + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL to the SWID file.", + "format": "iri-reference" + } + } + }, + "attachment": { + "type": "object", + "title": "Attachment", + "description": "Specifies the metadata and content for an attachment.", + "required": [ + "content" + ], + "additionalProperties": false, + "properties": { + "contentType": { + "type": "string", + "title": "Content-Type", + "description": "Specifies the content type of the text. Defaults to text/plain if not specified.", + "default": "text/plain" + }, + "encoding": { + "type": "string", + "title": "Encoding", + "description": "Specifies the optional encoding the text is represented in.", + "enum": [ + "base64" + ] + }, + "content": { + "type": "string", + "title": "Attachment Text", + "description": "The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text." + } + } + }, + "hash": { + "type": "object", + "title": "Hash Objects", + "required": [ + "alg", + "content" + ], + "additionalProperties": false, + "properties": { + "alg": { + "$ref": "#/definitions/hash-alg" + }, + "content": { + "$ref": "#/definitions/hash-content" + } + } + }, + "hash-alg": { + "type": "string", + "enum": [ + "MD5", + "SHA-1", + "SHA-256", + "SHA-384", + "SHA-512", + "SHA3-256", + "SHA3-384", + "SHA3-512", + "BLAKE2b-256", + "BLAKE2b-384", + "BLAKE2b-512", + "BLAKE3" + ], + "title": "Hash Algorithm" + }, + "hash-content": { + "type": "string", + "title": "Hash Content (value)", + "examples": ["3942447fac867ae5cdb3229b658f4d48"], + "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$" + }, + "license": { + "type": "object", + "title": "License Object", + "oneOf": [ + { + "required": ["id"] + }, + { + "required": ["name"] + } + ], + "additionalProperties": false, + "properties": { + "id": { + "$ref": "spdx.schema.json", + "title": "License ID (SPDX)", + "description": "A valid SPDX license ID", + "examples": ["Apache-2.0"] + }, + "name": { + "type": "string", + "title": "License Name", + "description": "If SPDX does not define the license used, this field may be used to provide the license name", + "examples": ["Acme Software License"] + }, + "text": { + "title": "License text", + "description": "An optional way to include the textual content of a license.", + "$ref": "#/definitions/attachment" + }, + "url": { + "type": "string", + "title": "License URL", + "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness", + "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"], + "format": "iri-reference" + } + } + }, + "licenseChoice": { + "type": "object", + "title": "License(s)", + "additionalProperties": false, + "properties": { + "license": { + "$ref": "#/definitions/license" + }, + "expression": { + "type": "string", + "title": "SPDX License Expression", + "examples": [ + "Apache-2.0 AND (MIT OR GPL-2.0-only)", + "GPL-3.0-only WITH Classpath-exception-2.0" + ] + } + }, + "oneOf":[ + { + "required": ["license"] + }, + { + "required": ["expression"] + } + ] + }, + "commit": { + "type": "object", + "title": "Commit", + "description": "Specifies an individual commit", + "additionalProperties": false, + "properties": { + "uid": { + "type": "string", + "title": "UID", + "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes." + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL to the commit. This URL will typically point to a commit in a version control system.", + "format": "iri-reference" + }, + "author": { + "title": "Author", + "description": "The author who created the changes in the commit", + "$ref": "#/definitions/identifiableAction" + }, + "committer": { + "title": "Committer", + "description": "The person who committed or pushed the commit", + "$ref": "#/definitions/identifiableAction" + }, + "message": { + "type": "string", + "title": "Message", + "description": "The text description of the contents of the commit" + } + } + }, + "patch": { + "type": "object", + "title": "Patch", + "description": "Specifies an individual patch", + "required": [ + "type" + ], + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "unofficial", + "monkey", + "backport", + "cherry-pick" + ], + "title": "Type", + "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality.\n\n* __unofficial__ = A patch which is not developed by the creators or maintainers of the software being patched. Refer to [https://en.wikipedia.org/wiki/Unofficial_patch](https://en.wikipedia.org/wiki/Unofficial_patch)\n* __monkey__ = A patch which dynamically modifies runtime behavior. Refer to [https://en.wikipedia.org/wiki/Monkey_patch](https://en.wikipedia.org/wiki/Monkey_patch)\n* __backport__ = A patch which takes code from a newer version of software and applies it to older versions of the same software. Refer to [https://en.wikipedia.org/wiki/Backporting](https://en.wikipedia.org/wiki/Backporting)\n* __cherry-pick__ = A patch created by selectively applying commits from other versions or branches of the same software." + }, + "diff": { + "title": "Diff", + "description": "The patch file (or diff) that show changes. Refer to [https://en.wikipedia.org/wiki/Diff](https://en.wikipedia.org/wiki/Diff)", + "$ref": "#/definitions/diff" + }, + "resolves": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/issue"}, + "title": "Resolves", + "description": "A collection of issues the patch resolves" + } + } + }, + "diff": { + "type": "object", + "title": "Diff", + "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff", + "additionalProperties": false, + "properties": { + "text": { + "title": "Diff text", + "description": "Specifies the optional text of the diff", + "$ref": "#/definitions/attachment" + }, + "url": { + "type": "string", + "title": "URL", + "description": "Specifies the URL to the diff", + "format": "iri-reference" + } + } + }, + "issue": { + "type": "object", + "title": "Diff", + "description": "An individual issue that has been resolved.", + "required": [ + "type" + ], + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "defect", + "enhancement", + "security" + ], + "title": "Type", + "description": "Specifies the type of issue" + }, + "id": { + "type": "string", + "title": "ID", + "description": "The identifier of the issue assigned by the source of the issue" + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the issue" + }, + "description": { + "type": "string", + "title": "Description", + "description": "A description of the issue" + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source of the issue where it is documented", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'" + }, + "url": { + "type": "string", + "title": "URL", + "description": "The url of the issue documentation as provided by the source", + "format": "iri-reference" + } + } + }, + "references": { + "type": "array", + "items": { + "type": "string", + "format": "iri-reference" + }, + "title": "References", + "description": "A collection of URL's for reference. Multiple URLs are allowed.", + "examples": ["https://example.com"] + } + } + }, + "identifiableAction": { + "type": "object", + "title": "Identifiable Action", + "description": "Specifies an individual commit", + "additionalProperties": false, + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "title": "Timestamp", + "description": "The timestamp in which the action occurred" + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the individual who performed the action" + }, + "email": { + "type": "string", + "format": "idn-email", + "title": "E-mail", + "description": "The email address of the individual who performed the action" + } + } + }, + "externalReference": { + "type": "object", + "title": "External Reference", + "description": "Specifies an individual external reference", + "required": [ + "url", + "type" + ], + "additionalProperties": false, + "properties": { + "url": { + "type": "string", + "title": "URL", + "description": "The URL to the external reference", + "format": "iri-reference" + }, + "comment": { + "type": "string", + "title": "Comment", + "description": "An optional comment describing the external reference" + }, + "type": { + "type": "string", + "title": "Type", + "description": "Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the \"other\" type.", + "enum": [ + "vcs", + "issue-tracker", + "website", + "advisories", + "bom", + "mailing-list", + "social", + "chat", + "documentation", + "support", + "distribution", + "license", + "build-meta", + "build-system", + "release-notes", + "other" + ] + }, + "hashes": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/hash"}, + "title": "Hashes", + "description": "The hashes of the external reference (if applicable)." + } + } + }, + "dependency": { + "type": "object", + "title": "Dependency", + "description": "Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.", + "required": [ + "ref" + ], + "additionalProperties": false, + "properties": { + "ref": { + "$ref": "#/definitions/refType", + "title": "Reference", + "description": "References a component by the components bom-ref attribute" + }, + "dependsOn": { + "type": "array", + "uniqueItems": true, + "additionalItems": false, + "items": { + "$ref": "#/definitions/refType" + }, + "title": "Depends On", + "description": "The bom-ref identifiers of the components that are dependencies of this dependency object." + } + } + }, + "service": { + "type": "object", + "title": "Service Object", + "required": [ + "name" + ], + "additionalProperties": false, + "properties": { + "bom-ref": { + "$ref": "#/definitions/refType", + "title": "BOM Reference", + "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref MUST be unique within the BOM." + }, + "provider": { + "title": "Provider", + "description": "The organization that provides the service.", + "$ref": "#/definitions/organizationalEntity" + }, + "group": { + "type": "string", + "title": "Service Group", + "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.", + "examples": ["com.acme"] + }, + "name": { + "type": "string", + "title": "Service Name", + "description": "The name of the service. This will often be a shortened, single name of the service.", + "examples": ["ticker-service"] + }, + "version": { + "type": "string", + "title": "Service Version", + "description": "The service version.", + "examples": ["1.0.0"] + }, + "description": { + "type": "string", + "title": "Service Description", + "description": "Specifies a description for the service" + }, + "endpoints": { + "type": "array", + "items": { + "type": "string", + "format": "iri-reference" + }, + "title": "Endpoints", + "description": "The endpoint URIs of the service. Multiple endpoints are allowed.", + "examples": ["https://example.com/api/v1/ticker"] + }, + "authenticated": { + "type": "boolean", + "title": "Authentication Required", + "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication." + }, + "x-trust-boundary": { + "type": "boolean", + "title": "Crosses Trust Boundary", + "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed." + }, + "data": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/dataClassification"}, + "title": "Data Classification", + "description": "Specifies the data classification." + }, + "licenses": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/licenseChoice"}, + "title": "Component License(s)" + }, + "externalReferences": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/externalReference"}, + "title": "External References", + "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM." + }, + "services": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/service"}, + "uniqueItems": true, + "title": "Services", + "description": "A list of services included or deployed behind the parent service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies." + }, + "releaseNotes": { + "$ref": "#/definitions/releaseNotes", + "title": "Release notes", + "description": "Specifies optional release notes." + }, + "properties": { + "type": "array", + "title": "Properties", + "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.", + "additionalItems": false, + "items": {"$ref": "#/definitions/property"} + }, + "signature": { + "$ref": "#/definitions/signature", + "title": "Signature", + "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)." + } + } + }, + "dataClassification": { + "type": "object", + "title": "Hash Objects", + "required": [ + "flow", + "classification" + ], + "additionalProperties": false, + "properties": { + "flow": { + "$ref": "#/definitions/dataFlow", + "title": "Directional Flow", + "description": "Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways, and unknown states that the direction is not known." + }, + "classification": { + "type": "string", + "title": "Classification", + "description": "Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed." + } + } + }, + "dataFlow": { + "type": "string", + "enum": [ + "inbound", + "outbound", + "bi-directional", + "unknown" + ], + "title": "Data flow direction", + "description": "Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways, and unknown states that the direction is not known." + }, + + "copyright": { + "type": "object", + "title": "Copyright", + "required": [ + "text" + ], + "additionalProperties": false, + "properties": { + "text": { + "type": "string", + "title": "Copyright Text" + } + } + }, + + "componentEvidence": { + "type": "object", + "title": "Evidence", + "description": "Provides the ability to document evidence collected through various forms of extraction or analysis.", + "additionalProperties": false, + "properties": { + "licenses": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/licenseChoice"}, + "title": "Component License(s)" + }, + "copyright": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/copyright"}, + "title": "Copyright" + } + } + }, + "compositions": { + "type": "object", + "title": "Compositions", + "required": [ + "aggregate" + ], + "additionalProperties": false, + "properties": { + "aggregate": { + "$ref": "#/definitions/aggregateType", + "title": "Aggregate", + "description": "Specifies an aggregate type that describe how complete a relationship is." + }, + "assemblies": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "string" + }, + "title": "BOM references", + "description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only." + }, + "dependencies": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "string" + }, + "title": "BOM references", + "description": "The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only." + }, + "signature": { + "$ref": "#/definitions/signature", + "title": "Signature", + "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)." + } + } + }, + "aggregateType": { + "type": "string", + "default": "not_specified", + "enum": [ + "complete", + "incomplete", + "incomplete_first_party_only", + "incomplete_third_party_only", + "unknown", + "not_specified" + ] + }, + "property": { + "type": "object", + "title": "Lightweight name-value pair", + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The name of the property. Duplicate names are allowed, each potentially having a different value." + }, + "value": { + "type": "string", + "title": "Value", + "description": "The value of the property." + } + } + }, + "localeType": { + "type": "string", + "pattern": "^([a-z]{2})(-[A-Z]{2})?$", + "title": "Locale", + "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code MUST be lower case. If the country code is specified, the country code MUST be upper case. The language code and country code MUST be separated by a minus sign. Examples: en, en-US, fr, fr-CA" + }, + "releaseType": { + "type": "string", + "examples": [ + "major", + "minor", + "patch", + "pre-release", + "internal" + ], + "description": "The software versioning type. It is RECOMMENDED that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it." + }, + "note": { + "type": "object", + "title": "Note", + "description": "A note containing the locale and content.", + "required": [ + "text" + ], + "additionalProperties": false, + "properties": { + "locale": { + "$ref": "#/definitions/localeType", + "title": "Locale", + "description": "The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: \"en\", \"en-US\", \"fr\" and \"fr-CA\"" + }, + "text": { + "title": "Release note content", + "description": "Specifies the full content of the release note.", + "$ref": "#/definitions/attachment" + } + } + }, + "releaseNotes": { + "type": "object", + "title": "Release notes", + "required": [ + "type" + ], + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/definitions/releaseType", + "title": "Type", + "description": "The software versioning type the release note describes." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of the release." + }, + "featuredImage": { + "type": "string", + "format": "iri-reference", + "title": "Featured image", + "description": "The URL to an image that may be prominently displayed with the release note." + }, + "socialImage": { + "type": "string", + "format": "iri-reference", + "title": "Social image", + "description": "The URL to an image that may be used in messaging on social media platforms." + }, + "description": { + "type": "string", + "title": "Description", + "description": "A short description of the release." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "title": "Timestamp", + "description": "The date and time (timestamp) when the release note was created." + }, + "aliases": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Aliases", + "description": "One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names)." + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Tags", + "description": "One or more tags that may aid in search or retrieval of the release note." + }, + "resolves": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/issue"}, + "title": "Resolves", + "description": "A collection of issues that have been resolved." + }, + "notes": { + "type": "array", + "additionalItems": false, + "items": {"$ref": "#/definitions/note"}, + "title": "Notes", + "description": "Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages." + }, + "properties": { + "type": "array", + "title": "Properties", + "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.", + "additionalItems": false, + "items": {"$ref": "#/definitions/property"} + } + } + }, + "advisory": { + "type": "object", + "title": "Advisory", + "description": "Title and location where advisory information can be obtained. An advisory is a notification of a threat to a component, service, or system.", + "required": ["url"], + "additionalProperties": false, + "properties": { + "title": { + "type": "string", + "title": "Title", + "description": "An optional name of the advisory." + }, + "url": { + "type": "string", + "title": "URL", + "format": "iri-reference", + "description": "Location where the advisory can be obtained." + } + } + }, + "cwe": { + "type": "integer", + "minimum": 1, + "title": "CWE", + "description": "Integer representation of a Common Weaknesses Enumerations (CWE). For example 399 (of https://cwe.mitre.org/data/definitions/399.html)" + }, + "severity": { + "type": "string", + "title": "Severity", + "description": "Textual representation of the severity of the vulnerability adopted by the analysis method. If the analysis method uses values other than what is provided, the user is expected to translate appropriately.", + "enum": [ + "critical", + "high", + "medium", + "low", + "info", + "none", + "unknown" + ] + }, + "scoreMethod": { + "type": "string", + "title": "Method", + "description": "Specifies the severity or risk scoring methodology or standard used.\n\n* CVSSv2 - [Common Vulnerability Scoring System v2](https://www.first.org/cvss/v2/)\n* CVSSv3 - [Common Vulnerability Scoring System v3](https://www.first.org/cvss/v3-0/)\n* CVSSv31 - [Common Vulnerability Scoring System v3.1](https://www.first.org/cvss/v3-1/)\n* OWASP - [OWASP Risk Rating Methodology](https://owasp.org/www-community/OWASP_Risk_Rating_Methodology)", + "enum": [ + "CVSSv2", + "CVSSv3", + "CVSSv31", + "OWASP", + "other" + ] + }, + "impactAnalysisState": { + "type": "string", + "title": "Impact Analysis State", + "description": "Declares the current state of an occurrence of a vulnerability, after automated or manual analysis. \n\n* __resolved__ = the vulnerability has been remediated. \n* __resolved\\_with\\_pedigree__ = the vulnerability has been remediated and evidence of the changes are provided in the affected components pedigree containing verifiable commit history and/or diff(s). \n* __exploitable__ = the vulnerability may be directly or indirectly exploitable. \n* __in\\_triage__ = the vulnerability is being investigated. \n* __false\\_positive__ = the vulnerability is not specific to the component or service and was falsely identified or associated. \n* __not\\_affected__ = the component or service is not affected by the vulnerability. Justification should be specified for all not_affected cases.", + "enum": [ + "resolved", + "resolved_with_pedigree", + "exploitable", + "in_triage", + "false_positive", + "not_affected" + ] + }, + "impactAnalysisJustification": { + "type": "string", + "title": "Impact Analysis Justification", + "description": "The rationale of why the impact analysis state was asserted. \n\n* __code\\_not\\_present__ = the code has been removed or tree-shaked. \n* __code\\_not\\_reachable__ = the vulnerable code is not invoked at runtime. \n* __requires\\_configuration__ = exploitability requires a configurable option to be set/unset. \n* __requires\\_dependency__ = exploitability requires a dependency that is not present. \n* __requires\\_environment__ = exploitability requires a certain environment which is not present. \n* __protected\\_by\\_compiler__ = exploitability requires a compiler flag to be set/unset. \n* __protected\\_at\\_runtime__ = exploits are prevented at runtime. \n* __protected\\_at\\_perimeter__ = attacks are blocked at physical, logical, or network perimeter. \n* __protected\\_by\\_mitigating\\_control__ = preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability.", + "enum": [ + "code_not_present", + "code_not_reachable", + "requires_configuration", + "requires_dependency", + "requires_environment", + "protected_by_compiler", + "protected_at_runtime", + "protected_at_perimeter", + "protected_by_mitigating_control" + ] + }, + "rating": { + "type": "object", + "title": "Rating", + "description": "Defines the severity or risk ratings of a vulnerability.", + "additionalProperties": false, + "properties": { + "source": { + "$ref": "#/definitions/vulnerabilitySource", + "description": "The source that calculated the severity or risk rating of the vulnerability." + }, + "score": { + "type": "number", + "title": "Score", + "description": "The numerical score of the rating." + }, + "severity": { + "$ref": "#/definitions/severity", + "description": "Textual representation of the severity that corresponds to the numerical score of the rating." + }, + "method": { + "$ref": "#/definitions/scoreMethod" + }, + "vector": { + "type": "string", + "title": "Vector", + "description": "Textual representation of the metric values used to score the vulnerability" + }, + "justification": { + "type": "string", + "title": "Justification", + "description": "An optional reason for rating the vulnerability as it was" + } + } + }, + "vulnerabilitySource": { + "type": "object", + "title": "Source", + "description": "The source of vulnerability information. This is often the organization that published the vulnerability.", + "additionalProperties": false, + "properties": { + "url": { + "type": "string", + "title": "URL", + "description": "The url of the vulnerability documentation as provided by the source.", + "examples": [ + "https://nvd.nist.gov/vuln/detail/CVE-2021-39182" + ] + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the source.", + "examples": [ + "NVD", + "National Vulnerability Database", + "OSS Index", + "VulnDB", + "GitHub Advisories" + ] + } + } + }, + "vulnerability": { + "type": "object", + "title": "Vulnerability", + "description": "Defines a weakness in an component or service that could be exploited or triggered by a threat source.", + "additionalProperties": false, + "properties": { + "bom-ref": { + "$ref": "#/definitions/refType", + "title": "BOM Reference", + "description": "An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref MUST be unique within the BOM." + }, + "id": { + "type": "string", + "title": "ID", + "description": "The identifier that uniquely identifies the vulnerability.", + "examples": [ + "CVE-2021-39182", + "GHSA-35m5-8cvj-8783", + "SNYK-PYTHON-ENROCRYPT-1912876" + ] + }, + "source": { + "$ref": "#/definitions/vulnerabilitySource", + "description": "The source that published the vulnerability." + }, + "references": { + "type": "array", + "title": "References", + "description": "Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.", + "additionalItems": false, + "items": { + "required": [ + "id", + "source" + ], + "additionalProperties": false, + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "An identifier that uniquely identifies the vulnerability.", + "examples": [ + "CVE-2021-39182", + "GHSA-35m5-8cvj-8783", + "SNYK-PYTHON-ENROCRYPT-1912876" + ] + }, + "source": { + "$ref": "#/definitions/vulnerabilitySource", + "description": "The source that published the vulnerability." + } + } + } + }, + "ratings": { + "type": "array", + "title": "Ratings", + "description": "List of vulnerability ratings", + "additionalItems": false, + "items": { + "$ref": "#/definitions/rating" + } + }, + "cwes": { + "type": "array", + "title": "CWEs", + "description": "List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability. For example 399 (of https://cwe.mitre.org/data/definitions/399.html)", + "examples": ["399"], + "additionalItems": false, + "items": { + "$ref": "#/definitions/cwe" + } + }, + "description": { + "type": "string", + "title": "Description", + "description": "A description of the vulnerability as provided by the source." + }, + "detail": { + "type": "string", + "title": "Details", + "description": "If available, an in-depth description of the vulnerability as provided by the source organization. Details often include examples, proof-of-concepts, and other information useful in understanding root cause." + }, + "recommendation": { + "type": "string", + "title": "Details", + "description": "Recommendations of how the vulnerability can be remediated or mitigated." + }, + "advisories": { + "type": "array", + "title": "Advisories", + "description": "Published advisories of the vulnerability if provided.", + "additionalItems": false, + "items": { + "$ref": "#/definitions/advisory" + } + }, + "created": { + "type": "string", + "format": "date-time", + "title": "Created", + "description": "The date and time (timestamp) when the vulnerability record was created in the vulnerability database." + }, + "published": { + "type": "string", + "format": "date-time", + "title": "Published", + "description": "The date and time (timestamp) when the vulnerability record was first published." + }, + "updated": { + "type": "string", + "format": "date-time", + "title": "Updated", + "description": "The date and time (timestamp) when the vulnerability record was last updated." + }, + "credits": { + "type": "object", + "title": "Credits", + "description": "Individuals or organizations credited with the discovery of the vulnerability.", + "additionalProperties": false, + "properties": { + "organizations": { + "type": "array", + "title": "Organizations", + "description": "The organizations credited with vulnerability discovery.", + "additionalItems": false, + "items": { + "$ref": "#/definitions/organizationalEntity" + } + }, + "individuals": { + "type": "array", + "title": "Individuals", + "description": "The individuals, not associated with organizations, that are credited with vulnerability discovery.", + "additionalItems": false, + "items": { + "$ref": "#/definitions/organizationalContact" + } + } + } + }, + "tools": { + "type": "array", + "title": "Creation Tools", + "description": "The tool(s) used to identify, confirm, or score the vulnerability.", + "additionalItems": false, + "items": {"$ref": "#/definitions/tool"} + }, + "analysis": { + "type": "object", + "title": "Impact Analysis", + "description": "An assessment of the impact and exploitability of the vulnerability.", + "additionalProperties": false, + "properties": { + "state": { + "$ref": "#/definitions/impactAnalysisState" + }, + "justification": { + "$ref": "#/definitions/impactAnalysisJustification" + }, + "response": { + "type": "array", + "title": "Response", + "description": "A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable.", + "additionalItems": false, + "items": { + "type": "string", + "enum": [ + "can_not_fix", + "will_not_fix", + "update", + "rollback", + "workaround_available" + ] + } + }, + "detail": { + "type": "string", + "title": "Detail", + "description": "Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability." + } + } + }, + "affects": { + "type": "array", + "uniqueItems": true, + "additionalItems": false, + "items": { + "required": [ + "ref" + ], + "additionalProperties": false, + "properties": { + "ref": { + "$ref": "#/definitions/refType", + "title": "Reference", + "description": "References a component or service by the objects bom-ref" + }, + "versions": { + "type": "array", + "title": "Versions", + "description": "Zero or more individual versions or range of versions.", + "additionalItems": false, + "items": { + "oneOf": [ + { + "required": ["version"] + }, + { + "required": ["range"] + } + ], + "additionalProperties": false, + "properties": { + "version": { + "description": "A single version of a component or service.", + "$ref": "#/definitions/version" + }, + "range": { + "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst", + "$ref": "#/definitions/version" + }, + "status": { + "description": "The vulnerability status for the version or range of versions.", + "$ref": "#/definitions/affectedStatus", + "default": "affected" + } + } + } + } + } + }, + "title": "Affects", + "description": "The components or services that are affected by the vulnerability." + }, + "properties": { + "type": "array", + "title": "Properties", + "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.", + "additionalItems": false, + "items": { + "$ref": "#/definitions/property" + } + } + } + }, + "affectedStatus": { + "description": "The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.", + "type": "string", + "enum": [ + "affected", + "unaffected", + "unknown" + ] + }, + "version": { + "description": "A single version of a component or service.", + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "range": { + "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst", + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "signature": { + "$ref": "jsf-0.82.schema.json#/definitions/signature", + "title": "Signature", + "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)." + } + } +} diff --git a/schema/cyclonedx/cyclonedx.xsd b/schema/cyclonedx/cyclonedx.xsd index 968d03e37..f9859c789 100644 --- a/schema/cyclonedx/cyclonedx.xsd +++ b/schema/cyclonedx/cyclonedx.xsd @@ -16,30 +16,37 @@ limitations under the License. --> + version="1.4.1"> - CycloneDX Software Bill-of-Material Specification + CycloneDX Software Bill of Materials Standard https://cyclonedx.org/ Apache License, Version 2.0 + + + Identifier-DataType for interlinked elements. + + + + - The date and time (timestamp) when the document was created. + The date and time (timestamp) when the BOM was created. @@ -84,7 +91,10 @@ limitations under the License. Provides the ability to document properties in a key/value store. This provides flexibility to include data not officially supported in the standard - without having to use additional namespaces or create extensions. + without having to use additional namespaces or create extensions. Property names + of interest to the general public are encouraged to be registered in the + CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy. + Formal registration is OPTIONAL. @@ -138,22 +148,22 @@ limitations under the License. - Specifies a tool (manual or automated). + Information about the automated or manual tool used - The vendor of the tool used to create the BOM. + The name of the vendor who created the tool - The name of the tool used to create the BOM. + The name of the tool - The version of the tool used to create the BOM. + The version of the tool @@ -163,6 +173,11 @@ limitations under the License. + + + Provides the ability to document external references related to the tool. + + @@ -263,7 +278,7 @@ limitations under the License. of the component. Examples: commons-lang3 and jquery - + The component version. The version should ideally comply with semantic versioning but is not enforced. @@ -276,8 +291,8 @@ limitations under the License. - Specifies the scope of the component. If scope is not specified, 'runtime' - scope should be assumed by the consumer of the BOM + Specifies the scope of the component. If scope is not specified, 'required' + scope SHOULD be assumed by the consumer of the BOM. @@ -290,22 +305,21 @@ limitations under the License. - An optional copyright notice informing users of the underlying claims to + A copyright notice informing users of the underlying claims to copyright ownership in a published work. - DEPRECATED - DO NOT USE. This will be removed in a future version. - Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe + Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe - Specifies the package-url (PURL). The purl, if specified, must be valid and conform + Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification defined at: https://github.com/package-url/purl-spec @@ -322,7 +336,7 @@ limitations under the License. DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. - A boolean value indicating is the component has been modified from the original. + A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original. @@ -346,15 +360,18 @@ limitations under the License. Provides the ability to document properties in a key/value store. This provides flexibility to include data not officially supported in the standard - without having to use additional namespaces or create extensions. + without having to use additional namespaces or create extensions. Property names + of interest to the general public are encouraged to be registered in the + CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy. + Formal registration is OPTIONAL. - Specifies optional sub-components. This is not a dependency tree. It provides a way - to specify a hierarchical representation of component assemblies, similar to - system -> subsystem -> parts assembly in physical supply chains. + A list of software and hardware components included in the parent component. This is not a + dependency tree. It provides a way to specify a hierarchical representation of component + assemblies, similar to system -> subsystem -> parts assembly in physical supply chains. @@ -375,6 +392,11 @@ limitations under the License. Provides the ability to document evidence collected through various forms of extraction or analysis. + + + Specifies optional release notes. + + @@ -394,13 +416,13 @@ limitations under the License. - The optional mime-type of the component. When used on file components, the mime-type + The OPTIONAL mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type. - + An optional identifier which can be used to reference the component elsewhere in the BOM. @@ -455,7 +477,7 @@ limitations under the License. - Specifies attributes of the text + The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. @@ -553,7 +575,7 @@ limitations under the License. A hardware device such as a processor, or chip-set. A hardware device - containing firmware should include a component for the physical hardware itself, and another + containing firmware SHOULD include a component for the physical hardware itself, and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. @@ -598,7 +620,7 @@ limitations under the License. - + @@ -751,6 +773,11 @@ limitations under the License. URL to an automated build system + + + URL to release notes + + Use this if no other types accurately describe the purpose of the external reference @@ -994,6 +1021,11 @@ limitations under the License. + + + An individual issue that has been resolved. + + @@ -1156,7 +1188,7 @@ limitations under the License. - + References a component or service by the its bom-ref attribute @@ -1277,15 +1309,17 @@ limitations under the License. Provides the ability to document properties in a key/value store. This provides flexibility to include data not officially supported in the standard - without having to use additional namespaces or create extensions. + without having to use additional namespaces or create extensions. Property names + of interest to the general public are encouraged to be registered in the + CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy. + Formal registration is OPTIONAL. - Specifies optional sub-service. This is not a dependency tree. It provides a way - to specify a hierarchical representation of service assemblies, similar to - system -> subsystem -> parts assembly in physical supply chains. + A list of services included or deployed behind the parent service. This is not a dependency + tree. It provides a way to specify a hierarchical representation of service assemblies. @@ -1301,6 +1335,11 @@ limitations under the License. + + + Specifies optional release notes. + + @@ -1309,7 +1348,7 @@ limitations under the License. - + An optional identifier which can be used to reference the service elsewhere in the BOM. @@ -1501,8 +1540,151 @@ limitations under the License. + + + + Defines a syntax for representing two character language code (ISO-639) followed by an optional two + character country code. The language code MUST be lower case. If the country code is specified, the + country code MUST be upper case. The language code and country code MUST be separated by a minus sign. + Examples: en, en-US, fr, fr-CA + + + + + + + + + + + + The software versioning type. It is RECOMMENDED that the release type use one + of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software + release types is not practical, so standardizing on the recommended values, whenever possible, + is strongly encouraged. + * major = A major release may contain significant changes or may introduce breaking changes. + * minor = A minor release, also known as an update, may contain a smaller number of changes than major releases. + * patch = Patch releases are typically unplanned and may resolve defects or important security issues. + * pre-release = A pre-release may include alpha, beta, or release candidates and typically have + limited support. They provide the ability to preview a release prior to its general availability. + * internal = Internal releases are not for public consumption and are intended to be used exclusively + by the project or manufacturer that produced it. + + + + + + The title of the release. + + + + + The URL to an image that may be prominently displayed with the release note. + + + + + The URL to an image that may be used in messaging on social media platforms. + + + + + A short description of the release. + + + + + The date and time (timestamp) when the release note was created. + + + + + + + + One or more alternate names the release may be referred to. This may + include unofficial terms used by development and marketing teams (e.g. code names). + + + + + + + + + + + One or more tags that may aid in search or retrieval of the release note. + + + + + + + + A collection of issues that have been resolved. + + + + + + + + + + + + + Zero or more release notes containing the locale and content. Multiple + note elements may be specified to support release notes in a wide variety of languages. + + + + + + The ISO-639 (or higher) language code and optional ISO-3166 + (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA". + + + + + Specifies the full content of the release note. + + + + + + + + + + + Provides the ability to document properties in a key/value store. + This provides flexibility to include data not officially supported in the standard + without having to use additional namespaces or create extensions. Property names + of interest to the general public are encouraged to be registered in the + CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy. + Formal registration is OPTIONAL. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + User-defined attributes may be used on this element as long as they + do not have the same name as an existing attribute used by the schema. + + + + - + References a component or service by the its bom-ref attribute @@ -1549,6 +1731,595 @@ limitations under the License. + + + + + Defines a weakness in an component or service that could be exploited or triggered by a threat source. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + User-defined attributes may be used on this element as long as they + do not have the same name as an existing attribute used by the schema. + + + + + + + + + The identifier that uniquely identifies the vulnerability. For example: + CVE-2021-39182, GHSA-35m5-8cvj-8783, and SNYK-PYTHON-ENROCRYPT-1912876. + + + + + The source that published the vulnerability. + + + + + Zero or more pointers to vulnerabilities that are the equivalent of the + vulnerability specified. Often times, the same vulnerability may exist in multiple sources of + vulnerability intelligence, but have different identifiers. References provide a way to + correlate vulnerabilities across multiple sources of vulnerability intelligence. + + + + + + A pointer to a vulnerability that is the equivalent of the + vulnerability specified. + + + + + + The identifier that uniquely identifies the vulnerability. For example: + CVE-2021-39182, GHSA-35m5-8cvj-8783, and SNYK-PYTHON-ENROCRYPT-1912876. + + + + + The source that published the vulnerability. + + + + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + List of vulnerability ratings. + + + + + + + + + + + + List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability. + For example 399 (of https://cwe.mitre.org/data/definitions/399.html) + + + + + + + + + + A description of the vulnerability as provided by the source. + + + + + If available, an in-depth description of the vulnerability as provided by the + source organization. Details often include examples, proof-of-concepts, and other information + useful in understanding root cause. + + + + + Recommendations of how the vulnerability can be remediated or mitigated. + + + + + + + Published advisories of the vulnerability if provided. + + + + + + + + + + The date and time (timestamp) when the vulnerability record was created in the vulnerability database. + + + + + The date and time (timestamp) when the vulnerability record was first published. + + + + + The date and time (timestamp) when the vulnerability record was last updated. + + + + + Individuals or organizations credited with the discovery of the vulnerability. + + + + + + The organizations credited with vulnerability discovery. + + + + + + + + + + The individuals, not associated with organizations, that are credited with vulnerability discovery. + + + + + + + + + + + + + The tool(s) used to identify, confirm, or score the vulnerability. + + + + + + + + + + + + An assessment of the impact and exploitability of the vulnerability. + + + + + + + Declares the current state of an occurrence of a vulnerability, after automated or manual analysis. + + + + + + + The rationale of why the impact analysis state was asserted. + + + + + + A response to the vulnerability by the manufacturer, supplier, or + project responsible for the affected component or service. More than one response + is allowed. Responses are strongly encouraged for vulnerabilities where the analysis + state is exploitable. + + + + + + + + + + + Detailed description of the impact including methods used during assessment. + If a vulnerability is not exploitable, this field should include specific details + on why the component or service is not impacted by this vulnerability. + + + + + + + + + The components or services that are affected by the vulnerability. + + + + + + + + + References a component or service by the objects bom-ref. + + + + + Zero or more individual versions or range of versions. + + + + + + + + + + A single version of a component or service. + + + + + A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst + + + + + + + The vulnerability status for the version or range of versions. + + + + + + + + + + + + + + + + + + + + An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. + Uniqueness is enforced within all elements and children of the root-level bom element. + + + + + + + + + + The name of the source. + For example: NVD, National Vulnerability Database, OSS Index, VulnDB, and GitHub Advisories + + + + + + The url of the vulnerability documentation as provided by the source. + For example: https://nvd.nist.gov/vuln/detail/CVE-2021-39182 + + + + + + + + + + The source that calculated the severity or risk rating of the vulnerability. + + + + + The numerical score of the rating. + + + + + Textual representation of the severity that corresponds to the numerical score of the rating. + + + + + The risk scoring methodology/standard used. + + + + + Textual representation of the metric values used to score the vulnerability. + + + + + An optional reason for rating the vulnerability as it was. + + + + + + + + + + An optional name of the advisory. + + + + + Location where the advisory can be obtained. + + + + + + + + + Textual representation of the severity of the vulnerability adopted by the analysis method. If the + analysis method uses values other than what is provided, the user is expected to translate appropriately. + + + + + + + + + + + + + + + + + Declares the current state of an occurrence of a vulnerability, after automated or manual analysis. + + + + + + + The vulnerability has been remediated. + + + + + + + The vulnerability has been remediated and evidence of the changes are provided in the affected + components pedigree containing verifiable commit history and/or diff(s). + + + + + + + The vulnerability may be directly or indirectly exploitable. + + + + + + + The vulnerability is being investigated. + + + + + + + The vulnerability is not specific to the component or service and was falsely identified or associated. + + + + + + + The component or service is not affected by the vulnerability. Justification should be specified + for all not_affected cases. + + + + + + + + + + The rationale of why the impact analysis state was asserted. + + + + + + + The code has been removed or tree-shaked. + + + + + + + The vulnerable code is not invoked at runtime. + + + + + + + Exploitability requires a configurable option to be set/unset. + + + + + + + Exploitability requires a dependency that is not present. + + + + + + + Exploitability requires a certain environment which is not present. + + + + + + + Exploitability requires a compiler flag to be set/unset. + + + + + + + Exploits are prevented at runtime. + + + + + + + Attacks are blocked at physical, logical, or network perimeter. + + + + + + + Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability. + + + + + + + + + + Specifies the severity or risk scoring methodology or standard used. + + + + + + + The rating is based on CVSS v2 standard + https://www.first.org/cvss/v2/ + + + + + + + The rating is based on CVSS v3.0 standard + https://www.first.org/cvss/v3-0/ + + + + + + + The rating is based on CVSS v3.1 standard + https://www.first.org/cvss/v3-1/ + + + + + + + The rating is based on OWASP Risk Rating + https://owasp.org/www-community/OWASP_Risk_Rating_Methodology + + + + + + + Use this if the risk scoring methodology is not based on any of the options above + + + + + + + + + + The rationale of why the impact analysis state was asserted. + + + + + + + + + + + + + + + The vulnerability status of a given version or range of versions of a product. The statuses + 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. + The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. + There can be many reasons for an 'unknown' status, including that an investigation has not been + undertaken or that a vendor has not disclosed the status. + + + + + + + + + + @@ -1559,12 +2330,12 @@ limitations under the License. - Provides the ability to document a list of components. + A list of software and hardware components. - Provides the ability to document a list of external services. + A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services. @@ -1585,10 +2356,17 @@ limitations under the License. - Provides the ability to document properties in a name-value store. - This provides flexibility to include data not officially supported in the standard - without having to use additional namespaces or create extensions. Unlike key-value - stores, properties support duplicate names, each potentially having different values. + Provides the ability to document properties in a key/value store. + This provides flexibility to include data not officially supported in the standard + without having to use additional namespaces or create extensions. Property names + of interest to the general public are encouraged to be registered in the + CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy. + Formal registration is OPTIONAL. + + + + + Vulnerabilities identified in components or services. @@ -1601,19 +2379,17 @@ limitations under the License. - The version allows component publishers/authors to make changes to existing - BOMs to update various aspects of the document such as description or licenses. When a system - is presented with multiple BOMs for the same component, the system should use the most recent - version of the BOM. The default version is '1' and should be incremented for each version of the - BOM that is published. Each version of a component should have a unique BOM and if no changes are - made to the BOMs, then each BOM will have a version of '1'. + Whenever an existing BOM is modified, either manually or through automated + processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with + multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. + The default version is '1'. - Every BOM generated should have a unique serial number, even if the contents - of the BOM being generated have not changed over time. The process or tool responsible for - creating the BOM should create random UUID's for every BOM generated. + Every BOM generated SHOULD have a unique serial number, even if the contents of + the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122. + Use of serial numbers are RECOMMENDED. diff --git a/schema/cyclonedx/spdx.xsd b/schema/cyclonedx/spdx.xsd index b45e2de06..66ba6f199 100644 --- a/schema/cyclonedx/spdx.xsd +++ b/schema/cyclonedx/spdx.xsd @@ -2,1009 +2,19 @@ + version="1.0-3.16"> - + - Academic Free License v2.0 + Interbase Public License v1.0 - + - Attribution Assurance License - - - - - Adobe Systems Incorporated Source Code License Agreement - - - - - Academic Free License v3.0 - - - - - Amazon Digital Services License - - - - - BSD Zero Clause License - - - - - Afmparse License - - - - - Academic Free License v1.2 - - - - - Affero General Public License v1.0 or later - - - - - Academic Free License v2.1 - - - - - Academic Free License v1.1 - - - - - Affero General Public License v1.0 - - - - - Adobe Glyph List License - - - - - AMD's plpa_map.c License - - - - - Aladdin Free Public License - - - - - ANTLR Software Rights Notice - - - - - Apple MIT License - - - - - Apache License 1.0 - - - - - ANTLR Software Rights Notice with license fallback - - - - - Abstyles License - - - - - Affero General Public License v1.0 only - - - - - Adobe Postscript AFM License - - - - - Apple Public Source License 1.0 - - - - - Apple Public Source License 1.1 - - - - - Apple Public Source License 2.0 - - - - - GNU Affero General Public License v3.0 only - - - - - Apache License 1.1 - - - - - Apache License 2.0 - - - - - Adaptive Public License 1.0 - - - - - Bahyph License - - - - - Artistic License 1.0 - - - - - Academy of Motion Picture Arts and Sciences BSD - - - - - Barr License - - - - - GNU Affero General Public License v3.0 or later - - - - - Blue Oak Model License 1.0.0 - - - - - Beerware License - - - - - Artistic License 1.0 w/clause 8 - - - - - SQLite Blessing - - - - - Borceux license - - - - - BSD 2-Clause NetBSD License - - - - - BSD 1-Clause License - - - - - BSD-2-Clause Plus Patent License - - - - - BitTorrent Open Source License v1.0 - - - - - BSD 2-Clause FreeBSD License - - - - - BSD with attribution - - - - - BSD 2-Clause "Simplified" License - - - - - Apple Public Source License 1.2 - - - - - Lawrence Berkeley National Labs BSD variant license - - - - - Artistic License 2.0 - - - - - BSD 3-Clause No Nuclear License 2014 - - - - - BSD 3-Clause Modification - - - - - BSD 4 Clause Shortened - - - - - BSD 3-Clause "New" or "Revised" License - - - - - BSD 3-Clause Open MPI variant - - - - - BitTorrent Open Source License v1.1 - - - - - BSD 3-Clause No Nuclear Warranty - - - - - BSD Source Code Attribution - - - - - BSD Protection License - - - - - GNU Affero General Public License v3.0 - - - - - Business Source License 1.1 - - - - - Artistic License 1.0 (Perl) - - - - - Boost Software License 1.0 - - - - - BSD 2-Clause with views sentence - - - - - Cryptographic Autonomy License 1.0 (Combined Work Exception) - - - - - Computer Associates Trusted Open Source License 1.1 - - - - - bzip2 and libbzip2 License v1.0.5 - - - - - bzip2 and libbzip2 License v1.0.6 - - - - - Creative Commons Attribution 2.5 Generic - - - - - Creative Commons Attribution 3.0 Austria - - - - - Computational Use of Data Agreement v1.0 - - - - - Creative Commons Attribution 3.0 United States - - - - - Creative Commons Attribution 1.0 Generic - - - - - Creative Commons Attribution Non Commercial 1.0 Generic - - - - - Creative Commons Attribution Non Commercial 2.0 Generic - - - - - Creative Commons Attribution Non Commercial 2.5 Generic - - - - - Creative Commons Attribution 2.0 Generic - - - - - Creative Commons Attribution Non Commercial 4.0 International - - - - - Creative Commons Attribution Non Commercial No Derivatives 1.0 Generic - - - - - Creative Commons Attribution Non Commercial No Derivatives 2.0 Generic - - - - - Creative Commons Attribution Non Commercial 3.0 Unported - - - - - Creative Commons Attribution Non Commercial No Derivatives 3.0 IGO - - - - - Creative Commons Attribution Non Commercial No Derivatives 3.0 Unported - - - - - BSD 3-Clause No Nuclear License - - - - - Creative Commons Attribution Non Commercial No Derivatives 4.0 International - - - - - Creative Commons Attribution Non Commercial Share Alike 2.0 Generic - - - - - Creative Commons Attribution Non Commercial Share Alike 2.5 Generic - - - - - Creative Commons Attribution Non Commercial Share Alike 3.0 Unported - - - - - Creative Commons Attribution Non Commercial Share Alike 4.0 International - - - - - Creative Commons Attribution No Derivatives 1.0 Generic - - - - - BSD 3-Clause Clear License - - - - - Creative Commons Attribution No Derivatives 2.5 Generic - - - - - Creative Commons Attribution No Derivatives 3.0 Unported - - - - - Creative Commons Attribution No Derivatives 4.0 International - - - - - Creative Commons Attribution Share Alike 1.0 Generic - - - - - Creative Commons Attribution Share Alike 2.0 England and Wales - - - - - Creative Commons Attribution Share Alike 2.0 Generic - - - - - Creative Commons Attribution Share Alike 2.1 Japan - - - - - Creative Commons Attribution No Derivatives 2.0 Generic - - - - - Creative Commons Attribution-Share Alike 3.0 Austria - - - - - Creative Commons Attribution Share Alike 3.0 Unported - - - - - Creative Commons Attribution Share Alike 4.0 International - - - - - Creative Commons Attribution Share Alike 2.5 Generic - - - - - Creative Commons Attribution 3.0 Unported - - - - - Common Development and Distribution License 1.0 - - - - - Creative Commons Zero v1.0 Universal - - - - - Creative Commons Attribution Non Commercial No Derivatives 2.5 Generic - - - - - Creative Commons Attribution Non Commercial Share Alike 1.0 Generic - - - - - Caldera License - - - - - Community Data License Agreement Permissive 1.0 - - - - - Creative Commons Attribution 4.0 International - - - - - Creative Commons Public Domain Dedication and Certification - - - - - BSD-4-Clause (University of California-Specific) - - - - - BSD 4-Clause "Original" or "Old" License - - - - - Cryptographic Autonomy License 1.0 - - - - - Common Development and Distribution License 1.1 - - - - - CERN Open Hardware Licence v1.2 - - - - - CERN Open Hardware Licence v1.1 - - - - - CERN Open Hardware Licence Version 2 - Permissive - - - - - CERN Open Hardware Licence Version 2 - Strongly Reciprocal - - - - - CeCILL Free Software License Agreement v1.1 - - - - - CeCILL Free Software License Agreement v2.0 - - - - - CeCILL Free Software License Agreement v1.0 - - - - - CNRI Python License - - - - - CNRI Python Open Source GPL Compatible License Agreement - - - - - copyleft-next 0.3.0 - - - - - Common Public Attribution License 1.0 - - - - - copyleft-next 0.3.1 - - - - - Common Public License 1.0 - - - - - Clarified Artistic License - - - - - CeCILL-C Free Software License Agreement - - - - - CNRI Jython License - - - - - Condor Public License v1.1 - - - - - Code Project Open License 1.02 - - - - - curl License - - - - - diffmark license - - - - - Crossword License - - - - - Dotseqn License - - - - - DOC License - - - - - DSDP License - - - - - Detection Rule License 1.0 - - - - - Educational Community License v1.0 - - - - - Educational Community License v2.0 - - - - - eCos license version 2.0 - - - - - CrystalStacker License - - - - - CERN Open Hardware Licence Version 2 - Weakly Reciprocal - - - - - Deutsche Freie Software Lizenz - - - - - eGenix.com Public License 1.1.0 - - - - - EPICS Open License - - - - - Entessa Public License v1.0 - - - - - Eclipse Public License 1.0 - - - - - Eiffel Forum License v2.0 - - - - - CUA Office Public License v1.0 - - - - - Etalab Open License 2.0 - - - - - European Union Public License 1.0 - - - - - Erlang Public License v1.1 - - - - - EU DataGrid Software License - - - - - European Union Public License 1.1 - - - - - Cube License - - - - - dvipdfm License - - - - - FreeBSD Documentation License - - - - - Eurosym License - - - - - FSF All Permissive License - - - - - FreeImage Public License v1.0 - - - - - FSF Unlimited License (with License Retention) - - - - - FSF Unlimited License - - - - - GD License - - - - - GNU Free Documentation License v1.1 only - invariants - - - - - European Union Public License 1.2 - - - - - Eclipse Public License 2.0 - - - - - GNU Free Documentation License v1.1 or later - no invariants - - - - - GNU Free Documentation License v1.1 only - - - - - GNU Free Documentation License v1.1 or later - - - - - GNU Free Documentation License v1.1 - - - - - Freetype Project License - - - - - GNU Free Documentation License v1.2 or later - invariants - - - - - GNU Free Documentation License v1.1 or later - invariants - - - - - GNU Free Documentation License v1.2 only - invariants - - - - - GNU Free Documentation License v1.2 only - - - - - GNU Free Documentation License v1.2 or later - - - - - GNU Free Documentation License v1.2 - - - - - GNU Free Documentation License v1.2 only - no invariants - - - - - GNU Free Documentation License v1.3 only - invariants - - - - - GNU Free Documentation License v1.3 only - no invariants - - - - - GNU Free Documentation License v1.3 or later - invariants - - - - - GNU Free Documentation License v1.2 or later - no invariants - - - - - Fair License - - - - - Frameworx Open License 1.0 - - - - - Giftware License - - - - - GNU Free Documentation License v1.1 only - no invariants - - - - - GL2PS License - - - - - Glulxe License - - - - - 3dfx Glide License - - - - - gnuplot License - - - - - Good Luck With That Public License - - - - - GNU General Public License v1.0 only - - - - - GNU General Public License v1.0 or later - - - - - GNU General Public License v1.0 only - - - - - GNU Free Documentation License v1.3 only - - - - - GNU General Public License v2.0 only - - - - - GNU General Public License v2.0 or later + Mup License @@ -1012,224 +22,14 @@ GNU General Public License v2.0 w/Autoconf exception - + - GNU General Public License v2.0 or later + Open LDAP Public License v2.1 - + - GNU Free Documentation License v1.3 - - - - - GNU General Public License v1.0 or later - - - - - Community Data License Agreement Sharing 1.0 - - - - - GNU General Public License v2.0 w/Classpath exception - - - - - GNU General Public License v2.0 w/GCC Runtime Library exception - - - - - GNU General Public License v2.0 w/Bison exception - - - - - GNU General Public License v2.0 w/Font exception - - - - - GNU General Public License v2.0 only - - - - - CeCILL Free Software License Agreement v2.1 - - - - - GNU General Public License v3.0 only - - - - - GNU General Public License v3.0 or later - - - - - GNU General Public License v3.0 w/Autoconf exception - - - - - GNU General Public License v3.0 only - - - - - Hippocratic License 2.1 - - - - - Historical Permission Notice and Disclaimer - - - - - HTML Tidy License - - - - - GNU General Public License v3.0 w/GCC Runtime Library exception - - - - - Haskell Language Report License - - - - - GNU General Public License v3.0 or later - - - - - ICU License - - - - - ImageMagick License - - - - - iMatix Standard Function Library Agreement - - - - - IBM PowerPC Initialization and Boot Software - - - - - Intel ACPI Software License Agreement - - - - - Intel Open Source License - - - - - Info-ZIP License - - - - - IPA Font License - - - - - Independent JPEG Group License - - - - - ISC License - - - - - JasPer License - - - - - Japan Network Information Center License - - - - - JSON License - - - - - Licence Art Libre 1.2 - - - - - Licence Art Libre 1.3 - - - - - Latex2e License - - - - - Leptonica License - - - - - Historical Permission Notice and Disclaimer - sell variant - - - - - GNU Library General Public License v2 only - - - - - GNU Library General Public License v2 or later - - - - - Imlib2 License - - - - - IBM Public License v1.0 - - - - - GNU Lesser General Public License v2.1 only - - - - - GNU Lesser General Public License v2.1 or later + Creative Commons Attribution Non Commercial Share Alike 3.0 IGO @@ -1237,144 +37,54 @@ GNU Library General Public License v2 or later - + - GNU Library General Public License v2 only + XPP License - + - CeCILL-B Free Software License Agreement + SIL Open Font License 1.1 - + - GNU Lesser General Public License v3.0 or later + CNRI Python License - + - GNU Lesser General Public License v3.0 only + Linux man-pages Copyleft - + - Lesser General Public License For Linguistic Resources + Open LDAP Public License v2.2 - + - PNG Reference Library version 2 + Open Software License 1.1 - + - libpng License + Eclipse Public License 2.0 - + - libselinux public domain notice + Academic Free License v1.1 - + - GNU Lesser General Public License v3.0 or later + Affero General Public License v1.0 or later - + - Eiffel Forum License v1.0 - - - - - libtiff License - - - - - GNU Free Documentation License v1.3 or later - no invariants - - - - - Licence Libre du Québec – Réciprocité forte version 1.1 - - - - - Licence Libre du Québec – Réciprocité version 1.1 - - - - - Lucent Public License Version 1.0 - - - - - Licence Libre du Québec – Permissive version 1.1 - - - - - Linux Kernel Variant of OpenIB.org license - - - - - LaTeX Project Public License v1.0 - - - - - LaTeX Project Public License v1.2 - - - - - LaTeX Project Public License v1.3a - - - - - Lucent Public License v1.02 - - - - - LaTeX Project Public License v1.3c - - - - - MakeIndex License - - - - - GNU Library General Public License v2.1 or later - - - - - LaTeX Project Public License v1.1 - - - - - CMU License - - - - - The MirOS Licence - - - - - Enlightenment License (e16) + Good Luck With That Public License @@ -1382,54 +92,59 @@ MIT License Modern Variant - + - MIT License + BSD 1-Clause License - + - enna License + SGI Free Software License B v1.0 - + - MIT Open Group variant + Open Market License - + - feh License + psfrag License - + - MIT +no-false-attribs license + Artistic License 1.0 - + - Mozilla Public License 1.0 + Creative Commons Public Domain Dedication and Certification - + - mpich2 License + eGenix.com Public License 1.1.0 - + - Mozilla Public License 2.0 + European Union Public License 1.1 - + - Mozilla Public License 2.0 (no copyleft exception) + Sendmail License - + - Microsoft Reciprocal License + Python Software Foundation License 2.0 + + + + + Open Government Licence v1.0 @@ -1437,11 +152,1681 @@ Matrix Template Library License + + + Nara Institute of Science and Technology License (2003) + + + + + ANTLR Software Rights Notice with license fallback + + + + + PostgreSQL License + + + + + Open Software License 1.0 + + + + + Nethack General Public License + + + + + Creative Commons Attribution Non Commercial No Derivatives 4.0 International + + + + + Code Project Open License 1.02 + + + + + FSF Unlimited License (with License Retention) + + + + + GNU Free Documentation License v1.2 only - no invariants + + + + + Net-SNMP License + + + + + Amazon Digital Services License + + + + + Sendmail License 8.23 + + + + + CNRI Jython License + + + + + Reciprocal Public License 1.5 + + + + + BSD-2-Clause Plus Patent License + + + + + SIL Open Font License 1.1 with no Reserved Font Name + + + + + Apple Public Source License 1.2 + + + + + Open LDAP Public License v2.4 + + + + + Mozilla Public License 2.0 (no copyleft exception) + + + + + ISC License + + + + + Creative Commons Attribution Share Alike 2.5 Generic + + + + + Sleepycat License + + + + + CUA Office Public License v1.0 + + + + + Frameworx Open License 1.0 + + + + + Common Public Attribution License 1.0 + + + + + Norwegian Licence for Open Government Data (NLOD) 2.0 + + + + + Creative Commons Attribution Non Commercial 2.0 Generic + + + + + GNU Free Documentation License v1.1 or later - no invariants + + + + + Creative Commons Attribution 2.5 Generic + + + + + Newsletr License + + + + + The Parity Public License 7.0.0 + + + + + Leptonica License + + + + + CMU License + + + + + Adobe Postscript AFM License + + + + + Creative Commons Attribution Non Commercial 2.5 Generic + + + + + Cryptographic Autonomy License 1.0 (Combined Work Exception) + + + + + BSD 4 Clause Shortened + + + + + Netscape Public License v1.1 + + + + + Qhull License + + + + + CeCILL-C Free Software License Agreement + + + + + GNU General Public License v1.0 only + + + + + Creative Commons Attribution Non Commercial No Derivatives 3.0 Germany + + + + + Creative Commons Attribution Non Commercial Share Alike 3.0 Unported + + + + + Creative Commons Attribution Non Commercial Share Alike 1.0 Generic + + + + + MIT Open Group variant + + + + + Multics License + + + + + Scheme Widget Library (SWL) Software License Agreement + + + + + GNU General Public License v1.0 or later + + + + + GNU General Public License v3.0 or later + + + + + DOC License + + + + + PHP License v3.0 + + + + + Sun Industry Standards Source License v1.2 + + + + + Common Documentation License 1.0 + + + + + Lucent Public License Version 1.0 + + + + + Red Hat eCos Public License v1.1 + + + + + Licence Art Libre 1.3 + + + + + Creative Commons Attribution Share Alike 3.0 Germany + + + + + Community Data License Agreement Permissive 1.0 + + + + + gnuplot License + + + + + App::s2p License + + + + + iMatix Standard Function Library Agreement + + + + + Microsoft Public License + + + + + eCos license version 2.0 + + + + + BSD 3-Clause "New" or "Revised" License + + + + + Creative Commons Attribution Non Commercial No Derivatives 3.0 IGO + + + + + ICU License + + + + + GNU Affero General Public License v3.0 or later + + + + + Creative Commons Attribution Share Alike 2.1 Japan + + + + + Creative Commons Attribution Non Commercial Share Alike 4.0 International + + + + + The Unlicense + + + + + Creative Commons Attribution Non Commercial 3.0 Germany + + + + + Open LDAP Public License v1.4 + + + + + CERN Open Hardware Licence Version 2 - Weakly Reciprocal + + + + + SugarCRM Public License v1.1.3 + + + + + IPA Font License + + + + + Academic Free License v2.0 + + + + + Unicode License Agreement - Data Files and Software (2016) + + + + + Creative Commons Attribution Non Commercial No Derivatives 3.0 Unported + + + + + CERN Open Hardware Licence Version 2 - Permissive + + + + + Creative Commons Attribution Non Commercial 3.0 Unported + + + + + Copyfree Open Innovation License + + + + + Cryptographic Autonomy License 1.0 + + + + + Licence Libre du Québec – Permissive version 1.1 + + + + + SIL Open Font License 1.1 with Reserved Font Name + + + + + Lucent Public License v1.02 + + + + + Open LDAP Public License v1.3 + + + + + Taiwan Open Government Data License, version 1.0 + + + + + Creative Commons Attribution Non Commercial Share Alike 2.0 Generic + + + + + Python License 2.0 + + + + + NTP No Attribution + + + + + FSF All Permissive License + + + + + Erlang Public License v1.1 + + + + + Barr License + + + + + Creative Commons Attribution 3.0 United States + + + + + BSD 3-Clause No Nuclear License 2014 + + + + + No Limit Public License + + + + + BSD 3-Clause Clear License + + + + + SGI Free Software License B v1.1 + + + + + Open Data Commons Public Domain Dedication & License 1.0 + + + + + Common Development and Distribution License 1.0 + + + + + GNU Lesser General Public License v2.1 or later + + + + + Blue Oak Model License 1.0.0 + + + + + Creative Commons Attribution-NonCommercial-ShareAlike 2.0 France + + + + + Fraunhofer FDK AAC Codec Library + + + + + Standard ML of New Jersey License + + + + + Affero General Public License v1.0 only + + + + + CeCILL Free Software License Agreement v1.0 + + + + + Attribution Assurance License + + + + + GNU General Public License v2.0 w/Font exception + + + + + Info-ZIP License + + + + + SSH OpenSSH license + + + + + SSH short notice + + + + + GNU General Public License v2.0 or later + + + + + Clarified Artistic License + + + + + SNIA Public License 1.1 + + + + + GNU Free Documentation License v1.1 only - invariants + + + + + BSD 3-Clause No Military License + + + + + GNU Free Documentation License v1.1 + + Mozilla Public License 1.1 + + + Open LDAP Public License v1.1 + + + + + JSON License + + + + + GNU Free Documentation License v1.3 only - no invariants + + + + + OCLC Research Public License 2.0 + + + + + Open LDAP Public License v2.0.1 + + + + + FreeBSD Documentation License + + + + + GNU General Public License v1.0 or later + + + + + Yahoo! Public License v1.1 + + + + + Common Public License 1.0 + + + + + Apache License 1.0 + + + + + SIL Open Font License 1.0 + + + + + Creative Commons Attribution 4.0 International + + + + + DSDP License + + + + + IBM PowerPC Initialization and Boot Software + + + + + MIT No Attribution + + + + + Detection Rule License 1.0 + + + + + zlib License + + + + + Adaptive Public License 1.0 + + + + + Sybase Open Watcom Public License 1.0 + + + + + GNU General Public License v2.0 w/GCC Runtime Library exception + + + + + European Union Public License 1.2 + + + + + FSF Unlimited License + + + + + NASA Open Source Agreement 1.3 + + + + + BSD 2-Clause "Simplified" License + + + + + XFree86 License 1.1 + + + + + Eurosym License + + + + + Open LDAP Public License v2.8 + + + + + dvipdfm License + + + + + NIST Public Domain Notice + + + + + Apache License 1.1 + + + + + The Parity Public License 6.0.0 + + + + + Creative Commons Attribution 2.0 Generic + + + + + GNU Lesser General Public License v3.0 or later + + + + + BSD 2-Clause with views sentence + + + + + GNU General Public License v2.0 w/Classpath exception + + + + + BSD 3-Clause No Nuclear Warranty + + + + + X11 License + + + + + Community Data License Agreement Permissive 2.0 + + + + + Haskell Language Report License + + + + + Artistic License 1.0 w/clause 8 + + + + + Apple Public Source License 2.0 + + + + + GNU General Public License v3.0 or later + + + + + Solderpad Hardware License v0.5 + + + + + CNRI Python Open Source GPL Compatible License Agreement + + + + + Condor Public License v1.1 + + + + + Open LDAP Public License v2.3 + + + + + GNU General Public License v2.0 only + + + + + Business Source License 1.1 + + + + + Licence Libre du Québec – Réciprocité version 1.1 + + + + + Academy of Motion Picture Arts and Sciences BSD + + + + + copyleft-next 0.3.1 + + + + + GNU Free Documentation License v1.3 or later - invariants + + + + + Open LDAP Public License v2.7 + + + + + Open Software License 2.0 + + + + + Unicode License Agreement - Data Files and Software (2015) + + + + + Computer Associates Trusted Open Source License 1.1 + + + + + Ricoh Source Code Public License + + + + + PNG Reference Library version 2 + + + + + LaTeX Project Public License v1.1 + + + + + Community Data License Agreement Sharing 1.0 + + + + + Glulxe License + + + + + GNU Free Documentation License v1.3 or later - no invariants + + + + + Open LDAP Public License v1.2 + + + + + Common Development and Distribution License 1.1 + + + + + CERN Open Hardware Licence v1.1 + + + + + BSD Source Code Attribution + + + + + Independent JPEG Group License + + + + + Zimbra Public License v1.4 + + + + + BSD Zero Clause License + + + + + Creative Commons Attribution 1.0 Generic + + + + + wxWindows Library License + + + + + Zope Public License 2.1 + + + + + NTP License + + + + + Artistic License 1.0 (Perl) + + + + + Creative Commons Attribution No Derivatives 2.0 Generic + + + + + Creative Commons Attribution No Derivatives 4.0 International + + + + + Adobe Systems Incorporated Source Code License Agreement + + + + + Eclipse Public License 1.0 + + + + + diffmark license + + + + + xinetd License + + + + + Plexus Classworlds License + + + + + Japan Network Information Center License + + + + + Adobe Glyph List License + + + + + Cube License + + + + + TCP Wrappers License + + + + + Creative Commons Attribution Share Alike 1.0 Generic + + + + + BSD 2-Clause FreeBSD License + + + + + Open Government Licence - Canada + + + + + ANTLR Software Rights Notice + + + + + GNU Library General Public License v2.1 or later + + + + + Open Software License 2.1 + + + + + psutils License + + + + + SCEA Shared Source License + + + + + The MirOS Licence + + + + + Hippocratic License 2.1 + + + + + GNU Free Documentation License v1.2 only - invariants + + + + + GNU Lesser General Public License v2.1 only + + + + + Entessa Public License v1.0 + + + + + Microsoft Reciprocal License + + + + + libselinux public domain notice + + + + + GNU Library General Public License v2 only + + + + + Open LDAP Public License v2.5 + + + + + Imlib2 License + + + + + libpng License + + + + + Scheme Language Report License + + + + + Mozilla Public License 1.0 + + + + + Sax Public Domain Notice + + + + + Norwegian Licence for Open Government Data (NLOD) 1.0 + + + + + Simple Public License 2.0 + + + + + Technische Universitaet Berlin License 1.0 + + + + + GNU Free Documentation License v1.1 only - no invariants + + + + + Creative Commons Attribution No Derivatives 3.0 Germany + + + + + MakeIndex License + + + + + EPICS Open License + + + + + GNU Free Documentation License v1.3 only - invariants + + + + + XSkat License + + + + + bzip2 and libbzip2 License v1.0.5 + + + + + Community Specification License 1.0 + + + + + GL2PS License + + + + + Historical Permission Notice and Disclaimer + + + + + bzip2 and libbzip2 License v1.0.6 + + + + + Creative Commons Attribution Non Commercial 1.0 Generic + + + + + Fair License + + + + + CeCILL-B Free Software License Agreement + + + + + 3dfx Glide License + + + + + Creative Commons Attribution Share Alike 4.0 International + + + + + Creative Commons Zero v1.0 Universal + + + + + enna License + + + + + Wsuipa License + + + + + RSA Message-Digest License + + + + + VOSTROM Public License for Open Source + + + + + Open Use of Data Agreement v1.0 + + + + + CERN Open Hardware Licence Version 2 - Strongly Reciprocal + + + + + X11 License Distribution Modification Variant + + + + + copyleft-next 0.3.0 + + + + + Zimbra Public License v1.3 + + + + + NIST Public Domain Notice with license fallback + + + + + Nokia Open Source License + + + + + Academic Free License v2.1 + + + + + Zope Public License 2.0 + + + + + Open Data Commons Open Database License v1.0 + + + + + zlib/libpng License with Acknowledgement + + + + + PHP License v3.01 + + + + + Afmparse License + + + + + Historical Permission Notice and Disclaimer - sell variant + + + + + PolyForm Small Business License 1.0.0 + + + + + IBM Public License v1.0 + + + + + CeCILL Free Software License Agreement v1.1 + + + + + feh License + + + + + SIL Open Font License 1.0 with Reserved Font Name + + + + + TMate Open Source License + + + + + BSD 3-Clause No Nuclear License + + + + + W3C Software Notice and License (1998-07-20) + + + + + Sun Public License v1.0 + + + + + NetCDF license + + + + + Aladdin Free Public License + + + + + AMD's plpa_map.c License + + + + + CrystalStacker License + + + + + Intel ACPI Software License Agreement + + + + + CERN Open Hardware Licence v1.2 + + + + + Creative Commons Attribution Non Commercial Share Alike 3.0 Germany + + + + + MIT License + + + + + Zed License + + + + + Open LDAP Public License v2.0 (or possibly 2.0A and 2.0B) + + + + + Mulan Permissive Software License, Version 1 + + + + + Eiffel Forum License v2.0 + + + + + Latex2e License + + + + + Spencer License 94 + + + + + Open Public License v1.0 + + + + + Creative Commons Attribution Non Commercial 4.0 International + + + + + GNU Lesser General Public License v3.0 or later + + + + + Universal Permissive License v1.0 + + + + + University of Illinois/NCSA Open Source License + + + + + SGI Free Software License B v2.0 + + + + + GNU General Public License v3.0 w/GCC Runtime Library exception + + + + + Zend License v2.0 + + + + + ImageMagick License + + + + + Open LDAP Public License v2.6 + + + + + Unicode Terms of Use + + + + + GNU General Public License v3.0 only + + + + + Artistic License 2.0 + + + + + SQLite Blessing + + + + + Etalab Open License 2.0 + + + + + GNU Free Documentation License v1.2 only + + + + + LaTeX Project Public License v1.0 + + + + + Rdisc License + + + + + BSD 3-Clause Modification + + + + + Xerox License + + + + + Mozilla Public License 2.0 + + + + + BitTorrent Open Source License v1.1 + + + + + Creative Commons Attribution Non Commercial No Derivatives 2.0 Generic + + + + + Sun Industry Standards Source License v1.1 + + + + + libtiff License + + + + + Creative Commons Attribution Non Commercial Share Alike 2.0 England and Wales + + + + + Deutsche Freie Software Lizenz + + + + + LaTeX Project Public License v1.2 + + + + + TAPR Open Hardware License v1.0 + + + + + European Union Public License 1.0 + + + + + Solderpad Hardware License, Version 0.51 + + + + + Freetype Project License + + + + + W3C Software Notice and Document License (2015-05-13) + + + + + OSET Public License version 2.1 + + + + + EU DataGrid Software License + + + + + Upstream Compatibility License v1.0 + + + + + Borceux license + + + + + Elastic License 2.0 + + + + + BSD 2-Clause NetBSD License + + + + + BSD 3-Clause Open MPI variant + + + + + Open Software License 3.0 + + + + + curl License + + + + + Spencer License 86 + + + + + Boost Software License 1.0 + + + + + Standard ML of New Jersey License + + + + + Trusster Open Source License + + + + + Netizen Open Source License + + + + + Academic Free License v1.2 + + Mulan Permissive Software License, Version 2 @@ -1452,679 +1837,24 @@ Motosoto License - + - Mup License + Creative Commons Attribution Non Commercial Share Alike 2.5 Generic - + - Mulan Permissive Software License, Version 1 + JasPer License - + - Nara Institute of Science and Technology License (2003) + BSD-4-Clause (University of California-Specific) - + - Naumen Public License - - - - - Multics License - - - - - Net Boolean Public License v1 - - - - - University of Illinois/NCSA Open Source License - - - - - Net-SNMP License - - - - - NetCDF license - - - - - NASA Open Source Agreement 1.3 - - - - - Nethack General Public License - - - - - NIST Public Domain Notice with license fallback - - - - - NIST Public Domain Notice - - - - - Newsletr License - - - - - No Limit Public License - - - - - Nokia Open Source License - - - - - Netizen Open Source License - - - - - Noweb License - - - - - Norwegian Licence for Open Government Data - - - - - Netscape Public License v1.0 - - - - - Non-Commercial Government Licence - - - - - NRL License - - - - - NTP No Attribution - - - - - NTP License - - - - - GNU Free Documentation License v1.3 or later - - - - - Nunit License - - - - - Open Use of Data Agreement v1.0 - - - - - Netscape Public License v1.1 - - - - - Open CASCADE Technology Public License - - - - - Open Data Commons Attribution License v1.0 - - - - - SIL Open Font License 1.0 with no Reserved Font Name - - - - - OCLC Research Public License 2.0 - - - - - SIL Open Font License 1.0 with Reserved Font Name - - - - - SIL Open Font License 1.0 - - - - - SIL Open Font License 1.1 with no Reserved Font Name - - - - - SIL Open Font License 1.1 with Reserved Font Name - - - - - SIL Open Font License 1.1 - - - - - Taiwan Open Government Data License, version 1.0 - - - - - OGC Software License, Version 1.0 - - - - - Open Government Licence v1.0 - - - - - Open Government Licence v2.0 - - - - - Open Government Licence v3.0 - - - - - Open Group Test Suite License - - - - - Open LDAP Public License v1.1 - - - - - Open LDAP Public License v1.2 - - - - - Open LDAP Public License v1.3 - - - - - Open Government Licence - Canada - - - - - Open LDAP Public License v2.0.1 - - - - - Open LDAP Public License v2.0 (or possibly 2.0A and 2.0B) - - - - - Open LDAP Public License v2.1 - - - - - Open LDAP Public License v2.2.1 - - - - - Open LDAP Public License 2.2.2 - - - - - Open LDAP Public License v2.2 - - - - - Open Data Commons Open Database License v1.0 - - - - - Open LDAP Public License v2.4 - - - - - Open LDAP Public License v1.4 - - - - - Open LDAP Public License v2.3 - - - - - Open LDAP Public License v2.7 - - - - - Open LDAP Public License v2.8 - - - - - Open Market License - - - - - OpenSSL License - - - - - Open LDAP Public License v2.6 - - - - - Open Public License v1.0 - - - - - Open Software License 1.0 - - - - - Open Software License 1.1 - - - - - Open Software License 2.0 - - - - - OSET Public License version 2.1 - - - - - Open Software License 2.1 - - - - - The Parity Public License 6.0.0 - - - - - The Parity Public License 7.0.0 - - - - - Open Data Commons Public Domain Dedication & License 1.0 - - - - - PHP License v3.0 - - - - - Open Software License 3.0 - - - - - Plexus Classworlds License - - - - - Microsoft Public License - - - - - PolyForm Small Business License 1.0.0 - - - - - PolyForm Noncommercial License 1.0.0 - - - - - Python Software Foundation License 2.0 - - - - - psfrag License - - - - - PostgreSQL License - - - - - psutils License - - - - - Qhull License - - - - - Q Public License 1.0 - - - - - Rdisc License - - - - - Python License 2.0 - - - - - Reciprocal Public License 1.1 - - - - - Reciprocal Public License 1.5 - - - - - Red Hat eCos Public License v1.1 - - - - - RSA Message-Digest License - - - - - Ricoh Source Code Public License - - - - - Ruby License - - - - - Sax Public Domain Notice - - - - - Saxpath License - - - - - SCEA Shared Source License - - - - - Sendmail License 8.23 - - - - - Sendmail License - - - - - SGI Free Software License B v1.0 - - - - - SGI Free Software License B v1.1 - - - - - SGI Free Software License B v2.0 - - - - - Solderpad Hardware License v0.5 - - - - - Solderpad Hardware License, Version 0.51 - - - - - Simple Public License 2.0 - - - - - Sun Industry Standards Source License v1.2 - - - - - Sun Industry Standards Source License v1.1 - - - - - Sleepycat License - - - - - Standard ML of New Jersey License - - - - - Secure Messaging Protocol Public License - - - - - SNIA Public License 1.1 - - - - - Spencer License 86 - - - - - Spencer License 94 - - - - - Spencer License 99 - - - - - Sun Public License v1.0 - - - - - SSH OpenSSH license - - - - - PHP License v3.01 - - - - - SSH short notice - - - - - MIT No Attribution - - - - - RealNetworks Public Source License v1.0 - - - - - Scheme Widget Library (SWL) Software License Agreement - - - - - SugarCRM Public License v1.1.3 - - - - - TCL/TK License - - - - - TCP Wrappers License - - - - - Server Side Public License, v 1 - - - - - TMate Open Source License - - - - - Trusster Open Source License - - - - - TORQUE v2.5+ Software License v1.1 - - - - - TAPR Open Hardware License v1.0 - - - - - Upstream Compatibility License v1.0 - - - - - Unicode License Agreement - Data Files and Software (2015) - - - - - Unicode License Agreement - Data Files and Software (2016) - - - - - Unicode Terms of Use - - - - - Technische Universitaet Berlin License 1.0 - - - - - Universal Permissive License v1.0 - - - - - The Unlicense - - - - - VOSTROM Public License for Open Source - - - - - Vim License + Bahyph License @@ -2132,54 +1862,29 @@ Vovida Software License v1.0 - - - W3C Software Notice and Document License (2015-05-13) - - W3C Software Notice and License (2002-12-31) - + - W3C Software Notice and License (1998-07-20) + Open Data Commons Attribution License v1.0 - + - Wsuipa License + BitTorrent Open Source License v1.0 - + - Sybase Open Watcom Public License 1.0 + Open Government Licence v2.0 - + - Do What The F*ck You Want To Public License - - - - - X11 License - - - - - Xerox License - - - - - XFree86 License 1.1 - - - - - xinetd License + GNU Lesser General Public License v3.0 only @@ -2187,54 +1892,14 @@ X.Net License - + - XPP License + Ruby License - + - XSkat License - - - - - Yahoo! Public License v1.0 - - - - - Yahoo! Public License v1.1 - - - - - Zed License - - - - - Zend License v2.0 - - - - - Technische Universitaet Berlin License 2.0 - - - - - Zimbra Public License v1.4 - - - - - zlib/libpng License with Acknowledgement - - - - - zlib License + GNU Free Documentation License v1.3 @@ -2242,24 +1907,509 @@ Zope Public License 1.1 - + - Zope Public License 2.0 + Open CASCADE Technology Public License - + - Zope Public License 2.1 + LaTeX Project Public License v1.3c - + - wxWindows Library License + Apache License 2.0 - + - Zimbra Public License v1.3 + GD License + + + + + Creative Commons Attribution 3.0 Netherlands + + + + + LaTeX Project Public License v1.3a + + + + + Creative Commons Attribution 2.5 Australia + + + + + GNU Free Documentation License v1.1 only + + + + + GNU Free Documentation License v1.1 or later + + + + + Open Government Licence v3.0 + + + + + Yahoo! Public License v1.0 + + + + + Reciprocal Public License 1.1 + + + + + GNU Library General Public License v2 or later + + + + + Open Publication License v1.0 + + + + + Noweb License + + + + + Academic Free License v3.0 + + + + + Nunit License + + + + + Creative Commons Attribution 3.0 Unported + + + + + Beerware License + + + + + Caldera License + + + + + GNU General Public License v1.0 only + + + + + GNU General Public License v2.0 or later + + + + + Non-Commercial Government Licence + + + + + Creative Commons Attribution No Derivatives 2.5 Generic + + + + + GNU General Public License v2.0 only + + + + + Intel Open Source License + + + + + Vim License + + + + + Creative Commons Attribution Share Alike 2.0 Generic + + + + + MIT +no-false-attribs license + + + + + Apple Public Source License 1.1 + + + + + GNU Free Documentation License v1.2 or later + + + + + BSD with attribution + + + + + SIL Open Font License 1.0 with no Reserved Font Name + + + + + Naumen Public License + + + + + Creative Commons Attribution Non Commercial No Derivatives 2.5 Generic + + + + + Computational Use of Data Agreement v1.0 + + + + + Lesser General Public License For Linguistic Resources + + + + + mpich2 License + + + + + Apple Public Source License 1.0 + + + + + Linux Kernel Variant of OpenIB.org license + + + + + Enlightenment License (e16) + + + + + GNU Free Documentation License v1.2 + + + + + Open Group Test Suite License + + + + + Dotseqn License + + + + + Data licence Germany – attribution – version 2.0 + + + + + Saxpath License + + + + + GNU Affero General Public License v3.0 + + + + + Abstyles License + + + + + Creative Commons Attribution Share Alike 3.0 Unported + + + + + Giftware License + + + + + FreeImage Public License v1.0 + + + + + CeCILL Free Software License Agreement v2.1 + + + + + RealNetworks Public Source License v1.0 + + + + + GNU Free Documentation License v1.3 or later + + + + + GNU Free Documentation License v1.1 or later - invariants + + + + + Educational Community License v2.0 + + + + + Licence Libre du Québec – Réciprocité forte version 1.1 + + + + + GNU General Public License v3.0 w/Autoconf exception + + + + + Jam License + + + + + GNU Free Documentation License v1.2 or later - no invariants + + + + + CeCILL Free Software License Agreement v2.0 + + + + + PolyForm Noncommercial License 1.0.0 + + + + + OGC Software License, Version 1.0 + + + + + Creative Commons Attribution No Derivatives 3.0 Unported + + + + + Q Public License 1.0 + + + + + Licence Art Libre 1.2 + + + + + Creative Commons Attribution 3.0 Germany + + + + + OpenSSL License + + + + + Spencer License 99 + + + + + Creative Commons Attribution Share Alike 3.0 Austria + + + + + BSD Protection License + + + + + Open LDAP Public License 2.2.2 + + + + + NRL License + + + + + TORQUE v2.5+ Software License v1.1 + + + + + HTML Tidy License + + + + + Server Side Public License, v 1 + + + + + Netscape Public License v1.0 + + + + + GNU Library General Public License v2 only + + + + + GNU Affero General Public License v3.0 only + + + + + GNU Free Documentation License v1.2 or later - invariants + + + + + GNU General Public License v2.0 w/Bison exception + + + + + Creative Commons Attribution Non Commercial No Derivatives 1.0 Generic + + + + + Educational Community License v1.0 + + + + + Do What The F*ck You Want To Public License + + + + + Creative Commons Attribution Share Alike 2.0 England and Wales + + + + + GNU General Public License v3.0 only + + + + + Open LDAP Public License v2.2.1 + + + + + Secure Messaging Protocol Public License + + + + + Creative Commons Attribution 3.0 Austria + + + + + Eiffel Forum License v1.0 + + + + + Net Boolean Public License v1 + + + + + Lawrence Berkeley National Labs BSD variant license + + + + + Affero General Public License v1.0 + + + + + Crossword License + + + + + TCL/TK License + + + + + Creative Commons Attribution No Derivatives 1.0 Generic + + + + + Apple MIT License + + + + + Technische Universitaet Berlin License 2.0 + + + + + GNU Free Documentation License v1.3 only + + + + + Non-Profit Open Software License 3.0 + + + + + BSD 4-Clause "Original" or "Old" License @@ -2267,11 +2417,6 @@ gSOAP Public License v1.3b - - - Interbase Public License v1.0 - - GNU Lesser General Public License v2.1 only @@ -2282,220 +2427,145 @@ GNU Lesser General Public License v3.0 only - - - Non-Profit Open Software License 3.0 - - - - - Open LDAP Public License v2.5 - - - - - Standard ML of New Jersey License - - - - - 389 Directory Server Exception - - - - - Autoconf exception 2.0 - - - - - Autoconf exception 3.0 - - - - - Bison exception 2.2 - - - - - Bootloader Distribution Exception - - - - - Classpath exception 2.0 - - - - - CLISP exception 2.0 - - - - - DigiRule FOSS License Exception - - - - - eCos exception 2.0 - - - - - Fawkes Runtime Exception - - - - - FLTK exception - - - - - Font exception 2.0 - - FreeRTOS Exception 2.0 - - - GCC Runtime Library exception 2.0 - - - - - GCC Runtime Library exception 3.1 - - - - - GNU JavaMail exception - - - - - GPL-3.0 Linking Exception - - - - - GPL-3.0 Linking Exception (with Corresponding Source) - - - - - GPL Cooperation Commitment 1.0 - - - - - i2p GPL+Java Exception - - - - - LGPL-3.0 Linking Exception - - - - - Libtool Exception - - - - - Linux Syscall Note - - - - - LLVM Exception - - - - - LZMA exception - - - - - Macros and Inline Functions Exception - - - - - Nokia Qt LGPL exception 1.1 - - - - - OCaml LGPL Linking Exception - - - - - Open CASCADE Exception 1.0 - - - - - OpenJDK Assembly exception 1.0 - - - - - OpenVPN OpenSSL Exception - - - - - PS/PDF font exception (2017-08-17) - - - - - Qt GPL exception 1.0 - - - - - Qt LGPL exception 1.1 - - - - - Qwt exception 1.0 - - - - - Solderpad Hardware License v2.0 - - - - - Solderpad Hardware License v2.1 - - Swift Exception + + + Qt LGPL exception 1.1 + + + + + GNU JavaMail exception + + + + + CLISP exception 2.0 + + + + + eCos exception 2.0 + + + + + GPL Cooperation Commitment 1.0 + + + + + DigiRule FOSS License Exception + + + + + Font exception 2.0 + + + + + Qt GPL exception 1.0 + + + + + PS/PDF font exception (2017-08-17) + + + + + GPL-3.0 Linking Exception (with Corresponding Source) + + + + + Linux Syscall Note + + + + + GCC Runtime Library exception 2.0 + + + + + LZMA exception + + + + + Autoconf exception 3.0 + + U-Boot exception 2.0 - + - Universal FOSS Exception, Version 1.0 + LLVM Exception + + + + + OCaml LGPL Linking Exception + + + + + Autoconf exception 2.0 + + + + + Bootloader Distribution Exception + + + + + LGPL-3.0 Linking Exception + + + + + OpenVPN OpenSSL Exception + + + + + FLTK exception + + + + + Bison exception 2.2 + + + + + Open CASCADE Exception 1.0 + + + + + GCC Runtime Library exception 3.1 + + + + + OpenJDK Assembly exception 1.0 @@ -2503,7 +2573,67 @@ WxWindows Library Exception 3.1 + + + Fawkes Runtime Exception + + + + + Nokia Qt LGPL exception 1.1 + + + + + Qwt exception 1.0 + + + + + Universal FOSS Exception, Version 1.0 + + + + + Classpath exception 2.0 + + + + + Solderpad Hardware License v2.0 + + + + + GPL-3.0 Linking Exception + + + + + Solderpad Hardware License v2.1 + + + + + Libtool Exception + + + + + Macros and Inline Functions Exception + + + + + 389 Directory Server Exception + + + + + i2p GPL+Java Exception + + - \ No newline at end of file + diff --git a/syft/formats.go b/syft/formats.go index b425ef68a..1e8a44983 100644 --- a/syft/formats.go +++ b/syft/formats.go @@ -4,8 +4,8 @@ import ( "bytes" "strings" - "github.com/anchore/syft/internal/formats/cyclonedx13json" - "github.com/anchore/syft/internal/formats/cyclonedx13xml" + "github.com/anchore/syft/internal/formats/cyclonedxjson" + "github.com/anchore/syft/internal/formats/cyclonedxxml" "github.com/anchore/syft/internal/formats/spdx22json" "github.com/anchore/syft/internal/formats/spdx22tagvalue" "github.com/anchore/syft/internal/formats/syftjson" @@ -19,8 +19,8 @@ const ( JSONFormatID = syftjson.ID TextFormatID = text.ID TableFormatID = table.ID - CycloneDxXMLFormatID = cyclonedx13xml.ID - CycloneDxJSONFormatID = cyclonedx13json.ID + CycloneDxXMLFormatID = cyclonedxxml.ID + CycloneDxJSONFormatID = cyclonedxjson.ID SPDXTagValueFormatID = spdx22tagvalue.ID SPDXJSONFormatID = spdx22json.ID ) @@ -30,8 +30,8 @@ var formats []sbom.Format func init() { formats = []sbom.Format{ syftjson.Format(), - cyclonedx13xml.Format(), - cyclonedx13json.Format(), + cyclonedxxml.Format(), + cyclonedxjson.Format(), spdx22tagvalue.Format(), spdx22json.Format(), table.Format(), @@ -68,9 +68,9 @@ func FormatByName(name string) sbom.Format { case "json", "syftjson": return FormatByID(syftjson.ID) case "cyclonedx", "cyclone", "cyclonedxxml": - return FormatByID(cyclonedx13xml.ID) + return FormatByID(cyclonedxxml.ID) case "cyclonedxjson": - return FormatByID(cyclonedx13json.ID) + return FormatByID(cyclonedxjson.ID) case "spdx", "spdxtv", "spdxtagvalue": return FormatByID(spdx22tagvalue.ID) case "spdxjson": diff --git a/syft/formats_test.go b/syft/formats_test.go index 76cf52586..f55dcce10 100644 --- a/syft/formats_test.go +++ b/syft/formats_test.go @@ -1,8 +1,12 @@ package syft import ( - "github.com/anchore/syft/internal/formats/cyclonedx13json" - "github.com/anchore/syft/internal/formats/cyclonedx13xml" + "io" + "os" + "testing" + + "github.com/anchore/syft/internal/formats/cyclonedxjson" + "github.com/anchore/syft/internal/formats/cyclonedxxml" "github.com/anchore/syft/internal/formats/spdx22json" "github.com/anchore/syft/internal/formats/spdx22tagvalue" "github.com/anchore/syft/internal/formats/syftjson" @@ -10,9 +14,6 @@ import ( "github.com/anchore/syft/internal/formats/text" "github.com/anchore/syft/syft/sbom" "github.com/stretchr/testify/require" - "io" - "os" - "testing" "github.com/stretchr/testify/assert" ) @@ -89,25 +90,25 @@ func TestFormatByName(t *testing.T) { // Cyclonedx JSON { name: "cyclonedx-json", - want: cyclonedx13json.ID, + want: cyclonedxjson.ID, }, { name: "cyclonedx-1-json", - want: cyclonedx13json.ID, + want: cyclonedxjson.ID, }, // Cyclonedx XML { name: "cyclonedx", - want: cyclonedx13xml.ID, + want: cyclonedxxml.ID, }, { name: "cyclonedx-xml", - want: cyclonedx13xml.ID, + want: cyclonedxxml.ID, }, { name: "cyclonedx-1-xml", - want: cyclonedx13xml.ID, + want: cyclonedxxml.ID, }, // Syft Table diff --git a/test/integration/encode_decode_cycle_test.go b/test/integration/encode_decode_cycle_test.go index baffd1847..e12ab8bd6 100644 --- a/test/integration/encode_decode_cycle_test.go +++ b/test/integration/encode_decode_cycle_test.go @@ -2,13 +2,14 @@ package integration import ( "bytes" - "github.com/anchore/syft/internal/formats/cyclonedx13json" - "github.com/anchore/syft/internal/formats/cyclonedx13xml" + "regexp" + "testing" + + "github.com/anchore/syft/internal/formats/cyclonedxjson" + "github.com/anchore/syft/internal/formats/cyclonedxxml" "github.com/anchore/syft/internal/formats/syftjson" "github.com/anchore/syft/syft/sbom" "github.com/stretchr/testify/require" - "regexp" - "testing" "github.com/anchore/syft/syft" @@ -34,7 +35,7 @@ func TestEncodeDecodeEncodeCycleComparison(t *testing.T) { json: true, }, { - formatOption: cyclonedx13json.ID, + formatOption: cyclonedxjson.ID, redactor: func(in []byte) []byte { in = regexp.MustCompile("\"(timestamp|serialNumber|bom-ref)\": \"[^\"]+\",").ReplaceAll(in, []byte{}) return in @@ -42,7 +43,7 @@ func TestEncodeDecodeEncodeCycleComparison(t *testing.T) { json: true, }, { - formatOption: cyclonedx13xml.ID, + formatOption: cyclonedxxml.ID, redactor: func(in []byte) []byte { in = regexp.MustCompile("(serialNumber|bom-ref)=\"[^\"]+\"").ReplaceAll(in, []byte{}) in = regexp.MustCompile("[^<]+").ReplaceAll(in, []byte{})