liboqs
Loading...
Searching...
No Matches
kem.h
Go to the documentation of this file.
1
20
21#ifndef OQS_KEM_H
22#define OQS_KEM_H
23
24#include <stdbool.h>
25#include <stddef.h>
26#include <stdint.h>
27
28#include <oqs/oqs.h>
29
30#if defined(__cplusplus)
31extern "C" {
32#endif
33
35#define OQS_KEM_alg_bike_l1 "BIKE-L1"
37#define OQS_KEM_alg_bike_l3 "BIKE-L3"
39#define OQS_KEM_alg_bike_l5 "BIKE-L5"
41
42#define OQS_KEM_alg_classic_mceliece_348864 "Classic-McEliece-348864"
44#define OQS_KEM_alg_classic_mceliece_348864f "Classic-McEliece-348864f"
46#define OQS_KEM_alg_classic_mceliece_460896 "Classic-McEliece-460896"
48#define OQS_KEM_alg_classic_mceliece_460896f "Classic-McEliece-460896f"
50#define OQS_KEM_alg_classic_mceliece_6688128 "Classic-McEliece-6688128"
52#define OQS_KEM_alg_classic_mceliece_6688128f "Classic-McEliece-6688128f"
54#define OQS_KEM_alg_classic_mceliece_6960119 "Classic-McEliece-6960119"
56#define OQS_KEM_alg_classic_mceliece_6960119f "Classic-McEliece-6960119f"
58#define OQS_KEM_alg_classic_mceliece_8192128 "Classic-McEliece-8192128"
60#define OQS_KEM_alg_classic_mceliece_8192128f "Classic-McEliece-8192128f"
62#define OQS_KEM_alg_hqc_128 "HQC-128"
64#define OQS_KEM_alg_hqc_192 "HQC-192"
66#define OQS_KEM_alg_hqc_256 "HQC-256"
68#define OQS_KEM_alg_kyber_512 "Kyber512"
70#define OQS_KEM_alg_kyber_768 "Kyber768"
72#define OQS_KEM_alg_kyber_1024 "Kyber1024"
74#define OQS_KEM_alg_ml_kem_512 "ML-KEM-512"
76#define OQS_KEM_alg_ml_kem_768 "ML-KEM-768"
78#define OQS_KEM_alg_ml_kem_1024 "ML-KEM-1024"
80
81#define OQS_KEM_alg_ntruprime_sntrup761 "sntrup761"
83#define OQS_KEM_alg_frodokem_640_aes "FrodoKEM-640-AES"
85#define OQS_KEM_alg_frodokem_640_shake "FrodoKEM-640-SHAKE"
87#define OQS_KEM_alg_frodokem_976_aes "FrodoKEM-976-AES"
89#define OQS_KEM_alg_frodokem_976_shake "FrodoKEM-976-SHAKE"
91#define OQS_KEM_alg_frodokem_1344_aes "FrodoKEM-1344-AES"
93#define OQS_KEM_alg_frodokem_1344_shake "FrodoKEM-1344-SHAKE"
94// EDIT-WHEN-ADDING-KEM
96
98#define OQS_KEM_algs_length 29
100
110OQS_API const char *OQS_KEM_alg_identifier(size_t i);
111
121
128OQS_API int OQS_KEM_alg_is_enabled(const char *method_name);
129
133typedef struct OQS_KEM {
134
136 const char *method_name;
137
144 const char *alg_version;
145
148
151
162
175 OQS_STATUS (*keypair_derand)(uint8_t *public_key, uint8_t *secret_key, const uint8_t *seed);
176
188 OQS_STATUS (*keypair)(uint8_t *public_key, uint8_t *secret_key);
189
202 OQS_STATUS (*encaps)(uint8_t *ciphertext, uint8_t *shared_secret, const uint8_t *public_key);
203
216 OQS_STATUS (*decaps)(uint8_t *shared_secret, const uint8_t *ciphertext, const uint8_t *secret_key);
217
219
229OQS_API OQS_KEM *OQS_KEM_new(const char *method_name);
230
244OQS_API OQS_STATUS OQS_KEM_keypair_derand(const OQS_KEM *kem, uint8_t *public_key, uint8_t *secret_key, const uint8_t *seed);
245
258OQS_API OQS_STATUS OQS_KEM_keypair(const OQS_KEM *kem, uint8_t *public_key, uint8_t *secret_key);
259
273OQS_API OQS_STATUS OQS_KEM_encaps(const OQS_KEM *kem, uint8_t *ciphertext, uint8_t *shared_secret, const uint8_t *public_key);
274
288OQS_API OQS_STATUS OQS_KEM_decaps(const OQS_KEM *kem, uint8_t *shared_secret, const uint8_t *ciphertext, const uint8_t *secret_key);
289
296
297#ifdef OQS_ENABLE_KEM_BIKE
298#include <oqs/kem_bike.h>
299#endif /* OQS_ENABLE_KEM_BIKE */
301#ifdef OQS_ENABLE_KEM_CLASSIC_MCELIECE
302#include <oqs/kem_classic_mceliece.h>
303#endif /* OQS_ENABLE_KEM_CLASSIC_MCELIECE */
304#ifdef OQS_ENABLE_KEM_HQC
305#include <oqs/kem_hqc.h>
306#endif /* OQS_ENABLE_KEM_HQC */
307#ifdef OQS_ENABLE_KEM_KYBER
308#include <oqs/kem_kyber.h>
309#endif /* OQS_ENABLE_KEM_KYBER */
310#ifdef OQS_ENABLE_KEM_ML_KEM
311#include <oqs/kem_ml_kem.h>
312#endif /* OQS_ENABLE_KEM_ML_KEM */
314#ifdef OQS_ENABLE_KEM_NTRUPRIME
315#include <oqs/kem_ntruprime.h>
316#endif /* OQS_ENABLE_KEM_NTRUPRIME */
317#ifdef OQS_ENABLE_KEM_FRODOKEM
318#include <oqs/kem_frodokem.h>
319#endif /* OQS_ENABLE_KEM_FRODOKEM */
320// EDIT-WHEN-ADDING-KEM
321
322#if defined(__cplusplus)
323} // extern "C"
324#endif
325
326#endif // OQS_KEM_H
#define OQS_API
Definition common.h:94
OQS_STATUS
Definition common.h:116
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 OQS_STATUS OQS_KEM_keypair(const OQS_KEM *kem, uint8_t *public_key, uint8_t *secret_key)
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_KEM * OQS_KEM_new(const char *method_name)
OQS_API const char * OQS_KEM_alg_identifier(size_t i)
OQS_API int OQS_KEM_alg_count(void)
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 int OQS_KEM_alg_is_enabled(const char *method_name)
OQS_API void OQS_KEM_free(OQS_KEM *kem)
Definition kem.h:133
const char * method_name
Definition kem.h:136
size_t length_shared_secret
Definition kem.h:159
size_t length_ciphertext
Definition kem.h:157
size_t length_secret_key
Definition kem.h:155
uint8_t claimed_nist_level
Definition kem.h:147
size_t length_keypair_seed
Definition kem.h:161
OQS_STATUS(* decaps)(uint8_t *shared_secret, const uint8_t *ciphertext, const uint8_t *secret_key)
Definition kem.h:216
OQS_STATUS(* keypair_derand)(uint8_t *public_key, uint8_t *secret_key, const uint8_t *seed)
Definition kem.h:175
OQS_STATUS(* encaps)(uint8_t *ciphertext, uint8_t *shared_secret, const uint8_t *public_key)
Definition kem.h:202
const char * alg_version
Definition kem.h:144
size_t length_public_key
Definition kem.h:153
bool ind_cca
Definition kem.h:150
OQS_STATUS(* keypair)(uint8_t *public_key, uint8_t *secret_key)
Definition kem.h:188