iqr_rng.h

Go to the documentation of this file.

#ifndef IQR_RNG_H
#define IQR_RNG_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>
#include <stdint.h>

#include "iqr_api.h"
#include "iqr_context.h"
#include "iqr_hash.h"
#include "iqr_retval.h"

// ---------------------------------------------------------------------------------------------------------------------------------
// Constants.
// ---------------------------------------------------------------------------------------------------------------------------------

#define IQR_SHAKE_128_SIZE 16
#define IQR_SHAKE_256_SIZE 32

// ---------------------------------------------------------------------------------------------------------------------------------
// Opaque data type.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct iqr_RNG_struct iqr_RNG;

// ---------------------------------------------------------------------------------------------------------------------------------
// Data structure.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct {
    iqr_retval (*initialize)(void **state, const uint8_t *seed, size_t seed_size);

    iqr_retval (*reseed)(void *state, const uint8_t *entropy, size_t entropy_size);

    iqr_retval (*getbytes)(void *state, uint8_t *buffer, size_t buffer_size);

    iqr_retval (*cleanup)(void **state);
} iqr_RNGCallbacks;

// ---------------------------------------------------------------------------------------------------------------------------------
// Global function registration.
// ---------------------------------------------------------------------------------------------------------------------------------

// ---------------------------------------------------------------------------------------------------------------------------------
// Random Number Generator initialization and validation.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_RNGCreate(const iqr_Context *ctx, const iqr_RNGCallbacks *cb, iqr_RNG **rng);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_RNGDestroy(iqr_RNG **rng);

// ---------------------------------------------------------------------------------------------------------------------------------
// HMAC DRBG Random Number Generator.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_RNGCreateHMACDRBG(const iqr_Context *ctx, iqr_HashAlgorithmType hash_algo, iqr_RNG **rng);

// ---------------------------------------------------------------------------------------------------------------------------------
// SHAKE Random Number Generator.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_RNGCreateSHAKE(const iqr_Context *ctx, size_t shake_size, iqr_RNG **rng);

// ---------------------------------------------------------------------------------------------------------------------------------
// Random Number Generator usage.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_RNGInitialize(iqr_RNG *rng, const uint8_t *buffer, size_t length);

IQR_API
iqr_retval iqr_RNGReseed(const iqr_RNG *rng, const uint8_t *buffer, size_t length);

IQR_API
iqr_retval iqr_RNGGetBytes(const iqr_RNG *rng, uint8_t *buffer, size_t num_bytes);

#ifdef __cplusplus
}
#endif

#endif /* IQR_RNG_H */