ANNOUNCE: shipcheck - CRA compliance auditor for Yocto builds
Hi all,
(Cross-posted to [email protected] and
[email protected].)
I just published shipcheck, an open-source CLI that reads a Yocto build directory and drafts the paperwork required by the EU Cyber Resilience Act (Regulation 2024/2847) - the Annex VII technical file, the Declaration of Conformity, and an evidence report pivoted by CRA Annex item.
The short version: CRA is a paperwork regulation, not a scanner-selection problem. Yocto already emits most of the technical evidence - SPDX SBOMs via create-spdx, CVE scans via cve-check or Bootlin's sbom-cve-check, license.manifest files, signing-class config. What's missing is a tool that walks those artefacts, maps them onto the CRA Annex structure, and renders the drafts a compliance officer can review.
shipcheck does that piece, with seven registered checks:
sbom-generation SPDX 2.x validation against BSI TR-03183-2
cve-tracking consumes cve-check, vex.bbclass, and
sbom-cve-check JSON (the last is preferred)
yocto-cve-check reads tmp/log/cve/cve-summary.json directly license-audit per-arch license.manifest walker secure-boot detects signing class configuration and flags
known test keys
image-signing detects FIT signatures and dm-verity config
vuln-reporting validates the vendor-commitment half of the
dossier from a separate product.yaml manifest
It is deliberately narrow: Apache-2.0 Python, no runtime probes, no shell-outs, no network calls at scan time, and no LLM or AI inference anywhere in the pipeline - shipcheck is fully deterministic. An auditor can read the check code and confirm exactly what each check inspects.
Pilot 0001 (poky Scarthgap, core-image-minimal) is committed at pilots/0001-poky-scarthgap-min/REPORT.md with the full kas-container bootstrap. A worked example driven from a product-vendor.yaml (every field set to the placeholder "VENDOR") is committed at audits/0002-blog-demo/ if you want to read the generated Annex VII and DoC drafts without running shipcheck locally.
Install:
uv tool install shipcheck # or: pipx install shipcheck cd path/to/yocto/build
shipcheck init
shipcheck check --build-dir . --format evidence --out dossier/
Blog post walks through the Annex structure, what Yocto gives you for free, and where the paperwork gap lives:
https://jetm.github.io/blog/posts/auditing-your-yocto-build-for-cra-compliance/
Repo:
https://github.com/jetm/shipcheck
Feedback very welcome - especially from maintainers on the cve-check, create-spdx, and vex side of things who have opinions on how the check defaults should evolve. File an issue on GitHub, or reply here.
Best,
Javier
Quoted 1 line · Javier Tia
Hi all,
Hello Javier,
Quoted 8 lines
(Cross-posted to [email protected] and
[email protected].)I just published shipcheck, an open-source CLI that reads a Yocto build directory and drafts the paperwork required by the EU Cyber Resilience Act (Regulation 2024/2847) - the Annex VII technical file, the Declaration of Conformity, and an evidence report pivoted by CRA Annex item.
Thanks, it's great to have a tool filling that gap!
Quoted 7 lines
The short version: CRA is a paperwork regulation, not a scanner-selection problem. Yocto already emits most of the technical evidence - SPDX SBOMs via create-spdx, CVE scans via cve-check or Bootlin's sbom-cve-check, license.manifest files, signing-class config. What's missing is a tool that walks those artefacts, maps them onto the CRA Annex structure, and renders the drafts a compliance officer can review.
Not super relevant, but I would dispute the "paperwork regulation" bit, and one can only gloss over the "scanner-selection" issue if one assumes that problem already solved.
Quoted 33 lines
shipcheck does that piece, with seven registered checks:
sbom-generation SPDX 2.x validation against BSI TR-03183-2
cve-tracking consumes cve-check, vex.bbclass, and
sbom-cve-check JSON (the last is preferred)yocto-cve-check reads tmp/log/cve/cve-summary.json directly license-audit per-arch license.manifest walker secure-boot detects signing class configuration and flagsknown test keys
image-signing detects FIT signatures and dm-verity config
vuln-reporting validates the vendor-commitment half of the
dossier from a separateproduct.yamlmanifestIt is deliberately narrow: Apache-2.0 Python, no runtime probes, no shell-outs, no network calls at scan time, and no LLM or AI inference anywhere in the pipeline - shipcheck is fully deterministic. An auditor can read the check code and confirm exactly what each check inspects.
Pilot 0001 (poky Scarthgap, core-image-minimal) is committed at
pilots/0001-poky-scarthgap-min/REPORT.mdwith the full kas-container bootstrap. A worked example driven from aproduct-vendor.yaml(every field set to the placeholder "VENDOR") is committed at audits/0002-blog-demo/ if you want to read the generated Annex VII and DoC drafts without running shipcheck locally.Install:
uv tool install shipcheck # or: pipx install shipcheck cd path/to/yocto/build
shipcheck init
shipcheck check --build-dir . --format evidence --out dossier/
Quoted 4 lines
Blog post walks through the Annex structure, what Yocto gives you for free, and where the paperwork gap lives:
https://jetm.github.io/blog/posts/auditing-your-yocto-build-for-cra-compliance/
Thanks, the blog post is very helpful!
Quoted 7 lines
Repo:
https://github.com/jetm/shipcheck
Feedback very welcome - especially from maintainers on the cve-check, create-spdx, and vex side of things who have opinions on how the check defaults should evolve. File an issue on GitHub, or reply here.
I haven't tested the tool yet, so more feedback to potentially come later, but I would certainly be interested in being able to validate SPDX3.0 output.
Quoted 2 lines
Best,
Javier
Cheers,
Olivier
Quoted 2 lines
Hi Olivier,
Quoted 2 lines · Olivier Benjamin
I would certainly be interested in being able to validate SPDX 3.0 output.
That shipped in v0.0.6. The short version: Yocto Scarthgap scores 20/50 on the new check because create-spdx-3.0 doesn't emit supplier or per-Package checksums in any form -- field or Relationship. The format detection, CreationInfo, and rootElement checks all pass; it's the 30 per-Package points that are zero.
Full details, the scoring breakdown, and a drafted 2-patch series for openembedded-core to fix the emission gap are in the GitHub issue:
https://github.com/jetm/shipcheck/issues/3
If you have a Scarthgap or walnascar build with create-spdx-3.0 enabled, I'd be curious what score you see:
pip install shipcheck==0.0.6 shipcheck check --build-dir <your-build-dir>
The sbom-generation row is the one to watch. Any feedback on the BSI v2.1.0 -> SPDX 3.0 field mapping (committed at audits/0003-spdx3-mapping/mapping.md, marked draft pending review) would also be welcome -- you have more context on how the SPDX community expects BSI's requirements to map to 3.0 constructs.
Quoted 3 lines
Not super relevant, but I would dispute the "paperwork regulation" bit, and one can only gloss over the "scanner-selection" issue if one assumes that problem already solved.
Fair pushback. I was shortcutting. The paperwork framing was meant to highlight the documentation gap, not to minimize the vulnerability- management side of things.
Signature · 1 line
Javier Tia