mbed TLS v2.16.7
hmac_drbg.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright (C) 2006-2019, ARM Limited, All Rights Reserved
12  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
13  *
14  * This file is provided under the Apache License 2.0, or the
15  * GNU General Public License v2.0 or later.
16  *
17  * **********
18  * Apache License 2.0:
19  *
20  * Licensed under the Apache License, Version 2.0 (the "License"); you may
21  * not use this file except in compliance with the License.
22  * You may obtain a copy of the License at
23  *
24  * http://www.apache.org/licenses/LICENSE-2.0
25  *
26  * Unless required by applicable law or agreed to in writing, software
27  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
28  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29  * See the License for the specific language governing permissions and
30  * limitations under the License.
31  *
32  * **********
33  *
34  * **********
35  * GNU General Public License v2.0 or later:
36  *
37  * This program is free software; you can redistribute it and/or modify
38  * it under the terms of the GNU General Public License as published by
39  * the Free Software Foundation; either version 2 of the License, or
40  * (at your option) any later version.
41  *
42  * This program is distributed in the hope that it will be useful,
43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45  * GNU General Public License for more details.
46  *
47  * You should have received a copy of the GNU General Public License along
48  * with this program; if not, write to the Free Software Foundation, Inc.,
49  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
50  *
51  * **********
52  *
53  * This file is part of mbed TLS (https://tls.mbed.org)
54  */
55 #ifndef MBEDTLS_HMAC_DRBG_H
56 #define MBEDTLS_HMAC_DRBG_H
57 
58 #if !defined(MBEDTLS_CONFIG_FILE)
59 #include "config.h"
60 #else
61 #include MBEDTLS_CONFIG_FILE
62 #endif
63 
64 #include "md.h"
65 
66 #if defined(MBEDTLS_THREADING_C)
67 #include "threading.h"
68 #endif
69 
70 /*
71  * Error codes
72  */
73 #define MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG -0x0003
74 #define MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG -0x0005
75 #define MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR -0x0007
76 #define MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED -0x0009
86 #if !defined(MBEDTLS_HMAC_DRBG_RESEED_INTERVAL)
87 #define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000
88 #endif
89 
90 #if !defined(MBEDTLS_HMAC_DRBG_MAX_INPUT)
91 #define MBEDTLS_HMAC_DRBG_MAX_INPUT 256
92 #endif
93 
94 #if !defined(MBEDTLS_HMAC_DRBG_MAX_REQUEST)
95 #define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024
96 #endif
97 
98 #if !defined(MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT)
99 #define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384
100 #endif
101 
102 /* \} name SECTION: Module settings */
103 
104 #define MBEDTLS_HMAC_DRBG_PR_OFF 0
105 #define MBEDTLS_HMAC_DRBG_PR_ON 1
107 #ifdef __cplusplus
108 extern "C" {
109 #endif
110 
115 {
116  /* Working state: the key K is not stored explicitly,
117  * but is implied by the HMAC context */
119  unsigned char V[MBEDTLS_MD_MAX_SIZE];
122  /* Administrative state */
123  size_t entropy_len;
128  /* Callbacks */
129  int (*f_entropy)(void *, unsigned char *, size_t);
130  void *p_entropy;
132 #if defined(MBEDTLS_THREADING_C)
134 #endif
136 
146 
206  const mbedtls_md_info_t * md_info,
207  int (*f_entropy)(void *, unsigned char *, size_t),
208  void *p_entropy,
209  const unsigned char *custom,
210  size_t len );
211 
231  const mbedtls_md_info_t * md_info,
232  const unsigned char *data, size_t data_len );
233 
248  int resistance );
249 
260  size_t len );
261 
275  int interval );
276 
290  const unsigned char *additional, size_t add_len );
291 
312  const unsigned char *additional, size_t len );
313 
340 int mbedtls_hmac_drbg_random_with_add( void *p_rng,
341  unsigned char *output, size_t output_len,
342  const unsigned char *additional,
343  size_t add_len );
344 
363 int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len );
364 
371 
372 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
373 #if defined(MBEDTLS_DEPRECATED_WARNING)
374 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
375 #else
376 #define MBEDTLS_DEPRECATED
377 #endif
378 
392  const unsigned char *additional, size_t add_len );
393 #undef MBEDTLS_DEPRECATED
394 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
395 
396 #if defined(MBEDTLS_FS_IO)
397 
409 
425 #endif /* MBEDTLS_FS_IO */
426 
427 
428 #if defined(MBEDTLS_SELF_TEST)
429 
435 int mbedtls_hmac_drbg_self_test( int verbose );
436 #endif
437 
438 #ifdef __cplusplus
439 }
440 #endif
441 
442 #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:99
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:133
int(* f_entropy)(void *, unsigned char *, size_t)
Definition: hmac_drbg.h:129
unsigned char V[MBEDTLS_MD_MAX_SIZE]
Definition: hmac_drbg.h:119
Threading abstraction layer.
struct mbedtls_hmac_drbg_context mbedtls_hmac_drbg_context
#define MBEDTLS_DEPRECATED
Definition: hmac_drbg.h:376
MBEDTLS_DEPRECATED void mbedtls_hmac_drbg_update(mbedtls_hmac_drbg_context *ctx, const unsigned char *additional, size_t add_len)
This function updates the state of the HMAC_DRBG context.
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:107
mbedtls_md_context_t md_ctx
Definition: hmac_drbg.h:118
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.