blob: 959a5d57c4d796fc6d34e1e8a60c691fead3ec89 [file] [log] [blame]
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001/**
2 * \file ctr_drbg.h
3 *
Gilles Peskineec51dd12019-09-30 15:01:02 +02004 * \brief This file contains definitions and functions for the
5 * CTR_DRBG pseudorandom generator.
Rose Zadikc9474eb2018-03-27 10:58:22 +01006 *
Rose Zadikf25eb6e2018-04-16 14:51:52 +01007 * CTR_DRBG is a standardized way of building a PRNG from a block-cipher
8 * in counter mode operation, as defined in <em>NIST SP 800-90A:
9 * Recommendation for Random Number Generation Using Deterministic Random
10 * Bit Generators</em>.
Rose Zadik2f8163d2018-01-25 21:55:14 +000011 *
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +030012 * The Mbed TLS implementation of CTR_DRBG uses AES-256 (default) or AES-128
Gilles Peskined0c64c82019-10-03 14:20:46 +020013 * (if \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled at compile time)
Gilles Peskinedddda812019-10-03 14:22:04 +020014 * as the underlying block cipher, with a derivation function.
Gilles Peskinedddda812019-10-03 14:22:04 +020015 *
Gilles Peskinee9a34542019-10-22 20:43:24 +020016 * The security strength as defined in NIST SP 800-90A is
17 * 128 bits when AES-128 is used (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY enabled)
18 * and 256 bits otherwise, provided that #MBEDTLS_CTR_DRBG_ENTROPY_LEN is
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020019 * kept at its default value (and not overridden in mbedtls_config.h) and that the
Gilles Peskinee9a34542019-10-22 20:43:24 +020020 * DRBG instance is set up with default parameters.
21 * See the documentation of mbedtls_ctr_drbg_seed() for more
22 * information.
Darryl Greena40a1012018-01-05 15:33:17 +000023 */
24/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020025 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020026 * SPDX-License-Identifier: Apache-2.0
27 *
28 * Licensed under the Apache License, Version 2.0 (the "License"); you may
29 * not use this file except in compliance with the License.
30 * You may obtain a copy of the License at
31 *
32 * http://www.apache.org/licenses/LICENSE-2.0
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 * See the License for the specific language governing permissions and
38 * limitations under the License.
Paul Bakker0e04d0e2011-11-27 14:46:59 +000039 */
Rose Zadik2f8163d2018-01-25 21:55:14 +000040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#ifndef MBEDTLS_CTR_DRBG_H
42#define MBEDTLS_CTR_DRBG_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020043#include "mbedtls/private_access.h"
Paul Bakker0e04d0e2011-11-27 14:46:59 +000044
Bence Szépkútic662b362021-05-27 11:25:03 +020045#include "mbedtls/build_info.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050046
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010047#include "mbedtls/aes.h"
Paul Bakker0e04d0e2011-11-27 14:46:59 +000048
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010049#if defined(MBEDTLS_THREADING_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010050#include "mbedtls/threading.h"
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +010051#endif
52
Gilles Peskined2971572021-07-26 18:48:10 +020053/** The entropy source failed. */
54#define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034
55/** The requested random buffer length is too big. */
56#define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036
57/** The input (entropy + additional data) is too large. */
58#define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038
59/** Read or write error in file. */
60#define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A
Paul Bakker0e04d0e2011-11-27 14:46:59 +000061
Rose Zadik2f8163d2018-01-25 21:55:14 +000062#define MBEDTLS_CTR_DRBG_BLOCKSIZE 16 /**< The block size used by the cipher. */
Nir Sonnenscheince266e42018-08-29 10:11:46 +030063
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030064#if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
Gilles Peskine08875d42019-09-24 14:40:40 +020065#define MBEDTLS_CTR_DRBG_KEYSIZE 16
66/**< The key size in bytes used by the cipher.
67 *
68 * Compile-time choice: 16 bytes (128 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020069 * because #MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020070 */
Nir Sonnenscheineb73f7a2018-07-30 17:46:49 +030071#else
Gilles Peskine08875d42019-09-24 14:40:40 +020072#define MBEDTLS_CTR_DRBG_KEYSIZE 32
73/**< The key size in bytes used by the cipher.
74 *
75 * Compile-time choice: 32 bytes (256 bits)
Gilles Peskined0c64c82019-10-03 14:20:46 +020076 * because \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled.
Gilles Peskine08875d42019-09-24 14:40:40 +020077 */
Nir Sonnenscheina4588d42018-07-30 16:59:36 +030078#endif
Nir Sonnenschein43e4ff02018-09-03 14:15:46 +030079
Rose Zadik2f8163d2018-01-25 21:55:14 +000080#define MBEDTLS_CTR_DRBG_KEYBITS ( MBEDTLS_CTR_DRBG_KEYSIZE * 8 ) /**< The key size for the DRBG operation, in bits. */
81#define MBEDTLS_CTR_DRBG_SEEDLEN ( MBEDTLS_CTR_DRBG_KEYSIZE + MBEDTLS_CTR_DRBG_BLOCKSIZE ) /**< The seed length, calculated as (counter + AES key). */
Paul Bakker9bcf16c2013-06-24 19:31:17 +020082
Paul Bakker088c5c52014-04-25 11:11:10 +020083/**
84 * \name SECTION: Module settings
85 *
86 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020087 * Either change them in mbedtls_config.h or define them using the compiler command
Rose Zadik2f8163d2018-01-25 21:55:14 +000088 * line.
Paul Bakker088c5c52014-04-25 11:11:10 +020089 * \{
90 */
91
Gilles Peskinedddda812019-10-03 14:22:04 +020092/** \def MBEDTLS_CTR_DRBG_ENTROPY_LEN
93 *
94 * \brief The amount of entropy used per seed by default, in bytes.
95 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020096#if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
97#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
Gilles Peskinedddda812019-10-03 14:22:04 +020098/** This is 48 bytes because the entropy module uses SHA-512
Gilles Peskined0c64c82019-10-03 14:20:46 +020099 * (\c MBEDTLS_ENTROPY_FORCE_SHA256 is disabled).
Gilles Peskine08875d42019-09-24 14:40:40 +0200100 */
Rose Zadik2f8163d2018-01-25 21:55:14 +0000101#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Gilles Peskinedddda812019-10-03 14:22:04 +0200102
103#else /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
104
105/** This is 32 bytes because the entropy module uses SHA-256
106 * (the SHA512 module is disabled or
107 * \c MBEDTLS_ENTROPY_FORCE_SHA256 is enabled).
Rose Zadik2f8163d2018-01-25 21:55:14 +0000108 */
Gilles Peskinedddda812019-10-03 14:22:04 +0200109#if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
110/** \warning To achieve a 256-bit security strength, you must pass a nonce
111 * to mbedtls_ctr_drbg_seed().
112 */
113#endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */
Gilles Peskine08875d42019-09-24 14:40:40 +0200114#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
Gilles Peskinedddda812019-10-03 14:22:04 +0200115#endif /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
116#endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118#if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000119#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
120/**< The interval before reseed is performed by default. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200121#endif
122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123#if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000124#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
125/**< The maximum number of additional input Bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200126#endif
127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200128#if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000129#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
130/**< The maximum number of requested Bytes per call. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200131#endif
132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT)
Rose Zadik2f8163d2018-01-25 21:55:14 +0000134#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Gilles Peskine08875d42019-09-24 14:40:40 +0200135/**< The maximum size of seed or reseed buffer in bytes. */
Paul Bakker088c5c52014-04-25 11:11:10 +0200136#endif
137
138/* \} name SECTION: Module settings */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000139
Rose Zadik2f8163d2018-01-25 21:55:14 +0000140#define MBEDTLS_CTR_DRBG_PR_OFF 0
141/**< Prediction resistance is disabled. */
142#define MBEDTLS_CTR_DRBG_PR_ON 1
143/**< Prediction resistance is enabled. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000144
145#ifdef __cplusplus
146extern "C" {
147#endif
148
Gilles Peskine69971662019-10-23 19:39:36 +0200149#if MBEDTLS_CTR_DRBG_ENTROPY_LEN >= MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2
150/** The default length of the nonce read from the entropy source.
151 *
152 * This is \c 0 because a single read from the entropy source is sufficient
153 * to include a nonce.
154 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
155 */
156#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN 0
157#else
158/** The default length of the nonce read from the entropy source.
159 *
160 * This is half of the default entropy length because a single read from
161 * the entropy source does not provide enough material to form a nonce.
162 * See the documentation of mbedtls_ctr_drbg_seed() for more information.
163 */
164#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN ( MBEDTLS_CTR_DRBG_ENTROPY_LEN + 1 ) / 2
165#endif
166
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000167/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000168 * \brief The CTR_DRBG context structure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000169 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200170typedef struct mbedtls_ctr_drbg_context
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000171{
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200172 unsigned char MBEDTLS_PRIVATE(counter)[16]; /*!< The counter (V). */
173 int MBEDTLS_PRIVATE(reseed_counter); /*!< The reseed counter.
Gilles Peskinec0ace352019-10-22 17:06:31 +0200174 * This is the number of requests that have
175 * been made since the last (re)seeding,
Gilles Peskine9be50982019-10-22 18:42:27 +0200176 * minus one.
177 * Before the initial seeding, this field
178 * contains the amount of entropy in bytes
Jaeden Ameroa15c7132020-01-09 13:02:16 +0000179 * to use as a nonce for the initial seeding,
180 * or -1 if no nonce length has been explicitly
181 * set (see mbedtls_ctr_drbg_set_nonce_len()).
Gilles Peskine9be50982019-10-22 18:42:27 +0200182 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200183 int MBEDTLS_PRIVATE(prediction_resistance); /*!< This determines whether prediction
Rose Zadik2f8163d2018-01-25 21:55:14 +0000184 resistance is enabled, that is
185 whether to systematically reseed before
186 each random generation. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200187 size_t MBEDTLS_PRIVATE(entropy_len); /*!< The amount of entropy grabbed on each
Gilles Peskinec0ace352019-10-22 17:06:31 +0200188 seed or reseed operation, in bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200189 int MBEDTLS_PRIVATE(reseed_interval); /*!< The reseed interval.
Gilles Peskinec0ace352019-10-22 17:06:31 +0200190 * This is the maximum number of requests
191 * that can be made between reseedings. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000192
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200193 mbedtls_aes_context MBEDTLS_PRIVATE(aes_ctx); /*!< The AES context. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000194
195 /*
196 * Callbacks (Entropy)
197 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200198 int (*MBEDTLS_PRIVATE(f_entropy))(void *, unsigned char *, size_t);
Rose Zadik2f8163d2018-01-25 21:55:14 +0000199 /*!< The entropy callback function. */
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000200
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200201 void *MBEDTLS_PRIVATE(p_entropy); /*!< The context for the entropy function. */
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100202
203#if defined(MBEDTLS_THREADING_C)
Gilles Peskineda290f92021-02-09 18:44:02 +0100204 /* Invariant: the mutex is initialized if and only if f_entropy != NULL.
205 * This means that the mutex is initialized during the initial seeding
206 * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free().
207 *
208 * Note that this invariant may change without notice. Do not rely on it
209 * and do not access the mutex directly in application code.
210 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200211 mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
Manuel Pégourié-Gonnard0a4fb092015-05-07 12:50:31 +0100212#endif
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000213}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214mbedtls_ctr_drbg_context;
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000215
216/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000217 * \brief This function initializes the CTR_DRBG context,
218 * and prepares it for mbedtls_ctr_drbg_seed()
219 * or mbedtls_ctr_drbg_free().
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200220 *
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800221 * \note The reseed interval is
222 * #MBEDTLS_CTR_DRBG_RESEED_INTERVAL by default.
223 * You can override it by calling
224 * mbedtls_ctr_drbg_set_reseed_interval().
225 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000226 * \param ctx The CTR_DRBG context to initialize.
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200227 */
228void mbedtls_ctr_drbg_init( mbedtls_ctr_drbg_context *ctx );
229
230/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000231 * \brief This function seeds and sets up the CTR_DRBG
232 * entropy source for future reseeds.
Paul Bakker9af723c2014-05-01 13:03:14 +0200233 *
Gilles Peskine223deea2019-09-24 14:48:53 +0200234 * A typical choice for the \p f_entropy and \p p_entropy parameters is
235 * to use the entropy module:
236 * - \p f_entropy is mbedtls_entropy_func();
237 * - \p p_entropy is an instance of ::mbedtls_entropy_context initialized
238 * with mbedtls_entropy_init() (which registers the platform's default
239 * entropy sources).
240 *
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200241 * The entropy length is #MBEDTLS_CTR_DRBG_ENTROPY_LEN by default.
242 * You can override it by calling mbedtls_ctr_drbg_set_entropy_len().
Gilles Peskineec51dd12019-09-30 15:01:02 +0200243 *
Gilles Peskinee9a34542019-10-22 20:43:24 +0200244 * The entropy nonce length is:
245 * - \c 0 if the entropy length is at least 3/2 times the entropy length,
246 * which guarantees that the security strength is the maximum permitted
247 * by the key size and entropy length according to NIST SP 800-90A §10.2.1;
248 * - Half the entropy length otherwise.
249 * You can override it by calling mbedtls_ctr_drbg_set_nonce_len().
Gilles Peskine69971662019-10-23 19:39:36 +0200250 * With the default entropy length, the entropy nonce length is
251 * #MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN.
252 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200253 * You can provide a nonce and personalization string in addition to the
Gilles Peskine223deea2019-09-24 14:48:53 +0200254 * entropy source, to make this instantiation as unique as possible.
Gilles Peskine9be50982019-10-22 18:42:27 +0200255 * See SP 800-90A §8.6.7 for more details about nonces.
Gilles Peskine223deea2019-09-24 14:48:53 +0200256 *
Gilles Peskine9be50982019-10-22 18:42:27 +0200257 * The _seed_material_ value passed to the derivation function in
258 * the CTR_DRBG Instantiate Process described in NIST SP 800-90A §10.2.1.3.2
259 * is the concatenation of the following strings:
260 * - A string obtained by calling \p f_entropy function for the entropy
261 * length.
Gilles Peskinee9a34542019-10-22 20:43:24 +0200262 */
Gilles Peskine69971662019-10-23 19:39:36 +0200263#if MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN == 0
Gilles Peskinee9a34542019-10-22 20:43:24 +0200264/**
265 * - If mbedtls_ctr_drbg_set_nonce_len() has been called, a string
266 * obtained by calling \p f_entropy function for the specified length.
267 */
268#else
269/**
270 * - A string obtained by calling \p f_entropy function for the entropy nonce
271 * length. If the entropy nonce length is \c 0, this function does not
272 * make a second call to \p f_entropy.
273 */
274#endif
Gilles Peskinef305d922021-02-09 18:44:18 +0100275#if defined(MBEDTLS_THREADING_C)
276/**
277 * \note When Mbed TLS is built with threading support,
278 * after this function returns successfully,
279 * it is safe to call mbedtls_ctr_drbg_random()
280 * from multiple threads. Other operations, including
281 * reseeding, are not thread-safe.
282 */
283#endif /* MBEDTLS_THREADING_C */
Gilles Peskinee9a34542019-10-22 20:43:24 +0200284/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200285 * - The \p custom string.
286 *
287 * \note To achieve the nominal security strength permitted
288 * by CTR_DRBG, the entropy length must be:
289 * - at least 16 bytes for a 128-bit strength
290 * (maximum achievable strength when using AES-128);
291 * - at least 32 bytes for a 256-bit strength
292 * (maximum achievable strength when using AES-256).
293 *
294 * In addition, if you do not pass a nonce in \p custom,
295 * the sum of the entropy length
Gilles Peskinee9a34542019-10-22 20:43:24 +0200296 * and the entropy nonce length must be:
Gilles Peskine9be50982019-10-22 18:42:27 +0200297 * - at least 24 bytes for a 128-bit strength
298 * (maximum achievable strength when using AES-128);
299 * - at least 48 bytes for a 256-bit strength
300 * (maximum achievable strength when using AES-256).
301 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000302 * \param ctx The CTR_DRBG context to seed.
Gilles Peskinebd326f92019-10-28 17:33:07 +0100303 * It must have been initialized with
304 * mbedtls_ctr_drbg_init().
305 * After a successful call to mbedtls_ctr_drbg_seed(),
306 * you may not call mbedtls_ctr_drbg_seed() again on
307 * the same context unless you call
308 * mbedtls_ctr_drbg_free() and mbedtls_ctr_drbg_init()
309 * again first.
Gilles Peskinef305d922021-02-09 18:44:18 +0100310 * After a failed call to mbedtls_ctr_drbg_seed(),
311 * you must call mbedtls_ctr_drbg_free().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000312 * \param f_entropy The entropy callback, taking as arguments the
313 * \p p_entropy context, the buffer to fill, and the
Gilles Peskine08875d42019-09-24 14:40:40 +0200314 * length of the buffer.
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200315 * \p f_entropy is always called with a buffer size
Gilles Peskine9be50982019-10-22 18:42:27 +0200316 * less than or equal to the entropy length.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200317 * \param p_entropy The entropy context to pass to \p f_entropy.
Gilles Peskine217b8152019-10-01 18:39:45 +0200318 * \param custom The personalization string.
319 * This can be \c NULL, in which case the personalization
320 * string is empty regardless of the value of \p len.
321 * \param len The length of the personalization string.
Gilles Peskine944bc582019-09-24 14:48:30 +0200322 * This must be at most
323 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
324 * - #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000325 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100326 * \return \c 0 on success.
327 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000328 */
Manuel Pégourié-Gonnard8d128ef2015-04-28 22:38:08 +0200329int mbedtls_ctr_drbg_seed( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000330 int (*f_entropy)(void *, unsigned char *, size_t),
331 void *p_entropy,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000332 const unsigned char *custom,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000333 size_t len );
334
335/**
Gavin Acquroff6aceb512020-03-01 17:06:11 -0800336 * \brief This function resets CTR_DRBG context to the state immediately
337 * after initial call of mbedtls_ctr_drbg_init().
Paul Bakkerfff03662014-06-18 16:21:25 +0200338 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000339 * \param ctx The CTR_DRBG context to clear.
Paul Bakkerfff03662014-06-18 16:21:25 +0200340 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341void mbedtls_ctr_drbg_free( mbedtls_ctr_drbg_context *ctx );
Paul Bakkerfff03662014-06-18 16:21:25 +0200342
343/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000344 * \brief This function turns prediction resistance on or off.
345 * The default value is off.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000346 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000347 * \note If enabled, entropy is gathered at the beginning of
Gilles Peskineec51dd12019-09-30 15:01:02 +0200348 * every call to mbedtls_ctr_drbg_random_with_add()
349 * or mbedtls_ctr_drbg_random().
Rose Zadik2f8163d2018-01-25 21:55:14 +0000350 * Only use this if your entropy source has sufficient
351 * throughput.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000352 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000353 * \param ctx The CTR_DRBG context.
354 * \param resistance #MBEDTLS_CTR_DRBG_PR_ON or #MBEDTLS_CTR_DRBG_PR_OFF.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356void mbedtls_ctr_drbg_set_prediction_resistance( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000357 int resistance );
358
359/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000360 * \brief This function sets the amount of entropy grabbed on each
Gilles Peskine50ed86b2019-10-04 12:15:55 +0200361 * seed or reseed.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200362 *
363 * The default value is #MBEDTLS_CTR_DRBG_ENTROPY_LEN.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000364 *
Gilles Peskinedddda812019-10-03 14:22:04 +0200365 * \note The security strength of CTR_DRBG is bounded by the
366 * entropy length. Thus:
367 * - When using AES-256
368 * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is disabled,
369 * which is the default),
370 * \p len must be at least 32 (in bytes)
371 * to achieve a 256-bit strength.
372 * - When using AES-128
373 * (\c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY is enabled)
374 * \p len must be at least 16 (in bytes)
375 * to achieve a 128-bit strength.
Gilles Peskine223deea2019-09-24 14:48:53 +0200376 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000377 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200378 * \param len The amount of entropy to grab, in bytes.
Gilles Peskine9be50982019-10-22 18:42:27 +0200379 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
380 * and at most the maximum length accepted by the
381 * entropy function that is set in the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383void mbedtls_ctr_drbg_set_entropy_len( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000384 size_t len );
385
386/**
Gilles Peskine9be50982019-10-22 18:42:27 +0200387 * \brief This function sets the amount of entropy grabbed
388 * as a nonce for the initial seeding.
389 *
390 * Call this function before calling mbedtls_ctr_drbg_seed() to read
391 * a nonce from the entropy source during the initial seeding.
392 *
393 * \param ctx The CTR_DRBG context.
394 * \param len The amount of entropy to grab for the nonce, in bytes.
395 * This must be at most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT
396 * and at most the maximum length accepted by the
397 * entropy function that is set in the context.
398 *
399 * \return \c 0 on success.
400 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if \p len is
401 * more than #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
402 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
403 * if the initial seeding has already taken place.
404 */
405int mbedtls_ctr_drbg_set_nonce_len( mbedtls_ctr_drbg_context *ctx,
406 size_t len );
407
408/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000409 * \brief This function sets the reseed interval.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200410 *
411 * The reseed interval is the number of calls to mbedtls_ctr_drbg_random()
412 * or mbedtls_ctr_drbg_random_with_add() after which the entropy function
413 * is called again.
414 *
415 * The default value is #MBEDTLS_CTR_DRBG_RESEED_INTERVAL.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000416 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000417 * \param ctx The CTR_DRBG context.
418 * \param interval The reseed interval.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420void mbedtls_ctr_drbg_set_reseed_interval( mbedtls_ctr_drbg_context *ctx,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000421 int interval );
422
423/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000424 * \brief This function reseeds the CTR_DRBG context, that is
425 * extracts data from the entropy source.
Paul Bakker9af723c2014-05-01 13:03:14 +0200426 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100427 * \note This function is not thread-safe. It is not safe
428 * to call this function if another thread might be
429 * concurrently obtaining random numbers from the same
430 * context or updating or reseeding the same context.
431 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000432 * \param ctx The CTR_DRBG context.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200433 * \param additional Additional data to add to the state. Can be \c NULL.
Rose Zadik2f8163d2018-01-25 21:55:14 +0000434 * \param len The length of the additional data.
Gilles Peskine944bc582019-09-24 14:48:30 +0200435 * This must be less than
436 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
437 * where \c entropy_len is the entropy length
438 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000439 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100440 * \return \c 0 on success.
441 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443int mbedtls_ctr_drbg_reseed( mbedtls_ctr_drbg_context *ctx,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000444 const unsigned char *additional, size_t len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000445
446/**
Rose Zadikc9474eb2018-03-27 10:58:22 +0100447 * \brief This function updates the state of the CTR_DRBG context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000448 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100449 * \note This function is not thread-safe. It is not safe
450 * to call this function if another thread might be
451 * concurrently obtaining random numbers from the same
452 * context or updating or reseeding the same context.
453 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100454 * \param ctx The CTR_DRBG context.
Gilles Peskine08875d42019-09-24 14:40:40 +0200455 * \param additional The data to update the state with. This must not be
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200456 * \c NULL unless \p add_len is \c 0.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500457 * \param add_len Length of \p additional in bytes. This must be at
458 * most #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
Rose Zadikc9474eb2018-03-27 10:58:22 +0100459 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500460 * \return \c 0 on success.
461 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if
462 * \p add_len is more than
463 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT.
464 * \return An error from the underlying AES cipher on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000465 */
TRodziewicz26371e42021-06-08 16:45:41 +0200466int mbedtls_ctr_drbg_update( mbedtls_ctr_drbg_context *ctx,
467 const unsigned char *additional,
468 size_t add_len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000469
470/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000471 * \brief This function updates a CTR_DRBG instance with additional
472 * data and uses it to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000473 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200474 * This function automatically reseeds if the reseed counter is exceeded
475 * or prediction resistance is enabled.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000476 *
Gilles Peskinef305d922021-02-09 18:44:18 +0100477 * \note This function is not thread-safe. It is not safe
478 * to call this function if another thread might be
479 * concurrently obtaining random numbers from the same
480 * context or updating or reseeding the same context.
481 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000482 * \param p_rng The CTR_DRBG context. This must be a pointer to a
483 * #mbedtls_ctr_drbg_context structure.
484 * \param output The buffer to fill.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200485 * \param output_len The length of the buffer in bytes.
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200486 * \param additional Additional data to update. Can be \c NULL, in which
Gilles Peskine08875d42019-09-24 14:40:40 +0200487 * case the additional data is empty regardless of
488 * the value of \p add_len.
489 * \param add_len The length of the additional data
Gilles Peskine10f16ac2019-10-01 18:30:02 +0200490 * if \p additional is not \c NULL.
Gilles Peskine944bc582019-09-24 14:48:30 +0200491 * This must be less than #MBEDTLS_CTR_DRBG_MAX_INPUT
492 * and less than
493 * #MBEDTLS_CTR_DRBG_MAX_SEED_INPUT - \c entropy_len
494 * where \c entropy_len is the entropy length
495 * configured for the context.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000496 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100497 * \return \c 0 on success.
498 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000499 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200501int mbedtls_ctr_drbg_random_with_add( void *p_rng,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000502 unsigned char *output, size_t output_len,
Paul Bakker1bc9efc2011-12-03 11:29:32 +0000503 const unsigned char *additional, size_t add_len );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000504
505/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000506 * \brief This function uses CTR_DRBG to generate random data.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000507 *
Gilles Peskine2d8f0692019-10-01 18:31:28 +0200508 * This function automatically reseeds if the reseed counter is exceeded
509 * or prediction resistance is enabled.
Gilles Peskinef305d922021-02-09 18:44:18 +0100510 */
511#if defined(MBEDTLS_THREADING_C)
512/**
513 * \note When Mbed TLS is built with threading support,
514 * it is safe to call mbedtls_ctr_drbg_random()
515 * from multiple threads. Other operations, including
516 * reseeding, are not thread-safe.
517 */
518#endif /* MBEDTLS_THREADING_C */
519/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000520 * \param p_rng The CTR_DRBG context. This must be a pointer to a
521 * #mbedtls_ctr_drbg_context structure.
522 * \param output The buffer to fill.
Gilles Peskine944bc582019-09-24 14:48:30 +0200523 * \param output_len The length of the buffer in bytes.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000524 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100525 * \return \c 0 on success.
526 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
Rose Zadik2f8163d2018-01-25 21:55:14 +0000527 * #MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000528 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200529int mbedtls_ctr_drbg_random( void *p_rng,
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000530 unsigned char *output, size_t output_len );
531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532#if defined(MBEDTLS_FS_IO)
Paul Bakkerfc754a92011-12-05 13:23:51 +0000533/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000534 * \brief This function writes a seed file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000535 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000536 * \param ctx The CTR_DRBG context.
537 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000538 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100539 * \return \c 0 on success.
Rose Zadikf25eb6e2018-04-16 14:51:52 +0100540 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200541 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on reseed
Rose Zadik2f8163d2018-01-25 21:55:14 +0000542 * failure.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544int mbedtls_ctr_drbg_write_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
Paul Bakkerfc754a92011-12-05 13:23:51 +0000545
546/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000547 * \brief This function reads and updates a seed file. The seed
548 * is added to this instance.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000549 *
Rose Zadik2f8163d2018-01-25 21:55:14 +0000550 * \param ctx The CTR_DRBG context.
551 * \param path The name of the file.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000552 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100553 * \return \c 0 on success.
554 * \return #MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR on file error.
Gilles Peskineec51dd12019-09-30 15:01:02 +0200555 * \return #MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED on
556 * reseed failure.
557 * \return #MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG if the existing
558 * seed file is too large.
Paul Bakkerfc754a92011-12-05 13:23:51 +0000559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560int mbedtls_ctr_drbg_update_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
561#endif /* MBEDTLS_FS_IO */
Paul Bakkerfc754a92011-12-05 13:23:51 +0000562
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500563#if defined(MBEDTLS_SELF_TEST)
564
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000565/**
Rose Zadik2f8163d2018-01-25 21:55:14 +0000566 * \brief The CTR_DRBG checkup routine.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000567 *
Rose Zadikc9474eb2018-03-27 10:58:22 +0100568 * \return \c 0 on success.
569 * \return \c 1 on failure.
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571int mbedtls_ctr_drbg_self_test( int verbose );
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000572
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500573#endif /* MBEDTLS_SELF_TEST */
574
Paul Bakker0e04d0e2011-11-27 14:46:59 +0000575#ifdef __cplusplus
576}
577#endif
578
579#endif /* ctr_drbg.h */