Skip to content

Commit 8a73b32

Browse files
authored
Merge pull request #78 from rnjudge/add-drawio-example
Add general software profile example
2 parents 6c43edb + b0d664c commit 8a73b32

File tree

5 files changed

+1007
-0
lines changed

5 files changed

+1007
-0
lines changed

software/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,6 @@ Each directory contains build metadata which is used to create the build artifac
3030
| 9 | 2 Java files | generated from Gradle | 1 document |a copy of the [App-BOM-ination SPDX example](https://github.com/yevster/App-BOM-ination) contributed by @yevster for the SPDX spec version 2.0 docfest |
3131
| 10 | 1 Python file | python package | 1 document | packaged using the [instructions from python.org](https://packaging.python.org/en/latest/tutorials/packaging-projects/) |
3232
| 11 | 1 Rust file | compiled with Cargo | 1 document | SBOM describing both source and artifact, related with GENERATED_FROM |
33+
| 12 | 1 Ruby library | built using `bundle` | 1 document | SBOM describing Ruby library packaged in a gem |
34+
| 13 | Bundled app with a package and container | No compiling - hypothetical example | Documents in progress | SBOM describing a hypothetical "Acme Aplication" |
3335

software/example13/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Example 13
2+
3+
## Description
4+
5+
This is a hypothetical example of a "simple" piece of software, Acme Application version 1.3. This example shows what an SPDX-3.0 document looks like for said Acme Application. The idea for this example is that other profiles will be able to build on top of this and demonstrate how all the profiles can work in harmony.
6+
7+
In this specific example, Acme Application is a bundled and distributed piece of software. When Acme Application is run, it pulls in the `alpine:latest` container image which runs in parallel to the `npm-elliptic` library that is packaged and distributed within the Acme Application binary. Among others not depicted for the sake of simplicity, `openssl` is a package included in the `alpine:latest` container image. The example-13 SBOM describes the Acme Application top level piece of software.

software/example13/example-13.png

109 KB
Loading
Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
{
2+
"@context": "https://spdx.org/rdf/3.0.0/spdx-context.jsonld",
3+
"@graph": [
4+
{
5+
"type": "Person",
6+
"spdxId": "urn:[email protected]",
7+
"creationInfo": "_:creationinfo",
8+
"name": "Application Owner Jane Doe",
9+
"externalIdentifiers": [
10+
{
11+
"type": "ExternalIdentifier",
12+
"externalIdentifierType": "email",
13+
"identifier": "[email protected]"
14+
}
15+
]
16+
},
17+
{
18+
"type": "Organization",
19+
"spdxId": "urn:acme.com-4fe40e24-20e3-11ee-be56-0242ac120002",
20+
"creationInfo": "_:creationinfo",
21+
"name": "Acme Company"
22+
},
23+
{
24+
"type": "Person",
25+
"spdxId": "urn:github.com-indutny-c4fe40e24-20e3-11ee-be56-0242ac120002",
26+
"creationInfo": "_:creationinfo",
27+
"name": "Fedor Indutny",
28+
"externalIdentifiers": [
29+
{
30+
"type": "ExternalIdentifier",
31+
"externalIdentifierType": "other",
32+
"identifierLocator": "https://github.com/indutny"
33+
}
34+
]
35+
},
36+
{
37+
"type": "Organization",
38+
"spdxId": "urn:github.com-alpinelinux-4fe40e24-20e3-11ee-be56-0242ac120002",
39+
"creationInfo": "_:creationinfo",
40+
"name": "Alpine Linux"
41+
42+
},
43+
{
44+
"type": "CreationInfo",
45+
"@id": "_:creationinfo",
46+
"specVersion": "3.0.0",
47+
"createdBy": [
48+
49+
"urn:acme.com-4fe40e24-20e3-11ee-be56-0242ac120002"
50+
],
51+
"created": "2024-05-02T00:00:00Z"
52+
},
53+
{
54+
"type": "SpdxDocument",
55+
"spdxId": "http://spdx.example.com/Document1",
56+
"creationInfo": "_:creationinfo",
57+
"profileConformance": [
58+
"core",
59+
"software"
60+
],
61+
"rootElement": [
62+
"urn:example13-sbom.com-4fe40e24-20e3-11ee-be56-0242ac120002"
63+
]
64+
},
65+
{
66+
"type": "software_Sbom",
67+
"spdxId": "urn:example13-sbom.com-4fe40e24-20e3-11ee-be56-0242ac120002",
68+
"creationInfo": "_:creationinfo",
69+
"profileConformance": [
70+
"core",
71+
"software"
72+
],
73+
"rootElement": [
74+
"urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002"
75+
]
76+
},
77+
{
78+
"type": "software_Package",
79+
"spdxId": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002",
80+
"creationInfo": "_:creationinfo",
81+
"name": "Acme Application",
82+
"software_packageVersion": "1.3",
83+
"suppliedBy": "urn:acme.com-4fe40e24-20e3-11ee-be56-0242ac120002",
84+
"software_primaryPurpose": "application"
85+
},
86+
{
87+
"type": "software_Package",
88+
"spdxId": "urn:npm-elliptic-6.5.2-4fe40e24-20e3-11ee-be56-0242ac120002",
89+
"creationInfo": "_:creationinfo",
90+
"name": "npm-elliptic",
91+
"software_packageVersion": "6.5.2",
92+
"suppliedBy": "urn:github.com-indutny-c4fe40e24-20e3-11ee-be56-0242ac120002",
93+
"software_primaryPurpose": "library",
94+
"externalIdentifiers": [
95+
{
96+
"type": "ExternalIdentifier",
97+
"externalIdentifierType": "other",
98+
"identifierLocator": "https://github.com/indutny/elliptic/releases/tag/v6.5.2"
99+
}
100+
]
101+
102+
},
103+
{
104+
"type": "software_Package",
105+
"spdxId": "urn:container-alpine-latest-sha256:69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a-4fe40e24-20e3-11ee-be56-0242ac120002",
106+
"creationInfo": "_:creationinfo",
107+
"name": "alpine:latest",
108+
"software_packageVersion": "69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a",
109+
"suppliedBy": "urn:github.com-alpinelinux-4fe40e24-20e3-11ee-be56-0242ac120002",
110+
"software_primaryPurpose": "container"
111+
},
112+
{
113+
"type": "software_Package",
114+
"spdxId": "urn:openssl-3.0.4-4fe40e24-20e3-11ee-be56-0242ac120002",
115+
"creationInfo": "_:creationinfo",
116+
"name": "openssl",
117+
"software_packageVersion": "3.0.4",
118+
"software_primaryPurpose": "library"
119+
},
120+
{
121+
"type": "Relationship",
122+
"spdxId": "urn:acme-relationship-1-4fe40e24-20e3-11ee-be56-0242ac120002",
123+
"creationInfo": "_:creationinfo",
124+
"from": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002",
125+
"to": "urn:[email protected]",
126+
"relationshipType": "availableFrom"
127+
},
128+
{
129+
"type": "Relationship",
130+
"spdxId": "urn:acme-relationship-2-4fe40e24-20e3-11ee-be56-0242ac120002",
131+
"creationInfo": "_:creationinfo",
132+
"from": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002",
133+
"to": "urn:npm-elliptic-6.5.2-4fe40e24-20e3-11ee-be56-0242ac120002",
134+
"relationshipType": "contains"
135+
},
136+
{
137+
"type": "Relationship",
138+
"spdxId": "urn:acme-relationship-3-4fe40e24-20e3-11ee-be56-0242ac120002",
139+
"creationInfo": "_:creationinfo",
140+
"from": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002",
141+
"to": "urn:container-alpine-latest-sha256:69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a-4fe40e24-20e3-11ee-be56-0242ac120002",
142+
"relationshipType": "depends_on"
143+
},
144+
{
145+
"type": "Relationship",
146+
"spdxId": "urn:acme-relationship-4-4fe40e24-20e3-11ee-be56-0242ac120002",
147+
"creationInfo": "_:creationinfo",
148+
"from": "urn:container-alpine-latest-sha256:69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a-4fe40e24-20e3-11ee-be56-0242ac120002",
149+
"to": "urn:openssl-3.0.4-4fe40e24-20e3-11ee-be56-0242ac120002",
150+
"relationshipType": "contains"
151+
}
152+
]
153+
}

0 commit comments

Comments
 (0)