Skip to contentSkip to conversation

crypto: make the seed() function optional

RFC PATCH In review Mathieu Malaterre 3 participants 3 messages Sep 13, 2017 – Oct 8, 2017 Crypto API

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 crypto: make the seed() function optional

This makes it simplier for driver author to not provide the seed() function in case of a pseudo RNG where the seed operation is a no-op.

Document that the seed() function pointer is optional in header.

---
The PRNG as found on Ingenic JZ4780 is one such example. This is found on a MIPS Creator CI20 SoC.

 crypto/rng.c         | 7 ++++++-
 include/crypto/rng.h | 2 +-
 2 files changed, 7 insertions(+), 2 deletions(-)
crypto/rng.c +6 -1
index 5e8469244960..ed08581901a9 100644
@@ -35,9 +35,14 @@ static int crypto_default_rng_refcnt;
 
 int crypto_rng_reset(struct crypto_rng *tfm, const u8 *seed, unsigned int slen)
 {
+	struct rng_alg *ralg = crypto_rng_alg(tfm);
 	u8 *buf = NULL;
 	int err;
 
+	/* In case of PRNG, no need to seed */
+	if (!ralg->seed)
+		return 0;
+
 	if (!seed && slen) {
 		buf = kmalloc(slen, GFP_KERNEL);
 		if (!buf)
@@ -47,7 +52,7 @@ int crypto_rng_reset(struct crypto_rng *tfm, const u8 *seed, unsigned int slen)
 		seed = buf;
 	}
 
-	err = crypto_rng_alg(tfm)->seed(tfm, seed, slen);
+	err = ralg->seed(tfm, seed, slen);
 
 	kzfree(buf);
 	return err;
include/crypto/rng.h +1 -1
index b95ede354a66..ac5d061d0297 100644
@@ -32,7 +32,7 @@ struct crypto_rng;
  *		random number generator requires a seed for setting
  *		up a new state, the seed must be provided by the
  *		consumer while invoking this function. The required
- *		size of the seed is defined with @seedsize .
+ *		size of the seed is defined with @seedsize. Optional.
  * @set_ent:	Set entropy that would otherwise be obtained from
  *		entropy source.  Internal use only.
  * @seedsize:	The seed size required for a random number generator
Signature · 1 line
2.11.0
maintainer
#1 lore raw
Quoted 9 lines · Mathieu Malaterre

This makes it simplier for driver author to not provide the seed() function in case of a pseudo RNG where the seed operation is a no-op.

Document that the seed() function pointer is optional in header.

---
The PRNG as found on Ingenic JZ4780 is one such example. This is found on a MIPS Creator CI20 SoC.

So how does it seed itself? This also contradicts with the JZ4780 driver that's currently in the patch queue as it does contain a seed function.

Cheers,

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
#2 lore raw

Hi Herbert,

Quoted 6 lines · Herbert Xu
Quoted 5 lines · Mathieu Malaterre

This makes it simplier for driver author to not provide the seed() function in case of a pseudo RNG where the seed operation is a no-op.

Document that the seed() function pointer is optional in header.

Quoted 8 lines
Quoted 4 lines

---
The PRNG as found on Ingenic JZ4780 is one such example. This is found on a MIPS Creator CI20 SoC.

So how does it seed itself? This also contradicts with the JZ4780 driver that's currently in the patch queue as it does contain a seed function.

The current version of JZ4780 driver in the patch queue indeed has seed function. But when Mathieu sent this email based on v2 of the driver. V2 did not have seed callback. Using v2 resulted in a NULL pointer in kernel. This patch prevents that NULL pointer access.

Regardless of what JZ4780 driver has this patch makes sense.

Currently crypto framework does not mandate seed callback's presence. If mandatory, crypto framework should error out if seed is not implemented while registering the PRNG.

Thanks,
PrasannaKumar