blob: c188b08ae235eb51f188ee532746b9c4b16e8e7c [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020053#define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034 /**< The entropy source failed. */
Rose Zadik2f8163d2018-01-25 21:55:14 +000054#define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036 /**< The requested random buffer length is too big. */
55#define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038 /**< The input (entropy + additional data) is too large. */
56#define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A /**< Read or write error in file. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +000057
Rose Zadik2f8163d2018-01-25 21:55:14 +000058#define MBEDTLS_CTR_DRBG_BLOCKSIZE 16 /**< The block size used by the cipher. */
Nir Sonnenscheince266e42018-08-29 10:11:46 +030059
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030060#if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
Gilles Peskine08875d42019-09-24 14:40:40 +020061#define MBEDTLS_CTR_DRBG_KEYSIZE 16
62/**< The key size in bytes used by the cipher.
63 *
64 * Compile-time choice: 16 bytes (128 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020065 * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020066 */
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +030067#else
Gilles Peskine08875d42019-09-24 14:40:40 +020068#define MBEDTLS_CTR_DRBG_KEYSIZE 32
69/**< The key size in bytes used by the cipher.
70 *
71 * Compile-time choice: 32 bytes (256 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020072 * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020073 */
Nir Sonnenscheina4588d42018-07-30 16:59:36 +030074#endif
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030075
Rose Zadik2f8163d2018-01-25 21:55:14 +000076#define MBEDTLS_CTR_DRBG_KEYBITS ( MBEDTLS_CTR_DRBG_KEYSIZE * 8 ) /**< The key size for the DRBG operation, in bits. */
77#define MBEDTLS_CTR_DRBG_SEEDLEN ( MBEDTLS_CTR_DRBG_KEYSIZE + MBEDTLS_CTR_DRBG_BLOCKSIZE ) /**< The seed length, calculated as (counter + AES key). */
Paul Bakker9bcf16c2013-06-24 19:31:17 +020078
Paul Bakker088c5c52014-04-25 11:11:10 +020079/**
80 * \name SECTION: Module settings
81 *
82 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020083 * Either change them in mbedtls_config.h or define them using the compiler command
Rose Zadik2f8163d2018-01-25 21:55:14 +000084 * line.
Paul Bakker088c5c52014-04-25 11:11:10 +020085 * \{
86 */
87
Gilles Peskinedddda812019-10-03 14:22:04 +020088/** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN
89 *
90 * \brief The amount of entropy used per seed by default, in bytes.
91 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092#if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
93#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
Gilles Peskinedddda812019-10-03 14:22:04 +020094/** This is 48 bytes because the entropy module uses SHA-512
Gilles Peskined0c64c82019-10-03 14:20:46 +020095 * (\c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled).
Gilles Peskine08875d42019-09-24 14:40:40 +020096 */
Rose Zadik2f8163d2018-01-25 21:55:14 +000097#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Gilles Peskinedddda812019-10-03 14:22:04 +020098
99#else /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
100
101/** This is 32 bytes because the entropy module uses SHA-256
102 * (the SHA512 module is disabled or
103 * \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled).
Rose Zadik2f8163d2018-01-25 21:55:14 +0000104 */
Gilles Peskinedddda812019-10-03 14:22:04 +0200105#if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
106/** \warning To achieve a 256-bit security strength, you must pass a nonce
107 * to mbedtls_ctr_drbg_seed().
108 */
109#endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */
Gilles Peskine08875d42019-09-24 14:40:40 +0200110#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
Gilles Peskinedddda812019-10-03 14:22:04 +0200111#endif /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
112#endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114#if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000115#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
116/**< The interval before reseed is performed by default. */
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_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000120#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
121/**< The maximum number of additional input Bytes. */
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_REQUEST)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000125#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
126/**< The maximum number of requested Bytes per call. */
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_SEED_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000130#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Gilles Peskine08875d42019-09-24 14:40:40 +0200131/**< The maximum size of seed or reseed buffer in bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200132#endif
133
134/* \} name SECTION: Module settings */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000135
Rose Zadik2f8163d2018-01-25 21:55:14 +0000136#define MBEDTLS_CTR_DRBG_PR_OFF 0
137/**< Prediction resistance is disabled. */
138#define MBEDTLS_CTR_DRBG_PR_ON 1
139/**< Prediction resistance is enabled. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000140
141#ifdef __cplusplus
142extern "C" {
143#endif
144
Gilles Peskine69971662019-10-23 19:39:36 +0200145#if MBEDTLS_CTR_DRBG_ENTROPY_LEN >= MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2
146/** The default length of the nonce read from the entropy source.
147 *
148 * This is \c 0 because a single read from the entropy source is sufficient
149 * to include a nonce.
150 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
151 */
152#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN 0
153#else
154/** The default length of the nonce read from the entropy source.
155 *
156 * This is half of the default entropy length because a single read from
157 * the entropy source does not provide enough material to form a nonce.
158 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
159 */
160#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN ( MBEDTLS_CTR_DRBG_ENTROPY_LEN + 1 ) / 2
161#endif
162
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000163/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000164 * \brief The CTR_DRBG context structure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000165 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200166typedef struct mbedtls_ctr_drbg_context
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000167{
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200168 unsigned char MBEDTLS_PRIVATE(counter)[16]; /*!< The counter (V). */
169 int MBEDTLS_PRIVATE(reseed_counter); /*!< The reseed counter.
Gilles Peskinec0ace352019-10-22 17:06:31 +0200170 * This is the number of requests that have
171 * been made since the last (re)seeding,
Gilles Peskine9be50982019-10-22 18:42:27 +0200172 * minus one.
173 * Before the initial seeding, this field
174 * contains the amount of entropy in bytes
Jaeden Ameroa15c7132020-01-09 13:02:16 +0000175 * to use as a nonce for the initial seeding,
176 * or -1 if no nonce length has been explicitly
177 * set (see mbedtls_ctr_drbg_set_nonce_len()).
Gilles Peskine9be50982019-10-22 18:42:27 +0200178 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200179 int MBEDTLS_PRIVATE(prediction_resistance); /*!< This determines whether prediction
Rose Zadik2f8163d2018-01-25 21:55:14 +0000180 resistance is enabled, that is
181 whether to systematically reseed before
182 each random generation. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200183 size_t MBEDTLS_PRIVATE(entropy_len); /*!< The amount of entropy grabbed on each
Gilles Peskinec0ace352019-10-22 17:06:31 +0200184 seed or reseed operation, in bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200185 int MBEDTLS_PRIVATE(reseed_interval); /*!< The reseed interval.
Gilles Peskinec0ace352019-10-22 17:06:31 +0200186 * This is the maximum number of requests
187 * that can be made between reseedings. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000188
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200189 mbedtls_aes_context MBEDTLS_PRIVATE(aes_ctx); /*!< The AES context. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000190
191 /*
192 * Callbacks (Entropy)
193 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200194 int (*MBEDTLS_PRIVATE(f_entropy))(void *, unsigned char *, size_t);
Rose Zadik2f8163d2018-01-25 21:55:14 +0000195 /*!< The entropy callback function. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000196
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200197 void *MBEDTLS_PRIVATE(p_entropy); /*!< The context for the entropy function. */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100198
199#if defined(MBEDTLS_THREADING_C)
Gilles Peskineda290f92021-02-09 18:44:02 +0100200 /* Invariant: the mutex is initialized if and only if f_entropy != NULL.
201 * This means that the mutex is initialized during the initial seeding
202 * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free().
203 *
204 * Note that this invariant may change without notice. Do not rely on it
205 * and do not access the mutex directly in application code.
206 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200207 mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100208#endif
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000209}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210mbedtls_ctr_drbg_context;
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000211
212/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000213 * \brief This function initializes the CTR_DRBG context,
214 * and prepares it for mbedtls_ctr_drbg_seed()
215 * or mbedtls_ctr_drbg_free().
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200216 *
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800217 * \note The reseed interval is
218 * #MBEDTLS_CTR_DRBG_RESEED_INTERVAL by default.
219 * You can override it by calling
220 * mbedtls_ctr_drbg_set_reseed_interval().
221 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000222 * \param ctx The CTR_DRBG context to initialize.
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200223 */
224void mbedtls_ctr_drbg_init( mbedtls_ctr_drbg_context *ctx );
225
226/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000227 * \brief This function seeds and sets up the CTR_DRBG
228 * entropy source for future reseeds.
Paul Bakker9af723c2014-05-01 13:03:14 +0200229 *
Gilles Peskine223deea2019-09-24 14:48:53 +0200230 * A typical choice for the \p f_entropy and \p p_entropy parameters is
231 * to use the entropy module:
232 * - \p f_entropy is mbedtls_entropy_func();
233 * - \p p_entropy is an instance of ::mbedtls_entropy_context initialized
234 * with mbedtls_entropy_init() (which registers the platform's default
235 * entropy sources).
236 *
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200237 * The entropy length is #MBEDTLS_CTR_DRBG_ENTROPY_LEN by default.
238 * You can override it by calling mbedtls_ctr_drbg_set_entropy_len().
Gilles Peskineec51dd12019-09-30 15:01:02 +0200239 *
Gilles Peskinee9a34542019-10-22 20:43:24 +0200240 * The entropy nonce length is:
241 * - \c 0 if the entropy length is at least 3/2 times the entropy length,
242 * which guarantees that the security strength is the maximum permitted
243 * by the key size and entropy length according to NIST SP 800-90A §10.2.1;
244 * - Half the entropy length otherwise.
245 * You can override it by calling mbedtls_ctr_drbg_set_nonce_len().
Gilles Peskine69971662019-10-23 19:39:36 +0200246 * With the default entropy length, the entropy nonce length is
247 * #MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN.
248 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200249 * You can provide a nonce and personalization string in addition to the
Gilles Peskine223deea2019-09-24 14:48:53 +0200250 * entropy source, to make this instantiation as unique as possible.
Gilles Peskine9be50982019-10-22 18:42:27 +0200251 * See SP 800-90A §8.6.7 for more details about nonces.
Gilles Peskine223deea2019-09-24 14:48:53 +0200252 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200253 * The _seed_material_ value passed to the derivation function in
254 * the CTR_DRBG Instantiate Process described in NIST SP 800-90A §10.2.1.3.2
255 * is the concatenation of the following strings:
256 * - A string obtained by calling \p f_entropy function for the entropy
257 * length.
Gilles Peskinee9a34542019-10-22 20:43:24 +0200258 */
Gilles Peskine69971662019-10-23 19:39:36 +0200259#if MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN == 0
Gilles Peskinee9a34542019-10-22 20:43:24 +0200260/**
261 * - If mbedtls_ctr_drbg_set_nonce_len() has been called, a string
262 * obtained by calling \p f_entropy function for the specified length.
263 */
264#else
265/**
266 * - A string obtained by calling \p f_entropy function for the entropy nonce
267 * length. If the entropy nonce length is \c 0, this function does not
268 * make a second call to \p f_entropy.
269 */
270#endif
Gilles Peskinef305d922021-02-09 18:44:18 +0100271#if defined(MBEDTLS_THREADING_C)
272/**
273 * \note When Mbed TLS is built with threading support,
274 * after this function returns successfully,
275 * it is safe to call mbedtls_ctr_drbg_random()
276 * from multiple threads. Other operations, including
277 * reseeding, are not thread-safe.
278 */
279#endif /* MBEDTLS_THREADING_C */
Gilles Peskinee9a34542019-10-22 20:43:24 +0200280/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200281 * - The \p custom string.
282 *
283 * \note To achieve the nominal security strength permitted
284 * by CTR_DRBG, the entropy length must be:
285 * - at least 16 bytes for a 128-bit strength
286 * (maximum achievable strength when using AES-128);
287 * - at least 32 bytes for a 256-bit strength
288 * (maximum achievable strength when using AES-256).
289 *
290 * In addition, if you do not pass a nonce in \p custom,
291 * the sum of the entropy length
Gilles Peskinee9a34542019-10-22 20:43:24 +0200292 * and the entropy nonce length must be:
Gilles Peskine9be50982019-10-22 18:42:27 +0200293 * - at least 24 bytes for a 128-bit strength
294 * (maximum achievable strength when using AES-128);
295 * - at least 48 bytes for a 256-bit strength
296 * (maximum achievable strength when using AES-256).
297 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000298 * \param ctx The CTR_DRBG context to seed.
Gilles Peskinebd326f92019-10-28 17:33:07 +0100299 * It must have been initialized with
300 * mbedtls_ctr_drbg_init().
301 * After a successful call to mbedtls_ctr_drbg_seed(),
302 * you may not call mbedtls_ctr_drbg_seed() again on
303 * the same context unless you call
304 * mbedtls_ctr_drbg_free() and mbedtls_ctr_drbg_init()
305 * again first.
Gilles Peskinef305d922021-02-09 18:44:18 +0100306 * After a failed call to mbedtls_ctr_drbg_seed(),
307 * you must call mbedtls_ctr_drbg_free().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000308 * \param f_entropy The entropy callback, taking as arguments the
309 * \p p_entropy context, the buffer to fill, and the
Gilles Peskine08875d42019-09-24 14:40:40 +0200310 * length of the buffer.
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200311 * \p f_entropy is always called with a buffer size
Gilles Peskine9be50982019-10-22 18:42:27 +0200312 * less than or equal to the entropy length.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200313 * \param p_entropy The entropy context to pass to \p f_entropy.
Gilles Peskine217b8152019-10-01 18:39:45 +0200314 * \param custom The personalization string.
315 * This can be \c NULL, in which case the personalization
316 * string is empty regardless of the value of \p len.
317 * \param len The length of the personalization string.
Gilles Peskine944bc582019-09-24 14:48:30 +0200318 * This must be at most
319 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
320 * - #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000321 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100322 * \return \c 0 on success.
323 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000324 */
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200325int mbedtls_ctr_drbg_seed( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000326 int (*f_entropy)(void *, unsigned char *, size_t),
327 void *p_entropy,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000328 const unsigned char *custom,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000329 size_t len );
330
331/**
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800332 * \brief This function resets CTR_DRBG context to the state immediately
333 * after initial call of mbedtls_ctr_drbg_init().
Paul Bakkerfff03662014-06-18 16:21:25 +0200334 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000335 * \param ctx The CTR_DRBG context to clear.
Paul Bakkerfff03662014-06-18 16:21:25 +0200336 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337void mbedtls_ctr_drbg_free( mbedtls_ctr_drbg_context *ctx );
Paul Bakkerfff03662014-06-18 16:21:25 +0200338
339/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000340 * \brief This function turns prediction resistance on or off.
341 * The default value is off.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000342 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000343 * \note If enabled, entropy is gathered at the beginning of
Gilles Peskineec51dd12019-09-30 15:01:02 +0200344 * every call to mbedtls_ctr_drbg_random_with_add()
345 * or mbedtls_ctr_drbg_random().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000346 * Only use this if your entropy source has sufficient
347 * throughput.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000348 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000349 * \param ctx The CTR_DRBG context.
350 * \param resistance #MBEDTLS_CTR_DRBG_PR_ON or #MBEDTLS_CTR_DRBG_PR_OFF.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352void mbedtls_ctr_drbg_set_prediction_resistance( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000353 int resistance );
354
355/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000356 * \brief This function sets the amount of entropy grabbed on each
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200357 * seed or reseed.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200358 *
359 * The default value is #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000360 *
Gilles Peskinedddda812019-10-03 14:22:04 +0200361 * \note The security strength of CTR_DRBG is bounded by the
362 * entropy length. Thus:
363 * - When using AES-256
364 * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled,
365 * which is the default),
366 * \p len must be at least 32 (in bytes)
367 * to achieve a 256-bit strength.
368 * - When using AES-128
369 * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled)
370 * \p len must be at least 16 (in bytes)
371 * to achieve a 128-bit strength.
Gilles Peskine223deea2019-09-24 14:48:53 +0200372 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000373 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200374 * \param len The amount of entropy to grab, in bytes.
Gilles Peskine9be50982019-10-22 18:42:27 +0200375 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
376 * and at most the maximum length accepted by the
377 * entropy function that is set in the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379void mbedtls_ctr_drbg_set_entropy_len( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000380 size_t len );
381
382/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200383 * \brief This function sets the amount of entropy grabbed
384 * as a nonce for the initial seeding.
385 *
386 * Call this function before calling mbedtls_ctr_drbg_seed() to read
387 * a nonce from the entropy source during the initial seeding.
388 *
389 * \param ctx The CTR_DRBG context.
390 * \param len The amount of entropy to grab for the nonce, in bytes.
391 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
392 * and at most the maximum length accepted by the
393 * entropy function that is set in the context.
394 *
395 * \return \c 0 on success.
396 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if \p len is
397 * more than #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
398 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
399 * if the initial seeding has already taken place.
400 */
401int mbedtls_ctr_drbg_set_nonce_len( mbedtls_ctr_drbg_context *ctx,
402 size_t len );
403
404/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000405 * \brief This function sets the reseed interval.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200406 *
407 * The reseed interval is the number of calls to mbedtls_ctr_drbg_random()
408 * or mbedtls_ctr_drbg_random_with_add() after which the entropy function
409 * is called again.
410 *
411 * The default value is #MBEDTLS_CTR_DRBG_RESEED_INTERVAL.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000412 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000413 * \param ctx The CTR_DRBG context.
414 * \param interval The reseed interval.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416void mbedtls_ctr_drbg_set_reseed_interval( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000417 int interval );
418
419/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000420 * \brief This function reseeds the CTR_DRBG context, that is
421 * extracts data from the entropy source.
Paul Bakker9af723c2014-05-01 13:03:14 +0200422 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100423 * \note This function is not thread-safe. It is not safe
424 * to call this function if another thread might be
425 * concurrently obtaining random numbers from the same
426 * context or updating or reseeding the same context.
427 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000428 * \param ctx The CTR_DRBG context.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200429 * \param additional Additional data to add to the state. Can be \c NULL.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000430 * \param len The length of the additional data.
Gilles Peskine944bc582019-09-24 14:48:30 +0200431 * This must be less than
432 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
433 * where \c entropy_len is the entropy length
434 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000435 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100436 * \return \c 0 on success.
437 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439int mbedtls_ctr_drbg_reseed( mbedtls_ctr_drbg_context *ctx,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000440 const unsigned char *additional, size_t len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000441
442/**
Rose Zadikc9474eb2018-03-27 10:58:22 +0100443 * \brief This function updates the state of the CTR_DRBG context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000444 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100445 * \note This function is not thread-safe. It is not safe
446 * to call this function if another thread might be
447 * concurrently obtaining random numbers from the same
448 * context or updating or reseeding the same context.
449 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100450 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200451 * \param additional The data to update the state with. This must not be
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200452 * \c NULL unless \p add_len is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500453 * \param add_len Length of \p additional in bytes. This must be at
454 * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Rose Zadikc9474eb2018-03-27 10:58:22 +0100455 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500456 * \return \c 0 on success.
457 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if
458 * \p add_len is more than
459 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
460 * \return An error from the underlying AES cipher on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000461 */
TRodziewicz26371e42021-06-08 16:45:41 +0200462int mbedtls_ctr_drbg_update( mbedtls_ctr_drbg_context *ctx,
463 const unsigned char *additional,
464 size_t add_len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000465
466/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000467 * \brief This function updates a CTR_DRBG instance with additional
468 * data and uses it to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000469 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200470 * This function automatically reseeds if the reseed counter is exceeded
471 * or prediction resistance is enabled.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000472 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100473 * \note This function is not thread-safe. It is not safe
474 * to call this function if another thread might be
475 * concurrently obtaining random numbers from the same
476 * context or updating or reseeding the same context.
477 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000478 * \param p_rng The CTR_DRBG context. This must be a pointer to a
479 * #mbedtls_ctr_drbg_context structure.
480 * \param output The buffer to fill.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200481 * \param output_len The length of the buffer in bytes.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200482 * \param additional Additional data to update. Can be \c NULL, in which
Gilles Peskine08875d42019-09-24 14:40:40 +0200483 * case the additional data is empty regardless of
484 * the value of \p add_len.
485 * \param add_len The length of the additional data
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200486 * if \p additional is not \c NULL.
Gilles Peskine944bc582019-09-24 14:48:30 +0200487 * This must be less than #MBEDTLS_CTR_DRBG_MAX_INPUT
488 * and less than
489 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
490 * where \c entropy_len is the entropy length
491 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000492 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100493 * \return \c 0 on success.
494 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000495 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497int mbedtls_ctr_drbg_random_with_add( void *p_rng,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000498 unsigned char *output, size_t output_len,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000499 const unsigned char *additional, size_t add_len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000500
501/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000502 * \brief This function uses CTR_DRBG to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000503 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200504 * This function automatically reseeds if the reseed counter is exceeded
505 * or prediction resistance is enabled.
Gilles Peskinef305d922021-02-09 18:44:18 +0100506 */
507#if defined(MBEDTLS_THREADING_C)
508/**
509 * \note When Mbed TLS is built with threading support,
510 * it is safe to call mbedtls_ctr_drbg_random()
511 * from multiple threads. Other operations, including
512 * reseeding, are not thread-safe.
513 */
514#endif /* MBEDTLS_THREADING_C */
515/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000516 * \param p_rng The CTR_DRBG context. This must be a pointer to a
517 * #mbedtls_ctr_drbg_context structure.
518 * \param output The buffer to fill.
Gilles Peskine944bc582019-09-24 14:48:30 +0200519 * \param output_len The length of the buffer in bytes.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000520 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100521 * \return \c 0 on success.
522 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000523 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000524 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525int mbedtls_ctr_drbg_random( void *p_rng,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000526 unsigned char *output, size_t output_len );
527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528#if defined(MBEDTLS_FS_IO)
Paul Bakkerfc754a92011-12-05 13:23:51 +0000529/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000530 * \brief This function writes a seed file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000531 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000532 * \param ctx The CTR_DRBG context.
533 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000534 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100535 * \return \c 0 on success.
Rose Zadikf25eb6e2018-04-16 14:51:52 +0100536 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200537 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed
Rose Zadik2f8163d2018-01-25 21:55:14 +0000538 * failure.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540int mbedtls_ctr_drbg_write_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
Paul Bakkerfc754a92011-12-05 13:23:51 +0000541
542/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000543 * \brief This function reads and updates a seed file. The seed
544 * is added to this instance.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000545 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000546 * \param ctx The CTR_DRBG context.
547 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000548 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100549 * \return \c 0 on success.
550 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200551 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on
552 * reseed failure.
553 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if the existing
554 * seed file is too large.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556int mbedtls_ctr_drbg_update_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
557#endif /* MBEDTLS_FS_IO */
Paul Bakkerfc754a92011-12-05 13:23:51 +0000558
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500559#if defined(MBEDTLS_SELF_TEST)
560
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000561/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000562 * \brief The CTR_DRBG checkup routine.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000563 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100564 * \return \c 0 on success.
565 * \return \c 1 on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567int mbedtls_ctr_drbg_self_test( int verbose );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000568
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500569#endif /* MBEDTLS_SELF_TEST */
570
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000571#ifdef __cplusplus
572}
573#endif
574
575#endif /* ctr_drbg.h */