mbed TLS v3.1.0
|
Entropy accumulator implementation. More...
#include "mbedtls/private_access.h"
#include "mbedtls/build_info.h"
#include <stddef.h>
#include "mbedtls/sha256.h"
#include "mbedtls/threading.h"
Go to the source code of this file.
Data Structures | |
struct | mbedtls_entropy_source_state |
Entropy source state. More... | |
struct | mbedtls_entropy_context |
Entropy context structure. More... | |
Macros | |
#define | MBEDTLS_ENTROPY_SHA256_ACCUMULATOR |
#define | MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C |
#define | MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E |
#define | MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040 |
#define | MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D |
#define | MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F |
#define | MBEDTLS_ENTROPY_BLOCK_SIZE 32 |
#define | MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024 |
#define | MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES |
#define | MBEDTLS_ENTROPY_SOURCE_STRONG 1 |
#define | MBEDTLS_ENTROPY_SOURCE_WEAK 0 |
SECTION: Module settings | |
The configuration options you can set for this module are in this section. Either change them in mbedtls_config.h or define them on the compiler command line. | |
#define | MBEDTLS_ENTROPY_MAX_SOURCES 20 |
#define | MBEDTLS_ENTROPY_MAX_GATHER 128 |
Typedefs | |
typedef int(* | mbedtls_entropy_f_source_ptr )(void *data, unsigned char *output, size_t len, size_t *olen) |
Entropy poll callback pointer. More... | |
typedef struct mbedtls_entropy_source_state | mbedtls_entropy_source_state |
Entropy source state. More... | |
typedef struct mbedtls_entropy_context | mbedtls_entropy_context |
Entropy context structure. More... | |
Functions | |
void | mbedtls_entropy_init (mbedtls_entropy_context *ctx) |
Initialize the context. More... | |
void | mbedtls_entropy_free (mbedtls_entropy_context *ctx) |
Free the data in the context. More... | |
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) More... | |
int | mbedtls_entropy_gather (mbedtls_entropy_context *ctx) |
Trigger an extra gather poll for the accumulator (Thread-safe if MBEDTLS_THREADING_C is enabled) More... | |
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 MBEDTLS_THREADING_C is enabled) More... | |
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) More... | |
int | mbedtls_entropy_update_nv_seed (mbedtls_entropy_context *ctx) |
Trigger an update of the seed file in NV by using the current entropy pool. More... | |
int | mbedtls_entropy_write_seed_file (mbedtls_entropy_context *ctx, const char *path) |
Write a seed file. More... | |
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_SIZE bytes are read from the seed file. The rest is ignored. More... | |
int | mbedtls_entropy_self_test (int verbose) |
Checkup routine. More... | |
int | mbedtls_entropy_source_self_test (int verbose) |
Checkup routine. More... | |
Entropy accumulator implementation.
Definition in file entropy.h.
#define MBEDTLS_ENTROPY_BLOCK_SIZE 32 |
#define MBEDTLS_ENTROPY_MAX_GATHER 128 |
#define MBEDTLS_ENTROPY_MAX_SEED_SIZE 1024 |
#define MBEDTLS_ENTROPY_MAX_SOURCES 20 |
#define MBEDTLS_ENTROPY_SOURCE_MANUAL MBEDTLS_ENTROPY_MAX_SOURCES |
#define MBEDTLS_ENTROPY_SOURCE_STRONG 1 |
#define MBEDTLS_ENTROPY_SOURCE_WEAK 0 |
#define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR -0x003F |
#define MBEDTLS_ERR_ENTROPY_MAX_SOURCES -0x003E |
#define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED -0x0040 |
#define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE -0x003D |
#define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED -0x003C |
typedef struct mbedtls_entropy_context mbedtls_entropy_context |
Entropy context structure.
typedef int(* mbedtls_entropy_f_source_ptr)(void *data, unsigned char *output, size_t len, size_t *olen) |
Entropy poll callback pointer.
data | Callback-specific data pointer |
output | Data to fill |
len | Maximum size to provide |
olen | The actual amount of bytes put into the buffer (Can be 0) |
typedef struct mbedtls_entropy_source_state mbedtls_entropy_source_state |
Entropy source state.
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)
ctx | Entropy context |
f_source | Entropy function |
p_source | Function data |
threshold | Minimum required from source before entropy is released ( with mbedtls_entropy_func() ) (in bytes) |
strong | MBEDTLS_ENTROPY_SOURCE_STRONG or MBEDTLS_ENTROPY_SOURCE_WEAK. At least one strong source needs to be added. Weaker sources (such as the cycle counter) can be used as a complement. |
void mbedtls_entropy_free | ( | mbedtls_entropy_context * | ctx | ) |
Free the data in the context.
ctx | Entropy context to free |
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 MBEDTLS_THREADING_C is enabled)
data | Entropy context |
output | Buffer to fill |
len | Number of bytes desired, must be at most MBEDTLS_ENTROPY_BLOCK_SIZE |
int mbedtls_entropy_gather | ( | mbedtls_entropy_context * | ctx | ) |
Trigger an extra gather poll for the accumulator (Thread-safe if MBEDTLS_THREADING_C is enabled)
ctx | Entropy context |
void mbedtls_entropy_init | ( | mbedtls_entropy_context * | ctx | ) |
Initialize the context.
ctx | Entropy context to initialize |
int mbedtls_entropy_self_test | ( | int | verbose | ) |
Checkup routine.
This module self-test also calls the entropy self-test, mbedtls_entropy_source_self_test();
int mbedtls_entropy_source_self_test | ( | int | verbose | ) |
Checkup routine.
Verifies the integrity of the hardware entropy source provided by the function 'mbedtls_hardware_poll()'.
Note this is the only hardware entropy source that is known at link time, and other entropy sources configured dynamically at runtime by the function mbedtls_entropy_add_source() will not be tested.
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)
ctx | Entropy context |
data | Data to add |
len | Length of data |
int mbedtls_entropy_update_nv_seed | ( | mbedtls_entropy_context * | ctx | ) |
Trigger an update of the seed file in NV by using the current entropy pool.
ctx | Entropy context |
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_SIZE bytes are read from the seed file. The rest is ignored.
ctx | Entropy context |
path | Name of the file |
int mbedtls_entropy_write_seed_file | ( | mbedtls_entropy_context * | ctx, |
const char * | path | ||
) |
Write a seed file.
ctx | Entropy context |
path | Name of the file |