CBOMProfiles /Use Cases ← Working group site
DISCLOSURE · WORKED USE CASE

Procurement: one document, read by a second profile

A procurement profile is applied to the Keycloak 26.7.3 product record, the same record the PQC migration use case reads. The record is not changed. This is the first worked example in the disclosure group.

What this shows

The vendor's Keycloak product record is read, unchanged, against a procurement profile. The same record conforms to the interface enumeration profile, the baseline, the PQC migration profile and its extended depth. This example shows with a real document that one detailed record can serve several consumers. Each consumer applies the profile that matches its own decision.

It also shows the limit of this reuse. The product record contains every fact the procurement profile asks for, so the record can answer that profile. The reverse is not true. A record written only for procurement could not answer the migration profile, because nobody collected the capability attributes.

Files

File Status
profile-procurement.rules.json v0.1. Extends the interface disclosure baseline v0.9. Well-formed under requirements C1 to C18
examples/cbom-keycloak-product.cdx.json The vendor's build record of the Keycloak 26.7.3 image, in CycloneDX 2.0. Conforms
examples/cbom-keycloak-product-fail-procurement-P5.cdx.json The same record with the storage interface left out and no reason stated. Fails procurement#P5 only
perspectives/perspective-procurement.cdx.json A CycloneDX 2.0 perspective generated from the rules. Informative only; the rules file is normative

What the profile adds

The profile chooses which existing facts are required and makes some rules stricter. It does not add any new per-interface attribute. Rule ids are local to the profile that declares them. procurement#P5 is therefore a different rule from the baseline's interface-disclosure#P5, which asks for the subject type.

Rule Requirement Why a buyer needs it
scope Subject type product; lifecycle stage implemented only A tender response describes the product being offered. An intention is a promise and belongs in the commercial response
I9 (override) Implementing library, no longer withholdable The buyer has to match advisories for the life of the contract. The tender's confidentiality terms deal with the supplier's reason to withhold it
P5 (new) A storage interface for key material at rest, or a stated reason for having none Responses tend to describe the paths that traffic takes and say nothing about where keys are kept
P6 (new) Coverage all or all-external, not partial A partial disclosure cannot be compared across responses

Verdicts

Document Validator verdict
cbom-keycloak-product Conforms. The realm key storage interface (sto-realm-keys) satisfies P5. Coverage is all-external. Every interface names its implementing library, directly or through the component that provides it
cbom-keycloak-product-fail-procurement-P5 Does not conform. Fails procurement#P5 only. It still conforms to the baseline, which does not ask for a storage interface
legacy/cbom-keycloak-product-1.7 The same facts in CycloneDX 1.7. The validator reads it as legacy, flags it, and reaches the same verdict as for the 2.0 record

To reproduce a verdict, run python3 validate_cbom.py examples/cbom-keycloak-product.cdx.json profile-procurement.rules.json in docs/methodology/. The validator exits with 0 when the record conforms and 1 when it does not conform. Other exit codes mark a usage error (2), a profile error (3), a refusal on carrier version (4) and a claim mismatch (5).

What this asks of the group

PKIC CBOM Profiles Working Group · draft for comment.