Update documentation about optional f_rng parameter

Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
Manuel Pégourié-Gonnard 2020-06-04 10:20:12 +02:00
parent 75036a0aff
commit 966cb796c4

View File

@ -518,10 +518,13 @@ int mbedtls_ecp_tls_write_group( const mbedtls_ecp_group *grp, size_t *olen,
* operations for any valid m. It avoids any if-branch or * operations for any valid m. It avoids any if-branch or
* array index depending on the value of m. * array index depending on the value of m.
* *
* \note If f_rng is not NULL, it is used to randomize intermediate * \note If \p f_rng is not NULL, it is used to randomize
* results in order to prevent potential timing attacks * intermediate results to prevent potential timing attacks
* targeting these results. It is recommended to always * targeting these results. We recommend always providing
* provide a non-NULL f_rng (the overhead is negligible). * a non-NULL \p f_rng. The overhead is negligible.
* Note: unless #MBEDTLS_ECP_NO_INTERNAL_RNG is defined, when
* \p f_rng is NULL, an internal RNG (seeded from the value
* of \p m) will be used instead.
* *
* \param grp ECP group * \param grp ECP group
* \param R Destination point * \param R Destination point