mbed TLS v2.23.0: entropy.h Source File

mbed TLS v2.23.0

entropy.h
Go to the documentation of this file.
1
6 /*
7 * Copyright (C) 2006-2016, ARM Limited, All Rights Reserved
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 * This file is part of mbed TLS (https://tls.mbed.org)
23 */
24 #ifndef MBEDTLS_ENTROPY_H
25 #define MBEDTLS_ENTROPY_H
26
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "mbedtls/config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32
33 #include <stddef.h>
34
35 #if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
36 #include "mbedtls/sha512.h"
37 #define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
38 #else
39 #if defined(MBEDTLS_SHA256_C)
40 #define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
41 #include "mbedtls/sha256.h"
42 #endif
43 #endif
44
45 #if defined(MBEDTLS_THREADING_C)
46 #include "mbedtls/threading.h"
47 #endif
48
49 #if defined(MBEDTLS_HAVEGE_C)
50 #include "mbedtls/havege.h"
51 #endif
52
53 #define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C
54 #define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E
55 #define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040
56 #define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D
57 #define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F
67 #if !defined(MBEDTLS_ENTROPY_MAX_SOURCES)
68 #define MBEDTLS_ENTROPY_MAX_SOURCES 20
69 #endif
70
71 #if !defined(MBEDTLS_ENTROPY_MAX_GATHER)
72 #define MBEDTLS_ENTROPY_MAX_GATHER 128
73 #endif
74
75 /* \} name SECTION: Module settings */
76
77 #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
78 #define MBEDTLS_ENTROPY_BLOCK_SIZE 64
79 #else
80 #define MBEDTLS_ENTROPY_BLOCK_SIZE 32
81 #endif
82
83 #define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024
84 #define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES
85
86 #define MBEDTLS_ENTROPY_SOURCE_STRONG 1
87 #define MBEDTLS_ENTROPY_SOURCE_WEAK 0
89 #ifdef __cplusplus
90 extern "C" {
91 #endif
92
104 typedef int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len,
105 size_t *olen);
106
110 typedef struct mbedtls_entropy_source_state
111 {
112 mbedtls_entropy_f_source_ptr f_source;
113 void * p_source;
114 size_t size;
115 size_t threshold;
116 int strong;
117 }
118 mbedtls_entropy_source_state;
119
123 typedef struct mbedtls_entropy_context
124 {
125 int accumulator_started;
126 #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
127 mbedtls_sha512_context accumulator;
128 #else
129 mbedtls_sha256_context accumulator;
130 #endif
131 int source_count;
132 mbedtls_entropy_source_state source[MBEDTLS_ENTROPY_MAX_SOURCES];
133 #if defined(MBEDTLS_HAVEGE_C)
134 mbedtls_havege_state havege_data;
135 #endif
136 #if defined(MBEDTLS_THREADING_C)
137 mbedtls_threading_mutex_t mutex;
138 #endif
139 #if defined(MBEDTLS_ENTROPY_NV_SEED)
140 int initial_entropy_run;
141 #endif
142 }
143 mbedtls_entropy_context;
144
150 void mbedtls_entropy_init( mbedtls_entropy_context *ctx );
151
157 void mbedtls_entropy_free( mbedtls_entropy_context *ctx );
158
176 int mbedtls_entropy_add_source( mbedtls_entropy_context *ctx,
177 mbedtls_entropy_f_source_ptr f_source, void *p_source,
178 size_t threshold, int strong );
179
188 int mbedtls_entropy_gather( mbedtls_entropy_context *ctx );
189
201 int mbedtls_entropy_func( void *data, unsigned char *output, size_t len );
202
213 int mbedtls_entropy_update_manual( mbedtls_entropy_context *ctx,
214 const unsigned char *data, size_t len );
215
216 #if defined(MBEDTLS_ENTROPY_NV_SEED)
217
225 int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx );
226 #endif /* MBEDTLS_ENTROPY_NV_SEED */
227
228 #if defined(MBEDTLS_FS_IO)
229
239 int mbedtls_entropy_write_seed_file( mbedtls_entropy_context *ctx, const char *path );
240
253 int mbedtls_entropy_update_seed_file( mbedtls_entropy_context *ctx, const char *path );
254 #endif /* MBEDTLS_FS_IO */
255
256 #if defined(MBEDTLS_SELF_TEST)
257
265 int mbedtls_entropy_self_test( int verbose );
266
267 #if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
268
281 int mbedtls_entropy_source_self_test( int verbose );
282 #endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
283 #endif /* MBEDTLS_SELF_TEST */
284
285 #ifdef __cplusplus
286 }
287 #endif
288
289 #endif /* entropy.h */
mbedtls_entropy_f_source_ptr
int(* mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len, size_t *olen)
Entropy poll callback pointer.
Definition: entropy.h:104
mbedtls_entropy_source_state::strong
int strong
Definition: entropy.h:116
MBEDTLS_ENTROPY_MAX_SOURCES
#define MBEDTLS_ENTROPY_MAX_SOURCES
Definition: entropy.h:68
sha512.h
This file contains SHA-384 and SHA-512 definitions and functions.
mbedtls_entropy_init
void mbedtls_entropy_init(mbedtls_entropy_context *ctx)
Initialize the context.
mbedtls_entropy_context::source
mbedtls_entropy_source_state source[MBEDTLS_ENTROPY_MAX_SOURCES]
Definition: entropy.h:132
mbedtls_havege_state
HAVEGE state structure.
Definition: havege.h:46
mbedtls_entropy_context
Entropy context structure.
Definition: entropy.h:124
havege.h
HAVEGE: HArdware Volatile Entropy Gathering and Expansion.
mbedtls_entropy_source_state::threshold
size_t threshold
Definition: entropy.h:115
mbedtls_entropy_source_state::size
size_t size
Definition: entropy.h:114
mbedtls_entropy_self_test
int mbedtls_entropy_self_test(int verbose)
Checkup routine.
mbedtls_sha512_context
The SHA-512 context structure.
Definition: sha512.h:58
mbedtls_entropy_source_state
Entropy source state.
Definition: entropy.h:111
mbedtls_entropy_func
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...
mbedtls_entropy_context::accumulator
mbedtls_sha512_context accumulator
Definition: entropy.h:127
sha256.h
This file contains SHA-224 and SHA-256 definitions and functions.
mbedtls_entropy_source_state
struct mbedtls_entropy_source_state mbedtls_entropy_source_state
Entropy source state.
mbedtls_entropy_free
void mbedtls_entropy_free(mbedtls_entropy_context *ctx)
Free the data in the context.
threading.h
Threading abstraction layer.
mbedtls_entropy_write_seed_file
int mbedtls_entropy_write_seed_file(mbedtls_entropy_context *ctx, const char *path)
Write a seed file.
mbedtls_entropy_context
struct mbedtls_entropy_context mbedtls_entropy_context
Entropy context structure.
mbedtls_sha256_context
The SHA-256 context structure.
Definition: sha256.h:59
mbedtls_entropy_context::accumulator_started
int accumulator_started
Definition: entropy.h:125
mbedtls_entropy_source_state::p_source
void * p_source
Definition: entropy.h:113
mbedtls_entropy_update_manual
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)
config.h
Configuration options (set of defines)
mbedtls_entropy_context::source_count
int source_count
Definition: entropy.h:131
mbedtls_entropy_source_state::f_source
mbedtls_entropy_f_source_ptr f_source
Definition: entropy.h:112
mbedtls_entropy_gather
int mbedtls_entropy_gather(mbedtls_entropy_context *ctx)
Trigger an extra gather poll for the accumulator (Thread-safe if MBEDTLS_THREADING_C is enabled)
mbedtls_entropy_update_seed_file
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...
mbedtls_entropy_add_source
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)