| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1 | /** |
| 2 | * @file |
| 3 | * Random number generator (RNG) module documentation file. |
| Manuel Pégourié-Gonnard | 8119dad | 2015-08-06 10:59:26 +0200 | [diff] [blame^] | 4 | * |
| 5 | * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved |
| 6 | * |
| 7 | * This file is part of mbed TLS (https://tls.mbed.org) |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU General Public License as published by |
| 11 | * the Free Software Foundation; either version 2 of the License, or |
| 12 | * (at your option) any later version. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU General Public License along |
| 20 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 22 | */ |
| 23 | |
| 24 | /** |
| 25 | * @addtogroup rng_module Random number generator (RNG) module |
| Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 26 | * |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 27 | * The Random number generator (RNG) module provides random number |
| 28 | * generation, see \c ctr_dbrg_random(). |
| 29 | * |
| 30 | * The block-cipher counter-mode based deterministic random |
| Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 31 | * bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external |
| Manuel Pégourié-Gonnard | 151dc77 | 2015-05-14 13:55:51 +0200 | [diff] [blame] | 32 | * source of entropy. For these purposes \c mbedtls_entropy_func() can be used. This is |
| Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 33 | * an implementation based on a simple entropy accumulator design. |
| 34 | * |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 35 | * The other number generator that is included is less strong and uses the HAVEGE |
| 36 | * (HArdware Volatile Entropy Gathering and Expansion) software heuristic |
| 37 | * which considered unsafe for primary usage, but provides additional random |
| 38 | * to the entropy pool if enables. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 39 | * |
| 40 | * \* Meaning that there seems to be no practical algorithm that can guess |
| 41 | * the next bit with a probability larger than 1/2 in an output sequence. |
| 42 | * |
| 43 | * This module can be used to generate random numbers. |
| 44 | */ |