blob: 4c24c048f32623fc2ea2a21cc02f0b4532160a73 [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
Mateusz Starzyk16fec332021-07-22 16:43:35 +020062/** The block size used by the cipher. */
63#define MBEDTLS_CTR_DRBG_BLOCKSIZE 16
Nir Sonnenscheince266e42018-08-29 10:11:46 +030064
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030065#if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
Gilles Peskine08875d42019-09-24 14:40:40 +020066#define MBEDTLS_CTR_DRBG_KEYSIZE 16
67/**< The key size in bytes used by the cipher.
68 *
69 * Compile-time choice: 16 bytes (128 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020070 * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020071 */
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +030072#else
Gilles Peskine08875d42019-09-24 14:40:40 +020073#define MBEDTLS_CTR_DRBG_KEYSIZE 32
74/**< The key size in bytes used by the cipher.
75 *
76 * Compile-time choice: 32 bytes (256 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020077 * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020078 */
Nir Sonnenscheina4588d42018-07-30 16:59:36 +030079#endif
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030080
Rose Zadik2f8163d2018-01-25 21:55:14 +000081#define MBEDTLS_CTR_DRBG_KEYBITS ( MBEDTLS_CTR_DRBG_KEYSIZE * 8 ) /**< The key size for the DRBG operation, in bits. */
82#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 +020083
Paul Bakker088c5c52014-04-25 11:11:10 +020084/**
85 * \name SECTION: Module settings
86 *
87 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020088 * Either change them in mbedtls_config.h or define them using the compiler command
Rose Zadik2f8163d2018-01-25 21:55:14 +000089 * line.
Paul Bakker088c5c52014-04-25 11:11:10 +020090 * \{
91 */
92
Gilles Peskinedddda812019-10-03 14:22:04 +020093/** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN
94 *
95 * \brief The amount of entropy used per seed by default, in bytes.
96 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020097#if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
98#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
Gilles Peskinedddda812019-10-03 14:22:04 +020099/** This is 48 bytes because the entropy module uses SHA-512
Gilles Peskined0c64c82019-10-03 14:20:46 +0200100 * (\c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled).
Gilles Peskine08875d42019-09-24 14:40:40 +0200101 */
Rose Zadik2f8163d2018-01-25 21:55:14 +0000102#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Gilles Peskinedddda812019-10-03 14:22:04 +0200103
104#else /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
105
106/** This is 32 bytes because the entropy module uses SHA-256
107 * (the SHA512 module is disabled or
108 * \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled).
Rose Zadik2f8163d2018-01-25 21:55:14 +0000109 */
Gilles Peskinedddda812019-10-03 14:22:04 +0200110#if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
111/** \warning To achieve a 256-bit security strength, you must pass a nonce
112 * to mbedtls_ctr_drbg_seed().
113 */
114#endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */
Gilles Peskine08875d42019-09-24 14:40:40 +0200115#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
Gilles Peskinedddda812019-10-03 14:22:04 +0200116#endif /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
117#endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119#if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000120#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
121/**< The interval before reseed is performed by default. */
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_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000125#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
126/**< The maximum number of additional input Bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200127#endif
128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000130#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
131/**< The maximum number of requested Bytes per call. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200132#endif
133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200134#if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000135#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Gilles Peskine08875d42019-09-24 14:40:40 +0200136/**< The maximum size of seed or reseed buffer in bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200137#endif
138
139/* \} name SECTION: Module settings */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000140
Rose Zadik2f8163d2018-01-25 21:55:14 +0000141#define MBEDTLS_CTR_DRBG_PR_OFF 0
142/**< Prediction resistance is disabled. */
143#define MBEDTLS_CTR_DRBG_PR_ON 1
144/**< Prediction resistance is enabled. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000145
146#ifdef __cplusplus
147extern "C" {
148#endif
149
Gilles Peskine69971662019-10-23 19:39:36 +0200150#if MBEDTLS_CTR_DRBG_ENTROPY_LEN >= MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2
151/** The default length of the nonce read from the entropy source.
152 *
153 * This is \c 0 because a single read from the entropy source is sufficient
154 * to include a nonce.
155 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
156 */
157#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN 0
158#else
159/** The default length of the nonce read from the entropy source.
160 *
161 * This is half of the default entropy length because a single read from
162 * the entropy source does not provide enough material to form a nonce.
163 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
164 */
165#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN ( MBEDTLS_CTR_DRBG_ENTROPY_LEN + 1 ) / 2
166#endif
167
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000168/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000169 * \brief The CTR_DRBG context structure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000170 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200171typedef struct mbedtls_ctr_drbg_context
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000172{
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200173 unsigned char MBEDTLS_PRIVATE(counter)[16]; /*!< The counter (V). */
174 int MBEDTLS_PRIVATE(reseed_counter); /*!< The reseed counter.
Gilles Peskinec0ace352019-10-22 17:06:31 +0200175 * This is the number of requests that have
176 * been made since the last (re)seeding,
Gilles Peskine9be50982019-10-22 18:42:27 +0200177 * minus one.
178 * Before the initial seeding, this field
179 * contains the amount of entropy in bytes
Jaeden Ameroa15c7132020-01-09 13:02:16 +0000180 * to use as a nonce for the initial seeding,
181 * or -1 if no nonce length has been explicitly
182 * set (see mbedtls_ctr_drbg_set_nonce_len()).
Gilles Peskine9be50982019-10-22 18:42:27 +0200183 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200184 int MBEDTLS_PRIVATE(prediction_resistance); /*!< This determines whether prediction
Rose Zadik2f8163d2018-01-25 21:55:14 +0000185 resistance is enabled, that is
186 whether to systematically reseed before
187 each random generation. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200188 size_t MBEDTLS_PRIVATE(entropy_len); /*!< The amount of entropy grabbed on each
Gilles Peskinec0ace352019-10-22 17:06:31 +0200189 seed or reseed operation, in bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200190 int MBEDTLS_PRIVATE(reseed_interval); /*!< The reseed interval.
Gilles Peskinec0ace352019-10-22 17:06:31 +0200191 * This is the maximum number of requests
192 * that can be made between reseedings. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000193
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200194 mbedtls_aes_context MBEDTLS_PRIVATE(aes_ctx); /*!< The AES context. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000195
196 /*
197 * Callbacks (Entropy)
198 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200199 int (*MBEDTLS_PRIVATE(f_entropy))(void *, unsigned char *, size_t);
Rose Zadik2f8163d2018-01-25 21:55:14 +0000200 /*!< The entropy callback function. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000201
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200202 void *MBEDTLS_PRIVATE(p_entropy); /*!< The context for the entropy function. */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100203
204#if defined(MBEDTLS_THREADING_C)
Gilles Peskineda290f92021-02-09 18:44:02 +0100205 /* Invariant: the mutex is initialized if and only if f_entropy != NULL.
206 * This means that the mutex is initialized during the initial seeding
207 * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free().
208 *
209 * Note that this invariant may change without notice. Do not rely on it
210 * and do not access the mutex directly in application code.
211 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200212 mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100213#endif
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000214}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215mbedtls_ctr_drbg_context;
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000216
217/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000218 * \brief This function initializes the CTR_DRBG context,
219 * and prepares it for mbedtls_ctr_drbg_seed()
220 * or mbedtls_ctr_drbg_free().
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200221 *
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800222 * \note The reseed interval is
223 * #MBEDTLS_CTR_DRBG_RESEED_INTERVAL by default.
224 * You can override it by calling
225 * mbedtls_ctr_drbg_set_reseed_interval().
226 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000227 * \param ctx The CTR_DRBG context to initialize.
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200228 */
229void mbedtls_ctr_drbg_init( mbedtls_ctr_drbg_context *ctx );
230
231/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000232 * \brief This function seeds and sets up the CTR_DRBG
233 * entropy source for future reseeds.
Paul Bakker9af723c2014-05-01 13:03:14 +0200234 *
Gilles Peskine223deea2019-09-24 14:48:53 +0200235 * A typical choice for the \p f_entropy and \p p_entropy parameters is
236 * to use the entropy module:
237 * - \p f_entropy is mbedtls_entropy_func();
238 * - \p p_entropy is an instance of ::mbedtls_entropy_context initialized
239 * with mbedtls_entropy_init() (which registers the platform's default
240 * entropy sources).
241 *
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200242 * The entropy length is #MBEDTLS_CTR_DRBG_ENTROPY_LEN by default.
243 * You can override it by calling mbedtls_ctr_drbg_set_entropy_len().
Gilles Peskineec51dd12019-09-30 15:01:02 +0200244 *
Gilles Peskinee9a34542019-10-22 20:43:24 +0200245 * The entropy nonce length is:
246 * - \c 0 if the entropy length is at least 3/2 times the entropy length,
247 * which guarantees that the security strength is the maximum permitted
248 * by the key size and entropy length according to NIST SP 800-90A §10.2.1;
249 * - Half the entropy length otherwise.
250 * You can override it by calling mbedtls_ctr_drbg_set_nonce_len().
Gilles Peskine69971662019-10-23 19:39:36 +0200251 * With the default entropy length, the entropy nonce length is
252 * #MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN.
253 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200254 * You can provide a nonce and personalization string in addition to the
Gilles Peskine223deea2019-09-24 14:48:53 +0200255 * entropy source, to make this instantiation as unique as possible.
Gilles Peskine9be50982019-10-22 18:42:27 +0200256 * See SP 800-90A §8.6.7 for more details about nonces.
Gilles Peskine223deea2019-09-24 14:48:53 +0200257 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200258 * The _seed_material_ value passed to the derivation function in
259 * the CTR_DRBG Instantiate Process described in NIST SP 800-90A §10.2.1.3.2
260 * is the concatenation of the following strings:
261 * - A string obtained by calling \p f_entropy function for the entropy
262 * length.
Gilles Peskinee9a34542019-10-22 20:43:24 +0200263 */
Gilles Peskine69971662019-10-23 19:39:36 +0200264#if MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN == 0
Gilles Peskinee9a34542019-10-22 20:43:24 +0200265/**
266 * - If mbedtls_ctr_drbg_set_nonce_len() has been called, a string
267 * obtained by calling \p f_entropy function for the specified length.
268 */
269#else
270/**
271 * - A string obtained by calling \p f_entropy function for the entropy nonce
272 * length. If the entropy nonce length is \c 0, this function does not
273 * make a second call to \p f_entropy.
274 */
275#endif
Gilles Peskinef305d922021-02-09 18:44:18 +0100276#if defined(MBEDTLS_THREADING_C)
277/**
278 * \note When Mbed TLS is built with threading support,
279 * after this function returns successfully,
280 * it is safe to call mbedtls_ctr_drbg_random()
281 * from multiple threads. Other operations, including
282 * reseeding, are not thread-safe.
283 */
284#endif /* MBEDTLS_THREADING_C */
Gilles Peskinee9a34542019-10-22 20:43:24 +0200285/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200286 * - The \p custom string.
287 *
288 * \note To achieve the nominal security strength permitted
289 * by CTR_DRBG, the entropy length must be:
290 * - at least 16 bytes for a 128-bit strength
291 * (maximum achievable strength when using AES-128);
292 * - at least 32 bytes for a 256-bit strength
293 * (maximum achievable strength when using AES-256).
294 *
295 * In addition, if you do not pass a nonce in \p custom,
296 * the sum of the entropy length
Gilles Peskinee9a34542019-10-22 20:43:24 +0200297 * and the entropy nonce length must be:
Gilles Peskine9be50982019-10-22 18:42:27 +0200298 * - at least 24 bytes for a 128-bit strength
299 * (maximum achievable strength when using AES-128);
300 * - at least 48 bytes for a 256-bit strength
301 * (maximum achievable strength when using AES-256).
302 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000303 * \param ctx The CTR_DRBG context to seed.
Gilles Peskinebd326f92019-10-28 17:33:07 +0100304 * It must have been initialized with
305 * mbedtls_ctr_drbg_init().
306 * After a successful call to mbedtls_ctr_drbg_seed(),
307 * you may not call mbedtls_ctr_drbg_seed() again on
308 * the same context unless you call
309 * mbedtls_ctr_drbg_free() and mbedtls_ctr_drbg_init()
310 * again first.
Gilles Peskinef305d922021-02-09 18:44:18 +0100311 * After a failed call to mbedtls_ctr_drbg_seed(),
312 * you must call mbedtls_ctr_drbg_free().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000313 * \param f_entropy The entropy callback, taking as arguments the
314 * \p p_entropy context, the buffer to fill, and the
Gilles Peskine08875d42019-09-24 14:40:40 +0200315 * length of the buffer.
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200316 * \p f_entropy is always called with a buffer size
Gilles Peskine9be50982019-10-22 18:42:27 +0200317 * less than or equal to the entropy length.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200318 * \param p_entropy The entropy context to pass to \p f_entropy.
Gilles Peskine217b8152019-10-01 18:39:45 +0200319 * \param custom The personalization string.
320 * This can be \c NULL, in which case the personalization
321 * string is empty regardless of the value of \p len.
322 * \param len The length of the personalization string.
Gilles Peskine944bc582019-09-24 14:48:30 +0200323 * This must be at most
324 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
325 * - #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000326 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100327 * \return \c 0 on success.
328 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000329 */
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200330int mbedtls_ctr_drbg_seed( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000331 int (*f_entropy)(void *, unsigned char *, size_t),
332 void *p_entropy,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000333 const unsigned char *custom,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000334 size_t len );
335
336/**
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800337 * \brief This function resets CTR_DRBG context to the state immediately
338 * after initial call of mbedtls_ctr_drbg_init().
Paul Bakkerfff03662014-06-18 16:21:25 +0200339 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000340 * \param ctx The CTR_DRBG context to clear.
Paul Bakkerfff03662014-06-18 16:21:25 +0200341 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200342void mbedtls_ctr_drbg_free( mbedtls_ctr_drbg_context *ctx );
Paul Bakkerfff03662014-06-18 16:21:25 +0200343
344/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000345 * \brief This function turns prediction resistance on or off.
346 * The default value is off.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000347 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000348 * \note If enabled, entropy is gathered at the beginning of
Gilles Peskineec51dd12019-09-30 15:01:02 +0200349 * every call to mbedtls_ctr_drbg_random_with_add()
350 * or mbedtls_ctr_drbg_random().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000351 * Only use this if your entropy source has sufficient
352 * throughput.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000353 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000354 * \param ctx The CTR_DRBG context.
355 * \param resistance #MBEDTLS_CTR_DRBG_PR_ON or #MBEDTLS_CTR_DRBG_PR_OFF.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357void mbedtls_ctr_drbg_set_prediction_resistance( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000358 int resistance );
359
360/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000361 * \brief This function sets the amount of entropy grabbed on each
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200362 * seed or reseed.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200363 *
364 * The default value is #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000365 *
Gilles Peskinedddda812019-10-03 14:22:04 +0200366 * \note The security strength of CTR_DRBG is bounded by the
367 * entropy length. Thus:
368 * - When using AES-256
369 * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled,
370 * which is the default),
371 * \p len must be at least 32 (in bytes)
372 * to achieve a 256-bit strength.
373 * - When using AES-128
374 * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled)
375 * \p len must be at least 16 (in bytes)
376 * to achieve a 128-bit strength.
Gilles Peskine223deea2019-09-24 14:48:53 +0200377 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000378 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200379 * \param len The amount of entropy to grab, in bytes.
Gilles Peskine9be50982019-10-22 18:42:27 +0200380 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
381 * and at most the maximum length accepted by the
382 * entropy function that is set in the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384void mbedtls_ctr_drbg_set_entropy_len( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000385 size_t len );
386
387/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200388 * \brief This function sets the amount of entropy grabbed
389 * as a nonce for the initial seeding.
390 *
391 * Call this function before calling mbedtls_ctr_drbg_seed() to read
392 * a nonce from the entropy source during the initial seeding.
393 *
394 * \param ctx The CTR_DRBG context.
395 * \param len The amount of entropy to grab for the nonce, in bytes.
396 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
397 * and at most the maximum length accepted by the
398 * entropy function that is set in the context.
399 *
400 * \return \c 0 on success.
401 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if \p len is
402 * more than #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
403 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
404 * if the initial seeding has already taken place.
405 */
406int mbedtls_ctr_drbg_set_nonce_len( mbedtls_ctr_drbg_context *ctx,
407 size_t len );
408
409/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000410 * \brief This function sets the reseed interval.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200411 *
412 * The reseed interval is the number of calls to mbedtls_ctr_drbg_random()
413 * or mbedtls_ctr_drbg_random_with_add() after which the entropy function
414 * is called again.
415 *
416 * The default value is #MBEDTLS_CTR_DRBG_RESEED_INTERVAL.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000417 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000418 * \param ctx The CTR_DRBG context.
419 * \param interval The reseed interval.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200421void mbedtls_ctr_drbg_set_reseed_interval( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000422 int interval );
423
424/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000425 * \brief This function reseeds the CTR_DRBG context, that is
426 * extracts data from the entropy source.
Paul Bakker9af723c2014-05-01 13:03:14 +0200427 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100428 * \note This function is not thread-safe. It is not safe
429 * to call this function if another thread might be
430 * concurrently obtaining random numbers from the same
431 * context or updating or reseeding the same context.
432 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000433 * \param ctx The CTR_DRBG context.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200434 * \param additional Additional data to add to the state. Can be \c NULL.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000435 * \param len The length of the additional data.
Gilles Peskine944bc582019-09-24 14:48:30 +0200436 * This must be less than
437 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
438 * where \c entropy_len is the entropy length
439 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000440 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100441 * \return \c 0 on success.
442 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200444int mbedtls_ctr_drbg_reseed( mbedtls_ctr_drbg_context *ctx,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000445 const unsigned char *additional, size_t len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000446
447/**
Rose Zadikc9474eb2018-03-27 10:58:22 +0100448 * \brief This function updates the state of the CTR_DRBG context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000449 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100450 * \note This function is not thread-safe. It is not safe
451 * to call this function if another thread might be
452 * concurrently obtaining random numbers from the same
453 * context or updating or reseeding the same context.
454 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100455 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200456 * \param additional The data to update the state with. This must not be
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200457 * \c NULL unless \p add_len is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500458 * \param add_len Length of \p additional in bytes. This must be at
459 * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Rose Zadikc9474eb2018-03-27 10:58:22 +0100460 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500461 * \return \c 0 on success.
462 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if
463 * \p add_len is more than
464 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
465 * \return An error from the underlying AES cipher on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000466 */
TRodziewicz26371e42021-06-08 16:45:41 +0200467int mbedtls_ctr_drbg_update( mbedtls_ctr_drbg_context *ctx,
468 const unsigned char *additional,
469 size_t add_len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000470
471/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000472 * \brief This function updates a CTR_DRBG instance with additional
473 * data and uses it to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000474 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200475 * This function automatically reseeds if the reseed counter is exceeded
476 * or prediction resistance is enabled.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000477 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100478 * \note This function is not thread-safe. It is not safe
479 * to call this function if another thread might be
480 * concurrently obtaining random numbers from the same
481 * context or updating or reseeding the same context.
482 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000483 * \param p_rng The CTR_DRBG context. This must be a pointer to a
484 * #mbedtls_ctr_drbg_context structure.
485 * \param output The buffer to fill.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200486 * \param output_len The length of the buffer in bytes.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200487 * \param additional Additional data to update. Can be \c NULL, in which
Gilles Peskine08875d42019-09-24 14:40:40 +0200488 * case the additional data is empty regardless of
489 * the value of \p add_len.
490 * \param add_len The length of the additional data
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200491 * if \p additional is not \c NULL.
Gilles Peskine944bc582019-09-24 14:48:30 +0200492 * This must be less than #MBEDTLS_CTR_DRBG_MAX_INPUT
493 * and less than
494 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
495 * where \c entropy_len is the entropy length
496 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000497 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100498 * \return \c 0 on success.
499 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000500 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200502int mbedtls_ctr_drbg_random_with_add( void *p_rng,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000503 unsigned char *output, size_t output_len,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000504 const unsigned char *additional, size_t add_len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000505
506/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000507 * \brief This function uses CTR_DRBG to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000508 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200509 * This function automatically reseeds if the reseed counter is exceeded
510 * or prediction resistance is enabled.
Gilles Peskinef305d922021-02-09 18:44:18 +0100511 */
512#if defined(MBEDTLS_THREADING_C)
513/**
514 * \note When Mbed TLS is built with threading support,
515 * it is safe to call mbedtls_ctr_drbg_random()
516 * from multiple threads. Other operations, including
517 * reseeding, are not thread-safe.
518 */
519#endif /* MBEDTLS_THREADING_C */
520/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000521 * \param p_rng The CTR_DRBG context. This must be a pointer to a
522 * #mbedtls_ctr_drbg_context structure.
523 * \param output The buffer to fill.
Gilles Peskine944bc582019-09-24 14:48:30 +0200524 * \param output_len The length of the buffer in bytes.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000525 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100526 * \return \c 0 on success.
527 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000528 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200530int mbedtls_ctr_drbg_random( void *p_rng,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000531 unsigned char *output, size_t output_len );
532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533#if defined(MBEDTLS_FS_IO)
Paul Bakkerfc754a92011-12-05 13:23:51 +0000534/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000535 * \brief This function writes a seed file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000536 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000537 * \param ctx The CTR_DRBG context.
538 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000539 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100540 * \return \c 0 on success.
Rose Zadikf25eb6e2018-04-16 14:51:52 +0100541 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200542 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed
Rose Zadik2f8163d2018-01-25 21:55:14 +0000543 * failure.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545int mbedtls_ctr_drbg_write_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
Paul Bakkerfc754a92011-12-05 13:23:51 +0000546
547/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000548 * \brief This function reads and updates a seed file. The seed
549 * is added to this instance.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000550 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000551 * \param ctx The CTR_DRBG context.
552 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000553 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100554 * \return \c 0 on success.
555 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200556 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on
557 * reseed failure.
558 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if the existing
559 * seed file is too large.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000560 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200561int mbedtls_ctr_drbg_update_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
562#endif /* MBEDTLS_FS_IO */
Paul Bakkerfc754a92011-12-05 13:23:51 +0000563
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500564#if defined(MBEDTLS_SELF_TEST)
565
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000566/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000567 * \brief The CTR_DRBG checkup routine.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000568 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100569 * \return \c 0 on success.
570 * \return \c 1 on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572int mbedtls_ctr_drbg_self_test( int verbose );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000573
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500574#endif /* MBEDTLS_SELF_TEST */
575
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000576#ifdef __cplusplus
577}
578#endif
579
580#endif /* ctr_drbg.h */