sharpetronics/liboqs
1
0
Fork 0
mirror of https://github.com/open-quantum-safe/liboqs.git synced 2025-11-27 00:04:24 -05:00
Code Issues Projects Releases Wiki Activity

enable Valgrind memory use testing (#854)

Browse Source
This commit is contained in:
Michael Baentsch 2020-12-02 20:45:30 +00:00 committed by GitHub
parent 1ad950ac00
commit 3ca64c35ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 504 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.circleci/config.yml
View File

@ -63,7 +63,7 @@ jobs:
working_directory: build
- run:
name: Run tests
command: python3 -m pytest --verbose --ignore=tests/test_code_conventions.py --junitxml=build/test-results/pytest/test-results.xml << parameters.PYTEST_ARGS >>
command: mkdir -p tmp && python3 -m pytest --verbose --ignore=tests/test_code_conventions.py --junitxml=build/test-results/pytest/test-results.xml << parameters.PYTEST_ARGS >>
- store_test_results: # Note that this command will fail when running CircleCI locally, that is expected behaviour
path: build/test-results
- store_artifacts:
@ -95,7 +95,7 @@ jobs:
(cd build &&
cmake -GNinja << parameters.CMAKE_ARGS >> .. && cmake -LA .. &&
ninja) &&
python3 -m pytest --verbose --numprocesses=auto --ignore=tests/test_code_conventions.py --junitxml=build/test-results/pytest/test-results.xml
mkdir -p tmp && python3 -m pytest --verbose --numprocesses=auto --ignore=tests/test_code_conventions.py --junitxml=build/test-results/pytest/test-results.xml
"
- store_test_results:
path: build/test-results
@ -131,7 +131,7 @@ jobs:
working_directory: build
- run:
name: Run tests
command: python3 -m pytest --verbose --ignore=tests/test_code_conventions.py --junitxml=build/test-results/pytest/test-results.xml << parameters.PYTEST_ARGS >>
command: mkdir tmp && python3 -m pytest --verbose --ignore=tests/test_code_conventions.py --junitxml=build/test-results/pytest/test-results.xml << parameters.PYTEST_ARGS >>
- store_test_results: # Note that this command will fail when running CircleCI locally, that is expected behaviour
path: build/test-results
- store_artifacts:

2
appveyor.yml
View File

@ -31,7 +31,7 @@ before_test:
test_script:
- cmd: |-
cd %APPVEYOR_BUILD_FOLDER%
set PATH=%cd%\build\bin;%PATH% && python -m pytest --numprocesses=auto --verbose --ignore=tests/test_code_conventions.py --junitxml=build\test-results\pytest\test-results.xml
set PATH=%cd%\build\bin;%PATH% && if not exist tmp (mkdir tmp) && python -m pytest --numprocesses=auto --verbose --ignore=tests/test_code_conventions.py --junitxml=build\test-results\pytest\test-results.xml
after_test:
- ps: |-

10
tests/CMakeLists.txt
View File

@ -66,6 +66,9 @@ else ()
target_link_libraries(test_kem PRIVATE ${API_TEST_DEPS})
endif()
add_executable(test_kem_mem test_kem_mem.c)
target_link_libraries(test_kem_mem PRIVATE ${API_TEST_DEPS})
add_executable(speed_kem speed_kem.c)
target_link_libraries(speed_kem PRIVATE ${API_TEST_DEPS})
@ -83,6 +86,9 @@ else ()
target_link_libraries(test_sig PRIVATE ${API_TEST_DEPS})
endif()
add_executable(test_sig_mem test_sig_mem.c)
target_link_libraries(test_sig_mem PRIVATE ${API_TEST_DEPS})
add_executable(speed_sig speed_sig.c)
target_link_libraries(speed_sig PRIVATE ${API_TEST_DEPS})
@ -95,7 +101,7 @@ add_definitions(-DOQS_COMPILE_OPTIONS="[${OQS_COMPILE_OPTIONS}]")
# for DLL builds.
add_custom_target(
run_tests
COMMAND ${PYTHON3_EXEC} -m pytest --verbose --numprocesses=auto
COMMAND mkdir -p tmp && ${PYTHON3_EXEC} -m pytest --verbose --numprocesses=auto
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
DEPENDS oqs example_kem kat_kem test_kem example_sig kat_sig test_sig ${UNIX_TESTS}
DEPENDS oqs example_kem kat_kem test_kem example_sig kat_sig test_sig test_sig_mem test_kem_mem ${UNIX_TESTS}
USES_TERMINAL)

219
tests/test_kem_mem.c Normal file
View File

@ -0,0 +1,219 @@
// SPDX-License-Identifier: MIT
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <oqs/oqs.h>
#include "system_info.c"
#include "tmp_store.c"
/* Displays hexadecimal strings */
static void OQS_print_hex_string(const char *label, const uint8_t *str, size_t len) {
printf("%-20s (%4zu bytes): ", label, len);
for (size_t i = 0; i < (len); i++) {
printf("%02X", str[i]);
}
printf("\n");
}
typedef struct magic_s {
uint8_t val[32];
} magic_t;
typedef enum kem_ops {
KEM_KEYGEN = 0,
KEM_ENCAPS = 1,
KEM_DECAPS = 2
} KEM_OPS;
static OQS_STATUS kem_test_correctness(const char *method_name, KEM_OPS op) {
OQS_KEM *kem = NULL;
uint8_t *public_key = NULL;
uint8_t *secret_key = NULL;
uint8_t *ciphertext = NULL;
uint8_t *shared_secret_e = NULL;
uint8_t *shared_secret_d = NULL;
OQS_STATUS rc, ret = OQS_ERROR;
int rv;
size_t retlen;
kem = OQS_KEM_new(method_name);
if (kem == NULL) {
fprintf(stderr, "ERROR: OQS_KEM_new failed\n");
goto err;
}
switch (op) {
case KEM_KEYGEN:
printf("================================================================================\n");
printf("Executing keygen for KEM %s\n", kem->method_name);
printf("================================================================================\n");
public_key = malloc(kem->length_public_key);
secret_key = malloc(kem->length_secret_key);
if ((public_key == NULL) || (secret_key == NULL)) {
fprintf(stderr, "ERROR: malloc failed\n");
goto err;
}
rc = OQS_KEM_keypair(kem, public_key, secret_key);
if (rc != OQS_SUCCESS) {
fprintf(stderr, "ERROR: OQS_KEM_keypair failed\n");
goto err;
}
if (oqs_fstore("pk", method_name, public_key, kem->length_public_key) != OQS_SUCCESS) {
goto err;
}
if (oqs_fstore("sk", method_name, secret_key, kem->length_secret_key) != OQS_SUCCESS) {
goto err;
}
ret = OQS_SUCCESS;
goto cleanup;
case KEM_ENCAPS:
printf("================================================================================\n");
printf("Executing encaps for KEM %s\n", kem->method_name);
printf("================================================================================\n");
public_key = malloc(kem->length_public_key);
secret_key = malloc(kem->length_secret_key);
ciphertext = malloc(kem->length_ciphertext);
shared_secret_e = malloc(kem->length_shared_secret);
if ((public_key == NULL) || (secret_key == NULL) || (ciphertext == NULL) || (shared_secret_e == NULL)) {
fprintf(stderr, "ERROR: malloc failed\n");
goto err;
}
if (oqs_fload("pk", method_name, public_key, kem->length_public_key, &retlen) != OQS_SUCCESS) {
goto err;
}
if (oqs_fload("sk", method_name, secret_key, kem->length_secret_key, &retlen) != OQS_SUCCESS) {
goto err;
}
rc = OQS_KEM_encaps(kem, ciphertext, shared_secret_e, public_key);
if (rc != OQS_SUCCESS) {
fprintf(stderr, "ERROR: OQS_KEM_encaps failed\n");
goto err;
}
if (oqs_fstore("ct", method_name, ciphertext, kem->length_ciphertext) != OQS_SUCCESS) {
goto err;
}
if (oqs_fstore("se", method_name, shared_secret_e, kem->length_shared_secret) != OQS_SUCCESS) {
goto err;
}
ret = OQS_SUCCESS;
goto cleanup;
case KEM_DECAPS:
printf("================================================================================\n");
printf("Executing decaps for KEM %s\n", kem->method_name);
printf("================================================================================\n");
public_key = malloc(kem->length_public_key);
secret_key = malloc(kem->length_secret_key);
ciphertext = malloc(kem->length_ciphertext);
shared_secret_e = malloc(kem->length_shared_secret);
shared_secret_d = malloc(kem->length_shared_secret);
if ((public_key == NULL) || (secret_key == NULL) || (ciphertext == NULL) || (shared_secret_e == NULL) || (shared_secret_d == NULL)) {
fprintf(stderr, "ERROR: malloc failed\n");
goto err;
}
if (oqs_fload("pk", method_name, public_key, kem->length_public_key, &retlen) != OQS_SUCCESS) {
goto err;
}
if (oqs_fload("sk", method_name, secret_key, kem->length_secret_key, &retlen) != OQS_SUCCESS) {
goto err;
}
if (oqs_fload("ct", method_name, ciphertext, kem->length_ciphertext, &retlen) != OQS_SUCCESS) {
goto err;
}
if (oqs_fload("se", method_name, shared_secret_e, kem->length_shared_secret, &retlen) != OQS_SUCCESS) {
goto err;
}
rc = OQS_KEM_decaps(kem, shared_secret_d, ciphertext, secret_key);
if (rc != OQS_SUCCESS) {
fprintf(stderr, "ERROR: OQS_KEM_decaps failed\n");
goto err;
}
rv = memcmp(shared_secret_e, shared_secret_d, kem->length_shared_secret);
if (rv != 0) {
fprintf(stderr, "ERROR: shared secrets are not equal\n");
OQS_print_hex_string("shared_secret_e", shared_secret_e, kem->length_shared_secret);
OQS_print_hex_string("shared_secret_d", shared_secret_d, kem->length_shared_secret);
goto err;
} else {
printf("shared secrets are equal\n");
}
ret = OQS_SUCCESS;
goto cleanup;
default:
fprintf(stderr, "Incorrect operation requested. Aborting.\n");
goto err;
}
err:
ret = OQS_ERROR;
cleanup:
if (kem != NULL) {
OQS_MEM_secure_free(secret_key, kem->length_secret_key);
OQS_MEM_secure_free(shared_secret_e, kem->length_shared_secret);
OQS_MEM_secure_free(shared_secret_d, kem->length_shared_secret);
}
if (public_key) {
OQS_MEM_insecure_free(public_key);
}
if (ciphertext) {
OQS_MEM_insecure_free(ciphertext);
}
OQS_KEM_free(kem);
return ret;
}
int main(int argc, char **argv) {
if (argc != 3) {
fprintf(stderr, "Usage: test_kem_mem algname operation (0,1,2)\n");
fprintf(stderr, " algname: ");
for (size_t i = 0; i < OQS_KEM_algs_length; i++) {
if (i > 0) {
fprintf(stderr, ", ");
}
fprintf(stderr, "%s", OQS_KEM_alg_identifier(i));
}
fprintf(stderr, "\n");
return EXIT_FAILURE;
}
print_system_info();
char *alg_name = argv[1];
if (!OQS_KEM_alg_is_enabled(alg_name)) {
printf("KEM algorithm %s not enabled!\n", alg_name);
return EXIT_FAILURE;
}
// Use system RNG in this program
OQS_randombytes_switch_algorithm(OQS_RAND_alg_system);
OQS_STATUS rc;
rc = kem_test_correctness(alg_name, (unsigned int)atoi(argv[2]));
if (rc != OQS_SUCCESS) {
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}

28
tests/test_mem.py Normal file
View File

@ -0,0 +1,28 @@
# SPDX-License-Identifier: MIT
import helpers
import os
import os.path
import pytest
import platform
from hashlib import sha256
@helpers.filtered_test
@pytest.mark.parametrize('kem_name', helpers.available_kems_by_name())
def test_kem(kem_name):
kats = helpers.get_kats("kem")
if not(helpers.is_kem_enabled_by_name(kem_name)): pytest.skip('Not enabled')
for i in range(3):
helpers.run_subprocess([helpers.path_to_executable('test_kem_mem'), kem_name, str(i)])
@helpers.filtered_test
@pytest.mark.parametrize('sig_name', helpers.available_sigs_by_name())
def test_sig(sig_name):
if not(helpers.is_sig_enabled_by_name(sig_name)): pytest.skip('Not enabled')
for i in range(3):
helpers.run_subprocess([helpers.path_to_executable('test_sig_mem'), sig_name, str(i)])
if __name__ == "__main__":
import sys
pytest.main(sys.argv)

197
tests/test_sig_mem.c Normal file
View File

@ -0,0 +1,197 @@
// SPDX-License-Identifier: MIT
#if defined(_WIN32)
#pragma warning(disable : 4244 4293)
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <oqs/oqs.h>
#include "system_info.c"
#include "tmp_store.c"
typedef enum sig_ops {
SIG_KEYGEN = 0,
SIG_SIGN = 1,
SIG_VERIFY = 2
} SIG_OPS;
static OQS_STATUS sig_test_correctness(const char *method_name, SIG_OPS op) {
OQS_SIG *sig = NULL;
uint8_t *public_key = NULL;
uint8_t *secret_key = NULL;
uint8_t *message = NULL;
size_t message_len = 100;
uint8_t *signature = NULL;
size_t signature_len;
OQS_STATUS rc, ret = OQS_ERROR;
sig = OQS_SIG_new(method_name);
if (sig == NULL) {
fprintf(stderr, "ERROR: OQS_SIG_new failed\n");
goto err;
}
switch (op) {
case SIG_KEYGEN:
printf("================================================================================\n");
printf("Executing keygen for SIGALG %s\n", sig->method_name);
printf("================================================================================\n");
public_key = malloc(sig->length_public_key);
secret_key = malloc(sig->length_secret_key);
if ((public_key == NULL) || (secret_key == NULL)) {
fprintf(stderr, "ERROR: malloc failed\n");
goto err;
}
rc = OQS_SIG_keypair(sig, public_key, secret_key);
if (rc != OQS_SUCCESS) {
fprintf(stderr, "ERROR: OQS_SIG_keypair failed\n");
goto err;
}
if (oqs_fstore("pk", method_name, public_key, sig->length_public_key) != OQS_SUCCESS) {
goto err;
}
if (oqs_fstore("sk", method_name, secret_key, sig->length_secret_key) != OQS_SUCCESS) {
goto err;
}
ret = OQS_SUCCESS;
goto cleanup;
case SIG_SIGN:
printf("================================================================================\n");
printf("Executing sign for SIGALG %s\n", sig->method_name);
printf("================================================================================\n");
public_key = malloc(sig->length_public_key);
secret_key = malloc(sig->length_secret_key);
message = malloc(message_len);
signature = malloc(sig->length_signature);
if ((public_key == NULL) || (secret_key == NULL) || (message == NULL) || (signature == NULL)) {
fprintf(stderr, "ERROR: malloc failed\n");
goto err;
}
if (oqs_fload("pk", method_name, public_key, sig->length_public_key, &signature_len) != OQS_SUCCESS) {
goto err;
}
if (oqs_fload("sk", method_name, secret_key, sig->length_secret_key, &signature_len) != OQS_SUCCESS) {
goto err;
}
OQS_randombytes(message, message_len);
rc = OQS_SIG_sign(sig, signature, &signature_len, message, message_len, secret_key);
if (rc != OQS_SUCCESS) {
fprintf(stderr, "ERROR: OQS_SIG_sign failed\n");
goto err;
}
if (oqs_fstore("ct", method_name, message, message_len) != OQS_SUCCESS) {
goto err;
}
if (oqs_fstore("se", method_name, signature, signature_len) != OQS_SUCCESS) {
goto err;
}
ret = OQS_SUCCESS;
goto cleanup;
case SIG_VERIFY:
printf("================================================================================\n");
printf("Executing verify for SIGALG %s\n", sig->method_name);
printf("================================================================================\n");
public_key = malloc(sig->length_public_key);
secret_key = malloc(sig->length_secret_key);
message = malloc(message_len);
signature = malloc(sig->length_signature);
if ((public_key == NULL) || (secret_key == NULL) || (message == NULL) || (signature == NULL)) {
fprintf(stderr, "ERROR: malloc failed\n");
goto err;
}
if (oqs_fload("pk", method_name, public_key, sig->length_public_key, &signature_len) != OQS_SUCCESS) {
goto err;
}
if (oqs_fload("sk", method_name, secret_key, sig->length_secret_key, &signature_len) != OQS_SUCCESS) {
goto err;
}
if (oqs_fload("ct", method_name, message, message_len, &signature_len) != OQS_SUCCESS) {
goto err;
}
if (oqs_fload("se", method_name, signature, sig->length_signature, &signature_len) != OQS_SUCCESS) {
goto err;
}
rc = OQS_SIG_verify(sig, message, message_len, signature, signature_len, public_key);
if (rc != OQS_SUCCESS) {
fprintf(stderr, "ERROR: OQS_SIG_verify failed\n");
goto err;
}
printf("verification passes as expected\n");
ret = OQS_SUCCESS;
goto cleanup;
default:
fprintf(stderr, "Incorrect operation requested. Aborting.\n");
goto err;
}
err:
ret = OQS_ERROR;
cleanup:
if (public_key) {
OQS_MEM_insecure_free(public_key);
}
if (message) {
OQS_MEM_insecure_free(message);
}
if (signature) {
OQS_MEM_insecure_free(signature);
}
if (sig != NULL) {
OQS_MEM_secure_free(secret_key, sig->length_secret_key);
OQS_SIG_free(sig);
}
return ret;
}
int main(int argc, char **argv) {
if (argc != 3) {
fprintf(stderr, "Usage: test_sig algname operation (0,1,2)\n");
fprintf(stderr, " algname: ");
for (size_t i = 0; i < OQS_SIG_algs_length; i++) {
if (i > 0) {
fprintf(stderr, ", ");
}
fprintf(stderr, "%s", OQS_SIG_alg_identifier(i));
}
fprintf(stderr, "\n");
return EXIT_FAILURE;
}
print_system_info();
char *alg_name = argv[1];
if (!OQS_SIG_alg_is_enabled(alg_name)) {
printf("Signature algorithm %s not enabled!\n", alg_name);
return EXIT_FAILURE;
}
// Use system RNG in this program
OQS_randombytes_switch_algorithm(OQS_RAND_alg_system);
OQS_STATUS rc = sig_test_correctness(alg_name, (unsigned int)atoi(argv[2]));
if (rc != OQS_SUCCESS) {
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}

48
tests/tmp_store.c Normal file
View File

@ -0,0 +1,48 @@
// SPDX-License-Identifier: MIT
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#define STORE_PREFIX "tmp/oqs-temp-file-"
#define MAXPATHLEN 128
static OQS_STATUS oqs_fstore(const char *fname, const char *mname, uint8_t *data, size_t len) {
char fpath[MAXPATHLEN];
strcpy(fpath, STORE_PREFIX);
strcat(fpath, mname);
FILE *fp = fopen(strcat(fpath, fname), "wb");
if (!fp) {
fprintf(stderr, "Couldn't open %s for writing.\n", fpath);
return OQS_ERROR;
}
fwrite(data, len, 1, fp);
fclose(fp);
return OQS_SUCCESS;
}
static OQS_STATUS oqs_fload(const char *fname, const char *mname, uint8_t *data, size_t len, size_t *rcvd) {
size_t len_read = 0, r = 0;
uint8_t *dr = NULL;
char fpath[MAXPATHLEN];
strcpy(fpath, STORE_PREFIX);
strcat(fpath, mname);
FILE *fp = fopen(strcat(fpath, fname), "rb");
if (!fp) {
fprintf(stderr, "Couldn't open %s for reading.\n", fpath);
return OQS_ERROR;
}
do { // assume some OSs don't deliver all data in one go...
dr = (uint8_t *)(data + len_read);
r = fread(dr, 1, len - len_read, fp);
len_read += r;
} while (r > 0);
*rcvd = len_read;
if (len_read <= 0) {
fprintf(stderr, "Error reading data (operations called in proper sequence?). Expecting %zu. Exiting.\n", len);
return OQS_ERROR;
}
fclose(fp);
return OQS_SUCCESS;
}