mbed TLS v2.7.6
hmac_drbg.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8  * SPDX-License-Identifier: Apache-2.0
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License"); you may
11  * not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  *
22  * This file is part of mbed TLS (https://tls.mbed.org)
23  */
24 #ifndef MBEDTLS_HMAC_DRBG_H
25 #define MBEDTLS_HMAC_DRBG_H
26 
27 #include "md.h"
28 
29 #if defined(MBEDTLS_THREADING_C)
30 #include "threading.h"
31 #endif
32 
33 /*
34  * Error codes
35  */
36 #define MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG -0x0003
37 #define MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG -0x0005
38 #define MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR -0x0007
39 #define MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED -0x0009
49 #if !defined(MBEDTLS_HMAC_DRBG_RESEED_INTERVAL)
50 #define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000
51 #endif
52 
53 #if !defined(MBEDTLS_HMAC_DRBG_MAX_INPUT)
54 #define MBEDTLS_HMAC_DRBG_MAX_INPUT 256
55 #endif
56 
57 #if !defined(MBEDTLS_HMAC_DRBG_MAX_REQUEST)
58 #define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024
59 #endif
60 
61 #if !defined(MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT)
62 #define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384
63 #endif
64 
65 /* \} name SECTION: Module settings */
66 
67 #define MBEDTLS_HMAC_DRBG_PR_OFF 0
68 #define MBEDTLS_HMAC_DRBG_PR_ON 1
70 #ifdef __cplusplus
71 extern "C" {
72 #endif
73 
77 typedef struct
78 {
79  /* Working state: the key K is not stored explicitely,
80  * but is implied by the HMAC context */
82  unsigned char V[MBEDTLS_MD_MAX_SIZE];
85  /* Administrative state */
86  size_t entropy_len;
91  /* Callbacks */
92  int (*f_entropy)(void *, unsigned char *, size_t);
93  void *p_entropy;
95 #if defined(MBEDTLS_THREADING_C)
97 #endif
99 
109 
135  const mbedtls_md_info_t * md_info,
136  int (*f_entropy)(void *, unsigned char *, size_t),
137  void *p_entropy,
138  const unsigned char *custom,
139  size_t len );
140 
155  const mbedtls_md_info_t * md_info,
156  const unsigned char *data, size_t data_len );
157 
168  int resistance );
169 
179  size_t len );
180 
189  int interval );
190 
202  const unsigned char *additional, size_t add_len );
203 
215  const unsigned char *additional, size_t len );
216 
233 int mbedtls_hmac_drbg_random_with_add( void *p_rng,
234  unsigned char *output, size_t output_len,
235  const unsigned char *additional,
236  size_t add_len );
237 
251 int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len );
252 
259 
260 #if defined(MBEDTLS_FS_IO)
261 
271 
284 #endif /* MBEDTLS_FS_IO */
285 
286 
287 #if defined(MBEDTLS_SELF_TEST)
288 
293 int mbedtls_hmac_drbg_self_test( int verbose );
294 #endif
295 
296 #ifdef __cplusplus
297 }
298 #endif
299 
300 #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 Seed and setup entropy source for future reseeds.
#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). (For use with deterministic ECDSA...
void mbedtls_hmac_drbg_set_reseed_interval(mbedtls_hmac_drbg_context *ctx, int interval)
Set the reseed interval (Default: MBEDTLS_HMAC_DRBG_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)
HMAC_DRBG generate random.
int mbedtls_hmac_drbg_self_test(int verbose)
Checkup routine.
mbedtls_threading_mutex_t mutex
Definition: hmac_drbg.h:96
Threading abstraction layer.
int mbedtls_hmac_drbg_update_seed_file(mbedtls_hmac_drbg_context *ctx, const char *path)
Read and update a seed file. Seed is added to this instance.
void mbedtls_hmac_drbg_update(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t add_len)
HMAC_DRBG update state.
The generic message-digest wrapper.
void mbedtls_hmac_drbg_init(mbedtls_hmac_drbg_context *ctx)
HMAC_DRBG context initialization Makes the context ready for mbedtls_hmac_drbg_seed(), mbedtls_hmac_drbg_seed_buf() or mbedtls_hmac_drbg_free().
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)
HMAC_DRBG generate random with additional update input.
int mbedtls_hmac_drbg_reseed(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t len)
HMAC_DRBG reseeding (extracts data from entropy source)
struct mbedtls_md_info_t mbedtls_md_info_t
Definition: md.h:78
mbedtls_md_context_t md_ctx
Definition: hmac_drbg.h:81
int mbedtls_hmac_drbg_write_seed_file(mbedtls_hmac_drbg_context *ctx, const char *path)
Write a seed file.
void mbedtls_hmac_drbg_set_entropy_len(mbedtls_hmac_drbg_context *ctx, size_t len)
Set the amount of entropy grabbed on each reseed (Default: given by the security strength, which depends on the hash used, see mbedtls_hmac_drbg_init() )
void mbedtls_hmac_drbg_set_prediction_resistance(mbedtls_hmac_drbg_context *ctx, int resistance)
Enable / disable prediction resistance (Default: Off)