crypto-common: change generate_* to support getrandom
#1371
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
This commit splits the existing `generate_*` functions into two different variants: - `fn generate_*`: accepts no parameters and uses `OsRng` automatically. Gated on the `getrandom` feature. - `fn generate_*_with_rng`: accepts a `&mut impl CryptoRngCore` parameter. Gated on the `rand_core`. Previously all of the `generate_*` methods were parameterized on a `CryptoRngCore`. Splitting them up like this makes it very easy for users to do the right thing, which is use `getrandom`/`OsRng`, but without the need to document how to import `OsRng` into their code everywhere. Retaining the parameterized versions as `*_with_rng` allows users to pass a custom RNG where it makes sense, for example `rand::thread_rng`, or potentially an embedded peripheral/entropy pool.
newpavlov
approved these changes
Oct 31, 2023
tarcieri
commented
Nov 9, 2023
| /// Generate random key using the provided [`CryptoRngCore`]. | ||
| #[cfg(feature = "rand_core")] | ||
| #[inline] | ||
| fn generate_key(mut rng: impl CryptoRngCore) -> Key<Self> { | ||
| fn generate_key_with_rng(rng: &mut impl CryptoRngCore) -> Key<Self> { | ||
| let mut key = Key::<Self>::default(); | ||
| rng.fill_bytes(&mut key); |
There was a problem hiding this comment.
@newpavlov should we also make these methods fallible and call try_fill_bytes?
There was a problem hiding this comment.
It may be worth to add separate try_* variants and add a note to the generate_* method docs about potential (improbable) panics.
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.
This commit splits the existing
generate_*functions into two different variants:fn generate_*: accepts no parameters and usesOsRngautomatically. Gated on thegetrandomfeature.fn generate_*_with_rng: accepts a&mut impl CryptoRngCoreparameter. Gated on therand_core.Previously all of the
generate_*methods were parameterized on aCryptoRngCore.Splitting them up like this makes it very easy for users to do the right thing, which is use
getrandom/OsRng, but without the need to document how to importOsRnginto their code everywhere.Retaining the parameterized versions as
*_with_rngallows users to pass a custom RNG where it makes sense, for examplerand::thread_rng, or potentially an embedded peripheral/entropy pool.