iqr_dilithium.h

Go to the documentation of this file.

 
#ifndef IQR_DILITHIUM_H
#define IQR_DILITHIUM_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "iqr_api.h"
#include "iqr_retval.h"
#include "iqr_rng.h"
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Opaque data types.
// ---------------------------------------------------------------------------------------------------------------------------------
 
typedef struct iqr_DilithiumParams_struct iqr_DilithiumParams;
 
typedef struct iqr_DilithiumPublicKey_struct iqr_DilithiumPublicKey;
 
typedef struct iqr_DilithiumPrivateKey_struct iqr_DilithiumPrivateKey;
 
typedef struct iqr_DilithiumVariant_struct iqr_DilithiumVariant;
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Dilithium variants.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_EXTERN
const iqr_DilithiumVariant IQR_DILITHIUM_2;
 
IQR_EXTERN
const iqr_DilithiumVariant IQR_DILITHIUM_3;
 
IQR_EXTERN
const iqr_DilithiumVariant IQR_DILITHIUM_5;
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Dilithium parameter management functions.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_API
iqr_retval iqr_DilithiumCreateParams(const iqr_Context *ctx, const iqr_DilithiumVariant *variant, iqr_DilithiumParams **params);
 
IQR_API_UNENFORCED_RETURN
iqr_retval iqr_DilithiumDestroyParams(iqr_DilithiumParams **params);
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Dilithium key management functions.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_API
iqr_retval iqr_DilithiumCreateKeyPair(const iqr_DilithiumParams *params, const iqr_RNG *rng, iqr_DilithiumPublicKey **public_key,
    iqr_DilithiumPrivateKey **private_key);
 
IQR_API
iqr_retval iqr_DilithiumImportPublicKey(const iqr_DilithiumParams *params, const uint8_t *buf, size_t buf_size,
    iqr_DilithiumPublicKey **public_key);
 
IQR_API
iqr_retval iqr_DilithiumImportPrivateKey(const iqr_DilithiumParams *params, const uint8_t *buf, size_t buf_size,
    iqr_DilithiumPrivateKey **private_key);
 
IQR_API
iqr_retval iqr_DilithiumExportPublicKey(const iqr_DilithiumPublicKey *public_key, uint8_t *buf, size_t buf_size);
 
IQR_API
iqr_retval iqr_DilithiumExportPrivateKey(const iqr_DilithiumPrivateKey *private_key, uint8_t *buf, size_t buf_size);
 
IQR_API_UNENFORCED_RETURN
iqr_retval iqr_DilithiumDestroyPublicKey(iqr_DilithiumPublicKey **public_key);
 
IQR_API_UNENFORCED_RETURN
iqr_retval iqr_DilithiumDestroyPrivateKey(iqr_DilithiumPrivateKey **private_key);
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Dilithium size functions.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_API
iqr_retval iqr_DilithiumGetPublicKeySize(const iqr_DilithiumParams *params, size_t *public_key_size);
 
IQR_API
iqr_retval iqr_DilithiumGetPrivateKeySize(const iqr_DilithiumParams *params, size_t *private_key_size);
 
IQR_API
iqr_retval iqr_DilithiumGetSignatureSize(const iqr_DilithiumParams *params, size_t *sig_size);
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Dilithium signature functionality.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_API
iqr_retval iqr_DilithiumSign(const iqr_DilithiumPrivateKey *private_key, const uint8_t *message, size_t message_size, uint8_t *sig,
    size_t sig_size);
 
IQR_API
iqr_retval iqr_DilithiumVerify(const iqr_DilithiumPublicKey *public_key, const uint8_t *message, size_t message_size,
    const uint8_t *sig, size_t sig_size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* IQR_DILITHIUM_H */