Improve documentation in mbedtls_rsa_check_privkey
This commit is contained in:
parent
f8c028a2fb
commit
68767a6e88
1 changed files with 5 additions and 7 deletions
|
@ -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.
|
* \return 0 if successful, or an \c MBEDTLS_ERR_RSA_XXX error code.
|
||||||
*
|
*
|
||||||
* \note This function performs checks substantiating
|
* \note The consistency checks performed by this function not only
|
||||||
* the consistency of the key material used to setup
|
* ensure that \c mbedtls_rsa_private can be called successfully
|
||||||
* the RSA context. In case of implementations saving
|
* on the given context, but that the various parameters are
|
||||||
* all core RSA parameters, this might mean a consistency
|
* mutually consistent with high probability, in the sense that
|
||||||
* check in the sense of \c mbedtls_rsa_validate_params,
|
* \c mbedtls_rsa_public and \c mbedtls_rsa_private are inverses.
|
||||||
* while other implementations might perform an empirical
|
|
||||||
* check consisting of an encryption-decryption pair.
|
|
||||||
*
|
*
|
||||||
* \warning This function should catch accidental misconfigurations
|
* \warning This function should catch accidental misconfigurations
|
||||||
* like swapping of parameters, but it cannot establish full
|
* like swapping of parameters, but it cannot establish full
|
||||||
|
|
Loading…
Reference in a new issue