commit 5bdfca926fecd1fcf2caa8e4ff5af43f35c9668c
author Hanno Becker <hanno.becker@arm.com> Tue Dec 18 13:59:28 2018 +0000
committer Hanno Becker <hanno.becker@arm.com> Tue Dec 18 13:59:28 2018 +0000
tree d43707cb891452a5b81670265c53acdddba31a8a
parent 05cf6dabb8eedcba65937e1505f85ac8f76c56d6

Further RSA documentation improvements

include/mbedtls/rsa.h

diff --git a/include/mbedtls/rsa.h b/include/mbedtls/rsa.h
index 814376b..b87c79d 100644
--- a/include/mbedtls/rsa.h
+++ b/include/mbedtls/rsa.h
@@ -725,7 +725,10 @@
  *                 return #MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED.
  *
  * \param ctx      The initialized RSA context to use.
- * \param f_rng    The RNG function. This is needed for #MBEDTLS_RSA_PRIVATE.
+ * \param f_rng    The RNG function. If \p mode is #MBEDTLS_RSA_PRIVATE,
+ *                 this is used for blinding and should be provided; see
+ *                 mbedtls_rsa_private() for more. If \p mode is
+ *                 #MBEDTLS_RSA_PUBLIC, it is ignored.
  * \param p_rng    The RNG context to be passed to \p f_rng. This may be
  *                 \c NULL if \p f_rng is \c NULL or doesn't need a context.
  * \param mode     The mode of operation. This must be either
@@ -771,7 +774,10 @@
  *                 return #MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED.
  *
  * \param ctx      The initialized RSA context to use.
- * \param f_rng    The RNG function. This is needed for #MBEDTLS_RSA_PRIVATE.
+ * \param f_rng    The RNG function. If \p mode is #MBEDTLS_RSA_PRIVATE,
+ *                 this is used for blinding and should be provided; see
+ *                 mbedtls_rsa_private() for more. If \p mode is
+ *                 #MBEDTLS_RSA_PUBLIC, it is ignored.
  * \param p_rng    The RNG context to be passed to \p f_rng. This may be
  *                 \c NULL if \p f_rng is \c NULL or doesn't need a context.
  * \param mode     The mode of operation. This must be either
@@ -877,9 +883,10 @@
  *                 return #MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED.
  *
  * \param ctx      The initialized RSA context to use.
- * \param f_rng    The RNG function. It is needed for PKCS#1 v2.1 encoding
- *                 and for \p mode set to #MBEDTLS_RSA_PRIVATE, and ignored
- *                 otherwise.
+ * \param f_rng    The RNG function. If the padding mode is PKCS#1 v2.1
+ *                 and \p mode is set to #MBEDTLS_RSA_PRIVATE, it is used for
+ *                 blinding and should be provided; see mbedtls_rsa_private().
+ *                 It is ignored otherwise.
  * \param p_rng    The RNG context to be passed to \p f_rng. This may be \c NULL
  *                 if \p f_rng is \c NULL or doesn't need a context argument.
  * \param mode     The mode of operation. This must be either