yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-12-23 19:35:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for the RNG-function

Browse source
This commit is contained in:
Jarno Lamsa 2019-10-03 13:36:06 +03:00
parent 436d18dcaa
commit 39a9d40f84
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
include/mbedtls/platform_util.h
View file

@ -219,7 +219,7 @@ void *mbedtls_platform_memcpy( void *dst, const void *src, size_t num );
int mbedtls_platform_memcmp( const void *buf1, const void *buf2, size_t num ); int mbedtls_platform_memcmp( const void *buf1, const void *buf2, size_t num );
/** /**
* \brief A global RNG-function * \brief RNG-function for getting a random in given range.
* *
* This function is meant to provide a global RNG to be used * This function is meant to provide a global RNG to be used
* throughout Mbed TLS for hardening the library. It is used * throughout Mbed TLS for hardening the library. It is used
@ -228,6 +228,12 @@ int mbedtls_platform_memcmp( const void *buf1, const void *buf2, size_t num );
* cryptographically secure RNG, but provide an RNG for utility * cryptographically secure RNG, but provide an RNG for utility
* functions. * functions.
* *
* \note Currently the function is dependent of hardware providing an
* rng with MBEDTLS_ENTROPY_HARDWARE_ALT. By default, 0 is
* returned.
*
* \note If the given range is [0, 0), 0 is returned.
*
* \param num Max-value for the generated random number, exclusive. * \param num Max-value for the generated random number, exclusive.
* The generated number will be on range [0, num). * The generated number will be on range [0, num).
* *