Skip to content

Support CycloneDX 1.6 reports

Oscar Tovar requested to merge otovar/add-support-for-cyclonedx-1.6-reports into master

What does this MR do and why?

CycloneDX 1.6 JSON schema source.

The following validations have been added to the official schema source:

  • Validates component name has a min length of 1 and max of 255. This matches the constraint in the database.
  • Validates component version has a min length of 1 and a max of 255. This matches the constraint in the database.
  • Inlines the license and signature definitions that are referenced in schema files.

Steps taken to inline license definition

This works around the local spdx.schema.json reference used to define the CycloneDX 1.6 schema's license type. The following steps were applied to update the schema:

  1. Add the definitions from https://github.com/CycloneDX/specification/blob/f18b992f8523728c17318a488dd716e5c677ae4c/schema/spdx.schema.json to the CycloneDX 1.6 JSON schema's license definition.
  2. Remove the $ref field from the definition.

Steps taken to inline signature definition

This works around the local jsf-0.82.schema.json reference used to define the CycloneDX 1.6 schema's signature type. The following steps were applied to update the schema:

  1. Add the definitions from https://github.com/CycloneDX/specification/blob/f18b992f8523728c17318a488dd716e5c677ae4c/schema/jsf-0.82.schema.json to the CycloneDX 1.6 JSON schema's signature definition.
  2. Remove the $ref field from the definition.

Changelog: added

Relates to #472837 (closed)

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Generate a CycloneDX SBOM using Trivy 0.53.0 or later (this produces a 1.6 compatible CycloneDX SBOM).
  2. Upload report in CI/CD job and verify that the dependency list is populated.
Edited by Oscar Tovar

Merge request reports