From ada5acad138cc4cd41039947fd9bb6b2a4a1bf7b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 09:57:04 -0700 Subject: [PATCH 001/104] F-4262 - Reject negative stored array lengths when loading token objects --- src/internal.c | 6 + tests/include.am | 7 + tests/object_store_decode_test.c | 436 +++++++++++++++++++++++++++++++ 3 files changed, 449 insertions(+) create mode 100644 tests/object_store_decode_test.c diff --git a/src/internal.c b/src/internal.c index 7c61a3f6..db6e1ad0 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2462,6 +2462,7 @@ static int wp11_storage_write_array(void* storage, * @param [in] len Length of data to read. * @return 0 on success. * @return BUFFER_E to indicate failure. + * @return ASN_PARSE_E when the stored length is negative. * @return MEMORY_E when dynamic memory allocation fails. */ static int wp11_storage_read_alloc_array(void* storage, @@ -2471,6 +2472,11 @@ static int wp11_storage_read_alloc_array(void* storage, /* Read length of array. */ ret = wp11_storage_read_int(storage, len); + if (ret == 0 && *len < 0) { + *len = 0; + /* Not BUFFER_E, which callers accept as an older record's end. */ + ret = ASN_PARSE_E; + } if (ret == 0 && *len > 0) { /* Allocate buffer to hold data. */ *buffer = (unsigned char*)XMALLOC(*len, NULL, DYNAMIC_TYPE_TMP_BUFFER); diff --git a/tests/include.am b/tests/include.am index 584136e7..ed95d9e3 100644 --- a/tests/include.am +++ b/tests/include.am @@ -320,6 +320,11 @@ noinst_PROGRAMS += tests/login_pin_state_test tests_login_pin_state_test_SOURCES = tests/login_pin_state_test.c tests_login_pin_state_test_LDADD = +check_PROGRAMS += tests/object_store_decode_test +noinst_PROGRAMS += tests/object_store_decode_test +tests_object_store_decode_test_SOURCES = tests/object_store_decode_test.c +tests_object_store_decode_test_LDADD = + if BUILD_STATIC tests_pkcs11test_LDADD += src/libwolfpkcs11.la tests_pkcs11mtt_LDADD += src/libwolfpkcs11.la @@ -385,6 +390,7 @@ tests_set_pin_rekey_test_LDADD += src/libwolfpkcs11.la tests_nss_configdir_prefix_test_LDADD += src/libwolfpkcs11.la tests_logout_retire_test_LDADD += src/libwolfpkcs11.la tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la +tests_object_store_decode_test_LDADD += src/libwolfpkcs11.la else tests_object_id_uniqueness_test_LDADD += src/libwolfpkcs11.la tests_empty_pin_store_test_LDADD += src/libwolfpkcs11.la @@ -442,6 +448,7 @@ tests_set_pin_rekey_test_LDADD += src/libwolfpkcs11.la tests_nss_configdir_prefix_test_LDADD += src/libwolfpkcs11.la tests_logout_retire_test_LDADD += src/libwolfpkcs11.la tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la +tests_object_store_decode_test_LDADD += src/libwolfpkcs11.la endif EXTRA_DIST += tests/unit.h \ diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c new file mode 100644 index 00000000..b240c46f --- /dev/null +++ b/tests/object_store_decode_test.c @@ -0,0 +1,436 @@ +/* object_store_decode_test.c + * + * Copyright (C) 2026 wolfSSL Inc. + * + * This file is part of wolfPKCS11. + * + * wolfPKCS11 is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfPKCS11 is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA + * + * Stored token objects whose recorded lengths do not describe valid data must + * be rejected cleanly when the token is loaded or logged into. Each reload runs + * in a child process so a failure is reported instead of ending the test. + */ + +#ifdef HAVE_CONFIG_H + #include +#endif + +#include +#include +#include + +#ifndef WOLFSSL_USER_SETTINGS + #include +#endif +#include +#include + +#ifndef WOLFPKCS11_USER_SETTINGS + #include +#endif +#include + +#ifndef HAVE_PKCS11_STATIC + #include +#endif + +#include "testdata.h" +#include "pkcs11_test_util.h" + +#if !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_TPM_STORE) && \ + !defined(WOLFPKCS11_CUSTOM_STORE) && !defined(WOLFPKCS11_NO_ENV) && \ + !defined(_WIN32) + +#include +#include +#include + +#define TEST_DIR "./store/object_store_decode_test" +#define MAX_OBJ_ID 8 +#define MAX_FILE_SZ 16384 + +/* Offset of the first variable-length attribute in a stored object record. */ +#define OBJ_ID_LEN_OFF (12 + 3 * sizeof(CK_ULONG) + 1 + 1 + 4 + 4 + 8 + 8) +#define OBJ_LABEL_LEN_OFF (OBJ_ID_LEN_OFF + 4) +#define OBJ_ISSUER_LEN_OFF (OBJ_LABEL_LEN_OFF + 4) + +#define CHILD_PASS 0 +#define CHILD_FAIL 1 +#define CHILD_SETUP 2 + +static byte soPin[] = "password123456"; +static byte userPin[] = "wolfpkcs11-test"; +static CK_BBOOL ckTrue = CK_TRUE; +static CK_BBOOL ckFalse = CK_FALSE; + +static const char* storeKinds[] = { + "obj", "data", "symmkey", "rsakey_priv", "rsakey_pub", "ecckey_priv", + "ecckey_pub", "dhkey_priv", "dhkey_pub", "cert", "trust" +}; + +static void store_path(char* path, size_t sz, const char* kind, int objId) +{ + if (objId < 0) { + (void)snprintf(path, sz, "%s/wp11_%s_%016lx", TEST_DIR, kind, 1UL); + } + else { + (void)snprintf(path, sz, "%s/wp11_%s_%016lx_%016lx", TEST_DIR, kind, + 1UL, (unsigned long)objId); + } +} + +static void cleanup_test_files(void) +{ + char path[256]; + size_t k; + int i; + + for (k = 0; k < sizeof(storeKinds) / sizeof(*storeKinds); k++) { + for (i = 0; i < MAX_OBJ_ID; i++) { + store_path(path, sizeof(path), storeKinds[k], i); + (void)remove(path); + } + } + store_path(path, sizeof(path), "token", -1); + (void)remove(path); +} + +/* Locate the stored file of the given kind for the single object of that kind. */ +static int find_store_file(const char* kind, char* path, size_t sz) +{ + FILE* f; + int i; + + for (i = 0; i < MAX_OBJ_ID; i++) { + store_path(path, sz, kind, i); + f = fopen(path, "rb"); + if (f != NULL) { + fclose(f); + return 0; + } + } + return -1; +} + +static int read_file(const char* path, byte* data, size_t sz, size_t* readSz) +{ + FILE* f = fopen(path, "rb"); + + if (f == NULL) + return -1; + *readSz = fread(data, 1, sz, f); + if (ferror(f) || !feof(f)) { + fclose(f); + return -1; + } + fclose(f); + return 0; +} + +static int write_file(const char* path, const byte* data, size_t sz) +{ + FILE* f = fopen(path, "wb"); + size_t written; + + if (f == NULL) + return -1; + written = fwrite(data, 1, sz, f); + if (fclose(f) != 0 || written != sz) + return -1; + return 0; +} + +static word32 get_be32(const byte* p) +{ + return ((word32)p[0] << 24) | ((word32)p[1] << 16) | + ((word32)p[2] << 8) | (word32)p[3]; +} + +static void put_be32(byte* p, word32 v) +{ + p[0] = (byte)(v >> 24); + p[1] = (byte)(v >> 16); + p[2] = (byte)(v >> 8); + p[3] = (byte)v; +} + +/* Overwrite a 4-byte length field that is expected to hold 'expect'. */ +static int patch_length(const char* path, size_t off, word32 expect, + word32 value) +{ + static byte data[MAX_FILE_SZ]; + size_t sz = 0; + + if (read_file(path, data, sizeof(data), &sz) != 0 || sz < off + 4) + return -1; + if (get_be32(data + off) != expect) + return -1; + put_be32(data + off, value); + return write_file(path, data, sz); +} + +static CK_RV init_slot(CK_SLOT_ID* slot) +{ + CK_RV rv; + CK_C_INITIALIZE_ARGS args; + CK_SLOT_ID slots[16]; + CK_ULONG count = sizeof(slots) / sizeof(*slots); + + XMEMSET(&args, 0, sizeof(args)); + args.flags = CKF_OS_LOCKING_OK; + rv = funcList->C_Initialize(&args); + if (rv == CKR_OK) + rv = funcList->C_GetSlotList(CK_TRUE, slots, &count); + if (rv == CKR_OK && count == 0) + rv = CKR_TOKEN_NOT_PRESENT; + if (rv == CKR_OK) + *slot = slots[0]; + return rv; +} + +static CK_RV provision_token(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_UTF8CHAR label[32]; + CK_FLAGS flags = CKF_SERIAL_SESSION | CKF_RW_SESSION; + + XMEMSET(label, ' ', sizeof(label)); + XMEMCPY(label, "wolfpkcs11", 10); + rv = funcList->C_InitToken(slot, soPin, sizeof(soPin) - 1, label); + if (rv == CKR_OK) + rv = funcList->C_OpenSession(slot, flags, NULL, NULL, &session); + if (rv == CKR_OK) + rv = funcList->C_Login(session, CKU_SO, soPin, sizeof(soPin) - 1); + if (rv == CKR_OK) + rv = funcList->C_InitPIN(session, userPin, sizeof(userPin) - 1); + if (session != CK_INVALID_HANDLE) { + (void)funcList->C_Logout(session); + (void)funcList->C_CloseSession(session); + } + return rv; +} + +static CK_RV open_session(CK_SLOT_ID slot, int login, + CK_SESSION_HANDLE* session) +{ + CK_RV rv; + CK_FLAGS flags = CKF_SERIAL_SESSION | CKF_RW_SESSION; + + rv = funcList->C_OpenSession(slot, flags, NULL, NULL, session); + if (rv == CKR_OK && login) { + rv = funcList->C_Login(*session, CKU_USER, userPin, + sizeof(userPin) - 1); + } + return rv; +} + +typedef CK_RV (*create_fn)(CK_SESSION_HANDLE session); + +/* Provision a fresh token, create objects with 'create' and persist them. */ +static CK_RV store_objects(create_fn create) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + + cleanup_test_files(); + rv = pkcs11_load(); + if (rv != CKR_OK) + return rv; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = provision_token(slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = create(session); + if (session != CK_INVALID_HANDLE) + (void)funcList->C_CloseSession(session); + (void)funcList->C_Finalize(NULL); + pkcs11_unload(); + return rv; +} + +typedef int (*child_fn)(void); + +/* Run fn in a child process. Returns CHILD_PASS only when it exits normally + * reporting that the invariant held. */ +static int run_in_child(child_fn fn) +{ + pid_t pid; + int status = 0; + + fflush(stdout); + fflush(stderr); + pid = fork(); + if (pid < 0) + return CHILD_SETUP; + if (pid == 0) { + int res = fn(); + fflush(stdout); + fflush(stderr); + _exit(res); + } + if (waitpid(pid, &status, 0) != pid) + return CHILD_SETUP; + if (WIFSIGNALED(status)) { + fprintf(stderr, " reload terminated by signal %d\n", + WTERMSIG(status)); + return CHILD_FAIL; + } + if (!WIFEXITED(status)) + return CHILD_FAIL; + return WEXITSTATUS(status); +} + +static CK_RV create_data_object(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + static byte app[] = "wolfpkcs11"; + static byte value[] = "stored data object value"; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_APPLICATION, app, sizeof(app) - 1 }, + { CKA_VALUE, value, sizeof(value) - 1 }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} + +/* Either the token refuses to load or the data object reports a real label + * length. */ +static int child_data_label_length(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ULONG count = 0; + CK_ATTRIBUTE findTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + }; + CK_ATTRIBUTE label = { CKA_LABEL, NULL, 0 }; + int res = CHILD_SETUP; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv != CKR_OK) + return CHILD_PASS; + + rv = open_session(slot, 0, &session); + if (rv == CKR_OK) + rv = funcList->C_FindObjectsInit(session, findTmpl, 1); + if (rv == CKR_OK) + rv = funcList->C_FindObjects(session, &obj, 1, &count); + if (rv == CKR_OK) + rv = funcList->C_FindObjectsFinal(session); + if (rv == CKR_OK && count == 1) + rv = funcList->C_GetAttributeValue(session, obj, &label, 1); + if (rv == CKR_OK && count == 1) { + res = (label.ulValueLen == CK_UNAVAILABLE_INFORMATION || + label.ulValueLen > 64) ? CHILD_FAIL : CHILD_PASS; + if (res != CHILD_PASS) { + fprintf(stderr, " loaded label length 0x%lx\n", + (unsigned long)label.ulValueLen); + } + } + (void)funcList->C_Finalize(NULL); + return res; +} + +/* A negative length must not pass as the end of an older record format. */ +static int child_token_not_loaded(void) +{ + CK_SLOT_ID slot = 0; + int res; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + res = (init_slot(&slot) != CKR_OK) ? CHILD_PASS : CHILD_FAIL; + (void)funcList->C_Finalize(NULL); + return res; +} + +static void test_negative_optional_length(void) +{ + CK_RV rv; + char path[256]; + int res = CHILD_SETUP; + + printf("\n--- stored issuer length must not be negative ---\n"); + rv = store_objects(create_data_object); + CHECK_RV(rv, "store data object", CKR_OK); + if (rv != CKR_OK) + return; + if (find_store_file("obj", path, sizeof(path)) == 0 && + patch_length(path, OBJ_ISSUER_LEN_OFF, 0, 0xFFFFFFFFUL) == 0) { + res = run_in_child(child_token_not_loaded); + } + CHECK_TRUE(res == CHILD_PASS, + "negative stored issuer length is not loaded"); + cleanup_test_files(); +} + +static void test_negative_attribute_length(void) +{ + CK_RV rv; + char path[256]; + int res = CHILD_SETUP; + + printf("\n--- stored attribute length must not be negative ---\n"); + rv = store_objects(create_data_object); + CHECK_RV(rv, "store data object", CKR_OK); + if (rv != CKR_OK) + return; + if (find_store_file("obj", path, sizeof(path)) == 0 && + patch_length(path, OBJ_LABEL_LEN_OFF, 0, 0xFFFFFFFFUL) == 0) { + res = run_in_child(child_data_label_length); + } + CHECK_TRUE(res == CHILD_PASS, + "negative stored attribute length is not loaded"); + cleanup_test_files(); +} + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + XSETENV("WOLFPKCS11_TOKEN_PATH", TEST_DIR, 1); + + printf("=== wolfPKCS11 stored object decode test ===\n"); + test_negative_optional_length(); + test_negative_attribute_length(); + + return pkcs11_test_summary(); +} + +#else + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + printf("File-backed token storage not available, skipping test\n"); + return 77; +} + +#endif From 8437bbfc1dff4c515979224f402085b3457005ac Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:16:19 -0700 Subject: [PATCH 002/104] F-5078 - Grow stored array buffers only as data is read --- src/internal.c | 118 +++++++++++++++-- tests/object_store_decode_test.c | 219 +++++++++++++++++++++++++++++++ 2 files changed, 327 insertions(+), 10 deletions(-) diff --git a/src/internal.c b/src/internal.c index db6e1ad0..1461aedf 100644 --- a/src/internal.c +++ b/src/internal.c @@ -147,6 +147,11 @@ #define WP11_MAX_CERT_SZ 4096 #endif +/* Initial allocation when reading a variable-length array from storage. */ +#ifndef WP11_STORE_READ_CHUNK_SZ +#define WP11_STORE_READ_CHUNK_SZ 4096 +#endif + #define PKCS11_CHECK_VALUE_SIZE 3 /* Sizes for storage. */ @@ -1979,6 +1984,36 @@ int wolfPKCS11_Store_Read(void* store, unsigned char* buffer, int len) return ret; } +#ifndef WOLFPKCS11_TPM_STORE +/** + * Get the number of bytes left to read from a store file. + * + * @param [in] store Context for operation. + * @param [out] left Number of bytes after the read position. + * @return 0 on success. + * @return BUFFER_E when the position cannot be worked out or restored. + */ +static int wolfPKCS11_Store_Left(void* store, long* left) +{ + WP11_FileStoreCtx* ctx = (WP11_FileStoreCtx*)store; + long pos = -1; + long end = -1; + + /* stdio directly: the file store's handles are FILE* (see fdopen()). */ + if (ctx != NULL && ctx->file != XBADFILE && ctx->file != NULL) { + pos = ftell(ctx->file); + if (pos >= 0 && fseek(ctx->file, 0, SEEK_END) == 0) + end = ftell(ctx->file); + if (pos >= 0 && fseek(ctx->file, pos, SEEK_SET) != 0) + end = -1; + } + if (pos < 0 || end < pos) + return BUFFER_E; + *left = end - pos; + return 0; +} +#endif + /** * Writes a specific number of bytes from buffer. * @@ -2080,6 +2115,26 @@ static void wp11_storage_close(void* storage) wolfPKCS11_Store_Close(storage); } +/** + * Get the number of bytes left to read, when the store can tell. + * + * @param [in] storage Context for operation. + * @param [out] left Number of bytes left to read. + * @return 0 on success. + * @return NOT_AVAILABLE_E when the store cannot tell. + * @return Other value on failure. + */ +static int wp11_storage_left(void* storage, long* left) +{ +#if !defined(WOLFPKCS11_CUSTOM_STORE) && !defined(WOLFPKCS11_TPM_STORE) + return wolfPKCS11_Store_Left(storage, left); +#else + (void)storage; + (void)left; + return NOT_AVAILABLE_E; +#endif +} + /** * Reads a specific number of bytes into buffer. * @@ -2469,6 +2524,13 @@ static int wp11_storage_read_alloc_array(void* storage, unsigned char** buffer, int* len) { int ret; + int have = 0; + int bufSz = 0; + int newSz; + int first = WP11_STORE_READ_CHUNK_SZ; + long left = 0; + unsigned char* buf = NULL; + unsigned char* tmp; /* Read length of array. */ ret = wp11_storage_read_int(storage, len); @@ -2478,21 +2540,57 @@ static int wp11_storage_read_alloc_array(void* storage, ret = ASN_PARSE_E; } if (ret == 0 && *len > 0) { - /* Allocate buffer to hold data. */ - *buffer = (unsigned char*)XMALLOC(*len, NULL, DYNAMIC_TYPE_TMP_BUFFER); - if (*buffer == NULL) - ret = MEMORY_E; + /* When the store knows its size, allocate once if the data is there. */ + ret = wp11_storage_left(storage, &left); + if (ret == 0 && (long)*len > left) + ret = BUFFER_E; + else if (ret == 0) + first = *len; + else if (ret == NOT_AVAILABLE_E) + ret = 0; + } + /* Otherwise grow the buffer only as stored data is read, so a corrupt + * length cannot drive an allocation larger than the data present. */ + while (ret == 0 && have < *len) { + if (bufSz == 0) + newSz = first; + else if (bufSz <= *len / 2) + newSz = bufSz * 2; + else + newSz = *len; + if (newSz > *len) + newSz = *len; - if (ret == 0) { - /* Read array data into allocated buffer. */ - ret = wp11_storage_read(storage, *buffer, *len); - if (ret != 0) { - XFREE(*buffer, NULL, DYNAMIC_TYPE_TMP_BUFFER); - *buffer = NULL; + tmp = (unsigned char*)XMALLOC(newSz, NULL, DYNAMIC_TYPE_TMP_BUFFER); + if (tmp == NULL) { + ret = MEMORY_E; + } + else { + if (buf != NULL) { + XMEMCPY(tmp, buf, have); + wc_ForceZero(buf, (word32)have); + XFREE(buf, NULL, DYNAMIC_TYPE_TMP_BUFFER); } + buf = tmp; + bufSz = newSz; + /* Read array data into the newly allocated space. */ + ret = wp11_storage_read(storage, buf + have, bufSz - have); + if (ret == 0) + have = bufSz; } } + if (ret != 0 && (buf != NULL || ret == MEMORY_E)) { + if (buf != NULL) { + wc_ForceZero(buf, (word32)bufSz); + XFREE(buf, NULL, DYNAMIC_TYPE_TMP_BUFFER); + } + *buffer = NULL; + } + else if (buf != NULL) { + *buffer = buf; + } + return ret; } diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c index b240c46f..e26332f6 100644 --- a/tests/object_store_decode_test.c +++ b/tests/object_store_decode_test.c @@ -36,6 +36,7 @@ #endif #include #include +#include #ifndef WOLFPKCS11_USER_SETTINGS #include @@ -80,6 +81,74 @@ static const char* storeKinds[] = { "ecckey_pub", "dhkey_priv", "dhkey_pub", "cert", "trust" }; +#if defined(USE_WOLFSSL_MEMORY) && !defined(WOLFSSL_STATIC_MEMORY) && \ + !defined(WOLFSSL_DEBUG_MEMORY) +#define HAVE_ALLOC_TRACKING +#define ALLOC_REFUSE_SZ ((size_t)64 * 1024 * 1024) + +#define TRACK_HDR_SZ 16 + +static size_t largestAlloc = 0; +/* Live bytes in blocks no larger than peakCap, and their peak. */ +static size_t peakCap = 0; +static size_t liveBytes = 0; +static size_t peakLive = 0; + +static void* track_malloc(size_t sz) +{ + unsigned char* p; + + if (sz > largestAlloc) + largestAlloc = sz; + if (sz >= ALLOC_REFUSE_SZ) + return NULL; + p = (unsigned char*)malloc(sz + TRACK_HDR_SZ); + if (p == NULL) + return NULL; + XMEMCPY(p, &sz, sizeof(sz)); + if (sz <= peakCap) { + liveBytes += sz; + if (liveBytes > peakLive) + peakLive = liveBytes; + } + return p + TRACK_HDR_SZ; +} + +static void track_free(void* ptr) +{ + unsigned char* p; + size_t sz; + + if (ptr == NULL) + return; + p = (unsigned char*)ptr - TRACK_HDR_SZ; + XMEMCPY(&sz, p, sizeof(sz)); + if (sz <= peakCap) + liveBytes -= sz; + free(p); +} + +static void* track_realloc(void* ptr, size_t sz) +{ + void* n; + size_t old; + + if (ptr == NULL) + return track_malloc(sz); + if (sz == 0) { + track_free(ptr); + return NULL; + } + n = track_malloc(sz); + if (n == NULL) + return NULL; + XMEMCPY(&old, (unsigned char*)ptr - TRACK_HDR_SZ, sizeof(old)); + XMEMCPY(n, ptr, (old < sz) ? old : sz); + track_free(ptr); + return n; +} +#endif + static void store_path(char* path, size_t sz, const char* kind, int objId) { if (objId < 0) { @@ -410,6 +479,149 @@ static void test_negative_attribute_length(void) cleanup_test_files(); } +#define LARGE_VALUE_SZ 300001 +static byte largeValue[LARGE_VALUE_SZ]; +static byte largeRead[LARGE_VALUE_SZ]; + +static CK_RV create_large_data_object(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_VALUE, largeValue, sizeof(largeValue) }, + }; + size_t i; + + for (i = 0; i < sizeof(largeValue); i++) + largeValue[i] = (byte)(i * 7 + (i >> 8)); + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} + +static void test_large_stored_value_round_trip(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ULONG count = 0; + CK_ATTRIBUTE findTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + }; + CK_ATTRIBUTE value = { CKA_VALUE, largeRead, sizeof(largeRead) }; + + printf("\n--- large stored value reloads intact ---\n"); + rv = store_objects(create_large_data_object); + CHECK_RV(rv, "store large data object", CKR_OK); + if (rv != CKR_OK) + return; + rv = pkcs11_load(); + if (rv == CKR_OK) { + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 0, &session); + if (rv == CKR_OK) + rv = funcList->C_FindObjectsInit(session, findTmpl, 1); + if (rv == CKR_OK) + rv = funcList->C_FindObjects(session, &obj, 1, &count); + if (rv == CKR_OK) + rv = funcList->C_FindObjectsFinal(session); + if (rv == CKR_OK && count != 1) + rv = CKR_GENERAL_ERROR; + if (rv == CKR_OK) + rv = funcList->C_GetAttributeValue(session, obj, &value, 1); + (void)funcList->C_Finalize(NULL); + pkcs11_unload(); + } + CHECK_RV(rv, "reload large data object", CKR_OK); + CHECK_TRUE(rv == CKR_OK && value.ulValueLen == sizeof(largeValue) && + XMEMCMP(largeRead, largeValue, sizeof(largeValue)) == 0, + "large stored value is unchanged after reload"); + cleanup_test_files(); +} + +#ifdef HAVE_ALLOC_TRACKING +/* Loading must not size an allocation from a length the data cannot back. */ +static int child_load_allocation_bound(void) +{ + CK_SLOT_ID slot = 0; + + if (wolfSSL_SetAllocators(track_malloc, track_free, track_realloc) != 0) + return CHILD_SETUP; + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + if (init_slot(&slot) == CKR_OK) + (void)funcList->C_Finalize(NULL); + if (largestAlloc >= ALLOC_REFUSE_SZ) { + fprintf(stderr, " largest allocation while loading: %lu\n", + (unsigned long)largestAlloc); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static void test_oversized_attribute_length(void) +{ + CK_RV rv; + char path[256]; + int res = CHILD_SETUP; + + printf("\n--- stored attribute length must be bounded ---\n"); + rv = store_objects(create_data_object); + CHECK_RV(rv, "store data object", CKR_OK); + if (rv != CKR_OK) + return; + if (find_store_file("obj", path, sizeof(path)) == 0 && + patch_length(path, OBJ_LABEL_LEN_OFF, 0, 0x7FFFFFF8UL) == 0) { + res = run_in_child(child_load_allocation_bound); + } + CHECK_TRUE(res == CHILD_PASS, + "oversized stored attribute length is not allocated"); + cleanup_test_files(); +} + +/* Loading a large stored value holds about one copy of it, not two. Larger + * blocks cannot be partial copies of it, so they are not counted. */ +static int child_large_value_peak(void) +{ + CK_SLOT_ID slot = 0; + + peakCap = LARGE_VALUE_SZ; + if (wolfSSL_SetAllocators(track_malloc, track_free, track_realloc) != 0) + return CHILD_SETUP; + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + if (init_slot(&slot) == CKR_OK) + (void)funcList->C_Finalize(NULL); + if (peakLive >= (size_t)LARGE_VALUE_SZ + LARGE_VALUE_SZ / 2) { + fprintf(stderr, " peak live bytes while loading: %lu\n", + (unsigned long)peakLive); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static void test_large_stored_value_peak(void) +{ + CK_RV rv; + int res; + + printf("\n--- large stored value loads without a second copy ---\n"); + rv = store_objects(create_large_data_object); + CHECK_RV(rv, "store large data object", CKR_OK); + if (rv != CKR_OK) + return; + res = run_in_child(child_large_value_peak); + CHECK_TRUE(res == CHILD_PASS, + "peak memory while loading stays near one copy"); + cleanup_test_files(); +} +#endif + int main(int argc, char* argv[]) { (void)argc; @@ -419,6 +631,13 @@ int main(int argc, char* argv[]) printf("=== wolfPKCS11 stored object decode test ===\n"); test_negative_optional_length(); test_negative_attribute_length(); +#ifdef HAVE_ALLOC_TRACKING + test_oversized_attribute_length(); +#endif + test_large_stored_value_round_trip(); +#ifdef HAVE_ALLOC_TRACKING + test_large_stored_value_peak(); +#endif return pkcs11_test_summary(); } From 8427035a6461d3fd3fb60d289848a67873c6b5bf Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:25:41 -0700 Subject: [PATCH 003/104] F-13814 - Set data object lengths only after a successful storage read --- src/internal.c | 11 +++-- tests/object_store_decode_test.c | 75 +++++++++++++++++++++++++++++++- 2 files changed, 80 insertions(+), 6 deletions(-) diff --git a/src/internal.c b/src/internal.c index 1461aedf..3a1a1e04 100644 --- a/src/internal.c +++ b/src/internal.c @@ -3596,7 +3596,7 @@ static int wp11_Object_Load_Data(WP11_Object* object, int tokenId, int objId) { int ret; void* storage = NULL; - int tempLen; + int tempLen = 0; /* Open access to data. */ ret = wp11_storage_open_readonly(WOLFPKCS11_STORE_DATA, tokenId, objId, @@ -3605,7 +3605,8 @@ static int wp11_Object_Load_Data(WP11_Object* object, int tokenId, int objId) ret = wp11_storage_read_alloc_array(storage, &object->data.genericData.data, &tempLen); - object->data.genericData.dataLen = (word32)tempLen; + if (ret == 0) + object->data.genericData.dataLen = (word32)tempLen; } /* Read application length and application. */ @@ -3613,7 +3614,8 @@ static int wp11_Object_Load_Data(WP11_Object* object, int tokenId, int objId) ret = wp11_storage_read_alloc_array(storage, &object->data.genericData.application, &tempLen); - object->data.genericData.applicationLen = (word32)tempLen; + if (ret == 0) + object->data.genericData.applicationLen = (word32)tempLen; } /* Read object ID length and object ID. */ @@ -3621,7 +3623,8 @@ static int wp11_Object_Load_Data(WP11_Object* object, int tokenId, int objId) ret = wp11_storage_read_alloc_array(storage, &object->data.genericData.objectId, &tempLen); - object->data.genericData.objectIdLen = (word32)tempLen; + if (ret == 0) + object->data.genericData.objectIdLen = (word32)tempLen; } wp11_storage_close(storage); diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c index e26332f6..d90771cc 100644 --- a/tests/object_store_decode_test.c +++ b/tests/object_store_decode_test.c @@ -75,6 +75,7 @@ static byte soPin[] = "password123456"; static byte userPin[] = "wolfpkcs11-test"; static CK_BBOOL ckTrue = CK_TRUE; static CK_BBOOL ckFalse = CK_FALSE; +static byte dataValue[] = "stored data object value"; static const char* storeKinds[] = { "obj", "data", "symmkey", "rsakey_priv", "rsakey_pub", "ecckey_priv", @@ -370,13 +371,12 @@ static CK_RV create_data_object(CK_SESSION_HANDLE session) CK_OBJECT_CLASS dataClass = CKO_DATA; CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; static byte app[] = "wolfpkcs11"; - static byte value[] = "stored data object value"; CK_ATTRIBUTE tmpl[] = { { CKA_CLASS, &dataClass, sizeof(dataClass) }, { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, { CKA_APPLICATION, app, sizeof(app) - 1 }, - { CKA_VALUE, value, sizeof(value) - 1 }, + { CKA_VALUE, dataValue, sizeof(dataValue) - 1 }, }; return funcList->C_CreateObject(session, tmpl, @@ -479,6 +479,76 @@ static void test_negative_attribute_length(void) cleanup_test_files(); } +static int truncate_file(const char* path, size_t keep) +{ + static byte data[MAX_FILE_SZ]; + size_t sz = 0; + + if (read_file(path, data, sizeof(data), &sz) != 0 || sz <= keep) + return -1; + return write_file(path, data, keep); +} + +/* Either the token refuses to load or the data object reads back its full + * stored value. */ +static int child_data_value_intact(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ULONG count = 0; + CK_ATTRIBUTE findTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + }; + byte value[64]; + CK_ATTRIBUTE attr = { CKA_VALUE, value, sizeof(value) }; + int res = CHILD_FAIL; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv != CKR_OK) + return CHILD_PASS; + + rv = open_session(slot, 0, &session); + if (rv == CKR_OK) + rv = funcList->C_FindObjectsInit(session, findTmpl, 1); + if (rv == CKR_OK) + rv = funcList->C_FindObjects(session, &obj, 1, &count); + if (rv == CKR_OK) + rv = funcList->C_FindObjectsFinal(session); + if (rv == CKR_OK && count == 1) + rv = funcList->C_GetAttributeValue(session, obj, &attr, 1); + if (rv == CKR_OK && count == 1 && + attr.ulValueLen == sizeof(dataValue) - 1 && + XMEMCMP(value, dataValue, sizeof(dataValue) - 1) == 0) { + res = CHILD_PASS; + } + (void)funcList->C_Finalize(NULL); + return res; +} + +static void test_truncated_data_record(void) +{ + CK_RV rv; + char path[256]; + int res = CHILD_SETUP; + + printf("\n--- truncated data object record is not loaded ---\n"); + rv = store_objects(create_data_object); + CHECK_RV(rv, "store data object", CKR_OK); + if (rv != CKR_OK) + return; + if (find_store_file("data", path, sizeof(path)) == 0 && + truncate_file(path, 2) == 0) { + res = run_in_child(child_data_value_intact); + } + CHECK_TRUE(res == CHILD_PASS, "truncated data object record is rejected"); + cleanup_test_files(); +} + #define LARGE_VALUE_SZ 300001 static byte largeValue[LARGE_VALUE_SZ]; static byte largeRead[LARGE_VALUE_SZ]; @@ -638,6 +708,7 @@ int main(int argc, char* argv[]) #ifdef HAVE_ALLOC_TRACKING test_large_stored_value_peak(); #endif + test_truncated_data_record(); return pkcs11_test_summary(); } From 651c6c8bb39e87769b8edecb1d48ec5bc618477f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:45:11 -0700 Subject: [PATCH 004/104] F-4264 - Reject stored private key records shorter than the tag --- src/internal.c | 44 ++++--- tests/object_store_decode_test.c | 189 ++++++++++++++++++++++++++++++- 2 files changed, 218 insertions(+), 15 deletions(-) diff --git a/src/internal.c b/src/internal.c index 3a1a1e04..77960a7b 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4230,11 +4230,14 @@ static int wp11_Object_Decode_RsaKey(WP11_Object* object) else #endif if (object->objClass == CKO_PRIVATE_KEY) { - unsigned char* der; + unsigned char* der = NULL; int len = object->keyDataLen - AES_BLOCK_SIZE; - der = (unsigned char*)XMALLOC(len, NULL, DYNAMIC_TYPE_TMP_BUFFER); - if (der == NULL) { + if (object->keyDataLen <= AES_BLOCK_SIZE) + ret = BAD_FUNC_ARG; + if (ret == 0) + der = (unsigned char*)XMALLOC(len, NULL, DYNAMIC_TYPE_TMP_BUFFER); + if (ret == 0 && der == NULL) { ret = MEMORY_E; } if (ret == 0) { @@ -4578,11 +4581,14 @@ static int wp11_Object_Decode_EccKey(WP11_Object* object) else #endif if (object->objClass == CKO_PRIVATE_KEY) { - unsigned char* der; + unsigned char* der = NULL; int len = object->keyDataLen - AES_BLOCK_SIZE; - der = (unsigned char*)XMALLOC(len, NULL, DYNAMIC_TYPE_TMP_BUFFER); - if (der == NULL) { + if (object->keyDataLen <= AES_BLOCK_SIZE) + ret = BAD_FUNC_ARG; + if (ret == 0) + der = (unsigned char*)XMALLOC(len, NULL, DYNAMIC_TYPE_TMP_BUFFER); + if (ret == 0 && der == NULL) { ret = MEMORY_E; } if (ret == 0) { @@ -4818,11 +4824,14 @@ static int wp11_Object_Decode_MldsaKey(WP11_Object* object) int ret = 0; if (object->objClass == CKO_PRIVATE_KEY) { - unsigned char* der; + unsigned char* der = NULL; int len = object->keyDataLen - AES_BLOCK_SIZE; - der = (unsigned char*)XMALLOC(len, NULL, DYNAMIC_TYPE_TMP_BUFFER); - if (der == NULL) { + if (object->keyDataLen <= AES_BLOCK_SIZE) + ret = BAD_FUNC_ARG; + if (ret == 0) + der = (unsigned char*)XMALLOC(len, NULL, DYNAMIC_TYPE_TMP_BUFFER); + if (ret == 0 && der == NULL) { ret = MEMORY_E; } if (ret == 0) { @@ -5035,11 +5044,18 @@ static int wp11_Object_Decode_DhKey(WP11_Object* object) int ret = 0; if (object->objClass == CKO_PRIVATE_KEY) { - ret = wp11_DecryptData(object->data.dhKey->key, object->keyData, - object->keyDataLen - AES_BLOCK_SIZE, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + if (object->keyDataLen <= AES_BLOCK_SIZE) + ret = BAD_FUNC_ARG; + else if (object->keyDataLen - AES_BLOCK_SIZE > WP11_MAX_DH_KEY_SZ) + ret = BUFFER_E; + if (ret == 0) { + ret = wp11_DecryptData(object->data.dhKey->key, object->keyData, + object->keyDataLen - AES_BLOCK_SIZE, + object->slot->token.key, + sizeof(object->slot->token.key), + object->iv, sizeof(object->iv), + object->devId); + } if (ret == 0) object->data.dhKey->len = object->keyDataLen - AES_BLOCK_SIZE; } diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c index d90771cc..963e34b6 100644 --- a/tests/object_store_decode_test.c +++ b/tests/object_store_decode_test.c @@ -79,7 +79,8 @@ static byte dataValue[] = "stored data object value"; static const char* storeKinds[] = { "obj", "data", "symmkey", "rsakey_priv", "rsakey_pub", "ecckey_priv", - "ecckey_pub", "dhkey_priv", "dhkey_pub", "cert", "trust" + "ecckey_pub", "dhkey_priv", "dhkey_pub", "cert", "trust", "mldsakey_priv", + "mldsakey_pub" }; #if defined(USE_WOLFSSL_MEMORY) && !defined(WOLFSSL_STATIC_MEMORY) && \ @@ -549,6 +550,191 @@ static void test_truncated_data_record(void) cleanup_test_files(); } +/* Replace the first length-prefixed array in a stored key record with newLen + * bytes, keeping the rest of the record unchanged. */ +static int rewrite_first_array(const char* path, word32 newLen) +{ + static byte data[MAX_FILE_SZ]; + static byte out[MAX_FILE_SZ]; + size_t sz = 0; + word32 oldLen; + size_t tail; + + if (read_file(path, data, sizeof(data), &sz) != 0 || sz < 4) + return -1; + oldLen = get_be32(data); + if (oldLen > sz - 4 || 4 + (size_t)newLen + (sz - 4 - oldLen) > sizeof(out)) + return -1; + tail = sz - 4 - oldLen; + put_be32(out, newLen); + XMEMSET(out + 4, 0x5A, newLen); + XMEMCPY(out + 4, data + 4, (newLen < oldLen) ? newLen : oldLen); + XMEMCPY(out + 4 + newLen, data + 4 + oldLen, tail); + return write_file(path, out, 4 + newLen + tail); +} + +/* Loading may succeed but logging in must reject the damaged key record. */ +static int child_login_rejected(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + int res = CHILD_FAIL; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv != CKR_OK) + return CHILD_PASS; + rv = open_session(slot, 1, &session); + if (rv != CKR_OK) + res = CHILD_PASS; + (void)funcList->C_Finalize(NULL); + return res; +} + +static void check_damaged_key_record(const char* name, create_fn create, + const char* kind, word32 newLen) +{ + CK_RV rv; + char path[256]; + char msg[128]; + int res = CHILD_SETUP; + + rv = store_objects(create); + (void)snprintf(msg, sizeof(msg), "store %s", name); + CHECK_RV(rv, msg, CKR_OK); + if (rv != CKR_OK) + return; + if (find_store_file(kind, path, sizeof(path)) == 0 && + rewrite_first_array(path, newLen) == 0) { + res = run_in_child(child_login_rejected); + } + (void)snprintf(msg, sizeof(msg), "damaged %s record is rejected", name); + CHECK_TRUE(res == CHILD_PASS, msg); + cleanup_test_files(); +} + +#ifndef NO_DH +static CK_RV create_dh_private_key(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS keyClass = CKO_PRIVATE_KEY; + CK_KEY_TYPE keyType = CKK_DH; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIME, dh_ffdhe2048_p, sizeof(dh_ffdhe2048_p) }, + { CKA_BASE, dh_ffdhe2048_g, sizeof(dh_ffdhe2048_g) }, + { CKA_VALUE, dh_2048_priv, sizeof(dh_2048_priv) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} +#endif + +#ifdef HAVE_ECC +static CK_RV create_ecc_private_key(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS keyClass = CKO_PRIVATE_KEY; + CK_KEY_TYPE keyType = CKK_EC; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SIGN, &ckTrue, sizeof(ckTrue) }, + { CKA_EC_PARAMS, ecc_p256_params, sizeof(ecc_p256_params) }, + { CKA_VALUE, ecc_p256_priv, sizeof(ecc_p256_priv) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} +#endif + +#ifndef NO_RSA +static CK_RV create_rsa_private_key(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS keyClass = CKO_PRIVATE_KEY; + CK_KEY_TYPE keyType = CKK_RSA; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SIGN, &ckTrue, sizeof(ckTrue) }, + { CKA_MODULUS, rsa_2048_modulus, sizeof(rsa_2048_modulus) }, + { CKA_PUBLIC_EXPONENT, rsa_2048_pub_exp, sizeof(rsa_2048_pub_exp) }, + { CKA_PRIVATE_EXPONENT, rsa_2048_priv_exp, sizeof(rsa_2048_priv_exp) }, + { CKA_PRIME_1, rsa_2048_p, sizeof(rsa_2048_p) }, + { CKA_PRIME_2, rsa_2048_q, sizeof(rsa_2048_q) }, + { CKA_EXPONENT_1, rsa_2048_dP, sizeof(rsa_2048_dP) }, + { CKA_EXPONENT_2, rsa_2048_dQ, sizeof(rsa_2048_dQ) }, + { CKA_COEFFICIENT, rsa_2048_u, sizeof(rsa_2048_u) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} +#endif + +#ifdef WOLFPKCS11_MLDSA +static CK_RV create_mldsa_key_pair(CK_SESSION_HANDLE session) +{ + CK_MECHANISM mech = { CKM_ML_DSA_KEY_PAIR_GEN, NULL, 0 }; + CK_ULONG paramSet = CKP_ML_DSA_44; + CK_OBJECT_HANDLE pub = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE priv = CK_INVALID_HANDLE; + CK_ATTRIBUTE pubTmpl[] = { + { CKA_PARAMETER_SET, ¶mSet, sizeof(paramSet) }, + { CKA_VERIFY, &ckTrue, sizeof(ckTrue) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + }; + CK_ATTRIBUTE privTmpl[] = { + { CKA_SIGN, &ckTrue, sizeof(ckTrue) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + }; + + return funcList->C_GenerateKeyPair(session, &mech, pubTmpl, + sizeof(pubTmpl) / sizeof(*pubTmpl), privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &pub, &priv); +} +#endif + +/* A stored private key record shorter than its authentication tag, or + * longer than the key it decrypts into. */ +static void test_short_private_key_record(void) +{ + printf("\n--- short private key record is rejected ---\n"); +#ifndef NO_DH + check_damaged_key_record("DH private key", create_dh_private_key, + "dhkey_priv", 8); + check_damaged_key_record("tag-only DH private key", create_dh_private_key, + "dhkey_priv", 16); + check_damaged_key_record("oversized DH private key", + create_dh_private_key, "dhkey_priv", 4096 + 16); +#endif +#ifdef HAVE_ECC + check_damaged_key_record("tag-only ECC private key", + create_ecc_private_key, "ecckey_priv", 16); +#endif +#ifndef NO_RSA + check_damaged_key_record("tag-only RSA private key", + create_rsa_private_key, "rsakey_priv", 16); +#endif +#ifdef WOLFPKCS11_MLDSA + check_damaged_key_record("tag-only ML-DSA private key", + create_mldsa_key_pair, "mldsakey_priv", 16); +#endif +} + #define LARGE_VALUE_SZ 300001 static byte largeValue[LARGE_VALUE_SZ]; static byte largeRead[LARGE_VALUE_SZ]; @@ -709,6 +895,7 @@ int main(int argc, char* argv[]) test_large_stored_value_peak(); #endif test_truncated_data_record(); + test_short_private_key_record(); return pkcs11_test_summary(); } From 2982321af146b93b9e05b773d4ef054addcff6da Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:53:42 -0700 Subject: [PATCH 005/104] F-4733 - Bound stored DH public key length to the key buffer --- src/internal.c | 3 +++ tests/object_store_decode_test.c | 31 +++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) diff --git a/src/internal.c b/src/internal.c index 77960a7b..70a522de 100644 --- a/src/internal.c +++ b/src/internal.c @@ -5059,6 +5059,9 @@ static int wp11_Object_Decode_DhKey(WP11_Object* object) if (ret == 0) object->data.dhKey->len = object->keyDataLen - AES_BLOCK_SIZE; } + else if (object->keyDataLen > WP11_MAX_DH_KEY_SZ) { + ret = BUFFER_E; + } else { XMEMCPY(object->data.dhKey->key, object->keyData, object->keyDataLen); object->data.dhKey->len = object->keyDataLen; diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c index 963e34b6..15a57d96 100644 --- a/tests/object_store_decode_test.c +++ b/tests/object_store_decode_test.c @@ -735,6 +735,34 @@ static void test_short_private_key_record(void) #endif } +#ifndef NO_DH +static CK_RV create_dh_public_key(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS keyClass = CKO_PUBLIC_KEY; + CK_KEY_TYPE keyType = CKK_DH; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIME, dh_ffdhe2048_p, sizeof(dh_ffdhe2048_p) }, + { CKA_BASE, dh_ffdhe2048_g, sizeof(dh_ffdhe2048_g) }, + { CKA_VALUE, dh_2048_pub, sizeof(dh_2048_pub) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} + +/* A stored public key record longer than the largest supported key. */ +static void test_oversized_public_key_record(void) +{ + printf("\n--- oversized public key record is rejected ---\n"); + check_damaged_key_record("oversized DH public key", create_dh_public_key, + "dhkey_pub", 4096); +} +#endif + #define LARGE_VALUE_SZ 300001 static byte largeValue[LARGE_VALUE_SZ]; static byte largeRead[LARGE_VALUE_SZ]; @@ -896,6 +924,9 @@ int main(int argc, char* argv[]) #endif test_truncated_data_record(); test_short_private_key_record(); +#ifndef NO_DH + test_oversized_public_key_record(); +#endif return pkcs11_test_summary(); } From 4a951dfdf53b6f216715801481a7b5e3aa28a1cd Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:06:36 -0700 Subject: [PATCH 006/104] F-3641 - Reject stored trust records that are not the trust size --- src/internal.c | 28 ++++++++++++++++++------ tests/object_store_decode_test.c | 37 ++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 7 deletions(-) diff --git a/src/internal.c b/src/internal.c index 70a522de..37a9c6b3 100644 --- a/src/internal.c +++ b/src/internal.c @@ -3511,14 +3511,25 @@ static void wp11_Object_Decode_Cert(WP11_Object* object) * Trust is not encrypted. * * @param [in, out] object Trust object. + * @return 0 on success. + * @return BUFFER_E when the stored trust data is not the expected size. */ -static void wp11_Object_Decode_Trust(WP11_Object* object) +static int wp11_Object_Decode_Trust(WP11_Object* object) { + int ret = 0; + if (object->keyData != NULL) { - XMEMCPY((unsigned char*)&object->data.trust, object->keyData, - object->keyDataLen); + if (object->keyDataLen != (int)sizeof(WP11_Trust)) { + ret = BUFFER_E; + } + else { + XMEMCPY((unsigned char*)&object->data.trust, object->keyData, + object->keyDataLen); + } } - object->encoded = 0; + object->encoded = (ret != 0); + + return ret; } #endif @@ -3585,7 +3596,11 @@ static int wp11_Object_Load_Trust(WP11_Object* object, int tokenId, int objId) ret = wp11_storage_read_alloc_array(storage, &object->keyData, &object->keyDataLen); wp11_storage_close(storage); - wp11_Object_Decode_Trust(object); + /* An empty record would leave the trust zeroed but decoded. */ + if (ret == 0 && object->keyData == NULL) + ret = BUFFER_E; + if (ret == 0) + ret = wp11_Object_Decode_Trust(object); } return ret; @@ -6960,8 +6975,7 @@ static int wp11_Object_Decode(WP11_Object* object) } #ifdef WOLFPKCS11_NSS else if (object->objClass == CKO_NSS_TRUST) { - wp11_Object_Decode_Trust(object); - ret = 0; + ret = wp11_Object_Decode_Trust(object); } #endif else if (object->objClass == CKO_DATA) { diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c index 15a57d96..43d034be 100644 --- a/tests/object_store_decode_test.c +++ b/tests/object_store_decode_test.c @@ -763,6 +763,40 @@ static void test_oversized_public_key_record(void) } #endif +#ifdef WOLFPKCS11_NSS +static CK_RV create_trust_object(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS trustClass = CKO_NSS_TRUST; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + static byte issuer[] = "CN=Test,O=wolfSSL,C=US"; + static byte serial[] = { 0x02, 0x05, 0x00, 0xC6, 0xA7, 0x91, 0x84 }; + static byte sha1Hash[20] = { 0 }; + static byte md5Hash[16] = { 0 }; + CK_ULONG trustValue = 0xCE534352; + CK_ATTRIBUTE tmpl[] = { + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_CLASS, &trustClass, sizeof(trustClass) }, + { CKA_ISSUER, issuer, sizeof(issuer) - 1 }, + { CKA_SERIAL_NUMBER, serial, sizeof(serial) }, + { CKA_CERT_SHA1_HASH, sha1Hash, sizeof(sha1Hash) }, + { CKA_CERT_MD5_HASH, md5Hash, sizeof(md5Hash) }, + { CKA_TRUST_SERVER_AUTH, &trustValue, sizeof(trustValue) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} + +/* Trust records have a fixed size and are stored unencrypted. */ +static void test_trust_record_length(void) +{ + printf("\n--- trust record length must match ---\n"); + check_damaged_key_record("oversized trust", create_trust_object, "trust", + 1024); + check_damaged_key_record("empty trust", create_trust_object, "trust", 0); +} +#endif + #define LARGE_VALUE_SZ 300001 static byte largeValue[LARGE_VALUE_SZ]; static byte largeRead[LARGE_VALUE_SZ]; @@ -927,6 +961,9 @@ int main(int argc, char* argv[]) #ifndef NO_DH test_oversized_public_key_record(); #endif +#ifdef WOLFPKCS11_NSS + test_trust_record_length(); +#endif return pkcs11_test_summary(); } From 4ab2ef30d6eb0fb7bee5f5635b34df8c31d7d05e Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:14:03 -0700 Subject: [PATCH 007/104] F-3404 - Write the encoded TPM key into the caller's buffer --- src/internal.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/internal.c b/src/internal.c index 37a9c6b3..9b803a83 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4150,15 +4150,15 @@ static int WP11_Object_EncodeTpmKey(WP11_Object* object, byte* keyData, if (keyData != NULL) { if (ret <= keyDataLen) { /* Write size marker for the public part */ - XMEMCPY(object->keyData, &pubAreaSize, + XMEMCPY(keyData, &pubAreaSize, sizeof(UINT16)); idx += sizeof(UINT16); /* Write the public part with bytes aligned */ - XMEMCPY(object->keyData + idx, pubAreaBuffer, + XMEMCPY(keyData + idx, pubAreaBuffer, sizeof(UINT16) + pubAreaSize); idx += sizeof(UINT16) + pubAreaSize; /* Write the private part, size marker is included */ - XMEMCPY(object->keyData + idx, &object->tpmKey->priv, + XMEMCPY(keyData + idx, &object->tpmKey->priv, sizeof(UINT16) + object->tpmKey->priv.size); idx += sizeof(UINT16) + object->tpmKey->priv.size; From af7c5da2ed97aaf4b0a4331c83c2634fa9df55f2 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:20:21 -0700 Subject: [PATCH 008/104] F-8643 - Keep key buffer allocation errors in TPM RSA and ECC encoders --- src/internal.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/internal.c b/src/internal.c index 9b803a83..578ccf85 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4336,7 +4336,10 @@ static int wp11_Object_Encode_RsaKey(WP11_Object* object) } #ifdef WOLFPKCS11_TPM - ret = WP11_Object_EncodeTpmKey(object, object->keyData, object->keyDataLen); + if (ret == 0) { + ret = WP11_Object_EncodeTpmKey(object, object->keyData, + object->keyDataLen); + } if (ret > 0) { ret = 0; } @@ -4678,7 +4681,10 @@ static int wp11_Object_Encode_EccKey(WP11_Object* object) } #ifdef WOLFPKCS11_TPM - ret = WP11_Object_EncodeTpmKey(object, object->keyData, object->keyDataLen); + if (ret == 0) { + ret = WP11_Object_EncodeTpmKey(object, object->keyData, + object->keyDataLen); + } if (ret > 0) { ret = 0; } From 004016c8cfc9e272da271cdc4628bf3e2b5f84cf Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:27:25 -0700 Subject: [PATCH 009/104] F-13813 - Release DH and symmetric key data when encoding fails --- src/internal.c | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/internal.c b/src/internal.c index 578ccf85..1256dfcb 100644 --- a/src/internal.c +++ b/src/internal.c @@ -5130,6 +5130,14 @@ static int wp11_Object_Encode_DhKey(WP11_Object* object) } } + if (ret != 0) { + if (object->keyData != NULL) + wc_ForceZero(object->keyData, object->keyDataLen); + XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); + object->keyData = NULL; + object->keyDataLen = 0; + } + return ret; } @@ -6507,6 +6515,14 @@ static int wp11_Object_Encode_SymmKey(WP11_Object* object) object->keyDataLen = object->data.symmKey->len + AES_BLOCK_SIZE; } + if (ret != 0) { + if (object->keyData != NULL) + wc_ForceZero(object->keyData, object->keyDataLen); + XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); + object->keyData = NULL; + object->keyDataLen = 0; + } + return ret; } From c240e05f3bc45a89cb4b9f4db4645c594ec2d3f7 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:33:20 -0700 Subject: [PATCH 010/104] F-3017 - Zeroize encoded private keys when RSA, ECC or ML-DSA encoding fails --- src/internal.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/internal.c b/src/internal.c index 1256dfcb..a760ef73 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4370,6 +4370,8 @@ static int wp11_Object_Encode_RsaKey(WP11_Object* object) } if (ret != 0) { + if (object->keyData != NULL) + wc_ForceZero(object->keyData, object->keyDataLen); XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); object->keyData = NULL; object->keyDataLen = 0; @@ -4711,6 +4713,8 @@ static int wp11_Object_Encode_EccKey(WP11_Object* object) } if (ret != 0) { + if (object->keyData != NULL) + wc_ForceZero(object->keyData, object->keyDataLen); XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); object->keyData = NULL; object->keyDataLen = 0; @@ -4961,6 +4965,8 @@ static int wp11_Object_Encode_MldsaKey(WP11_Object* object) } if (ret != 0) { + if (object->keyData != NULL) + wc_ForceZero(object->keyData, object->keyDataLen); XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); object->keyData = NULL; object->keyDataLen = 0; From bb0085e11e172b05102ac892abc4656b4a0cd490 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:47:05 -0700 Subject: [PATCH 011/104] F-3413 - Zeroize decrypted private key buffers on every decode path --- src/internal.c | 21 ++-- tests/object_store_decode_test.c | 170 +++++++++++++++++++++++++++++++ 2 files changed, 185 insertions(+), 6 deletions(-) diff --git a/src/internal.c b/src/internal.c index a760ef73..ea0f1950 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4264,16 +4264,20 @@ static int wp11_Object_Decode_RsaKey(WP11_Object* object) if (ret == 0) { /* Decode RSA private key. */ ret = wc_RsaPrivateKeyDecode(der, &idx, key, len); - wc_ForceZero(der, len); } - if (der != NULL) + if (der != NULL) { + wc_ForceZero(der, len); XFREE(der, NULL, DYNAMIC_TYPE_TMP_BUFFER); + } } else { /* Decode RSA public key. */ ret = wc_RsaPublicKeyDecode(object->keyData, &idx, key, object->keyDataLen); } + /* Drop partially decoded components and the init before a retry. */ + if (ret != 0) + wc_FreeRsaKey(key); object->encoded = (ret != 0); return ret; @@ -4620,16 +4624,20 @@ static int wp11_Object_Decode_EccKey(WP11_Object* object) if (ret == 0) { /* Decode ECC private key. */ ret = wc_EccPrivateKeyDecode(der, &idx, key, len); - wc_ForceZero(der, len); } - if (der != NULL) + if (der != NULL) { + wc_ForceZero(der, len); XFREE(der, NULL, DYNAMIC_TYPE_TMP_BUFFER); + } } else { /* Decode ECC public key. */ ret = wc_EccPublicKeyDecode(object->keyData, &idx, key, object->keyDataLen); } + /* Drop partially decoded components and the init before a retry. */ + if (ret != 0) + wc_ecc_free(key); object->encoded = (ret != 0); return ret; @@ -4877,10 +4885,11 @@ static int wp11_Object_Decode_MldsaKey(WP11_Object* object) ret = MldsaKeyTryDecode(object->data.mldsaKey, WC_ML_DSA_87, der, len, object->objClass); } - wc_ForceZero(der, len); } - if (der != NULL) + if (der != NULL) { + wc_ForceZero(der, len); XFREE(der, NULL, DYNAMIC_TYPE_TMP_BUFFER); + } } else { /* Decode ML-DSA public key. */ diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c index 43d034be..6432fc66 100644 --- a/tests/object_store_decode_test.c +++ b/tests/object_store_decode_test.c @@ -940,6 +940,173 @@ static void test_large_stored_value_peak(void) } #endif +#ifdef HAVE_ALLOC_TRACKING +#define MAX_TRACKED 8192 + +typedef struct TrackedAlloc { + void* ptr; + size_t sz; +} TrackedAlloc; + +static TrackedAlloc tracked[MAX_TRACKED]; +static const byte* secretNeedle = NULL; +static size_t secretNeedleSz = 0; +static int secretFreed = 0; + +static void track_add(void* ptr, size_t sz) +{ + int i; + + for (i = 0; ptr != NULL && i < MAX_TRACKED; i++) { + if (tracked[i].ptr == NULL) { + tracked[i].ptr = ptr; + tracked[i].sz = sz; + break; + } + } +} + +static int track_find(void* ptr) +{ + int i; + + for (i = 0; ptr != NULL && i < MAX_TRACKED; i++) { + if (tracked[i].ptr == ptr) + return i; + } + return -1; +} + +static int holds_secret(const byte* buf, size_t sz) +{ + size_t i; + + for (i = 0; sz >= secretNeedleSz && i <= sz - secretNeedleSz; i++) { + if (XMEMCMP(buf + i, secretNeedle, secretNeedleSz) == 0) + return 1; + } + return 0; +} + +static void* scan_malloc(size_t sz) +{ + void* ptr = malloc(sz); + + /* Zeroed so a scan only sees bytes the library wrote. */ + if (ptr != NULL) + XMEMSET(ptr, 0, sz); + track_add(ptr, sz); + return ptr; +} + +static void scan_free(void* ptr) +{ + int i = track_find(ptr); + + if (i >= 0) { + if (holds_secret((const byte*)ptr, tracked[i].sz)) + secretFreed++; + tracked[i].ptr = NULL; + } + free(ptr); +} + +static void* scan_realloc(void* ptr, size_t sz) +{ + int i = track_find(ptr); + int oldKnown = (ptr == NULL || i >= 0); + size_t oldSz = (i >= 0) ? tracked[i].sz : 0; + void* newPtr = realloc(ptr, sz); + + if (newPtr != NULL) { + if (i >= 0) + tracked[i].ptr = NULL; + if (oldKnown && sz > oldSz) + XMEMSET((byte*)newPtr + oldSz, 0, sz - oldSz); + track_add(newPtr, sz); + } + return newPtr; +} + +/* Logging in with a stored private key that fails authentication must not + * release decrypted key material to the heap. */ +static int child_no_key_material_freed(void) +{ + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + + if (wolfSSL_SetAllocators(scan_malloc, scan_free, scan_realloc) != 0) + return CHILD_SETUP; + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + if (init_slot(&slot) == CKR_OK) { + (void)open_session(slot, 1, &session); + (void)funcList->C_Finalize(NULL); + } + if (secretFreed != 0) { + fprintf(stderr, " %d freed buffer(s) held key material\n", + secretFreed); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +/* Flip the last byte of the first length-prefixed array (the GCM tag). */ +static int corrupt_first_array_tag(const char* path) +{ + static byte data[MAX_FILE_SZ]; + size_t sz = 0; + word32 len; + + if (read_file(path, data, sizeof(data), &sz) != 0 || sz < 4) + return -1; + len = get_be32(data); + if (len == 0 || len > sz - 4) + return -1; + data[4 + len - 1] ^= 0x01; + return write_file(path, data, sz); +} + +static void check_failed_decrypt_scrubbed(const char* name, create_fn create, + const char* kind, + const byte* secret, size_t secretSz) +{ + CK_RV rv; + char path[256]; + char msg[128]; + int res = CHILD_SETUP; + + rv = store_objects(create); + (void)snprintf(msg, sizeof(msg), "store %s", name); + CHECK_RV(rv, msg, CKR_OK); + if (rv != CKR_OK) + return; + secretNeedle = secret; + secretNeedleSz = secretSz; + if (find_store_file(kind, path, sizeof(path)) == 0 && + corrupt_first_array_tag(path) == 0) { + res = run_in_child(child_no_key_material_freed); + } + (void)snprintf(msg, sizeof(msg), + "%s buffer is cleared after failed decrypt", name); + CHECK_TRUE(res == CHILD_PASS, msg); + cleanup_test_files(); +} + +static void test_failed_decrypt_scrubbed(void) +{ + printf("\n--- private key buffer cleared after failed decrypt ---\n"); +#ifdef HAVE_ECC + check_failed_decrypt_scrubbed("ECC private key", create_ecc_private_key, + "ecckey_priv", ecc_p256_priv, sizeof(ecc_p256_priv)); +#endif +#ifndef NO_RSA + check_failed_decrypt_scrubbed("RSA private key", create_rsa_private_key, + "rsakey_priv", rsa_2048_priv_exp, 32); +#endif +} +#endif + int main(int argc, char* argv[]) { (void)argc; @@ -964,6 +1131,9 @@ int main(int argc, char* argv[]) #ifdef WOLFPKCS11_NSS test_trust_record_length(); #endif +#ifdef HAVE_ALLOC_TRACKING + test_failed_decrypt_scrubbed(); +#endif return pkcs11_test_summary(); } From 808664451bd7a26279c50beb2abe4a9db618f3d3 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:53:02 -0700 Subject: [PATCH 012/104] F-8667 - Scrub symmetric and DH key buffers after a failed decrypt --- src/internal.c | 8 +++++++ tests/object_store_decode_test.c | 41 ++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) diff --git a/src/internal.c b/src/internal.c index ea0f1950..0bff0a83 100644 --- a/src/internal.c +++ b/src/internal.c @@ -5091,6 +5091,10 @@ static int wp11_Object_Decode_DhKey(WP11_Object* object) sizeof(object->slot->token.key), object->iv, sizeof(object->iv), object->devId); + if (ret != 0) { + wc_ForceZero(object->data.dhKey->key, + (word32)(object->keyDataLen - AES_BLOCK_SIZE)); + } } if (ret == 0) object->data.dhKey->len = object->keyDataLen - AES_BLOCK_SIZE; @@ -6493,6 +6497,10 @@ static int wp11_Object_Decode_SymmKey(WP11_Object* object) object->slot->token.key, sizeof(object->slot->token.key), object->iv, sizeof(object->iv), object->devId); + if (ret != 0) { + wc_ForceZero(object->data.symmKey->data, + (word32)(object->keyDataLen - AES_BLOCK_SIZE)); + } } if (ret == 0) object->data.symmKey->len = object->keyDataLen - AES_BLOCK_SIZE; diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c index 6432fc66..dc3f434b 100644 --- a/tests/object_store_decode_test.c +++ b/tests/object_store_decode_test.c @@ -1105,6 +1105,46 @@ static void test_failed_decrypt_scrubbed(void) "rsakey_priv", rsa_2048_priv_exp, 32); #endif } + +#ifndef NO_AES +static byte aesKeyValue[32] = { + 0x5b, 0x1e, 0xc4, 0x27, 0x9a, 0x30, 0xe8, 0x71, + 0x0d, 0xb6, 0x43, 0xf9, 0x82, 0x2c, 0x95, 0x6e, + 0xa7, 0x14, 0xd0, 0x3b, 0x68, 0xcf, 0x51, 0x0a, + 0xe3, 0x9d, 0x26, 0x7c, 0xb1, 0x48, 0xf5, 0x13 +}; + +static CK_RV create_aes_key(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS keyClass = CKO_SECRET_KEY; + CK_KEY_TYPE keyType = CKK_AES; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, aesKeyValue, sizeof(aesKeyValue) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} +#endif + +static void test_failed_key_decrypt_scrubbed(void) +{ + printf("\n--- secret key storage cleared after failed decrypt ---\n"); +#ifndef NO_AES + check_failed_decrypt_scrubbed("AES key", create_aes_key, "symmkey", + aesKeyValue, sizeof(aesKeyValue)); +#endif +#ifndef NO_DH + check_failed_decrypt_scrubbed("DH private key value", create_dh_private_key, + "dhkey_priv", dh_2048_priv, sizeof(dh_2048_priv)); +#endif +} #endif int main(int argc, char* argv[]) @@ -1133,6 +1173,7 @@ int main(int argc, char* argv[]) #endif #ifdef HAVE_ALLOC_TRACKING test_failed_decrypt_scrubbed(); + test_failed_key_decrypt_scrubbed(); #endif return pkcs11_test_summary(); From 0d8ae911e4ee33195de4503b4366e9fddd7255fb Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:32:45 -0700 Subject: [PATCH 013/104] Keep the old key record when encoding fails --- src/internal.c | 144 +++++++++++++++---------------- tests/object_store_decode_test.c | 90 ++++++++++++++++++- 2 files changed, 157 insertions(+), 77 deletions(-) diff --git a/src/internal.c b/src/internal.c index 0bff0a83..96a6bfed 100644 --- a/src/internal.c +++ b/src/internal.c @@ -3488,6 +3488,33 @@ static int wp11_DecryptData(byte* out, byte* data, int len, byte* key, return ret; } +/** + * Finish encoding key data into a new buffer: on success release the previous + * record, on failure drop the new buffer and put the previous record back so + * the key still decodes at the next login. + * + * @param [in, out] object Key object. + * @param [in] oldData Key data buffer before the encode. + * @param [in] oldLen Length of key data before the encode. + * @param [in] newLen Size of the buffer allocated for the encode. + * @param [in] ret Result of the encode. + */ +static void wp11_Object_EncodeDone(WP11_Object* object, unsigned char* oldData, + int oldLen, word32 newLen, int ret) +{ + if (ret == 0) { + XFREE(oldData, NULL, DYNAMIC_TYPE_TMP_BUFFER); + } + else { + if (object->keyData != oldData && object->keyData != NULL) { + wc_ForceZero(object->keyData, newLen); + XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); + } + object->keyData = oldData; + object->keyDataLen = oldLen; + } +} + /** * "Decode" the certificate. * @@ -4295,6 +4322,8 @@ static int wp11_Object_Decode_RsaKey(WP11_Object* object) static int wp11_Object_Encode_RsaKey(WP11_Object* object) { int ret; + unsigned char* oldData = object->keyData; + int oldLen = object->keyDataLen; #ifdef WOLFPKCS11_TPM ret = WP11_Object_EncodeTpmKey(object, NULL, 0); @@ -4331,7 +4360,6 @@ static int wp11_Object_Encode_RsaKey(WP11_Object* object) } if (ret == 0) { - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); /* Allocate buffer to hold encoded key. */ object->keyData = (unsigned char*)XMALLOC(object->keyDataLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); @@ -4373,13 +4401,8 @@ static int wp11_Object_Encode_RsaKey(WP11_Object* object) } } - if (ret != 0) { - if (object->keyData != NULL) - wc_ForceZero(object->keyData, object->keyDataLen); - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); - object->keyData = NULL; - object->keyDataLen = 0; - } + wp11_Object_EncodeDone(object, oldData, oldLen, (word32)object->keyDataLen, + ret); return ret; } @@ -4655,6 +4678,8 @@ static int wp11_Object_Decode_EccKey(WP11_Object* object) static int wp11_Object_Encode_EccKey(WP11_Object* object) { int ret; + unsigned char* oldData = object->keyData; + int oldLen = object->keyDataLen; #ifdef WOLFPKCS11_TPM ret = WP11_Object_EncodeTpmKey(object, NULL, 0); @@ -4682,7 +4707,6 @@ static int wp11_Object_Encode_EccKey(WP11_Object* object) } if (ret == 0) { - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); /* Allocate buffer to hold encoded key. */ object->keyData = (unsigned char*)XMALLOC(object->keyDataLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); @@ -4720,13 +4744,8 @@ static int wp11_Object_Encode_EccKey(WP11_Object* object) } } - if (ret != 0) { - if (object->keyData != NULL) - wc_ForceZero(object->keyData, object->keyDataLen); - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); - object->keyData = NULL; - object->keyDataLen = 0; - } + wp11_Object_EncodeDone(object, oldData, oldLen, (word32)object->keyDataLen, + ret); return ret; } @@ -4924,6 +4943,8 @@ static int wp11_Object_Decode_MldsaKey(WP11_Object* object) static int wp11_Object_Encode_MldsaKey(WP11_Object* object) { int ret; + unsigned char* oldData = object->keyData; + int oldLen = object->keyDataLen; if (object->objClass == CKO_PRIVATE_KEY) { /* Get length of encoded private key. */ @@ -4943,7 +4964,6 @@ static int wp11_Object_Encode_MldsaKey(WP11_Object* object) } if (ret == 0) { - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); /* Allocate buffer to hold encoded key. */ object->keyData = (unsigned char*)XMALLOC(object->keyDataLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); @@ -4973,13 +4993,8 @@ static int wp11_Object_Encode_MldsaKey(WP11_Object* object) } } - if (ret != 0) { - if (object->keyData != NULL) - wc_ForceZero(object->keyData, object->keyDataLen); - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); - object->keyData = NULL; - object->keyDataLen = 0; - } + wp11_Object_EncodeDone(object, oldData, oldLen, (word32)object->keyDataLen, + ret); return ret; } @@ -5123,12 +5138,14 @@ static int wp11_Object_Decode_DhKey(WP11_Object* object) static int wp11_Object_Encode_DhKey(WP11_Object* object) { int ret = 0; + unsigned char* oldData = object->keyData; + int oldLen = object->keyDataLen; + word32 newLen = object->data.dhKey->len + AES_BLOCK_SIZE; - object->keyDataLen = object->data.dhKey->len + AES_BLOCK_SIZE; - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); + object->keyDataLen = (int)newLen; /* Allocate buffer to hold encoded key. */ - object->keyData = (unsigned char*)XMALLOC(object->keyDataLen, NULL, - DYNAMIC_TYPE_TMP_BUFFER); + object->keyData = (unsigned char*)XMALLOC(newLen, NULL, + DYNAMIC_TYPE_TMP_BUFFER); if (object->keyData == NULL) ret = MEMORY_E; @@ -5148,14 +5165,7 @@ static int wp11_Object_Encode_DhKey(WP11_Object* object) object->keyDataLen = object->data.dhKey->len; } } - - if (ret != 0) { - if (object->keyData != NULL) - wc_ForceZero(object->keyData, object->keyDataLen); - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); - object->keyData = NULL; - object->keyDataLen = 0; - } + wp11_Object_EncodeDone(object, oldData, oldLen, newLen, ret); return ret; } @@ -5527,6 +5537,8 @@ static int wp11_Object_Encode_MlKemKey(WP11_Object* object) { int ret; word32 keyLen = 0; + unsigned char* oldData = object->keyData; + int oldLen = object->keyDataLen; if (object->objClass == CKO_PRIVATE_KEY) { ret = wc_MlKemKey_PrivateKeySize(object->data.mlKemKey, &keyLen); @@ -5542,7 +5554,6 @@ static int wp11_Object_Encode_MlKemKey(WP11_Object* object) } if (ret == 0) { - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); object->keyData = (unsigned char*)XMALLOC(object->keyDataLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); if (object->keyData == NULL) @@ -5564,13 +5575,8 @@ static int wp11_Object_Encode_MlKemKey(WP11_Object* object) object->keyData, keyLen); } - if (ret != 0) { - if (object->keyData != NULL) - wc_ForceZero(object->keyData, object->keyDataLen); - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); - object->keyData = NULL; - object->keyDataLen = 0; - } + wp11_Object_EncodeDone(object, oldData, oldLen, (word32)object->keyDataLen, + ret); return ret; } @@ -5749,13 +5755,14 @@ static int wp11_Object_Encode_HssKey(WP11_Object* object) { int ret; word32 pubLen = 0; + unsigned char* oldData = object->keyData; + int oldLen = object->keyDataLen; if (object->objClass != CKO_PUBLIC_KEY) return NOT_AVAILABLE_E; /* verify-only: no private-key objects */ ret = wc_LmsKey_GetPubLen(object->data.lmsKey, &pubLen); if (ret == 0) { - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); object->keyData = (unsigned char*)XMALLOC(pubLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); if (object->keyData == NULL) @@ -5767,14 +5774,7 @@ static int wp11_Object_Encode_HssKey(WP11_Object* object) if (ret == 0) object->keyDataLen = (int)pubLen; } - /* On failure release the buffer so a later store does not skip re-encoding - * (keyData != NULL) and persist an uninitialised buffer with a stale - * length. This is public key material only, so no zeroization is needed. */ - if (ret != 0) { - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); - object->keyData = NULL; - object->keyDataLen = 0; - } + wp11_Object_EncodeDone(object, oldData, oldLen, pubLen, ret); return ret; } @@ -6194,13 +6194,14 @@ static int wp11_Object_Encode_XmssKey(WP11_Object* object) { int ret; word32 pubLen = 0; + unsigned char* oldData = object->keyData; + int oldLen = object->keyDataLen; if (object->objClass != CKO_PUBLIC_KEY) return NOT_AVAILABLE_E; ret = wc_XmssKey_GetPubLen(object->data.xmssKey, &pubLen); if (ret == 0) { - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); object->keyData = (unsigned char*)XMALLOC(pubLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); if (object->keyData == NULL) @@ -6212,14 +6213,7 @@ static int wp11_Object_Encode_XmssKey(WP11_Object* object) if (ret == 0) object->keyDataLen = (int)pubLen; } - /* On failure release the buffer so a later store does not skip re-encoding - * (keyData != NULL) and persist an uninitialised buffer with a stale - * length. This is public key material only, so no zeroization is needed. */ - if (ret != 0) { - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); - object->keyData = NULL; - object->keyDataLen = 0; - } + wp11_Object_EncodeDone(object, oldData, oldLen, pubLen, ret); return ret; } @@ -6519,12 +6513,14 @@ static int wp11_Object_Decode_SymmKey(WP11_Object* object) static int wp11_Object_Encode_SymmKey(WP11_Object* object) { int ret = 0; + unsigned char* oldData = object->keyData; + int oldLen = object->keyDataLen; + word32 newLen = object->data.symmKey->len + AES_BLOCK_SIZE; - object->keyDataLen = object->data.symmKey->len + AES_BLOCK_SIZE; - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); + object->keyDataLen = (int)newLen; /* Allocate buffer to hold encoded key. */ - object->keyData = (unsigned char*)XMALLOC(object->keyDataLen, NULL, - DYNAMIC_TYPE_TMP_BUFFER); + object->keyData = (unsigned char*)XMALLOC(newLen, NULL, + DYNAMIC_TYPE_TMP_BUFFER); if (object->keyData == NULL) ret = MEMORY_E; @@ -6534,17 +6530,8 @@ static int wp11_Object_Encode_SymmKey(WP11_Object* object) object->slot->token.key, sizeof(object->slot->token.key), object->iv, sizeof(object->iv), object->devId); - if (ret == 0) - object->keyDataLen = object->data.symmKey->len + AES_BLOCK_SIZE; - } - - if (ret != 0) { - if (object->keyData != NULL) - wc_ForceZero(object->keyData, object->keyDataLen); - XFREE(object->keyData, NULL, DYNAMIC_TYPE_TMP_BUFFER); - object->keyData = NULL; - object->keyDataLen = 0; } + wp11_Object_EncodeDone(object, oldData, oldLen, newLen, ret); return ret; } @@ -7211,10 +7198,12 @@ static int wp11_Object_Encode(WP11_Object* object, int protect) { int ret = 0; int encrypt = wp11_Object_IsEncrypted(object); + byte oldIv[GCM_NONCE_MID_SZ]; /* Every AES-GCM encryption under the token key needs a fresh nonce. Do * this immediately before encoding, while the plaintext is still the * source of the ciphertext that will be persisted. */ + XMEMCPY(oldIv, object->iv, sizeof(oldIv)); if (encrypt) { WP11_Lock_LockRW(&object->slot->token.rngLock); ret = wc_RNG_GenerateBlock(&object->slot->token.rng, object->iv, @@ -7223,6 +7212,9 @@ static int wp11_Object_Encode(WP11_Object* object, int protect) } if (ret == 0) ret = wp11_Object_EncodeData(object, protect); + /* The previous record stays in use when the encode fails. */ + if (ret != 0) + XMEMCPY(object->iv, oldIv, sizeof(object->iv)); return ret; } diff --git a/tests/object_store_decode_test.c b/tests/object_store_decode_test.c index dc3f434b..74fcdb2f 100644 --- a/tests/object_store_decode_test.c +++ b/tests/object_store_decode_test.c @@ -95,6 +95,7 @@ static size_t largestAlloc = 0; static size_t peakCap = 0; static size_t liveBytes = 0; static size_t peakLive = 0; +static int refuseAllocs = 0; static void* track_malloc(size_t sz) { @@ -102,7 +103,7 @@ static void* track_malloc(size_t sz) if (sz > largestAlloc) largestAlloc = sz; - if (sz >= ALLOC_REFUSE_SZ) + if (sz >= ALLOC_REFUSE_SZ || refuseAllocs) return NULL; p = (unsigned char*)malloc(sz + TRACK_HDR_SZ); if (p == NULL) @@ -1133,6 +1134,90 @@ static CK_RV create_aes_key(CK_SESSION_HANDLE session) } #endif +#ifndef NO_AES +/* Count the AES keys visible after a login and check one still encrypts. */ +static CK_RV use_stored_aes_key(CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_OBJECT_CLASS keyClass = CKO_SECRET_KEY; + CK_KEY_TYPE keyType = CKK_AES; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + }; + CK_OBJECT_HANDLE key = CK_INVALID_HANDLE; + CK_ULONG count = 0; + byte iv[16]; + byte plain[16]; + byte enc[32]; + CK_ULONG encLen = sizeof(enc); + CK_MECHANISM mech = { CKM_AES_CBC, iv, sizeof(iv) }; + + XMEMSET(iv, 0, sizeof(iv)); + XMEMSET(plain, 0, sizeof(plain)); + rv = funcList->C_FindObjectsInit(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl)); + if (rv == CKR_OK) { + rv = funcList->C_FindObjects(session, &key, 1, &count); + (void)funcList->C_FindObjectsFinal(session); + } + if (rv == CKR_OK && count != 1) + rv = CKR_OBJECT_HANDLE_INVALID; + if (rv == CKR_OK) + rv = funcList->C_EncryptInit(session, &mech, key); + if (rv == CKR_OK) + rv = funcList->C_Encrypt(session, plain, sizeof(plain), enc, &encLen); + return rv; +} + +/* A logout whose re-encryption of a stored key fails must leave the stored + * record in place, so the next login still decodes it. */ +static int child_login_after_failed_encode(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + int res = CHILD_FAIL; + + if (wolfSSL_SetAllocators(track_malloc, track_free, track_realloc) != 0) + return CHILD_SETUP; + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv != CKR_OK) + return CHILD_SETUP; + refuseAllocs = 1; + (void)funcList->C_Logout(session); + refuseAllocs = 0; + rv = funcList->C_Login(session, CKU_USER, userPin, sizeof(userPin) - 1); + if (rv == CKR_OK) + rv = use_stored_aes_key(session); + if (rv == CKR_OK) + res = CHILD_PASS; + else + fprintf(stderr, " login or key use after failed encode: 0x%lx\n", + (unsigned long)rv); + (void)funcList->C_Finalize(NULL); + return res; +} + +static void test_login_after_failed_encode(void) +{ + CK_RV rv; + int res = CHILD_SETUP; + + printf("\n--- stored key survives a failed re-encryption at logout ---\n"); + rv = store_objects(create_aes_key); + CHECK_RV(rv, "store AES key", CKR_OK); + if (rv == CKR_OK) + res = run_in_child(child_login_after_failed_encode); + CHECK_TRUE(res == CHILD_PASS, "login decodes the key after a failed encode"); + cleanup_test_files(); +} +#endif + static void test_failed_key_decrypt_scrubbed(void) { printf("\n--- secret key storage cleared after failed decrypt ---\n"); @@ -1174,6 +1259,9 @@ int main(int argc, char* argv[]) #ifdef HAVE_ALLOC_TRACKING test_failed_decrypt_scrubbed(); test_failed_key_decrypt_scrubbed(); +#ifndef NO_AES + test_login_after_failed_encode(); +#endif #endif return pkcs11_test_summary(); From 885ac28fc3d126e39d8aa4f349e7a77a38d71c07 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 17:11:24 -0700 Subject: [PATCH 014/104] F-10400 - Authenticate stored object policy with the key encryption --- src/crypto.c | 6 + src/internal.c | 910 +++++++++++++-- tests/include.am | 8 + tests/object_policy_integrity_test.c | 1538 ++++++++++++++++++++++++++ wolfpkcs11/internal.h | 6 + 5 files changed, 2395 insertions(+), 73 deletions(-) create mode 100644 tests/object_policy_integrity_test.c diff --git a/src/crypto.c b/src/crypto.c index 92de2f52..a301c4d2 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -1189,6 +1189,12 @@ static CK_RV SetAttributeValue(WP11_Session* session, WP11_Object* obj, return CKR_ATTRIBUTE_VALUE_INVALID; else if (ret == BUFFER_E) return CKR_BUFFER_TOO_SMALL; + else if (ret == BAD_STATE_E) { + /* Logged in yet undecoded: the stored key failed to verify. */ + if (WP11_Slot_IsUserLoggedIn(WP11_Session_GetSlot(session))) + return CKR_FUNCTION_FAILED; + return CKR_USER_NOT_LOGGED_IN; + } else if (ret != 0) return CKR_FUNCTION_FAILED; } diff --git a/src/internal.c b/src/internal.c index 96a6bfed..70975161 100644 --- a/src/internal.c +++ b/src/internal.c @@ -303,6 +303,8 @@ struct WP11_Object { int keyDataLen; /* Length of encoded key data */ byte iv[GCM_NONCE_MID_SZ]; /* IV/nonce for encrypt/decrypt */ byte encoded:1; /* Key isn't in decoded form */ + byte undecoded:1; /* Loaded key data not yet decoded */ + byte unbound:1; /* Key data not bound to the policy */ #endif WP11_Session* session; /* Session object belongs to */ @@ -601,6 +603,9 @@ struct WP11_Slot { WP11_Object* discarded; /* Destroyed objects awaiting free */ WP11_Lock callLock; /* Lock for object call epochs */ byte reclaim:1; /* Unlinked objects await free */ +#ifndef WOLFPKCS11_NO_STORE + WP11_Lock storeLock; /* Held for a whole token store pass */ +#endif }; #if defined(HAVE_FIPS) && FIPS_VERSION_LT(6,0) @@ -1272,25 +1277,52 @@ static void wolfPKCS11_StoreAbortTemp(WP11_FileStoreCtx* ctx) } } -static int wolfPKCS11_StoreCommitTemp(WP11_FileStoreCtx* ctx) +#if defined(DEBUG_WOLFPKCS11) && !defined(_WIN32) && !defined(_MSC_VER) +static int wp11_storeExitAfter = 0; + +/** + * Test hook: end the process right after the given number of store renames, + * standing in for a crash part way through a store pass. + * + * @param renames [in] Renames to allow, or 0 to disable the hook. + */ +WP11_API void WP11_Test_StoreExitAfterRenames(int renames) { - int ret = 0; + wp11_storeExitAfter = renames; +} +#endif - if (ctx == NULL || ctx->has_temp == 0) { - return 0; - } +static int wolfPKCS11_StoreRename(const char* from, const char* to) +{ + int ret = 0; #if defined(_WIN32) || defined(_MSC_VER) - if (!MoveFileExA(ctx->temp_name, ctx->final_name, + if (!MoveFileExA(from, to, MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH)) { ret = READ_ONLY_E; } #else - if (rename(ctx->temp_name, ctx->final_name) != 0) { + if (rename(from, to) != 0) { ret = READ_ONLY_E; } #endif +#if defined(DEBUG_WOLFPKCS11) && !defined(_WIN32) && !defined(_MSC_VER) + if (ret == 0 && wp11_storeExitAfter > 0 && --wp11_storeExitAfter == 0) + _exit(WP11_TEST_STORE_EXIT_CODE); +#endif + + return ret; +} + +static int wolfPKCS11_StoreCommitTemp(WP11_FileStoreCtx* ctx) +{ + int ret = 0; + if (ctx == NULL || ctx->has_temp == 0) { + return 0; + } + + ret = wolfPKCS11_StoreRename(ctx->temp_name, ctx->final_name); if (ret == 0) { ctx->has_temp = 0; } @@ -1614,6 +1646,478 @@ static int wolfPKCS11_Store_Name(int type, CK_ULONG id1, CK_ULONG id2, char* nam return ret; } + +/* One token store pass commits as a unit: staged records, then a marker. */ +#define WP11_STORE_BATCH +#define WP11_STORE_STAGED_MAX (WP11_STORE_MAX_PATH + 8) + +#define WP11_BATCH_DISCARD 0 +#define WP11_BATCH_APPLY 1 +#define WP11_BATCH_CHECK 2 + +typedef struct WP11_StoreBatch { + WP11_Slot* slot; + XFILE intent; +#if defined(_WIN32) || defined(_MSC_VER) + HANDLE lockFile; +#else + int lockFd; +#endif + int locked; + int active; + int failed; + size_t dirLen; + char dir[WP11_STORE_MAX_PATH]; + char intentName[WP11_STORE_STAGED_MAX]; + char commitName[WP11_STORE_STAGED_MAX]; + char lockName[WP11_STORE_STAGED_MAX]; +} WP11_StoreBatch; + +static WP11_StoreBatch storeBatch; + +/** + * Work out the store directory and the batch file names for a token. + * + * @param [in] tokenId Id of token. + * @return 0 on success. + * @return READ_ONLY_E when the names cannot be built. + */ +static int wolfPKCS11_StoreBatchNames(int tokenId) +{ + int ret = 0; + int len; + int i; + int sep = -1; + + len = wolfPKCS11_Store_Name(WOLFPKCS11_STORE_TOKEN, (CK_ULONG)tokenId, 0, + storeBatch.dir, sizeof(storeBatch.dir)); + if (len <= 0 || len >= (int)sizeof(storeBatch.dir)) + ret = READ_ONLY_E; + for (i = 0; ret == 0 && i < len; i++) { + if (storeBatch.dir[i] == '/' || storeBatch.dir[i] == '\\') + sep = i; + } + if (ret == 0 && sep <= 0) + ret = READ_ONLY_E; + if (ret == 0) { + storeBatch.dir[sep] = '\0'; + storeBatch.dirLen = (size_t)sep; + len = XSNPRINTF(storeBatch.intentName, sizeof(storeBatch.intentName), + "%s/wp11_txn_%016lx_intent", storeBatch.dir, + (unsigned long)tokenId); + if (len <= 0 || len >= (int)sizeof(storeBatch.intentName)) + ret = READ_ONLY_E; + } + if (ret == 0) { + len = XSNPRINTF(storeBatch.commitName, sizeof(storeBatch.commitName), + "%s/wp11_txn_%016lx_commit", storeBatch.dir, + (unsigned long)tokenId); + if (len <= 0 || len >= (int)sizeof(storeBatch.commitName)) + ret = READ_ONLY_E; + } + if (ret == 0) { + len = XSNPRINTF(storeBatch.lockName, sizeof(storeBatch.lockName), + "%s/wp11_txn_%016lx_lock", storeBatch.dir, + (unsigned long)tokenId); + if (len <= 0 || len >= (int)sizeof(storeBatch.lockName)) + ret = READ_ONLY_E; + } + + return ret; +} + +/** + * Take or release the lock file that keeps other processes out of the batch + * files while a pass or a recovery runs. + * + * @param [in] lock 1 to take the lock, 0 to release it. + * @return 0 on success. + * @return READ_ONLY_E when the lock cannot be taken. + */ +static int wolfPKCS11_StoreBatchLockFile(int lock) +{ + int ret = 0; +#if defined(_WIN32) || defined(_MSC_VER) + OVERLAPPED ov; + + XMEMSET(&ov, 0, sizeof(ov)); + if (lock) { + storeBatch.lockFile = CreateFileA(storeBatch.lockName, + GENERIC_READ | GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE, + NULL, OPEN_ALWAYS, + FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OPEN_REPARSE_POINT, NULL); + if (storeBatch.lockFile == INVALID_HANDLE_VALUE) + ret = READ_ONLY_E; + if (ret == 0 && !LockFileEx(storeBatch.lockFile, + LOCKFILE_EXCLUSIVE_LOCK, 0, 1, 0, &ov)) { + CloseHandle(storeBatch.lockFile); + ret = READ_ONLY_E; + } + storeBatch.locked = (ret == 0); + } + else if (storeBatch.locked) { + (void)UnlockFileEx(storeBatch.lockFile, 0, 1, 0, &ov); + CloseHandle(storeBatch.lockFile); + storeBatch.locked = 0; + } +#else + struct flock fl; + + XMEMSET(&fl, 0, sizeof(fl)); + fl.l_whence = SEEK_SET; + if (lock) { + storeBatch.lockFd = open(storeBatch.lockName, + O_RDWR | O_CREAT | O_NOFOLLOW, S_IRUSR | S_IWUSR); + if (storeBatch.lockFd < 0) + ret = READ_ONLY_E; + fl.l_type = F_WRLCK; + while (ret == 0 && fcntl(storeBatch.lockFd, F_SETLKW, &fl) != 0) { + if (errno != EINTR) { + close(storeBatch.lockFd); + ret = READ_ONLY_E; + } + } + storeBatch.locked = (ret == 0); + } + else if (storeBatch.locked) { + fl.l_type = F_UNLCK; + (void)fcntl(storeBatch.lockFd, F_SETLK, &fl); + close(storeBatch.lockFd); + storeBatch.locked = 0; + } +#endif + + return ret; +} + +/** + * Check that a listed name is a store file directly in the store directory. + * + * @param [in] name Name read from a batch list. + * @return 1 when acceptable, 0 otherwise. + */ +static int wolfPKCS11_StoreBatchNameOk(const char* name) +{ + size_t len = XSTRLEN(name); + size_t i; + int ok; + + ok = len > storeBatch.dirLen + 6 && + XSTRNCMP(name, storeBatch.dir, storeBatch.dirLen) == 0 && + name[storeBatch.dirLen] == '/' && + XSTRNCMP(name + storeBatch.dirLen + 1, "wp11_", 5) == 0; + for (i = storeBatch.dirLen + 1; ok && i < len; i++) { + if (name[i] == '/' || name[i] == '\\') + ok = 0; + } + + return ok; +} + +/** + * Check that a final record name can be replaced by a rename. + * + * @param [in] name Final record name. + * @return 1 when absent or a regular file, 0 otherwise. + */ +static int wolfPKCS11_StoreBatchReplaceable(const char* name) +{ +#if defined(_WIN32) || defined(_MSC_VER) + DWORD attrs = GetFileAttributesA(name); + + return attrs == INVALID_FILE_ATTRIBUTES || + (attrs & (FILE_ATTRIBUTE_DIRECTORY | + FILE_ATTRIBUTE_REPARSE_POINT)) == 0; +#else + struct stat st; + + if (lstat(name, &st) != 0) + return errno == ENOENT; + return S_ISREG(st.st_mode); +#endif +} + +/** + * Act on each staged record a batch list names: remove it, rename it into + * place, or check that it can be renamed into place. + * + * @param [in] listName Intent or commit file. + * @param [in] mode WP11_BATCH_DISCARD, WP11_BATCH_APPLY or + * WP11_BATCH_CHECK. + * @return 0 on success. + * @return READ_ONLY_E when the list is unreadable or malformed, or a record + * cannot be put in place. Discarding never fails. + */ +static int wolfPKCS11_StoreBatchApply(const char* listName, int mode) +{ + int ret = 0; + XFILE list; + XFILE staged; + size_t len; + char line[WP11_STORE_MAX_PATH + 2]; + char stagedName[WP11_STORE_STAGED_MAX]; + + list = XFOPEN(listName, "rb"); + if (list == XBADFILE) + return (mode == WP11_BATCH_DISCARD) ? 0 : READ_ONLY_E; + while (fgets(line, sizeof(line), list) != NULL) { + len = XSTRLEN(line); + /* The intent can end in a line a crash cut short; a marker cannot. */ + if (len == 0 || line[len - 1] != '\n') { + if (mode != WP11_BATCH_DISCARD) + ret = READ_ONLY_E; + continue; + } + line[len - 1] = '\0'; + len = (size_t)XSNPRINTF(stagedName, sizeof(stagedName), "%s.new", + line); + if (!wolfPKCS11_StoreBatchNameOk(line) || len >= sizeof(stagedName)) { + if (mode != WP11_BATCH_DISCARD) + ret = READ_ONLY_E; + continue; + } + if (mode == WP11_BATCH_DISCARD) { + (void)remove(stagedName); + } + else if (mode == WP11_BATCH_CHECK) { + if (!wolfPKCS11_StoreBatchReplaceable(line)) + ret = READ_ONLY_E; + } + else if (wolfPKCS11_StoreRename(stagedName, line) != 0) { + /* Already renamed by an earlier, interrupted roll forward. */ + staged = XFOPEN(stagedName, "rb"); + if (staged != XBADFILE) { + XFCLOSE(staged); + ret = READ_ONLY_E; + } + } + } + if (ferror(list) && mode != WP11_BATCH_DISCARD) + ret = READ_ONLY_E; + XFCLOSE(list); + + return ret; +} + +/** + * Finish a store pass that reached its commit point, or drop one that did + * not. Caller holds the batch locks and has set the batch names. + * + * @return 0 on success. + * @return READ_ONLY_E when a committed pass could not be finished; the + * marker is kept so a later attempt can finish it. + */ +static int wolfPKCS11_StoreBatchRecover(void) +{ + int ret = 0; + XFILE marker; + + marker = XFOPEN(storeBatch.commitName, "rb"); + if (marker != XBADFILE) { + XFCLOSE(marker); + ret = wolfPKCS11_StoreBatchApply(storeBatch.commitName, + WP11_BATCH_APPLY); + if (ret == 0) + (void)remove(storeBatch.commitName); + } + else { + (void)wolfPKCS11_StoreBatchApply(storeBatch.intentName, + WP11_BATCH_DISCARD); + (void)remove(storeBatch.intentName); + } + + return ret; +} + +/** + * Bring the store for a token to a committed state before it is read. + * + * @param [in] tokenId Id of token. + * @return 0 on success. + * @return Other value when an interrupted pass could not be finished. + */ +static int wolfPKCS11_StoreBatchCheck(int tokenId) +{ + int ret = 0; + XFILE marker; + WP11_Slot* slot; + + if (WP11_Slot_Get((CK_SLOT_ID)tokenId, &slot) != 0) + return 0; + WP11_Lock_LockRW(&slot->storeLock); + if (wolfPKCS11_StoreBatchNames(tokenId) == 0) { + if (wolfPKCS11_StoreBatchLockFile(1) == 0) { + ret = wolfPKCS11_StoreBatchRecover(); + (void)wolfPKCS11_StoreBatchLockFile(0); + } + else { + /* A committed pass that cannot be finished must not be read. */ + marker = XFOPEN(storeBatch.commitName, "rb"); + if (marker != XBADFILE) { + XFCLOSE(marker); + ret = READ_ONLY_E; + } + } + } + WP11_Lock_UnlockRW(&slot->storeLock); + + return ret; +} + +/** + * Start a store pass: records closed from now on are staged, not committed. + * On success the batch locks are held until wolfPKCS11_StoreBatchEnd. Without + * a usable store directory the pass runs unstaged and fails as before. + * + * @param [in] tokenId Id of token being stored. + * @return 0 on success. + * @return Other value when an interrupted pass could not be finished. + */ +static int wolfPKCS11_StoreBatchBegin(int tokenId) +{ + int ret = 0; +#ifndef WOLFPKCS11_NO_ENV + const char* str; +#endif +#if defined(_WIN32) || defined(_MSC_VER) + HANDLE h; +#endif + int fd; + +#ifndef WOLFPKCS11_NO_ENV + /* Storage is turned off, so the pass writes nothing. */ + str = XGETENV("WOLFPKCS11_NO_STORE"); + if (str != NULL) + return 0; +#endif + if (WP11_Slot_Get((CK_SLOT_ID)tokenId, &storeBatch.slot) != 0) + return BAD_FUNC_ARG; + WP11_Lock_LockRW(&storeBatch.slot->storeLock); + ret = wolfPKCS11_StoreBatchNames(tokenId); + if (ret == 0) + ret = wolfPKCS11_StoreEnsureDir(storeBatch.dir); + if (ret == 0) + ret = wolfPKCS11_StoreBatchLockFile(1); + if (ret == 0) + ret = wolfPKCS11_StoreBatchRecover(); + if (ret == 0) { + #if defined(_WIN32) || defined(_MSC_VER) + /* Create afresh without following a link planted at the name. */ + (void)DeleteFileA(storeBatch.intentName); + h = CreateFileA(storeBatch.intentName, GENERIC_WRITE, 0, NULL, + CREATE_NEW, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OPEN_REPARSE_POINT, + NULL); + fd = (h != INVALID_HANDLE_VALUE) ? + _open_osfhandle((intptr_t)h, _O_WRONLY | _O_BINARY) : -1; + if (h != INVALID_HANDLE_VALUE && fd < 0) + CloseHandle(h); + storeBatch.intent = (fd >= 0) ? _fdopen(fd, "wb") : XBADFILE; + if (fd >= 0 && storeBatch.intent == XBADFILE) + _close(fd); + #else + fd = open(storeBatch.intentName, + O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, S_IRUSR | S_IWUSR); + storeBatch.intent = (fd >= 0) ? fdopen(fd, "wb") : XBADFILE; + if (fd >= 0 && storeBatch.intent == XBADFILE) + close(fd); + #endif + if (storeBatch.intent == XBADFILE) + ret = READ_ONLY_E; + } + if (ret == 0) { + storeBatch.active = 1; + storeBatch.failed = 0; + } + else { + (void)wolfPKCS11_StoreBatchLockFile(0); + WP11_Lock_UnlockRW(&storeBatch.slot->storeLock); + storeBatch.slot = NULL; + } + + return ret; +} + +/** + * Stage a written record as ".new" and list it in the intent file. + * + * @param [in, out] ctx File store context with a written temporary file. + * @return 0 on success. + * @return READ_ONLY_E when the record could not be staged. + */ +static int wolfPKCS11_StoreStageTemp(WP11_FileStoreCtx* ctx) +{ + int ret = 0; + int len; + char stagedName[WP11_STORE_STAGED_MAX]; + + len = XSNPRINTF(stagedName, sizeof(stagedName), "%s.new", + ctx->final_name); + if (len <= 0 || len >= (int)sizeof(stagedName)) + ret = READ_ONLY_E; + if (ret == 0) + ret = wolfPKCS11_StoreRename(ctx->temp_name, stagedName); + if (ret == 0) { + ctx->has_temp = 0; + if (fputs(ctx->final_name, storeBatch.intent) < 0 || + fputc('\n', storeBatch.intent) == EOF || + fflush(storeBatch.intent) != 0) { + ret = READ_ONLY_E; + } + } + + return ret; +} + +/** + * End a store pass. When committing, the intent becomes the commit marker and + * the staged records are renamed into place; otherwise they are removed. + * Once the marker exists the pass is committed and reported as such, and any + * record left unrenamed is finished by the next store or load. + * Releases the batch locks taken by wolfPKCS11_StoreBatchBegin. + * + * @param [in] commit 1 when every record of the pass was written. + * @return 0 when the pass is committed or there was nothing to commit. + * @return READ_ONLY_E when the pass was not committed. + */ +static int wolfPKCS11_StoreBatchEnd(int commit) +{ + int ret = 0; + + if (storeBatch.active) { + storeBatch.active = 0; + if (XFCLOSE(storeBatch.intent) != 0) + storeBatch.failed = 1; + storeBatch.intent = XBADFILE; + if (storeBatch.failed) + ret = READ_ONLY_E; + if (ret == 0 && commit) { + ret = wolfPKCS11_StoreBatchApply(storeBatch.intentName, + WP11_BATCH_CHECK); + } + if (ret == 0 && commit) { + ret = wolfPKCS11_StoreRename(storeBatch.intentName, + storeBatch.commitName); + } + if (ret == 0 && commit) { + if (wolfPKCS11_StoreBatchApply(storeBatch.commitName, + WP11_BATCH_APPLY) == 0) { + (void)remove(storeBatch.commitName); + } + } + else { + (void)wolfPKCS11_StoreBatchApply(storeBatch.intentName, + WP11_BATCH_DISCARD); + (void)remove(storeBatch.intentName); + } + (void)wolfPKCS11_StoreBatchLockFile(0); + } + if (storeBatch.slot != NULL) { + WP11_Lock_UnlockRW(&storeBatch.slot->storeLock); + storeBatch.slot = NULL; + } + + return ret; +} #endif int wolfPKCS11_Store_Remove(int type, CK_ULONG id1, CK_ULONG id2) @@ -1914,8 +2418,17 @@ void wolfPKCS11_Store_Close(void* store) } if (ctx->is_write && ctx->has_temp) { - commitRet = wolfPKCS11_StoreCommitTemp(ctx); + #ifdef WP11_STORE_BATCH + if (storeBatch.active) + commitRet = wolfPKCS11_StoreStageTemp(ctx); + else + #endif + commitRet = wolfPKCS11_StoreCommitTemp(ctx); if (commitRet != 0) { + #ifdef WP11_STORE_BATCH + if (storeBatch.active) + storeBatch.failed = 1; + #endif wolfPKCS11_StoreAbortTemp(ctx); #ifdef WOLFPKCS11_DEBUG_STORE printf("Store commit failed for %s (ret %d)\n", @@ -2986,6 +3499,8 @@ int WP11_Object_Copy(WP11_Object *src, WP11_Object *dest) OBJ_COPY_DATA(src, dest, keyData); XMEMCPY(dest->iv, src->iv, sizeof(dest->iv)); dest->encoded = src->encoded; + dest->undecoded = src->undecoded; + dest->unbound = src->unbound; #endif dest->objClass = src->objClass; dest->keyGenMech = src->keyGenMech; @@ -3431,11 +3946,14 @@ int WP11_Object_Copy(WP11_Object *src, WP11_Object *dest) * @param [in] keySz Length of AES key in bytes. * @param [in] iv IV/nonce. * @param [in] ivSz Length of IV in bytes. + * @param [in] aad Additional authenticated data. May be NULL. + * @param [in] aadSz Length of additional authenticated data in bytes. * @return 0 on success. * @return -ve on failure. */ static int wp11_EncryptData(byte* out, byte* data, int len, byte* key, - int keySz, byte* iv, int ivSz, int devId) + int keySz, byte* iv, int ivSz, const byte* aad, + word32 aadSz, int devId) { Aes aes; int ret; @@ -3446,7 +3964,7 @@ static int wp11_EncryptData(byte* out, byte* data, int len, byte* key, } if (ret == 0) { ret = wc_AesGcmEncrypt(&aes, out, data, len, iv, ivSz, out + len, - AES_BLOCK_SIZE, NULL, 0); + AES_BLOCK_SIZE, aad, aadSz); } wc_AesFree(&aes); @@ -3465,12 +3983,15 @@ static int wp11_EncryptData(byte* out, byte* data, int len, byte* key, * @param [in] keySz Length of AES key in bytes. * @param [in] iv IV/nonce. * @param [in] ivSz Length of IV in bytes. + * @param [in] aad Additional authenticated data. May be NULL. + * @param [in] aadSz Length of additional authenticated data in bytes. * @return 0 on success. * @return AES_GCM_AUTH_E when encrypted data could not be verified. * @return Other -ve on failure. */ static int wp11_DecryptData(byte* out, byte* data, int len, byte* key, - int keySz, byte* iv, int ivSz, int devId) + int keySz, byte* iv, int ivSz, const byte* aad, + word32 aadSz, int devId) { Aes aes; int ret; @@ -3481,13 +4002,115 @@ static int wp11_DecryptData(byte* out, byte* data, int len, byte* key, } if (ret == 0) { ret = wc_AesGcmDecrypt(&aes, out, data, len, iv, ivSz, data + len, - AES_BLOCK_SIZE, NULL, 0); + AES_BLOCK_SIZE, aad, aadSz); } wc_AesFree(&aes); return ret; } +/* Set by the SO, who never holds the user's key, or by the library itself. */ +#ifdef WOLFPKCS11_TPM +#define WP11_FLAG_UNBOUND (WP11_FLAG_TRUSTED | WP11_FLAG_TPM) +#else +#define WP11_FLAG_UNBOUND WP11_FLAG_TRUSTED +#endif + +#define WP11_POLICY_AAD_VER 1 +#define WP11_POLICY_AAD_SZ (1 + 3 * sizeof(CK_ULONG) + 1 + sizeof(word32)) + +/** + * Serialize the object attributes that govern use of its key material. + * + * @param [in] object Key object. + * @param [out] aad Buffer of WP11_POLICY_AAD_SZ bytes. + */ +static void wp11_Object_PolicyAad(WP11_Object* object, byte* aad) +{ + CK_ULONG vals[3]; + word32 flags = object->opFlag & ~(word32)WP11_FLAG_UNBOUND; + int idx = 0; + int i; + int j; + + vals[0] = object->objClass; + vals[1] = object->type; + vals[2] = object->keyGenMech; + aad[idx++] = WP11_POLICY_AAD_VER; + for (i = 0; i < 3; i++) { + for (j = (int)sizeof(CK_ULONG) - 1; j >= 0; j--) + aad[idx++] = (byte)(vals[i] >> (j * 8)); + } + aad[idx++] = (byte)object->local; + for (j = (int)sizeof(word32) - 1; j >= 0; j--) + aad[idx++] = (byte)(flags >> (j * 8)); +} + +/** + * Encrypt key material with the token key, bound to the object's policy. + * + * @param [in, out] object Key object. + * @param [out] out Buffer for encrypted data and tag. + * @param [in] data Key material. + * @param [in] len Length of key material. + * @return 0 on success. + * @return -ve on failure. + */ +static int wp11_Object_EncryptKeyData(WP11_Object* object, byte* out, + byte* data, int len) +{ + int ret; + byte aad[WP11_POLICY_AAD_SZ]; + + wp11_Object_PolicyAad(object, aad); + ret = wp11_EncryptData(out, data, len, object->slot->token.key, + sizeof(object->slot->token.key), object->iv, + sizeof(object->iv), aad, sizeof(aad), + object->devId); + if (ret == 0) + object->unbound = 0; + + return ret; +} + +/** + * Decrypt key material with the token key, verifying the object's policy. + * Key data stored before the policy was bound is accepted and marked so it is + * bound when next stored. + * + * @param [in, out] object Key object. + * @param [out] out Buffer for decrypted key material. + * @param [in] data Encrypted data and tag. + * @param [in] len Length of encrypted data. + * @return 0 on success. + * @return AES_GCM_AUTH_E when encrypted data could not be verified. + * @return Other -ve on failure. + */ +static int wp11_Object_DecryptKeyData(WP11_Object* object, byte* out, + byte* data, int len) +{ + int ret; + byte aad[WP11_POLICY_AAD_SZ]; + + wp11_Object_PolicyAad(object, aad); + ret = wp11_DecryptData(out, data, len, object->slot->token.key, + sizeof(object->slot->token.key), object->iv, + sizeof(object->iv), aad, sizeof(aad), + object->devId); + if (ret == AES_GCM_AUTH_E) { + ret = wp11_DecryptData(out, data, len, object->slot->token.key, + sizeof(object->slot->token.key), object->iv, + sizeof(object->iv), NULL, 0, object->devId); + if (ret == 0) + object->unbound = 1; + } + + return ret; +} + +static int wp11_Object_IsEncrypted(WP11_Object* object); +static int wp11_Object_Encode(WP11_Object* object, int protect); + /** * Finish encoding key data into a new buffer: on success release the previous * record, on failure drop the new buffer and put the previous record back so @@ -4283,10 +4906,7 @@ static int wp11_Object_Decode_RsaKey(WP11_Object* object) ret = MEMORY_E; } if (ret == 0) { - ret = wp11_DecryptData(der, object->keyData, len, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_DecryptKeyData(object, der, object->keyData, len); } if (ret == 0) { /* Decode RSA private key. */ @@ -4383,10 +5003,8 @@ static int wp11_Object_Encode_RsaKey(WP11_Object* object) ret = wc_RsaKeyToDer(object->data.rsaKey, object->keyData, object->keyDataLen); if (ret >= 0) { - ret = wp11_EncryptData(object->keyData, object->keyData, ret, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_EncryptKeyData(object, object->keyData, + object->keyData, ret); } #else ret = NOT_COMPILED_IN; @@ -4639,10 +5257,7 @@ static int wp11_Object_Decode_EccKey(WP11_Object* object) ret = MEMORY_E; } if (ret == 0) { - ret = wp11_DecryptData(der, object->keyData, len, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_DecryptKeyData(object, der, object->keyData, len); } if (ret == 0) { /* Decode ECC private key. */ @@ -4729,10 +5344,8 @@ static int wp11_Object_Encode_EccKey(WP11_Object* object) ret = wc_EccPrivateKeyToDer(object->data.ecKey, object->keyData, object->keyDataLen); if (ret >= 0) { - ret = wp11_EncryptData(object->keyData, object->keyData, ret, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_EncryptKeyData(object, object->keyData, + object->keyData, ret); } } else if (ret == 0 && object->objClass == CKO_PUBLIC_KEY) { @@ -4887,10 +5500,7 @@ static int wp11_Object_Decode_MldsaKey(WP11_Object* object) ret = MEMORY_E; } if (ret == 0) { - ret = wp11_DecryptData(der, object->keyData, len, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_DecryptKeyData(object, der, object->keyData, len); } if (ret == 0) { /* Decode ML-DSA private key. */ @@ -4977,10 +5587,8 @@ static int wp11_Object_Encode_MldsaKey(WP11_Object* object) object->keyData, object->keyDataLen); if (ret >= 0) { - ret = wp11_EncryptData(object->keyData, object->keyData, ret, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_EncryptKeyData(object, object->keyData, + object->keyData, ret); } } else if (ret == 0 && object->objClass == CKO_PUBLIC_KEY) { @@ -5100,12 +5708,8 @@ static int wp11_Object_Decode_DhKey(WP11_Object* object) else if (object->keyDataLen - AES_BLOCK_SIZE > WP11_MAX_DH_KEY_SZ) ret = BUFFER_E; if (ret == 0) { - ret = wp11_DecryptData(object->data.dhKey->key, object->keyData, - object->keyDataLen - AES_BLOCK_SIZE, - object->slot->token.key, - sizeof(object->slot->token.key), - object->iv, sizeof(object->iv), - object->devId); + ret = wp11_Object_DecryptKeyData(object, object->data.dhKey->key, + object->keyData, object->keyDataLen - AES_BLOCK_SIZE); if (ret != 0) { wc_ForceZero(object->data.dhKey->key, (word32)(object->keyDataLen - AES_BLOCK_SIZE)); @@ -5151,11 +5755,9 @@ static int wp11_Object_Encode_DhKey(WP11_Object* object) if (ret == 0) { if (object->objClass == CKO_PRIVATE_KEY) { - ret = wp11_EncryptData(object->keyData, object->data.dhKey->key, - object->data.dhKey->len, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_EncryptKeyData(object, object->keyData, + object->data.dhKey->key, + object->data.dhKey->len); if (ret == 0) object->keyDataLen = object->data.dhKey->len + AES_BLOCK_SIZE; } @@ -5480,10 +6082,7 @@ static int wp11_Object_Decode_MlKemKey(WP11_Object* object) ret = MEMORY_E; } if (ret == 0) { - ret = wp11_DecryptData(der, object->keyData, len, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_DecryptKeyData(object, der, object->keyData, len); } if (ret == 0) { ret = MlKemKeyTryDecode(object->data.mlKemKey, WC_ML_KEM_512, @@ -5564,10 +6163,8 @@ static int wp11_Object_Encode_MlKemKey(WP11_Object* object) ret = wc_MlKemKey_EncodePrivateKey(object->data.mlKemKey, object->keyData, keyLen); if (ret == 0) { - ret = wp11_EncryptData(object->keyData, object->keyData, keyLen, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_EncryptKeyData(object, object->keyData, + object->keyData, keyLen); } } else if (ret == 0 && object->objClass == CKO_PUBLIC_KEY) { @@ -6486,11 +7083,9 @@ static int wp11_Object_Decode_SymmKey(WP11_Object* object) (word32)(object->keyDataLen - AES_BLOCK_SIZE) > WP11_MAX_SYM_KEY_SZ) ret = BUFFER_E; if (ret == 0) { - ret = wp11_DecryptData(object->data.symmKey->data, object->keyData, - object->keyDataLen - AES_BLOCK_SIZE, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_DecryptKeyData(object, object->data.symmKey->data, + object->keyData, + object->keyDataLen - AES_BLOCK_SIZE); if (ret != 0) { wc_ForceZero(object->data.symmKey->data, (word32)(object->keyDataLen - AES_BLOCK_SIZE)); @@ -6525,11 +7120,9 @@ static int wp11_Object_Encode_SymmKey(WP11_Object* object) ret = MEMORY_E; if (ret == 0) { - ret = wp11_EncryptData(object->keyData, object->data.symmKey->data, - object->data.symmKey->len, - object->slot->token.key, - sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + ret = wp11_Object_EncryptKeyData(object, object->keyData, + object->data.symmKey->data, + object->data.symmKey->len); } wp11_Object_EncodeDone(object, oldData, oldLen, newLen, ret); @@ -6796,6 +7389,8 @@ static int wp11_Object_Load(WP11_Object* object, int tokenId, int objId) } } } + if (ret == 0 && wp11_Object_IsEncrypted(object)) + object->undecoded = 1; return ret; } @@ -6913,10 +7508,15 @@ static int wp11_Object_Store_Object(WP11_Object* object, int tokenId, int objId) */ static int wp11_Object_Store(WP11_Object* object, int tokenId, int objId) { - int ret; + int ret = 0; + /* Bind decoded key data to the current policy before writing anything, so + * a failure leaves the stored record unchanged. */ + if (object->unbound && !object->encoded && wp11_Object_IsEncrypted(object)) + ret = wp11_Object_Encode(object, 0); /* Open access to key object. */ - ret = wp11_Object_Store_Object(object, tokenId, objId); + if (ret == 0) + ret = wp11_Object_Store_Object(object, tokenId, objId); if (ret == 0) { if (object->objClass == CKO_CERTIFICATE) { @@ -7066,6 +7666,8 @@ static int wp11_Object_Decode(WP11_Object* object) } } + if (ret == 0) + object->undecoded = 0; /* Authentication failure means this object isn't for this user. */ if (ret == AES_GCM_AUTH_E) ret = 0; @@ -7267,6 +7869,7 @@ static int wp11_Object_ReKey(WP11_Object* object, byte* oldKey, byte* newKey, int ret = 0; int len = 0; byte* plain = NULL; + byte aad[WP11_POLICY_AAD_SZ]; /* Key data is the encrypted payload followed by the AES-GCM tag. */ if (object->keyDataLen < AES_BLOCK_SIZE) @@ -7281,9 +7884,18 @@ static int wp11_Object_ReKey(WP11_Object* object, byte* oldKey, byte* newKey, ret = MEMORY_E; } if (ret == 0) { + wp11_Object_PolicyAad(object, aad); ret = wp11_DecryptData(plain, object->keyData, len, oldKey, sizeof(object->slot->token.key), object->iv, - sizeof(object->iv), object->devId); + sizeof(object->iv), aad, sizeof(aad), + object->devId); + /* Key data stored before policy binding has no AAD. */ + if (ret == AES_GCM_AUTH_E) { + ret = wp11_DecryptData(plain, object->keyData, len, oldKey, + sizeof(object->slot->token.key), + object->iv, sizeof(object->iv), NULL, 0, + object->devId); + } } if (ret == 0) { WP11_Lock_LockRW(&object->slot->token.rngLock); @@ -7294,7 +7906,8 @@ static int wp11_Object_ReKey(WP11_Object* object, byte* oldKey, byte* newKey, if (ret == 0) { ret = wp11_EncryptData(reKey->keyData, plain, len, newKey, sizeof(object->slot->token.key), reKey->iv, - sizeof(reKey->iv), object->devId); + sizeof(reKey->iv), aad, sizeof(aad), + object->devId); } if (plain != NULL) { @@ -7833,9 +8446,16 @@ static int wp11_Token_Load(WP11_Slot* slot, int tokenId, WP11_Token* token) int objCnt = 0; word32 len; + ret = 0; +#ifdef WP11_STORE_BATCH + /* Finish or drop a store pass that a crash interrupted. */ + ret = wolfPKCS11_StoreBatchCheck(tokenId); +#endif /* Open access to token object. */ - ret = wp11_storage_open_readonly(WOLFPKCS11_STORE_TOKEN, tokenId, 0, - &storage); + if (ret == 0) { + ret = wp11_storage_open_readonly(WOLFPKCS11_STORE_TOKEN, tokenId, 0, + &storage); + } if (ret == 0) { /* Read label for token. (32) */ ret = wp11_storage_read_string(storage, token->label, @@ -7990,7 +8610,7 @@ static int wp11_Token_Load(WP11_Slot* slot, int tokenId, WP11_Token* token) * @return BUFFER_E when storing fails. * @return NOT_AVAILABLE_E when unable to write data. */ -static int wp11_Token_Store(WP11_Token* token, int tokenId) +static int wp11_Token_StorePass(WP11_Token* token, int tokenId) { int ret; int i; @@ -8123,6 +8743,34 @@ static int wp11_Token_Store(WP11_Token* token, int tokenId) return ret; } + +/** + * Store the token and its objects as one pass that commits as a unit. + * + * @param [in] token Token object. + * @param [in] tokenId Id of token. + * @return 0 on success. + * @return Other value when the pass did not commit. + */ +static int wp11_Token_Store(WP11_Token* token, int tokenId) +{ + int ret; +#ifdef WP11_STORE_BATCH + int endRet; + + ret = wolfPKCS11_StoreBatchBegin(tokenId); + if (ret == 0) { + ret = wp11_Token_StorePass(token, tokenId); + endRet = wolfPKCS11_StoreBatchEnd(ret == 0); + if (ret == 0) + ret = endRet; + } +#else + ret = wp11_Token_StorePass(token, tokenId); +#endif + + return ret; +} #endif /* !WOLFPKCS11_NO_STORE */ /** @@ -8242,6 +8890,9 @@ static void wp11_Slot_Final(WP11_Slot* slot) wp11_Token_Final(&slot->token); #ifdef WOLFPKCS11_TPM wp11_TpmFinal(slot); +#endif +#ifndef WOLFPKCS11_NO_STORE + WP11_Lock_Free(&slot->storeLock); #endif WP11_Lock_Free(&slot->callLock); WP11_Lock_Free(&slot->lock); @@ -8277,6 +8928,15 @@ static int wp11_Slot_Init(WP11_Slot* slot, int id) WP11_Lock_Free(&slot->lock); } } +#ifndef WOLFPKCS11_NO_STORE + if (ret == 0) { + ret = WP11_Lock_Init(&slot->storeLock); + if (ret != 0) { + WP11_Lock_Free(&slot->callLock); + WP11_Lock_Free(&slot->lock); + } + } +#endif if (ret == 0) { #if defined(WOLFPKCS11_TPM) ret = wp11_TpmInit(slot); @@ -8844,6 +9504,9 @@ int WP11_Slot_TokenReset(WP11_Slot* slot, char* pin, int pinLen, char* label) { int ret; WP11_Token* token; +#ifdef WP11_STORE_BATCH + char emptyLabel[LABEL_SZ]; +#endif WP11_Lock_LockRW(&slot->lock); /* Zeroizes token. */ @@ -8858,8 +9521,25 @@ int WP11_Slot_TokenReset(WP11_Slot* slot, char* pin, int pinLen, char* label) WP11_Lock_UnlockRW(&slot->lock); /* Locking used in setting SO PIN. */ - if (ret == 0) + if (ret == 0) { ret = WP11_Slot_SetSOPin(slot, pin, pinLen); +#ifdef WP11_STORE_BATCH + /* Only a staged store pass is known to leave storage unchanged. */ + if (ret != 0) { + /* Reset not stored: restore the token that is still in storage. */ + XMEMSET(emptyLabel, 0, sizeof(emptyLabel)); + WP11_Lock_LockRW(&slot->lock); + wp11_Token_Final(token); + if (wp11_Token_Init(token, emptyLabel) == 0) { + WP11_Lock_UnlockRW(&slot->lock); + (void)wp11_Slot_Load(slot, (int)slot->id); + } + else { + WP11_Lock_UnlockRW(&slot->lock); + } + } +#endif + } return ret; } @@ -9625,9 +10305,21 @@ int WP11_Slot_SetSOPin(WP11_Slot* slot, char* pin, int pinLen) { int ret = 0; WP11_Token* token; +#ifdef WP11_STORE_BATCH + byte oldPin[PIN_HASH_SZ]; + byte oldPinSeed[PIN_SEED_SZ]; + int oldPinLen; + int oldFlags; +#endif WP11_Lock_LockRW(&slot->lock); token = &slot->token; +#ifdef WP11_STORE_BATCH + XMEMCPY(oldPin, token->soPin, sizeof(oldPin)); + XMEMCPY(oldPinSeed, token->soPinSeed, sizeof(oldPinSeed)); + oldPinLen = token->soPinLen; + oldFlags = token->tokenFlags; +#endif /* New seed each time. */ WP11_Lock_LockRW(&slot->token.rngLock); ret = wc_RNG_GenerateBlock(&slot->token.rng, token->soPinSeed, @@ -9646,9 +10338,22 @@ int WP11_Slot_SetSOPin(WP11_Slot* slot, char* pin, int pinLen) token->tokenFlags |= WP11_TOKEN_FLAG_SO_PIN_SET; #ifndef WOLFPKCS11_NO_STORE ret = wp11_Token_Store(token, (int)slot->id); + #ifdef WP11_STORE_BATCH + if (ret != 0 && (oldFlags & WP11_TOKEN_FLAG_SO_PIN_SET)) { + /* Keep the PIN that is still in storage in effect. */ + XMEMCPY(token->soPin, oldPin, sizeof(oldPin)); + XMEMCPY(token->soPinSeed, oldPinSeed, sizeof(oldPinSeed)); + token->soPinLen = oldPinLen; + token->tokenFlags = oldFlags; + } + #endif #endif } WP11_Lock_UnlockRW(&slot->lock); +#ifdef WP11_STORE_BATCH + wc_ForceZero(oldPin, sizeof(oldPin)); + wc_ForceZero(oldPinSeed, sizeof(oldPinSeed)); +#endif return ret; } @@ -9757,6 +10462,7 @@ static int wp11_Slot_SetUserPin(WP11_Slot* slot, char* oldPin, int oldPinLen, #ifndef WOLFPKCS11_NO_STORE WP11_ReKeyData* reKey = NULL; int reKeyCnt = 0; + WP11_Object* object; #endif #ifndef WOLFPKCS11_NO_TIME time_t now = 0; @@ -9866,6 +10572,15 @@ static int wp11_Slot_SetUserPin(WP11_Slot* slot, char* oldPin, int oldPinLen, sizeof(d->prev.seed)) != 0) { ret = BAD_STATE_E; } + /* Bind pending policy changes under the old key first, so every + * record re-keys from key data that verifies. */ + for (object = token->object; ret == 0 && object != NULL; + object = object->next) { + if (object->unbound && !object->encoded && + wp11_Object_IsEncrypted(object)) { + ret = wp11_Object_Encode(object, 0); + } + } if (ret == 0) { ret = wp11_Token_ReKeyPrepare(token, d->oldKey, d->key, &reKey, &reKeyCnt); @@ -9890,9 +10605,11 @@ static int wp11_Slot_SetUserPin(WP11_Slot* slot, char* oldPin, int oldPinLen, if (ret != 0) { wp11_Token_ReKeySwap(reKey, reKeyCnt); wp11_Token_RestoreUserPinState(token, &d->prev); + #ifndef WP11_STORE_BATCH /* Best effort to put the previous state back in storage. */ (void)wp11_Token_Store(token, (int)slot->id); token->objCnt = d->prev.objCnt; + #endif } #endif } @@ -14482,6 +15199,40 @@ static int WP11_Object_SetEndDate(WP11_Object* object, char* endDate, int len) return ret; } +#ifndef WOLFPKCS11_NO_STORE +/** + * Track a change to a token object's policy so its key data is bound to the + * new policy when next stored. The change is undone when the key data is not + * decoded, as it could not be bound. Caller holds the object's lock when it + * is on a token. + * + * @param object [in] Object object. + * @param prevClass [in] Object class before the change. + * @param prevFlag [in] Operational flags before the change. + * @return BAD_STATE_E when the key data is not decoded. + * 0 on success. + */ +static int wp11_Object_PolicyChanged(WP11_Object* object, + CK_OBJECT_CLASS prevClass, word32 prevFlag) +{ + int ret = 0; + + if (object->onToken && wp11_Object_IsEncrypted(object) && + (object->objClass != prevClass || + ((object->opFlag ^ prevFlag) & ~(word32)WP11_FLAG_UNBOUND) != 0)) { + if (object->encoded || object->undecoded) { + object->objClass = prevClass; + object->opFlag = prevFlag; + ret = BAD_STATE_E; + } + else { + object->unbound = 1; + } + } + + return ret; +} +#endif /** * Set an attribute against the object. @@ -14492,15 +15243,24 @@ static int WP11_Object_SetEndDate(WP11_Object* object, char* endDate, int len) * @param len [in] Length of attribute data in bytes. * @return BUFFER_E when data is too small. * BAD_FUNC_ARG when type is not supported with object. + * BAD_STATE_E when a policy change cannot be bound to the stored key. * 0 on success. */ int WP11_Object_SetAttr(WP11_Object* object, CK_ATTRIBUTE_TYPE type, byte* data, CK_ULONG len) { int ret = 0; +#ifndef WOLFPKCS11_NO_STORE + CK_OBJECT_CLASS prevClass; + word32 prevFlag; +#endif if (object->onToken) WP11_Lock_LockRW(object->lock); +#ifndef WOLFPKCS11_NO_STORE + prevClass = object->objClass; + prevFlag = object->opFlag; +#endif switch (type) { case CKA_CLASS: @@ -14875,6 +15635,10 @@ int WP11_Object_SetAttr(WP11_Object* object, CK_ATTRIBUTE_TYPE type, byte* data, ret = BAD_FUNC_ARG; break; } +#ifndef WOLFPKCS11_NO_STORE + if (ret == 0) + ret = wp11_Object_PolicyChanged(object, prevClass, prevFlag); +#endif if (object->onToken) WP11_Lock_UnlockRW(object->lock); diff --git a/tests/include.am b/tests/include.am index ed95d9e3..44afb51b 100644 --- a/tests/include.am +++ b/tests/include.am @@ -325,6 +325,12 @@ noinst_PROGRAMS += tests/object_store_decode_test tests_object_store_decode_test_SOURCES = tests/object_store_decode_test.c tests_object_store_decode_test_LDADD = +check_PROGRAMS += tests/object_policy_integrity_test +noinst_PROGRAMS += tests/object_policy_integrity_test +tests_object_policy_integrity_test_SOURCES = \ + tests/object_policy_integrity_test.c +tests_object_policy_integrity_test_LDADD = + if BUILD_STATIC tests_pkcs11test_LDADD += src/libwolfpkcs11.la tests_pkcs11mtt_LDADD += src/libwolfpkcs11.la @@ -391,6 +397,7 @@ tests_nss_configdir_prefix_test_LDADD += src/libwolfpkcs11.la tests_logout_retire_test_LDADD += src/libwolfpkcs11.la tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la tests_object_store_decode_test_LDADD += src/libwolfpkcs11.la +tests_object_policy_integrity_test_LDADD += src/libwolfpkcs11.la else tests_object_id_uniqueness_test_LDADD += src/libwolfpkcs11.la tests_empty_pin_store_test_LDADD += src/libwolfpkcs11.la @@ -449,6 +456,7 @@ tests_nss_configdir_prefix_test_LDADD += src/libwolfpkcs11.la tests_logout_retire_test_LDADD += src/libwolfpkcs11.la tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la tests_object_store_decode_test_LDADD += src/libwolfpkcs11.la +tests_object_policy_integrity_test_LDADD += src/libwolfpkcs11.la endif EXTRA_DIST += tests/unit.h \ diff --git a/tests/object_policy_integrity_test.c b/tests/object_policy_integrity_test.c new file mode 100644 index 00000000..afda742f --- /dev/null +++ b/tests/object_policy_integrity_test.c @@ -0,0 +1,1538 @@ +/* object_policy_integrity_test.c + * + * Copyright (C) 2026 wolfSSL Inc. + * + * This file is part of wolfPKCS11. + * + * wolfPKCS11 is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfPKCS11 is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA + * + * The policy attributes of a protected token key are only honored when they + * match the policy the key material was stored under. Legitimate attribute + * updates, PIN changes and stores written before the policy was bound must + * keep working. Each reload runs in a child process. + */ + +#ifdef HAVE_CONFIG_H + #include +#endif + +#include +#include +#include + +#ifndef WOLFSSL_USER_SETTINGS + #include +#endif +#include +#include +#include +#include + +#ifndef WOLFPKCS11_USER_SETTINGS + #include +#endif +#include +#include + +#ifndef HAVE_PKCS11_STATIC + #include +#endif + +#include "testdata.h" +#include "pkcs11_test_util.h" + +#if !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_TPM_STORE) && \ + !defined(WOLFPKCS11_CUSTOM_STORE) && !defined(WOLFPKCS11_NO_ENV) && \ + !defined(_WIN32) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ + defined(HAVE_AES_CBC) + +#include +#include +#include +#include + +#define TEST_DIR "./store/object_policy_integrity_test" +#define MAX_OBJ_ID 8 +#define MAX_FILE_SZ 16384 + +/* Offsets of the class and operational flags in a stored object record. */ +#define OBJ_CLASS_OFF (12 + sizeof(CK_ULONG)) +#define OBJ_FLAGS_OFF (12 + 3 * sizeof(CK_ULONG) + 1 + 1 + 4) +#define OBJ_IV_SZ 12 +#define TAG_SZ 16 +#define BLOCK_SZ 16 + +#define CHILD_PASS 0 +#define CHILD_FAIL 1 +#define CHILD_SETUP 2 + +static byte soPin[] = "password123456"; +static byte userPin[] = "wolfpkcs11-test"; +static CK_BBOOL ckTrue = CK_TRUE; +static CK_BBOOL ckFalse = CK_FALSE; + +static const char* storeKinds[] = { + "obj", "data", "symmkey", "rsakey_priv", "rsakey_pub", "ecckey_priv", + "ecckey_pub", "dhkey_priv", "dhkey_pub", "cert", "trust", "mldsakey_priv", + "mldsakey_pub", "mlkemkey_priv", "mlkemkey_pub" +}; + +static byte aesKeyValue[32] = { + 0x2f, 0x91, 0x0c, 0x6a, 0xd3, 0x48, 0x75, 0xbe, + 0x13, 0xe0, 0x5c, 0x87, 0x29, 0xfa, 0x64, 0x0b, + 0xc8, 0x3d, 0x9e, 0x51, 0x06, 0xb7, 0x7a, 0x22, + 0xe4, 0x1f, 0x98, 0x6d, 0x30, 0xab, 0x55, 0xc1 +}; +static byte refPlain[BLOCK_SZ] = { + 0x70, 0x6f, 0x6c, 0x69, 0x63, 0x79, 0x2d, 0x72, + 0x65, 0x66, 0x2d, 0x62, 0x6c, 0x6f, 0x63, 0x6b +}; +static byte refCipher[BLOCK_SZ]; + +/* Parameters of the current check, read by the child process. */ +static CK_OBJECT_CLASS keyClass = CKO_SECRET_KEY; +static CK_ATTRIBUTE_TYPE secretAttr = CKA_VALUE; +static const byte* secretNeedle = NULL; +static size_t secretNeedleSz = 0; +static int checkAesUse = 0; +static CK_MECHANISM_TYPE signMech = CKM_VENDOR_DEFINED; +static CK_BBOOL expSensitive = CK_TRUE; +static CK_BBOOL expExtractable = CK_FALSE; +static CK_BBOOL expDecrypt = CK_TRUE; + +static void store_path(char* path, size_t sz, const char* kind, int objId) +{ + if (objId < 0) { + (void)snprintf(path, sz, "%s/wp11_%s_%016lx", TEST_DIR, kind, 1UL); + } + else { + (void)snprintf(path, sz, "%s/wp11_%s_%016lx_%016lx", TEST_DIR, kind, + 1UL, (unsigned long)objId); + } +} + +static void cleanup_test_files(void) +{ + char path[256]; + size_t k; + int i; + + for (k = 0; k < sizeof(storeKinds) / sizeof(*storeKinds); k++) { + for (i = 0; i < MAX_OBJ_ID; i++) { + store_path(path, sizeof(path), storeKinds[k], i); + (void)remove(path); + } + } + store_path(path, sizeof(path), "token", -1); + (void)remove(path); +} + +/* Locate the stored file of the given kind for its single object. */ +static int find_store_file(const char* kind, char* path, size_t sz) +{ + FILE* f; + int i; + + for (i = 0; i < MAX_OBJ_ID; i++) { + store_path(path, sz, kind, i); + f = fopen(path, "rb"); + if (f != NULL) { + fclose(f); + return 0; + } + } + return -1; +} + +static int read_file(const char* path, byte* data, size_t sz, size_t* readSz) +{ + FILE* f = fopen(path, "rb"); + + if (f == NULL) + return -1; + *readSz = fread(data, 1, sz, f); + if (ferror(f) || !feof(f)) { + fclose(f); + return -1; + } + fclose(f); + return 0; +} + +static int write_file(const char* path, const byte* data, size_t sz) +{ + FILE* f = fopen(path, "wb"); + size_t written; + + if (f == NULL) + return -1; + written = fwrite(data, 1, sz, f); + if (fclose(f) != 0 || written != sz) + return -1; + return 0; +} + +static word32 get_be32(const byte* p) +{ + return ((word32)p[0] << 24) | ((word32)p[1] << 16) | + ((word32)p[2] << 8) | (word32)p[3]; +} + +static void put_be32(byte* p, word32 v) +{ + p[0] = (byte)(v >> 24); + p[1] = (byte)(v >> 16); + p[2] = (byte)(v >> 8); + p[3] = (byte)v; +} + +static CK_ULONG get_be_ulong(const byte* p) +{ + CK_ULONG v = 0; + size_t i; + + for (i = 0; i < sizeof(CK_ULONG); i++) + v = (v << 8) | p[i]; + return v; +} + +/* Rewrite the stored flags of the object of the checked class so they read as + * exportable. */ +static int mark_stored_key_exportable(void) +{ + static byte data[MAX_FILE_SZ]; + char path[256]; + size_t sz = 0; + word32 flags; + int i; + int found = 0; + + for (i = 0; i < MAX_OBJ_ID && !found; i++) { + store_path(path, sizeof(path), "obj", i); + if (read_file(path, data, sizeof(data), &sz) == 0 && + sz >= OBJ_FLAGS_OFF + 4 && + get_be_ulong(data + OBJ_CLASS_OFF) == keyClass) { + found = 1; + } + } + if (!found) + return -1; + flags = get_be32(data + OBJ_FLAGS_OFF); + if ((flags & WP11_FLAG_SENSITIVE) == 0 || + (flags & WP11_FLAG_EXTRACTABLE) != 0) + return -1; + flags &= ~(word32)WP11_FLAG_SENSITIVE; + flags |= WP11_FLAG_EXTRACTABLE; + put_be32(data + OBJ_FLAGS_OFF, flags); + return write_file(path, data, sz); +} + +static CK_RV init_slot(CK_SLOT_ID* slot) +{ + CK_RV rv; + CK_C_INITIALIZE_ARGS args; + CK_SLOT_ID slots[16]; + CK_ULONG count = sizeof(slots) / sizeof(*slots); + + XMEMSET(&args, 0, sizeof(args)); + args.flags = CKF_OS_LOCKING_OK; + rv = funcList->C_Initialize(&args); + if (rv == CKR_OK) + rv = funcList->C_GetSlotList(CK_TRUE, slots, &count); + if (rv == CKR_OK && count == 0) + rv = CKR_TOKEN_NOT_PRESENT; + if (rv == CKR_OK) + *slot = slots[0]; + return rv; +} + +static CK_RV provision_token(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_UTF8CHAR label[32]; + CK_FLAGS flags = CKF_SERIAL_SESSION | CKF_RW_SESSION; + + XMEMSET(label, ' ', sizeof(label)); + XMEMCPY(label, "wolfpkcs11", 10); + rv = funcList->C_InitToken(slot, soPin, sizeof(soPin) - 1, label); + if (rv == CKR_OK) + rv = funcList->C_OpenSession(slot, flags, NULL, NULL, &session); + if (rv == CKR_OK) + rv = funcList->C_Login(session, CKU_SO, soPin, sizeof(soPin) - 1); + if (rv == CKR_OK) + rv = funcList->C_InitPIN(session, userPin, sizeof(userPin) - 1); + if (session != CK_INVALID_HANDLE) { + (void)funcList->C_Logout(session); + (void)funcList->C_CloseSession(session); + } + return rv; +} + +static CK_RV open_session(CK_SLOT_ID slot, int login, + CK_SESSION_HANDLE* session) +{ + CK_RV rv; + CK_FLAGS flags = CKF_SERIAL_SESSION | CKF_RW_SESSION; + + rv = funcList->C_OpenSession(slot, flags, NULL, NULL, session); + if (rv == CKR_OK && login) { + rv = funcList->C_Login(*session, CKU_USER, userPin, + (CK_ULONG)sizeof(userPin) - 1); + } + return rv; +} + +static CK_RV find_key(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE* obj) +{ + CK_RV rv; + CK_ULONG count = 0; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + }; + + rv = funcList->C_FindObjectsInit(session, tmpl, 1); + if (rv == CKR_OK) { + rv = funcList->C_FindObjects(session, obj, 1, &count); + (void)funcList->C_FindObjectsFinal(session); + } + if (rv == CKR_OK && count != 1) + rv = CKR_OBJECT_HANDLE_INVALID; + return rv; +} + +static CK_RV aes_encrypt_block(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE obj, + byte* out) +{ + CK_RV rv; + byte iv[BLOCK_SZ]; + CK_MECHANISM mech; + CK_ULONG outSz = BLOCK_SZ; + + XMEMSET(iv, 0, sizeof(iv)); + mech.mechanism = CKM_AES_CBC; + mech.pParameter = iv; + mech.ulParameterLen = sizeof(iv); + rv = funcList->C_EncryptInit(session, &mech, obj); + if (rv == CKR_OK) + rv = funcList->C_Encrypt(session, refPlain, sizeof(refPlain), out, + &outSz); + if (rv == CKR_OK && outSz != BLOCK_SZ) + rv = CKR_FUNCTION_FAILED; + return rv; +} + +/* Sign a fixed digest-sized message with the key. */ +static CK_RV sign_block(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE obj) +{ + CK_RV rv; + CK_MECHANISM mech; + byte msg[32]; + static byte sig[8192]; + CK_ULONG sigSz = sizeof(sig); + + XMEMSET(msg, 0x5a, sizeof(msg)); + mech.mechanism = signMech; + mech.pParameter = NULL; + mech.ulParameterLen = 0; + rv = funcList->C_SignInit(session, &mech, obj); + if (rv == CKR_OK) + rv = funcList->C_Sign(session, msg, sizeof(msg), sig, &sigSz); + return rv; +} + +static CK_RV get_bool(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE obj, + CK_ATTRIBUTE_TYPE type, CK_BBOOL* val) +{ + CK_ATTRIBUTE attr; + + attr.type = type; + attr.pValue = val; + attr.ulValueLen = sizeof(*val); + return funcList->C_GetAttributeValue(session, obj, &attr, 1); +} + +typedef CK_RV (*create_fn)(CK_SESSION_HANDLE session); + +/* Provision a fresh token, create objects with 'create' and persist them. */ +static CK_RV store_objects(create_fn create) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + + cleanup_test_files(); + rv = pkcs11_load(); + if (rv != CKR_OK) + return rv; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = provision_token(slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = create(session); + if (session != CK_INVALID_HANDLE) + (void)funcList->C_CloseSession(session); + (void)funcList->C_Finalize(NULL); + pkcs11_unload(); + return rv; +} + +typedef int (*child_fn)(void); + +/* Run fn in a child process. Returns CHILD_PASS only when it exits normally + * reporting that the invariant held. */ +static int run_in_child(child_fn fn) +{ + pid_t pid; + int status = 0; + + fflush(stdout); + fflush(stderr); + pid = fork(); + if (pid < 0) + return CHILD_SETUP; + if (pid == 0) { + int res = fn(); + fflush(stdout); + fflush(stderr); + _exit(res); + } + if (waitpid(pid, &status, 0) != pid) + return CHILD_SETUP; + if (WIFSIGNALED(status)) { + fprintf(stderr, " reload terminated by signal %d\n", + WTERMSIG(status)); + return CHILD_FAIL; + } + if (!WIFEXITED(status)) + return CHILD_FAIL; + return WEXITSTATUS(status); +} + +/* After logging in, the key signs. */ +static int child_key_signs(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = sign_block(session, obj); + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " signing after reload failed: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static int holds_secret(const byte* buf, size_t sz) +{ + size_t i; + + if (secretNeedle == NULL || sz < secretNeedleSz) + return 0; + for (i = 0; i + secretNeedleSz <= sz; i++) { + if (XMEMCMP(buf + i, secretNeedle, secretNeedleSz) == 0) + return 1; + } + return 0; +} + +static CK_RV create_aes_key_ex(CK_SESSION_HANDLE session, CK_BBOOL priv, + CK_BBOOL sensitive, CK_BBOOL extractable) +{ + CK_RV rv; + CK_OBJECT_CLASS cls = CKO_SECRET_KEY; + CK_KEY_TYPE keyType = CKK_AES; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &cls, sizeof(cls) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &priv, sizeof(priv) }, + { CKA_SENSITIVE, &sensitive, sizeof(sensitive) }, + { CKA_EXTRACTABLE, &extractable, sizeof(extractable) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_DECRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, aesKeyValue, sizeof(aesKeyValue) }, + }; + + rv = funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); + if (rv == CKR_OK) + rv = aes_encrypt_block(session, obj, refCipher); + return rv; +} + +static CK_RV create_aes_key(CK_SESSION_HANDLE session) +{ + return create_aes_key_ex(session, CK_TRUE, CK_TRUE, CK_FALSE); +} + +#ifdef HAVE_ECC +static CK_RV create_ecc_private_key(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS cls = CKO_PRIVATE_KEY; + CK_KEY_TYPE keyType = CKK_EC; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &cls, sizeof(cls) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_SIGN, &ckTrue, sizeof(ckTrue) }, + { CKA_EC_PARAMS, ecc_p256_params, sizeof(ecc_p256_params) }, + { CKA_VALUE, ecc_p256_priv, sizeof(ecc_p256_priv) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} +#endif + +#ifndef NO_RSA +static CK_RV create_rsa_private_key(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS cls = CKO_PRIVATE_KEY; + CK_KEY_TYPE keyType = CKK_RSA; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &cls, sizeof(cls) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_SIGN, &ckTrue, sizeof(ckTrue) }, + { CKA_MODULUS, rsa_2048_modulus, sizeof(rsa_2048_modulus) }, + { CKA_PUBLIC_EXPONENT, rsa_2048_pub_exp, sizeof(rsa_2048_pub_exp) }, + { CKA_PRIVATE_EXPONENT, rsa_2048_priv_exp, sizeof(rsa_2048_priv_exp) }, + { CKA_PRIME_1, rsa_2048_p, sizeof(rsa_2048_p) }, + { CKA_PRIME_2, rsa_2048_q, sizeof(rsa_2048_q) }, + { CKA_EXPONENT_1, rsa_2048_dP, sizeof(rsa_2048_dP) }, + { CKA_EXPONENT_2, rsa_2048_dQ, sizeof(rsa_2048_dQ) }, + { CKA_COEFFICIENT, rsa_2048_u, sizeof(rsa_2048_u) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} +#endif + +#ifndef NO_DH +static CK_RV create_dh_private_key(CK_SESSION_HANDLE session) +{ + CK_OBJECT_CLASS cls = CKO_PRIVATE_KEY; + CK_KEY_TYPE keyType = CKK_DH; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &cls, sizeof(cls) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIME, dh_ffdhe2048_p, sizeof(dh_ffdhe2048_p) }, + { CKA_BASE, dh_ffdhe2048_g, sizeof(dh_ffdhe2048_g) }, + { CKA_VALUE, dh_2048_priv, sizeof(dh_2048_priv) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); +} +#endif + +#ifdef WOLFPKCS11_MLDSA +static CK_RV create_mldsa_key_pair(CK_SESSION_HANDLE session) +{ + CK_MECHANISM mech = { CKM_ML_DSA_KEY_PAIR_GEN, NULL, 0 }; + CK_ULONG paramSet = CKP_ML_DSA_44; + CK_OBJECT_HANDLE pub = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE priv = CK_INVALID_HANDLE; + CK_ATTRIBUTE pubTmpl[] = { + { CKA_PARAMETER_SET, ¶mSet, sizeof(paramSet) }, + { CKA_VERIFY, &ckTrue, sizeof(ckTrue) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + }; + CK_ATTRIBUTE privTmpl[] = { + { CKA_SIGN, &ckTrue, sizeof(ckTrue) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + }; + + return funcList->C_GenerateKeyPair(session, &mech, pubTmpl, + sizeof(pubTmpl) / sizeof(*pubTmpl), privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &pub, &priv); +} +#endif + +#if defined(WOLFPKCS11_MLDSA) || defined(WOLFPKCS11_MLKEM) +static byte pqValue[8192]; +static CK_ULONG pqValueSz = 0; +static CK_MECHANISM_TYPE pqGenMech = CKM_VENDOR_DEFINED; +static CK_ULONG pqParamSet = 0; + +/* Generate an exportable post-quantum key pair and record the private value. */ +static CK_RV create_pq_exportable_key_pair(CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_MECHANISM mech; + CK_OBJECT_HANDLE pub = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE priv = CK_INVALID_HANDLE; + CK_ATTRIBUTE pubTmpl[] = { + { CKA_PARAMETER_SET, &pqParamSet, sizeof(pqParamSet) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + }; + CK_ATTRIBUTE privTmpl[] = { + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + }; + CK_ATTRIBUTE attr; + + mech.mechanism = pqGenMech; + mech.pParameter = NULL; + mech.ulParameterLen = 0; + rv = funcList->C_GenerateKeyPair(session, &mech, pubTmpl, + sizeof(pubTmpl) / sizeof(*pubTmpl), privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &pub, &priv); + if (rv == CKR_OK) { + attr.type = CKA_VALUE; + attr.pValue = pqValue; + attr.ulValueLen = sizeof(pqValue); + rv = funcList->C_GetAttributeValue(session, priv, &attr, 1); + pqValueSz = attr.ulValueLen; + } + if (rv == CKR_OK && (pqValueSz == 0 || pqValueSz > sizeof(pqValue))) + rv = CKR_FUNCTION_FAILED; + return rv; +} + +/* After logging in, the private key value reads back unchanged. */ +static int child_pq_value_kept(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + static byte buf[sizeof(pqValue)]; + CK_ATTRIBUTE attr; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) { + attr.type = CKA_VALUE; + attr.pValue = buf; + attr.ulValueLen = sizeof(buf); + rv = funcList->C_GetAttributeValue(session, obj, &attr, 1); + } + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK || attr.ulValueLen != pqValueSz || + XMEMCMP(buf, pqValue, pqValueSz) != 0) { + fprintf(stderr, " private value not kept: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static void check_pq_round_trip(const char* name, CK_MECHANISM_TYPE genMech, + CK_ULONG paramSet) +{ + CK_RV rv; + char msg[160]; + int res = CHILD_SETUP; + + keyClass = CKO_PRIVATE_KEY; + pqGenMech = genMech; + pqParamSet = paramSet; + rv = store_objects(create_pq_exportable_key_pair); + (void)snprintf(msg, sizeof(msg), "store %s", name); + CHECK_RV(rv, msg, CKR_OK); + if (rv == CKR_OK) + res = run_in_child(child_pq_value_kept); + (void)snprintf(msg, sizeof(msg), "%s private value kept after reload", + name); + CHECK_TRUE(res == CHILD_PASS, msg); + cleanup_test_files(); +} + +static void test_pq_keys_round_trip(void) +{ + printf("\n--- post-quantum private keys round trip ---\n"); +#ifdef WOLFPKCS11_MLDSA + check_pq_round_trip("ML-DSA key pair", CKM_ML_DSA_KEY_PAIR_GEN, + CKP_ML_DSA_44); +#endif +#ifdef WOLFPKCS11_MLKEM + check_pq_round_trip("ML-KEM key pair", CKM_ML_KEM_KEY_PAIR_GEN, + CKP_ML_KEM_768); +#endif +} +#endif + +/* After logging in, the key must not be exported and, for an AES key, must not + * work as the original key. */ +static int child_key_not_exported(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + static byte buf[4096]; + byte out[BLOCK_SZ]; + CK_BBOOL derive = CK_FALSE; + CK_ATTRIBUTE attr; + int res = CHILD_PASS; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv != CKR_OK) { + fprintf(stderr, " login failed: 0x%lx\n", (unsigned long)rv); + res = CHILD_FAIL; + } + if (res == CHILD_PASS && find_key(session, &obj) == CKR_OK) { + attr.type = secretAttr; + attr.pValue = buf; + attr.ulValueLen = sizeof(buf); + rv = funcList->C_GetAttributeValue(session, obj, &attr, 1); + if (rv == CKR_OK && (holds_secret(buf, attr.ulValueLen) || + (secretNeedle == NULL && attr.ulValueLen > 0))) { + fprintf(stderr, " key value was returned\n"); + res = CHILD_FAIL; + } + if (checkAesUse && aes_encrypt_block(session, obj, out) == CKR_OK && + XMEMCMP(out, refCipher, sizeof(out)) == 0) { + fprintf(stderr, " key still operates as the original key\n"); + res = CHILD_FAIL; + } + if (signMech != CKM_VENDOR_DEFINED && + sign_block(session, obj) == CKR_OK) { + fprintf(stderr, " key still signs\n"); + res = CHILD_FAIL; + } + if (get_bool(session, obj, CKA_DERIVE, &derive) == CKR_OK) { + derive = (derive == CK_TRUE) ? CK_FALSE : CK_TRUE; + attr.type = CKA_DERIVE; + attr.pValue = &derive; + attr.ulValueLen = sizeof(derive); + rv = funcList->C_SetAttributeValue(session, obj, &attr, 1); + if (rv == CKR_OK || rv == CKR_USER_NOT_LOGGED_IN) { + fprintf(stderr, " policy update returned 0x%lx\n", + (unsigned long)rv); + res = CHILD_FAIL; + } + } + } + (void)funcList->C_Finalize(NULL); + return res; +} + +/* After logging in, the AES key works as the original key and reports the + * expected policy. */ +static int child_key_intact(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + byte out[BLOCK_SZ]; + byte value[sizeof(aesKeyValue)]; + CK_BBOOL sensitive = CK_FALSE; + CK_BBOOL extractable = CK_TRUE; + CK_BBOOL decrypt = CK_FALSE; + CK_ATTRIBUTE attr; + int res = CHILD_PASS; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = aes_encrypt_block(session, obj, out); + if (rv == CKR_OK && XMEMCMP(out, refCipher, sizeof(out)) != 0) + rv = CKR_FUNCTION_FAILED; + if (rv == CKR_OK) + rv = get_bool(session, obj, CKA_SENSITIVE, &sensitive); + if (rv == CKR_OK) + rv = get_bool(session, obj, CKA_EXTRACTABLE, &extractable); + if (rv == CKR_OK) + rv = get_bool(session, obj, CKA_DECRYPT, &decrypt); + if (rv != CKR_OK) { + fprintf(stderr, " key unusable after reload: 0x%lx\n", + (unsigned long)rv); + res = CHILD_FAIL; + } + else if (sensitive != expSensitive || extractable != expExtractable || + decrypt != expDecrypt) { + fprintf(stderr, " policy not kept: sensitive %d extractable %d " + "decrypt %d\n", sensitive, extractable, decrypt); + res = CHILD_FAIL; + } + else if (sensitive == CK_TRUE) { + attr.type = CKA_VALUE; + attr.pValue = value; + attr.ulValueLen = sizeof(value); + if (funcList->C_GetAttributeValue(session, obj, &attr, 1) == CKR_OK) { + fprintf(stderr, " sensitive key value was returned\n"); + res = CHILD_FAIL; + } + } + (void)funcList->C_Finalize(NULL); + return res; +} + +static void set_aes_check(void) +{ + keyClass = CKO_SECRET_KEY; + secretAttr = CKA_VALUE; + secretNeedle = aesKeyValue + sizeof(aesKeyValue) - 16; + secretNeedleSz = 16; + checkAesUse = 1; + expSensitive = CK_TRUE; + expExtractable = CK_FALSE; + expDecrypt = CK_TRUE; +} + +static void check_stored_policy(const char* name, create_fn create, + CK_OBJECT_CLASS cls, CK_ATTRIBUTE_TYPE type, + const byte* secret, size_t secretSz, int aes, + CK_MECHANISM_TYPE sign) +{ + CK_RV rv; + char msg[160]; + int res = CHILD_SETUP; + + rv = store_objects(create); + (void)snprintf(msg, sizeof(msg), "store %s", name); + CHECK_RV(rv, msg, CKR_OK); + if (rv != CKR_OK) + return; + keyClass = cls; + secretAttr = type; + secretNeedle = NULL; + secretNeedleSz = 0; + if (secret != NULL && secretSz >= 16) { + secretNeedle = secret + secretSz - 16; + secretNeedleSz = 16; + } + checkAesUse = aes; + signMech = sign; + if (sign != CKM_VENDOR_DEFINED) { + res = run_in_child(child_key_signs); + (void)snprintf(msg, sizeof(msg), "%s signs after reload", name); + CHECK_TRUE(res == CHILD_PASS, msg); + res = CHILD_SETUP; + } + if (mark_stored_key_exportable() == 0) + res = run_in_child(child_key_not_exported); + signMech = CKM_VENDOR_DEFINED; + (void)snprintf(msg, sizeof(msg), + "%s keeps the policy it was stored under", name); + CHECK_TRUE(res == CHILD_PASS, msg); + cleanup_test_files(); +} + +static void test_stored_policy_is_authenticated(void) +{ + printf("\n--- stored key policy is authenticated ---\n"); + check_stored_policy("AES key", create_aes_key, CKO_SECRET_KEY, CKA_VALUE, + aesKeyValue, sizeof(aesKeyValue), 1, CKM_VENDOR_DEFINED); +#ifdef HAVE_ECC + check_stored_policy("ECC private key", create_ecc_private_key, + CKO_PRIVATE_KEY, CKA_VALUE, ecc_p256_priv, sizeof(ecc_p256_priv), 0, + CKM_ECDSA); +#endif +#ifndef NO_RSA + check_stored_policy("RSA private key", create_rsa_private_key, + CKO_PRIVATE_KEY, CKA_PRIVATE_EXPONENT, rsa_2048_priv_exp, + sizeof(rsa_2048_priv_exp), 0, CKM_RSA_PKCS); +#endif +#ifndef NO_DH + check_stored_policy("DH private key", create_dh_private_key, + CKO_PRIVATE_KEY, CKA_VALUE, dh_2048_priv, sizeof(dh_2048_priv), 0, + CKM_VENDOR_DEFINED); +#endif +#ifdef WOLFPKCS11_MLDSA + check_stored_policy("ML-DSA private key", create_mldsa_key_pair, + CKO_PRIVATE_KEY, CKA_VALUE, NULL, 0, 0, CKM_ML_DSA); +#endif +} + +/* Tighten the policy of an exportable key while logged in. */ +static CK_RV create_and_restrict_aes_key(CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_DECRYPT, &ckFalse, sizeof(ckFalse) }, + }; + + rv = create_aes_key_ex(session, CK_TRUE, CK_FALSE, CK_TRUE); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) { + rv = funcList->C_SetAttributeValue(session, obj, tmpl, + sizeof(tmpl) / sizeof(*tmpl)); + } + return rv; +} + +/* Restrict the key while logged in, then persist the token by adding another + * object and stop without finalizing. */ +static int child_restrict_and_store(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE data = CK_INVALID_HANDLE; + CK_OBJECT_CLASS dataClass = CKO_DATA; + byte value[] = "stored"; + CK_ATTRIBUTE restrictTmpl[] = { + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + }; + CK_ATTRIBUTE dataTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, value, sizeof(value) - 1 }, + }; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = funcList->C_SetAttributeValue(session, obj, restrictTmpl, 2); + if (rv == CKR_OK) + rv = funcList->C_CreateObject(session, dataTmpl, 3, &data); + if (rv != CKR_OK) { + fprintf(stderr, " restrict and store failed: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static CK_RV create_exportable_aes_key(CK_SESSION_HANDLE session) +{ + return create_aes_key_ex(session, CK_TRUE, CK_FALSE, CK_TRUE); +} + +static CK_RV create_public_aes_key(CK_SESSION_HANDLE session) +{ + return create_aes_key_ex(session, CK_FALSE, CK_TRUE, CK_FALSE); +} + +/* Without the user logged in, a policy change cannot be bound to the stored + * key and is refused, while a label change is accepted. */ +static int child_unbound_update_refused(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + char label[] = "renamed"; + CK_ATTRIBUTE policy[] = { + { CKA_DECRYPT, &ckFalse, sizeof(ckFalse) }, + }; + CK_ATTRIBUTE name[] = { + { CKA_LABEL, label, sizeof(label) - 1 }, + }; + int res = CHILD_PASS; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 0, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv != CKR_OK) { + fprintf(stderr, " public key not found: 0x%lx\n", (unsigned long)rv); + res = CHILD_FAIL; + } + if (res == CHILD_PASS) { + rv = funcList->C_SetAttributeValue(session, obj, policy, 1); + if (rv != CKR_USER_NOT_LOGGED_IN) { + fprintf(stderr, " policy change returned 0x%lx\n", + (unsigned long)rv); + res = CHILD_FAIL; + } + rv = funcList->C_SetAttributeValue(session, obj, name, 1); + if (rv != CKR_OK) { + fprintf(stderr, " label change returned 0x%lx\n", + (unsigned long)rv); + res = CHILD_FAIL; + } + } + (void)funcList->C_Finalize(NULL); + return res; +} + +static void test_legitimate_updates_round_trip(void) +{ + CK_RV rv; + int res = CHILD_SETUP; + + printf("\n--- legitimate policy updates survive a reload ---\n"); + set_aes_check(); + rv = store_objects(create_and_restrict_aes_key); + CHECK_RV(rv, "restrict AES key policy while logged in", CKR_OK); + if (rv == CKR_OK) { + expDecrypt = CK_FALSE; + res = run_in_child(child_key_intact); + } + CHECK_TRUE(res == CHILD_PASS, "restricted policy is kept after reload"); + res = CHILD_SETUP; + if (rv == CKR_OK && mark_stored_key_exportable() == 0) + res = run_in_child(child_key_not_exported); + CHECK_TRUE(res == CHILD_PASS, + "restricted policy cannot be undone in store"); + cleanup_test_files(); + + res = CHILD_SETUP; + set_aes_check(); + rv = store_objects(create_exportable_aes_key); + CHECK_RV(rv, "store exportable AES key", CKR_OK); + if (rv == CKR_OK) + res = run_in_child(child_restrict_and_store); + CHECK_TRUE(res == CHILD_PASS, "restrict key and store while logged in"); + if (res == CHILD_PASS) + res = run_in_child(child_key_intact); + CHECK_TRUE(res == CHILD_PASS, "policy stored while logged in is kept"); + if (res == CHILD_PASS && mark_stored_key_exportable() == 0) + res = run_in_child(child_key_not_exported); + else + res = CHILD_SETUP; + CHECK_TRUE(res == CHILD_PASS, "policy stored while logged in is bound"); + cleanup_test_files(); + + res = CHILD_SETUP; + set_aes_check(); + rv = store_objects(create_public_aes_key); + CHECK_RV(rv, "store public AES key", CKR_OK); + if (rv == CKR_OK) + res = run_in_child(child_unbound_update_refused); + CHECK_TRUE(res == CHILD_PASS, "policy change needs the user's key"); + res = CHILD_SETUP; + if (rv == CKR_OK) + res = run_in_child(child_key_intact); + CHECK_TRUE(res == CHILD_PASS, "public key usable after refused change"); + cleanup_test_files(); +} + +#if (defined(WOLFPKCS11_PBKDF2) || defined(HAVE_SCRYPT)) && \ + !defined(WOLFSSL_STM32U5_DHUK) && \ + !(defined(HAVE_FIPS) && defined(WOLFPKCS11_NSS)) +#define HAVE_LEGACY_STORE_TEST + +/* Derive the token storage key from the user PIN and the stored token seed, + * the way stores have always been keyed. */ +static int derive_token_key(byte* key, word32 keySz) +{ + static byte data[MAX_FILE_SZ]; + char path[256]; + size_t sz = 0; + size_t off = 32; + byte* seed; + + store_path(path, sizeof(path), "token", -1); + if (read_file(path, data, sizeof(data), &sz) != 0) + return -1; + /* label, SO PIN, SO seed, SO fail count and times */ + if (sz < off + 4) + return -1; + off += 4 + get_be32(data + off) + 16 + 4 + 2 * sizeof(time_t); + /* user PIN, user seed, user fail count and times */ + if (sz < off + 4) + return -1; + off += 4 + get_be32(data + off) + 16 + 4 + 2 * sizeof(time_t); + if (sz < off + 16) + return -1; + seed = data + off; +#ifdef WOLFPKCS11_PBKDF2 + return wc_PBKDF2(key, userPin, (int)sizeof(userPin) - 1, seed, 16, + PBKDF2_ITERATIONS, (int)keySz, WC_SHA256); +#else + return wc_scrypt(key, userPin, (int)sizeof(userPin) - 1, seed, 16, + WP11_HASH_PIN_COST, WP11_HASH_PIN_BLOCKSIZE, + WP11_HASH_PIN_PARALLEL, (int)keySz); +#endif +} + +static int read_stored_iv(byte* iv) +{ + static byte data[MAX_FILE_SZ]; + char path[256]; + size_t sz = 0; + + if (find_store_file("obj", path, sizeof(path)) != 0 || + read_file(path, data, sizeof(data), &sz) != 0 || sz < OBJ_IV_SZ) + return -1; + XMEMCPY(iv, data, OBJ_IV_SZ); + return 0; +} + +/* Replace the stored AES key with an encryption that binds no policy. */ +static int write_unbound_key_record(void) +{ + byte key[32]; + byte iv[OBJ_IV_SZ]; + byte rec[4 + sizeof(aesKeyValue) + TAG_SZ]; + char path[256]; + Aes aes; + int ret; + + ret = derive_token_key(key, sizeof(key)); + if (ret == 0) + ret = read_stored_iv(iv); + if (ret == 0) + ret = find_store_file("symmkey", path, sizeof(path)); + if (ret == 0) + ret = wc_AesInit(&aes, NULL, INVALID_DEVID); + if (ret == 0) { + ret = wc_AesGcmSetKey(&aes, key, sizeof(key)); + if (ret == 0) { + ret = wc_AesGcmEncrypt(&aes, rec + 4, aesKeyValue, + sizeof(aesKeyValue), iv, sizeof(iv), + rec + 4 + sizeof(aesKeyValue), TAG_SZ, NULL, 0); + } + wc_AesFree(&aes); + } + if (ret == 0) { + put_be32(rec, (word32)(sizeof(aesKeyValue) + TAG_SZ)); + ret = write_file(path, rec, sizeof(rec)); + } + wc_ForceZero(key, sizeof(key)); + return ret; +} + +/* Returns 1 when the stored AES key record still verifies without a policy. */ +static int stored_key_is_unbound(void) +{ + static byte data[MAX_FILE_SZ]; + byte key[32]; + byte iv[OBJ_IV_SZ]; + byte plain[sizeof(aesKeyValue)]; + char path[256]; + size_t sz = 0; + Aes aes; + int ret; + int unbound = 0; + + ret = derive_token_key(key, sizeof(key)); + if (ret == 0) + ret = read_stored_iv(iv); + if (ret == 0) + ret = find_store_file("symmkey", path, sizeof(path)); + if (ret == 0) + ret = read_file(path, data, sizeof(data), &sz); + if (ret == 0 && (sz != 4 + sizeof(aesKeyValue) + TAG_SZ || + get_be32(data) != sizeof(aesKeyValue) + TAG_SZ)) + ret = -1; + if (ret == 0) + ret = wc_AesInit(&aes, NULL, INVALID_DEVID); + if (ret == 0) { + ret = wc_AesGcmSetKey(&aes, key, sizeof(key)); + if (ret == 0) { + ret = wc_AesGcmDecrypt(&aes, plain, data + 4, sizeof(plain), iv, + sizeof(iv), data + 4 + sizeof(plain), TAG_SZ, NULL, 0); + unbound = (ret == 0); + } + wc_AesFree(&aes); + } + wc_ForceZero(key, sizeof(key)); + wc_ForceZero(plain, sizeof(plain)); + return unbound; +} + +static void test_unbound_store_upgraded(void) +{ + CK_RV rv; + int res = CHILD_SETUP; + + printf("\n--- store without bound policy loads and is upgraded ---\n"); + rv = store_objects(create_aes_key); + CHECK_RV(rv, "store AES key", CKR_OK); + if (rv == CKR_OK && write_unbound_key_record() == 0 && + stored_key_is_unbound()) { + set_aes_check(); + res = run_in_child(child_key_intact); + } + CHECK_TRUE(res == CHILD_PASS, "unbound key record still loads"); + CHECK_TRUE(res == CHILD_PASS && !stored_key_is_unbound(), + "key record is rebound to its policy after use"); + if (res == CHILD_PASS) + res = run_in_child(child_key_intact); + CHECK_TRUE(res == CHILD_PASS, "rebound key loads again"); + res = CHILD_SETUP; + if (mark_stored_key_exportable() == 0) + res = run_in_child(child_key_not_exported); + CHECK_TRUE(res == CHILD_PASS, "rebound key keeps its policy"); + cleanup_test_files(); +} +#endif + +static byte otherUserPin[] = "wolfpkcs11-other"; + +/* Store passes that cannot start must leave the PIN and token in effect. */ +static int child_failed_store_keeps_state(void) +{ + CK_RV rv; + CK_RV setRv = CKR_OK; + CK_RV initRv = CKR_OK; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_UTF8CHAR label[32]; + byte out[BLOCK_SZ]; + char lockPath[256]; + + (void)snprintf(lockPath, sizeof(lockPath), "%s/wp11_txn_%016lx_lock", + TEST_DIR, 1UL); + XMEMSET(label, ' ', sizeof(label)); + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + /* A directory at the lock file name makes every store pass fail. */ + (void)unlink(lockPath); + if (rv == CKR_OK && mkdir(lockPath, 0700) != 0) + rv = CKR_GENERAL_ERROR; + if (rv == CKR_OK) { + setRv = funcList->C_SetPIN(session, userPin, sizeof(userPin) - 1, + otherUserPin, sizeof(otherUserPin) - 1); + (void)funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; + initRv = funcList->C_InitToken(slot, soPin, sizeof(soPin) - 1, label); + } + (void)rmdir(lockPath); + if (rv == CKR_OK && (setRv == CKR_OK || initRv == CKR_OK)) + rv = CKR_GENERAL_ERROR; + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = aes_encrypt_block(session, obj, out); + if (rv == CKR_OK && XMEMCMP(out, refCipher, sizeof(out)) != 0) + rv = CKR_FUNCTION_FAILED; + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " old PIN or key lost after failed stores: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static void test_failed_store_keeps_state(void) +{ + CK_RV rv; + + printf("\n--- failed PIN change and token init keep stored state ---\n"); + set_aes_check(); + rv = store_objects(create_aes_key); + CHECK_RV(rv, "store AES key", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(run_in_child(child_failed_store_keeps_state) == CHILD_PASS, + "old PIN and key work after failed stores"); + } + cleanup_test_files(); +} + +#ifdef DEBUG_WOLFPKCS11 +/* Matches WP11_TEST_STORE_EXIT_CODE in wolfpkcs11/internal.h. */ +#define STORE_EXIT_CODE 75 +#define CRASH_MAX_RENAMES 40 + +extern void WP11_Test_StoreExitAfterRenames(int renames); + +static int crashAt = 0; + +/* Restrict the key and store the token, ending after crashAt renames. */ +static int child_restrict_and_crash(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE data = CK_INVALID_HANDLE; + CK_OBJECT_CLASS dataClass = CKO_DATA; + byte value[] = "stored"; + CK_ATTRIBUTE restrictTmpl[] = { + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + }; + CK_ATTRIBUTE dataTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, value, sizeof(value) - 1 }, + }; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = funcList->C_SetAttributeValue(session, obj, restrictTmpl, 2); + if (rv == CKR_OK) { + WP11_Test_StoreExitAfterRenames(crashAt); + rv = funcList->C_CreateObject(session, dataTmpl, 3, &data); + WP11_Test_StoreExitAfterRenames(0); + } + return (rv == CKR_OK) ? CHILD_PASS : CHILD_FAIL; +} + +/* The key loads and encrypts as before, under the old or the new policy. */ +static int child_key_old_or_new(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + byte out[BLOCK_SZ]; + CK_BBOOL sensitive = CK_FALSE; + CK_BBOOL extractable = CK_FALSE; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = aes_encrypt_block(session, obj, out); + if (rv == CKR_OK && XMEMCMP(out, refCipher, sizeof(out)) != 0) + rv = CKR_FUNCTION_FAILED; + if (rv == CKR_OK) + rv = get_bool(session, obj, CKA_SENSITIVE, &sensitive); + if (rv == CKR_OK) + rv = get_bool(session, obj, CKA_EXTRACTABLE, &extractable); + if (rv == CKR_OK && sensitive == extractable) + rv = CKR_GENERAL_ERROR; + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " key not usable after crash at rename %d: 0x%lx\n", + crashAt, (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static void test_store_pass_is_atomic(void) +{ + CK_RV rv; + int res; + int done = 0; + int bad = 0; + + printf("\n--- a store pass cut short at any rename keeps the key ---\n"); + for (crashAt = 1; !done && bad == 0 && crashAt <= CRASH_MAX_RENAMES; + crashAt++) { + set_aes_check(); + rv = store_objects(create_exportable_aes_key); + if (rv != CKR_OK) { + bad++; + break; + } + res = run_in_child(child_restrict_and_crash); + if (res == CHILD_PASS) + done = 1; + else if (res != STORE_EXIT_CODE) + bad++; + if (run_in_child(child_key_old_or_new) != CHILD_PASS) + bad++; + } + CHECK_TRUE(done, "store pass runs to completion without the hook"); + CHECK_TRUE(bad == 0, "key is old or new after a crash at every rename"); + cleanup_test_files(); +} + +static byte newUserPin[] = "wolfpkcs11-new1"; + +/* Restrict the key and change the user PIN, ending after crashAt renames. */ +static int child_rebind_and_change_pin(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE restrictTmpl[] = { + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + }; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = funcList->C_SetAttributeValue(session, obj, restrictTmpl, 2); + if (rv == CKR_OK) { + WP11_Test_StoreExitAfterRenames(crashAt); + rv = funcList->C_SetPIN(session, userPin, sizeof(userPin) - 1, + newUserPin, sizeof(newUserPin) - 1); + WP11_Test_StoreExitAfterRenames(0); + } + return (rv == CKR_OK) ? CHILD_PASS : CHILD_FAIL; +} + +/* The key works after logging in with either the old or the new PIN. */ +static int child_key_under_either_pin(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + byte out[BLOCK_SZ]; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 0, &session); + if (rv == CKR_OK) { + rv = funcList->C_Login(session, CKU_USER, userPin, + sizeof(userPin) - 1); + if (rv == CKR_PIN_INCORRECT) { + rv = funcList->C_Login(session, CKU_USER, newUserPin, + sizeof(newUserPin) - 1); + } + } + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = aes_encrypt_block(session, obj, out); + if (rv == CKR_OK && XMEMCMP(out, refCipher, sizeof(out)) != 0) + rv = CKR_FUNCTION_FAILED; + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " key not usable after crash at rename %d: 0x%lx\n", + crashAt, (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static void test_pin_change_pass_is_atomic(void) +{ + CK_RV rv; + int res; + int done = 0; + int bad = 0; + + printf("\n--- a PIN change cut short at any rename keeps the key ---\n"); + for (crashAt = 1; !done && bad == 0 && crashAt <= CRASH_MAX_RENAMES; + crashAt++) { + set_aes_check(); + rv = store_objects(create_exportable_aes_key); + if (rv != CKR_OK) { + bad++; + break; + } + res = run_in_child(child_rebind_and_change_pin); + if (res == CHILD_PASS) + done = 1; + else if (res != STORE_EXIT_CODE) + bad++; + if (run_in_child(child_key_under_either_pin) != CHILD_PASS) + bad++; + } + CHECK_TRUE(done, "PIN change runs to completion without the hook"); + CHECK_TRUE(bad == 0, "key usable with old or new PIN after every crash"); + cleanup_test_files(); +} +#endif + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + XSETENV("WOLFPKCS11_TOKEN_PATH", TEST_DIR, 1); + + printf("=== wolfPKCS11 stored object policy integrity test ===\n"); + test_stored_policy_is_authenticated(); + test_legitimate_updates_round_trip(); + test_failed_store_keeps_state(); +#ifdef DEBUG_WOLFPKCS11 + test_store_pass_is_atomic(); + test_pin_change_pass_is_atomic(); +#endif +#if defined(WOLFPKCS11_MLDSA) || defined(WOLFPKCS11_MLKEM) + test_pq_keys_round_trip(); +#endif +#ifdef HAVE_LEGACY_STORE_TEST + test_unbound_store_upgraded(); +#endif + + return pkcs11_test_summary(); +} + +#else + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + printf("File-backed token storage not available, skipping test\n"); + return 77; +} + +#endif diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 9d2aec7a..5f59f28f 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -424,6 +424,12 @@ WP11_API void WP11_Object_SetFindHook(void (*hook)(void)); WP11_API void WP11_Session_SetAddObjectHook(void (*hook)(void)); WP11_API void WP11_Slot_SetPinCheckHook(void (*hook)(void)); WP11_API void WP11_Test_FailTokenInit(int fail); +#if !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_CUSTOM_STORE) && \ + !defined(WOLFPKCS11_TPM_STORE) && !defined(_WIN32) && !defined(_MSC_VER) +/* Exit status of a process ended by the store rename test hook. */ +#define WP11_TEST_STORE_EXIT_CODE 75 +WP11_API void WP11_Test_StoreExitAfterRenames(int renames); +#endif #if defined(WOLFPKCS11_TPM) && (!defined(NO_RSA) || defined(HAVE_ECC)) WP11_API int WP11_Test_DecodeTpmKey(CK_SLOT_ID slotId, unsigned char* keyData, int keyDataLen); From 80fb60444e275c85e6333d292391131a9d36ebde Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:33:15 -0700 Subject: [PATCH 015/104] Take the store lock before publishing the store batch slot --- src/internal.c | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/src/internal.c b/src/internal.c index 70975161..aedbf6d7 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1983,6 +1983,7 @@ static int wolfPKCS11_StoreBatchBegin(int tokenId) HANDLE h; #endif int fd; + WP11_Slot* slot; #ifndef WOLFPKCS11_NO_ENV /* Storage is turned off, so the pass writes nothing. */ @@ -1990,9 +1991,11 @@ static int wolfPKCS11_StoreBatchBegin(int tokenId) if (str != NULL) return 0; #endif - if (WP11_Slot_Get((CK_SLOT_ID)tokenId, &storeBatch.slot) != 0) + if (WP11_Slot_Get((CK_SLOT_ID)tokenId, &slot) != 0) return BAD_FUNC_ARG; - WP11_Lock_LockRW(&storeBatch.slot->storeLock); + /* The batch state is only written while the store lock is held. */ + WP11_Lock_LockRW(&slot->storeLock); + storeBatch.slot = slot; ret = wolfPKCS11_StoreBatchNames(tokenId); if (ret == 0) ret = wolfPKCS11_StoreEnsureDir(storeBatch.dir); @@ -2030,8 +2033,8 @@ static int wolfPKCS11_StoreBatchBegin(int tokenId) } else { (void)wolfPKCS11_StoreBatchLockFile(0); - WP11_Lock_UnlockRW(&storeBatch.slot->storeLock); storeBatch.slot = NULL; + WP11_Lock_UnlockRW(&slot->storeLock); } return ret; @@ -2082,6 +2085,7 @@ static int wolfPKCS11_StoreStageTemp(WP11_FileStoreCtx* ctx) static int wolfPKCS11_StoreBatchEnd(int commit) { int ret = 0; + WP11_Slot* slot; if (storeBatch.active) { storeBatch.active = 0; @@ -2111,9 +2115,10 @@ static int wolfPKCS11_StoreBatchEnd(int commit) } (void)wolfPKCS11_StoreBatchLockFile(0); } - if (storeBatch.slot != NULL) { - WP11_Lock_UnlockRW(&storeBatch.slot->storeLock); + slot = storeBatch.slot; + if (slot != NULL) { storeBatch.slot = NULL; + WP11_Lock_UnlockRW(&slot->storeLock); } return ret; From e990c0d5aadb4dba0fa982c4bb3915331162c64b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:33:16 -0700 Subject: [PATCH 016/104] Skip store batch recovery when token storage is disabled --- src/internal.c | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/internal.c b/src/internal.c index aedbf6d7..53a619b5 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1942,6 +1942,11 @@ static int wolfPKCS11_StoreBatchCheck(int tokenId) XFILE marker; WP11_Slot* slot; +#ifndef WOLFPKCS11_NO_ENV + /* Storage is turned off, so nothing is read and nothing is finished. */ + if (XGETENV("WOLFPKCS11_NO_STORE") != NULL) + return 0; +#endif if (WP11_Slot_Get((CK_SLOT_ID)tokenId, &slot) != 0) return 0; WP11_Lock_LockRW(&slot->storeLock); From 014bbf45daf94220741fe4e4f53045542a50f1f0 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:33:16 -0700 Subject: [PATCH 017/104] Hold the store batch locks until the token load finishes --- src/internal.c | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/src/internal.c b/src/internal.c index 53a619b5..860a0076 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1930,18 +1930,22 @@ static int wolfPKCS11_StoreBatchRecover(void) } /** - * Bring the store for a token to a committed state before it is read. + * Bring the store for a token to a committed state before it is read. On + * return the batch locks are held, so the token and object records read + * until wolfPKCS11_StoreBatchRelease belong to one committed pass. * - * @param [in] tokenId Id of token. + * @param [in] tokenId Id of token. + * @param [out] held Slot whose batch locks are held, or NULL. * @return 0 on success. * @return Other value when an interrupted pass could not be finished. */ -static int wolfPKCS11_StoreBatchCheck(int tokenId) +static int wolfPKCS11_StoreBatchCheck(int tokenId, WP11_Slot** held) { int ret = 0; XFILE marker; WP11_Slot* slot; + *held = NULL; #ifndef WOLFPKCS11_NO_ENV /* Storage is turned off, so nothing is read and nothing is finished. */ if (XGETENV("WOLFPKCS11_NO_STORE") != NULL) @@ -1950,10 +1954,10 @@ static int wolfPKCS11_StoreBatchCheck(int tokenId) if (WP11_Slot_Get((CK_SLOT_ID)tokenId, &slot) != 0) return 0; WP11_Lock_LockRW(&slot->storeLock); + *held = slot; if (wolfPKCS11_StoreBatchNames(tokenId) == 0) { if (wolfPKCS11_StoreBatchLockFile(1) == 0) { ret = wolfPKCS11_StoreBatchRecover(); - (void)wolfPKCS11_StoreBatchLockFile(0); } else { /* A committed pass that cannot be finished must not be read. */ @@ -1964,11 +1968,23 @@ static int wolfPKCS11_StoreBatchCheck(int tokenId) } } } - WP11_Lock_UnlockRW(&slot->storeLock); return ret; } +/** + * Release the batch locks held since wolfPKCS11_StoreBatchCheck. + * + * @param [in] held Slot returned by wolfPKCS11_StoreBatchCheck. + */ +static void wolfPKCS11_StoreBatchRelease(WP11_Slot* held) +{ + if (held != NULL) { + (void)wolfPKCS11_StoreBatchLockFile(0); + WP11_Lock_UnlockRW(&held->storeLock); + } +} + /** * Start a store pass: records closed from now on are staged, not committed. * On success the batch locks are held until wolfPKCS11_StoreBatchEnd. Without @@ -8455,11 +8471,15 @@ static int wp11_Token_Load(WP11_Slot* slot, int tokenId, WP11_Token* token) WP11_Object** current; int objCnt = 0; word32 len; +#ifdef WP11_STORE_BATCH + WP11_Slot* batchHeld = NULL; +#endif ret = 0; #ifdef WP11_STORE_BATCH - /* Finish or drop a store pass that a crash interrupted. */ - ret = wolfPKCS11_StoreBatchCheck(tokenId); + /* Finish or drop a store pass that a crash interrupted, then keep other + * store passes out until every record of the token has been read. */ + ret = wolfPKCS11_StoreBatchCheck(tokenId, &batchHeld); #endif /* Open access to token object. */ if (ret == 0) { @@ -8606,6 +8626,9 @@ static int wp11_Token_Load(WP11_Slot* slot, int tokenId, WP11_Token* token) /* No data to read. */ ret = 0; } +#ifdef WP11_STORE_BATCH + wolfPKCS11_StoreBatchRelease(batchHeld); +#endif return ret; } From e17221dd01f99fceb0232de02c0374c1f72422eb Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:33:55 -0700 Subject: [PATCH 018/104] Record store batch entries by file name --- src/internal.c | 59 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 43 insertions(+), 16 deletions(-) diff --git a/src/internal.c b/src/internal.c index 860a0076..13f34d5d 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1791,7 +1791,8 @@ static int wolfPKCS11_StoreBatchLockFile(int lock) } /** - * Check that a listed name is a store file directly in the store directory. + * Check that a listed name is the basename of a store file. Lists hold + * basenames so a recovery does not depend on how the directory was spelled. * * @param [in] name Name read from a batch list. * @return 1 when acceptable, 0 otherwise. @@ -1802,11 +1803,9 @@ static int wolfPKCS11_StoreBatchNameOk(const char* name) size_t i; int ok; - ok = len > storeBatch.dirLen + 6 && - XSTRNCMP(name, storeBatch.dir, storeBatch.dirLen) == 0 && - name[storeBatch.dirLen] == '/' && - XSTRNCMP(name + storeBatch.dirLen + 1, "wp11_", 5) == 0; - for (i = storeBatch.dirLen + 1; ok && i < len; i++) { + ok = len > 5 && XSTRNCMP(name, "wp11_", 5) == 0 && + storeBatch.dirLen + 1 + len < WP11_STORE_MAX_PATH; + for (i = 0; ok && i < len; i++) { if (name[i] == '/' || name[i] == '\\') ok = 0; } @@ -1854,7 +1853,10 @@ static int wolfPKCS11_StoreBatchApply(const char* listName, int mode) XFILE list; XFILE staged; size_t len; + size_t i; + const char* base; char line[WP11_STORE_MAX_PATH + 2]; + char finalName[WP11_STORE_MAX_PATH]; char stagedName[WP11_STORE_STAGED_MAX]; list = XFOPEN(listName, "rb"); @@ -1869,9 +1871,24 @@ static int wolfPKCS11_StoreBatchApply(const char* listName, int mode) continue; } line[len - 1] = '\0'; - len = (size_t)XSNPRINTF(stagedName, sizeof(stagedName), "%s.new", - line); - if (!wolfPKCS11_StoreBatchNameOk(line) || len >= sizeof(stagedName)) { + /* A list written with full paths is read by its basenames too. */ + base = line; + for (i = 0; i + 1 < len; i++) { + if (line[i] == '/' || line[i] == '\\') + base = line + i + 1; + } + if (!wolfPKCS11_StoreBatchNameOk(base)) { + if (mode != WP11_BATCH_DISCARD) + ret = READ_ONLY_E; + continue; + } + len = (size_t)XSNPRINTF(finalName, sizeof(finalName), "%s/%s", + storeBatch.dir, base); + if (len < sizeof(finalName)) { + len = (size_t)XSNPRINTF(stagedName, sizeof(stagedName), "%s.new", + finalName); + } + if (len >= sizeof(finalName) || len >= sizeof(stagedName)) { if (mode != WP11_BATCH_DISCARD) ret = READ_ONLY_E; continue; @@ -1880,10 +1897,10 @@ static int wolfPKCS11_StoreBatchApply(const char* listName, int mode) (void)remove(stagedName); } else if (mode == WP11_BATCH_CHECK) { - if (!wolfPKCS11_StoreBatchReplaceable(line)) + if (!wolfPKCS11_StoreBatchReplaceable(finalName)) ret = READ_ONLY_E; } - else if (wolfPKCS11_StoreRename(stagedName, line) != 0) { + else if (wolfPKCS11_StoreRename(stagedName, finalName) != 0) { /* Already renamed by an earlier, interrupted roll forward. */ staged = XFOPEN(stagedName, "rb"); if (staged != XBADFILE) { @@ -2062,7 +2079,8 @@ static int wolfPKCS11_StoreBatchBegin(int tokenId) } /** - * Stage a written record as ".new" and list it in the intent file. + * Stage a written record as ".new" and list its basename in the intent + * file. The record must be in the store directory of the pass. * * @param [in, out] ctx File store context with a written temporary file. * @return 0 on success. @@ -2072,17 +2090,26 @@ static int wolfPKCS11_StoreStageTemp(WP11_FileStoreCtx* ctx) { int ret = 0; int len; + const char* base; char stagedName[WP11_STORE_STAGED_MAX]; - len = XSNPRINTF(stagedName, sizeof(stagedName), "%s.new", - ctx->final_name); - if (len <= 0 || len >= (int)sizeof(stagedName)) + base = ctx->final_name + storeBatch.dirLen + 1; + if (XSTRNCMP(ctx->final_name, storeBatch.dir, storeBatch.dirLen) != 0 || + ctx->final_name[storeBatch.dirLen] != '/' || + !wolfPKCS11_StoreBatchNameOk(base)) { ret = READ_ONLY_E; + } + if (ret == 0) { + len = XSNPRINTF(stagedName, sizeof(stagedName), "%s.new", + ctx->final_name); + if (len <= 0 || len >= (int)sizeof(stagedName)) + ret = READ_ONLY_E; + } if (ret == 0) ret = wolfPKCS11_StoreRename(ctx->temp_name, stagedName); if (ret == 0) { ctx->has_temp = 0; - if (fputs(ctx->final_name, storeBatch.intent) < 0 || + if (fputs(base, storeBatch.intent) < 0 || fputc('\n', storeBatch.intent) == EOF || fflush(storeBatch.intent) != 0) { ret = READ_ONLY_E; From d9ee4f2f8e177fa836a6b191a9a2a500a9b4b04b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:35:04 -0700 Subject: [PATCH 019/104] Sync staged store files before commit --- src/internal.c | 119 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 111 insertions(+), 8 deletions(-) diff --git a/src/internal.c b/src/internal.c index 13f34d5d..6ed704a2 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1314,6 +1314,93 @@ static int wolfPKCS11_StoreRename(const char* from, const char* to) return ret; } +/** + * Flush a written store file to stable storage. + * + * @param [in] file Open file written by the store. + * @return 0 on success. + * @return READ_ONLY_E when the data may not have reached the device. + */ +static int wolfPKCS11_StoreSyncFile(XFILE file) +{ + int ret = 0; +#if defined(_WIN32) || defined(_MSC_VER) + intptr_t osHandle; +#endif + + if (XFFLUSH(file) != 0) + ret = READ_ONLY_E; +#if defined(_WIN32) || defined(_MSC_VER) + if (ret == 0) { + osHandle = _get_osfhandle(_fileno(file)); + if (!FlushFileBuffers((HANDLE)osHandle)) + ret = READ_ONLY_E; + } +#else + if (ret == 0 && fsync(fileno(file)) != 0) + ret = READ_ONLY_E; +#endif + + return ret; +} + +/** + * Make the renames done in a store directory durable. Windows has no + * directory flush; its renames are done write-through instead. + * + * @param [in] dir Store directory. + * @return 0 on success. + * @return READ_ONLY_E when the directory could not be flushed. + */ +static int wolfPKCS11_StoreSyncDir(const char* dir) +{ + int ret = 0; +#if !defined(_WIN32) && !defined(_MSC_VER) + int fd; + + fd = open(dir, O_RDONLY); + if (fd < 0) { + ret = READ_ONLY_E; + } + else { + /* Filesystems without directory flushing answer EINVAL. */ + if (fsync(fd) != 0 && errno != EINVAL) + ret = READ_ONLY_E; + close(fd); + } +#else + (void)dir; +#endif + + return ret; +} + +/** + * Make a rename of a store file durable by flushing its directory. + * + * @param [in] name Renamed store file. + * @return 0 on success. + * @return READ_ONLY_E when the directory could not be flushed. + */ +static int wolfPKCS11_StoreSyncParent(const char* name) +{ + size_t len = XSTRLEN(name); + size_t i; + size_t sep = 0; + char dir[WP11_STORE_MAX_PATH]; + + for (i = 0; i < len; i++) { + if (name[i] == '/' || name[i] == '\\') + sep = i; + } + if (sep == 0 || sep >= sizeof(dir)) + return READ_ONLY_E; + XMEMCPY(dir, name, sep); + dir[sep] = '\0'; + + return wolfPKCS11_StoreSyncDir(dir); +} + static int wolfPKCS11_StoreCommitTemp(WP11_FileStoreCtx* ctx) { int ret = 0; @@ -1325,6 +1412,7 @@ static int wolfPKCS11_StoreCommitTemp(WP11_FileStoreCtx* ctx) ret = wolfPKCS11_StoreRename(ctx->temp_name, ctx->final_name); if (ret == 0) { ctx->has_temp = 0; + ret = wolfPKCS11_StoreSyncParent(ctx->final_name); } return ret; @@ -1934,6 +2022,9 @@ static int wolfPKCS11_StoreBatchRecover(void) XFCLOSE(marker); ret = wolfPKCS11_StoreBatchApply(storeBatch.commitName, WP11_BATCH_APPLY); + /* The marker outlives the records it names until they are durable. */ + if (ret == 0) + ret = wolfPKCS11_StoreSyncDir(storeBatch.dir); if (ret == 0) (void)remove(storeBatch.commitName); } @@ -2137,6 +2228,8 @@ static int wolfPKCS11_StoreBatchEnd(int commit) if (storeBatch.active) { storeBatch.active = 0; + if (commit && wolfPKCS11_StoreSyncFile(storeBatch.intent) != 0) + storeBatch.failed = 1; if (XFCLOSE(storeBatch.intent) != 0) storeBatch.failed = 1; storeBatch.intent = XBADFILE; @@ -2146,13 +2239,18 @@ static int wolfPKCS11_StoreBatchEnd(int commit) ret = wolfPKCS11_StoreBatchApply(storeBatch.intentName, WP11_BATCH_CHECK); } + /* The staged records must be durable before the marker can be. */ + if (ret == 0 && commit) + ret = wolfPKCS11_StoreSyncDir(storeBatch.dir); if (ret == 0 && commit) { ret = wolfPKCS11_StoreRename(storeBatch.intentName, storeBatch.commitName); } if (ret == 0 && commit) { + (void)wolfPKCS11_StoreSyncDir(storeBatch.dir); if (wolfPKCS11_StoreBatchApply(storeBatch.commitName, - WP11_BATCH_APPLY) == 0) { + WP11_BATCH_APPLY) == 0 && + wolfPKCS11_StoreSyncDir(storeBatch.dir) == 0) { (void)remove(storeBatch.commitName); } } @@ -2466,17 +2564,22 @@ void wolfPKCS11_Store_Close(void* store) int commitRet = 0; if (ctx->file != XBADFILE && ctx->file != NULL) { - XFCLOSE(ctx->file); + if (ctx->is_write && wolfPKCS11_StoreSyncFile(ctx->file) != 0) + commitRet = BUFFER_E; + if (XFCLOSE(ctx->file) != 0 && ctx->is_write) + commitRet = BUFFER_E; ctx->file = XBADFILE; } if (ctx->is_write && ctx->has_temp) { - #ifdef WP11_STORE_BATCH - if (storeBatch.active) - commitRet = wolfPKCS11_StoreStageTemp(ctx); - else - #endif - commitRet = wolfPKCS11_StoreCommitTemp(ctx); + if (commitRet == 0) { + #ifdef WP11_STORE_BATCH + if (storeBatch.active) + commitRet = wolfPKCS11_StoreStageTemp(ctx); + else + #endif + commitRet = wolfPKCS11_StoreCommitTemp(ctx); + } if (commitRet != 0) { #ifdef WP11_STORE_BATCH if (storeBatch.active) From 05872b9f900147ba23e882c0edc6aa34d83b5482 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:35:04 -0700 Subject: [PATCH 020/104] Correct the store batch setup comment --- src/internal.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/internal.c b/src/internal.c index 6ed704a2..7e9ba205 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2095,8 +2095,8 @@ static void wolfPKCS11_StoreBatchRelease(WP11_Slot* held) /** * Start a store pass: records closed from now on are staged, not committed. - * On success the batch locks are held until wolfPKCS11_StoreBatchEnd. Without - * a usable store directory the pass runs unstaged and fails as before. + * On success the batch locks are held until wolfPKCS11_StoreBatchEnd. When + * the pass cannot start, nothing is written and the error is returned. * * @param [in] tokenId Id of token being stored. * @return 0 on success. From 84665b1b4d01722e5aec5f21e48bf7e4f6e53d50 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:35:41 -0700 Subject: [PATCH 021/104] Rename WP11_FLAG_UNBOUND to WP11_FLAG_POLICY_EXCLUDED --- src/internal.c | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/internal.c b/src/internal.c index 7e9ba205..d26cbeba 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4165,11 +4165,12 @@ static int wp11_DecryptData(byte* out, byte* data, int len, byte* key, return ret; } -/* Set by the SO, who never holds the user's key, or by the library itself. */ +/* Flags left out of the bound policy: set by the SO, who never holds the + * user's key, or by the library itself. */ #ifdef WOLFPKCS11_TPM -#define WP11_FLAG_UNBOUND (WP11_FLAG_TRUSTED | WP11_FLAG_TPM) +#define WP11_FLAG_POLICY_EXCLUDED (WP11_FLAG_TRUSTED | WP11_FLAG_TPM) #else -#define WP11_FLAG_UNBOUND WP11_FLAG_TRUSTED +#define WP11_FLAG_POLICY_EXCLUDED WP11_FLAG_TRUSTED #endif #define WP11_POLICY_AAD_VER 1 @@ -4184,7 +4185,7 @@ static int wp11_DecryptData(byte* out, byte* data, int len, byte* key, static void wp11_Object_PolicyAad(WP11_Object* object, byte* aad) { CK_ULONG vals[3]; - word32 flags = object->opFlag & ~(word32)WP11_FLAG_UNBOUND; + word32 flags = object->opFlag & ~(word32)WP11_FLAG_POLICY_EXCLUDED; int idx = 0; int i; int j; @@ -15382,7 +15383,7 @@ static int wp11_Object_PolicyChanged(WP11_Object* object, if (object->onToken && wp11_Object_IsEncrypted(object) && (object->objClass != prevClass || - ((object->opFlag ^ prevFlag) & ~(word32)WP11_FLAG_UNBOUND) != 0)) { + ((object->opFlag ^ prevFlag) & ~(word32)WP11_FLAG_POLICY_EXCLUDED) != 0)) { if (object->encoded || object->undecoded) { object->objClass = prevClass; object->opFlag = prevFlag; From 5ea1e480bf263d34bf72e8434ef1f5290d66385b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Thu, 15 Oct 2026 08:43:16 -0700 Subject: [PATCH 022/104] Hold the token lock across the SO PIN change store --- src/internal.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/internal.c b/src/internal.c index d26cbeba..a56300f3 100644 --- a/src/internal.c +++ b/src/internal.c @@ -10501,6 +10501,9 @@ int WP11_Slot_SetSOPin(WP11_Slot* slot, char* pin, int pinLen) token->soPinLen = sizeof(token->soPin); token->tokenFlags |= WP11_TOKEN_FLAG_SO_PIN_SET; #ifndef WOLFPKCS11_NO_STORE + /* Lock order is slot, token, then store: no object changes under + * the pass, as in C_CreateObject. */ + WP11_Lock_LockRW(&token->lock); ret = wp11_Token_Store(token, (int)slot->id); #ifdef WP11_STORE_BATCH if (ret != 0 && (oldFlags & WP11_TOKEN_FLAG_SO_PIN_SET)) { @@ -10511,6 +10514,7 @@ int WP11_Slot_SetSOPin(WP11_Slot* slot, char* pin, int pinLen) token->tokenFlags = oldFlags; } #endif + WP11_Lock_UnlockRW(&token->lock); #endif } WP11_Lock_UnlockRW(&slot->lock); From e1e32f2c2cd61c80ea58788ee86e8a7af6943967 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:35:42 -0700 Subject: [PATCH 023/104] Clean up staged store files in the policy test --- tests/object_policy_integrity_test.c | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/tests/object_policy_integrity_test.c b/tests/object_policy_integrity_test.c index afda742f..c0da2e72 100644 --- a/tests/object_policy_integrity_test.c +++ b/tests/object_policy_integrity_test.c @@ -123,8 +123,18 @@ static void store_path(char* path, size_t sz, const char* kind, int objId) } } +static void remove_record(const char* path) +{ + char staged[280]; + + (void)remove(path); + (void)snprintf(staged, sizeof(staged), "%s.new", path); + (void)remove(staged); +} + static void cleanup_test_files(void) { + static const char* txnKinds[] = { "lock", "intent", "commit" }; char path[256]; size_t k; int i; @@ -132,11 +142,17 @@ static void cleanup_test_files(void) for (k = 0; k < sizeof(storeKinds) / sizeof(*storeKinds); k++) { for (i = 0; i < MAX_OBJ_ID; i++) { store_path(path, sizeof(path), storeKinds[k], i); - (void)remove(path); + remove_record(path); } } store_path(path, sizeof(path), "token", -1); - (void)remove(path); + remove_record(path); + for (k = 0; k < sizeof(txnKinds) / sizeof(*txnKinds); k++) { + (void)snprintf(path, sizeof(path), "%s/wp11_txn_%016lx_%s", TEST_DIR, + 1UL, txnKinds[k]); + if (remove(path) != 0) + (void)rmdir(path); + } } /* Locate the stored file of the given kind for its single object. */ From e79a8d181f12cb4edd7f0804e8301cf82eb498b1 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:35:43 -0700 Subject: [PATCH 024/104] Test store failures with undecoded keys --- tests/object_policy_integrity_test.c | 280 ++++++++++++++++++++++++++- 1 file changed, 275 insertions(+), 5 deletions(-) diff --git a/tests/object_policy_integrity_test.c b/tests/object_policy_integrity_test.c index c0da2e72..fc659127 100644 --- a/tests/object_policy_integrity_test.c +++ b/tests/object_policy_integrity_test.c @@ -1239,6 +1239,14 @@ static void test_unbound_store_upgraded(void) static byte otherUserPin[] = "wolfpkcs11-other"; +/* A directory at the lock file name makes every store pass fail. */ +static int block_store(char* lockPath, size_t sz) +{ + (void)snprintf(lockPath, sz, "%s/wp11_txn_%016lx_lock", TEST_DIR, 1UL); + (void)unlink(lockPath); + return (mkdir(lockPath, 0700) == 0) ? 0 : -1; +} + /* Store passes that cannot start must leave the PIN and token in effect. */ static int child_failed_store_keeps_state(void) { @@ -1252,17 +1260,13 @@ static int child_failed_store_keeps_state(void) byte out[BLOCK_SZ]; char lockPath[256]; - (void)snprintf(lockPath, sizeof(lockPath), "%s/wp11_txn_%016lx_lock", - TEST_DIR, 1UL); XMEMSET(label, ' ', sizeof(label)); if (pkcs11_load() != CKR_OK) return CHILD_SETUP; rv = init_slot(&slot); if (rv == CKR_OK) rv = open_session(slot, 1, &session); - /* A directory at the lock file name makes every store pass fail. */ - (void)unlink(lockPath); - if (rv == CKR_OK && mkdir(lockPath, 0700) != 0) + if (rv == CKR_OK && block_store(lockPath, sizeof(lockPath)) != 0) rv = CKR_GENERAL_ERROR; if (rv == CKR_OK) { setRv = funcList->C_SetPIN(session, userPin, sizeof(userPin) - 1, @@ -1306,6 +1310,269 @@ static void test_failed_store_keeps_state(void) cleanup_test_files(); } +/* Create a public AES key on the token and change its policy so the next + * store pass has to rebind it. The key is only decoded in this process. */ +static CK_RV create_unbound_public_key(CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_OBJECT_CLASS cls = CKO_SECRET_KEY; + CK_KEY_TYPE keyType = CKK_AES; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &cls, sizeof(cls) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_DECRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, aesKeyValue, sizeof(aesKeyValue) }, + }; + CK_ATTRIBUTE policy[] = { + { CKA_DECRYPT, &ckFalse, sizeof(ckFalse) }, + }; + + rv = funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); + if (rv == CKR_OK) + rv = funcList->C_SetAttributeValue(session, obj, policy, 1); + return rv; +} + +/* With the user's key never decoded in this process, a PIN change whose + * store fails must not touch the stored key. */ +static int child_undecoded_keys_survive_failed_pin_change(int asSO) +{ + CK_RV rv; + CK_RV setRv = CKR_OK; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + char lockPath[256]; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 0, &session); + if (rv == CKR_OK && asSO) + rv = funcList->C_Login(session, CKU_SO, soPin, sizeof(soPin) - 1); + if (rv == CKR_OK) + rv = create_unbound_public_key(session); + if (rv == CKR_OK && block_store(lockPath, sizeof(lockPath)) != 0) + rv = CKR_GENERAL_ERROR; + if (rv == CKR_OK && asSO) { + setRv = funcList->C_InitPIN(session, otherUserPin, + sizeof(otherUserPin) - 1); + } + else if (rv == CKR_OK) { + setRv = funcList->C_SetPIN(session, userPin, sizeof(userPin) - 1, + otherUserPin, sizeof(otherUserPin) - 1); + } + (void)rmdir(lockPath); + if (rv == CKR_OK && setRv == CKR_OK) + rv = CKR_GENERAL_ERROR; + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " forced PIN change failure not set up: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static int child_public_pin_change_fails(void) +{ + return child_undecoded_keys_survive_failed_pin_change(0); +} + +static int child_so_init_pin_fails(void) +{ + return child_undecoded_keys_survive_failed_pin_change(1); +} + +/* The user's key still works under the PIN that stayed in storage. */ +static int child_user_key_works(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + byte out[BLOCK_SZ]; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = aes_encrypt_block(session, obj, out); + if (rv == CKR_OK && XMEMCMP(out, refCipher, sizeof(out)) != 0) + rv = CKR_FUNCTION_FAILED; + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " stored key lost by a failed PIN change: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static void test_failed_store_keeps_undecoded_keys(void) +{ + CK_RV rv; + + printf("\n--- failed PIN change with undecoded keys keeps them ---\n"); + set_aes_check(); + rv = store_objects(create_aes_key); + CHECK_RV(rv, "store AES key", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(run_in_child(child_public_pin_change_fails) == CHILD_PASS, + "public session PIN change store failure is forced"); + CHECK_TRUE(run_in_child(child_user_key_works) == CHILD_PASS, + "key survives a failed public session PIN change"); + } + cleanup_test_files(); + rv = store_objects(create_aes_key); + CHECK_RV(rv, "store AES key", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(run_in_child(child_so_init_pin_fails) == CHILD_PASS, + "SO user PIN init store failure is forced"); + CHECK_TRUE(run_in_child(child_user_key_works) == CHILD_PASS, + "key survives a failed SO user PIN init"); + } + cleanup_test_files(); +} + +/* A token init whose store fails leaves nothing behind, and a retry works. */ +static int child_init_token_retry(void) +{ + CK_RV rv; + CK_RV initRv = CKR_OK; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_TOKEN_INFO info; + char lockPath[256]; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK && block_store(lockPath, sizeof(lockPath)) != 0) + rv = CKR_GENERAL_ERROR; + if (rv == CKR_OK) { + initRv = funcList->C_InitToken(slot, soPin, sizeof(soPin) - 1, + (CK_UTF8CHAR*)"wolfpkcs11 " + " "); + (void)rmdir(lockPath); + if (initRv == CKR_OK) + rv = CKR_GENERAL_ERROR; + } + if (rv == CKR_OK) + rv = funcList->C_GetTokenInfo(slot, &info); + if (rv == CKR_OK && (info.flags & CKF_TOKEN_INITIALIZED) != 0) + rv = CKR_GENERAL_ERROR; + if (rv == CKR_OK) + rv = provision_token(slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " token init retry failed: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +static void test_init_token_failure_on_fresh_store(void) +{ + printf("\n--- failed token init on a fresh store can be retried ---\n"); + cleanup_test_files(); + CHECK_TRUE(run_in_child(child_init_token_retry) == CHILD_PASS, + "token init works after a failed init of a fresh store"); + cleanup_test_files(); +} + +#define ALT_TEST_DIR "store/./object_policy_integrity_test" + +static byte stagedRecord[] = "staged-record"; + +/* Load the token with the store directory spelled differently. */ +static int child_load_from_alt_dir(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + + XSETENV("WOLFPKCS11_TOKEN_PATH", ALT_TEST_DIR, 1); + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) + rv = find_key(session, &obj); + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " load from the renamed store dir failed: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +/* A committed pass left by a crash is finished by a process that reaches the + * store directory through a different path, whether the marker lists the + * records by basename or by the path the crashed process used. */ +static void test_recovery_ignores_dir_spelling(void) +{ + CK_RV rv; + char path[256]; + char fullPath[256]; + char staged[280]; + char marker[256]; + char lines[600]; + static byte data[MAX_FILE_SZ]; + size_t sz = 0; + int res; + + printf("\n--- committed pass is finished from any store dir path ---\n"); + set_aes_check(); + rv = store_objects(create_aes_key); + CHECK_RV(rv, "store AES key", CKR_OK); + store_path(path, sizeof(path), "data", MAX_OBJ_ID - 1); + store_path(fullPath, sizeof(fullPath), "data", MAX_OBJ_ID - 2); + (void)snprintf(marker, sizeof(marker), "%s/wp11_txn_%016lx_commit", + TEST_DIR, 1UL); + (void)snprintf(lines, sizeof(lines), "wp11_data_%016lx_%016lx\n%s\n", 1UL, + (unsigned long)(MAX_OBJ_ID - 1), fullPath); + if (rv == CKR_OK) { + (void)snprintf(staged, sizeof(staged), "%s.new", path); + CHECK_TRUE(write_file(staged, stagedRecord, sizeof(stagedRecord)) == 0, + "stage a record"); + (void)snprintf(staged, sizeof(staged), "%s.new", fullPath); + CHECK_TRUE(write_file(staged, stagedRecord, sizeof(stagedRecord)) == 0, + "stage a second record"); + CHECK_TRUE(write_file(marker, (const byte*)lines, XSTRLEN(lines)) == 0, + "write a commit marker naming both"); + res = run_in_child(child_load_from_alt_dir); + CHECK_TRUE(res == CHILD_PASS, "token loads through the other path"); + CHECK_TRUE(read_file(path, data, sizeof(data), &sz) == 0 && + sz == sizeof(stagedRecord) && + XMEMCMP(data, stagedRecord, sz) == 0, + "record listed by basename was put in place"); + CHECK_TRUE(read_file(fullPath, data, sizeof(data), &sz) == 0 && + sz == sizeof(stagedRecord) && + XMEMCMP(data, stagedRecord, sz) == 0, + "record listed by full path was put in place"); + (void)snprintf(staged, sizeof(staged), "%s.new", path); + CHECK_TRUE(access(staged, F_OK) != 0, "staged copy is gone"); + CHECK_TRUE(access(marker, F_OK) != 0, "commit marker is gone"); + } + cleanup_test_files(); +} + #ifdef DEBUG_WOLFPKCS11 /* Matches WP11_TEST_STORE_EXIT_CODE in wolfpkcs11/internal.h. */ #define STORE_EXIT_CODE 75 @@ -1527,6 +1794,9 @@ int main(int argc, char* argv[]) test_stored_policy_is_authenticated(); test_legitimate_updates_round_trip(); test_failed_store_keeps_state(); + test_failed_store_keeps_undecoded_keys(); + test_init_token_failure_on_fresh_store(); + test_recovery_ignores_dir_spelling(); #ifdef DEBUG_WOLFPKCS11 test_store_pass_is_atomic(); test_pin_change_pass_is_atomic(); From d8d715fae157a63b366153001640da8c6b7bd1aa Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:35:43 -0700 Subject: [PATCH 025/104] Cache the empty user PIN verdict when loading a token --- src/internal.c | 47 ++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 38 insertions(+), 9 deletions(-) diff --git a/src/internal.c b/src/internal.c index a56300f3..e6d9c644 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8584,7 +8584,35 @@ static int wp11_token_write_seed(void* storage, WP11_Token* token) } /** - * Load a token from storage. + * Check for an empty user PIN while loading, when the caller alone can reach + * the token, and cache the verdict as WP11_Slot_Has_Empty_Pin would. + * + * @param [in] slot Slot object. + * @param [in, out] token Token being loaded. + * @return 1 when the user PIN is set and empty, 0 otherwise. + */ +static int wp11_Token_HasEmptyPin(WP11_Slot* slot, WP11_Token* token) +{ + int ret = 0; + byte hash[PIN_HASH_SZ]; + + if ((token->tokenFlags & WP11_TOKEN_FLAG_USER_PIN_SET) != 0) { + if (HashPIN((char*)"", 0, token->userPinSeed, + sizeof(token->userPinSeed), hash, sizeof(hash), slot) == 0) { + ret = WP11_ConstantCompare(hash, token->userPin, + token->userPinLen) != 0; + } + token->userPinEmpty = ret ? 1 : 2; + wc_ForceZero(hash, sizeof(hash)); + } + + return ret; +} + +/** + * Load a token from storage. Runs without the slot lock from library + * initialization and under it from a token reset; neither its callees nor + * this function take the slot lock. * * @param [in, out] object Token object. * @param [in] tokenId Id of token this key belongs to. @@ -8736,7 +8764,7 @@ static int wp11_Token_Load(WP11_Slot* slot, int tokenId, WP11_Token* token) } /* If there is no pin, there is no login, so decode now */ - if (WP11_Slot_Has_Empty_Pin(slot) && (ret == 0)) { + if (ret == 0 && wp11_Token_HasEmptyPin(slot, token)) { #ifndef WOLFPKCS11_NO_STORE /* Derive token->key from empty PIN + seed before decoding */ ret = HashPIN((char*)"", 0, token->seed, sizeof(token->seed), @@ -9690,17 +9718,18 @@ int WP11_Slot_TokenReset(WP11_Slot* slot, char* pin, int pinLen, char* label) #ifdef WP11_STORE_BATCH /* Only a staged store pass is known to leave storage unchanged. */ if (ret != 0) { - /* Reset not stored: restore the token that is still in storage. */ + /* Reset not stored: restore the token that is still in storage, + * under the lock so no session sees it half loaded. */ XMEMSET(emptyLabel, 0, sizeof(emptyLabel)); WP11_Lock_LockRW(&slot->lock); wp11_Token_Final(token); - if (wp11_Token_Init(token, emptyLabel) == 0) { - WP11_Lock_UnlockRW(&slot->lock); - (void)wp11_Slot_Load(slot, (int)slot->id); - } - else { - WP11_Lock_UnlockRW(&slot->lock); + if (wp11_Token_Init(token, emptyLabel) == 0 && + wp11_Slot_Load(slot, (int)slot->id) != 0) { + /* Storage still holds the token; leave a blank one here. */ + wp11_Token_Final(token); + (void)wp11_Token_Init(token, emptyLabel); } + WP11_Lock_UnlockRW(&slot->lock); } #endif } From a5706b858e3dc192afcdc5bb7df77e7875bf882a Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Thu, 15 Oct 2026 08:43:27 -0700 Subject: [PATCH 026/104] Test that a stored PIN change needs no logout to take effect --- tests/object_policy_integrity_test.c | 76 ++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) diff --git a/tests/object_policy_integrity_test.c b/tests/object_policy_integrity_test.c index fc659127..dd98ba31 100644 --- a/tests/object_policy_integrity_test.c +++ b/tests/object_policy_integrity_test.c @@ -1444,6 +1444,81 @@ static void test_failed_store_keeps_undecoded_keys(void) cleanup_test_files(); } +/* Change the user PIN and end without logging out or finalizing. */ +static int child_change_pin_and_exit(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 1, &session); + if (rv == CKR_OK) { + rv = funcList->C_SetPIN(session, userPin, sizeof(userPin) - 1, + otherUserPin, sizeof(otherUserPin) - 1); + } + if (rv != CKR_OK) { + fprintf(stderr, " PIN change failed: 0x%lx\n", (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +/* The key works after logging in with the new PIN. */ +static int child_key_under_new_pin(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + byte out[BLOCK_SZ]; + + if (pkcs11_load() != CKR_OK) + return CHILD_SETUP; + rv = init_slot(&slot); + if (rv == CKR_OK) + rv = open_session(slot, 0, &session); + if (rv == CKR_OK) { + rv = funcList->C_Login(session, CKU_USER, otherUserPin, + sizeof(otherUserPin) - 1); + } + if (rv == CKR_OK) + rv = find_key(session, &obj); + if (rv == CKR_OK) + rv = aes_encrypt_block(session, obj, out); + if (rv == CKR_OK && XMEMCMP(out, refCipher, sizeof(out)) != 0) + rv = CKR_FUNCTION_FAILED; + (void)funcList->C_Finalize(NULL); + if (rv != CKR_OK) { + fprintf(stderr, " key not usable under the new PIN: 0x%lx\n", + (unsigned long)rv); + return CHILD_FAIL; + } + return CHILD_PASS; +} + +/* The store pass of a PIN change must itself leave every key usable under + * the new PIN, without a later logout or finalize rewriting the records. */ +static void test_pin_change_is_complete_when_stored(void) +{ + CK_RV rv; + + printf("\n--- a stored PIN change needs no logout to take effect ---\n"); + set_aes_check(); + rv = store_objects(create_aes_key); + CHECK_RV(rv, "store AES key", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(run_in_child(child_change_pin_and_exit) == CHILD_PASS, + "PIN change stored"); + CHECK_TRUE(run_in_child(child_key_under_new_pin) == CHILD_PASS, + "key usable under the new PIN after an exit"); + } + cleanup_test_files(); +} + /* A token init whose store fails leaves nothing behind, and a retry works. */ static int child_init_token_retry(void) { @@ -1795,6 +1870,7 @@ int main(int argc, char* argv[]) test_legitimate_updates_round_trip(); test_failed_store_keeps_state(); test_failed_store_keeps_undecoded_keys(); + test_pin_change_is_complete_when_stored(); test_init_token_failure_on_fresh_store(); test_recovery_ignores_dir_spelling(); #ifdef DEBUG_WOLFPKCS11 From 64f8bcdc1d872b03fc54716806385cc36d79f605 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:35:45 -0700 Subject: [PATCH 027/104] Tidy store batch comments --- src/internal.c | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/src/internal.c b/src/internal.c index e6d9c644..d02e2204 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4165,8 +4165,7 @@ static int wp11_DecryptData(byte* out, byte* data, int len, byte* key, return ret; } -/* Flags left out of the bound policy: set by the SO, who never holds the - * user's key, or by the library itself. */ +/* Left out of the bound policy: set by the SO or the library, not the user. */ #ifdef WOLFPKCS11_TPM #define WP11_FLAG_POLICY_EXCLUDED (WP11_FLAG_TRUSTED | WP11_FLAG_TPM) #else @@ -8636,8 +8635,7 @@ static int wp11_Token_Load(WP11_Slot* slot, int tokenId, WP11_Token* token) ret = 0; #ifdef WP11_STORE_BATCH - /* Finish or drop a store pass that a crash interrupted, then keep other - * store passes out until every record of the token has been read. */ + /* Finish or drop an interrupted pass, then keep passes out until read. */ ret = wolfPKCS11_StoreBatchCheck(tokenId, &batchHeld); #endif /* Open access to token object. */ @@ -9718,8 +9716,7 @@ int WP11_Slot_TokenReset(WP11_Slot* slot, char* pin, int pinLen, char* label) #ifdef WP11_STORE_BATCH /* Only a staged store pass is known to leave storage unchanged. */ if (ret != 0) { - /* Reset not stored: restore the token that is still in storage, - * under the lock so no session sees it half loaded. */ + /* Reload under the lock so no session sees a half loaded token. */ XMEMSET(emptyLabel, 0, sizeof(emptyLabel)); WP11_Lock_LockRW(&slot->lock); wp11_Token_Final(token); @@ -10530,8 +10527,7 @@ int WP11_Slot_SetSOPin(WP11_Slot* slot, char* pin, int pinLen) token->soPinLen = sizeof(token->soPin); token->tokenFlags |= WP11_TOKEN_FLAG_SO_PIN_SET; #ifndef WOLFPKCS11_NO_STORE - /* Lock order is slot, token, then store: no object changes under - * the pass, as in C_CreateObject. */ + /* Order is slot, token, storeLock: no object changes under the pass. */ WP11_Lock_LockRW(&token->lock); ret = wp11_Token_Store(token, (int)slot->id); #ifdef WP11_STORE_BATCH @@ -15416,7 +15412,8 @@ static int wp11_Object_PolicyChanged(WP11_Object* object, if (object->onToken && wp11_Object_IsEncrypted(object) && (object->objClass != prevClass || - ((object->opFlag ^ prevFlag) & ~(word32)WP11_FLAG_POLICY_EXCLUDED) != 0)) { + ((object->opFlag ^ prevFlag) & + ~(word32)WP11_FLAG_POLICY_EXCLUDED) != 0)) { if (object->encoded || object->undecoded) { object->objClass = prevClass; object->opFlag = prevFlag; From c988a2fb8e0fc474ec61108a05770e1d508bcbee Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Thu, 15 Oct 2026 08:43:55 -0700 Subject: [PATCH 028/104] Publish SO PIN changes under the token lock --- src/internal.c | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/src/internal.c b/src/internal.c index d02e2204..e9db7767 100644 --- a/src/internal.c +++ b/src/internal.c @@ -10495,6 +10495,8 @@ int WP11_Slot_SetSOPin(WP11_Slot* slot, char* pin, int pinLen) { int ret = 0; WP11_Token* token; + byte pinSeed[PIN_SEED_SZ]; + byte pinHash[PIN_HASH_SZ]; #ifdef WP11_STORE_BATCH byte oldPin[PIN_HASH_SZ]; byte oldPinSeed[PIN_SEED_SZ]; @@ -10512,23 +10514,25 @@ int WP11_Slot_SetSOPin(WP11_Slot* slot, char* pin, int pinLen) #endif /* New seed each time. */ WP11_Lock_LockRW(&slot->token.rngLock); - ret = wc_RNG_GenerateBlock(&slot->token.rng, token->soPinSeed, - sizeof(token->soPinSeed)); + ret = wc_RNG_GenerateBlock(&slot->token.rng, pinSeed, sizeof(pinSeed)); WP11_Lock_UnlockRW(&slot->token.rngLock); if (ret == 0) { WP11_Lock_UnlockRW(&slot->lock); /* Costly Operation done out of lock. */ - ret = HashPIN(pin, pinLen, token->soPinSeed, - sizeof(token->soPinSeed), token->soPin, - sizeof(token->soPin), slot); + ret = HashPIN(pin, pinLen, pinSeed, sizeof(pinSeed), pinHash, + sizeof(pinHash), slot); WP11_Lock_LockRW(&slot->lock); } if (ret == 0) { + #ifndef WOLFPKCS11_NO_STORE + /* Order is slot, token, storeLock: no store runs from here on. */ + WP11_Lock_LockRW(&token->lock); + #endif + XMEMCPY(token->soPinSeed, pinSeed, sizeof(token->soPinSeed)); + XMEMCPY(token->soPin, pinHash, sizeof(token->soPin)); token->soPinLen = sizeof(token->soPin); token->tokenFlags |= WP11_TOKEN_FLAG_SO_PIN_SET; #ifndef WOLFPKCS11_NO_STORE - /* Order is slot, token, storeLock: no object changes under the pass. */ - WP11_Lock_LockRW(&token->lock); ret = wp11_Token_Store(token, (int)slot->id); #ifdef WP11_STORE_BATCH if (ret != 0 && (oldFlags & WP11_TOKEN_FLAG_SO_PIN_SET)) { @@ -10543,6 +10547,7 @@ int WP11_Slot_SetSOPin(WP11_Slot* slot, char* pin, int pinLen) #endif } WP11_Lock_UnlockRW(&slot->lock); + wc_ForceZero(pinHash, sizeof(pinHash)); #ifdef WP11_STORE_BATCH wc_ForceZero(oldPin, sizeof(oldPin)); wc_ForceZero(oldPinSeed, sizeof(oldPinSeed)); From 023ba804cfe7ae4ba4e3a7a719f2a4357806d398 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:55:08 -0700 Subject: [PATCH 029/104] F-5763 - Release the replaced operation when a new one is initialized --- src/internal.c | 85 ++++- tests/include.am | 7 + tests/session_op_lifecycle_test.c | 519 ++++++++++++++++++++++++++++++ wolfpkcs11/internal.h | 1 + 4 files changed, 600 insertions(+), 12 deletions(-) create mode 100644 tests/session_op_lifecycle_test.c diff --git a/src/internal.c b/src/internal.c index e9db7767..d87070b8 100644 --- a/src/internal.c +++ b/src/internal.c @@ -973,6 +973,7 @@ static int wp11_Slot_AddSession(WP11_Slot* slot, WP11_Session** session) return ret; } +static void wp11_Session_FreeOp(WP11_Session* session); static void wp11_Slot_UnlinkObject(WP11_Slot* slot, WP11_Object* object, WP11_Object** list); static void wp11_Slot_FreeUnlinkedObjects(WP11_Slot* slot); @@ -1012,6 +1013,17 @@ static void wp11_Session_Final(WP11_Session* session) /* Finalize any find. */ WP11_Session_FindFinal(session); + wp11_Session_FreeOp(session); +} + +/** + * Release the resources owned by the session's current operation and mark no + * operation as initialized. + * + * @param session [in] Session object. + */ +static void wp11_Session_FreeOp(WP11_Session* session) +{ #if !defined(NO_RSA) && !defined(WC_NO_RSA_OAEP) if (session->mechanism == CKM_RSA_PKCS_OAEP && session->params.oaep.label != NULL) { @@ -1040,8 +1052,11 @@ static void wp11_Session_Final(WP11_Session* session) session->params.gcm.aad = NULL; } if (session->params.gcm.enc != NULL) { + wc_ForceZero(session->params.gcm.enc, + (word32)session->params.gcm.encSz); XFREE(session->params.gcm.enc, NULL, DYNAMIC_TYPE_TMP_BUFFER); session->params.gcm.enc = NULL; + session->params.gcm.encSz = 0; } #ifdef WOLFSSL_AESGCM_STREAM if (session->params.gcm.streamInit) { @@ -1101,6 +1116,17 @@ static void wp11_Session_Final(WP11_Session* session) session->init = 0; } +/** + * Abort the active operation on the session, releasing what it owns. + * + * @param session [in] Session object. + */ +void WP11_Session_AbortOp(WP11_Session* session) +{ + if (session->init != 0) + wp11_Session_FreeOp(session); +} + #ifndef WOLFPKCS11_NO_STORE #ifndef WOLFPKCS11_CUSTOM_STORE @@ -11591,6 +11617,8 @@ CK_MECHANISM_TYPE WP11_Session_GetMechanism(WP11_Session* session) void WP11_Session_SetMechanism(WP11_Session* session, CK_MECHANISM_TYPE mechanism) { + /* Committing a new operation ends any operation it replaces. */ + WP11_Session_AbortOp(session); session->mechanism = mechanism; } @@ -11714,14 +11742,22 @@ int WP11_Session_SetOaepParams(WP11_Session* session, CK_MECHANISM_TYPE hashAlg, { int ret; WP11_OaepParams* oaep = &session->params.oaep; + enum wc_HashType hashType; + int mgfType; + + ret = wp11_hash_type(hashAlg, &hashType); + if (ret == 0) + ret = wp11_mgf(mgf, &mgfType); + if (ret != 0) + return ret; + WP11_Session_AbortOp(session); if (session->mechanism == CKM_RSA_PKCS_OAEP && oaep->label != NULL) { XFREE(oaep->label, NULL, DYNAMIC_TYPE_TMP_BUFFER); } XMEMSET(oaep, 0, sizeof(*oaep)); - ret = wp11_hash_type(hashAlg, &oaep->hashType); - if (ret == 0) - ret = wp11_mgf(mgf, &oaep->mgf); + oaep->hashType = hashType; + oaep->mgf = mgfType; if (ret == 0 && label == NULL) { oaep->label = NULL; oaep->labelSz = 0; @@ -11757,13 +11793,19 @@ int WP11_Session_SetPssParams(WP11_Session* session, CK_MECHANISM_TYPE hashAlg, { int ret; WP11_PssParams* pss = &session->params.pss; + enum wc_HashType hashType; + int mgfType; - XMEMSET(pss, 0, sizeof(*pss)); - ret = wp11_hash_type(hashAlg, &pss->hashType); - if (ret == 0) - ret = wp11_mgf(mgf, &pss->mgf); + ret = wp11_hash_type(hashAlg, &hashType); if (ret == 0) + ret = wp11_mgf(mgf, &mgfType); + if (ret == 0) { + WP11_Session_AbortOp(session); + XMEMSET(pss, 0, sizeof(*pss)); + pss->hashType = hashType; + pss->mgf = mgfType; pss->saltLen = sLen; + } return ret; } @@ -11784,7 +11826,8 @@ int WP11_Session_SetMldsaParams(WP11_Session* session, CK_VOID_PTR params, CK_ULONG paramsLen) { int ret = 0; - WP11_MldsaParams* mldsa = &session->params.mldsa; + WP11_MldsaParams newParams; + WP11_MldsaParams* mldsa = &newParams; XMEMSET(mldsa, 0, sizeof(*mldsa)); @@ -11846,6 +11889,11 @@ int WP11_Session_SetMldsaParams(WP11_Session* session, CK_VOID_PTR params, mldsa->ctxSz = 0; } + if (ret == 0) { + WP11_Session_AbortOp(session); + XMEMCPY(&session->params.mldsa, mldsa, sizeof(*mldsa)); + } + return ret; } #endif /* WOLFPKCS11_MLDSA */ @@ -11873,6 +11921,7 @@ int WP11_Session_SetCbcParams(WP11_Session* session, unsigned char* iv, * at allocation, so a prior operation can leave stale multi-part streaming * state here. Reset it before use (as the other Set*Params routines do) so * a fresh CBC operation cannot inherit a bogus partial-block count. */ + WP11_Session_AbortOp(session); cbc->partialSz = 0; cbc->finalReady = 0; XMEMSET(cbc->partial, 0, sizeof(cbc->partial)); @@ -11923,6 +11972,7 @@ int WP11_Session_SetCtrParams(WP11_Session* session, CK_ULONG ulCounterBits, if (ulCounterBits > 128 || ulCounterBits == 0) return BAD_FUNC_ARG; + WP11_Session_AbortOp(session); XMEMSET(ctr, 0, sizeof(*ctr)); ret = wc_AesInit(&ctr->aes, NULL, object->devId); if (ret == 0) { @@ -11950,6 +12000,7 @@ int WP11_Session_SetAesWrapParams(WP11_Session* session, byte* iv, word32 ivLen, WP11_KeyWrapParams *wrap = &session->params.kw; WP11_Data *key; + WP11_Session_AbortOp(session); XMEMSET(wrap, 0, sizeof(*wrap)); ret = wc_AesInit(&wrap->aes, NULL, object->devId); if (ret == 0) { @@ -12005,6 +12056,7 @@ int WP11_Session_SetGcmParams(WP11_Session* session, unsigned char* iv, ret = BAD_FUNC_ARG; if (ret == 0) { + WP11_Session_AbortOp(session); if (session->mechanism == CKM_AES_GCM && gcm->aad != NULL) { XFREE(gcm->aad, NULL, DYNAMIC_TYPE_TMP_BUFFER); } @@ -12065,6 +12117,7 @@ int WP11_Session_SetCcmParams(WP11_Session* session, int dataSz, ret = BAD_FUNC_ARG; if (ret == 0) { + WP11_Session_AbortOp(session); if (session->mechanism == CKM_AES_CCM && ccm->aad != NULL) { XFREE(ccm->aad, NULL, DYNAMIC_TYPE_TMP_BUFFER); } @@ -12100,6 +12153,7 @@ int WP11_Session_SetCtsParams(WP11_Session* session, unsigned char* iv, WP11_CtsParams* cts = &session->params.cts; WP11_Data* key; + WP11_Session_AbortOp(session); /* AES object on session. */ ret = wc_AesInit(&cts->aes, NULL, object->devId); if (ret == 0) { @@ -20037,6 +20091,7 @@ int WP11_Aes_Cmac_Init(WP11_Object* secret, WP11_Session* session, if (sigLen > WC_CMAC_TAG_MAX_SZ || sigLen < WC_CMAC_TAG_MIN_SZ) return BAD_FUNC_ARG; + WP11_Session_AbortOp(session); cmac->sigLen = (byte)sigLen; if (secret->onToken) WP11_Lock_LockRO(secret->lock); @@ -20221,6 +20276,7 @@ int WP11_Digest_Init(CK_MECHANISM_TYPE mechanism, WP11_Session* session) ret = wp11_digest_hash_type(mechanism, &hashType); if (ret == 0) { + WP11_Session_AbortOp(session); digest->hashType = (enum wc_HashType)hashType; ret = wc_HashInit(&digest->hash, (enum wc_HashType)hashType); } @@ -20447,12 +20503,14 @@ int WP11_Hmac_Init(CK_MECHANISM_TYPE mechanism, WP11_Object* secret, WP11_Data* key; ret = wp11_hmac_hash_type(mechanism, &hashType); - if (ret == 0) - hmac->hmacSz = wc_HmacSizeByType(hashType); - if (ret == 0 && digestSize != 0 && hmac->hmacSz != (word32)digestSize) + if (ret == 0 && digestSize != 0 && + (word32)wc_HmacSizeByType(hashType) != (word32)digestSize) ret = BAD_FUNC_ARG; - if (ret == 0) + if (ret == 0) { + WP11_Session_AbortOp(session); + hmac->hmacSz = wc_HmacSizeByType(hashType); ret = wc_HmacInit(&hmac->hmac, NULL, secret->slot->devId); + } if (ret == 0) { if (secret->onToken) WP11_Lock_LockRO(secret->lock); @@ -20603,6 +20661,9 @@ int WP11_TLS_MAC_init(unsigned long hashType, unsigned long macLen, byte server, int ret = 0; WP11_TlsMacParams *mac = &session->params.tlsMac; + if (hashType != CKM_TLS_PRF && MechToMac(hashType) == no_mac) + return BAD_FUNC_ARG; + WP11_Session_AbortOp(session); XMEMSET(mac, 0, sizeof(*mac)); if (hashType == CKM_TLS_PRF) { mac->isTlsPrf = 1; diff --git a/tests/include.am b/tests/include.am index 44afb51b..3ac00568 100644 --- a/tests/include.am +++ b/tests/include.am @@ -331,6 +331,11 @@ tests_object_policy_integrity_test_SOURCES = \ tests/object_policy_integrity_test.c tests_object_policy_integrity_test_LDADD = +check_PROGRAMS += tests/session_op_lifecycle_test +noinst_PROGRAMS += tests/session_op_lifecycle_test +tests_session_op_lifecycle_test_SOURCES = tests/session_op_lifecycle_test.c +tests_session_op_lifecycle_test_LDADD = + if BUILD_STATIC tests_pkcs11test_LDADD += src/libwolfpkcs11.la tests_pkcs11mtt_LDADD += src/libwolfpkcs11.la @@ -398,6 +403,7 @@ tests_logout_retire_test_LDADD += src/libwolfpkcs11.la tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la tests_object_store_decode_test_LDADD += src/libwolfpkcs11.la tests_object_policy_integrity_test_LDADD += src/libwolfpkcs11.la +tests_session_op_lifecycle_test_LDADD += src/libwolfpkcs11.la else tests_object_id_uniqueness_test_LDADD += src/libwolfpkcs11.la tests_empty_pin_store_test_LDADD += src/libwolfpkcs11.la @@ -457,6 +463,7 @@ tests_logout_retire_test_LDADD += src/libwolfpkcs11.la tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la tests_object_store_decode_test_LDADD += src/libwolfpkcs11.la tests_object_policy_integrity_test_LDADD += src/libwolfpkcs11.la +tests_session_op_lifecycle_test_LDADD += src/libwolfpkcs11.la endif EXTRA_DIST += tests/unit.h \ diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c new file mode 100644 index 00000000..95e425d7 --- /dev/null +++ b/tests/session_op_lifecycle_test.c @@ -0,0 +1,519 @@ +/* session_op_lifecycle_test.c + * + * Copyright (C) 2006-2026 wolfSSL Inc. + * + * This file is part of wolfPKCS11. + * + * wolfPKCS11 is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfPKCS11 is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA + * + * Every way a session operation ends (completion, error, replacement or + * session close) must release and scrub the state the operation owned. + */ + +#ifdef HAVE_CONFIG_H + #include +#endif + +#include +#include +#include + +#ifndef WOLFSSL_USER_SETTINGS + #include +#endif +#include +#include +#include + +#ifndef WOLFPKCS11_USER_SETTINGS + #include +#endif +#include + +#ifndef HAVE_PKCS11_STATIC +#include +#endif + +#include "testdata.h" +#include "pkcs11_test_util.h" + +#define TEST_DIR "./store/session_op_lifecycle_test" + +#if defined(USE_WOLFSSL_MEMORY) && !defined(NO_WOLFSSL_MEMORY) && \ + !defined(WOLFSSL_STATIC_MEMORY) && !defined(WOLFSSL_DEBUG_MEMORY) + #define TRACK_ALLOCS +#endif + +/* Fixtures and helpers are shared by tests that compile in different builds. */ +#if defined(_MSC_VER) + #pragma warning(push) + #pragma warning(disable: 4101 4189 4505) +#elif defined(__GNUC__) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wunused-variable" + #pragma GCC diagnostic ignored "-Wunused-function" +#endif + +static CK_OBJECT_CLASS secretClass = CKO_SECRET_KEY; +static CK_KEY_TYPE aesType = CKK_AES; +static CK_KEY_TYPE genericType = CKK_GENERIC_SECRET; +static CK_BBOOL ckTrue = CK_TRUE; +static CK_BBOOL ckFalse = CK_FALSE; + +/* Uniform key bytes so the value is recognisable in any key schedule. */ +static byte aesKeyValue[16] = { + 0xC3, 0xC3, 0xC3, 0xC3, 0xC3, 0xC3, 0xC3, 0xC3, + 0xC3, 0xC3, 0xC3, 0xC3, 0xC3, 0xC3, 0xC3, 0xC3 +}; +static byte macKeyValue[32] = { + 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, + 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, + 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, + 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C, 0x3C +}; +static byte gcmIv[12] = { 0 }; +static byte gcmAad[48] = { 0 }; +static byte plainMarker[32] = { + 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, + 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, + 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, + 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B, 0x6B +}; + +#ifdef TRACK_ALLOCS +/* Allocation hooks: count live blocks and look for a watched byte pattern in + * every block handed back to the allocator. */ +#define ALLOC_HDR_SZ 16 + +static long liveBlocks = 0; +static const byte* watchData = NULL; +static size_t watchLen = 0; +static int watchHit = 0; + +static void track_scan(const byte* p, size_t sz) +{ + size_t i; + + if (watchData == NULL || watchLen == 0 || sz < watchLen) + return; + for (i = 0; i + watchLen <= sz; i++) { + if (XMEMCMP(p + i, watchData, watchLen) == 0) { + watchHit = 1; + return; + } + } +} + +static void* track_malloc(size_t sz) +{ + byte* p = (byte*)malloc(sz + ALLOC_HDR_SZ); + + if (p == NULL) + return NULL; + /* Zeroed so a scan only sees bytes the library wrote. */ + XMEMSET(p, 0, sz + ALLOC_HDR_SZ); + XMEMCPY(p, &sz, sizeof(sz)); + liveBlocks++; + return p + ALLOC_HDR_SZ; +} + +static void track_free(void* ptr) +{ + byte* p; + size_t sz; + + if (ptr == NULL) + return; + p = (byte*)ptr - ALLOC_HDR_SZ; + XMEMCPY(&sz, p, sizeof(sz)); + track_scan((byte*)ptr, sz); + liveBlocks--; + free(p); +} + +static void* track_realloc(void* ptr, size_t sz) +{ + void* n; + size_t oldSz; + + if (ptr == NULL) + return track_malloc(sz); + if (sz == 0) { + track_free(ptr); + return NULL; + } + n = track_malloc(sz); + if (n == NULL) + return NULL; + XMEMCPY(&oldSz, (byte*)ptr - ALLOC_HDR_SZ, sizeof(oldSz)); + XMEMCPY(n, ptr, (oldSz < sz) ? oldSz : sz); + track_free(ptr); + return n; +} + +static void watch_start(const byte* data, size_t len) +{ + watchData = data; + watchLen = len; + watchHit = 0; +} + +static int watch_stop(void) +{ + watchData = NULL; + watchLen = 0; + return watchHit; +} +#endif /* TRACK_ALLOCS */ + +static CK_RV create_secret(CK_SESSION_HANDLE session, CK_KEY_TYPE* type, + byte* value, CK_ULONG valueLen, + CK_OBJECT_HANDLE* key) +{ + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, type, sizeof(*type) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_DECRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_SIGN, &ckTrue, sizeof(ckTrue) }, + { CKA_VERIFY, &ckTrue, sizeof(ckTrue) }, + { CKA_TOKEN, &ckFalse, sizeof(ckFalse) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_VALUE, value, valueLen }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), key); +} + +#if !defined(NO_RSA) && (!defined(WC_NO_RSA_OAEP) || defined(WC_RSA_PSS)) +static CK_RV create_rsa_public(CK_SESSION_HANDLE session, + CK_OBJECT_HANDLE* key) +{ + static CK_OBJECT_CLASS pubClass = CKO_PUBLIC_KEY; + static CK_KEY_TYPE rsaType = CKK_RSA; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &pubClass, sizeof(pubClass) }, + { CKA_KEY_TYPE, &rsaType, sizeof(rsaType) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_VERIFY, &ckTrue, sizeof(ckTrue) }, + { CKA_TOKEN, &ckFalse, sizeof(ckFalse) }, + { CKA_MODULUS, rsa_2048_modulus, sizeof(rsa_2048_modulus) }, + { CKA_PUBLIC_EXPONENT, rsa_2048_pub_exp, sizeof(rsa_2048_pub_exp) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), key); +} +#endif + +#ifdef HAVE_ECC +static CK_RV create_ec_public(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE* key) +{ + static CK_OBJECT_CLASS pubClass = CKO_PUBLIC_KEY; + static CK_KEY_TYPE ecType = CKK_EC; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &pubClass, sizeof(pubClass) }, + { CKA_KEY_TYPE, &ecType, sizeof(ecType) }, + { CKA_VERIFY, &ckTrue, sizeof(ckTrue) }, + { CKA_TOKEN, &ckFalse, sizeof(ckFalse) }, + { CKA_EC_PARAMS, ecc_p256_params, sizeof(ecc_p256_params) }, + { CKA_EC_POINT, ecc_p256_pub, sizeof(ecc_p256_pub) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), key); +} +#endif + +static CK_RV init_library(CK_SLOT_ID* slot) +{ + CK_RV rv; + CK_C_INITIALIZE_ARGS args; + CK_ULONG slotCount = 1; + + XMEMSET(&args, 0, sizeof(args)); + args.flags = CKF_OS_LOCKING_OK; + rv = funcList->C_Initialize(&args); + if (rv == CKR_OK) + rv = funcList->C_GetSlotList(CK_TRUE, slot, &slotCount); + if (rv == CKR_OK && slotCount == 0) + rv = CKR_TOKEN_NOT_PRESENT; + return rv; +} + +static CK_RV open_with_keys(CK_SLOT_ID slot, CK_SESSION_HANDLE* session, + CK_OBJECT_HANDLE* aesKey, + CK_OBJECT_HANDLE* macKey) +{ + CK_RV rv; + + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, session); + if (rv == CKR_OK) { + rv = create_secret(*session, &aesType, aesKeyValue, + sizeof(aesKeyValue), aesKey); + } + if (rv == CKR_OK) { + rv = create_secret(*session, &genericType, macKeyValue, + sizeof(macKeyValue), macKey); + } + return rv; +} + +#if defined(_MSC_VER) + #pragma warning(pop) +#elif defined(__GNUC__) + #pragma GCC diagnostic pop +#endif + +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ + !defined(NO_HMAC) && !defined(NO_SHA256) +/* Starting an operation of another category must release the resources held + * by the operation it replaces. */ +static void test_cross_category_init_releases_state(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_GCM_PARAMS gcmParams; + CK_MECHANISM gcmMech = { CKM_AES_GCM, &gcmParams, sizeof(gcmParams) }; + CK_MECHANISM hmacMech = { CKM_SHA256_HMAC, NULL, 0 }; + CK_MECHANISM sha256Mech = { CKM_SHA256, NULL, 0 }; +#if !defined(NO_RSA) && !defined(WC_NO_RSA_OAEP) + CK_OBJECT_HANDLE rsaKey = CK_INVALID_HANDLE; + byte label[24] = { 0 }; + CK_RSA_PKCS_OAEP_PARAMS oaepParams = { + CKM_SHA256, CKG_MGF1_SHA256, CKZ_DATA_SPECIFIED, label, sizeof(label) + }; + CK_MECHANISM oaepMech = { CKM_RSA_PKCS_OAEP, &oaepParams, + sizeof(oaepParams) }; +#endif +#ifdef HAVE_ECC + CK_OBJECT_HANDLE ecKey = CK_INVALID_HANDLE; + CK_MECHANISM ecdsaMech = { CKM_ECDSA, NULL, 0 }; +#endif + byte out[64]; + CK_ULONG outLen; + CK_SLOT_ID slot; + long before; + + printf("\n--- replacing an operation releases its state ---\n"); + XMEMSET(&gcmParams, 0, sizeof(gcmParams)); + gcmParams.pIv = gcmIv; + gcmParams.ulIvLen = sizeof(gcmIv); + gcmParams.ulIvBits = sizeof(gcmIv) * 8; + gcmParams.pAAD = gcmAad; + gcmParams.ulAADLen = sizeof(gcmAad); + gcmParams.ulTagBits = 128; + + rv = init_library(&slot); + CHECK_RV(rv, "initialize library", CKR_OK); + if (rv != CKR_OK) + goto out; + before = liveBlocks; + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM with AAD)", CKR_OK); + rv = funcList->C_VerifyInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_VerifyInit(HMAC) over active encrypt", CKR_OK); + + rv = funcList->C_DecryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_DecryptInit(AES-GCM with AAD)", CKR_OK); + rv = funcList->C_DigestInit(session, &sha256Mech); + CHECK_RV(rv, "C_DigestInit over active decrypt", CKR_OK); + + rv = funcList->C_SignInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_SignInit(HMAC) over active digest", CKR_OK); + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM) over active sign", CKR_OK); + rv = funcList->C_SignInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_SignInit(HMAC) over active encrypt", CKR_OK); + + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM) over active sign", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_EncryptUpdate(session, plainMarker, sizeof(plainMarker), + out, &outLen); + CHECK_RV(rv, "C_EncryptUpdate(AES-GCM)", CKR_OK); + watch_start(plainMarker, sizeof(plainMarker)); + rv = funcList->C_SignInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_SignInit(HMAC) over multi-part encrypt", CKR_OK); + CHECK_TRUE(!watch_stop(), + "replaced operation scrubs buffered input before release"); + +#ifdef HAVE_ECC + rv = create_ec_public(session, &ecKey); + CHECK_RV(rv, "C_CreateObject(EC public)", CKR_OK); + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM) over active sign", CKR_OK); + rv = funcList->C_VerifyInit(session, &ecdsaMech, ecKey); + CHECK_RV(rv, "C_VerifyInit(ECDSA) over active encrypt", CKR_OK); + rv = funcList->C_DestroyObject(session, ecKey); + CHECK_RV(rv, "C_DestroyObject(EC)", CKR_OK); +#endif + +#if !defined(NO_RSA) && !defined(WC_NO_RSA_OAEP) + rv = create_rsa_public(session, &rsaKey); + CHECK_RV(rv, "C_CreateObject(RSA public)", CKR_OK); + rv = funcList->C_EncryptInit(session, &oaepMech, rsaKey); + CHECK_RV(rv, "C_EncryptInit(RSA-OAEP with label)", CKR_OK); + rv = funcList->C_DecryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_DecryptInit(AES-GCM) over active encrypt", CKR_OK); + rv = funcList->C_SignInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_SignInit(HMAC) over active decrypt", CKR_OK); + rv = funcList->C_DestroyObject(session, rsaKey); + CHECK_RV(rv, "C_DestroyObject(RSA)", CKR_OK); +#endif + + rv = funcList->C_DestroyObject(session, aesKey); + CHECK_RV(rv, "C_DestroyObject(AES)", CKR_OK); + rv = funcList->C_DestroyObject(session, macKey); + CHECK_RV(rv, "C_DestroyObject(HMAC)", CKR_OK); + funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; + CHECK_TRUE(liveBlocks == before, + "replaced operations leave no allocation behind"); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + +#if !defined(NO_AES) && defined(HAVE_AES_CBC) && defined(HAVE_ECC) +/* A request that is rejected before it can start must leave the operation + * already active on the session untouched. */ +static void test_rejected_init_keeps_active_operation(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_MECHANISM cbcMech = { CKM_AES_CBC, NULL, 0 }; + CK_MECHANISM ecdsaMech = { CKM_ECDSA, NULL, 0 }; + CK_MECHANISM badMech = { CKM_VENDOR_DEFINED, NULL, 0 }; +#if !defined(NO_HMAC) && !defined(NO_SHA256) + CK_ULONG badMacLen = 5; + CK_MECHANISM hmacMech = { CKM_SHA256_HMAC, &badMacLen, + sizeof(badMacLen) }; +#endif +#if !defined(NO_RSA) && defined(WC_RSA_PSS) + CK_OBJECT_HANDLE rsaKey = CK_INVALID_HANDLE; + CK_RSA_PKCS_PSS_PARAMS pssParams = { CKM_VENDOR_DEFINED, CKG_MGF1_SHA256, + 32 }; + CK_MECHANISM pssMech = { CKM_RSA_PKCS_PSS, &pssParams, + sizeof(pssParams) }; +#endif + byte iv[16] = { 0 }; + byte out[32]; + CK_ULONG outLen; + CK_SLOT_ID slot; + + printf("\n--- a rejected Init keeps the active operation ---\n"); + cbcMech.pParameter = iv; + cbcMech.ulParameterLen = sizeof(iv); + + rv = init_library(&slot); + CHECK_RV(rv, "initialize library", CKR_OK); + if (rv != CKR_OK) + goto out; + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_EncryptInit(session, &cbcMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-CBC)", CKR_OK); + rv = funcList->C_VerifyInit(session, &ecdsaMech, macKey); + CHECK_RV(rv, "C_VerifyInit(ECDSA) with a secret key", + CKR_KEY_TYPE_INCONSISTENT); + rv = funcList->C_SignInit(session, &badMech, macKey); + CHECK_RV(rv, "C_SignInit(unknown mechanism)", CKR_MECHANISM_INVALID); +#if !defined(NO_HMAC) && !defined(NO_SHA256) + rv = funcList->C_SignInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_SignInit(HMAC with bad output length)", + CKR_MECHANISM_PARAM_INVALID); +#endif +#if !defined(NO_RSA) && defined(WC_RSA_PSS) + rv = create_rsa_public(session, &rsaKey); + CHECK_RV(rv, "C_CreateObject(RSA public)", CKR_OK); + rv = funcList->C_VerifyInit(session, &pssMech, rsaKey); + CHECK_RV(rv, "C_VerifyInit(RSA-PSS with bad hash)", + CKR_MECHANISM_PARAM_INVALID); +#endif + + outLen = sizeof(out); + rv = funcList->C_EncryptUpdate(session, plainMarker, sizeof(plainMarker), + out, &outLen); + CHECK_RV(rv, "C_EncryptUpdate after rejected Inits", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_EncryptFinal(session, out, &outLen); + CHECK_RV(rv, "C_EncryptFinal after rejected Inits", CKR_OK); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + +static int run_test(void) +{ + CK_RV rv; + +#ifdef TRACK_ALLOCS + if (wolfSSL_SetAllocators(track_malloc, track_free, track_realloc) != 0) { + CHECK_TRUE(0, "install allocation hooks"); + return -1; + } +#endif + + rv = pkcs11_load(); + CHECK_RV(rv, "load library", CKR_OK); + if (rv != CKR_OK) + return -1; + +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ + !defined(NO_HMAC) && !defined(NO_SHA256) + test_cross_category_init_releases_state(); +#endif +#if !defined(NO_AES) && defined(HAVE_AES_CBC) && defined(HAVE_ECC) + test_rejected_init_keeps_active_operation(); +#endif + + pkcs11_unload(); + return 0; +} + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + +#ifndef WOLFPKCS11_NO_ENV + XSETENV("WOLFPKCS11_TOKEN_PATH", TEST_DIR, 1); +#endif + + printf("=== wolfPKCS11 session operation lifecycle test ===\n"); + run_test(); + return pkcs11_test_summary(); +} diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 5f59f28f..00fc1519 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -459,6 +459,7 @@ WP11_LOCAL void WP11_Session_FreeData(WP11_Session *session); WP11_LOCAL int WP11_Session_IsHashOpInitialized(WP11_Session* session, int mechanism); WP11_LOCAL enum wc_HashType WP11_Session_ToHashType(WP11_Session* session); WP11_LOCAL void WP11_Session_SetOpInitialized(WP11_Session* session, int init); +WP11_LOCAL void WP11_Session_AbortOp(WP11_Session* session); WP11_LOCAL WP11_Slot* WP11_Session_GetSlot(WP11_Session* session); WP11_LOCAL CK_SLOT_ID WP11_Session_GetSlotId(WP11_Session* session); WP11_LOCAL CK_MECHANISM_TYPE WP11_Session_GetMechanism(WP11_Session* session); From 92b96a52a7ae669e2d79833de9c09861852d675a Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:31:07 -0700 Subject: [PATCH 030/104] F-8664 - Release operation state on terminating error paths --- src/crypto.c | 120 +++++++++++++++--------------- src/internal.c | 2 + tests/session_op_lifecycle_test.c | 88 ++++++++++++++++++++++ 3 files changed, 150 insertions(+), 60 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index a301c4d2..5f628d3b 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -2890,7 +2890,7 @@ static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_CBC_ENC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -2914,12 +2914,12 @@ static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, return CKR_OPERATION_NOT_INITIALIZED; } if (!CK_ULONG_FITS_WORD32(ulDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } /* Ensure padded result fits in word32 */ if (ulDataLen > (CK_ULONG)(0xFFFFFFFF - AES_BLOCK_SIZE)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -2967,7 +2967,7 @@ static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_GCM_ENC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -2992,7 +2992,7 @@ static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_CCM_ENC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -3017,7 +3017,7 @@ static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_ECB_ENC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -3061,7 +3061,7 @@ static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_KEYWRAP_ENC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -3086,7 +3086,7 @@ static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_KEYWRAP_ENC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulDataLen) || ulDataLen == 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -3116,7 +3116,7 @@ static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, (void)encDataLen; (void)ulDataLen; (void)pEncryptedData; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } @@ -3211,7 +3211,7 @@ static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, return rv; } if (!CK_ULONG_FITS_WORD32(ulPartLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -3233,7 +3233,7 @@ static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, pEncryptedPart, &encPartLen, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); rv = CKR_FUNCTION_FAILED; WOLFPKCS11_LEAVE("C_EncryptUpdate", rv); return rv; @@ -3246,7 +3246,7 @@ static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, return CKR_OPERATION_NOT_INITIALIZED; } if (!CK_ULONG_FITS_WORD32(ulPartLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -3262,7 +3262,7 @@ static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, ret = WP11_AesCbcPad_EncryptUpdate(pPart, (int)ulPartLen, pEncryptedPart, &encPartLen, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulEncryptedPartLen = encPartLen; @@ -3288,7 +3288,7 @@ static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, return CKR_DATA_LEN_RANGE; } if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulEncryptedPartLen = encPartLen; @@ -3311,7 +3311,7 @@ static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, pEncryptedPart, &encPartLen, obj, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulEncryptedPartLen = encPartLen; @@ -3333,7 +3333,7 @@ static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, if (ret == BUFFER_E) return CKR_BUFFER_TOO_SMALL; if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulEncryptedPartLen = encPartLen; @@ -3345,7 +3345,7 @@ static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, (void)ret; (void)ulPartLen; (void)pEncryptedPart; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); rv = CKR_MECHANISM_INVALID; WOLFPKCS11_LEAVE("C_EncryptUpdate", rv); return rv; @@ -3441,7 +3441,7 @@ static CK_RV wp11_C_EncryptFinal(CK_SESSION_HANDLE hSession, ret = WP11_AesCbc_EncryptFinal(session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } break; @@ -3462,7 +3462,7 @@ static CK_RV wp11_C_EncryptFinal(CK_SESSION_HANDLE hSession, ret = WP11_AesCbcPad_EncryptFinal(pLastEncryptedPart, &encPartLen, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } break; @@ -3479,7 +3479,7 @@ static CK_RV wp11_C_EncryptFinal(CK_SESSION_HANDLE hSession, ret = WP11_AesCtr_Final(session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulLastEncryptedPartLen = 0; @@ -3501,7 +3501,7 @@ static CK_RV wp11_C_EncryptFinal(CK_SESSION_HANDLE hSession, ret = WP11_AesGcm_EncryptFinal(pLastEncryptedPart, &encPartLen, obj, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulLastEncryptedPartLen = encPartLen; @@ -3523,7 +3523,7 @@ static CK_RV wp11_C_EncryptFinal(CK_SESSION_HANDLE hSession, if (ret == BUFFER_E) return CKR_BUFFER_TOO_SMALL; if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulLastEncryptedPartLen = encPartLen; @@ -3534,7 +3534,7 @@ static CK_RV wp11_C_EncryptFinal(CK_SESSION_HANDLE hSession, (void)encPartLen; (void)ret; (void)pLastEncryptedPart; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } @@ -3974,7 +3974,7 @@ static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_CBC_DEC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulEncryptedDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -3998,7 +3998,7 @@ static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, return CKR_OPERATION_NOT_INITIALIZED; } if (!CK_ULONG_FITS_WORD32(ulEncryptedDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -4063,7 +4063,7 @@ static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, return CKR_OPERATION_NOT_INITIALIZED; if (ulEncryptedDataLen < (CK_ULONG)WP11_AesGcm_GetTagBits(session) / 8) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_ENCRYPTED_DATA_LEN_RANGE; } decDataLen = (word32)ulEncryptedDataLen - @@ -4088,7 +4088,7 @@ static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, return CKR_OPERATION_NOT_INITIALIZED; if (ulEncryptedDataLen < (CK_ULONG)WP11_AesCcm_GetMacLen(session)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_ENCRYPTED_DATA_LEN_RANGE; } decDataLen = (word32)ulEncryptedDataLen - @@ -4112,7 +4112,7 @@ static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_ECB_DEC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulEncryptedDataLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -4161,7 +4161,7 @@ static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, /* AES Key Wrap ciphertext is at least two semiblocks: one data * semiblock plus the 8-byte integrity check value. */ if (ulEncryptedDataLen < 2 * KEYWRAP_BLOCK_SIZE) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_ENCRYPTED_DATA_LEN_RANGE; } decDataLen = (word32)(ulEncryptedDataLen - KEYWRAP_BLOCK_SIZE); @@ -4187,7 +4187,7 @@ static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, * after unwrapping; the upper bound is ciphertext - 8. */ if (ulEncryptedDataLen < 2 * KEYWRAP_BLOCK_SIZE || (ulEncryptedDataLen % KEYWRAP_BLOCK_SIZE) != 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_ENCRYPTED_DATA_LEN_RANGE; } decDataLen = (word32)(ulEncryptedDataLen - KEYWRAP_BLOCK_SIZE); @@ -4220,7 +4220,7 @@ static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, (void)ret; (void)ulEncryptedDataLen; (void)pData; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } @@ -4307,7 +4307,7 @@ static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_AES_CBC_DEC)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulEncryptedPartLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -4325,7 +4325,7 @@ static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, (int)ulEncryptedPartLen, pPart, &decPartLen, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulPartLen = decPartLen; @@ -4336,7 +4336,7 @@ static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, return CKR_OPERATION_NOT_INITIALIZED; } if (!CK_ULONG_FITS_WORD32(ulEncryptedPartLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -4363,7 +4363,7 @@ static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, return CKR_BUFFER_TOO_SMALL; } if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulPartLen = decPartLen; @@ -4389,7 +4389,7 @@ static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, return CKR_DATA_LEN_RANGE; } if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulPartLen = decPartLen; @@ -4407,7 +4407,7 @@ static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, ret = WP11_AesGcm_DecryptUpdate(pEncryptedPart, (int)ulEncryptedPartLen, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } break; @@ -4428,7 +4428,7 @@ static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, if (ret == BUFFER_E) return CKR_BUFFER_TOO_SMALL; if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulPartLen = decPartLen; @@ -4440,7 +4440,7 @@ static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, (void)ret; (void)ulEncryptedPartLen; (void)pPart; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } @@ -4533,7 +4533,7 @@ static CK_RV wp11_C_DecryptFinal(CK_SESSION_HANDLE hSession, ret = WP11_AesCbc_DecryptFinal(session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } break; @@ -4568,7 +4568,7 @@ static CK_RV wp11_C_DecryptFinal(CK_SESSION_HANDLE hSession, return CKR_BUFFER_TOO_SMALL; } if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulLastPartLen = decPartLen; @@ -4586,7 +4586,7 @@ static CK_RV wp11_C_DecryptFinal(CK_SESSION_HANDLE hSession, ret = WP11_AesCtr_Final(session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulLastPartLen = 0; @@ -4599,7 +4599,7 @@ static CK_RV wp11_C_DecryptFinal(CK_SESSION_HANDLE hSession, if (WP11_AesGcm_EncDataLen(session) < WP11_AesGcm_GetTagBits(session) / 8) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_ENCRYPTED_DATA_LEN_RANGE; } decPartLen = WP11_AesGcm_EncDataLen(session) - @@ -4614,7 +4614,7 @@ static CK_RV wp11_C_DecryptFinal(CK_SESSION_HANDLE hSession, ret = WP11_AesGcm_DecryptFinal(pLastPart, &decPartLen, obj, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulLastPartLen = decPartLen; @@ -4635,7 +4635,7 @@ static CK_RV wp11_C_DecryptFinal(CK_SESSION_HANDLE hSession, if (ret == BUFFER_E) return CKR_BUFFER_TOO_SMALL; if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } *pulLastPartLen = decPartLen; @@ -4646,7 +4646,7 @@ static CK_RV wp11_C_DecryptFinal(CK_SESSION_HANDLE hSession, (void)decPartLen; (void)ret; (void)pLastPart; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } @@ -4835,7 +4835,7 @@ CK_RV C_DigestUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, ret = WP11_Digest_Update(pPart, (word32)ulPartLen, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } return CKR_OK; @@ -4879,21 +4879,21 @@ static CK_RV wp11_C_DigestKey(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hKey) ret = WP11_Object_Find(session, hKey, &obj); if (ret != 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_OBJECT_HANDLE_INVALID; } ret = WP11_Digest_Key(obj, session); if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } if (ret > 0) { /* Positive return is a CK_RV (e.g. CKR_FUNCTION_NOT_SUPPORTED on * WOLFPKCS11_NO_STORE builds). Pass it through but still terminate * the digest operation so the session is not left active. */ - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return (CK_RV)ret; } return CKR_OK; @@ -5810,7 +5810,7 @@ static CK_RV wp11_C_Sign(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, (void)sigLen; (void)ulDataLen; (void)pSignature; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } WP11_Session_SetOpInitialized(session, 0); @@ -5941,7 +5941,7 @@ static CK_RV wp11_C_SignUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, if (!WP11_Session_IsOpInitialized(session, WP11_INIT_TLS_MAC_SIGN)) return CKR_OPERATION_NOT_INITIALIZED; if (!CK_ULONG_FITS_WORD32(ulPartLen)) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_DATA_LEN_RANGE; } @@ -5950,11 +5950,11 @@ static CK_RV wp11_C_SignUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, #endif default: (void)ulPartLen; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } @@ -6127,7 +6127,7 @@ static CK_RV wp11_C_SignFinal(CK_SESSION_HANDLE hSession, default: (void)sigLen; (void)pSignature; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } WP11_Session_SetOpInitialized(session, 0); @@ -6948,7 +6948,7 @@ static CK_RV wp11_C_Verify(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, default: (void)ulDataLen; (void)ulSignatureLen; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } WP11_Session_SetOpInitialized(session, 0); @@ -7081,11 +7081,11 @@ static CK_RV wp11_C_VerifyUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, #endif default: (void)ulPartLen; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } if (ret < 0) { - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_FUNCTION_FAILED; } @@ -7216,7 +7216,7 @@ static CK_RV wp11_C_VerifyFinal(CK_SESSION_HANDLE hSession, #endif default: (void)ulSignatureLen; - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); return CKR_MECHANISM_INVALID; } WP11_Session_SetOpInitialized(session, 0); @@ -8878,7 +8878,7 @@ static CK_RV wp11_C_WrapKey(CK_SESSION_HANDLE hSession, /* C_WrapKey is single-part: a length query or a short buffer * leaves C_Encrypt's operation active, which would make the * caller's next C_WrapKey fail with CKR_OPERATION_ACTIVE. */ - WP11_Session_SetOpInitialized(session, 0); + WP11_Session_AbortOp(session); if (rv != CKR_OK) goto err_out; } diff --git a/src/internal.c b/src/internal.c index d87070b8..5a29f2a4 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1112,6 +1112,8 @@ static void wp11_Session_FreeOp(WP11_Session* session) session->params.digest.hashType); session->init &= ~WP11_INIT_DIGEST_MASK; } + /* Older wolfSSL versions do not zeroize the key schedule in wc_AesFree. */ + wc_ForceZero(&session->params, sizeof(session->params)); /* Ensure no stale bits remain after all cleanup. */ session->init = 0; } diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index 95e425d7..007b2733 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -476,6 +476,90 @@ static void test_rejected_init_keeps_active_operation(void) } #endif +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AES_CBC) && \ + !defined(NO_SHA256) +static int finalize_watched(CK_SESSION_HANDLE session) +{ + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); + return watch_stop(); +} + +/* An operation that ends on an error must release and scrub its keyed and + * buffered state, just as a completed operation does. */ +static void test_failed_operation_scrubs_state(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + byte iv[16] = { 0 }; + CK_MECHANISM cbcMech = { CKM_AES_CBC, NULL, 0 }; + CK_MECHANISM sha256Mech = { CKM_SHA256, NULL, 0 }; + CK_ULONG bigLen = (CK_ULONG)0xFFFFFFFFUL; + byte out[64]; + CK_ULONG outLen; + CK_SLOT_ID slot; + int i; + + printf("\n--- an operation ending on error scrubs its state ---\n"); + cbcMech.pParameter = iv; + cbcMech.ulParameterLen = sizeof(iv); + if (sizeof(CK_ULONG) <= sizeof(word32)) { + printf("SKIP: lengths beyond 32 bits need a 64-bit CK_ULONG\n"); + return; + } + bigLen += 16; + + for (i = 0; i < 2; i++) { + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + rv = funcList->C_EncryptInit(session, &cbcMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-CBC)", CKR_OK); + outLen = sizeof(out); + /* Watch from the failing call: it may free the state itself. */ + watch_start(aesKeyValue, sizeof(aesKeyValue)); + if (i == 0) { + rv = funcList->C_EncryptUpdate(session, out, bigLen, out, &outLen); + CHECK_RV(rv, "C_EncryptUpdate(oversized)", CKR_DATA_LEN_RANGE); + } + else { + rv = funcList->C_Encrypt(session, out, bigLen, out, &outLen); + CHECK_RV(rv, "C_Encrypt(oversized)", CKR_DATA_LEN_RANGE); + } + CHECK_TRUE(!finalize_watched(session), + "failed AES operation leaves no key schedule behind"); + session = CK_INVALID_HANDLE; + } + + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + rv = funcList->C_DigestInit(session, &sha256Mech); + CHECK_RV(rv, "C_DigestInit(SHA-256)", CKR_OK); + rv = funcList->C_DigestUpdate(session, plainMarker, sizeof(plainMarker)); + CHECK_RV(rv, "C_DigestUpdate", CKR_OK); + watch_start(plainMarker, sizeof(plainMarker)); + rv = funcList->C_DigestKey(session, CK_INVALID_HANDLE); + CHECK_RV(rv, "C_DigestKey(invalid handle)", CKR_OBJECT_HANDLE_INVALID); + CHECK_TRUE(!finalize_watched(session), + "failed digest leaves no buffered input behind"); + session = CK_INVALID_HANDLE; + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + static int run_test(void) { CK_RV rv; @@ -499,6 +583,10 @@ static int run_test(void) #if !defined(NO_AES) && defined(HAVE_AES_CBC) && defined(HAVE_ECC) test_rejected_init_keeps_active_operation(); #endif +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AES_CBC) && \ + !defined(NO_SHA256) + test_failed_operation_scrubs_state(); +#endif pkcs11_unload(); return 0; From 6e40e9d9051da847389f1924daf06963a3ed3806 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:07:02 -0700 Subject: [PATCH 031/104] F-11514 - Free buffered AES-GCM data when GCM parameters are reset --- src/internal.c | 8 ++++ tests/session_op_lifecycle_test.c | 69 +++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+) diff --git a/src/internal.c b/src/internal.c index 5a29f2a4..ac1cd363 100644 --- a/src/internal.c +++ b/src/internal.c @@ -12062,6 +12062,14 @@ int WP11_Session_SetGcmParams(WP11_Session* session, unsigned char* iv, if (session->mechanism == CKM_AES_GCM && gcm->aad != NULL) { XFREE(gcm->aad, NULL, DYNAMIC_TYPE_TMP_BUFFER); } + if (session->mechanism == CKM_AES_GCM && gcm->enc != NULL) { + wc_ForceZero(gcm->enc, (word32)gcm->encSz); + XFREE(gcm->enc, NULL, DYNAMIC_TYPE_TMP_BUFFER); + } +#ifdef WOLFSSL_AESGCM_STREAM + if (session->mechanism == CKM_AES_GCM && gcm->streamInit) + wc_AesFree(&gcm->aes); +#endif XMEMSET(gcm, 0, sizeof(*gcm)); if (ivSz > 0) XMEMCPY(gcm->iv, iv, ivSz); diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index 007b2733..aff52515 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -560,6 +560,72 @@ static void test_failed_operation_scrubs_state(void) } #endif +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) +/* Re-initializing AES-GCM must release, scrubbed, any data a previous GCM + * operation left buffered on the session. */ +static void test_gcm_reinit_releases_buffer(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_GCM_PARAMS gcmParams; + CK_MECHANISM gcmMech = { CKM_AES_GCM, &gcmParams, sizeof(gcmParams) }; + byte out[64]; + CK_ULONG outLen; + CK_SLOT_ID slot; + long before; + int hit; + + printf("\n--- GCM re-init releases buffered data ---\n"); + XMEMSET(&gcmParams, 0, sizeof(gcmParams)); + gcmParams.pIv = gcmIv; + gcmParams.ulIvLen = sizeof(gcmIv); + gcmParams.ulIvBits = sizeof(gcmIv) * 8; + gcmParams.ulTagBits = 128; + + rv = init_library(&slot); + CHECK_RV(rv, "initialize library", CKR_OK); + if (rv != CKR_OK) + goto out; + before = liveBlocks; + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM)", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_EncryptUpdate(session, plainMarker, sizeof(plainMarker), + out, &outLen); + CHECK_RV(rv, "C_EncryptUpdate(AES-GCM)", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Encrypt(session, gcmIv, sizeof(gcmIv), out, &outLen); + CHECK_RV(rv, "C_Encrypt(AES-GCM) ends the operation", CKR_OK); + + watch_start(plainMarker, sizeof(plainMarker)); + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + hit = watch_stop(); + CHECK_RV(rv, "C_EncryptInit(AES-GCM) again", CKR_OK); + CHECK_TRUE(!hit, "GCM re-init scrubs buffered data before release"); + + rv = funcList->C_DestroyObject(session, aesKey); + CHECK_RV(rv, "C_DestroyObject(AES)", CKR_OK); + rv = funcList->C_DestroyObject(session, macKey); + CHECK_RV(rv, "C_DestroyObject(HMAC)", CKR_OK); + funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; + CHECK_TRUE(liveBlocks == before, + "GCM re-init leaves no allocation behind"); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + static int run_test(void) { CK_RV rv; @@ -587,6 +653,9 @@ static int run_test(void) !defined(NO_SHA256) test_failed_operation_scrubs_state(); #endif +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) + test_gcm_reinit_releases_buffer(); +#endif pkcs11_unload(); return 0; From 63a63067260175483a88faeec637c20d5f497dfa Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:20:11 -0700 Subject: [PATCH 032/104] F-11506 - Free AES and HMAC contexts when key setup fails --- src/internal.c | 14 ++++++ tests/session_op_lifecycle_test.c | 71 +++++++++++++++++++++++++++++++ 2 files changed, 85 insertions(+) diff --git a/src/internal.c b/src/internal.c index ac1cd363..8c176fac 100644 --- a/src/internal.c +++ b/src/internal.c @@ -11916,6 +11916,7 @@ int WP11_Session_SetCbcParams(WP11_Session* session, unsigned char* iv, int enc, WP11_Object* object) { int ret; + int aesInit = 0; WP11_CbcParams* cbc = &session->params.cbc; WP11_Data* key; @@ -11931,6 +11932,8 @@ int WP11_Session_SetCbcParams(WP11_Session* session, unsigned char* iv, /* AES object on session. */ ret = wc_AesInit(&cbc->aes, NULL, object->devId); + if (ret == 0) + aesInit = 1; #ifdef WOLFSSL_STM32U5_DHUK if (ret == 0 && object->dhukIvLen > 0) { ret = wc_Stm32_Aes_SetDHUK_IV(&cbc->aes, object->dhukIv, @@ -11947,6 +11950,9 @@ int WP11_Session_SetCbcParams(WP11_Session* session, unsigned char* iv, WP11_Lock_UnlockRO(object->lock); } + if (ret != 0 && aesInit) + wc_AesFree(&cbc->aes); + return ret; } #endif /* HAVE_AES_CBC */ @@ -11984,6 +11990,8 @@ int WP11_Session_SetCtrParams(WP11_Session* session, CK_ULONG ulCounterBits, ret = wc_AesSetKey(&ctr->aes, key->data, key->len, cb, AES_ENCRYPTION); if (object->onToken) WP11_Lock_UnlockRO(object->lock); + if (ret != 0) + wc_AesFree(&ctr->aes); } if (ret == 0) { XMEMCPY(ctr->counter, cb, sizeof(ctr->counter)); @@ -12013,6 +12021,8 @@ int WP11_Session_SetAesWrapParams(WP11_Session* session, byte* iv, word32 ivLen, enc ? AES_ENCRYPTION : AES_DECRYPTION); if (object->onToken) WP11_Lock_UnlockRO(object->lock); + if (ret != 0) + wc_AesFree(&wrap->aes); } if (ret == 0) { if (iv != NULL) @@ -12174,6 +12184,8 @@ int WP11_Session_SetCtsParams(WP11_Session* session, unsigned char* iv, enc ? AES_ENCRYPTION : AES_DECRYPTION); if (object->onToken) WP11_Lock_UnlockRO(object->lock); + if (ret != 0) + wc_AesFree(&cts->aes); } return ret; @@ -20528,6 +20540,8 @@ int WP11_Hmac_Init(CK_MECHANISM_TYPE mechanism, WP11_Object* secret, ret = wc_HmacSetKey(&hmac->hmac, hashType, key->data, key->len); if (secret->onToken) WP11_Lock_UnlockRO(secret->lock); + if (ret != 0) + wc_HmacFree(&hmac->hmac); } return ret; diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index aff52515..2da90e5c 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -626,6 +626,74 @@ static void test_gcm_reinit_releases_buffer(void) } #endif +#if !defined(NO_AES) && defined(HAVE_AES_CBC) +/* A key that the cipher rejects during setup must not leave a half-built + * context behind, and the session must stay usable. */ +static void test_failed_key_setup_keeps_session_usable(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE oddKey = CK_INVALID_HANDLE; + byte oddValue[20]; + byte iv[16] = { 0 }; + CK_MECHANISM cbcMech = { CKM_AES_CBC, NULL, 0 }; + byte out[32]; + CK_ULONG outLen; + CK_SLOT_ID slot; +#ifdef TRACK_ALLOCS + long before = 0; +#endif + + printf("\n--- a failed key setup leaves the session usable ---\n"); + cbcMech.pParameter = iv; + cbcMech.ulParameterLen = sizeof(iv); + XMEMSET(oddValue, 0x5A, sizeof(oddValue)); + + rv = init_library(&slot); + CHECK_RV(rv, "initialize library", CKR_OK); + if (rv != CKR_OK) + goto out; +#ifdef TRACK_ALLOCS + before = liveBlocks; +#endif + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = create_secret(session, &aesType, oddValue, sizeof(oddValue), &oddKey); + if (rv != CKR_OK) { + printf("SKIP: token rejects AES keys of invalid length\n"); + } + else { + rv = funcList->C_EncryptInit(session, &cbcMech, oddKey); + CHECK_TRUE(rv != CKR_OK, "C_EncryptInit with an unusable key fails"); + rv = funcList->C_EncryptInit(session, &cbcMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-CBC) after failed setup", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Encrypt(session, iv, sizeof(iv), out, &outLen); + CHECK_RV(rv, "C_Encrypt(AES-CBC) after failed setup", CKR_OK); + funcList->C_DestroyObject(session, oddKey); + } + + funcList->C_DestroyObject(session, aesKey); + funcList->C_DestroyObject(session, macKey); + funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; +#ifdef TRACK_ALLOCS + CHECK_TRUE(liveBlocks == before, + "failed key setup leaves no allocation behind"); +#endif + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + static int run_test(void) { CK_RV rv; @@ -656,6 +724,9 @@ static int run_test(void) #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) test_gcm_reinit_releases_buffer(); #endif +#if !defined(NO_AES) && defined(HAVE_AES_CBC) + test_failed_key_setup_keeps_session_usable(); +#endif pkcs11_unload(); return 0; From a017615aaf569a32b358c29ab6ee90df619136f3 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:52:29 -0700 Subject: [PATCH 033/104] F-12480 - Drop the session reference to a destroyed AES key read at operation time --- src/internal.c | 38 +++++- tests/session_op_lifecycle_test.c | 199 ++++++++++++++++++++++++++++++ 2 files changed, 232 insertions(+), 5 deletions(-) diff --git a/src/internal.c b/src/internal.c index 8c176fac..27e6643d 100644 --- a/src/internal.c +++ b/src/internal.c @@ -11346,6 +11346,20 @@ static int wp11_init_get_op_category(int init) } } +/** + * Return whether the mechanism reads the key object each time data is + * processed rather than copying the key at initialization. + * + * @param mechanism [in] Mechanism of the operation. + * @return 1 when the key object is read during the operation. + * 0 otherwise. + */ +static int wp11_mech_reads_key(CK_MECHANISM_TYPE mechanism) +{ + return mechanism == CKM_AES_GCM || mechanism == CKM_AES_CCM || + mechanism == CKM_AES_ECB; +} + /** * Check whether the session has an active operation of the given category. * Per PKCS#11 spec, only operations of the same type block re-initialization. @@ -11361,6 +11375,9 @@ int WP11_Session_IsOpCategoryActive(WP11_Session* session, int opCategory) if (session->init == 0) return 0; + /* The key of this operation was destroyed so it can no longer run. */ + if (session->curr == NULL && wp11_mech_reads_key(session->mechanism)) + return 0; currentInit = session->init & ~WP11_INIT_DIGEST_MASK; return wp11_init_get_op_category(currentInit) == opCategory; @@ -12548,7 +12565,9 @@ void WP11_Session_RemoveObject(WP11_Session* session, WP11_Object* object) * operation context during their *Init and run to completion without referring * to the object again, so a caller may legitimately destroy the key before * finishing the operation (wolfCrypt's PKCS#11 layer does exactly this for - * multi-part HMAC). Those operations are left untouched. + * multi-part HMAC). Those operations are left untouched. AES-GCM, AES-CCM and + * AES-ECB read the key object when data is processed, so only their reference + * is dropped; the owning session releases the operation state itself. * * Asymmetric operations dereference the key object while running, so for those * key types drop the active reference in every session that holds it and reset @@ -12561,18 +12580,22 @@ void WP11_Slot_ClearActiveObject(WP11_Slot* slot, WP11_Object* object) { WP11_Session* curr; CK_KEY_TYPE keyType; + int symmetric; if (slot == NULL || object == NULL) return; keyType = WP11_Object_GetType(object); - if (keyType == CKK_AES || keyType == CKK_GENERIC_SECRET || - keyType == CKK_HKDF) - return; + symmetric = (keyType == CKK_AES || keyType == CKK_GENERIC_SECRET || + keyType == CKK_HKDF); WP11_Lock_LockRW(&slot->lock); for (curr = slot->session; curr != NULL; curr = curr->next) { - if (curr->curr == object) { + if (curr->curr == object && symmetric) { + if (wp11_mech_reads_key(curr->mechanism)) + curr->curr = NULL; + } + else if (curr->curr == object) { #if !defined(NO_RSA) && !defined(WC_NO_RSA_OAEP) /* Release the operation-owned RSA-OAEP label before dropping the * operation state. Otherwise a later init for a different mechanism @@ -12600,6 +12623,11 @@ void WP11_Slot_ClearActiveObject(WP11_Slot* slot, WP11_Object* object) */ void WP11_Session_GetObject(WP11_Session* session, WP11_Object** object) { + /* The key was destroyed: release the state its operation still holds. */ + if (session->curr == NULL && wp11_mech_reads_key(session->mechanism) && + (session->init & ~WP11_INIT_DIGEST_MASK) != 0) { + WP11_Session_AbortOp(session); + } *object = session->curr; } diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index 2da90e5c..3ed8f8b4 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -694,6 +694,197 @@ static void test_failed_key_setup_keeps_session_usable(void) } #endif +#if !defined(NO_AES) && (defined(HAVE_AESGCM) || defined(HAVE_AESECB) || \ + defined(HAVE_AESCCM)) +/* Destroying a key must end the operations that still read it, while + * operations that copied the key at Init time may finish. */ +static void test_destroyed_key_ends_dependent_operation(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE tmpKey = CK_INVALID_HANDLE; +#ifdef HAVE_AESGCM + CK_GCM_PARAMS gcmParams; + CK_MECHANISM gcmMech = { CKM_AES_GCM, &gcmParams, sizeof(gcmParams) }; +#endif +#ifdef HAVE_AESECB + CK_MECHANISM ecbMech = { CKM_AES_ECB, NULL, 0 }; +#endif +#ifdef HAVE_AESCCM + CK_CCM_PARAMS ccmParams; + CK_MECHANISM ccmMech = { CKM_AES_CCM, &ccmParams, sizeof(ccmParams) }; +#endif +#ifdef HAVE_AES_CBC + byte iv[16] = { 0 }; + CK_MECHANISM cbcMech = { CKM_AES_CBC, NULL, 0 }; +#endif + byte out[64]; + CK_ULONG outLen; + CK_SLOT_ID slot; + + printf("\n--- destroying a key ends operations that read it ---\n"); +#ifdef HAVE_AESGCM + XMEMSET(&gcmParams, 0, sizeof(gcmParams)); + gcmParams.pIv = gcmIv; + gcmParams.ulIvLen = sizeof(gcmIv); + gcmParams.ulIvBits = sizeof(gcmIv) * 8; + gcmParams.ulTagBits = 128; +#endif +#ifdef HAVE_AESCCM + XMEMSET(&ccmParams, 0, sizeof(ccmParams)); + ccmParams.ulDataLen = 16; + ccmParams.pIv = gcmIv; + ccmParams.ulIvLen = sizeof(gcmIv); + ccmParams.pAAD = gcmAad; + ccmParams.ulAADLen = sizeof(gcmAad); + ccmParams.ulMacLen = 16; +#endif +#ifdef HAVE_AES_CBC + cbcMech.pParameter = iv; + cbcMech.ulParameterLen = sizeof(iv); +#endif + + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + +#ifdef HAVE_AESGCM + rv = create_secret(session, &aesType, aesKeyValue, sizeof(aesKeyValue), + &tmpKey); + CHECK_RV(rv, "C_CreateObject(AES)", CKR_OK); + rv = funcList->C_EncryptInit(session, &gcmMech, tmpKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM)", CKR_OK); + rv = funcList->C_DestroyObject(session, tmpKey); + CHECK_RV(rv, "C_DestroyObject(active AES-GCM key)", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Encrypt(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_Encrypt(AES-GCM) after key destroyed", + CKR_OPERATION_NOT_INITIALIZED); + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM) with another key", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Encrypt(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_Encrypt(AES-GCM) with another key", CKR_OK); +#endif +#ifdef HAVE_AESCCM + rv = create_secret(session, &aesType, aesKeyValue, sizeof(aesKeyValue), + &tmpKey); + CHECK_RV(rv, "C_CreateObject(AES)", CKR_OK); + rv = funcList->C_EncryptInit(session, &ccmMech, tmpKey); + CHECK_RV(rv, "C_EncryptInit(AES-CCM)", CKR_OK); + rv = funcList->C_DestroyObject(session, tmpKey); + CHECK_RV(rv, "C_DestroyObject(active AES-CCM key)", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Encrypt(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_Encrypt(AES-CCM) after key destroyed", + CKR_OPERATION_NOT_INITIALIZED); + rv = funcList->C_EncryptInit(session, &ccmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-CCM) with another key", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Encrypt(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_Encrypt(AES-CCM) with another key", CKR_OK); +#endif +#ifdef HAVE_AESECB + rv = create_secret(session, &aesType, aesKeyValue, sizeof(aesKeyValue), + &tmpKey); + CHECK_RV(rv, "C_CreateObject(AES)", CKR_OK); + rv = funcList->C_DecryptInit(session, &ecbMech, tmpKey); + CHECK_RV(rv, "C_DecryptInit(AES-ECB)", CKR_OK); + rv = funcList->C_DestroyObject(session, tmpKey); + CHECK_RV(rv, "C_DestroyObject(active AES-ECB key)", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Decrypt(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_Decrypt(AES-ECB) after key destroyed", + CKR_OPERATION_NOT_INITIALIZED); +#endif +#ifdef HAVE_AES_CBC + rv = create_secret(session, &aesType, aesKeyValue, sizeof(aesKeyValue), + &tmpKey); + CHECK_RV(rv, "C_CreateObject(AES)", CKR_OK); + rv = funcList->C_EncryptInit(session, &cbcMech, tmpKey); + CHECK_RV(rv, "C_EncryptInit(AES-CBC)", CKR_OK); + rv = funcList->C_DestroyObject(session, tmpKey); + CHECK_RV(rv, "C_DestroyObject(active AES-CBC key)", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Encrypt(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_Encrypt(AES-CBC) with key copied at Init", CKR_OK); +#endif + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ + !defined(WOLFSSL_AESGCM_STREAM) +/* Destroying the key of a multi-part AES-GCM operation must release the + * plaintext it buffered once the operation is next used. */ +static void test_destroyed_gcm_key_releases_input(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE tmpKey = CK_INVALID_HANDLE; + CK_GCM_PARAMS gcmParams; + CK_MECHANISM gcmMech = { CKM_AES_GCM, &gcmParams, sizeof(gcmParams) }; + byte out[64]; + CK_ULONG outLen; + CK_SLOT_ID slot; + long before; + int hit; + + printf("\n--- destroying an AES-GCM key releases buffered input ---\n"); + XMEMSET(&gcmParams, 0, sizeof(gcmParams)); + gcmParams.pIv = gcmIv; + gcmParams.ulIvLen = sizeof(gcmIv); + gcmParams.ulIvBits = sizeof(gcmIv) * 8; + gcmParams.ulTagBits = 128; + + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + if (rv == CKR_OK) { + rv = create_secret(session, &aesType, aesKeyValue, sizeof(aesKeyValue), + &tmpKey); + } + if (rv == CKR_OK) + rv = funcList->C_EncryptInit(session, &gcmMech, tmpKey); + if (rv == CKR_OK) { + outLen = sizeof(out); + rv = funcList->C_EncryptUpdate(session, plainMarker, + sizeof(plainMarker), out, &outLen); + } + if (rv == CKR_OK) + rv = funcList->C_DestroyObject(session, tmpKey); + CHECK_RV(rv, "buffer AES-GCM input and destroy its key", CKR_OK); + if (rv != CKR_OK) + goto out; + + before = liveBlocks; + watch_start(plainMarker, sizeof(plainMarker)); + outLen = sizeof(out); + rv = funcList->C_EncryptFinal(session, out, &outLen); + hit = watch_stop(); + CHECK_RV(rv, "C_EncryptFinal(AES-GCM) after key destroyed", + CKR_OPERATION_NOT_INITIALIZED); + CHECK_TRUE(liveBlocks < before, "buffered AES-GCM input is released"); + CHECK_TRUE(!hit, "buffered AES-GCM input is scrubbed"); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + static int run_test(void) { CK_RV rv; @@ -727,6 +918,14 @@ static int run_test(void) #if !defined(NO_AES) && defined(HAVE_AES_CBC) test_failed_key_setup_keeps_session_usable(); #endif +#if !defined(NO_AES) && (defined(HAVE_AESGCM) || defined(HAVE_AESECB) || \ + defined(HAVE_AESCCM)) + test_destroyed_key_ends_dependent_operation(); +#endif +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ + !defined(WOLFSSL_AESGCM_STREAM) + test_destroyed_gcm_key_releases_input(); +#endif pkcs11_unload(); return 0; From 91badc4d454783eef704c03a838cd41264f9fe75 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:04:35 -0700 Subject: [PATCH 034/104] F-4071 - Scrub accumulated MAC input before growing or freeing it --- src/internal.c | 41 ++++++++----- tests/session_op_lifecycle_test.c | 98 +++++++++++++++++++++++++++++++ 2 files changed, 123 insertions(+), 16 deletions(-) diff --git a/src/internal.c b/src/internal.c index 27e6643d..0f735033 100644 --- a/src/internal.c +++ b/src/internal.c @@ -538,6 +538,7 @@ struct WP11_Session { byte* data; /* Held data for one-shot mechs */ word32 dataSz; /* Size of held data */ + word32 dataCap; /* Allocated size of held data */ int devId; WP11_Session* next; /* Next session for slot */ @@ -11387,31 +11388,36 @@ int WP11_Session_UpdateData(WP11_Session *session, byte *data, word32 dataLen) { int ret = 0; byte* tmp; + word32 cap; /* Guard the cumulative word32 sum against silent wrap that would lead to * a tiny allocation followed by an oversized XMEMCPY past it. */ if (dataLen > (word32)0xFFFFFFFFu - session->dataSz) return MEMORY_E; -#ifdef XREALLOC - tmp = (byte*)XREALLOC(session->data, session->dataSz + dataLen, NULL, - DYNAMIC_TYPE_TMP_BUFFER); - if (tmp == NULL) - ret = MEMORY_E; -#else - tmp = (byte*)XMALLOC(session->dataSz + dataLen, NULL, - DYNAMIC_TYPE_TMP_BUFFER); - if (tmp == NULL) - ret = MEMORY_E; - if (ret == 0) { - if (session->data != NULL) - XMEMCPY(tmp, session->data, session->dataSz); - XFREE(session->data, NULL, DYNAMIC_TYPE_TMP_BUFFER); + if (session->data == NULL || dataLen > session->dataCap - session->dataSz) { + /* Doubling keeps the copying linear in the total input. */ + cap = session->dataSz + dataLen; + if (session->dataCap <= (word32)0x7FFFFFFFu && + cap < session->dataCap * 2) { + cap = session->dataCap * 2; + } + /* Grow by copying so the old buffer can be scrubbed before freeing. */ + tmp = (byte*)XMALLOC(cap, NULL, DYNAMIC_TYPE_TMP_BUFFER); + if (tmp == NULL) + ret = MEMORY_E; + if (ret == 0) { + if (session->data != NULL) { + XMEMCPY(tmp, session->data, session->dataSz); + wc_ForceZero(session->data, session->dataCap); + } + XFREE(session->data, NULL, DYNAMIC_TYPE_TMP_BUFFER); + session->data = tmp; + session->dataCap = cap; + } } -#endif /* !XREALLOC */ if (ret == 0) { - session->data = tmp; XMEMCPY(session->data + session->dataSz, data, dataLen); session->dataSz += dataLen; } @@ -11427,9 +11433,12 @@ void WP11_Session_GetData(WP11_Session *session, byte** data, word32* dataLen) void WP11_Session_FreeData(WP11_Session *session) { + if (session->data != NULL) + wc_ForceZero(session->data, session->dataCap); XFREE(session->data, NULL, DYNAMIC_TYPE_TMP_BUFFER); session->data = NULL; session->dataSz = 0; + session->dataCap = 0; session->init = 0; } diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index 3ed8f8b4..cb269bd5 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -98,6 +98,7 @@ static byte plainMarker[32] = { #define ALLOC_HDR_SZ 16 static long liveBlocks = 0; +static long allocCount = 0; static const byte* watchData = NULL; static size_t watchLen = 0; static int watchHit = 0; @@ -126,6 +127,7 @@ static void* track_malloc(size_t sz) XMEMSET(p, 0, sz + ALLOC_HDR_SZ); XMEMCPY(p, &sz, sizeof(sz)); liveBlocks++; + allocCount++; return p + ALLOC_HDR_SZ; } @@ -822,6 +824,98 @@ static void test_destroyed_key_ends_dependent_operation(void) } #endif +#if defined(TRACK_ALLOCS) && defined(WOLFSSL_HAVE_PRF) && !defined(NO_SHA256) +static CK_RV tls_mac_sign_init(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE key) +{ + CK_TLS_MAC_PARAMS params; + CK_MECHANISM mech = { CKM_TLS_MAC, ¶ms, sizeof(params) }; + + params.prfHashMechanism = CKM_SHA256; + params.ulMacLength = 12; + params.ulServerOrClient = 1; + return funcList->C_SignInit(session, &mech, key); +} + +/* Input accumulated for a one-shot MAC must be scrubbed whenever its buffer + * is grown or released. */ +static void test_mac_input_scrubbed_on_release(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + byte sig[64]; + CK_ULONG sigLen; + CK_SLOT_ID slot; + int hit; + + printf("\n--- accumulated MAC input is scrubbed ---\n"); + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = tls_mac_sign_init(session, macKey); + CHECK_RV(rv, "C_SignInit(TLS MAC)", CKR_OK); + rv = funcList->C_SignUpdate(session, plainMarker, sizeof(plainMarker)); + CHECK_RV(rv, "C_SignUpdate(TLS MAC)", CKR_OK); + watch_start(plainMarker, sizeof(plainMarker)); + rv = funcList->C_SignUpdate(session, plainMarker, sizeof(plainMarker)); + CHECK_RV(rv, "C_SignUpdate(TLS MAC) again", CKR_OK); + sigLen = sizeof(sig); + rv = funcList->C_SignFinal(session, sig, &sigLen); + hit = watch_stop(); + CHECK_RV(rv, "C_SignFinal(TLS MAC)", CKR_OK); + CHECK_TRUE(!hit, "MAC input is scrubbed when its buffer is released"); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} + +#define MAC_SMALL_PARTS 1024 + +/* Many one-byte MAC parts must not reallocate the buffered input each time. */ +static void test_mac_input_grows_linearly(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + byte part = 0x5a; + CK_SLOT_ID slot; + long allocs; + int i; + + printf("\n--- many small MAC parts grow the input buffer linearly ---\n"); + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = tls_mac_sign_init(session, macKey); + CHECK_RV(rv, "C_SignInit(TLS MAC)", CKR_OK); + allocs = allocCount; + for (i = 0; rv == CKR_OK && i < MAC_SMALL_PARTS; i++) + rv = funcList->C_SignUpdate(session, &part, 1); + allocs = allocCount - allocs; + CHECK_RV(rv, "one-byte C_SignUpdate(TLS MAC) parts", CKR_OK); + if (allocs > 64) + fprintf(stderr, " %ld allocations for %d parts\n", allocs, i); + CHECK_TRUE(allocs <= 64, "buffered MAC input is not reallocated per part"); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(WOLFSSL_AESGCM_STREAM) /* Destroying the key of a multi-part AES-GCM operation must release the @@ -926,6 +1020,10 @@ static int run_test(void) !defined(WOLFSSL_AESGCM_STREAM) test_destroyed_gcm_key_releases_input(); #endif +#if defined(TRACK_ALLOCS) && defined(WOLFSSL_HAVE_PRF) && !defined(NO_SHA256) + test_mac_input_scrubbed_on_release(); + test_mac_input_grows_linearly(); +#endif pkcs11_unload(); return 0; From e52a716bde37bd0916a1debc798cdbd59736cbcd Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:12:12 -0700 Subject: [PATCH 035/104] F-8660 - Release accumulated MAC input when the session operation ends --- src/internal.c | 1 + tests/session_op_lifecycle_test.c | 45 +++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/src/internal.c b/src/internal.c index 0f735033..10912bfc 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1113,6 +1113,7 @@ static void wp11_Session_FreeOp(WP11_Session* session) session->params.digest.hashType); session->init &= ~WP11_INIT_DIGEST_MASK; } + WP11_Session_FreeData(session); /* Older wolfSSL versions do not zeroize the key schedule in wc_AesFree. */ wc_ForceZero(&session->params, sizeof(session->params)); /* Ensure no stale bits remain after all cleanup. */ diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index cb269bd5..e1669dac 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -916,6 +916,50 @@ static void test_mac_input_grows_linearly(void) } #endif +#if defined(TRACK_ALLOCS) && defined(WOLFSSL_HAVE_PRF) && !defined(NO_SHA256) +/* Closing a session in the middle of a one-shot MAC must release, scrubbed, + * the input accumulated so far. */ +static void test_mac_input_released_on_close(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_SLOT_ID slot; + long before; + int hit; + + printf("\n--- closing a session releases accumulated MAC input ---\n"); + rv = init_library(&slot); + CHECK_RV(rv, "initialize library", CKR_OK); + if (rv != CKR_OK) + goto out; + before = liveBlocks; + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = tls_mac_sign_init(session, macKey); + CHECK_RV(rv, "C_SignInit(TLS MAC)", CKR_OK); + rv = funcList->C_SignUpdate(session, plainMarker, sizeof(plainMarker)); + CHECK_RV(rv, "C_SignUpdate(TLS MAC)", CKR_OK); + + watch_start(plainMarker, sizeof(plainMarker)); + funcList->C_CloseSession(session); + hit = watch_stop(); + session = CK_INVALID_HANDLE; + CHECK_TRUE(!hit, "closed session scrubs accumulated MAC input"); + CHECK_TRUE(liveBlocks == before, + "closed session leaves no allocation behind"); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(WOLFSSL_AESGCM_STREAM) /* Destroying the key of a multi-part AES-GCM operation must release the @@ -1023,6 +1067,7 @@ static int run_test(void) #if defined(TRACK_ALLOCS) && defined(WOLFSSL_HAVE_PRF) && !defined(NO_SHA256) test_mac_input_scrubbed_on_release(); test_mac_input_grows_linearly(); + test_mac_input_released_on_close(); #endif pkcs11_unload(); From fbb7c6ab0007b8c7ec252a8bf2f17178e7589820 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:20:46 -0700 Subject: [PATCH 036/104] F-8641 - Require an active digest before saving operation state --- src/internal.c | 7 +++- tests/session_op_lifecycle_test.c | 61 +++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 2 deletions(-) diff --git a/src/internal.c b/src/internal.c index 10912bfc..d1365384 100644 --- a/src/internal.c +++ b/src/internal.c @@ -20880,7 +20880,10 @@ int WP11_GetOperationState(WP11_Session* session, unsigned char* stateData, wc_Hashes* hashAlg; #endif - *stateDataLen = sizeof(session->mechanism); + if (session->init == 0) + return CKR_OPERATION_NOT_INITIALIZED; + if (!WP11_Session_IsOpInitialized(session, WP11_INIT_DIGEST)) + return CKR_STATE_UNSAVEABLE; switch (session->mechanism) { #ifndef NO_MD5 @@ -20916,7 +20919,7 @@ int WP11_GetOperationState(WP11_Session* session, unsigned char* stateData, default: return CKR_STATE_UNSAVEABLE; } - *stateDataLen += mechSize; + *stateDataLen = sizeof(session->mechanism) + mechSize; if (stateData == NULL) return CKR_OK; diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index e1669dac..a88c19ec 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -264,10 +264,14 @@ static CK_RV open_with_keys(CK_SLOT_ID slot, CK_SESSION_HANDLE* session, rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, session); +#ifndef NO_AES if (rv == CKR_OK) { rv = create_secret(*session, &aesType, aesKeyValue, sizeof(aesKeyValue), aesKey); } +#else + (void)aesKey; +#endif if (rv == CKR_OK) { rv = create_secret(*session, &genericType, macKeyValue, sizeof(macKeyValue), macKey); @@ -960,6 +964,60 @@ static void test_mac_input_released_on_close(void) } #endif +#ifndef NO_SHA256 +/* Operation state is only available while a digest is in progress, and a + * refused request leaves the caller's length untouched. */ +static void test_operation_state_requires_active_digest(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_MECHANISM sha256Mech = { CKM_SHA256, NULL, 0 }; +#ifndef NO_HMAC + CK_MECHANISM hmacMech = { CKM_SHA256_HMAC, NULL, 0 }; +#endif + byte digest[32]; + CK_ULONG digestLen; + CK_ULONG stateLen; + CK_SLOT_ID slot; + + printf("\n--- operation state needs an active digest ---\n"); + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_DigestInit(session, &sha256Mech); + CHECK_RV(rv, "C_DigestInit(SHA-256)", CKR_OK); + digestLen = sizeof(digest); + rv = funcList->C_Digest(session, plainMarker, sizeof(plainMarker), digest, + &digestLen); + CHECK_RV(rv, "C_Digest completes the operation", CKR_OK); + stateLen = 0; + rv = funcList->C_GetOperationState(session, NULL, &stateLen); + CHECK_RV(rv, "C_GetOperationState after digest completed", + CKR_OPERATION_NOT_INITIALIZED); + +#ifndef NO_HMAC + rv = funcList->C_SignInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_SignInit(HMAC)", CKR_OK); + stateLen = 1234; + rv = funcList->C_GetOperationState(session, NULL, &stateLen); + CHECK_RV(rv, "C_GetOperationState during HMAC", CKR_STATE_UNSAVEABLE); + CHECK_TRUE(stateLen == 1234, + "refused C_GetOperationState leaves the length untouched"); +#endif + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(WOLFSSL_AESGCM_STREAM) /* Destroying the key of a multi-part AES-GCM operation must release the @@ -1069,6 +1127,9 @@ static int run_test(void) test_mac_input_grows_linearly(); test_mac_input_released_on_close(); #endif +#ifndef NO_SHA256 + test_operation_state_requires_active_digest(); +#endif pkcs11_unload(); return 0; From 59d913bf0968a5836103b5d3131eaa4b9111c2b1 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:36:53 -0700 Subject: [PATCH 037/104] F-5871 - Release the active operation before restoring saved state --- src/internal.c | 1 + tests/session_op_lifecycle_test.c | 77 +++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) diff --git a/src/internal.c b/src/internal.c index d1365384..8eee81fc 100644 --- a/src/internal.c +++ b/src/internal.c @@ -20988,6 +20988,7 @@ int WP11_SetOperationState(WP11_Session* session, unsigned char* stateData, if (stateDataLen < sizeof(session->mechanism)) return CKR_SAVED_STATE_INVALID; + WP11_Session_AbortOp(session); XMEMCPY(&session->mechanism, stateData, sizeof(session->mechanism)); switch (session->mechanism) { #ifndef NO_MD5 diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index a88c19ec..e584eae5 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -1018,6 +1018,79 @@ static void test_operation_state_requires_active_digest(void) } #endif +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ + !defined(NO_SHA256) +/* Restoring a saved digest state must release the operation it replaces. */ +static void test_restored_state_releases_operation(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_MECHANISM sha256Mech = { CKM_SHA256, NULL, 0 }; + CK_GCM_PARAMS gcmParams; + CK_MECHANISM gcmMech = { CKM_AES_GCM, &gcmParams, sizeof(gcmParams) }; + byte state[1024]; + CK_ULONG stateLen; + byte digest[32]; + CK_ULONG digestLen; + CK_SLOT_ID slot; + long before; + + printf("\n--- restoring a saved state releases the replaced op ---\n"); + XMEMSET(&gcmParams, 0, sizeof(gcmParams)); + gcmParams.pIv = gcmIv; + gcmParams.ulIvLen = sizeof(gcmIv); + gcmParams.ulIvBits = sizeof(gcmIv) * 8; + gcmParams.pAAD = gcmAad; + gcmParams.ulAADLen = sizeof(gcmAad); + gcmParams.ulTagBits = 128; + + rv = init_library(&slot); + CHECK_RV(rv, "initialize library", CKR_OK); + if (rv != CKR_OK) + goto out; + before = liveBlocks; + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_DigestInit(session, &sha256Mech); + CHECK_RV(rv, "C_DigestInit(SHA-256)", CKR_OK); + rv = funcList->C_DigestUpdate(session, plainMarker, sizeof(plainMarker)); + CHECK_RV(rv, "C_DigestUpdate", CKR_OK); + stateLen = sizeof(state); + rv = funcList->C_GetOperationState(session, state, &stateLen); + CHECK_RV(rv, "C_GetOperationState", CKR_OK); + digestLen = sizeof(digest); + rv = funcList->C_DigestFinal(session, digest, &digestLen); + CHECK_RV(rv, "C_DigestFinal", CKR_OK); + + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM with AAD)", CKR_OK); + rv = funcList->C_SetOperationState(session, state, stateLen, 0, 0); + CHECK_RV(rv, "C_SetOperationState over active encrypt", CKR_OK); + digestLen = sizeof(digest); + rv = funcList->C_DigestFinal(session, digest, &digestLen); + CHECK_RV(rv, "C_DigestFinal of restored state", CKR_OK); + + rv = funcList->C_DestroyObject(session, aesKey); + CHECK_RV(rv, "C_DestroyObject(AES)", CKR_OK); + rv = funcList->C_DestroyObject(session, macKey); + CHECK_RV(rv, "C_DestroyObject(HMAC)", CKR_OK); + funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; + CHECK_TRUE(liveBlocks == before, + "restored state leaves no allocation behind"); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(WOLFSSL_AESGCM_STREAM) /* Destroying the key of a multi-part AES-GCM operation must release the @@ -1130,6 +1203,10 @@ static int run_test(void) #ifndef NO_SHA256 test_operation_state_requires_active_digest(); #endif +#if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ + !defined(NO_SHA256) + test_restored_state_releases_operation(); +#endif pkcs11_unload(); return 0; From d85d878165b5791d72676a97cde1ed7945737996 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:44:36 -0700 Subject: [PATCH 038/104] F-11510 - Validate saved operation state before changing the session --- src/internal.c | 18 +++++---- tests/session_op_lifecycle_test.c | 64 +++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+), 7 deletions(-) diff --git a/src/internal.c b/src/internal.c index 8eee81fc..c2cb445c 100644 --- a/src/internal.c +++ b/src/internal.c @@ -20979,18 +20979,18 @@ int WP11_SetOperationState(WP11_Session* session, unsigned char* stateData, unsigned long mechSize = 0; int hashType = WC_HASH_TYPE_NONE; int ret; + CK_MECHANISM_TYPE mechanism; #if defined(LIBWOLFSSL_VERSION_HEX) && LIBWOLFSSL_VERSION_HEX < 0x05007004 wc_HashAlg* hashAlg; #else wc_Hashes* hashAlg; #endif - if (stateDataLen < sizeof(session->mechanism)) + if (stateDataLen < sizeof(mechanism)) return CKR_SAVED_STATE_INVALID; - WP11_Session_AbortOp(session); - XMEMCPY(&session->mechanism, stateData, sizeof(session->mechanism)); - switch (session->mechanism) { + XMEMCPY(&mechanism, stateData, sizeof(mechanism)); + switch (mechanism) { #ifndef NO_MD5 case CKM_MD5: mechSize = sizeof(wc_Md5); @@ -21025,16 +21025,20 @@ int WP11_SetOperationState(WP11_Session* session, unsigned char* stateData, return CKR_SAVED_STATE_INVALID; } - if (stateDataLen < (sizeof(session->mechanism) + mechSize)) + if (stateDataLen < (sizeof(mechanism) + mechSize)) return CKR_SAVED_STATE_INVALID; - stateData += sizeof(session->mechanism); + stateData += sizeof(mechanism); - ret = wp11_digest_hash_type(session->mechanism, &hashType); + ret = wp11_digest_hash_type(mechanism, &hashType); if (ret != CKR_OK) return ret; + /* The saved state is valid: replace the current operation. */ + WP11_Session_AbortOp(session); + session->mechanism = mechanism; + session->params.digest.hashType = (enum wc_HashType)hashType; ret = wc_HashInit(&session->params.digest.hash, (enum wc_HashType)hashType); diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index e584eae5..93980053 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -1091,6 +1091,69 @@ static void test_restored_state_releases_operation(void) } #endif +#ifndef NO_SHA256 +/* A saved state that is rejected must leave the session's digest exactly as + * it was. */ +static void test_rejected_state_keeps_session(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_MECHANISM sha256Mech = { CKM_SHA256, NULL, 0 }; + CK_MECHANISM_TYPE badMech; + byte state[1024]; + byte bogus[1024]; + byte after[1024]; + CK_ULONG stateLen; + CK_ULONG afterLen; + CK_SLOT_ID slot; + + printf("\n--- a rejected saved state keeps the session state ---\n"); + rv = init_library(&slot); + if (rv == CKR_OK) { + rv = funcList->C_OpenSession(slot, + CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &session); + } + CHECK_RV(rv, "open session", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_DigestInit(session, &sha256Mech); + CHECK_RV(rv, "C_DigestInit(SHA-256)", CKR_OK); + rv = funcList->C_DigestUpdate(session, plainMarker, sizeof(plainMarker)); + CHECK_RV(rv, "C_DigestUpdate", CKR_OK); + stateLen = sizeof(state); + rv = funcList->C_GetOperationState(session, state, &stateLen); + CHECK_RV(rv, "C_GetOperationState", CKR_OK); + if (rv != CKR_OK) + goto out; + + XMEMCPY(bogus, state, stateLen); + badMech = CKM_AES_CBC; + XMEMCPY(bogus, &badMech, sizeof(badMech)); + rv = funcList->C_SetOperationState(session, bogus, stateLen, 0, 0); + CHECK_RV(rv, "C_SetOperationState(unsupported mechanism)", + CKR_SAVED_STATE_INVALID); + badMech = CKM_SHA256; + XMEMCPY(bogus, &badMech, sizeof(badMech)); + rv = funcList->C_SetOperationState(session, bogus, sizeof(badMech) + 4, 0, + 0); + CHECK_RV(rv, "C_SetOperationState(truncated state)", + CKR_SAVED_STATE_INVALID); + + afterLen = sizeof(after); + rv = funcList->C_GetOperationState(session, after, &afterLen); + CHECK_RV(rv, "C_GetOperationState after rejected states", CKR_OK); + CHECK_TRUE(rv == CKR_OK && afterLen == stateLen && + XMEMCMP(after, state, stateLen) == 0, + "rejected saved state leaves the digest state unchanged"); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(WOLFSSL_AESGCM_STREAM) /* Destroying the key of a multi-part AES-GCM operation must release the @@ -1202,6 +1265,7 @@ static int run_test(void) #endif #ifndef NO_SHA256 test_operation_state_requires_active_digest(); + test_rejected_state_keeps_session(); #endif #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(NO_SHA256) From 0af972a9e931a352d5ff985176644338e7301c19 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:51:03 -0700 Subject: [PATCH 039/104] F-5870 - Reject key handles when restoring a keyless operation state --- src/slot.c | 9 ++++-- tests/session_op_lifecycle_test.c | 49 +++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 2 deletions(-) diff --git a/src/slot.c b/src/slot.c index 8c9aa1ce..c0942db8 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1842,8 +1842,13 @@ CK_RV C_SetOperationState(CK_SESSION_HANDLE hSession, return rv; } - (void)hEncryptionKey; - (void)hAuthenticationKey; + /* Only keyless digest states can be saved, so no key is ever needed. */ + if (hEncryptionKey != CK_INVALID_HANDLE || + hAuthenticationKey != CK_INVALID_HANDLE) { + rv = CKR_KEY_NOT_NEEDED; + WOLFPKCS11_LEAVE("C_SetOperationState", rv); + return rv; + } rv = WP11_SetOperationState(session, pOperationState, ulOperationStateLen); WOLFPKCS11_LEAVE("C_SetOperationState", rv); diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index 93980053..9446ddb7 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -1154,6 +1154,54 @@ static void test_rejected_state_keeps_session(void) } #endif +#ifndef NO_SHA256 +/* Saved digest states need no key, so restoring one with a key handle is + * refused. */ +static void test_restore_with_key_is_refused(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_MECHANISM sha256Mech = { CKM_SHA256, NULL, 0 }; + byte state[1024]; + CK_ULONG stateLen; + CK_SLOT_ID slot; + + printf("\n--- restoring a digest state with a key is refused ---\n"); + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_DigestInit(session, &sha256Mech); + CHECK_RV(rv, "C_DigestInit(SHA-256)", CKR_OK); + rv = funcList->C_DigestUpdate(session, plainMarker, sizeof(plainMarker)); + CHECK_RV(rv, "C_DigestUpdate", CKR_OK); + stateLen = sizeof(state); + rv = funcList->C_GetOperationState(session, state, &stateLen); + CHECK_RV(rv, "C_GetOperationState", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_SetOperationState(session, state, stateLen, macKey, 0); + CHECK_RV(rv, "C_SetOperationState with encryption key", + CKR_KEY_NOT_NEEDED); + rv = funcList->C_SetOperationState(session, state, stateLen, 0, macKey); + CHECK_RV(rv, "C_SetOperationState with authentication key", + CKR_KEY_NOT_NEEDED); + rv = funcList->C_SetOperationState(session, state, stateLen, 0, 0); + CHECK_RV(rv, "C_SetOperationState without keys", CKR_OK); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(WOLFSSL_AESGCM_STREAM) /* Destroying the key of a multi-part AES-GCM operation must release the @@ -1266,6 +1314,7 @@ static int run_test(void) #ifndef NO_SHA256 test_operation_state_requires_active_digest(); test_rejected_state_keeps_session(); + test_restore_with_key_is_refused(); #endif #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(NO_SHA256) From 3bfe45789f09103fa739882168d6a3ac0faacbe7 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 15:33:39 -0700 Subject: [PATCH 040/104] F-10394 - Cancel the active operation when Init is called with a NULL mechanism --- src/crypto.c | 77 +++++++++-- src/internal.c | 27 +++- tests/pkcs11mtt.c | 24 ++++ tests/pkcs11test.c | 24 ++++ tests/session_op_lifecycle_test.c | 220 +++++++++++++++++++++++++++++- wolfpkcs11/internal.h | 2 + wolfpkcs11/pkcs11.h | 1 + 7 files changed, 360 insertions(+), 15 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 5f628d3b..47ae7f69 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -2452,6 +2452,35 @@ CK_RV C_FindObjectsFinal(CK_SESSION_HANDLE hSession) } +#ifdef WOLFPKCS11_PKCS11_V3_0 +/** + * Terminate the active operation of a kind, as requested by calling an Init + * function with a NULL mechanism. + * + * @param session [in] Session object. + * @param opCategory [in] Operation category (WP11_OP_*). + * @param recover [in] Whether the kind is verification with recovery. + * @return CKR_OK as releasing an operation cannot fail. + */ +static CK_RV CancelOperation(WP11_Session* session, int opCategory, + int recover) +{ + int recoverActive; + + recoverActive = WP11_Session_IsOpInitialized(session, + WP11_INIT_RSA_PKCS_VERIFY_RECOVER) || + WP11_Session_IsOpInitialized(session, + WP11_INIT_RSA_X_509_VERIFY_RECOVER); + /* Not IsOpCategoryActive: an op whose key was destroyed still holds + * state that must be released. */ + if (WP11_Session_IsOpCategoryInit(session, opCategory) && + recoverActive == recover) { + WP11_Session_AbortOp(session); + } + return CKR_OK; +} +#endif + static CK_RV EncryptInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey, byte skipOpCheck) @@ -2481,7 +2510,11 @@ static CK_RV EncryptInit(CK_SESSION_HANDLE hSession, return rv; } if (pMechanism == NULL) { +#ifdef WOLFPKCS11_PKCS11_V3_0 + rv = CancelOperation(session, WP11_OP_ENCRYPT, 0); +#else rv = CKR_ARGUMENTS_BAD; +#endif WOLFPKCS11_LEAVE("C_EncryptInit", rv); return rv; } @@ -2736,7 +2769,8 @@ static CK_RV EncryptInit(CK_SESSION_HANDLE hSession, * @param hKey [in] Handle to key object. * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SESSION_HANDLE_INVALID when session handle is not valid. - * CKR_ARGUMENTS_BAD when pMechanism is NULL. + * CKR_ARGUMENTS_BAD when pMechanism is NULL; PKCS#11 v3.0 builds + * instead cancel the active operation and return CKR_OK. * CKR_OBJECT_HANDLE_INVALID when key object handle is not valid. * CKR_KEY_TYPE_INCONSISTENT when the key type is not valid for the * mechanism (operation). @@ -3581,8 +3615,13 @@ static CK_RV DecryptInit(CK_SESSION_HANDLE hSession, } if (WP11_Session_Get(hSession, &session) != 0) return CKR_SESSION_HANDLE_INVALID; - if (pMechanism == NULL) + if (pMechanism == NULL) { +#ifdef WOLFPKCS11_PKCS11_V3_0 + return CancelOperation(session, WP11_OP_DECRYPT, 0); +#else return CKR_ARGUMENTS_BAD; +#endif + } ret = WP11_Object_Find(session, hKey, &obj); if (ret != 0) @@ -3823,7 +3862,8 @@ static CK_RV DecryptInit(CK_SESSION_HANDLE hSession, * @param hKey [in] Handle to key object. * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SESSION_HANDLE_INVALID when session handle is not valid. - * CKR_ARGUMENTS_BAD when pMechanism is NULL. + * CKR_ARGUMENTS_BAD when pMechanism is NULL; PKCS#11 v3.0 builds + * instead cancel the active operation and return CKR_OK. * CKR_OBJECT_HANDLE_INVALID when key object handle is not valid. * CKR_KEY_TYPE_INCONSISTENT when the key type is not valid for the * mechanism (operation). @@ -4674,7 +4714,8 @@ CK_RV C_DecryptFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pLastPart, * @param pMechanism [in] Type of operation to perform with parameters. * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SESSION_HANDLE_INVALID when session handle is not valid. - * CKR_ARGUMENTS_BAD when pMechanism is NULL. + * CKR_ARGUMENTS_BAD when pMechanism is NULL; PKCS#11 v3.0 builds + * instead cancel the active operation and return CKR_OK. * CKR_MECHANISM_INVALID when the mechanism is not supported with this * type of operation. */ @@ -4704,7 +4745,11 @@ CK_RV C_DigestInit(CK_SESSION_HANDLE hSession, return rv; } if (pMechanism == NULL) { +#ifdef WOLFPKCS11_PKCS11_V3_0 + rv = CancelOperation(session, WP11_OP_DIGEST, 0); +#else rv = CKR_ARGUMENTS_BAD; +#endif WOLFPKCS11_LEAVE("C_DigestInit", rv); return rv; } @@ -5103,7 +5148,8 @@ static int GetInitValue(CK_MECHANISM_TYPE mechanism) { * @param hKey [in] Handle to key object. * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SESSION_HANDLE_INVALID when session handle is not valid. - * CKR_ARGUMENTS_BAD when pMechanism is NULL. + * CKR_ARGUMENTS_BAD when pMechanism is NULL; PKCS#11 v3.0 builds + * instead cancel the active operation and return CKR_OK. * CKR_OBJECT_HANDLE_INVALID when key object handle is not valid. * CKR_KEY_TYPE_INCONSISTENT when the key type is not valid for the * mechanism (operation). @@ -5138,8 +5184,13 @@ static CK_RV wp11_C_SignInit(CK_SESSION_HANDLE hSession, } if (WP11_Session_Get(hSession, &session) != 0) return CKR_SESSION_HANDLE_INVALID; - if (pMechanism == NULL) + if (pMechanism == NULL) { +#ifdef WOLFPKCS11_PKCS11_V3_0 + return CancelOperation(session, WP11_OP_SIGN, 0); +#else return CKR_ARGUMENTS_BAD; +#endif + } ret = WP11_Object_Find(session, hKey, &obj); #ifdef WOLFSSL_MAXQ10XX_CRYPTO @@ -6282,7 +6333,8 @@ CK_RV C_SignRecover(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, * @param hKey [in] Handle to key object. * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SESSION_HANDLE_INVALID when session handle is not valid. - * CKR_ARGUMENTS_BAD when pMechanism is NULL. + * CKR_ARGUMENTS_BAD when pMechanism is NULL; PKCS#11 v3.0 builds + * instead cancel the active operation and return CKR_OK. * CKR_OBJECT_HANDLE_INVALID when key object handle is not valid. * CKR_KEY_TYPE_INCONSISTENT when the key type is not valid for the * mechanism (operation). @@ -6322,7 +6374,11 @@ static CK_RV wp11_C_VerifyInit(CK_SESSION_HANDLE hSession, return rv; } if (pMechanism == NULL) { +#ifdef WOLFPKCS11_PKCS11_V3_0 + rv = CancelOperation(session, WP11_OP_VERIFY, 0); +#else rv = CKR_ARGUMENTS_BAD; +#endif WOLFPKCS11_LEAVE("C_VerifyInit", rv); return rv; } @@ -7248,7 +7304,8 @@ CK_RV C_VerifyFinal(CK_SESSION_HANDLE hSession, * @param hKey [in] Handle to key object. * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SESSION_HANDLE_INVALID when session handle is not valid. - * CKR_ARGUMENTS_BAD when pMechanism is NULL. + * CKR_ARGUMENTS_BAD when pMechanism is NULL; PKCS#11 v3.0 builds + * instead cancel the active operation and return CKR_OK. * CKR_OBJECT_HANDLE_INVALID when key object handle is not valid. * CKR_MECHANISM_INVALID when the mechanism is not supported with this * type of operation. @@ -7281,7 +7338,11 @@ static CK_RV wp11_C_VerifyRecoverInit(CK_SESSION_HANDLE hSession, return rv; } if (pMechanism == NULL) { +#ifdef WOLFPKCS11_PKCS11_V3_0 + rv = CancelOperation(session, WP11_OP_VERIFY, 1); +#else rv = CKR_ARGUMENTS_BAD; +#endif WOLFPKCS11_LEAVE("C_VerifyRecoverInit", rv); return rv; } diff --git a/src/internal.c b/src/internal.c index c2cb445c..091306ba 100644 --- a/src/internal.c +++ b/src/internal.c @@ -11363,26 +11363,41 @@ static int wp11_mech_reads_key(CK_MECHANISM_TYPE mechanism) } /** - * Check whether the session has an active operation of the given category. - * Per PKCS#11 spec, only operations of the same type block re-initialization. + * Check whether the session holds operation state of the given category, even + * when the key the operation reads was destroyed. * * @param session [in] Session object. * @param opCategory [in] Operation category (WP11_OP_*). - * @return 1 when an operation of the same category is active. + * @return 1 when an operation of the category is initialized. * 0 otherwise. */ -int WP11_Session_IsOpCategoryActive(WP11_Session* session, int opCategory) +int WP11_Session_IsOpCategoryInit(WP11_Session* session, int opCategory) { int currentInit; if (session->init == 0) return 0; + + currentInit = session->init & ~WP11_INIT_DIGEST_MASK; + return wp11_init_get_op_category(currentInit) == opCategory; +} + +/** + * Check whether the session has an active operation of the given category. + * Per PKCS#11 spec, only operations of the same type block re-initialization. + * + * @param session [in] Session object. + * @param opCategory [in] Operation category (WP11_OP_*). + * @return 1 when an operation of the same category is active. + * 0 otherwise. + */ +int WP11_Session_IsOpCategoryActive(WP11_Session* session, int opCategory) +{ /* The key of this operation was destroyed so it can no longer run. */ if (session->curr == NULL && wp11_mech_reads_key(session->mechanism)) return 0; - currentInit = session->init & ~WP11_INIT_DIGEST_MASK; - return wp11_init_get_op_category(currentInit) == opCategory; + return WP11_Session_IsOpCategoryInit(session, opCategory); } int WP11_Session_UpdateData(WP11_Session *session, byte *data, word32 dataLen) diff --git a/tests/pkcs11mtt.c b/tests/pkcs11mtt.c index c82c9d00..609a85b0 100644 --- a/tests/pkcs11mtt.c +++ b/tests/pkcs11mtt.c @@ -1054,8 +1054,12 @@ static CK_RV test_encrypt_decrypt(void* args) } if (ret == CKR_OK) { ret = funcList->C_EncryptInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "AES-CBC Encrypt Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "AES-CBC Encrypt Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_EncryptInit(session, &mech, CK_INVALID_HANDLE); @@ -1124,8 +1128,12 @@ static CK_RV test_encrypt_decrypt(void* args) } if (ret == CKR_OK) { ret = funcList->C_DecryptInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "AES-CBC Decrypt Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "AES-CBC Decrypt Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_DecryptInit(session, &mech, CK_INVALID_HANDLE); @@ -1231,7 +1239,11 @@ static CK_RV test_digest(void* args) } if (ret == CKR_OK) { ret = funcList->C_DigestInit(session, NULL); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "Digest Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "Digest Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_Digest(CK_INVALID_HANDLE, data, dataSz, hash, @@ -1331,7 +1343,11 @@ static CK_RV test_sign_verify(void* args) } if (ret == CKR_OK) { ret = funcList->C_SignInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "HMAC Sign Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "HMAC Sign Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_SignInit(session, &mech, CK_INVALID_HANDLE); @@ -1397,7 +1413,11 @@ static CK_RV test_sign_verify(void* args) } if (ret == CKR_OK) { ret = funcList->C_VerifyInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "HMAC Verify Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "HMAC Verify Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_VerifyInit(session, &mech, CK_INVALID_HANDLE); @@ -1534,8 +1554,12 @@ static CK_RV test_recover(void* args) } if (ret == CKR_OK) { ret = funcList->C_VerifyRecoverInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "Verify Recover Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "Verify Recover Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_VerifyRecoverInit(session, &mech, CK_INVALID_HANDLE); diff --git a/tests/pkcs11test.c b/tests/pkcs11test.c index dce1bb21..eb4f800a 100644 --- a/tests/pkcs11test.c +++ b/tests/pkcs11test.c @@ -4838,8 +4838,12 @@ static CK_RV test_encrypt_decrypt(void* args) } if (ret == CKR_OK) { ret = funcList->C_EncryptInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "AES-CBC Encrypt Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "AES-CBC Encrypt Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_EncryptInit(session, &mech, CK_INVALID_HANDLE); @@ -4908,8 +4912,12 @@ static CK_RV test_encrypt_decrypt(void* args) } if (ret == CKR_OK) { ret = funcList->C_DecryptInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "AES-CBC Decrypt Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "AES-CBC Decrypt Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_DecryptInit(session, &mech, CK_INVALID_HANDLE); @@ -5382,7 +5390,11 @@ static CK_RV test_digest_fail(void* args) } if (ret == CKR_OK) { ret = funcList->C_DigestInit(session, NULL); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "Digest Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "Digest Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_Digest(CK_INVALID_HANDLE, data, dataSz, hash, @@ -5522,7 +5534,11 @@ static CK_RV test_sign_verify(void* args) } if (ret == CKR_OK) { ret = funcList->C_SignInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "HMAC Sign Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "HMAC Sign Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_SignInit(session, &mech, CK_INVALID_HANDLE); @@ -5588,7 +5604,11 @@ static CK_RV test_sign_verify(void* args) } if (ret == CKR_OK) { ret = funcList->C_VerifyInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "HMAC Verify Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "HMAC Verify Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_VerifyInit(session, &mech, CK_INVALID_HANDLE); @@ -5781,8 +5801,12 @@ static CK_RV test_recover(void* args) } if (ret == CKR_OK) { ret = funcList->C_VerifyRecoverInit(session, NULL, key); +#ifdef WOLFPKCS11_PKCS11_V3_0 + CHECK_CKR(ret, "Verify Recover Init no mechanism cancels"); +#else CHECK_CKR_FAIL(ret, CKR_ARGUMENTS_BAD, "Verify Recover Init no mechanism"); +#endif } if (ret == CKR_OK) { ret = funcList->C_VerifyRecoverInit(session, &mech, CK_INVALID_HANDLE); diff --git a/tests/session_op_lifecycle_test.c b/tests/session_op_lifecycle_test.c index 9446ddb7..80571e58 100644 --- a/tests/session_op_lifecycle_test.c +++ b/tests/session_op_lifecycle_test.c @@ -200,7 +200,7 @@ static CK_RV create_secret(CK_SESSION_HANDLE session, CK_KEY_TYPE* type, sizeof(tmpl) / sizeof(*tmpl), key); } -#if !defined(NO_RSA) && (!defined(WC_NO_RSA_OAEP) || defined(WC_RSA_PSS)) +#ifndef NO_RSA static CK_RV create_rsa_public(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE* key) { @@ -211,6 +211,7 @@ static CK_RV create_rsa_public(CK_SESSION_HANDLE session, { CKA_KEY_TYPE, &rsaType, sizeof(rsaType) }, { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, { CKA_VERIFY, &ckTrue, sizeof(ckTrue) }, + { CKA_VERIFY_RECOVER, &ckTrue, sizeof(ckTrue) }, { CKA_TOKEN, &ckFalse, sizeof(ckFalse) }, { CKA_MODULUS, rsa_2048_modulus, sizeof(rsa_2048_modulus) }, { CKA_PUBLIC_EXPONENT, rsa_2048_pub_exp, sizeof(rsa_2048_pub_exp) }, @@ -1202,6 +1203,216 @@ static void test_restore_with_key_is_refused(void) } #endif +#if defined(WOLFPKCS11_PKCS11_V3_0) && !defined(NO_AES) && \ + defined(HAVE_AES_CBC) && !defined(NO_HMAC) && !defined(NO_SHA256) +/* An Init call with a NULL mechanism terminates the active operation of that + * kind only, and a new operation of the same kind can then start. */ +static void test_null_mechanism_cancels_operation(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + byte iv[16] = { 0 }; + CK_MECHANISM cbcMech = { CKM_AES_CBC, NULL, 0 }; + CK_MECHANISM hmacMech = { CKM_SHA256_HMAC, NULL, 0 }; + CK_MECHANISM sha256Mech = { CKM_SHA256, NULL, 0 }; +#ifndef NO_RSA + CK_OBJECT_HANDLE rsaKey = CK_INVALID_HANDLE; + CK_MECHANISM rsaMech = { CKM_RSA_PKCS, NULL, 0 }; +#endif +#if defined(TRACK_ALLOCS) && defined(HAVE_AESGCM) + CK_GCM_PARAMS gcmParams; + CK_MECHANISM gcmMech = { CKM_AES_GCM, &gcmParams, sizeof(gcmParams) }; + long before; +#endif + byte out[64]; + CK_ULONG outLen; + CK_SLOT_ID slot; + + printf("\n--- a NULL mechanism cancels the active operation ---\n"); + cbcMech.pParameter = iv; + cbcMech.ulParameterLen = sizeof(iv); + + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + + rv = funcList->C_EncryptInit(session, &cbcMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-CBC)", CKR_OK); + rv = funcList->C_EncryptInit(session, NULL, aesKey); + CHECK_RV(rv, "C_EncryptInit(NULL) cancels", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_EncryptUpdate(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_EncryptUpdate after cancel", + CKR_OPERATION_NOT_INITIALIZED); + rv = funcList->C_EncryptInit(session, &cbcMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-CBC) after cancel", CKR_OK); + rv = funcList->C_EncryptInit(session, NULL, aesKey); + CHECK_RV(rv, "C_EncryptInit(NULL) cancels again", CKR_OK); + + rv = funcList->C_DecryptInit(session, &cbcMech, aesKey); + CHECK_RV(rv, "C_DecryptInit(AES-CBC)", CKR_OK); + rv = funcList->C_DecryptInit(session, NULL, aesKey); + CHECK_RV(rv, "C_DecryptInit(NULL) cancels", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_DecryptUpdate(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_DecryptUpdate after cancel", + CKR_OPERATION_NOT_INITIALIZED); + + rv = funcList->C_SignInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_SignInit(HMAC)", CKR_OK); + rv = funcList->C_SignInit(session, NULL, macKey); + CHECK_RV(rv, "C_SignInit(NULL) cancels", CKR_OK); + rv = funcList->C_SignUpdate(session, plainMarker, 16); + CHECK_RV(rv, "C_SignUpdate after cancel", CKR_OPERATION_NOT_INITIALIZED); + + rv = funcList->C_VerifyInit(session, &hmacMech, macKey); + CHECK_RV(rv, "C_VerifyInit(HMAC)", CKR_OK); +#ifndef NO_RSA + rv = funcList->C_VerifyRecoverInit(session, NULL, macKey); + CHECK_RV(rv, "C_VerifyRecoverInit(NULL) with a verify active", CKR_OK); + rv = funcList->C_VerifyUpdate(session, plainMarker, 16); + CHECK_RV(rv, "verify survives cancel of verify-recover", CKR_OK); +#endif + rv = funcList->C_VerifyInit(session, NULL, macKey); + CHECK_RV(rv, "C_VerifyInit(NULL) cancels", CKR_OK); + rv = funcList->C_VerifyUpdate(session, plainMarker, 16); + CHECK_RV(rv, "C_VerifyUpdate after cancel", + CKR_OPERATION_NOT_INITIALIZED); + +#ifndef NO_RSA + rv = create_rsa_public(session, &rsaKey); + CHECK_RV(rv, "C_CreateObject(RSA public)", CKR_OK); + rv = funcList->C_VerifyRecoverInit(session, &rsaMech, rsaKey); + CHECK_RV(rv, "C_VerifyRecoverInit(RSA)", CKR_OK); + rv = funcList->C_VerifyInit(session, NULL, rsaKey); + CHECK_RV(rv, "C_VerifyInit(NULL) with a verify-recover active", CKR_OK); + rv = funcList->C_VerifyRecoverInit(session, &rsaMech, rsaKey); + CHECK_RV(rv, "verify-recover survives cancel of verify", + CKR_OPERATION_ACTIVE); + rv = funcList->C_VerifyRecoverInit(session, NULL, rsaKey); + CHECK_RV(rv, "C_VerifyRecoverInit(NULL) cancels", CKR_OK); + rv = funcList->C_VerifyRecoverInit(session, &rsaMech, rsaKey); + CHECK_RV(rv, "C_VerifyRecoverInit(RSA) after cancel", CKR_OK); + rv = funcList->C_VerifyRecoverInit(session, NULL, rsaKey); + CHECK_RV(rv, "C_VerifyRecoverInit(NULL) cancels again", CKR_OK); +#endif + + rv = funcList->C_DigestInit(session, &sha256Mech); + CHECK_RV(rv, "C_DigestInit(SHA-256)", CKR_OK); + rv = funcList->C_EncryptInit(session, NULL, aesKey); + CHECK_RV(rv, "C_EncryptInit(NULL) with only a digest active", CKR_OK); + rv = funcList->C_DigestUpdate(session, plainMarker, 16); + CHECK_RV(rv, "digest survives cancel of another kind", CKR_OK); + rv = funcList->C_DigestInit(session, NULL); + CHECK_RV(rv, "C_DigestInit(NULL) cancels", CKR_OK); + rv = funcList->C_DigestUpdate(session, plainMarker, 16); + CHECK_RV(rv, "C_DigestUpdate after cancel", + CKR_OPERATION_NOT_INITIALIZED); + +#if defined(TRACK_ALLOCS) && defined(HAVE_AESGCM) + XMEMSET(&gcmParams, 0, sizeof(gcmParams)); + gcmParams.pIv = gcmIv; + gcmParams.ulIvLen = sizeof(gcmIv); + gcmParams.ulIvBits = sizeof(gcmIv) * 8; + gcmParams.pAAD = gcmAad; + gcmParams.ulAADLen = sizeof(gcmAad); + gcmParams.ulTagBits = 128; + before = liveBlocks; + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM with AAD)", CKR_OK); + rv = funcList->C_EncryptInit(session, NULL, aesKey); + CHECK_RV(rv, "C_EncryptInit(NULL) cancels AES-GCM", CKR_OK); + CHECK_TRUE(liveBlocks == before, + "cancelled operation leaves no allocation behind"); +#endif + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + +#if defined(WOLFPKCS11_PKCS11_V3_0) && !defined(NO_AES) && defined(HAVE_AESGCM) +/* A NULL mechanism must still cancel, and release, an operation whose key + * was destroyed while the operation held buffered data. */ +static void test_null_mechanism_cancels_after_key_destroyed(void) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE macKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE tmpKey = CK_INVALID_HANDLE; + CK_GCM_PARAMS gcmParams; + CK_MECHANISM gcmMech = { CKM_AES_GCM, &gcmParams, sizeof(gcmParams) }; + byte out[64]; + CK_ULONG outLen; + CK_SLOT_ID slot; +#ifdef TRACK_ALLOCS + long before; + int hit; +#endif + + printf("\n--- a NULL mechanism cancels an operation with a destroyed key " + "---\n"); + XMEMSET(&gcmParams, 0, sizeof(gcmParams)); + gcmParams.pIv = gcmIv; + gcmParams.ulIvLen = sizeof(gcmIv); + gcmParams.ulIvBits = sizeof(gcmIv) * 8; + gcmParams.ulTagBits = 128; + + rv = init_library(&slot); + if (rv == CKR_OK) + rv = open_with_keys(slot, &session, &aesKey, &macKey); + CHECK_RV(rv, "open session with keys", CKR_OK); + if (rv != CKR_OK) + goto out; + +#ifdef TRACK_ALLOCS + before = liveBlocks; +#endif + rv = create_secret(session, &aesType, aesKeyValue, sizeof(aesKeyValue), + &tmpKey); + CHECK_RV(rv, "C_CreateObject(AES)", CKR_OK); + rv = funcList->C_EncryptInit(session, &gcmMech, tmpKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM)", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_EncryptUpdate(session, plainMarker, sizeof(plainMarker), + out, &outLen); + CHECK_RV(rv, "C_EncryptUpdate(AES-GCM)", CKR_OK); + rv = funcList->C_DestroyObject(session, tmpKey); + CHECK_RV(rv, "C_DestroyObject(active AES-GCM key)", CKR_OK); + +#ifdef TRACK_ALLOCS + watch_start(plainMarker, sizeof(plainMarker)); +#endif + rv = funcList->C_EncryptInit(session, NULL, 0); + CHECK_RV(rv, "C_EncryptInit(NULL) after key destroyed", CKR_OK); +#ifdef TRACK_ALLOCS + hit = watch_stop(); + CHECK_TRUE(!hit, "cancel scrubs buffered plaintext before release"); + CHECK_TRUE(liveBlocks == before, + "cancel releases the operation of a destroyed key"); +#endif + + rv = funcList->C_EncryptInit(session, &gcmMech, aesKey); + CHECK_RV(rv, "C_EncryptInit(AES-GCM) with another key", CKR_OK); + outLen = sizeof(out); + rv = funcList->C_Encrypt(session, plainMarker, 16, out, &outLen); + CHECK_RV(rv, "C_Encrypt(AES-GCM) with another key", CKR_OK); + +out: + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(WOLFSSL_AESGCM_STREAM) /* Destroying the key of a multi-part AES-GCM operation must release the @@ -1316,6 +1527,13 @@ static int run_test(void) test_rejected_state_keeps_session(); test_restore_with_key_is_refused(); #endif +#if defined(WOLFPKCS11_PKCS11_V3_0) && !defined(NO_AES) && \ + defined(HAVE_AES_CBC) && !defined(NO_HMAC) && !defined(NO_SHA256) + test_null_mechanism_cancels_operation(); +#endif +#if defined(WOLFPKCS11_PKCS11_V3_0) && !defined(NO_AES) && defined(HAVE_AESGCM) + test_null_mechanism_cancels_after_key_destroyed(); +#endif #if defined(TRACK_ALLOCS) && !defined(NO_AES) && defined(HAVE_AESGCM) && \ !defined(NO_SHA256) test_restored_state_releases_operation(); diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 00fc1519..8ea0208b 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -451,6 +451,8 @@ WP11_LOCAL int WP11_Session_Get(CK_SESSION_HANDLE sessionHandle, WP11_Session** WP11_LOCAL int WP11_Session_GetState(WP11_Session* session); WP11_LOCAL int WP11_Session_IsRW(WP11_Session* session); WP11_LOCAL int WP11_Session_IsOpInitialized(WP11_Session* session, int init); +WP11_LOCAL int WP11_Session_IsOpCategoryInit(WP11_Session* session, + int opCategory); WP11_LOCAL int WP11_Session_IsOpCategoryActive(WP11_Session* session, int opCategory); WP11_LOCAL int WP11_Session_UpdateData(WP11_Session *session, byte *data, word32 dataLen); diff --git a/wolfpkcs11/pkcs11.h b/wolfpkcs11/pkcs11.h index 3397af80..03bd305e 100644 --- a/wolfpkcs11/pkcs11.h +++ b/wolfpkcs11/pkcs11.h @@ -484,6 +484,7 @@ extern "C" { #define CKR_MUTEX_BAD 0x000001A0UL #define CKR_MUTEX_NOT_LOCKED 0x000001A1UL #define CKR_FUNCTION_REJECTED 0x00000200UL +#define CKR_OPERATION_CANCEL_FAILED 0x00000202UL #define CKR_VENDOR_DEFINED 0x80000000UL From a0a07151e854d23a0a8e1fff946328b8e5460ea1 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 08:40:21 -0700 Subject: [PATCH 041/104] F-2769 - Blank pad fixed-length info fields --- src/internal.c | 16 +++ src/slot.c | 8 +- src/wolfpkcs11.c | 9 ++ tests/include.am | 7 ++ tests/info_mech_table_test.c | 191 +++++++++++++++++++++++++++++++++++ wolfpkcs11/internal.h | 1 + 6 files changed, 230 insertions(+), 2 deletions(-) create mode 100644 tests/info_mech_table_test.c diff --git a/src/internal.c b/src/internal.c index 091306ba..7d7960e5 100644 --- a/src/internal.c +++ b/src/internal.c @@ -11105,6 +11105,22 @@ void WP11_Slot_GetTokenLabel(WP11_Slot* slot, char* label) WP11_Lock_UnlockRO(&slot->lock); } +/** + * Replace NUL bytes in a fixed-length character field with blanks. + * + * @param field [in,out] Character field. + * @param len [in] Length of field in bytes. + */ +void WP11_BlankPad(CK_UTF8CHAR* field, int len) +{ + int i; + + for (i = 0; i < len; i++) { + if (field[i] == '\0') + field[i] = ' '; + } +} + /** * Check if token has been initialized. * diff --git a/src/slot.c b/src/slot.c index c0942db8..1f48ece7 100644 --- a/src/slot.c +++ b/src/slot.c @@ -138,6 +138,8 @@ CK_RV C_GetSlotInfo(CK_SLOT_ID slotID, CK_SLOT_INFO_PTR pInfo) } XMEMCPY(pInfo, &slotInfoTemplate, sizeof(slotInfoTemplate)); + WP11_BlankPad(pInfo->slotDescription, sizeof(pInfo->slotDescription)); + WP11_BlankPad(pInfo->manufacturerID, sizeof(pInfo->manufacturerID)); /* Put in the slot id value as two decimal digits. */ pInfo->slotDescription[SLOT_ID_IDX + 0] = ((slotID / 10) % 10) + '0'; pInfo->slotDescription[SLOT_ID_IDX + 1] = ((slotID ) % 10) + '0'; @@ -164,8 +166,8 @@ static CK_TOKEN_INFO tokenInfoTemplate = { "wolfpkcs11", "wolfpkcs11", { - 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, - 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 + '0', '0', '0', '0', '0', '0', '0', '0', '0', + '0', '0', '0', '0', '0', '0', '0' }, /* serialNumber */ CKF_RNG | CKF_CLOCK_ON_TOKEN | CKF_LOGIN_REQUIRED, WP11_SESSION_CNT_MAX, /* ulMaxSessionCount */ @@ -230,6 +232,8 @@ CK_RV C_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pInfo) } XMEMCPY(pInfo, &tokenInfoTemplate, sizeof(tokenInfoTemplate)); + WP11_BlankPad(pInfo->manufacturerID, sizeof(pInfo->manufacturerID)); + WP11_BlankPad(pInfo->model, sizeof(pInfo->model)); WP11_Slot_GetTokenLabel(slot, (char*)pInfo->label); pInfo->serialNumber[14] = ((slotID / 10) % 10) + '0'; pInfo->serialNumber[15] = ((slotID / 1) % 10) + '0'; diff --git a/src/wolfpkcs11.c b/src/wolfpkcs11.c index bc1e64d0..1c1a48f0 100644 --- a/src/wolfpkcs11.c +++ b/src/wolfpkcs11.c @@ -666,6 +666,9 @@ CK_RV C_GetInfo(CK_INFO_PTR pInfo) } XMEMCPY(pInfo, &wolfpkcs11Info, sizeof(wolfpkcs11Info)); + WP11_BlankPad(pInfo->manufacturerID, sizeof(pInfo->manufacturerID)); + WP11_BlankPad(pInfo->libraryDescription, + sizeof(pInfo->libraryDescription)); ret = CKR_OK; WOLFPKCS11_LEAVE("C_GetInfo", ret); return ret; @@ -680,6 +683,9 @@ CK_RV C_GetInfoV3_0(CK_INFO_PTR pInfo) return CKR_ARGUMENTS_BAD; XMEMCPY(pInfo, &wolfpkcs11Info_3_0, sizeof(wolfpkcs11Info_3_0)); + WP11_BlankPad(pInfo->manufacturerID, sizeof(pInfo->manufacturerID)); + WP11_BlankPad(pInfo->libraryDescription, + sizeof(pInfo->libraryDescription)); return CKR_OK; } @@ -694,6 +700,9 @@ CK_RV C_GetInfoV3_2(CK_INFO_PTR pInfo) return CKR_ARGUMENTS_BAD; XMEMCPY(pInfo, &wolfpkcs11Info_3_2, sizeof(wolfpkcs11Info_3_2)); + WP11_BlankPad(pInfo->manufacturerID, sizeof(pInfo->manufacturerID)); + WP11_BlankPad(pInfo->libraryDescription, + sizeof(pInfo->libraryDescription)); return CKR_OK; } diff --git a/tests/include.am b/tests/include.am index 3ac00568..cb413712 100644 --- a/tests/include.am +++ b/tests/include.am @@ -336,6 +336,11 @@ noinst_PROGRAMS += tests/session_op_lifecycle_test tests_session_op_lifecycle_test_SOURCES = tests/session_op_lifecycle_test.c tests_session_op_lifecycle_test_LDADD = +check_PROGRAMS += tests/info_mech_table_test +noinst_PROGRAMS += tests/info_mech_table_test +tests_info_mech_table_test_SOURCES = tests/info_mech_table_test.c +tests_info_mech_table_test_LDADD = + if BUILD_STATIC tests_pkcs11test_LDADD += src/libwolfpkcs11.la tests_pkcs11mtt_LDADD += src/libwolfpkcs11.la @@ -404,6 +409,7 @@ tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la tests_object_store_decode_test_LDADD += src/libwolfpkcs11.la tests_object_policy_integrity_test_LDADD += src/libwolfpkcs11.la tests_session_op_lifecycle_test_LDADD += src/libwolfpkcs11.la +tests_info_mech_table_test_LDADD += src/libwolfpkcs11.la else tests_object_id_uniqueness_test_LDADD += src/libwolfpkcs11.la tests_empty_pin_store_test_LDADD += src/libwolfpkcs11.la @@ -464,6 +470,7 @@ tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la tests_object_store_decode_test_LDADD += src/libwolfpkcs11.la tests_object_policy_integrity_test_LDADD += src/libwolfpkcs11.la tests_session_op_lifecycle_test_LDADD += src/libwolfpkcs11.la +tests_info_mech_table_test_LDADD += src/libwolfpkcs11.la endif EXTRA_DIST += tests/unit.h \ diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c new file mode 100644 index 00000000..adb64dc6 --- /dev/null +++ b/tests/info_mech_table_test.c @@ -0,0 +1,191 @@ +/* info_mech_table_test.c + * + * Copyright (C) 2006-2025 wolfSSL Inc. + * + * This file is part of wolfPKCS11. + * + * wolfPKCS11 is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfPKCS11 is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA + * + * Library, slot, token and mechanism information must match the PKCS#11 + * encoding rules and what the token actually implements. + */ + +#ifdef HAVE_CONFIG_H + #include +#endif + +#include +#include + +#ifndef WOLFSSL_USER_SETTINGS + #include +#endif +#include +#include + +#ifndef WOLFPKCS11_USER_SETTINGS + #include +#endif +#include + +#ifndef HAVE_PKCS11_STATIC +#include +#endif + +#include "testdata.h" +#include "pkcs11_test_util.h" + +#define TEST_DIR "./store/info_mech_table_test" + +/* Fixed-length character fields are blank padded and never contain NUL. */ +static int blank_padded(const CK_UTF8CHAR* field, size_t len) +{ + size_t i; + + for (i = 0; i < len; i++) { + if (field[i] == '\0') + return 0; + } + return 1; +} + +static void check_info(CK_FUNCTION_LIST* list, const char* name) +{ + CK_RV rv; + CK_INFO info; + char msg[96]; + + XMEMSET(&info, 0, sizeof(info)); + rv = list->C_GetInfo(&info); + snprintf(msg, sizeof(msg), "C_GetInfo(%s)", name); + CHECK_RV(rv, msg, CKR_OK); + if (rv != CKR_OK) + return; + snprintf(msg, sizeof(msg), "%s CK_INFO.manufacturerID blank padded", name); + CHECK_TRUE(blank_padded(info.manufacturerID, sizeof(info.manufacturerID)), + msg); + snprintf(msg, sizeof(msg), "%s CK_INFO.libraryDescription blank padded", + name); + CHECK_TRUE(blank_padded(info.libraryDescription, + sizeof(info.libraryDescription)), msg); +} + +static void test_info_blank_padding(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SLOT_INFO slotInfo; + CK_TOKEN_INFO tokenInfo; +#ifdef WOLFPKCS11_PKCS11_V3_0 + CK_INTERFACE interfaces[8]; + CK_ULONG count = sizeof(interfaces) / sizeof(interfaces[0]); + CK_ULONG i; + char name[32]; +#ifndef HAVE_PKCS11_STATIC + CK_C_GetInterfaceList getList; +#endif +#endif + + check_info(funcList, "v2"); + +#ifdef WOLFPKCS11_PKCS11_V3_0 +#ifndef HAVE_PKCS11_STATIC + getList = (CK_C_GetInterfaceList)dlsym(dlib, "C_GetInterfaceList"); + CHECK_TRUE(getList != NULL, "C_GetInterfaceList symbol"); + rv = (getList != NULL) ? getList(interfaces, &count) : CKR_GENERAL_ERROR; +#else + rv = C_GetInterfaceList(interfaces, &count); +#endif + CHECK_RV(rv, "C_GetInterfaceList", CKR_OK); + for (i = 0; rv == CKR_OK && i < count; i++) { + snprintf(name, sizeof(name), "interface %lu", (unsigned long)i); + check_info((CK_FUNCTION_LIST*)interfaces[i].pFunctionList, name); + } +#endif + + XMEMSET(&slotInfo, 0, sizeof(slotInfo)); + rv = funcList->C_GetSlotInfo(slot, &slotInfo); + CHECK_RV(rv, "C_GetSlotInfo", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(blank_padded(slotInfo.slotDescription, + sizeof(slotInfo.slotDescription)), + "CK_SLOT_INFO.slotDescription blank padded"); + CHECK_TRUE(blank_padded(slotInfo.manufacturerID, + sizeof(slotInfo.manufacturerID)), + "CK_SLOT_INFO.manufacturerID blank padded"); + } + + XMEMSET(&tokenInfo, 0, sizeof(tokenInfo)); + rv = funcList->C_GetTokenInfo(slot, &tokenInfo); + CHECK_RV(rv, "C_GetTokenInfo", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(blank_padded(tokenInfo.label, sizeof(tokenInfo.label)), + "CK_TOKEN_INFO.label blank padded"); + CHECK_TRUE(blank_padded(tokenInfo.manufacturerID, + sizeof(tokenInfo.manufacturerID)), + "CK_TOKEN_INFO.manufacturerID blank padded"); + CHECK_TRUE(blank_padded(tokenInfo.model, sizeof(tokenInfo.model)), + "CK_TOKEN_INFO.model blank padded"); + CHECK_TRUE(blank_padded(tokenInfo.serialNumber, + sizeof(tokenInfo.serialNumber)), + "CK_TOKEN_INFO.serialNumber has no NUL bytes"); + } +} + +static int run_test(void) +{ + CK_RV rv; + CK_C_INITIALIZE_ARGS args; + CK_SLOT_ID slotList[16]; + CK_ULONG slotCount = sizeof(slotList) / sizeof(slotList[0]); + + rv = pkcs11_load(); + CHECK_RV(rv, "load library", CKR_OK); + if (rv != CKR_OK) + return -1; + + XMEMSET(&args, 0, sizeof(args)); + args.flags = CKF_OS_LOCKING_OK; + rv = funcList->C_Initialize(&args); + CHECK_RV(rv, "C_Initialize", CKR_OK); + if (rv == CKR_OK) { + rv = funcList->C_GetSlotList(CK_TRUE, slotList, &slotCount); + CHECK_RV(rv, "C_GetSlotList", CKR_OK); + } + if (rv == CKR_OK && slotCount == 0) { + CHECK_TRUE(0, "at least one slot"); + rv = CKR_TOKEN_NOT_PRESENT; + } + if (rv == CKR_OK) { + test_info_blank_padding(slotList[0]); + } + funcList->C_Finalize(NULL); + + pkcs11_unload(); + return 0; +} + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + +#ifndef WOLFPKCS11_NO_ENV + XSETENV("WOLFPKCS11_TOKEN_PATH", TEST_DIR, 1); +#endif + + printf("=== wolfPKCS11 info and mechanism table test ===\n"); + run_test(); + return pkcs11_test_summary(); +} diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 8ea0208b..3ecacfc0 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -442,6 +442,7 @@ WP11_LOCAL int WP11_Slot_ChangeUserPin(WP11_Slot* slot, char* oldPin, WP11_LOCAL int WP11_Slot_TokenReset(WP11_Slot* slot, char* pin, int pinLen, char* label); WP11_LOCAL void WP11_Slot_GetTokenLabel(WP11_Slot* slot, char* label); +WP11_LOCAL void WP11_BlankPad(CK_UTF8CHAR* field, int len); WP11_LOCAL int WP11_Slot_IsTokenInitialized(WP11_Slot* slot); WP11_LOCAL int WP11_Slot_TokenFailedLogin(WP11_Slot* slot, int login); WP11_LOCAL time_t WP11_Slot_TokenFailedExpire(WP11_Slot* slot, int login); From cda47adbc8be88cea3b3536869bc16aa45da6440 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 08:55:03 -0700 Subject: [PATCH 042/104] F-6230 - Report the token clock only when a valid UTC time is available --- src/slot.c | 42 +++++++++++++++++++--------------- tests/info_mech_table_test.c | 44 ++++++++++++++++++++++++++++++++++++ tests/pkcs11test.c | 11 ++++++--- 3 files changed, 76 insertions(+), 21 deletions(-) diff --git a/src/slot.c b/src/slot.c index 1f48ece7..667374ca 100644 --- a/src/slot.c +++ b/src/slot.c @@ -204,6 +204,7 @@ CK_RV C_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pInfo) #ifndef WOLFPKCS11_NO_TIME time_t now, expire; struct tm nowTM; + struct tm* utc; #endif WP11_Slot* slot; int cnt; @@ -245,28 +246,33 @@ CK_RV C_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pInfo) #ifndef WOLFPKCS11_NO_TIME now = XTIME(0); XMEMSET(&nowTM, 0, sizeof(nowTM)); - if (XGMTIME(&now, &nowTM) != NULL) { - pInfo->utcTime[ 0] = (((1900 + nowTM.tm_year) / 1000) % 10) + '0'; - pInfo->utcTime[ 1] = (((1900 + nowTM.tm_year) / 100) % 10) + '0'; - pInfo->utcTime[ 2] = (((1900 + nowTM.tm_year) / 10) % 10) + '0'; - pInfo->utcTime[ 3] = (((1900 + nowTM.tm_year) / 1) % 10) + '0'; - pInfo->utcTime[ 4] = (((1 + nowTM.tm_mon) / 10) % 10) + '0'; - pInfo->utcTime[ 5] = (((1 + nowTM.tm_mon) / 1) % 10) + '0'; - pInfo->utcTime[ 6] = ((nowTM.tm_mday / 10) % 10) + '0'; - pInfo->utcTime[ 7] = ((nowTM.tm_mday / 1) % 10) + '0'; - pInfo->utcTime[ 8] = ((nowTM.tm_hour / 10) % 10) + '0'; - pInfo->utcTime[ 9] = ((nowTM.tm_hour / 1) % 10) + '0'; - pInfo->utcTime[10] = ((nowTM.tm_min / 10) % 10) + '0'; - pInfo->utcTime[11] = ((nowTM.tm_min / 1) % 10) + '0'; - pInfo->utcTime[12] = ((nowTM.tm_sec / 10) % 10) + '0'; - pInfo->utcTime[13] = ((nowTM.tm_sec / 1) % 10) + '0'; + /* XGMTIME may map to gmtime(), which ignores nowTM. */ + utc = NULL; + if (now != (time_t)-1) + utc = XGMTIME(&now, &nowTM); + if (utc != NULL) { + pInfo->utcTime[ 0] = (((1900 + utc->tm_year) / 1000) % 10) + '0'; + pInfo->utcTime[ 1] = (((1900 + utc->tm_year) / 100) % 10) + '0'; + pInfo->utcTime[ 2] = (((1900 + utc->tm_year) / 10) % 10) + '0'; + pInfo->utcTime[ 3] = (((1900 + utc->tm_year) / 1) % 10) + '0'; + pInfo->utcTime[ 4] = (((1 + utc->tm_mon) / 10) % 10) + '0'; + pInfo->utcTime[ 5] = (((1 + utc->tm_mon) / 1) % 10) + '0'; + pInfo->utcTime[ 6] = ((utc->tm_mday / 10) % 10) + '0'; + pInfo->utcTime[ 7] = ((utc->tm_mday / 1) % 10) + '0'; + pInfo->utcTime[ 8] = ((utc->tm_hour / 10) % 10) + '0'; + pInfo->utcTime[ 9] = ((utc->tm_hour / 1) % 10) + '0'; + pInfo->utcTime[10] = ((utc->tm_min / 10) % 10) + '0'; + pInfo->utcTime[11] = ((utc->tm_min / 1) % 10) + '0'; + pInfo->utcTime[12] = ((utc->tm_sec / 10) % 10) + '0'; + pInfo->utcTime[13] = ((utc->tm_sec / 1) % 10) + '0'; } else { - /* Set date to all zeros. */ - XMEMCPY(pInfo->utcTime, "00000000000000", 14); + pInfo->flags &= ~(CKF_CLOCK_ON_TOKEN); + XMEMSET(pInfo->utcTime, ' ', sizeof(pInfo->utcTime)); } #else - XMEMCPY(pInfo->utcTime, "00000000000000", 14); + pInfo->flags &= ~(CKF_CLOCK_ON_TOKEN); + XMEMSET(pInfo->utcTime, ' ', sizeof(pInfo->utcTime)); #endif cnt = WP11_Slot_TokenFailedLogin(slot, WP11_LOGIN_SO); diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c index adb64dc6..3ce45b72 100644 --- a/tests/info_mech_table_test.c +++ b/tests/info_mech_table_test.c @@ -143,6 +143,49 @@ static void test_info_blank_padding(CK_SLOT_ID slot) } } +static int two_digits(const CK_CHAR* p, int* val) +{ + if (p[0] < '0' || p[0] > '9' || p[1] < '0' || p[1] > '9') + return 0; + *val = (p[0] - '0') * 10 + (p[1] - '0'); + return 1; +} + +/* A token that claims a clock must report a valid UTC time. */ +static void test_token_clock(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_TOKEN_INFO tokenInfo; + int century = 0, year = 0, month = 0, day = 0; + int hour = 0, minute = 0, second = 0; + int valid; + + XMEMSET(&tokenInfo, 0, sizeof(tokenInfo)); + rv = funcList->C_GetTokenInfo(slot, &tokenInfo); + CHECK_RV(rv, "C_GetTokenInfo(clock)", CKR_OK); + if (rv != CKR_OK) + return; + + if ((tokenInfo.flags & CKF_CLOCK_ON_TOKEN) == 0) { + CHECK_TRUE(XMEMCMP(tokenInfo.utcTime, " ", + sizeof(tokenInfo.utcTime)) == 0, + "utcTime is blank without a clock"); + return; + } + + valid = two_digits(&tokenInfo.utcTime[0], ¢ury) && + two_digits(&tokenInfo.utcTime[2], &year) && + two_digits(&tokenInfo.utcTime[4], &month) && + two_digits(&tokenInfo.utcTime[6], &day) && + two_digits(&tokenInfo.utcTime[8], &hour) && + two_digits(&tokenInfo.utcTime[10], &minute) && + two_digits(&tokenInfo.utcTime[12], &second); + CHECK_TRUE(valid && century * 100 + year >= 1970 && + month >= 1 && month <= 12 && day >= 1 && day <= 31 && + hour <= 23 && minute <= 59 && second <= 60, + "CKF_CLOCK_ON_TOKEN reports a valid utcTime"); +} + static int run_test(void) { CK_RV rv; @@ -169,6 +212,7 @@ static int run_test(void) } if (rv == CKR_OK) { test_info_blank_padding(slotList[0]); + test_token_clock(slotList[0]); } funcList->C_Finalize(NULL); diff --git a/tests/pkcs11test.c b/tests/pkcs11test.c index eb4f800a..31b29296 100644 --- a/tests/pkcs11test.c +++ b/tests/pkcs11test.c @@ -61,6 +61,11 @@ #define PKCS11TEST_FUNC_SESS_DECL(func) \ PKCS11TEST_CASE(func, TEST_FLAG_INIT | TEST_FLAG_TOKEN | TEST_FLAG_SESSION) +#ifndef WOLFPKCS11_NO_TIME + #define TOKEN_CLOCK_FLAG CKF_CLOCK_ON_TOKEN +#else + #define TOKEN_CLOCK_FLAG 0 +#endif #ifndef HAVE_PKCS11_STATIC static void* dlib; @@ -468,7 +473,7 @@ static CK_RV test_no_token_init(void* args) * that has never had C_InitToken called. Pre-fix wp11_Token_Init * unconditionally marked the token state INITIALIZED, so the old * test included CKF_TOKEN_INITIALIZED in the expected mask. */ - CK_FLAGS expFlags = CKF_RNG | CKF_CLOCK_ON_TOKEN; + CK_FLAGS expFlags = CKF_RNG | TOKEN_CLOCK_FLAG; int flags = CKF_SERIAL_SESSION | CKF_RW_SESSION; ret = funcList->C_GetTokenInfo(slot, &tokenInfo); @@ -695,7 +700,7 @@ static CK_RV test_token(void* args) CK_SESSION_HANDLE session = *(CK_SESSION_HANDLE*)args; CK_RV ret; CK_TOKEN_INFO tokenInfo; - CK_FLAGS expFlags = CKF_RNG | CKF_CLOCK_ON_TOKEN | CKF_TOKEN_INITIALIZED; + CK_FLAGS expFlags = CKF_RNG | TOKEN_CLOCK_FLAG | CKF_TOKEN_INITIALIZED; unsigned char label[32]; int flags = CKF_SERIAL_SESSION | CKF_RW_SESSION; @@ -1002,7 +1007,7 @@ static CK_RV test_login_logout(void* args) CK_SESSION_HANDLE session = *(CK_SESSION_HANDLE*)args; CK_RV ret = 0; CK_TOKEN_INFO tokenInfo; - CK_FLAGS expFlags = CKF_RNG | CKF_CLOCK_ON_TOKEN | CKF_LOGIN_REQUIRED | + CK_FLAGS expFlags = CKF_RNG | TOKEN_CLOCK_FLAG | CKF_LOGIN_REQUIRED | CKF_TOKEN_INITIALIZED | CKF_USER_PIN_INITIALIZED; funcList->C_Logout(session); From b985c999d3014db7159fedf664c62543a103e34b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:04:28 -0700 Subject: [PATCH 043/104] F-6053 - Advertise wrap and unwrap only for mechanisms C_WrapKey supports --- src/crypto.c | 42 ++++ src/slot.c | 23 +- tests/info_mech_table_test.c | 398 +++++++++++++++++++++++++++++++++++ 3 files changed, 458 insertions(+), 5 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 47ae7f69..d3f7db62 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -8778,6 +8778,10 @@ static CK_RV wp11_C_WrapKey(CK_SESSION_HANDLE hSession, CK_OBJECT_CLASS keyClass = CKO_PRIVATE_KEY; word32 serialSize = 0; byte* serialBuff = NULL; +#ifndef NO_AES + byte* padBuff; + word32 padSize; +#endif CK_BBOOL getVar; CK_ULONG getVarLen = sizeof(CK_BBOOL); @@ -8910,6 +8914,25 @@ static CK_RV wp11_C_WrapKey(CK_SESSION_HANDLE hSession, rv = CKR_WRAPPING_KEY_TYPE_INCONSISTENT; goto err_out; } + /* AES-ECB zero-pads a secret key value to the block size. */ + if (pMechanism->mechanism == CKM_AES_ECB && + keyClass == CKO_SECRET_KEY && + (serialSize % AES_BLOCK_SIZE) != 0) { + padSize = serialSize + AES_BLOCK_SIZE - + (serialSize % AES_BLOCK_SIZE); + padBuff = (byte*)XMALLOC(padSize, NULL, + DYNAMIC_TYPE_TMP_BUFFER); + if (padBuff == NULL) { + rv = CKR_HOST_MEMORY; + goto err_out; + } + XMEMCPY(padBuff, serialBuff, serialSize); + XMEMSET(padBuff + serialSize, 0, padSize - serialSize); + wc_ForceZero(serialBuff, serialSize); + XFREE(serialBuff, NULL, DYNAMIC_TYPE_TMP_BUFFER); + serialBuff = padBuff; + serialSize = padSize; + } #ifdef WOLFSSL_STM32U5_DHUK if (WP11_Object_GetDevId(wrappingKey) == @@ -9178,6 +9201,25 @@ static CK_RV wp11_C_UnwrapKey(CK_SESSION_HANDLE hSession, if (rv != CKR_OK) goto err_out; + /* AES-ECB keeps no length: CKA_VALUE_LEN drops secret padding. */ + if (pMechanism->mechanism == CKM_AES_ECB && + keyClass == CKO_SECRET_KEY) { + FindAttributeType(pTemplate, ulAttributeCount, CKA_VALUE_LEN, + &attr); + if (attr == NULL) { + rv = CKR_TEMPLATE_INCOMPLETE; + goto err_out; + } + if (attr->pValue == NULL || + attr->ulValueLen != sizeof(CK_ULONG) || + *(CK_ULONG*)attr->pValue == 0 || + *(CK_ULONG*)attr->pValue > ulUnwrappedLen) { + rv = CKR_TEMPLATE_INCONSISTENT; + goto err_out; + } + ulUnwrappedLen = *(CK_ULONG*)attr->pValue; + } + break; #endif #ifndef NO_RSA diff --git a/src/slot.c b/src/slot.c index 667374ca..24010e46 100644 --- a/src/slot.c +++ b/src/slot.c @@ -574,6 +574,14 @@ CK_RV C_GetMechanismList(CK_SLOT_ID slotID, return rv; } +/* Matches the key serialization C_WrapKey compiles in for RSA and secret + * keys; without any, every wrap fails with CKR_KEY_NOT_WRAPPABLE. */ +#if defined(WOLFSSL_STM32U5_DHUK) || !defined(WOLFPKCS11_NO_STORE) + #define WP11_MECH_WRAP_FLAG CKF_WRAP +#else + #define WP11_MECH_WRAP_FLAG 0 +#endif + #ifndef NO_RSA #ifdef WOLFSSL_KEY_GEN /* Info on RSA key generation mechanism. */ @@ -583,13 +591,13 @@ static CK_MECHANISM_INFO rsaKgMechInfo = { #endif /* Info on RSA X.509 mechanism. */ static CK_MECHANISM_INFO rsaX509MechInfo = { - 1024, 4096, CKF_ENCRYPT | CKF_DECRYPT | CKF_SIGN | CKF_VERIFY | CKF_WRAP | - CKF_UNWRAP | CKF_VERIFY_RECOVER + 1024, 4096, CKF_ENCRYPT | CKF_DECRYPT | CKF_SIGN | CKF_VERIFY | + CKF_VERIFY_RECOVER }; /* Info on RSA PKCS#1.5 mechanism. */ static CK_MECHANISM_INFO rsaPkcsMechInfo = { 1024, 4096, CKF_ENCRYPT | CKF_DECRYPT | CKF_SIGN | CKF_VERIFY | - CKF_VERIFY_RECOVER + CKF_VERIFY_RECOVER | WP11_MECH_WRAP_FLAG | CKF_UNWRAP }; #ifndef WC_NO_RSA_OAEP /* Info on RSA PKCS#1 OAEP mechanism. */ @@ -753,7 +761,7 @@ static CK_MECHANISM_INFO aesKeyGenMechInfo = { }; #ifdef HAVE_AES_KEYWRAP static CK_MECHANISM_INFO aesKeyWrapMechInfo = { - 16, 32, CKF_ENCRYPT | CKF_DECRYPT | CKF_WRAP | CKF_UNWRAP + 16, 32, CKF_ENCRYPT | CKF_DECRYPT | WP11_MECH_WRAP_FLAG | CKF_UNWRAP }; #endif #ifdef HAVE_AES_CBC @@ -761,6 +769,9 @@ static CK_MECHANISM_INFO aesKeyWrapMechInfo = { static CK_MECHANISM_INFO aesCbcMechInfo = { 16, 32, CKF_ENCRYPT | CKF_DECRYPT }; +static CK_MECHANISM_INFO aesCbcPadMechInfo = { + 16, 32, CKF_ENCRYPT | CKF_DECRYPT | WP11_MECH_WRAP_FLAG | CKF_UNWRAP +}; static CK_MECHANISM_INFO aesCbcEncryptDataMechInfo = { 1, 32, CKF_DERIVE }; @@ -786,7 +797,7 @@ static CK_MECHANISM_INFO aesCcmMechInfo = { #ifdef HAVE_AESECB /* Info on AES-ECB mechanism. */ static CK_MECHANISM_INFO aesEcbMechInfo = { - 16, 32, CKF_ENCRYPT | CKF_DECRYPT + 16, 32, CKF_ENCRYPT | CKF_DECRYPT | WP11_MECH_WRAP_FLAG | CKF_UNWRAP }; #endif #ifdef HAVE_AESCTS @@ -1083,6 +1094,8 @@ CK_RV C_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type, #endif #ifdef HAVE_AES_CBC case CKM_AES_CBC_PAD: + XMEMCPY(pInfo, &aesCbcPadMechInfo, sizeof(CK_MECHANISM_INFO)); + break; case CKM_AES_CBC: XMEMCPY(pInfo, &aesCbcMechInfo, sizeof(CK_MECHANISM_INFO)); break; diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c index 3ce45b72..028e162d 100644 --- a/tests/info_mech_table_test.c +++ b/tests/info_mech_table_test.c @@ -186,12 +186,396 @@ static void test_token_clock(CK_SLOT_ID slot) "CKF_CLOCK_ON_TOKEN reports a valid utcTime"); } +/* C_WrapKey rejects every key before the mechanism check when it cannot + * serialize keys, as in a build without a store. */ +#if defined(WOLFPKCS11_NO_STORE) && !defined(WOLFSSL_STM32U5_DHUK) + #define WRAP_UNSUPPORTED_RV CKR_KEY_NOT_WRAPPABLE +#else + #define WRAP_UNSUPPORTED_RV CKR_MECHANISM_INVALID +#endif + +static CK_OBJECT_CLASS secretClass = CKO_SECRET_KEY; +static CK_KEY_TYPE genericType = CKK_GENERIC_SECRET; +static CK_BBOOL ckTrue = CK_TRUE; +static CK_BBOOL ckFalse = CK_FALSE; + +typedef struct WrapCase { + CK_MECHANISM_TYPE mech; + int useIv; + int rsa; +} WrapCase; + +/* Wrap and unwrap must succeed exactly for mechanisms that advertise them. */ +static void test_wrap_flags(CK_SLOT_ID slot, CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_MECHANISM_INFO info; + CK_MECHANISM mech; + CK_OBJECT_HANDLE secret = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE wrapKey; + CK_OBJECT_HANDLE unwrapKey; + CK_OBJECT_HANDLE unwrapped; + CK_BYTE iv[16]; + CK_BYTE secretValue[32]; + CK_BYTE aesValue[16]; + CK_BYTE wrapped[512]; + CK_ULONG wrappedLen; + CK_BYTE* unwrapData; + CK_ULONG unwrapLen; + char msg[96]; + size_t i; +#ifndef NO_RSA + CK_OBJECT_HANDLE rsaPub = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE rsaPriv = CK_INVALID_HANDLE; + CK_OBJECT_CLASS pubClass = CKO_PUBLIC_KEY; + CK_OBJECT_CLASS privClass = CKO_PRIVATE_KEY; + CK_KEY_TYPE rsaType = CKK_RSA; + CK_ATTRIBUTE rsaPubTmpl[] = { + { CKA_CLASS, &pubClass, sizeof(pubClass) }, + { CKA_KEY_TYPE, &rsaType, sizeof(rsaType) }, + { CKA_WRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_MODULUS, rsa_2048_modulus, sizeof(rsa_2048_modulus) }, + { CKA_PUBLIC_EXPONENT, rsa_2048_pub_exp, sizeof(rsa_2048_pub_exp) }, + }; + CK_ATTRIBUTE rsaPrivTmpl[] = { + { CKA_CLASS, &privClass, sizeof(privClass) }, + { CKA_KEY_TYPE, &rsaType, sizeof(rsaType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_UNWRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_DECRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_MODULUS, rsa_2048_modulus, sizeof(rsa_2048_modulus) }, + { CKA_PRIVATE_EXPONENT, rsa_2048_priv_exp, sizeof(rsa_2048_priv_exp) }, + { CKA_PRIME_1, rsa_2048_p, sizeof(rsa_2048_p) }, + { CKA_PRIME_2, rsa_2048_q, sizeof(rsa_2048_q) }, + { CKA_EXPONENT_1, rsa_2048_dP, sizeof(rsa_2048_dP) }, + { CKA_EXPONENT_2, rsa_2048_dQ, sizeof(rsa_2048_dQ) }, + { CKA_COEFFICIENT, rsa_2048_u, sizeof(rsa_2048_u) }, + { CKA_PUBLIC_EXPONENT, rsa_2048_pub_exp, sizeof(rsa_2048_pub_exp) }, + }; +#endif +#ifndef NO_AES + CK_KEY_TYPE aesType = CKK_AES; + CK_ATTRIBUTE aesTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_WRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_UNWRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_DECRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, aesValue, sizeof(aesValue) }, + }; +#endif + CK_ATTRIBUTE secretTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, secretValue, sizeof(secretValue) }, + }; + CK_ULONG secretLen = sizeof(secretValue); + CK_ATTRIBUTE unwrapTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE_LEN, &secretLen, sizeof(secretLen) }, + }; + static const WrapCase cases[] = { + { CKM_AES_KEY_WRAP, 0, 0 }, + { CKM_AES_KEY_WRAP_PAD, 0, 0 }, + { CKM_AES_CBC, 1, 0 }, + { CKM_AES_CBC_PAD, 1, 0 }, + { CKM_AES_ECB, 0, 0 }, + { CKM_RSA_PKCS, 0, 1 }, + { CKM_RSA_X_509, 0, 1 }, + }; + + XMEMSET(iv, 0x11, sizeof(iv)); + XMEMSET(secretValue, 0x22, sizeof(secretValue)); + XMEMSET(aesValue, 0x33, sizeof(aesValue)); + + rv = funcList->C_CreateObject(session, secretTmpl, + sizeof(secretTmpl) / sizeof(*secretTmpl), + &secret); + CHECK_RV(rv, "C_CreateObject(secret to wrap)", CKR_OK); + if (rv != CKR_OK) + return; +#ifndef NO_AES + rv = funcList->C_CreateObject(session, aesTmpl, + sizeof(aesTmpl) / sizeof(*aesTmpl), &aesKey); + CHECK_RV(rv, "C_CreateObject(AES wrapping key)", CKR_OK); +#endif +#ifndef NO_RSA + rv = funcList->C_CreateObject(session, rsaPubTmpl, + sizeof(rsaPubTmpl) / sizeof(*rsaPubTmpl), + &rsaPub); + CHECK_RV(rv, "C_CreateObject(RSA wrapping key)", CKR_OK); + rv = funcList->C_CreateObject(session, rsaPrivTmpl, + sizeof(rsaPrivTmpl) / sizeof(*rsaPrivTmpl), + &rsaPriv); + CHECK_RV(rv, "C_CreateObject(RSA unwrapping key)", CKR_OK); +#endif + + for (i = 0; i < sizeof(cases) / sizeof(cases[0]); i++) { + rv = funcList->C_GetMechanismInfo(slot, cases[i].mech, &info); + if (rv == CKR_MECHANISM_INVALID) + continue; + snprintf(msg, sizeof(msg), "C_GetMechanismInfo(0x%lx)", + (unsigned long)cases[i].mech); + CHECK_RV(rv, msg, CKR_OK); + if (rv != CKR_OK) + continue; + + wrapKey = aesKey; + unwrapKey = aesKey; +#ifndef NO_RSA + if (cases[i].rsa) { + wrapKey = rsaPub; + unwrapKey = rsaPriv; + } +#endif + if (wrapKey == CK_INVALID_HANDLE || unwrapKey == CK_INVALID_HANDLE) + continue; + + mech.mechanism = cases[i].mech; + mech.pParameter = cases[i].useIv ? iv : NULL; + mech.ulParameterLen = cases[i].useIv ? sizeof(iv) : 0; + + wrappedLen = sizeof(wrapped); + rv = funcList->C_WrapKey(session, &mech, wrapKey, secret, wrapped, + &wrappedLen); + snprintf(msg, sizeof(msg), "C_WrapKey(0x%lx) matches CKF_WRAP", + (unsigned long)cases[i].mech); + CHECK_RV(rv, msg, ((info.flags & CKF_WRAP) != 0) ? + CKR_OK : WRAP_UNSUPPORTED_RV); + + unwrapData = wrapped; + unwrapLen = wrappedLen; + if (rv != CKR_OK) { + XMEMSET(wrapped, 0x44, sizeof(wrapped)); + unwrapLen = cases[i].rsa ? 256 : 48; + } + if (rv != CKR_OK && (info.flags & CKF_UNWRAP) != 0) { + /* Unwrap works without wrap support: encrypt the key directly. */ + wrappedLen = sizeof(wrapped); + rv = funcList->C_EncryptInit(session, &mech, wrapKey); + if (rv == CKR_OK) { + rv = funcList->C_Encrypt(session, secretValue, + sizeof(secretValue), wrapped, + &wrappedLen); + } + snprintf(msg, sizeof(msg), "C_Encrypt(0x%lx) key to unwrap", + (unsigned long)cases[i].mech); + CHECK_RV(rv, msg, CKR_OK); + unwrapLen = wrappedLen; + } + unwrapped = CK_INVALID_HANDLE; + /* AES-ECB needs CKA_VALUE_LEN to know the key length. */ + rv = funcList->C_UnwrapKey(session, &mech, unwrapKey, unwrapData, + unwrapLen, unwrapTmpl, + sizeof(unwrapTmpl) / sizeof(*unwrapTmpl) - + (cases[i].mech == CKM_AES_ECB ? 0 : 1), + &unwrapped); + snprintf(msg, sizeof(msg), "C_UnwrapKey(0x%lx) matches CKF_UNWRAP", + (unsigned long)cases[i].mech); + CHECK_RV(rv, msg, ((info.flags & CKF_UNWRAP) != 0) ? + CKR_OK : CKR_MECHANISM_INVALID); + if (unwrapped != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, unwrapped); + } +} + +#ifndef NO_AES +/* AES-ECB wraps a key that is not block aligned and unwraps it back. */ +static void test_ecb_wrap_short_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_MECHANISM_INFO info; + CK_MECHANISM mech = { CKM_AES_ECB, NULL, 0 }; + CK_OBJECT_HANDLE secret = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE unwrapped = CK_INVALID_HANDLE; + CK_KEY_TYPE aesType = CKK_AES; + CK_ULONG valueLen = 20; + CK_BYTE secretValue[20]; + CK_BYTE aesValue[16]; + CK_BYTE wrapped[64]; + CK_BYTE value[32]; + CK_ULONG wrappedLen = sizeof(wrapped); + CK_ATTRIBUTE secretTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, secretValue, sizeof(secretValue) }, + }; + CK_ATTRIBUTE aesTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_WRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_UNWRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_DECRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, aesValue, sizeof(aesValue) }, + }; + CK_ATTRIBUTE unwrapTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE_LEN, &valueLen, sizeof(valueLen) }, + }; + CK_ATTRIBUTE valueAttr = { CKA_VALUE, value, sizeof(value) }; + + rv = funcList->C_GetMechanismInfo(slot, CKM_AES_ECB, &info); + if (rv != CKR_OK || (info.flags & CKF_WRAP) == 0) + return; + XMEMSET(secretValue, 0x5c, sizeof(secretValue)); + XMEMSET(aesValue, 0x3a, sizeof(aesValue)); + rv = funcList->C_CreateObject(session, secretTmpl, + sizeof(secretTmpl) / sizeof(*secretTmpl), &secret); + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, aesTmpl, + sizeof(aesTmpl) / sizeof(*aesTmpl), &aesKey); + } + CHECK_RV(rv, "create 20 byte secret and AES wrapping key", CKR_OK); + if (rv == CKR_OK) { + rv = funcList->C_WrapKey(session, &mech, aesKey, secret, wrapped, + &wrappedLen); + CHECK_RV(rv, "C_WrapKey(AES-ECB) pads a 20 byte key", CKR_OK); + CHECK_TRUE(rv != CKR_OK || wrappedLen == 32, + "AES-ECB wrapped length is two blocks"); + } + if (rv == CKR_OK) { + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, + sizeof(unwrapTmpl) / sizeof(*unwrapTmpl), + &unwrapped); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) with CKA_VALUE_LEN", CKR_OK); + } + if (rv == CKR_OK) { + CK_OBJECT_HANDLE noLen = CK_INVALID_HANDLE; + + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, + sizeof(unwrapTmpl) / sizeof(*unwrapTmpl) - 1, + &noLen); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) needs CKA_VALUE_LEN", + CKR_TEMPLATE_INCOMPLETE); + rv = CKR_OK; + } + if (rv == CKR_OK) { + rv = funcList->C_GetAttributeValue(session, unwrapped, &valueAttr, 1); + CHECK_TRUE(rv == CKR_OK && valueAttr.ulValueLen == sizeof(secretValue) + && XMEMCMP(value, secretValue, sizeof(secretValue)) == 0, + "AES-ECB unwrapped key has its original value"); + } + if (unwrapped != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, unwrapped); + if (aesKey != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, aesKey); + if (secret != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, secret); +} +#endif + +#if !defined(NO_RSA) && !defined(NO_AES) && !defined(WOLFPKCS11_NO_STORE) +/* An RSA key AES-ECB wraps must unwrap without CKA_VALUE_LEN. */ +static void test_ecb_wrap_rsa_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_MECHANISM_INFO info; + CK_MECHANISM mech = { CKM_AES_ECB, NULL, 0 }; + CK_OBJECT_HANDLE rsaPriv = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE unwrapped = CK_INVALID_HANDLE; + CK_OBJECT_CLASS privClass = CKO_PRIVATE_KEY; + CK_KEY_TYPE rsaType = CKK_RSA; + CK_KEY_TYPE aesType = CKK_AES; + CK_BYTE aesValue[16]; + CK_BYTE wrapped[2048]; + CK_ULONG wrappedLen = sizeof(wrapped); + CK_ATTRIBUTE rsaPrivTmpl[] = { + { CKA_CLASS, &privClass, sizeof(privClass) }, + { CKA_KEY_TYPE, &rsaType, sizeof(rsaType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_MODULUS, rsa_2048_modulus, sizeof(rsa_2048_modulus) }, + { CKA_PRIVATE_EXPONENT, rsa_2048_priv_exp, sizeof(rsa_2048_priv_exp) }, + { CKA_PRIME_1, rsa_2048_p, sizeof(rsa_2048_p) }, + { CKA_PRIME_2, rsa_2048_q, sizeof(rsa_2048_q) }, + { CKA_EXPONENT_1, rsa_2048_dP, sizeof(rsa_2048_dP) }, + { CKA_EXPONENT_2, rsa_2048_dQ, sizeof(rsa_2048_dQ) }, + { CKA_COEFFICIENT, rsa_2048_u, sizeof(rsa_2048_u) }, + { CKA_PUBLIC_EXPONENT, rsa_2048_pub_exp, sizeof(rsa_2048_pub_exp) }, + }; + CK_ATTRIBUTE aesTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_WRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_UNWRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_DECRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, aesValue, sizeof(aesValue) }, + }; + CK_ATTRIBUTE unwrapTmpl[] = { + { CKA_CLASS, &privClass, sizeof(privClass) }, + { CKA_KEY_TYPE, &rsaType, sizeof(rsaType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + }; + + rv = funcList->C_GetMechanismInfo(slot, CKM_AES_ECB, &info); + if (rv != CKR_OK || (info.flags & CKF_WRAP) == 0) + return; + XMEMSET(aesValue, 0x4b, sizeof(aesValue)); + rv = funcList->C_CreateObject(session, rsaPrivTmpl, + sizeof(rsaPrivTmpl) / sizeof(*rsaPrivTmpl), &rsaPriv); + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, aesTmpl, + sizeof(aesTmpl) / sizeof(*aesTmpl), &aesKey); + } + CHECK_RV(rv, "create RSA private key and AES wrapping key", CKR_OK); + if (rv == CKR_OK) { + rv = funcList->C_WrapKey(session, &mech, aesKey, rsaPriv, wrapped, + &wrappedLen); + } + if (rv == CKR_OK) { + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, + sizeof(unwrapTmpl) / sizeof(*unwrapTmpl), + &unwrapped); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) of the RSA key it wrapped", CKR_OK); + } + else { + CHECK_TRUE(rsaPriv != CK_INVALID_HANDLE && aesKey != CK_INVALID_HANDLE, + "C_WrapKey(AES-ECB) refuses an unaligned RSA key"); + } + if (unwrapped != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, unwrapped); + if (aesKey != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, aesKey); + if (rsaPriv != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, rsaPriv); +} +#endif + static int run_test(void) { CK_RV rv; CK_C_INITIALIZE_ARGS args; CK_SLOT_ID slotList[16]; CK_ULONG slotCount = sizeof(slotList) / sizeof(slotList[0]); + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; rv = pkcs11_load(); CHECK_RV(rv, "load library", CKR_OK); @@ -213,6 +597,20 @@ static int run_test(void) if (rv == CKR_OK) { test_info_blank_padding(slotList[0]); test_token_clock(slotList[0]); + rv = funcList->C_OpenSession(slotList[0], + CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &session); + CHECK_RV(rv, "C_OpenSession", CKR_OK); + } + if (rv == CKR_OK) { + test_wrap_flags(slotList[0], session); +#ifndef NO_AES + test_ecb_wrap_short_key(slotList[0], session); +#endif +#if !defined(NO_RSA) && !defined(NO_AES) && !defined(WOLFPKCS11_NO_STORE) + test_ecb_wrap_rsa_key(slotList[0], session); +#endif + funcList->C_CloseSession(session); } funcList->C_Finalize(NULL); From d8d206d2e851c21a1c5f45ccd7bc53cf5244f43f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:14:17 -0700 Subject: [PATCH 044/104] F-12477 - Report generic secret key generation sizes in bits --- src/internal.c | 11 --------- src/slot.c | 3 ++- tests/info_mech_table_test.c | 45 ++++++++++++++++++++++++++++++++++++ wolfpkcs11/internal.h | 11 +++++++++ 4 files changed, 58 insertions(+), 12 deletions(-) diff --git a/src/internal.c b/src/internal.c index 7d7960e5..dddc786a 100644 --- a/src/internal.c +++ b/src/internal.c @@ -132,17 +132,6 @@ #define WP11_MAX_DH_KEY_SZ (4096/8) #endif -/* Maximum size of storage for generated/derived symmetric key. */ -#ifdef WOLFPKCS11_NSS -#define WP11_MAX_SYM_KEY_SZ (2048) -#elif !defined(NO_DH) -#define WP11_MAX_SYM_KEY_SZ (4096/8) -#elif defined(HAVE_ECC) -#define WP11_MAX_SYM_KEY_SZ ((521+7)/8) -#else -#define WP11_MAX_SYM_KEY_SZ 64 -#endif - #ifndef WP11_MAX_CERT_SZ #define WP11_MAX_CERT_SZ 4096 #endif diff --git a/src/slot.c b/src/slot.c index 24010e46..c4843bc6 100644 --- a/src/slot.c +++ b/src/slot.c @@ -893,8 +893,9 @@ static CK_MECHANISM_INFO sha3MechInfo = { }; #endif #endif +/* Key sizes in bits. */ static CK_MECHANISM_INFO genSecKeyGenMechInfo = { - 1, 32, CKF_GENERATE + 8, WP11_MAX_SYM_KEY_SZ * 8, CKF_GENERATE }; static CK_MECHANISM_INFO pkcs5Pbkdf2MechInfo = { diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c index 028e162d..81a9b4e0 100644 --- a/tests/info_mech_table_test.c +++ b/tests/info_mech_table_test.c @@ -199,6 +199,50 @@ static CK_KEY_TYPE genericType = CKK_GENERIC_SECRET; static CK_BBOOL ckTrue = CK_TRUE; static CK_BBOOL ckFalse = CK_FALSE; +static CK_RV generate_generic(CK_SESSION_HANDLE session, CK_ULONG len) +{ + CK_RV rv; + CK_MECHANISM mech = { CKM_GENERIC_SECRET_KEY_GEN, NULL, 0 }; + CK_OBJECT_HANDLE key = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_VALUE_LEN, &len, sizeof(len) }, + }; + + rv = funcList->C_GenerateKey(session, &mech, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &key); + if (key != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, key); + return rv; +} + +/* Generic secret key sizes are reported in bits and match what generates. */ +static void test_generic_secret_size(CK_SLOT_ID slot, + CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_MECHANISM_INFO info; + + rv = funcList->C_GetMechanismInfo(slot, CKM_GENERIC_SECRET_KEY_GEN, &info); + CHECK_RV(rv, "C_GetMechanismInfo(CKM_GENERIC_SECRET_KEY_GEN)", CKR_OK); + if (rv != CKR_OK) + return; + + CHECK_TRUE(info.ulMinKeySize >= 8 && info.ulMinKeySize % 8 == 0 && + info.ulMaxKeySize % 8 == 0 && + info.ulMaxKeySize >= info.ulMinKeySize, + "generic secret key sizes are whole bytes in bits"); + rv = generate_generic(session, info.ulMinKeySize / 8); + CHECK_RV(rv, "generate generic secret of minimum size", CKR_OK); + rv = generate_generic(session, info.ulMaxKeySize / 8); + CHECK_RV(rv, "generate generic secret of maximum size", CKR_OK); + rv = generate_generic(session, info.ulMaxKeySize / 8 + 1); + CHECK_TRUE(rv != CKR_OK, + "generic secret above maximum size is rejected"); +} + typedef struct WrapCase { CK_MECHANISM_TYPE mech; int useIv; @@ -603,6 +647,7 @@ static int run_test(void) CHECK_RV(rv, "C_OpenSession", CKR_OK); } if (rv == CKR_OK) { + test_generic_secret_size(slotList[0], session); test_wrap_flags(slotList[0], session); #ifndef NO_AES test_ecb_wrap_short_key(slotList[0], session); diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 3ecacfc0..9b85b534 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -348,6 +348,17 @@ C_EXTRA_FLAGS="-DWOLFSSL_PUBLIC_MP -DWC_RSA_DIRECT" #define WP11_MAX_PIN_LEN 32 #endif +/* Maximum size of storage for generated/derived symmetric key. */ +#ifdef WOLFPKCS11_NSS +#define WP11_MAX_SYM_KEY_SZ (2048) +#elif !defined(NO_DH) +#define WP11_MAX_SYM_KEY_SZ (4096/8) +#elif defined(HAVE_ECC) +#define WP11_MAX_SYM_KEY_SZ ((521+7)/8) +#else +#define WP11_MAX_SYM_KEY_SZ 64 +#endif + /* Login failure constants. */ #ifndef WP11_MAX_LOGIN_FAILS_SO #define WP11_MAX_LOGIN_FAILS_SO 3 From bf8e0b18b7ffacf3cab8b92fbf07b3a0534ead6f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:26:09 -0700 Subject: [PATCH 045/104] F-13248 - Advertise PBKDF2 and PKCS#12 PBE key generation only with HMAC --- src/slot.c | 12 ++++++++++ tests/info_mech_table_test.c | 45 ++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) diff --git a/src/slot.c b/src/slot.c index c4843bc6..69118d08 100644 --- a/src/slot.c +++ b/src/slot.c @@ -486,16 +486,20 @@ static CK_MECHANISM_TYPE mechanismList[] = { #ifdef WOLFPKCS11_NSS /* NSS uses this as a target-key marker when unwrapping TLS secrets. */ CKM_SSL3_MASTER_KEY_DERIVE, +#ifndef NO_HMAC CKM_NSS_PKCS12_PBE_SHA224_HMAC_KEY_GEN, CKM_NSS_PKCS12_PBE_SHA256_HMAC_KEY_GEN, CKM_NSS_PKCS12_PBE_SHA384_HMAC_KEY_GEN, CKM_NSS_PKCS12_PBE_SHA512_HMAC_KEY_GEN, #endif +#endif #ifdef WOLFSSL_HAVE_PRF CKM_TLS_MAC, #endif CKM_GENERIC_SECRET_KEY_GEN, +#ifndef NO_HMAC CKM_PKCS5_PBKD2 +#endif }; /* Count of mechanisms in list. */ @@ -730,6 +734,7 @@ static CK_MECHANISM_INFO nssTls12MasterKeyDeriveDhInfo = { static CK_MECHANISM_INFO nssTls12MasterKeyDeriveInfo = { 48, 128, CKF_DERIVE }; +#ifndef NO_HMAC static CK_MECHANISM_INFO nssPkcs12PbeSha224HmacKeyGenMechInfo = { 224, 224, CKF_GENERATE }; @@ -742,6 +747,7 @@ static CK_MECHANISM_INFO nssPkcs12PbeSha384HmacKeyGenMechInfo = { static CK_MECHANISM_INFO nssPkcs12PbeSha512HmacKeyGenMechInfo = { 512, 512, CKF_GENERATE }; +#endif /* NSS requires this mechanism identifier when selecting the slot used to * unwrap cached TLS secrets. C_DeriveKey does not implement the mechanism, so * do not advertise CKF_DERIVE. */ @@ -898,9 +904,11 @@ static CK_MECHANISM_INFO genSecKeyGenMechInfo = { 8, WP11_MAX_SYM_KEY_SZ * 8, CKF_GENERATE }; +#ifndef NO_HMAC static CK_MECHANISM_INFO pkcs5Pbkdf2MechInfo = { 1, 256, CKF_GENERATE }; +#endif /** * Get information on a mechanism. @@ -1245,6 +1253,7 @@ CK_RV C_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type, XMEMCPY(pInfo, &nssTls12MasterKeyDeriveDhInfo, sizeof(CK_MECHANISM_INFO)); break; +#ifndef NO_HMAC case CKM_NSS_PKCS12_PBE_SHA224_HMAC_KEY_GEN: XMEMCPY(pInfo, &nssPkcs12PbeSha224HmacKeyGenMechInfo, sizeof(CK_MECHANISM_INFO)); @@ -1261,6 +1270,7 @@ CK_RV C_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type, XMEMCPY(pInfo, &nssPkcs12PbeSha512HmacKeyGenMechInfo, sizeof(CK_MECHANISM_INFO)); break; +#endif case CKM_SSL3_MASTER_KEY_DERIVE: XMEMCPY(pInfo, &ssl3MasterKeyTargetInfo, sizeof(CK_MECHANISM_INFO)); @@ -1277,10 +1287,12 @@ CK_RV C_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type, XMEMCPY(pInfo, &genSecKeyGenMechInfo, sizeof(CK_MECHANISM_INFO)); break; +#ifndef NO_HMAC case CKM_PKCS5_PBKD2: XMEMCPY(pInfo, &pkcs5Pbkdf2MechInfo, sizeof(CK_MECHANISM_INFO)); break; +#endif default: return CKR_MECHANISM_INVALID; } diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c index 81a9b4e0..73549bbe 100644 --- a/tests/info_mech_table_test.c +++ b/tests/info_mech_table_test.c @@ -243,6 +243,50 @@ static void test_generic_secret_size(CK_SLOT_ID slot, "generic secret above maximum size is rejected"); } +/* Every listed key generation mechanism must be known to C_GenerateKey. */ +static void test_listed_keygen_supported(CK_SLOT_ID slot, + CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_MECHANISM_TYPE mechs[256]; + CK_ULONG count = sizeof(mechs) / sizeof(mechs[0]); + CK_ULONG i; + CK_MECHANISM_INFO info; + CK_MECHANISM mech; + CK_OBJECT_HANDLE key; + char msg[96]; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + }; + + rv = funcList->C_GetMechanismList(slot, mechs, &count); + CHECK_RV(rv, "C_GetMechanismList", CKR_OK); + if (rv != CKR_OK) + return; + + for (i = 0; i < count; i++) { + rv = funcList->C_GetMechanismInfo(slot, mechs[i], &info); + snprintf(msg, sizeof(msg), "C_GetMechanismInfo(listed 0x%lx)", + (unsigned long)mechs[i]); + CHECK_RV(rv, msg, CKR_OK); + if (rv != CKR_OK || (info.flags & CKF_GENERATE) == 0) + continue; + + mech.mechanism = mechs[i]; + mech.pParameter = NULL; + mech.ulParameterLen = 0; + key = CK_INVALID_HANDLE; + rv = funcList->C_GenerateKey(session, &mech, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &key); + if (key != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, key); + snprintf(msg, sizeof(msg), "C_GenerateKey accepts listed 0x%lx", + (unsigned long)mechs[i]); + CHECK_TRUE(rv != CKR_MECHANISM_INVALID, msg); + } +} + typedef struct WrapCase { CK_MECHANISM_TYPE mech; int useIv; @@ -648,6 +692,7 @@ static int run_test(void) } if (rv == CKR_OK) { test_generic_secret_size(slotList[0], session); + test_listed_keygen_supported(slotList[0], session); test_wrap_flags(slotList[0], session); #ifndef NO_AES test_ecb_wrap_short_key(slotList[0], session); From 6708b01ccb40fd3aaf2ba6fb8a079af3e6fff645 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:34:25 -0700 Subject: [PATCH 046/104] F-8634 - Report C_OpenSession failures instead of returning CKR_OK --- src/slot.c | 12 ++++++ tests/info_mech_table_test.c | 76 ++++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+) diff --git a/src/slot.c b/src/slot.c index 69118d08..6ed43989 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1598,6 +1598,8 @@ CK_RV C_SetPIN(CK_SESSION_HANDLE hSession, CK_UTF8CHAR_PTR pOldPin, * CKR_SESSION_READ_WRITE_SO_EXISTS when there is an existing open * Security Officer session. * CKR_SESSION_COUNT when no more sessions can be opened on token. + * CKR_HOST_MEMORY when allocating the session fails. + * CKR_FUNCTION_FAILED when opening the session fails otherwise. * CKR_OK on success. */ CK_RV C_OpenSession(CK_SLOT_ID slotID, CK_FLAGS flags, @@ -1647,6 +1649,16 @@ CK_RV C_OpenSession(CK_SLOT_ID slotID, CK_FLAGS flags, WOLFPKCS11_LEAVE("C_OpenSession", rv); return rv; } + if (ret == MEMORY_E) { + rv = CKR_HOST_MEMORY; + WOLFPKCS11_LEAVE("C_OpenSession", rv); + return rv; + } + if (ret != 0) { + rv = CKR_FUNCTION_FAILED; + WOLFPKCS11_LEAVE("C_OpenSession", rv); + return rv; + } rv = CKR_OK; WOLFPKCS11_LEAVE("C_OpenSession", rv); diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c index 73549bbe..3eea94f6 100644 --- a/tests/info_mech_table_test.c +++ b/tests/info_mech_table_test.c @@ -27,6 +27,7 @@ #endif #include +#include #include #ifndef WOLFSSL_USER_SETTINGS @@ -34,6 +35,7 @@ #endif #include #include +#include #ifndef WOLFPKCS11_USER_SETTINGS #include @@ -49,6 +51,34 @@ #define TEST_DIR "./store/info_mech_table_test" +#if defined(USE_WOLFSSL_MEMORY) && !defined(NO_WOLFSSL_MEMORY) && \ + !defined(WOLFSSL_STATIC_MEMORY) && !defined(WOLFSSL_DEBUG_MEMORY) + #define ALLOC_HOOKS +#endif + +#ifdef ALLOC_HOOKS +static int failAllocs = 0; + +static void* hook_malloc(size_t sz) +{ + if (failAllocs) + return NULL; + return malloc(sz); +} + +static void hook_free(void* ptr) +{ + free(ptr); +} + +static void* hook_realloc(void* ptr, size_t sz) +{ + if (failAllocs) + return NULL; + return realloc(ptr, sz); +} +#endif + /* Fixed-length character fields are blank padded and never contain NUL. */ static int blank_padded(const CK_UTF8CHAR* field, size_t len) { @@ -287,6 +317,43 @@ static void test_listed_keygen_supported(CK_SLOT_ID slot, } } +#ifdef ALLOC_HOOKS +/* A session is reported open only when a usable handle was returned. */ +static void test_open_session_alloc_failure(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE handles[8]; + CK_SESSION_INFO sessInfo; + int opened = 0; + int failed = 0; + int i; + + for (i = 0; i < (int)(sizeof(handles) / sizeof(handles[0])); i++) { + handles[i] = CK_INVALID_HANDLE; + failAllocs = 1; + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &handles[i]); + failAllocs = 0; + if (rv != CKR_OK) { + CHECK_RV(rv, "C_OpenSession without memory", CKR_HOST_MEMORY); + failed = 1; + break; + } + opened++; + rv = funcList->C_GetSessionInfo(handles[i], &sessInfo); + CHECK_RV(rv, "C_OpenSession returns a usable handle", CKR_OK); + if (rv != CKR_OK) + break; + } + CHECK_TRUE(failed, "C_OpenSession reports allocation failure"); + + for (i = 0; i < opened; i++) { + if (handles[i] != CK_INVALID_HANDLE) + funcList->C_CloseSession(handles[i]); + } +} +#endif + typedef struct WrapCase { CK_MECHANISM_TYPE mech; int useIv; @@ -693,6 +760,9 @@ static int run_test(void) if (rv == CKR_OK) { test_generic_secret_size(slotList[0], session); test_listed_keygen_supported(slotList[0], session); +#ifdef ALLOC_HOOKS + test_open_session_alloc_failure(slotList[0]); +#endif test_wrap_flags(slotList[0], session); #ifndef NO_AES test_ecb_wrap_short_key(slotList[0], session); @@ -718,6 +788,12 @@ int main(int argc, char* argv[]) #endif printf("=== wolfPKCS11 info and mechanism table test ===\n"); +#ifdef ALLOC_HOOKS + if (wolfSSL_SetAllocators(hook_malloc, hook_free, hook_realloc) != 0) { + CHECK_TRUE(0, "install allocation hooks"); + return pkcs11_test_summary(); + } +#endif run_test(); return pkcs11_test_summary(); } From 5eb1dc964271ae12ef4d91780ec394a1cf6d4ea2 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:38:53 -0700 Subject: [PATCH 047/104] F-10370 - Document how C_Initialize uses pInitArgs --- src/wolfpkcs11.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/wolfpkcs11.c b/src/wolfpkcs11.c index 1c1a48f0..7170625a 100644 --- a/src/wolfpkcs11.c +++ b/src/wolfpkcs11.c @@ -522,8 +522,12 @@ CK_RV C_GetInterface(CK_UTF8CHAR_PTR pInterfaceName, CK_VERSION_PTR pVersion, /** * Initialize the Crypto-Ki library. * - * @param pInitArgs [out] Ignored. - * @return CKR_FUNCTION_FAILED when initializing fails. + * @param pInitArgs [in] Optional CK_C_INITIALIZE_ARGS. The mutex callbacks + * must be all set or all NULL and pReserved must be + * NULL. NSS builds read the configdir from + * LibraryParameters. The callbacks are not used. + * @return CKR_ARGUMENTS_BAD when pInitArgs is not valid. + * CKR_FUNCTION_FAILED when initializing fails. * CKR_OK on success. */ CK_RV C_Initialize(CK_VOID_PTR pInitArgs) From efc177032ca616a11d17ffd27fd2140ee70325c2 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:43:24 -0700 Subject: [PATCH 048/104] F-10371 - Remove the wrong NULL pulCount return from C_GetMechanismList docs --- src/slot.c | 1 - 1 file changed, 1 deletion(-) diff --git a/src/slot.c b/src/slot.c index 6ed43989..3f4ecb58 100644 --- a/src/slot.c +++ b/src/slot.c @@ -518,7 +518,6 @@ static int mechanismCnt = ((int)(sizeof(mechanismList)/sizeof(*mechanismList))); * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SLOT_ID_INVALID when no slot with id can be found. * CKR_ARGUMENTS_BAD when pulCount is NULL. - * CKR_BUFFER_TOO_SMALL when pulCount is NULL. * CKR_BUFFER_TOO_SMALL when there are more mechanisms than entries in * array. * CKR_OK on success. From ea063a150a11db71acf842fdde436218c76d740a Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:49:41 -0700 Subject: [PATCH 049/104] F-10372 - Document CKR_PIN_LEN_RANGE for C_InitToken PIN length --- src/slot.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/slot.c b/src/slot.c index 3f4ecb58..c6b1da12 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1309,8 +1309,8 @@ CK_RV C_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type, * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SLOT_ID_INVALID when no slot with id can be found. * CKR_ARGUMENTS_BAD when pPin or pLabel is NULL. - * CKR_PIN_INCORRECT when length of PIN is not valid or PIN does not - * match initialized PIN. + * CKR_PIN_LEN_RANGE when length of PIN is not valid. + * CKR_PIN_INCORRECT when PIN does not match initialized PIN. * CKR_SESSION_EXISTS when a session is open on the token. * CKR_FUNCTION_FAILED when resetting token fails. * CKR_OK on success. From b000e3ab8a0dd09bec22c0993493831c61ae374b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:54:18 -0700 Subject: [PATCH 050/104] F-10373 - Document CKR_PIN_LEN_RANGE for C_InitPIN PIN length --- src/slot.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/slot.c b/src/slot.c index c6b1da12..a285b819 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1398,7 +1398,7 @@ CK_RV C_InitToken(CK_SLOT_ID slotID, CK_UTF8CHAR_PTR pPin, * CKR_SESSION_HANDLE_INVALID when session handle is not valid. * CKR_ARGUMENTS_BAD when pPin is NULL. * CKR_USER_NOT_LOGGED_IN when not logged in as Security Officer. - * CKR_PIN_INCORRECT when length of PIN is not valid. + * CKR_PIN_LEN_RANGE when length of PIN is not valid. * CKR_FUNCTION_FAILED when setting User PIN fails. * CKR_OK on success. */ From 30885170c6a30e2b69135638954136623d8da524 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:59:03 -0700 Subject: [PATCH 051/104] F-10374 - Document CKR_PIN_LEN_RANGE for the C_SetPIN new PIN length --- src/slot.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/slot.c b/src/slot.c index a285b819..55d9f3a7 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1468,8 +1468,9 @@ CK_RV C_InitPIN(CK_SESSION_HANDLE hSession, CK_UTF8CHAR_PTR pPin, * @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized. * CKR_SESSION_HANDLE_INVALID when session handle is not valid. * CKR_ARGUMENTS_BAD when pOldPin or pNewPin is NULL. - * CKR_PIN_INCORRECT when length of old or new PIN is not valid or - * old PIN does not verify. + * CKR_PIN_INCORRECT when length of old PIN is not valid or old PIN + * does not verify. + * CKR_PIN_LEN_RANGE when length of new PIN is not valid. * CKR_SESSION_READ_ONLY when session not read/write. * CKR_USER_PIN_NOT_INITIALIZED when no previous PIN set for user. * CKR_FUNCTION_FAILED when setting user PIN fails. From c825ec03a193768a12e3084f338b95950fa0a0e2 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 10:03:10 -0700 Subject: [PATCH 052/104] F-9413 - Correct the WP11_Slot_UserLogin return code docs --- src/internal.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index dddc786a..6a4e7af6 100644 --- a/src/internal.c +++ b/src/internal.c @@ -10335,7 +10335,8 @@ void WP11_Slot_ObjectCallLeave(WP11_ObjectCalls* calls) * @param slot [in] Slot object. * @param pin [in] PIN to use to login. * @param pinLen [in] Length of PIN. - * @return READ_ONLY_E when there is a read-only session open. + * @return LOGGED_IN_E when the user is already logged in. + * LOGGED_IN_ANOTHER_E when the SO is logged in. * PIN_NOT_SET_E when the token is not initialized. * PIN_INVALID_E when the PIN is not correct or changed during login. * MEMORY_E when dynamic memory allocation fails. From 8895ce1d16bf2932037e40dfef66fea34c06fc82 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:36:02 -0700 Subject: [PATCH 053/104] Require CKA_VALUE_LEN on ECB unwrap only when ambiguous --- src/crypto.c | 12 +-- tests/info_mech_table_test.c | 150 +++++++++++++++++++++++++++++++++++ 2 files changed, 157 insertions(+), 5 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index d3f7db62..19361469 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9201,23 +9201,25 @@ static CK_RV wp11_C_UnwrapKey(CK_SESSION_HANDLE hSession, if (rv != CKR_OK) goto err_out; - /* AES-ECB keeps no length: CKA_VALUE_LEN drops secret padding. */ + /* ECB zero pads; a 32 byte AES value may be a padded AES-192 key. */ if (pMechanism->mechanism == CKM_AES_ECB && keyClass == CKO_SECRET_KEY) { FindAttributeType(pTemplate, ulAttributeCount, CKA_VALUE_LEN, &attr); - if (attr == NULL) { + if (attr == NULL && (keyType != CKK_AES || + ulUnwrappedLen != AES_128_KEY_SIZE)) { rv = CKR_TEMPLATE_INCOMPLETE; goto err_out; } - if (attr->pValue == NULL || + if (attr != NULL && (attr->pValue == NULL || attr->ulValueLen != sizeof(CK_ULONG) || *(CK_ULONG*)attr->pValue == 0 || - *(CK_ULONG*)attr->pValue > ulUnwrappedLen) { + *(CK_ULONG*)attr->pValue > ulUnwrappedLen)) { rv = CKR_TEMPLATE_INCONSISTENT; goto err_out; } - ulUnwrappedLen = *(CK_ULONG*)attr->pValue; + if (attr != NULL) + ulUnwrappedLen = *(CK_ULONG*)attr->pValue; } break; diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c index 3eea94f6..d1c7505c 100644 --- a/tests/info_mech_table_test.c +++ b/tests/info_mech_table_test.c @@ -640,6 +640,154 @@ static void test_ecb_wrap_short_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) if (secret != CK_INVALID_HANDLE) funcList->C_DestroyObject(session, secret); } + +/* An AES-128 key unwraps under AES-ECB without CKA_VALUE_LEN, a two block + * value needs it since it may be a padded AES-192 key, and a CKA_VALUE_LEN + * that is zero or longer than the decrypted data is rejected. */ +static void test_ecb_unwrap_aes_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) +{ + CK_RV rv; + CK_MECHANISM_INFO info; + CK_MECHANISM mech = { CKM_AES_ECB, NULL, 0 }; + CK_OBJECT_HANDLE inner = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE unwrapped = CK_INVALID_HANDLE; + CK_KEY_TYPE aesType = CKK_AES; + CK_ULONG valueLen = 0; + CK_BYTE innerValue[16]; + CK_BYTE aes192Value[24]; + CK_BYTE aesValue[16]; + CK_BYTE wrapped[64]; + CK_BYTE value[32]; + CK_ULONG wrappedLen = sizeof(wrapped); + CK_ATTRIBUTE innerTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, innerValue, sizeof(innerValue) }, + }; + CK_ATTRIBUTE aesTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_WRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_UNWRAP, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, aesValue, sizeof(aesValue) }, + }; + CK_ATTRIBUTE unwrapTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE_LEN, &valueLen, sizeof(valueLen) }, + }; + CK_ULONG unwrapCnt = sizeof(unwrapTmpl) / sizeof(*unwrapTmpl); + CK_ATTRIBUTE valueAttr = { CKA_VALUE, value, sizeof(value) }; + + rv = funcList->C_GetMechanismInfo(slot, CKM_AES_ECB, &info); + if (rv != CKR_OK || (info.flags & CKF_WRAP) == 0) + return; + XMEMSET(innerValue, 0x6d, sizeof(innerValue)); + XMEMSET(aes192Value, 0x7b, sizeof(aes192Value)); + XMEMSET(aesValue, 0x2e, sizeof(aesValue)); + rv = funcList->C_CreateObject(session, innerTmpl, + sizeof(innerTmpl) / sizeof(*innerTmpl), &inner); + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, aesTmpl, + sizeof(aesTmpl) / sizeof(*aesTmpl), &aesKey); + } + CHECK_RV(rv, "create AES-128 key and AES wrapping key", CKR_OK); + if (rv == CKR_OK) { + rv = funcList->C_WrapKey(session, &mech, aesKey, inner, wrapped, + &wrappedLen); + CHECK_RV(rv, "C_WrapKey(AES-ECB) of an AES-128 key", CKR_OK); + CHECK_TRUE(rv != CKR_OK || wrappedLen == sizeof(innerValue), + "AES-ECB wrapped AES-128 key is one block"); + } + if (rv == CKR_OK) { + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, unwrapCnt - 1, + &unwrapped); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) of an AES key without CKA_VALUE_LEN", + CKR_OK); + } + if (rv == CKR_OK) { + rv = funcList->C_GetAttributeValue(session, unwrapped, &valueAttr, 1); + CHECK_TRUE(rv == CKR_OK && valueAttr.ulValueLen == sizeof(innerValue) + && XMEMCMP(value, innerValue, sizeof(innerValue)) == 0, + "AES-ECB unwrapped AES key keeps the full value"); + funcList->C_DestroyObject(session, unwrapped); + unwrapped = CK_INVALID_HANDLE; + } + if (rv == CKR_OK) { + valueLen = 0; + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, unwrapCnt, + &unwrapped); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) rejects a zero CKA_VALUE_LEN", + CKR_TEMPLATE_INCONSISTENT); + valueLen = wrappedLen + 1; + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, unwrapCnt, + &unwrapped); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) rejects an oversized CKA_VALUE_LEN", + CKR_TEMPLATE_INCONSISTENT); + valueLen = wrappedLen; + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, unwrapCnt, + &unwrapped); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) of an AES key with CKA_VALUE_LEN", + CKR_OK); + funcList->C_DestroyObject(session, unwrapped); + unwrapped = CK_INVALID_HANDLE; + } + if (rv == CKR_OK) { + funcList->C_DestroyObject(session, inner); + inner = CK_INVALID_HANDLE; + innerTmpl[5].pValue = aes192Value; + innerTmpl[5].ulValueLen = sizeof(aes192Value); + rv = funcList->C_CreateObject(session, innerTmpl, + sizeof(innerTmpl) / sizeof(*innerTmpl), &inner); + CHECK_RV(rv, "create AES-192 key", CKR_OK); + } + if (rv == CKR_OK) { + wrappedLen = sizeof(wrapped); + rv = funcList->C_WrapKey(session, &mech, aesKey, inner, wrapped, + &wrappedLen); + CHECK_RV(rv, "C_WrapKey(AES-ECB) pads an AES-192 key", CKR_OK); + CHECK_TRUE(rv != CKR_OK || wrappedLen == 32, + "AES-ECB wrapped AES-192 key is two blocks"); + } + if (rv == CKR_OK) { + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, unwrapCnt - 1, + &unwrapped); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) of two blocks needs CKA_VALUE_LEN", + CKR_TEMPLATE_INCOMPLETE); + valueLen = sizeof(aes192Value); + rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, + wrappedLen, unwrapTmpl, unwrapCnt, + &unwrapped); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) of an AES-192 key with CKA_VALUE_LEN", + CKR_OK); + } + if (rv == CKR_OK) { + valueAttr.ulValueLen = sizeof(value); + rv = funcList->C_GetAttributeValue(session, unwrapped, &valueAttr, 1); + CHECK_TRUE(rv == CKR_OK && valueAttr.ulValueLen == sizeof(aes192Value) + && XMEMCMP(value, aes192Value, sizeof(aes192Value)) == 0, + "AES-ECB unwrapped AES-192 key has its original value"); + } + if (unwrapped != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, unwrapped); + if (aesKey != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, aesKey); + if (inner != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, inner); +} #endif #if !defined(NO_RSA) && !defined(NO_AES) && !defined(WOLFPKCS11_NO_STORE) @@ -649,6 +797,7 @@ static void test_ecb_wrap_rsa_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) CK_RV rv; CK_MECHANISM_INFO info; CK_MECHANISM mech = { CKM_AES_ECB, NULL, 0 }; + CK_MECHANISM cbcMech = { CKM_AES_CBC_PAD, NULL, 0 }; CK_OBJECT_HANDLE rsaPriv = CK_INVALID_HANDLE; CK_OBJECT_HANDLE aesKey = CK_INVALID_HANDLE; CK_OBJECT_HANDLE unwrapped = CK_INVALID_HANDLE; @@ -766,6 +915,7 @@ static int run_test(void) test_wrap_flags(slotList[0], session); #ifndef NO_AES test_ecb_wrap_short_key(slotList[0], session); + test_ecb_unwrap_aes_key(slotList[0], session); #endif #if !defined(NO_RSA) && !defined(NO_AES) && !defined(WOLFPKCS11_NO_STORE) test_ecb_wrap_rsa_key(slotList[0], session); From 7a10138aaaf06899c4e2ac8b008cd0e4ee63e658 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:36:02 -0700 Subject: [PATCH 054/104] Return CKR_KEY_SIZE_RANGE for unaligned ECB wraps --- src/crypto.c | 5 +++ tests/info_mech_table_test.c | 67 +++++++++++++++++++++++++++++++----- 2 files changed, 64 insertions(+), 8 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 19361469..88a17bdf 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -8963,6 +8963,11 @@ static CK_RV wp11_C_WrapKey(CK_SESSION_HANDLE hSession, * leaves C_Encrypt's operation active, which would make the * caller's next C_WrapKey fail with CKR_OPERATION_ACTIVE. */ WP11_Session_AbortOp(session); + /* Only a block aligned key encoding can be ECB wrapped. */ + if (rv == CKR_DATA_LEN_RANGE && + pMechanism->mechanism == CKM_AES_ECB) { + rv = CKR_KEY_SIZE_RANGE; + } if (rv != CKR_OK) goto err_out; } diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c index d1c7505c..bf05f17d 100644 --- a/tests/info_mech_table_test.c +++ b/tests/info_mech_table_test.c @@ -790,8 +790,10 @@ static void test_ecb_unwrap_aes_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) } #endif -#if !defined(NO_RSA) && !defined(NO_AES) && !defined(WOLFPKCS11_NO_STORE) -/* An RSA key AES-ECB wraps must unwrap without CKA_VALUE_LEN. */ +#if !defined(NO_RSA) && !defined(NO_AES) && defined(HAVE_AES_CBC) && \ + !defined(WOLFPKCS11_NO_STORE) +/* AES-ECB refuses an RSA key whose encoding is not block aligned, and the + * zero padded encoding unwraps under AES-ECB without CKA_VALUE_LEN. */ static void test_ecb_wrap_rsa_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) { CK_RV rv; @@ -805,8 +807,14 @@ static void test_ecb_wrap_rsa_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) CK_KEY_TYPE rsaType = CKK_RSA; CK_KEY_TYPE aesType = CKK_AES; CK_BYTE aesValue[16]; + CK_BYTE iv[16]; CK_BYTE wrapped[2048]; + CK_BYTE encoded[2048]; + CK_BYTE modulus[sizeof(rsa_2048_modulus)]; CK_ULONG wrappedLen = sizeof(wrapped); + CK_ULONG encodedLen = sizeof(encoded); + CK_ULONG ecbLen = sizeof(encoded); + CK_ATTRIBUTE modAttr = { CKA_MODULUS, modulus, sizeof(modulus) }; CK_ATTRIBUTE rsaPrivTmpl[] = { { CKA_CLASS, &privClass, sizeof(privClass) }, { CKA_KEY_TYPE, &rsaType, sizeof(rsaType) }, @@ -842,6 +850,9 @@ static void test_ecb_wrap_rsa_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) if (rv != CKR_OK || (info.flags & CKF_WRAP) == 0) return; XMEMSET(aesValue, 0x4b, sizeof(aesValue)); + XMEMSET(iv, 0x1c, sizeof(iv)); + cbcMech.pParameter = iv; + cbcMech.ulParameterLen = sizeof(iv); rv = funcList->C_CreateObject(session, rsaPrivTmpl, sizeof(rsaPrivTmpl) / sizeof(*rsaPrivTmpl), &rsaPriv); if (rv == CKR_OK) { @@ -849,20 +860,59 @@ static void test_ecb_wrap_rsa_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) sizeof(aesTmpl) / sizeof(*aesTmpl), &aesKey); } CHECK_RV(rv, "create RSA private key and AES wrapping key", CKR_OK); + /* Recover the key encoding through AES-CBC-PAD; it is zero padded below. */ if (rv == CKR_OK) { - rv = funcList->C_WrapKey(session, &mech, aesKey, rsaPriv, wrapped, + rv = funcList->C_WrapKey(session, &cbcMech, aesKey, rsaPriv, wrapped, &wrappedLen); + if (rv == CKR_FUNCTION_FAILED) { + printf("Skipping AES-ECB RSA wrap: RSA key export unsupported\n"); + rv = CKR_GENERAL_ERROR; + } + else { + CHECK_RV(rv, "C_WrapKey(AES-CBC-PAD) of the RSA key", CKR_OK); + } + } + if (rv == CKR_OK) { + rv = funcList->C_WrapKey(session, &mech, aesKey, rsaPriv, encoded, + &ecbLen); + CHECK_RV(rv, "C_WrapKey(AES-ECB) refuses an unaligned RSA key", + CKR_KEY_SIZE_RANGE); + rv = (rv == CKR_KEY_SIZE_RANGE) ? CKR_OK : CKR_GENERAL_ERROR; + } + if (rv == CKR_OK) { + rv = funcList->C_DecryptInit(session, &cbcMech, aesKey); + if (rv == CKR_OK) { + rv = funcList->C_Decrypt(session, wrapped, wrappedLen, encoded, + &encodedLen); + } + CHECK_RV(rv, "C_Decrypt(AES-CBC-PAD) of the wrapped RSA key", CKR_OK); + CHECK_TRUE(rv != CKR_OK || (encodedLen % 16) != 0, + "RSA key encoding is not block aligned"); + } + if (rv == CKR_OK) { + XMEMSET(encoded + encodedLen, 0, 16 - (encodedLen % 16)); + encodedLen += 16 - (encodedLen % 16); + wrappedLen = sizeof(wrapped); + rv = funcList->C_EncryptInit(session, &mech, aesKey); + if (rv == CKR_OK) { + rv = funcList->C_Encrypt(session, encoded, encodedLen, wrapped, + &wrappedLen); + } + CHECK_RV(rv, "C_Encrypt(AES-ECB) of the padded RSA key", CKR_OK); } if (rv == CKR_OK) { rv = funcList->C_UnwrapKey(session, &mech, aesKey, wrapped, wrappedLen, unwrapTmpl, sizeof(unwrapTmpl) / sizeof(*unwrapTmpl), &unwrapped); - CHECK_RV(rv, "C_UnwrapKey(AES-ECB) of the RSA key it wrapped", CKR_OK); + CHECK_RV(rv, "C_UnwrapKey(AES-ECB) of an RSA key without CKA_VALUE_LEN", + CKR_OK); } - else { - CHECK_TRUE(rsaPriv != CK_INVALID_HANDLE && aesKey != CK_INVALID_HANDLE, - "C_WrapKey(AES-ECB) refuses an unaligned RSA key"); + if (rv == CKR_OK) { + rv = funcList->C_GetAttributeValue(session, unwrapped, &modAttr, 1); + CHECK_TRUE(rv == CKR_OK && modAttr.ulValueLen == sizeof(modulus) && + XMEMCMP(modulus, rsa_2048_modulus, sizeof(modulus)) == 0, + "AES-ECB unwrapped RSA key has the original modulus"); } if (unwrapped != CK_INVALID_HANDLE) funcList->C_DestroyObject(session, unwrapped); @@ -917,7 +967,8 @@ static int run_test(void) test_ecb_wrap_short_key(slotList[0], session); test_ecb_unwrap_aes_key(slotList[0], session); #endif -#if !defined(NO_RSA) && !defined(NO_AES) && !defined(WOLFPKCS11_NO_STORE) +#if !defined(NO_RSA) && !defined(NO_AES) && defined(HAVE_AES_CBC) && \ + !defined(WOLFPKCS11_NO_STORE) test_ecb_wrap_rsa_key(slotList[0], session); #endif funcList->C_CloseSession(session); From 5d086abb2654741acf80954622c7d687934b7add Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 14 Oct 2026 08:42:16 -0700 Subject: [PATCH 055/104] Refuse an unaligned AES-ECB wrap before encrypting --- src/crypto.c | 11 ++++++----- tests/info_mech_table_test.c | 5 +++++ 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 88a17bdf..1b9c22ad 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -8933,6 +8933,12 @@ static CK_RV wp11_C_WrapKey(CK_SESSION_HANDLE hSession, serialBuff = padBuff; serialSize = padSize; } + /* Only a block aligned key encoding can be ECB wrapped. */ + if (pMechanism->mechanism == CKM_AES_ECB && + (serialSize % AES_BLOCK_SIZE) != 0) { + rv = CKR_KEY_SIZE_RANGE; + goto err_out; + } #ifdef WOLFSSL_STM32U5_DHUK if (WP11_Object_GetDevId(wrappingKey) == @@ -8963,11 +8969,6 @@ static CK_RV wp11_C_WrapKey(CK_SESSION_HANDLE hSession, * leaves C_Encrypt's operation active, which would make the * caller's next C_WrapKey fail with CKR_OPERATION_ACTIVE. */ WP11_Session_AbortOp(session); - /* Only a block aligned key encoding can be ECB wrapped. */ - if (rv == CKR_DATA_LEN_RANGE && - pMechanism->mechanism == CKM_AES_ECB) { - rv = CKR_KEY_SIZE_RANGE; - } if (rv != CKR_OK) goto err_out; } diff --git a/tests/info_mech_table_test.c b/tests/info_mech_table_test.c index bf05f17d..9a44cda3 100644 --- a/tests/info_mech_table_test.c +++ b/tests/info_mech_table_test.c @@ -877,6 +877,11 @@ static void test_ecb_wrap_rsa_key(CK_SLOT_ID slot, CK_SESSION_HANDLE session) &ecbLen); CHECK_RV(rv, "C_WrapKey(AES-ECB) refuses an unaligned RSA key", CKR_KEY_SIZE_RANGE); + ecbLen = 0; + rv = funcList->C_WrapKey(session, &mech, aesKey, rsaPriv, NULL, + &ecbLen); + CHECK_RV(rv, "C_WrapKey(AES-ECB) length query refuses it too", + CKR_KEY_SIZE_RANGE); rv = (rv == CKR_KEY_SIZE_RANGE) ? CKR_OK : CKR_GENERAL_ERROR; } if (rv == CKR_OK) { From 61ac0c82174db9f46213c461a021abee41a60dc8 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 14 Oct 2026 08:42:16 -0700 Subject: [PATCH 056/104] Add an AES-ECB unit test build --- .github/workflows/unit-test.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml index bdafcab8..668ec374 100644 --- a/.github/workflows/unit-test.yml +++ b/.github/workflows/unit-test.yml @@ -16,6 +16,11 @@ jobs: with: config: --enable-singlethreaded + aesecb: + uses: ./.github/workflows/build-workflow.yml + with: + config: --enable-aesecb + tpm: uses: ./.github/workflows/build-workflow.yml with: From 707181a1b39e471e4a88c536a9c324aa13c0bb5c Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 09:34:10 -0700 Subject: [PATCH 057/104] F-10378 - Fix file store path lookup build with WOLFPKCS11_NO_ENV --- .github/workflows/unit-test.yml | 5 +++++ src/internal.c | 6 ++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml index 668ec374..450197a9 100644 --- a/.github/workflows/unit-test.yml +++ b/.github/workflows/unit-test.yml @@ -61,6 +61,11 @@ jobs: uses: ./.github/workflows/build-workflow.yml with: config: CFLAGS="-DWOLFPKCS11_NO_STORE" + no_env: + uses: ./.github/workflows/build-workflow.yml + with: + config: C_EXTRA_FLAGS="-DWOLFPKCS11_NO_ENV -DWOLFPKCS11_DEFAULT_TOKEN_PATH=./store/default" + check: mkdir -p store && ./tests/pkcs11test no_aesgcm: uses: ./.github/workflows/build-workflow.yml with: diff --git a/src/internal.c b/src/internal.c index 6a4e7af6..7491ad16 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1576,14 +1576,14 @@ static int wolfPKCS11_Store_Name(int type, CK_ULONG id1, CK_ULONG id2, char* nam int nameLen) { int ret = 0; -#ifndef WOLFPKCS11_NO_ENV const char* str = NULL; -#endif /* Reserve enough space in the final filename for suffixes such as * "/wp11_rsakey_priv_%016lx_%016lx" (47 chars worst-case). */ enum { WP11_STORE_SUFFIX_RESERVE = 48 }; +#ifndef WOLFPKCS11_NO_ENV char homePath[256]; +#endif #ifdef WP11_HAVE_STORE_DIR_LOCK char storeDirCopy[WP11_STORE_MAX_PATH]; #endif @@ -1631,6 +1631,7 @@ static int wolfPKCS11_Store_Name(int type, CK_ULONG id1, CK_ULONG id2, char* nam } #endif +#ifndef WOLFPKCS11_NO_ENV if (str == NULL) { const char* homeDir = NULL; @@ -1654,6 +1655,7 @@ static int wolfPKCS11_Store_Name(int type, CK_ULONG id1, CK_ULONG id2, char* nam } #endif } +#endif /* 47 is maximum number of character to a filename and path separator. */ if (str == NULL) { From 0b29427b133e099d5345f842059e3fa44911d696 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:23:17 -0700 Subject: [PATCH 058/104] F-10379 - Keep token object count intact when an object store fails --- src/crypto.c | 2 + src/internal.c | 11 +- tests/include.am | 6 + tests/token_store_test.c | 309 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 322 insertions(+), 6 deletions(-) create mode 100644 tests/token_store_test.c diff --git a/src/crypto.c b/src/crypto.c index 1b9c22ad..873157aa 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9988,6 +9988,8 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, if (ret == 0) { rv = AddObject(session, obj, pTemplate, ulAttributeCount, phKey); + if (rv != CKR_OK) + WP11_Object_Free(obj); } } else { diff --git a/src/internal.c b/src/internal.c index 7491ad16..69c7aabd 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8852,12 +8852,6 @@ static int wp11_Token_StorePass(WP11_Token* token, int tokenId) #ifdef DEBUG_WOLFPKCS11 printf("Failed to store object %d, token %d, ret: %d\n", i, tokenId, ret); - #endif - token->objCnt = i; /* mark number of objects actually stored */ - #ifdef WOLFPKCS11_TPM_STORE - if ((ret & RC_MAX_FM0) == TPM_RC_NV_SPACE) { - ret = 0; /* allow this error and continue */ - } #endif break; } @@ -12357,6 +12351,11 @@ int WP11_Session_AddObject(WP11_Session* session, int onToken, object->handle = CK_INVALID_HANDLE; object->next = NULL; object->lock = NULL; + #ifdef WOLFPKCS11_TPM_STORE + /* Best effort: the failed store may have recreated the token + * NV index empty. The original error is returned. */ + (void)wp11_Slot_Store(session->slot, (int)session->slotId); + #endif } } #endif diff --git a/tests/include.am b/tests/include.am index cb413712..1273180f 100644 --- a/tests/include.am +++ b/tests/include.am @@ -264,6 +264,10 @@ check_PROGRAMS += tests/token_reset_fail_test noinst_PROGRAMS += tests/token_reset_fail_test tests_token_reset_fail_test_SOURCES = tests/token_reset_fail_test.c tests_token_reset_fail_test_LDADD = +check_PROGRAMS += tests/token_store_test +noinst_PROGRAMS += tests/token_store_test +tests_token_store_test_SOURCES = tests/token_store_test.c +tests_token_store_test_LDADD = check_PROGRAMS += tests/nss_email_store_test noinst_PROGRAMS += tests/nss_email_store_test @@ -395,6 +399,7 @@ tests_hbs_persistence_test_LDADD += src/libwolfpkcs11.la tests_hkdf_persistence_test_LDADD += src/libwolfpkcs11.la tests_unique_id_test_LDADD += src/libwolfpkcs11.la tests_token_reset_fail_test_LDADD += src/libwolfpkcs11.la +tests_token_store_test_LDADD += src/libwolfpkcs11.la tests_nss_email_store_test_LDADD += src/libwolfpkcs11.la tests_generate_key_class_test_LDADD += src/libwolfpkcs11.la tests_generate_keypair_class_test_LDADD += src/libwolfpkcs11.la @@ -456,6 +461,7 @@ tests_hbs_persistence_test_LDADD += src/libwolfpkcs11.la tests_hkdf_persistence_test_LDADD += src/libwolfpkcs11.la tests_unique_id_test_LDADD += src/libwolfpkcs11.la tests_token_reset_fail_test_LDADD += src/libwolfpkcs11.la +tests_token_store_test_LDADD += src/libwolfpkcs11.la tests_nss_email_store_test_LDADD += src/libwolfpkcs11.la tests_generate_key_class_test_LDADD += src/libwolfpkcs11.la tests_generate_keypair_class_test_LDADD += src/libwolfpkcs11.la diff --git a/tests/token_store_test.c b/tests/token_store_test.c new file mode 100644 index 00000000..f6d005dd --- /dev/null +++ b/tests/token_store_test.c @@ -0,0 +1,309 @@ +/* token_store_test.c + * + * Copyright (C) 2006-2026 wolfSSL Inc. + * + * This file is part of wolfPKCS11. + * + * wolfPKCS11 is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfPKCS11 is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA + * + * Token persistence must stay consistent with the in-memory token: every + * token object is persisted and reloaded, and a failure to persist token + * state is reported to the caller instead of being reported as success. + */ + +#ifdef HAVE_CONFIG_H + #include +#endif + +#include +#include +#include + +#ifndef WOLFSSL_USER_SETTINGS + #include +#endif +#include +#include + +#ifndef WOLFPKCS11_USER_SETTINGS + #include +#endif +#include + +#ifndef HAVE_PKCS11_STATIC +#include +#endif + +#include "testdata.h" +#include "pkcs11_test_util.h" + +#if !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_TPM_STORE) && \ + !defined(WOLFPKCS11_CUSTOM_STORE) && !defined(WOLFPKCS11_NO_ENV) && \ + !defined(WOLFPKCS11_USER_ENV) && !defined(_WIN32) + +#include +#include +#include + +#define TEST_DIR "./store/token_store_test" + +static const char* soPin = "password123456"; +static const char* userPin = "wolfpkcs11-test"; +static const char tokenLabel[] = "token-store-test"; +static CK_OBJECT_CLASS secretClass = CKO_SECRET_KEY; +static CK_KEY_TYPE genericType = CKK_GENERIC_SECRET; +static CK_BBOOL ckTrue = CK_TRUE; +static CK_BBOOL ckFalse = CK_FALSE; +static byte keyData[16] = { 0 }; + +static void clear_store_dir(void) +{ + DIR* dir; + struct dirent* ent; + char path[512]; + + (void)mkdir("./store", 0700); + (void)chmod(TEST_DIR, 0700); + dir = opendir(TEST_DIR); + if (dir == NULL) { + (void)mkdir(TEST_DIR, 0700); + return; + } + while ((ent = readdir(dir)) != NULL) { + if (strcmp(ent->d_name, ".") == 0 || strcmp(ent->d_name, "..") == 0) + continue; + snprintf(path, sizeof(path), "%s/%s", TEST_DIR, ent->d_name); + if (remove(path) != 0) + (void)rmdir(path); + } + closedir(dir); +} + +static CK_RV lib_init(void) +{ + CK_C_INITIALIZE_ARGS args; + + XMEMSET(&args, 0, sizeof(args)); + args.flags = CKF_OS_LOCKING_OK; + return funcList->C_Initialize(&args); +} + +static CK_RV first_slot(CK_SLOT_ID* slot) +{ + CK_RV rv; + CK_SLOT_ID slotList[16]; + CK_ULONG slotCount = sizeof(slotList) / sizeof(slotList[0]); + + rv = funcList->C_GetSlotList(CK_TRUE, slotList, &slotCount); + if (rv == CKR_OK && slotCount == 0) + rv = CKR_TOKEN_NOT_PRESENT; + if (rv == CKR_OK) + *slot = slotList[0]; + return rv; +} + +/* Initialize the library and provision a fresh token with a user PIN. */ +static CK_RV token_setup(CK_SLOT_ID* slot) +{ + CK_RV rv; + CK_SESSION_HANDLE soSession = CK_INVALID_HANDLE; + unsigned char label[32]; + + clear_store_dir(); + rv = lib_init(); + if (rv == CKR_OK) + rv = first_slot(slot); + if (rv == CKR_OK) { + XMEMSET(label, ' ', sizeof(label)); + XMEMCPY(label, tokenLabel, XSTRLEN(tokenLabel)); + rv = funcList->C_InitToken(*slot, (CK_UTF8CHAR_PTR)soPin, + (CK_ULONG)XSTRLEN(soPin), label); + } + if (rv == CKR_OK) { + rv = funcList->C_OpenSession(*slot, + CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &soSession); + } + if (rv == CKR_OK) { + rv = funcList->C_Login(soSession, CKU_SO, (CK_UTF8CHAR_PTR)soPin, + (CK_ULONG)XSTRLEN(soPin)); + } + if (rv == CKR_OK) { + rv = funcList->C_InitPIN(soSession, (CK_UTF8CHAR_PTR)userPin, + (CK_ULONG)XSTRLEN(userPin)); + } + if (soSession != CK_INVALID_HANDLE) { + funcList->C_Logout(soSession); + funcList->C_CloseSession(soSession); + } + return rv; +} + +static CK_RV user_session(CK_SLOT_ID slot, CK_SESSION_HANDLE* session) +{ + CK_RV rv; + + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, session); + if (rv == CKR_OK) { + rv = funcList->C_Login(*session, CKU_USER, (CK_UTF8CHAR_PTR)userPin, + (CK_ULONG)XSTRLEN(userPin)); + } + return rv; +} + +static void close_session(CK_SESSION_HANDLE session) +{ + if (session != CK_INVALID_HANDLE) { + funcList->C_Logout(session); + funcList->C_CloseSession(session); + } +} + +static CK_RV create_token_secret(CK_SESSION_HANDLE session, const char* label, + CK_OBJECT_HANDLE* obj) +{ + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_VALUE, keyData, sizeof(keyData) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_LABEL, NULL, 0 }, + }; + + tmpl[5].pValue = (CK_VOID_PTR)label; + tmpl[5].ulValueLen = (CK_ULONG)XSTRLEN(label); + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), obj); +} + +static CK_ULONG count_label(CK_SESSION_HANDLE session, const char* label) +{ + CK_RV rv; + CK_OBJECT_HANDLE found[8]; + CK_ULONG foundCnt = 0; + CK_ATTRIBUTE tmpl[] = { + { CKA_LABEL, NULL, 0 }, + }; + + tmpl[0].pValue = (CK_VOID_PTR)label; + tmpl[0].ulValueLen = (CK_ULONG)XSTRLEN(label); + rv = funcList->C_FindObjectsInit(session, tmpl, 1); + if (rv == CKR_OK) { + rv = funcList->C_FindObjects(session, found, 8, &foundCnt); + funcList->C_FindObjectsFinal(session); + } + return (rv == CKR_OK) ? foundCnt : 0; +} + +/* Reload the token from storage and open a user session on it. */ +static CK_RV reload(CK_SLOT_ID slot, CK_SESSION_HANDLE* session) +{ + CK_RV rv; + + funcList->C_Finalize(NULL); + rv = lib_init(); + if (rv == CKR_OK) + rv = user_session(slot, session); + return rv; +} + +/* Token objects keep being persisted after storage is paused and resumed. */ +static void test_objects_persist_across_storage_pause(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + + printf("\n--- token objects persist across a storage pause ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "pause-first", &obj); + CHECK_RV(rv, "create first token object", CKR_OK); + } + if (rv == CKR_OK) { + XSETENV("WOLFPKCS11_NO_STORE", "1", 1); + rv = create_token_secret(session, "pause-second", &obj); + unsetenv("WOLFPKCS11_NO_STORE"); + CHECK_RV(rv, "create token object while storage is paused", CKR_OK); + } + if (rv == CKR_OK) { + rv = create_token_secret(session, "pause-third", &obj); + CHECK_RV(rv, "create token object after storage resumes", CKR_OK); + } + close_session(session); + session = CK_INVALID_HANDLE; + + if (rv == CKR_OK) { + rv = reload(slot, &session); + CHECK_RV(rv, "reload token", CKR_OK); + } + if (rv == CKR_OK) { + CHECK_TRUE(count_label(session, "pause-first") == 1, + "object stored before the pause is reloaded"); + CHECK_TRUE(count_label(session, "pause-second") == 1, + "object created during the pause is reloaded"); + CHECK_TRUE(count_label(session, "pause-third") == 1, + "object created after the pause is reloaded"); + } + close_session(session); + funcList->C_Finalize(NULL); +} + +static int run_tests(void) +{ + CK_RV rv; + + rv = pkcs11_load(); + CHECK_RV(rv, "load library", CKR_OK); + if (rv != CKR_OK) + return -1; + + test_objects_persist_across_storage_pause(); + + clear_store_dir(); + pkcs11_unload(); + return 0; +} + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + + XSETENV("WOLFPKCS11_TOKEN_PATH", TEST_DIR, 1); + unsetenv("WOLFPKCS11_NO_STORE"); + + printf("=== wolfPKCS11 token store test ===\n"); + run_tests(); + return pkcs11_test_summary(); +} + +#else + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + printf("Token store test requires the file-backed store, skipping\n"); + return 77; +} + +#endif From 3a1a71ee184dbf7705b8e7440ab7c54a2631cfca Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:21:42 -0700 Subject: [PATCH 059/104] F-10386 - Report token store commit failures to the caller --- src/internal.c | 101 +++++++++++++++------- tests/token_store_test.c | 179 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 251 insertions(+), 29 deletions(-) diff --git a/src/internal.c b/src/internal.c index 69c7aabd..53e53985 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2563,10 +2563,14 @@ int wolfPKCS11_Store_Open(int type, CK_ULONG id1, CK_ULONG id2, int read, * Closes access to location being read or written. * Any dynamic memory associated with the store is freed here. * - * @param [in] store Context for operation. + * @param [in] store Context for operation. + * @param [in] commit 1 to commit written data and 0 to discard it. + * @return 0 on success. + * @return Other value when written data could not be committed. */ -void wolfPKCS11_Store_Close(void* store) +static int wolfPKCS11_Store_CloseCommit(void* store, int commit) { + int ret = 0; #ifdef WOLFPKCS11_TPM_STORE WP11_TpmStore* tpmStore = (WP11_TpmStore*)store; #else @@ -2580,27 +2584,32 @@ void wolfPKCS11_Store_Close(void* store) #ifdef WOLFPKCS11_TPM_STORE /* nothing to do for TPM */ (void)tpmStore; + (void)commit; #else if (ctx != NULL) { int commitRet = 0; if (ctx->file != XBADFILE && ctx->file != NULL) { - if (ctx->is_write && wolfPKCS11_StoreSyncFile(ctx->file) != 0) - commitRet = BUFFER_E; - if (XFCLOSE(ctx->file) != 0 && ctx->is_write) - commitRet = BUFFER_E; + if (ctx->is_write && commit && + wolfPKCS11_StoreSyncFile(ctx->file) != 0) { + commit = 0; + ret = BUFFER_E; + } + if (XFCLOSE(ctx->file) != 0 && ctx->is_write) { + commit = 0; + ret = BUFFER_E; + } ctx->file = XBADFILE; } - if (ctx->is_write && ctx->has_temp) { - if (commitRet == 0) { - #ifdef WP11_STORE_BATCH - if (storeBatch.active) - commitRet = wolfPKCS11_StoreStageTemp(ctx); - else - #endif - commitRet = wolfPKCS11_StoreCommitTemp(ctx); - } + if (ctx->is_write && ctx->has_temp && commit) { + #ifdef WP11_STORE_BATCH + if (storeBatch.active) + commitRet = wolfPKCS11_StoreStageTemp(ctx); + else + #endif + commitRet = wolfPKCS11_StoreCommitTemp(ctx); + ret = commitRet; if (commitRet != 0) { #ifdef WP11_STORE_BATCH if (storeBatch.active) @@ -2621,6 +2630,18 @@ void wolfPKCS11_Store_Close(void* store) XFREE(ctx, NULL, DYNAMIC_TYPE_TMP_BUFFER); } #endif + return ret; +} + +/** + * Closes access to location being read or written. + * Any dynamic memory associated with the store is freed here. + * + * @param [in] store Context for operation. + */ +void wolfPKCS11_Store_Close(void* store) +{ + (void)wolfPKCS11_Store_CloseCommit(store, 1); } /** @@ -2805,6 +2826,28 @@ static void wp11_storage_close(void* storage) wolfPKCS11_Store_Close(storage); } +/* + * Closes access to location being written, committing the data only when + * writing succeeded. + * + * @param [in] storage Context for operation. + * @param [in] ret Result of writing the data. + * @return ret when writing failed. + * @return Result of committing the data otherwise. + */ +static int wp11_storage_close_write(void* storage, int ret) +{ +#ifdef WOLFPKCS11_CUSTOM_STORE + wolfPKCS11_Store_Close(storage); +#else + int closeRet = wolfPKCS11_Store_CloseCommit(storage, ret == 0); + + if (ret == 0) + ret = closeRet; +#endif + return ret; +} + /** * Get the number of bytes left to read, when the store can tell. * @@ -4771,7 +4814,7 @@ static int wp11_Object_Store_Cert(WP11_Object* object, int tokenId, int objId) /* Write cert to storage. */ ret = wp11_storage_write_array(storage, object->data.cert.data, object->data.cert.len); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } #ifdef WOLFSSL_MAXQ10XX_CRYPTO @@ -4810,7 +4853,7 @@ static int wp11_Object_Store_Trust(WP11_Object* object, int tokenId, int objId) /* Write trust to storage. */ ret = wp11_storage_write_array(storage, (unsigned char*)&object->data.trust, sizeof(WP11_Trust)); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; @@ -5039,7 +5082,7 @@ static int wp11_Object_Store_Data(WP11_Object* object, int tokenId, int objId) object->data.genericData.objectIdLen); } - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); return ret; } @@ -5388,7 +5431,7 @@ static int wp11_Object_Store_RsaKey(WP11_Object* object, int tokenId, int objId) ret = wp11_storage_write_array(storage, object->keyData, object->keyDataLen); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; @@ -5613,7 +5656,7 @@ static int wp11_Object_Store_EccKey(WP11_Object* object, int tokenId, int objId) ret = wp11_storage_write_array(storage, object->keyData, object->keyDataLen); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; @@ -5858,7 +5901,7 @@ static int wp11_Object_Store_MldsaKey(WP11_Object* object, int tokenId, ret = wp11_storage_write_array(storage, object->keyData, object->keyDataLen); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; @@ -6201,7 +6244,7 @@ static int wp11_Object_Store_DhKey(WP11_Object* object, int tokenId, int objId) ret = wp11_storage_write_array(storage, der, len); } - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } if (der != NULL) { XFREE(der, NULL, DYNAMIC_TYPE_TMP_BUFFER); @@ -6422,7 +6465,7 @@ static int wp11_Object_Store_MlKemKey(WP11_Object* object, int tokenId, if (ret == 0) { ret = wp11_storage_write_array(storage, object->keyData, object->keyDataLen); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; @@ -6598,7 +6641,7 @@ static int wp11_Object_Store_HssKey(WP11_Object* object, int tokenId, int objId) if (ret == 0) { ret = wp11_storage_write_array(storage, object->keyData, object->keyDataLen); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; } @@ -7038,7 +7081,7 @@ static int wp11_Object_Store_XmssKey(WP11_Object* object, int tokenId, if (ret == 0) { ret = wp11_storage_write_array(storage, object->keyData, object->keyDataLen); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; } @@ -7364,7 +7407,7 @@ static int wp11_Object_Store_SymmKey(WP11_Object* object, int tokenId, ret = wp11_storage_write_array(storage, object->keyData, object->keyDataLen); - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; @@ -7667,7 +7710,7 @@ static int wp11_Object_Store_Object(WP11_Object* object, int tokenId, int objId) } #endif - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } return ret; } @@ -8839,7 +8882,7 @@ static int wp11_Token_StorePass(WP11_Token* token, int tokenId) ret = wp11_storage_open(WOLFPKCS11_STORE_TOKEN, tokenId, 0, variableSz, &storage); if (ret == 0) { - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); storage = NULL; } @@ -8939,7 +8982,7 @@ static int wp11_Token_StorePass(WP11_Token* token, int tokenId) ret = wp11_storage_write_int(storage, token->nextObjId); } - wp11_storage_close(storage); + ret = wp11_storage_close_write(storage, ret); } else if (ret == NOT_AVAILABLE_E) { /* Not writing. */ diff --git a/tests/token_store_test.c b/tests/token_store_test.c index f6d005dd..48a37c5e 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -209,6 +209,14 @@ static CK_ULONG count_label(CK_SESSION_HANDLE session, const char* label) return (rv == CKR_OK) ? foundCnt : 0; } +/* Path of the stored record of a token object. */ +static void object_record_path(CK_SLOT_ID slot, int objId, char* path, + size_t pathSz) +{ + snprintf(path, pathSz, "%s/wp11_obj_%016lx_%016lx", TEST_DIR, + (unsigned long)slot, (unsigned long)objId); +} + /* Reload the token from storage and open a user session on it. */ static CK_RV reload(CK_SLOT_ID slot, CK_SESSION_HANDLE* session) { @@ -267,6 +275,173 @@ static void test_objects_persist_across_storage_pause(void) funcList->C_Finalize(NULL); } +/* A token object whose record cannot be committed is not reported created. */ +static void test_create_reports_commit_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + char path[512]; + int blocked = 0; + + printf("\n--- token object creation reports a commit failure ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "commit-first", &obj); + CHECK_RV(rv, "create first token object", CKR_OK); + } + if (rv == CKR_OK) { + object_record_path(slot, 1, path, sizeof(path)); + blocked = (mkdir(path, 0700) == 0); + CHECK_TRUE(blocked, "occupy the next object record path"); + } + if (blocked) { + rv = create_token_secret(session, "commit-second", &obj); + CHECK_TRUE(rv != CKR_OK, + "create fails when the object cannot be committed"); + CHECK_TRUE(count_label(session, "commit-second") == 0, + "uncommitted object is not in the token"); + CHECK_TRUE(count_label(session, "commit-first") == 1, + "committed object is still in the token"); + (void)rmdir(path); + } + close_session(session); + funcList->C_Finalize(NULL); +} + +/* A PIN change that cannot be stored leaves the stored PIN in effect. */ +static void test_pin_change_store_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + static const char* newPin = "wolfpkcs11-next"; + + if (geteuid() == 0) { + printf("\nSkipping PIN store failure test when run as root\n"); + return; + } + printf("\n--- PIN change that cannot be stored is not applied ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK && chmod(TEST_DIR, 0500) == 0) { + rv = funcList->C_SetPIN(session, (CK_UTF8CHAR_PTR)userPin, + (CK_ULONG)XSTRLEN(userPin), + (CK_UTF8CHAR_PTR)newPin, + (CK_ULONG)XSTRLEN(newPin)); + (void)chmod(TEST_DIR, 0700); + CHECK_TRUE(rv != CKR_OK, "PIN change reports the store failure"); + funcList->C_Logout(session); + rv = funcList->C_Login(session, CKU_USER, (CK_UTF8CHAR_PTR)userPin, + (CK_ULONG)XSTRLEN(userPin)); + CHECK_RV(rv, "stored PIN still logs in", CKR_OK); + } + close_session(session); + funcList->C_Finalize(NULL); +} + +/* A first user PIN that cannot be stored does not log in. */ +static void test_init_pin_store_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE soSession = CK_INVALID_HANDLE; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + unsigned char label[32]; + + if (geteuid() == 0) { + printf("\nSkipping user PIN store failure test when run as root\n"); + return; + } + printf("\n--- user PIN that cannot be stored is not applied ---\n"); + clear_store_dir(); + rv = lib_init(); + if (rv == CKR_OK) + rv = first_slot(&slot); + if (rv == CKR_OK) { + XMEMSET(label, ' ', sizeof(label)); + XMEMCPY(label, tokenLabel, XSTRLEN(tokenLabel)); + rv = funcList->C_InitToken(slot, (CK_UTF8CHAR_PTR)soPin, + (CK_ULONG)XSTRLEN(soPin), label); + } + if (rv == CKR_OK) { + rv = funcList->C_OpenSession(slot, + CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &soSession); + } + if (rv == CKR_OK) { + rv = funcList->C_Login(soSession, CKU_SO, (CK_UTF8CHAR_PTR)soPin, + (CK_ULONG)XSTRLEN(soPin)); + } + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK && chmod(TEST_DIR, 0500) == 0) { + rv = funcList->C_InitPIN(soSession, (CK_UTF8CHAR_PTR)userPin, + (CK_ULONG)XSTRLEN(userPin)); + (void)chmod(TEST_DIR, 0700); + CHECK_TRUE(rv != CKR_OK, "user PIN set reports the store failure"); + close_session(soSession); + soSession = CK_INVALID_HANDLE; + rv = user_session(slot, &session); + CHECK_TRUE(rv != CKR_OK, "unstored user PIN does not log in"); + } + close_session(soSession); + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} + +/* A token reset that cannot be stored leaves the stored token in effect. */ +static void test_token_reset_store_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + unsigned char label[32]; + static const char* wrongPin = "not-the-so-pin"; + + if (geteuid() == 0) { + printf("\nSkipping token reset store failure test when run as root\n"); + return; + } + printf("\n--- token reset that cannot be stored is not applied ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "reset-keep", &obj); + CHECK_RV(rv, "create token object", CKR_OK); + } + close_session(session); + session = CK_INVALID_HANDLE; + XMEMSET(label, ' ', sizeof(label)); + XMEMCPY(label, tokenLabel, XSTRLEN(tokenLabel)); + if (rv == CKR_OK && chmod(TEST_DIR, 0500) == 0) { + rv = funcList->C_InitToken(slot, (CK_UTF8CHAR_PTR)soPin, + (CK_ULONG)XSTRLEN(soPin), label); + (void)chmod(TEST_DIR, 0700); + CHECK_TRUE(rv != CKR_OK, "token reset reports the store failure"); + rv = funcList->C_InitToken(slot, (CK_UTF8CHAR_PTR)wrongPin, + (CK_ULONG)XSTRLEN(wrongPin), label); + CHECK_TRUE(rv != CKR_OK, "token reset still requires the SO PIN"); + rv = user_session(slot, &session); + CHECK_RV(rv, "stored user PIN still logs in", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(count_label(session, "reset-keep") == 1, + "stored token object is still present"); + } + } + close_session(session); + funcList->C_Finalize(NULL); +} + static int run_tests(void) { CK_RV rv; @@ -277,6 +452,10 @@ static int run_tests(void) return -1; test_objects_persist_across_storage_pause(); + test_create_reports_commit_failure(); + test_pin_change_store_failure(); + test_init_pin_store_failure(); + test_token_reset_store_failure(); clear_store_dir(); pkcs11_unload(); From 9852432914d32ceb5ba9dc692b473faaaaeb09c6 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:29:54 -0700 Subject: [PATCH 060/104] F-10384 - Keep the stored token record until the new one is committed --- src/internal.c | 6 ++-- tests/token_store_test.c | 62 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 2 deletions(-) diff --git a/src/internal.c b/src/internal.c index 53e53985..33c666fb 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8866,7 +8866,7 @@ static int wp11_Token_Load(WP11_Slot* slot, int tokenId, WP11_Token* token) */ static int wp11_Token_StorePass(WP11_Token* token, int tokenId) { - int ret; + int ret = 0; int i; void* storage = NULL; WP11_Object* object; @@ -8876,7 +8876,8 @@ static int wp11_Token_StorePass(WP11_Token* token, int tokenId) printf("wp11_Token_Store: tokenId %d, objCnt %d\n", tokenId, token->objCnt); #endif - /* Reserve space for token object */ +#ifdef WOLFPKCS11_TPM_STORE + /* Reserve NV space for token object before the objects use it. */ variableSz = token->userPinLen + token->soPinLen + (token->objCnt * FIELD_SIZE(WP11_Object, type)); ret = wp11_storage_open(WOLFPKCS11_STORE_TOKEN, tokenId, 0, variableSz, @@ -8885,6 +8886,7 @@ static int wp11_Token_StorePass(WP11_Token* token, int tokenId) ret = wp11_storage_close_write(storage, ret); storage = NULL; } +#endif /* Store the objects */ object = token->object; diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 48a37c5e..70f31329 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -217,6 +217,20 @@ static void object_record_path(CK_SLOT_ID slot, int objId, char* path, (unsigned long)slot, (unsigned long)objId); } +/* Read a stored file into buf, returning its length or -1 on error. */ +static long read_store_file(const char* path, byte* buf, size_t bufSz) +{ + FILE* f; + long len; + + f = fopen(path, "rb"); + if (f == NULL) + return -1; + len = (long)fread(buf, 1, bufSz, f); + fclose(f); + return len; +} + /* Reload the token from storage and open a user session on it. */ static CK_RV reload(CK_SLOT_ID slot, CK_SESSION_HANDLE* session) { @@ -313,6 +327,53 @@ static void test_create_reports_commit_failure(void) funcList->C_Finalize(NULL); } +/* A failed token object store leaves the stored token record unchanged. */ +static void test_token_record_kept_on_failed_store(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + char path[512]; + char tokenPath[512]; + byte before[1024]; + byte after[1024]; + long beforeLen = -1; + long afterLen = -1; + int blocked = 0; + + printf("\n--- token record is kept when an object store fails ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "record-first", &obj); + CHECK_RV(rv, "create first token object", CKR_OK); + } + if (rv == CKR_OK) { + snprintf(tokenPath, sizeof(tokenPath), "%s/wp11_token_%016lx", + TEST_DIR, (unsigned long)slot); + beforeLen = read_store_file(tokenPath, before, sizeof(before)); + CHECK_TRUE(beforeLen > 0 && beforeLen < (long)sizeof(before), + "token record is stored"); + object_record_path(slot, 1, path, sizeof(path)); + blocked = (beforeLen > 0) && (mkdir(path, 0700) == 0); + } + if (blocked) { + rv = create_token_secret(session, "record-second", &obj); + CHECK_TRUE(rv != CKR_OK, + "create fails when the object cannot be committed"); + afterLen = read_store_file(tokenPath, after, sizeof(after)); + CHECK_TRUE(afterLen == beforeLen && + XMEMCMP(before, after, (size_t)beforeLen) == 0, + "token record is unchanged by the failed store"); + (void)rmdir(path); + } + close_session(session); + funcList->C_Finalize(NULL); +} + /* A PIN change that cannot be stored leaves the stored PIN in effect. */ static void test_pin_change_store_failure(void) { @@ -453,6 +514,7 @@ static int run_tests(void) test_objects_persist_across_storage_pause(); test_create_reports_commit_failure(); + test_token_record_kept_on_failed_store(); test_pin_change_store_failure(); test_init_pin_store_failure(); test_token_reset_store_failure(); From c3d56c15265b59e21a4860939af3870dbc73ccf1 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:39:40 -0700 Subject: [PATCH 061/104] F-11505 - Report token store failures from C_Finalize --- src/internal.c | 20 +++++++++++++------ src/wolfpkcs11.c | 7 +++---- tests/token_store_test.c | 42 ++++++++++++++++++++++++++++++++++++++++ wolfpkcs11/internal.h | 2 +- 4 files changed, 60 insertions(+), 11 deletions(-) diff --git a/src/internal.c b/src/internal.c index 33c666fb..e152f086 100644 --- a/src/internal.c +++ b/src/internal.c @@ -9320,9 +9320,14 @@ int WP11_Library_Init(void) /** * Finalize the globals for the library. * Multiple finalizations allowed. + * + * @return 0 on success. + * @return BAD_MUTEX_E when locking fails. + * @return Other value when storing a token fails. Cleanup is still done. */ -void WP11_Library_Final(void) +int WP11_Library_Final(void) { + int ret = 0; int i; int cnt; @@ -9331,7 +9336,7 @@ void WP11_Library_Final(void) * WP11_Lock_Free so a racing WP11_Library_IsInitialized can't observe * count>0, then call WP11_Lock_LockRO on a freed globalLock. */ if (wc_LockMutex(&libraryInitLock) != 0) - return; + return BAD_MUTEX_E; #endif WP11_Lock_LockRW(&globalLock); @@ -9341,13 +9346,14 @@ void WP11_Library_Final(void) #ifndef WOLFPKCS11_NO_STORE /* Store the slots. */ for (i = 0; i < slotCnt; i++) { - int ret = wp11_Slot_Store(&slotList[i], i + 1); + int storeRet = wp11_Slot_Store(&slotList[i], i + 1); #ifdef DEBUG_WOLFPKCS11 - if (ret != 0) { - printf("Failed to store slot %d, ret: %d\n", i + 1, ret); + if (storeRet != 0) { + printf("Failed to store slot %d, ret: %d\n", i + 1, storeRet); } #endif - (void)ret; /* store failure cannot be returned, so log and ignore */ + if (ret == 0) + ret = storeRet; } #if !defined (WOLFPKCS11_CUSTOM_STORE) && defined(WOLFPKCS11_NSS) /* Serialize the free against a concurrent WP11_SetStoreDir / @@ -9380,6 +9386,8 @@ void WP11_Library_Final(void) #ifdef WP11_HAVE_LIBRARY_INIT_LOCK wc_UnLockMutex(&libraryInitLock); #endif + + return ret; } /** diff --git a/src/wolfpkcs11.c b/src/wolfpkcs11.c index 7170625a..1f887113 100644 --- a/src/wolfpkcs11.c +++ b/src/wolfpkcs11.c @@ -590,7 +590,8 @@ CK_RV C_Initialize(CK_VOID_PTR pInitArgs) * Finalize the Crypto-Ki library. * * @param pReserved [out] Ignored. - * @return CKR_OK on success. + * @return CKR_FUNCTION_FAILED when token state could not be stored. + * CKR_OK on success. */ CK_RV C_Finalize(CK_VOID_PTR pReserved) { @@ -608,9 +609,7 @@ CK_RV C_Finalize(CK_VOID_PTR pReserved) return ret; } - WP11_Library_Final(); - - ret = CKR_OK; + ret = WP11_Library_Final() == 0 ? CKR_OK : CKR_FUNCTION_FAILED; WOLFPKCS11_LEAVE("C_Finalize", ret); return ret; } diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 70f31329..52ab8708 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -503,6 +503,47 @@ static void test_token_reset_store_failure(void) funcList->C_Finalize(NULL); } +/* C_Finalize reports a token that could not be stored. */ +static void test_finalize_reports_store_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + + if (geteuid() == 0) { + printf("\nSkipping finalize store failure test when run as root\n"); + return; + } + printf("\n--- finalize reports a token store failure ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "final-first", &obj); + CHECK_RV(rv, "create token object", CKR_OK); + } + close_session(session); + session = CK_INVALID_HANDLE; + if (rv == CKR_OK && chmod(TEST_DIR, 0500) == 0) { + rv = funcList->C_Finalize(NULL); + (void)chmod(TEST_DIR, 0700); + CHECK_RV(rv, "finalize reports the store failure", + CKR_FUNCTION_FAILED); + rv = lib_init(); + CHECK_RV(rv, "library initializes after the failed finalize", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + CHECK_TRUE(count_label(session, "final-first") == 1, + "previously stored object is still present"); + } + } + close_session(session); + funcList->C_Finalize(NULL); +} + static int run_tests(void) { CK_RV rv; @@ -518,6 +559,7 @@ static int run_tests(void) test_pin_change_store_failure(); test_init_pin_store_failure(); test_token_reset_store_failure(); + test_finalize_reports_store_failure(); clear_store_dir(); pkcs11_unload(); diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 9b85b534..dc14d6db 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -399,7 +399,7 @@ typedef struct WP11_ObjectCalls WP11_ObjectCalls; WP11_LOCAL int WP11_Library_Init(void); -WP11_LOCAL void WP11_Library_Final(void); +WP11_LOCAL int WP11_Library_Final(void); WP11_LOCAL int WP11_Library_IsInitialized(void); WP11_LOCAL int WP11_SlotIdValid(CK_SLOT_ID slotId); From d8f04dc27f43ebc822d4d182298822c1c5778cf8 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:53:16 -0700 Subject: [PATCH 062/104] F-8645 - Undo partial library initialization on failure --- src/internal.c | 24 ++++++++++++- tests/token_store_test.c | 73 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index e152f086..6ff021fc 100644 --- a/src/internal.c +++ b/src/internal.c @@ -9261,6 +9261,10 @@ int WP11_Library_Init(void) { int ret = 0; int i; + int lockInit = 0; + int cryptInit = 0; + int rngInit = 0; + int slotInitCnt = 0; #ifdef WP11_HAVE_LIBRARY_INIT_LOCK /* Serialize the entire init sequence: both the libraryInitCount==0 @@ -9274,8 +9278,10 @@ int WP11_Library_Init(void) if (libraryInitCount == 0) { ret = WP11_Lock_Init(&globalLock); if (ret == 0) { - + lockInit = 1; ret = wolfCrypt_Init(); + if (ret == 0) + cryptInit = 1; #ifdef WC_RNG_SEED_CB if (ret == 0) { ret = wc_SetSeed_Cb(wc_GenerateSeed); @@ -9292,17 +9298,33 @@ int WP11_Library_Init(void) #else ret = wc_InitRng(&globalRandom); #endif + if (ret == 0) + rngInit = 1; } } for (i = 0; (ret == 0) && (i < slotCnt); i++) { ret = wp11_Slot_Init(&slotList[i], i + 1); + if (ret == 0) + slotInitCnt++; } #ifndef WOLFPKCS11_NO_STORE for (i = 0; (ret == 0) && (i < slotCnt); i++) { ret = wp11_Slot_Load(&slotList[i], i + 1); } #endif + if (ret != 0) { + /* Undo partial initialization so a retry starts clean. */ + for (i = 0; i < slotInitCnt; i++) + wp11_Slot_Final(&slotList[i]); + if (rngInit) + wc_FreeRng(&globalRandom); + if (cryptInit) + wolfCrypt_Cleanup(); + if (lockInit) { + WP11_Lock_Free(&globalLock); + } + } } if (ret == 0) { WP11_Lock_LockRW(&globalLock); diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 52ab8708..a2e1b70f 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -231,6 +231,21 @@ static long read_store_file(const char* path, byte* buf, size_t bufSz) return len; } +/* Replace a stored file with len bytes from buf. */ +static int write_store_file(const char* path, const byte* buf, size_t len) +{ + FILE* f; + size_t written; + + f = fopen(path, "wb"); + if (f == NULL) + return -1; + written = fwrite(buf, 1, len, f); + if (fclose(f) != 0 || written != len) + return -1; + return 0; +} + /* Reload the token from storage and open a user session on it. */ static CK_RV reload(CK_SLOT_ID slot, CK_SESSION_HANDLE* session) { @@ -544,6 +559,63 @@ static void test_finalize_reports_store_failure(void) funcList->C_Finalize(NULL); } +/* The library initializes once an unreadable token record is repaired. */ +static void test_init_retry_after_load_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + char tokenPath[512]; + byte record[1024]; + long recordLen = -1; + + printf("\n--- library initializes after a failed initialization ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "retry-keep", &obj); + CHECK_RV(rv, "create token object", CKR_OK); + } + close_session(session); + session = CK_INVALID_HANDLE; + funcList->C_Finalize(NULL); + + if (rv == CKR_OK) { + snprintf(tokenPath, sizeof(tokenPath), "%s/wp11_token_%016lx", + TEST_DIR, (unsigned long)slot); + recordLen = read_store_file(tokenPath, record, sizeof(record)); + CHECK_TRUE(recordLen > 0 && recordLen < (long)sizeof(record), + "token record is stored"); + } + if (recordLen > 0) { + CHECK_TRUE(write_store_file(tokenPath, record, 4) == 0, + "truncate the token record"); + rv = lib_init(); + CHECK_TRUE(rv != CKR_OK, "initialize fails on a truncated record"); + if (rv == CKR_OK) + funcList->C_Finalize(NULL); + rv = write_store_file(tokenPath, record, (size_t)recordLen) == 0 ? + CKR_OK : CKR_GENERAL_ERROR; + if (rv == CKR_OK) + rv = lib_init(); + CHECK_RV(rv, "initialize succeeds once the record is restored", + CKR_OK); + if (rv == CKR_OK) { + rv = user_session(slot, &session); + CHECK_RV(rv, "user logs in after the retry", CKR_OK); + } + if (rv == CKR_OK) { + CHECK_TRUE(count_label(session, "retry-keep") == 1, + "stored object is loaded after the retry"); + } + close_session(session); + funcList->C_Finalize(NULL); + } +} + static int run_tests(void) { CK_RV rv; @@ -560,6 +632,7 @@ static int run_tests(void) test_init_pin_store_failure(); test_token_reset_store_failure(); test_finalize_reports_store_failure(); + test_init_retry_after_load_failure(); clear_store_dir(); pkcs11_unload(); From fcbeeb2c7530de8d6e4af57eb54852d49bb3ccb4 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:05:58 -0700 Subject: [PATCH 063/104] F-10385 - Handle a failed object allocation without freeing NULL --- src/internal.c | 5 ++- tests/token_store_test.c | 69 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index 6ff021fc..be4c2339 100644 --- a/src/internal.c +++ b/src/internal.c @@ -3400,7 +3400,7 @@ static int wp11_Object_New(WP11_Slot* slot, CK_KEY_TYPE type, /* Type-specific allocation will be done later when object class is known */ - if (ret != 0) { + if (ret != 0 && obj != NULL) { WP11_Object_Free(obj); obj = NULL; } @@ -12997,6 +12997,9 @@ int WP11_Session_IsFindActive(WP11_Session* session) void WP11_Object_Free(WP11_Object* object) { int certFreed = 0; + + if (object == NULL) + return; #ifdef WOLFPKCS11_TPM if (object->tpmKey != NULL) { wolfTPM2_UnloadHandle(&object->slot->tpmDev, &object->tpmKey->handle); diff --git a/tests/token_store_test.c b/tests/token_store_test.c index a2e1b70f..57279fa3 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -68,6 +68,31 @@ static CK_BBOOL ckTrue = CK_TRUE; static CK_BBOOL ckFalse = CK_FALSE; static byte keyData[16] = { 0 }; +#if !defined(WOLFSSL_STATIC_MEMORY) && !defined(WOLFSSL_DEBUG_MEMORY) && \ + !defined(NO_WOLFSSL_MEMORY) +#define TEST_ALLOC_FAILURE +static int failAllocs = 0; + +static void* test_malloc(size_t n) +{ + if (failAllocs) + return NULL; + return malloc(n); +} + +static void test_free(void* p) +{ + free(p); +} + +static void* test_realloc(void* p, size_t n) +{ + if (failAllocs) + return NULL; + return realloc(p, n); +} +#endif + static void clear_store_dir(void) { DIR* dir; @@ -616,6 +641,41 @@ static void test_init_retry_after_load_failure(void) } } +#ifdef TEST_ALLOC_FAILURE +/* Object creation fails cleanly when memory cannot be allocated. */ +static void test_create_object_out_of_memory(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_VALUE, keyData, sizeof(keyData) }, + { CKA_TOKEN, &ckFalse, sizeof(ckFalse) }, + }; + + printf("\n--- object creation fails cleanly without memory ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + failAllocs = 1; + rv = funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); + failAllocs = 0; + CHECK_TRUE(rv != CKR_OK, "create fails when allocation fails"); + rv = funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); + CHECK_RV(rv, "create succeeds once memory is available", CKR_OK); + } + close_session(session); + funcList->C_Finalize(NULL); +} +#endif + static int run_tests(void) { CK_RV rv; @@ -633,6 +693,9 @@ static int run_tests(void) test_token_reset_store_failure(); test_finalize_reports_store_failure(); test_init_retry_after_load_failure(); +#ifdef TEST_ALLOC_FAILURE + test_create_object_out_of_memory(); +#endif clear_store_dir(); pkcs11_unload(); @@ -648,6 +711,12 @@ int main(int argc, char* argv[]) unsetenv("WOLFPKCS11_NO_STORE"); printf("=== wolfPKCS11 token store test ===\n"); +#ifdef TEST_ALLOC_FAILURE + if (wolfSSL_SetAllocators(test_malloc, test_free, test_realloc) != 0) { + fprintf(stderr, "FAIL: wolfSSL_SetAllocators\n"); + return 1; + } +#endif run_tests(); return pkcs11_test_summary(); } From 42963cab6b9e1c7e2a19504824b9d8d84a119e65 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:19:14 -0700 Subject: [PATCH 064/104] F-13243 - Report token object unstore failures from object destroy --- src/internal.c | 32 ++++++++++++----- tests/token_store_test.c | 75 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+), 9 deletions(-) diff --git a/src/internal.c b/src/internal.c index be4c2339..0226a7f2 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2333,6 +2333,10 @@ int wolfPKCS11_Store_Remove(int type, CK_ULONG id1, CK_ULONG id2) ret = wolfPKCS11_Store_Name(type, id1, id2, name, sizeof(name)); if (ret > 0 && ret < (int)sizeof(name)) { ret = remove(name); + if (ret < 0 && errno == ENOENT) { + /* Nothing was stored, so nothing is left behind. */ + ret = 0; + } if (ret < 0) { printf("remove(%s) failed: %d\n", name, ret); } @@ -12504,6 +12508,9 @@ int WP11_Session_RemoveObjectByHandle(WP11_Session* session, WP11_Token* token = &session->slot->token; WP11_Session* owner = session; int id = 0; +#ifndef WOLFPKCS11_NO_STORE + int storeRet; +#endif /* The token lock guards every object list on the slot (session lists * included). Take it before touching any list or the object. Token objects @@ -12595,13 +12602,16 @@ int WP11_Session_RemoveObjectByHandle(WP11_Session* session, #ifndef WOLFPKCS11_NO_STORE /* remove any id's with higher value */ - ret = wp11_Object_Unstore(*curr, (int)session->slotId, id); + storeRet = wp11_Object_Unstore(*curr, (int)session->slotId, id); #ifdef DEBUG_WOLFPKCS11 - if (ret != 0) { + if (storeRet != 0) { printf("Failed to unstore slot %d, id: %d, ret: %d, continuing...\n", - (int)session->slotId, id, ret); + (int)session->slotId, id, storeRet); } #endif + /* NOT_AVAILABLE_E: storage is disabled, nothing to remove. */ + if (ret == 0 && storeRet != NOT_AVAILABLE_E) + ret = storeRet; #endif curr = &(*curr)->next; @@ -12610,21 +12620,25 @@ int WP11_Session_RemoveObjectByHandle(WP11_Session* session, } #ifndef WOLFPKCS11_NO_STORE - ret = wp11_Object_Unstore(object, (int)session->slotId, id); + storeRet = wp11_Object_Unstore(object, (int)session->slotId, id); #ifdef DEBUG_WOLFPKCS11 - if (ret != 0) { + if (storeRet != 0) { printf("Failed to unstore slot %d, id: %d, ret: %d\n", - (int)session->slotId, id, ret); + (int)session->slotId, id, storeRet); } #endif + if (ret == 0 && storeRet != NOT_AVAILABLE_E) + ret = storeRet; /* re-store the token */ - ret = wp11_Slot_Store(session->slot, (int)session->slotId); + storeRet = wp11_Slot_Store(session->slot, (int)session->slotId); #ifdef DEBUG_WOLFPKCS11 - if (ret != 0) { + if (storeRet != 0) { printf("Failed to store slot %d, ret: %d\n", - (int)session->slotId, ret); + (int)session->slotId, storeRet); } #endif + if (ret == 0) + ret = storeRet; #endif } else { diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 57279fa3..5072d4fd 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -641,6 +641,79 @@ static void test_init_retry_after_load_failure(void) } } +/* Destroying a token object reports stored data that cannot be removed. */ +static void test_destroy_reports_unstore_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE first; + CK_OBJECT_HANDLE second; + char keyPath[512]; + char innerPath[600]; + int blocked = 0; + + printf("\n--- destroy reports stored data that cannot be removed ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "destroy-first", &first); + CHECK_RV(rv, "create first token object", CKR_OK); + } + if (rv == CKR_OK) { + rv = create_token_secret(session, "destroy-second", &second); + CHECK_RV(rv, "create second token object", CKR_OK); + } + if (rv == CKR_OK) { + snprintf(keyPath, sizeof(keyPath), "%s/wp11_symmkey_%016lx_%016lx", + TEST_DIR, (unsigned long)slot, 1UL); + snprintf(innerPath, sizeof(innerPath), "%s/keep", keyPath); + blocked = remove(keyPath) == 0 && mkdir(keyPath, 0700) == 0 && + write_store_file(innerPath, keyData, sizeof(keyData)) == 0; + CHECK_TRUE(blocked, "make the stored key data unremovable"); + } + if (blocked) { + rv = funcList->C_DestroyObject(session, second); + CHECK_TRUE(rv != CKR_OK, + "destroy reports stored data that was not removed"); + CHECK_TRUE(count_label(session, "destroy-first") == 1, + "other token object is still present"); + (void)remove(innerPath); + (void)rmdir(keyPath); + } + close_session(session); + funcList->C_Finalize(NULL); +} + +/* A token object never written to storage can still be destroyed. */ +static void test_destroy_unstored_object(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + + printf("\n--- destroy of an object created while paused ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + XSETENV("WOLFPKCS11_NO_STORE", "1", 1); + rv = create_token_secret(session, "paused-destroy", &obj); + unsetenv("WOLFPKCS11_NO_STORE"); + CHECK_RV(rv, "create token object while storage is paused", CKR_OK); + } + if (rv == CKR_OK) { + rv = funcList->C_DestroyObject(session, obj); + CHECK_RV(rv, "destroy the never stored object", CKR_OK); + } + close_session(session); + funcList->C_Finalize(NULL); +} + #ifdef TEST_ALLOC_FAILURE /* Object creation fails cleanly when memory cannot be allocated. */ static void test_create_object_out_of_memory(void) @@ -693,6 +766,8 @@ static int run_tests(void) test_token_reset_store_failure(); test_finalize_reports_store_failure(); test_init_retry_after_load_failure(); + test_destroy_reports_unstore_failure(); + test_destroy_unstored_object(); #ifdef TEST_ALLOC_FAILURE test_create_object_out_of_memory(); #endif From 0966e8001f9275a7f784c85b64e7f76111c7a853 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:24:42 -0700 Subject: [PATCH 065/104] F-2791 - Zeroize token state with wc_ForceZero on finalize --- src/internal.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index 0226a7f2..cda45e2a 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8511,7 +8511,7 @@ static void wp11_Token_Final(WP11_Token* token) Rng_Free(&token->rng); WP11_Lock_Free(&token->rngLock); WP11_Lock_Free(&token->lock); - XMEMSET(token, 0, sizeof(*token)); + wc_ForceZero(token, sizeof(*token)); } #ifndef WOLFPKCS11_NO_STORE From 26dd0a501428f94a10478b1bdd3241714e604ce9 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:36:19 -0700 Subject: [PATCH 066/104] F-11502 - Propagate token flag read errors during token load --- src/internal.c | 4 +-- tests/token_store_test.c | 54 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 2 deletions(-) diff --git a/src/internal.c b/src/internal.c index cda45e2a..0919ca46 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8806,9 +8806,9 @@ static int wp11_Token_Load(WP11_Slot* slot, int tokenId, WP11_Token* token) token->nextObjId = 1; ret = 0; } - else { + else if (ret == 0) { ret = wp11_storage_read_int(storage, &token->nextObjId); - if (ret == BUFFER_E || token->nextObjId == 0) { + if (ret == BUFFER_E || (ret == 0 && token->nextObjId == 0)) { token->nextObjId = 1; ret = 0; } diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 5072d4fd..3a980bed 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -749,6 +749,59 @@ static void test_create_object_out_of_memory(void) } #endif +/* A token record from before the trailing fields were added still loads. */ +static void test_load_record_without_trailing_fields(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + char tokenPath[512]; + byte record[1024]; + long recordLen = -1; + long dropLen; + + printf("\n--- token record without trailing fields loads ---\n"); + for (dropLen = 4; dropLen <= 8; dropLen += 4) { + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "legacy-keep", &obj); + CHECK_RV(rv, "create token object", CKR_OK); + } + close_session(session); + session = CK_INVALID_HANDLE; + funcList->C_Finalize(NULL); + if (rv == CKR_OK) { + snprintf(tokenPath, sizeof(tokenPath), "%s/wp11_token_%016lx", + TEST_DIR, (unsigned long)slot); + recordLen = read_store_file(tokenPath, record, sizeof(record)); + CHECK_TRUE(recordLen > dropLen && recordLen < (long)sizeof(record), + "token record is stored"); + } + if (rv == CKR_OK && recordLen > dropLen) { + CHECK_TRUE(write_store_file(tokenPath, record, + (size_t)(recordLen - dropLen)) == 0, + "drop trailing token record fields"); + rv = lib_init(); + CHECK_RV(rv, "initialize with the shorter record", CKR_OK); + if (rv == CKR_OK) { + rv = user_session(slot, &session); + CHECK_RV(rv, "user logs in", CKR_OK); + } + if (rv == CKR_OK) { + CHECK_TRUE(count_label(session, "legacy-keep") == 1, + "stored object is loaded"); + } + close_session(session); + session = CK_INVALID_HANDLE; + funcList->C_Finalize(NULL); + } + } +} + static int run_tests(void) { CK_RV rv; @@ -768,6 +821,7 @@ static int run_tests(void) test_init_retry_after_load_failure(); test_destroy_reports_unstore_failure(); test_destroy_unstored_object(); + test_load_record_without_trailing_fields(); #ifdef TEST_ALLOC_FAILURE test_create_object_out_of_memory(); #endif From 4b93de5243c0a6b6503bbf2ae607b352f6be8fa7 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:37:27 -0700 Subject: [PATCH 067/104] Prefer the token store error in object destroy --- src/internal.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index 0919ca46..b78cae27 100644 --- a/src/internal.c +++ b/src/internal.c @@ -12637,7 +12637,8 @@ int WP11_Session_RemoveObjectByHandle(WP11_Session* session, (int)session->slotId, storeRet); } #endif - if (ret == 0) + /* A token record left unwritten outranks a record left behind. */ + if (storeRet != 0) ret = storeRet; #endif } From 0a197455f28bdd1c7f63f1d81dd65ae8694b6146 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:37:27 -0700 Subject: [PATCH 068/104] Document both CKR_FUNCTION_FAILED cases of C_Finalize --- src/wolfpkcs11.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/wolfpkcs11.c b/src/wolfpkcs11.c index 1f887113..73369a85 100644 --- a/src/wolfpkcs11.c +++ b/src/wolfpkcs11.c @@ -590,7 +590,10 @@ CK_RV C_Initialize(CK_VOID_PTR pInitArgs) * Finalize the Crypto-Ki library. * * @param pReserved [out] Ignored. - * @return CKR_FUNCTION_FAILED when token state could not be stored. + * @return CKR_FUNCTION_FAILED when token state could not be stored, in which + * case the library is finalized all the same, or when the + * initialization lock could not be taken, in which case it stays + * initialized and the call can be retried. * CKR_OK on success. */ CK_RV C_Finalize(CK_VOID_PTR pReserved) From 6df366482dbb01b5726acf3c095961efb6866613 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:37:49 -0700 Subject: [PATCH 069/104] Test a close failure in wolfPKCS11_Store_CloseCommit --- src/internal.c | 19 +++++++++++++++ tests/token_store_test.c | 50 ++++++++++++++++++++++++++++++++++++++++ wolfpkcs11/internal.h | 1 + 3 files changed, 70 insertions(+) diff --git a/src/internal.c b/src/internal.c index b78cae27..d09c0a17 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1298,6 +1298,7 @@ static void wolfPKCS11_StoreAbortTemp(WP11_FileStoreCtx* ctx) #if defined(DEBUG_WOLFPKCS11) && !defined(_WIN32) && !defined(_MSC_VER) static int wp11_storeExitAfter = 0; +static int wp11_storeCloseFailAfter = -1; /** * Test hook: end the process right after the given number of store renames, @@ -1309,6 +1310,17 @@ WP11_API void WP11_Test_StoreExitAfterRenames(int renames) { wp11_storeExitAfter = renames; } + +/** + * Test hook: make the close of a written store record fail once, after the + * given number of closes succeed. + * + * @param closes [in] Closes to allow first, or -1 to disable the hook. + */ +WP11_API void WP11_Test_StoreCloseFailAfter(int closes) +{ + wp11_storeCloseFailAfter = closes; +} #endif static int wolfPKCS11_StoreRename(const char* from, const char* to) @@ -2599,6 +2611,13 @@ static int wolfPKCS11_Store_CloseCommit(void* store, int commit) commit = 0; ret = BUFFER_E; } + #if defined(DEBUG_WOLFPKCS11) && !defined(_WIN32) && !defined(_MSC_VER) + if (ctx->is_write && wp11_storeCloseFailAfter >= 0 && + wp11_storeCloseFailAfter-- == 0) { + /* Test hook: with the descriptor gone the close fails. */ + (void)close(fileno(ctx->file)); + } + #endif if (XFCLOSE(ctx->file) != 0 && ctx->is_write) { commit = 0; ret = BUFFER_E; diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 3a980bed..240f8913 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -367,6 +367,53 @@ static void test_create_reports_commit_failure(void) funcList->C_Finalize(NULL); } +#ifdef DEBUG_WOLFPKCS11 +/* Debug-only hook exported by libwolfpkcs11. */ +extern void WP11_Test_StoreCloseFailAfter(int closes); + +/* A token object whose record cannot be closed is not reported created. */ +static void test_create_reports_close_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + + printf("\n--- token object creation reports a close failure ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "close-first", &obj); + CHECK_RV(rv, "create first token object", CKR_OK); + } + if (rv == CKR_OK) { + WP11_Test_StoreCloseFailAfter(0); + rv = create_token_secret(session, "close-second", &obj); + WP11_Test_StoreCloseFailAfter(-1); + CHECK_TRUE(rv != CKR_OK, + "create fails when the record cannot be closed"); + CHECK_TRUE(count_label(session, "close-second") == 0, + "unclosed object is not in the token"); + close_session(session); + session = CK_INVALID_HANDLE; + rv = reload(slot, &session); + CHECK_RV(rv, "reload token", CKR_OK); + } + if (rv == CKR_OK) { + CHECK_TRUE(count_label(session, "close-first") == 1, + "stored object is reloaded"); + CHECK_TRUE(count_label(session, "close-second") == 0, + "unclosed object was not stored"); + rv = create_token_secret(session, "close-third", &obj); + CHECK_RV(rv, "create succeeds once records close", CKR_OK); + } + close_session(session); + funcList->C_Finalize(NULL); +} +#endif + /* A failed token object store leaves the stored token record unchanged. */ static void test_token_record_kept_on_failed_store(void) { @@ -813,6 +860,9 @@ static int run_tests(void) test_objects_persist_across_storage_pause(); test_create_reports_commit_failure(); +#endif +#ifdef DEBUG_WOLFPKCS11 + test_create_reports_close_failure(); test_token_record_kept_on_failed_store(); test_pin_change_store_failure(); test_init_pin_store_failure(); diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index dc14d6db..35164ff0 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -440,6 +440,7 @@ WP11_API void WP11_Test_FailTokenInit(int fail); /* Exit status of a process ended by the store rename test hook. */ #define WP11_TEST_STORE_EXIT_CODE 75 WP11_API void WP11_Test_StoreExitAfterRenames(int renames); +WP11_API void WP11_Test_StoreCloseFailAfter(int closes); #endif #if defined(WOLFPKCS11_TPM) && (!defined(NO_RSA) || defined(HAVE_ECC)) WP11_API int WP11_Test_DecodeTpmKey(CK_SLOT_ID slotId, unsigned char* keyData, From 4870e54bbd9caa76e04b5b4b5b2cf601cc5323bc Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:37:57 -0700 Subject: [PATCH 070/104] Test C_DeriveKey reporting a token store failure --- tests/token_store_test.c | 95 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 240f8913..4f2e50f2 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -367,6 +367,98 @@ static void test_create_reports_commit_failure(void) funcList->C_Finalize(NULL); } +#if !defined(NO_AES) && defined(HAVE_AES_CBC) +static CK_KEY_TYPE aesType = CKK_AES; +static byte deriveBaseKey[16] = { + 0x4b, 0x1d, 0x8e, 0x3f, 0xa2, 0x57, 0xc0, 0x69, + 0x9d, 0x24, 0x6b, 0xf8, 0x13, 0xe5, 0x70, 0xac +}; +static byte deriveData[16] = { 0 }; + +/* Derive a token key from an AES base key with CKM_AES_CBC_ENCRYPT_DATA. */ +static CK_RV derive_token_secret(CK_SESSION_HANDLE session, + CK_OBJECT_HANDLE base, const char* label, + CK_OBJECT_HANDLE* obj) +{ + CK_MECHANISM mech; + CK_AES_CBC_ENCRYPT_DATA_PARAMS params; + CK_ULONG valueLen = sizeof(deriveData); + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_VALUE_LEN, &valueLen, sizeof(valueLen) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_LABEL, NULL, 0 }, + }; + + XMEMSET(¶ms, 0, sizeof(params)); + params.pData = deriveData; + params.length = sizeof(deriveData); + mech.mechanism = CKM_AES_CBC_ENCRYPT_DATA; + mech.pParameter = ¶ms; + mech.ulParameterLen = sizeof(params); + tmpl[5].pValue = (CK_VOID_PTR)label; + tmpl[5].ulValueLen = (CK_ULONG)XSTRLEN(label); + return funcList->C_DeriveKey(session, &mech, base, tmpl, + sizeof(tmpl) / sizeof(*tmpl), obj); +} + +/* A derived token key whose record cannot be committed is not reported + * created, and deriving works again once it can be. */ +static void test_derive_reports_commit_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + char path[512]; + int blocked = 0; + CK_ATTRIBUTE baseTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_VALUE, deriveBaseKey, sizeof(deriveBaseKey) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_LABEL, (CK_VOID_PTR)"derive-base", 11 }, + }; + + printf("\n--- derived token key reports a commit failure ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, baseTmpl, + sizeof(baseTmpl) / sizeof(*baseTmpl), + &base); + CHECK_RV(rv, "create base token key", CKR_OK); + } + if (rv == CKR_OK) { + object_record_path(slot, 1, path, sizeof(path)); + blocked = (mkdir(path, 0700) == 0); + CHECK_TRUE(blocked, "occupy the next object record path"); + } + if (blocked) { + rv = derive_token_secret(session, base, "derive-token", &derived); + CHECK_TRUE(rv != CKR_OK, + "derive fails when the key cannot be committed"); + CHECK_TRUE(count_label(session, "derive-token") == 0, + "uncommitted derived key is not in the token"); + CHECK_TRUE(count_label(session, "derive-base") == 1, + "base key is still in the token"); + (void)rmdir(path); + rv = derive_token_secret(session, base, "derive-token", &derived); + CHECK_RV(rv, "derive succeeds once the key can be committed", CKR_OK); + CHECK_TRUE(count_label(session, "derive-token") == 1, + "committed derived key is in the token"); + } + close_session(session); + funcList->C_Finalize(NULL); +} +#endif + #ifdef DEBUG_WOLFPKCS11 /* Debug-only hook exported by libwolfpkcs11. */ extern void WP11_Test_StoreCloseFailAfter(int closes); @@ -860,9 +952,12 @@ static int run_tests(void) test_objects_persist_across_storage_pause(); test_create_reports_commit_failure(); +#if !defined(NO_AES) && defined(HAVE_AES_CBC) + test_derive_reports_commit_failure(); #endif #ifdef DEBUG_WOLFPKCS11 test_create_reports_close_failure(); +#endif test_token_record_kept_on_failed_store(); test_pin_change_store_failure(); test_init_pin_store_failure(); From 80948e83695f5ebc9850125c60da882c40f5dbfb Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:37:58 -0700 Subject: [PATCH 071/104] Test library initialization rollback when allocation fails --- tests/token_store_test.c | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 4f2e50f2..2a0954ff 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -854,6 +854,34 @@ static void test_destroy_unstored_object(void) } #ifdef TEST_ALLOC_FAILURE +/* A library initialization that fails part way is undone and retried. */ +static void test_init_out_of_memory(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + + printf("\n--- library initializes after running out of memory ---\n"); + clear_store_dir(); + failAllocs = 1; + rv = lib_init(); + failAllocs = 0; + CHECK_TRUE(rv != CKR_OK, "initialize fails when allocation fails"); + if (rv == CKR_OK) + funcList->C_Finalize(NULL); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup once memory is available", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "init-retry", &obj); + CHECK_RV(rv, "create token object after the retry", CKR_OK); + } + close_session(session); + funcList->C_Finalize(NULL); +} + /* Object creation fails cleanly when memory cannot be allocated. */ static void test_create_object_out_of_memory(void) { @@ -968,6 +996,7 @@ static int run_tests(void) test_destroy_unstored_object(); test_load_record_without_trailing_fields(); #ifdef TEST_ALLOC_FAILURE + test_init_out_of_memory(); test_create_object_out_of_memory(); #endif From 1ffe6e567c3c92a947ce755f751a6874b6567a52 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 16:24:44 -0700 Subject: [PATCH 072/104] Skip store failure tests when the directory stays writable --- tests/token_store_test.c | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 2a0954ff..ebb2724c 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -553,6 +553,26 @@ static void test_token_record_kept_on_failed_store(void) funcList->C_Finalize(NULL); } +/* Some platforms, such as MSYS2, ignore a read-only mode on a directory. */ +static int block_store_dir(void) +{ + FILE* probe; + char path[256]; + + if (chmod(TEST_DIR, 0500) != 0) + return 0; + (void)snprintf(path, sizeof(path), "%s/wp11_probe", TEST_DIR); + probe = fopen(path, "wb"); + if (probe != NULL) { + fclose(probe); + (void)remove(path); + (void)chmod(TEST_DIR, 0700); + printf("Skipping: store directory cannot be made read-only\n"); + return 0; + } + return 1; +} + /* A PIN change that cannot be stored leaves the stored PIN in effect. */ static void test_pin_change_store_failure(void) { @@ -570,7 +590,7 @@ static void test_pin_change_store_failure(void) CHECK_RV(rv, "token setup", CKR_OK); if (rv == CKR_OK) rv = user_session(slot, &session); - if (rv == CKR_OK && chmod(TEST_DIR, 0500) == 0) { + if (rv == CKR_OK && block_store_dir()) { rv = funcList->C_SetPIN(session, (CK_UTF8CHAR_PTR)userPin, (CK_ULONG)XSTRLEN(userPin), (CK_UTF8CHAR_PTR)newPin, @@ -620,7 +640,7 @@ static void test_init_pin_store_failure(void) (CK_ULONG)XSTRLEN(soPin)); } CHECK_RV(rv, "token setup", CKR_OK); - if (rv == CKR_OK && chmod(TEST_DIR, 0500) == 0) { + if (rv == CKR_OK && block_store_dir()) { rv = funcList->C_InitPIN(soSession, (CK_UTF8CHAR_PTR)userPin, (CK_ULONG)XSTRLEN(userPin)); (void)chmod(TEST_DIR, 0700); @@ -663,7 +683,7 @@ static void test_token_reset_store_failure(void) session = CK_INVALID_HANDLE; XMEMSET(label, ' ', sizeof(label)); XMEMCPY(label, tokenLabel, XSTRLEN(tokenLabel)); - if (rv == CKR_OK && chmod(TEST_DIR, 0500) == 0) { + if (rv == CKR_OK && block_store_dir()) { rv = funcList->C_InitToken(slot, (CK_UTF8CHAR_PTR)soPin, (CK_ULONG)XSTRLEN(soPin), label); (void)chmod(TEST_DIR, 0700); @@ -705,7 +725,7 @@ static void test_finalize_reports_store_failure(void) } close_session(session); session = CK_INVALID_HANDLE; - if (rv == CKR_OK && chmod(TEST_DIR, 0500) == 0) { + if (rv == CKR_OK && block_store_dir()) { rv = funcList->C_Finalize(NULL); (void)chmod(TEST_DIR, 0700); CHECK_RV(rv, "finalize reports the store failure", From cc1d926f2f80d0336b7a4445838fa1ba9f87267c Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Thu, 15 Oct 2026 09:39:04 -0700 Subject: [PATCH 073/104] Set the no_env default token path with configure --- .github/workflows/unit-test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml index 450197a9..590f3cb8 100644 --- a/.github/workflows/unit-test.yml +++ b/.github/workflows/unit-test.yml @@ -64,7 +64,7 @@ jobs: no_env: uses: ./.github/workflows/build-workflow.yml with: - config: C_EXTRA_FLAGS="-DWOLFPKCS11_NO_ENV -DWOLFPKCS11_DEFAULT_TOKEN_PATH=./store/default" + config: C_EXTRA_FLAGS="-DWOLFPKCS11_NO_ENV" --with-default-token-path=./store/default check: mkdir -p store && ./tests/pkcs11test no_aesgcm: uses: ./.github/workflows/build-workflow.yml From aebbd5106f5efa99c19f587787456087a440f817 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 15:44:20 -0700 Subject: [PATCH 074/104] F-10386 - Stage TPM store records in memory until commit --- .github/workflows/unit-test.yml | 5 + CMakeLists.txt | 3 +- cmake/options.h.in | 4 +- configure.ac | 2 +- src/internal.c | 199 +++++++++++++++++++------ tests/concurrent_destroy_object_test.c | 3 +- tests/login_pin_state_test.c | 34 +++-- tests/pkcs11mtt.c | 3 +- tests/token_store_test.c | 137 ++++++++++++++++- wolfpkcs11/internal.h | 3 + 10 files changed, 323 insertions(+), 70 deletions(-) diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml index 590f3cb8..ef84a163 100644 --- a/.github/workflows/unit-test.yml +++ b/.github/workflows/unit-test.yml @@ -26,6 +26,11 @@ jobs: with: config: --enable-singlethreaded --enable-wolftpm --disable-dh C_EXTRA_FLAGS="-DWOLFPKCS11_TPM_STORE" check: ./tests/pkcs11str && ./tests/pkcs11test && ./tests/rsa_session_persistence_test + tpm_debug: + uses: ./.github/workflows/build-workflow.yml + with: + config: --enable-singlethreaded --enable-wolftpm --disable-dh --enable-debug C_EXTRA_FLAGS="-DWOLFPKCS11_TPM_STORE" + check: ./tests/token_store_test tpm_no_store: uses: ./.github/workflows/build-workflow.yml diff --git a/CMakeLists.txt b/CMakeLists.txt index 2d6a09a6..3989eaad 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -158,8 +158,7 @@ if(NOT WOLFPKCS11_SINGLE_THREADED) "-D_POSIX_THREADS") endif() else() - set(SINGLE_THREADED 1) - list(APPEND WOLFPKCS11_DEFINITIONS "-DSINGLE_THREADED") + list(APPEND WOLFPKCS11_DEFINITIONS "-DWOLFPKCS11_SINGLE_THREADED") endif() diff --git a/cmake/options.h.in b/cmake/options.h.in index 594bcdb3..14e5d04f 100644 --- a/cmake/options.h.in +++ b/cmake/options.h.in @@ -38,8 +38,8 @@ extern "C" { #endif #undef DEBUG_WOLFPKCS11 #cmakedefine DEBUG_WOLFPKCS11 -#undef SINGLE_THREADED -#cmakedefine SINGLE_THREADED +#undef WOLFPKCS11_SINGLE_THREADED +#cmakedefine WOLFPKCS11_SINGLE_THREADED #undef NO_RSA #cmakedefine NO_RSA #undef WC_NO_RSA_OAEP diff --git a/configure.ac b/configure.ac index 2ef69ffa..24ea49bc 100644 --- a/configure.ac +++ b/configure.ac @@ -127,7 +127,7 @@ AS_IF([ test "x$ENABLED_SINGLETHREADED" = "xno" ],[ ]) ]) -AS_IF([ test "x$ENABLED_SINGLETHREADED" = "xyes" ],[ AM_CFLAGS="-DSINGLE_THREADED $AM_CFLAGS" ]) +AS_IF([ test "x$ENABLED_SINGLETHREADED" = "xyes" ],[ AM_CFLAGS="-DWOLFPKCS11_SINGLE_THREADED $AM_CFLAGS" ]) HAVE_PTHREAD=0 AS_IF([test "x$ax_pthread_ok" = "xyes"],[HAVE_PTHREAD=1]) diff --git a/src/internal.c b/src/internal.c index d09c0a17..1bf55fbd 100644 --- a/src/internal.c +++ b/src/internal.c @@ -171,7 +171,12 @@ /* Determine object id from object handle. */ #define OBJ_HANDLE_OBJ_ID(h) ((h) & 0xfffffff) -#ifdef SINGLE_THREADED +/* SINGLE_THREADED alters wolfSSL struct layouts; only wolfSSL sets it. */ +#if defined(SINGLE_THREADED) || defined(WOLFPKCS11_SINGLE_THREADED) + #define WP11_NO_LOCKING +#endif + +#ifdef WP11_NO_LOCKING /* Disable locking. */ typedef int WP11_Lock; @@ -656,7 +661,7 @@ static int libraryInitCount = 0; /* Lock for globals including global random. */ static WP11_Lock globalLock; -#if !defined(SINGLE_THREADED) && defined(WOLFSSL_MUTEX_INITIALIZER) && \ +#if !defined(WP11_NO_LOCKING) && defined(WOLFSSL_MUTEX_INITIALIZER) && \ defined(WOLFSSL_MUTEX_INITIALIZER_CLAUSE) /* Permanently-live mutex that serializes WP11_Library_Init, * WP11_Library_Final, and WP11_Library_IsInitialized. Needed because @@ -676,7 +681,7 @@ static wolfSSL_Mutex libraryInitLock #define WP11_HAVE_LIBRARY_INIT_LOCK #endif -#if !defined(SINGLE_THREADED) && defined(WOLFSSL_MUTEX_INITIALIZER) && \ +#if !defined(WP11_NO_LOCKING) && defined(WOLFSSL_MUTEX_INITIALIZER) && \ defined(WOLFSSL_MUTEX_INITIALIZER_CLAUSE) && \ !defined(WOLFPKCS11_TPM_STORE) && defined(WOLFPKCS11_NSS) /* Permanently-live leaf mutex serializing the module-global storeDir, which @@ -691,7 +696,7 @@ static wolfSSL_Mutex storeDirLock #endif -#ifndef SINGLE_THREADED +#ifndef WP11_NO_LOCKING /** * Initialize a lock. * @@ -1148,6 +1153,10 @@ typedef struct WP11_TpmStore { WOLFTPM2_DEV* dev; WOLFTPM2_NV nv; word32 offset; + byte* buf; /* write record staged until commit, follows context */ + word32 bufSz; + word32 nvIndex; + int writeFailed; } WP11_TpmStore; static WP11_TpmStore tpmStores[1]; /* maximum of 1 open store */ @@ -2381,9 +2390,7 @@ int wolfPKCS11_Store_OpenSz(int type, CK_ULONG id1, CK_ULONG id2, int read, WP11_Slot* slot = &slotList[0]; WP11_TpmStore* tpmStore = &tpmStores[0]; word32 nvIndex; - word32 nvAttributes; int maxSz; - WOLFTPM2_HANDLE parent; #else WP11_FileStoreCtx* ctx = NULL; char name[WP11_STORE_MAX_PATH] = "\0"; @@ -2402,7 +2409,6 @@ int wolfPKCS11_Store_OpenSz(int type, CK_ULONG id1, CK_ULONG id2, int read, #endif #ifdef WOLFPKCS11_TPM_STORE - XMEMSET(&parent, 0, sizeof(parent)); XMEMSET(tpmStore, 0, sizeof(*tpmStore)); tpmStore->dev = &slot->tpmDev; @@ -2413,39 +2419,26 @@ int wolfPKCS11_Store_OpenSz(int type, CK_ULONG id1, CK_ULONG id2, int read, if (maxSz <= 0) { ret = NOT_AVAILABLE_E; } - if (ret == 0) { - TPMS_NV_PUBLIC nvPublic; - XMEMSET(&nvPublic, 0, sizeof(nvPublic)); - - /* Get NV attributes */ - parent.hndl = WOLFPKCS11_TPM_AUTH_TYPE; - (void)wolfTPM2_GetNvAttributesTemplate(parent.hndl, &nvAttributes); - - /* If write check if handle is large enough */ - if (!read) { - ret = wolfTPM2_NVReadPublic(tpmStore->dev, nvIndex, &nvPublic); - if (ret == 0 && nvPublic.dataSize < maxSz) { - /* NV is not large enough, delete and re-create */ - printf("Expanding TPM NV Handle 0x%x: %d -> %d\n", - nvIndex, nvPublic.dataSize, maxSz); - - ret = wolfTPM2_NVDeleteAuth(tpmStore->dev, &parent, nvIndex); - if (ret != 0) { - printf("Error %d (%s) removing NV handle 0x%x: \n", - ret, wolfTPM2_GetRCString(ret), nvIndex); - } - } - } + if (ret == 0 && read) { /* Try and open handle */ ret = wolfTPM2_NVOpen(tpmStore->dev, &tpmStore->nv, nvIndex, NULL, 0); if (ret != 0) { - if (!read) { - ret = wolfTPM2_NVCreateAuth(tpmStore->dev, &parent, - &tpmStore->nv, nvIndex, nvAttributes, maxSz, NULL, 0); - } - else { - ret = NOT_AVAILABLE_E; /* read for handle that doesn't exist */ - } + ret = NOT_AVAILABLE_E; /* read for handle that doesn't exist */ + } + } + else if (ret == 0) { + /* Stage the record in its own context, NV is only touched on commit */ + tpmStore = (WP11_TpmStore*)XMALLOC(sizeof(*tpmStore) + (size_t)maxSz, + NULL, DYNAMIC_TYPE_TMP_BUFFER); + if (tpmStore == NULL) { + ret = MEMORY_E; + } + else { + XMEMSET(tpmStore, 0, sizeof(*tpmStore)); + tpmStore->dev = &slot->tpmDev; + tpmStore->buf = (byte*)(tpmStore + 1); + tpmStore->bufSz = (word32)maxSz; + tpmStore->nvIndex = nvIndex; } } if (ret == 0) { @@ -2575,6 +2568,83 @@ int wolfPKCS11_Store_Open(int type, CK_ULONG id1, CK_ULONG id2, int read, return wolfPKCS11_Store_OpenSz(type, id1, id2, read, 0, store); } +#ifdef WOLFPKCS11_TPM_STORE +/** + * Writes the staged record to its NV index, growing the index when needed. + * + * @param [in] tpmStore TPM store context holding the staged record. + * @return 0 on success. + * @return Other value when the record could not be written. + */ +static int wolfPKCS11_Store_TpmCommit(WP11_TpmStore* tpmStore) +{ + int ret; + int create = 0; + word32 nvAttributes = 0; + word32 readSz; + WOLFTPM2_HANDLE parent; + TPMS_NV_PUBLIC nvPublic; + + XMEMSET(&parent, 0, sizeof(parent)); + XMEMSET(&nvPublic, 0, sizeof(nvPublic)); + parent.hndl = WOLFPKCS11_TPM_AUTH_TYPE; + + ret = wolfTPM2_GetNvAttributesTemplate(parent.hndl, &nvAttributes); + if (ret == 0 && wolfTPM2_NVReadPublic(tpmStore->dev, tpmStore->nvIndex, + &nvPublic) != 0) { + /* No NV index holds this record yet. */ + create = 1; + } + else if (ret == 0 && nvPublic.dataSize < tpmStore->bufSz) { + /* NV is not large enough, delete and re-create */ + printf("Expanding TPM NV Handle 0x%x: %d -> %d\n", + tpmStore->nvIndex, (int)nvPublic.dataSize, (int)tpmStore->bufSz); + create = 1; + if (tpmStore->offset == 0) { + /* Nothing staged, so carry the stored record into the new index */ + ret = wolfTPM2_NVOpen(tpmStore->dev, &tpmStore->nv, + tpmStore->nvIndex, NULL, 0); + if (ret == 0) { + ret = wolfTPM2_SetAuthHandle(tpmStore->dev, 0, + &tpmStore->nv.handle); + } + if (ret == 0) { + readSz = nvPublic.dataSize; + ret = wolfTPM2_NVReadAuth(tpmStore->dev, &tpmStore->nv, + tpmStore->nvIndex, tpmStore->buf, &readSz, 0); + if (ret == 0) + tpmStore->offset = readSz; + } + if (ret == TPM_RC_NV_UNINITIALIZED) + ret = 0; + } + if (ret == 0) { + ret = wolfTPM2_NVDeleteAuth(tpmStore->dev, &parent, + tpmStore->nvIndex); + if (ret != 0) { + printf("Error %d (%s) removing NV handle 0x%x: \n", + ret, wolfTPM2_GetRCString(ret), tpmStore->nvIndex); + } + } + } + + if (ret == 0 && create) { + ret = wolfTPM2_NVCreateAuth(tpmStore->dev, &parent, &tpmStore->nv, + tpmStore->nvIndex, nvAttributes, tpmStore->bufSz, NULL, 0); + } + else if (ret == 0 && tpmStore->offset > 0) { + ret = wolfTPM2_NVOpen(tpmStore->dev, &tpmStore->nv, tpmStore->nvIndex, + NULL, 0); + } + if (ret == 0 && tpmStore->offset > 0) { + /* wolfTPM splits this into as few maximum sized NV writes as fit */ + ret = wolfTPM2_NVWriteAuth(tpmStore->dev, &tpmStore->nv, + tpmStore->nv.handle.hndl, tpmStore->buf, tpmStore->offset, 0); + } + return ret; +} +#endif + /** * Closes access to location being read or written. * Any dynamic memory associated with the store is freed here. @@ -2589,6 +2659,7 @@ static int wolfPKCS11_Store_CloseCommit(void* store, int commit) int ret = 0; #ifdef WOLFPKCS11_TPM_STORE WP11_TpmStore* tpmStore = (WP11_TpmStore*)store; + size_t ctxSz; #else WP11_FileStoreCtx* ctx = (WP11_FileStoreCtx*)store; #endif @@ -2598,9 +2669,17 @@ static int wolfPKCS11_Store_CloseCommit(void* store, int commit) #endif #ifdef WOLFPKCS11_TPM_STORE - /* nothing to do for TPM */ - (void)tpmStore; - (void)commit; + if (tpmStore != NULL && tpmStore->buf != NULL) { + if (tpmStore->writeFailed) { + ret = BUFFER_E; + } + else if (commit) { + ret = wolfPKCS11_Store_TpmCommit(tpmStore); + } + ctxSz = sizeof(*tpmStore) + tpmStore->bufSz; + wc_ForceZero(tpmStore, ctxSz); + XFREE(tpmStore, NULL, DYNAMIC_TYPE_TMP_BUFFER); + } #else if (ctx != NULL) { int commitRet = 0; @@ -2771,11 +2850,16 @@ int wolfPKCS11_Store_Write(void* store, unsigned char* buffer, int len) #endif #ifdef WOLFPKCS11_TPM_STORE - ret = wolfTPM2_NVWriteAuth(tpmStore->dev, &tpmStore->nv, - tpmStore->nv.handle.hndl, buffer, len, tpmStore->offset); - if (ret == 0) { - tpmStore->offset += len; - ret = len; + if (tpmStore != NULL) { + if (tpmStore->buf == NULL || buffer == NULL || len < 0 || + (word32)len > tpmStore->bufSz - tpmStore->offset) { + tpmStore->writeFailed = 1; + } + else { + XMEMCPY(tpmStore->buf + tpmStore->offset, buffer, (size_t)len); + tpmStore->offset += (word32)len; + ret = len; + } } #else if (ctx != NULL && ctx->file != XBADFILE && ctx->file != NULL) { @@ -2926,6 +3010,24 @@ static int wp11_storage_read(void* storage, unsigned char* buffer, int len) return ret; } +#ifdef DEBUG_WOLFPKCS11 +static int storeWriteFailAfter = -1; + +/** + * Test hook: make storage writes fail after a number of them succeed. + * Exposed only in debug builds so a test can interrupt a record mid-write. + * + * @param writes [in] Writes that succeed before every later write fails, + * or -1 to stop failing writes. + * @return 0 always. + */ +WP11_API int WP11_Test_StoreWriteFailAfter(int writes) +{ + storeWriteFailAfter = writes; + return 0; +} +#endif + /** * Writes a specific number of bytes from buffer. * @@ -2940,6 +3042,13 @@ static int wp11_storage_write(void* storage, unsigned char* buffer, int len) int ret = 0; unsigned char* p = buffer; +#ifdef DEBUG_WOLFPKCS11 + if (storeWriteFailAfter == 0) + return BUFFER_E; + if (storeWriteFailAfter > 0) + storeWriteFailAfter--; +#endif + /* Keep writing until no data written, error or all written. */ while (len > 0) { ret = wolfPKCS11_Store_Write(storage, p, len); diff --git a/tests/concurrent_destroy_object_test.c b/tests/concurrent_destroy_object_test.c index 7edc50c1..8b07a0bb 100644 --- a/tests/concurrent_destroy_object_test.c +++ b/tests/concurrent_destroy_object_test.c @@ -60,7 +60,8 @@ #include "testdata.h" -#if !defined(NO_AES) && !defined(SINGLE_THREADED) +#if !defined(NO_AES) && !defined(SINGLE_THREADED) && \ + !defined(WOLFPKCS11_SINGLE_THREADED) #include diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index 9388178a..92dc169b 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -48,7 +48,11 @@ #include "testdata.h" #include "pkcs11_test_util.h" -#ifndef SINGLE_THREADED +#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_SINGLE_THREADED) + #define LOGIN_TEST_THREADS +#endif + +#ifdef LOGIN_TEST_THREADS #include #include #endif @@ -361,7 +365,7 @@ static void logout_protects_all_objects_test(void) } #endif -#ifndef SINGLE_THREADED +#ifdef LOGIN_TEST_THREADS #define EMPTY_PIN_ROUNDS 8 static pthread_mutex_t infoMutex = PTHREAD_MUTEX_INITIALIZER; @@ -510,7 +514,7 @@ static void set_pin_lockout(CK_USER_TYPE type, const char* pin, int maxFails, } #endif -#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) +#if defined(LOGIN_TEST_THREADS) && !defined(WOLFPKCS11_NO_TIME) #define LOCKOUT_THREADS 6 #define LOCKOUT_ROUNDS 4 @@ -636,7 +640,7 @@ static void concurrent_login_lockout_test(void) } #endif -#ifndef SINGLE_THREADED +#ifdef LOGIN_TEST_THREADS #define CLOSE_OPEN_ROUNDS 10 static pthread_mutex_t openMutex = PTHREAD_MUTEX_INITIALIZER; @@ -727,7 +731,7 @@ static void close_last_session_race_test(void) } #endif -#ifndef SINGLE_THREADED +#ifdef LOGIN_TEST_THREADS #define CHURN_ROUNDS 200 typedef struct churn_ctx { @@ -808,7 +812,7 @@ static void find_during_object_churn_test(void) } #endif -#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_STORE) && \ +#if defined(LOGIN_TEST_THREADS) && !defined(WOLFPKCS11_NO_STORE) && \ !defined(NO_AES) #define FIND_LOGIN_ROUNDS 3 @@ -1043,7 +1047,7 @@ static void logout_drops_private_session_objects_test(void) } #endif -#if defined(DEBUG_WOLFPKCS11) && !defined(SINGLE_THREADED) && \ +#if defined(DEBUG_WOLFPKCS11) && defined(LOGIN_TEST_THREADS) && \ !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_NSS) #define FIND_HOOK_WAIT_MS 200 @@ -1151,7 +1155,7 @@ static void find_with_racing_logout_test(void) } #endif -#if defined(DEBUG_WOLFPKCS11) && !defined(SINGLE_THREADED) && \ +#if defined(DEBUG_WOLFPKCS11) && defined(LOGIN_TEST_THREADS) && \ !defined(WOLFPKCS11_NO_TIME) extern void WP11_Slot_SetPinCheckHook(void (*hook)(void)); @@ -1287,33 +1291,33 @@ static int run_test(void) if (rv != CKR_OK) return -1; -#ifndef SINGLE_THREADED +#ifdef LOGIN_TEST_THREADS empty_pin_change_requires_login_test(); #endif #ifdef LOGIN_TEST_FILE_STORE failed_login_leaves_no_token_key_test(); #endif -#ifndef SINGLE_THREADED +#ifdef LOGIN_TEST_THREADS close_last_session_race_test(); #endif #ifndef WOLFPKCS11_NSS logout_drops_private_session_objects_test(); #endif -#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) +#if defined(LOGIN_TEST_THREADS) && !defined(WOLFPKCS11_NO_TIME) concurrent_login_lockout_test(); #endif -#ifndef SINGLE_THREADED -#if defined(DEBUG_WOLFPKCS11) && !defined(SINGLE_THREADED) && \ +#if defined(DEBUG_WOLFPKCS11) && defined(LOGIN_TEST_THREADS) && \ !defined(WOLFPKCS11_NO_TIME) guess_in_flight_test(); #endif +#ifdef LOGIN_TEST_THREADS find_during_object_churn_test(); #endif -#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_STORE) && \ +#if defined(LOGIN_TEST_THREADS) && !defined(WOLFPKCS11_NO_STORE) && \ !defined(NO_AES) find_during_login_changes_test(); #endif -#if defined(DEBUG_WOLFPKCS11) && !defined(SINGLE_THREADED) && \ +#if defined(DEBUG_WOLFPKCS11) && defined(LOGIN_TEST_THREADS) && \ !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_NSS) find_with_racing_logout_test(); #endif diff --git a/tests/pkcs11mtt.c b/tests/pkcs11mtt.c index 609a85b0..2727a2ec 100644 --- a/tests/pkcs11mtt.c +++ b/tests/pkcs11mtt.c @@ -40,7 +40,8 @@ #include -#if defined(_POSIX_THREADS) && !defined(SINGLE_THREADED) +#if defined(_POSIX_THREADS) && !defined(SINGLE_THREADED) && \ + !defined(WOLFPKCS11_SINGLE_THREADED) #include #define TEST_MULTITHREADED diff --git a/tests/token_store_test.c b/tests/token_store_test.c index ebb2724c..87b8e7f4 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -52,6 +52,14 @@ #if !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_TPM_STORE) && \ !defined(WOLFPKCS11_CUSTOM_STORE) && !defined(WOLFPKCS11_NO_ENV) && \ !defined(WOLFPKCS11_USER_ENV) && !defined(_WIN32) + #define TOKEN_STORE_FILE_TEST +#elif defined(WOLFPKCS11_TPM_STORE) && defined(DEBUG_WOLFPKCS11) && \ + !defined(WOLFPKCS11_NO_ENV) && !defined(WOLFPKCS11_USER_ENV) && \ + !defined(_WIN32) + #define TOKEN_STORE_TPM_TEST +#endif + +#if defined(TOKEN_STORE_FILE_TEST) || defined(TOKEN_STORE_TPM_TEST) #include #include @@ -68,8 +76,8 @@ static CK_BBOOL ckTrue = CK_TRUE; static CK_BBOOL ckFalse = CK_FALSE; static byte keyData[16] = { 0 }; -#if !defined(WOLFSSL_STATIC_MEMORY) && !defined(WOLFSSL_DEBUG_MEMORY) && \ - !defined(NO_WOLFSSL_MEMORY) +#if defined(TOKEN_STORE_FILE_TEST) && !defined(WOLFSSL_STATIC_MEMORY) && \ + !defined(WOLFSSL_DEBUG_MEMORY) && !defined(NO_WOLFSSL_MEMORY) #define TEST_ALLOC_FAILURE static int failAllocs = 0; @@ -93,6 +101,7 @@ static void* test_realloc(void* p, size_t n) } #endif +#ifdef TOKEN_STORE_FILE_TEST static void clear_store_dir(void) { DIR* dir; @@ -115,6 +124,7 @@ static void clear_store_dir(void) } closedir(dir); } +#endif static CK_RV lib_init(void) { @@ -146,7 +156,9 @@ static CK_RV token_setup(CK_SLOT_ID* slot) CK_SESSION_HANDLE soSession = CK_INVALID_HANDLE; unsigned char label[32]; +#ifdef TOKEN_STORE_FILE_TEST clear_store_dir(); +#endif rv = lib_init(); if (rv == CKR_OK) rv = first_slot(slot); @@ -234,6 +246,7 @@ static CK_ULONG count_label(CK_SESSION_HANDLE session, const char* label) return (rv == CKR_OK) ? foundCnt : 0; } +#ifdef TOKEN_STORE_FILE_TEST /* Path of the stored record of a token object. */ static void object_record_path(CK_SLOT_ID slot, int objId, char* path, size_t pathSz) @@ -988,6 +1001,118 @@ static void test_load_record_without_trailing_fields(void) } } } +#endif /* TOKEN_STORE_FILE_TEST */ + +#ifdef TOKEN_STORE_TPM_TEST +/* Debug-only hook exported by libwolfpkcs11. */ +extern int WP11_Test_StoreWriteFailAfter(int writes); + +#define MAX_STORE_WRITES 500 + +/* Reload the token from what storage holds after storing was made to fail. */ +static CK_RV reload_stored(CK_SLOT_ID slot, CK_SESSION_HANDLE* session) +{ + CK_RV rv; + + (void)funcList->C_Finalize(NULL); + (void)WP11_Test_StoreWriteFailAfter(-1); + rv = lib_init(); + if (rv == CKR_OK) + rv = user_session(slot, session); + return rv; +} + +/* An object create that fails at any storage write keeps the stored token. */ +static void test_interrupted_create_keeps_stored_token(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + int writes; + int intact = 1; + + printf("\n--- interrupted object create keeps the stored token ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "tpm-keep", &obj); + CHECK_RV(rv, "create stored token object", CKR_OK); + } + for (writes = 0; intact && rv == CKR_OK && writes < MAX_STORE_WRITES; + writes++) { + (void)WP11_Test_StoreWriteFailAfter(writes); + rv = create_token_secret(session, "tpm-new", &obj); + if (rv == CKR_OK) { + (void)WP11_Test_StoreWriteFailAfter(-1); + break; + } + close_session(session); + session = CK_INVALID_HANDLE; + rv = reload_stored(slot, &session); + if (rv != CKR_OK || count_label(session, "tpm-keep") != 1 || + count_label(session, "tpm-new") != 0) { + printf("Stored token changed by a store failing after %d " + "writes\n", writes); + intact = 0; + } + } + CHECK_TRUE(intact, "stored token is intact after each failed create"); + CHECK_TRUE(rv == CKR_OK && writes < MAX_STORE_WRITES, + "create succeeds once storing works"); + close_session(session); + funcList->C_Finalize(NULL); +} + +/* A PIN change that fails at any storage write keeps the stored PIN. */ +static void test_interrupted_pin_change_keeps_stored_pin(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + int writes; + int intact = 1; + static const char* newPin = "wolfpkcs11-next"; + + printf("\n--- interrupted PIN change keeps the stored PIN ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "tpm-pin-keep", &obj); + CHECK_RV(rv, "create stored token object", CKR_OK); + } + for (writes = 0; intact && rv == CKR_OK && writes < MAX_STORE_WRITES; + writes++) { + (void)WP11_Test_StoreWriteFailAfter(writes); + rv = funcList->C_SetPIN(session, (CK_UTF8CHAR_PTR)userPin, + (CK_ULONG)XSTRLEN(userPin), + (CK_UTF8CHAR_PTR)newPin, + (CK_ULONG)XSTRLEN(newPin)); + if (rv == CKR_OK) { + (void)WP11_Test_StoreWriteFailAfter(-1); + break; + } + close_session(session); + session = CK_INVALID_HANDLE; + rv = reload_stored(slot, &session); + if (rv != CKR_OK || count_label(session, "tpm-pin-keep") != 1) { + printf("Stored token changed by a store failing after %d " + "writes\n", writes); + intact = 0; + } + } + CHECK_TRUE(intact, "stored PIN logs in after each failed PIN change"); + CHECK_TRUE(rv == CKR_OK && writes < MAX_STORE_WRITES, + "PIN change succeeds once storing works"); + close_session(session); + funcList->C_Finalize(NULL); +} +#endif /* TOKEN_STORE_TPM_TEST */ static int run_tests(void) { @@ -998,6 +1123,7 @@ static int run_tests(void) if (rv != CKR_OK) return -1; +#ifdef TOKEN_STORE_FILE_TEST test_objects_persist_across_storage_pause(); test_create_reports_commit_failure(); #if !defined(NO_AES) && defined(HAVE_AES_CBC) @@ -1021,6 +1147,10 @@ static int run_tests(void) #endif clear_store_dir(); +#else + test_interrupted_create_keeps_stored_token(); + test_interrupted_pin_change_keeps_stored_pin(); +#endif pkcs11_unload(); return 0; } @@ -1050,7 +1180,8 @@ int main(int argc, char* argv[]) { (void)argc; (void)argv; - printf("Token store test requires the file-backed store, skipping\n"); + printf("Token store test requires the file-backed store or a debug " + "TPM store, skipping\n"); return 77; } diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 35164ff0..c7ff02e3 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -442,6 +442,9 @@ WP11_API void WP11_Test_FailTokenInit(int fail); WP11_API void WP11_Test_StoreExitAfterRenames(int renames); WP11_API void WP11_Test_StoreCloseFailAfter(int closes); #endif +#ifndef WOLFPKCS11_NO_STORE +WP11_API int WP11_Test_StoreWriteFailAfter(int writes); +#endif #if defined(WOLFPKCS11_TPM) && (!defined(NO_RSA) || defined(HAVE_ECC)) WP11_API int WP11_Test_DecodeTpmKey(CK_SLOT_ID slotId, unsigned char* keyData, int keyDataLen); From 8677b1210b9b9915b74898759a15b43b33b74da8 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:43:50 -0700 Subject: [PATCH 075/104] F-10380 - Size and index post-quantum key records in the TPM store --- src/internal.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/internal.c b/src/internal.c index 1bf55fbd..cfd60b2f 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1233,6 +1233,12 @@ static int wolfPKCS11_Store_GetMaxSize(int type, int variableSz) case WOLFPKCS11_STORE_DHKEY_PUB: case WOLFPKCS11_STORE_CERT: case WOLFPKCS11_STORE_TRUST: + case WOLFPKCS11_STORE_MLDSAKEY_PRIV: + case WOLFPKCS11_STORE_MLDSAKEY_PUB: + case WOLFPKCS11_STORE_MLKEMKEY_PRIV: + case WOLFPKCS11_STORE_MLKEMKEY_PUB: + case WOLFPKCS11_STORE_HSSKEY_PUB: + case WOLFPKCS11_STORE_XMSSKEY_PUB: maxSz = sizeof(word32) + variableSz; break; @@ -1248,9 +1254,9 @@ static int wolfPKCS11_Store_GetMaxSize(int type, int variableSz) #ifdef WOLFPKCS11_TPM_STORE static word32 wolfPKCS11_Store_Handle(int type, CK_ULONG id1, CK_ULONG id2) { - /* Build unique handle */ + /* Build unique handle. Store types run past 0x0F, so use five bits. */ word32 nvIndex = WOLFPKCS11_TPM_NV_BASE + - ((type & 0x0F) << 16) + + ((type & 0x1F) << 16) + (((word32)id1 & 0xFF) << 8) + ((word32)id2 & 0xFF); return nvIndex; From d3796c43d2de68942abeea86e24e47f839f08095 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:38:27 -0700 Subject: [PATCH 076/104] Map TPM NV delete errors to failures --- src/internal.c | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index cfd60b2f..6b18b36c 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2351,9 +2351,15 @@ int wolfPKCS11_Store_Remove(int type, CK_ULONG id1, CK_ULONG id2) XMEMSET(&parent, 0, sizeof(parent)); parent.hndl = WOLFPKCS11_TPM_AUTH_TYPE; ret = wolfTPM2_NVDeleteAuth(tpmStore->dev, &parent, nvIndex); - if (ret != 0) { + /* TPM_RC_HANDLE carries the handle number: nothing is stored there. */ + if (ret > 0 && (ret & (RC_FMT1 | 0x3F)) == TPM_RC_HANDLE) { + ret = 0; + } + else if (ret != 0) { printf("Error %d (%s) removing NV handle 0x%x: \n", ret, wolfTPM2_GetRCString(ret), nvIndex); + /* Callers take a negative value as failure, not a TPM RC. */ + ret = WC_HW_E; } #else /* remove file */ From c22b33360b9f734bfd081d03c5ec9e7ff64d4cf3 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:38:27 -0700 Subject: [PATCH 077/104] Reject TPM records over the NV index limit --- src/internal.c | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/src/internal.c b/src/internal.c index 6b18b36c..3fb42290 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1159,6 +1159,45 @@ typedef struct WP11_TpmStore { int writeFailed; } WP11_TpmStore; static WP11_TpmStore tpmStores[1]; /* maximum of 1 open store */ +static word32 tpmNvIndexMax = 0; /* TPM_PT_NV_INDEX_MAX, 0 when unknown */ + +/** + * Read the largest NV index the TPM allows, so a record that cannot fit in + * one is refused before any NV index is touched. + * + * @return 0 on success. + * @return TPM RC or BAD_FUNC_ARG when the limit could not be read. + */ +static int wolfPKCS11_Store_TpmReadLimits(void) +{ + int rc; + GetCapability_In in; + GetCapability_Out out; + TPML_TAGGED_TPM_PROPERTY* props; + + XMEMSET(&in, 0, sizeof(in)); + XMEMSET(&out, 0, sizeof(out)); + in.capability = TPM_CAP_TPM_PROPERTIES; + in.property = TPM_PT_NV_INDEX_MAX; + in.propertyCount = 1; + rc = TPM2_GetCapability(&in, &out); + if (rc == TPM_RC_SUCCESS) { + props = &out.capabilityData.data.tpmProperties; + if (out.capabilityData.capability != TPM_CAP_TPM_PROPERTIES || + props->count < 1 || + props->tpmProperty[0].property != TPM_PT_NV_INDEX_MAX || + props->tpmProperty[0].value == 0) { + rc = BAD_FUNC_ARG; + } + else { + tpmNvIndexMax = props->tpmProperty[0].value; + } + } + if (rc != 0) + printf("TPM NV index size limit unknown: %d\n", rc); + + return rc; +} /* Internal function to get maximum size for each store type */ static int wolfPKCS11_Store_GetMaxSize(int type, int variableSz) @@ -2438,6 +2477,12 @@ int wolfPKCS11_Store_OpenSz(int type, CK_ULONG id1, CK_ULONG id2, int read, ret = NOT_AVAILABLE_E; /* read for handle that doesn't exist */ } } + else if (ret == 0 && tpmNvIndexMax != 0 && (word32)maxSz > tpmNvIndexMax) { + /* Too big for one NV index: refuse it before anything is written. */ + printf("Store record of %d bytes exceeds the TPM NV index limit of " + "%u\n", maxSz, (unsigned int)tpmNvIndexMax); + ret = BUFFER_E; + } else if (ret == 0) { /* Stage the record in its own context, NV is only touched on commit */ tpmStore = (WP11_TpmStore*)XMALLOC(sizeof(*tpmStore) + (size_t)maxSz, @@ -9212,6 +9257,10 @@ static int wp11_TpmInit(WP11_Slot* slot) "FIPS 140-2 %d, CC-EAL4 %d\n", caps.mfgStr, caps.mfg, caps.vendorStr, caps.fwVerMajor, caps.fwVerMinor, caps.fwVerVendor, caps.fips140_2, caps.cc_eal4); + #ifdef WOLFPKCS11_TPM_STORE + /* Without the limit, an oversized record fails at commit instead. */ + (void)wolfPKCS11_Store_TpmReadLimits(); + #endif } if (ret == 0) { ret = wolfTPM2_SetCryptoDevCb(&slot->tpmDev, wolfTPM2_CryptoDevCb, From f241a31c24af2eeac08f32e70e84a72ae0678e88 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:38:27 -0700 Subject: [PATCH 078/104] Test grown and overflowing TPM store records --- src/internal.c | 18 +++++ tests/token_store_test.c | 151 ++++++++++++++++++++++++++++++++++++++- wolfpkcs11/internal.h | 3 + 3 files changed, 169 insertions(+), 3 deletions(-) diff --git a/src/internal.c b/src/internal.c index 3fb42290..92db2c8d 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1160,6 +1160,20 @@ typedef struct WP11_TpmStore { } WP11_TpmStore; static WP11_TpmStore tpmStores[1]; /* maximum of 1 open store */ static word32 tpmNvIndexMax = 0; /* TPM_PT_NV_INDEX_MAX, 0 when unknown */ +#ifdef DEBUG_WOLFPKCS11 +static int tpmStoreShortBy = 0; + +/** + * Test hook: stage every record in a buffer short by the given number of + * bytes, so a write runs past it. + * + * @param bytes [in] Bytes to leave out, or 0 to disable the hook. + */ +WP11_API void WP11_Test_TpmStoreShortBy(int bytes) +{ + tpmStoreShortBy = bytes; +} +#endif /** * Read the largest NV index the TPM allows, so a record that cannot fit in @@ -2484,6 +2498,10 @@ int wolfPKCS11_Store_OpenSz(int type, CK_ULONG id1, CK_ULONG id2, int read, ret = BUFFER_E; } else if (ret == 0) { + #ifdef DEBUG_WOLFPKCS11 + if (tpmStoreShortBy > 0 && maxSz > tpmStoreShortBy) + maxSz -= tpmStoreShortBy; + #endif /* Stage the record in its own context, NV is only touched on commit */ tpmStore = (WP11_TpmStore*)XMALLOC(sizeof(*tpmStore) + (size_t)maxSz, NULL, DYNAMIC_TYPE_TMP_BUFFER); diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 87b8e7f4..087aec22 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -1004,11 +1004,66 @@ static void test_load_record_without_trailing_fields(void) #endif /* TOKEN_STORE_FILE_TEST */ #ifdef TOKEN_STORE_TPM_TEST -/* Debug-only hook exported by libwolfpkcs11. */ +/* Debug-only hooks exported by libwolfpkcs11. */ extern int WP11_Test_StoreWriteFailAfter(int writes); +extern void WP11_Test_TpmStoreShortBy(int bytes); #define MAX_STORE_WRITES 500 +static byte privateValue[16] = { + 0x5a, 0x0c, 0xe7, 0x31, 0x9b, 0x46, 0xd8, 0x2f, + 0x74, 0xa1, 0x1e, 0xc3, 0x68, 0xf5, 0x0d, 0xb2 +}; + +/* Create a private, readable token secret encrypted under the token key. */ +static CK_RV create_private_token_secret(CK_SESSION_HANDLE session, + const char* label, + CK_OBJECT_HANDLE* obj) +{ + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &genericType, sizeof(genericType) }, + { CKA_VALUE, privateValue, sizeof(privateValue) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_LABEL, NULL, 0 }, + }; + + tmpl[7].pValue = (CK_VOID_PTR)label; + tmpl[7].ulValueLen = (CK_ULONG)XSTRLEN(label); + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), obj); +} + +/* The private secret with the label is found and its value decrypts. */ +static int private_secret_usable(CK_SESSION_HANDLE session, const char* label) +{ + CK_RV rv; + CK_OBJECT_HANDLE found[8]; + CK_ULONG foundCnt = 0; + byte value[sizeof(privateValue)]; + CK_ATTRIBUTE valueAttr = { CKA_VALUE, value, sizeof(value) }; + CK_ATTRIBUTE tmpl[] = { + { CKA_LABEL, NULL, 0 }, + }; + + tmpl[0].pValue = (CK_VOID_PTR)label; + tmpl[0].ulValueLen = (CK_ULONG)XSTRLEN(label); + rv = funcList->C_FindObjectsInit(session, tmpl, 1); + if (rv == CKR_OK) { + rv = funcList->C_FindObjects(session, found, 8, &foundCnt); + funcList->C_FindObjectsFinal(session); + } + if (rv == CKR_OK && foundCnt != 1) + rv = CKR_OBJECT_HANDLE_INVALID; + if (rv == CKR_OK) + rv = funcList->C_GetAttributeValue(session, found[0], &valueAttr, 1); + return rv == CKR_OK && valueAttr.ulValueLen == sizeof(privateValue) && + XMEMCMP(value, privateValue, sizeof(privateValue)) == 0; +} + /* Reload the token from what storage holds after storing was made to fail. */ static CK_RV reload_stored(CK_SLOT_ID slot, CK_SESSION_HANDLE* session) { @@ -1086,6 +1141,10 @@ static void test_interrupted_pin_change_keeps_stored_pin(void) rv = create_token_secret(session, "tpm-pin-keep", &obj); CHECK_RV(rv, "create stored token object", CKR_OK); } + if (rv == CKR_OK) { + rv = create_private_token_secret(session, "tpm-pin-private", &obj); + CHECK_RV(rv, "create stored private token object", CKR_OK); + } for (writes = 0; intact && rv == CKR_OK && writes < MAX_STORE_WRITES; writes++) { (void)WP11_Test_StoreWriteFailAfter(writes); @@ -1100,18 +1159,102 @@ static void test_interrupted_pin_change_keeps_stored_pin(void) close_session(session); session = CK_INVALID_HANDLE; rv = reload_stored(slot, &session); - if (rv != CKR_OK || count_label(session, "tpm-pin-keep") != 1) { + /* Records under the token key must still open with the stored PIN. */ + if (rv != CKR_OK || count_label(session, "tpm-pin-keep") != 1 || + !private_secret_usable(session, "tpm-pin-private")) { printf("Stored token changed by a store failing after %d " "writes\n", writes); intact = 0; } } - CHECK_TRUE(intact, "stored PIN logs in after each failed PIN change"); + CHECK_TRUE(intact, "stored PIN and private key work after each failed " + "PIN change"); CHECK_TRUE(rv == CKR_OK && writes < MAX_STORE_WRITES, "PIN change succeeds once storing works"); close_session(session); funcList->C_Finalize(NULL); } + +/* A record that outgrows its NV index is moved to a larger one with its + * data and reloads from there. */ +static void test_grown_record_reloads(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + char longLabel[200]; + CK_ATTRIBUTE labelAttr = { CKA_LABEL, longLabel, sizeof(longLabel) - 1 }; + + printf("\n--- record that outgrows its NV index reloads ---\n"); + XMEMSET(longLabel, 'g', sizeof(longLabel) - 1); + longLabel[sizeof(longLabel) - 1] = '\0'; + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "tpm-grow", &obj); + CHECK_RV(rv, "create stored token object", CKR_OK); + } + if (rv == CKR_OK) { + rv = funcList->C_SetAttributeValue(session, obj, &labelAttr, 1); + CHECK_RV(rv, "grow the object record past its NV index", CKR_OK); + } + close_session(session); + session = CK_INVALID_HANDLE; + if (rv == CKR_OK) { + rv = reload_stored(slot, &session); + CHECK_RV(rv, "reload token", CKR_OK); + } + if (rv == CKR_OK) { + CHECK_TRUE(count_label(session, longLabel) == 1, + "grown record reloads with its new data"); + CHECK_TRUE(count_label(session, "tpm-grow") == 0, + "old record is gone"); + } + close_session(session); + funcList->C_Finalize(NULL); +} + +/* A record written past its staging buffer is reported, not committed. */ +static void test_record_overflow_reports_failure(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj; + + printf("\n--- record overflowing its staging buffer is reported ---\n"); + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv == CKR_OK) + rv = user_session(slot, &session); + if (rv == CKR_OK) { + rv = create_token_secret(session, "tpm-fit", &obj); + CHECK_RV(rv, "create stored token object", CKR_OK); + } + if (rv == CKR_OK) { + WP11_Test_TpmStoreShortBy(1); + rv = create_token_secret(session, "tpm-overflow", &obj); + WP11_Test_TpmStoreShortBy(0); + CHECK_TRUE(rv != CKR_OK, "create fails when a record overflows"); + close_session(session); + session = CK_INVALID_HANDLE; + rv = reload_stored(slot, &session); + CHECK_RV(rv, "reload token", CKR_OK); + } + if (rv == CKR_OK) { + CHECK_TRUE(count_label(session, "tpm-fit") == 1, + "stored object is still present"); + CHECK_TRUE(count_label(session, "tpm-overflow") == 0, + "overflowing object was not stored"); + rv = create_token_secret(session, "tpm-overflow", &obj); + CHECK_RV(rv, "create succeeds once records fit", CKR_OK); + } + close_session(session); + funcList->C_Finalize(NULL); +} #endif /* TOKEN_STORE_TPM_TEST */ static int run_tests(void) @@ -1150,6 +1293,8 @@ static int run_tests(void) #else test_interrupted_create_keeps_stored_token(); test_interrupted_pin_change_keeps_stored_pin(); + test_grown_record_reloads(); + test_record_overflow_reports_failure(); #endif pkcs11_unload(); return 0; diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index c7ff02e3..f0b0cb87 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -445,6 +445,9 @@ WP11_API void WP11_Test_StoreCloseFailAfter(int closes); #ifndef WOLFPKCS11_NO_STORE WP11_API int WP11_Test_StoreWriteFailAfter(int writes); #endif +#if defined(WOLFPKCS11_TPM_STORE) && !defined(WOLFPKCS11_NO_STORE) +WP11_API void WP11_Test_TpmStoreShortBy(int bytes); +#endif #if defined(WOLFPKCS11_TPM) && (!defined(NO_RSA) || defined(HAVE_ECC)) WP11_API int WP11_Test_DecodeTpmKey(CK_SLOT_ID slotId, unsigned char* keyData, int keyDataLen); From 6eec33357e3fc69c8a29327f80d8b3472a468822 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 14 Oct 2026 08:42:42 -0700 Subject: [PATCH 079/104] Map TPM store commit errors to a negative error --- src/internal.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index 92db2c8d..624d9f7c 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2649,7 +2649,8 @@ int wolfPKCS11_Store_Open(int type, CK_ULONG id1, CK_ULONG id2, int read, * * @param [in] tpmStore TPM store context holding the staged record. * @return 0 on success. - * @return Other value when the record could not be written. + * @return WC_HW_E when the TPM reports an error. + * @return Other negative value when the record could not be written. */ static int wolfPKCS11_Store_TpmCommit(WP11_TpmStore* tpmStore) { @@ -2716,6 +2717,9 @@ static int wolfPKCS11_Store_TpmCommit(WP11_TpmStore* tpmStore) ret = wolfTPM2_NVWriteAuth(tpmStore->dev, &tpmStore->nv, tpmStore->nv.handle.hndl, tpmStore->buf, tpmStore->offset, 0); } + /* Callers only treat a negative value as a failure. */ + if (ret > 0) + ret = WC_HW_E; return ret; } #endif From ea8d42d2ec98a2f106f2cf0fa63bb0d4d1397009 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Thu, 15 Oct 2026 09:39:04 -0700 Subject: [PATCH 080/104] Skip the threaded C_SetPIN race in single-threaded builds --- tests/set_pin_rekey_test.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/set_pin_rekey_test.c b/tests/set_pin_rekey_test.c index 7adaadea..8686a048 100644 --- a/tests/set_pin_rekey_test.c +++ b/tests/set_pin_rekey_test.c @@ -32,7 +32,8 @@ #include #include #endif -#if defined(_POSIX_THREADS) && !defined(SINGLE_THREADED) && !defined(_WIN32) +#if defined(_POSIX_THREADS) && !defined(SINGLE_THREADED) && \ + !defined(WOLFPKCS11_SINGLE_THREADED) && !defined(_WIN32) #include #define SET_PIN_REKEY_THREADS #endif From c06a7448316f1c61869efdf93afff98288e41ffc Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Thu, 15 Oct 2026 09:45:30 -0700 Subject: [PATCH 081/104] Fail one store write in the interrupted TPM PIN change test --- src/internal.c | 20 +++++++++++++++++++- tests/token_store_test.c | 6 ++++-- wolfpkcs11/internal.h | 1 + 3 files changed, 24 insertions(+), 3 deletions(-) diff --git a/src/internal.c b/src/internal.c index 624d9f7c..bdbb42ef 100644 --- a/src/internal.c +++ b/src/internal.c @@ -3091,6 +3091,7 @@ static int wp11_storage_read(void* storage, unsigned char* buffer, int len) #ifdef DEBUG_WOLFPKCS11 static int storeWriteFailAfter = -1; +static int storeWriteFailOnce = 0; /** * Test hook: make storage writes fail after a number of them succeed. @@ -3103,6 +3104,20 @@ static int storeWriteFailAfter = -1; WP11_API int WP11_Test_StoreWriteFailAfter(int writes) { storeWriteFailAfter = writes; + storeWriteFailOnce = 0; + return 0; +} + +/** + * Test hook: make one storage write fail after a number of them succeed. + * + * @param writes [in] Writes that succeed before the one that fails. + * @return 0 always. + */ +WP11_API int WP11_Test_StoreWriteFailOnce(int writes) +{ + storeWriteFailAfter = writes; + storeWriteFailOnce = 1; return 0; } #endif @@ -3122,8 +3137,11 @@ static int wp11_storage_write(void* storage, unsigned char* buffer, int len) unsigned char* p = buffer; #ifdef DEBUG_WOLFPKCS11 - if (storeWriteFailAfter == 0) + if (storeWriteFailAfter == 0) { + if (storeWriteFailOnce) + storeWriteFailAfter = -1; return BUFFER_E; + } if (storeWriteFailAfter > 0) storeWriteFailAfter--; #endif diff --git a/tests/token_store_test.c b/tests/token_store_test.c index 087aec22..1be6d8bf 100644 --- a/tests/token_store_test.c +++ b/tests/token_store_test.c @@ -1006,6 +1006,7 @@ static void test_load_record_without_trailing_fields(void) #ifdef TOKEN_STORE_TPM_TEST /* Debug-only hooks exported by libwolfpkcs11. */ extern int WP11_Test_StoreWriteFailAfter(int writes); +extern int WP11_Test_StoreWriteFailOnce(int writes); extern void WP11_Test_TpmStoreShortBy(int bytes); #define MAX_STORE_WRITES 500 @@ -1121,7 +1122,8 @@ static void test_interrupted_create_keeps_stored_token(void) funcList->C_Finalize(NULL); } -/* A PIN change that fails at any storage write keeps the stored PIN. */ +/* A PIN change that fails at any one storage write keeps the stored PIN. + * TPM records commit one at a time, so the old records are written back. */ static void test_interrupted_pin_change_keeps_stored_pin(void) { CK_RV rv; @@ -1147,7 +1149,7 @@ static void test_interrupted_pin_change_keeps_stored_pin(void) } for (writes = 0; intact && rv == CKR_OK && writes < MAX_STORE_WRITES; writes++) { - (void)WP11_Test_StoreWriteFailAfter(writes); + (void)WP11_Test_StoreWriteFailOnce(writes); rv = funcList->C_SetPIN(session, (CK_UTF8CHAR_PTR)userPin, (CK_ULONG)XSTRLEN(userPin), (CK_UTF8CHAR_PTR)newPin, diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index f0b0cb87..2ccad122 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -444,6 +444,7 @@ WP11_API void WP11_Test_StoreCloseFailAfter(int closes); #endif #ifndef WOLFPKCS11_NO_STORE WP11_API int WP11_Test_StoreWriteFailAfter(int writes); +WP11_API int WP11_Test_StoreWriteFailOnce(int writes); #endif #if defined(WOLFPKCS11_TPM_STORE) && !defined(WOLFPKCS11_NO_STORE) WP11_API void WP11_Test_TpmStoreShortBy(int bytes); From 80e50cd5ba84f2e7d47a5dd3a4ab281eb5c87a03 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:18:31 -0700 Subject: [PATCH 082/104] F-10396 - Reject ECDH shared data when the KDF is CKD_NULL --- src/crypto.c | 2 + tests/ec_derive_test.c | 342 +++++++++++++++++++++++++++++++++++++++++ tests/include.am | 7 + 3 files changed, 351 insertions(+) create mode 100644 tests/ec_derive_test.c diff --git a/src/crypto.c b/src/crypto.c index 873157aa..6c740397 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9668,6 +9668,8 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, return CKR_MECHANISM_PARAM_INVALID; if (params->kdf != CKD_NULL) return CKR_MECHANISM_PARAM_INVALID; + if (params->pSharedData != NULL || params->ulSharedDataLen != 0) + return CKR_MECHANISM_PARAM_INVALID; keyLen = (word32)(params->ulPublicDataLen / 2); derivedKey = (byte*)XMALLOC(keyLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c new file mode 100644 index 00000000..56012c04 --- /dev/null +++ b/tests/ec_derive_test.c @@ -0,0 +1,342 @@ +/* ec_derive_test.c + * + * Copyright (C) 2006-2025 wolfSSL Inc. + * + * This file is part of wolfPKCS11. + * + * wolfPKCS11 is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfPKCS11 is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA + * + * Tests for C_DeriveKey with CKM_ECDH1_DERIVE: mechanism parameter + * validation and the attributes of the derived key object. + */ + +#ifdef HAVE_CONFIG_H + #include +#endif + +#include + +#ifndef WOLFSSL_USER_SETTINGS + #include +#endif +#include +#include + +#ifndef WOLFPKCS11_USER_SETTINGS + #include +#endif +#include + +#ifndef HAVE_PKCS11_STATIC +#include +#endif + +#include "testdata.h" + +#define TEST_DIR "./store/ec_derive_test" + +static int test_passed = 0; +static int test_failed = 0; +static int test_skipped = 0; + +#ifndef HAVE_PKCS11_STATIC +static void* dlib; +#endif +static CK_FUNCTION_LIST* funcList; +static CK_SLOT_ID slot = 0; +static const char* tokenName = "wolfpkcs11"; +static byte* soPin = (byte*)"password123456"; +static int soPinLen = 14; +static byte* userPin = (byte*)"wolfpkcs11-test"; +static int userPinLen = 15; + +#define CHECK_RV(rv, exp, op) do { \ + if ((rv) != (exp)) { \ + fprintf(stderr, "FAIL: %s: got 0x%lx, expected 0x%lx\n", op, \ + (unsigned long)(rv), (unsigned long)(exp)); \ + test_failed++; \ + result = -1; \ + goto cleanup; \ + } \ + else { \ + printf("PASS: %s\n", op); \ + test_passed++; \ + } \ +} while (0) + +#define CHECK_CKR(rv, op) CHECK_RV(rv, CKR_OK, op) + +#ifdef HAVE_ECC +static CK_OBJECT_CLASS privKeyClass = CKO_PRIVATE_KEY; +static CK_OBJECT_CLASS secretKeyClass = CKO_SECRET_KEY; +static CK_KEY_TYPE eccKeyType = CKK_EC; +static CK_KEY_TYPE genericKeyType = CKK_GENERIC_SECRET; +static CK_BBOOL ckTrue = CK_TRUE; +static CK_BBOOL ckFalse = CK_FALSE; +static CK_ULONG secretLen = 32; + +/* Session P-256 private key usable for ECDH. */ +static CK_RV create_ec_base(CK_SESSION_HANDLE session, CK_BBOOL sensitive, + CK_BBOOL extractable, CK_OBJECT_HANDLE* obj) +{ + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &privKeyClass, sizeof(privKeyClass) }, + { CKA_KEY_TYPE, &eccKeyType, sizeof(eccKeyType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &sensitive, sizeof(sensitive) }, + { CKA_EXTRACTABLE, &extractable, sizeof(extractable) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EC_PARAMS, ecc_p256_params, sizeof(ecc_p256_params) }, + { CKA_VALUE, ecc_p256_priv, sizeof(ecc_p256_priv) }, + }; + CK_ULONG cnt = sizeof(tmpl) / sizeof(*tmpl); + + return funcList->C_CreateObject(session, tmpl, cnt, obj); +} + +/* ECDH derive of a public, extractable generic secret. */ +static CK_RV ecdh_derive(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE base, + CK_ECDH1_DERIVE_PARAMS* params, + CK_OBJECT_HANDLE* derived) +{ + CK_MECHANISM mech; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE_LEN, &secretLen, sizeof(secretLen) }, + }; + CK_ULONG cnt = sizeof(tmpl) / sizeof(*tmpl); + + mech.mechanism = CKM_ECDH1_DERIVE; + mech.pParameter = params; + mech.ulParameterLen = sizeof(*params); + + return funcList->C_DeriveKey(session, &mech, base, tmpl, cnt, derived); +} + +static void ecdh_params_init(CK_ECDH1_DERIVE_PARAMS* params, byte* point, + CK_ULONG pointLen) +{ + XMEMSET(params, 0, sizeof(*params)); + params->kdf = CKD_NULL; + params->pSharedData = NULL; + params->ulSharedDataLen = 0; + params->pPublicData = point; + params->ulPublicDataLen = pointLen; +} + +/* With CKD_NULL there is no KDF, so shared data must be absent. */ +static int test_null_kdf_shared_data(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + byte sharedData[4] = { 0x01, 0x02, 0x03, 0x04 }; + int result = 0; + + ret = create_ec_base(session, CK_FALSE, CK_TRUE, &base); + CHECK_CKR(ret, "create EC base key"); + + ecdh_params_init(¶ms, ecc_p256_point, sizeof(ecc_p256_point)); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_CKR(ret, "CKD_NULL derive without shared data"); + funcList->C_DestroyObject(session, derived); + derived = CK_INVALID_HANDLE; + + params.pSharedData = sharedData; + params.ulSharedDataLen = sizeof(sharedData); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "CKD_NULL derive rejects shared data"); + + params.pSharedData = NULL; + params.ulSharedDataLen = sizeof(sharedData); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "CKD_NULL derive rejects shared data length"); + + params.pSharedData = sharedData; + params.ulSharedDataLen = 0; + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "CKD_NULL derive rejects shared data pointer"); + +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + return result; +} +#endif /* HAVE_ECC */ + +static CK_RV pkcs11_init(void) +{ + CK_RV ret; + CK_C_INITIALIZE_ARGS args; + CK_SLOT_ID slotList[16]; + CK_ULONG slotCount = sizeof(slotList) / sizeof(slotList[0]); +#ifndef HAVE_PKCS11_STATIC + CK_C_GetFunctionList func; + + dlib = dlopen(WOLFPKCS11_DLL_FILENAME, RTLD_NOW | RTLD_LOCAL); + if (dlib == NULL) { + fprintf(stderr, "dlopen error: %s\n", dlerror()); + return -1; + } + func = (CK_C_GetFunctionList)dlsym(dlib, "C_GetFunctionList"); + if (func == NULL) { + dlclose(dlib); + dlib = NULL; + return -1; + } + ret = func(&funcList); + if (ret != CKR_OK) { + dlclose(dlib); + dlib = NULL; + return ret; + } +#else + ret = C_GetFunctionList(&funcList); + if (ret != CKR_OK) + return ret; +#endif + + XMEMSET(&args, 0, sizeof(args)); + args.flags = CKF_OS_LOCKING_OK; + ret = funcList->C_Initialize(&args); + if (ret != CKR_OK) + return ret; + + ret = funcList->C_GetSlotList(CK_TRUE, slotList, &slotCount); + if (ret != CKR_OK) + return ret; + if (slotCount == 0) + return CKR_GENERAL_ERROR; + slot = slotList[0]; + return ret; +} + +static CK_RV pkcs11_final(void) +{ + if (funcList != NULL) { + funcList->C_Finalize(NULL); + funcList = NULL; + } +#ifndef HAVE_PKCS11_STATIC + if (dlib) { + dlclose(dlib); + dlib = NULL; + } +#endif + return CKR_OK; +} + +static CK_RV pkcs11_setup_token(void) +{ + CK_RV ret; + unsigned char label[32]; + CK_SESSION_HANDLE soSession; + int sessFlags = CKF_SERIAL_SESSION | CKF_RW_SESSION; + + XMEMSET(label, ' ', sizeof(label)); + XMEMCPY(label, tokenName, XSTRLEN(tokenName)); + ret = funcList->C_InitToken(slot, soPin, soPinLen, label); + if (ret != CKR_OK) + return ret; + + ret = funcList->C_OpenSession(slot, sessFlags, NULL, NULL, &soSession); + if (ret != CKR_OK) + return ret; + ret = funcList->C_Login(soSession, CKU_SO, soPin, soPinLen); + if (ret == CKR_OK) + ret = funcList->C_InitPIN(soSession, userPin, userPinLen); + funcList->C_Logout(soSession); + funcList->C_CloseSession(soSession); + return ret; +} + +static int ec_derive_test(void) +{ + CK_RV ret; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + int sessFlags = CKF_SERIAL_SESSION | CKF_RW_SESSION; + int result = 0; + + printf("\n=== Testing C_DeriveKey with CKM_ECDH1_DERIVE ===\n"); + + ret = pkcs11_init(); + CHECK_CKR(ret, "C_Initialize"); + + ret = pkcs11_setup_token(); + CHECK_CKR(ret, "token setup"); + + ret = funcList->C_OpenSession(slot, sessFlags, NULL, NULL, &session); + CHECK_CKR(ret, "C_OpenSession"); + ret = funcList->C_Login(session, CKU_USER, userPin, userPinLen); + CHECK_CKR(ret, "C_Login"); + +#ifdef HAVE_ECC + if (test_null_kdf_shared_data(session) != 0) + result = -1; +#else + printf("ECC not available, skipping ECDH derive tests\n"); + test_skipped = 1; +#endif + +cleanup: + if (session != CK_INVALID_HANDLE) { + funcList->C_Logout(session); + funcList->C_CloseSession(session); + } + pkcs11_final(); + return result; +} + +static void print_results(void) +{ + printf("\n=== Test Results ===\n"); + printf("Tests passed: %d\n", test_passed); + printf("Tests failed: %d\n", test_failed); + if (test_skipped != 0) + printf("Tests skipped: %d\n", test_skipped); + if (test_failed == 0) + printf("ALL TESTS PASSED!\n"); + else + printf("SOME TESTS FAILED!\n"); +} + +int main(int argc, char* argv[]) +{ +#ifndef WOLFPKCS11_NO_ENV + XSETENV("WOLFPKCS11_TOKEN_PATH", TEST_DIR, 1); +#endif + (void)argc; + (void)argv; + + if (ec_derive_test() != 0 && test_failed == 0) + test_failed++; + + print_results(); +#ifndef HAVE_ECC + if (test_failed == 0) + return 77; +#endif + return (test_failed == 0) ? 0 : 1; +} diff --git a/tests/include.am b/tests/include.am index 1273180f..39189517 100644 --- a/tests/include.am +++ b/tests/include.am @@ -206,6 +206,11 @@ noinst_PROGRAMS += tests/derive_inherit_protection_test tests_derive_inherit_protection_test_SOURCES = tests/derive_inherit_protection_test.c tests_derive_inherit_protection_test_LDADD = +check_PROGRAMS += tests/ec_derive_test +noinst_PROGRAMS += tests/ec_derive_test +tests_ec_derive_test_SOURCES = tests/ec_derive_test.c +tests_ec_derive_test_LDADD = + check_PROGRAMS += tests/secret_extractable_default_test noinst_PROGRAMS += tests/secret_extractable_default_test tests_secret_extractable_default_test_SOURCES = tests/secret_extractable_default_test.c @@ -386,6 +391,7 @@ tests_private_object_empty_pin_test_LDADD += src/libwolfpkcs11.la tests_key_sensitive_default_test_LDADD += src/libwolfpkcs11.la tests_derive_disabled_key_test_LDADD += src/libwolfpkcs11.la tests_derive_inherit_protection_test_LDADD += src/libwolfpkcs11.la +tests_ec_derive_test_LDADD += src/libwolfpkcs11.la tests_secret_extractable_default_test_LDADD += src/libwolfpkcs11.la tests_rsa_private_usage_default_test_LDADD += src/libwolfpkcs11.la tests_copyobject_token_test_LDADD += src/libwolfpkcs11.la @@ -448,6 +454,7 @@ tests_private_object_empty_pin_test_LDADD += src/libwolfpkcs11.la tests_key_sensitive_default_test_LDADD += src/libwolfpkcs11.la tests_derive_disabled_key_test_LDADD += src/libwolfpkcs11.la tests_derive_inherit_protection_test_LDADD += src/libwolfpkcs11.la +tests_ec_derive_test_LDADD += src/libwolfpkcs11.la tests_secret_extractable_default_test_LDADD += src/libwolfpkcs11.la tests_rsa_private_usage_default_test_LDADD += src/libwolfpkcs11.la tests_copyobject_token_test_LDADD += src/libwolfpkcs11.la From fbf2881b756e7d6350dc24c0f4c7b9710995c5ba Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:27:22 -0700 Subject: [PATCH 083/104] F-4272 - Bound the ECDH public data length before sizing the secret --- src/crypto.c | 7 +++++-- tests/ec_derive_test.c | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 2 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 6c740397..eae1993d 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9666,6 +9666,9 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, return CKR_MECHANISM_PARAM_INVALID; if (params->ulPublicDataLen == 0) return CKR_MECHANISM_PARAM_INVALID; + /* Largest DER-wrapped uncompressed point of a supported curve. */ + if (params->ulPublicDataLen > (CK_ULONG)(2 * MAX_ECC_BYTES + 4)) + return CKR_MECHANISM_PARAM_INVALID; if (params->kdf != CKD_NULL) return CKR_MECHANISM_PARAM_INVALID; if (params->pSharedData != NULL || params->ulSharedDataLen != 0) @@ -9678,8 +9681,8 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, XMEMSET(derivedKey, 0, keyLen); ret = WP11_EC_Derive(params->pPublicData, - (int)params->ulPublicDataLen, derivedKey, - &keyLen, obj); + (word32)params->ulPublicDataLen, derivedKey, + &keyLen, obj); if (ret != 0) rv = CKR_FUNCTION_FAILED; break; diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index 56012c04..a2fe1575 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -177,6 +177,45 @@ static int test_null_kdf_shared_data(CK_SESSION_HANDLE session) CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, "CKD_NULL derive rejects shared data pointer"); +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + return result; +} + +/* A public data length beyond any encodable EC point is a parameter error. */ +static int test_public_data_length_bound(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + byte bigPoint[512]; + CK_ULONG wideLen; + int result = 0; + + ret = create_ec_base(session, CK_FALSE, CK_TRUE, &base); + CHECK_CKR(ret, "create EC base key"); + + if (sizeof(CK_ULONG) > sizeof(word32)) { + /* Upper bits set, low 32 bits equal to the real point length. */ + wideLen = ((CK_ULONG)2 << 16) << 16; + wideLen += sizeof(ecc_p256_point); + ecdh_params_init(¶ms, ecc_p256_point, wideLen); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "public data length above 32 bits rejected"); + } + + XMEMSET(bigPoint, 0, sizeof(bigPoint)); + XMEMCPY(bigPoint, ecc_p256_point, sizeof(ecc_p256_point)); + ecdh_params_init(¶ms, bigPoint, sizeof(bigPoint)); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "oversized public data length rejected"); + cleanup: if (derived != CK_INVALID_HANDLE) funcList->C_DestroyObject(session, derived); @@ -295,6 +334,8 @@ static int ec_derive_test(void) #ifdef HAVE_ECC if (test_null_kdf_shared_data(session) != 0) result = -1; + if (test_public_data_length_bound(session) != 0) + result = -1; #else printf("ECC not available, skipping ECDH derive tests\n"); test_skipped = 1; From ec6c0d3dfd789a76d000e8cd5947670a7a9a0244 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:34:07 -0700 Subject: [PATCH 084/104] F-1610 - Keep the raw point fallback for an unsupported DER length form --- src/internal.c | 11 ++++++- tests/ec_derive_test.c | 75 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 85 insertions(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index bdbb42ef..4e156848 100644 --- a/src/internal.c +++ b/src/internal.c @@ -17868,9 +17868,10 @@ int WP11_EC_Derive(unsigned char* point, word32 pointLen, unsigned char* key, /* Not valid DER encoding, treat as raw X9.63 data */ x963Data = point; x963Len = pointLen; + i = 0; } } - if (i < (int)pointLen) { + if (i > 0 && i < (int)pointLen) { expectedPointLen = priv->data.ecKey->dp->size * 2 + 1; if (pointLen > expectedPointLen) { x963Len = point[i++]; @@ -17885,6 +17886,14 @@ int WP11_EC_Derive(unsigned char* point, word32 pointLen, unsigned char* key, } ret = wc_ecc_init_ex(&pubKey, NULL, priv->devId); + if (ret == 0 && priv->data.ecKey->dp != NULL) { + /* Compressed point is size + 1 bytes, uncompressed 2 * size + 1 */ + expectedPointLen = (word32)priv->data.ecKey->dp->size + 1; + if (x963Len > 0 && x963Data[0] == ECC_POINT_UNCOMP) + expectedPointLen += (word32)priv->data.ecKey->dp->size; + if (x963Len != expectedPointLen) + ret = ECC_BAD_ARG_E; + } if (ret == 0) { if (priv->data.ecKey->dp) { ret = wc_ecc_import_x963_ex(x963Data, x963Len, &pubKey, diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index a2fe1575..f7bed926 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -223,6 +223,79 @@ static int test_public_data_length_bound(CK_SESSION_HANDLE session) funcList->C_DestroyObject(session, base); return result; } + +/* An EC point wrapped with an unsupported DER length form is not accepted. */ +static int test_unsupported_der_length_form(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE pub = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE priv = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + CK_MECHANISM genMech = { CKM_EC_KEY_PAIR_GEN, NULL, 0 }; + byte p521Params[] = { 0x06, 0x05, 0x2B, 0x81, 0x04, 0x00, 0x23 }; + byte derPoint[2 * 66 + 4]; + byte badPoint[2 * 66 + 3]; + CK_ATTRIBUTE pointAttr = { CKA_EC_POINT, derPoint, sizeof(derPoint) }; + CK_ATTRIBUTE pubTmpl[] = { + { CKA_EC_PARAMS, p521Params, sizeof(p521Params) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + }; + CK_ATTRIBUTE privTmpl[] = { + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + }; + int result = 0; + + ret = funcList->C_GenerateKeyPair(session, &genMech, pubTmpl, + sizeof(pubTmpl) / sizeof(*pubTmpl), privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &pub, &priv); + if (ret != CKR_OK) { + printf("SKIP: P-521 key generation unavailable (0x%lx)\n", + (unsigned long)ret); + test_skipped = 1; + goto cleanup; + } + + ret = funcList->C_GetAttributeValue(session, pub, &pointAttr, 1); + CHECK_CKR(ret, "read P-521 EC point"); + if (pointAttr.ulValueLen != sizeof(derPoint) || derPoint[0] != 0x04 || + derPoint[1] != 0x81 || derPoint[2] != sizeof(badPoint) - 2) { + ret = CKR_GENERAL_ERROR; + } + CHECK_CKR(ret, "P-521 EC point is DER wrapped"); + + ecdh_params_init(¶ms, derPoint, sizeof(derPoint)); + ret = ecdh_derive(session, priv, ¶ms, &derived); + CHECK_CKR(ret, "derive with DER wrapped point"); + funcList->C_DestroyObject(session, derived); + derived = CK_INVALID_HANDLE; + + /* Same point with a long-form length byte that has no length octets. */ + badPoint[0] = 0x04; + badPoint[1] = (byte)(sizeof(badPoint) - 2); + XMEMCPY(badPoint + 2, derPoint + 3, sizeof(badPoint) - 2); + ecdh_params_init(¶ms, badPoint, sizeof(badPoint)); + ret = ecdh_derive(session, priv, ¶ms, &derived); + if (ret == CKR_OK) { + fprintf(stderr, "FAIL: malformed DER length form accepted\n"); + test_failed++; + result = -1; + goto cleanup; + } + printf("PASS: malformed DER length form rejected\n"); + test_passed++; + +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (priv != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, priv); + if (pub != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, pub); + return result; +} #endif /* HAVE_ECC */ static CK_RV pkcs11_init(void) @@ -336,6 +409,8 @@ static int ec_derive_test(void) result = -1; if (test_public_data_length_bound(session) != 0) result = -1; + if (test_unsupported_der_length_form(session) != 0) + result = -1; #else printf("ECC not available, skipping ECDH derive tests\n"); test_skipped = 1; From 1a0b5d4a8dd800a34227e3bf3568e740033bddbf Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:42:03 -0700 Subject: [PATCH 085/104] F-5159 - Bound the DER point length by the ECDH public data length --- src/internal.c | 2 ++ tests/ec_derive_test.c | 46 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+) diff --git a/src/internal.c b/src/internal.c index 4e156848..596ffeb3 100644 --- a/src/internal.c +++ b/src/internal.c @@ -17886,6 +17886,8 @@ int WP11_EC_Derive(unsigned char* point, word32 pointLen, unsigned char* key, } ret = wc_ecc_init_ex(&pubKey, NULL, priv->devId); + if (ret == 0 && x963Len > pointLen - (word32)(x963Data - point)) + ret = BUFFER_E; if (ret == 0 && priv->data.ecKey->dp != NULL) { /* Compressed point is size + 1 bytes, uncompressed 2 * size + 1 */ expectedPointLen = (word32)priv->data.ecKey->dp->size + 1; diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index f7bed926..a8b2655e 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -296,6 +296,50 @@ static int test_unsupported_der_length_form(CK_SESSION_HANDLE session) funcList->C_DestroyObject(session, pub); return result; } + +/* The DER length of a wrapped point must fit in the supplied public data. */ +static int test_der_length_within_public_data(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + byte wrapped[3 + sizeof(ecc_p256_point)]; + int result = 0; + + ret = create_ec_base(session, CK_FALSE, CK_TRUE, &base); + CHECK_CKR(ret, "create EC base key"); + + wrapped[0] = 0x04; + wrapped[1] = 0x81; + wrapped[2] = (byte)sizeof(ecc_p256_point); + XMEMCPY(wrapped + 3, ecc_p256_point, sizeof(ecc_p256_point)); + + ecdh_params_init(¶ms, wrapped, sizeof(wrapped)); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_CKR(ret, "derive with complete DER wrapped point"); + funcList->C_DestroyObject(session, derived); + derived = CK_INVALID_HANDLE; + + /* Declared length runs past the end of the supplied public data. */ + ecdh_params_init(¶ms, wrapped, sizeof(wrapped) - 2); + ret = ecdh_derive(session, base, ¶ms, &derived); + if (ret == CKR_OK) { + fprintf(stderr, "FAIL: truncated DER wrapped point accepted\n"); + test_failed++; + result = -1; + goto cleanup; + } + printf("PASS: truncated DER wrapped point rejected\n"); + test_passed++; + +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + return result; +} #endif /* HAVE_ECC */ static CK_RV pkcs11_init(void) @@ -411,6 +455,8 @@ static int ec_derive_test(void) result = -1; if (test_unsupported_der_length_form(session) != 0) result = -1; + if (test_der_length_within_public_data(session) != 0) + result = -1; #else printf("ECC not available, skipping ECDH derive tests\n"); test_skipped = 1; From 3eb444bf0ec0253ae88df7e86680ffe36690fa85 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:52:14 -0700 Subject: [PATCH 086/104] F-10383 - Clear the ECDH key RNG before freeing the stack RNG --- src/internal.c | 12 ++- tests/ec_derive_test.c | 197 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 205 insertions(+), 4 deletions(-) diff --git a/src/internal.c b/src/internal.c index 596ffeb3..bab53518 100644 --- a/src/internal.c +++ b/src/internal.c @@ -17853,8 +17853,10 @@ int WP11_EC_Derive(unsigned char* point, word32 pointLen, unsigned char* key, WC_RNG rng; #endif - if (priv->onToken) - WP11_Lock_LockRO(priv->lock); + /* Exclusive: the temporary RNG is stored in the shared key. */ + if (priv->onToken) { + WP11_Lock_LockRW(priv->lock); + } /* Check if the point data is DER-encoded (starts with OCTET STRING tag) */ if (pointLen >= 3 && point[0] == ASN_OCTET_STRING) { @@ -17956,12 +17958,14 @@ int WP11_EC_Derive(unsigned char* point, word32 pointLen, unsigned char* key, } #if defined(ECC_TIMING_RESISTANT) && (!defined(HAVE_FIPS) || \ (defined(HAVE_FIPS_VERSION) && (HAVE_FIPS_VERSION > 2))) + (void)wc_ecc_set_rng(priv->data.ecKey, NULL); Rng_Free(&rng); #endif } - if (priv->onToken) - WP11_Lock_UnlockRO(priv->lock); + if (priv->onToken) { + WP11_Lock_UnlockRW(priv->lock); + } wc_ecc_free(&pubKey); diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index a8b2655e..3bb1ff90 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -45,6 +45,12 @@ #include "testdata.h" +#if defined(HAVE_ECC) && !defined(SINGLE_THREADED) && \ + !defined(WOLFPKCS11_SINGLE_THREADED) + #define EC_DERIVE_THREAD_TEST + #include +#endif + #define TEST_DIR "./store/ec_derive_test" static int test_passed = 0; @@ -340,6 +346,191 @@ static int test_der_length_within_public_data(CK_SESSION_HANDLE session) funcList->C_DestroyObject(session, base); return result; } + +/* Repeated derives with one base key leave it usable and give one secret. */ +static int test_repeated_derive_same_key(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + byte secret[sizeof(ecc_secret_256)]; + CK_ATTRIBUTE valAttr = { CKA_VALUE, secret, sizeof(secret) }; + int i; + int result = 0; + + ret = create_ec_base(session, CK_FALSE, CK_TRUE, &base); + CHECK_CKR(ret, "create EC base key"); + + ecdh_params_init(¶ms, ecc_p256_point, sizeof(ecc_p256_point)); + for (i = 0; i < 3; i++) { + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_CKR(ret, "repeated derive with one base key"); + XMEMSET(secret, 0, sizeof(secret)); + valAttr.ulValueLen = sizeof(secret); + ret = funcList->C_GetAttributeValue(session, derived, &valAttr, 1); + CHECK_CKR(ret, "read derived secret"); + if (valAttr.ulValueLen != sizeof(ecc_secret_256) || + XMEMCMP(secret, ecc_secret_256, sizeof(secret)) != 0) { + ret = CKR_GENERAL_ERROR; + } + CHECK_CKR(ret, "derived secret matches expected value"); + ret = funcList->C_DestroyObject(session, derived); + derived = CK_INVALID_HANDLE; + CHECK_CKR(ret, "destroy derived secret"); + } + +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + return result; +} + +#ifdef EC_DERIVE_THREAD_TEST +#define DERIVE_THREADS 2 +#define DERIVES_PER_THREAD 200 + +typedef struct DeriveCtx { + CK_OBJECT_HANDLE base; + int failures; +} DeriveCtx; + +static pthread_mutex_t deriveGateLock = PTHREAD_MUTEX_INITIALIZER; +static pthread_cond_t deriveGateCond = PTHREAD_COND_INITIALIZER; +static int deriveGateReady = 0; +static int deriveGateOpen = 0; + +/* Hold each worker until every worker has arrived so their derives overlap. */ +static void derive_gate_wait(void) +{ + if (pthread_mutex_lock(&deriveGateLock) == 0) { + deriveGateReady++; + (void)pthread_cond_broadcast(&deriveGateCond); + while (!deriveGateOpen) { + if (pthread_cond_wait(&deriveGateCond, &deriveGateLock) != 0) + break; + } + (void)pthread_mutex_unlock(&deriveGateLock); + } +} + +static int derive_gate_open(int workers) +{ + int ret; + + ret = pthread_mutex_lock(&deriveGateLock); + if (ret == 0) { + while (ret == 0 && deriveGateReady < workers) + ret = pthread_cond_wait(&deriveGateCond, &deriveGateLock); + deriveGateOpen = 1; + if (pthread_cond_broadcast(&deriveGateCond) != 0) + ret = -1; + if (pthread_mutex_unlock(&deriveGateLock) != 0) + ret = -1; + } + return ret; +} + +static void* derive_worker(void* arg) +{ + DeriveCtx* ctx = (DeriveCtx*)arg; + CK_RV ret; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived; + CK_ECDH1_DERIVE_PARAMS params; + byte secret[sizeof(ecc_secret_256)]; + CK_ATTRIBUTE valAttr = { CKA_VALUE, secret, sizeof(secret) }; + int i; + + derive_gate_wait(); + ret = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &session); + if (ret != CKR_OK) { + ctx->failures = DERIVES_PER_THREAD; + return NULL; + } + + ecdh_params_init(¶ms, ecc_p256_point, sizeof(ecc_p256_point)); + for (i = 0; i < DERIVES_PER_THREAD; i++) { + derived = CK_INVALID_HANDLE; + ret = ecdh_derive(session, ctx->base, ¶ms, &derived); + if (ret == CKR_OK) { + valAttr.ulValueLen = sizeof(secret); + ret = funcList->C_GetAttributeValue(session, derived, &valAttr, 1); + } + if (ret == CKR_OK && (valAttr.ulValueLen != sizeof(ecc_secret_256) || + XMEMCMP(secret, ecc_secret_256, sizeof(secret)) != 0)) { + ret = CKR_GENERAL_ERROR; + } + if (derived != CK_INVALID_HANDLE && ret == CKR_OK) + ret = funcList->C_DestroyObject(session, derived); + else if (derived != CK_INVALID_HANDLE) + (void)funcList->C_DestroyObject(session, derived); + if (ret != CKR_OK) + ctx->failures++; + } + + if (funcList->C_CloseSession(session) != CKR_OK) + ctx->failures++; + return NULL; +} + +/* Derives that share one token key run concurrently and all succeed. */ +static int test_concurrent_derive_same_key(CK_SESSION_HANDLE session) +{ + CK_RV ret = CKR_OK; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &privKeyClass, sizeof(privKeyClass) }, + { CKA_KEY_TYPE, &eccKeyType, sizeof(eccKeyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EC_PARAMS, ecc_p256_params, sizeof(ecc_p256_params) }, + { CKA_VALUE, ecc_p256_priv, sizeof(ecc_p256_priv) }, + }; + pthread_t threads[DERIVE_THREADS]; + DeriveCtx ctx[DERIVE_THREADS]; + int started = 0; + int failures = 0; + int i; + int result = 0; + + ret = funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &base); + CHECK_CKR(ret, "create EC token base key"); + + for (i = 0; i < DERIVE_THREADS; i++) { + ctx[i].base = base; + ctx[i].failures = 0; + if (pthread_create(&threads[i], NULL, derive_worker, &ctx[i]) != 0) + break; + started++; + } + if (derive_gate_open(started) != 0) + failures++; + for (i = 0; i < started; i++) { + if (pthread_join(threads[i], NULL) != 0) + failures++; + failures += ctx[i].failures; + } + if (started != DERIVE_THREADS || failures != 0) { + fprintf(stderr, "%d of %d concurrent derives failed\n", failures, + DERIVE_THREADS * DERIVES_PER_THREAD); + ret = CKR_GENERAL_ERROR; + } + CHECK_CKR(ret, "concurrent derives with one token key all succeed"); + +cleanup: + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + return result; +} +#endif /* EC_DERIVE_THREAD_TEST */ #endif /* HAVE_ECC */ static CK_RV pkcs11_init(void) @@ -457,6 +648,12 @@ static int ec_derive_test(void) result = -1; if (test_der_length_within_public_data(session) != 0) result = -1; + if (test_repeated_derive_same_key(session) != 0) + result = -1; +#ifdef EC_DERIVE_THREAD_TEST + if (test_concurrent_derive_same_key(session) != 0) + result = -1; +#endif #else printf("ECC not available, skipping ECDH derive tests\n"); test_skipped = 1; From 43faec63b32bdf7a593634a7948befb958939220 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:04:55 -0700 Subject: [PATCH 087/104] F-6959 - Require user login to derive a private key object --- src/crypto.c | 5 +++ tests/ec_derive_test.c | 93 +++++++++++++++++++++++++++++++++++++++--- 2 files changed, 92 insertions(+), 6 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index eae1993d..7735dcde 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9650,6 +9650,11 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, return ret; #endif + rv = CheckPrivateLogin(session, pTemplate, ulAttributeCount, + CKO_SECRET_KEY); + if (rv != CKR_OK) + return rv; + switch (pMechanism->mechanism) { #ifdef HAVE_ECC case CKM_ECDH1_DERIVE: { diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index 3bb1ff90..934e9534 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -112,12 +112,26 @@ static CK_RV create_ec_base(CK_SESSION_HANDLE session, CK_BBOOL sensitive, return funcList->C_CreateObject(session, tmpl, cnt, obj); } +static CK_RV ecdh_derive_tmpl(CK_SESSION_HANDLE session, + CK_OBJECT_HANDLE base, + CK_ECDH1_DERIVE_PARAMS* params, + CK_ATTRIBUTE* tmpl, CK_ULONG cnt, + CK_OBJECT_HANDLE* derived) +{ + CK_MECHANISM mech; + + mech.mechanism = CKM_ECDH1_DERIVE; + mech.pParameter = params; + mech.ulParameterLen = sizeof(*params); + + return funcList->C_DeriveKey(session, &mech, base, tmpl, cnt, derived); +} + /* ECDH derive of a public, extractable generic secret. */ static CK_RV ecdh_derive(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE base, CK_ECDH1_DERIVE_PARAMS* params, CK_OBJECT_HANDLE* derived) { - CK_MECHANISM mech; CK_ATTRIBUTE tmpl[] = { { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, @@ -128,11 +142,7 @@ static CK_RV ecdh_derive(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE base, }; CK_ULONG cnt = sizeof(tmpl) / sizeof(*tmpl); - mech.mechanism = CKM_ECDH1_DERIVE; - mech.pParameter = params; - mech.ulParameterLen = sizeof(*params); - - return funcList->C_DeriveKey(session, &mech, base, tmpl, cnt, derived); + return ecdh_derive_tmpl(session, base, params, tmpl, cnt, derived); } static void ecdh_params_init(CK_ECDH1_DERIVE_PARAMS* params, byte* point, @@ -531,6 +541,75 @@ static int test_concurrent_derive_same_key(CK_SESSION_HANDLE session) return result; } #endif /* EC_DERIVE_THREAD_TEST */ + +/* Deriving a private key object requires a user login. */ +static int test_private_derive_requires_login(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + CK_ATTRIBUTE privTmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE_LEN, &secretLen, sizeof(secretLen) }, + }; +#ifndef WOLFPKCS11_LEGACY_PRIVATE_FALSE_DEFAULT + CK_ATTRIBUTE defTmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_VALUE_LEN, &secretLen, sizeof(secretLen) }, + }; +#endif + int loggedOut = 0; + int result = 0; + + ret = funcList->C_Logout(session); + CHECK_CKR(ret, "C_Logout"); + loggedOut = 1; + + ret = create_ec_base(session, CK_FALSE, CK_TRUE, &base); + CHECK_CKR(ret, "create public EC base key without login"); + + ecdh_params_init(¶ms, ecc_p256_point, sizeof(ecc_p256_point)); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_CKR(ret, "derive public key without login"); + funcList->C_DestroyObject(session, derived); + derived = CK_INVALID_HANDLE; + + ret = ecdh_derive_tmpl(session, base, ¶ms, privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &derived); + CHECK_RV(ret, CKR_USER_NOT_LOGGED_IN, + "derive private key without login rejected"); + +#ifndef WOLFPKCS11_LEGACY_PRIVATE_FALSE_DEFAULT + ret = ecdh_derive_tmpl(session, base, ¶ms, defTmpl, + sizeof(defTmpl) / sizeof(*defTmpl), &derived); + CHECK_RV(ret, CKR_USER_NOT_LOGGED_IN, + "derive default-private secret key without login rejected"); +#endif + + ret = funcList->C_Login(session, CKU_USER, userPin, userPinLen); + CHECK_CKR(ret, "C_Login"); + loggedOut = 0; + + ret = ecdh_derive_tmpl(session, base, ¶ms, privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &derived); + CHECK_CKR(ret, "derive private key after login"); + +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + if (loggedOut && + funcList->C_Login(session, CKU_USER, userPin, userPinLen) != + CKR_OK) { + result = -1; + } + return result; +} #endif /* HAVE_ECC */ static CK_RV pkcs11_init(void) @@ -654,6 +733,8 @@ static int ec_derive_test(void) if (test_concurrent_derive_same_key(session) != 0) result = -1; #endif + if (test_private_derive_requires_login(session) != 0) + result = -1; #else printf("ECC not available, skipping ECDH derive tests\n"); test_skipped = 1; From 752701402bf276e3bd5161682a5ce00114af04d7 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:12:11 -0700 Subject: [PATCH 088/104] F-13818 - Set derived key initial states before adding the object --- src/crypto.c | 12 ++-- tests/ec_derive_test.c | 149 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 155 insertions(+), 6 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 7735dcde..5979725a 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9996,8 +9996,12 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, rv = CKR_FUNCTION_FAILED; } if (ret == 0) { - rv = AddObject(session, obj, pTemplate, - ulAttributeCount, phKey); + /* Set before AddObject so a token store has them. */ + rv = SetInitialStates(obj); + if (rv == CKR_OK) { + rv = AddObject(session, obj, pTemplate, + ulAttributeCount, phKey); + } if (rv != CKR_OK) WP11_Object_Free(obj); } @@ -10009,10 +10013,6 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, } } - if ((rv == CKR_OK) && (derivedKey != NULL)) { - rv = SetInitialStates(obj); - } - if (derivedKey != NULL) { wc_ForceZero(derivedKey, keyLen); XFREE(derivedKey, NULL, DYNAMIC_TYPE_TMP_BUFFER); diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index 934e9534..179ba8f0 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -43,6 +43,12 @@ #include #endif +#if defined(HAVE_ECC) && !defined(WOLFPKCS11_NO_STORE) && !defined(_WIN32) + #define EC_DERIVE_PERSIST_TEST + #include + #include +#endif + #include "testdata.h" #if defined(HAVE_ECC) && !defined(SINGLE_THREADED) && \ @@ -749,6 +755,145 @@ static int ec_derive_test(void) return result; } +#ifdef EC_DERIVE_PERSIST_TEST +static const char persistLabel[] = "ec-derive-persist"; + +static CK_RV open_user_session(CK_SESSION_HANDLE* session) +{ + CK_RV ret; + + ret = pkcs11_init(); + if (ret == CKR_OK) { + ret = funcList->C_OpenSession(slot, + CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, session); + } + if (ret == CKR_OK) + ret = funcList->C_Login(*session, CKU_USER, userPin, userPinLen); + return ret; +} + +/* Derive a sensitive, non-extractable token key from a generated base key. */ +static CK_RV derive_token_key(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE pub = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE priv = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_MECHANISM genMech = { CKM_EC_KEY_PAIR_GEN, NULL, 0 }; + CK_ECDH1_DERIVE_PARAMS params; + byte point[2 * 32 + 3]; + CK_ATTRIBUTE pointAttr = { CKA_EC_POINT, point, sizeof(point) }; + CK_ATTRIBUTE pubTmpl[] = { + { CKA_EC_PARAMS, ecc_p256_params, sizeof(ecc_p256_params) }, + }; + CK_ATTRIBUTE privTmpl[] = { + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + }; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_VALUE_LEN, &secretLen, sizeof(secretLen) }, + { CKA_LABEL, (void*)persistLabel, sizeof(persistLabel) - 1 }, + }; + + ret = funcList->C_GenerateKeyPair(session, &genMech, pubTmpl, + sizeof(pubTmpl) / sizeof(*pubTmpl), privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &pub, &priv); + if (ret == CKR_OK) + ret = funcList->C_GetAttributeValue(session, pub, &pointAttr, 1); + if (ret == CKR_OK) { + ecdh_params_init(¶ms, point, pointAttr.ulValueLen); + ret = ecdh_derive_tmpl(session, priv, ¶ms, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &derived); + } + return ret; +} + +/* Historical protection flags of a derived token key survive a reload even + * when the process ends without C_Finalize. */ +static int test_token_derive_states_persist(void) +{ + CK_RV ret; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_ULONG found = 0; + CK_BBOOL alwaysSensitive = CK_FALSE; + CK_BBOOL neverExtractable = CK_FALSE; + CK_ATTRIBUTE findTmpl[] = { + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_LABEL, (void*)persistLabel, sizeof(persistLabel) - 1 }, + }; + CK_ATTRIBUTE stateTmpl[] = { + { CKA_ALWAYS_SENSITIVE, &alwaysSensitive, sizeof(CK_BBOOL) }, + { CKA_NEVER_EXTRACTABLE, &neverExtractable, sizeof(CK_BBOOL) }, + }; + pid_t pid; + int status = 0; + int result = 0; + + printf("\n=== Testing derived token key state persistence ===\n"); + + pid = fork(); + if (pid == 0) { + /* Exit without C_Finalize so only stores made by the derive count. */ + ret = open_user_session(&session); + if (ret == CKR_OK) + ret = derive_token_key(session); + _exit(ret == CKR_OK ? 0 : 1); + } + if (pid < 0) + ret = CKR_GENERAL_ERROR; + else if (waitpid(pid, &status, 0) != pid || !WIFEXITED(status) || + WEXITSTATUS(status) != 0) + ret = CKR_GENERAL_ERROR; + else + ret = CKR_OK; + CHECK_CKR(ret, "derive token key in child process"); + + ret = open_user_session(&session); + CHECK_CKR(ret, "reopen token"); + + ret = funcList->C_FindObjectsInit(session, findTmpl, + sizeof(findTmpl) / sizeof(*findTmpl)); + CHECK_CKR(ret, "C_FindObjectsInit"); + ret = funcList->C_FindObjects(session, &obj, 1, &found); + if (funcList->C_FindObjectsFinal(session) != CKR_OK && ret == CKR_OK) + ret = CKR_GENERAL_ERROR; + if (ret == CKR_OK && found != 1) + ret = CKR_GENERAL_ERROR; + CHECK_CKR(ret, "find derived token key"); + + ret = funcList->C_GetAttributeValue(session, obj, stateTmpl, + sizeof(stateTmpl) / sizeof(*stateTmpl)); + CHECK_CKR(ret, "read derived key historical flags"); + if (alwaysSensitive != CK_TRUE || neverExtractable != CK_TRUE) { + fprintf(stderr, "FAIL: reloaded derived key ALWAYS_SENSITIVE=%d " + "NEVER_EXTRACTABLE=%d, expected both TRUE\n", + (int)alwaysSensitive, (int)neverExtractable); + test_failed++; + result = -1; + goto cleanup; + } + printf("PASS: reloaded derived key keeps its historical flags\n"); + test_passed++; + +cleanup: + if (obj != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, obj); + if (session != CK_INVALID_HANDLE) { + funcList->C_Logout(session); + funcList->C_CloseSession(session); + } + pkcs11_final(); + return result; +} +#endif /* EC_DERIVE_PERSIST_TEST */ + static void print_results(void) { printf("\n=== Test Results ===\n"); @@ -772,6 +917,10 @@ int main(int argc, char* argv[]) if (ec_derive_test() != 0 && test_failed == 0) test_failed++; +#ifdef EC_DERIVE_PERSIST_TEST + if (test_token_derive_states_persist() != 0 && test_failed == 0) + test_failed++; +#endif print_results(); #ifndef HAVE_ECC From 4da47e534ca99ab5c7b067ad33c7fdcea5171371 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:30:17 -0700 Subject: [PATCH 089/104] F-13816 - Derive key historical flags from the base key history --- src/crypto.c | 49 +++++++++++++++++- tests/ec_derive_test.c | 110 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 158 insertions(+), 1 deletion(-) diff --git a/src/crypto.c b/src/crypto.c index 5979725a..8011dff5 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -599,6 +599,38 @@ static CK_RV SetInitialStates(WP11_Object* key) return rv; } +#if defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF) || \ + (!defined(NO_AES) && defined(HAVE_AES_CBC)) +/* PKCS#11 derive rules: the historical flags also need the base key's. */ +static CK_RV SetDerivedStates(WP11_Object* key, CK_BBOOL baseAlwaysSensitive, + CK_BBOOL baseNeverExtractable) +{ + CK_RV rv; + CK_BBOOL getVar = CK_FALSE; + CK_BBOOL state; + CK_ULONG getVarLen = sizeof(CK_BBOOL); + + rv = WP11_Object_GetAttr(key, CKA_SENSITIVE, &getVar, &getVarLen); + if (rv == CKR_OK) { + state = (baseAlwaysSensitive == CK_TRUE && getVar == CK_TRUE) ? + CK_TRUE : CK_FALSE; + rv = WP11_Object_SetAttr(key, CKA_ALWAYS_SENSITIVE, &state, + sizeof(CK_BBOOL)); + } + if (rv == CKR_OK) { + getVarLen = sizeof(CK_BBOOL); + rv = WP11_Object_GetAttr(key, CKA_EXTRACTABLE, &getVar, &getVarLen); + } + if (rv == CKR_OK) { + state = (baseNeverExtractable == CK_TRUE && getVar == CK_FALSE) ? + CK_TRUE : CK_FALSE; + rv = WP11_Object_SetAttr(key, CKA_NEVER_EXTRACTABLE, &state, + sizeof(CK_BBOOL)); + } + return rv; +} +#endif + static CK_RV TemplateHasAttribute(CK_ATTRIBUTE_TYPE type, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount) { @@ -9586,6 +9618,12 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, CK_BBOOL baseExtractable = CK_TRUE; CK_ULONG bLen; #endif +#endif +#if defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF) || \ + (!defined(NO_AES) && defined(HAVE_AES_CBC)) + CK_BBOOL baseAlwaysSensitive = CK_FALSE; + CK_BBOOL baseNeverExtractable = CK_FALSE; + CK_ULONG histLen; #endif WOLFPKCS11_ENTER("C_DeriveKey"); @@ -9956,6 +9994,14 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, &bLen) != 0) baseExtractable = CK_TRUE; #endif + histLen = sizeof(CK_BBOOL); + if (WP11_Object_GetAttr(obj, CKA_ALWAYS_SENSITIVE, + &baseAlwaysSensitive, &histLen) != 0) + baseAlwaysSensitive = CK_FALSE; + histLen = sizeof(CK_BBOOL); + if (WP11_Object_GetAttr(obj, CKA_NEVER_EXTRACTABLE, + &baseNeverExtractable, &histLen) != 0) + baseNeverExtractable = CK_FALSE; rv = CreateObject(session, pTemplate, ulAttributeCount, &obj); if (rv == CKR_OK) { /* obj now refers to the newly created derived key. */ @@ -9997,7 +10043,8 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, } if (ret == 0) { /* Set before AddObject so a token store has them. */ - rv = SetInitialStates(obj); + rv = SetDerivedStates(obj, baseAlwaysSensitive, + baseNeverExtractable); if (rv == CKR_OK) { rv = AddObject(session, obj, pTemplate, ulAttributeCount, phKey); diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index 179ba8f0..fb4c5b16 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -616,6 +616,114 @@ static int test_private_derive_requires_login(CK_SESSION_HANDLE session) } return result; } + +static CK_RV read_states(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE obj, + CK_BBOOL* alwaysSensitive, CK_BBOOL* neverExtractable) +{ + CK_ATTRIBUTE tmpl[] = { + { CKA_ALWAYS_SENSITIVE, alwaysSensitive, sizeof(CK_BBOOL) }, + { CKA_NEVER_EXTRACTABLE, neverExtractable, sizeof(CK_BBOOL) }, + }; + + return funcList->C_GetAttributeValue(session, obj, tmpl, + sizeof(tmpl) / sizeof(*tmpl)); +} + +/* A derived key is only always-sensitive / never-extractable when its base + * key has those historical properties too. */ +static int test_derived_states_follow_base(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE pub = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + CK_MECHANISM genMech = { CKM_EC_KEY_PAIR_GEN, NULL, 0 }; + CK_BBOOL alwaysSensitive = 0xAA; + CK_BBOOL neverExtractable = 0xAA; + byte point[2 * 32 + 3]; + CK_ATTRIBUTE pointAttr = { CKA_EC_POINT, point, sizeof(point) }; + CK_ATTRIBUTE pubTmpl[] = { + { CKA_EC_PARAMS, ecc_p256_params, sizeof(ecc_p256_params) }, + }; + CK_ATTRIBUTE privTmpl[] = { + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + }; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_VALUE_LEN, &secretLen, sizeof(secretLen) }, + }; + int result = 0; + + /* An imported key was never always-sensitive or never-extractable. */ + ret = create_ec_base(session, CK_TRUE, CK_FALSE, &base); + CHECK_CKR(ret, "create imported EC base key"); + ret = read_states(session, base, &alwaysSensitive, &neverExtractable); + CHECK_CKR(ret, "read imported base historical flags"); + if (alwaysSensitive != CK_FALSE || neverExtractable != CK_FALSE) + ret = CKR_GENERAL_ERROR; + CHECK_CKR(ret, "imported base historical flags are FALSE"); + + ecdh_params_init(¶ms, ecc_p256_point, sizeof(ecc_p256_point)); + ret = ecdh_derive_tmpl(session, base, ¶ms, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &derived); + CHECK_CKR(ret, "derive from imported base key"); + ret = read_states(session, derived, &alwaysSensitive, &neverExtractable); + CHECK_CKR(ret, "read derived historical flags"); + if (alwaysSensitive != CK_FALSE || neverExtractable != CK_FALSE) { + fprintf(stderr, "FAIL: derived from imported base: " + "ALWAYS_SENSITIVE=%d NEVER_EXTRACTABLE=%d, expected FALSE\n", + (int)alwaysSensitive, (int)neverExtractable); + test_failed++; + result = -1; + goto cleanup; + } + printf("PASS: derived key does not claim history its base lacks\n"); + test_passed++; + funcList->C_DestroyObject(session, derived); + derived = CK_INVALID_HANDLE; + funcList->C_DestroyObject(session, base); + base = CK_INVALID_HANDLE; + + /* A generated sensitive, non-extractable key passes its history on. */ + ret = funcList->C_GenerateKeyPair(session, &genMech, pubTmpl, + sizeof(pubTmpl) / sizeof(*pubTmpl), privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &pub, &base); + CHECK_CKR(ret, "generate EC base key"); + ret = funcList->C_GetAttributeValue(session, pub, &pointAttr, 1); + CHECK_CKR(ret, "read generated EC point"); + + ecdh_params_init(¶ms, point, pointAttr.ulValueLen); + ret = ecdh_derive_tmpl(session, base, ¶ms, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &derived); + CHECK_CKR(ret, "derive from generated base key"); + ret = read_states(session, derived, &alwaysSensitive, &neverExtractable); + CHECK_CKR(ret, "read derived historical flags"); + if (alwaysSensitive != CK_TRUE || neverExtractable != CK_TRUE) { + fprintf(stderr, "FAIL: derived from generated base: " + "ALWAYS_SENSITIVE=%d NEVER_EXTRACTABLE=%d, expected TRUE\n", + (int)alwaysSensitive, (int)neverExtractable); + test_failed++; + result = -1; + goto cleanup; + } + printf("PASS: derived key keeps history its base has\n"); + test_passed++; + +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + if (pub != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, pub); + return result; +} #endif /* HAVE_ECC */ static CK_RV pkcs11_init(void) @@ -741,6 +849,8 @@ static int ec_derive_test(void) #endif if (test_private_derive_requires_login(session) != 0) result = -1; + if (test_derived_states_follow_base(session) != 0) + result = -1; #else printf("ECC not available, skipping ECDH derive tests\n"); test_skipped = 1; From ab9147966f3037c8eb97aff8c10ff0ee51d828b4 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:37:26 -0700 Subject: [PATCH 090/104] F-3403 - Map derived key length failures to a PKCS#11 return value --- src/crypto.c | 2 +- tests/ec_derive_test.c | 42 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 1 deletion(-) diff --git a/src/crypto.c b/src/crypto.c index 8011dff5..4bf8e42b 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -10055,7 +10055,7 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, } else { WP11_Object_Free(obj); - rv = ret; + rv = CKR_FUNCTION_FAILED; } } } diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index fb4c5b16..cb9c6eb6 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -724,6 +724,46 @@ static int test_derived_states_follow_base(CK_SESSION_HANDLE session) funcList->C_DestroyObject(session, pub); return result; } + +/* A derived key type that cannot hold the secret fails with a defined + * PKCS#11 return value. */ +static int test_unusable_key_type_defined_error(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &eccKeyType, sizeof(eccKeyType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + }; + int result = 0; + + ret = create_ec_base(session, CK_FALSE, CK_TRUE, &base); + CHECK_CKR(ret, "create EC base key"); + + ecdh_params_init(¶ms, ecc_p256_point, sizeof(ecc_p256_point)); + ret = ecdh_derive_tmpl(session, base, ¶ms, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &derived); + if (ret == CKR_OK || ret >= CKR_VENDOR_DEFINED) { + fprintf(stderr, "FAIL: derive to EC secret key returned 0x%lx\n", + (unsigned long)ret); + test_failed++; + result = -1; + goto cleanup; + } + printf("PASS: derive to unusable key type returns 0x%lx\n", + (unsigned long)ret); + test_passed++; + +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + return result; +} #endif /* HAVE_ECC */ static CK_RV pkcs11_init(void) @@ -851,6 +891,8 @@ static int ec_derive_test(void) result = -1; if (test_derived_states_follow_base(session) != 0) result = -1; + if (test_unusable_key_type_defined_error(session) != 0) + result = -1; #else printf("ECC not available, skipping ECDH derive tests\n"); test_skipped = 1; From 128a0da1846f7cb75cad54efc4748f8579529036 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:38:29 -0700 Subject: [PATCH 091/104] Test ECDH derive with well-formed points of the wrong size --- tests/ec_derive_test.c | 76 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) diff --git a/tests/ec_derive_test.c b/tests/ec_derive_test.c index cb9c6eb6..be8a9ee6 100644 --- a/tests/ec_derive_test.c +++ b/tests/ec_derive_test.c @@ -90,7 +90,33 @@ static int userPinLen = 15; #define CHECK_CKR(rv, op) CHECK_RV(rv, CKR_OK, op) +#define CHECK_FAILS(rv, op) do { \ + if ((rv) == CKR_OK) { \ + fprintf(stderr, "FAIL: %s: got CKR_OK\n", op); \ + test_failed++; \ + result = -1; \ + goto cleanup; \ + } \ + else { \ + printf("PASS: %s\n", op); \ + test_passed++; \ + } \ +} while (0) + #ifdef HAVE_ECC +/* Uncompressed P-384 public point. */ +static byte ecc_p384_point[] = { + 0x04, 0x2b, 0x46, 0xc2, 0xd4, 0x00, 0xbd, 0xba, 0xae, 0xa5, 0xd1, 0x4e, + 0xcd, 0x6e, 0x06, 0x05, 0x02, 0x41, 0xec, 0x49, 0x2f, 0x3a, 0xf6, 0x90, + 0xf4, 0x77, 0x8d, 0x2c, 0x77, 0x2e, 0x43, 0x21, 0x63, 0x47, 0x13, 0xd0, + 0x9e, 0xaf, 0x8e, 0x6c, 0x02, 0x2e, 0xd0, 0x00, 0x80, 0x5d, 0x6b, 0x3c, + 0xb8, 0x86, 0x69, 0x22, 0x1e, 0x58, 0x40, 0xdf, 0x2a, 0x8c, 0x64, 0x06, + 0x41, 0x37, 0xa0, 0xdf, 0x77, 0xd7, 0x56, 0x0f, 0x5d, 0x92, 0x5e, 0x0d, + 0x51, 0xdc, 0x79, 0xca, 0xa1, 0x7a, 0x84, 0x00, 0x98, 0x74, 0xd6, 0x82, + 0xa2, 0x55, 0xc8, 0xc6, 0x00, 0x4f, 0xf7, 0x33, 0x30, 0xfb, 0x2f, 0x8a, + 0x4a +}; + static CK_OBJECT_CLASS privKeyClass = CKO_PRIVATE_KEY; static CK_OBJECT_CLASS secretKeyClass = CKO_SECRET_KEY; static CK_KEY_TYPE eccKeyType = CKK_EC; @@ -207,6 +233,54 @@ static int test_null_kdf_shared_data(CK_SESSION_HANDLE session) return result; } +/* A well-formed point of the wrong size for the base key's curve is rejected + * raw and DER wrapped, as is a raw point one byte short or long. */ +static int test_wrong_size_point_rejected(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_ECDH1_DERIVE_PARAMS params; + byte wrapped[2 + sizeof(ecc_p384_point)]; + byte longPoint[sizeof(ecc_p256_point) + 1]; + int result = 0; + + ret = create_ec_base(session, CK_FALSE, CK_TRUE, &base); + CHECK_CKR(ret, "create EC base key"); + + ecdh_params_init(¶ms, ecc_p384_point, sizeof(ecc_p384_point)); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_FAILS(ret, "raw P-384 point against a P-256 key rejected"); + + wrapped[0] = 0x04; + wrapped[1] = (byte)sizeof(ecc_p384_point); + XMEMCPY(wrapped + 2, ecc_p384_point, sizeof(ecc_p384_point)); + ecdh_params_init(¶ms, wrapped, sizeof(wrapped)); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_FAILS(ret, "DER wrapped P-384 point against a P-256 key rejected"); + + ecdh_params_init(¶ms, ecc_p256_point, sizeof(ecc_p256_point) - 1); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_FAILS(ret, "raw point one byte short rejected"); + + XMEMCPY(longPoint, ecc_p256_point, sizeof(ecc_p256_point)); + longPoint[sizeof(longPoint) - 1] = 0x00; + ecdh_params_init(¶ms, longPoint, sizeof(longPoint)); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_FAILS(ret, "raw point one byte long rejected"); + + ecdh_params_init(¶ms, ecc_p256_point, sizeof(ecc_p256_point)); + ret = ecdh_derive(session, base, ¶ms, &derived); + CHECK_CKR(ret, "correctly sized point still derives"); + +cleanup: + if (derived != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, derived); + if (base != CK_INVALID_HANDLE) + funcList->C_DestroyObject(session, base); + return result; +} + /* A public data length beyond any encodable EC point is a parameter error. */ static int test_public_data_length_bound(CK_SESSION_HANDLE session) { @@ -875,6 +949,8 @@ static int ec_derive_test(void) #ifdef HAVE_ECC if (test_null_kdf_shared_data(session) != 0) result = -1; + if (test_wrong_size_point_rejected(session) != 0) + result = -1; if (test_public_data_length_bound(session) != 0) result = -1; if (test_unsupported_der_length_form(session) != 0) From 01bcdfe50bf09e976b3c8f658ecebde10bc1b69f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:08:54 -0700 Subject: [PATCH 092/104] F-4687 - Reject HKDF salt and info lengths beyond 32 bits --- src/crypto.c | 7 + tests/include.am | 7 + tests/kdf_tls_derive_test.c | 348 ++++++++++++++++++++++++++++++++++++ 3 files changed, 362 insertions(+) create mode 100644 tests/kdf_tls_derive_test.c diff --git a/src/crypto.c b/src/crypto.c index 4bf8e42b..f6ba8325 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9750,6 +9750,13 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, kdfParams = (CK_HKDF_PARAMS_PTR)pMechanism->pParameter; if (!kdfParams->bExpand && !kdfParams->bExtract) return CKR_MECHANISM_PARAM_INVALID; + if (kdfParams->bExtract && + kdfParams->ulSaltType == CKF_HKDF_SALT_DATA && + !CK_ULONG_FITS_WORD32(kdfParams->ulSaltLen)) + return CKR_MECHANISM_PARAM_INVALID; + if (kdfParams->bExpand && + !CK_ULONG_FITS_WORD32(kdfParams->ulInfoLen)) + return CKR_MECHANISM_PARAM_INVALID; FindAttributeType(pTemplate, ulAttributeCount, CKA_VALUE_LEN, &lenAttr); diff --git a/tests/include.am b/tests/include.am index 39189517..2c0e9d7f 100644 --- a/tests/include.am +++ b/tests/include.am @@ -211,6 +211,11 @@ noinst_PROGRAMS += tests/ec_derive_test tests_ec_derive_test_SOURCES = tests/ec_derive_test.c tests_ec_derive_test_LDADD = +check_PROGRAMS += tests/kdf_tls_derive_test +noinst_PROGRAMS += tests/kdf_tls_derive_test +tests_kdf_tls_derive_test_SOURCES = tests/kdf_tls_derive_test.c +tests_kdf_tls_derive_test_LDADD = + check_PROGRAMS += tests/secret_extractable_default_test noinst_PROGRAMS += tests/secret_extractable_default_test tests_secret_extractable_default_test_SOURCES = tests/secret_extractable_default_test.c @@ -392,6 +397,7 @@ tests_key_sensitive_default_test_LDADD += src/libwolfpkcs11.la tests_derive_disabled_key_test_LDADD += src/libwolfpkcs11.la tests_derive_inherit_protection_test_LDADD += src/libwolfpkcs11.la tests_ec_derive_test_LDADD += src/libwolfpkcs11.la +tests_kdf_tls_derive_test_LDADD += src/libwolfpkcs11.la tests_secret_extractable_default_test_LDADD += src/libwolfpkcs11.la tests_rsa_private_usage_default_test_LDADD += src/libwolfpkcs11.la tests_copyobject_token_test_LDADD += src/libwolfpkcs11.la @@ -455,6 +461,7 @@ tests_key_sensitive_default_test_LDADD += src/libwolfpkcs11.la tests_derive_disabled_key_test_LDADD += src/libwolfpkcs11.la tests_derive_inherit_protection_test_LDADD += src/libwolfpkcs11.la tests_ec_derive_test_LDADD += src/libwolfpkcs11.la +tests_kdf_tls_derive_test_LDADD += src/libwolfpkcs11.la tests_secret_extractable_default_test_LDADD += src/libwolfpkcs11.la tests_rsa_private_usage_default_test_LDADD += src/libwolfpkcs11.la tests_copyobject_token_test_LDADD += src/libwolfpkcs11.la diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c new file mode 100644 index 00000000..b37d1775 --- /dev/null +++ b/tests/kdf_tls_derive_test.c @@ -0,0 +1,348 @@ +/* kdf_tls_derive_test.c + * + * Copyright (C) 2006-2025 wolfSSL Inc. + * + * This file is part of wolfPKCS11. + * + * wolfPKCS11 is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfPKCS11 is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA + * + * Tests for C_DeriveKey with the HKDF, DH, AES-CBC and TLS 1.2 mechanisms: + * mechanism parameter validation and the attributes of the derived keys. + */ + +#ifdef HAVE_CONFIG_H + #include +#endif + +#include +#include + +#ifndef WOLFSSL_USER_SETTINGS + #include +#endif +#include +#include + +#ifndef WOLFPKCS11_USER_SETTINGS + #include +#endif +#include + +#ifndef HAVE_PKCS11_STATIC +#include +#endif + +#include "testdata.h" + +#define TEST_DIR "./store/kdf_tls_derive_test" + +/* CK_ULONG lengths above the 32-bit range can only be expressed on LP64. */ +#if ULONG_MAX > 0xFFFFFFFFUL + #define WIDE_CK_ULONG + #define LEN_ABOVE_WORD32(n) ((CK_ULONG)0xFFFFFFFFUL + 1 + (CK_ULONG)(n)) +#endif + +#if defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG) + #define SECRET_BASE_TESTS +#endif + +static int test_passed = 0; +static int test_failed = 0; + +#ifndef HAVE_PKCS11_STATIC +static void* dlib; +#endif +static CK_FUNCTION_LIST* funcList; +static CK_SLOT_ID slot = 0; +static const char* tokenName = "wolfpkcs11"; +static byte* soPin = (byte*)"password123456"; +static int soPinLen = 14; +static byte* userPin = (byte*)"wolfpkcs11-test"; +static int userPinLen = 15; + +#define CHECK_RV(rv, exp, op) do { \ + if ((rv) != (exp)) { \ + fprintf(stderr, "FAIL: %s: got 0x%lx, expected 0x%lx\n", op, \ + (unsigned long)(rv), (unsigned long)(exp)); \ + test_failed++; \ + result = -1; \ + goto cleanup; \ + } \ + else { \ + printf("PASS: %s\n", op); \ + test_passed++; \ + } \ +} while (0) + +#define CHECK_CKR(rv, op) CHECK_RV(rv, CKR_OK, op) + +#ifdef SECRET_BASE_TESTS +static CK_OBJECT_CLASS secretKeyClass = CKO_SECRET_KEY; +static CK_KEY_TYPE genericKeyType = CKK_GENERIC_SECRET; +static CK_BBOOL ckTrue = CK_TRUE; +static CK_BBOOL ckFalse = CK_FALSE; + +static byte baseSecret[32] = { + 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, + 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, + 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, + 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b +}; + +/* Session secret key of the given type usable as a derive base. */ +static CK_RV create_secret_base(CK_SESSION_HANDLE session, CK_KEY_TYPE type, + byte* value, CK_ULONG valueLen, + CK_OBJECT_HANDLE* obj) +{ + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &type, sizeof(type) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, value, valueLen }, + }; + CK_ULONG cnt = sizeof(tmpl) / sizeof(*tmpl); + + return funcList->C_CreateObject(session, tmpl, cnt, obj); +} + +/* Derive a public, extractable generic secret of the given length. */ +static CK_RV derive_generic(CK_SESSION_HANDLE session, CK_MECHANISM* mech, + CK_OBJECT_HANDLE base, CK_ULONG len, + CK_OBJECT_HANDLE* derived) +{ + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE_LEN, &len, sizeof(len) }, + }; + CK_ULONG cnt = sizeof(tmpl) / sizeof(*tmpl); + + *derived = CK_INVALID_HANDLE; + return funcList->C_DeriveKey(session, mech, base, tmpl, cnt, derived); +} + +static void destroy_obj(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE* obj) +{ + if (*obj != CK_INVALID_HANDLE) { + funcList->C_DestroyObject(session, *obj); + *obj = CK_INVALID_HANDLE; + } +} +#endif /* SECRET_BASE_TESTS */ + +#if defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG) +/* HKDF salt and info lengths must be representable without truncation. */ +static int test_hkdf_lengths_fit_word32(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + byte salt[4] = { 0x00, 0x01, 0x02, 0x03 }; + byte info[4] = { 0xf0, 0xf1, 0xf2, 0xf3 }; + CK_HKDF_PARAMS params; + CK_MECHANISM mech = { CKM_HKDF_DERIVE, ¶ms, sizeof(params) }; + int result = 0; + + ret = create_secret_base(session, CKK_GENERIC_SECRET, baseSecret, + sizeof(baseSecret), &base); + CHECK_CKR(ret, "create HKDF base key"); + + XMEMSET(¶ms, 0, sizeof(params)); + params.bExtract = CK_TRUE; + params.bExpand = CK_TRUE; + params.prfHashMechanism = CKM_SHA256; + params.ulSaltType = CKF_HKDF_SALT_DATA; + params.pSalt = salt; + params.ulSaltLen = sizeof(salt); + params.pInfo = info; + params.ulInfoLen = sizeof(info); + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_CKR(ret, "HKDF derive with in-range lengths"); + destroy_obj(session, &derived); + + params.ulSaltLen = LEN_ABOVE_WORD32(sizeof(salt)); + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "HKDF salt length beyond 32 bits rejected"); + params.ulSaltLen = sizeof(salt); + + params.bExtract = CK_FALSE; + params.ulInfoLen = LEN_ABOVE_WORD32(sizeof(info)); + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "HKDF info length beyond 32 bits rejected"); + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &base); + return result; +} +#endif + +static CK_RV pkcs11_init(void) +{ + CK_RV ret; + CK_C_INITIALIZE_ARGS args; + CK_SLOT_ID slotList[16]; + CK_ULONG slotCount = sizeof(slotList) / sizeof(slotList[0]); +#ifndef HAVE_PKCS11_STATIC + CK_C_GetFunctionList func; + + dlib = dlopen(WOLFPKCS11_DLL_FILENAME, RTLD_NOW | RTLD_LOCAL); + if (dlib == NULL) { + fprintf(stderr, "dlopen error: %s\n", dlerror()); + return -1; + } + func = (CK_C_GetFunctionList)dlsym(dlib, "C_GetFunctionList"); + if (func == NULL) { + dlclose(dlib); + dlib = NULL; + return -1; + } + ret = func(&funcList); + if (ret != CKR_OK) { + dlclose(dlib); + dlib = NULL; + return ret; + } +#else + ret = C_GetFunctionList(&funcList); + if (ret != CKR_OK) + return ret; +#endif + + XMEMSET(&args, 0, sizeof(args)); + args.flags = CKF_OS_LOCKING_OK; + ret = funcList->C_Initialize(&args); + if (ret != CKR_OK) + return ret; + + ret = funcList->C_GetSlotList(CK_TRUE, slotList, &slotCount); + if (ret != CKR_OK) + return ret; + if (slotCount == 0) + return CKR_GENERAL_ERROR; + slot = slotList[0]; + return ret; +} + +static CK_RV pkcs11_final(void) +{ + if (funcList != NULL) { + funcList->C_Finalize(NULL); + funcList = NULL; + } +#ifndef HAVE_PKCS11_STATIC + if (dlib) { + dlclose(dlib); + dlib = NULL; + } +#endif + return CKR_OK; +} + +static CK_RV pkcs11_setup_token(void) +{ + CK_RV ret; + unsigned char label[32]; + CK_SESSION_HANDLE soSession; + int sessFlags = CKF_SERIAL_SESSION | CKF_RW_SESSION; + + XMEMSET(label, ' ', sizeof(label)); + XMEMCPY(label, tokenName, XSTRLEN(tokenName)); + ret = funcList->C_InitToken(slot, soPin, soPinLen, label); + if (ret != CKR_OK) + return ret; + + ret = funcList->C_OpenSession(slot, sessFlags, NULL, NULL, &soSession); + if (ret != CKR_OK) + return ret; + ret = funcList->C_Login(soSession, CKU_SO, soPin, soPinLen); + if (ret == CKR_OK) + ret = funcList->C_InitPIN(soSession, userPin, userPinLen); + funcList->C_Logout(soSession); + funcList->C_CloseSession(soSession); + return ret; +} + +static int kdf_tls_derive_test(void) +{ + CK_RV ret; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + int sessFlags = CKF_SERIAL_SESSION | CKF_RW_SESSION; + int result = 0; + + printf("\n=== Testing C_DeriveKey with KDF and TLS mechanisms ===\n"); + + ret = pkcs11_init(); + CHECK_CKR(ret, "C_Initialize"); + + ret = pkcs11_setup_token(); + CHECK_CKR(ret, "token setup"); + + ret = funcList->C_OpenSession(slot, sessFlags, NULL, NULL, &session); + CHECK_CKR(ret, "C_OpenSession"); + ret = funcList->C_Login(session, CKU_USER, userPin, userPinLen); + CHECK_CKR(ret, "C_Login"); + +#if defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG) + if (test_hkdf_lengths_fit_word32(session) != 0) + result = -1; +#endif + +cleanup: + if (session != CK_INVALID_HANDLE) { + funcList->C_Logout(session); + funcList->C_CloseSession(session); + } + pkcs11_final(); + return result; +} + +static void print_results(void) +{ + printf("\n=== Test Results ===\n"); + printf("Tests passed: %d\n", test_passed); + printf("Tests failed: %d\n", test_failed); + if (test_failed == 0) + printf("ALL TESTS PASSED!\n"); + else + printf("SOME TESTS FAILED!\n"); +} + +int main(int argc, char* argv[]) +{ +#ifndef WOLFPKCS11_NO_ENV + XSETENV("WOLFPKCS11_TOKEN_PATH", TEST_DIR, 1); +#endif + (void)argc; + (void)argv; + + if (kdf_tls_derive_test() != 0 && test_failed == 0) + test_failed++; + + print_results(); +#ifndef SECRET_BASE_TESTS + if (test_failed == 0) + return 77; +#endif + return (test_failed == 0) ? 0 : 1; +} From 7b9ca13c078e56f27e9725cde8007fc873ce90ff Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:17:37 -0700 Subject: [PATCH 093/104] F-4804 - Reject an extended master secret session hash length beyond 32 bits --- src/crypto.c | 2 ++ tests/kdf_tls_derive_test.c | 53 ++++++++++++++++++++++++++++++++++++- 2 files changed, 54 insertions(+), 1 deletion(-) diff --git a/src/crypto.c b/src/crypto.c index f6ba8325..60e890f2 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9962,6 +9962,8 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, return CKR_MECHANISM_PARAM_INVALID; nssParams = (CK_NSS_TLS_EXTENDED_MASTER_KEY_DERIVE_PARAMS*) pMechanism->pParameter; + if (!CK_ULONG_FITS_WORD32(nssParams->ulSessionHashLen)) + return CKR_MECHANISM_PARAM_INVALID; keyLen = PRF_KEY_SIZE; derivedKey = (byte*)XMALLOC(keyLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index b37d1775..4ebb1f08 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -54,7 +54,13 @@ #define LEN_ABOVE_WORD32(n) ((CK_ULONG)0xFFFFFFFFUL + 1 + (CK_ULONG)(n)) #endif -#if defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG) +#if defined(WOLFSSL_HAVE_PRF) && defined(WOLFPKCS11_NSS) && \ + defined(WIDE_CK_ULONG) + #define NSS_EMS_WIDE_TEST +#endif + +#if (defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG)) || \ + defined(NSS_EMS_WIDE_TEST) #define SECRET_BASE_TESTS #endif @@ -197,6 +203,46 @@ static int test_hkdf_lengths_fit_word32(CK_SESSION_HANDLE session) } #endif +#ifdef NSS_EMS_WIDE_TEST +/* The extended master secret session hash length must not be truncated. */ +static int test_session_hash_length_fits_word32(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + byte sessionHash[32]; + CK_VERSION version = { 3, 3 }; + CK_NSS_TLS_EXTENDED_MASTER_KEY_DERIVE_PARAMS params; + CK_MECHANISM mech = { CKM_NSS_TLS_EXTENDED_MASTER_KEY_DERIVE, ¶ms, + sizeof(params) }; + int result = 0; + + XMEMSET(sessionHash, 0xAA, sizeof(sessionHash)); + ret = create_secret_base(session, CKK_GENERIC_SECRET, baseSecret, + sizeof(baseSecret), &base); + CHECK_CKR(ret, "create TLS base key"); + + XMEMSET(¶ms, 0, sizeof(params)); + params.prfHashMechanism = CKM_SHA256; + params.pSessionHash = sessionHash; + params.ulSessionHashLen = sizeof(sessionHash); + params.pVersion = &version; + ret = derive_generic(session, &mech, base, 48, &derived); + CHECK_CKR(ret, "extended master secret derive"); + destroy_obj(session, &derived); + + params.ulSessionHashLen = LEN_ABOVE_WORD32(sizeof(sessionHash)); + ret = derive_generic(session, &mech, base, 48, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "session hash length beyond 32 bits rejected"); + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -308,6 +354,11 @@ static int kdf_tls_derive_test(void) result = -1; #endif +#ifdef NSS_EMS_WIDE_TEST + if (test_session_hash_length_fits_word32(session) != 0) + result = -1; +#endif + cleanup: if (session != CK_INVALID_HANDLE) { funcList->C_Logout(session); From 68fe5e0eafaa70ab0494d970a165cecf1a1297ad Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:26:44 -0700 Subject: [PATCH 094/104] F-4274 - Bound the DH peer public value length by the largest supported prime --- src/crypto.c | 3 +- src/internal.c | 7 ---- tests/kdf_tls_derive_test.c | 78 +++++++++++++++++++++++++++++++++++-- wolfpkcs11/internal.h | 7 ++++ 4 files changed, 84 insertions(+), 11 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 60e890f2..4b76988f 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9797,7 +9797,8 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, return CKR_KEY_TYPE_INCONSISTENT; if (pMechanism->pParameter == NULL) return CKR_MECHANISM_PARAM_INVALID; - if (pMechanism->ulParameterLen == 0) + if (pMechanism->ulParameterLen == 0 || + pMechanism->ulParameterLen > WP11_MAX_DH_KEY_SZ) return CKR_MECHANISM_PARAM_INVALID; keyLen = (word32)pMechanism->ulParameterLen; diff --git a/src/internal.c b/src/internal.c index bab53518..84da9f18 100644 --- a/src/internal.c +++ b/src/internal.c @@ -125,13 +125,6 @@ -/* Maximum size of storage for generated/derived DH key. */ -#ifdef WOLFPKCS11_NSS -#define WP11_MAX_DH_KEY_SZ (8192/8) -#else -#define WP11_MAX_DH_KEY_SZ (4096/8) -#endif - #ifndef WP11_MAX_CERT_SZ #define WP11_MAX_CERT_SZ 4096 #endif diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index 4ebb1f08..c6618781 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -64,6 +64,10 @@ #define SECRET_BASE_TESTS #endif +#if defined(SECRET_BASE_TESTS) || !defined(NO_DH) + #define DERIVE_TESTS +#endif + static int test_passed = 0; static int test_failed = 0; @@ -94,11 +98,14 @@ static int userPinLen = 15; #define CHECK_CKR(rv, op) CHECK_RV(rv, CKR_OK, op) -#ifdef SECRET_BASE_TESTS +#ifdef DERIVE_TESTS static CK_OBJECT_CLASS secretKeyClass = CKO_SECRET_KEY; static CK_KEY_TYPE genericKeyType = CKK_GENERIC_SECRET; static CK_BBOOL ckTrue = CK_TRUE; static CK_BBOOL ckFalse = CK_FALSE; +#endif + +#ifdef SECRET_BASE_TESTS static byte baseSecret[32] = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, @@ -125,7 +132,9 @@ static CK_RV create_secret_base(CK_SESSION_HANDLE session, CK_KEY_TYPE type, return funcList->C_CreateObject(session, tmpl, cnt, obj); } +#endif /* SECRET_BASE_TESTS */ +#ifdef DERIVE_TESTS /* Derive a public, extractable generic secret of the given length. */ static CK_RV derive_generic(CK_SESSION_HANDLE session, CK_MECHANISM* mech, CK_OBJECT_HANDLE base, CK_ULONG len, @@ -152,7 +161,7 @@ static void destroy_obj(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE* obj) *obj = CK_INVALID_HANDLE; } } -#endif /* SECRET_BASE_TESTS */ +#endif /* DERIVE_TESTS */ #if defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG) /* HKDF salt and info lengths must be representable without truncation. */ @@ -243,6 +252,64 @@ static int test_session_hash_length_fits_word32(CK_SESSION_HANDLE session) } #endif +#ifndef NO_DH +/* DH peer public value lengths are bounded by the largest supported prime. */ +static int test_dh_public_length_bound(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_CLASS privClass = CKO_PRIVATE_KEY; + CK_KEY_TYPE dhType = CKK_DH; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_MECHANISM mech; + byte padded[8192 / 8 + 1]; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &privClass, sizeof(privClass) }, + { CKA_KEY_TYPE, &dhType, sizeof(dhType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIME, dh_ffdhe2048_p, sizeof(dh_ffdhe2048_p) }, + { CKA_BASE, dh_ffdhe2048_g, sizeof(dh_ffdhe2048_g) }, + { CKA_VALUE, dh_2048_priv, sizeof(dh_2048_priv) }, + }; + int result = 0; + + ret = funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &base); + CHECK_CKR(ret, "create DH base key"); + + mech.mechanism = CKM_DH_PKCS_DERIVE; + mech.pParameter = dh_2048_peer; + mech.ulParameterLen = sizeof(dh_2048_peer); + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_CKR(ret, "DH derive with peer public value"); + destroy_obj(session, &derived); + + XMEMSET(padded, 0, sizeof(padded)); + XMEMCPY(padded + sizeof(padded) - sizeof(dh_2048_peer), dh_2048_peer, + sizeof(dh_2048_peer)); + mech.pParameter = padded; + mech.ulParameterLen = sizeof(padded); + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "DH public value longer than any prime rejected"); + +#ifdef WIDE_CK_ULONG + mech.pParameter = dh_2048_peer; + mech.ulParameterLen = LEN_ABOVE_WORD32(sizeof(dh_2048_peer)); + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "DH public value length beyond 32 bits rejected"); +#endif + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -359,6 +426,11 @@ static int kdf_tls_derive_test(void) result = -1; #endif +#ifndef NO_DH + if (test_dh_public_length_bound(session) != 0) + result = -1; +#endif + cleanup: if (session != CK_INVALID_HANDLE) { funcList->C_Logout(session); @@ -391,7 +463,7 @@ int main(int argc, char* argv[]) test_failed++; print_results(); -#ifndef SECRET_BASE_TESTS +#ifndef DERIVE_TESTS if (test_failed == 0) return 77; #endif diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 2ccad122..8b27fccc 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -359,6 +359,13 @@ C_EXTRA_FLAGS="-DWOLFSSL_PUBLIC_MP -DWC_RSA_DIRECT" #define WP11_MAX_SYM_KEY_SZ 64 #endif +/* Maximum size of storage for generated/derived DH key. */ +#ifdef WOLFPKCS11_NSS +#define WP11_MAX_DH_KEY_SZ (8192/8) +#else +#define WP11_MAX_DH_KEY_SZ (4096/8) +#endif + /* Login failure constants. */ #ifndef WP11_MAX_LOGIN_FAILS_SO #define WP11_MAX_LOGIN_FAILS_SO 3 From 7bb3ce62e250bcc9bcd5cbb3c89160e0728de88e Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:33:03 -0700 Subject: [PATCH 095/104] F-5077 - Reject an AES-CBC encrypt-data length beyond 32 bits --- src/crypto.c | 2 +- tests/kdf_tls_derive_test.c | 57 ++++++++++++++++++++++++++++++++++++- 2 files changed, 57 insertions(+), 2 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 4b76988f..ef74252b 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9826,7 +9826,7 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, sizeof(CK_AES_CBC_ENCRYPT_DATA_PARAMS)) return CKR_MECHANISM_PARAM_INVALID; params = (CK_AES_CBC_ENCRYPT_DATA_PARAMS*)pMechanism->pParameter; - if (params->length % 16) + if (!CK_ULONG_FITS_WORD32(params->length) || params->length % 16) return CKR_MECHANISM_PARAM_INVALID; keyLen = (word32)params->length; diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index c6618781..ef8186c3 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -59,8 +59,12 @@ #define NSS_EMS_WIDE_TEST #endif +#if !defined(NO_AES) && defined(HAVE_AES_CBC) && defined(WIDE_CK_ULONG) + #define AES_CBC_WIDE_TEST +#endif + #if (defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG)) || \ - defined(NSS_EMS_WIDE_TEST) + defined(NSS_EMS_WIDE_TEST) || defined(AES_CBC_WIDE_TEST) #define SECRET_BASE_TESTS #endif @@ -107,12 +111,20 @@ static CK_BBOOL ckFalse = CK_FALSE; #ifdef SECRET_BASE_TESTS +/* Not every SECRET_BASE_TESTS configuration uses the shared secret. */ +#if defined(__GNUC__) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wunused-variable" +#endif static byte baseSecret[32] = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b }; +#if defined(__GNUC__) + #pragma GCC diagnostic pop +#endif /* Session secret key of the given type usable as a derive base. */ static CK_RV create_secret_base(CK_SESSION_HANDLE session, CK_KEY_TYPE type, @@ -310,6 +322,44 @@ static int test_dh_public_length_bound(CK_SESSION_HANDLE session) } #endif +#ifdef AES_CBC_WIDE_TEST +/* The AES-CBC encrypt-data length must be representable in 32 bits. */ +static int test_aes_cbc_data_length_fits_word32(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + byte key[sizeof(aes_cbc_key)]; + byte plain[sizeof(aes_cbc_plain)]; + CK_AES_CBC_ENCRYPT_DATA_PARAMS params; + CK_MECHANISM mech = { CKM_AES_CBC_ENCRYPT_DATA, ¶ms, sizeof(params) }; + int result = 0; + + XMEMCPY(key, aes_cbc_key, sizeof(key)); + XMEMCPY(plain, aes_cbc_plain, sizeof(plain)); + ret = create_secret_base(session, CKK_AES, key, sizeof(key), &base); + CHECK_CKR(ret, "create AES base key"); + + XMEMSET(¶ms, 0, sizeof(params)); + XMEMCPY(params.iv, aes_cbc_iv, sizeof(params.iv)); + params.pData = plain; + params.length = sizeof(plain); + ret = derive_generic(session, &mech, base, sizeof(plain), &derived); + CHECK_CKR(ret, "AES-CBC encrypt-data derive"); + destroy_obj(session, &derived); + + params.length = LEN_ABOVE_WORD32(sizeof(plain)); + ret = derive_generic(session, &mech, base, sizeof(plain), &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "AES-CBC data length beyond 32 bits rejected"); + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -431,6 +481,11 @@ static int kdf_tls_derive_test(void) result = -1; #endif +#ifdef AES_CBC_WIDE_TEST + if (test_aes_cbc_data_length_fits_word32(session) != 0) + result = -1; +#endif + cleanup: if (session != CK_INVALID_HANDLE) { funcList->C_Logout(session); From 584c8fbf867b04c9a48022ad2b42ddcec8fcb14a Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:39:21 -0700 Subject: [PATCH 096/104] F-10389 - Require whole-byte sizes for each TLS key material field --- src/crypto.c | 6 ++ tests/kdf_tls_derive_test.c | 121 +++++++++++++++++++++++++++++++++++- 2 files changed, 126 insertions(+), 1 deletion(-) diff --git a/src/crypto.c b/src/crypto.c index ef74252b..e64540c2 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9869,6 +9869,12 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, tlsParams->ulIVSizeInBits > ((CK_ULONG)0xFFFFFFFF / 2)) { return CKR_MECHANISM_PARAM_INVALID; } + /* Each field is extracted separately in whole bytes */ + if ((tlsParams->ulMacSizeInBits % 8) != 0 || + (tlsParams->ulKeySizeInBits % 8) != 0 || + (tlsParams->ulIVSizeInBits % 8) != 0) { + return CKR_MECHANISM_PARAM_INVALID; + } /* Check sum won't overflow on 32-bit */ if (a > (CK_ULONG)0xFFFFFFFF - b) return CKR_MECHANISM_PARAM_INVALID; diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index ef8186c3..7b70acd1 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -64,7 +64,8 @@ #endif #if (defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG)) || \ - defined(NSS_EMS_WIDE_TEST) || defined(AES_CBC_WIDE_TEST) + defined(NSS_EMS_WIDE_TEST) || defined(AES_CBC_WIDE_TEST) || \ + defined(WOLFSSL_HAVE_PRF) #define SECRET_BASE_TESTS #endif @@ -360,6 +361,119 @@ static int test_aes_cbc_data_length_fits_word32(CK_SESSION_HANDLE session) } #endif +#ifdef WOLFSSL_HAVE_PRF +static byte clientRandom[32] = { + 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, + 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, + 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, + 0x79, 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f, 0x80 +}; +static byte serverRandom[32] = { + 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, + 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, 0x50, + 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, + 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f, 0x60 +}; + +static void tls_key_mat_init(CK_TLS12_KEY_MAT_PARAMS* params, + CK_SSL3_KEY_MAT_OUT* out, CK_ULONG macBits, + CK_ULONG keyBits, CK_ULONG ivBits) +{ + XMEMSET(out, 0, sizeof(*out)); + out->hClientMacSecret = CK_INVALID_HANDLE; + out->hServerMacSecret = CK_INVALID_HANDLE; + out->hClientKey = CK_INVALID_HANDLE; + out->hServerKey = CK_INVALID_HANDLE; + XMEMSET(params, 0, sizeof(*params)); + params->ulMacSizeInBits = macBits; + params->ulKeySizeInBits = keyBits; + params->ulIVSizeInBits = ivBits; + params->bIsExport = CK_FALSE; + params->RandomInfo.pClientRandom = clientRandom; + params->RandomInfo.ulClientRandomLen = sizeof(clientRandom); + params->RandomInfo.pServerRandom = serverRandom; + params->RandomInfo.ulServerRandomLen = sizeof(serverRandom); + params->pReturnedKeyMaterial = out; + params->prfHashMechanism = CKM_SHA256; +} + +static CK_RV tls_key_mat_derive(CK_SESSION_HANDLE session, + CK_OBJECT_HANDLE base, + CK_TLS12_KEY_MAT_PARAMS* params, + CK_ATTRIBUTE* tmpl, CK_ULONG cnt) +{ + CK_MECHANISM mech; + CK_ATTRIBUTE defTmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + }; + + if (tmpl == NULL) { + tmpl = defTmpl; + cnt = sizeof(defTmpl) / sizeof(*defTmpl); + } + mech.mechanism = CKM_TLS12_KEY_AND_MAC_DERIVE; + mech.pParameter = params; + mech.ulParameterLen = sizeof(*params); + + return funcList->C_DeriveKey(session, &mech, base, tmpl, cnt, NULL); +} + +static void destroy_key_mat(CK_SESSION_HANDLE session, + CK_SSL3_KEY_MAT_OUT* out) +{ + destroy_obj(session, &out->hClientMacSecret); + destroy_obj(session, &out->hServerMacSecret); + destroy_obj(session, &out->hClientKey); + destroy_obj(session, &out->hServerKey); +} + +/* Every TLS key material size must be a whole number of bytes. */ +static int test_tls_key_sizes_byte_aligned(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_TLS12_KEY_MAT_PARAMS params; + CK_SSL3_KEY_MAT_OUT out; + byte ivClient[16]; + byte ivServer[16]; + byte master[48]; + int result = 0; + + XMEMSET(master, 0x5c, sizeof(master)); + tls_key_mat_init(¶ms, &out, 256, 128, 128); + ret = create_secret_base(session, CKK_GENERIC_SECRET, master, + sizeof(master), &base); + CHECK_CKR(ret, "create TLS master secret"); + + out.pIVClient = ivClient; + out.pIVServer = ivServer; + ret = tls_key_mat_derive(session, base, ¶ms, NULL, 0); + CHECK_CKR(ret, "TLS key and MAC derive"); + destroy_key_mat(session, &out); + + tls_key_mat_init(¶ms, &out, 4, 4, 0); + ret = tls_key_mat_derive(session, base, ¶ms, NULL, 0); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "TLS MAC and key sizes not whole bytes rejected"); + + tls_key_mat_init(¶ms, &out, 256, 128, 4); + out.pIVClient = ivClient; + out.pIVServer = ivServer; + ret = tls_key_mat_derive(session, base, ¶ms, NULL, 0); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "TLS IV size not whole bytes rejected"); + +cleanup: + destroy_key_mat(session, &out); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -486,6 +600,11 @@ static int kdf_tls_derive_test(void) result = -1; #endif +#ifdef WOLFSSL_HAVE_PRF + if (test_tls_key_sizes_byte_aligned(session) != 0) + result = -1; +#endif + cleanup: if (session != CK_INVALID_HANDLE) { funcList->C_Logout(session); From 091e10c2f4d051495ca039675c409b9f1deb7612 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 15:11:29 -0700 Subject: [PATCH 097/104] F-10381 - Use one feature guard for the derive key locals and helpers --- src/crypto.c | 27 ++++++++++---------- tests/kdf_tls_derive_test.c | 50 +++++++++++++++++++++++++++++++++++-- 2 files changed, 62 insertions(+), 15 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index e64540c2..541962f9 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -54,6 +54,12 @@ #define PRF_KEY_SIZE 48 +/* Derive mechanisms that build their output into a secret key object. */ +#if defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF) || \ + (!defined(NO_AES) && defined(HAVE_AES_CBC)) || defined(WOLFSSL_HAVE_PRF) + #define WP11_DERIVE_SECRET_KEY +#endif + /* Check that a CK_ULONG value fits in word32 with room for overhead such as * authentication tags, key wrap blocks, or padding. On LP64 platforms CK_ULONG * is 64-bit but wolfCrypt functions use word32/int for lengths. */ @@ -599,8 +605,7 @@ static CK_RV SetInitialStates(WP11_Object* key) return rv; } -#if defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF) || \ - (!defined(NO_AES) && defined(HAVE_AES_CBC)) +#ifdef WP11_DERIVE_SECRET_KEY /* PKCS#11 derive rules: the historical flags also need the base key's. */ static CK_RV SetDerivedStates(WP11_Object* key, CK_BBOOL baseAlwaysSensitive, CK_BBOOL baseNeverExtractable) @@ -9371,7 +9376,7 @@ CK_RV C_UnwrapKey(CK_SESSION_HANDLE hSession, return rv; } -#if defined(HAVE_ECC) || !defined(NO_DH) +#ifdef WP11_DERIVE_SECRET_KEY /** * Determine the key length of the object. * @@ -9395,7 +9400,7 @@ static int SymmKeyLen(WP11_Object* obj, word32 len, CK_ULONG* symmKeyLen) switch (WP11_Object_GetType(obj)) { case CKK_AES: -#ifdef WOLFPKCS11_NSS +#if defined(WOLFPKCS11_NSS) && !defined(NO_AES) /* This is the only wrapping mechanism that we support. NSS chooses * the wrapping mechanism from the list in wrapMechanismList in * PK11_GetBestWrapMechanism. Unfortunately this relies on a default @@ -9606,7 +9611,7 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, CK_RV rv = CKR_OK; WP11_Session* session; WP11_Object* obj = NULL; -#if defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF) +#ifdef WP11_DERIVE_SECRET_KEY byte* derivedKey = NULL; word32 keyLen; CK_ULONG symmKeyLen; @@ -9619,8 +9624,7 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, CK_ULONG bLen; #endif #endif -#if defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF) || \ - (!defined(NO_AES) && defined(HAVE_AES_CBC)) +#ifdef WP11_DERIVE_SECRET_KEY CK_BBOOL baseAlwaysSensitive = CK_FALSE; CK_BBOOL baseNeverExtractable = CK_FALSE; CK_ULONG histLen; @@ -9995,11 +9999,9 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, return CKR_MECHANISM_INVALID; } -#if defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF) || \ - (!defined(NO_AES) && defined(HAVE_AES_CBC)) +#ifdef WP11_DERIVE_SECRET_KEY if ((ret == 0) && (derivedKey != NULL)) { -#if (defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF)) && \ - !defined(WOLFPKCS11_LEGACY_DERIVE_NO_INHERIT) +#ifndef WOLFPKCS11_LEGACY_DERIVE_NO_INHERIT /* F-4533: read the base key's protection bits while `obj' still * refers to it, before CreateObject reuses `obj' for the new key. */ bLen = sizeof(CK_BBOOL); @@ -10021,8 +10023,7 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, rv = CreateObject(session, pTemplate, ulAttributeCount, &obj); if (rv == CKR_OK) { /* obj now refers to the newly created derived key. */ -#if (defined(HAVE_ECC) || !defined(NO_DH) || defined(WOLFPKCS11_HKDF)) && \ - !defined(WOLFPKCS11_LEGACY_DERIVE_NO_INHERIT) +#ifndef WOLFPKCS11_LEGACY_DERIVE_NO_INHERIT /* F-4533: PKCS#11 v3.0 5.5.5 - a derived key must be at least as * protected as its base key. Force the inherited attributes after * the caller template has been applied so a weaker template diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index 7b70acd1..0253b541 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -64,8 +64,8 @@ #endif #if (defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG)) || \ - defined(NSS_EMS_WIDE_TEST) || defined(AES_CBC_WIDE_TEST) || \ - defined(WOLFSSL_HAVE_PRF) + defined(NSS_EMS_WIDE_TEST) || defined(WOLFSSL_HAVE_PRF) || \ + (!defined(NO_AES) && defined(HAVE_AES_CBC)) #define SECRET_BASE_TESTS #endif @@ -474,6 +474,47 @@ static int test_tls_key_sizes_byte_aligned(CK_SESSION_HANDLE session) } #endif +#if !defined(NO_AES) && defined(HAVE_AES_CBC) +/* AES-CBC encrypt-data derives the CBC encryption of the data. */ +static int test_aes_cbc_encrypt_data_value(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + byte key[sizeof(aes_cbc_key)]; + byte plain[sizeof(aes_cbc_plain)]; + byte value[sizeof(aes_cbc_cipher)]; + CK_ATTRIBUTE valueAttr = { CKA_VALUE, value, sizeof(value) }; + CK_AES_CBC_ENCRYPT_DATA_PARAMS params; + CK_MECHANISM mech = { CKM_AES_CBC_ENCRYPT_DATA, ¶ms, sizeof(params) }; + int result = 0; + + XMEMCPY(key, aes_cbc_key, sizeof(key)); + XMEMCPY(plain, aes_cbc_plain, sizeof(plain)); + ret = create_secret_base(session, CKK_AES, key, sizeof(key), &base); + CHECK_CKR(ret, "create AES base key"); + + XMEMSET(¶ms, 0, sizeof(params)); + XMEMCPY(params.iv, aes_cbc_iv, sizeof(params.iv)); + params.pData = plain; + params.length = sizeof(plain); + ret = derive_generic(session, &mech, base, sizeof(plain), &derived); + CHECK_CKR(ret, "AES-CBC encrypt-data derive"); + + ret = funcList->C_GetAttributeValue(session, derived, &valueAttr, 1); + CHECK_CKR(ret, "read derived key value"); + if (valueAttr.ulValueLen != sizeof(aes_cbc_cipher) || + XMEMCMP(value, aes_cbc_cipher, sizeof(aes_cbc_cipher)) != 0) + ret = CKR_GENERAL_ERROR; + CHECK_CKR(ret, "derived key is the CBC encryption of the data"); + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -605,6 +646,11 @@ static int kdf_tls_derive_test(void) result = -1; #endif +#if !defined(NO_AES) && defined(HAVE_AES_CBC) + if (test_aes_cbc_encrypt_data_value(session) != 0) + result = -1; +#endif + cleanup: if (session != CK_INVALID_HANDLE) { funcList->C_Logout(session); From 601c796f8401bf66876f998cb501915667811413 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 15:27:52 -0700 Subject: [PATCH 098/104] F-11518 - Require TLS random and session hash pointers before deriving --- src/crypto.c | 7 +++- tests/kdf_tls_derive_test.c | 82 +++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+), 2 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 541962f9..5ebb5b3b 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9859,7 +9859,9 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, sizeof(CK_TLS12_KEY_MAT_PARAMS)) return CKR_MECHANISM_PARAM_INVALID; tlsParams = (CK_TLS12_KEY_MAT_PARAMS*) pMechanism->pParameter; - if (tlsParams->pReturnedKeyMaterial == NULL) + if (tlsParams->pReturnedKeyMaterial == NULL || + tlsParams->RandomInfo.pClientRandom == NULL || + tlsParams->RandomInfo.pServerRandom == NULL) return CKR_MECHANISM_PARAM_INVALID; { @@ -9973,7 +9975,8 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, return CKR_MECHANISM_PARAM_INVALID; nssParams = (CK_NSS_TLS_EXTENDED_MASTER_KEY_DERIVE_PARAMS*) pMechanism->pParameter; - if (!CK_ULONG_FITS_WORD32(nssParams->ulSessionHashLen)) + if (nssParams->pSessionHash == NULL || + !CK_ULONG_FITS_WORD32(nssParams->ulSessionHashLen)) return CKR_MECHANISM_PARAM_INVALID; keyLen = PRF_KEY_SIZE; diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index 0253b541..1201fca6 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -515,6 +515,79 @@ static int test_aes_cbc_encrypt_data_value(CK_SESSION_HANDLE session) } #endif +#ifdef WOLFSSL_HAVE_PRF +/* TLS key expansion requires both client and server random data. */ +static int test_tls_randoms_required(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_TLS12_KEY_MAT_PARAMS params; + CK_SSL3_KEY_MAT_OUT out; + byte master[48]; + int result = 0; + + XMEMSET(master, 0x5c, sizeof(master)); + tls_key_mat_init(¶ms, &out, 256, 128, 0); + ret = create_secret_base(session, CKK_GENERIC_SECRET, master, + sizeof(master), &base); + CHECK_CKR(ret, "create TLS master secret"); + + params.RandomInfo.pClientRandom = NULL; + ret = tls_key_mat_derive(session, base, ¶ms, NULL, 0); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "TLS key and MAC derive without client random rejected"); + + tls_key_mat_init(¶ms, &out, 256, 128, 0); + params.RandomInfo.pServerRandom = NULL; + ret = tls_key_mat_derive(session, base, ¶ms, NULL, 0); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "TLS key and MAC derive without server random rejected"); + +cleanup: + destroy_key_mat(session, &out); + destroy_obj(session, &base); + return result; +} +#endif + +#if defined(WOLFSSL_HAVE_PRF) && defined(WOLFPKCS11_NSS) +/* The extended master secret is bound to a session hash. */ +static int test_session_hash_required(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_VERSION version = { 3, 3 }; + CK_NSS_TLS_EXTENDED_MASTER_KEY_DERIVE_PARAMS params; + CK_MECHANISM mech = { CKM_NSS_TLS_EXTENDED_MASTER_KEY_DERIVE, ¶ms, + sizeof(params) }; + int result = 0; + + ret = create_secret_base(session, CKK_GENERIC_SECRET, baseSecret, + sizeof(baseSecret), &base); + CHECK_CKR(ret, "create TLS base key"); + + XMEMSET(¶ms, 0, sizeof(params)); + params.prfHashMechanism = CKM_SHA256; + params.pSessionHash = NULL; + params.ulSessionHashLen = 0; + params.pVersion = &version; + ret = derive_generic(session, &mech, base, 48, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "extended master secret without session hash rejected"); + + params.ulSessionHashLen = 32; + ret = derive_generic(session, &mech, base, 48, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "extended master secret with NULL session hash rejected"); + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -651,6 +724,15 @@ static int kdf_tls_derive_test(void) result = -1; #endif +#ifdef WOLFSSL_HAVE_PRF + if (test_tls_randoms_required(session) != 0) + result = -1; +#endif +#if defined(WOLFSSL_HAVE_PRF) && defined(WOLFPKCS11_NSS) + if (test_session_hash_required(session) != 0) + result = -1; +#endif + cleanup: if (session != CK_INVALID_HANDLE) { funcList->C_Logout(session); From 225319897fee3b3a3085a2ff0926f461147f24a8 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 15:38:00 -0700 Subject: [PATCH 099/104] F-4066 - Report an unsupported TLS master secret version as a parameter error --- src/crypto.c | 2 +- tests/kdf_tls_derive_test.c | 48 +++++++++++++++++++++++++++++++++++++ tests/pkcs11test.c | 2 +- 3 files changed, 50 insertions(+), 2 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 5ebb5b3b..a25ab5eb 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9944,7 +9944,7 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, return CKR_MECHANISM_PARAM_INVALID; if ((prfParams->pVersion->major != 3) || (prfParams->pVersion->minor != 3)) - return CKR_MECHANISM_INVALID; + return CKR_MECHANISM_PARAM_INVALID; } keyLen = PRF_KEY_SIZE; diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index 1201fca6..e0ff0416 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -588,6 +588,50 @@ static int test_session_hash_required(CK_SESSION_HANDLE session) } #endif +#ifdef WOLFSSL_HAVE_PRF +/* An unsupported protocol version is a mechanism parameter error. */ +static int test_tls_master_version_param(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_VERSION version = { 3, 3 }; + CK_TLS12_MASTER_KEY_DERIVE_PARAMS params; + CK_MECHANISM mech = { CKM_TLS12_MASTER_KEY_DERIVE, ¶ms, + sizeof(params) }; + byte preMaster[48]; + int result = 0; + + XMEMSET(preMaster, 0x33, sizeof(preMaster)); + preMaster[0] = 3; + preMaster[1] = 3; + ret = create_secret_base(session, CKK_GENERIC_SECRET, preMaster, + sizeof(preMaster), &base); + CHECK_CKR(ret, "create TLS pre-master secret"); + + XMEMSET(¶ms, 0, sizeof(params)); + params.RandomInfo.pClientRandom = clientRandom; + params.RandomInfo.ulClientRandomLen = sizeof(clientRandom); + params.RandomInfo.pServerRandom = serverRandom; + params.RandomInfo.ulServerRandomLen = sizeof(serverRandom); + params.pVersion = &version; + params.prfHashMechanism = CKM_SHA256; + ret = derive_generic(session, &mech, base, 48, &derived); + CHECK_CKR(ret, "TLS 1.2 master secret derive"); + destroy_obj(session, &derived); + + version.minor = 1; + ret = derive_generic(session, &mech, base, 48, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "TLS master secret derive with other version rejected"); + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -728,6 +772,10 @@ static int kdf_tls_derive_test(void) if (test_tls_randoms_required(session) != 0) result = -1; #endif +#ifdef WOLFSSL_HAVE_PRF + if (test_tls_master_version_param(session) != 0) + result = -1; +#endif #if defined(WOLFSSL_HAVE_PRF) && defined(WOLFPKCS11_NSS) if (test_session_hash_required(session) != 0) result = -1; diff --git a/tests/pkcs11test.c b/tests/pkcs11test.c index 31b29296..8ff1da8f 100644 --- a/tests/pkcs11test.c +++ b/tests/pkcs11test.c @@ -16567,7 +16567,7 @@ static CK_RV test_derive_tls12_master_key(void* args) { ret = funcList->C_DeriveKey(session, &mechanism, hBaseKey, derivedKeyTemplate, ulDerivedKeyTemplateCount, &hDerivedKey); - CHECK_CKR_FAIL(ret, CKR_MECHANISM_INVALID, "Invalid version"); + CHECK_CKR_FAIL(ret, CKR_MECHANISM_PARAM_INVALID, "Invalid version"); version.major = 3; } From 7185f2bf893c57fe78b4a9eb98cf08a7c336b10c Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 16:00:13 -0700 Subject: [PATCH 100/104] F-13245 - Reject a derived key length larger than the derived secret --- src/crypto.c | 29 ++++++++- tests/kdf_tls_derive_test.c | 119 +++++++++++++++++++++++++++++++++++- tests/pkcs11test.c | 2 +- 3 files changed, 147 insertions(+), 3 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index a25ab5eb..aa8a4733 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9628,6 +9628,11 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, CK_BBOOL baseAlwaysSensitive = CK_FALSE; CK_BBOOL baseNeverExtractable = CK_FALSE; CK_ULONG histLen; + CK_ATTRIBUTE* valueLenAttr = NULL; + CK_ULONG reqValueLen = 0; +#endif +#ifndef NO_DH + CK_ULONG dhPrimeLen = 0; #endif WOLFPKCS11_ENTER("C_DeriveKey"); @@ -10023,7 +10028,29 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, if (WP11_Object_GetAttr(obj, CKA_NEVER_EXTRACTABLE, &baseNeverExtractable, &histLen) != 0) baseNeverExtractable = CK_FALSE; - rv = CreateObject(session, pTemplate, ulAttributeCount, &obj); + FindAttributeType(pTemplate, ulAttributeCount, CKA_VALUE_LEN, + &valueLenAttr); + if ((valueLenAttr != NULL) && (valueLenAttr->pValue != NULL) && + (valueLenAttr->ulValueLen == sizeof(CK_ULONG))) { + XMEMCPY(&reqValueLen, valueLenAttr->pValue, sizeof(CK_ULONG)); + } +#ifndef NO_DH + /* DH agreement drops leading zero bytes; restore up to the prime + * length on request. */ + if ((pMechanism->mechanism == CKM_DH_PKCS_DERIVE) && + (reqValueLen > keyLen) && + (reqValueLen <= pMechanism->ulParameterLen) && + (WP11_Object_GetAttr(obj, CKA_PRIME, NULL, &dhPrimeLen) == 0) && + (reqValueLen <= dhPrimeLen)) { + XMEMMOVE(derivedKey + (reqValueLen - keyLen), derivedKey, keyLen); + XMEMSET(derivedKey, 0, reqValueLen - keyLen); + keyLen = (word32)reqValueLen; + } +#endif + if (reqValueLen > keyLen) + rv = CKR_ATTRIBUTE_VALUE_INVALID; + if (rv == CKR_OK) + rv = CreateObject(session, pTemplate, ulAttributeCount, &obj); if (rv == CKR_OK) { /* obj now refers to the newly created derived key. */ #ifndef WOLFPKCS11_LEGACY_DERIVE_NO_INHERIT diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index e0ff0416..ba850ded 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -63,7 +63,7 @@ #define AES_CBC_WIDE_TEST #endif -#if (defined(WOLFPKCS11_HKDF) && defined(WIDE_CK_ULONG)) || \ +#if defined(WOLFPKCS11_HKDF) || \ defined(NSS_EMS_WIDE_TEST) || defined(WOLFSSL_HAVE_PRF) || \ (!defined(NO_AES) && defined(HAVE_AES_CBC)) #define SECRET_BASE_TESTS @@ -632,6 +632,117 @@ static int test_tls_master_version_param(CK_SESSION_HANDLE session) } #endif +#if defined(WOLFPKCS11_HKDF) || !defined(NO_DH) || \ + (!defined(NO_AES) && defined(HAVE_AES_CBC)) +/* A derived key has the requested CKA_VALUE_LEN or the derive fails. */ +static int test_derived_length_matches_template(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_MECHANISM mech; +#ifdef WOLFPKCS11_HKDF + CK_HKDF_PARAMS hkdfParams; +#endif +#if !defined(NO_AES) && defined(HAVE_AES_CBC) + byte key[sizeof(aes_cbc_key)]; + byte plain[sizeof(aes_cbc_plain)]; + CK_AES_CBC_ENCRYPT_DATA_PARAMS cbcParams; +#endif +#ifndef NO_DH + CK_OBJECT_CLASS privClass = CKO_PRIVATE_KEY; + CK_KEY_TYPE dhType = CKK_DH; + byte peer[2 * sizeof(dh_ffdhe2048_p)]; + byte value[sizeof(dh_ffdhe2048_p)]; + CK_ATTRIBUTE valueAttr = { CKA_VALUE, value, sizeof(value) }; + CK_ATTRIBUTE dhTmpl[] = { + { CKA_CLASS, &privClass, sizeof(privClass) }, + { CKA_KEY_TYPE, &dhType, sizeof(dhType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIME, dh_ffdhe2048_p, sizeof(dh_ffdhe2048_p) }, + { CKA_BASE, dh_ffdhe2048_g, sizeof(dh_ffdhe2048_g) }, + { CKA_VALUE, dh_2048_priv, sizeof(dh_2048_priv) }, + }; +#endif + int result = 0; + +#ifdef WOLFPKCS11_HKDF + ret = create_secret_base(session, CKK_GENERIC_SECRET, baseSecret, + sizeof(baseSecret), &base); + CHECK_CKR(ret, "create HKDF base key"); + XMEMSET(&hkdfParams, 0, sizeof(hkdfParams)); + hkdfParams.bExtract = CK_TRUE; + hkdfParams.bExpand = CK_FALSE; + hkdfParams.prfHashMechanism = CKM_SHA256; + hkdfParams.ulSaltType = CKF_HKDF_SALT_NULL; + mech.mechanism = CKM_HKDF_DERIVE; + mech.pParameter = &hkdfParams; + mech.ulParameterLen = sizeof(hkdfParams); + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_CKR(ret, "HKDF extract with digest-sized length"); + destroy_obj(session, &derived); + ret = derive_generic(session, &mech, base, 48, &derived); + CHECK_RV(ret, CKR_ATTRIBUTE_VALUE_INVALID, + "HKDF extract longer than the digest rejected"); + destroy_obj(session, &base); +#endif + +#if !defined(NO_AES) && defined(HAVE_AES_CBC) + XMEMCPY(key, aes_cbc_key, sizeof(key)); + XMEMCPY(plain, aes_cbc_plain, sizeof(plain)); + ret = create_secret_base(session, CKK_AES, key, sizeof(key), &base); + CHECK_CKR(ret, "create AES base key"); + XMEMSET(&cbcParams, 0, sizeof(cbcParams)); + XMEMCPY(cbcParams.iv, aes_cbc_iv, sizeof(cbcParams.iv)); + cbcParams.pData = plain; + cbcParams.length = sizeof(plain); + mech.mechanism = CKM_AES_CBC_ENCRYPT_DATA; + mech.pParameter = &cbcParams; + mech.ulParameterLen = sizeof(cbcParams); + ret = derive_generic(session, &mech, base, 2 * sizeof(plain), &derived); + CHECK_RV(ret, CKR_ATTRIBUTE_VALUE_INVALID, + "AES-CBC encrypt-data longer than the data rejected"); + destroy_obj(session, &base); +#endif + +#ifndef NO_DH + ret = funcList->C_CreateObject(session, dhTmpl, + sizeof(dhTmpl) / sizeof(*dhTmpl), &base); + CHECK_CKR(ret, "create DH base key"); + /* This peer value gives a shared secret with a leading zero byte. */ + XMEMSET(peer, 0, sizeof(peer)); + peer[sizeof(peer) - 2] = 0x01; + peer[sizeof(peer) - 1] = 0x5f; + mech.mechanism = CKM_DH_PKCS_DERIVE; + mech.pParameter = peer + sizeof(dh_ffdhe2048_p); + mech.ulParameterLen = sizeof(dh_ffdhe2048_p); + ret = derive_generic(session, &mech, base, sizeof(dh_ffdhe2048_p), + &derived); + CHECK_CKR(ret, "DH derive of a prime-sized secret"); + ret = funcList->C_GetAttributeValue(session, derived, &valueAttr, 1); + CHECK_CKR(ret, "read DH derived value"); + if (valueAttr.ulValueLen != sizeof(dh_ffdhe2048_p) || value[0] != 0) + ret = CKR_GENERAL_ERROR; + CHECK_CKR(ret, "DH derived value keeps its leading zero byte"); + destroy_obj(session, &derived); + + mech.pParameter = peer; + mech.ulParameterLen = sizeof(peer); + ret = derive_generic(session, &mech, base, sizeof(peer), &derived); + CHECK_RV(ret, CKR_ATTRIBUTE_VALUE_INVALID, + "DH derive longer than the prime rejected"); +#endif + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -781,6 +892,12 @@ static int kdf_tls_derive_test(void) result = -1; #endif +#if defined(WOLFPKCS11_HKDF) || !defined(NO_DH) || \ + (!defined(NO_AES) && defined(HAVE_AES_CBC)) + if (test_derived_length_matches_template(session) != 0) + result = -1; +#endif + cleanup: if (session != CK_INVALID_HANDLE) { funcList->C_Logout(session); diff --git a/tests/pkcs11test.c b/tests/pkcs11test.c index 8ff1da8f..151c39fd 100644 --- a/tests/pkcs11test.c +++ b/tests/pkcs11test.c @@ -10570,8 +10570,8 @@ static CK_RV aes_cbc_encrypt_data_test(CK_SESSION_HANDLE session, word32 outSz = sizeof(out); CK_OBJECT_HANDLE secret; CK_KEY_TYPE keyType = CKK_GENERIC_SECRET; - CK_ULONG secSz = outSz; CK_BYTE data[16] = { 0 }; + CK_ULONG secSz = sizeof(data); CK_AES_CBC_ENCRYPT_DATA_PARAMS aesParams = { { 0 }, data, sizeof(data) }; From 2f35597e742dd51687e2eddbd19a31209ec44b03 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 16:14:16 -0700 Subject: [PATCH 101/104] F-3636 - Set derive historical flags on TLS key material keys --- src/crypto.c | 41 ++++++++++--- tests/kdf_tls_derive_test.c | 116 ++++++++++++++++++++++++++++++++++++ 2 files changed, 149 insertions(+), 8 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index aa8a4733..281376b0 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9431,7 +9431,9 @@ static int SymmKeyLen(WP11_Object* obj, word32 len, CK_ULONG* symmKeyLen) #ifdef WOLFSSL_HAVE_PRF static int SetKeyExtract(WP11_Session* session, byte* ptr, CK_ULONG length, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulAttributeCount, - CK_BBOOL isMac, CK_OBJECT_HANDLE* handle) + CK_BBOOL isMac, CK_BBOOL baseAlwaysSensitive, + CK_BBOOL baseNeverExtractable, + CK_OBJECT_HANDLE* handle) { WP11_Object* secret = NULL; int ret; @@ -9458,6 +9460,12 @@ static int SetKeyExtract(WP11_Session* session, byte* ptr, CK_ULONG length, WP11_Object_Free(secret); return CKR_FUNCTION_FAILED; } + ret = (int)SetDerivedStates(secret, baseAlwaysSensitive, + baseNeverExtractable); + if (ret != CKR_OK) { + WP11_Object_Free(secret); + return CKR_FUNCTION_FAILED; + } ret = (int)AddObject(session, secret, pTemplate, ulAttributeCount, handle); if (ret != CKR_OK) { @@ -9517,7 +9525,9 @@ static int SetKeyExtract(WP11_Session* session, byte* ptr, CK_ULONG length, static int Tls12_Extract_Keys(WP11_Session* session, CK_TLS12_KEY_MAT_PARAMS* tlsParams, CK_ATTRIBUTE_PTR pTemplate, - CK_ULONG ulAttributeCount, byte* derivedKey) + CK_ULONG ulAttributeCount, byte* derivedKey, + CK_BBOOL baseAlwaysSensitive, + CK_BBOOL baseNeverExtractable) { int ret = 0; unsigned char* ptr = derivedKey; @@ -9530,7 +9540,8 @@ static int Tls12_Extract_Keys(WP11_Session* session, /* Client MAC key */ length = tlsParams->ulMacSizeInBits / 8; ret = SetKeyExtract(session, ptr, length, pTemplate, - ulAttributeCount, CK_TRUE, + ulAttributeCount, CK_TRUE, baseAlwaysSensitive, + baseNeverExtractable, &tlsParams->pReturnedKeyMaterial->hClientMacSecret); if (ret != 0) { return ret; @@ -9538,7 +9549,8 @@ static int Tls12_Extract_Keys(WP11_Session* session, ptr += length; /* Server MAC key */ ret = SetKeyExtract(session, ptr, length, pTemplate, - ulAttributeCount, CK_TRUE, + ulAttributeCount, CK_TRUE, baseAlwaysSensitive, + baseNeverExtractable, &tlsParams->pReturnedKeyMaterial->hServerMacSecret); if (ret != 0) { return ret; @@ -9547,7 +9559,8 @@ static int Tls12_Extract_Keys(WP11_Session* session, /* Client key */ length = tlsParams->ulKeySizeInBits / 8; ret = SetKeyExtract(session, ptr, length, pTemplate, - ulAttributeCount, CK_FALSE, + ulAttributeCount, CK_FALSE, baseAlwaysSensitive, + baseNeverExtractable, &tlsParams->pReturnedKeyMaterial->hClientKey); if (ret != 0) { return ret; @@ -9555,7 +9568,8 @@ static int Tls12_Extract_Keys(WP11_Session* session, ptr += length; /* Server key */ ret = SetKeyExtract(session, ptr, length, pTemplate, - ulAttributeCount, CK_FALSE, + ulAttributeCount, CK_FALSE, baseAlwaysSensitive, + baseNeverExtractable, &tlsParams->pReturnedKeyMaterial->hServerKey); if (ret != 0) { return ret; @@ -9913,9 +9927,20 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, "key expansion", 13, derivedKey, keyLen, CK_FALSE, obj); - if (ret == 0) + if (ret == 0) { + histLen = sizeof(CK_BBOOL); + if (WP11_Object_GetAttr(obj, CKA_ALWAYS_SENSITIVE, + &baseAlwaysSensitive, &histLen) != 0) + baseAlwaysSensitive = CK_FALSE; + histLen = sizeof(CK_BBOOL); + if (WP11_Object_GetAttr(obj, CKA_NEVER_EXTRACTABLE, + &baseNeverExtractable, &histLen) != 0) + baseNeverExtractable = CK_FALSE; ret = Tls12_Extract_Keys(session, tlsParams, pTemplate, - ulAttributeCount, derivedKey); + ulAttributeCount, derivedKey, + baseAlwaysSensitive, + baseNeverExtractable); + } /* Freeing here so that we don't attempt to generate a key at the * end of the function */ diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index ba850ded..f3a5012a 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -743,6 +743,118 @@ static int test_derived_length_matches_template(CK_SESSION_HANDLE session) } #endif +#ifdef WOLFSSL_HAVE_PRF +static CK_RV read_states(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE obj, + CK_BBOOL* alwaysSensitive, CK_BBOOL* neverExtractable) +{ + CK_ATTRIBUTE tmpl[] = { + { CKA_ALWAYS_SENSITIVE, alwaysSensitive, sizeof(CK_BBOOL) }, + { CKA_NEVER_EXTRACTABLE, neverExtractable, sizeof(CK_BBOOL) }, + }; + + return funcList->C_GetAttributeValue(session, obj, tmpl, + sizeof(tmpl) / sizeof(*tmpl)); +} + +/* All four TLS keys must report exactly the expected historical flags. */ +static CK_RV check_key_mat_states(CK_SESSION_HANDLE session, + CK_SSL3_KEY_MAT_OUT* out, CK_BBOOL expected) +{ + CK_RV ret = CKR_OK; + CK_OBJECT_HANDLE keys[4]; + CK_BBOOL alwaysSensitive; + CK_BBOOL neverExtractable; + int i; + + keys[0] = out->hClientMacSecret; + keys[1] = out->hServerMacSecret; + keys[2] = out->hClientKey; + keys[3] = out->hServerKey; + for (i = 0; i < 4 && ret == CKR_OK; i++) { + alwaysSensitive = !expected; + neverExtractable = !expected; + ret = read_states(session, keys[i], &alwaysSensitive, + &neverExtractable); + if (ret == CKR_OK && (alwaysSensitive != expected || + neverExtractable != expected)) { + fprintf(stderr, "TLS key %d: ALWAYS_SENSITIVE=%d " + "NEVER_EXTRACTABLE=%d, expected %d\n", i, + (int)alwaysSensitive, (int)neverExtractable, + (int)expected); + ret = CKR_GENERAL_ERROR; + } + } + return ret; +} + +/* TLS key material keys carry the derive historical protection flags. */ +static int test_tls_key_states_follow_base(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_TLS12_KEY_MAT_PARAMS params; + CK_SSL3_KEY_MAT_OUT out; + CK_MECHANISM genMech = { CKM_GENERIC_SECRET_KEY_GEN, NULL, 0 }; + CK_ULONG masterLen = 48; + byte master[48]; + CK_ATTRIBUTE genTmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE_LEN, &masterLen, sizeof(masterLen) }, + }; + CK_ATTRIBUTE keyTmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + }; + CK_ATTRIBUTE importTmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_EXTRACTABLE, &ckFalse, sizeof(ckFalse) }, + { CKA_DERIVE, &ckTrue, sizeof(ckTrue) }, + { CKA_VALUE, master, sizeof(master) }, + }; + int result = 0; + + tls_key_mat_init(¶ms, &out, 256, 128, 0); + ret = funcList->C_GenerateKey(session, &genMech, genTmpl, + sizeof(genTmpl) / sizeof(*genTmpl), &base); + CHECK_CKR(ret, "generate TLS master secret"); + ret = tls_key_mat_derive(session, base, ¶ms, keyTmpl, + sizeof(keyTmpl) / sizeof(*keyTmpl)); + CHECK_CKR(ret, "TLS key and MAC derive from generated secret"); + ret = check_key_mat_states(session, &out, CK_TRUE); + CHECK_CKR(ret, "TLS keys from generated secret keep history"); + destroy_key_mat(session, &out); + destroy_obj(session, &base); + + XMEMSET(master, 0x5c, sizeof(master)); + ret = funcList->C_CreateObject(session, importTmpl, + sizeof(importTmpl) / sizeof(*importTmpl), + &base); + CHECK_CKR(ret, "import TLS master secret"); + tls_key_mat_init(¶ms, &out, 256, 128, 0); + ret = tls_key_mat_derive(session, base, ¶ms, keyTmpl, + sizeof(keyTmpl) / sizeof(*keyTmpl)); + CHECK_CKR(ret, "TLS key and MAC derive from imported secret"); + ret = check_key_mat_states(session, &out, CK_FALSE); + CHECK_CKR(ret, "TLS keys from imported secret have no history"); + +cleanup: + destroy_key_mat(session, &out); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -887,6 +999,10 @@ static int kdf_tls_derive_test(void) if (test_tls_master_version_param(session) != 0) result = -1; #endif +#ifdef WOLFSSL_HAVE_PRF + if (test_tls_key_states_follow_base(session) != 0) + result = -1; +#endif #if defined(WOLFSSL_HAVE_PRF) && defined(WOLFPKCS11_NSS) if (test_session_hash_required(session) != 0) result = -1; From fc815ae72e37e7570a7b6005b24938377059de1f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 16:21:09 -0700 Subject: [PATCH 102/104] F-4074 - Add TLS key material keys only after all attributes are set --- src/crypto.c | 75 ++++++++----------- tests/kdf_tls_derive_test.c | 143 ++++++++++++++++++++++++++++++++++++ 2 files changed, 174 insertions(+), 44 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 281376b0..5d4039ef 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9466,59 +9466,46 @@ static int SetKeyExtract(WP11_Session* session, byte* ptr, CK_ULONG length, WP11_Object_Free(secret); return CKR_FUNCTION_FAILED; } - ret = (int)AddObject(session, secret, pTemplate, ulAttributeCount, - handle); - if (ret != CKR_OK) { - WP11_Object_Free(secret); - return ret; - } } else { WP11_Object_Free(secret); - return ret; + return CKR_FUNCTION_FAILED; } if (isMac) { ret = WP11_Object_SetAttr(secret, CKA_KEY_TYPE, (byte*)&keyType, sizeof(keyType)); - if (ret != CKR_OK) - return ret; - - ret = WP11_Object_SetAttr(secret, CKA_DERIVE, &ckTrue, - sizeof(CK_BBOOL)); - if (ret != CKR_OK) - return ret; - - ret = WP11_Object_SetAttr(secret, CKA_ENCRYPT, &ckFalse, - sizeof(CK_BBOOL)); - if (ret != CKR_OK) - return ret; - - ret = WP11_Object_SetAttr(secret, CKA_DECRYPT, &ckFalse, - sizeof(CK_BBOOL)); - if (ret != CKR_OK) - return ret; - - ret = WP11_Object_SetAttr(secret, CKA_SIGN, &ckTrue, - sizeof(CK_BBOOL)); - if (ret != CKR_OK) - return ret; - - ret = WP11_Object_SetAttr(secret, CKA_VERIFY, &ckTrue, - sizeof(CK_BBOOL)); - if (ret != CKR_OK) - return ret; - - ret = WP11_Object_SetAttr(secret, CKA_WRAP, &ckFalse, - sizeof(CK_BBOOL)); - if (ret != CKR_OK) - return ret; - - ret = WP11_Object_SetAttr(secret, CKA_UNWRAP, &ckFalse, - sizeof(CK_BBOOL)); - if (ret != CKR_OK) - return ret; + if (ret == CKR_OK) + ret = WP11_Object_SetAttr(secret, CKA_DERIVE, &ckTrue, + sizeof(CK_BBOOL)); + if (ret == CKR_OK) + ret = WP11_Object_SetAttr(secret, CKA_ENCRYPT, &ckFalse, + sizeof(CK_BBOOL)); + if (ret == CKR_OK) + ret = WP11_Object_SetAttr(secret, CKA_DECRYPT, &ckFalse, + sizeof(CK_BBOOL)); + if (ret == CKR_OK) + ret = WP11_Object_SetAttr(secret, CKA_SIGN, &ckTrue, + sizeof(CK_BBOOL)); + if (ret == CKR_OK) + ret = WP11_Object_SetAttr(secret, CKA_VERIFY, &ckTrue, + sizeof(CK_BBOOL)); + if (ret == CKR_OK) + ret = WP11_Object_SetAttr(secret, CKA_WRAP, &ckFalse, + sizeof(CK_BBOOL)); + if (ret == CKR_OK) + ret = WP11_Object_SetAttr(secret, CKA_UNWRAP, &ckFalse, + sizeof(CK_BBOOL)); + if (ret != CKR_OK) { + WP11_Object_Free(secret); + return CKR_FUNCTION_FAILED; + } } + /* Add only once the key is complete so a failure leaves no object. */ + ret = (int)AddObject(session, secret, pTemplate, ulAttributeCount, handle); + if (ret != CKR_OK) + WP11_Object_Free(secret); + return ret; } diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index f3a5012a..9ed0be6c 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -44,6 +44,13 @@ #include #endif +#if defined(WOLFSSL_HAVE_PRF) && !defined(WOLFPKCS11_NO_STORE) && \ + !defined(_WIN32) + #define TLS_PERSIST_TEST + #include + #include +#endif + #include "testdata.h" #define TEST_DIR "./store/kdf_tls_derive_test" @@ -1023,6 +1030,138 @@ static int kdf_tls_derive_test(void) return result; } +#ifdef TLS_PERSIST_TEST +static const char persistLabel[] = "tls-key-mat-persist"; + +static CK_RV open_user_session(CK_SESSION_HANDLE* session) +{ + CK_RV ret; + + ret = pkcs11_init(); + if (ret == CKR_OK) { + ret = funcList->C_OpenSession(slot, + CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, session); + } + if (ret == CKR_OK) + ret = funcList->C_Login(*session, CKU_USER, userPin, userPinLen); + return ret; +} + +/* Derive TLS key material into token keys whose template disallows signing. */ +static CK_RV derive_token_key_mat(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_TLS12_KEY_MAT_PARAMS params; + CK_SSL3_KEY_MAT_OUT out; + byte master[48]; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretKeyClass, sizeof(secretKeyClass) }, + { CKA_KEY_TYPE, &genericKeyType, sizeof(genericKeyType) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_SENSITIVE, &ckFalse, sizeof(ckFalse) }, + { CKA_EXTRACTABLE, &ckTrue, sizeof(ckTrue) }, + { CKA_SIGN, &ckFalse, sizeof(ckFalse) }, + { CKA_ENCRYPT, &ckTrue, sizeof(ckTrue) }, + { CKA_LABEL, (void*)persistLabel, sizeof(persistLabel) - 1 }, + }; + + XMEMSET(master, 0x5c, sizeof(master)); + ret = create_secret_base(session, CKK_GENERIC_SECRET, master, + sizeof(master), &base); + if (ret == CKR_OK) { + tls_key_mat_init(¶ms, &out, 256, 128, 0); + ret = tls_key_mat_derive(session, base, ¶ms, tmpl, + sizeof(tmpl) / sizeof(*tmpl)); + } + return ret; +} + +/* The MAC key usage attributes are part of the stored token object even when + * the process ends without C_Finalize. */ +static int test_token_mac_key_usage_persist(void) +{ + CK_RV ret; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE objs[8]; + CK_ULONG found = 0; + CK_ULONG i; + CK_ULONG macKeys = 0; + CK_BBOOL sign; + CK_BBOOL encrypt; + CK_ATTRIBUTE findTmpl[] = { + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_LABEL, (void*)persistLabel, sizeof(persistLabel) - 1 }, + }; + CK_ATTRIBUTE usageTmpl[] = { + { CKA_SIGN, &sign, sizeof(CK_BBOOL) }, + { CKA_ENCRYPT, &encrypt, sizeof(CK_BBOOL) }, + }; + pid_t pid; + int status = 0; + int result = 0; + + printf("\n=== Testing TLS MAC key token persistence ===\n"); + + pid = fork(); + if (pid == 0) { + /* Exit without C_Finalize so only stores made by the derive count. */ + ret = open_user_session(&session); + if (ret == CKR_OK) + ret = derive_token_key_mat(session); + _exit(ret == CKR_OK ? 0 : 1); + } + if (pid < 0) + ret = CKR_GENERAL_ERROR; + else if (waitpid(pid, &status, 0) != pid || !WIFEXITED(status) || + WEXITSTATUS(status) != 0) + ret = CKR_GENERAL_ERROR; + else + ret = CKR_OK; + CHECK_CKR(ret, "derive token key material in child process"); + + ret = open_user_session(&session); + CHECK_CKR(ret, "reopen token"); + + ret = funcList->C_FindObjectsInit(session, findTmpl, + sizeof(findTmpl) / sizeof(*findTmpl)); + CHECK_CKR(ret, "C_FindObjectsInit"); + ret = funcList->C_FindObjects(session, objs, + sizeof(objs) / sizeof(*objs), &found); + if (funcList->C_FindObjectsFinal(session) != CKR_OK && ret == CKR_OK) + ret = CKR_GENERAL_ERROR; + if (ret == CKR_OK && found != 4) + ret = CKR_GENERAL_ERROR; + CHECK_CKR(ret, "find derived token keys"); + + for (i = 0; i < found && ret == CKR_OK; i++) { + ret = funcList->C_GetAttributeValue(session, objs[i], usageTmpl, + sizeof(usageTmpl) / sizeof(*usageTmpl)); + if (ret == CKR_OK && sign == CK_TRUE && encrypt == CK_FALSE) + macKeys++; + } + CHECK_CKR(ret, "read derived key usage"); + if (macKeys != 2) { + fprintf(stderr, "FAIL: reloaded MAC keys with MAC usage: %lu, " + "expected 2\n", (unsigned long)macKeys); + test_failed++; + result = -1; + goto cleanup; + } + printf("PASS: reloaded MAC keys keep MAC usage\n"); + test_passed++; + +cleanup: + if (session != CK_INVALID_HANDLE) { + funcList->C_Logout(session); + funcList->C_CloseSession(session); + } + pkcs11_final(); + return result; +} +#endif /* TLS_PERSIST_TEST */ + static void print_results(void) { printf("\n=== Test Results ===\n"); @@ -1044,6 +1183,10 @@ int main(int argc, char* argv[]) if (kdf_tls_derive_test() != 0 && test_failed == 0) test_failed++; +#ifdef TLS_PERSIST_TEST + if (test_token_mac_key_usage_persist() != 0 && test_failed == 0) + test_failed++; +#endif print_results(); #ifndef DERIVE_TESTS From bb9e83ed8cf753d067f0340ff212f94ae66b6e29 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 16:46:36 -0700 Subject: [PATCH 103/104] F-8644 - Require an HKDF salt key handle to be a symmetric secret key --- src/crypto.c | 5 ++- src/internal.c | 9 ++++++ tests/kdf_tls_derive_test.c | 61 +++++++++++++++++++++++++++++++++++++ 3 files changed, 74 insertions(+), 1 deletion(-) diff --git a/src/crypto.c b/src/crypto.c index 5d4039ef..8dca61f6 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9796,7 +9796,10 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, ret = WP11_KDF_Derive(session, kdfParams, derivedKey, &keyLen, obj); - if (ret != 0) + /* A parameter check reports a CK_RV, not a wolfCrypt error. */ + if (ret == (int)CKR_MECHANISM_PARAM_INVALID) + rv = CKR_MECHANISM_PARAM_INVALID; + else if (ret != 0) rv = CKR_FUNCTION_FAILED; break; } diff --git a/src/internal.c b/src/internal.c index 84da9f18..df4277fc 100644 --- a/src/internal.c +++ b/src/internal.c @@ -18255,6 +18255,15 @@ int WP11_KDF_Derive(WP11_Session* session, CK_HKDF_PARAMS_PTR params, ret = WP11_Object_Find(session, params->hSaltKey, &saltKey); if (ret != 0) return CKR_OBJECT_HANDLE_INVALID; + /* Only these secret key types hold their value in symmKey. */ + if (saltKey->objClass != CKO_SECRET_KEY || + (saltKey->type != CKK_GENERIC_SECRET && +#ifndef NO_AES + saltKey->type != CKK_AES && +#endif + saltKey->type != CKK_HKDF) || + saltKey->data.symmKey == NULL) + return CKR_MECHANISM_PARAM_INVALID; salt = saltKey->data.symmKey->data; saltLen = saltKey->data.symmKey->len; break; diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index 9ed0be6c..e8e4f0ef 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -862,6 +862,63 @@ static int test_tls_key_states_follow_base(CK_SESSION_HANDLE session) } #endif +#ifdef WOLFPKCS11_HKDF +/* An HKDF salt key handle must refer to a symmetric secret key. */ +static int test_hkdf_salt_key_is_secret(CK_SESSION_HANDLE session) +{ + CK_RV ret; + CK_OBJECT_HANDLE base = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE salt = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE derived = CK_INVALID_HANDLE; + CK_OBJECT_CLASS dataClass = CKO_DATA; + byte saltValue[16]; + byte dataValue[64]; + CK_ATTRIBUTE dataTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_PRIVATE, &ckFalse, sizeof(ckFalse) }, + { CKA_VALUE, dataValue, sizeof(dataValue) }, + }; + CK_HKDF_PARAMS params; + CK_MECHANISM mech = { CKM_HKDF_DERIVE, ¶ms, sizeof(params) }; + int result = 0; + + XMEMSET(saltValue, 0x5a, sizeof(saltValue)); + XMEMSET(dataValue, 0xa5, sizeof(dataValue)); + ret = create_secret_base(session, CKK_GENERIC_SECRET, baseSecret, + sizeof(baseSecret), &base); + CHECK_CKR(ret, "create HKDF base key"); + ret = create_secret_base(session, CKK_GENERIC_SECRET, saltValue, + sizeof(saltValue), &salt); + CHECK_CKR(ret, "create HKDF salt key"); + + XMEMSET(¶ms, 0, sizeof(params)); + params.bExtract = CK_TRUE; + params.bExpand = CK_TRUE; + params.prfHashMechanism = CKM_SHA256; + params.ulSaltType = CKF_HKDF_SALT_KEY; + params.hSaltKey = salt; + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_CKR(ret, "HKDF derive with secret salt key"); + destroy_obj(session, &derived); + destroy_obj(session, &salt); + + ret = funcList->C_CreateObject(session, dataTmpl, + sizeof(dataTmpl) / sizeof(*dataTmpl), + &salt); + CHECK_CKR(ret, "create data object"); + params.hSaltKey = salt; + ret = derive_generic(session, &mech, base, 32, &derived); + CHECK_RV(ret, CKR_MECHANISM_PARAM_INVALID, + "HKDF salt key that is a data object rejected"); + +cleanup: + destroy_obj(session, &derived); + destroy_obj(session, &salt); + destroy_obj(session, &base); + return result; +} +#endif + static CK_RV pkcs11_init(void) { CK_RV ret; @@ -973,6 +1030,10 @@ static int kdf_tls_derive_test(void) result = -1; #endif +#ifdef WOLFPKCS11_HKDF + if (test_hkdf_salt_key_is_secret(session) != 0) + result = -1; +#endif #ifdef NSS_EMS_WIDE_TEST if (test_session_hash_length_fits_word32(session) != 0) result = -1; From 147e5a2cf9f02053a37ca2b7d9b3ac9f665e4509 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 13 Oct 2026 13:38:32 -0700 Subject: [PATCH 104/104] Pad the DH derived secret to the prime length --- src/crypto.c | 11 +++++++---- tests/kdf_tls_derive_test.c | 18 ++++++++++++++++++ 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/src/crypto.c b/src/crypto.c index 8dca61f6..82958613 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9814,7 +9814,13 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, pMechanism->ulParameterLen > WP11_MAX_DH_KEY_SZ) return CKR_MECHANISM_PARAM_INVALID; + /* The secret is bounded by the prime, not by the peer value. */ + if (WP11_Object_GetAttr(obj, CKA_PRIME, NULL, &dhPrimeLen) != 0 || + dhPrimeLen > WP11_MAX_DH_KEY_SZ) + return CKR_FUNCTION_FAILED; keyLen = (word32)pMechanism->ulParameterLen; + if (dhPrimeLen > keyLen) + keyLen = (word32)dhPrimeLen; derivedKey = (byte*)XMALLOC(keyLen, NULL, DYNAMIC_TYPE_TMP_BUFFER); if (derivedKey == NULL) return CKR_DEVICE_MEMORY; @@ -10053,10 +10059,7 @@ static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, /* DH agreement drops leading zero bytes; restore up to the prime * length on request. */ if ((pMechanism->mechanism == CKM_DH_PKCS_DERIVE) && - (reqValueLen > keyLen) && - (reqValueLen <= pMechanism->ulParameterLen) && - (WP11_Object_GetAttr(obj, CKA_PRIME, NULL, &dhPrimeLen) == 0) && - (reqValueLen <= dhPrimeLen)) { + (reqValueLen > keyLen) && (reqValueLen <= dhPrimeLen)) { XMEMMOVE(derivedKey + (reqValueLen - keyLen), derivedKey, keyLen); XMEMSET(derivedKey, 0, reqValueLen - keyLen); keyLen = (word32)reqValueLen; diff --git a/tests/kdf_tls_derive_test.c b/tests/kdf_tls_derive_test.c index e8e4f0ef..f619085e 100644 --- a/tests/kdf_tls_derive_test.c +++ b/tests/kdf_tls_derive_test.c @@ -661,6 +661,7 @@ static int test_derived_length_matches_template(CK_SESSION_HANDLE session) CK_KEY_TYPE dhType = CKK_DH; byte peer[2 * sizeof(dh_ffdhe2048_p)]; byte value[sizeof(dh_ffdhe2048_p)]; + byte expect[sizeof(dh_ffdhe2048_p)]; CK_ATTRIBUTE valueAttr = { CKA_VALUE, value, sizeof(value) }; CK_ATTRIBUTE dhTmpl[] = { { CKA_CLASS, &privClass, sizeof(privClass) }, @@ -736,6 +737,23 @@ static int test_derived_length_matches_template(CK_SESSION_HANDLE session) CHECK_CKR(ret, "DH derived value keeps its leading zero byte"); destroy_obj(session, &derived); + /* The same peer value encoded without its leading zero bytes. */ + XMEMCPY(expect, value, sizeof(expect)); + mech.pParameter = peer + sizeof(peer) - 2; + mech.ulParameterLen = 2; + ret = derive_generic(session, &mech, base, sizeof(dh_ffdhe2048_p), + &derived); + CHECK_CKR(ret, "DH derive of a prime-sized secret from a short peer value"); + valueAttr.ulValueLen = sizeof(value); + ret = funcList->C_GetAttributeValue(session, derived, &valueAttr, 1); + CHECK_CKR(ret, "read DH derived value from a short peer value"); + if (valueAttr.ulValueLen != sizeof(expect) || + XMEMCMP(value, expect, sizeof(expect)) != 0) { + ret = CKR_GENERAL_ERROR; + } + CHECK_CKR(ret, "DH derived value matches the zero padded peer derive"); + destroy_obj(session, &derived); + mech.pParameter = peer; mech.ulParameterLen = sizeof(peer); ret = derive_generic(session, &mech, base, sizeof(peer), &derived);