Skip to content

Commit 5f2f735

Browse files
authored
docs: Update SBOM extraction documentation (#1597)
Update documentation to specify that the SBOM file must follow the file name convention. Addresses #1529 (comment)
1 parent 0c598f8 commit 5f2f735

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

docs/scan-source.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,21 @@ If you want to check for known vulnerabilities only in dependencies in your SBOM
4646
osv-scanner scan source --sbom=/path/to/your/sbom.spdx.json
4747
```
4848

49-
[SPDX] and [CycloneDX] SBOMs using [Package URLs] are supported. The format is
50-
auto-detected based on the input file contents and the file name.
51-
52-
When scanning a directory, only SBOMs following the specification filename will be scanned. See the specs for [SPDX Filenames] and [CycloneDX Filenames].
49+
[SPDX] and [CycloneDX] SBOMs using [Package URLs] are supported.
50+
51+
To identify the correct SBOM format, the file name must follow the SBOM specifications for each format:
52+
53+
- [SPDX Filenames]:
54+
- `*.spdx.json`
55+
- `*.spdx`
56+
- `*.spdx.yml`
57+
- `*.spdx.rdf`
58+
- `*.spdx.rdf.xml`
59+
- [CycloneDX Filenames]:
60+
- `bom.json`
61+
- `*.cdx.json`
62+
- `bom.xml`
63+
- `*.cdx.xml`
5364

5465
[SPDX]: https://spdx.dev/
5566
[SPDX Filenames]: https://spdx.github.io/spdx-spec/v2.3/conformance/

0 commit comments

Comments
 (0)