Add general software profile example

This commit adds the software profile example drawio file and screenshot of the drawio diagram. The hope is that other profiles will build on top of this core example and we can generate SPDX docs for these examples to make adopting 3.0 easier. Signed-off-by: Rose Judge <[email protected]>
bact · May 15, 2024 · b0d664c · b0d664c
1 parent 6c43edb
commit b0d664c
Show file tree

Hide file tree

Showing 5 changed files with 1,007 additions and 0 deletions.
diff --git a/software/README.md b/software/README.md
@@ -30,4 +30,6 @@ Each directory contains build metadata which is used to create the build artifac
 |  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 |
 | 10 | 1 Python file | python package | 1 document | packaged using the [instructions from python.org](https://packaging.python.org/en/latest/tutorials/packaging-projects/) |
 | 11 | 1 Rust file | compiled with Cargo | 1 document | SBOM describing both source and artifact, related with GENERATED_FROM |
+| 12 | 1 Ruby library | built using `bundle` | 1 document | SBOM describing Ruby library packaged in a gem |
+| 13 | Bundled app with a package and container | No compiling - hypothetical example | Documents in progress | SBOM describing a hypothetical "Acme Aplication" |
 
diff --git a/software/example13/README.md b/software/example13/README.md
@@ -0,0 +1,7 @@
+# Example 13
+
+## Description
+
+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.
+
+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.
diff --git a/software/example13/example-13.png b/software/example13/example-13.png
diff --git a/software/example13/spdx-3.0/example-13-spdx-3.json b/software/example13/spdx-3.0/example-13-spdx-3.json
@@ -0,0 +1,153 @@
+{
+	 "@context": "https://spdx.org/rdf/3.0.0/spdx-context.jsonld",
+	 "@graph": [
+		 {
+			 "type": "Person",
+			 "spdxId": "urn:[email protected]",
+			 "creationInfo": "_:creationinfo",
+			 "name": "Application Owner Jane Doe",
+			 "externalIdentifiers": [
+				 {
+					 "type": "ExternalIdentifier",
+					 "externalIdentifierType": "email",
+					 "identifier": "[email protected]"
+				 }
+			 ]
+		 },
+		 {
+			 "type": "Organization",
+			 "spdxId": "urn:acme.com-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "name": "Acme Company"
+		 },
+		 {
+			 "type": "Person",
+			 "spdxId": "urn:github.com-indutny-c4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "name": "Fedor Indutny",
+			 "externalIdentifiers": [
+				 {
+					 "type": "ExternalIdentifier",
+					 "externalIdentifierType": "other",
+					 "identifierLocator": "https://github.com/indutny"
+				 }
+			 ]
+		 },
+		 {
+			 "type": "Organization",
+			 "spdxId": "urn:github.com-alpinelinux-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "name": "Alpine Linux"
+
+		 },
+		 {
+			 "type": "CreationInfo",
+			 "@id": "_:creationinfo",
+			 "specVersion": "3.0.0",
+			 "createdBy": [
+				 "urn:[email protected]",
+				 "urn:acme.com-4fe40e24-20e3-11ee-be56-0242ac120002"
+			 ],
+			 "created": "2024-05-02T00:00:00Z"
+		 },
+		 {
+			 "type": "SpdxDocument",
+			 "spdxId": "http://spdx.example.com/Document1",
+			 "creationInfo": "_:creationinfo",
+			 "profileConformance": [
+				 "core",
+				 "software"
+			 ],
+			 "rootElement": [
+				 "urn:example13-sbom.com-4fe40e24-20e3-11ee-be56-0242ac120002"
+			 ]
+		 },
+		 {
+			 "type": "software_Sbom",
+			 "spdxId": "urn:example13-sbom.com-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "profileConformance": [
+                                 "core",
+                                 "software"
+                         ],
+			 "rootElement": [
+				 "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002"
+			 ]
+		 },
+		 {
+			 "type": "software_Package",
+			 "spdxId": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "name": "Acme Application",
+			 "software_packageVersion": "1.3",
+			 "suppliedBy": "urn:acme.com-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "software_primaryPurpose": "application"
+		 },
+		 {
+			 "type": "software_Package",
+			 "spdxId": "urn:npm-elliptic-6.5.2-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "name": "npm-elliptic",
+			 "software_packageVersion": "6.5.2",
+			 "suppliedBy": "urn:github.com-indutny-c4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "software_primaryPurpose": "library",
+			 "externalIdentifiers": [
+				 {
+					 "type": "ExternalIdentifier",
+					 "externalIdentifierType": "other",
+					 "identifierLocator": "https://github.com/indutny/elliptic/releases/tag/v6.5.2"
+                                 }
+                         ]
+
+		 },
+		 {
+			 "type": "software_Package",
+			 "spdxId": "urn:container-alpine-latest-sha256:69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "name": "alpine:latest",
+			 "software_packageVersion": "69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a",
+			 "suppliedBy": "urn:github.com-alpinelinux-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "software_primaryPurpose": "container"
+		 },
+		 {
+			 "type": "software_Package",
+			 "spdxId": "urn:openssl-3.0.4-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "name": "openssl",
+			 "software_packageVersion": "3.0.4",
+			 "software_primaryPurpose": "library"
+		 },
+		 {
+			 "type": "Relationship",
+			 "spdxId": "urn:acme-relationship-1-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "from": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "to": "urn:[email protected]",
+			 "relationshipType": "availableFrom"
+		 },
+		 {
+			 "type": "Relationship",
+			 "spdxId": "urn:acme-relationship-2-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "from": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "to": "urn:npm-elliptic-6.5.2-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "relationshipType": "contains"
+		 },
+		 {
+			 "type": "Relationship",
+			 "spdxId": "urn:acme-relationship-3-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "from": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "to": "urn:container-alpine-latest-sha256:69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "relationshipType": "depends_on"
+		 },
+		 {
+			 "type": "Relationship",
+			 "spdxId": "urn:acme-relationship-4-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "creationInfo": "_:creationinfo",
+			 "from": "urn:container-alpine-latest-sha256:69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "to": "urn:openssl-3.0.4-4fe40e24-20e3-11ee-be56-0242ac120002",
+			 "relationshipType": "contains"
+		 }
+	 ]
+}