diff --git a/Makefile b/Makefile index a7c4d7f37854..d218022cf578 100644 --- a/Makefile +++ b/Makefile @@ -74,7 +74,7 @@ all: clean static-analysis test ## Run all checks (linting, license check, unit, @printf '$(SUCCESS)All checks pass!$(RESET)\n' .PHONY: test -test: unit validate-cyclonedx-schema integration cli ## Run all tests (unit, integration, linux acceptance, and CLI tests) +test: unit validate-cyclonedx-schema validate-cyclonedx-vex-schema integration cli ## Run all tests (unit, integration, linux acceptance, and CLI tests) help: @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "$(BOLD)$(CYAN)%-25s$(RESET)%s\n", $$1, $$2}' @@ -96,6 +96,7 @@ bootstrap-tools: $(TEMPDIR) curl -sSfL https://raw.githubusercontent.com/anchore/chronicle/main/install.sh | sh -s -- -b $(TEMPDIR)/ v0.3.0 # the only difference between goimports and gosimports is that gosimports removes extra whitespace between import blocks (see https://github.com/golang/go/issues/20818) GOBIN="$(shell realpath $(TEMPDIR))" go install github.com/rinchsan/gosimports/cmd/gosimports@v0.1.5 + GOBIN="$(shell realpath $(TEMPDIR))" go install github.com/neilpa/yajsv@v1.4.0 .github/scripts/goreleaser-install.sh -b $(TEMPDIR)/ v1.4.1 .PHONY: bootstrap-go @@ -143,6 +144,10 @@ check-go-mod-tidy: validate-cyclonedx-schema: cd schema/cyclonedx && make +.PHONY: validate-cyclonedx-vex-schema +validate-cyclonedx-vex-schema: + cd schema/cyclonedxvex && make + .PHONY: validate-grype-db-schema validate-grype-db-schema: # ensure the codebase is only referencing a single grype-db schema version, multiple is not allowed diff --git a/go.mod b/go.mod index 29630b92f143..755c3b687426 100644 --- a/go.mod +++ b/go.mod @@ -3,6 +3,7 @@ module github.com/anchore/grype go 1.18 require ( + github.com/CycloneDX/cyclonedx-go v0.5.0 github.com/Masterminds/sprig/v3 v3.2.2 github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d github.com/adrg/xdg v0.2.1 @@ -56,7 +57,6 @@ require ( cloud.google.com/go/compute v1.3.0 // indirect cloud.google.com/go/iam v0.1.1 // indirect cloud.google.com/go/storage v1.21.0 // indirect - github.com/CycloneDX/cyclonedx-go v0.5.0 // indirect github.com/Masterminds/goutils v1.1.1 // indirect github.com/Masterminds/semver/v3 v3.1.1 // indirect github.com/Microsoft/go-winio v0.5.1 // indirect diff --git a/grype/presenter/cyclonedxvex/bom_metadata.go b/grype/presenter/cyclonedxvex/bom_metadata.go new file mode 100644 index 000000000000..95c94b2164c9 --- /dev/null +++ b/grype/presenter/cyclonedxvex/bom_metadata.go @@ -0,0 +1,39 @@ +package cyclonedxvex + +import ( + "time" + + "github.com/CycloneDX/cyclonedx-go" + + "github.com/anchore/syft/syft/source" +) + +// NewBomMetadata returns a new BomDescriptor tailored for the current time and "syft" tool details. +func NewBomMetadata(name, version string, srcMetadata *source.Metadata) *cyclonedx.Metadata { + metadata := cyclonedx.Metadata{ + Timestamp: time.Now().Format(time.RFC3339), + Tools: &[]cyclonedx.Tool{ + { + Vendor: "anchore", + Name: name, + Version: version, + }, + }, + } + if srcMetadata != nil { + switch srcMetadata.Scheme { + case source.ImageScheme: + metadata.Component = &cyclonedx.Component{ + Type: "container", + Name: srcMetadata.ImageMetadata.UserInput, + Version: srcMetadata.ImageMetadata.ManifestDigest, + } + case source.DirectoryScheme: + metadata.Component = &cyclonedx.Component{ + Type: "file", + Name: srcMetadata.Path, + } + } + } + return &metadata +} diff --git a/grype/presenter/cyclonedxvex/document.go b/grype/presenter/cyclonedxvex/document.go new file mode 100644 index 000000000000..778521a68060 --- /dev/null +++ b/grype/presenter/cyclonedxvex/document.go @@ -0,0 +1,88 @@ +package cyclonedxvex + +import ( + "github.com/CycloneDX/cyclonedx-go" + "github.com/google/uuid" + + "github.com/anchore/grype/grype/match" + "github.com/anchore/grype/grype/pkg" + "github.com/anchore/grype/grype/vulnerability" + "github.com/anchore/grype/internal" + "github.com/anchore/grype/internal/version" + "github.com/anchore/packageurl-go" + "github.com/anchore/syft/syft/source" +) + +// NewDocument returns a CycloneDX Document object populated with the SBOM and vulnerability findings. +func NewDocument(packages []pkg.Package, matches match.Matches, srcMetadata *source.Metadata, provider vulnerability.MetadataProvider) (*cyclonedx.BOM, error) { + versionInfo := version.FromBuild() + doc := cyclonedx.NewBOM() + doc.SerialNumber = uuid.New().URN() + if srcMetadata != nil { + doc.Metadata = NewBomMetadata(internal.ApplicationName, versionInfo.Version, srcMetadata) + } + + // attach matches + components := []cyclonedx.Component{} + vulnerabilities := []cyclonedx.Vulnerability{} + + for _, p := range packages { + component := getComponent(p) + pkgMatches := matches.GetByPkgID(p.ID) + + if len(pkgMatches) > 0 { + for _, m := range pkgMatches { + v, err := NewVulnerability(m, provider) + if err != nil { + return &cyclonedx.BOM{}, err + } + v.Affects = &[]cyclonedx.Affects{ + { + Ref: component.BOMRef, + }, + } + vulnerabilities = append(vulnerabilities, v) + } + } + // add a *copy* of the Component to the bom document + components = append(components, component) + } + doc.Components = &components + doc.Vulnerabilities = &vulnerabilities + + return doc, nil +} + +func getComponent(p pkg.Package) cyclonedx.Component { + bomRef := string(p.ID) + // try and parse the PURL if possible and append syft id to it, to make + // the purl unique in the BOM. + // TODO: In the future we may want to dedupe by PURL and combine components with + // the same PURL while preserving their unique metadata. + if parsedPURL, err := packageurl.FromString(p.PURL); err == nil { + parsedPURL.Qualifiers = append(parsedPURL.Qualifiers, packageurl.Qualifier{Key: "syft-id", Value: string(p.ID)}) + bomRef = parsedPURL.ToString() + } + // make a new Component (by value) + component := cyclonedx.Component{ + Type: "library", // TODO: this is not accurate, syft does the same thing + Name: p.Name, + Version: p.Version, + PackageURL: p.PURL, + BOMRef: bomRef, + } + + var licenses cyclonedx.Licenses + for _, licenseName := range p.Licenses { + licenses = append(licenses, cyclonedx.LicenseChoice{ + License: &cyclonedx.License{ + Name: licenseName, + }, + }) + } + if len(licenses) > 0 { + // adding licenses to the Component + component.Licenses = &licenses + } + return component +} diff --git a/grype/presenter/cyclonedxvex/presenter.go b/grype/presenter/cyclonedxvex/presenter.go new file mode 100644 index 000000000000..08fe5a2dceef --- /dev/null +++ b/grype/presenter/cyclonedxvex/presenter.go @@ -0,0 +1,52 @@ +package cyclonedxvex + +import ( + "io" + + "github.com/CycloneDX/cyclonedx-go" + + "github.com/anchore/grype/grype/match" + "github.com/anchore/grype/grype/pkg" + "github.com/anchore/grype/grype/vulnerability" + "github.com/anchore/syft/syft/source" +) + +// Presenter writes a CycloneDX report from the given Matches and Scope contents +type Presenter struct { + results match.Matches + packages []pkg.Package + srcMetadata *source.Metadata + metadataProvider vulnerability.MetadataProvider + embedded bool + format cyclonedx.BOMFileFormat +} + +// NewPresenter is a *Presenter constructor +func NewPresenter(results match.Matches, packages []pkg.Package, srcMetadata *source.Metadata, metadataProvider vulnerability.MetadataProvider, embedded bool, format cyclonedx.BOMFileFormat) *Presenter { + return &Presenter{ + results: results, + packages: packages, + metadataProvider: metadataProvider, + srcMetadata: srcMetadata, + embedded: embedded, + format: format, + } +} + +// Present creates a CycloneDX-based reporting +func (pres *Presenter) Present(output io.Writer) error { + bom, err := NewDocument(pres.packages, pres.results, pres.srcMetadata, pres.metadataProvider) + if err != nil { + return err + } + encoder := cyclonedx.NewBOMEncoder(output, pres.format) + encoder.SetPretty(true) + + err = encoder.Encode(bom) + + if err != nil { + return err + } + + return err +} diff --git a/grype/presenter/cyclonedxvex/presenter_test.go b/grype/presenter/cyclonedxvex/presenter_test.go new file mode 100644 index 000000000000..1d005190c12e --- /dev/null +++ b/grype/presenter/cyclonedxvex/presenter_test.go @@ -0,0 +1,186 @@ +package cyclonedxvex + +import ( + "bytes" + "flag" + "regexp" + "testing" + + "github.com/CycloneDX/cyclonedx-go" + "github.com/sergi/go-diff/diffmatchpatch" + + "github.com/anchore/go-testutils" + "github.com/anchore/grype/grype/match" + "github.com/anchore/grype/grype/pkg" + "github.com/anchore/grype/grype/presenter/models" + "github.com/anchore/grype/grype/vulnerability" + "github.com/anchore/stereoscope/pkg/imagetest" + syftPkg "github.com/anchore/syft/syft/pkg" + "github.com/anchore/syft/syft/source" +) + +var update = flag.Bool("update", false, "update the *.golden files for json presenters") + +func createResults() (match.Matches, []pkg.Package) { + + pkg1 := pkg.Package{ + ID: "package-1-id", + Name: "package-1", + Version: "1.0.1", + Type: syftPkg.DebPkg, + } + pkg2 := pkg.Package{ + ID: "package-2-id", + Name: "package-2", + Version: "2.0.1", + Type: syftPkg.DebPkg, + Licenses: []string{ + "MIT", + "Apache-v2", + }, + } + + var match1 = match.Match{ + + Vulnerability: vulnerability.Vulnerability{ + ID: "CVE-1999-0001", + Namespace: "source-1", + }, + Package: pkg1, + Details: []match.Detail{ + { + Type: match.ExactDirectMatch, + Matcher: match.DpkgMatcher, + }, + }, + } + + var match2 = match.Match{ + + Vulnerability: vulnerability.Vulnerability{ + ID: "CVE-1999-0002", + Namespace: "source-2", + }, + Package: pkg2, + Details: []match.Detail{ + { + Type: match.ExactIndirectMatch, + Matcher: match.DpkgMatcher, + SearchedBy: map[string]interface{}{ + "some": "key", + }, + }, + }, + } + + matches := match.NewMatches() + + matches.Add(match1, match2) + + return matches, []pkg.Package{pkg1, pkg2} +} + +func TestCycloneDxPresenterImage(t *testing.T) { + for _, tcase := range []struct { + name string + format cyclonedx.BOMFileFormat + }{ + {name: "json", format: cyclonedx.BOMFileFormatJSON}, + {name: "xml", format: cyclonedx.BOMFileFormatXML}, + } { + t.Run(tcase.name, func(t *testing.T) { + var buffer bytes.Buffer + + matches, packages := createResults() + + img := imagetest.GetFixtureImage(t, "docker-archive", "image-simple") + s, _ := source.NewFromImage(img, "user-input") + + // This accounts for the non-deterministic digest value that we end up with when + // we build a container image dynamically during testing. Ultimately, we should + // use a golden image as a test fixture in place of building this image during + // testing. At that time, this line will no longer be necessary. + // + // This value is sourced from the "version" node in "./test-fixtures/snapshot/TestCycloneDxImgsPresenter.golden" + s.Metadata.ImageMetadata.ManifestDigest = "sha256:2731251dc34951c0e50fcc643b4c5f74922dad1a5d98f302b504cf46cd5d9368" + + pres := NewPresenter(matches, packages, &s.Metadata, models.NewMetadataMock(), true, tcase.format) + // run presenter + err := pres.Present(&buffer) + if err != nil { + t.Fatal(err) + } + + actual := buffer.Bytes() + if *update { + testutils.UpdateGoldenFileContents(t, actual) + } + + var expected = testutils.GetGoldenFileContents(t) + + // remove dynamic values, which are tested independently + actual = redact(actual) + expected = redact(expected) + + if !bytes.Equal(expected, actual) { + dmp := diffmatchpatch.New() + diffs := dmp.DiffMain(string(expected), string(actual), true) + t.Errorf("mismatched output:\n%s", dmp.DiffPrettyText(diffs)) + } + }) + } +} + +func TestCycloneDxPresenterDir(t *testing.T) { + for _, tcase := range []struct { + name string + format cyclonedx.BOMFileFormat + }{ + {name: "json", format: cyclonedx.BOMFileFormatJSON}, + {name: "xml", format: cyclonedx.BOMFileFormatXML}, + } { + t.Run(tcase.name, func(t *testing.T) { + var buffer bytes.Buffer + matches, packages := createResults() + + s, err := source.NewFromDirectory("/some/path") + if err != nil { + t.Fatal(err) + } + pres := NewPresenter(matches, packages, &s.Metadata, models.NewMetadataMock(), true, tcase.format) + + // run presenter + err = pres.Present(&buffer) + if err != nil { + t.Fatal(err) + } + + actual := buffer.Bytes() + if *update { + testutils.UpdateGoldenFileContents(t, actual) + } + + var expected = testutils.GetGoldenFileContents(t) + + // remove dynamic values, which are tested independently + actual = redact(actual) + expected = redact(expected) + + if !bytes.Equal(expected, actual) { + dmp := diffmatchpatch.New() + diffs := dmp.DiffMain(string(expected), string(actual), true) + t.Errorf("mismatched output:\n%s", dmp.DiffPrettyText(diffs)) + } + }) + } +} + +func redact(s []byte) []byte { + serialPattern := regexp.MustCompile(`urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`) + rfc3339Pattern := regexp.MustCompile(`([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]+)?(([Zz])|([\+|\-]([01][0-9]|2[0-3]):[0-5][0-9]))`) + + for _, pattern := range []*regexp.Regexp{serialPattern, rfc3339Pattern} { + s = pattern.ReplaceAll(s, []byte("redacted")) + } + return s +} diff --git a/grype/presenter/cyclonedxvex/test-fixtures/image-simple/Dockerfile b/grype/presenter/cyclonedxvex/test-fixtures/image-simple/Dockerfile new file mode 100644 index 000000000000..62fb151e4973 --- /dev/null +++ b/grype/presenter/cyclonedxvex/test-fixtures/image-simple/Dockerfile @@ -0,0 +1,6 @@ +# Note: changes to this file will result in updating several test values. Consider making a new image fixture instead of editing this one. +FROM scratch +ADD file-1.txt /somefile-1.txt +ADD file-2.txt /somefile-2.txt +# note: adding a directory will behave differently on docker engine v18 vs v19 +ADD target / diff --git a/grype/presenter/cyclonedxvex/test-fixtures/image-simple/file-1.txt b/grype/presenter/cyclonedxvex/test-fixtures/image-simple/file-1.txt new file mode 100644 index 000000000000..985d3408e98c --- /dev/null +++ b/grype/presenter/cyclonedxvex/test-fixtures/image-simple/file-1.txt @@ -0,0 +1 @@ +this file has contents \ No newline at end of file diff --git a/grype/presenter/cyclonedxvex/test-fixtures/image-simple/file-2.txt b/grype/presenter/cyclonedxvex/test-fixtures/image-simple/file-2.txt new file mode 100644 index 000000000000..396d08bbc72f --- /dev/null +++ b/grype/presenter/cyclonedxvex/test-fixtures/image-simple/file-2.txt @@ -0,0 +1 @@ +file-2 contents! \ No newline at end of file diff --git a/grype/presenter/cyclonedxvex/test-fixtures/image-simple/target/really/nested/file-3.txt b/grype/presenter/cyclonedxvex/test-fixtures/image-simple/target/really/nested/file-3.txt new file mode 100644 index 000000000000..f85472c937da --- /dev/null +++ b/grype/presenter/cyclonedxvex/test-fixtures/image-simple/target/really/nested/file-3.txt @@ -0,0 +1,2 @@ +another file! +with lines... \ No newline at end of file diff --git a/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterDir_json.golden b/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterDir_json.golden new file mode 100644 index 000000000000..4e9504c91986 --- /dev/null +++ b/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterDir_json.golden @@ -0,0 +1,104 @@ +{ + "bomFormat": "CycloneDX", + "specVersion": "1.4", + "serialNumber": "urn:uuid:ef5bc559-c07e-46bd-be44-dc400d6ff87b", + "version": 1, + "metadata": { + "timestamp": "2022-03-31T22:50:49+01:00", + "tools": [ + { + "vendor": "anchore", + "name": "grype", + "version": "[not provided]" + } + ], + "component": { + "type": "file", + "name": "/some/path" + } + }, + "components": [ + { + "bom-ref": "package-1-id", + "type": "library", + "name": "package-1", + "version": "1.0.1" + }, + { + "bom-ref": "package-2-id", + "type": "library", + "name": "package-2", + "version": "2.0.1", + "licenses": [ + { + "license": { + "name": "MIT" + } + }, + { + "license": { + "name": "Apache-v2" + } + } + ] + } + ], + "vulnerabilities": [ + { + "id": "CVE-1999-0001", + "source": { + "name": "source-1", + "url": "http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-0001" + }, + "ratings": [ + { + "score": 0, + "severity": "low" + }, + { + "score": 4, + "method": "CVSSv3", + "vector": "another vector" + } + ], + "description": "1999-01 description", + "advisories": [], + "analysis": { + "state": "in_triage" + }, + "affects": [ + { + "ref": "package-1-id" + } + ] + }, + { + "id": "CVE-1999-0002", + "source": { + "name": "source-2", + "url": "http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-0002" + }, + "ratings": [ + { + "score": 0, + "severity": "critical" + }, + { + "score": 1, + "method": "CVSSv2", + "vector": "vector" + } + ], + "description": "1999-02 description", + "advisories": [], + "analysis": { + "state": "in_triage" + }, + "affects": [ + { + "ref": "package-2-id" + } + ] + } + ] +} diff --git a/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterDir_xml.golden b/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterDir_xml.golden new file mode 100644 index 000000000000..f6542aee5901 --- /dev/null +++ b/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterDir_xml.golden @@ -0,0 +1,92 @@ + + + + 2022-03-31T22:50:49+01:00 + + + anchore + grype + [not provided] + + + + /some/path + + + + + package-1 + 1.0.1 + + + package-2 + 2.0.1 + + + MIT + + + Apache-v2 + + + + + + + CVE-1999-0001 + + source-1 + http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-0001 + + + + 0 + low + + + 4 + CVSSv3 + another vector + + + 1999-01 description + + + in_triage + + + + package-1-id + + + + + CVE-1999-0002 + + source-2 + http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-0002 + + + + 0 + critical + + + 1 + CVSSv2 + vector + + + 1999-02 description + + + in_triage + + + + package-2-id + + + + + \ No newline at end of file diff --git a/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterImage_json.golden b/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterImage_json.golden new file mode 100644 index 000000000000..39acc1eac7cd --- /dev/null +++ b/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterImage_json.golden @@ -0,0 +1,105 @@ +{ + "bomFormat": "CycloneDX", + "specVersion": "1.4", + "serialNumber": "urn:uuid:7266e5f9-8e64-464a-b998-fed127984f96", + "version": 1, + "metadata": { + "timestamp": "2022-03-31T22:50:49+01:00", + "tools": [ + { + "vendor": "anchore", + "name": "grype", + "version": "[not provided]" + } + ], + "component": { + "type": "container", + "name": "user-input", + "version": "sha256:2731251dc34951c0e50fcc643b4c5f74922dad1a5d98f302b504cf46cd5d9368" + } + }, + "components": [ + { + "bom-ref": "package-1-id", + "type": "library", + "name": "package-1", + "version": "1.0.1" + }, + { + "bom-ref": "package-2-id", + "type": "library", + "name": "package-2", + "version": "2.0.1", + "licenses": [ + { + "license": { + "name": "MIT" + } + }, + { + "license": { + "name": "Apache-v2" + } + } + ] + } + ], + "vulnerabilities": [ + { + "id": "CVE-1999-0001", + "source": { + "name": "source-1", + "url": "http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-0001" + }, + "ratings": [ + { + "score": 0, + "severity": "low" + }, + { + "score": 4, + "method": "CVSSv3", + "vector": "another vector" + } + ], + "description": "1999-01 description", + "advisories": [], + "analysis": { + "state": "in_triage" + }, + "affects": [ + { + "ref": "package-1-id" + } + ] + }, + { + "id": "CVE-1999-0002", + "source": { + "name": "source-2", + "url": "http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-0002" + }, + "ratings": [ + { + "score": 0, + "severity": "critical" + }, + { + "score": 1, + "method": "CVSSv2", + "vector": "vector" + } + ], + "description": "1999-02 description", + "advisories": [], + "analysis": { + "state": "in_triage" + }, + "affects": [ + { + "ref": "package-2-id" + } + ] + } + ] +} diff --git a/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterImage_xml.golden b/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterImage_xml.golden new file mode 100644 index 000000000000..ac4ce27c0bce --- /dev/null +++ b/grype/presenter/cyclonedxvex/test-fixtures/snapshot/TestCycloneDxPresenterImage_xml.golden @@ -0,0 +1,93 @@ + + + + 2022-03-31T22:50:49+01:00 + + + anchore + grype + [not provided] + + + + user-input + sha256:2731251dc34951c0e50fcc643b4c5f74922dad1a5d98f302b504cf46cd5d9368 + + + + + package-1 + 1.0.1 + + + package-2 + 2.0.1 + + + MIT + + + Apache-v2 + + + + + + + CVE-1999-0001 + + source-1 + http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-0001 + + + + 0 + low + + + 4 + CVSSv3 + another vector + + + 1999-01 description + + + in_triage + + + + package-1-id + + + + + CVE-1999-0002 + + source-2 + http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-0002 + + + + 0 + critical + + + 1 + CVSSv2 + vector + + + 1999-02 description + + + in_triage + + + + package-2-id + + + + + \ No newline at end of file diff --git a/grype/presenter/cyclonedxvex/vulnerability.go b/grype/presenter/cyclonedxvex/vulnerability.go new file mode 100644 index 000000000000..03f5691ec979 --- /dev/null +++ b/grype/presenter/cyclonedxvex/vulnerability.go @@ -0,0 +1,108 @@ +package cyclonedxvex + +import ( + "fmt" + "strconv" + "strings" + + "github.com/CycloneDX/cyclonedx-go" + + "github.com/anchore/grype/grype/match" + "github.com/anchore/grype/grype/vulnerability" + "github.com/anchore/grype/internal/log" +) + +// cvssVersionToMethod accepts a CVSS version as string (e.g. "3.1") and converts it to a +// CycloneDx rating Method, for example "CVSSv3" +func cvssVersionToMethod(version string) (cyclonedx.ScoringMethod, error) { + value, err := strconv.ParseFloat(version, 64) + if err != nil { + return "", err + } + switch value { + case 2: + return cyclonedx.ScoringMethodCVSSv2, nil + case 3: + return cyclonedx.ScoringMethodCVSSv3, nil + case 3.1: + return cyclonedx.ScoringMethodCVSSv31, nil + default: + return "", fmt.Errorf("unable to parse %s into a CVSS version", version) + } +} + +// NewVulnerability creates a Vulnerability document from a match and the metadata provider +func NewVulnerability(m match.Match, p vulnerability.MetadataProvider) (cyclonedx.Vulnerability, error) { + metadata, err := p.GetMetadata(m.Vulnerability.ID, m.Vulnerability.Namespace) + if err != nil { + return cyclonedx.Vulnerability{}, fmt.Errorf("unable to fetch vuln=%q metadata: %+v", m.Vulnerability.ID, err) + } + + // The schema does not allow "Negligible", only allowing the following: + // 'None', 'Low', 'Medium', 'High', 'Critical', 'Unknown' + severityMap := map[string]cyclonedx.Severity{ + "unknown": cyclonedx.SeverityUnknown, + "none": cyclonedx.SeverityNone, + "info": cyclonedx.SeverityInfo, + "negligible": cyclonedx.SeverityLow, + "low": cyclonedx.SeverityLow, + "medium": cyclonedx.SeverityMedium, + "high": cyclonedx.SeverityHigh, + "critical": cyclonedx.SeverityCritical, + } + severity, ok := severityMap[strings.ToLower(metadata.Severity)] + if !ok { + severity = cyclonedx.SeverityUnknown + } + var ratings = []cyclonedx.VulnerabilityRating{ + { + Severity: severity, + }, + } + for _, cvss := range metadata.Cvss { + method, err := cvssVersionToMethod(cvss.Version) + if err != nil { + log.Errorf("unable to parse CVSS version: %v", err) + // do not halt execution if one CVSS fails to provide an accurate Version + continue + } + rating := cyclonedx.VulnerabilityRating{ + Method: method, + Vector: cvss.Vector, + Score: cvss.Metrics.BaseScore, + } + + ratings = append(ratings, rating) + } + advisories := []cyclonedx.Advisory{} + for _, url := range metadata.URLs { + advisories = append(advisories, cyclonedx.Advisory{ + URL: url, + }) + } + v := cyclonedx.Vulnerability{ + ID: m.Vulnerability.ID, + Source: &cyclonedx.Source{ + Name: m.Vulnerability.Namespace, + URL: makeVulnerabilityURL(m.Vulnerability.ID), + }, + Ratings: &ratings, + Description: metadata.Description, + Advisories: &advisories, + Analysis: &cyclonedx.VulnerabilityAnalysis{ + State: cyclonedx.IASInTriage, + }, + } + + return v, nil +} + +func makeVulnerabilityURL(id string) string { + if strings.HasPrefix(id, "CVE-") { + return fmt.Sprintf("http://cve.mitre.org/cgi-bin/cvename.cgi?name=%s", id) + } + if strings.HasPrefix(id, "GHSA") { + return fmt.Sprintf("https://github.com/advisories/%s", id) + } + return id +} diff --git a/grype/presenter/cyclonedxvex/vulnerability_test.go b/grype/presenter/cyclonedxvex/vulnerability_test.go new file mode 100644 index 000000000000..efcd4c67cb5c --- /dev/null +++ b/grype/presenter/cyclonedxvex/vulnerability_test.go @@ -0,0 +1,146 @@ +package cyclonedxvex + +import ( + "strings" + "testing" + + "github.com/CycloneDX/cyclonedx-go" + "github.com/stretchr/testify/assert" + + "github.com/anchore/grype/grype/match" + "github.com/anchore/grype/grype/pkg" + "github.com/anchore/grype/grype/vulnerability" +) + +func TestCvssVersionToMethod(t *testing.T) { + testCases := []struct { + desc string + input string + expected cyclonedx.ScoringMethod + errors bool + }{ + { + desc: "invalid (not float)", + input: "", + expected: "", + errors: true, + }, + { + desc: "CVSS v2", + input: "2.0", + expected: cyclonedx.ScoringMethodCVSSv2, + errors: false, + }, + { + desc: "CVSS v3", + input: "3.1", + expected: cyclonedx.ScoringMethodCVSSv31, + errors: false, + }, + { + desc: "CVSS v3", + input: "3.0", + expected: cyclonedx.ScoringMethodCVSSv3, + errors: false, + }, + { + desc: "invalid (no match)", + input: "15.4", + expected: "", + errors: true, + }, + } + for _, tc := range testCases { + t.Run(tc.desc, func(t *testing.T) { + actual, err := cvssVersionToMethod(tc.input) + if !tc.errors { + assert.NoError(t, err) + } else { + assert.Error(t, err) + } + + assert.Equal(t, tc.expected, actual) + }) + } +} + +type metadataProvider struct { + severity string + cvss []vulnerability.Cvss +} + +func (m metadataProvider) GetMetadata(id, namespace string) (*vulnerability.Metadata, error) { + return &vulnerability.Metadata{ + ID: id, + DataSource: "", + Namespace: namespace, + Severity: m.severity, + URLs: nil, + Description: "", + Cvss: m.cvss, + }, nil +} + +func TestNewVulnerability_AlwaysIncludesSeverity(t *testing.T) { + tests := []struct { + name string + match match.Match + metadataProvider *metadataProvider + }{ + { + name: "populates severity with missing CVSS records", + match: match.Match{ + Vulnerability: vulnerability.Vulnerability{}, + Package: pkg.Package{}, + Details: nil, + }, + metadataProvider: &metadataProvider{ + severity: "High", + }, + }, + { + name: "populates severity with all CVSS records", + match: match.Match{ + Vulnerability: vulnerability.Vulnerability{}, + Package: pkg.Package{}, + Details: nil, + }, + metadataProvider: &metadataProvider{ + severity: "High", + cvss: []vulnerability.Cvss{ + { + Version: "2.0", + Metrics: vulnerability.CvssMetrics{ + BaseScore: 1.1, + }, + }, + { + Version: "3.0", + Metrics: vulnerability.CvssMetrics{ + BaseScore: 2.1, + }, + }, + { + Version: "3.1", + Metrics: vulnerability.CvssMetrics{ + BaseScore: 3.1, + }, + }, + }, + }, + }, + } + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + actual, err := NewVulnerability(test.match, test.metadataProvider) + assert.NoError(t, err) + if len(*actual.Ratings) == 0 { + t.Fatalf("expected a rating but found none") + } + assert.Equal(t, string((*actual.Ratings)[0].Severity), strings.ToLower(test.metadataProvider.severity)) + for _, r := range (*actual.Ratings)[1:] { + assert.Equal(t, string(r.Severity), "") + } + }) + } +} diff --git a/grype/presenter/format.go b/grype/presenter/format.go index 85ccb91e1564..f333e40b301d 100644 --- a/grype/presenter/format.go +++ b/grype/presenter/format.go @@ -11,6 +11,8 @@ const ( cycloneDXFormat format = "cyclonedx" sarifFormat format = "sarif" templateFormat format = "template" + embeddedVEXJSON format = "embedded-cyclonedx-vex-json" + embeddedVEXXML format = "embedded-cyclonedx-vex-xml" ) // format is a dedicated type to represent a specific kind of presenter output format. @@ -35,6 +37,10 @@ func parse(userInput string) format { return sarifFormat case strings.ToLower(templateFormat.String()): return templateFormat + case strings.ToLower(embeddedVEXJSON.String()): + return embeddedVEXJSON + case strings.ToLower(embeddedVEXXML.String()): + return embeddedVEXXML default: return unknownFormat } diff --git a/grype/presenter/presenter.go b/grype/presenter/presenter.go index 5d42d57bee98..cfe0dcc2d387 100644 --- a/grype/presenter/presenter.go +++ b/grype/presenter/presenter.go @@ -3,9 +3,12 @@ package presenter import ( "io" + cdx "github.com/CycloneDX/cyclonedx-go" + "github.com/anchore/grype/grype/match" "github.com/anchore/grype/grype/pkg" "github.com/anchore/grype/grype/presenter/cyclonedx" + "github.com/anchore/grype/grype/presenter/cyclonedxvex" "github.com/anchore/grype/grype/presenter/json" "github.com/anchore/grype/grype/presenter/sarif" "github.com/anchore/grype/grype/presenter/table" @@ -27,6 +30,10 @@ func GetPresenter(presenterConfig Config, matches match.Matches, ignoredMatches return table.NewPresenter(matches, packages, metadataProvider) case cycloneDXFormat: return cyclonedx.NewPresenter(matches, packages, context.Source, metadataProvider) + case embeddedVEXJSON: + return cyclonedxvex.NewPresenter(matches, packages, context.Source, metadataProvider, true, cdx.BOMFileFormatJSON) + case embeddedVEXXML: + return cyclonedxvex.NewPresenter(matches, packages, context.Source, metadataProvider, true, cdx.BOMFileFormatXML) case sarifFormat: return sarif.NewPresenter(matches, packages, context.Source, metadataProvider) case templateFormat: diff --git a/schema/cyclonedxvex/.gitignore b/schema/cyclonedxvex/.gitignore new file mode 100644 index 000000000000..472d439fa14f --- /dev/null +++ b/schema/cyclonedxvex/.gitignore @@ -0,0 +1,2 @@ +bom.xml +bom.json diff --git a/schema/cyclonedxvex/Makefile b/schema/cyclonedxvex/Makefile new file mode 100644 index 000000000000..b81e7474e178 --- /dev/null +++ b/schema/cyclonedxvex/Makefile @@ -0,0 +1,14 @@ +.DEFAULT_GOAL := validate-schema + +.PHONY: validate-schema +validate-schema: validate-schema-xml validate-schema-json + +.PHONY: validate-schema-xml +validate-schema-xml: + go run ../../main.go -c ../../test/grype-test-config.yaml ubuntu:latest -vv -o embedded-cyclondex-vex-xml > bom.xml + xmllint --noout --schema ./cyclonedx.xsd bom.xml + +.PHONY: validate-schema-json +validate-schema-json: + go run ../../main.go -c ../../test/grype-test-config.yaml ubuntu:latest -vv -o embedded-cyclondex-vex-json > bom.json + ../../.tmp/yajsv -s cyclonedx.json bom.json diff --git a/schema/cyclonedxvex/README.md b/schema/cyclonedxvex/README.md new file mode 100644 index 000000000000..c60d5553a110 --- /dev/null +++ b/schema/cyclonedxvex/README.md @@ -0,0 +1,5 @@ +# CycloneDX Schemas + +`grype` generates a CycloneDX VEX output. This validation is similar to what is done in `syft`, validating output against CycloneDX schemas. + +Validation is done with `xmllint`, which requires a copy of all schemas because it can't work with HTTP references. The schemas are modified to reference local copies of dependent schemas. diff --git a/schema/cyclonedxvex/cyclonedx.json b/schema/cyclonedxvex/cyclonedx.json new file mode 100644 index 000000000000..627cbc7dba4d --- /dev/null +++ b/schema/cyclonedxvex/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/cyclonedxvex/cyclonedx.xsd b/schema/cyclonedxvex/cyclonedx.xsd new file mode 100644 index 000000000000..f9859c78910b --- /dev/null +++ b/schema/cyclonedxvex/cyclonedx.xsd @@ -0,0 +1,2407 @@ + + + + + + + + + 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 BOM was created. + + + + + The tool(s) used in the creation of the BOM. + + + + + + + + + + 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. + + + + + + + + + + The component that the BOM describes. + + + + + The organization that manufactured the component that the BOM describes. + + + + + 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. + + + + + + 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. + + + + + + + + + The name of the organization + + + + + The URL of the organization. Multiple URLs are allowed. + + + + + A contact person at the organization. Multiple contacts are allowed. + + + + + + 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. + + + + + + + Information about the automated or manual tool used + + + + + The name of the vendor who created the tool + + + + + The name of the tool + + + + + The version of the tool + + + + + + + + + + + + Provides the ability to document external references related to the tool. + + + + + + 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 name of the contact + + + + + The email address of the contact. + + + + + The phone number of the contact. + + + + + + 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. + + + + + + + + + + + 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 organization that supplied the component. The supplier may often + be the manufacturer, but may also be a distributor or repackager. + + + + + The person(s) or organization(s) that authored the component + + + + + The person(s) or organization(s) that published the component + + + + + 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. + + + + + The name of the component. This will often be a shortened, single name + of the component. Examples: commons-lang3 and jquery + + + + + The component version. The version should ideally comply with semantic versioning + but is not enforced. + + + + + Specifies a description for the component + + + + + Specifies the scope of the component. If scope is not specified, 'required' + scope SHOULD be assumed by the consumer of the BOM. + + + + + + + + + + + + + A copyright notice informing users of the underlying claims to + copyright ownership in a published work. + + + + + + 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 + to the specification defined at: https://github.com/package-url/purl-spec + + + + + + + Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags. + + + + + + + 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. + + + + + + + Component pedigree is a way to document complex supply chain scenarios where components are + created, distributed, modified, redistributed, combined with other components, etc. + + + + + + Provides the ability to document external references related to the + component or to the project the component describes. + + + + + 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. + + + + + + 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. + + + + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + Provides the ability to document evidence collected through various forms of extraction or analysis. + + + + + Specifies optional release notes. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + 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. + + + + + + + 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. + Uniqueness is enforced within all elements and children of the root-level bom element. + + + + + + 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. + + + + + + + + + + A valid SPDX license ID + + + + + If SPDX does not define the license used, this field may be used to provide the license name + + + + + + Specifies the optional full text of the attachment + + + + + The URL to the attachment file. If the attachment is a license or BOM, + an externalReference should also be specified for completeness. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + + + The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. + + + + Specifies the content type of the text. Defaults to text/plain + if not specified. + + + + + + Specifies the optional encoding the text is represented in + + + + + + + + + + Specifies the file hash of the component + + + + + + Specifies the algorithm used to create the hash + + + + + + + + + + + The component is required for runtime + + + + + The component is optional at runtime. Optional components are components that + are not capable of being called due to them not be installed or otherwise accessible by any means. + Components that are installed but due to configuration or other restrictions are prohibited from + being called must be scoped as 'required'. + + + + + Components that are excluded provide the ability to document component usage + for test and other non-runtime purposes. Excluded components are not reachable within a call + graph at runtime. + + + + + + + + + + A software application. Refer to https://en.wikipedia.org/wiki/Application_software + for information about applications. + + + + + A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework + for information on how frameworks vary slightly from libraries. + + + + + A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing) + 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. + + + + + 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 + + + + + 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 + + + + + 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. + + + + + A special type of software that provides low-level control over a devices + hardware. Refer to https://en.wikipedia.org/wiki/Firmware + + + + + A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file + for information about files. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Define the format for acceptable CPE URIs. Supports CPE 2.2 and CPE 2.3 formats. + Refer to https://nvd.nist.gov/products/cpe for official specification. + + + + + + + + + + + + Specifies the full content of the SWID tag. + + + + + The URL to the SWID file. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + Maps to the tagId of a SoftwareIdentity. + + + + + Maps to the name of a SoftwareIdentity. + + + + + Maps to the version of a SoftwareIdentity. + + + + + Maps to the tagVersion of a SoftwareIdentity. + + + + + Maps to the patch of a SoftwareIdentity. + + + + + + + + Defines a string representation of a UUID conforming to RFC 4122. + + + + + + + + + + + + Version Control System + + + + + Issue or defect tracking system, or an Application Lifecycle Management (ALM) system + + + + + Website + + + + + Security advisories + + + + + Bill-of-material document (CycloneDX, SPDX, SWID, etc) + + + + + Mailing list or discussion group + + + + + Social media account + + + + + Real-time chat platform + + + + + Documentation, guides, or how-to instructions + + + + + Community or commercial support + + + + + Direct or repository download location + + + + + The URL to the license file. If a license URL has been defined in the license + node, it should also be defined as an external reference for completeness + + + + + Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) + + + + + URL to an automated build system + + + + + URL to release notes + + + + + Use this if no other types accurately describe the purpose of the external reference + + + + + + + + + External references provide a way to document systems, sites, and information that may be relevant + but which are not included with the BOM. + + + + + + Zero or more external references can be defined + + + + + + + + + + The URL to the external reference + + + + + An optional comment describing the external reference + + + + + + + + + + + + + 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. + + + + + + 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. + + + + + + + Zero or more commits can be specified. + + + + + Specifies an individual commit. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + + + A unique identifier of the commit. This may be version control + specific. For example, Subversion uses revision numbers whereas git uses commit hashes. + + + + + + The URL to the commit. This URL will typically point to a commit + in a version control system. + + + + + + The author who created the changes in the commit + + + + + The person who committed or pushed the commit + + + + + The text description of the contents of the commit + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + Zero or more patches can be specified. + + + + + Specifies an individual patch. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + + + The patch file (or diff) that show changes. + Refer to https://en.wikipedia.org/wiki/Diff + + + + + + + + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + Specifies the purpose for the patch including the resolution of defects, + security issues, or new behavior or functionality + + + + + + + + + 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 + + + + + A patch which dynamically modifies runtime behavior. + Refer to https://en.wikipedia.org/wiki/Monkey_patch + + + + + 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 + + + + + A patch created by selectively applying commits from other versions or + branches of the same software. + + + + + + + + + + A fault, flaw, or bug in software + + + + + A new feature or behavior in software + + + + + A special type of defect which impacts security + + + + + + + + + + Specifies the optional text of the diff + + + + + Specifies the URL to the diff + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + + An individual issue that has been resolved. + + + + + + The identifier of the issue assigned by the source of the issue + + + + + The name of the issue + + + + + A description of the issue + + + + + + + The source of the issue where it is documented. + + + + + + + The name of the source. For example "National Vulnerability Database", + "NVD", and "Apache" + + + + + + + The url of the issue documentation as provided by the source + + + + + + + + + + + + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + Specifies the type of issue + + + + + + + + + The timestamp in which the action occurred + + + + + The name of the individual who performed the action + + + + + The email address of the individual who performed the action + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + + 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. + + + + + + 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. + + + + + + Descendants are the exact opposite of ancestors. This provides a + way to document all forks (and their forks) of an original or root component. + + + + + + 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. + + + + + + A list of zero or more commits which provide a trail describing + how the component deviates from an ancestor, descendant, or variant. + + + + + 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. + + + + + Notes, observations, and other non-structured commentary + describing the components pedigree. + + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + + + + + References a component or service by the its bom-ref attribute + + + + + 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. + + + + + + + + + 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. + + + + + + + + + + + + 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 organization that provides the service. + + + + + 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. + + + + + The name of the service. This will often be a shortened, single name + of the service. + + + + + The service version. + + + + + Specifies a description for the service. + + + + + + + + A service endpoint URI. + + + + + + + + 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. + + + + + 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. + + + + + + + + Specifies the data classification. + + + + + + + + + Provides the ability to document external references related to the service. + + + + + 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. + + + + + + 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. + + + + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + Specifies optional release notes. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + An optional identifier which can be used to reference the service elsewhere in the BOM. + Uniqueness is enforced within all elements and children of the root-level bom element. + + + + + + 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. + + + + + + + Specifies the data classification. + + + + + + Specifies the flow direction of the data. + + + + + + + + + Specifies the flow direction of the data. Valid values are: + inbound, outbound, bi-directional, and unknown. 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. + + + + + + + + + + + + + + + A valid SPDX license expression. + Refer to https://spdx.org/specifications for syntax requirements + + + + + + + + + + + + + + + + + + + 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. + + + + + + + + + + + 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. + + + + + + + + + Specifies an aggregate type that describe how complete a relationship is. + + + + + + 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. + + + + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + + 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. + + + + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + + + + + + + + The relationship is complete. No further relationships including constituent components, services, or dependencies exist. + + + + + The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies. + + + + + The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented. + + + + + The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented. + + + + + The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive. + + + + + The relationship completeness is not specified. + + + + + + + + + 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 + + + + + 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. + + + + + + + + + + + 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. + + + + + + + Specifies an individual property with a name and value. + + + + + + The name of the property. Duplicate names are allowed, each potentially having a different value. + + + + + + + + + + + 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. + + + + + + + + + + + + + + + + Provides additional information about a BOM. + + + + + A list of software and hardware components. + + + + + A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services. + + + + + Provides the ability to document external references related to the BOM or + to the project the BOM describes. + + + + + Provides the ability to document dependency relationships. + + + + + Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. + + + + + 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. + + + + + + Allows any undeclared elements as long as the elements are placed in a different namespace. + + + + + + + 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 have not changed over time. If specified, the serial number MUST conform to RFC-4122. + Use of serial numbers are RECOMMENDED. + + + + + 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. + + + + + + + + + diff --git a/schema/cyclonedxvex/spdx.xsd b/schema/cyclonedxvex/spdx.xsd new file mode 100644 index 000000000000..66ba6f199e71 --- /dev/null +++ b/schema/cyclonedxvex/spdx.xsd @@ -0,0 +1,2639 @@ + + + + + + + + + Interbase Public License v1.0 + + + + + Mup License + + + + + GNU General Public License v2.0 w/Autoconf exception + + + + + Open LDAP Public License v2.1 + + + + + Creative Commons Attribution Non Commercial Share Alike 3.0 IGO + + + + + GNU Library General Public License v2 or later + + + + + XPP License + + + + + SIL Open Font License 1.1 + + + + + CNRI Python License + + + + + Linux man-pages Copyleft + + + + + Open LDAP Public License v2.2 + + + + + Open Software License 1.1 + + + + + Eclipse Public License 2.0 + + + + + Academic Free License v1.1 + + + + + Affero General Public License v1.0 or later + + + + + Good Luck With That Public License + + + + + MIT License Modern Variant + + + + + BSD 1-Clause License + + + + + SGI Free Software License B v1.0 + + + + + Open Market License + + + + + psfrag License + + + + + Artistic License 1.0 + + + + + Creative Commons Public Domain Dedication and Certification + + + + + eGenix.com Public License 1.1.0 + + + + + European Union Public License 1.1 + + + + + Sendmail License + + + + + Python Software Foundation License 2.0 + + + + + Open Government Licence v1.0 + + + + + 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 + + + + + Motosoto License + + + + + Creative Commons Attribution Non Commercial Share Alike 2.5 Generic + + + + + JasPer License + + + + + BSD-4-Clause (University of California-Specific) + + + + + Bahyph License + + + + + Vovida Software License v1.0 + + + + + W3C Software Notice and License (2002-12-31) + + + + + Open Data Commons Attribution License v1.0 + + + + + BitTorrent Open Source License v1.0 + + + + + Open Government Licence v2.0 + + + + + GNU Lesser General Public License v3.0 only + + + + + X.Net License + + + + + Ruby License + + + + + GNU Free Documentation License v1.3 + + + + + Zope Public License 1.1 + + + + + Open CASCADE Technology Public License + + + + + LaTeX Project Public License v1.3c + + + + + Apache License 2.0 + + + + + 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 + + + + + gSOAP Public License v1.3b + + + + + GNU Lesser General Public License v2.1 only + + + + + GNU Lesser General Public License v3.0 only + + + + + + FreeRTOS Exception 2.0 + + + + + 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 + + + + + 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 + + + + + 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 + + + + + +