mbedtls/doxygen/input/doc_rng.h

/**
 * \file doc_rng.h
 *
 * \brief Random number generator (RNG) module documentation file.
 */
/*
 *
 *  Copyright The Mbed TLS Contributors
 *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
 */

/**
 * @addtogroup rng_module Random number generator (RNG) module
 *
 * The Random number generator (RNG) module provides random number
 * generation, see \c mbedtls_ctr_drbg_random().
 *
 * The block-cipher counter-mode based deterministic random
 * bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external
 * source of entropy. For these purposes \c mbedtls_entropy_func() can be used.
 * This is an implementation based on a simple entropy accumulator design.
 *
 * Meaning that there seems to be no practical algorithm that can guess
 * the next bit with a probability larger than 1/2 in an output sequence.
 *
 * This module can be used to generate random numbers.
 */
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`/**`
doxygen: Remove copyright block from Doxygen comments Remove the copyright block from the Doxygen comments, to clean up the detailed description in the generated Doxygen output. Also, add \file and \brief tags to all headers in doxygen/input. 2018-01-23 15:36:58 +00:00			`* \file doc_rng.h`
			`*`
			`* \brief Random number generator (RNG) module documentation file.`
			`*/`
			`/*`
Make sure all .h files have license information Even if they don't need it: this simplifies future audits. 2015-08-06 08:59:26 +00:00			`*`
Update copyright notices to use Linux Foundation guidance As a result, the copyright of contributors other than Arm is now acknowledged, and the years of publishing are no longer tracked in the source files. Also remove the now-redundant lines declaring that the files are part of MbedTLS. This commit was generated using the following script: # ======================== #!/bin/sh # Find files find '(' -path './.git' -o -path './3rdparty' ')' -prune -o -type f -print \| xargs sed -bi ' # Replace copyright attribution line s/Copyright.Arm./Copyright The Mbed TLS Contributors/I # Remove redundant declaration and the preceding line $!N /This file is part of Mbed TLS/Id P D ' # ======================== Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2020-08-07 11:07:28 +00:00			`* Copyright The Mbed TLS Contributors`
update headers Signed-off-by: Dave Rodgman <dave.rodgman@arm.com> 2023-11-02 19:47:20 +00:00			`* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`*/`

			`/**`
			`* @addtogroup rng_module Random number generator (RNG) module`
Updated doxygen documentation in header files and HTML pages 2013-09-10 14:16:50 +00:00			`*`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`* The Random number generator (RNG) module provides random number`
Corrected naming and text in doxygen rng module Doxygen input file had incorrect function name for rng function mbedtls_ctr_drbg_random(), and formatting was fixed. 2016-01-04 16:09:23 +00:00			`* generation, see \c mbedtls_ctr_drbg_random().`
- Added a generic entropy accumulator that provides support for adding custom entropy sources and added some generic and platform dependent entropy sources 2011-12-03 21:45:14 +00:00			`*`
Updated doxygen documentation in header files and HTML pages 2013-09-10 14:16:50 +00:00			`* The block-cipher counter-mode based deterministic random`
- Added a generic entropy accumulator that provides support for adding custom entropy sources and added some generic and platform dependent entropy sources 2011-12-03 21:45:14 +00:00			`* bit generator (CTR_DBRG) as specified in NIST SP800-90. It needs an external`
Corrected naming and text in doxygen rng module Doxygen input file had incorrect function name for rng function mbedtls_ctr_drbg_random(), and formatting was fixed. 2016-01-04 16:09:23 +00:00			`* source of entropy. For these purposes \c mbedtls_entropy_func() can be used.`
			`* This is an implementation based on a simple entropy accumulator design.`
- Added a generic entropy accumulator that provides support for adding custom entropy sources and added some generic and platform dependent entropy sources 2011-12-03 21:45:14 +00:00			`*`
Corrected naming and text in doxygen rng module Doxygen input file had incorrect function name for rng function mbedtls_ctr_drbg_random(), and formatting was fixed. 2016-01-04 16:09:23 +00:00			`* Meaning that there seems to be no practical algorithm that can guess`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`* the next bit with a probability larger than 1/2 in an output sequence.`
			`*`
			`* This module can be used to generate random numbers.`
			`*/`