GODRIVER-3599 Add task and script to generate CycloneDX SBOM #2154
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
API Change ReportNo changes found! |
The GODRIVER SBOM (sbom.json) does not contain the direct and transitive dependencies defined in go.mod. Added code to generate a CycloneDX SBOM in order to better meet NITA Minimum Elements for Software Bill of Materials, OWASP Software Component Verification Standard (SCVS) Level 1, as well as include the necessary component identifiers for vulnerability discovery and VEX responses. Added a task, etc/script, and pre-commit hook for generating a CycloneDX SBOM using a pinned version of the cyclonedx-gomod tool. The SBOM includes the aggregate of modules required by packages in the mongo-go-driver library, excluding examples, tests and test packages. The task (generate-sbom) is added to the default tasks and will run only when go.mod is newer than sbom.cdx.json. The pre-commit hook (sbom-currency) ensures that if go.mod is staged for commit, that an updated sbom.json is also staged. Future TODO: Add libmongocrypt as an optional component once the libmongocrypt SBOM is updated with newer automation
jasonhills-mongodb
force-pushed
the
GODRIVER-3599/sbom_generation_using_cyclonedx-gomod
branch
from
7c63b31 to
a0af51a
Compare
prestonvasquez
added
the
review-priority-low
prestonvasquez
requested changes
Aug 14, 2025
| - id: sbom-currency | ||
| name: sbom-currency | ||
| language: system | ||
| types: [json] |
There was a problem hiding this comment.
This hook won't run if a commit changes go.mod. Is that intentional?
| summary: | | ||
| Generate a CycloneDX SBOM with the cyclonedx-gomod 'mod' subcommand | ||
| The SBOM includes the aggregate of modules required by packages in the mongo-go-driver library, excluding examples, tests and test packages. | ||
| Task will run only when go.mod is newer than sbom.cdx.json. |
There was a problem hiding this comment.
Should this be sbom.json and not sbom.cdx.json?
There was a problem hiding this comment.
Yes, good catch. That is a typo leftover from when I was naming the file sbom.cdx.json. Will fix.
|
|
||
| if ! $CHECK_CURRENCY; then | ||
| # The cyclonedx-gomod 'mod' subcommand is used to generate a CycloneDX SBOM with GOWORK=off to exclude example/test code. | ||
| # TODO: Add libmongocrypt as an optional component via a merge once the libmongocrypt SBOM is updated with newer automation |
There was a problem hiding this comment.
Does this need a followup GODRIVER ticket?
Co-authored-by: Preston Vasquez <prestonvasquez@icloud.com>
github-actions
bot
added
the
review-priority-normal
prestonvasquez
removed
the
review-priority-low
prestonvasquez
requested changes
Aug 15, 2025
| done | ||
| #shift $((OPTIND - 1)) | ||
|
|
||
| if ! $CHECK_CURRENCY; then |
There was a problem hiding this comment.
Should this script fail under certain conditions? For example, if it's being (1) called from the Evergreen CI and (2) calling results in a change to sbom.json? In such cases, I would expect the "Static Analysis" task to fail.
Running directly:
EXPECT_ERROR=1 bash etc/generate-sbon.sh # -> if sbom.json updates, exit 1In the associated task:
- name: generate-sbom
tags: ["ssdlc", "static-analysis"]
commands:
- command: subprocess.exec
params:
binary: bash
env:
EXPECT_ERROR: 1
args: [*task-runner, generate-sbom]
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.
GODRIVER-3599
Summary
Added a task, etc/script, and pre-commit hook for generating a CycloneDX SBOM using a pinned version of the
cyclonedx-gomodtool. The SBOM includes the aggregate of modules required by packages in the mongo-go-driver library, excluding examples, tests and test packages (i.e., only components used at runtime).The task (
generate-sbom) is added to the default tasks and will run only whengo.modis newer thansbom.json.The pre-commit hook (
sbom-currency) ensures that ifgo.modis staged for commit, that an updatedsbom.jsonis also staged.Future TODO: Add
libmongocryptas an optional component once thelibmongocryptSBOM is updated with newer automationBackground & Motivation
The GODRIVER SBOM (
sbom.json) does not contain the direct and transitive dependencies defined in go.mod. Added code to generate a CycloneDX SBOM in order to better meet NITA Minimum Elements for Software Bill of Materials, OWASP Software Component Verification Standard (SCVS) Level 1, as well as include the necessary component identifiers for vulnerability discovery and VEX responses.