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

Add predicate specification for CycloneDX #129

Merged
merged 3 commits into from
Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
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
1 change: 1 addition & 0 deletions spec/predicates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ our [vetting process], and may be of general interest:
operations.
- [SLSA Verification Summary]: SLSA verification decision about a software
artifact.
- [CycloneDX]: CycloneDX BOM for software artifacts.
danbev marked this conversation as resolved.
Show resolved Hide resolved

[Link]: link.md
[New Predicate Guidelines]: ../../docs/new_predicate_guidelines.md
Expand Down
77 changes: 77 additions & 0 deletions spec/predicates/cyclonedx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Predicate type: CycloneDX

Type URI: (tentative) https://cyclonedx.org/bom
danbev marked this conversation as resolved.
Show resolved Hide resolved

Version: 1.4

## Purpose

A Software Bill of Materials type following the [CycloneDX standard].

This allows representing "exportable", or "published" software artifacts,
services, vulnerability information, and more. For a complete list of
capabilities see [CycloneDX Capabilities].

## Prerequisites

The in-toto [attestation] framework and a [CycloneDX BOM 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
[CycloneDX Specification].

### Parsing Rules

The parsing rules for this predicate type are documented in the
[CycloneDX Specification].

### Fields

The fields that make up this predicate type are documented in the
[CycloneDX Specification].
marcelamelara marked this conversation as resolved.
Show resolved Hide resolved

The `predicate` contains a JSON-encoded CycloneDX BOM.
The `subject` contains whatever software artifacts are to be associated with
this CycloneDX BOM document.

## Example

```jsonc
{
// Standard attestation fields:
"_type": "https://in-toto.io/Statement/v0.1",
"subject": [{ ... }],

// Predicate:
"predicateType": "https://cyclonedx.org/bom/v1.4",
"predicate": {
"bomFormat": "CycloneDX",
"specVersion": "1.4",
"serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79",
"version": 1,
"components": [
{
"type": "library",
"name": "acme-library",
"version": "1.0.0"
}
]
...
}
}
```

## Changelog and Migrations

Not applicable for this initial version.

[Attestation]: ../README.md
[CycloneDX standard]: https://cyclonedx.org/specification/overview
[CycloneDX Capabilities]: https://cyclonedx.org/capabilities/
[CycloneDX Specification]: https://github.com/CycloneDX/specification/tree/1.4/schema
[CycloneDX BOM generation tool]: https://cyclonedx.org/tool-center