mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2024-12-29 09:21:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Corrected naming and text in doxygen rng module

Browse Source 
Doxygen input file had incorrect function name for rng function
mbedtls_ctr_drbg_random(), and formatting was fixed.
This commit is contained in:
Simon Butcher 2016-01-04 16:09:23 +00:00
parent 76da60c56e
commit 6e7d3d5462
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doxygen/input/doc_rng.h
View File

@ -24,19 +24,19 @@
* @addtogroup rng_module Random number generator (RNG) module
*
* The Random number generator (RNG) module provides random number
* generation, see \c ctr_dbrg_random().
* generation, see \c mbedtls_ctr_drbg_random().
*
* The block-cipher counter-mode based deterministic random
* bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external
* source of entropy. For these purposes \c mbedtls_entropy_func() can be used. This is
* an implementation based on a simple entropy accumulator design.
* source of entropy. For these purposes \c mbedtls_entropy_func() can be used.
* This is an implementation based on a simple entropy accumulator design.
*
* The other number generator that is included is less strong and uses the HAVEGE
* (HArdware Volatile Entropy Gathering and Expansion) software heuristic
* The other number generator that is included is less strong and uses the
* HAVEGE (HArdware Volatile Entropy Gathering and Expansion) software heuristic
* which considered unsafe for primary usage, but provides additional random
* to the entropy pool if enables.
*
* \* Meaning that there seems to be no practical algorithm that can guess
* Meaning that there seems to be no practical algorithm that can guess
* the next bit with a probability larger than 1/2 in an output sequence.
*
* This module can be used to generate random numbers.