blob: 22608a879babdcd50ce93b9a4f95e334cc5f46a9 [file] [log] [blame]
Tom Rini0344c602024-10-08 13:56:50 -06001/**
2 * \file doc_rng.h
3 *
4 * \brief Random number generator (RNG) module documentation file.
5 */
6/*
7 *
8 * Copyright The Mbed TLS Contributors
9 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
10 */
11
12/**
13 * @addtogroup rng_module Random number generator (RNG) module
14 *
15 * The Random number generator (RNG) module provides random number
16 * generation, see \c mbedtls_ctr_drbg_random().
17 *
18 * The block-cipher counter-mode based deterministic random
19 * bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external
20 * source of entropy. For these purposes \c mbedtls_entropy_func() can be used.
21 * This is an implementation based on a simple entropy accumulator design.
22 *
23 * Meaning that there seems to be no practical algorithm that can guess
24 * the next bit with a probability larger than 1/2 in an output sequence.
25 *
26 * This module can be used to generate random numbers.
27 */