yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-10-18 21:21:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation in mbedtls_rsa_check_privkey

Browse source
This commit is contained in:
Hanno Becker 2017-10-17 10:13:31 +01:00
parent f8c028a2fb
commit 68767a6e88
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
include/mbedtls/rsa.h
View file

@ -416,13 +416,11 @@ int mbedtls_rsa_check_pubkey( const mbedtls_rsa_context *ctx );
*
* \return 0 if successful, or an \c MBEDTLS_ERR_RSA_XXX error code.
*
* \note This function performs checks substantiating
* the consistency of the key material used to setup
* the RSA context. In case of implementations saving
* all core RSA parameters, this might mean a consistency
* check in the sense of \c mbedtls_rsa_validate_params,
* while other implementations might perform an empirical
* check consisting of an encryption-decryption pair.
* \note The consistency checks performed by this function not only
* ensure that \c mbedtls_rsa_private can be called successfully
* on the given context, but that the various parameters are
* mutually consistent with high probability, in the sense that
* \c mbedtls_rsa_public and \c mbedtls_rsa_private are inverses.
*
* \warning This function should catch accidental misconfigurations
* like swapping of parameters, but it cannot establish full