iqr_rainbow.h

Go to the documentation of this file.

#ifndef IQR_RAINBOW_H
#define IQR_RAINBOW_H

#ifdef __cplusplus
extern "C" {
#endif

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

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

typedef struct iqr_RainbowParams_struct iqr_RainbowParams;

typedef struct iqr_RainbowPublicKey_struct iqr_RainbowPublicKey;

typedef struct iqr_RainbowPrivateKey_struct iqr_RainbowPrivateKey;

typedef struct iqr_RainbowVariant_struct iqr_RainbowVariant;

// ---------------------------------------------------------------------------------------------------------------------------------
// Rainbow variants.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_EXTERN
const iqr_RainbowVariant IQR_RAINBOW_GF16_56_48_48;

IQR_EXTERN
const iqr_RainbowVariant IQR_RAINBOW_GF16_76_64_64;

IQR_EXTERN
const iqr_RainbowVariant IQR_RAINBOW_GF31_64_32_48;

IQR_EXTERN
const iqr_RainbowVariant IQR_RAINBOW_GF31_84_56_56;

IQR_EXTERN
const iqr_RainbowVariant IQR_RAINBOW_GF256_68_36_36;

IQR_EXTERN
const iqr_RainbowVariant IQR_RAINBOW_GF256_92_48_48;

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

IQR_API
iqr_retval iqr_RainbowCreateParams(const iqr_Context *ctx, const iqr_RainbowVariant *variant, iqr_RainbowParams **params);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_RainbowDestroyParams(iqr_RainbowParams **params);

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

IQR_API
iqr_retval iqr_RainbowCreateKeyPair(const iqr_RainbowParams *params, const iqr_RNG *rng, iqr_RainbowPublicKey **public_key,
    iqr_RainbowPrivateKey **private_key);

IQR_API
iqr_retval iqr_RainbowImportPrivateKey(const iqr_RainbowParams *params, const uint8_t *buf, size_t buf_size,
    iqr_RainbowPrivateKey **private_key);

IQR_API
iqr_retval iqr_RainbowExportPrivateKey(const iqr_RainbowPrivateKey *private_key, uint8_t *buf, size_t buf_size);

IQR_API
iqr_retval iqr_RainbowImportPublicKey(const iqr_RainbowParams *params, const uint8_t *buf, size_t buf_size,
    iqr_RainbowPublicKey **public_key);

IQR_API
iqr_retval iqr_RainbowExportPublicKey(const iqr_RainbowPublicKey *public_key, uint8_t *buf, size_t buf_size);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_RainbowDestroyPublicKey(iqr_RainbowPublicKey **public_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_RainbowDestroyPrivateKey(iqr_RainbowPrivateKey **private_key);

IQR_API
iqr_retval iqr_RainbowGetPrivateKeySize(const iqr_RainbowParams *params, size_t *private_key_size);

IQR_API
iqr_retval iqr_RainbowGetPublicKeySize(const iqr_RainbowParams *params, size_t *public_key_size);

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

IQR_API
iqr_retval iqr_RainbowGetSignatureSize(const iqr_RainbowParams *params, size_t *sig_size);

IQR_API
iqr_retval iqr_RainbowSign(const iqr_RainbowPrivateKey *private_key, const iqr_RNG *rng, const uint8_t *message,
    size_t message_size, uint8_t *sig, size_t sig_size);

IQR_API
iqr_retval iqr_RainbowVerify(const iqr_RainbowPublicKey *public_key, const uint8_t *message, size_t message_size,
    const uint8_t *sig, size_t sig_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_RAINBOW_H */