Skip to content

Commit a93e1f6

Browse files
committed
docs: add SBOM/EU CRA Compliance section to README
1 parent 225924e commit a93e1f6

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
@@ -74,6 +74,34 @@ Information on how to configure, build, and test wolfProvider can be found here:
7474
* Ed25519, Ed448 (signatures)
7575

7676

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

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

0 commit comments

Comments
 (0)