Skip to content

reference as new property batch 1#48

Merged
toscalix merged 13 commits intospdx:mainfrom
toscalix:reference-as-new-property
Jan 14, 2026
Merged

reference as new property batch 1#48
toscalix merged 13 commits intospdx:mainfrom
toscalix:reference-as-new-property

Conversation

@toscalix
Copy link
Copy Markdown
Collaborator

@toscalix toscalix commented Dec 15, 2025

Reference as new property:

  • Added the description and the values to the description file
  • Added the example entry to the CONTRIBUTING.md file
  • Added the references corresponding to the first batch of algorithms, according to the table Proposal of a new property: reference #9 (comment)

As a result of this action, #47 has been created.

As opportunistic changes...

  • id and name fields in the description document are now in lower case, for consistency
  • cast specifiedKey has been added

@stevenc-stb
Copy link
Copy Markdown
Collaborator

just a thought... do we need to name it reference 1: ... reference 2: or can we just name it reference:


reference 1: https://doi.org/10.17487/RFC2144
reference 2: https://tnlandforms.us/cs594-cns96/cast.pdf

to


reference: https://doi.org/10.17487/RFC2144
reference: https://tnlandforms.us/cs594-cns96/cast.pdf

@toscalix
Copy link
Copy Markdown
Collaborator Author

toscalix commented Jan 7, 2026

@scanoss-qg what is your take on this? From the cryptographic algorithms detection perspective, any preference?

@scanoss-qg
Copy link
Copy Markdown
Contributor

@toscalix from the detection perspective, references usually add value (eg: RFC2144 should be an exact match for CAST algorithm).
Some comments related to the yaml specification:

  • Free text value should be quoted -> cryptoClass: "Symmetric-Key-Algorithm/Block-Cipher"
  • Url values does not need to be quoted.
    I also think that @stevenc-stb proposal is not valid for yaml because it leads to repeated keys
    I propose the following format (yaml compliant)

references:
  - https://doi.org/10.17487/RFC3713
  - https://www.iso.org/standard/54531.html

@toscalix
Copy link
Copy Markdown
Collaborator Author

toscalix commented Jan 7, 2026

After discussing the different options described in this PR, we decided at the Cryptography Group meeting on 2026-01-08 to go for what Quique (@scanoss-qg ) proposes.

Updated reference format in SPDX Cryptographic Algorithm List example as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Updated formatting for reference list in the documentation as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Changed the reference property format as agreed during the [Cryptography Group meeting on 2026-01-08](spdx/meetings@67b0077)
Copy link
Copy Markdown
Collaborator

@stevenc-stb stevenc-stb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@toscalix toscalix merged commit a2b59c0 into spdx:main Jan 14, 2026
@toscalix toscalix deleted the reference-as-new-property branch January 28, 2026 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants