kdf: Kdf trait documentation improvements#2211
Merged
Merged
Conversation
Expands documentation and renames the second parameter (not counting `self`) to the KDF from `salt` => `non_secret`. When impl'ing this trait for `hkdf` it became clear that, using the existing structs, `info` was the only parameter that made sense (something @newpavlov hinted at), as `salt` is the only one that can be statefully configured and accessed via `self`. So this renames it to a much more nonspecific `non_secret` and notes in the documentation that such a parameter goes by many different names that all generally serve the same function: customizing the outputs in a non-correlated/indistinguishable manner. It suggests consulting the algorithm-specific documentation for what parameter it actually maps to, except for `Kdf`s marked `Pbkdf` where it says it always maps to the salt.
newpavlov
approved these changes
Jan 20, 2026
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
2 participants
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.
Expands documentation and renames the second parameter (not counting
self) to the KDF fromsalt=>non_secret.When impl'ing this trait for
hkdfit became clear that, using the existing structs,infowas the only parameter that made sense (something @newpavlov hinted at), assaltis the only one that can be statefully configured and accessed viaself.So this renames it to a much more nonspecific
non_secretand notes in the documentation that such a parameter goes by many different names that all generally serve the same function: customizing the outputs in a non-correlated/indistinguishable manner.It suggests consulting the algorithm-specific documentation for what parameter it actually maps to, except for
Kdfs markedPbkdfwhere it says it always maps to the salt.