mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-29 22:20:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve documentation of mbedtls_rsa_import[_raw]

Browse Source
This commit is contained in:
Hanno Becker 2017-10-25 17:04:10 +01:00
parent fc8fbfa059
commit 3319555b7c
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/mbedtls/rsa.h
View File

@ -171,6 +171,10 @@ void mbedtls_rsa_init( mbedtls_rsa_context *ctx,
* and complete the provided information to a ready-for-use * and complete the provided information to a ready-for-use
* public or private RSA key. * public or private RSA key.
* *
* \note See the documentation of \c mbedtls_rsa_complete for more
* information on which parameters are necessary to setup
* a private or public RSA key.
*
* \note The imported parameters are copied and need not be preserved * \note The imported parameters are copied and need not be preserved
* for the lifetime of the RSA context being set up. * for the lifetime of the RSA context being set up.
* *
@ -204,6 +208,10 @@ int mbedtls_rsa_import( mbedtls_rsa_context *ctx,
* and complete the provided information to a ready-for-use * and complete the provided information to a ready-for-use
* public or private RSA key. * public or private RSA key.
* *
* \note See the documentation of \c mbedtls_rsa_complete for more
* information on which parameters are necessary to setup
* a private or public RSA key.
*
* \note The imported parameters are copied and need not be preserved * \note The imported parameters are copied and need not be preserved
* for the lifetime of the RSA context being set up. * for the lifetime of the RSA context being set up.
* *