Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC: SBOM generation #714

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
clarify cyclonedx sbom output
Signed-off-by: Brian DeHamer <[email protected]>
bdehamer committed Aug 10, 2023
commit ab2cea9d60aacdddb5fcff8da41e8bf464092e5b
30 changes: 30 additions & 0 deletions accepted/0000-sbom-command.md
Original file line number Diff line number Diff line change
@@ -72,6 +72,13 @@ Both of the SBOM formats present a flat list of dependencies (CycloneDX groups t
"version": "4.3.4",
"bom-ref": "[email protected]",
"purl": "pkg:npm/[email protected]",
"scope": "required",
"externalReferences": [
{
"type": "distribution",
"url": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz"
}
],
"properties": [
{
"name": "cdx:npm:package:path",
@@ -98,6 +105,8 @@ The <code>[properties](https://cyclonedx.org/docs/1.4/json/#components_items_pro

Similarly, there are named properties defined for identifying things like "bundled", "private", and "extraneous" dependencies. Dependencies will be annotated with this properties as appropriate.

The CycloneDX specification also provides [fields](https://cyclonedx.org/docs/1.4/json/#components) for capturing other package metadata like author, license, website, etc. Not all packages provide this information, but these fields will be populated when the information is available.

#### SPDX

```json
@@ -230,7 +239,14 @@ The proposed CycloneDX SBOM generated for the project above would look like the
"type": "library",
"name": "@tsconfig/node14",
"version": "1.0.3",
"scope": "required",
"purl": "pkg:npm/%40tsconfig/[email protected]",
"externalReferences": [
{
"type": "distribution",
"url": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz"
}
],
"properties": [
{
"name": "cdx:npm:package:path",
@@ -253,7 +269,14 @@ The proposed CycloneDX SBOM generated for the project above would look like the
"type": "library",
"name": "debug",
"version": "4.3.4",
"scope": "required",
"purl": "pkg:npm/[email protected]",
"externalReferences": [
{
"type": "distribution",
"url": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz"
}
],
"properties": [
{
"name": "cdx:npm:package:path",
@@ -272,7 +295,14 @@ The proposed CycloneDX SBOM generated for the project above would look like the
"type": "library",
"name": "ms",
"version": "2.1.2",
"scope": "required",
"purl": "pkg:npm/[email protected]",
"externalReferences": [
{
"type": "distribution",
"url": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz"
}
],
"properties": [
{
"name": "cdx:npm:package:path",