feat: add sbom Makefile target#414
Open
MarkAtwood wants to merge 1 commit into
Open
Conversation
Adds sbom target that calls gen-sbom to produce CycloneDX and SPDX output files. Parses version from ChangeLog.md. Sources enumerated from src/*.c. Requires WOLFSSL_DIR pointing to wolfssl tree with the feat/sbom-embedded branch (includes gen-sbom).
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
Adds a make sbom target to generate CycloneDX and SPDX SBOM artifacts for wolfHSM using wolfSSL’s scripts/gen-sbom.
Changes:
- Introduces an
sbomMakefile target with checks for version parsing andWOLFSSL_DIR. - Gathers sources from
src/*.cand passes compiler defines + metadata intogen-sbom. - Emits versioned
wolfhsm-<version>.cdx.jsonandwolfhsm-<version>.spdx.jsonoutputs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # ---- SBOM generation ---- | ||
| CC ?= cc | ||
| WOLFSSL_DIR ?= ../../wolfssl | ||
| VERSION := $(shell sed -n 's/^# wolfHSM Release v\([0-9][0-9.]*\).*/\1/p' ChangeLog.md | head -1) |
| CC ?= cc | ||
| WOLFSSL_DIR ?= ../../wolfssl | ||
| VERSION := $(shell sed -n 's/^# wolfHSM Release v\([0-9][0-9.]*\).*/\1/p' ChangeLog.md | head -1) | ||
| SRCS := $(wildcard src/*.c) |
| --supplier "wolfSSL Inc." \ | ||
| --license-file LICENSING \ | ||
| --options-h "$$_defines" \ | ||
| --srcs $(SRCS) \ |
Comment on lines
+92
to
+94
| _py=$$(command -v python3 2>/dev/null || command -v python 2>/dev/null) && \ | ||
| [ -n "$$_py" ] || { echo "ERROR: python3 not found." >&2; exit 1; } && \ | ||
| "$$_py" $(WOLFSSL_DIR)/scripts/gen-sbom \ |
Comment on lines
+87
to
+88
| @_defines=$$(mktemp /tmp/wolfhsm-defines.XXXXXX) && \ | ||
| trap 'rm -f "$$_defines"' EXIT && \ |
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.
Summary
Adds a
make sbomtarget that produces CycloneDX and SPDX SBOM files for wolfHSM.ChangeLog.md(e.g.,# wolfHSM Release v1.4.0)src/*.c(sorted)gen-sbomto produce CDX + SPDX outputsUsage
```sh
make sbom WOLFSSL_DIR=/path/to/wolfssl/source
```
Outputs:
wolfhsm-<version>.cdx.json,wolfhsm-<version>.spdx.jsonRequirements
WOLFSSL_DIRmust point to a wolfssl source tree containingscripts/gen-sbom(available on thefeat/sbom-embeddedbranch of wolfssl)python3andpip install spdx-toolson the build hostTest plan
make sbom WOLFSSL_DIR=...