From fb1b851797bca8d445f37784a5c33eed4a311a2f Mon Sep 17 00:00:00 2001 From: Dave Rodgman Date: Mon, 31 Jul 2023 12:27:05 +0100 Subject: [PATCH] Improve docs for mbedtls_mpi_core_cond_assign Signed-off-by: Dave Rodgman --- library/bignum_core.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/library/bignum_core.h b/library/bignum_core.h index 64d51b92d1..e5500f117a 100644 --- a/library/bignum_core.h +++ b/library/bignum_core.h @@ -178,7 +178,9 @@ mbedtls_ct_condition_t mbedtls_mpi_core_lt_ct(const mbedtls_mpi_uint *A, * \param[in] A The address of the source MPI. This must be initialized. * \param limbs The number of limbs of \p A. * \param assign The condition deciding whether to perform the - * assignment or not. + * assignment or not. Callers will need to use + * the constant time interface (e.g. `mbedtls_ct_bool()`) + * to construct this argument. * * \note This function avoids leaking any information about whether * the assignment was done or not.