Mbed TLS v3.6.3
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(PSA_WANT_ALG_SHA_512)) && \
21 !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
22#define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
23#define MBEDTLS_ENTROPY_MD MBEDTLS_MD_SHA512
24#define MBEDTLS_ENTROPY_BLOCK_SIZE 64
25#else
26#if (defined(MBEDTLS_MD_CAN_SHA256) || defined(PSA_WANT_ALG_SHA_256))
27#define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
28#define MBEDTLS_ENTROPY_MD MBEDTLS_MD_SHA256
29#define MBEDTLS_ENTROPY_BLOCK_SIZE 32
30#endif
31#endif
32
33#if defined(MBEDTLS_THREADING_C)
34#include "mbedtls/threading.h"
35#endif
36
37
39#define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C
41#define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E
43#define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040
45#define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D
47#define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F
48
57#if !defined(MBEDTLS_ENTROPY_MAX_SOURCES)
58#define MBEDTLS_ENTROPY_MAX_SOURCES 20
59#endif
60
61#if !defined(MBEDTLS_ENTROPY_MAX_GATHER)
62#define MBEDTLS_ENTROPY_MAX_GATHER 128
63#endif
64
67#define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024
68#define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES
69
70#define MBEDTLS_ENTROPY_SOURCE_STRONG 1
71#define MBEDTLS_ENTROPY_SOURCE_WEAK 0
73#ifdef __cplusplus
74extern "C" {
75#endif
76
88typedef int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len,
89 size_t *olen);
90
96 void *MBEDTLS_PRIVATE(p_source);
97 size_t MBEDTLS_PRIVATE(size);
98 size_t MBEDTLS_PRIVATE(threshold);
99 int MBEDTLS_PRIVATE(strong);
100}
102
108 int MBEDTLS_PRIVATE(accumulator_started); /* 0 after init.
109 * 1 after the first update.
110 * -1 after free. */
111 int MBEDTLS_PRIVATE(source_count); /* Number of entries used in source. */
113#if defined(MBEDTLS_THREADING_C)
115#endif
116#if defined(MBEDTLS_ENTROPY_NV_SEED)
117 int MBEDTLS_PRIVATE(initial_entropy_run);
118#endif
119}
121
122#if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
127 unsigned char *output, size_t len, size_t *olen);
128#endif
129
136
143
162 mbedtls_entropy_f_source_ptr f_source, void *p_source,
163 size_t threshold, int strong);
164
174
186int mbedtls_entropy_func(void *data, unsigned char *output, size_t len);
187
199 const unsigned char *data, size_t len);
200
201#if defined(MBEDTLS_ENTROPY_NV_SEED)
210int mbedtls_entropy_update_nv_seed(mbedtls_entropy_context *ctx);
211#endif /* MBEDTLS_ENTROPY_NV_SEED */
212
213#if defined(MBEDTLS_FS_IO)
225
239#endif /* MBEDTLS_FS_IO */
240
241#if defined(MBEDTLS_SELF_TEST)
251
252#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
266int mbedtls_entropy_source_self_test(int verbose);
267#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
268#endif /* MBEDTLS_SELF_TEST */
269
270#ifdef __cplusplus
271}
272#endif
273
274#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:88
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:58
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:106
Entropy source state.
Definition: entropy.h:94
Threading abstraction layer.