aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Cosgrove <tom.cosgrove@arm.com>2022-12-14 09:53:45 +0000
committerTom Cosgrove <tom.cosgrove@arm.com>2022-12-15 16:56:36 +0000
commitd692ba4248c565c906cacdebb37840274e9444b4 (patch)
tree1cd1b26ef2ff1424eff1e00cfb1d3bee187cf912
parentdbac60924b5c1cddc586c6f2b578f82b0c439f2f (diff)
downloadmbedtls-d692ba4248c565c906cacdebb37840274e9444b4.zip
mbedtls-d692ba4248c565c906cacdebb37840274e9444b4.tar.gz
mbedtls-d692ba4248c565c906cacdebb37840274e9444b4.tar.bz2
Note that (as usual) for mbedtls_mpi_mod_inv() residues must be associated with the modulus
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
-rw-r--r--library/bignum_mod.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/library/bignum_mod.h b/library/bignum_mod.h
index b2c36a9..a708be6 100644
--- a/library/bignum_mod.h
+++ b/library/bignum_mod.h
@@ -196,6 +196,9 @@ int mbedtls_mpi_mod_sub( mbedtls_mpi_mod_residue *X,
/**
* \brief Perform modular inversion of an MPI with respect to a modulus \p N.
*
+ * \p A and \p X must be associated with the modulus \p N and will therefore
+ * have the same number of limbs as \p N.
+ *
* \p X may be aliased to \p A.
*
* \warning Currently only supports prime moduli, but does not check for them.