Specify modulus constraints

Signed-off-by: Werner Lewis <werner.lewis@arm.com>
This commit is contained in:
Werner Lewis 2022-12-14 13:45:49 +00:00
parent 5e9d2e9019
commit e1eb75dc99
2 changed files with 8 additions and 6 deletions

@ -7,9 +7,10 @@
* explicitly indicated otherwise: * explicitly indicated otherwise:
* *
* - **Modulus parameters**: the modulus is passed as a pointer to a structure * - **Modulus parameters**: the modulus is passed as a pointer to a structure
* of type #mbedtls_mpi_mod_modulus. The structure must be setup with an * of type #mbedtls_mpi_mod_modulus. The structure must be set up with an
* array of limbs storing the bignum value of the modulus. Unless otherwise * array of limbs storing the bignum value of the modulus. The modulus must
* specified, the modulus is called \p N and is input-only. * be odd and is assumed to have no leading zeroes. The modulus is usually
* named \p N and is usually input-only.
* - **Bignum parameters**: Bignums are passed as pointers to an array of * - **Bignum parameters**: Bignums are passed as pointers to an array of
* limbs or to a #mbedtls_mpi_mod_residue structure. A limb has the type * limbs or to a #mbedtls_mpi_mod_residue structure. A limb has the type
* #mbedtls_mpi_uint. Residues must be initialized before use, and must be * #mbedtls_mpi_uint. Residues must be initialized before use, and must be

@ -15,9 +15,10 @@
* The functions in this module obey the following conventions unless * The functions in this module obey the following conventions unless
* explicitly indicated otherwise: * explicitly indicated otherwise:
* - **Modulus parameters**: the modulus is passed as a pointer to a structure * - **Modulus parameters**: the modulus is passed as a pointer to a structure
* of type #mbedtls_mpi_mod_modulus. The structure must be setup with an * of type #mbedtls_mpi_mod_modulus. The structure must be set up with an
* array of limbs storing the bignum value of the modulus. Unless otherwise * array of limbs storing the bignum value of the modulus. The modulus must
* specified, the modulus is called \p N and is input-only. * be odd and is assumed to have no leading zeroes. The modulus is usually
* named \p N and is usually input-only.
* - **Bignum parameters**: Bignums are passed as pointers to an array of * - **Bignum parameters**: Bignums are passed as pointers to an array of
* limbs. A limb has the type #mbedtls_mpi_uint. Unless otherwise specified: * limbs. A limb has the type #mbedtls_mpi_uint. Unless otherwise specified:
* - Bignum parameters called \p A, \p B, ... are inputs, and are not * - Bignum parameters called \p A, \p B, ... are inputs, and are not