mbed TLS v2.16.12
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  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 #ifndef MBEDTLS_ENTROPY_H
50 #define MBEDTLS_ENTROPY_H
51 
52 #if !defined(MBEDTLS_CONFIG_FILE)
53 #include "config.h"
54 #else
55 #include MBEDTLS_CONFIG_FILE
56 #endif
57 
58 #include <stddef.h>
59 
60 #if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
61 #include "sha512.h"
62 #define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
63 #else
64 #if defined(MBEDTLS_SHA256_C)
65 #define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
66 #include "sha256.h"
67 #endif
68 #endif
69 
70 #if defined(MBEDTLS_THREADING_C)
71 #include "threading.h"
72 #endif
73 
74 #if defined(MBEDTLS_HAVEGE_C)
75 #include "havege.h"
76 #endif
77 
79 #define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C
81 #define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E
83 #define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040
85 #define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D
87 #define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F
88 
97 #if !defined(MBEDTLS_ENTROPY_MAX_SOURCES)
98 #define MBEDTLS_ENTROPY_MAX_SOURCES 20
99 #endif
100 
101 #if !defined(MBEDTLS_ENTROPY_MAX_GATHER)
102 #define MBEDTLS_ENTROPY_MAX_GATHER 128
103 #endif
104 
105 /* \} name SECTION: Module settings */
106 
107 #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
108 #define MBEDTLS_ENTROPY_BLOCK_SIZE 64
109 #else
110 #define MBEDTLS_ENTROPY_BLOCK_SIZE 32
111 #endif
112 
113 #define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024
114 #define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES
115 
116 #define MBEDTLS_ENTROPY_SOURCE_STRONG 1
117 #define MBEDTLS_ENTROPY_SOURCE_WEAK 0
119 #ifdef __cplusplus
120 extern "C" {
121 #endif
122 
134 typedef int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len,
135  size_t *olen);
136 
141 {
143  void * p_source;
144  size_t size;
145  size_t threshold;
146  int strong;
147 }
149 
154 {
155  int accumulator_started; /* 0 after init.
156  * 1 after the first update.
157  * -1 after free. */
158 #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
160 #elif defined(MBEDTLS_ENTROPY_SHA256_ACCUMULATOR)
162 #endif
163  int source_count; /* Number of entries used in source. */
165 #if defined(MBEDTLS_HAVEGE_C)
167 #endif
168 #if defined(MBEDTLS_THREADING_C)
170 #endif
171 #if defined(MBEDTLS_ENTROPY_NV_SEED)
172  int initial_entropy_run;
173 #endif
174 }
176 
183 
190 
209  mbedtls_entropy_f_source_ptr f_source, void *p_source,
210  size_t threshold, int strong );
211 
221 
233 int mbedtls_entropy_func( void *data, unsigned char *output, size_t len );
234 
246  const unsigned char *data, size_t len );
247 
248 #if defined(MBEDTLS_ENTROPY_NV_SEED)
257 int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx );
258 #endif /* MBEDTLS_ENTROPY_NV_SEED */
259 
260 #if defined(MBEDTLS_FS_IO)
272 
286 #endif /* MBEDTLS_FS_IO */
287 
288 #if defined(MBEDTLS_SELF_TEST)
297 int mbedtls_entropy_self_test( int verbose );
298 
299 #if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
313 int mbedtls_entropy_source_self_test( int verbose );
314 #endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
315 #endif /* MBEDTLS_SELF_TEST */
316 
317 #ifdef __cplusplus
318 }
319 #endif
320 
321 #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:134
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:98
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:154
mbedtls_threading_mutex_t mutex
Definition: entropy.h:169
mbedtls_entropy_source_state source[MBEDTLS_ENTROPY_MAX_SOURCES]
Definition: entropy.h:164
mbedtls_havege_state havege_data
Definition: entropy.h:166
mbedtls_sha512_context accumulator
Definition: entropy.h:159
Entropy source state.
Definition: entropy.h:141
mbedtls_entropy_f_source_ptr f_source
Definition: entropy.h:142
HAVEGE state structure.
Definition: havege.h:70
The SHA-256 context structure.
Definition: sha256.h:86
The SHA-512 context structure.
Definition: sha512.h:85
Threading abstraction layer.