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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pseudo random number generator info to randomUUID #38074

Merged
merged 1 commit into from Apr 11, 2021

Conversation

srknzl
Copy link
Contributor

@srknzl srknzl commented Apr 4, 2021

Hello, 馃槉 !

As far as I understand, recently added function crypto.randomUUID is cryptographically strong. I think it's better to mention it in the docs.

ref: #36729

@nodejs-github-bot nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Apr 4, 2021
@srknzl
Copy link
Contributor Author

srknzl commented Apr 4, 2021

alternatively we can say

"The UUID is generated using a cryptographically strong pseudo random number generator."

as in the case of javadoc of randomUUID java method

https://docs.oracle.com/javase/7/docs/api/java/util/UUID.html#randomUUID()

@jasnell
Copy link
Member

jasnell commented Apr 6, 2021

I'd remove the word "strong" to be honest. While it may be clear to those who are very familiar with pseudo-random number generators, I'd suspect that it's fairly meaningless to most developers. "The UUID is generated using a cryptographic pseudo-random number generator" would be just fine I think.

@srknzl srknzl changed the title Add "cryptographically strong" to description of randomUUID Add pseudo random number generator info to randomUUID Apr 7, 2021
doc/api/crypto.md Outdated Show resolved Hide resolved
PR-URL: nodejs#38074
Refs: nodejs#36729
Reviewed-By: Rich Trott <rtrott@gmail.com>
@Trott
Copy link
Member

Trott commented Apr 11, 2021

Landed in 993a1da

@Trott Trott merged commit 993a1da into nodejs:master Apr 11, 2021
targos pushed a commit that referenced this pull request May 1, 2021
PR-URL: #38074
Refs: #36729
Reviewed-By: Rich Trott <rtrott@gmail.com>
@danielleadams danielleadams mentioned this pull request May 3, 2021
danielleadams pushed a commit that referenced this pull request May 8, 2021
PR-URL: #38074
Refs: #36729
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants