lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-30 22:43:08 +03:00
Code Activity

Bignum Mod: improve documentation and style

Browse Source 
Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath
2022-11-28 14:32:33 +00:00
parent 84bee4c492
commit 1f8afa22a4
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
library/bignum_mod.c
View File

@ -203,7 +203,6 @@ int mbedtls_mpi_mod_read( mbedtls_mpi_mod_residue *r,
{ {
int ret = MBEDTLS_ERR_MPI_BAD_INPUT_DATA; int ret = MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
/* Do our best to check if r and m have been set up */ /* Do our best to check if r and m have been set up */
if( r->limbs == 0 || m->limbs == 0 ) if( r->limbs == 0 || m->limbs == 0 )
goto cleanup; goto cleanup;

19
library/bignum_mod.h
View File

@ -189,10 +189,10 @@ void mbedtls_mpi_mod_modulus_free( mbedtls_mpi_mod_modulus *m );
* equivalent to \p m (in the sense that all their fields or memory pointed by * equivalent to \p m (in the sense that all their fields or memory pointed by
* their fields hold the same value). * their fields hold the same value).
* *
* \param r The address of the residue. It must have exactly the same * \param[out] r The address of the residue. It must have exactly the same
* number of limbs as the modulus \p m. * number of limbs as the modulus \p m.
* \param m The address of the modulus. * \param[in] m The address of the modulus.
* \param buf The input buffer to import from. * \param[in] buf The input buffer to import from.
* \param buflen The length in bytes of \p buf. * \param buflen The length in bytes of \p buf.
* \param ext_rep The endianness of the number in the input buffer. * \param ext_rep The endianness of the number in the input buffer.
* *
@ -221,10 +221,12 @@ int mbedtls_mpi_mod_read( mbedtls_mpi_mod_residue *r,
* secret, the caller must ensure that \p buflen is at least * secret, the caller must ensure that \p buflen is at least
* (`m->bits`+7)/8. * (`m->bits`+7)/8.
* *
* \param r The address of the residue. It must have as many limbs as * \param[in] r The address of the residue. It must have the same number of
* the modulus \p m. * limbs as the modulus \p m. (\p r is an input parameter, but
* \param m The address of the modulus associated with \r. * its value will be modified during execution and restored
* \param buf The output buffer to export to. * before the function returns.)
* \param[in] m The address of the modulus associated with \r.
* \param[out] buf The output buffer to export to.
* \param buflen The length in bytes of \p buf. * \param buflen The length in bytes of \p buf.
* \param ext_rep The endianness in which the number should be written into * \param ext_rep The endianness in which the number should be written into
* the output buffer. * the output buffer.
@ -234,6 +236,9 @@ int mbedtls_mpi_mod_read( mbedtls_mpi_mod_residue *r,
* large enough to hold the value of \p r (without leading * large enough to hold the value of \p r (without leading
* zeroes). * zeroes).
* \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p ext_rep is invalid. * \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p ext_rep is invalid.
* \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if couldn't allocate enough
* memory for conversion. Can occur only for moduli with
* MBEDTLS_MPI_MOD_REP_MONTGOMERY.
*/ */
int mbedtls_mpi_mod_write( const mbedtls_mpi_mod_residue *r, int mbedtls_mpi_mod_write( const mbedtls_mpi_mod_residue *r,
const mbedtls_mpi_mod_modulus *m, const mbedtls_mpi_mod_modulus *m,