password-hash: clarity improvements for Salt* APIs#1266
Merged
Conversation
The `Salt` and `SaltString` types are wrappers for B64-encoded salt strings as used by the PHC string format. These API changes make it clearer that the input string needs to be B64-encoded. The old API is preserved but with deprecations to ease upgrades. The following methods were renamed: - `Salt::new` => `Salt::from_b64` - `Salt::b64_decode` => `Salt::decode_b64` (for consistency) - `SaltString::new` => `SaltString::from_b64` - `SaltString::b64_decode` => `SaltString::decode_b64` - `SaltString::b64_encode` => `SaltString::encode_b64` The `Salt::as_bytes` and `SaltString::as_bytes` methods were removed, as they return the B64-encoded string as bytes, rather than decoding B64 to bytes, which is what a user might be expecting.
Merged
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
SaltandSaltStringtypes are wrappers for B64-encoded salt strings as used by the PHC string format.These API changes make it clearer that the input string needs to be B64-encoded.
The old API is preserved but with deprecations to ease upgrades.
The following methods were renamed:
Salt::new=>Salt::from_b64Salt::b64_decode=>Salt::decode_b64(for consistency)SaltString::new=>SaltString::from_b64SaltString::b64_decode=>SaltString::decode_b64SaltString::b64_encode=>SaltString::encode_b64The
Salt::as_bytesandSaltString::as_bytesmethods were removed, as they return the B64-encoded string as bytes, rather than decoding B64 to bytes, which is what a user might be expecting.