Software Bill of Materials
Starting with 3.0.0 CIB seven publishes a Software Bill of Materials (SBOM) in the CycloneDX format for the project as a whole, for each distribution and for each Docker image. An SBOM lists every component that is part of the artifact, with its version and, where available, its license and package URL. It is the machine-readable counterpart of the license books: the license books are written for people, the SBOMs for vulnerability scanners, license-compliance tooling and inventory systems.
The SBOMs are additional artifacts deployed to our Artifact Repository
SBOMs are published starting with CIB seven 3.0.0. The examples on this page use that version; for a later release, replace the version in the paths.
Aggregate SBOMs of the Maven artifacts
Each SBOM is an aggregate SBOM: it covers the complete dependency tree of its scope, not only the direct dependencies.
| Scope | Artifact the SBOM is attached to | Classifier |
|---|---|---|
| The whole project | org.cibseven.bpm:cibseven-root |
cyclonedx |
| Tomcat distribution | org.cibseven.bpm.tomcat:cibseven-tomcat |
aggregate-sbom |
| WildFly distribution | org.cibseven.bpm.wildfly:cibseven-wildfly |
aggregate-sbom |
| CIB seven Run | org.cibseven.bpm.run:cibseven-bpm-run-root |
aggregate-sbom |
Every SBOM is deployed in both JSON and XML, so each row above results in two files.
Downloading an SBOM
An SBOM is deployed next to the artifact it belongs to, so it has the usual path of a Maven artifact in our Artifact Repository:
https://artifacts.cibseven.org/repository/public/<group path>/<artifactId>/<version>/<artifactId>-<version>-<classifier>.<json|xml>
The SBOMs of version 3.0.0 are therefore:
# the whole project
https://artifacts.cibseven.org/repository/public/org/cibseven/bpm/cibseven-root/3.0.0/cibseven-root-3.0.0-cyclonedx.json
# Tomcat distribution
https://artifacts.cibseven.org/repository/public/org/cibseven/bpm/tomcat/cibseven-tomcat/3.0.0/cibseven-tomcat-3.0.0-aggregate-sbom.json
# WildFly distribution
https://artifacts.cibseven.org/repository/public/org/cibseven/bpm/wildfly/cibseven-wildfly/3.0.0/cibseven-wildfly-3.0.0-aggregate-sbom.json
# CIB seven Run
https://artifacts.cibseven.org/repository/public/org/cibseven/bpm/run/cibseven-bpm-run-root/3.0.0/cibseven-bpm-run-root-3.0.0-aggregate-sbom.json
Replace the extension with xml for the XML variant.
Letting Maven resolve the SBOM works as well, with the coordinates groupId:artifactId:version:extension:classifier:
mvn dependency:copy \
-Dartifact=org.cibseven.bpm.tomcat:cibseven-tomcat:3.0.0:json:aggregate-sbom \
-DoutputDirectory=.
CIB seven CE+ and Enterprise Edition
Both editions publish the same SBOMs, under the same group and artifact ids as the Community Edition. Two things differ:
- The version carries the edition:
3.0.0for the Community Edition,3.0.0-plusfor CIB seven CE+ and3.0.0-eefor the Enterprise Edition. - The repository is the private one that your license gives you access to, instead of
public:private-groupfor CIB seven CE+ andenterprisefor the Enterprise Edition. Log in with the credentials from your license.
The SBOMs of CIB seven CE+ 3.0.0-plus:
# The whole project
https://artifacts.cibseven.org/repository/private-group/org/cibseven/bpm/cibseven-root/3.0.0-plus/cibseven-root-3.0.0-plus-cyclonedx.json
# Tomcat distribution
https://artifacts.cibseven.org/repository/private-group/org/cibseven/bpm/tomcat/cibseven-tomcat/3.0.0-plus/cibseven-tomcat-3.0.0-plus-aggregate-sbom.json
# WildFly distribution
https://artifacts.cibseven.org/repository/private-group/org/cibseven/bpm/wildfly/cibseven-wildfly/3.0.0-plus/cibseven-wildfly-3.0.0-plus-aggregate-sbom.json
# CIB seven Run
https://artifacts.cibseven.org/repository/private-group/org/cibseven/bpm/run/cibseven-bpm-run-root/3.0.0-plus/cibseven-bpm-run-root-3.0.0-plus-aggregate-sbom.json
The SBOMs of the Enterprise Edition 3.0.0-ee:
# The whole project
https://artifacts.cibseven.org/repository/enterprise/org/cibseven/bpm/cibseven-root/3.0.0-ee/cibseven-root-3.0.0-ee-cyclonedx.json
# Tomcat distribution
https://artifacts.cibseven.org/repository/enterprise/org/cibseven/bpm/tomcat/cibseven-tomcat/3.0.0-ee/cibseven-tomcat-3.0.0-ee-aggregate-sbom.json
# WildFly distribution
https://artifacts.cibseven.org/repository/enterprise/org/cibseven/bpm/wildfly/cibseven-wildfly/3.0.0-ee/cibseven-wildfly-3.0.0-ee-aggregate-sbom.json
# CIB seven Run
https://artifacts.cibseven.org/repository/enterprise/org/cibseven/bpm/run/cibseven-bpm-run-root/3.0.0-ee/cibseven-bpm-run-root-3.0.0-ee-aggregate-sbom.json
Per-artifact SBOMs
Earlier versions additionally deployed a small SBOM for every single module that listed only its direct dependencies. These are no longer published. Use the aggregate SBOM of the distribution you ship, or the project-wide one.
SBOMs of the Docker images
Each image is scanned after it is built, and the resulting CycloneDX SBOM is attached to the image in the registry with cosign, using the OCI 1.1 referrers API.
Which images carry an SBOM
The image SBOMs are published on artifacts.cibseven.org only: in the public repository for the Community Edition, and in the respective private repositories for CIB seven CE+ and the Enterprise Edition. The images on Docker Hub do not carry an SBOM. Pull the image from artifacts.cibseven.org if you need one.
Log in to the registry first, as you do for pulling the image itself, then retrieve the SBOM with cosign:
docker login artifacts.cibseven.org
# CIB seven CE+
cosign download sbom artifacts.cibseven.org/docker-ce-plus/cibseven:tomcat-3.0.0
# Enterprise Edition
cosign download sbom artifacts.cibseven.org/docker-ee/cibseven:tomcat-3.0.0-ee
The image repositories are the ones described under Docker.
Where the registry implements the referrers API, the SBOM is discoverable as a referrer of the image manifest. Where it does not, cosign falls back to its tag scheme and stores the SBOM under a tag derived from the image digest, sha256-<digest>.sbom. Either way the command above is the same.
The SBOM of an image describes the whole image, so it also covers the operating system packages of the base image, not only the CIB seven libraries.