xref: /third_party/mbedtls/doxygen/input/doc_rng.h (revision a8e1175b)
1/**
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
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.
22 */
23
24/**
25 * @addtogroup rng_module Random number generator (RNG) module
26 *
27 * The Random number generator (RNG) module provides random number
28 * generation, see \c mbedtls_ctr_drbg_random().
29 *
30 * The block-cipher counter-mode based deterministic random
31 * bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external
32 * source of entropy. For these purposes \c mbedtls_entropy_func() can be used.
33 * This is an implementation based on a simple entropy accumulator design.
34 *
35 * Meaning that there seems to be no practical algorithm that can guess
36 * the next bit with a probability larger than 1/2 in an output sequence.
37 *
38 * This module can be used to generate random numbers.
39 */
40