mbed TLS v2.28.2
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
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 */
22#ifndef MBEDTLS_ENTROPY_H
23#define MBEDTLS_ENTROPY_H
24
25#if !defined(MBEDTLS_CONFIG_FILE)
26#include "mbedtls/config.h"
27#else
28#include MBEDTLS_CONFIG_FILE
29#endif
30
31#include <stddef.h>
32
33#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
34#include "mbedtls/sha512.h"
35#define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
36#else
37#if defined(MBEDTLS_SHA256_C)
38#define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
39#include "mbedtls/sha256.h"
40#endif
41#endif
42
43#if defined(MBEDTLS_THREADING_C)
44#include "mbedtls/threading.h"
45#endif
46
47#if defined(MBEDTLS_HAVEGE_C)
48#include "mbedtls/havege.h"
49#endif
50
52#define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C
54#define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E
56#define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040
58#define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D
60#define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F
61
70#if !defined(MBEDTLS_ENTROPY_MAX_SOURCES)
71#define MBEDTLS_ENTROPY_MAX_SOURCES 20
72#endif
73
74#if !defined(MBEDTLS_ENTROPY_MAX_GATHER)
75#define MBEDTLS_ENTROPY_MAX_GATHER 128
76#endif
77
80#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
81#define MBEDTLS_ENTROPY_BLOCK_SIZE 64
82#else
83#define MBEDTLS_ENTROPY_BLOCK_SIZE 32
84#endif
85
86#define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024
87#define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES
88
89#define MBEDTLS_ENTROPY_SOURCE_STRONG 1
90#define MBEDTLS_ENTROPY_SOURCE_WEAK 0
92#ifdef __cplusplus
93extern "C" {
94#endif
95
107typedef int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len,
108 size_t *olen);
109
114{
116 void * p_source;
117 size_t size;
118 size_t threshold;
119 int strong;
120}
122
127{
128 int accumulator_started; /* 0 after init.
129 * 1 after the first update.
130 * -1 after free. */
131#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
133#elif defined(MBEDTLS_ENTROPY_SHA256_ACCUMULATOR)
135#endif
136 int source_count; /* Number of entries used in source. */
138#if defined(MBEDTLS_HAVEGE_C)
140#endif
141#if defined(MBEDTLS_THREADING_C)
143#endif
144#if defined(MBEDTLS_ENTROPY_NV_SEED)
145 int initial_entropy_run;
146#endif
147}
149
156
163
182 mbedtls_entropy_f_source_ptr f_source, void *p_source,
183 size_t threshold, int strong );
184
194
206int mbedtls_entropy_func( void *data, unsigned char *output, size_t len );
207
219 const unsigned char *data, size_t len );
220
221#if defined(MBEDTLS_ENTROPY_NV_SEED)
230int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx );
231#endif /* MBEDTLS_ENTROPY_NV_SEED */
232
233#if defined(MBEDTLS_FS_IO)
245
259#endif /* MBEDTLS_FS_IO */
260
261#if defined(MBEDTLS_SELF_TEST)
270int mbedtls_entropy_self_test( int verbose );
271
272#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
286int mbedtls_entropy_source_self_test( int verbose );
287#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
288#endif /* MBEDTLS_SELF_TEST */
289
290#ifdef __cplusplus
291}
292#endif
293
294#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:107
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:71
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:127
mbedtls_threading_mutex_t mutex
Definition: entropy.h:142
mbedtls_entropy_source_state source[MBEDTLS_ENTROPY_MAX_SOURCES]
Definition: entropy.h:137
mbedtls_havege_state havege_data
Definition: entropy.h:139
mbedtls_sha512_context accumulator
Definition: entropy.h:132
Entropy source state.
Definition: entropy.h:114
mbedtls_entropy_f_source_ptr f_source
Definition: entropy.h:115
HAVEGE state structure.
Definition: havege.h:44
The SHA-256 context structure.
Definition: sha256.h:59
The SHA-512 context structure.
Definition: sha512.h:58
Threading abstraction layer.