blob: 0f212e040c8110f1639a1378c2feed3c4f53bea4 [file] [log] [blame]
Paul Bakker37ca75d2011-01-06 12:28:03 +00001/**
Jaeden Amero25facdd2018-01-23 15:36:58 +00002 * \file doc_rng.h
3 *
4 * \brief Random number generator (RNG) module documentation file.
5 */
6/*
Manuel Pégourié-Gonnard8119dad2015-08-06 10:59:26 +02007 *
8 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02009 * SPDX-License-Identifier: Apache-2.0
10 *
11 * Licensed under the Apache License, Version 2.0 (the "License"); you may
12 * not use this file except in compliance with the License.
13 * You may obtain a copy of the License at
14 *
15 * http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing, software
18 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
19 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 * See the License for the specific language governing permissions and
21 * limitations under the License.
Manuel Pégourié-Gonnard8119dad2015-08-06 10:59:26 +020022 *
23 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker37ca75d2011-01-06 12:28:03 +000024 */
25
26/**
27 * @addtogroup rng_module Random number generator (RNG) module
Paul Bakker6083fd22011-12-03 21:45:14 +000028 *
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020029 * The Random number generator (RNG) module provides random number
Simon Butcher6e7d3d52016-01-04 16:09:23 +000030 * generation, see \c mbedtls_ctr_drbg_random().
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020031 *
32 * The block-cipher counter-mode based deterministic random
Paul Bakker6083fd22011-12-03 21:45:14 +000033 * bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external
Simon Butcher6e7d3d52016-01-04 16:09:23 +000034 * source of entropy. For these purposes \c mbedtls_entropy_func() can be used.
35 * This is an implementation based on a simple entropy accumulator design.
Paul Bakker6083fd22011-12-03 21:45:14 +000036 *
Simon Butcher6e7d3d52016-01-04 16:09:23 +000037 * The other number generator that is included is less strong and uses the
38 * HAVEGE (HArdware Volatile Entropy Gathering and Expansion) software heuristic
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020039 * which considered unsafe for primary usage, but provides additional random
40 * to the entropy pool if enables.
Paul Bakker37ca75d2011-01-06 12:28:03 +000041 *
Simon Butcher6e7d3d52016-01-04 16:09:23 +000042 * Meaning that there seems to be no practical algorithm that can guess
Paul Bakker37ca75d2011-01-06 12:28:03 +000043 * the next bit with a probability larger than 1/2 in an output sequence.
44 *
45 * This module can be used to generate random numbers.
46 */