diff options
Diffstat (limited to 'doxygen/input/doc_rng.h')
-rw-r--r-- | doxygen/input/doc_rng.h | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doxygen/input/doc_rng.h b/doxygen/input/doc_rng.h new file mode 100644 index 00000000000..22608a879ba --- /dev/null +++ b/doxygen/input/doc_rng.h @@ -0,0 +1,27 @@ +/** + * \file doc_rng.h + * + * \brief Random number generator (RNG) module documentation file. + */ +/* + * + * Copyright The Mbed TLS Contributors + * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later + */ + +/** + * @addtogroup rng_module Random number generator (RNG) module + * + * The Random number generator (RNG) module provides random number + * 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. + * + * 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. + */ |