blob: 892e3e353115c10ba39479135213a5a4379f5b31 [file] [log] [blame]
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001/**
2 * \file ctr_drbg.h
3 *
Gilles Peskinee3d8cf12019-10-02 19:02:13 +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 Peskinedd5b67b2019-10-03 14:20:46 +020013 * (if \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled at compile time)
Gilles Peskinecc748722019-10-03 14:22:04 +020014 * as the underlying block cipher, with a derivation function.
15 * The initial seeding grabs #MBEDTLS_CTR_DRBG_ENTROPY_LEN bytes of entropy.
16 * See the documentation of mbedtls_ctr_drbg_seed() for more details.
17 *
18 * Based on NIST SP 800-90A §10.2.1 table 3 and NIST SP 800-57 part 1 table 2,
19 * here are the security strengths achieved in typical configuration:
Gilles Peskine1eb7ba72019-09-24 14:48:53 +020020 * - 256 bits under the default configuration of the library, with AES-256
Gilles Peskinedd5b67b2019-10-03 14:20:46 +020021 * and with #MBEDTLS_CTR_DRBG_ENTROPY_LEN set to 48 or more.
Gilles Peskine1eb7ba72019-09-24 14:48:53 +020022 * - 256 bits if AES-256 is used, #MBEDTLS_CTR_DRBG_ENTROPY_LEN is set
Gilles Peskine3354f752019-09-25 20:22:24 +020023 * to 32 or more, and the DRBG is initialized with an explicit
Gilles Peskine4284bec2019-09-26 14:54:42 +020024 * nonce in the \c custom parameter to mbedtls_ctr_drbg_seed().
Gilles Peskine1eb7ba72019-09-24 14:48:53 +020025 * - 128 bits if AES-256 is used but #MBEDTLS_CTR_DRBG_ENTROPY_LEN is
26 * between 24 and 47 and the DRBG is not initialized with an explicit
27 * nonce (see mbedtls_ctr_drbg_seed()).
Gilles Peskinedd5b67b2019-10-03 14:20:46 +020028 * - 128 bits if AES-128 is used (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY enabled)
Gilles Peskine1eb7ba72019-09-24 14:48:53 +020029 * and #MBEDTLS_CTR_DRBG_ENTROPY_LEN is set to 24 or more (which is
30 * always the case unless it is explicitly set to a different value
Gilles Peskinedd5b67b2019-10-03 14:20:46 +020031 * in config.h).
Gilles Peskine8cec70a2019-10-02 18:23:38 +020032 *
33 * Note that the value of #MBEDTLS_CTR_DRBG_ENTROPY_LEN defaults to:
Gilles Peskinedd5b67b2019-10-03 14:20:46 +020034 * - \c 48 if the module \c MBEDTLS_SHA512_C is enabled and the symbol
35 * \c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled at compile time.
Gilles Peskine8cec70a2019-10-02 18:23:38 +020036 * This is the default configuration of the library.
Gilles Peskinedd5b67b2019-10-03 14:20:46 +020037 * - \c 32 if the module \c MBEDTLS_SHA512_C is disabled at compile time.
38 * - \c 32 if \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled at compile time.
Darryl Greena40a1012018-01-05 15:33:17 +000039 */
40/*
Bence Szépkútia2947ac2020-08-19 16:37:36 +020041 * Copyright The Mbed TLS Contributors
Bence Szépkútif744bd72020-06-05 13:02:18 +020042 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
43 *
44 * This file is provided under the Apache License 2.0, or the
45 * GNU General Public License v2.0 or later.
46 *
47 * **********
48 * Apache License 2.0:
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020049 *
50 * Licensed under the Apache License, Version 2.0 (the "License"); you may
51 * not use this file except in compliance with the License.
52 * You may obtain a copy of the License at
53 *
54 * http://www.apache.org/licenses/LICENSE-2.0
55 *
56 * Unless required by applicable law or agreed to in writing, software
57 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
58 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
59 * See the License for the specific language governing permissions and
60 * limitations under the License.
Paul Bakker0e04d0e2011-11-27 14:46:59 +000061 *
Bence Szépkútif744bd72020-06-05 13:02:18 +020062 * **********
63 *
64 * **********
65 * GNU General Public License v2.0 or later:
66 *
67 * This program is free software; you can redistribute it and/or modify
68 * it under the terms of the GNU General Public License as published by
69 * the Free Software Foundation; either version 2 of the License, or
70 * (at your option) any later version.
71 *
72 * This program is distributed in the hope that it will be useful,
73 * but WITHOUT ANY WARRANTY; without even the implied warranty of
74 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
75 * GNU General Public License for more details.
76 *
77 * You should have received a copy of the GNU General Public License along
78 * with this program; if not, write to the Free Software Foundation, Inc.,
79 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
80 *
81 * **********
Paul Bakker0e04d0e2011-11-27 14:46:59 +000082 */
Rose Zadik2f8163d2018-01-25 21:55:14 +000083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020084#ifndef MBEDTLS_CTR_DRBG_H
85#define MBEDTLS_CTR_DRBG_H
Paul Bakker0e04d0e2011-11-27 14:46:59 +000086
Ron Eldor8b0cf2e2018-02-14 16:02:41 +020087#if !defined(MBEDTLS_CONFIG_FILE)
88#include "config.h"
89#else
90#include MBEDTLS_CONFIG_FILE
91#endif
92
Paul Bakker0e04d0e2011-11-27 14:46:59 +000093#include "aes.h"
94
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010095#if defined(MBEDTLS_THREADING_C)
Ron Eldor6fd941f2017-05-14 16:17:33 +030096#include "threading.h"
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010097#endif
98
Gilles Peskine1990fab2021-07-26 18:48:10 +020099/** The entropy source failed. */
100#define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034
101/** The requested random buffer length is too big. */
102#define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036
103/** The input (entropy + additional data) is too large. */
104#define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038
105/** Read or write error in file. */
106#define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000107
Rose Zadik2f8163d2018-01-25 21:55:14 +0000108#define MBEDTLS_CTR_DRBG_BLOCKSIZE 16 /**< The block size used by the cipher. */
Nir Sonnenscheince266e42018-08-29 10:11:46 +0300109
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +0300110#if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200111#define MBEDTLS_CTR_DRBG_KEYSIZE 16
112/**< The key size in bytes used by the cipher.
113 *
114 * Compile-time choice: 16 bytes (128 bits)
Gilles Peskinedd5b67b2019-10-03 14:20:46 +0200115 * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled.
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200116 */
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +0300117#else
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200118#define MBEDTLS_CTR_DRBG_KEYSIZE 32
119/**< The key size in bytes used by the cipher.
120 *
121 * Compile-time choice: 32 bytes (256 bits)
Gilles Peskinedd5b67b2019-10-03 14:20:46 +0200122 * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled.
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200123 */
Nir Sonnenscheina4588d42018-07-30 16:59:36 +0300124#endif
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +0300125
Rose Zadik2f8163d2018-01-25 21:55:14 +0000126#define MBEDTLS_CTR_DRBG_KEYBITS ( MBEDTLS_CTR_DRBG_KEYSIZE * 8 ) /**< The key size for the DRBG operation, in bits. */
127#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 +0200128
Paul Bakker088c5c52014-04-25 11:11:10 +0200129/**
130 * \name SECTION: Module settings
131 *
132 * The configuration options you can set for this module are in this section.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000133 * Either change them in config.h or define them using the compiler command
134 * line.
Paul Bakker088c5c52014-04-25 11:11:10 +0200135 * \{
136 */
137
Gilles Peskinecc748722019-10-03 14:22:04 +0200138/** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN
139 *
140 * \brief The amount of entropy used per seed by default, in bytes.
141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142#if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
143#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
Gilles Peskinecc748722019-10-03 14:22:04 +0200144/** This is 48 bytes because the entropy module uses SHA-512
Gilles Peskinedd5b67b2019-10-03 14:20:46 +0200145 * (\c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled).
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200146 */
Rose Zadik2f8163d2018-01-25 21:55:14 +0000147#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Gilles Peskinecc748722019-10-03 14:22:04 +0200148
149#else /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
150
151/** This is 32 bytes because the entropy module uses SHA-256
152 * (the SHA512 module is disabled or
153 * \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled).
Rose Zadik2f8163d2018-01-25 21:55:14 +0000154 */
Gilles Peskinecc748722019-10-03 14:22:04 +0200155#if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
156/** \warning To achieve a 256-bit security strength, you must pass a nonce
157 * to mbedtls_ctr_drbg_seed().
158 */
159#endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200160#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
Gilles Peskinecc748722019-10-03 14:22:04 +0200161#endif /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
162#endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200164#if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000165#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
166/**< The interval before reseed is performed by default. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200167#endif
168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169#if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000170#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
171/**< The maximum number of additional input Bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200172#endif
173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174#if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000175#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
176/**< The maximum number of requested Bytes per call. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200177#endif
178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179#if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000180#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200181/**< The maximum size of seed or reseed buffer in bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200182#endif
183
184/* \} name SECTION: Module settings */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000185
Rose Zadik2f8163d2018-01-25 21:55:14 +0000186#define MBEDTLS_CTR_DRBG_PR_OFF 0
187/**< Prediction resistance is disabled. */
188#define MBEDTLS_CTR_DRBG_PR_ON 1
189/**< Prediction resistance is enabled. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000190
191#ifdef __cplusplus
192extern "C" {
193#endif
194
195/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000196 * \brief The CTR_DRBG context structure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000197 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200198typedef struct mbedtls_ctr_drbg_context
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000199{
Rose Zadik2f8163d2018-01-25 21:55:14 +0000200 unsigned char counter[16]; /*!< The counter (V). */
201 int reseed_counter; /*!< The reseed counter. */
202 int prediction_resistance; /*!< This determines whether prediction
203 resistance is enabled, that is
204 whether to systematically reseed before
205 each random generation. */
206 size_t entropy_len; /*!< The amount of entropy grabbed on each
207 seed or reseed operation. */
208 int reseed_interval; /*!< The reseed interval. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000209
Rose Zadik2f8163d2018-01-25 21:55:14 +0000210 mbedtls_aes_context aes_ctx; /*!< The AES context. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000211
212 /*
213 * Callbacks (Entropy)
214 */
215 int (*f_entropy)(void *, unsigned char *, size_t);
Rose Zadik2f8163d2018-01-25 21:55:14 +0000216 /*!< The entropy callback function. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000217
Rose Zadik2f8163d2018-01-25 21:55:14 +0000218 void *p_entropy; /*!< The context for the entropy function. */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100219
220#if defined(MBEDTLS_THREADING_C)
Gilles Peskine2ecc0b82021-02-09 18:44:02 +0100221 /* Invariant: the mutex is initialized if and only if f_entropy != NULL.
222 * This means that the mutex is initialized during the initial seeding
223 * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free().
224 *
225 * Note that this invariant may change without notice. Do not rely on it
226 * and do not access the mutex directly in application code.
227 */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100228 mbedtls_threading_mutex_t mutex;
229#endif
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000230}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231mbedtls_ctr_drbg_context;
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000232
233/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000234 * \brief This function initializes the CTR_DRBG context,
235 * and prepares it for mbedtls_ctr_drbg_seed()
236 * or mbedtls_ctr_drbg_free().
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200237 *
Gavin Acquroff77cb30c2020-03-01 17:06:11 -0800238 * \note The reseed interval is
239 * #MBEDTLS_CTR_DRBG_RESEED_INTERVAL by default.
240 * You can override it by calling
241 * mbedtls_ctr_drbg_set_reseed_interval().
242 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000243 * \param ctx The CTR_DRBG context to initialize.
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200244 */
245void mbedtls_ctr_drbg_init( mbedtls_ctr_drbg_context *ctx );
246
247/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000248 * \brief This function seeds and sets up the CTR_DRBG
249 * entropy source for future reseeds.
Paul Bakker9af723c2014-05-01 13:03:14 +0200250 *
Gilles Peskine1eb7ba72019-09-24 14:48:53 +0200251 * A typical choice for the \p f_entropy and \p p_entropy parameters is
252 * to use the entropy module:
253 * - \p f_entropy is mbedtls_entropy_func();
254 * - \p p_entropy is an instance of ::mbedtls_entropy_context initialized
255 * with mbedtls_entropy_init() (which registers the platform's default
256 * entropy sources).
257 *
Gilles Peskine912ffe42019-10-04 12:15:55 +0200258 * The entropy length is #MBEDTLS_CTR_DRBG_ENTROPY_LEN by default.
259 * You can override it by calling mbedtls_ctr_drbg_set_entropy_len().
Gilles Peskine0bf49eb2019-09-30 15:01:02 +0200260 *
Gilles Peskine9fb45182019-10-01 18:39:45 +0200261 * You can provide a personalization string in addition to the
Gilles Peskine1eb7ba72019-09-24 14:48:53 +0200262 * entropy source, to make this instantiation as unique as possible.
263 *
264 * \note The _seed_material_ value passed to the derivation
265 * function in the CTR_DRBG Instantiate Process
266 * described in NIST SP 800-90A §10.2.1.3.2
267 * is the concatenation of the string obtained from
268 * calling \p f_entropy and the \p custom string.
269 * The origin of the nonce depends on the value of
270 * the entropy length relative to the security strength.
Gilles Peskine1eb7ba72019-09-24 14:48:53 +0200271 * - If the entropy length is at least 1.5 times the
272 * security strength then the nonce is taken from the
273 * string obtained with \p f_entropy.
274 * - If the entropy length is less than the security
275 * strength, then the nonce is taken from \p custom.
276 * In this case, for compliance with SP 800-90A,
277 * you must pass a unique value of \p custom at
278 * each invocation. See SP 800-90A §8.6.7 for more
279 * details.
Gilles Peskinecc748722019-10-03 14:22:04 +0200280 */
281#if MBEDTLS_CTR_DRBG_ENTROPY_LEN < MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2
282/** \warning When #MBEDTLS_CTR_DRBG_ENTROPY_LEN is less than
283 * #MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2, to achieve the
284 * maximum security strength permitted by CTR_DRBG,
285 * you must pass a value of \p custom that is a nonce:
286 * this value must never be repeated in subsequent
287 * runs of the same application or on a different
288 * device.
289 */
290#endif
Gilles Peskine83195692021-02-09 18:44:18 +0100291#if defined(MBEDTLS_THREADING_C)
292/**
293 * \note When Mbed TLS is built with threading support,
294 * after this function returns successfully,
295 * it is safe to call mbedtls_ctr_drbg_random()
296 * from multiple threads. Other operations, including
297 * reseeding, are not thread-safe.
298 */
299#endif /* MBEDTLS_THREADING_C */
Gilles Peskinecc748722019-10-03 14:22:04 +0200300/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000301 * \param ctx The CTR_DRBG context to seed.
Gilles Peskineb02a2332019-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 Peskine83195692021-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 Peskine6b2c50c2019-09-24 14:40:40 +0200313 * length of the buffer.
Gilles Peskine912ffe42019-10-04 12:15:55 +0200314 * \p f_entropy is always called with a buffer size
315 * equal to the entropy length.
Gilles Peskine0bf49eb2019-09-30 15:01:02 +0200316 * \param p_entropy The entropy context to pass to \p f_entropy.
Gilles Peskine9fb45182019-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 Peskine80b3f4b2019-09-24 14:48:30 +0200321 * This must be at most
Gilles Peskinee215a4d2019-10-03 15:13:08 +0200322 * #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 */
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200328int mbedtls_ctr_drbg_seed( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000329 int (*f_entropy)(void *, unsigned char *, size_t),
330 void *p_entropy,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000331 const unsigned char *custom,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000332 size_t len );
333
334/**
Gavin Acquroff77cb30c2020-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 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340void 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 Peskine0bf49eb2019-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 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200355void mbedtls_ctr_drbg_set_prediction_resistance( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000356 int resistance );
357
358/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000359 * \brief This function sets the amount of entropy grabbed on each
Gilles Peskine912ffe42019-10-04 12:15:55 +0200360 * seed or reseed.
Gilles Peskine0bf49eb2019-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 Peskinecc748722019-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 Peskine1eb7ba72019-09-24 14:48:53 +0200375 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000376 * \param ctx The CTR_DRBG context.
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200377 * \param len The amount of entropy to grab, in bytes.
Gilles Peskine80b3f4b2019-09-24 14:48:30 +0200378 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380void mbedtls_ctr_drbg_set_entropy_len( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000381 size_t len );
382
383/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000384 * \brief This function sets the reseed interval.
Gilles Peskine0bf49eb2019-09-30 15:01:02 +0200385 *
386 * The reseed interval is the number of calls to mbedtls_ctr_drbg_random()
387 * or mbedtls_ctr_drbg_random_with_add() after which the entropy function
388 * is called again.
389 *
390 * The default value is #MBEDTLS_CTR_DRBG_RESEED_INTERVAL.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000391 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000392 * \param ctx The CTR_DRBG context.
393 * \param interval The reseed interval.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000394 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395void mbedtls_ctr_drbg_set_reseed_interval( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000396 int interval );
397
398/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000399 * \brief This function reseeds the CTR_DRBG context, that is
400 * extracts data from the entropy source.
Paul Bakker9af723c2014-05-01 13:03:14 +0200401 *
Gilles Peskine83195692021-02-09 18:44:18 +0100402 * \note This function is not thread-safe. It is not safe
403 * to call this function if another thread might be
404 * concurrently obtaining random numbers from the same
405 * context or updating or reseeding the same context.
406 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000407 * \param ctx The CTR_DRBG context.
Gilles Peskine759c91d2019-10-01 18:30:02 +0200408 * \param additional Additional data to add to the state. Can be \c NULL.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000409 * \param len The length of the additional data.
Gilles Peskine80b3f4b2019-09-24 14:48:30 +0200410 * This must be less than
411 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
412 * where \c entropy_len is the entropy length
413 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000414 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100415 * \return \c 0 on success.
416 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418int mbedtls_ctr_drbg_reseed( mbedtls_ctr_drbg_context *ctx,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000419 const unsigned char *additional, size_t len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000420
421/**
Rose Zadikc9474eb2018-03-27 10:58:22 +0100422 * \brief This function updates the state of the CTR_DRBG context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000423 *
Gilles Peskine83195692021-02-09 18:44:18 +0100424 * \note This function is not thread-safe. It is not safe
425 * to call this function if another thread might be
426 * concurrently obtaining random numbers from the same
427 * context or updating or reseeding the same context.
428 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100429 * \param ctx The CTR_DRBG context.
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200430 * \param additional The data to update the state with. This must not be
Gilles Peskine759c91d2019-10-01 18:30:02 +0200431 * \c NULL unless \p add_len is \c 0.
Gilles Peskinec4a80172018-09-12 19:15:53 +0200432 * \param add_len Length of \p additional in bytes. This must be at
433 * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Rose Zadikc9474eb2018-03-27 10:58:22 +0100434 *
Gilles Peskined9199932018-09-11 16:41:54 +0200435 * \return \c 0 on success.
Gilles Peskinec4a80172018-09-12 19:15:53 +0200436 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if
437 * \p add_len is more than
438 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Gilles Peskined9199932018-09-11 16:41:54 +0200439 * \return An error from the underlying AES cipher on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000440 */
Gilles Peskined9199932018-09-11 16:41:54 +0200441int mbedtls_ctr_drbg_update_ret( mbedtls_ctr_drbg_context *ctx,
442 const unsigned char *additional,
443 size_t add_len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000444
445/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000446 * \brief This function updates a CTR_DRBG instance with additional
447 * data and uses it to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000448 *
Gilles Peskine3f9c9732019-10-01 18:31:28 +0200449 * This function automatically reseeds if the reseed counter is exceeded
450 * or prediction resistance is enabled.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000451 *
Gilles Peskine83195692021-02-09 18:44:18 +0100452 * \note This function is not thread-safe. It is not safe
453 * to call this function if another thread might be
454 * concurrently obtaining random numbers from the same
455 * context or updating or reseeding the same context.
456 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000457 * \param p_rng The CTR_DRBG context. This must be a pointer to a
458 * #mbedtls_ctr_drbg_context structure.
459 * \param output The buffer to fill.
Gilles Peskine0bf49eb2019-09-30 15:01:02 +0200460 * \param output_len The length of the buffer in bytes.
Gilles Peskine759c91d2019-10-01 18:30:02 +0200461 * \param additional Additional data to update. Can be \c NULL, in which
Gilles Peskine6b2c50c2019-09-24 14:40:40 +0200462 * case the additional data is empty regardless of
463 * the value of \p add_len.
464 * \param add_len The length of the additional data
Gilles Peskine759c91d2019-10-01 18:30:02 +0200465 * if \p additional is not \c NULL.
Gilles Peskine80b3f4b2019-09-24 14:48:30 +0200466 * This must be less than #MBEDTLS_CTR_DRBG_MAX_INPUT
467 * and less than
468 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
469 * where \c entropy_len is the entropy length
470 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000471 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100472 * \return \c 0 on success.
473 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000474 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200476int mbedtls_ctr_drbg_random_with_add( void *p_rng,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000477 unsigned char *output, size_t output_len,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000478 const unsigned char *additional, size_t add_len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000479
480/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000481 * \brief This function uses CTR_DRBG to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000482 *
Gilles Peskine3f9c9732019-10-01 18:31:28 +0200483 * This function automatically reseeds if the reseed counter is exceeded
484 * or prediction resistance is enabled.
Gilles Peskine83195692021-02-09 18:44:18 +0100485 */
486#if defined(MBEDTLS_THREADING_C)
487/**
488 * \note When Mbed TLS is built with threading support,
489 * it is safe to call mbedtls_ctr_drbg_random()
490 * from multiple threads. Other operations, including
491 * reseeding, are not thread-safe.
492 */
493#endif /* MBEDTLS_THREADING_C */
494/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000495 * \param p_rng The CTR_DRBG context. This must be a pointer to a
496 * #mbedtls_ctr_drbg_context structure.
497 * \param output The buffer to fill.
Gilles Peskinee3d8cf12019-10-02 19:02:13 +0200498 * \param output_len The length of the buffer in bytes.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000499 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100500 * \return \c 0 on success.
501 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000502 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200504int mbedtls_ctr_drbg_random( void *p_rng,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000505 unsigned char *output, size_t output_len );
506
Gilles Peskined9199932018-09-11 16:41:54 +0200507
508#if ! defined(MBEDTLS_DEPRECATED_REMOVED)
509#if defined(MBEDTLS_DEPRECATED_WARNING)
510#define MBEDTLS_DEPRECATED __attribute__((deprecated))
511#else
512#define MBEDTLS_DEPRECATED
513#endif
514/**
515 * \brief This function updates the state of the CTR_DRBG context.
516 *
517 * \deprecated Superseded by mbedtls_ctr_drbg_update_ret()
518 * in 2.16.0.
519 *
520 * \note If \p add_len is greater than
521 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT, only the first
522 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT Bytes are used.
523 * The remaining Bytes are silently discarded.
524 *
525 * \param ctx The CTR_DRBG context.
526 * \param additional The data to update the state with.
527 * \param add_len Length of \p additional data.
528 */
529MBEDTLS_DEPRECATED void mbedtls_ctr_drbg_update(
530 mbedtls_ctr_drbg_context *ctx,
531 const unsigned char *additional,
532 size_t add_len );
533#undef MBEDTLS_DEPRECATED
534#endif /* !MBEDTLS_DEPRECATED_REMOVED */
535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536#if defined(MBEDTLS_FS_IO)
Paul Bakkerfc754a92011-12-05 13:23:51 +0000537/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000538 * \brief This function writes a seed file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000539 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000540 * \param ctx The CTR_DRBG context.
541 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000542 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100543 * \return \c 0 on success.
Rose Zadikf25eb6e2018-04-16 14:51:52 +0100544 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskine0bf49eb2019-09-30 15:01:02 +0200545 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed
Rose Zadik2f8163d2018-01-25 21:55:14 +0000546 * failure.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548int mbedtls_ctr_drbg_write_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
Paul Bakkerfc754a92011-12-05 13:23:51 +0000549
550/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000551 * \brief This function reads and updates a seed file. The seed
552 * is added to this instance.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000553 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000554 * \param ctx The CTR_DRBG context.
555 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000556 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100557 * \return \c 0 on success.
558 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskine0bf49eb2019-09-30 15:01:02 +0200559 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on
560 * reseed failure.
561 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if the existing
562 * seed file is too large.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564int mbedtls_ctr_drbg_update_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
565#endif /* MBEDTLS_FS_IO */
Paul Bakkerfc754a92011-12-05 13:23:51 +0000566
Ron Eldorfa8f6352017-06-20 15:48:46 +0300567#if defined(MBEDTLS_SELF_TEST)
568
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000569/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000570 * \brief The CTR_DRBG checkup routine.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000571 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100572 * \return \c 0 on success.
573 * \return \c 1 on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000574 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575int mbedtls_ctr_drbg_self_test( int verbose );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000576
Ron Eldorfa8f6352017-06-20 15:48:46 +0300577#endif /* MBEDTLS_SELF_TEST */
578
Paul Bakker534f82c2013-06-25 16:47:55 +0200579/* Internal functions (do not call directly) */
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200580int mbedtls_ctr_drbg_seed_entropy_len( mbedtls_ctr_drbg_context *,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200581 int (*)(void *, unsigned char *, size_t), void *,
582 const unsigned char *, size_t, size_t );
Paul Bakker534f82c2013-06-25 16:47:55 +0200583
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000584#ifdef __cplusplus
585}
586#endif
587
588#endif /* ctr_drbg.h */