iqr_lms.h

Go to the documentation of this file.

#ifndef IQR_LMS_H
#define IQR_LMS_H

#ifdef __cplusplus
extern "C" {
#endif

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

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

IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
#define IQR_LMS_PRIVATE_KEY_IDENTIFIER_SIZE 31

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

typedef struct iqr_LMSParams_struct iqr_LMSParams;

typedef struct iqr_LMSPublicKey_struct iqr_LMSPublicKey;

typedef struct iqr_LMSPrivateKey_struct iqr_LMSPrivateKey;

// ---------------------------------------------------------------------------------------------------------------------------------
// LMS domain parameters.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
typedef enum {
    IQR_LMS_WINTERNITZ_1    = 0,
    IQR_LMS_WINTERNITZ_2    = 1,
    IQR_LMS_WINTERNITZ_4    = 2,
    IQR_LMS_WINTERNITZ_8    = 3,

    // Used to maintain a number of values. MUST BE LAST.
    IQR_LMS_WINTERNITZ_LAST
} iqr_LMSWinternitz;

IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
typedef enum {
    IQR_LMS_HEIGHT_20       = 0,

    IQR_LMS_HEIGHT_10       = 1,

    IQR_LMS_HEIGHT_5        = 2,

    // Maintain a count of supported tree heights. MUST BE LAST.
    IQR_LMS_HEIGHT_LAST
} iqr_LMSHeight;

// ---------------------------------------------------------------------------------------------------------------------------------
// Domain parameter functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
iqr_retval iqr_LMSCreateParams(const iqr_Context *ctx, iqr_LMSWinternitz w, iqr_LMSHeight h, const uint8_t *I, size_t I_size,
    iqr_LMSParams **params);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_LMSDestroyParams(iqr_LMSParams **params);

IQR_API
IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
iqr_retval iqr_LMSGetWinternitz(const iqr_LMSParams *params, iqr_LMSWinternitz *w);

IQR_API
IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
iqr_retval iqr_LMSGetHeight(const iqr_LMSParams *params, iqr_LMSHeight *h);

IQR_API
iqr_retval iqr_LMSGetPrivateKeyIdentifier(const iqr_LMSParams *params, uint8_t *I, size_t I_size);

// ---------------------------------------------------------------------------------------------------------------------------------
// Key management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
iqr_retval iqr_LMSCreateKeyPair(const iqr_LMSParams *params, const iqr_RNG *rng, iqr_LMSPublicKey **pub_key,
    iqr_LMSPrivateKey **priv_key);

IQR_API
iqr_retval iqr_LMSImportPrivateKey(const iqr_LMSParams *params, const uint8_t *data, size_t size, iqr_LMSPrivateKey **priv_key);

IQR_API
iqr_retval iqr_LMSExportPrivateKey(const iqr_LMSPrivateKey *priv_key, uint8_t *buf, size_t buf_size);

IQR_API
iqr_retval iqr_LMSImportPublicKey(const iqr_LMSParams *params, const uint8_t *data, size_t size, iqr_LMSPublicKey **pub_key);

IQR_API
iqr_retval iqr_LMSExportPublicKey(const iqr_LMSPublicKey *pub_key, uint8_t *buf, size_t buf_size);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_LMSDestroyPrivateKey(iqr_LMSPrivateKey **priv_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_LMSDestroyPublicKey(iqr_LMSPublicKey **pub_key);

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

IQR_API
iqr_retval iqr_LMSGetPrivateKeyParams(const iqr_LMSPrivateKey *priv_key, iqr_LMSParams **params);

IQR_API
iqr_retval iqr_LMSGetPublicKeyParams(const iqr_LMSPublicKey *pub_key, iqr_LMSParams **params);

IQR_API
iqr_retval iqr_LMSGetPrivateKeySize(const iqr_LMSPrivateKey *priv_key, size_t *size);

IQR_API
iqr_retval iqr_LMSGetPublicKeySize(const iqr_LMSPublicKey *pub_key, size_t *size);

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

IQR_API
IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
iqr_retval iqr_LMSGetSignatureComponentSizes(const iqr_LMSParams *params, size_t *randomizer_size, size_t *ots_sig_size,
    size_t *sig_path_size);

IQR_API
iqr_retval iqr_LMSGetMaximumSignatureCount(const iqr_LMSParams *params, uint32_t *max_sigs);

IQR_API
iqr_retval iqr_LMSGetRemainingSignatureCount(const iqr_LMSParams *params, uint32_t index, uint32_t *remaining);

IQR_API
IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
iqr_retval iqr_LMSSign(const iqr_LMSPrivateKey *priv_key, const iqr_RNG *rng, uint32_t index, const uint8_t *digest,
    size_t digest_size, uint8_t *randomizer, size_t randomizer_size, uint8_t *ots_sig, size_t ots_sig_size, uint8_t *sig_path,
    size_t sig_path_size);

IQR_API
IQR_DEPRECATED_MSG("Deprecated due to recent changes in draft-mcgrew-hash-sigs-05.")
iqr_retval iqr_LMSVerify(const iqr_LMSPublicKey *pub_key, uint32_t index, const uint8_t *digest, size_t digest_size,
    const uint8_t *randomizer, size_t randomizer_size, const uint8_t *ots_sig, size_t ots_sig_size, const uint8_t *sig_path,
    size_t sig_path_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_LMS_H */