Skip to content

Export SBOM and VEX

This guide covers the automatic generation of Software Bill of Materials (SBOM) and Vulnerability Exploitability eXchange (VEX) documents during image builds.

Prerequisites

  • An image build whose distro configuration requires conf/distro/include/tolomeo-cyclonedx.inc, which activates the SBOM pipeline; the reference tolomeo-prod distribution does
  • A completed image build; see Build the ToloMEO Reference Image

Find the SBOM and VEX

After building an image, the SBOM, VEX, and summary files are generated under the deploy directory:

build/tmp-glibc/deploy/cyclonedx-export/<machine>/<image>
├── bom.json      # Software Bill of Materials (SBOM)
├── vex.json      # Vulnerability Exploitability eXchange (VEX)
└── summary.json  # Human-readable statistics and per-recipe breakdown

View the SBOM:

jq . build/tmp-glibc/deploy/cyclonedx-export/<machine>/<image>/bom.json

The bom.json file is generated in CycloneDX 1.6 format and can be uploaded to ToloMEO Cloud or shared with customers.

Note

Packages with DAVE as supplier can receive updates because they are maintained by DAVE. If you require pinned versions, contact DAVE.

Enable Kernel CVE Enrichment (Optional)

When meta-vulnscout is available, kernel CVE analysis is performed at three levels:

  1. kernel_generate_cve_exclusions — generates a cve-extra-exclusions.inc file listing kernel CVEs that are architecturally not applicable.
  2. kernel_filter_nonbuilt_cves — cross-references CVEs with the compiled source file list (SPDX_INCLUDE_COMPILED_SOURCES) to mark CVEs for source files not built into this kernel image as Ignored.
  3. improve_kernel_cve_report — image-level post-rootfs scout that re-classifies kernel CVEs using the vulns.git dataset and produces a .scouted.json file.

The includes of meta-tolomeo-distro already wire these classes. tolomeo-cve-check.inc adds the classes to IMAGE_CLASSES and KERNEL_CLASSES, and tolomeo-cyclonedx.inc sets CYCLONEDX_KERNEL_SCOUTED_FILE, so the assemble class picks up the .scouted.json of step 3. cyclonedx_collect detects kernel_filter_nonbuilt_cves and sequences itself after it.

Require both includes in the distro configuration, and mark the kernel's compiled sources:

require conf/distro/include/tolomeo-cve-check.inc
require conf/distro/include/tolomeo-cyclonedx.inc

SPDX_INCLUDE_COMPILED_SOURCES:pn-linux-yocto = "1"

Define Your Company as a Supplier

The meta-tolomeo layer includes DAVE Embedded Systems as a pre-configured supplier. Add your company supplier information so that your custom packages are correctly attributed in the SBOM.

Create or edit your distro configuration file (for example conf/distro/my-distro.conf):

# Define your company supplier information
CDX_SUPPLIER_MAP[mycompany.name] = "My Company Name"
CDX_SUPPLIER_MAP[mycompany.urls] = "https://www.mycompany.com https://gitlab.com/mycompany"

Assign Your Supplier to Your Packages

For each recipe you create or customize, add the supplier assignment:

CDX_COMPONENT_SUPPLIER = "mycompany"

Note

There is no need to set the supplier for all dependencies; it is automatically propagated.

How Suppliers Propagate

The supplier assignment system works in a hierarchical manner:

  1. Explicit assignments (highest priority): Suppliers set directly on recipes via CDX_COMPONENT_SUPPLIER
  2. Propagated suppliers: Suppliers automatically propagated from dependencies
  3. Default supplier (lowest priority): Applied to remaining components via CDX_DEFAULT_COMPONENT_SUPPLIER

When you assign a supplier to a package, it propagates to all its dependencies. DAVE-assigned packages have the highest priority and override other assignments. Your custom suppliers propagate to dependencies unless they already have a supplier assigned.

If your custom packagegroup-myapp has supplier mycompany, all packages it depends on are also marked as mycompany, unless they already have a different supplier assigned, such as DAVE packages. You only need to assign suppliers to your top-level packages; the system handles the rest.

Set a Default Supplier (Optional)

To ensure all components in your SBOM have a supplier assigned, set a default supplier in your distro configuration:

# Set default supplier for components without explicit assignment
CDX_DEFAULT_COMPONENT_SUPPLIER = "mycompany"

This assigns your company as the supplier for any component that has no supplier after the propagation process. It is useful for:

  • Third-party open-source components that you integrate
  • Components that aren't part of DAVE's managed packages
  • Ensuring complete supplier coverage in your SBOM

Set it for production builds: every component then has a supplier, which compliance and security audits often require. Leave it unset during development to see which components lack an explicit supplier assignment.

The build then reports the assignment:

Assigned default supplier 'mycompany' to 47 recipes without explicit supplier:
  - busybox
  - glibc
  - openssl
  ...

Override the Supplier of Specific Packages (Optional)

To override suppliers for specific packages in your distro configuration without appending to an existing recipe:

# In your distro config
CDX_COMPONENT_SUPPLIER:pn-my-custom-app = "mycompany"
CDX_COMPONENT_SUPPLIER:pn-my-custom-lib = "mycompany"

Use the CycloneDX 1.4 Format (Optional)

By default, CycloneDX 1.6 format is used. To use the older 1.4 format for compatibility with older tools, add this to your distro configuration after the require of tolomeo-cyclonedx.inc, which assigns 1.6:

CYCLONEDX_SPEC_VERSION = "1.4"

Troubleshooting

SBOM file is missing

Make sure the build completed successfully. The SBOM is generated at the end of the build process.

My packages don't show my company as the supplier

Check that:

  1. You've defined your supplier in CDX_SUPPLIER_MAP with both name and urls
  2. You've assigned CDX_COMPONENT_SUPPLIER = "mycompany" to your recipes
  3. Your distro configuration includes the supplier definition file
  4. The package you are trying to include is not already under DAVE's dependencies (DAVE suppliers have highest priority)

Some packages don't have a supplier assigned

If you see warnings about packages without suppliers during the build:

WARNING: The following 47 recipes in the SBOM do not have a supplier assigned:
  - busybox
  - glibc
  ...

TIP: You can set CDX_DEFAULT_COMPONENT_SUPPLIER to automatically assign a default supplier to these components.

Add a default supplier as described in Set a Default Supplier (Optional). To control which packages get your supplier instead, review the warning list, assign CDX_COMPONENT_SUPPLIER to specific top-level packages, and let propagation handle their dependencies.

See also