Improve documentation of PKCS1 decryption functions

Document the preconditions on the input and output buffers for
the PKCS1 decryption functions
- rsa_pkcs1_decrypt
- rsa_rsaes_pkcs1_v15_decrypt
- rsa_rsaes_oaep_decrypt
This commit is contained in:
Hanno Becker 2017-05-11 16:33:02 +01:00 committed by Simon Butcher
parent e7f5abc111
commit 1af21bfa38
2 changed files with 4 additions and 2 deletions

View file

@ -47,7 +47,7 @@ Bugfix
Changes
* Avoid shadowing of time and index functions through mbed TLS function
arguments. Found by inestlerode. Fixes #557.
* Improve documentation of PKCS1 decryption functions.
= mbed TLS 1.3.20 branch released 2017-06-21

View file

@ -378,6 +378,7 @@ int rsa_pkcs1_decrypt( rsa_context *ctx,
*
* \note The input buffer must be as large as the size
* of ctx->N (eg. 128 bytes if RSA-1024 is used).
*
*/
int rsa_rsaes_pkcs1_v15_decrypt( rsa_context *ctx,
int (*f_rng)(void *, unsigned char *, size_t),
@ -411,8 +412,9 @@ int rsa_rsaes_pkcs1_v15_decrypt( rsa_context *ctx,
* the decryption of the particular ciphertext provided,
* the function will return POLARSSL_ERR_RSA_OUTPUT_TOO_LARGE.
*
* \note The input buffer must be as large as the size
* \note The input buffer must be as large as the size
* of ctx->N (eg. 128 bytes if RSA-1024 is used).
*
*/
int rsa_rsaes_oaep_decrypt( rsa_context *ctx,
int (*f_rng)(void *, unsigned char *, size_t),