fix: Remove non-shipped dependencies from the SBOMs - #1630
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Our SBOMs report dependencies that are never shipped, like test frameworks, build tooling and integrations that are not compiled in. They show up as false positives in the vulnerability scans.
Vector: builds with an explicit, reduced feature set, but
cargo cyclonedxresolved the default features and reported every integration (AWS, Azure, etc.).Rust base images: now pass
--no-build-deps, which drops the build-time dependencies.Kafka: extended the list of skipped projects
OpenSearch (3.1.0 and 3.4.0): additionally skips the test framework, the test fixtures, the QA projects and the benchmarks. OpenSearch 3.6.0 was already fine since there an allow-list instead of a deny-list is used.
The Prometheus exporter 3.6.0.0 gets
includeConfigs = ["runtimeClasspath"]on itscyclonedxDirectBomtask, thecyclonedxBomextension only configures the aggregation there. 3.1.0.0 and 3.4.0.0 use plugin version 2.4.1, where the extension still applies to the project itself, so they are already correct.OpenSearch Dashboards and the HBase web UI pass
--required-onlyto cdxgen, which leaves out devDependencies and optional dependencies.Airflow and Superset got two fixes:
cyclonedx-bomwas installed into the product environment, so it was part of its own SBOM, and uninstalling it afterwards left its dependencies behind in the image. It is now installed into a throw-away venv that is removed after the SBOM is written.cyclonedx-pyrecords the file URL of that wheel instead of a purl. Without a purl they appear twice in the image SBOM (no deduplication possible). The purl is added in post-processing withjq.Definition of Done Checklist
Note
Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant.
Please make sure all these things are done and tick the boxes
TIP: Running integration tests with a new product image
The image can be built and uploaded to the kind cluster with the following commands:
See the output of
boilto retrieve the image manifest URI for<MANIFEST_URI>.