mbed TLS v2.24.0
hmac_drbg.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright The Mbed TLS Contributors
12  * SPDX-License-Identifier: Apache-2.0
13  *
14  * Licensed under the Apache License, Version 2.0 (the "License"); you may
15  * not use this file except in compliance with the License.
16  * You may obtain a copy of the License at
17  *
18  * http://www.apache.org/licenses/LICENSE-2.0
19  *
20  * Unless required by applicable law or agreed to in writing, software
21  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23  * See the License for the specific language governing permissions and
24  * limitations under the License.
25  */
26 #ifndef MBEDTLS_HMAC_DRBG_H
27 #define MBEDTLS_HMAC_DRBG_H
28 
29 #if !defined(MBEDTLS_CONFIG_FILE)
30 #include "mbedtls/config.h"
31 #else
32 #include MBEDTLS_CONFIG_FILE
33 #endif
34 
35 #include "mbedtls/md.h"
36 
37 #if defined(MBEDTLS_THREADING_C)
38 #include "mbedtls/threading.h"
39 #endif
40 
41 /*
42  * Error codes
43  */
44 #define MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG -0x0003
45 #define MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG -0x0005
46 #define MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR -0x0007
47 #define MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED -0x0009
57 #if !defined(MBEDTLS_HMAC_DRBG_RESEED_INTERVAL)
58 #define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000
59 #endif
60 
61 #if !defined(MBEDTLS_HMAC_DRBG_MAX_INPUT)
62 #define MBEDTLS_HMAC_DRBG_MAX_INPUT 256
63 #endif
64 
65 #if !defined(MBEDTLS_HMAC_DRBG_MAX_REQUEST)
66 #define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024
67 #endif
68 
69 #if !defined(MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT)
70 #define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384
71 #endif
72 
73 /* \} name SECTION: Module settings */
74 
75 #define MBEDTLS_HMAC_DRBG_PR_OFF 0
76 #define MBEDTLS_HMAC_DRBG_PR_ON 1
78 #ifdef __cplusplus
79 extern "C" {
80 #endif
81 
86 {
87  /* Working state: the key K is not stored explicitly,
88  * but is implied by the HMAC context */
90  unsigned char V[MBEDTLS_MD_MAX_SIZE];
93  /* Administrative state */
94  size_t entropy_len;
99  /* Callbacks */
100  int (*f_entropy)(void *, unsigned char *, size_t);
101  void *p_entropy;
103 #if defined(MBEDTLS_THREADING_C)
105 #endif
107 
117 
177  const mbedtls_md_info_t * md_info,
178  int (*f_entropy)(void *, unsigned char *, size_t),
179  void *p_entropy,
180  const unsigned char *custom,
181  size_t len );
182 
202  const mbedtls_md_info_t * md_info,
203  const unsigned char *data, size_t data_len );
204 
219  int resistance );
220 
231  size_t len );
232 
246  int interval );
247 
261  const unsigned char *additional, size_t add_len );
262 
283  const unsigned char *additional, size_t len );
284 
311 int mbedtls_hmac_drbg_random_with_add( void *p_rng,
312  unsigned char *output, size_t output_len,
313  const unsigned char *additional,
314  size_t add_len );
315 
334 int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len );
335 
342 
343 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
344 #if defined(MBEDTLS_DEPRECATED_WARNING)
345 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
346 #else
347 #define MBEDTLS_DEPRECATED
348 #endif
349 
361 MBEDTLS_DEPRECATED void mbedtls_hmac_drbg_update(
363  const unsigned char *additional, size_t add_len );
364 #undef MBEDTLS_DEPRECATED
365 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
366 
367 #if defined(MBEDTLS_FS_IO)
368 
380 
396 #endif /* MBEDTLS_FS_IO */
397 
398 
399 #if defined(MBEDTLS_SELF_TEST)
400 
406 int mbedtls_hmac_drbg_self_test( int verbose );
407 #endif
408 
409 #ifdef __cplusplus
410 }
411 #endif
412 
413 #endif /* hmac_drbg.h */
int mbedtls_hmac_drbg_seed(mbedtls_hmac_drbg_context *ctx, const mbedtls_md_info_t *md_info, int(*f_entropy)(void *, unsigned char *, size_t), void *p_entropy, const unsigned char *custom, size_t len)
HMAC_DRBG initial seeding.
#define MBEDTLS_MD_MAX_SIZE
Definition: md.h:70
int mbedtls_hmac_drbg_seed_buf(mbedtls_hmac_drbg_context *ctx, const mbedtls_md_info_t *md_info, const unsigned char *data, size_t data_len)
Initilisation of simpified HMAC_DRBG (never reseeds).
void mbedtls_hmac_drbg_set_reseed_interval(mbedtls_hmac_drbg_context *ctx, int interval)
Set the reseed interval.
void mbedtls_hmac_drbg_free(mbedtls_hmac_drbg_context *ctx)
Free an HMAC_DRBG context.
int mbedtls_hmac_drbg_random(void *p_rng, unsigned char *output, size_t out_len)
This function uses HMAC_DRBG to generate random data.
Configuration options (set of defines)
int mbedtls_hmac_drbg_self_test(int verbose)
The HMAC_DRBG Checkup routine.
mbedtls_threading_mutex_t mutex
Definition: hmac_drbg.h:104
#define MBEDTLS_DEPRECATED
Definition: pkcs11.h:60
unsigned char V[MBEDTLS_MD_MAX_SIZE]
Definition: hmac_drbg.h:90
Threading abstraction layer.
struct mbedtls_hmac_drbg_context mbedtls_hmac_drbg_context
int(* f_entropy)(void *, unsigned char *, size_t)
Definition: hmac_drbg.h:100
int mbedtls_hmac_drbg_update_seed_file(mbedtls_hmac_drbg_context *ctx, const char *path)
This function reads and updates a seed file. The seed is added to this instance.
This file contains the generic message-digest wrapper.
void mbedtls_hmac_drbg_init(mbedtls_hmac_drbg_context *ctx)
HMAC_DRBG context initialization.
int mbedtls_hmac_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 an HMAC_DRBG instance with additional data and uses it to generate random data...
int mbedtls_hmac_drbg_reseed(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t len)
This function reseeds the HMAC_DRBG context, that is extracts data from the entropy source...
struct mbedtls_md_info_t mbedtls_md_info_t
Definition: md.h:84
mbedtls_md_context_t md_ctx
Definition: hmac_drbg.h:89
int mbedtls_hmac_drbg_write_seed_file(mbedtls_hmac_drbg_context *ctx, const char *path)
This function writes a seed file.
int mbedtls_hmac_drbg_update_ret(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t add_len)
This function updates the state of the HMAC_DRBG context.
void mbedtls_hmac_drbg_set_entropy_len(mbedtls_hmac_drbg_context *ctx, size_t len)
This function sets the amount of entropy grabbed on each seed or reseed.
void mbedtls_hmac_drbg_set_prediction_resistance(mbedtls_hmac_drbg_context *ctx, int resistance)
This function turns prediction resistance on or off. The default value is off.