Skip to content

Commit 8db5499

Browse files
committed
docs: add SBOM/EU CRA Compliance section to README
1 parent f7921d9 commit 8db5499

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,34 @@ Information on how to configure, build, and test wolfProvider can be found here:
7575
* Ed25519, Ed448 (signatures)
7676

7777

78+
## SBOM / EU CRA Compliance
79+
80+
wolfProvider generates a Software Bill of Materials (SBOM) in CycloneDX 1.6 and
81+
SPDX 2.3 formats to support compliance with the EU Cyber Resilience Act (CRA).
82+
83+
```sh
84+
make sbom WOLFSSL_DIR=/path/to/wolfssl
85+
```
86+
87+
Requires `python3` and `pyspdxtools` (`pip install spdx-tools`). `WOLFSSL_DIR`
88+
must point to a wolfssl source tree containing `scripts/gen-sbom` (branch
89+
`feat/sbom-embedded`, or `master` once wolfSSL/wolfssl#10343 merges).
90+
91+
Output files in the build directory:
92+
93+
| File | Format |
94+
|------|--------|
95+
| `wolfprov-1.1.1.cdx.json` | CycloneDX 1.6 |
96+
| `wolfprov-1.1.1.spdx.json` | SPDX 2.3 JSON |
97+
| `wolfprov-1.1.1.spdx` | SPDX 2.3 tag-value |
98+
99+
```sh
100+
make install-sbom # installs to $(datadir)/doc/wolfprov/
101+
make uninstall-sbom
102+
```
103+
104+
For further CRA guidance see [wolfssl/doc/CRA.md](https://github.com/wolfSSL/wolfssl/blob/master/doc/CRA.md).
105+
78106
## Support
79107

80108
- [GitHub Issues](https://github.com/wolfssl/wolfProvider/issues)

0 commit comments

Comments
 (0)