ctrf-io / ctrf-io/ctrf

Also Mention UUID version 8

Open Beginner friendly
#59 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
93
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Current

Under section "9.2. testId" the spec says:

A producer MAY use a canonical string directly, or MAY encode that canonical string as a deterministic identifier such as a UUID version 5 or hash.

Proposed Change

A producer MAY use a canonical string directly, or MAY encode that canonical string as a deterministic identifier such as a UUID version 5, UUID version 8 or hash."

Rationale

According to RFC 9562 UUIDv5 must be built from SHA-1. When basing the UUID on e.g. SHA-256, RFC 9562 explains, that UUIDv8 MUST be used.

RFC 9562, Section "5.5. UUID Version 5" says:

There may be scenarios, usually depending on organizational security policies, where SHA-1 libraries may not be available or may be deemed unsafe for use. As such, it may be desirable to generate name-based UUIDs derived from SHA-256 or newer SHA methods. These name-based UUIDs MUST NOT utilize UUIDv5 and MUST be within the UUIDv8 space defined by Section 5.8.

Source: https://www.rfc-editor.org/rfc/rfc9562.html

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 with section 9.2, “testId,” and compare the current wording with the proposed sentence. Check RFC 9562 section 5.5 for the UUIDv8 rationale. Done means the specification mentions UUID version 8 alongside UUID version 5 and hash without changing the surrounding guidance.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.