third_party/mbedtls/repo/doxygen/input/doc_rng.h

   1 /**
   2  * \file doc_rng.h
   3  *
   4  * \brief Random number generator (RNG) module documentation file.
   5  */
   6 /*
   7  *
   8  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   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  *  This file is part of mbed TLS (https://tls.mbed.org)
  24  */
  25
  26 /**
  27  * @addtogroup rng_module Random number generator (RNG) module
  28  *
  29  * The Random number generator (RNG) module provides random number
  30  * generation, see \c mbedtls_ctr_drbg_random().
  31  *
  32  * The block-cipher counter-mode based deterministic random
  33  * bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external
  34  * 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.
  36  *
  37  * The other number generator that is included is less strong and uses the
  38  * HAVEGE (HArdware Volatile Entropy Gathering and Expansion) software heuristic
  39  * which considered unsafe for primary usage, but provides additional random
  40  * to the entropy pool if enables.
  41  *
  42  * Meaning that there seems to be no practical algorithm that can guess
  43  * 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  */