Commit 2576c04
docs(sbom): correct NTIA/SPDX claims; fix broken anchor
Three documentation corrections from the wolfssl-1zj review:
* README.md previously said 'Both produce SPDX 2.3 + CycloneDX
1.6 JSON validated against NTIA minimum elements'. Neither
entry point runs an NTIA-minimum-elements checker. The
autotools 'make sbom' path runs pyspdxtools (SPDX-spec
validation, not NTIA-specific) and gates the build on it;
the standalone embedded path runs no validation by default.
Replace with text saying the SBOMs are intended to satisfy
NTIA minimum elements, that only the autotools path runs
SPDX validation, and that neither path runs an NTIA checker
by default. Matters because downstream integrators quoting
this README to auditors must not be misled into claiming
NTIA validation has been performed (1zj.13).
* doc/CRA.md previously named ntia-conformance-checker
alongside pyspdxtools as a tool that 'will reject the SBOM
otherwise' when a LicenseRef has no hasExtractedLicensingInfos
block. ntia-conformance-checker validates the NTIA Minimum
Elements (supplier, component name, version, unique ID,
dependency relationships, author, timestamp) -- it does NOT
enforce SPDX 2.3 \xc2\xa710.1 extracted-text completeness, which is
a SPDX schema concern enforced by pyspdxtools. A reader who
relied on the claim would get a false pass on a malformed
LicenseRef SBOM. Drop the misleading mention; add a
sentence stating what ntia-conformance-checker actually
checks (1zj.16).
* doc/SBOM.md anchor link 'See [Prerequisites for make bomsh]
(#3-make-bomsh)' resolved to the top of section 3 instead
of the \xc2\xa73.1 prerequisites subsection. Fix to the GFM
auto-anchor for '### 3.1 Prerequisites for make bomsh',
which is #31-prerequisites-for-make-bomsh (1zj.18).
Closes wolfssl-1zj.13, wolfssl-1zj.16, wolfssl-1zj.181 parent c13f384 commit 2576c04
3 files changed
Lines changed: 14 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
48 | | - | |
49 | | - | |
50 | | - | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
51 | 55 | | |
52 | 56 | | |
53 | 57 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
181 | 181 | | |
182 | 182 | | |
183 | 183 | | |
184 | | - | |
185 | | - | |
186 | | - | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
187 | 190 | | |
188 | 191 | | |
189 | 192 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
381 | 381 | | |
382 | 382 | | |
383 | 383 | | |
384 | | - | |
| 384 | + | |
385 | 385 | | |
386 | 386 | | |
387 | 387 | | |
| |||
0 commit comments