mbed TLS v2.7.16
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 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  * This file is part of mbed TLS (https://tls.mbed.org)
50  */
51 #ifndef MBEDTLS_ENTROPY_H
52 #define MBEDTLS_ENTROPY_H
53 
54 #if !defined(MBEDTLS_CONFIG_FILE)
55 #include "config.h"
56 #else
57 #include MBEDTLS_CONFIG_FILE
58 #endif
59 
60 #include <stddef.h>
61 
62 #if defined(MBEDTLS_SHA512_C) && !defined(MBEDTLS_ENTROPY_FORCE_SHA256)
63 #include "sha512.h"
64 #define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
65 #else
66 #if defined(MBEDTLS_SHA256_C)
67 #define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
68 #include "sha256.h"
69 #endif
70 #endif
71 
72 #if defined(MBEDTLS_THREADING_C)
73 #include "threading.h"
74 #endif
75 
76 #if defined(MBEDTLS_HAVEGE_C)
77 #include "havege.h"
78 #endif
79 
80 #define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C
81 #define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E
82 #define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040
83 #define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D
84 #define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F
94 #if !defined(MBEDTLS_ENTROPY_MAX_SOURCES)
95 #define MBEDTLS_ENTROPY_MAX_SOURCES 20
96 #endif
97 
98 #if !defined(MBEDTLS_ENTROPY_MAX_GATHER)
99 #define MBEDTLS_ENTROPY_MAX_GATHER 128
100 #endif
101 
102 /* \} name SECTION: Module settings */
103 
104 #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
105 #define MBEDTLS_ENTROPY_BLOCK_SIZE 64
106 #else
107 #define MBEDTLS_ENTROPY_BLOCK_SIZE 32
108 #endif
109 
110 #define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024
111 #define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES
112 
113 #define MBEDTLS_ENTROPY_SOURCE_STRONG 1
114 #define MBEDTLS_ENTROPY_SOURCE_WEAK 0
116 #ifdef __cplusplus
117 extern "C" {
118 #endif
119 
131 typedef int (*mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len,
132  size_t *olen);
133 
137 typedef struct
138 {
140  void * p_source;
141  size_t size;
142  size_t threshold;
143  int strong;
144 }
146 
150 typedef struct
151 {
153 #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
155 #else
156  mbedtls_sha256_context accumulator;
157 #endif
160 #if defined(MBEDTLS_HAVEGE_C)
161  mbedtls_havege_state havege_data;
162 #endif
163 #if defined(MBEDTLS_THREADING_C)
164  mbedtls_threading_mutex_t mutex;
165 #endif
166 #if defined(MBEDTLS_ENTROPY_NV_SEED)
167  int initial_entropy_run;
168 #endif
169 }
171 
178 
185 
204  mbedtls_entropy_f_source_ptr f_source, void *p_source,
205  size_t threshold, int strong );
206 
216 
228 int mbedtls_entropy_func( void *data, unsigned char *output, size_t len );
229 
241  const unsigned char *data, size_t len );
242 
243 #if defined(MBEDTLS_ENTROPY_NV_SEED)
244 
252 int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx );
253 #endif /* MBEDTLS_ENTROPY_NV_SEED */
254 
255 #if defined(MBEDTLS_FS_IO)
256 
266 int mbedtls_entropy_write_seed_file( mbedtls_entropy_context *ctx, const char *path );
267 
280 int mbedtls_entropy_update_seed_file( mbedtls_entropy_context *ctx, const char *path );
281 #endif /* MBEDTLS_FS_IO */
282 
283 #if defined(MBEDTLS_SELF_TEST)
284 
292 int mbedtls_entropy_self_test( int verbose );
293 
294 #if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
295 
308 int mbedtls_entropy_source_self_test( int verbose );
309 #endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
310 #endif /* MBEDTLS_SELF_TEST */
311 
312 #ifdef __cplusplus
313 }
314 #endif
315 
316 #endif /* entropy.h */
int(* mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len, size_t *olen)
Entropy poll callback pointer.
Definition: entropy.h:131
HAVEGE state structure.
Definition: havege.h:71
mbedtls_entropy_f_source_ptr f_source
Definition: entropy.h:139
#define MBEDTLS_ENTROPY_MAX_SOURCES
Definition: entropy.h:95
Configuration options (set of defines)
void mbedtls_entropy_init(mbedtls_entropy_context *ctx)
Initialize the context.
Entropy context structure.
Definition: entropy.h:150
int mbedtls_entropy_self_test(int verbose)
Checkup routine.
mbedtls_sha512_context accumulator
Definition: entropy.h:154
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...
Threading abstraction layer.
The SHA-512 context structure.
Definition: sha512.h:80
HAVEGE: HArdware Volatile Entropy Gathering and Expansion.
The SHA-256 context structure.
Definition: sha256.h:80
void mbedtls_entropy_free(mbedtls_entropy_context *ctx)
Free the data in the context.
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) ...
int mbedtls_entropy_write_seed_file(mbedtls_entropy_context *ctx, const char *path)
Write a seed file.
The SHA-384 and SHA-512 cryptographic hash function.
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_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...
The SHA-224 and SHA-256 cryptographic hash function.
Entropy source state.
Definition: entropy.h:137
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)