spdx / spdx/cryptographic-algorithm-list

Evaluate and decide over the following discrepancies between SPDX and Cyclone DX algorithms IDs

Open
#41 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted question
Dominant language
No language data
Stars
8
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Rationale

In order to keep as much compatibility as possibl;e between SPDX Cryptographic Algorithm List and the CycloneDX algorithms family, SPDX should revisit the following algorithms IDs and decide if:

  • we keep them as they are
  • we change them using the same ID that CycloneDX does
  • look for a way to include a second way to name the algorithm

Request

Evaluate the following IDs:

Some algorithms in CycloneDX are mapped to slightly different SPDX filenames:

  • CAST5/CAST6 → SPDX: cast.yaml
  • ChaCha/ChaCha20 → SPDX: chacha(salsa).yaml
  • FFDH → SPDX: diffiehellman.yaml
  • SHA-1 → SPDX: shs.yaml
  • SHA-2 → SPDX: shax.yaml
  • SHA-3 → SPDX: keccak.yaml Confirm this one!
  • SNOW3G → SPDX: snow.yaml

DoD

  • Discussion and decision about the IDs has been carried out:
    • cast
    • chacha(salsa)
    • diffiehellman
    • shs
    • shax
    • keccak
    • snow
  • List the PR that solve the discrepancies if changes need to be introduced to the algorithms IDs
  • Link to the rationale and the decisions taken if no changes are needed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the listed SPDX filenames with the corresponding CycloneDX algorithm IDs and review the naming rationale for each discrepancy. Done means recording a decision for cast, chacha(salsa), diffiehellman, shs, shax, keccak, and snow, with links to any resulting PRs or rationale.

Written by the indexing model from the issue text.

Assessment

Domain
cryptography
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.