mbed TLS v3.3.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
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
25
26#include "mbedtls/build_info.h"
27
28#include <stddef.h>
29
30#if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
31#include "mbedtls/sha512.h"
32#define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
33#else
34#if defined(MBEDTLS_SHA256_C)
35#define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
36#include "mbedtls/sha256.h"
37#endif
38#endif
39
40#if defined(MBEDTLS_THREADING_C)
41#include "mbedtls/threading.h"
42#endif
43
44
46#define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C
48#define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E
50#define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040
52#define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D
54#define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F
55
64#if !defined(MBEDTLS_ENTROPY_MAX_SOURCES)
65#define MBEDTLS_ENTROPY_MAX_SOURCES 20
66#endif
67
68#if !defined(MBEDTLS_ENTROPY_MAX_GATHER)
69#define MBEDTLS_ENTROPY_MAX_GATHER 128
70#endif
71
74#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
75#define MBEDTLS_ENTROPY_BLOCK_SIZE 64
76#else
77#define MBEDTLS_ENTROPY_BLOCK_SIZE 32
78#endif
79
80#define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024
81#define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES
82
83#define MBEDTLS_ENTROPY_SOURCE_STRONG 1
84#define MBEDTLS_ENTROPY_SOURCE_WEAK 0
86#ifdef __cplusplus
87extern "C" {
88#endif
89
101typedef int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len,
102 size_t *olen);
103
108{
110 void * MBEDTLS_PRIVATE(p_source);
111 size_t MBEDTLS_PRIVATE(size);
112 size_t MBEDTLS_PRIVATE(threshold);
113 int MBEDTLS_PRIVATE(strong);
114}
116
121{
122 int MBEDTLS_PRIVATE(accumulator_started); /* 0 after init.
123 * 1 after the first update.
124 * -1 after free. */
125#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
127#elif defined(MBEDTLS_ENTROPY_SHA256_ACCUMULATOR)
129#endif
130 int MBEDTLS_PRIVATE(source_count); /* Number of entries used in source. */
132#if defined(MBEDTLS_THREADING_C)
133 mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
134#endif
135#if defined(MBEDTLS_ENTROPY_NV_SEED)
136 int MBEDTLS_PRIVATE(initial_entropy_run);
137#endif
138}
140
141#if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
146 unsigned char *output, size_t len, size_t *olen );
147#endif
148
155
162
181 mbedtls_entropy_f_source_ptr f_source, void *p_source,
182 size_t threshold, int strong );
183
193
205int mbedtls_entropy_func( void *data, unsigned char *output, size_t len );
206
218 const unsigned char *data, size_t len );
219
220#if defined(MBEDTLS_ENTROPY_NV_SEED)
229int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx );
230#endif /* MBEDTLS_ENTROPY_NV_SEED */
231
232#if defined(MBEDTLS_FS_IO)
244
258#endif /* MBEDTLS_FS_IO */
259
260#if defined(MBEDTLS_SELF_TEST)
269int mbedtls_entropy_self_test( int verbose );
270
271#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
285int mbedtls_entropy_source_self_test( int verbose );
286#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
287#endif /* MBEDTLS_SELF_TEST */
288
289#ifdef __cplusplus
290}
291#endif
292
293#endif /* entropy.h */
Build-time configuration info.
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:101
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:65
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.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
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:121
Entropy source state.
Definition: entropy.h:108
The SHA-256 context structure.
Definition: sha256.h:53
The SHA-512 context structure.
Definition: sha512.h:52
Threading abstraction layer.