Repository navigation
feat(2.0): add instruments to behavior instances #1201
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
base: 2.0-dev
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -69,6 +69,15 @@ | |
| "items": { | ||
| "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType" | ||
| } | ||
| }, | ||
| "instruments": { | ||
| "type": "array", | ||
| "title": "Instruments", | ||
| "description": "References using bom-link or `refId` to objects by means of which this behavior is performed, such as the cryptographic key and algorithm used to create a signature. An instrument neither performs the behavior nor is affected by it.", | ||
| "uniqueItems": true, | ||
| "items": { | ||
| "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType" | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. type and description do not match
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're right. I copied the type and the wording from the neighbouring I see two ways to fix it and would like your preference before changing anything:
I lean towards option 1, because the cross-BOM case matters for cryptographic assets, but I don't want this PR to pre-empt the decision in #1202. Which would you prefer? |
||
| } | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| { | ||
| "$comment": "A build service signs a firmware image. The behavior instance names who signs (actors), what is signed (targets), and the key and algorithm used to sign (instruments).", | ||
| "specFormat": "CycloneDX", | ||
| "specVersion": "2.0", | ||
| "serialNumber": "urn:uuid:c2000000-0000-4000-8000-0000000000b3", | ||
| "version": 1, | ||
| "definitions": { | ||
| "components": [ | ||
| { | ||
| "type": "cryptographic-asset", | ||
| "refId": "alg-ml-dsa-65", | ||
| "name": "ML-DSA-65", | ||
| "cryptoProperties": { | ||
| "assetType": "algorithm", | ||
| "algorithmProperties": { | ||
| "primitive": "signature", | ||
| "algorithmFamily": "ML-DSA", | ||
| "parameterSetIdentifier": "65", | ||
| "cryptoFunctions": [ | ||
| "sign", | ||
| "verify" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "type": "cryptographic-asset", | ||
| "refId": "key-release-signing", | ||
| "name": "Release signing private key", | ||
| "cryptoProperties": { | ||
| "assetType": "related-crypto-material", | ||
| "relatedCryptoMaterialProperties": { | ||
| "type": "private-key", | ||
| "keyUsage": [ | ||
| "sign" | ||
| ], | ||
| "relatedCryptographicAssets": [ | ||
| { | ||
| "type": "algorithm", | ||
| "ref": "alg-ml-dsa-65" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "blueprints": [ | ||
| { | ||
| "refId": "bp-signing", | ||
| "name": "Firmware release signing", | ||
| "modelTypes": [ | ||
| "behavioral" | ||
| ], | ||
| "assets": [ | ||
| { | ||
| "refId": "asset-build-service", | ||
| "type": "service", | ||
| "name": "Build service" | ||
| }, | ||
| { | ||
| "refId": "asset-firmware", | ||
| "type": "data", | ||
| "name": "Firmware image" | ||
| } | ||
| ], | ||
| "behaviors": { | ||
| "instances": [ | ||
| { | ||
| "refId": "bi-sign-firmware", | ||
| "behavior": "security:cryptography:signsCode", | ||
| "acknowledgment": [ | ||
| "declared" | ||
| ], | ||
| "actors": [ | ||
| "asset-build-service" | ||
| ], | ||
| "targets": [ | ||
| "asset-firmware" | ||
| ], | ||
| "instruments": [ | ||
| "key-release-signing", | ||
| "key-release-signing" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| { | ||
| "$comment": "A build service signs a firmware image. The behavior instance names who signs (actors), what is signed (targets), and the key and algorithm used to sign (instruments).", | ||
| "specFormat": "CycloneDX", | ||
| "specVersion": "2.0", | ||
| "serialNumber": "urn:uuid:c2000000-0000-4000-8000-0000000000b2", | ||
| "version": 1, | ||
| "definitions": { | ||
| "components": [ | ||
| { | ||
| "type": "cryptographic-asset", | ||
| "refId": "alg-ml-dsa-65", | ||
| "name": "ML-DSA-65", | ||
| "cryptoProperties": { | ||
| "assetType": "algorithm", | ||
| "algorithmProperties": { | ||
| "primitive": "signature", | ||
| "algorithmFamily": "ML-DSA", | ||
| "parameterSetIdentifier": "65", | ||
| "cryptoFunctions": [ | ||
| "sign", | ||
| "verify" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "type": "cryptographic-asset", | ||
| "refId": "key-release-signing", | ||
| "name": "Release signing private key", | ||
| "cryptoProperties": { | ||
| "assetType": "related-crypto-material", | ||
| "relatedCryptoMaterialProperties": { | ||
| "type": "private-key", | ||
| "keyUsage": [ | ||
| "sign" | ||
| ], | ||
| "relatedCryptographicAssets": [ | ||
| { | ||
| "type": "algorithm", | ||
| "ref": "alg-ml-dsa-65" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "blueprints": [ | ||
| { | ||
| "refId": "bp-signing", | ||
| "name": "Firmware release signing", | ||
| "modelTypes": [ | ||
| "behavioral" | ||
| ], | ||
| "assets": [ | ||
| { | ||
| "refId": "asset-build-service", | ||
| "type": "service", | ||
| "name": "Build service" | ||
| }, | ||
| { | ||
| "refId": "asset-firmware", | ||
| "type": "data", | ||
| "name": "Firmware image" | ||
| } | ||
| ], | ||
| "behaviors": { | ||
| "instances": [ | ||
| { | ||
| "refId": "bi-sign-firmware", | ||
| "behavior": "security:cryptography:signsCode", | ||
| "acknowledgment": [ | ||
| "declared" | ||
| ], | ||
| "actors": [ | ||
| "asset-build-service" | ||
| ], | ||
| "targets": [ | ||
| "asset-firmware" | ||
| ], | ||
| "instruments": "key-release-signing" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| { | ||
| "$comment": "A build service signs a firmware image. The behavior instance names who signs (actors), what is signed (targets), and the key and algorithm used to sign (instruments).", | ||
| "specFormat": "CycloneDX", | ||
| "specVersion": "2.0", | ||
| "serialNumber": "urn:uuid:c2000000-0000-4000-8000-0000000000b1", | ||
| "version": 1, | ||
| "definitions": { | ||
| "components": [ | ||
| { | ||
| "type": "cryptographic-asset", | ||
| "refId": "alg-ml-dsa-65", | ||
| "name": "ML-DSA-65", | ||
| "cryptoProperties": { | ||
| "assetType": "algorithm", | ||
| "algorithmProperties": { | ||
| "primitive": "signature", | ||
| "algorithmFamily": "ML-DSA", | ||
| "parameterSetIdentifier": "65", | ||
| "cryptoFunctions": [ | ||
| "sign", | ||
| "verify" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "type": "cryptographic-asset", | ||
| "refId": "key-release-signing", | ||
| "name": "Release signing private key", | ||
| "cryptoProperties": { | ||
| "assetType": "related-crypto-material", | ||
| "relatedCryptoMaterialProperties": { | ||
| "type": "private-key", | ||
| "keyUsage": [ | ||
| "sign" | ||
| ], | ||
| "relatedCryptographicAssets": [ | ||
| { | ||
| "type": "algorithm", | ||
| "ref": "alg-ml-dsa-65" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "blueprints": [ | ||
| { | ||
| "refId": "bp-signing", | ||
| "name": "Firmware release signing", | ||
| "modelTypes": [ | ||
| "behavioral" | ||
| ], | ||
| "assets": [ | ||
| { | ||
| "refId": "asset-build-service", | ||
| "type": "service", | ||
| "name": "Build service" | ||
| }, | ||
| { | ||
| "refId": "asset-firmware", | ||
| "type": "data", | ||
| "name": "Firmware image" | ||
| } | ||
| ], | ||
| "behaviors": { | ||
| "instances": [ | ||
| { | ||
| "refId": "bi-sign-firmware", | ||
| "behavior": "security:cryptography:signsCode", | ||
| "acknowledgment": [ | ||
| "declared" | ||
| ], | ||
| "actors": [ | ||
| "asset-build-service" | ||
| ], | ||
| "targets": [ | ||
| "asset-firmware" | ||
| ], | ||
| "instruments": [ | ||
| "key-release-signing", | ||
| "alg-ml-dsa-65" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could this be more clear?
maybe like so