kem.h

Go to the documentation of this file.

 
#ifndef OQS_KEM_H
#define OQS_KEM_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include <oqs/oqs.h>
 
#if defined(__cplusplus)
extern "C" {
#endif

#define OQS_KEM_alg_bike_l1 "BIKE-L1"
#define OQS_KEM_alg_bike_l3 "BIKE-L3"
#define OQS_KEM_alg_bike_l5 "BIKE-L5"

#define OQS_KEM_alg_classic_mceliece_348864 "Classic-McEliece-348864"
#define OQS_KEM_alg_classic_mceliece_348864f "Classic-McEliece-348864f"
#define OQS_KEM_alg_classic_mceliece_460896 "Classic-McEliece-460896"
#define OQS_KEM_alg_classic_mceliece_460896f "Classic-McEliece-460896f"
#define OQS_KEM_alg_classic_mceliece_6688128 "Classic-McEliece-6688128"
#define OQS_KEM_alg_classic_mceliece_6688128f "Classic-McEliece-6688128f"
#define OQS_KEM_alg_classic_mceliece_6960119 "Classic-McEliece-6960119"
#define OQS_KEM_alg_classic_mceliece_6960119f "Classic-McEliece-6960119f"
#define OQS_KEM_alg_classic_mceliece_8192128 "Classic-McEliece-8192128"
#define OQS_KEM_alg_classic_mceliece_8192128f "Classic-McEliece-8192128f"
#define OQS_KEM_alg_hqc_1 "HQC-1"
#define OQS_KEM_alg_hqc_3 "HQC-3"
#define OQS_KEM_alg_hqc_5 "HQC-5"
#define OQS_KEM_alg_kyber_512 "Kyber512"
#define OQS_KEM_alg_kyber_768 "Kyber768"
#define OQS_KEM_alg_kyber_1024 "Kyber1024"
#define OQS_KEM_alg_ml_kem_512 "ML-KEM-512"
#define OQS_KEM_alg_ml_kem_768 "ML-KEM-768"
#define OQS_KEM_alg_ml_kem_1024 "ML-KEM-1024"

#define OQS_KEM_alg_ntru_hps2048509 "NTRU-HPS-2048-509"
#define OQS_KEM_alg_ntru_hps2048677 "NTRU-HPS-2048-677"
#define OQS_KEM_alg_ntru_hps4096821 "NTRU-HPS-4096-821"
#define OQS_KEM_alg_ntru_hps40961229 "NTRU-HPS-4096-1229"
#define OQS_KEM_alg_ntru_hrss701 "NTRU-HRSS-701"
#define OQS_KEM_alg_ntru_hrss1373 "NTRU-HRSS-1373"
#define OQS_KEM_alg_ntruprime_sntrup761 "sntrup761"
#define OQS_KEM_alg_frodokem_640_aes "FrodoKEM-640-AES"
#define OQS_KEM_alg_frodokem_640_shake "FrodoKEM-640-SHAKE"
#define OQS_KEM_alg_frodokem_976_aes "FrodoKEM-976-AES"
#define OQS_KEM_alg_frodokem_976_shake "FrodoKEM-976-SHAKE"
#define OQS_KEM_alg_frodokem_1344_aes "FrodoKEM-1344-AES"
#define OQS_KEM_alg_frodokem_1344_shake "FrodoKEM-1344-SHAKE"
#define OQS_KEM_alg_efrodokem_640_aes "eFrodoKEM-640-AES"
#define OQS_KEM_alg_efrodokem_640_shake "eFrodoKEM-640-SHAKE"
#define OQS_KEM_alg_efrodokem_976_aes "eFrodoKEM-976-AES"
#define OQS_KEM_alg_efrodokem_976_shake "eFrodoKEM-976-SHAKE"
#define OQS_KEM_alg_efrodokem_1344_aes "eFrodoKEM-1344-AES"
#define OQS_KEM_alg_efrodokem_1344_shake "eFrodoKEM-1344-SHAKE"
// EDIT-WHEN-ADDING-KEM

#define OQS_KEM_algs_length 41

OQS_API const char *OQS_KEM_alg_identifier(size_t i);

OQS_API int OQS_KEM_alg_count(void);

OQS_API int OQS_KEM_alg_is_enabled(const char *method_name);

typedef struct OQS_KEM {

    const char *method_name;

    const char *alg_version;

    uint8_t claimed_nist_level;

    bool ind_cca;

    size_t length_public_key;
    size_t length_secret_key;
    size_t length_ciphertext;
    size_t length_shared_secret;
    size_t length_keypair_seed;
    size_t length_encaps_seed;

    OQS_STATUS (*keypair_derand)(uint8_t *public_key, uint8_t *secret_key, const uint8_t *seed);

    OQS_STATUS (*keypair)(uint8_t *public_key, uint8_t *secret_key);

    OQS_STATUS (*encaps_derand)(uint8_t *ciphertext, uint8_t *shared_secret, const uint8_t *public_key, const uint8_t *seed);

    OQS_STATUS (*encaps)(uint8_t *ciphertext, uint8_t *shared_secret, const uint8_t *public_key);

    OQS_STATUS (*decaps)(uint8_t *shared_secret, const uint8_t *ciphertext, const uint8_t *secret_key);
 
} OQS_KEM;

OQS_API OQS_KEM *OQS_KEM_new(const char *method_name);

OQS_API OQS_STATUS OQS_KEM_keypair_derand(const OQS_KEM *kem, uint8_t *public_key, uint8_t *secret_key, const uint8_t *seed);

OQS_API OQS_STATUS OQS_KEM_keypair(const OQS_KEM *kem, uint8_t *public_key, uint8_t *secret_key);

OQS_API OQS_STATUS OQS_KEM_encaps_derand(const OQS_KEM *kem, uint8_t *ciphertext, uint8_t *shared_secret, const uint8_t *public_key, const uint8_t *seed);

OQS_API OQS_STATUS OQS_KEM_encaps(const OQS_KEM *kem, uint8_t *ciphertext, uint8_t *shared_secret, const uint8_t *public_key);

OQS_API OQS_STATUS OQS_KEM_decaps(const OQS_KEM *kem, uint8_t *shared_secret, const uint8_t *ciphertext, const uint8_t *secret_key);

OQS_API void OQS_KEM_free(OQS_KEM *kem);
 
#ifdef OQS_ENABLE_KEM_BIKE
#include <oqs/kem_bike.h>
#endif /* OQS_ENABLE_KEM_BIKE */
#ifdef OQS_ENABLE_KEM_CLASSIC_MCELIECE
#include <oqs/kem_classic_mceliece.h>
#endif /* OQS_ENABLE_KEM_CLASSIC_MCELIECE */
#ifdef OQS_ENABLE_KEM_HQC
#include <oqs/kem_hqc.h>
#endif /* OQS_ENABLE_KEM_HQC */
#ifdef OQS_ENABLE_KEM_KYBER
#include <oqs/kem_kyber.h>
#endif /* OQS_ENABLE_KEM_KYBER */
#ifdef OQS_ENABLE_KEM_ML_KEM
#include <oqs/kem_ml_kem.h>
#endif /* OQS_ENABLE_KEM_ML_KEM */
#ifdef OQS_ENABLE_KEM_NTRU
#include <oqs/kem_ntru.h>
#endif /* OQS_ENABLE_KEM_NTRU */
#ifdef OQS_ENABLE_KEM_NTRUPRIME
#include <oqs/kem_ntruprime.h>
#endif /* OQS_ENABLE_KEM_NTRUPRIME */
#ifdef OQS_ENABLE_KEM_FRODOKEM
#include <oqs/kem_frodokem.h>
#endif /* OQS_ENABLE_KEM_FRODOKEM */
// EDIT-WHEN-ADDING-KEM
 
#if defined(__cplusplus)
} // extern "C"
#endif
 
#endif // OQS_KEM_H