Mbed TLS v2.28.5
Loading...
Searching...
No Matches
ctr_drbg.h
Go to the documentation of this file.
1
24/*
25 * Copyright The Mbed TLS Contributors
26 * 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.
39 */
40
41#ifndef MBEDTLS_CTR_DRBG_H
42#define MBEDTLS_CTR_DRBG_H
43
44#if !defined(MBEDTLS_CONFIG_FILE)
45#include "mbedtls/config.h"
46#else
47#include MBEDTLS_CONFIG_FILE
48#endif
49
50#include "mbedtls/aes.h"
51
52#if defined(MBEDTLS_THREADING_C)
53#include "mbedtls/threading.h"
54#endif
55
57#define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034
59#define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036
61#define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038
63#define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A
64
65#define MBEDTLS_CTR_DRBG_BLOCKSIZE 16
67#if defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
68#define MBEDTLS_CTR_DRBG_KEYSIZE 16
74#else
75#define MBEDTLS_CTR_DRBG_KEYSIZE 32
81#endif
82
83#define MBEDTLS_CTR_DRBG_KEYBITS (MBEDTLS_CTR_DRBG_KEYSIZE * 8)
84#define MBEDTLS_CTR_DRBG_SEEDLEN (MBEDTLS_CTR_DRBG_KEYSIZE + MBEDTLS_CTR_DRBG_BLOCKSIZE)
99#if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
100#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
104#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
105
106#else /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
107
112#if !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY)
116#endif /* !defined(MBEDTLS_CTR_DRBG_USE_128_BIT_KEY) */
117#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
118#endif /* defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256) */
119#endif /* !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN) */
120
121#if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
122#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
124#endif
125
126#if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT)
127#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
129#endif
130
131#if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST)
132#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
134#endif
135
136#if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT)
137#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
139#endif
140
143#define MBEDTLS_CTR_DRBG_PR_OFF 0
145#define MBEDTLS_CTR_DRBG_PR_ON 1
148#ifdef __cplusplus
149extern "C" {
150#endif
151
152#if MBEDTLS_CTR_DRBG_ENTROPY_LEN >= MBEDTLS_CTR_DRBG_KEYSIZE * 3 / 2
159#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN 0
160#else
167#define MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN (MBEDTLS_CTR_DRBG_ENTROPY_LEN + 1) / 2
168#endif
169
174 unsigned char counter[16];
189 size_t entropy_len;
197 /*
198 * Callbacks (Entropy)
199 */
200 int (*f_entropy)(void *, unsigned char *, size_t);
203 void *p_entropy;
205#if defined(MBEDTLS_THREADING_C)
206 /* Invariant: the mutex is initialized if and only if f_entropy != NULL.
207 * This means that the mutex is initialized during the initial seeding
208 * in mbedtls_ctr_drbg_seed() and freed in mbedtls_ctr_drbg_free().
209 *
210 * Note that this invariant may change without notice. Do not rely on it
211 * and do not access the mutex directly in application code.
212 */
214#endif
215}
217
231
265#if MBEDTLS_CTR_DRBG_ENTROPY_NONCE_LEN == 0
270#else
276#endif
277#if defined(MBEDTLS_THREADING_C)
285#endif /* MBEDTLS_THREADING_C */
332 int (*f_entropy)(void *, unsigned char *, size_t),
333 void *p_entropy,
334 const unsigned char *custom,
335 size_t len);
336
344
359 int resistance);
360
386 size_t len);
387
408 size_t len);
409
423 int interval);
424
446 const unsigned char *additional, size_t len);
447
469 const unsigned char *additional,
470 size_t add_len);
471
504 unsigned char *output, size_t output_len,
505 const unsigned char *additional, size_t add_len);
506
513#if defined(MBEDTLS_THREADING_C)
520#endif /* MBEDTLS_THREADING_C */
532 unsigned char *output, size_t output_len);
533
534
535#if !defined(MBEDTLS_DEPRECATED_REMOVED)
536#if defined(MBEDTLS_DEPRECATED_WARNING)
537#define MBEDTLS_DEPRECATED __attribute__((deprecated))
538#else
539#define MBEDTLS_DEPRECATED
540#endif
558 const unsigned char *additional,
559 size_t add_len);
560#undef MBEDTLS_DEPRECATED
561#endif /* !MBEDTLS_DEPRECATED_REMOVED */
562
563#if defined(MBEDTLS_FS_IO)
576
592#endif /* MBEDTLS_FS_IO */
593
594#if defined(MBEDTLS_SELF_TEST)
595
603
604#endif /* MBEDTLS_SELF_TEST */
605
606#ifdef __cplusplus
607}
608#endif
609
610#endif /* ctr_drbg.h */
This file contains AES definitions and functions.
Configuration options (set of defines)
int mbedtls_ctr_drbg_set_nonce_len(mbedtls_ctr_drbg_context *ctx, size_t len)
This function sets the amount of entropy grabbed as a nonce for the initial seeding.
int mbedtls_ctr_drbg_random_with_add(void *p_rng, unsigned char *output, size_t output_len, const unsigned char *additional, size_t add_len)
This function updates a CTR_DRBG instance with additional data and uses it to generate random data.
void mbedtls_ctr_drbg_free(mbedtls_ctr_drbg_context *ctx)
This function resets CTR_DRBG context to the state immediately after initial call of mbedtls_ctr_drbg...
int mbedtls_ctr_drbg_update_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path)
This function reads and updates a seed file. The seed is added to this instance.
int mbedtls_ctr_drbg_reseed(mbedtls_ctr_drbg_context *ctx, const unsigned char *additional, size_t len)
This function reseeds the CTR_DRBG context, that is extracts data from the entropy source.
MBEDTLS_DEPRECATED void mbedtls_ctr_drbg_update(mbedtls_ctr_drbg_context *ctx, const unsigned char *additional, size_t add_len)
This function updates the state of the CTR_DRBG context.
struct mbedtls_ctr_drbg_context mbedtls_ctr_drbg_context
The CTR_DRBG context structure.
int mbedtls_ctr_drbg_self_test(int verbose)
The CTR_DRBG checkup routine.
void mbedtls_ctr_drbg_init(mbedtls_ctr_drbg_context *ctx)
This function initializes the CTR_DRBG context, and prepares it for mbedtls_ctr_drbg_seed() or mbedtl...
int mbedtls_ctr_drbg_update_ret(mbedtls_ctr_drbg_context *ctx, const unsigned char *additional, size_t add_len)
This function updates the state of the CTR_DRBG context.
#define MBEDTLS_DEPRECATED
Definition ctr_drbg.h:539
int mbedtls_ctr_drbg_seed(mbedtls_ctr_drbg_context *ctx, int(*f_entropy)(void *, unsigned char *, size_t), void *p_entropy, const unsigned char *custom, size_t len)
This function seeds and sets up the CTR_DRBG entropy source for future reseeds.
void mbedtls_ctr_drbg_set_prediction_resistance(mbedtls_ctr_drbg_context *ctx, int resistance)
This function turns prediction resistance on or off. The default value is off.
void mbedtls_ctr_drbg_set_reseed_interval(mbedtls_ctr_drbg_context *ctx, int interval)
This function sets the reseed interval.
void mbedtls_ctr_drbg_set_entropy_len(mbedtls_ctr_drbg_context *ctx, size_t len)
This function sets the amount of entropy grabbed on each seed or reseed.
int mbedtls_ctr_drbg_random(void *p_rng, unsigned char *output, size_t output_len)
This function uses CTR_DRBG to generate random data.
int mbedtls_ctr_drbg_write_seed_file(mbedtls_ctr_drbg_context *ctx, const char *path)
This function writes a seed file.
The AES context-type definition.
Definition aes.h:91
The CTR_DRBG context structure.
Definition ctr_drbg.h:173
unsigned char counter[16]
Definition ctr_drbg.h:174
mbedtls_threading_mutex_t mutex
Definition ctr_drbg.h:213
int(* f_entropy)(void *, unsigned char *, size_t)
Definition ctr_drbg.h:200
mbedtls_aes_context aes_ctx
Definition ctr_drbg.h:195
Threading abstraction layer.