| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1 | /** |
| Jaeden Amero | 25facdd | 2018-01-23 15:36:58 +0000 | [diff] [blame] | 2 | * \file doc_rng.h |
| 3 | * |
| 4 | * \brief Random number generator (RNG) module documentation file. |
| 5 | */ |
| 6 | /* |
| Manuel Pégourié-Gonnard | 8119dad | 2015-08-06 10:59:26 +0200 | [diff] [blame] | 7 | * |
| Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 8 | * Copyright The Mbed TLS Contributors |
| Dave Rodgman | 7ff7965 | 2023-11-03 12:04:52 +0000 | [diff] [blame] | 9 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * @addtogroup rng_module Random number generator (RNG) module |
| Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 14 | * |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 15 | * The Random number generator (RNG) module provides random number |
| Simon Butcher | 6e7d3d5 | 2016-01-04 16:09:23 +0000 | [diff] [blame] | 16 | * generation, see \c mbedtls_ctr_drbg_random(). |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 17 | * |
| 18 | * The block-cipher counter-mode based deterministic random |
| Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 19 | * bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external |
| Simon Butcher | 6e7d3d5 | 2016-01-04 16:09:23 +0000 | [diff] [blame] | 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. |
| Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 22 | * |
| Simon Butcher | 6e7d3d5 | 2016-01-04 16:09:23 +0000 | [diff] [blame] | 23 | * The other number generator that is included is less strong and uses the |
| 24 | * HAVEGE (HArdware Volatile Entropy Gathering and Expansion) software heuristic |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 25 | * which considered unsafe for primary usage, but provides additional random |
| 26 | * to the entropy pool if enables. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 27 | * |
| Simon Butcher | 6e7d3d5 | 2016-01-04 16:09:23 +0000 | [diff] [blame] | 28 | * Meaning that there seems to be no practical algorithm that can guess |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 29 | * the next bit with a probability larger than 1/2 in an output sequence. |
| 30 | * |
| 31 | * This module can be used to generate random numbers. |
| 32 | */ |