Skip to content

[Docs] Improve password_hash() documentation, specifically about Argon2 #4577

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

Open
galvao opened this issue Apr 1, 2025 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@galvao
Copy link

galvao commented Apr 1, 2025

Affected page

password_hash
predefined constants

Current issue

Lack of clarity:

  • memory_cost option reads: "Maximum memory (in kibibytes) that may [...]", denoting a clear typo: is it kilobytes? That was my first guess, but then again, the predefined constant for memory cost states that it is provided in bytes, so which one is it?
  • time_cost: There's no information about which unit of time is used (probably seconds, but this is a guess). The information is also missing from the predefined constant for time cost.

Suggested improvement

Provide the correct information about which unit is used to set the costs, both for memory and time.
It would probably be a good idea to double check the remaining documentation for password_* functions.

@galvao galvao added the enhancement New feature or request label Apr 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant