Summary
Add image annotations to the CSSC Dashboard images that expose the project's security policy and a programmatic vulnerability-reporting URL, so consumers can discover both from image metadata.
Motivation
The images already carry rich supply-chain annotations (source, revision, base image, build workflow/run, SBOM + provenance referrers). What is missing is a machine-discoverable pointer to the security policy and to where/how to report a vulnerability in these images. Surfacing these links in the annotations keeps them traveling with the image regardless of registry UI.
Proposed change
Add two separate custom annotations (there are no standard org.opencontainers.image.* annotations for these, so com.toddysm.* custom annotations are used, consistent with the existing namespace):
- Security policy —
com.toddysm.security.policy
- Value: URL of the human-readable security policy (the repo
SECURITY.md, e.g. https://github.com/toddysm/cssc-framework/security/policy).
- This is the annotation already described previously.
- Vulnerability reporting URL —
com.toddysm.security.report-url
- Value: the URL that can be used to programmatically report a vulnerability (the GitHub private advisory intake endpoint, e.g.
https://github.com/toddysm/cssc-framework/security/advisories/new).
For both annotations:
- Set them at both the multi-arch index and each per-platform manifest, matching how the other annotations are applied.
- Wire the values through
build-cssc-dashboard.yml alongside the existing --annotation flags.
Prerequisite
Docs to update
The documentation must be updated to describe both new annotations:
docs/reference/image-annotations.md — add both annotations to the Custom annotations (com.toddysm.*) table.
docs/guides/build/reading-image-annotations.md — show how to read the security-policy and vulnerability-reporting links.
Acceptance criteria
Summary
Add image annotations to the CSSC Dashboard images that expose the project's security policy and a programmatic vulnerability-reporting URL, so consumers can discover both from image metadata.
Motivation
The images already carry rich supply-chain annotations (source, revision, base image, build workflow/run, SBOM + provenance referrers). What is missing is a machine-discoverable pointer to the security policy and to where/how to report a vulnerability in these images. Surfacing these links in the annotations keeps them traveling with the image regardless of registry UI.
Proposed change
Add two separate custom annotations (there are no standard
org.opencontainers.image.*annotations for these, socom.toddysm.*custom annotations are used, consistent with the existing namespace):com.toddysm.security.policySECURITY.md, e.g.https://github.com/toddysm/cssc-framework/security/policy).com.toddysm.security.report-urlhttps://github.com/toddysm/cssc-framework/security/advisories/new).For both annotations:
build-cssc-dashboard.ymlalongside the existing--annotationflags.Prerequisite
SECURITY.mdsecurity policy — being added in Create a security policy (SECURITY.md) #136 / PR Add repository security policy (SECURITY.md) #137. Once merged, the policy is served at.../security/policyand the reporting intake at.../security/advisories/new.Docs to update
The documentation must be updated to describe both new annotations:
docs/reference/image-annotations.md— add both annotations to the Custom annotations (com.toddysm.*) table.docs/guides/build/reading-image-annotations.md— show how to read the security-policy and vulnerability-reporting links.Acceptance criteria
com.toddysm.security.policyandcom.toddysm.security.report-urlannotations at index + per-platform manifest.com.toddysm.security.policyresolves to the security policy page.com.toddysm.security.report-urlresolves to the programmatic vulnerability-reporting endpoint.