Mbed TLS v3.6.0
Loading...
Searching...
No Matches
entropy.h
Go to the documentation of this file.
1
6/*
7 * Copyright The Mbed TLS Contributors
8 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9 */
10#ifndef MBEDTLS_ENTROPY_H
11#define MBEDTLS_ENTROPY_H
13
14#include "mbedtls/build_info.h"
15
16#include <stddef.h>
17
18#include "md.h"
19
20#if defined(MBEDTLS_MD_CAN_SHA512) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
21#define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
22#define MBEDTLS_ENTROPY_MD MBEDTLS_MD_SHA512
23#define MBEDTLS_ENTROPY_BLOCK_SIZE 64
24#else
25#if defined(MBEDTLS_MD_CAN_SHA256)
26#define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
27#define MBEDTLS_ENTROPY_MD MBEDTLS_MD_SHA256
28#define MBEDTLS_ENTROPY_BLOCK_SIZE 32
29#endif
30#endif
31
32#if defined(MBEDTLS_THREADING_C)
33#include "mbedtls/threading.h"
34#endif
35
36
38#define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C
40#define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E
42#define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040
44#define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D
46#define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F
47
56#if !defined(MBEDTLS_ENTROPY_MAX_SOURCES)
57#define MBEDTLS_ENTROPY_MAX_SOURCES 20
58#endif
59
60#if !defined(MBEDTLS_ENTROPY_MAX_GATHER)
61#define MBEDTLS_ENTROPY_MAX_GATHER 128
62#endif
63
66#define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024
67#define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES
68
69#define MBEDTLS_ENTROPY_SOURCE_STRONG 1
70#define MBEDTLS_ENTROPY_SOURCE_WEAK 0
72#ifdef __cplusplus
73extern "C" {
74#endif
75
87typedef int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len,
88 size_t *olen);
89
95 void *MBEDTLS_PRIVATE(p_source);
96 size_t MBEDTLS_PRIVATE(size);
97 size_t MBEDTLS_PRIVATE(threshold);
98 int MBEDTLS_PRIVATE(strong);
99}
101
107 int MBEDTLS_PRIVATE(accumulator_started); /* 0 after init.
108 * 1 after the first update.
109 * -1 after free. */
110 int MBEDTLS_PRIVATE(source_count); /* Number of entries used in source. */
112#if defined(MBEDTLS_THREADING_C)
114#endif
115#if defined(MBEDTLS_ENTROPY_NV_SEED)
116 int MBEDTLS_PRIVATE(initial_entropy_run);
117#endif
118}
120
121#if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
126 unsigned char *output, size_t len, size_t *olen);
127#endif
128
135
142
161 mbedtls_entropy_f_source_ptr f_source, void *p_source,
162 size_t threshold, int strong);
163
173
185int mbedtls_entropy_func(void *data, unsigned char *output, size_t len);
186
198 const unsigned char *data, size_t len);
199
200#if defined(MBEDTLS_ENTROPY_NV_SEED)
209int mbedtls_entropy_update_nv_seed(mbedtls_entropy_context *ctx);
210#endif /* MBEDTLS_ENTROPY_NV_SEED */
211
212#if defined(MBEDTLS_FS_IO)
224
238#endif /* MBEDTLS_FS_IO */
239
240#if defined(MBEDTLS_SELF_TEST)
250
251#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
265int mbedtls_entropy_source_self_test(int verbose);
266#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
267#endif /* MBEDTLS_SELF_TEST */
268
269#ifdef __cplusplus
270}
271#endif
272
273#endif /* entropy.h */
void mbedtls_entropy_free(mbedtls_entropy_context *ctx)
Free the data in the context.
int(* mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len, size_t *olen)
Entropy poll callback pointer.
Definition entropy.h:87
int mbedtls_entropy_update_seed_file(mbedtls_entropy_context *ctx, const char *path)
Read and update a seed file. Seed is added to this instance. No more than MBEDTLS_ENTROPY_MAX_SEED_SI...
int mbedtls_entropy_func(void *data, unsigned char *output, size_t len)
Retrieve entropy from the accumulator (Maximum length: MBEDTLS_ENTROPY_BLOCK_SIZE) (Thread-safe if MB...
#define MBEDTLS_ENTROPY_MAX_SOURCES
Definition entropy.h:57
int mbedtls_entropy_update_manual(mbedtls_entropy_context *ctx, const unsigned char *data, size_t len)
Add data to the accumulator manually (Thread-safe if MBEDTLS_THREADING_C is enabled)
void mbedtls_entropy_init(mbedtls_entropy_context *ctx)
Initialize the context.
int mbedtls_entropy_write_seed_file(mbedtls_entropy_context *ctx, const char *path)
Write a seed file.
int mbedtls_entropy_gather(mbedtls_entropy_context *ctx)
Trigger an extra gather poll for the accumulator (Thread-safe if MBEDTLS_THREADING_C is enabled)
int mbedtls_entropy_add_source(mbedtls_entropy_context *ctx, mbedtls_entropy_f_source_ptr f_source, void *p_source, size_t threshold, int strong)
Adds an entropy source to poll (Thread-safe if MBEDTLS_THREADING_C is enabled)
int mbedtls_entropy_self_test(int verbose)
Checkup routine.
int mbedtls_platform_entropy_poll(void *data, unsigned char *output, size_t len, size_t *olen)
Platform-specific entropy poll callback.
Build-time configuration info.
This file contains the generic functions for message-digest (hashing) and HMAC.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
Entropy context structure.
Definition entropy.h:105
Entropy source state.
Definition entropy.h:93
Threading abstraction layer.