iqr_sphincs.h

Go to the documentation of this file.

 
#ifndef IQR_SPHINCS_H
#define IQR_SPHINCS_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "iqr_api.h"
#include "iqr_hash.h"
#include "iqr_retval.h"
#include "iqr_rng.h"
 
#include <stddef.h>
#include <stdint.h>
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Opaque data types.
// ---------------------------------------------------------------------------------------------------------------------------------
 
typedef struct iqr_SPHINCSParams_struct iqr_SPHINCSParams;
 
typedef struct iqr_SPHINCSPublicKey_struct iqr_SPHINCSPublicKey;
 
typedef struct iqr_SPHINCSPrivateKey_struct iqr_SPHINCSPrivateKey;
 
typedef struct iqr_SPHINCSVariant_struct iqr_SPHINCSVariant;
 
// ---------------------------------------------------------------------------------------------------------------------------------
// SPHINCS+ variants.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHA2_256_128F;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHA2_256_128S;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHAKE_256_128F;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHAKE_256_128S;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHA2_256_192F;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHA2_256_192S;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHAKE_256_192F;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHAKE_256_192S;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHA2_256_256F;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHA2_256_256S;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHAKE_256_256F;
 
IQR_EXTERN
const iqr_SPHINCSVariant IQR_SPHINCS_SHAKE_256_256S;
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Domain parameter functions.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_API
iqr_retval iqr_SPHINCSCreateParams(const iqr_Context *ctx, const iqr_SPHINCSVariant *variant, iqr_SPHINCSParams **params);
 
IQR_API_UNENFORCED_RETURN
iqr_retval iqr_SPHINCSDestroyParams(iqr_SPHINCSParams **params);
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Key management functions.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_API
iqr_retval iqr_SPHINCSCreateKeyPair(const iqr_SPHINCSParams *params, const iqr_RNG *rng, iqr_SPHINCSPublicKey **public_key,
    iqr_SPHINCSPrivateKey **private_key);
 
IQR_API
iqr_retval iqr_SPHINCSImportPrivateKey(const iqr_SPHINCSParams *params, const uint8_t *buf, size_t buf_size,
    iqr_SPHINCSPrivateKey **private_key);
 
IQR_API
iqr_retval iqr_SPHINCSExportPrivateKey(const iqr_SPHINCSPrivateKey *private_key, uint8_t *buf, size_t buf_size);
 
IQR_API
iqr_retval iqr_SPHINCSImportPublicKey(const iqr_SPHINCSParams *params, const uint8_t *buf, size_t buf_size,
    iqr_SPHINCSPublicKey **public_key);
 
IQR_API
iqr_retval iqr_SPHINCSExportPublicKey(const iqr_SPHINCSPublicKey *public_key, uint8_t *buf, size_t buf_size);
 
IQR_API_UNENFORCED_RETURN
iqr_retval iqr_SPHINCSDestroyPrivateKey(iqr_SPHINCSPrivateKey **private_key);
 
IQR_API_UNENFORCED_RETURN
iqr_retval iqr_SPHINCSDestroyPublicKey(iqr_SPHINCSPublicKey **public_key);
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Key data retrieval functions.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_API
iqr_retval iqr_SPHINCSGetPrivateKeySize(const iqr_SPHINCSParams *params, size_t *private_key_size);
 
IQR_API
iqr_retval iqr_SPHINCSGetPublicKeySize(const iqr_SPHINCSParams *params, size_t *public_key_size);
 
// ---------------------------------------------------------------------------------------------------------------------------------
// Signature functionality.
// ---------------------------------------------------------------------------------------------------------------------------------
 
IQR_API
iqr_retval iqr_SPHINCSGetSignatureSize(const iqr_SPHINCSParams *params, size_t *sig_size);
 
IQR_API
iqr_retval iqr_SPHINCSSign(const iqr_SPHINCSPrivateKey *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_SPHINCSVerify(const iqr_SPHINCSPublicKey *public_key, const uint8_t *message, size_t message_size,
    const uint8_t *sig, size_t sig_size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* IQR_SPHINCS_H */