-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit contains a suggestion for updating the SPDX predicate specification, to include the version in the predicateType. The motivation for this change is same to the motivation that was mentioned for including the version in the CycloneDX predicate specification which is that it allows a consumer to determine the version without having to parse the predicate itself. Signed-off-by: Daniel Bevenius <[email protected]>
- Loading branch information
Showing
1 changed file
with
39 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,69 @@ | ||
# Predicate type: SPDX | ||
|
||
Type URI: (tentative) https://spdx.dev/Document | ||
Type URI: https://spdx.dev/Document | ||
|
||
Version: 1.0.0 | ||
|
||
TODO: Ask SPDX project to choose a URI and to review this spec. Ideally the URI | ||
would resolve to this file. Also, decide whether we want the version number to | ||
reflect the spdxVersion (e.g. 2.2) or have them be independent (no version | ||
number in URI). | ||
Version: 2.3 | ||
|
||
## Purpose | ||
|
||
A Software Bill of Materials type following the | ||
[SPDX standard](https://spdx.dev/specifications/). | ||
[SPDX Specification]. | ||
|
||
This allows to represent an "exportable" or "published" software artifact. It | ||
can also be used as an entry point for other types of in-toto attestation when | ||
performing policy decisions. | ||
|
||
## Prerequisites | ||
|
||
The in-toto [attestation] framework and a [SPDX generation tool]. | ||
|
||
## Model | ||
|
||
This is a predicate type that fits within the larger [Attestation] framework. | ||
|
||
## Schema | ||
|
||
The schema of this predicate type is documented in the | ||
[SPDX Specification]. | ||
|
||
### Parsing Rules | ||
|
||
The parsing rules for this predicate type are documented in the | ||
[SPDX Specification]. | ||
|
||
### Fields | ||
|
||
The fields that make up this predicate type are documented in the | ||
[SPDX specification]. | ||
|
||
The `predicate` contains a JSON-encoded SPDX document. | ||
The `subject` contains whatever software artifacts are to be associated with | ||
this SPDX document. | ||
|
||
|
||
## Example | ||
|
||
```jsonc | ||
{ | ||
// Standard attestation fields: | ||
"_type": "https://in-toto.io/Statement/v0.1", | ||
"subject": [{ ... }], | ||
|
||
// Predicate: | ||
"predicateType": "https://spdx.dev/Document", | ||
"predicateType": "https://spdx.dev/Document/v2.3", | ||
"predicate": { | ||
"SPDXID" : "SPDXRef-DOCUMENT", | ||
"spdxVersion" : "SPDX-2.2", | ||
"spdxVersion" : "SPDX-2.3", | ||
... | ||
} | ||
} | ||
``` | ||
|
||
_(Note: This is a Predicate type that fits within the larger | ||
[Attestation](../README.md) framework.)_ | ||
## Changelog and Migrations | ||
|
||
The `predicate` contains a JSON-encoded SPDX document. The SPDX format has a | ||
mandatory `spdxVersion` field, so we omit the version number from the | ||
`predicateType` URI to avoid confusion. | ||
### Version 2.3 | ||
* Added version to predicateType | ||
|
||
The `subject` contains whatever software artifacts are to be associated with | ||
this SPDX document. | ||
[Attestation]: ../README.md | ||
[SPDX specification]: https://spdx.github.io/spdx-spec/v2.3 | ||
[SPDX generation tool]: https://spdx.dev/resources/tools/ |