Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing text in sha512t24u description #386

Closed
jmarshall opened this issue Mar 23, 2022 · 2 comments
Closed

Confusing text in sha512t24u description #386

jmarshall opened this issue Mar 23, 2022 · 2 comments

Comments

@jmarshall
Copy link
Member

jmarshall commented Mar 23, 2022

The opening paragraph of the Truncated Digest (sha512t24u) section says:

The sha512t24u truncated digest algorithm [Hart2020] computes an ASCII digest from binary data. The method uses two well-established standard algorithms, the SHA-512 hash function, which generates a binary digest from binary data, and Base64 URL encoding, which encodes binary data using printable characters. [Emphasis added]

This is confusingly written, as “URL encoding” refers to percent encoding of URLs, which is a different encoding unrelated to the base64 variant used here.

It would be better to use the RFC 4648 terminology for this encoding: either “…and Base64 URL/Filename-Safe encoding, which encodes binary data…” or “…and base64url encoding, which…” (as is used in step 3 later in the section).

@ahwagner
Copy link
Member

I agree, this would be a good change. Of these options, my preference would be for base64url for consistency and brevity.

Copy link

github-actions bot commented Jan 9, 2024

This issue was marked stale due to inactivity.

@github-actions github-actions bot added the Stale See .github/workflows/stale.yml label Jan 9, 2024
@ahwagner ahwagner removed the Stale See .github/workflows/stale.yml label Jan 9, 2024
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

No branches or pull requests

2 participants