blob: eb72f9ee97c4eb5a47e1b5e999e782da2e72c8a4 [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
19 * kept at its default value (and not overridden in config.h) and that the
20 * 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 Rodgman7ff79652023-11-03 12:04:52 +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
Paul Bakker0e04d0e2011-11-27 14:46:59 +000031
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050032#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010033#include "mbedtls/config.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050034#else
35#include MBEDTLS_CONFIG_FILE
36#endif
37
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010038#include "mbedtls/aes.h"
Paul Bakker0e04d0e2011-11-27 14:46:59 +000039
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010040#if defined(MBEDTLS_THREADING_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010041#include "mbedtls/threading.h"
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010042#endif
43
Gilles Peskinea3974432021-07-26 18:48:10 +020044/** The entropy source failed. */
45#define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034
46/** The requested random buffer length is too big. */
47#define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036
48/** The input (entropy + additional data) is too large. */
49#define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038
50/** Read or write error in file. */
51#define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A
Paul Bakker0e04d0e2011-11-27 14:46:59 +000052
Rose Zadik2f8163d2018-01-25 21:55:14 +000053#define MBEDTLS_CTR_DRBG_BLOCKSIZE 16 /**< The block size used by the cipher. */
Nir Sonnenscheince266e42018-08-29 10:11:46 +030054
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030055#if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
Gilles Peskine08875d42019-09-24 14:40:40 +020056#define MBEDTLS_CTR_DRBG_KEYSIZE 16
57/**< The key size in bytes used by the cipher.
58 *
59 * Compile-time choice: 16 bytes (128 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020060 * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020061 */
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +030062#else
Gilles Peskine08875d42019-09-24 14:40:40 +020063#define MBEDTLS_CTR_DRBG_KEYSIZE 32
64/**< The key size in bytes used by the cipher.
65 *
66 * Compile-time choice: 32 bytes (256 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020067 * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020068 */
Nir Sonnenscheina4588d42018-07-30 16:59:36 +030069#endif
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030070
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010071#define MBEDTLS_CTR_DRBG_KEYBITS (MBEDTLS_CTR_DRBG_KEYSIZE * 8) /**< The key size for the DRBG operation, in bits. */
72#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 +020073
Paul Bakker088c5c52014-04-25 11:11:10 +020074/**
75 * \name SECTION: Module settings
76 *
77 * The configuration options you can set for this module are in this section.
Rose Zadik2f8163d2018-01-25 21:55:14 +000078 * Either change them in config.h or define them using the compiler command
79 * line.
Paul Bakker088c5c52014-04-25 11:11:10 +020080 * \{
81 */
82
Gilles Peskinedddda812019-10-03 14:22:04 +020083/** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN
84 *
85 * \brief The amount of entropy used per seed by default, in bytes.
86 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087#if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
88#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
Gilles Peskinedddda812019-10-03 14:22:04 +020089/** This is 48 bytes because the entropy module uses SHA-512
Gilles Peskined0c64c82019-10-03 14:20:46 +020090 * (\c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled).
Gilles Peskine08875d42019-09-24 14:40:40 +020091 */
Rose Zadik2f8163d2018-01-25 21:55:14 +000092#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Gilles Peskinedddda812019-10-03 14:22:04 +020093
94#else /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
95
96/** This is 32 bytes because the entropy module uses SHA-256
97 * (the SHA512 module is disabled or
98 * \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled).
Rose Zadik2f8163d2018-01-25 21:55:14 +000099 */
Gilles Peskinedddda812019-10-03 14:22:04 +0200100#if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
101/** \warning To achieve a 256-bit security strength, you must pass a nonce
102 * to mbedtls_ctr_drbg_seed().
103 */
104#endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */
Gilles Peskine08875d42019-09-24 14:40:40 +0200105#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
Gilles Peskinedddda812019-10-03 14:22:04 +0200106#endif /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
107#endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109#if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000110#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
111/**< The interval before reseed is performed by default. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200112#endif
113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114#if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000115#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
116/**< The maximum number of additional input Bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200117#endif
118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119#if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000120#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
121/**< The maximum number of requested Bytes per call. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200122#endif
123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200124#if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000125#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Gilles Peskine08875d42019-09-24 14:40:40 +0200126/**< The maximum size of seed or reseed buffer in bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200127#endif
128
Andrzej Kurek73afe272022-01-24 10:31:06 -0500129/** \} name SECTION: Module settings */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000130
Rose Zadik2f8163d2018-01-25 21:55:14 +0000131#define MBEDTLS_CTR_DRBG_PR_OFF 0
132/**< Prediction resistance is disabled. */
133#define MBEDTLS_CTR_DRBG_PR_ON 1
134/**< Prediction resistance is enabled. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000135
136#ifdef __cplusplus
137extern "C" {
138#endif
139
Gilles Peskine69971662019-10-23 19:39:36 +0200140#if MBEDTLS_CTR_DRBG_ENTROPY_LEN >= MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2
141/** The default length of the nonce read from the entropy source.
142 *
143 * This is \c 0 because a single read from the entropy source is sufficient
144 * to include a nonce.
145 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
146 */
147#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN 0
148#else
149/** The default length of the nonce read from the entropy source.
150 *
151 * This is half of the default entropy length because a single read from
152 * the entropy source does not provide enough material to form a nonce.
153 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
154 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100155#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN (MBEDTLS_CTR_DRBG_ENTROPY_LEN + 1) / 2
Gilles Peskine69971662019-10-23 19:39:36 +0200156#endif
157
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000158/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000159 * \brief The CTR_DRBG context structure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000160 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100161typedef struct mbedtls_ctr_drbg_context {
Rose Zadik2f8163d2018-01-25 21:55:14 +0000162 unsigned char counter[16]; /*!< The counter (V). */
Gilles Peskinec0ace352019-10-22 17:06:31 +0200163 int reseed_counter; /*!< The reseed counter.
164 * This is the number of requests that have
165 * been made since the last (re)seeding,
Gilles Peskine9be50982019-10-22 18:42:27 +0200166 * minus one.
167 * Before the initial seeding, this field
168 * contains the amount of entropy in bytes
Jaeden Ameroa15c7132020-01-09 13:02:16 +0000169 * to use as a nonce for the initial seeding,
170 * or -1 if no nonce length has been explicitly
171 * set (see mbedtls_ctr_drbg_set_nonce_len()).
Gilles Peskine9be50982019-10-22 18:42:27 +0200172 */
Rose Zadik2f8163d2018-01-25 21:55:14 +0000173 int prediction_resistance; /*!< This determines whether prediction
174 resistance is enabled, that is
175 whether to systematically reseed before
176 each random generation. */
177 size_t entropy_len; /*!< The amount of entropy grabbed on each
Gilles Peskinec0ace352019-10-22 17:06:31 +0200178 seed or reseed operation, in bytes. */
179 int reseed_interval; /*!< The reseed interval.
180 * This is the maximum number of requests
181 * that can be made between reseedings. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000182
Rose Zadik2f8163d2018-01-25 21:55:14 +0000183 mbedtls_aes_context aes_ctx; /*!< The AES context. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000184
185 /*
186 * Callbacks (Entropy)
187 */
188 int (*f_entropy)(void *, unsigned char *, size_t);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100189 /*!< The entropy callback function. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000190
Rose Zadik2f8163d2018-01-25 21:55:14 +0000191 void *p_entropy; /*!< The context for the entropy function. */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100192
193#if defined(MBEDTLS_THREADING_C)
Gilles Peskineda290f92021-02-09 18:44:02 +0100194 /* Invariant: the mutex is initialized if and only if f_entropy != NULL.
195 * This means that the mutex is initialized during the initial seeding
196 * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free().
197 *
198 * Note that this invariant may change without notice. Do not rely on it
199 * and do not access the mutex directly in application code.
200 */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100201 mbedtls_threading_mutex_t mutex;
202#endif
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000203}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204mbedtls_ctr_drbg_context;
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000205
206/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000207 * \brief This function initializes the CTR_DRBG context,
208 * and prepares it for mbedtls_ctr_drbg_seed()
209 * or mbedtls_ctr_drbg_free().
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200210 *
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800211 * \note The reseed interval is
212 * #MBEDTLS_CTR_DRBG_RESEED_INTERVAL by default.
213 * You can override it by calling
214 * mbedtls_ctr_drbg_set_reseed_interval().
215 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000216 * \param ctx The CTR_DRBG context to initialize.
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200217 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100218void mbedtls_ctr_drbg_init(mbedtls_ctr_drbg_context *ctx);
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200219
220/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000221 * \brief This function seeds and sets up the CTR_DRBG
222 * entropy source for future reseeds.
Paul Bakker9af723c2014-05-01 13:03:14 +0200223 *
Gilles Peskine223deea2019-09-24 14:48:53 +0200224 * A typical choice for the \p f_entropy and \p p_entropy parameters is
225 * to use the entropy module:
226 * - \p f_entropy is mbedtls_entropy_func();
227 * - \p p_entropy is an instance of ::mbedtls_entropy_context initialized
228 * with mbedtls_entropy_init() (which registers the platform's default
229 * entropy sources).
230 *
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200231 * The entropy length is #MBEDTLS_CTR_DRBG_ENTROPY_LEN by default.
232 * You can override it by calling mbedtls_ctr_drbg_set_entropy_len().
Gilles Peskineec51dd12019-09-30 15:01:02 +0200233 *
Gilles Peskinee9a34542019-10-22 20:43:24 +0200234 * The entropy nonce length is:
235 * - \c 0 if the entropy length is at least 3/2 times the entropy length,
236 * which guarantees that the security strength is the maximum permitted
237 * by the key size and entropy length according to NIST SP 800-90A §10.2.1;
238 * - Half the entropy length otherwise.
239 * You can override it by calling mbedtls_ctr_drbg_set_nonce_len().
Gilles Peskine69971662019-10-23 19:39:36 +0200240 * With the default entropy length, the entropy nonce length is
241 * #MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN.
242 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200243 * You can provide a nonce and personalization string in addition to the
Gilles Peskine223deea2019-09-24 14:48:53 +0200244 * entropy source, to make this instantiation as unique as possible.
Gilles Peskine9be50982019-10-22 18:42:27 +0200245 * See SP 800-90A §8.6.7 for more details about nonces.
Gilles Peskine223deea2019-09-24 14:48:53 +0200246 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200247 * The _seed_material_ value passed to the derivation function in
248 * the CTR_DRBG Instantiate Process described in NIST SP 800-90A §10.2.1.3.2
249 * is the concatenation of the following strings:
250 * - A string obtained by calling \p f_entropy function for the entropy
251 * length.
Gilles Peskinee9a34542019-10-22 20:43:24 +0200252 */
Gilles Peskine69971662019-10-23 19:39:36 +0200253#if MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN == 0
Gilles Peskinee9a34542019-10-22 20:43:24 +0200254/**
255 * - If mbedtls_ctr_drbg_set_nonce_len() has been called, a string
256 * obtained by calling \p f_entropy function for the specified length.
257 */
258#else
259/**
260 * - A string obtained by calling \p f_entropy function for the entropy nonce
261 * length. If the entropy nonce length is \c 0, this function does not
262 * make a second call to \p f_entropy.
263 */
264#endif
Gilles Peskinef305d922021-02-09 18:44:18 +0100265#if defined(MBEDTLS_THREADING_C)
266/**
267 * \note When Mbed TLS is built with threading support,
268 * after this function returns successfully,
269 * it is safe to call mbedtls_ctr_drbg_random()
270 * from multiple threads. Other operations, including
271 * reseeding, are not thread-safe.
272 */
273#endif /* MBEDTLS_THREADING_C */
Gilles Peskinee9a34542019-10-22 20:43:24 +0200274/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200275 * - The \p custom string.
276 *
277 * \note To achieve the nominal security strength permitted
278 * by CTR_DRBG, the entropy length must be:
279 * - at least 16 bytes for a 128-bit strength
280 * (maximum achievable strength when using AES-128);
281 * - at least 32 bytes for a 256-bit strength
282 * (maximum achievable strength when using AES-256).
283 *
284 * In addition, if you do not pass a nonce in \p custom,
285 * the sum of the entropy length
Gilles Peskinee9a34542019-10-22 20:43:24 +0200286 * and the entropy nonce length must be:
Gilles Peskine9be50982019-10-22 18:42:27 +0200287 * - at least 24 bytes for a 128-bit strength
288 * (maximum achievable strength when using AES-128);
289 * - at least 48 bytes for a 256-bit strength
290 * (maximum achievable strength when using AES-256).
291 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000292 * \param ctx The CTR_DRBG context to seed.
Gilles Peskinebd326f92019-10-28 17:33:07 +0100293 * It must have been initialized with
294 * mbedtls_ctr_drbg_init().
295 * After a successful call to mbedtls_ctr_drbg_seed(),
296 * you may not call mbedtls_ctr_drbg_seed() again on
297 * the same context unless you call
298 * mbedtls_ctr_drbg_free() and mbedtls_ctr_drbg_init()
299 * again first.
Gilles Peskinef305d922021-02-09 18:44:18 +0100300 * After a failed call to mbedtls_ctr_drbg_seed(),
301 * you must call mbedtls_ctr_drbg_free().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000302 * \param f_entropy The entropy callback, taking as arguments the
303 * \p p_entropy context, the buffer to fill, and the
Gilles Peskine08875d42019-09-24 14:40:40 +0200304 * length of the buffer.
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200305 * \p f_entropy is always called with a buffer size
Gilles Peskine9be50982019-10-22 18:42:27 +0200306 * less than or equal to the entropy length.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200307 * \param p_entropy The entropy context to pass to \p f_entropy.
Gilles Peskine217b8152019-10-01 18:39:45 +0200308 * \param custom The personalization string.
309 * This can be \c NULL, in which case the personalization
310 * string is empty regardless of the value of \p len.
311 * \param len The length of the personalization string.
Gilles Peskine944bc582019-09-24 14:48:30 +0200312 * This must be at most
313 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
314 * - #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000315 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100316 * \return \c 0 on success.
317 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000318 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100319int mbedtls_ctr_drbg_seed(mbedtls_ctr_drbg_context *ctx,
320 int (*f_entropy)(void *, unsigned char *, size_t),
321 void *p_entropy,
322 const unsigned char *custom,
323 size_t len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000324
325/**
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800326 * \brief This function resets CTR_DRBG context to the state immediately
327 * after initial call of mbedtls_ctr_drbg_init().
Paul Bakkerfff03662014-06-18 16:21:25 +0200328 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000329 * \param ctx The CTR_DRBG context to clear.
Paul Bakkerfff03662014-06-18 16:21:25 +0200330 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100331void mbedtls_ctr_drbg_free(mbedtls_ctr_drbg_context *ctx);
Paul Bakkerfff03662014-06-18 16:21:25 +0200332
333/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000334 * \brief This function turns prediction resistance on or off.
335 * The default value is off.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000336 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000337 * \note If enabled, entropy is gathered at the beginning of
Gilles Peskineec51dd12019-09-30 15:01:02 +0200338 * every call to mbedtls_ctr_drbg_random_with_add()
339 * or mbedtls_ctr_drbg_random().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000340 * Only use this if your entropy source has sufficient
341 * throughput.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000342 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000343 * \param ctx The CTR_DRBG context.
344 * \param resistance #MBEDTLS_CTR_DRBG_PR_ON or #MBEDTLS_CTR_DRBG_PR_OFF.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000345 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100346void mbedtls_ctr_drbg_set_prediction_resistance(mbedtls_ctr_drbg_context *ctx,
347 int resistance);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000348
349/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000350 * \brief This function sets the amount of entropy grabbed on each
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200351 * seed or reseed.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200352 *
353 * The default value is #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000354 *
Gilles Peskinedddda812019-10-03 14:22:04 +0200355 * \note The security strength of CTR_DRBG is bounded by the
356 * entropy length. Thus:
357 * - When using AES-256
358 * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled,
359 * which is the default),
360 * \p len must be at least 32 (in bytes)
361 * to achieve a 256-bit strength.
362 * - When using AES-128
363 * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled)
364 * \p len must be at least 16 (in bytes)
365 * to achieve a 128-bit strength.
Gilles Peskine223deea2019-09-24 14:48:53 +0200366 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000367 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200368 * \param len The amount of entropy to grab, in bytes.
Gilles Peskine9be50982019-10-22 18:42:27 +0200369 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
370 * and at most the maximum length accepted by the
371 * entropy function that is set in the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000372 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100373void mbedtls_ctr_drbg_set_entropy_len(mbedtls_ctr_drbg_context *ctx,
374 size_t len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000375
376/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200377 * \brief This function sets the amount of entropy grabbed
378 * as a nonce for the initial seeding.
379 *
380 * Call this function before calling mbedtls_ctr_drbg_seed() to read
381 * a nonce from the entropy source during the initial seeding.
382 *
383 * \param ctx The CTR_DRBG context.
384 * \param len The amount of entropy to grab for the nonce, in bytes.
385 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
386 * and at most the maximum length accepted by the
387 * entropy function that is set in the context.
388 *
389 * \return \c 0 on success.
390 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if \p len is
391 * more than #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
392 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
393 * if the initial seeding has already taken place.
394 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100395int mbedtls_ctr_drbg_set_nonce_len(mbedtls_ctr_drbg_context *ctx,
396 size_t len);
Gilles Peskine9be50982019-10-22 18:42:27 +0200397
398/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000399 * \brief This function sets the reseed interval.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200400 *
401 * The reseed interval is the number of calls to mbedtls_ctr_drbg_random()
402 * or mbedtls_ctr_drbg_random_with_add() after which the entropy function
403 * is called again.
404 *
405 * The default value is #MBEDTLS_CTR_DRBG_RESEED_INTERVAL.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000406 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000407 * \param ctx The CTR_DRBG context.
408 * \param interval The reseed interval.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000409 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100410void mbedtls_ctr_drbg_set_reseed_interval(mbedtls_ctr_drbg_context *ctx,
411 int interval);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000412
413/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000414 * \brief This function reseeds the CTR_DRBG context, that is
415 * extracts data from the entropy source.
Paul Bakker9af723c2014-05-01 13:03:14 +0200416 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100417 * \note This function is not thread-safe. It is not safe
418 * to call this function if another thread might be
419 * concurrently obtaining random numbers from the same
420 * context or updating or reseeding the same context.
421 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000422 * \param ctx The CTR_DRBG context.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200423 * \param additional Additional data to add to the state. Can be \c NULL.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000424 * \param len The length of the additional data.
Gilles Peskine944bc582019-09-24 14:48:30 +0200425 * This must be less than
426 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
427 * where \c entropy_len is the entropy length
428 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000429 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100430 * \return \c 0 on success.
431 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000432 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100433int mbedtls_ctr_drbg_reseed(mbedtls_ctr_drbg_context *ctx,
434 const unsigned char *additional, size_t len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000435
436/**
Rose Zadikc9474eb2018-03-27 10:58:22 +0100437 * \brief This function updates the state of the CTR_DRBG context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000438 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100439 * \note This function is not thread-safe. It is not safe
440 * to call this function if another thread might be
441 * concurrently obtaining random numbers from the same
442 * context or updating or reseeding the same context.
443 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100444 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200445 * \param additional The data to update the state with. This must not be
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200446 * \c NULL unless \p add_len is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500447 * \param add_len Length of \p additional in bytes. This must be at
448 * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Rose Zadikc9474eb2018-03-27 10:58:22 +0100449 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500450 * \return \c 0 on success.
451 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if
452 * \p add_len is more than
453 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
454 * \return An error from the underlying AES cipher on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000455 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100456int mbedtls_ctr_drbg_update_ret(mbedtls_ctr_drbg_context *ctx,
457 const unsigned char *additional,
458 size_t add_len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000459
460/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000461 * \brief This function updates a CTR_DRBG instance with additional
462 * data and uses it to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000463 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200464 * This function automatically reseeds if the reseed counter is exceeded
465 * or prediction resistance is enabled.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000466 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100467 * \note This function is not thread-safe. It is not safe
468 * to call this function if another thread might be
469 * concurrently obtaining random numbers from the same
470 * context or updating or reseeding the same context.
471 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000472 * \param p_rng The CTR_DRBG context. This must be a pointer to a
473 * #mbedtls_ctr_drbg_context structure.
474 * \param output The buffer to fill.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200475 * \param output_len The length of the buffer in bytes.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200476 * \param additional Additional data to update. Can be \c NULL, in which
Gilles Peskine08875d42019-09-24 14:40:40 +0200477 * case the additional data is empty regardless of
478 * the value of \p add_len.
479 * \param add_len The length of the additional data
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200480 * if \p additional is not \c NULL.
Gilles Peskine944bc582019-09-24 14:48:30 +0200481 * This must be less than #MBEDTLS_CTR_DRBG_MAX_INPUT
482 * and less than
483 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
484 * where \c entropy_len is the entropy length
485 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000486 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100487 * \return \c 0 on success.
488 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000489 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000490 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100491int mbedtls_ctr_drbg_random_with_add(void *p_rng,
492 unsigned char *output, size_t output_len,
493 const unsigned char *additional, size_t add_len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000494
495/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000496 * \brief This function uses CTR_DRBG to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000497 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200498 * This function automatically reseeds if the reseed counter is exceeded
499 * or prediction resistance is enabled.
Gilles Peskinef305d922021-02-09 18:44:18 +0100500 */
501#if defined(MBEDTLS_THREADING_C)
502/**
503 * \note When Mbed TLS is built with threading support,
504 * it is safe to call mbedtls_ctr_drbg_random()
505 * from multiple threads. Other operations, including
506 * reseeding, are not thread-safe.
507 */
508#endif /* MBEDTLS_THREADING_C */
509/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000510 * \param p_rng The CTR_DRBG context. This must be a pointer to a
511 * #mbedtls_ctr_drbg_context structure.
512 * \param output The buffer to fill.
Gilles Peskine944bc582019-09-24 14:48:30 +0200513 * \param output_len The length of the buffer in bytes.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000514 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100515 * \return \c 0 on success.
516 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000517 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000518 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100519int mbedtls_ctr_drbg_random(void *p_rng,
520 unsigned char *output, size_t output_len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000521
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500522
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100523#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500524#if defined(MBEDTLS_DEPRECATED_WARNING)
525#define MBEDTLS_DEPRECATED __attribute__((deprecated))
526#else
527#define MBEDTLS_DEPRECATED
528#endif
529/**
530 * \brief This function updates the state of the CTR_DRBG context.
531 *
532 * \deprecated Superseded by mbedtls_ctr_drbg_update_ret()
533 * in 2.16.0.
534 *
535 * \note If \p add_len is greater than
536 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT, only the first
537 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT Bytes are used.
538 * The remaining Bytes are silently discarded.
539 *
540 * \param ctx The CTR_DRBG context.
541 * \param additional The data to update the state with.
542 * \param add_len Length of \p additional data.
543 */
544MBEDTLS_DEPRECATED void mbedtls_ctr_drbg_update(
545 mbedtls_ctr_drbg_context *ctx,
546 const unsigned char *additional,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100547 size_t add_len);
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500548#undef MBEDTLS_DEPRECATED
549#endif /* !MBEDTLS_DEPRECATED_REMOVED */
550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#if defined(MBEDTLS_FS_IO)
Paul Bakkerfc754a92011-12-05 13:23:51 +0000552/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000553 * \brief This function writes a seed file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000554 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000555 * \param ctx The CTR_DRBG context.
556 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000557 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100558 * \return \c 0 on success.
Rose Zadikf25eb6e2018-04-16 14:51:52 +0100559 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200560 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed
Rose Zadik2f8163d2018-01-25 21:55:14 +0000561 * failure.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000562 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100563int mbedtls_ctr_drbg_write_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path);
Paul Bakkerfc754a92011-12-05 13:23:51 +0000564
565/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000566 * \brief This function reads and updates a seed file. The seed
567 * is added to this instance.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000568 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000569 * \param ctx The CTR_DRBG context.
570 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000571 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100572 * \return \c 0 on success.
573 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200574 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on
575 * reseed failure.
576 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if the existing
577 * seed file is too large.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000578 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100579int mbedtls_ctr_drbg_update_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580#endif /* MBEDTLS_FS_IO */
Paul Bakkerfc754a92011-12-05 13:23:51 +0000581
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500582#if defined(MBEDTLS_SELF_TEST)
583
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000584/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000585 * \brief The CTR_DRBG checkup routine.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000586 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100587 * \return \c 0 on success.
588 * \return \c 1 on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000589 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100590int mbedtls_ctr_drbg_self_test(int verbose);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000591
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500592#endif /* MBEDTLS_SELF_TEST */
593
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000594#ifdef __cplusplus
595}
596#endif
597
598#endif /* ctr_drbg.h */