feat(cryptography): add cryptographic agility plane to CBOM#947
Open
bhess wants to merge 1 commit into
Open
Conversation
Optional cryptoProperties.agility (configurationSource, configurationRef, changeMechanism) plus certificate renewal and key rotation objects backed by a shared lifecycleAutomation enum. Signed-off-by: Basil Hess <bhe@zurich.ibm.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This adds the cryptographic "agility plane" outlined in #892. It records how a cryptographic asset's configuration was set, how that configuration can be changed, and how keys and certificates are rotated and renewed, so that crypto-agility and PQC migration readiness can be expressed in a CBOM.
This covers the three observable dimensions raised in the issue: configuration source, change mechanism, and rotation/renewal. Everything is optional, so existing CBOMs stay valid.
What's added
A new
cryptoProperties.agilityobject that applies to any asset type:configurationSource: how the configuration was determined, roughly ordered from least to most agile:hardcoded,product-default,administrator-configured,policy-managed,negotiated(plusother,unknown).configurationRef: a bom-ref to the configuration that drives this setting, typically adatacomponent whose data type isconfiguration.changeMechanism: how a change gets applied, ordered from least to most agile:not-possible,hardware-replacement,firmware-update,software-update,restart-required,runtime-config(plusother,unknown).A shared
lifecycleAutomationenum for the degree of automation, ordered from least to most agile:not-supported,manual,on-demand,automatic(plusother,unknown).Two per-domain lifecycle objects:
certificateProperties.renewal={ automation, mechanism }, whereautomationis alifecycleAutomationvalue andmechanismis a free-form string (e.g.ACME,EST,SCEP,CMP,CMC).relatedCryptoMaterialProperties.rotation={ automation, mechanism }, wheremechanismis a free-form string (e.g.KMIP,PKCS#11,AWS KMS,Google Cloud KMS,Azure Key Vault,HashiCorp Vault Transit).Design notes
otherandunknownfollow the usual CycloneDX convention.mechanismfields are free-form strings with examples rather than enums, since rotation mechanisms in particular vary a lot (protocols, interfaces, managed services). The name follows the existingsecuredBy.mechanism.configurationSourceandchangeMechanismlive on oneagilityobject instead of being repeated per asset type, because they apply equally to algorithms, protocols, certificates, and keys.Other agility aspects
Originally posted by @stevespringett in #892
Backwards compatibility
Fully additive; no breaking changes.
Refs #892