liboqs
Loading...
Searching...
No Matches
sig.h
Go to the documentation of this file.
1
21#ifndef OQS_SIG_H
22#define OQS_SIG_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
36#define OQS_SIG_alg_dilithium_2 "Dilithium2"
38#define OQS_SIG_alg_dilithium_3 "Dilithium3"
40#define OQS_SIG_alg_dilithium_5 "Dilithium5"
42#define OQS_SIG_alg_ml_dsa_44_ipd "ML-DSA-44-ipd"
44#define OQS_SIG_alg_ml_dsa_44 "ML-DSA-44"
46#define OQS_SIG_alg_ml_dsa_65_ipd "ML-DSA-65-ipd"
48#define OQS_SIG_alg_ml_dsa_65 "ML-DSA-65"
50#define OQS_SIG_alg_ml_dsa_87_ipd "ML-DSA-87-ipd"
52#define OQS_SIG_alg_ml_dsa_87 "ML-DSA-87"
54#define OQS_SIG_alg_falcon_512 "Falcon-512"
56#define OQS_SIG_alg_falcon_1024 "Falcon-1024"
58#define OQS_SIG_alg_falcon_padded_512 "Falcon-padded-512"
60#define OQS_SIG_alg_falcon_padded_1024 "Falcon-padded-1024"
62#define OQS_SIG_alg_sphincs_sha2_128f_simple "SPHINCS+-SHA2-128f-simple"
64#define OQS_SIG_alg_sphincs_sha2_128s_simple "SPHINCS+-SHA2-128s-simple"
66#define OQS_SIG_alg_sphincs_sha2_192f_simple "SPHINCS+-SHA2-192f-simple"
68#define OQS_SIG_alg_sphincs_sha2_192s_simple "SPHINCS+-SHA2-192s-simple"
70#define OQS_SIG_alg_sphincs_sha2_256f_simple "SPHINCS+-SHA2-256f-simple"
72#define OQS_SIG_alg_sphincs_sha2_256s_simple "SPHINCS+-SHA2-256s-simple"
74#define OQS_SIG_alg_sphincs_shake_128f_simple "SPHINCS+-SHAKE-128f-simple"
76#define OQS_SIG_alg_sphincs_shake_128s_simple "SPHINCS+-SHAKE-128s-simple"
78#define OQS_SIG_alg_sphincs_shake_192f_simple "SPHINCS+-SHAKE-192f-simple"
80#define OQS_SIG_alg_sphincs_shake_192s_simple "SPHINCS+-SHAKE-192s-simple"
82#define OQS_SIG_alg_sphincs_shake_256f_simple "SPHINCS+-SHAKE-256f-simple"
84#define OQS_SIG_alg_sphincs_shake_256s_simple "SPHINCS+-SHAKE-256s-simple"
86#define OQS_SIG_alg_mayo_1 "MAYO-1"
88#define OQS_SIG_alg_mayo_2 "MAYO-2"
90#define OQS_SIG_alg_mayo_3 "MAYO-3"
92#define OQS_SIG_alg_mayo_5 "MAYO-5"
94#define OQS_SIG_alg_cross_rsdp_128_balanced "cross-rsdp-128-balanced"
96#define OQS_SIG_alg_cross_rsdp_128_fast "cross-rsdp-128-fast"
98#define OQS_SIG_alg_cross_rsdp_128_small "cross-rsdp-128-small"
100#define OQS_SIG_alg_cross_rsdp_192_balanced "cross-rsdp-192-balanced"
102#define OQS_SIG_alg_cross_rsdp_192_fast "cross-rsdp-192-fast"
104#define OQS_SIG_alg_cross_rsdp_192_small "cross-rsdp-192-small"
106#define OQS_SIG_alg_cross_rsdp_256_balanced "cross-rsdp-256-balanced"
108#define OQS_SIG_alg_cross_rsdp_256_fast "cross-rsdp-256-fast"
110#define OQS_SIG_alg_cross_rsdp_256_small "cross-rsdp-256-small"
112#define OQS_SIG_alg_cross_rsdpg_128_balanced "cross-rsdpg-128-balanced"
114#define OQS_SIG_alg_cross_rsdpg_128_fast "cross-rsdpg-128-fast"
116#define OQS_SIG_alg_cross_rsdpg_128_small "cross-rsdpg-128-small"
118#define OQS_SIG_alg_cross_rsdpg_192_balanced "cross-rsdpg-192-balanced"
120#define OQS_SIG_alg_cross_rsdpg_192_fast "cross-rsdpg-192-fast"
122#define OQS_SIG_alg_cross_rsdpg_192_small "cross-rsdpg-192-small"
124#define OQS_SIG_alg_cross_rsdpg_256_balanced "cross-rsdpg-256-balanced"
126#define OQS_SIG_alg_cross_rsdpg_256_fast "cross-rsdpg-256-fast"
128#define OQS_SIG_alg_cross_rsdpg_256_small "cross-rsdpg-256-small"
130// EDIT-WHEN-ADDING-SIG
132
134#define OQS_SIG_algs_length 47
136
146OQS_API const char *OQS_SIG_alg_identifier(size_t i);
147
157
164OQS_API int OQS_SIG_alg_is_enabled(const char *method_name);
165
169typedef struct OQS_SIG {
170
172 const char *method_name;
173
180 const char *alg_version;
181
184
187
194
206 OQS_STATUS (*keypair)(uint8_t *public_key, uint8_t *secret_key);
207
222 OQS_STATUS (*sign)(uint8_t *signature, size_t *signature_len, const uint8_t *message, size_t message_len, const uint8_t *secret_key);
223
234 OQS_STATUS (*verify)(const uint8_t *message, size_t message_len, const uint8_t *signature, size_t signature_len, const uint8_t *public_key);
235
237
247OQS_API OQS_SIG *OQS_SIG_new(const char *method_name);
248
261OQS_API OQS_STATUS OQS_SIG_keypair(const OQS_SIG *sig, uint8_t *public_key, uint8_t *secret_key);
262
278OQS_API OQS_STATUS OQS_SIG_sign(const OQS_SIG *sig, uint8_t *signature, size_t *signature_len, const uint8_t *message, size_t message_len, const uint8_t *secret_key);
279
291OQS_API OQS_STATUS OQS_SIG_verify(const OQS_SIG *sig, const uint8_t *message, size_t message_len, const uint8_t *signature, size_t signature_len, const uint8_t *public_key);
292
299
301#ifdef OQS_ENABLE_SIG_DILITHIUM
302#include <oqs/sig_dilithium.h>
303#endif /* OQS_ENABLE_SIG_DILITHIUM */
304#ifdef OQS_ENABLE_SIG_ML_DSA
305#include <oqs/sig_ml_dsa.h>
306#endif /* OQS_ENABLE_SIG_ML_DSA */
307#ifdef OQS_ENABLE_SIG_FALCON
308#include <oqs/sig_falcon.h>
309#endif /* OQS_ENABLE_SIG_FALCON */
310#ifdef OQS_ENABLE_SIG_SPHINCS
311#include <oqs/sig_sphincs.h>
312#endif /* OQS_ENABLE_SIG_SPHINCS */
313#ifdef OQS_ENABLE_SIG_MAYO
314#include <oqs/sig_mayo.h>
315#endif /* OQS_ENABLE_SIG_MAYO */
316#ifdef OQS_ENABLE_SIG_CROSS
317#include <oqs/sig_cross.h>
318#endif /* OQS_ENABLE_SIG_CROSS */
320// EDIT-WHEN-ADDING-SIG
321
322#if defined(__cplusplus)
323} // extern "C"
324#endif
325
326#endif // OQS_SIG_H
#define OQS_API
Definition common.h:92
OQS_STATUS
Definition common.h:114
OQS_API int OQS_SIG_alg_count(void)
OQS_API void OQS_SIG_free(OQS_SIG *sig)
struct OQS_SIG OQS_SIG
OQS_API const char * OQS_SIG_alg_identifier(size_t i)
OQS_API OQS_SIG * OQS_SIG_new(const char *method_name)
OQS_API int OQS_SIG_alg_is_enabled(const char *method_name)
OQS_API OQS_STATUS OQS_SIG_sign(const OQS_SIG *sig, uint8_t *signature, size_t *signature_len, const uint8_t *message, size_t message_len, const uint8_t *secret_key)
OQS_API OQS_STATUS OQS_SIG_keypair(const OQS_SIG *sig, uint8_t *public_key, uint8_t *secret_key)
OQS_API OQS_STATUS OQS_SIG_verify(const OQS_SIG *sig, const uint8_t *message, size_t message_len, const uint8_t *signature, size_t signature_len, const uint8_t *public_key)
Definition sig.h:169
size_t length_secret_key
Definition sig.h:191
size_t length_signature
Definition sig.h:193
bool euf_cma
Definition sig.h:186
OQS_STATUS(* keypair)(uint8_t *public_key, uint8_t *secret_key)
Definition sig.h:206
const char * method_name
Definition sig.h:172
size_t length_public_key
Definition sig.h:189
const char * alg_version
Definition sig.h:180
OQS_STATUS(* sign)(uint8_t *signature, size_t *signature_len, const uint8_t *message, size_t message_len, const uint8_t *secret_key)
Definition sig.h:222
OQS_STATUS(* verify)(const uint8_t *message, size_t message_len, const uint8_t *signature, size_t signature_len, const uint8_t *public_key)
Definition sig.h:234
uint8_t claimed_nist_level
Definition sig.h:183