blob: c00756df1b6885d1f77e94b0f34f7d28c5e97170 [file] [log] [blame]
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001/**
2 * \file ctr_drbg.h
3 *
Gilles Peskineec51dd12019-09-30 15:01:02 +02004 * \brief This file contains definitions and functions for the
5 * CTR_DRBG pseudorandom generator.
Rose Zadikc9474eb2018-03-27 10:58:22 +01006 *
Rose Zadikf25eb6e2018-04-16 14:51:52 +01007 * 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 Zadik2f8163d2018-01-25 21:55:14 +000011 *
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +030012 * The Mbed TLS implementation of CTR_DRBG uses AES-256 (default) or AES-128
Gilles Peskined0c64c82019-10-03 14:20:46 +020013 * (if \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled at compile time)
Gilles Peskinedddda812019-10-03 14:22:04 +020014 * as the underlying block cipher, with a derivation function.
Gilles Peskinedddda812019-10-03 14:22:04 +020015 *
Gilles Peskinee9a34542019-10-22 20:43:24 +020016 * 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útibb0cfeb2021-05-28 09:42:25 +020019 * kept at its default value (and not overridden in mbedtls_config.h) and that the
Gilles Peskinee9a34542019-10-22 20:43:24 +020020 * DRBG instance is set up with default parameters.
21 * See the documentation of mbedtls_ctr_drbg_seed() for more
22 * information.
Darryl Greena40a1012018-01-05 15:33:17 +000023 */
24/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020025 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000026 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker0e04d0e2011-11-27 14:46:59 +000027 */
Rose Zadik2f8163d2018-01-25 21:55:14 +000028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#ifndef MBEDTLS_CTR_DRBG_H
30#define MBEDTLS_CTR_DRBG_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020031#include "mbedtls/private_access.h"
Paul Bakker0e04d0e2011-11-27 14:46:59 +000032
Bence Szépkútic662b362021-05-27 11:25:03 +020033#include "mbedtls/build_info.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050034
Valerio Setti5f4b28d2023-11-13 10:18:16 +010035/* 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 Ameroc49fbbf2019-07-04 20:01:14 +010038#include "mbedtls/aes.h"
Valerio Setti5f4b28d2023-11-13 10:18:16 +010039#else
40#include "psa/crypto.h"
41#endif
42
Manuel Pégourié-Gonnard4011eb42023-03-21 17:10:45 +010043#include "entropy.h"
Paul Bakker0e04d0e2011-11-27 14:46:59 +000044
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010045#if defined(MBEDTLS_THREADING_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010046#include "mbedtls/threading.h"
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010047#endif
48
Gilles Peskined2971572021-07-26 18:48:10 +020049/** 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 Bakker0e04d0e2011-11-27 14:46:59 +000057
Rose Zadik2f8163d2018-01-25 21:55:14 +000058#define MBEDTLS_CTR_DRBG_BLOCKSIZE 16 /**< The block size used by the cipher. */
Nir Sonnenscheince266e42018-08-29 10:11:46 +030059
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030060#if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
Gilles Peskine08875d42019-09-24 14:40:40 +020061#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 Peskined0c64c82019-10-03 14:20:46 +020065 * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020066 */
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +030067#else
Gilles Peskine08875d42019-09-24 14:40:40 +020068#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 Peskined0c64c82019-10-03 14:20:46 +020072 * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020073 */
Nir Sonnenscheina4588d42018-07-30 16:59:36 +030074#endif
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030075
Gilles Peskine449bd832023-01-11 14:50:10 +010076#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 Bakker9bcf16c2013-06-24 19:31:17 +020078
Paul Bakker088c5c52014-04-25 11:11:10 +020079/**
80 * \name SECTION: Module settings
81 *
82 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020083 * Either change them in mbedtls_config.h or define them using the compiler command
Rose Zadik2f8163d2018-01-25 21:55:14 +000084 * line.
Paul Bakker088c5c52014-04-25 11:11:10 +020085 * \{
86 */
87
Gilles Peskinedddda812019-10-03 14:22:04 +020088/** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN
89 *
90 * \brief The amount of entropy used per seed by default, in bytes.
91 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092#if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
Manuel Pégourié-Gonnard4011eb42023-03-21 17:10:45 +010093#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
94/** This is 48 bytes because the entropy module uses SHA-512.
Gilles Peskine08875d42019-09-24 14:40:40 +020095 */
Rose Zadik2f8163d2018-01-25 21:55:14 +000096#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Gilles Peskinedddda812019-10-03 14:22:04 +020097
Manuel Pégourié-Gonnard4011eb42023-03-21 17:10:45 +010098#else /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Gilles Peskinedddda812019-10-03 14:22:04 +020099
Manuel Pégourié-Gonnard4011eb42023-03-21 17:10:45 +0100100/** This is 32 bytes because the entropy module uses SHA-256.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000101 */
Gilles Peskinedddda812019-10-03 14:22:04 +0200102#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 Peskine08875d42019-09-24 14:40:40 +0200107#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
Manuel Pégourié-Gonnard4011eb42023-03-21 17:10:45 +0100108#endif /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Gilles Peskinedddda812019-10-03 14:22:04 +0200109#endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200111#if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000112#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
113/**< The interval before reseed is performed by default. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200114#endif
115
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200116#if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000117#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
118/**< The maximum number of additional input Bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200119#endif
120
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200121#if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000122#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
123/**< The maximum number of requested Bytes per call. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200124#endif
125
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126#if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000127#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Gilles Peskine08875d42019-09-24 14:40:40 +0200128/**< The maximum size of seed or reseed buffer in bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200129#endif
130
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100131/** \} name SECTION: Module settings */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000132
Rose Zadik2f8163d2018-01-25 21:55:14 +0000133#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 Bakker0e04d0e2011-11-27 14:46:59 +0000137
138#ifdef __cplusplus
139extern "C" {
140#endif
141
Gilles Peskine69971662019-10-23 19:39:36 +0200142#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 Peskine449bd832023-01-11 14:50:10 +0100157#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN (MBEDTLS_CTR_DRBG_ENTROPY_LEN + 1) / 2
Gilles Peskine69971662019-10-23 19:39:36 +0200158#endif
159
Valerio Setti5f4b28d2023-11-13 10:18:16 +0100160#if !defined(MBEDTLS_AES_C)
161typedef 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 Bakker0e04d0e2011-11-27 14:46:59 +0000167/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000168 * \brief The CTR_DRBG context structure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000169 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100170typedef struct mbedtls_ctr_drbg_context {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200171 unsigned char MBEDTLS_PRIVATE(counter)[16]; /*!< The counter (V). */
172 int MBEDTLS_PRIVATE(reseed_counter); /*!< The reseed counter.
Gilles Peskine449bd832023-01-11 14:50:10 +0100173 * 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 Starzyk846f0212021-05-19 19:44:07 +0200182 int MBEDTLS_PRIVATE(prediction_resistance); /*!< This determines whether prediction
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 resistance is enabled, that is
184 whether to systematically reseed before
185 each random generation. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200186 size_t MBEDTLS_PRIVATE(entropy_len); /*!< The amount of entropy grabbed on each
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 seed or reseed operation, in bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200188 int MBEDTLS_PRIVATE(reseed_interval); /*!< The reseed interval.
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 * This is the maximum number of requests
190 * that can be made between reseedings. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000191
Valerio Setti5f4b28d2023-11-13 10:18:16 +0100192#if defined(MBEDTLS_AES_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200193 mbedtls_aes_context MBEDTLS_PRIVATE(aes_ctx); /*!< The AES context. */
Valerio Setti5f4b28d2023-11-13 10:18:16 +0100194#else
195 mbedtls_ctr_drbg_psa_context MBEDTLS_PRIVATE(psa_ctx); /*!< The PSA context. */
196#endif
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000197
198 /*
199 * Callbacks (Entropy)
200 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 int(*MBEDTLS_PRIVATE(f_entropy))(void *, unsigned char *, size_t);
202 /*!< The entropy callback function. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000203
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200204 void *MBEDTLS_PRIVATE(p_entropy); /*!< The context for the entropy function. */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100205
206#if defined(MBEDTLS_THREADING_C)
Gilles Peskineda290f92021-02-09 18:44:02 +0100207 /* 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 Starzyk846f0212021-05-19 19:44:07 +0200214 mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100215#endif
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000216}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217mbedtls_ctr_drbg_context;
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000218
219/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000220 * \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é-Gonnard8d128ef2015-04-28 22:38:08 +0200223 *
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800224 * \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 Zadik2f8163d2018-01-25 21:55:14 +0000229 * \param ctx The CTR_DRBG context to initialize.
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200230 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100231void mbedtls_ctr_drbg_init(mbedtls_ctr_drbg_context *ctx);
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200232
233/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000234 * \brief This function seeds and sets up the CTR_DRBG
235 * entropy source for future reseeds.
Paul Bakker9af723c2014-05-01 13:03:14 +0200236 *
Gilles Peskine223deea2019-09-24 14:48:53 +0200237 * 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 Peskine50ed86b2019-10-04 12:15:55 +0200244 * 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 Peskineec51dd12019-09-30 15:01:02 +0200246 *
Gilles Peskinee9a34542019-10-22 20:43:24 +0200247 * 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 Peskine69971662019-10-23 19:39:36 +0200253 * With the default entropy length, the entropy nonce length is
254 * #MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN.
255 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200256 * You can provide a nonce and personalization string in addition to the
Gilles Peskine223deea2019-09-24 14:48:53 +0200257 * entropy source, to make this instantiation as unique as possible.
Gilles Peskine9be50982019-10-22 18:42:27 +0200258 * See SP 800-90A §8.6.7 for more details about nonces.
Gilles Peskine223deea2019-09-24 14:48:53 +0200259 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200260 * 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 Peskinee9a34542019-10-22 20:43:24 +0200265 */
Gilles Peskine69971662019-10-23 19:39:36 +0200266#if MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN == 0
Gilles Peskinee9a34542019-10-22 20:43:24 +0200267/**
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 Peskinef305d922021-02-09 18:44:18 +0100278#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 Peskinee9a34542019-10-22 20:43:24 +0200287/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200288 * - 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 Peskinee9a34542019-10-22 20:43:24 +0200299 * and the entropy nonce length must be:
Gilles Peskine9be50982019-10-22 18:42:27 +0200300 * - 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 Zadik2f8163d2018-01-25 21:55:14 +0000305 * \param ctx The CTR_DRBG context to seed.
Gilles Peskinebd326f92019-10-28 17:33:07 +0100306 * 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 Peskinef305d922021-02-09 18:44:18 +0100313 * After a failed call to mbedtls_ctr_drbg_seed(),
314 * you must call mbedtls_ctr_drbg_free().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000315 * \param f_entropy The entropy callback, taking as arguments the
316 * \p p_entropy context, the buffer to fill, and the
Gilles Peskine08875d42019-09-24 14:40:40 +0200317 * length of the buffer.
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200318 * \p f_entropy is always called with a buffer size
Gilles Peskine9be50982019-10-22 18:42:27 +0200319 * less than or equal to the entropy length.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200320 * \param p_entropy The entropy context to pass to \p f_entropy.
Gilles Peskine217b8152019-10-01 18:39:45 +0200321 * \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 Peskine944bc582019-09-24 14:48:30 +0200325 * This must be at most
326 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
327 * - #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000328 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100329 * \return \c 0 on success.
330 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000331 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100332int 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 Bakker0e04d0e2011-11-27 14:46:59 +0000337
338/**
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800339 * \brief This function resets CTR_DRBG context to the state immediately
340 * after initial call of mbedtls_ctr_drbg_init().
Paul Bakkerfff03662014-06-18 16:21:25 +0200341 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000342 * \param ctx The CTR_DRBG context to clear.
Paul Bakkerfff03662014-06-18 16:21:25 +0200343 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100344void mbedtls_ctr_drbg_free(mbedtls_ctr_drbg_context *ctx);
Paul Bakkerfff03662014-06-18 16:21:25 +0200345
346/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000347 * \brief This function turns prediction resistance on or off.
348 * The default value is off.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000349 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000350 * \note If enabled, entropy is gathered at the beginning of
Gilles Peskineec51dd12019-09-30 15:01:02 +0200351 * every call to mbedtls_ctr_drbg_random_with_add()
352 * or mbedtls_ctr_drbg_random().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000353 * Only use this if your entropy source has sufficient
354 * throughput.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000355 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000356 * \param ctx The CTR_DRBG context.
357 * \param resistance #MBEDTLS_CTR_DRBG_PR_ON or #MBEDTLS_CTR_DRBG_PR_OFF.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000358 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100359void mbedtls_ctr_drbg_set_prediction_resistance(mbedtls_ctr_drbg_context *ctx,
360 int resistance);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000361
362/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000363 * \brief This function sets the amount of entropy grabbed on each
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200364 * seed or reseed.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200365 *
366 * The default value is #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000367 *
Gilles Peskinedddda812019-10-03 14:22:04 +0200368 * \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 Peskine223deea2019-09-24 14:48:53 +0200379 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000380 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200381 * \param len The amount of entropy to grab, in bytes.
Gilles Peskine9be50982019-10-22 18:42:27 +0200382 * 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 Bakker0e04d0e2011-11-27 14:46:59 +0000385 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100386void mbedtls_ctr_drbg_set_entropy_len(mbedtls_ctr_drbg_context *ctx,
387 size_t len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000388
389/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200390 * \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 Peskine449bd832023-01-11 14:50:10 +0100408int mbedtls_ctr_drbg_set_nonce_len(mbedtls_ctr_drbg_context *ctx,
409 size_t len);
Gilles Peskine9be50982019-10-22 18:42:27 +0200410
411/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000412 * \brief This function sets the reseed interval.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200413 *
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 Bakker0e04d0e2011-11-27 14:46:59 +0000419 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000420 * \param ctx The CTR_DRBG context.
421 * \param interval The reseed interval.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000422 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100423void mbedtls_ctr_drbg_set_reseed_interval(mbedtls_ctr_drbg_context *ctx,
424 int interval);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000425
426/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000427 * \brief This function reseeds the CTR_DRBG context, that is
428 * extracts data from the entropy source.
Paul Bakker9af723c2014-05-01 13:03:14 +0200429 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100430 * \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 Zadik2f8163d2018-01-25 21:55:14 +0000435 * \param ctx The CTR_DRBG context.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200436 * \param additional Additional data to add to the state. Can be \c NULL.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000437 * \param len The length of the additional data.
Gilles Peskine944bc582019-09-24 14:48:30 +0200438 * 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 Bakker0e04d0e2011-11-27 14:46:59 +0000442 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100443 * \return \c 0 on success.
444 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000445 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100446int mbedtls_ctr_drbg_reseed(mbedtls_ctr_drbg_context *ctx,
447 const unsigned char *additional, size_t len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000448
449/**
Rose Zadikc9474eb2018-03-27 10:58:22 +0100450 * \brief This function updates the state of the CTR_DRBG context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000451 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100452 * \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 Zadikc9474eb2018-03-27 10:58:22 +0100457 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200458 * \param additional The data to update the state with. This must not be
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200459 * \c NULL unless \p add_len is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500460 * \param add_len Length of \p additional in bytes. This must be at
461 * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Rose Zadikc9474eb2018-03-27 10:58:22 +0100462 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500463 * \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 Bakker0e04d0e2011-11-27 14:46:59 +0000468 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100469int mbedtls_ctr_drbg_update(mbedtls_ctr_drbg_context *ctx,
470 const unsigned char *additional,
471 size_t add_len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000472
473/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000474 * \brief This function updates a CTR_DRBG instance with additional
475 * data and uses it to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000476 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200477 * This function automatically reseeds if the reseed counter is exceeded
478 * or prediction resistance is enabled.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000479 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100480 * \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 Zadik2f8163d2018-01-25 21:55:14 +0000485 * \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 Peskineec51dd12019-09-30 15:01:02 +0200488 * \param output_len The length of the buffer in bytes.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200489 * \param additional Additional data to update. Can be \c NULL, in which
Gilles Peskine08875d42019-09-24 14:40:40 +0200490 * 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 Peskine10f16ac2019-10-01 18:30:02 +0200493 * if \p additional is not \c NULL.
Gilles Peskine944bc582019-09-24 14:48:30 +0200494 * 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 Bakker0e04d0e2011-11-27 14:46:59 +0000499 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100500 * \return \c 0 on success.
501 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000502 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000503 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504int 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 Bakker0e04d0e2011-11-27 14:46:59 +0000507
508/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000509 * \brief This function uses CTR_DRBG to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000510 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200511 * This function automatically reseeds if the reseed counter is exceeded
512 * or prediction resistance is enabled.
Gilles Peskinef305d922021-02-09 18:44:18 +0100513 */
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 Zadik2f8163d2018-01-25 21:55:14 +0000523 * \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 Peskine944bc582019-09-24 14:48:30 +0200526 * \param output_len The length of the buffer in bytes.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000527 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100528 * \return \c 0 on success.
529 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000530 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000531 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100532int mbedtls_ctr_drbg_random(void *p_rng,
533 unsigned char *output, size_t output_len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535#if defined(MBEDTLS_FS_IO)
Paul Bakkerfc754a92011-12-05 13:23:51 +0000536/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000537 * \brief This function writes a seed file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000538 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000539 * \param ctx The CTR_DRBG context.
540 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000541 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100542 * \return \c 0 on success.
Rose Zadikf25eb6e2018-04-16 14:51:52 +0100543 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200544 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed
Rose Zadik2f8163d2018-01-25 21:55:14 +0000545 * failure.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000546 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100547int mbedtls_ctr_drbg_write_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path);
Paul Bakkerfc754a92011-12-05 13:23:51 +0000548
549/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000550 * \brief This function reads and updates a seed file. The seed
551 * is added to this instance.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000552 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000553 * \param ctx The CTR_DRBG context.
554 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000555 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100556 * \return \c 0 on success.
557 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200558 * \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 Bakkerfc754a92011-12-05 13:23:51 +0000562 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100563int mbedtls_ctr_drbg_update_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564#endif /* MBEDTLS_FS_IO */
Paul Bakkerfc754a92011-12-05 13:23:51 +0000565
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500566#if defined(MBEDTLS_SELF_TEST)
567
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000568/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000569 * \brief The CTR_DRBG checkup routine.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000570 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100571 * \return \c 0 on success.
572 * \return \c 1 on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000573 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100574int mbedtls_ctr_drbg_self_test(int verbose);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000575
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500576#endif /* MBEDTLS_SELF_TEST */
577
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000578#ifdef __cplusplus
579}
580#endif
581
582#endif /* ctr_drbg.h */