iqr_frododh.h

Go to the documentation of this file.

#ifndef IQR_FRODODH_H
#define IQR_FRODODH_H

#ifdef __cplusplus
extern "C" {
#endif

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

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

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

#define IQR_FRODODH_INITIATOR_PUBLIC_KEY_SIZE  15632

#define IQR_FRODODH_RESPONDER_PUBLIC_KEY_SIZE  15624

#define IQR_FRODODH_SECRET_SIZE  32

// ---------------------------------------------------------------------------------------------------------------------------------
// Opaque data types.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct iqr_FrodoDHParams_struct iqr_FrodoDHParams;

typedef struct iqr_FrodoDHInitiatorPrivateKey_struct iqr_FrodoDHInitiatorPrivateKey;

typedef struct iqr_FrodoDHResponderPrivateKey_struct iqr_FrodoDHResponderPrivateKey;

typedef struct iqr_FrodoDHVariant_struct iqr_FrodoDHVariant;

// ---------------------------------------------------------------------------------------------------------------------------------
// FrodoDH variants.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_EXTERN
const iqr_FrodoDHVariant IQR_FRODODH_976_AES;

IQR_EXTERN
const iqr_FrodoDHVariant IQR_FRODODH_976_CSHAKE;

// ---------------------------------------------------------------------------------------------------------------------------------
// Domain parameter functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_FrodoDHCreateParams(const iqr_Context *ctx, const iqr_FrodoDHVariant *variant, iqr_FrodoDHParams **params);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_FrodoDHDestroyParams(iqr_FrodoDHParams **params);

// ---------------------------------------------------------------------------------------------------------------------------------
// Private key generation functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_FrodoDHCreateInitiatorPrivateKey(const iqr_FrodoDHParams *params, const iqr_RNG *rng,
    iqr_FrodoDHInitiatorPrivateKey **initiator_private_key);

IQR_API
iqr_retval iqr_FrodoDHCreateResponderPrivateKey(const iqr_FrodoDHParams *params, const iqr_RNG *rng,
    iqr_FrodoDHResponderPrivateKey **responder_private_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_FrodoDHDestroyInitiatorPrivateKey(iqr_FrodoDHInitiatorPrivateKey **initiator_private_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_FrodoDHDestroyResponderPrivateKey(iqr_FrodoDHResponderPrivateKey **responder_private_key);

// ---------------------------------------------------------------------------------------------------------------------------------
// Shared secret generation functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_FrodoDHGetInitiatorPublicKey(iqr_FrodoDHInitiatorPrivateKey *initiator_private_key, const iqr_RNG *rng,
    uint8_t *initiator_public_key, size_t initiator_public_key_size);

IQR_API
iqr_retval iqr_FrodoDHGetResponderPublicKey(iqr_FrodoDHResponderPrivateKey *responder_private_key, const iqr_RNG *rng,
    const uint8_t *initiator_public_key, size_t initiator_public_key_size, uint8_t *responder_public_key,
    size_t responder_public_key_size);

IQR_API
iqr_retval iqr_FrodoDHGetInitiatorSecret(const iqr_FrodoDHInitiatorPrivateKey *initiator_private_key,
    const uint8_t *responder_public_key, size_t responder_public_key_size, uint8_t *secret, size_t secret_size);

IQR_API
iqr_retval iqr_FrodoDHGetResponderSecret(const iqr_FrodoDHResponderPrivateKey *responder_private_key, uint8_t *secret,
    size_t secret_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_FRODODH_H */