Mbed TLS v2.28.8
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
12
13#if !defined(MBEDTLS_CONFIG_FILE)
14#include "mbedtls/config.h"
15#else
16#include MBEDTLS_CONFIG_FILE
17#endif
18
19#include <stddef.h>
20
21#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
22#include "mbedtls/sha512.h"
23#define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
24#else
25#if defined(MBEDTLS_SHA256_C)
26#define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
27#include "mbedtls/sha256.h"
28#endif
29#endif
30
31#if defined(MBEDTLS_THREADING_C)
32#include "mbedtls/threading.h"
33#endif
34
35#if defined(MBEDTLS_HAVEGE_C)
36#include "mbedtls/havege.h"
37#endif
38
40#define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C
42#define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E
44#define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040
46#define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D
48#define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F
49
58#if !defined(MBEDTLS_ENTROPY_MAX_SOURCES)
59#define MBEDTLS_ENTROPY_MAX_SOURCES 20
60#endif
61
62#if !defined(MBEDTLS_ENTROPY_MAX_GATHER)
63#define MBEDTLS_ENTROPY_MAX_GATHER 128
64#endif
65
68#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
69#define MBEDTLS_ENTROPY_BLOCK_SIZE 64
70#else
71#define MBEDTLS_ENTROPY_BLOCK_SIZE 32
72#endif
73
74#define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024
75#define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES
76
77#define MBEDTLS_ENTROPY_SOURCE_STRONG 1
78#define MBEDTLS_ENTROPY_SOURCE_WEAK 0
80#ifdef __cplusplus
81extern "C" {
82#endif
83
95typedef int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len,
96 size_t *olen);
97
109
114 int accumulator_started; /* 0 after init.
115 * 1 after the first update.
116 * -1 after free. */
117#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
119#elif defined(MBEDTLS_ENTROPY_SHA256_ACCUMULATOR)
121#endif
122 int source_count; /* Number of entries used in source. */
124#if defined(MBEDTLS_HAVEGE_C)
125 mbedtls_havege_state havege_data;
126#endif
127#if defined(MBEDTLS_THREADING_C)
129#endif
130#if defined(MBEDTLS_ENTROPY_NV_SEED)
131 int initial_entropy_run;
132#endif
133}
135
142
149
168 mbedtls_entropy_f_source_ptr f_source, void *p_source,
169 size_t threshold, int strong);
170
180
192int mbedtls_entropy_func(void *data, unsigned char *output, size_t len);
193
205 const unsigned char *data, size_t len);
206
207#if defined(MBEDTLS_ENTROPY_NV_SEED)
216int mbedtls_entropy_update_nv_seed(mbedtls_entropy_context *ctx);
217#endif /* MBEDTLS_ENTROPY_NV_SEED */
218
219#if defined(MBEDTLS_FS_IO)
231
245#endif /* MBEDTLS_FS_IO */
246
247#if defined(MBEDTLS_SELF_TEST)
257
258#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
272int mbedtls_entropy_source_self_test(int verbose);
273#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
274#endif /* MBEDTLS_SELF_TEST */
275
276#ifdef __cplusplus
277}
278#endif
279
280#endif /* entropy.h */
Configuration options (set of defines)
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:95
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:59
struct mbedtls_entropy_source_state mbedtls_entropy_source_state
Entropy source state.
struct mbedtls_entropy_context mbedtls_entropy_context
Entropy context structure.
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.
HAVEGE: HArdware Volatile Entropy Gathering and Expansion.
This file contains SHA-224 and SHA-256 definitions and functions.
This file contains SHA-384 and SHA-512 definitions and functions.
Entropy context structure.
Definition entropy.h:113
mbedtls_threading_mutex_t mutex
Definition entropy.h:128
mbedtls_entropy_source_state source[MBEDTLS_ENTROPY_MAX_SOURCES]
Definition entropy.h:123
mbedtls_sha512_context accumulator
Definition entropy.h:118
Entropy source state.
Definition entropy.h:101
mbedtls_entropy_f_source_ptr f_source
Definition entropy.h:102
HAVEGE state structure.
Definition havege.h:31
The SHA-256 context structure.
Definition sha256.h:46
The SHA-512 context structure.
Definition sha512.h:45
Threading abstraction layer.