ikm_lms.h

Go to the documentation of this file.

#ifndef IKS_LMS_H
#define IKS_LMS_H

#ifdef __cplusplus
extern "C" {
#endif

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

#include "iqr_api.h"
#include "iqr_rng.h"
#include "iqr_lms.h"

#include "ikm_retval.h"
#include "ikm_io.h"

// ---------------------------------------------------------------------------------------------------------------------------------
// Opaque data type.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct ikm_LMSPrivateKey_struct ikm_LMSPrivateKey;

// ---------------------------------------------------------------------------------------------------------------------------------
// Key creation functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
ikm_retval ikm_LMSCreateKeyPair(const iqr_LMSParams *params, const iqr_RNG *rng, iqr_LMSPublicKey **pub_key,
    ikm_LMSPrivateKey **priv_key);

IQR_API
ikm_retval ikm_LMSCreateSplitKeyPair(const iqr_LMSParams *params, const iqr_RNG *rng, iqr_LMSPublicKey **pub_key,
    ikm_LMSPrivateKey *priv_keys[], size_t num_priv_keys);

IQR_API
ikm_retval ikm_LMSLoadPrivateKey(const iqr_Context *ctx, const ikm_IO *io, uint32_t key_id, ikm_LMSPrivateKey **priv_key);

IQR_API
ikm_retval ikm_LMSStorePrivateKey(ikm_LMSPrivateKey **priv_key, const ikm_IO *io, uint32_t key_id);

IQR_API_UNENFORCED_RETURN
ikm_retval ikm_LMSDestroyPrivateKey(ikm_LMSPrivateKey **priv_key);

// ---------------------------------------------------------------------------------------------------------------------------------
// Key data retrieval functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
ikm_retval ikm_LMSGetPrivateKeyParams(const ikm_LMSPrivateKey *priv_key, iqr_LMSParams **params);

// ---------------------------------------------------------------------------------------------------------------------------------
// Signature functionality.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
ikm_retval ikm_LMSSign(ikm_LMSPrivateKey *priv_key, const iqr_RNG *rng, const uint8_t *digest, size_t digest_size,
    uint8_t *sig, size_t sig_size);

IQR_API
ikm_retval ikm_LMSGetRemainingSignatureCount(const ikm_LMSPrivateKey *priv_key, uint32_t *remaining);

#ifdef __cplusplus
}
#endif

#endif /* IKS_LMS_H */