lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-30 22:43:08 +03:00
Code Activity

Improve mbedtls_rsa_init/set_padding() descriptions

Browse Source 
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
This commit is contained in:
Ronald Cron
2021-06-08 09:09:04 +02:00
parent 6fe1bc3f24
commit d2cfa3e980
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/mbedtls/rsa.h
View File

@ -135,10 +135,9 @@ mbedtls_rsa_context;
* \brief This function initializes an RSA context. * \brief This function initializes an RSA context.
* *
* \note This function initializes the padding and the hash * \note This function initializes the padding and the hash
* identifier for #MBEDTLS_RSA_PKCS_V21 to respectively * identifier to respectively #MBEDTLS_RSA_PKCS_V15 and
* #MBEDTLS_RSA_PKCS_V15 and #MBEDTLS_MD_NONE. See * #MBEDTLS_MD_NONE. See mbedtls_rsa_set_padding() for more
* mbedtls_rsa_set_padding() for more information about * information about those parameters.
* those parameters.
* *
* \param ctx The RSA context to initialize. This must not be \c NULL. * \param ctx The RSA context to initialize. This must not be \c NULL.
*/ */
@ -169,9 +168,10 @@ void mbedtls_rsa_init( mbedtls_rsa_context *ctx );
* \param ctx The initialized RSA context to be configured. * \param ctx The initialized RSA context to be configured.
* \param padding The padding mode to use. This must be either * \param padding The padding mode to use. This must be either
* #MBEDTLS_RSA_PKCS_V15 or #MBEDTLS_RSA_PKCS_V21. * #MBEDTLS_RSA_PKCS_V15 or #MBEDTLS_RSA_PKCS_V21.
* \param hash_id The #MBEDTLS_RSA_PKCS_V21 hash identifier. * \param hash_id The hash identifier for PSS or OAEP, if \p padding is
* #MBEDTLS_MD_NONE is accepted by this function but may be * #MBEDTLS_RSA_PKCS_V21. #MBEDTLS_MD_NONE is accepted by this
* not suitable for some operations. * function but may be not suitable for some operations.
* Ignored if \p padding is #MBEDTLS_RSA_PKCS_V15.
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return #MBEDTLS_ERR_RSA_INVALID_PADDING failure: * \return #MBEDTLS_ERR_RSA_INVALID_PADDING failure: