Update to RFC 9562 #117
Update to RFC 9562 #117
Conversation
kohenkatz
force-pushed
the
update-draft-name
branch
from
a3cbee1
to
022de58
Compare
|
Sorry for the 13-month delay on this! I think it is ready for review now. |
cameracker
force-pushed
the
update-draft-name
branch
from
401484c
to
5f2ba72
Compare
|
I just realized the coverage isnt running anymore... |
|
Got codecov set back up but it probably wont run on this until we merge. I added @dylan-bourque to the review to see if he has any feedback, but the changes seem correct to me and consistent with the verbiage in the latest RFC. Thank you for taking the time to update this. |
|
I gave this a quick scan and didn't see anything. I'm traveling today so won't have a chance to do a deeper review probably until Monday. |
| func (g *Gen) NewV6() (UUID, error) { | ||
| /* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-6 |
There was a problem hiding this comment.
Nit: maybe include the source link in the godoc comment so that someone doesn't have to dive into the code to find it.
There was a problem hiding this comment.
@dylan-bourque I thought about that, but I think it's too much information that most users won't care about. The link is only there to show the origin of the bit layout below it, which is not something that needs to be in the godoc. The README has links to the full RFC, and that shows up in the godoc already.
| func (g *Gen) NewV7() (UUID, error) { | ||
| var u UUID | ||
| /* https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-04.html#name-uuid-version-7 | ||
| 0 1 2 3 | ||
| /* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-7 |
Co-authored-by: Cameron Ackerman <cameron_ackerman@selinc.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #117 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 513 498 -15
=========================================
- Hits 513 498 -15 ☔ View full report in Codecov by Sentry. |
On 2022-10-17, the IETF uuidrev workgroup published a new draft that replaces peabody draft 04. On 2023-11-06, they released draft 14.On 2024-05-07, the IETF published RFC 9562, obsoleting RFC 4122.This PR updates this project to implement the newest RFC. (fixes #118)
There are a few changes in documentation: mostly pointing to the new RFC URL, and adding comments as appropriate to explain the changes.
A new constant
VariantRFC9562is added, with the oldVariantRFC4122kept as an alias to it for backward compatibility.The one major code change is in the implementation of UUID version 6. Since draft-01, this version now
SHOULDuse new pseudo-random data for the final 62 bytes, instead of using aclock_seqvalue for 14 of those bytes. (Although implementationsMAYkeep the oldclock_seqbehavior, this is discouraged, and is only allowed alongside keeping the MAC address as thenodevalue. Since we are not keeping the MAC address, we also should not keep theclock_seq.