mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2025-02-24 07:46:53 +00:00
CTR_DRBG: more consistent formatting and wording
In particular, don't use #MBEDTLS_xxx on macros that are undefined in some configurations, since this would be typeset with a literal '#'.
This commit is contained in:
parent
2884ba3720
commit
d0c64c856d
|
@ -12,26 +12,26 @@
|
||||||
* The Mbed TLS implementation of CTR_DRBG uses AES-256 (default) or AES-128
|
* The Mbed TLS implementation of CTR_DRBG uses AES-256 (default) or AES-128
|
||||||
* as the underlying block cipher, with a derivation function. The security
|
* as the underlying block cipher, with a derivation function. The security
|
||||||
* strength is:
|
* strength is:
|
||||||
|
* (if \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled at compile time)
|
||||||
* - 256 bits under the default configuration of the library, with AES-256
|
* - 256 bits under the default configuration of the library, with AES-256
|
||||||
* (`MBEDTLS_CTR_DRBG_USE_128_BIT_KEY` not set) and
|
* and with #MBEDTLS_CTR_DRBG_ENTROPY_LEN set to 48 or more.
|
||||||
* with #MBEDTLS_CTR_DRBG_ENTROPY_LEN set to 48 or more.
|
|
||||||
* - 256 bits if AES-256 is used, #MBEDTLS_CTR_DRBG_ENTROPY_LEN is set
|
* - 256 bits if AES-256 is used, #MBEDTLS_CTR_DRBG_ENTROPY_LEN is set
|
||||||
* to 32 or more, and the DRBG is initialized with an explicit
|
* to 32 or more, and the DRBG is initialized with an explicit
|
||||||
* nonce in the \c custom parameter to mbedtls_ctr_drbg_seed().
|
* nonce in the \c custom parameter to mbedtls_ctr_drbg_seed().
|
||||||
* - 128 bits if AES-256 is used but #MBEDTLS_CTR_DRBG_ENTROPY_LEN is
|
* - 128 bits if AES-256 is used but #MBEDTLS_CTR_DRBG_ENTROPY_LEN is
|
||||||
* between 24 and 47 and the DRBG is not initialized with an explicit
|
* between 24 and 47 and the DRBG is not initialized with an explicit
|
||||||
* nonce (see mbedtls_ctr_drbg_seed()).
|
* nonce (see mbedtls_ctr_drbg_seed()).
|
||||||
* - 128 bits if AES-128 is used (`MBEDTLS_CTR_DRBG_USE_128_BIT_KEY` set)
|
* - 128 bits if AES-128 is used (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY enabled)
|
||||||
* and #MBEDTLS_CTR_DRBG_ENTROPY_LEN is set to 24 or more (which is
|
* and #MBEDTLS_CTR_DRBG_ENTROPY_LEN is set to 24 or more (which is
|
||||||
* always the case unless it is explicitly set to a different value
|
* always the case unless it is explicitly set to a different value
|
||||||
* in `config.h`).
|
* in config.h).
|
||||||
*
|
*
|
||||||
* Note that the value of #MBEDTLS_CTR_DRBG_ENTROPY_LEN defaults to:
|
* Note that the value of #MBEDTLS_CTR_DRBG_ENTROPY_LEN defaults to:
|
||||||
* - \c 48 if the module #MBEDTLS_SHA512_C is enabled and the symbol
|
* - \c 48 if the module \c MBEDTLS_SHA512_C is enabled and the symbol
|
||||||
* #MBEDTLS_ENTROPY_FORCE_SHA256 is not enabled at compile time.
|
* \c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled at compile time.
|
||||||
* This is the default configuration of the library.
|
* This is the default configuration of the library.
|
||||||
* - \c 32 if the module #MBEDTLS_SHA512_C is disabled at compile time.
|
* - \c 32 if the module \c MBEDTLS_SHA512_C is disabled at compile time.
|
||||||
* - \c 32 if #MBEDTLS_ENTROPY_FORCE_SHA256 is enabled at compile time.
|
* - \c 32 if \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled at compile time.
|
||||||
*/
|
*/
|
||||||
/*
|
/*
|
||||||
* Copyright (C) 2006-2019, Arm Limited (or its affiliates), All Rights Reserved
|
* Copyright (C) 2006-2019, Arm Limited (or its affiliates), All Rights Reserved
|
||||||
|
@ -79,14 +79,14 @@
|
||||||
/**< The key size in bytes used by the cipher.
|
/**< The key size in bytes used by the cipher.
|
||||||
*
|
*
|
||||||
* Compile-time choice: 16 bytes (128 bits)
|
* Compile-time choice: 16 bytes (128 bits)
|
||||||
* because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is set.
|
* because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled.
|
||||||
*/
|
*/
|
||||||
#else
|
#else
|
||||||
#define MBEDTLS_CTR_DRBG_KEYSIZE 32
|
#define MBEDTLS_CTR_DRBG_KEYSIZE 32
|
||||||
/**< The key size in bytes used by the cipher.
|
/**< The key size in bytes used by the cipher.
|
||||||
*
|
*
|
||||||
* Compile-time choice: 32 bytes (256 bits)
|
* Compile-time choice: 32 bytes (256 bits)
|
||||||
* because `MBEDTLS_CTR_DRBG_USE_128_BIT_KEY` is not set.
|
* because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled.
|
||||||
*/
|
*/
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
@ -107,7 +107,7 @@
|
||||||
/** The amount of entropy used per seed by default.
|
/** The amount of entropy used per seed by default.
|
||||||
*
|
*
|
||||||
* This is 48 bytes because the entropy module uses SHA-512
|
* This is 48 bytes because the entropy module uses SHA-512
|
||||||
* #MBEDTLS_ENTROPY_FORCE_SHA256 is not set).
|
* (\c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled).
|
||||||
*
|
*
|
||||||
* \note See mbedtls_ctr_drbg_set_entropy_len() regarding what values are
|
* \note See mbedtls_ctr_drbg_set_entropy_len() regarding what values are
|
||||||
* acceptable.
|
* acceptable.
|
||||||
|
@ -117,7 +117,7 @@
|
||||||
/** The amount of entropy used per seed by default.
|
/** The amount of entropy used per seed by default.
|
||||||
*
|
*
|
||||||
* This is 32 bytes because the entropy module uses SHA-256
|
* This is 32 bytes because the entropy module uses SHA-256
|
||||||
* (the SHA512 module is disabled or #MBEDTLS_ENTROPY_FORCE_SHA256 is set).
|
* (the SHA512 module is disabled or #MBEDTLS_ENTROPY_FORCE_SHA256 is enabled).
|
||||||
*
|
*
|
||||||
* \note See mbedtls_ctr_drbg_set_entropy_len() regarding what values are
|
* \note See mbedtls_ctr_drbg_set_entropy_len() regarding what values are
|
||||||
* acceptable.
|
* acceptable.
|
||||||
|
|
Loading…
Reference in a new issue