iqr_sike.h

Go to the documentation of this file.

#ifndef IQR_SIKE_H
#define IQR_SIKE_H

#ifdef __cplusplus
extern "C" {
#endif

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

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

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

typedef struct iqr_SIKEParams_struct iqr_SIKEParams;

typedef struct iqr_SIKEPublicKey_struct iqr_SIKEPublicKey;

typedef struct iqr_SIKEPrivateKey_struct iqr_SIKEPrivateKey;

typedef struct iqr_SIKEVariant_struct iqr_SIKEVariant;

// ---------------------------------------------------------------------------------------------------------------------------------
// SIKE variants.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_EXTERN
const iqr_SIKEVariant IQR_SIKE_P503;

IQR_EXTERN
const iqr_SIKEVariant IQR_SIKE_P751;

// ---------------------------------------------------------------------------------------------------------------------------------
// SIKE parameter management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_SIKECreateParams(const iqr_Context *ctx, const iqr_SIKEVariant *variant, iqr_SIKEParams **params);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_SIKEDestroyParams(iqr_SIKEParams **params);

// ---------------------------------------------------------------------------------------------------------------------------------
// SIKE key management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_SIKECreateKeyPair(const iqr_SIKEParams *params, const iqr_RNG *rng, iqr_SIKEPublicKey **public_key,
    iqr_SIKEPrivateKey **private_key);

IQR_API
iqr_retval iqr_SIKEImportPublicKey(const iqr_SIKEParams *params, const uint8_t *buf, size_t buf_size,
    iqr_SIKEPublicKey **public_key);

IQR_API
iqr_retval iqr_SIKEImportPrivateKey(const iqr_SIKEParams *params, const uint8_t *buf, size_t buf_size,
    iqr_SIKEPrivateKey **private_key);

IQR_API
iqr_retval iqr_SIKEExportPublicKey(const iqr_SIKEPublicKey *public_key, uint8_t *buf, size_t buf_size);

IQR_API
iqr_retval iqr_SIKEExportPrivateKey(const iqr_SIKEPrivateKey *private_key, uint8_t *buf, size_t buf_size);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_SIKEDestroyPublicKey(iqr_SIKEPublicKey **public_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_SIKEDestroyPrivateKey(iqr_SIKEPrivateKey **private_key);

// ---------------------------------------------------------------------------------------------------------------------------------
// SIKE size functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_SIKEGetPublicKeySize(const iqr_SIKEParams *params, size_t *public_key_size);

IQR_API
iqr_retval iqr_SIKEGetPrivateKeySize(const iqr_SIKEParams *params, size_t *private_key_size);

IQR_API
iqr_retval iqr_SIKEGetCiphertextSize(const iqr_SIKEParams *params, size_t *ciphertext_size);

IQR_API
iqr_retval iqr_SIKEGetSharedKeySize(const iqr_SIKEParams *params, size_t *shared_key_size);

// ---------------------------------------------------------------------------------------------------------------------------------
// SIKE encapsulation/decapsulation functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_SIKEEncapsulate(const iqr_SIKEPublicKey *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_SIKEDecapsulate(const iqr_SIKEPrivateKey *private_key, const uint8_t *ciphertext, size_t ciphertext_size,
    uint8_t *shared_key, size_t shared_key_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_SIKE_H */