mbed TLS v2.16.1
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: GPL-2.0
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  *
24  * This file is part of mbed TLS (https://tls.mbed.org)
25  */
26 #ifndef MBEDTLS_HMAC_DRBG_H
27 #define MBEDTLS_HMAC_DRBG_H
28 
29 #if !defined(MBEDTLS_CONFIG_FILE)
30 #include "config.h"
31 #else
32 #include MBEDTLS_CONFIG_FILE
33 #endif
34 
35 #include "md.h"
36 
37 #if defined(MBEDTLS_THREADING_C)
38 #include "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 explicitely,
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)
104  mbedtls_threading_mutex_t mutex;
105 #endif
107 
117 
143  const mbedtls_md_info_t * md_info,
144  int (*f_entropy)(void *, unsigned char *, size_t),
145  void *p_entropy,
146  const unsigned char *custom,
147  size_t len );
148 
163  const mbedtls_md_info_t * md_info,
164  const unsigned char *data, size_t data_len );
165 
176  int resistance );
177 
187  size_t len );
188 
197  int interval );
198 
213  const unsigned char *additional, size_t add_len );
214 
226  const unsigned char *additional, size_t len );
227 
244 int mbedtls_hmac_drbg_random_with_add( void *p_rng,
245  unsigned char *output, size_t output_len,
246  const unsigned char *additional,
247  size_t add_len );
248 
262 int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len );
263 
270 
271 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
272 #if defined(MBEDTLS_DEPRECATED_WARNING)
273 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
274 #else
275 #define MBEDTLS_DEPRECATED
276 #endif
277 
292  const unsigned char *additional, size_t add_len );
293 #undef MBEDTLS_DEPRECATED
294 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
295 
296 #if defined(MBEDTLS_FS_IO)
297 
307 
320 #endif /* MBEDTLS_FS_IO */
321 
322 
323 #if defined(MBEDTLS_SELF_TEST)
324 
329 int mbedtls_hmac_drbg_self_test( int verbose );
330 #endif
331 
332 #ifdef __cplusplus
333 }
334 #endif
335 
336 #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:74
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.
Configuration options (set of defines)
int mbedtls_hmac_drbg_self_test(int verbose)
Checkup routine.
unsigned char V[MBEDTLS_MD_MAX_SIZE]
Definition: hmac_drbg.h:90
Threading abstraction layer.
struct mbedtls_hmac_drbg_context mbedtls_hmac_drbg_context
#define MBEDTLS_DEPRECATED
Definition: hmac_drbg.h:275
MBEDTLS_DEPRECATED void mbedtls_hmac_drbg_update(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t add_len)
HMAC_DRBG update state.
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)
Read and update a seed file. 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 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:82
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)
Write a seed file.
int mbedtls_hmac_drbg_update_ret(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t add_len)
HMAC_DRBG update state.
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)