Skip to content

docs: clarify CBOM algorithm naming notation and HSS patterns - #108

Open
Mehrn0ush wants to merge 1 commit into
CycloneDX:mainfrom
Mehrn0ush:docs/cbom-algorithm-naming-notation
Open

Mehrn0ush wants to merge 1 commit into
CycloneDX:mainfrom
Mehrn0ush:docs/cbom-algorithm-naming-notation

Conversation

@Mehrn0ush

Copy link
Copy Markdown

Following @stevespringett suggestion in the meeting to contribute to the CBOM guide, and @bhess review suggestion in CycloneDX/specification#1029, this adds detailed naming-pattern guidance to the Cryptography Definitions chapter. It accompanies the shorter schema description proposed in that specification PR.

The update:

  • Clarifies that parentheses group content, while | separates alternatives.
  • Documents placeholders, optional content, repetition, literal characters, and variant references.
  • Explains unique reference resolution, cycle prevention, and partial identification.
  • Documents LMS/LMOTS parameter units and HSS level ordering, pair-count consistency, and non-inheritance of omitted parameters.
  • Adds HSS naming examples and renames the existing RSA example heading for clarity.

Related specification PR: CycloneDX/specification#1029
Review suggestion: CycloneDX/specification#1029 (comment)

This guide update describes notation proposed in #1029; please coordinate review and merging with that change.

Validation:

  • Built the CBOM guide locally with build/build-pdf.sh CBOM.
  • Built and ran the Docker guide generator.
  • Both builds produced a 38-page draft PDF.
  • Inspected the updated sections, including notation, HSS examples, code-block rendering, and the existing RSA example.

@Mehrn0ush
Mehrn0ush requested a review from a team as a code owner October 9, 2026 07:58
Signed-off-by: Mehrn0ush <mehrnoush.vaseghi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants