yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-26 19:45:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

Increase readability of Doxygen output

Browse Source 
Multiple lists were not properly recognized as such.
This commit is contained in:
Hanno Becker 2017-09-29 13:34:25 +01:00
parent 91c194dabb
commit ed20361321
1 changed files with 52 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
include/mbedtls/rsa.h
View File

@ -94,7 +94,8 @@ extern "C" {
* \param P Pointer to MPI holding first prime factor of N on success * \param P Pointer to MPI holding first prime factor of N on success
* \param Q Pointer to MPI holding second prime factor of N on success * \param Q Pointer to MPI holding second prime factor of N on success
* *
* \return - 0 if successful. In this case, P and Q constitute a * \return
* - 0 if successful. In this case, P and Q constitute a
* factorization of N, and it is guaranteed that D and E * factorization of N, and it is guaranteed that D and E
* are indeed modular inverses modulo P-1 and modulo Q-1. * are indeed modular inverses modulo P-1 and modulo Q-1.
* The values of N, D and E are unchanged. It is checked * The values of N, D and E are unchanged. It is checked
@ -128,7 +129,8 @@ int mbedtls_rsa_deduce_moduli( mbedtls_mpi *N, mbedtls_mpi *D, mbedtls_mpi *E,
* *
* \note This function does not check whether P and Q are primes. * \note This function does not check whether P and Q are primes.
* *
* \return - 0 if successful. In this case, D is set to a simultaneous * \return
* - 0 if successful. In this case, D is set to a simultaneous
* modular inverse of E modulo both P-1 and Q-1. * modular inverse of E modulo both P-1 and Q-1.
* - A non-zero error code otherwise. In this case, the values * - A non-zero error code otherwise. In this case, the values
* of P, Q, E are undefined. * of P, Q, E are undefined.
@ -181,12 +183,13 @@ int mbedtls_rsa_deduce_crt( const mbedtls_mpi *P, const mbedtls_mpi *Q,
* \param f_rng PRNG to be used for randomization, or NULL * \param f_rng PRNG to be used for randomization, or NULL
* \param p_rng PRNG context for f_rng, or NULL * \param p_rng PRNG context for f_rng, or NULL
* *
* \return - 0 if the following conditions are satisfied: * \return
* - N = PQ if N,P,Q != NULL * - 0 if the following conditions are satisfied:
* - D and E are modular inverses modulo P-1 and Q-1 * - N = PQ if N,P,Q != NULL
* if D,E,P,Q != NULL * - D and E are modular inverses modulo P-1 and Q-1
* - P prime if f_rng, P != NULL * if D,E,P,Q != NULL
* - Q prime if f_rng, Q != NULL * - P prime if f_rng, P != NULL
* - Q prime if f_rng, Q != NULL
* - A non-zero error code otherwise. * - A non-zero error code otherwise.
* *
* \note The function can be used with a restricted set of arguments * \note The function can be used with a restricted set of arguments
@ -213,12 +216,13 @@ int mbedtls_rsa_validate_params( const mbedtls_mpi *N, const mbedtls_mpi *P,
* \param DQ MPI to check for D modulo P-1 * \param DQ MPI to check for D modulo P-1
* \param QP MPI to check for the modular inverse of Q modulo P. * \param QP MPI to check for the modular inverse of Q modulo P.
* *
* \return - 0 if the following conditions are satisfied: * \return
* - D = DP mod P-1 if P, D, DP != NULL * - 0 if the following conditions are satisfied:
* - Q = DQ mod P-1 if P, D, DQ != NULL * - D = DP mod P-1 if P, D, DP != NULL
* - QP = Q^-1 mod P if P, Q, QP != NULL * - Q = DQ mod P-1 if P, D, DQ != NULL
* - MBEDTLS_ERR_RSA_KEY_CHECK_FAILED if check failed, * - QP = Q^-1 mod P if P, Q, QP != NULL
* potentially including MBEDTLS_ERR_MPI_XXX if some * - \c MBEDTLS_ERR_RSA_KEY_CHECK_FAILED if check failed,
* potentially including \c MBEDTLS_ERR_MPI_XXX if some
* MPI calculations failed. * MPI calculations failed.
* - MBEDTLS_ERR_RSA_BAD_INPUT_DATA if insufficient * - MBEDTLS_ERR_RSA_BAD_INPUT_DATA if insufficient
* data was provided to check DP, DQ or QP. * data was provided to check DP, DQ or QP.
@ -386,18 +390,19 @@ int mbedtls_rsa_import_raw( mbedtls_rsa_context *ctx,
* \param f_rng RNG function, * \param f_rng RNG function,
* \param p_rng RNG parameter * \param p_rng RNG parameter
* *
* To setup an RSA public key, precisely N and E * \note
* must have been imported. * - To setup an RSA public key, precisely N and E
* must have been imported.
* *
* To setup an RSA private key, enough information must be * - To setup an RSA private key, enough information must be
* present for the other parameters to be efficiently derivable. * present for the other parameters to be efficiently derivable.
* *
* The default implementation supports the following: * The default implementation supports the following:
* (a) Derive P, Q from N, D, E * - Derive P, Q from N, D, E
* (b) Derive N, D from P, Q, E. * - Derive N, D from P, Q, E.
* *
* Alternative implementations need not support these * - Alternative implementations need not support these
* and may return MBEDTLS_ERR_RSA_BAD_INPUT_DATA instead. * and may return \c MBEDTLS_ERR_RSA_BAD_INPUT_DATA instead.
* *
* \note The PRNG is used for probabilistic algorithms * \note The PRNG is used for probabilistic algorithms
* like the derivation of P, Q from N, D, E, as * like the derivation of P, Q from N, D, E, as
@ -446,15 +451,19 @@ int mbedtls_rsa_check_crt( const mbedtls_rsa_context *ctx,
* \param D MPI to hold the private exponent, or NULL * \param D MPI to hold the private exponent, or NULL
* \param E MPI to hold the public exponent, or NULL * \param E MPI to hold the public exponent, or NULL
* *
* \return 0 if successful, non-zero error code otherwise. * \return
* In particular, if exporting the requested parameters * - 0 if successful. In this case, the non-NULL buffers
* cannot be done because of a lack of functionality * pointed to by N, P, Q, D, E are fully written, with
* or because of security policies, the error code * additional unused space filled leading by 0-bytes.
* MBEDTLS_ERR_RSA_EXPORT_UNSUPPORTED is returned. * - Non-zero return code otherwise. In particular, if
* In this case, the RSA context stays intact and can * exporting the requested parameters
* be continued to be used. * cannot be done because of a lack of functionality
* or because of security policies, the error code
* \c MBEDTLS_ERR_RSA_EXPORT_UNSUPPORTED is returned.
* In this case, the RSA context stays intact and can
* be continued to be used.
* *
* \note Two reasons for returning MBEDTLS_ERR_RSA_EXPORT_UNSUPPORTED * \note Reasons for returning \c MBEDTLS_ERR_RSA_EXPORT_UNSUPPORTED
* would be the following: Firstly, it might be that an * would be the following: Firstly, it might be that an
* alternative RSA implementation is in use which stores * alternative RSA implementation is in use which stores
* the key externally, and which either cannot or should not * the key externally, and which either cannot or should not
@ -487,19 +496,19 @@ int mbedtls_rsa_export( const mbedtls_rsa_context *ctx,
* \note The length fields are ignored if the corresponding * \note The length fields are ignored if the corresponding
* buffer pointers are NULL. * buffer pointers are NULL.
* *
* \return 0 if successful. In this case, the non-NULL buffers * \return
* pointed to by N, P, Q, D, E are fully written, with * - 0 if successful. In this case, the non-NULL buffers
* additional unused space filled leading by 0-bytes. * pointed to by N, P, Q, D, E are fully written, with
* additional unused space filled leading by 0-bytes.
* - Non-zero return code otherwise. In particular, if
* exporting the requested parameters
* cannot be done because of a lack of functionality
* or because of security policies, the error code
* \c MBEDTLS_ERR_RSA_EXPORT_UNSUPPORTED is returned.
* In this case, the RSA context stays intact and can
* be continued to be used.
* *
* \return 0 if successful, non-zero error code otherwise. * \note Reasons for returning \c MBEDTLS_ERR_RSA_EXPORT_UNSUPPORTED
* In particular, if exporting the requested parameters
* cannot be done because of a lack of functionality
* or because of security policies, the error code
* MBEDTLS_ERR_RSA_EXPORT_UNSUPPORTED is returned.
* In this case, the RSA context stays intact and can
* be continued to be used.
*
* \note Two reasons for returning MBEDTLS_ERR_RSA_EXPORT_UNSUPPORTED
* would be the following: Firstly, it might be that an * would be the following: Firstly, it might be that an
* alternative RSA implementation is in use which stores * alternative RSA implementation is in use which stores
* the key externally, and which either cannot or should not * the key externally, and which either cannot or should not