Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 1 | /** |
| 2 | * \file ctr_drbg.h |
| 3 | * |
Gilles Peskine | e3d8cf1 | 2019-10-02 19:02:13 +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 | dd5b67b | 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 | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 14 | * as the underlying block cipher, with a derivation function. |
| 15 | * The initial seeding grabs #MBEDTLS_CTR_DRBG_ENTROPY_LEN bytes of entropy. |
| 16 | * See the documentation of mbedtls_ctr_drbg_seed() for more details. |
| 17 | * |
| 18 | * Based on NIST SP 800-90A §10.2.1 table 3 and NIST SP 800-57 part 1 table 2, |
| 19 | * here are the security strengths achieved in typical configuration: |
Gilles Peskine | 1eb7ba7 | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 20 | * - 256 bits under the default configuration of the library, with AES-256 |
Gilles Peskine | dd5b67b | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 21 | * and with #MBEDTLS_CTR_DRBG_ENTROPY_LEN set to 48 or more. |
Gilles Peskine | 1eb7ba7 | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 22 | * - 256 bits if AES-256 is used, #MBEDTLS_CTR_DRBG_ENTROPY_LEN is set |
Gilles Peskine | 3354f75 | 2019-09-25 20:22:24 +0200 | [diff] [blame] | 23 | * to 32 or more, and the DRBG is initialized with an explicit |
Gilles Peskine | 4284bec | 2019-09-26 14:54:42 +0200 | [diff] [blame] | 24 | * nonce in the \c custom parameter to mbedtls_ctr_drbg_seed(). |
Gilles Peskine | 1eb7ba7 | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 25 | * - 128 bits if AES-256 is used but #MBEDTLS_CTR_DRBG_ENTROPY_LEN is |
| 26 | * between 24 and 47 and the DRBG is not initialized with an explicit |
| 27 | * nonce (see mbedtls_ctr_drbg_seed()). |
Gilles Peskine | dd5b67b | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 28 | * - 128 bits if AES-128 is used (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY enabled) |
Gilles Peskine | 1eb7ba7 | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 29 | * and #MBEDTLS_CTR_DRBG_ENTROPY_LEN is set to 24 or more (which is |
| 30 | * always the case unless it is explicitly set to a different value |
Gilles Peskine | dd5b67b | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 31 | * in config.h). |
Gilles Peskine | 8cec70a | 2019-10-02 18:23:38 +0200 | [diff] [blame] | 32 | * |
| 33 | * Note that the value of #MBEDTLS_CTR_DRBG_ENTROPY_LEN defaults to: |
Gilles Peskine | dd5b67b | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 34 | * - \c 48 if the module \c MBEDTLS_SHA512_C is enabled and the symbol |
| 35 | * \c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled at compile time. |
Gilles Peskine | 8cec70a | 2019-10-02 18:23:38 +0200 | [diff] [blame] | 36 | * This is the default configuration of the library. |
Gilles Peskine | dd5b67b | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 37 | * - \c 32 if the module \c MBEDTLS_SHA512_C is disabled at compile time. |
| 38 | * - \c 32 if \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled at compile time. |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 39 | */ |
| 40 | /* |
Bence Szépkúti | a2947ac | 2020-08-19 16:37:36 +0200 | [diff] [blame] | 41 | * Copyright The Mbed TLS Contributors |
Bence Szépkúti | f744bd7 | 2020-06-05 13:02:18 +0200 | [diff] [blame] | 42 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
| 43 | * |
| 44 | * This file is provided under the Apache License 2.0, or the |
| 45 | * GNU General Public License v2.0 or later. |
| 46 | * |
| 47 | * ********** |
| 48 | * Apache License 2.0: |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 49 | * |
| 50 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 51 | * not use this file except in compliance with the License. |
| 52 | * You may obtain a copy of the License at |
| 53 | * |
| 54 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 55 | * |
| 56 | * Unless required by applicable law or agreed to in writing, software |
| 57 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 58 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 59 | * See the License for the specific language governing permissions and |
| 60 | * limitations under the License. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 61 | * |
Bence Szépkúti | f744bd7 | 2020-06-05 13:02:18 +0200 | [diff] [blame] | 62 | * ********** |
| 63 | * |
| 64 | * ********** |
| 65 | * GNU General Public License v2.0 or later: |
| 66 | * |
| 67 | * This program is free software; you can redistribute it and/or modify |
| 68 | * it under the terms of the GNU General Public License as published by |
| 69 | * the Free Software Foundation; either version 2 of the License, or |
| 70 | * (at your option) any later version. |
| 71 | * |
| 72 | * This program is distributed in the hope that it will be useful, |
| 73 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 74 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 75 | * GNU General Public License for more details. |
| 76 | * |
| 77 | * You should have received a copy of the GNU General Public License along |
| 78 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 79 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 80 | * |
| 81 | * ********** |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 82 | */ |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 83 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 84 | #ifndef MBEDTLS_CTR_DRBG_H |
| 85 | #define MBEDTLS_CTR_DRBG_H |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 86 | |
Ron Eldor | 8b0cf2e | 2018-02-14 16:02:41 +0200 | [diff] [blame] | 87 | #if !defined(MBEDTLS_CONFIG_FILE) |
| 88 | #include "config.h" |
| 89 | #else |
| 90 | #include MBEDTLS_CONFIG_FILE |
| 91 | #endif |
| 92 | |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 93 | #include "aes.h" |
| 94 | |
Manuel Pégourié-Gonnard | 0a4fb09 | 2015-05-07 12:50:31 +0100 | [diff] [blame] | 95 | #if defined(MBEDTLS_THREADING_C) |
Ron Eldor | 6fd941f | 2017-05-14 16:17:33 +0300 | [diff] [blame] | 96 | #include "threading.h" |
Manuel Pégourié-Gonnard | 0a4fb09 | 2015-05-07 12:50:31 +0100 | [diff] [blame] | 97 | #endif |
| 98 | |
Gilles Peskine | 1990fab | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 99 | /** The entropy source failed. */ |
| 100 | #define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034 |
| 101 | /** The requested random buffer length is too big. */ |
| 102 | #define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036 |
| 103 | /** The input (entropy + additional data) is too large. */ |
| 104 | #define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038 |
| 105 | /** Read or write error in file. */ |
| 106 | #define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 107 | |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 108 | #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] | 109 | |
Nir Sonnenschein | 43e4ff0 | 2018-09-03 14:15:46 +0300 | [diff] [blame] | 110 | #if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 111 | #define MBEDTLS_CTR_DRBG_KEYSIZE 16 |
| 112 | /**< The key size in bytes used by the cipher. |
| 113 | * |
| 114 | * Compile-time choice: 16 bytes (128 bits) |
Gilles Peskine | dd5b67b | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 115 | * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled. |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 116 | */ |
Nir Sonnenschein | eb73f7a | 2018-07-30 17:46:49 +0300 | [diff] [blame] | 117 | #else |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 118 | #define MBEDTLS_CTR_DRBG_KEYSIZE 32 |
| 119 | /**< The key size in bytes used by the cipher. |
| 120 | * |
| 121 | * Compile-time choice: 32 bytes (256 bits) |
Gilles Peskine | dd5b67b | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 122 | * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled. |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 123 | */ |
Nir Sonnenschein | a4588d4 | 2018-07-30 16:59:36 +0300 | [diff] [blame] | 124 | #endif |
Nir Sonnenschein | 43e4ff0 | 2018-09-03 14:15:46 +0300 | [diff] [blame] | 125 | |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 126 | #define MBEDTLS_CTR_DRBG_KEYBITS ( MBEDTLS_CTR_DRBG_KEYSIZE * 8 ) /**< The key size for the DRBG operation, in bits. */ |
| 127 | #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] | 128 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 129 | /** |
| 130 | * \name SECTION: Module settings |
| 131 | * |
| 132 | * The configuration options you can set for this module are in this section. |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 133 | * Either change them in config.h or define them using the compiler command |
| 134 | * line. |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 135 | * \{ |
| 136 | */ |
| 137 | |
Gilles Peskine | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 138 | /** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN |
| 139 | * |
| 140 | * \brief The amount of entropy used per seed by default, in bytes. |
| 141 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 142 | #if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) |
| 143 | #if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) |
Gilles Peskine | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 144 | /** This is 48 bytes because the entropy module uses SHA-512 |
Gilles Peskine | dd5b67b | 2019-10-03 14:20:46 +0200 | [diff] [blame] | 145 | * (\c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled). |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 146 | */ |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 147 | #define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 |
Gilles Peskine | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 148 | |
| 149 | #else /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */ |
| 150 | |
| 151 | /** This is 32 bytes because the entropy module uses SHA-256 |
| 152 | * (the SHA512 module is disabled or |
| 153 | * \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled). |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 154 | */ |
Gilles Peskine | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 155 | #if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) |
| 156 | /** \warning To achieve a 256-bit security strength, you must pass a nonce |
| 157 | * to mbedtls_ctr_drbg_seed(). |
| 158 | */ |
| 159 | #endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */ |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 160 | #define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32 |
Gilles Peskine | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 161 | #endif /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */ |
| 162 | #endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 163 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 164 | #if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL) |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 165 | #define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 |
| 166 | /**< The interval before reseed is performed by default. */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 167 | #endif |
| 168 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 169 | #if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT) |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 170 | #define MBEDTLS_CTR_DRBG_MAX_INPUT 256 |
| 171 | /**< The maximum number of additional input Bytes. */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 172 | #endif |
| 173 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 174 | #if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST) |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 175 | #define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 |
| 176 | /**< The maximum number of requested Bytes per call. */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 177 | #endif |
| 178 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 179 | #if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT) |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 180 | #define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 181 | /**< The maximum size of seed or reseed buffer in bytes. */ |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 182 | #endif |
| 183 | |
| 184 | /* \} name SECTION: Module settings */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 185 | |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 186 | #define MBEDTLS_CTR_DRBG_PR_OFF 0 |
| 187 | /**< Prediction resistance is disabled. */ |
| 188 | #define MBEDTLS_CTR_DRBG_PR_ON 1 |
| 189 | /**< Prediction resistance is enabled. */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 190 | |
| 191 | #ifdef __cplusplus |
| 192 | extern "C" { |
| 193 | #endif |
| 194 | |
| 195 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 196 | * \brief The CTR_DRBG context structure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 197 | */ |
Dawid Drozd | 428cc52 | 2018-07-24 10:02:47 +0200 | [diff] [blame] | 198 | typedef struct mbedtls_ctr_drbg_context |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 199 | { |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 200 | unsigned char counter[16]; /*!< The counter (V). */ |
| 201 | int reseed_counter; /*!< The reseed counter. */ |
| 202 | int prediction_resistance; /*!< This determines whether prediction |
| 203 | resistance is enabled, that is |
| 204 | whether to systematically reseed before |
| 205 | each random generation. */ |
| 206 | size_t entropy_len; /*!< The amount of entropy grabbed on each |
| 207 | seed or reseed operation. */ |
| 208 | int reseed_interval; /*!< The reseed interval. */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 209 | |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 210 | mbedtls_aes_context aes_ctx; /*!< The AES context. */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 211 | |
| 212 | /* |
| 213 | * Callbacks (Entropy) |
| 214 | */ |
| 215 | int (*f_entropy)(void *, unsigned char *, size_t); |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 216 | /*!< The entropy callback function. */ |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 217 | |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 218 | void *p_entropy; /*!< The context for the entropy function. */ |
Manuel Pégourié-Gonnard | 0a4fb09 | 2015-05-07 12:50:31 +0100 | [diff] [blame] | 219 | |
| 220 | #if defined(MBEDTLS_THREADING_C) |
Gilles Peskine | 2ecc0b8 | 2021-02-09 18:44:02 +0100 | [diff] [blame] | 221 | /* Invariant: the mutex is initialized if and only if f_entropy != NULL. |
| 222 | * This means that the mutex is initialized during the initial seeding |
| 223 | * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free(). |
| 224 | * |
| 225 | * Note that this invariant may change without notice. Do not rely on it |
| 226 | * and do not access the mutex directly in application code. |
| 227 | */ |
Manuel Pégourié-Gonnard | 0a4fb09 | 2015-05-07 12:50:31 +0100 | [diff] [blame] | 228 | mbedtls_threading_mutex_t mutex; |
| 229 | #endif |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 230 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 231 | mbedtls_ctr_drbg_context; |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 232 | |
| 233 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 234 | * \brief This function initializes the CTR_DRBG context, |
| 235 | * and prepares it for mbedtls_ctr_drbg_seed() |
| 236 | * or mbedtls_ctr_drbg_free(). |
Manuel Pégourié-Gonnard | 8d128ef | 2015-04-28 22:38:08 +0200 | [diff] [blame] | 237 | * |
Gavin Acquroff | 77cb30c | 2020-03-01 17:06:11 -0800 | [diff] [blame] | 238 | * \note The reseed interval is |
| 239 | * #MBEDTLS_CTR_DRBG_RESEED_INTERVAL by default. |
| 240 | * You can override it by calling |
| 241 | * mbedtls_ctr_drbg_set_reseed_interval(). |
| 242 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 243 | * \param ctx The CTR_DRBG context to initialize. |
Manuel Pégourié-Gonnard | 8d128ef | 2015-04-28 22:38:08 +0200 | [diff] [blame] | 244 | */ |
| 245 | void mbedtls_ctr_drbg_init( mbedtls_ctr_drbg_context *ctx ); |
| 246 | |
| 247 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 248 | * \brief This function seeds and sets up the CTR_DRBG |
| 249 | * entropy source for future reseeds. |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 250 | * |
Gilles Peskine | 1eb7ba7 | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 251 | * A typical choice for the \p f_entropy and \p p_entropy parameters is |
| 252 | * to use the entropy module: |
| 253 | * - \p f_entropy is mbedtls_entropy_func(); |
| 254 | * - \p p_entropy is an instance of ::mbedtls_entropy_context initialized |
| 255 | * with mbedtls_entropy_init() (which registers the platform's default |
| 256 | * entropy sources). |
| 257 | * |
Gilles Peskine | 912ffe4 | 2019-10-04 12:15:55 +0200 | [diff] [blame] | 258 | * The entropy length is #MBEDTLS_CTR_DRBG_ENTROPY_LEN by default. |
| 259 | * You can override it by calling mbedtls_ctr_drbg_set_entropy_len(). |
Gilles Peskine | 0bf49eb | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 260 | * |
Gilles Peskine | 9fb4518 | 2019-10-01 18:39:45 +0200 | [diff] [blame] | 261 | * You can provide a personalization string in addition to the |
Gilles Peskine | 1eb7ba7 | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 262 | * entropy source, to make this instantiation as unique as possible. |
| 263 | * |
| 264 | * \note The _seed_material_ value passed to the derivation |
| 265 | * function in the CTR_DRBG Instantiate Process |
| 266 | * described in NIST SP 800-90A §10.2.1.3.2 |
| 267 | * is the concatenation of the string obtained from |
| 268 | * calling \p f_entropy and the \p custom string. |
| 269 | * The origin of the nonce depends on the value of |
| 270 | * the entropy length relative to the security strength. |
Gilles Peskine | 1eb7ba7 | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 271 | * - If the entropy length is at least 1.5 times the |
| 272 | * security strength then the nonce is taken from the |
| 273 | * string obtained with \p f_entropy. |
| 274 | * - If the entropy length is less than the security |
| 275 | * strength, then the nonce is taken from \p custom. |
| 276 | * In this case, for compliance with SP 800-90A, |
| 277 | * you must pass a unique value of \p custom at |
| 278 | * each invocation. See SP 800-90A §8.6.7 for more |
| 279 | * details. |
Gilles Peskine | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 280 | */ |
| 281 | #if MBEDTLS_CTR_DRBG_ENTROPY_LEN < MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2 |
| 282 | /** \warning When #MBEDTLS_CTR_DRBG_ENTROPY_LEN is less than |
| 283 | * #MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2, to achieve the |
| 284 | * maximum security strength permitted by CTR_DRBG, |
| 285 | * you must pass a value of \p custom that is a nonce: |
| 286 | * this value must never be repeated in subsequent |
| 287 | * runs of the same application or on a different |
| 288 | * device. |
| 289 | */ |
| 290 | #endif |
Gilles Peskine | 8319569 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 291 | #if defined(MBEDTLS_THREADING_C) |
| 292 | /** |
| 293 | * \note When Mbed TLS is built with threading support, |
| 294 | * after this function returns successfully, |
| 295 | * it is safe to call mbedtls_ctr_drbg_random() |
| 296 | * from multiple threads. Other operations, including |
| 297 | * reseeding, are not thread-safe. |
| 298 | */ |
| 299 | #endif /* MBEDTLS_THREADING_C */ |
Gilles Peskine | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 300 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 301 | * \param ctx The CTR_DRBG context to seed. |
Gilles Peskine | b02a233 | 2019-10-28 17:33:07 +0100 | [diff] [blame] | 302 | * It must have been initialized with |
| 303 | * mbedtls_ctr_drbg_init(). |
| 304 | * After a successful call to mbedtls_ctr_drbg_seed(), |
| 305 | * you may not call mbedtls_ctr_drbg_seed() again on |
| 306 | * the same context unless you call |
| 307 | * mbedtls_ctr_drbg_free() and mbedtls_ctr_drbg_init() |
| 308 | * again first. |
Gilles Peskine | 8319569 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 309 | * After a failed call to mbedtls_ctr_drbg_seed(), |
| 310 | * you must call mbedtls_ctr_drbg_free(). |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 311 | * \param f_entropy The entropy callback, taking as arguments the |
| 312 | * \p p_entropy context, the buffer to fill, and the |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 313 | * length of the buffer. |
Gilles Peskine | 912ffe4 | 2019-10-04 12:15:55 +0200 | [diff] [blame] | 314 | * \p f_entropy is always called with a buffer size |
| 315 | * equal to the entropy length. |
Gilles Peskine | 0bf49eb | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 316 | * \param p_entropy The entropy context to pass to \p f_entropy. |
Gilles Peskine | 9fb4518 | 2019-10-01 18:39:45 +0200 | [diff] [blame] | 317 | * \param custom The personalization string. |
| 318 | * This can be \c NULL, in which case the personalization |
| 319 | * string is empty regardless of the value of \p len. |
| 320 | * \param len The length of the personalization string. |
Gilles Peskine | 80b3f4b | 2019-09-24 14:48:30 +0200 | [diff] [blame] | 321 | * This must be at most |
Gilles Peskine | e215a4d | 2019-10-03 15:13:08 +0200 | [diff] [blame] | 322 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT |
| 323 | * - #MBEDTLS_CTR_DRBG_ENTROPY_LEN. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 324 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 325 | * \return \c 0 on success. |
| 326 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 327 | */ |
Manuel Pégourié-Gonnard | 8d128ef | 2015-04-28 22:38:08 +0200 | [diff] [blame] | 328 | int mbedtls_ctr_drbg_seed( mbedtls_ctr_drbg_context *ctx, |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 329 | int (*f_entropy)(void *, unsigned char *, size_t), |
| 330 | void *p_entropy, |
Paul Bakker | 1bc9efc | 2011-12-03 11:29:32 +0000 | [diff] [blame] | 331 | const unsigned char *custom, |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 332 | size_t len ); |
| 333 | |
| 334 | /** |
Gavin Acquroff | 77cb30c | 2020-03-01 17:06:11 -0800 | [diff] [blame] | 335 | * \brief This function resets CTR_DRBG context to the state immediately |
| 336 | * after initial call of mbedtls_ctr_drbg_init(). |
Paul Bakker | fff0366 | 2014-06-18 16:21:25 +0200 | [diff] [blame] | 337 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 338 | * \param ctx The CTR_DRBG context to clear. |
Paul Bakker | fff0366 | 2014-06-18 16:21:25 +0200 | [diff] [blame] | 339 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 340 | void mbedtls_ctr_drbg_free( mbedtls_ctr_drbg_context *ctx ); |
Paul Bakker | fff0366 | 2014-06-18 16:21:25 +0200 | [diff] [blame] | 341 | |
| 342 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 343 | * \brief This function turns prediction resistance on or off. |
| 344 | * The default value is off. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 345 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 346 | * \note If enabled, entropy is gathered at the beginning of |
Gilles Peskine | 0bf49eb | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 347 | * every call to mbedtls_ctr_drbg_random_with_add() |
| 348 | * or mbedtls_ctr_drbg_random(). |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 349 | * Only use this if your entropy source has sufficient |
| 350 | * throughput. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 351 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 352 | * \param ctx The CTR_DRBG context. |
| 353 | * \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] | 354 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 355 | void mbedtls_ctr_drbg_set_prediction_resistance( mbedtls_ctr_drbg_context *ctx, |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 356 | int resistance ); |
| 357 | |
| 358 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 359 | * \brief This function sets the amount of entropy grabbed on each |
Gilles Peskine | 912ffe4 | 2019-10-04 12:15:55 +0200 | [diff] [blame] | 360 | * seed or reseed. |
Gilles Peskine | 0bf49eb | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 361 | * |
| 362 | * The default value is #MBEDTLS_CTR_DRBG_ENTROPY_LEN. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 363 | * |
Gilles Peskine | cc74872 | 2019-10-03 14:22:04 +0200 | [diff] [blame] | 364 | * \note The security strength of CTR_DRBG is bounded by the |
| 365 | * entropy length. Thus: |
| 366 | * - When using AES-256 |
| 367 | * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled, |
| 368 | * which is the default), |
| 369 | * \p len must be at least 32 (in bytes) |
| 370 | * to achieve a 256-bit strength. |
| 371 | * - When using AES-128 |
| 372 | * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled) |
| 373 | * \p len must be at least 16 (in bytes) |
| 374 | * to achieve a 128-bit strength. |
Gilles Peskine | 1eb7ba7 | 2019-09-24 14:48:53 +0200 | [diff] [blame] | 375 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 376 | * \param ctx The CTR_DRBG context. |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 377 | * \param len The amount of entropy to grab, in bytes. |
Gilles Peskine | 80b3f4b | 2019-09-24 14:48:30 +0200 | [diff] [blame] | 378 | * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 379 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 380 | void mbedtls_ctr_drbg_set_entropy_len( mbedtls_ctr_drbg_context *ctx, |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 381 | size_t len ); |
| 382 | |
| 383 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 384 | * \brief This function sets the reseed interval. |
Gilles Peskine | 0bf49eb | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 385 | * |
| 386 | * The reseed interval is the number of calls to mbedtls_ctr_drbg_random() |
| 387 | * or mbedtls_ctr_drbg_random_with_add() after which the entropy function |
| 388 | * is called again. |
| 389 | * |
| 390 | * The default value is #MBEDTLS_CTR_DRBG_RESEED_INTERVAL. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 391 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 392 | * \param ctx The CTR_DRBG context. |
| 393 | * \param interval The reseed interval. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 394 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 395 | void mbedtls_ctr_drbg_set_reseed_interval( mbedtls_ctr_drbg_context *ctx, |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 396 | int interval ); |
| 397 | |
| 398 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 399 | * \brief This function reseeds the CTR_DRBG context, that is |
| 400 | * extracts data from the entropy source. |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 401 | * |
Gilles Peskine | 8319569 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 402 | * \note This function is not thread-safe. It is not safe |
| 403 | * to call this function if another thread might be |
| 404 | * concurrently obtaining random numbers from the same |
| 405 | * context or updating or reseeding the same context. |
| 406 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 407 | * \param ctx The CTR_DRBG context. |
Gilles Peskine | 759c91d | 2019-10-01 18:30:02 +0200 | [diff] [blame] | 408 | * \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] | 409 | * \param len The length of the additional data. |
Gilles Peskine | 80b3f4b | 2019-09-24 14:48:30 +0200 | [diff] [blame] | 410 | * This must be less than |
| 411 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len |
| 412 | * where \c entropy_len is the entropy length |
| 413 | * configured for the context. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 414 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 415 | * \return \c 0 on success. |
| 416 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 417 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 418 | int mbedtls_ctr_drbg_reseed( mbedtls_ctr_drbg_context *ctx, |
Paul Bakker | 1bc9efc | 2011-12-03 11:29:32 +0000 | [diff] [blame] | 419 | const unsigned char *additional, size_t len ); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 420 | |
| 421 | /** |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 422 | * \brief This function updates the state of the CTR_DRBG context. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 423 | * |
Gilles Peskine | 8319569 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 424 | * \note This function is not thread-safe. It is not safe |
| 425 | * to call this function if another thread might be |
| 426 | * concurrently obtaining random numbers from the same |
| 427 | * context or updating or reseeding the same context. |
| 428 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 429 | * \param ctx The CTR_DRBG context. |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 430 | * \param additional The data to update the state with. This must not be |
Gilles Peskine | 759c91d | 2019-10-01 18:30:02 +0200 | [diff] [blame] | 431 | * \c NULL unless \p add_len is \c 0. |
Gilles Peskine | c4a8017 | 2018-09-12 19:15:53 +0200 | [diff] [blame] | 432 | * \param add_len Length of \p additional in bytes. This must be at |
| 433 | * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT. |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 434 | * |
Gilles Peskine | d919993 | 2018-09-11 16:41:54 +0200 | [diff] [blame] | 435 | * \return \c 0 on success. |
Gilles Peskine | c4a8017 | 2018-09-12 19:15:53 +0200 | [diff] [blame] | 436 | * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if |
| 437 | * \p add_len is more than |
| 438 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT. |
Gilles Peskine | d919993 | 2018-09-11 16:41:54 +0200 | [diff] [blame] | 439 | * \return An error from the underlying AES cipher on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 440 | */ |
Gilles Peskine | d919993 | 2018-09-11 16:41:54 +0200 | [diff] [blame] | 441 | int mbedtls_ctr_drbg_update_ret( mbedtls_ctr_drbg_context *ctx, |
| 442 | const unsigned char *additional, |
| 443 | size_t add_len ); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 444 | |
| 445 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 446 | * \brief This function updates a CTR_DRBG instance with additional |
| 447 | * data and uses it to generate random data. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 448 | * |
Gilles Peskine | 3f9c973 | 2019-10-01 18:31:28 +0200 | [diff] [blame] | 449 | * This function automatically reseeds if the reseed counter is exceeded |
| 450 | * or prediction resistance is enabled. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 451 | * |
Gilles Peskine | 8319569 | 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 | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 457 | * \param p_rng The CTR_DRBG context. This must be a pointer to a |
| 458 | * #mbedtls_ctr_drbg_context structure. |
| 459 | * \param output The buffer to fill. |
Gilles Peskine | 0bf49eb | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 460 | * \param output_len The length of the buffer in bytes. |
Gilles Peskine | 759c91d | 2019-10-01 18:30:02 +0200 | [diff] [blame] | 461 | * \param additional Additional data to update. Can be \c NULL, in which |
Gilles Peskine | 6b2c50c | 2019-09-24 14:40:40 +0200 | [diff] [blame] | 462 | * case the additional data is empty regardless of |
| 463 | * the value of \p add_len. |
| 464 | * \param add_len The length of the additional data |
Gilles Peskine | 759c91d | 2019-10-01 18:30:02 +0200 | [diff] [blame] | 465 | * if \p additional is not \c NULL. |
Gilles Peskine | 80b3f4b | 2019-09-24 14:48:30 +0200 | [diff] [blame] | 466 | * This must be less than #MBEDTLS_CTR_DRBG_MAX_INPUT |
| 467 | * and less than |
| 468 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len |
| 469 | * where \c entropy_len is the entropy length |
| 470 | * configured for the context. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 471 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 472 | * \return \c 0 on success. |
| 473 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 474 | * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 475 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 476 | int mbedtls_ctr_drbg_random_with_add( void *p_rng, |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 477 | unsigned char *output, size_t output_len, |
Paul Bakker | 1bc9efc | 2011-12-03 11:29:32 +0000 | [diff] [blame] | 478 | const unsigned char *additional, size_t add_len ); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 479 | |
| 480 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 481 | * \brief This function uses CTR_DRBG to generate random data. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 482 | * |
Gilles Peskine | 3f9c973 | 2019-10-01 18:31:28 +0200 | [diff] [blame] | 483 | * This function automatically reseeds if the reseed counter is exceeded |
| 484 | * or prediction resistance is enabled. |
Gilles Peskine | 8319569 | 2021-02-09 18:44:18 +0100 | [diff] [blame] | 485 | */ |
| 486 | #if defined(MBEDTLS_THREADING_C) |
| 487 | /** |
| 488 | * \note When Mbed TLS is built with threading support, |
| 489 | * it is safe to call mbedtls_ctr_drbg_random() |
| 490 | * from multiple threads. Other operations, including |
| 491 | * reseeding, are not thread-safe. |
| 492 | */ |
| 493 | #endif /* MBEDTLS_THREADING_C */ |
| 494 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 495 | * \param p_rng The CTR_DRBG context. This must be a pointer to a |
| 496 | * #mbedtls_ctr_drbg_context structure. |
| 497 | * \param output The buffer to fill. |
Gilles Peskine | e3d8cf1 | 2019-10-02 19:02:13 +0200 | [diff] [blame] | 498 | * \param output_len The length of the buffer in bytes. |
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 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 504 | int mbedtls_ctr_drbg_random( void *p_rng, |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 505 | unsigned char *output, size_t output_len ); |
| 506 | |
Gilles Peskine | d919993 | 2018-09-11 16:41:54 +0200 | [diff] [blame] | 507 | |
| 508 | #if ! defined(MBEDTLS_DEPRECATED_REMOVED) |
| 509 | #if defined(MBEDTLS_DEPRECATED_WARNING) |
| 510 | #define MBEDTLS_DEPRECATED __attribute__((deprecated)) |
| 511 | #else |
| 512 | #define MBEDTLS_DEPRECATED |
| 513 | #endif |
| 514 | /** |
| 515 | * \brief This function updates the state of the CTR_DRBG context. |
| 516 | * |
| 517 | * \deprecated Superseded by mbedtls_ctr_drbg_update_ret() |
| 518 | * in 2.16.0. |
| 519 | * |
| 520 | * \note If \p add_len is greater than |
| 521 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT, only the first |
| 522 | * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT Bytes are used. |
| 523 | * The remaining Bytes are silently discarded. |
| 524 | * |
| 525 | * \param ctx The CTR_DRBG context. |
| 526 | * \param additional The data to update the state with. |
| 527 | * \param add_len Length of \p additional data. |
| 528 | */ |
| 529 | MBEDTLS_DEPRECATED void mbedtls_ctr_drbg_update( |
| 530 | mbedtls_ctr_drbg_context *ctx, |
| 531 | const unsigned char *additional, |
| 532 | size_t add_len ); |
| 533 | #undef MBEDTLS_DEPRECATED |
| 534 | #endif /* !MBEDTLS_DEPRECATED_REMOVED */ |
| 535 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 536 | #if defined(MBEDTLS_FS_IO) |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 537 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 538 | * \brief This function writes a seed file. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 539 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 540 | * \param ctx The CTR_DRBG context. |
| 541 | * \param path The name of the file. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 542 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 543 | * \return \c 0 on success. |
Rose Zadik | f25eb6e | 2018-04-16 14:51:52 +0100 | [diff] [blame] | 544 | * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error. |
Gilles Peskine | 0bf49eb | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 545 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 546 | * failure. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 547 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 548 | 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] | 549 | |
| 550 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 551 | * \brief This function reads and updates a seed file. The seed |
| 552 | * is added to this instance. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 553 | * |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 554 | * \param ctx The CTR_DRBG context. |
| 555 | * \param path The name of the file. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 556 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 557 | * \return \c 0 on success. |
| 558 | * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error. |
Gilles Peskine | 0bf49eb | 2019-09-30 15:01:02 +0200 | [diff] [blame] | 559 | * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on |
| 560 | * reseed failure. |
| 561 | * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if the existing |
| 562 | * seed file is too large. |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 563 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 564 | int mbedtls_ctr_drbg_update_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path ); |
| 565 | #endif /* MBEDTLS_FS_IO */ |
Paul Bakker | fc754a9 | 2011-12-05 13:23:51 +0000 | [diff] [blame] | 566 | |
Ron Eldor | fa8f635 | 2017-06-20 15:48:46 +0300 | [diff] [blame] | 567 | #if defined(MBEDTLS_SELF_TEST) |
| 568 | |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 569 | /** |
Rose Zadik | 2f8163d | 2018-01-25 21:55:14 +0000 | [diff] [blame] | 570 | * \brief The CTR_DRBG checkup routine. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 571 | * |
Rose Zadik | c9474eb | 2018-03-27 10:58:22 +0100 | [diff] [blame] | 572 | * \return \c 0 on success. |
| 573 | * \return \c 1 on failure. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 574 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 575 | int mbedtls_ctr_drbg_self_test( int verbose ); |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 576 | |
Ron Eldor | fa8f635 | 2017-06-20 15:48:46 +0300 | [diff] [blame] | 577 | #endif /* MBEDTLS_SELF_TEST */ |
| 578 | |
Paul Bakker | 534f82c | 2013-06-25 16:47:55 +0200 | [diff] [blame] | 579 | /* Internal functions (do not call directly) */ |
Manuel Pégourié-Gonnard | 8d128ef | 2015-04-28 22:38:08 +0200 | [diff] [blame] | 580 | int mbedtls_ctr_drbg_seed_entropy_len( mbedtls_ctr_drbg_context *, |
Paul Bakker | b9e4e2c | 2014-05-01 14:18:25 +0200 | [diff] [blame] | 581 | int (*)(void *, unsigned char *, size_t), void *, |
| 582 | const unsigned char *, size_t, size_t ); |
Paul Bakker | 534f82c | 2013-06-25 16:47:55 +0200 | [diff] [blame] | 583 | |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 584 | #ifdef __cplusplus |
| 585 | } |
| 586 | #endif |
| 587 | |
| 588 | #endif /* ctr_drbg.h */ |