mbed TLS v3.3.0
Loading...
Searching...
No Matches
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
29
30#include "mbedtls/build_info.h"
31
32#include "mbedtls/md.h"
33
34#if defined(MBEDTLS_THREADING_C)
35#include "mbedtls/threading.h"
36#endif
37
38/*
39 * Error codes
40 */
42#define MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG -0x0003
44#define MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG -0x0005
46#define MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR -0x0007
48#define MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED -0x0009
49
58#if !defined(MBEDTLS_HMAC_DRBG_RESEED_INTERVAL)
59#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000
60#endif
61
62#if !defined(MBEDTLS_HMAC_DRBG_MAX_INPUT)
63#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256
64#endif
65
66#if !defined(MBEDTLS_HMAC_DRBG_MAX_REQUEST)
67#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024
68#endif
69
70#if !defined(MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT)
71#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384
72#endif
73
76#define MBEDTLS_HMAC_DRBG_PR_OFF 0
77#define MBEDTLS_HMAC_DRBG_PR_ON 1
79#ifdef __cplusplus
80extern "C" {
81#endif
82
87{
88 /* Working state: the key K is not stored explicitly,
89 * but is implied by the HMAC context */
92 int MBEDTLS_PRIVATE(reseed_counter);
94 /* Administrative state */
95 size_t MBEDTLS_PRIVATE(entropy_len);
96 int MBEDTLS_PRIVATE(prediction_resistance);
98 int MBEDTLS_PRIVATE(reseed_interval);
100 /* Callbacks */
101 int (*MBEDTLS_PRIVATE(f_entropy))(void *, unsigned char *, size_t);
102 void *MBEDTLS_PRIVATE(p_entropy);
104#if defined(MBEDTLS_THREADING_C)
105 /* Invariant: the mutex is initialized if and only if
106 * md_ctx->md_info != NULL. This means that the mutex is initialized
107 * during the initial seeding in mbedtls_hmac_drbg_seed() or
108 * mbedtls_hmac_drbg_seed_buf() and freed in mbedtls_ctr_drbg_free().
109 *
110 * Note that this invariant may change without notice. Do not rely on it
111 * and do not access the mutex directly in application code.
112 */
113 mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
114#endif
116
130
163#if defined(MBEDTLS_THREADING_C)
171#endif /* MBEDTLS_THREADING_C */
200 const mbedtls_md_info_t * md_info,
201 int (*f_entropy)(void *, unsigned char *, size_t),
202 void *p_entropy,
203 const unsigned char *custom,
204 size_t len );
205
212#if defined(MBEDTLS_THREADING_C)
220#endif /* MBEDTLS_THREADING_C */
235 const mbedtls_md_info_t * md_info,
236 const unsigned char *data, size_t data_len );
237
252 int resistance );
253
264 size_t len );
265
279 int interval );
280
299 const unsigned char *additional, size_t add_len );
300
326 const unsigned char *additional, size_t len );
327
360 unsigned char *output, size_t output_len,
361 const unsigned char *additional,
362 size_t add_len );
363
370#if defined(MBEDTLS_THREADING_C)
377#endif /* MBEDTLS_THREADING_C */
391int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len );
392
400
401#if defined(MBEDTLS_FS_IO)
414
430#endif /* MBEDTLS_FS_IO */
431
432
433#if defined(MBEDTLS_SELF_TEST)
441#endif
442
443#ifdef __cplusplus
444}
445#endif
446
447#endif /* hmac_drbg.h */
Build-time configuration info.
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.
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.
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.
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.
void mbedtls_hmac_drbg_init(mbedtls_hmac_drbg_context *ctx)
HMAC_DRBG context initialization.
void mbedtls_hmac_drbg_set_reseed_interval(mbedtls_hmac_drbg_context *ctx, int interval)
Set the reseed interval.
int mbedtls_hmac_drbg_self_test(int verbose)
The HMAC_DRBG Checkup routine.
void mbedtls_hmac_drbg_free(mbedtls_hmac_drbg_context *ctx)
This function resets HMAC_DRBG context to the state immediately after initial call of mbedtls_hmac_dr...
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)
Initialisation of simplified HMAC_DRBG (never reseeds).
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.
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_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_random(void *p_rng, unsigned char *output, size_t out_len)
This function uses HMAC_DRBG to generate random data.
int 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.
This file contains the generic message-digest wrapper.
struct mbedtls_md_info_t mbedtls_md_info_t
Definition: md.h:88
#define MBEDTLS_MD_MAX_SIZE
Definition: md.h:67
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
Threading abstraction layer.