mbed TLS v2.16.3
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 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32 
33 #include "md.h"
34 
35 #if defined(MBEDTLS_THREADING_C)
36 #include "threading.h"
37 #endif
38 
39 /*
40  * Error codes
41  */
42 #define MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG -0x0003
43 #define MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG -0x0005
44 #define MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR -0x0007
45 #define MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED -0x0009
55 #if !defined(MBEDTLS_HMAC_DRBG_RESEED_INTERVAL)
56 #define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000
57 #endif
58 
59 #if !defined(MBEDTLS_HMAC_DRBG_MAX_INPUT)
60 #define MBEDTLS_HMAC_DRBG_MAX_INPUT 256
61 #endif
62 
63 #if !defined(MBEDTLS_HMAC_DRBG_MAX_REQUEST)
64 #define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024
65 #endif
66 
67 #if !defined(MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT)
68 #define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384
69 #endif
70 
71 /* \} name SECTION: Module settings */
72 
73 #define MBEDTLS_HMAC_DRBG_PR_OFF 0
74 #define MBEDTLS_HMAC_DRBG_PR_ON 1
76 #ifdef __cplusplus
77 extern "C" {
78 #endif
79 
84 {
85  /* Working state: the key K is not stored explicitly,
86  * but is implied by the HMAC context */
88  unsigned char V[MBEDTLS_MD_MAX_SIZE];
91  /* Administrative state */
92  size_t entropy_len;
97  /* Callbacks */
98  int (*f_entropy)(void *, unsigned char *, size_t);
99  void *p_entropy;
101 #if defined(MBEDTLS_THREADING_C)
103 #endif
105 
115 
141  const mbedtls_md_info_t * md_info,
142  int (*f_entropy)(void *, unsigned char *, size_t),
143  void *p_entropy,
144  const unsigned char *custom,
145  size_t len );
146 
161  const mbedtls_md_info_t * md_info,
162  const unsigned char *data, size_t data_len );
163 
174  int resistance );
175 
185  size_t len );
186 
195  int interval );
196 
211  const unsigned char *additional, size_t add_len );
212 
224  const unsigned char *additional, size_t len );
225 
242 int mbedtls_hmac_drbg_random_with_add( void *p_rng,
243  unsigned char *output, size_t output_len,
244  const unsigned char *additional,
245  size_t add_len );
246 
260 int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len );
261 
268 
269 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
270 #if defined(MBEDTLS_DEPRECATED_WARNING)
271 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
272 #else
273 #define MBEDTLS_DEPRECATED
274 #endif
275 
290  const unsigned char *additional, size_t add_len );
291 #undef MBEDTLS_DEPRECATED
292 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
293 
294 #if defined(MBEDTLS_FS_IO)
295 
305 
318 #endif /* MBEDTLS_FS_IO */
319 
320 
321 #if defined(MBEDTLS_SELF_TEST)
322 
327 int mbedtls_hmac_drbg_self_test( int verbose );
328 #endif
329 
330 #ifdef __cplusplus
331 }
332 #endif
333 
334 #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:72
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.
mbedtls_threading_mutex_t mutex
Definition: hmac_drbg.h:102
int(* f_entropy)(void *, unsigned char *, size_t)
Definition: hmac_drbg.h:98
unsigned char V[MBEDTLS_MD_MAX_SIZE]
Definition: hmac_drbg.h:88
Threading abstraction layer.
struct mbedtls_hmac_drbg_context mbedtls_hmac_drbg_context
#define MBEDTLS_DEPRECATED
Definition: hmac_drbg.h:271
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 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:80
mbedtls_md_context_t md_ctx
Definition: hmac_drbg.h:87
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)