iqr_kyber.h

Go to the documentation of this file.

#ifndef IQR_KYBER_H
#define IQR_KYBER_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_KYBER_SHARED_KEY_SIZE 32

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

typedef struct iqr_KyberParams_struct iqr_KyberParams;

typedef struct iqr_KyberPublicKey_struct iqr_KyberPublicKey;

typedef struct iqr_KyberPrivateKey_struct iqr_KyberPrivateKey;

typedef struct iqr_KyberVariant_struct iqr_KyberVariant;

// ---------------------------------------------------------------------------------------------------------------------------------
// Kyber variants.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_EXTERN
const iqr_KyberVariant IQR_KYBER_768;

IQR_EXTERN
const iqr_KyberVariant IQR_KYBER_1024;

// ---------------------------------------------------------------------------------------------------------------------------------
// Kyber parameter management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_KyberCreateParams(const iqr_Context *ctx, const iqr_KyberVariant *variant, iqr_KyberParams **params);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_KyberDestroyParams(iqr_KyberParams **params);

// ---------------------------------------------------------------------------------------------------------------------------------
// Kyber key management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_KyberCreateKeyPair(const iqr_KyberParams *params, const iqr_RNG *rng, iqr_KyberPublicKey **public_key,
    iqr_KyberPrivateKey **private_key);

IQR_API
iqr_retval iqr_KyberImportPublicKey(const iqr_KyberParams *params, const uint8_t *buf, size_t buf_size,
    iqr_KyberPublicKey **public_key);

IQR_API
iqr_retval iqr_KyberImportPrivateKey(const iqr_KyberParams *params, const uint8_t *buf, size_t buf_size,
    iqr_KyberPrivateKey **private_key);

IQR_API
iqr_retval iqr_KyberExportPublicKey(const iqr_KyberPublicKey *public_key, uint8_t *buf, size_t buf_size);

IQR_API
iqr_retval iqr_KyberExportPrivateKey(const iqr_KyberPrivateKey *private_key, uint8_t *buf, size_t buf_size);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_KyberDestroyPublicKey(iqr_KyberPublicKey **public_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_KyberDestroyPrivateKey(iqr_KyberPrivateKey **private_key);

// ---------------------------------------------------------------------------------------------------------------------------------
// Kyber size functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_KyberGetPublicKeySize(const iqr_KyberParams *params, size_t *public_key_size);

IQR_API
iqr_retval iqr_KyberGetPrivateKeySize(const iqr_KyberParams *params, size_t *private_key_size);

IQR_API
iqr_retval iqr_KyberGetCiphertextSize(const iqr_KyberParams *params, size_t *ciphertext_size);

// ---------------------------------------------------------------------------------------------------------------------------------
// Kyber encapsulation/decapsulation functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_KyberEncapsulate(const iqr_KyberPublicKey *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_KyberDecapsulate(const iqr_KyberPrivateKey *private_key, const uint8_t *ciphertext, size_t ciphertext_size,
    uint8_t *shared_key, size_t shared_key_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_KYBER_H */