mbed TLS v2.7.6
ctr_drbg.h
Go to the documentation of this file.
1 
9 /*
10  * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
11  * SPDX-License-Identifier: Apache-2.0
12  *
13  * Licensed under the Apache License, Version 2.0 (the "License"); you may
14  * not use this file except in compliance with the License.
15  * You may obtain a copy of the License at
16  *
17  * http://www.apache.org/licenses/LICENSE-2.0
18  *
19  * Unless required by applicable law or agreed to in writing, software
20  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
21  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22  * See the License for the specific language governing permissions and
23  * limitations under the License.
24  *
25  * This file is part of Mbed TLS (https://tls.mbed.org)
26  */
27 
28 #ifndef MBEDTLS_CTR_DRBG_H
29 #define MBEDTLS_CTR_DRBG_H
30 
31 #include "aes.h"
32 
33 #if defined(MBEDTLS_THREADING_C)
34 #include "threading.h"
35 #endif
36 
37 #define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED -0x0034
38 #define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG -0x0036
39 #define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG -0x0038
40 #define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR -0x003A
42 #define MBEDTLS_CTR_DRBG_BLOCKSIZE 16
43 #define MBEDTLS_CTR_DRBG_KEYSIZE 32
44 #define MBEDTLS_CTR_DRBG_KEYBITS ( MBEDTLS_CTR_DRBG_KEYSIZE * 8 )
45 #define MBEDTLS_CTR_DRBG_SEEDLEN ( MBEDTLS_CTR_DRBG_KEYSIZE + MBEDTLS_CTR_DRBG_BLOCKSIZE )
56 #if !defined(MBEDTLS_CTR_DRBG_ENTROPY_LEN)
57 #if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
58 #define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
59 
63 #else
64 #define MBEDTLS_CTR_DRBG_ENTROPY_LEN 32
65 
69 #endif
70 #endif
71 
72 #if !defined(MBEDTLS_CTR_DRBG_RESEED_INTERVAL)
73 #define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
74 
75 #endif
76 
77 #if !defined(MBEDTLS_CTR_DRBG_MAX_INPUT)
78 #define MBEDTLS_CTR_DRBG_MAX_INPUT 256
79 
80 #endif
81 
82 #if !defined(MBEDTLS_CTR_DRBG_MAX_REQUEST)
83 #define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
84 
85 #endif
86 
87 #if !defined(MBEDTLS_CTR_DRBG_MAX_SEED_INPUT)
88 #define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
89 
90 #endif
91 
92 /* \} name SECTION: Module settings */
93 
94 #define MBEDTLS_CTR_DRBG_PR_OFF 0
95 
96 #define MBEDTLS_CTR_DRBG_PR_ON 1
97 
99 #ifdef __cplusplus
100 extern "C" {
101 #endif
102 
106 typedef struct
107 {
108  unsigned char counter[16];
114  size_t entropy_len;
120  /*
121  * Callbacks (Entropy)
122  */
123  int (*f_entropy)(void *, unsigned char *, size_t);
126  void *p_entropy;
128 #if defined(MBEDTLS_THREADING_C)
130 #endif
131 }
133 
142 
163  int (*f_entropy)(void *, unsigned char *, size_t),
164  void *p_entropy,
165  const unsigned char *custom,
166  size_t len );
167 
174 
188  int resistance );
189 
199  size_t len );
200 
209  int interval );
210 
223  const unsigned char *additional, size_t len );
224 
237  const unsigned char *additional, size_t add_len );
238 
256 int mbedtls_ctr_drbg_random_with_add( void *p_rng,
257  unsigned char *output, size_t output_len,
258  const unsigned char *additional, size_t add_len );
259 
274 int mbedtls_ctr_drbg_random( void *p_rng,
275  unsigned char *output, size_t output_len );
276 
277 #if defined(MBEDTLS_FS_IO)
278 
289 int mbedtls_ctr_drbg_write_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
290 
303 int mbedtls_ctr_drbg_update_seed_file( mbedtls_ctr_drbg_context *ctx, const char *path );
304 #endif /* MBEDTLS_FS_IO */
305 
311 int mbedtls_ctr_drbg_self_test( int verbose );
312 
313 /* Internal functions (do not call directly) */
315  int (*)(void *, unsigned char *, size_t), void *,
316  const unsigned char *, size_t, size_t );
317 
318 #ifdef __cplusplus
319 }
320 #endif
321 
322 #endif /* ctr_drbg.h */
The CTR_DRBG context structure.
Definition: ctr_drbg.h:106
void mbedtls_ctr_drbg_free(mbedtls_ctr_drbg_context *ctx)
This function clears CTR_CRBG context data.
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.
int mbedtls_ctr_drbg_seed_entropy_len(mbedtls_ctr_drbg_context *, int(*)(void *, unsigned char *, size_t), void *, const unsigned char *, size_t, size_t)
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...
mbedtls_threading_mutex_t mutex
Definition: ctr_drbg.h:129
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.
void mbedtls_ctr_drbg_set_reseed_interval(mbedtls_ctr_drbg_context *ctx, int interval)
This function sets the reseed interval. The default value is MBEDTLS_CTR_DRBG_RESEED_INTERVAL.
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.
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...
Threading abstraction layer.
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_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_set_entropy_len(mbedtls_ctr_drbg_context *ctx, size_t len)
This function sets the amount of entropy grabbed on each seed or reseed. The default value is MBEDTLS...
The Advanced Encryption Standard (AES) specifies a FIPS-approved cryptographic algorithm that can be ...
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.
int mbedtls_ctr_drbg_self_test(int verbose)
The CTR_DRBG checkup routine.
mbedtls_aes_context aes_ctx
Definition: ctr_drbg.h:118
The AES context-type definition.
Definition: aes.h:73