wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2025-07-31 11:17:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4960 from anhu/stm32_pq_bench

Browse Source 
Add Post-quantum KEM benchmark for STM32
This commit is contained in:
David Garske
2022-03-15 16:36:08 -07:00
committed by GitHub
parent d531e21f34 fbfb1fee91
commit 5b268c0852
1 changed files with 109 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
wolfcrypt/benchmark/benchmark.c
View File

@ -248,6 +248,14 @@
#if defined(HAVE_PQC) && defined(HAVE_FALCON) #if defined(HAVE_PQC) && defined(HAVE_FALCON)
#include <wolfssl/wolfcrypt/falcon.h> #include <wolfssl/wolfcrypt/falcon.h>
#endif #endif
#ifdef HAVE_PQM4
#include <api_kyber.h>
#define PQM4_PUBLIC_KEY_LENGTH CRYPTO_PUBLICKEYBYTES
#define PQM4_PRIVATE_KEY_LENGTH CRYPTO_SECRETKEYBYTES
#define PQM4_SHARED_SECRET_LENGTH CRYPTO_BYTES
#define PQM4_CIPHERTEXT_LENGTH CRYPTO_CIPHERTEXTBYTES
typedef char OQS_KEM;
#endif
#include <wolfssl/wolfcrypt/dh.h> #include <wolfssl/wolfcrypt/dh.h>
#include <wolfssl/wolfcrypt/random.h> #include <wolfssl/wolfcrypt/random.h>
@ -648,6 +656,22 @@ static const bench_alg bench_asym_opt[] = {
{ NULL, 0 } { NULL, 0 }
}; };
/* All recognized other cryptographic algorithm choosing command line options.
*/
static const bench_alg bench_other_opt[] = {
{ "-other", 0xffffffff },
#ifndef WC_NO_RNG
{ "-rng", BENCH_RNG },
#endif
#ifdef HAVE_SCRYPT
{ "-scrypt", BENCH_SCRYPT },
#endif
{ NULL, 0}
};
#endif /* MAIN_NO_ARGS */
#endif /* !WOLFSSL_BENCHMARK_ALL && !NO_MAIN_DRIVER */
/* The post-quantum-specific mapping of command line option to bit values and /* The post-quantum-specific mapping of command line option to bit values and
* OQS name. */ * OQS name. */
typedef struct bench_pq_alg { typedef struct bench_pq_alg {
@ -662,6 +686,10 @@ typedef struct bench_pq_alg {
* options. */ * options. */
static const bench_pq_alg bench_pq_asym_opt[] = { static const bench_pq_alg bench_pq_asym_opt[] = {
{ "-pq", 0xffffffff, NULL}, { "-pq", 0xffffffff, NULL},
#ifdef HAVE_PQM4
{ "-kyber_level1-kg", BENCH_KYBER_LEVEL1_KEYGEN, NULL },
{ "-kyber_level1-ed", BENCH_KYBER_LEVEL1_ENCAP, NULL },
#endif
#ifdef HAVE_LIBOQS #ifdef HAVE_LIBOQS
{ "-falcon_level1", BENCH_FALCON_LEVEL1_SIGN, { "-falcon_level1", BENCH_FALCON_LEVEL1_SIGN,
OQS_SIG_alg_falcon_512 }, OQS_SIG_alg_falcon_512 },
@ -723,23 +751,6 @@ static const bench_pq_alg bench_pq_asym_opt[] = {
{ NULL, 0, NULL } { NULL, 0, NULL }
}; };
/* All recognized other cryptographic algorithm choosing command line options.
*/
static const bench_alg bench_other_opt[] = {
{ "-other", 0xffffffff },
#ifndef WC_NO_RNG
{ "-rng", BENCH_RNG },
#endif
#ifdef HAVE_SCRYPT
{ "-scrypt", BENCH_SCRYPT },
#endif
{ NULL, 0}
};
#endif /* MAIN_NO_ARGS */
#endif /* !WOLFSSL_BENCHMARK_ALL && !NO_MAIN_DRIVER */
#ifdef HAVE_WNR #ifdef HAVE_WNR
const char* wnrConfigFile = "wnr-example.conf"; const char* wnrConfigFile = "wnr-example.conf";
#endif #endif
@ -1239,7 +1250,6 @@ static void benchmark_static_init(void)
/******************************************************************************/ /******************************************************************************/
/* Begin Stats Functions */ /* Begin Stats Functions */
/******************************************************************************/ /******************************************************************************/
static int gPrintStats = 0;
typedef enum bench_stat_type { typedef enum bench_stat_type {
BENCH_STAT_ASYM, BENCH_STAT_ASYM,
BENCH_STAT_SYM, BENCH_STAT_SYM,
@ -1247,6 +1257,8 @@ typedef enum bench_stat_type {
} bench_stat_type_t; } bench_stat_type_t;
#ifdef WC_ENABLE_BENCH_THREADING #ifdef WC_ENABLE_BENCH_THREADING
static int gPrintStats = 0;
static pthread_mutex_t bench_lock = PTHREAD_MUTEX_INITIALIZER; static pthread_mutex_t bench_lock = PTHREAD_MUTEX_INITIALIZER;
#ifndef BENCH_MAX_NAME_SZ #ifndef BENCH_MAX_NAME_SZ
@ -1617,7 +1629,7 @@ static void bench_stats_asym_finish(const char* algo, int strength,
} }
#endif #endif
#if defined(HAVE_PQC) && defined(HAVE_LIBOQS) #if defined(HAVE_PQC)
static void bench_stats_pq_asym_finish(const char* algo, int doAsync, int count, static void bench_stats_pq_asym_finish(const char* algo, int doAsync, int count,
double start, int ret) double start, int ret)
{ {
@ -2276,15 +2288,13 @@ static void* benchmarks_do(void* args)
#endif #endif
#endif #endif
#if defined(HAVE_PQC) && defined(HAVE_LIBOQS) #if defined(HAVE_PQC)
if (bench_all || (bench_pq_asym_algs & BENCH_FALCON_LEVEL1_SIGN))
bench_falconKeySign(1);
if (bench_all || (bench_pq_asym_algs & BENCH_FALCON_LEVEL5_SIGN))
bench_falconKeySign(5);
if (bench_all || (bench_pq_asym_algs & BENCH_KYBER_LEVEL1_KEYGEN)) if (bench_all || (bench_pq_asym_algs & BENCH_KYBER_LEVEL1_KEYGEN))
bench_pqcKemKeygen(BENCH_KYBER_LEVEL1_KEYGEN); bench_pqcKemKeygen(BENCH_KYBER_LEVEL1_KEYGEN);
if (bench_all || (bench_pq_asym_algs & BENCH_KYBER_LEVEL1_ENCAP)) if (bench_all || (bench_pq_asym_algs & BENCH_KYBER_LEVEL1_ENCAP))
bench_pqcKemEncapDecap(BENCH_KYBER_LEVEL1_ENCAP); bench_pqcKemEncapDecap(BENCH_KYBER_LEVEL1_ENCAP);
#endif
#if defined(HAVE_LIBOQS)
if (bench_all || (bench_pq_asym_algs & BENCH_KYBER_LEVEL3_KEYGEN)) if (bench_all || (bench_pq_asym_algs & BENCH_KYBER_LEVEL3_KEYGEN))
bench_pqcKemKeygen(BENCH_KYBER_LEVEL3_KEYGEN); bench_pqcKemKeygen(BENCH_KYBER_LEVEL3_KEYGEN);
if (bench_all || (bench_pq_asym_algs & BENCH_KYBER_LEVEL3_ENCAP)) if (bench_all || (bench_pq_asym_algs & BENCH_KYBER_LEVEL3_ENCAP))
@ -2333,7 +2343,13 @@ static void* benchmarks_do(void* args)
bench_pqcKemKeygen(BENCH_NTRUHRSS_LEVEL3_KEYGEN); bench_pqcKemKeygen(BENCH_NTRUHRSS_LEVEL3_KEYGEN);
if (bench_all || (bench_pq_asym_algs & BENCH_NTRUHRSS_LEVEL3_ENCAP)) if (bench_all || (bench_pq_asym_algs & BENCH_NTRUHRSS_LEVEL3_ENCAP))
bench_pqcKemEncapDecap(BENCH_NTRUHRSS_LEVEL3_ENCAP); bench_pqcKemEncapDecap(BENCH_NTRUHRSS_LEVEL3_ENCAP);
#ifdef HAVE_FALCON
if (bench_all || (bench_pq_asym_algs & BENCH_FALCON_LEVEL1_SIGN))
bench_falconKeySign(1);
if (bench_all || (bench_pq_asym_algs & BENCH_FALCON_LEVEL5_SIGN))
bench_falconKeySign(5);
#endif #endif
#endif /* HAVE_LIBOQS */
#ifdef WOLFCRYPT_HAVE_SAKKE #ifdef WOLFCRYPT_HAVE_SAKKE
#ifdef WOLFCRYPT_SAKKE_KMS #ifdef WOLFCRYPT_SAKKE_KMS
@ -6905,7 +6921,7 @@ void bench_sakke(void)
#endif /* WOLFCRYPT_SAKKE_CLIENT */ #endif /* WOLFCRYPT_SAKKE_CLIENT */
#endif /* WOLFCRYPT_HAVE_SAKKE */ #endif /* WOLFCRYPT_HAVE_SAKKE */
#if defined(HAVE_PQC) && defined(HAVE_LIBOQS) #if defined(HAVE_PQC)
static void bench_pqcKemInit(word32 alg, byte **priv_key, byte **pub_key, static void bench_pqcKemInit(word32 alg, byte **priv_key, byte **pub_key,
const char **wolf_name, OQS_KEM **kem) const char **wolf_name, OQS_KEM **kem)
{ {
@ -6917,32 +6933,41 @@ static void bench_pqcKemInit(word32 alg, byte **priv_key, byte **pub_key,
for (i=0; bench_pq_asym_opt[i].str != NULL; i++) { for (i=0; bench_pq_asym_opt[i].str != NULL; i++) {
if (alg == bench_pq_asym_opt[i].val) { if (alg == bench_pq_asym_opt[i].val) {
#ifdef HAVE_LIBOQS
pqc_name = bench_pq_asym_opt[i].pqc_name; pqc_name = bench_pq_asym_opt[i].pqc_name;
#endif
*wolf_name = bench_pq_asym_opt[i].str; *wolf_name = bench_pq_asym_opt[i].str;
break; break;
} }
} }
#ifdef HAVE_LIBOQS
if (pqc_name == NULL) { if (pqc_name == NULL) {
printf("Bad OQS Alg specified\n"); printf("Bad OQS Alg specified\n");
return; return;
} }
#ifdef HAVE_LIBOQS
*kem = OQS_KEM_new(pqc_name); *kem = OQS_KEM_new(pqc_name);
if (*kem == NULL) { if (*kem == NULL) {
printf("OQS_KEM_new() failed\n"); printf("OQS_KEM_new() failed\n");
return; return;
} }
#endif
*pub_key = (byte*)XMALLOC((*kem)->length_public_key, HEAP_HINT, *pub_key = (byte*)XMALLOC((*kem)->length_public_key, HEAP_HINT,
DYNAMIC_TYPE_TMP_BUFFER); DYNAMIC_TYPE_TMP_BUFFER);
*priv_key = (byte*)XMALLOC((*kem)->length_secret_key, HEAP_HINT, *priv_key = (byte*)XMALLOC((*kem)->length_secret_key, HEAP_HINT,
DYNAMIC_TYPE_TMP_BUFFER); DYNAMIC_TYPE_TMP_BUFFER);
#endif
#ifdef HAVE_PQM4
*pub_key = (byte*)XMALLOC(PQM4_PUBLIC_KEY_LENGTH, HEAP_HINT,
DYNAMIC_TYPE_TMP_BUFFER);
*priv_key = (byte*)XMALLOC(PQM4_PRIVATE_KEY_LENGTH, HEAP_HINT,
DYNAMIC_TYPE_TMP_BUFFER);
(void)pqc_name;
#endif
} }
void bench_pqcKemKeygen(word32 alg) void bench_pqcKemKeygen(word32 alg)
@ -6956,7 +6981,10 @@ void bench_pqcKemKeygen(word32 alg)
bench_pqcKemInit(alg, &priv_key, &pub_key, &wolf_name, &kem); bench_pqcKemInit(alg, &priv_key, &pub_key, &wolf_name, &kem);
if (wolf_name == NULL || kem == NULL || pub_key == NULL || if (wolf_name == NULL || pub_key == NULL ||
#ifdef HAVE_LIBOQS
kem == NULL ||
#endif
priv_key == NULL) { priv_key == NULL) {
printf("bench_pqcKemInit() failed\n"); printf("bench_pqcKemInit() failed\n");
goto exit; goto exit;
@ -6971,6 +6999,13 @@ void bench_pqcKemKeygen(word32 alg)
printf("OQS_KEM_keypair() failed: %d\n", ret); printf("OQS_KEM_keypair() failed: %d\n", ret);
goto exit; goto exit;
} }
#endif
#ifdef HAVE_PQM4
ret = crypto_kem_keypair(pub_key, priv_key);
if (ret != 0) {
printf("crypto_kem_keypair() failed: %d\n", ret);
goto exit;
}
#endif #endif
} }
count += i; count += i;
@ -6982,8 +7017,9 @@ void bench_pqcKemKeygen(word32 alg)
exit: exit:
XFREE(priv_key, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER); XFREE(priv_key, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER);
XFREE(pub_key, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER); XFREE(pub_key, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER);
#ifdef HAVE_LIBOQS
OQS_KEM_free(kem); OQS_KEM_free(kem);
#endif
} }
void bench_pqcKemEncapDecap(word32 alg) void bench_pqcKemEncapDecap(word32 alg)
@ -6999,7 +7035,10 @@ void bench_pqcKemEncapDecap(word32 alg)
bench_pqcKemInit(alg, &priv_key, &pub_key, &wolf_name, &kem); bench_pqcKemInit(alg, &priv_key, &pub_key, &wolf_name, &kem);
if (wolf_name == NULL || kem == NULL || pub_key == NULL || if (wolf_name == NULL || pub_key == NULL ||
#ifdef HAVE_LIBOQS
kem == NULL ||
#endif
priv_key == NULL) { priv_key == NULL) {
printf("bench_pqcKemInit() failed\n"); printf("bench_pqcKemInit() failed\n");
goto exit; goto exit;
@ -7011,20 +7050,39 @@ void bench_pqcKemEncapDecap(word32 alg)
printf("OQS_KEM_keypair() failed: %d\n", ret); printf("OQS_KEM_keypair() failed: %d\n", ret);
goto exit; goto exit;
} }
#endif
shared_secret = (byte*)XMALLOC(kem->length_shared_secret, HEAP_HINT, shared_secret = (byte*)XMALLOC(kem->length_shared_secret, HEAP_HINT,
DYNAMIC_TYPE_TMP_BUFFER); DYNAMIC_TYPE_TMP_BUFFER);
ciphertext = (byte*)XMALLOC(kem->length_ciphertext, HEAP_HINT, ciphertext = (byte*)XMALLOC(kem->length_ciphertext, HEAP_HINT,
DYNAMIC_TYPE_TMP_BUFFER); DYNAMIC_TYPE_TMP_BUFFER);
#endif
#ifdef HAVE_PQM4
ret = crypto_kem_keypair(pub_key, priv_key);
if (ret != 0) {
printf("crypto_kem_keypair() failed: %d\n", ret);
goto exit;
}
shared_secret = (byte*)XMALLOC(PQM4_SHARED_SECRET_LENGTH, HEAP_HINT,
DYNAMIC_TYPE_TMP_BUFFER);
ciphertext = (byte*)XMALLOC(PQM4_CIPHERTEXT_LENGTH, HEAP_HINT,
DYNAMIC_TYPE_TMP_BUFFER);
#endif
if (shared_secret == NULL || ciphertext == NULL) { if (shared_secret == NULL || ciphertext == NULL) {
printf("XMALLOC() failed\n"); printf("XMALLOC() failed\n");
goto exit; goto exit;
} }
if (ret == OQS_SUCCESS) { #ifdef HAVE_LIBOQS
if (ret == OQS_SUCCESS)
#endif
#ifdef HAVE_PQM4
if (ret == 0)
#endif
{
bench_stats_start(&count, &start); bench_stats_start(&count, &start);
do { do {
for (i = 0; i < agreeTimes; i++) { for (i = 0; i < agreeTimes; i++) {
@ -7040,6 +7098,19 @@ void bench_pqcKemEncapDecap(word32 alg)
printf("OQS_KEM_decaps() failed: %d\n", ret); printf("OQS_KEM_decaps() failed: %d\n", ret);
goto exit; goto exit;
} }
#endif
#ifdef HAVE_PQM4
ret = crypto_kem_enc(ciphertext, shared_secret, pub_key);
if (ret != 0){
printf("crypto_kem_enc() failed: %d\n", ret);
goto exit;
}
ret = crypto_kem_dec(shared_secret, ciphertext, priv_key);
if (ret != 0){
printf("crypto_kem_dec() failed: %d\n", ret);
goto exit;
}
#endif #endif
} }
count += i; count += i;
@ -7054,9 +7125,12 @@ exit:
XFREE(shared_secret, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER); XFREE(shared_secret, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER);
XFREE(priv_key, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER); XFREE(priv_key, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER);
XFREE(pub_key, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER); XFREE(pub_key, HEAP_HINT, DYNAMIC_TYPE_TMP_BUFFER);
#ifdef HAVE_LIBOQS
OQS_KEM_free(kem); OQS_KEM_free(kem);
#endif
} }
#ifdef HAVE_FALCON
void bench_falconKeySign(byte level) void bench_falconKeySign(byte level)
{ {
int ret = 0; int ret = 0;
@ -7155,6 +7229,7 @@ void bench_falconKeySign(byte level)
wc_falcon_free(&key); wc_falcon_free(&key);
} }
#endif /* HAVE_FALCON */
#endif /* HAVE_PQC && HAVE_LIBOQS */ #endif /* HAVE_PQC && HAVE_LIBOQS */
#ifndef HAVE_STACK_SIZE #ifndef HAVE_STACK_SIZE
@ -7614,10 +7689,10 @@ int main(int argc, char** argv)
} }
} }
} }
#endif
else if (string_matches(argv[1], "-print")) { else if (string_matches(argv[1], "-print")) {
gPrintStats = 1; gPrintStats = 1;
} }
#endif
else if (argv[1][0] == '-') { else if (argv[1][0] == '-') {
optMatched = 0; optMatched = 0;
#ifndef WOLFSSL_BENCHMARK_ALL #ifndef WOLFSSL_BENCHMARK_ALL