Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 1 | /** |
| 2 | * \file ctr_drbg.h |
| 3 | * |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 4 | * \brief This file contains definitions and functions for the |
| 5 | * CTR_DRBG pseudorandom generator. |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 6 | * |
Rose Zadik | f25eb6e | 2018-04-16 14:51:52 +0100 | [diff] [blame] | 7 | * CTR_DRBG is a standardized way of building a PRNG from a block-cipher |
| 8 | * in counter mode operation, as defined in <em>NIST SP 800-90A: |
| 9 | * Recommendation for Random Number Generation Using Deterministic Random |
| 10 | * Bit Generators</em>. |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 11 | * |
Nir Sonnenschein | eb73f7a | 2018-07-30 17:46:49 +0300 | [diff] [blame] | 12 | * The Mbed TLS implementation of CTR_DRBG uses AES-256 (default) or AES-128 |
Gilles Peskine | d0c64c8 | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 13 | * (if \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled at compile time) |
Gilles Peskine | dddda81 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 14 | * as the underlying block cipher, with a derivation function. |
Gilles Peskine | dddda81 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 15 | * |
Gilles Peskine | e9a3454 | 2019-10-22 20:43:24 +0200 | [diff] [blame] | 16 | * The security strength as defined in NIST SP 800-90A is |
| 17 | * 128 bits when AES-128 is used (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY enabled) |
| 18 | * and 256 bits otherwise, provided that #MBEDTLS_CTR_DRBG_ENTROPY_LEN is |
Bence Szépkúti | bb0cfeb | 2021-05-28 09:42:25 +0200 | [diff] [blame] | 19 | * kept at its default value (and not overridden in mbedtls_config.h) and that the |
Gilles Peskine | e9a3454 | 2019-10-22 20:43:24 +0200 | [diff] [blame] | 20 | * DRBG instance is set up with default parameters. |
| 21 | * See the documentation of mbedtls_ctr_drbg_seed() for more |
| 22 | * information. |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 23 | */ |
| 24 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 25 | * Copyright The Mbed TLS Contributors |
Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 26 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 27 | */ |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 28 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 29 | #ifndef MBEDTLS_CTR_DRBG_H |
| 30 | #define MBEDTLS_CTR_DRBG_H |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 31 | #include "mbedtls/private_access.h" |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 32 | |
Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 33 | #include "mbedtls/build_info.h" |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 34 | |
Valerio Setti | 5f4b28d | 2023-11-13 10:18:16 +0100 | [diff] [blame^] | 35 | /* In case AES_C is defined then it is the primary option for backward |
| 36 | * compatibility purposes. If that's not available, PSA is used instead */ |
| 37 | #if defined(MBEDTLS_AES_C) |
Jaeden Amero | c49fbbf | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 38 | #include "mbedtls/aes.h" |
Valerio Setti | 5f4b28d | 2023-11-13 10:18:16 +0100 | [diff] [blame^] | 39 | #else |
| 40 | #include "psa/crypto.h" |
| 41 | #endif |
| 42 | |
Manuel Pégourié-Gonnard | 4011eb4 | 2023-03-21 17:10:45 +0100 | [diff] [blame] | 43 | #include "entropy.h" |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 44 | |
Manuel Pégourié-Gonnard | 0a4fb09 | 2015-05-07 12:50:31 +0100 | [diff] [blame] | 45 | #if defined(MBEDTLS_THREADING_C) |
Jaeden Amero | c49fbbf | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 46 | #include "mbedtls/threading.h" |
Manuel Pégourié-Gonnard | 0a4fb09 | 2015-05-07 12:50:31 +0100 | [diff] [blame] | 47 | #endif |
| 48 | |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 49 | /** The entropy source failed. */ |
| 50 | #define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034 |
| 51 | /** The requested random buffer length is too big. */ |
| 52 | #define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036 |
| 53 | /** The input (entropy + additional data) is too large. */ |
| 54 | #define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038 |
| 55 | /** Read or write error in file. */ |
| 56 | #define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 57 | |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 58 | #define MBEDTLS_CTR_DRBG_BLOCKSIZE 16 /**< The block size used by the cipher. */ |
Nir Sonnenschein | ce266e4 | 2018-08-29 10:11:46 +0300 | [diff] [blame] | 59 | |
Nir Sonnenschein | 43e4ff0 | 2018-09-03 14:15:46 +0300 | [diff] [blame] | 60 | #if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 61 | #define MBEDTLS_CTR_DRBG_KEYSIZE 16 |
| 62 | /**< The key size in bytes used by the cipher. |
| 63 | * |
| 64 | * Compile-time choice: 16 bytes (128 bits) |
Gilles Peskine | d0c64c8 | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 65 | * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled. |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 66 | */ |
Nir Sonnenschein | eb73f7a | 2018-07-30 17:46:49 +0300 | [diff] [blame] | 67 | #else |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 68 | #define MBEDTLS_CTR_DRBG_KEYSIZE 32 |
| 69 | /**< The key size in bytes used by the cipher. |
| 70 | * |
| 71 | * Compile-time choice: 32 bytes (256 bits) |
Gilles Peskine | d0c64c8 | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 72 | * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled. |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 73 | */ |
Nir Sonnenschein | a4588d4 | 2018-07-30 16:59:36 +0300 | [diff] [blame] | 74 | #endif |
Nir Sonnenschein | 43e4ff0 | 2018-09-03 14:15:46 +0300 | [diff] [blame] | 75 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 76 | #define MBEDTLS_CTR_DRBG_KEYBITS (MBEDTLS_CTR_DRBG_KEYSIZE * 8) /**< The key size for the DRBG operation, in bits. */ |
| 77 | #define MBEDTLS_CTR_DRBG_SEEDLEN (MBEDTLS_CTR_DRBG_KEYSIZE + MBEDTLS_CTR_DRBG_BLOCKSIZE) /**< The seed length, calculated as (counter + AES key). */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 78 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 79 | /** |
| 80 | * \name SECTION: Module settings |
| 81 | * |
| 82 | * The configuration options you can set for this module are in this section. |
Bence Szépkúti | bb0cfeb | 2021-05-28 09:42:25 +0200 | [diff] [blame] | 83 | * Either change them in mbedtls_config.h or define them using the compiler command |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 84 | * line. |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 85 | * \{ |
| 86 | */ |
| 87 | |
Gilles Peskine | dddda81 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 88 | /** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN |
| 89 | * |
| 90 | * \brief The amount of entropy used per seed by default, in bytes. |
| 91 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 92 | #if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) |
Manuel Pégourié-Gonnard | 4011eb4 | 2023-03-21 17:10:45 +0100 | [diff] [blame] | 93 | #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR) |
| 94 | /** This is 48 bytes because the entropy module uses SHA-512. |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 95 | */ |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 96 | #define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 |
Gilles Peskine | dddda81 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 97 | |
Manuel Pégourié-Gonnard | 4011eb4 | 2023-03-21 17:10:45 +0100 | [diff] [blame] | 98 | #else /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */ |
Gilles Peskine | dddda81 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 99 | |
Manuel Pégourié-Gonnard | 4011eb4 | 2023-03-21 17:10:45 +0100 | [diff] [blame] | 100 | /** This is 32 bytes because the entropy module uses SHA-256. |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 101 | */ |
Gilles Peskine | dddda81 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 102 | #if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) |
| 103 | /** \warning To achieve a 256-bit security strength, you must pass a nonce |
| 104 | * to mbedtls_ctr_drbg_seed(). |
| 105 | */ |
| 106 | #endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */ |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 107 | #define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32 |
Manuel Pégourié-Gonnard | 4011eb4 | 2023-03-21 17:10:45 +0100 | [diff] [blame] | 108 | #endif /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */ |
Gilles Peskine | dddda81 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 109 | #endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 110 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 111 | #if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL) |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 112 | #define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 |
| 113 | /**< The interval before reseed is performed by default. */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 114 | #endif |
| 115 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 116 | #if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT) |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 117 | #define MBEDTLS_CTR_DRBG_MAX_INPUT 256 |
| 118 | /**< The maximum number of additional input Bytes. */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 119 | #endif |
| 120 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 121 | #if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST) |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 122 | #define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 |
| 123 | /**< The maximum number of requested Bytes per call. */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 124 | #endif |
| 125 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 126 | #if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT) |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 127 | #define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 128 | /**< The maximum size of seed or reseed buffer in bytes. */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 129 | #endif |
| 130 | |
Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 131 | /** \} name SECTION: Module settings */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 132 | |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 133 | #define MBEDTLS_CTR_DRBG_PR_OFF 0 |
| 134 | /**< Prediction resistance is disabled. */ |
| 135 | #define MBEDTLS_CTR_DRBG_PR_ON 1 |
| 136 | /**< Prediction resistance is enabled. */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 137 | |
| 138 | #ifdef __cplusplus |
| 139 | extern "C" { |
| 140 | #endif |
| 141 | |
Gilles Peskine | 6997166 | 2019-10-23 19:39:36 +0200 | [diff] [blame] | 142 | #if MBEDTLS_CTR_DRBG_ENTROPY_LEN >= MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2 |
| 143 | /** The default length of the nonce read from the entropy source. |
| 144 | * |
| 145 | * This is \c 0 because a single read from the entropy source is sufficient |
| 146 | * to include a nonce. |
| 147 | * See the documentation of mbedtls_ctr_drbg_seed() for more information. |
| 148 | */ |
| 149 | #define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN 0 |
| 150 | #else |
| 151 | /** The default length of the nonce read from the entropy source. |
| 152 | * |
| 153 | * This is half of the default entropy length because a single read from |
| 154 | * the entropy source does not provide enough material to form a nonce. |
| 155 | * See the documentation of mbedtls_ctr_drbg_seed() for more information. |
| 156 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 157 | #define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN (MBEDTLS_CTR_DRBG_ENTROPY_LEN + 1) / 2 |
Gilles Peskine | 6997166 | 2019-10-23 19:39:36 +0200 | [diff] [blame] | 158 | #endif |
| 159 | |
Valerio Setti | 5f4b28d | 2023-11-13 10:18:16 +0100 | [diff] [blame^] | 160 | #if !defined(MBEDTLS_AES_C) |
| 161 | typedef struct mbedtls_ctr_drbg_psa_context { |
| 162 | mbedtls_svc_key_id_t key_id; |
| 163 | psa_cipher_operation_t operation; |
| 164 | } mbedtls_ctr_drbg_psa_context; |
| 165 | #endif |
| 166 | |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 167 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 168 | * \brief The CTR_DRBG context structure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 169 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 170 | typedef struct mbedtls_ctr_drbg_context { |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 171 | unsigned char MBEDTLS_PRIVATE(counter)[16]; /*!< The counter (V). */ |
| 172 | int MBEDTLS_PRIVATE(reseed_counter); /*!< The reseed counter. |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 173 | * This is the number of requests that have |
| 174 | * been made since the last (re)seeding, |
| 175 | * minus one. |
| 176 | * Before the initial seeding, this field |
| 177 | * contains the amount of entropy in bytes |
| 178 | * to use as a nonce for the initial seeding, |
| 179 | * or -1 if no nonce length has been explicitly |
| 180 | * set (see mbedtls_ctr_drbg_set_nonce_len()). |
| 181 | */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 182 | int MBEDTLS_PRIVATE(prediction_resistance); /*!< This determines whether prediction |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 183 | resistance is enabled, that is |
| 184 | whether to systematically reseed before |
| 185 | each random generation. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 186 | size_t MBEDTLS_PRIVATE(entropy_len); /*!< The amount of entropy grabbed on each |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 187 | seed or reseed operation, in bytes. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 188 | int MBEDTLS_PRIVATE(reseed_interval); /*!< The reseed interval. |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 189 | * This is the maximum number of requests |
| 190 | * that can be made between reseedings. */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 191 | |
Valerio Setti | 5f4b28d | 2023-11-13 10:18:16 +0100 | [diff] [blame^] | 192 | #if defined(MBEDTLS_AES_C) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 193 | mbedtls_aes_context MBEDTLS_PRIVATE(aes_ctx); /*!< The AES context. */ |
Valerio Setti | 5f4b28d | 2023-11-13 10:18:16 +0100 | [diff] [blame^] | 194 | #else |
| 195 | mbedtls_ctr_drbg_psa_context MBEDTLS_PRIVATE(psa_ctx); /*!< The PSA context. */ |
| 196 | #endif |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 197 | |
| 198 | /* |
| 199 | * Callbacks (Entropy) |
| 200 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 201 | int(*MBEDTLS_PRIVATE(f_entropy))(void *, unsigned char *, size_t); |
| 202 | /*!< The entropy callback function. */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 203 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 204 | void *MBEDTLS_PRIVATE(p_entropy); /*!< The context for the entropy function. */ |
Manuel Pégourié-Gonnard | 0a4fb09 | 2015-05-07 12:50:31 +0100 | [diff] [blame] | 205 | |
| 206 | #if defined(MBEDTLS_THREADING_C) |
Gilles Peskine | da290f9 | 2021-02-09 18:44:02 +0100 | [diff] [blame] | 207 | /* Invariant: the mutex is initialized if and only if f_entropy != NULL. |
| 208 | * This means that the mutex is initialized during the initial seeding |
| 209 | * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free(). |
| 210 | * |
| 211 | * Note that this invariant may change without notice. Do not rely on it |
| 212 | * and do not access the mutex directly in application code. |
| 213 | */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 214 | mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex); |
Manuel Pégourié-Gonnard | 0a4fb09 | 2015-05-07 12:50:31 +0100 | [diff] [blame] | 215 | #endif |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 216 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 217 | mbedtls_ctr_drbg_context; |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 218 | |
| 219 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 220 | * \brief This function initializes the CTR_DRBG context, |
| 221 | * and prepares it for mbedtls_ctr_drbg_seed() |
| 222 | * or mbedtls_ctr_drbg_free(). |
Manuel Pégourié-Gonnard | 8d128ef | 2015-04-28 22:38:08 +0200 | [diff] [blame] | 223 | * |
Gavin Acquroff | 6aceb51 | 2020-03-01 17:06:11 -0800 | [diff] [blame] | 224 | * \note The reseed interval is |
| 225 | * #MBEDTLS_CTR_DRBG_RESEED_INTERVAL by default. |
| 226 | * You can override it by calling |
| 227 | * mbedtls_ctr_drbg_set_reseed_interval(). |
| 228 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 229 | * \param ctx The CTR_DRBG context to initialize. |
Manuel Pégourié-Gonnard | 8d128ef | 2015-04-28 22:38:08 +0200 | [diff] [blame] | 230 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 231 | void mbedtls_ctr_drbg_init(mbedtls_ctr_drbg_context *ctx); |
Manuel Pégourié-Gonnard | 8d128ef | 2015-04-28 22:38:08 +0200 | [diff] [blame] | 232 | |
| 233 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 234 | * \brief This function seeds and sets up the CTR_DRBG |
| 235 | * entropy source for future reseeds. |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 236 | * |
Gilles Peskine | 223deea | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 237 | * A typical choice for the \p f_entropy and \p p_entropy parameters is |
| 238 | * to use the entropy module: |
| 239 | * - \p f_entropy is mbedtls_entropy_func(); |
| 240 | * - \p p_entropy is an instance of ::mbedtls_entropy_context initialized |
| 241 | * with mbedtls_entropy_init() (which registers the platform's default |
| 242 | * entropy sources). |
| 243 | * |
Gilles Peskine | 50ed86b | 2019-10-04 12:15:55 +0200 | [diff] [blame] | 244 | * The entropy length is #MBEDTLS_CTR_DRBG_ENTROPY_LEN by default. |
| 245 | * You can override it by calling mbedtls_ctr_drbg_set_entropy_len(). |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 246 | * |
Gilles Peskine | e9a3454 | 2019-10-22 20:43:24 +0200 | [diff] [blame] | 247 | * The entropy nonce length is: |
| 248 | * - \c 0 if the entropy length is at least 3/2 times the entropy length, |
| 249 | * which guarantees that the security strength is the maximum permitted |
| 250 | * by the key size and entropy length according to NIST SP 800-90A §10.2.1; |
| 251 | * - Half the entropy length otherwise. |
| 252 | * You can override it by calling mbedtls_ctr_drbg_set_nonce_len(). |
Gilles Peskine | 6997166 | 2019-10-23 19:39:36 +0200 | [diff] [blame] | 253 | * With the default entropy length, the entropy nonce length is |
| 254 | * #MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN. |
| 255 | * |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 256 | * You can provide a nonce and personalization string in addition to the |
Gilles Peskine | 223deea | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 257 | * entropy source, to make this instantiation as unique as possible. |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 258 | * See SP 800-90A §8.6.7 for more details about nonces. |
Gilles Peskine | 223deea | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 259 | * |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 260 | * The _seed_material_ value passed to the derivation function in |
| 261 | * the CTR_DRBG Instantiate Process described in NIST SP 800-90A §10.2.1.3.2 |
| 262 | * is the concatenation of the following strings: |
| 263 | * - A string obtained by calling \p f_entropy function for the entropy |
| 264 | * length. |
Gilles Peskine | e9a3454 | 2019-10-22 20:43:24 +0200 | [diff] [blame] | 265 | */ |
Gilles Peskine | 6997166 | 2019-10-23 19:39:36 +0200 | [diff] [blame] | 266 | #if MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN == 0 |
Gilles Peskine | e9a3454 | 2019-10-22 20:43:24 +0200 | [diff] [blame] | 267 | /** |
| 268 | * - If mbedtls_ctr_drbg_set_nonce_len() has been called, a string |
| 269 | * obtained by calling \p f_entropy function for the specified length. |
| 270 | */ |
| 271 | #else |
| 272 | /** |
| 273 | * - A string obtained by calling \p f_entropy function for the entropy nonce |
| 274 | * length. If the entropy nonce length is \c 0, this function does not |
| 275 | * make a second call to \p f_entropy. |
| 276 | */ |
| 277 | #endif |
Gilles Peskine | f305d92 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 278 | #if defined(MBEDTLS_THREADING_C) |
| 279 | /** |
| 280 | * \note When Mbed TLS is built with threading support, |
| 281 | * after this function returns successfully, |
| 282 | * it is safe to call mbedtls_ctr_drbg_random() |
| 283 | * from multiple threads. Other operations, including |
| 284 | * reseeding, are not thread-safe. |
| 285 | */ |
| 286 | #endif /* MBEDTLS_THREADING_C */ |
Gilles Peskine | e9a3454 | 2019-10-22 20:43:24 +0200 | [diff] [blame] | 287 | /** |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 288 | * - The \p custom string. |
| 289 | * |
| 290 | * \note To achieve the nominal security strength permitted |
| 291 | * by CTR_DRBG, the entropy length must be: |
| 292 | * - at least 16 bytes for a 128-bit strength |
| 293 | * (maximum achievable strength when using AES-128); |
| 294 | * - at least 32 bytes for a 256-bit strength |
| 295 | * (maximum achievable strength when using AES-256). |
| 296 | * |
| 297 | * In addition, if you do not pass a nonce in \p custom, |
| 298 | * the sum of the entropy length |
Gilles Peskine | e9a3454 | 2019-10-22 20:43:24 +0200 | [diff] [blame] | 299 | * and the entropy nonce length must be: |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 300 | * - at least 24 bytes for a 128-bit strength |
| 301 | * (maximum achievable strength when using AES-128); |
| 302 | * - at least 48 bytes for a 256-bit strength |
| 303 | * (maximum achievable strength when using AES-256). |
| 304 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 305 | * \param ctx The CTR_DRBG context to seed. |
Gilles Peskine | bd326f9 | 2019-10-28 17:33:07 +0100 | [diff] [blame] | 306 | * It must have been initialized with |
| 307 | * mbedtls_ctr_drbg_init(). |
| 308 | * After a successful call to mbedtls_ctr_drbg_seed(), |
| 309 | * you may not call mbedtls_ctr_drbg_seed() again on |
| 310 | * the same context unless you call |
| 311 | * mbedtls_ctr_drbg_free() and mbedtls_ctr_drbg_init() |
| 312 | * again first. |
Gilles Peskine | f305d92 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 313 | * After a failed call to mbedtls_ctr_drbg_seed(), |
| 314 | * you must call mbedtls_ctr_drbg_free(). |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 315 | * \param f_entropy The entropy callback, taking as arguments the |
| 316 | * \p p_entropy context, the buffer to fill, and the |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 317 | * length of the buffer. |
Gilles Peskine | 50ed86b | 2019-10-04 12:15:55 +0200 | [diff] [blame] | 318 | * \p f_entropy is always called with a buffer size |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 319 | * less than or equal to the entropy length. |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 320 | * \param p_entropy The entropy context to pass to \p f_entropy. |
Gilles Peskine | 217b815 | 2019-10-01 18:39:45 +0200 | [diff] [blame] | 321 | * \param custom The personalization string. |
| 322 | * This can be \c NULL, in which case the personalization |
| 323 | * string is empty regardless of the value of \p len. |
| 324 | * \param len The length of the personalization string. |
Gilles Peskine | 944bc58 | 2019-09-24 14:48:30 +0200 | [diff] [blame] | 325 | * This must be at most |
| 326 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT |
| 327 | * - #MBEDTLS_CTR_DRBG_ENTROPY_LEN. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 328 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 329 | * \return \c 0 on success. |
| 330 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 331 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 332 | int mbedtls_ctr_drbg_seed(mbedtls_ctr_drbg_context *ctx, |
| 333 | int (*f_entropy)(void *, unsigned char *, size_t), |
| 334 | void *p_entropy, |
| 335 | const unsigned char *custom, |
| 336 | size_t len); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 337 | |
| 338 | /** |
Gavin Acquroff | 6aceb51 | 2020-03-01 17:06:11 -0800 | [diff] [blame] | 339 | * \brief This function resets CTR_DRBG context to the state immediately |
| 340 | * after initial call of mbedtls_ctr_drbg_init(). |
Paul Bakker | fff0366 | 2014-06-18 16:21:25 +0200 | [diff] [blame] | 341 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 342 | * \param ctx The CTR_DRBG context to clear. |
Paul Bakker | fff0366 | 2014-06-18 16:21:25 +0200 | [diff] [blame] | 343 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 344 | void mbedtls_ctr_drbg_free(mbedtls_ctr_drbg_context *ctx); |
Paul Bakker | fff0366 | 2014-06-18 16:21:25 +0200 | [diff] [blame] | 345 | |
| 346 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 347 | * \brief This function turns prediction resistance on or off. |
| 348 | * The default value is off. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 349 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 350 | * \note If enabled, entropy is gathered at the beginning of |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 351 | * every call to mbedtls_ctr_drbg_random_with_add() |
| 352 | * or mbedtls_ctr_drbg_random(). |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 353 | * Only use this if your entropy source has sufficient |
| 354 | * throughput. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 355 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 356 | * \param ctx The CTR_DRBG context. |
| 357 | * \param resistance #MBEDTLS_CTR_DRBG_PR_ON or #MBEDTLS_CTR_DRBG_PR_OFF. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 358 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 359 | void mbedtls_ctr_drbg_set_prediction_resistance(mbedtls_ctr_drbg_context *ctx, |
| 360 | int resistance); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 361 | |
| 362 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 363 | * \brief This function sets the amount of entropy grabbed on each |
Gilles Peskine | 50ed86b | 2019-10-04 12:15:55 +0200 | [diff] [blame] | 364 | * seed or reseed. |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 365 | * |
| 366 | * The default value is #MBEDTLS_CTR_DRBG_ENTROPY_LEN. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 367 | * |
Gilles Peskine | dddda81 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 368 | * \note The security strength of CTR_DRBG is bounded by the |
| 369 | * entropy length. Thus: |
| 370 | * - When using AES-256 |
| 371 | * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled, |
| 372 | * which is the default), |
| 373 | * \p len must be at least 32 (in bytes) |
| 374 | * to achieve a 256-bit strength. |
| 375 | * - When using AES-128 |
| 376 | * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled) |
| 377 | * \p len must be at least 16 (in bytes) |
| 378 | * to achieve a 128-bit strength. |
Gilles Peskine | 223deea | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 379 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 380 | * \param ctx The CTR_DRBG context. |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 381 | * \param len The amount of entropy to grab, in bytes. |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 382 | * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT |
| 383 | * and at most the maximum length accepted by the |
| 384 | * entropy function that is set in the context. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 385 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 386 | void mbedtls_ctr_drbg_set_entropy_len(mbedtls_ctr_drbg_context *ctx, |
| 387 | size_t len); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 388 | |
| 389 | /** |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 390 | * \brief This function sets the amount of entropy grabbed |
| 391 | * as a nonce for the initial seeding. |
| 392 | * |
| 393 | * Call this function before calling mbedtls_ctr_drbg_seed() to read |
| 394 | * a nonce from the entropy source during the initial seeding. |
| 395 | * |
| 396 | * \param ctx The CTR_DRBG context. |
| 397 | * \param len The amount of entropy to grab for the nonce, in bytes. |
| 398 | * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT |
| 399 | * and at most the maximum length accepted by the |
| 400 | * entropy function that is set in the context. |
| 401 | * |
| 402 | * \return \c 0 on success. |
| 403 | * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if \p len is |
| 404 | * more than #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT. |
| 405 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED |
| 406 | * if the initial seeding has already taken place. |
| 407 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 408 | int mbedtls_ctr_drbg_set_nonce_len(mbedtls_ctr_drbg_context *ctx, |
| 409 | size_t len); |
Gilles Peskine | 9be5098 | 2019-10-22 18:42:27 +0200 | [diff] [blame] | 410 | |
| 411 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 412 | * \brief This function sets the reseed interval. |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 413 | * |
| 414 | * The reseed interval is the number of calls to mbedtls_ctr_drbg_random() |
| 415 | * or mbedtls_ctr_drbg_random_with_add() after which the entropy function |
| 416 | * is called again. |
| 417 | * |
| 418 | * The default value is #MBEDTLS_CTR_DRBG_RESEED_INTERVAL. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 419 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 420 | * \param ctx The CTR_DRBG context. |
| 421 | * \param interval The reseed interval. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 422 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 423 | void mbedtls_ctr_drbg_set_reseed_interval(mbedtls_ctr_drbg_context *ctx, |
| 424 | int interval); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 425 | |
| 426 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 427 | * \brief This function reseeds the CTR_DRBG context, that is |
| 428 | * extracts data from the entropy source. |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 429 | * |
Gilles Peskine | f305d92 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 430 | * \note This function is not thread-safe. It is not safe |
| 431 | * to call this function if another thread might be |
| 432 | * concurrently obtaining random numbers from the same |
| 433 | * context or updating or reseeding the same context. |
| 434 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 435 | * \param ctx The CTR_DRBG context. |
Gilles Peskine | 10f16ac | 2019-10-01 18:30:02 +0200 | [diff] [blame] | 436 | * \param additional Additional data to add to the state. Can be \c NULL. |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 437 | * \param len The length of the additional data. |
Gilles Peskine | 944bc58 | 2019-09-24 14:48:30 +0200 | [diff] [blame] | 438 | * This must be less than |
| 439 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len |
| 440 | * where \c entropy_len is the entropy length |
| 441 | * configured for the context. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 442 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 443 | * \return \c 0 on success. |
| 444 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 445 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 446 | int mbedtls_ctr_drbg_reseed(mbedtls_ctr_drbg_context *ctx, |
| 447 | const unsigned char *additional, size_t len); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 448 | |
| 449 | /** |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 450 | * \brief This function updates the state of the CTR_DRBG context. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 451 | * |
Gilles Peskine | f305d92 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 452 | * \note This function is not thread-safe. It is not safe |
| 453 | * to call this function if another thread might be |
| 454 | * concurrently obtaining random numbers from the same |
| 455 | * context or updating or reseeding the same context. |
| 456 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 457 | * \param ctx The CTR_DRBG context. |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 458 | * \param additional The data to update the state with. This must not be |
Gilles Peskine | 10f16ac | 2019-10-01 18:30:02 +0200 | [diff] [blame] | 459 | * \c NULL unless \p add_len is \c 0. |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 460 | * \param add_len Length of \p additional in bytes. This must be at |
| 461 | * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT. |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 462 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 463 | * \return \c 0 on success. |
| 464 | * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if |
| 465 | * \p add_len is more than |
| 466 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT. |
| 467 | * \return An error from the underlying AES cipher on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 468 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 469 | int mbedtls_ctr_drbg_update(mbedtls_ctr_drbg_context *ctx, |
| 470 | const unsigned char *additional, |
| 471 | size_t add_len); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 472 | |
| 473 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 474 | * \brief This function updates a CTR_DRBG instance with additional |
| 475 | * data and uses it to generate random data. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 476 | * |
Gilles Peskine | 2d8f069 | 2019-10-01 18:31:28 +0200 | [diff] [blame] | 477 | * This function automatically reseeds if the reseed counter is exceeded |
| 478 | * or prediction resistance is enabled. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 479 | * |
Gilles Peskine | f305d92 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 480 | * \note This function is not thread-safe. It is not safe |
| 481 | * to call this function if another thread might be |
| 482 | * concurrently obtaining random numbers from the same |
| 483 | * context or updating or reseeding the same context. |
| 484 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 485 | * \param p_rng The CTR_DRBG context. This must be a pointer to a |
| 486 | * #mbedtls_ctr_drbg_context structure. |
| 487 | * \param output The buffer to fill. |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 488 | * \param output_len The length of the buffer in bytes. |
Gilles Peskine | 10f16ac | 2019-10-01 18:30:02 +0200 | [diff] [blame] | 489 | * \param additional Additional data to update. Can be \c NULL, in which |
Gilles Peskine | 08875d4 | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 490 | * case the additional data is empty regardless of |
| 491 | * the value of \p add_len. |
| 492 | * \param add_len The length of the additional data |
Gilles Peskine | 10f16ac | 2019-10-01 18:30:02 +0200 | [diff] [blame] | 493 | * if \p additional is not \c NULL. |
Gilles Peskine | 944bc58 | 2019-09-24 14:48:30 +0200 | [diff] [blame] | 494 | * This must be less than #MBEDTLS_CTR_DRBG_MAX_INPUT |
| 495 | * and less than |
| 496 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len |
| 497 | * where \c entropy_len is the entropy length |
| 498 | * configured for the context. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 499 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 500 | * \return \c 0 on success. |
| 501 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 502 | * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 503 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 504 | int mbedtls_ctr_drbg_random_with_add(void *p_rng, |
| 505 | unsigned char *output, size_t output_len, |
| 506 | const unsigned char *additional, size_t add_len); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 507 | |
| 508 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 509 | * \brief This function uses CTR_DRBG to generate random data. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 510 | * |
Gilles Peskine | 2d8f069 | 2019-10-01 18:31:28 +0200 | [diff] [blame] | 511 | * This function automatically reseeds if the reseed counter is exceeded |
| 512 | * or prediction resistance is enabled. |
Gilles Peskine | f305d92 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 513 | */ |
| 514 | #if defined(MBEDTLS_THREADING_C) |
| 515 | /** |
| 516 | * \note When Mbed TLS is built with threading support, |
| 517 | * it is safe to call mbedtls_ctr_drbg_random() |
| 518 | * from multiple threads. Other operations, including |
| 519 | * reseeding, are not thread-safe. |
| 520 | */ |
| 521 | #endif /* MBEDTLS_THREADING_C */ |
| 522 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 523 | * \param p_rng The CTR_DRBG context. This must be a pointer to a |
| 524 | * #mbedtls_ctr_drbg_context structure. |
| 525 | * \param output The buffer to fill. |
Gilles Peskine | 944bc58 | 2019-09-24 14:48:30 +0200 | [diff] [blame] | 526 | * \param output_len The length of the buffer in bytes. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 527 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 528 | * \return \c 0 on success. |
| 529 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 530 | * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 531 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 532 | int mbedtls_ctr_drbg_random(void *p_rng, |
| 533 | unsigned char *output, size_t output_len); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 534 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 535 | #if defined(MBEDTLS_FS_IO) |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 536 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 537 | * \brief This function writes a seed file. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 538 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 539 | * \param ctx The CTR_DRBG context. |
| 540 | * \param path The name of the file. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 541 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 542 | * \return \c 0 on success. |
Rose Zadik | f25eb6e | 2018-04-16 14:51:52 +0100 | [diff] [blame] | 543 | * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error. |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 544 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 545 | * failure. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 546 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 547 | int mbedtls_ctr_drbg_write_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path); |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 548 | |
| 549 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 550 | * \brief This function reads and updates a seed file. The seed |
| 551 | * is added to this instance. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 552 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 553 | * \param ctx The CTR_DRBG context. |
| 554 | * \param path The name of the file. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 555 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 556 | * \return \c 0 on success. |
| 557 | * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error. |
Gilles Peskine | ec51dd1 | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 558 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on |
| 559 | * reseed failure. |
| 560 | * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if the existing |
| 561 | * seed file is too large. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 562 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 563 | int mbedtls_ctr_drbg_update_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 564 | #endif /* MBEDTLS_FS_IO */ |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 565 | |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 566 | #if defined(MBEDTLS_SELF_TEST) |
| 567 | |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 568 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 569 | * \brief The CTR_DRBG checkup routine. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 570 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 571 | * \return \c 0 on success. |
| 572 | * \return \c 1 on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 573 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 574 | int mbedtls_ctr_drbg_self_test(int verbose); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 575 | |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 576 | #endif /* MBEDTLS_SELF_TEST */ |
| 577 | |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 578 | #ifdef __cplusplus |
| 579 | } |
| 580 | #endif |
| 581 | |
| 582 | #endif /* ctr_drbg.h */ |