iqr_frodokem.h

Go to the documentation of this file.

#ifndef IQR_FRODOKEM_H
#define IQR_FRODOKEM_H

#ifdef __cplusplus
extern "C" {
#endif

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

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

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

#define IQR_FRODOKEM_PUBLIC_KEY_SIZE 15632

#define IQR_FRODOKEM_PRIVATE_KEY_SIZE 31280

#define IQR_FRODOKEM_CIPHERTEXT_SIZE 15768

#define IQR_FRODOKEM_SHARED_KEY_SIZE 24

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

typedef struct iqr_FrodoKEMParams_struct iqr_FrodoKEMParams;

typedef struct iqr_FrodoKEMPublicKey_struct iqr_FrodoKEMPublicKey;

typedef struct iqr_FrodoKEMPrivateKey_struct iqr_FrodoKEMPrivateKey;

typedef struct iqr_FrodoKEMVariant_struct iqr_FrodoKEMVariant;

// ---------------------------------------------------------------------------------------------------------------------------------
// FrodoKEM variants.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_EXTERN
const iqr_FrodoKEMVariant IQR_FRODOKEM_976_AES;

IQR_EXTERN
const iqr_FrodoKEMVariant IQR_FRODOKEM_976_CSHAKE;

// ---------------------------------------------------------------------------------------------------------------------------------
// FrodoKEM parameter management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_FrodoKEMCreateParams(const iqr_Context *ctx, const iqr_FrodoKEMVariant *variant, iqr_FrodoKEMParams **params);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_FrodoKEMDestroyParams(iqr_FrodoKEMParams **params);

// ---------------------------------------------------------------------------------------------------------------------------------
// FrodoKEM key management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_FrodoKEMCreateKeyPair(const iqr_FrodoKEMParams *params, const iqr_RNG *rng, iqr_FrodoKEMPublicKey **public_key,
    iqr_FrodoKEMPrivateKey **private_key);

IQR_API
iqr_retval iqr_FrodoKEMImportPublicKey(const iqr_FrodoKEMParams *params, const uint8_t *buf, size_t buf_size,
    iqr_FrodoKEMPublicKey **public_key);

IQR_API
iqr_retval iqr_FrodoKEMImportPrivateKey(const iqr_FrodoKEMParams *params, const uint8_t *buf, size_t buf_size,
    iqr_FrodoKEMPrivateKey **private_key);

IQR_API
iqr_retval iqr_FrodoKEMExportPublicKey(const iqr_FrodoKEMPublicKey *public_key, uint8_t *buf, size_t buf_size);

IQR_API
iqr_retval iqr_FrodoKEMExportPrivateKey(const iqr_FrodoKEMPrivateKey *private_key, uint8_t *buf, size_t buf_size);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_FrodoKEMDestroyPublicKey(iqr_FrodoKEMPublicKey **public_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_FrodoKEMDestroyPrivateKey(iqr_FrodoKEMPrivateKey **private_key);

// ---------------------------------------------------------------------------------------------------------------------------------
// FrodoKEM encapsulation/decapsulation functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_FrodoKEMEncapsulate(const iqr_FrodoKEMPublicKey *public_key, const iqr_RNG *rng, uint8_t *ciphertext,
    size_t ciphertext_size, uint8_t *shared_key, size_t shared_key_size);

IQR_API
iqr_retval iqr_FrodoKEMDecapsulate(const iqr_FrodoKEMPrivateKey *private_key, const uint8_t *ciphertext, size_t ciphertext_size,
    uint8_t *shared_key, size_t shared_key_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_FRODOKEM_H */