Document that RSA public exponent must be odd

2018-12-17 10:06:21 +00:00 · 2018-12-17 10:06:21 +00:00 · 0118d4190a
commit 0118d4190a
parent 385ce91592
1 changed files with 1 additions and 0 deletions
--- a/include/mbedtls/rsa.h
+++ b/include/mbedtls/rsa.h
@ -433,6 +433,7 @@ size_t mbedtls_rsa_get_len( const mbedtls_rsa_context *ctx );
 *                 This may be \c NULL if \p f_rng doesn't need a context.
 * \param nbits    The size of the public key in bits.
 * \param exponent The public exponent to use. For example, \c 65537.
+ *                 This must be odd.
 *
 * \return         \c 0 on success.
 * \return         An \c MBEDTLS_ERR_RSA_XXX error code on failure.