mbed TLS v2.0.0
entropy.h
Go to the documentation of this file.
1 
24 #ifndef MBEDTLS_ENTROPY_H
25 #define MBEDTLS_ENTROPY_H
26 
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "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 "sha512.h"
37 #define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR
38 #else
39 #if defined(MBEDTLS_SHA256_C)
40 #define MBEDTLS_ENTROPY_SHA256_ACCUMULATOR
41 #include "sha256.h"
42 #endif
43 #endif
44 
45 #if defined(MBEDTLS_THREADING_C)
46 #include "threading.h"
47 #endif
48 
49 #if defined(MBEDTLS_HAVEGE_C)
50 #include "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
111 {
113  void * p_source;
114  size_t size;
115  size_t threshold;
116  int strong;
117 }
119 
123 typedef struct
124 {
125 #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
127 #else
128  mbedtls_sha256_context accumulator;
129 #endif
132 #if defined(MBEDTLS_HAVEGE_C)
133  mbedtls_havege_state havege_data;
134 #endif
135 #if defined(MBEDTLS_THREADING_C)
136  mbedtls_threading_mutex_t mutex;
137 #endif
138 }
140 
147 
154 
173  mbedtls_entropy_f_source_ptr f_source, void *p_source,
174  size_t threshold, int strong );
175 
185 
197 int mbedtls_entropy_func( void *data, unsigned char *output, size_t len );
198 
210  const unsigned char *data, size_t len );
211 
212 #if defined(MBEDTLS_FS_IO)
213 
223 int mbedtls_entropy_write_seed_file( mbedtls_entropy_context *ctx, const char *path );
224 
237 int mbedtls_entropy_update_seed_file( mbedtls_entropy_context *ctx, const char *path );
238 #endif /* MBEDTLS_FS_IO */
239 
240 #if defined(MBEDTLS_SELF_TEST)
241 
246 int mbedtls_entropy_self_test( int verbose );
247 #endif /* MBEDTLS_SELF_TEST */
248 
249 #ifdef __cplusplus
250 }
251 #endif
252 
253 #endif /* entropy.h */
void * p_source
The callback data pointer.
Definition: entropy.h:113
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
size_t threshold
Minimum bytes required before release.
Definition: entropy.h:115
HAVEGE state structure.
Definition: havege.h:38
mbedtls_entropy_f_source_ptr f_source
The entropy source callback.
Definition: entropy.h:112
#define MBEDTLS_ENTROPY_MAX_SOURCES
Maximum number of sources supported.
Definition: entropy.h:68
Compatibility names (set of defines)
void mbedtls_entropy_init(mbedtls_entropy_context *ctx)
Initialize the context.
size_t size
Amount received in bytes.
Definition: entropy.h:114
Entropy context structure.
Definition: entropy.h:123
int mbedtls_entropy_self_test(int verbose)
Checkup routine.
mbedtls_sha512_context accumulator
Definition: entropy.h:126
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.
SHA-512 context structure.
Definition: sha512.h:47
HAVEGE: HArdware Volatile Entropy Gathering and Expansion.
SHA-256 context structure.
Definition: sha256.h:47
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.
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.
int strong
Is the source strong?
Definition: entropy.h:116
Entropy source state.
Definition: entropy.h:110
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)