iqr_mceliece.h

Go to the documentation of this file.

#ifndef IQR_MCELIECE_H
#define IQR_MCELIECE_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>

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

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

typedef struct iqr_McElieceParams_struct iqr_McElieceParams;

typedef struct iqr_McEliecePublicKey_struct iqr_McEliecePublicKey;

typedef struct iqr_McEliecePrivateKey_struct iqr_McEliecePrivateKey;

// ---------------------------------------------------------------------------------------------------------------------------------
// McEliece QC-MDPC specific enum.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef enum {
    IQR_MCELIECE_PUBKEY9857    = 0,  
    IQR_MCELIECE_PUBKEY14866   = 1,  
    IQR_MCELIECE_PUBKEY20409   = 2,  

    IQR_MCELIECE_PUBKEY32771   = 3,  
    IQR_MCELIECE_PUBKEY45062   = 4,  
    IQR_MCELIECE_PUBKEY61449   = 5,  

    // Maintain a count of supported public key sizes. MUST BE LAST.
    IQR_MDPC_PUBKEY_LAST
} iqr_McElieceKeySize;

// ---------------------------------------------------------------------------------------------------------------------------------
// McEliece parameter management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_McElieceCreateParams(const iqr_Context *ctx, iqr_HashAlgorithmType hash_algo, iqr_McElieceKeySize public_key_size,
    iqr_McElieceParams **params);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_McElieceDestroyParams(iqr_McElieceParams **params);

// ---------------------------------------------------------------------------------------------------------------------------------
// McEliece key management functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_McElieceCreateKeyPair(const iqr_McElieceParams *params, const iqr_RNG *rng, iqr_McEliecePublicKey **pub_key,
    iqr_McEliecePrivateKey **priv_key);

IQR_API
iqr_retval iqr_McElieceGetPublicKeySize(const iqr_McEliecePublicKey *pub_key, size_t *size);

IQR_API
iqr_retval iqr_McElieceGetPrivateKeySize(const iqr_McEliecePrivateKey *priv_key, size_t *size);

IQR_API
iqr_retval iqr_McElieceGetPublicKeyParams(const iqr_McEliecePublicKey *pub_key, iqr_McElieceParams **params);

IQR_API
iqr_retval iqr_McElieceGetPrivateKeyParams(const iqr_McEliecePrivateKey *priv_key, iqr_McElieceParams **params);

IQR_API
iqr_retval iqr_McElieceImportPublicKey(const iqr_McElieceParams *params, const uint8_t *data, size_t size,
    iqr_McEliecePublicKey **pub_key);

IQR_API
iqr_retval iqr_McElieceImportPrivateKey(const iqr_McElieceParams *params, const uint8_t *data, size_t size,
    iqr_McEliecePrivateKey **priv_key);

IQR_API
iqr_retval iqr_McElieceExportPublicKey(const iqr_McEliecePublicKey *pub_key, uint8_t *buf, size_t buf_size);

IQR_API
iqr_retval iqr_McElieceExportPrivateKey(const iqr_McEliecePrivateKey *priv_key, uint8_t *buf, size_t buf_size);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_McElieceDestroyPublicKey(iqr_McEliecePublicKey **pub_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_McElieceDestroyPrivateKey(iqr_McEliecePrivateKey **priv_key);

// ---------------------------------------------------------------------------------------------------------------------------------
// McEliece encryption / decryption functionality.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_McElieceGetCiphertextSize(const iqr_McElieceParams *params, size_t plaintext_size, size_t *ciphertext_size);

IQR_API
iqr_retval iqr_McElieceGetPlaintextSize(const iqr_McElieceParams *params, size_t ciphertext_size, size_t *plaintext_size);

IQR_API
iqr_retval iqr_McElieceEncrypt(const iqr_McEliecePublicKey *pub_key, const iqr_RNG *rng, const uint8_t *plaintext,
    size_t plaintext_size, uint8_t *ciphertext, size_t ciphertext_size);

IQR_API
iqr_retval iqr_McElieceDecrypt(const iqr_McEliecePrivateKey *priv_key, const uint8_t *ciphertext, size_t ciphertext_size,
    uint8_t *plaintext, size_t *plaintext_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_MCELIECE_H */