blob: 8d28150d74eef613c5405afa08e9d4f4b3d53893 [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
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020026 * SPDX-License-Identifier: Apache-2.0
27 *
28 * Licensed under the Apache License, Version 2.0 (the "License"); you may
29 * not use this file except in compliance with the License.
30 * You may obtain a copy of the License at
31 *
32 * http://www.apache.org/licenses/LICENSE-2.0
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 * See the License for the specific language governing permissions and
38 * limitations under the License.
Paul Bakker0e04d0e2011-11-27 14:46:59 +000039 */
Rose Zadik2f8163d2018-01-25 21:55:14 +000040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#ifndef MBEDTLS_CTR_DRBG_H
42#define MBEDTLS_CTR_DRBG_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020043#include "mbedtls/private_access.h"
Paul Bakker0e04d0e2011-11-27 14:46:59 +000044
Bence Szépkútic662b362021-05-27 11:25:03 +020045#include "mbedtls/build_info.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050046
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010047#include "mbedtls/aes.h"
Paul Bakker0e04d0e2011-11-27 14:46:59 +000048
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010049#if defined(MBEDTLS_THREADING_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010050#include "mbedtls/threading.h"
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010051#endif
52
Gilles Peskined2971572021-07-26 18:48:10 +020053/** The entropy source failed. */
54#define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034
55/** The requested random buffer length is too big. */
56#define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036
57/** The input (entropy + additional data) is too large. */
58#define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038
59/** Read or write error in file. */
60#define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A
Paul Bakker0e04d0e2011-11-27 14:46:59 +000061
Rose Zadik2f8163d2018-01-25 21:55:14 +000062#define MBEDTLS_CTR_DRBG_BLOCKSIZE 16 /**< The block size used by the cipher. */
Nir Sonnenscheince266e42018-08-29 10:11:46 +030063
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030064#if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
Gilles Peskine08875d42019-09-24 14:40:40 +020065#define MBEDTLS_CTR_DRBG_KEYSIZE 16
66/**< The key size in bytes used by the cipher.
67 *
68 * Compile-time choice: 16 bytes (128 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020069 * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020070 */
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +030071#else
Gilles Peskine08875d42019-09-24 14:40:40 +020072#define MBEDTLS_CTR_DRBG_KEYSIZE 32
73/**< The key size in bytes used by the cipher.
74 *
75 * Compile-time choice: 32 bytes (256 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020076 * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020077 */
Nir Sonnenscheina4588d42018-07-30 16:59:36 +030078#endif
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030079
Gilles Peskine449bd832023-01-11 14:50:10 +010080#define MBEDTLS_CTR_DRBG_KEYBITS (MBEDTLS_CTR_DRBG_KEYSIZE * 8) /**< The key size for the DRBG operation, in bits. */
81#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 +020082
Paul Bakker088c5c52014-04-25 11:11:10 +020083/**
84 * \name SECTION: Module settings
85 *
86 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020087 * Either change them in mbedtls_config.h or define them using the compiler command
Rose Zadik2f8163d2018-01-25 21:55:14 +000088 * line.
Paul Bakker088c5c52014-04-25 11:11:10 +020089 * \{
90 */
91
Gilles Peskinedddda812019-10-03 14:22:04 +020092/** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN
93 *
94 * \brief The amount of entropy used per seed by default, in bytes.
95 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020096#if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
97#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
Gilles Peskinedddda812019-10-03 14:22:04 +020098/** This is 48 bytes because the entropy module uses SHA-512
Gilles Peskined0c64c82019-10-03 14:20:46 +020099 * (\c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled).
Gilles Peskine08875d42019-09-24 14:40:40 +0200100 */
Rose Zadik2f8163d2018-01-25 21:55:14 +0000101#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Gilles Peskinedddda812019-10-03 14:22:04 +0200102
103#else /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
104
105/** This is 32 bytes because the entropy module uses SHA-256
106 * (the SHA512 module is disabled or
107 * \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled).
Rose Zadik2f8163d2018-01-25 21:55:14 +0000108 */
Gilles Peskinedddda812019-10-03 14:22:04 +0200109#if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
110/** \warning To achieve a 256-bit security strength, you must pass a nonce
111 * to mbedtls_ctr_drbg_seed().
112 */
113#endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */
Gilles Peskine08875d42019-09-24 14:40:40 +0200114#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
Gilles Peskinedddda812019-10-03 14:22:04 +0200115#endif /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
116#endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118#if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000119#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
120/**< The interval before reseed is performed by default. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200121#endif
122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123#if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000124#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
125/**< The maximum number of additional input Bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200126#endif
127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200128#if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000129#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
130/**< The maximum number of requested Bytes per call. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200131#endif
132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000134#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Gilles Peskine08875d42019-09-24 14:40:40 +0200135/**< The maximum size of seed or reseed buffer in bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200136#endif
137
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100138/** \} name SECTION: Module settings */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000139
Rose Zadik2f8163d2018-01-25 21:55:14 +0000140#define MBEDTLS_CTR_DRBG_PR_OFF 0
141/**< Prediction resistance is disabled. */
142#define MBEDTLS_CTR_DRBG_PR_ON 1
143/**< Prediction resistance is enabled. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000144
145#ifdef __cplusplus
146extern "C" {
147#endif
148
Gilles Peskine69971662019-10-23 19:39:36 +0200149#if MBEDTLS_CTR_DRBG_ENTROPY_LEN >= MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2
150/** The default length of the nonce read from the entropy source.
151 *
152 * This is \c 0 because a single read from the entropy source is sufficient
153 * to include a nonce.
154 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
155 */
156#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN 0
157#else
158/** The default length of the nonce read from the entropy source.
159 *
160 * This is half of the default entropy length because a single read from
161 * the entropy source does not provide enough material to form a nonce.
162 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
163 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100164#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN (MBEDTLS_CTR_DRBG_ENTROPY_LEN + 1) / 2
Gilles Peskine69971662019-10-23 19:39:36 +0200165#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
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200192 mbedtls_aes_context MBEDTLS_PRIVATE(aes_ctx); /*!< The AES context. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000193
194 /*
195 * Callbacks (Entropy)
196 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 int(*MBEDTLS_PRIVATE(f_entropy))(void *, unsigned char *, size_t);
198 /*!< The entropy callback function. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000199
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200200 void *MBEDTLS_PRIVATE(p_entropy); /*!< The context for the entropy function. */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100201
202#if defined(MBEDTLS_THREADING_C)
Gilles Peskineda290f92021-02-09 18:44:02 +0100203 /* Invariant: the mutex is initialized if and only if f_entropy != NULL.
204 * This means that the mutex is initialized during the initial seeding
205 * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free().
206 *
207 * Note that this invariant may change without notice. Do not rely on it
208 * and do not access the mutex directly in application code.
209 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200210 mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100211#endif
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213mbedtls_ctr_drbg_context;
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000214
215/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000216 * \brief This function initializes the CTR_DRBG context,
217 * and prepares it for mbedtls_ctr_drbg_seed()
218 * or mbedtls_ctr_drbg_free().
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200219 *
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800220 * \note The reseed interval is
221 * #MBEDTLS_CTR_DRBG_RESEED_INTERVAL by default.
222 * You can override it by calling
223 * mbedtls_ctr_drbg_set_reseed_interval().
224 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000225 * \param ctx The CTR_DRBG context to initialize.
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200226 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100227void mbedtls_ctr_drbg_init(mbedtls_ctr_drbg_context *ctx);
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200228
229/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000230 * \brief This function seeds and sets up the CTR_DRBG
231 * entropy source for future reseeds.
Paul Bakker9af723c2014-05-01 13:03:14 +0200232 *
Gilles Peskine223deea2019-09-24 14:48:53 +0200233 * A typical choice for the \p f_entropy and \p p_entropy parameters is
234 * to use the entropy module:
235 * - \p f_entropy is mbedtls_entropy_func();
236 * - \p p_entropy is an instance of ::mbedtls_entropy_context initialized
237 * with mbedtls_entropy_init() (which registers the platform's default
238 * entropy sources).
239 *
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200240 * The entropy length is #MBEDTLS_CTR_DRBG_ENTROPY_LEN by default.
241 * You can override it by calling mbedtls_ctr_drbg_set_entropy_len().
Gilles Peskineec51dd12019-09-30 15:01:02 +0200242 *
Gilles Peskinee9a34542019-10-22 20:43:24 +0200243 * The entropy nonce length is:
244 * - \c 0 if the entropy length is at least 3/2 times the entropy length,
245 * which guarantees that the security strength is the maximum permitted
246 * by the key size and entropy length according to NIST SP 800-90A §10.2.1;
247 * - Half the entropy length otherwise.
248 * You can override it by calling mbedtls_ctr_drbg_set_nonce_len().
Gilles Peskine69971662019-10-23 19:39:36 +0200249 * With the default entropy length, the entropy nonce length is
250 * #MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN.
251 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200252 * You can provide a nonce and personalization string in addition to the
Gilles Peskine223deea2019-09-24 14:48:53 +0200253 * entropy source, to make this instantiation as unique as possible.
Gilles Peskine9be50982019-10-22 18:42:27 +0200254 * See SP 800-90A §8.6.7 for more details about nonces.
Gilles Peskine223deea2019-09-24 14:48:53 +0200255 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200256 * The _seed_material_ value passed to the derivation function in
257 * the CTR_DRBG Instantiate Process described in NIST SP 800-90A §10.2.1.3.2
258 * is the concatenation of the following strings:
259 * - A string obtained by calling \p f_entropy function for the entropy
260 * length.
Gilles Peskinee9a34542019-10-22 20:43:24 +0200261 */
Gilles Peskine69971662019-10-23 19:39:36 +0200262#if MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN == 0
Gilles Peskinee9a34542019-10-22 20:43:24 +0200263/**
264 * - If mbedtls_ctr_drbg_set_nonce_len() has been called, a string
265 * obtained by calling \p f_entropy function for the specified length.
266 */
267#else
268/**
269 * - A string obtained by calling \p f_entropy function for the entropy nonce
270 * length. If the entropy nonce length is \c 0, this function does not
271 * make a second call to \p f_entropy.
272 */
273#endif
Gilles Peskinef305d922021-02-09 18:44:18 +0100274#if defined(MBEDTLS_THREADING_C)
275/**
276 * \note When Mbed TLS is built with threading support,
277 * after this function returns successfully,
278 * it is safe to call mbedtls_ctr_drbg_random()
279 * from multiple threads. Other operations, including
280 * reseeding, are not thread-safe.
281 */
282#endif /* MBEDTLS_THREADING_C */
Gilles Peskinee9a34542019-10-22 20:43:24 +0200283/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200284 * - The \p custom string.
285 *
286 * \note To achieve the nominal security strength permitted
287 * by CTR_DRBG, the entropy length must be:
288 * - at least 16 bytes for a 128-bit strength
289 * (maximum achievable strength when using AES-128);
290 * - at least 32 bytes for a 256-bit strength
291 * (maximum achievable strength when using AES-256).
292 *
293 * In addition, if you do not pass a nonce in \p custom,
294 * the sum of the entropy length
Gilles Peskinee9a34542019-10-22 20:43:24 +0200295 * and the entropy nonce length must be:
Gilles Peskine9be50982019-10-22 18:42:27 +0200296 * - at least 24 bytes for a 128-bit strength
297 * (maximum achievable strength when using AES-128);
298 * - at least 48 bytes for a 256-bit strength
299 * (maximum achievable strength when using AES-256).
300 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000301 * \param ctx The CTR_DRBG context to seed.
Gilles Peskinebd326f92019-10-28 17:33:07 +0100302 * 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 Peskinef305d922021-02-09 18:44:18 +0100309 * After a failed call to mbedtls_ctr_drbg_seed(),
310 * you must call mbedtls_ctr_drbg_free().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000311 * \param f_entropy The entropy callback, taking as arguments the
312 * \p p_entropy context, the buffer to fill, and the
Gilles Peskine08875d42019-09-24 14:40:40 +0200313 * length of the buffer.
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200314 * \p f_entropy is always called with a buffer size
Gilles Peskine9be50982019-10-22 18:42:27 +0200315 * less than or equal to the entropy length.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200316 * \param p_entropy The entropy context to pass to \p f_entropy.
Gilles Peskine217b8152019-10-01 18:39:45 +0200317 * \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 Peskine944bc582019-09-24 14:48:30 +0200321 * This must be at most
322 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
323 * - #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000324 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100325 * \return \c 0 on success.
326 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000327 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328int mbedtls_ctr_drbg_seed(mbedtls_ctr_drbg_context *ctx,
329 int (*f_entropy)(void *, unsigned char *, size_t),
330 void *p_entropy,
331 const unsigned char *custom,
332 size_t len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000333
334/**
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800335 * \brief This function resets CTR_DRBG context to the state immediately
336 * after initial call of mbedtls_ctr_drbg_init().
Paul Bakkerfff03662014-06-18 16:21:25 +0200337 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000338 * \param ctx The CTR_DRBG context to clear.
Paul Bakkerfff03662014-06-18 16:21:25 +0200339 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100340void mbedtls_ctr_drbg_free(mbedtls_ctr_drbg_context *ctx);
Paul Bakkerfff03662014-06-18 16:21:25 +0200341
342/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000343 * \brief This function turns prediction resistance on or off.
344 * The default value is off.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000345 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000346 * \note If enabled, entropy is gathered at the beginning of
Gilles Peskineec51dd12019-09-30 15:01:02 +0200347 * every call to mbedtls_ctr_drbg_random_with_add()
348 * or mbedtls_ctr_drbg_random().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000349 * Only use this if your entropy source has sufficient
350 * throughput.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000351 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000352 * \param ctx The CTR_DRBG context.
353 * \param resistance #MBEDTLS_CTR_DRBG_PR_ON or #MBEDTLS_CTR_DRBG_PR_OFF.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000354 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100355void mbedtls_ctr_drbg_set_prediction_resistance(mbedtls_ctr_drbg_context *ctx,
356 int resistance);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000357
358/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000359 * \brief This function sets the amount of entropy grabbed on each
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200360 * seed or reseed.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200361 *
362 * The default value is #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000363 *
Gilles Peskinedddda812019-10-03 14:22:04 +0200364 * \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 Peskine223deea2019-09-24 14:48:53 +0200375 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000376 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200377 * \param len The amount of entropy to grab, in bytes.
Gilles Peskine9be50982019-10-22 18:42:27 +0200378 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
379 * and at most the maximum length accepted by the
380 * entropy function that is set in the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000381 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100382void mbedtls_ctr_drbg_set_entropy_len(mbedtls_ctr_drbg_context *ctx,
383 size_t len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000384
385/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200386 * \brief This function sets the amount of entropy grabbed
387 * as a nonce for the initial seeding.
388 *
389 * Call this function before calling mbedtls_ctr_drbg_seed() to read
390 * a nonce from the entropy source during the initial seeding.
391 *
392 * \param ctx The CTR_DRBG context.
393 * \param len The amount of entropy to grab for the nonce, in bytes.
394 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
395 * and at most the maximum length accepted by the
396 * entropy function that is set in the context.
397 *
398 * \return \c 0 on success.
399 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if \p len is
400 * more than #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
401 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
402 * if the initial seeding has already taken place.
403 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100404int mbedtls_ctr_drbg_set_nonce_len(mbedtls_ctr_drbg_context *ctx,
405 size_t len);
Gilles Peskine9be50982019-10-22 18:42:27 +0200406
407/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000408 * \brief This function sets the reseed interval.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200409 *
410 * The reseed interval is the number of calls to mbedtls_ctr_drbg_random()
411 * or mbedtls_ctr_drbg_random_with_add() after which the entropy function
412 * is called again.
413 *
414 * The default value is #MBEDTLS_CTR_DRBG_RESEED_INTERVAL.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000415 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000416 * \param ctx The CTR_DRBG context.
417 * \param interval The reseed interval.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000418 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100419void mbedtls_ctr_drbg_set_reseed_interval(mbedtls_ctr_drbg_context *ctx,
420 int interval);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000421
422/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000423 * \brief This function reseeds the CTR_DRBG context, that is
424 * extracts data from the entropy source.
Paul Bakker9af723c2014-05-01 13:03:14 +0200425 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100426 * \note This function is not thread-safe. It is not safe
427 * to call this function if another thread might be
428 * concurrently obtaining random numbers from the same
429 * context or updating or reseeding the same context.
430 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000431 * \param ctx The CTR_DRBG context.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200432 * \param additional Additional data to add to the state. Can be \c NULL.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000433 * \param len The length of the additional data.
Gilles Peskine944bc582019-09-24 14:48:30 +0200434 * This must be less than
435 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
436 * where \c entropy_len is the entropy length
437 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000438 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100439 * \return \c 0 on success.
440 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000441 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100442int mbedtls_ctr_drbg_reseed(mbedtls_ctr_drbg_context *ctx,
443 const unsigned char *additional, size_t len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000444
445/**
Rose Zadikc9474eb2018-03-27 10:58:22 +0100446 * \brief This function updates the state of the CTR_DRBG context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000447 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100448 * \note This function is not thread-safe. It is not safe
449 * to call this function if another thread might be
450 * concurrently obtaining random numbers from the same
451 * context or updating or reseeding the same context.
452 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100453 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200454 * \param additional The data to update the state with. This must not be
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200455 * \c NULL unless \p add_len is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500456 * \param add_len Length of \p additional in bytes. This must be at
457 * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Rose Zadikc9474eb2018-03-27 10:58:22 +0100458 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500459 * \return \c 0 on success.
460 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if
461 * \p add_len is more than
462 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
463 * \return An error from the underlying AES cipher on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000464 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100465int mbedtls_ctr_drbg_update(mbedtls_ctr_drbg_context *ctx,
466 const unsigned char *additional,
467 size_t add_len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000468
469/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000470 * \brief This function updates a CTR_DRBG instance with additional
471 * data and uses it to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000472 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200473 * This function automatically reseeds if the reseed counter is exceeded
474 * or prediction resistance is enabled.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000475 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100476 * \note This function is not thread-safe. It is not safe
477 * to call this function if another thread might be
478 * concurrently obtaining random numbers from the same
479 * context or updating or reseeding the same context.
480 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000481 * \param p_rng The CTR_DRBG context. This must be a pointer to a
482 * #mbedtls_ctr_drbg_context structure.
483 * \param output The buffer to fill.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200484 * \param output_len The length of the buffer in bytes.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200485 * \param additional Additional data to update. Can be \c NULL, in which
Gilles Peskine08875d42019-09-24 14:40:40 +0200486 * case the additional data is empty regardless of
487 * the value of \p add_len.
488 * \param add_len The length of the additional data
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200489 * if \p additional is not \c NULL.
Gilles Peskine944bc582019-09-24 14:48:30 +0200490 * This must be less than #MBEDTLS_CTR_DRBG_MAX_INPUT
491 * and less than
492 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
493 * where \c entropy_len is the entropy length
494 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000495 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100496 * \return \c 0 on success.
497 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000498 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000499 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100500int mbedtls_ctr_drbg_random_with_add(void *p_rng,
501 unsigned char *output, size_t output_len,
502 const unsigned char *additional, size_t add_len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000503
504/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000505 * \brief This function uses CTR_DRBG to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000506 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200507 * This function automatically reseeds if the reseed counter is exceeded
508 * or prediction resistance is enabled.
Gilles Peskinef305d922021-02-09 18:44:18 +0100509 */
510#if defined(MBEDTLS_THREADING_C)
511/**
512 * \note When Mbed TLS is built with threading support,
513 * it is safe to call mbedtls_ctr_drbg_random()
514 * from multiple threads. Other operations, including
515 * reseeding, are not thread-safe.
516 */
517#endif /* MBEDTLS_THREADING_C */
518/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000519 * \param p_rng The CTR_DRBG context. This must be a pointer to a
520 * #mbedtls_ctr_drbg_context structure.
521 * \param output The buffer to fill.
Gilles Peskine944bc582019-09-24 14:48:30 +0200522 * \param output_len The length of the buffer in bytes.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000523 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100524 * \return \c 0 on success.
525 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000526 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000527 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100528int mbedtls_ctr_drbg_random(void *p_rng,
529 unsigned char *output, size_t output_len);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200531#if defined(MBEDTLS_FS_IO)
Paul Bakkerfc754a92011-12-05 13:23:51 +0000532/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000533 * \brief This function writes a seed file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000534 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000535 * \param ctx The CTR_DRBG context.
536 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000537 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100538 * \return \c 0 on success.
Rose Zadikf25eb6e2018-04-16 14:51:52 +0100539 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200540 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed
Rose Zadik2f8163d2018-01-25 21:55:14 +0000541 * failure.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000542 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100543int mbedtls_ctr_drbg_write_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path);
Paul Bakkerfc754a92011-12-05 13:23:51 +0000544
545/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000546 * \brief This function reads and updates a seed file. The seed
547 * is added to this instance.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000548 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000549 * \param ctx The CTR_DRBG context.
550 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000551 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100552 * \return \c 0 on success.
553 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200554 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on
555 * reseed failure.
556 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if the existing
557 * seed file is too large.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000558 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100559int mbedtls_ctr_drbg_update_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560#endif /* MBEDTLS_FS_IO */
Paul Bakkerfc754a92011-12-05 13:23:51 +0000561
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500562#if defined(MBEDTLS_SELF_TEST)
563
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000564/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000565 * \brief The CTR_DRBG checkup routine.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000566 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100567 * \return \c 0 on success.
568 * \return \c 1 on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000569 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100570int mbedtls_ctr_drbg_self_test(int verbose);
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000571
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500572#endif /* MBEDTLS_SELF_TEST */
573
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000574#ifdef __cplusplus
575}
576#endif
577
578#endif /* ctr_drbg.h */