docs: exclude dollar sign from set of allowed characters for passwords and salts #74
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alexander Bartolomey <github@alexanderbartolomey.de>
Signed-off-by: Alexander Bartolomey <github@alexanderbartolomey.de>
Signed-off-by: Alexander Bartolomey <github@alexanderbartolomey.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Your docs for salts and passwords currently supports any special characters. Particularly for the salt, this causes issues, because a salt including "$" will break the encoding of apr1 secret.
For an 8 byte salt, the chances of it including a dollar sign are small but not zero, and exactly this happened to us, breaking downstream at the validation of the password.
This PR refines the documentation to explicitly exclude $ from the set of special characters included in the example password and salt.