From a95a4fa2e2ea341d26e8a76a186c4489716029f1 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 08:22:46 -0700 Subject: [PATCH 01/61] F-8673 - Lock the cached empty user PIN state --- src/internal.c | 62 +++++--- tests/include.am | 7 + tests/login_pin_state_test.c | 277 +++++++++++++++++++++++++++++++++++ 3 files changed, 322 insertions(+), 24 deletions(-) create mode 100644 tests/login_pin_state_test.c diff --git a/src/internal.c b/src/internal.c index c844a26b..485ff7c5 100644 --- a/src/internal.c +++ b/src/internal.c @@ -865,33 +865,38 @@ static int wp11_Session_New(WP11_Slot* slot, CK_OBJECT_HANDLE handle, */ int WP11_Slot_Has_Empty_Pin(WP11_Slot* slot) { + int ret = 0; + int pinSet; + int cached; + byte seed[PIN_SEED_SZ]; + if (slot == NULL) return 0; - if (slot->token.tokenFlags & WP11_TOKEN_FLAG_USER_PIN_SET) { - switch (slot->token.userPinEmpty) { - case 1: - /* Empty user PIN */ - return 1; - case 2: - /* Non-empty user PIN */ - return 0; - default: - /* Cache result as WP11_Slot_CheckUserPin is very expensive */ - if (WP11_Slot_CheckUserPin(slot, (char*)"", 0) == 0) { - /* Empty user PIN */ - slot->token.userPinEmpty = 1; - return 1; - } - else { - /* Non-empty user PIN */ - slot->token.userPinEmpty = 2; - return 0; - } + WP11_Lock_LockRO(&slot->lock); + pinSet = (slot->token.tokenFlags & WP11_TOKEN_FLAG_USER_PIN_SET) != 0; + cached = slot->token.userPinEmpty; + XMEMCPY(seed, slot->token.userPinSeed, sizeof(seed)); + WP11_Lock_UnlockRO(&slot->lock); + + if (pinSet) { + if (cached == 0) { + /* Cache result as WP11_Slot_CheckUserPin is very expensive */ + ret = (WP11_Slot_CheckUserPin(slot, (char*)"", 0) == 0); + WP11_Lock_LockRW(&slot->lock); + /* Only cache a verdict for the PIN that was checked. */ + if (slot->token.userPinEmpty == 0 && + XMEMCMP(seed, slot->token.userPinSeed, sizeof(seed)) == 0) { + slot->token.userPinEmpty = ret ? 1 : 2; + } + WP11_Lock_UnlockRW(&slot->lock); + } + else { + ret = (cached == 1); } } - return 0; + return ret; } /** @@ -8458,6 +8463,7 @@ int WP11_Slot_CheckUserPin(WP11_Slot* slot, char* pin, int pinLen) int ret = 0; WP11_Token* token; byte hash[PIN_HASH_SZ]; + byte seed[PIN_SEED_SZ]; WP11_Lock_LockRO(&slot->lock); token = &slot->token; @@ -8469,11 +8475,13 @@ int WP11_Slot_CheckUserPin(WP11_Slot* slot, char* pin, int pinLen) ret = PIN_NOT_SET_E; if (ret == 0) { + /* C_SetPIN may replace the seed while the hash runs unlocked. */ + XMEMCPY(seed, token->userPinSeed, sizeof(seed)); WP11_Lock_UnlockRO(&slot->lock); /* Costly Operation done out of lock. */ - ret = HashPIN(pin, pinLen, token->userPinSeed, - sizeof(token->userPinSeed), hash, sizeof(hash), slot); + ret = HashPIN(pin, pinLen, seed, sizeof(seed), hash, sizeof(hash), + slot); WP11_Lock_LockRO(&slot->lock); } @@ -8974,7 +8982,13 @@ time_t WP11_Slot_TokenFailedExpire(WP11_Slot* slot, int login) */ int WP11_Slot_IsTokenUserPinInitialized(WP11_Slot* slot) { - return slot->token.tokenFlags & WP11_TOKEN_FLAG_USER_PIN_SET; + int ret; + + WP11_Lock_LockRO(&slot->lock); + ret = slot->token.tokenFlags & WP11_TOKEN_FLAG_USER_PIN_SET; + WP11_Lock_UnlockRO(&slot->lock); + + return ret; } /** diff --git a/tests/include.am b/tests/include.am index 769f36ac..d3162c44 100644 --- a/tests/include.am +++ b/tests/include.am @@ -300,6 +300,11 @@ noinst_PROGRAMS += tests/nss_configdir_prefix_test tests_nss_configdir_prefix_test_SOURCES = tests/nss_configdir_prefix_test.c tests_nss_configdir_prefix_test_LDADD = +check_PROGRAMS += tests/login_pin_state_test +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 = + if BUILD_STATIC tests_pkcs11test_LDADD += src/libwolfpkcs11.la tests_pkcs11mtt_LDADD += src/libwolfpkcs11.la @@ -361,6 +366,7 @@ tests_copy_data_object_token_test_LDADD += src/libwolfpkcs11.la tests_data_object_partial_update_test_LDADD += src/libwolfpkcs11.la tests_wrapkey_length_query_test_LDADD += src/libwolfpkcs11.la tests_nss_configdir_prefix_test_LDADD += src/libwolfpkcs11.la +tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la else tests_object_id_uniqueness_test_LDADD += src/libwolfpkcs11.la tests_empty_pin_store_test_LDADD += src/libwolfpkcs11.la @@ -414,6 +420,7 @@ tests_copy_data_object_token_test_LDADD += src/libwolfpkcs11.la tests_data_object_partial_update_test_LDADD += src/libwolfpkcs11.la tests_wrapkey_length_query_test_LDADD += src/libwolfpkcs11.la tests_nss_configdir_prefix_test_LDADD += src/libwolfpkcs11.la +tests_login_pin_state_test_LDADD += src/libwolfpkcs11.la endif EXTRA_DIST += tests/unit.h \ diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c new file mode 100644 index 00000000..f15e9f71 --- /dev/null +++ b/tests/login_pin_state_test.c @@ -0,0 +1,277 @@ +/* login_pin_state_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 + * + * Login, PIN and session state invariants of the token. + */ + +#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" + +#ifndef SINGLE_THREADED +#include +#endif + +#define TEST_DIR "./store/login_pin_state_test" +#define WOLFPKCS11_TOKEN_FILENAME "wp11_token_0000000000000001" + +/* Not every helper is used in every build configuration. */ +#if defined(__GNUC__) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wunused-variable" + #pragma GCC diagnostic ignored "-Wunused-function" +#endif + +static const char* soPin = "password123456"; +static const char* userPin = "wolfpkcs11-test"; +static const char tokenLabel[] = "login-pin-state"; + +/* Start from an unprovisioned token so earlier runs cannot affect this one. */ +static void cleanup_test_files(void) +{ + char filepath[512]; + + snprintf(filepath, sizeof(filepath), "%s" PATH_SEP "%s", TEST_DIR, + WOLFPKCS11_TOKEN_FILENAME); + (void)remove(filepath); +} + +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); +} + +/* Initialize the library, re-initialize the token and set the user PIN. */ +static CK_RV token_setup(CK_SLOT_ID* slot, const char* pin) +{ + CK_RV rv; + CK_SLOT_ID slotList[16]; + CK_ULONG slotCount = sizeof(slotList) / sizeof(slotList[0]); + CK_SESSION_HANDLE soSession = CK_INVALID_HANDLE; + unsigned char label[32]; + + rv = lib_init(); + if (rv == CKR_OK) + 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]; + 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)pin, + (CK_ULONG)XSTRLEN(pin)); + funcList->C_Logout(soSession); + } + if (soSession != CK_INVALID_HANDLE) + funcList->C_CloseSession(soSession); + return rv; +} + +static CK_RV open_rw(CK_SLOT_ID slot, CK_SESSION_HANDLE* session) +{ + return funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, session); +} + +static CK_RV user_login(CK_SESSION_HANDLE session, const char* pin) +{ + return funcList->C_Login(session, CKU_USER, (CK_UTF8CHAR_PTR)pin, + (CK_ULONG)XSTRLEN(pin)); +} + +#if defined(__GNUC__) + #pragma GCC diagnostic pop +#endif + +#ifndef SINGLE_THREADED +#define EMPTY_PIN_ROUNDS 8 + +static pthread_mutex_t infoMutex = PTHREAD_MUTEX_INITIALIZER; +static int infoStop = 0; +static CK_SLOT_ID infoSlot = 0; + +static int info_should_stop(void) +{ + int stop; + + pthread_mutex_lock(&infoMutex); + stop = infoStop; + pthread_mutex_unlock(&infoMutex); + return stop; +} + +static void info_set_stop(int stop) +{ + pthread_mutex_lock(&infoMutex); + infoStop = stop; + pthread_mutex_unlock(&infoMutex); +} + +static void* token_info_loop(void* arg) +{ + CK_TOKEN_INFO info; + + (void)arg; + while (!info_should_stop()) + (void)funcList->C_GetTokenInfo(infoSlot, &info); + return NULL; +} + +/* Once a non-empty user PIN is set, the token requires login and private + * objects cannot be created without one, even with concurrent token queries. */ +static void empty_pin_change_requires_login_test(void) +{ + CK_RV rv; + int i; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_TOKEN_INFO info; + pthread_t thread; + const char* newPin = "non-empty-pin"; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_BBOOL privTrue = CK_TRUE; + CK_ATTRIBUTE privTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_PRIVATE, &privTrue, sizeof(privTrue) }, + }; + int loginRequired = 1; + int privateDenied = 1; + + printf("--- empty PIN replaced by a non-empty PIN ---\n"); + for (i = 0; i < EMPTY_PIN_ROUNDS; i++) { + rv = token_setup(&slot, ""); + if (i == 0 && rv == CKR_PIN_LEN_RANGE) { + printf("SKIP: empty user PIN not supported by this build\n"); + funcList->C_Finalize(NULL); + return; + } + if (rv == CKR_OK) + rv = open_rw(slot, &session); + CHECK_RV(rv, "token setup with empty user PIN", CKR_OK); + if (rv != CKR_OK) { + funcList->C_Finalize(NULL); + return; + } + + infoSlot = slot; + info_set_stop(0); + if (pthread_create(&thread, NULL, token_info_loop, NULL) != 0) { + CHECK_TRUE(0, "create token info thread"); + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); + return; + } + rv = funcList->C_SetPIN(session, (CK_UTF8CHAR_PTR)"", 0, + (CK_UTF8CHAR_PTR)newPin, + (CK_ULONG)XSTRLEN(newPin)); + info_set_stop(1); + pthread_join(thread, NULL); + CHECK_RV(rv, "C_SetPIN from empty to non-empty PIN", CKR_OK); + + if (funcList->C_GetTokenInfo(slot, &info) != CKR_OK || + (info.flags & CKF_LOGIN_REQUIRED) == 0) { + loginRequired = 0; + } + obj = CK_INVALID_HANDLE; + rv = funcList->C_CreateObject(session, privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &obj); + if (rv != CKR_USER_NOT_LOGGED_IN) + privateDenied = 0; + + funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; + funcList->C_Finalize(NULL); + } + CHECK_TRUE(loginRequired, "token reports login required after PIN set"); + CHECK_TRUE(privateDenied, + "private object creation needs login after PIN set"); +} +#endif + +static int run_test(void) +{ + CK_RV rv; + + rv = pkcs11_load(); + CHECK_RV(rv, "load library", CKR_OK); + if (rv != CKR_OK) + return -1; + +#ifndef SINGLE_THREADED + empty_pin_change_requires_login_test(); +#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 login and PIN state test ===\n"); + cleanup_test_files(); + run_test(); + return pkcs11_test_summary(); +} From 09bc0366882277618a903cbdcda57ee2cf90edc6 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 08:44:58 -0700 Subject: [PATCH 02/61] F-8662 - Clear the derived key and decoded objects on failed login --- src/internal.c | 147 +++++++++++++++++++++++++++++++++-- tests/login_pin_state_test.c | 110 ++++++++++++++++++++++++++ wolfpkcs11/internal.h | 1 + 3 files changed, 250 insertions(+), 8 deletions(-) diff --git a/src/internal.c b/src/internal.c index 485ff7c5..fd242e61 100644 --- a/src/internal.c +++ b/src/internal.c @@ -6965,9 +6965,15 @@ static int wp11_Object_EncodeData(WP11_Object* object, int protect) return ret; } -static int wp11_Object_Encode(WP11_Object* object, int protect) +/** + * Check whether the object's key material is encrypted with the token key. + * + * @param [in] object Key object. + * @return 1 when encrypted with the token key. + * @return 0 otherwise. + */ +static int wp11_Object_IsEncrypted(WP11_Object* object) { - int ret = 0; int encrypt = object->objClass == CKO_PRIVATE_KEY || object->type == CKK_AES || object->type == CKK_GENERIC_SECRET; @@ -6976,10 +6982,17 @@ static int wp11_Object_Encode(WP11_Object* object, int protect) encrypt = encrypt || object->type == CKK_HKDF; #endif + return encrypt; +} + +static int wp11_Object_Encode(WP11_Object* object, int protect) +{ + int ret = 0; + /* 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. */ - if (encrypt) { + if (wp11_Object_IsEncrypted(object)) { WP11_Lock_LockRW(&object->slot->token.rngLock); ret = wc_RNG_GenerateBlock(&object->slot->token.rng, object->iv, sizeof(object->iv)); @@ -6991,6 +7004,69 @@ static int wp11_Object_Encode(WP11_Object* object, int protect) return ret; } +/** + * Discard the decoded key material of an object, keeping its encrypted form. + * + * @param [in, out] object Key object. + */ +static void wp11_Object_Scrub(WP11_Object* object) +{ + switch (object->type) { + #ifndef NO_RSA + case CKK_RSA: + if (object->objClass == CKO_PRIVATE_KEY) { + wc_FreeRsaKey(object->data.rsaKey); + object->encoded = 1; + } + break; + #endif + #ifdef HAVE_ECC + case CKK_EC: + if (object->objClass == CKO_PRIVATE_KEY) { + wc_ecc_free(object->data.ecKey); + object->encoded = 1; + } + break; + #endif + #ifdef WOLFPKCS11_MLDSA + case CKK_ML_DSA: + if (object->objClass == CKO_PRIVATE_KEY) { + wc_MlDsaKey_Free(object->data.mldsaKey); + object->encoded = 1; + } + break; + #endif + #ifndef NO_DH + case CKK_DH: + if (object->objClass == CKO_PRIVATE_KEY) { + wc_ForceZero(object->data.dhKey->key, object->data.dhKey->len); + object->encoded = 1; + } + break; + #endif + #ifdef WOLFPKCS11_MLKEM + case CKK_ML_KEM: + if (object->objClass == CKO_PRIVATE_KEY) { + wc_MlKemKey_Free(object->data.mlKemKey); + object->encoded = 1; + } + break; + #endif + #ifndef NO_AES + case CKK_AES: + #endif + #ifdef WOLFPKCS11_HKDF + case CKK_HKDF: + #endif + case CKK_GENERIC_SECRET: + wc_ForceZero(object->data.symmKey->data, object->data.symmKey->len); + object->encoded = 1; + break; + default: + break; + } +} + /** * Unstore a key object to storage. * @@ -8616,6 +8692,12 @@ int WP11_Slot_UserLogin(WP11_Slot* slot, char* pin, int pinLen) #endif int state; WP11_Token* token = &slot->token; +#ifndef WOLFPKCS11_NO_STORE + byte key[AES_256_KEY_SIZE]; + byte prevKey[AES_256_KEY_SIZE]; + WP11_Object* object; + WP11_Object* failed = NULL; +#endif #ifndef WOLFPKCS11_NO_TIME if (wc_GetTime(&now, sizeof(now)) != 0) @@ -8655,7 +8737,7 @@ int WP11_Slot_UserLogin(WP11_Slot* slot, char* pin, int pinLen) /* Re-create token->key from PIN + token->seed (HashPIN) on load. */ if (ret == 0) { ret = HashPIN(pin, pinLen, token->seed, sizeof(token->seed), - token->key, sizeof(token->key), slot); + key, sizeof(key), slot); } #endif WP11_Lock_LockRW(&slot->lock); @@ -8671,20 +8753,35 @@ int WP11_Slot_UserLogin(WP11_Slot* slot, char* pin, int pinLen) } /* Worked - clear failure info. */ else if (ret == 0) { - #ifndef WOLFPKCS11_NO_STORE - WP11_Object* object; - #endif - token->userFailedLogin = 0; token->userLastFailedLogin = 0; token->userFailLoginTimeout = 0; #ifndef WOLFPKCS11_NO_STORE + /* Lock order is slot then token; the token lock keeps the object + * list stable across the decode and any rollback. */ + WP11_Lock_LockRW(&token->lock); + XMEMCPY(prevKey, token->key, sizeof(prevKey)); + XMEMCPY(token->key, key, sizeof(token->key)); object = token->object; while (ret == 0 && object != NULL) { ret = wp11_Object_Decode(object); + if (ret != 0) + failed = object; object = object->next; } + if (ret != 0) { + /* Login failed: drop what was decoded and the key derived + * from the PIN. The stored ciphertext is left untouched. */ + for (object = token->object; + pinLen > 0 && object != NULL && object != failed; + object = object->next) { + if (wp11_Object_IsEncrypted(object) && !object->encoded) + wp11_Object_Scrub(object); + } + XMEMCPY(token->key, prevKey, sizeof(token->key)); + } + WP11_Lock_UnlockRW(&token->lock); #endif } WP11_Lock_UnlockRW(&slot->lock); @@ -8696,6 +8793,10 @@ int WP11_Slot_UserLogin(WP11_Slot* slot, char* pin, int pinLen) WP11_Lock_UnlockRW(&slot->lock); } +#ifndef WOLFPKCS11_NO_STORE + wc_ForceZero(key, sizeof(key)); + wc_ForceZero(prevKey, sizeof(prevKey)); +#endif return ret; } @@ -8898,6 +8999,36 @@ WP11_API int WP11_Slot_TokenKeyIsZero(CK_SLOT_ID slotId) return acc == 0 ? 1 : 0; } + +/** + * Test hook: count the token objects whose encrypted key material is held + * decoded in memory. + * + * @param slotId [in] Slot id (1-based, as used by the PKCS#11 API). + * @return Number of decoded encrypted objects, -1 on a bad slot id. + */ +WP11_API int WP11_Slot_TokenDecodedObjectCount(CK_SLOT_ID slotId) +{ + WP11_Slot* slot = NULL; + int cnt = 0; +#ifndef WOLFPKCS11_NO_STORE + WP11_Object* object; +#endif + + if (WP11_Slot_Get(slotId, &slot) != 0 || slot == NULL) + return -1; + +#ifndef WOLFPKCS11_NO_STORE + WP11_Lock_LockRO(&slot->token.lock); + for (object = slot->token.object; object != NULL; object = object->next) { + if (wp11_Object_IsEncrypted(object) && !object->encoded) + cnt++; + } + WP11_Lock_UnlockRO(&slot->token.lock); +#endif + + return cnt; +} #endif /* DEBUG_WOLFPKCS11 */ /** diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index f15e9f71..c6840aae 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -53,6 +53,13 @@ #define TEST_DIR "./store/login_pin_state_test" #define WOLFPKCS11_TOKEN_FILENAME "wp11_token_0000000000000001" +/* These debug tests damage the default file store under TEST_DIR. */ +#if defined(DEBUG_WOLFPKCS11) && !defined(WOLFPKCS11_NO_STORE) && \ + !defined(WOLFPKCS11_TPM_STORE) && !defined(WOLFPKCS11_CUSTOM_STORE) && \ + !defined(WOLFPKCS11_NO_ENV) && !defined(NO_AES) + #define LOGIN_TEST_FILE_STORE +#endif + /* Not every helper is used in every build configuration. */ #if defined(__GNUC__) #pragma GCC diagnostic push @@ -134,10 +141,110 @@ static CK_RV user_login(CK_SESSION_HANDLE session, const char* pin) (CK_ULONG)XSTRLEN(pin)); } +#if !defined(WOLFPKCS11_NO_STORE) && !defined(NO_AES) +static CK_OBJECT_CLASS secretClass = CKO_SECRET_KEY; +static CK_KEY_TYPE aesType = CKK_AES; +static CK_BBOOL ckTrue = CK_TRUE; +static byte aesValue[16] = { + 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, + 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff +}; +#endif + #if defined(__GNUC__) #pragma GCC diagnostic pop #endif +#ifdef LOGIN_TEST_FILE_STORE +/* DEBUG_WOLFPKCS11-only introspection hooks exported by libwolfpkcs11. */ +extern int WP11_Slot_TokenKeyIsZero(CK_SLOT_ID slotId); +extern int WP11_Slot_TokenDecodedObjectCount(CK_SLOT_ID slotId); + +#define SYMMKEY_FILENAME "wp11_symmkey_0000000000000001_0000000000000000" + +/* Replace the oldest stored secret key with a record too short to decrypt. */ +static int truncate_stored_key(void) +{ + FILE* f; + char filepath[512]; + static const byte shortRecord[12] = { 0x00, 0x00, 0x00, 0x08 }; + int ret = -1; + + snprintf(filepath, sizeof(filepath), "%s" PATH_SEP "%s", TEST_DIR, + SYMMKEY_FILENAME); + f = fopen(filepath, "wb"); + if (f != NULL) { + if (fwrite(shortRecord, 1, sizeof(shortRecord), f) == + sizeof(shortRecord)) { + ret = 0; + } + if (fclose(f) != 0) + ret = -1; + } + return ret; +} + +/* A login that fails after the PIN is verified must not leave the key derived + * from the PIN, or any key decoded before the failure, resident in memory. */ +static void failed_login_leaves_no_token_key_test(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 keyTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_VALUE, aesValue, sizeof(aesValue) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + }; + + printf("--- failed login leaves no token key ---\n"); + rv = token_setup(&slot, userPin); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + if (rv == CKR_OK) + rv = user_login(session, userPin); + /* Objects decode newest first, so the second key decodes before the + * damaged first one. */ + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, keyTmpl, + sizeof(keyTmpl) / sizeof(*keyTmpl), &obj); + } + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, keyTmpl, + sizeof(keyTmpl) / sizeof(*keyTmpl), &obj); + } + CHECK_RV(rv, "create private token keys", CKR_OK); + if (session != CK_INVALID_HANDLE) { + funcList->C_Logout(session); + funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; + } + funcList->C_Finalize(NULL); + if (rv != CKR_OK) + return; + + CHECK_TRUE(truncate_stored_key() == 0, "replace stored key record"); + rv = lib_init(); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + CHECK_RV(rv, "reload token", CKR_OK); + if (rv == CKR_OK) { + rv = user_login(session, userPin); + CHECK_TRUE(rv != CKR_OK, "login fails on undecodable token object"); + CHECK_TRUE(WP11_Slot_TokenKeyIsZero(slot) == 1, + "token key is clear after failed login"); + CHECK_TRUE(WP11_Slot_TokenDecodedObjectCount(slot) == 0, + "no decoded keys left after failed login"); + funcList->C_CloseSession(session); + } + funcList->C_Finalize(NULL); + cleanup_test_files(); +} +#endif + #ifndef SINGLE_THREADED #define EMPTY_PIN_ROUNDS 8 @@ -256,6 +363,9 @@ static int run_test(void) #ifndef SINGLE_THREADED empty_pin_change_requires_login_test(); #endif +#ifdef LOGIN_TEST_FILE_STORE + failed_login_leaves_no_token_key_test(); +#endif pkcs11_unload(); return 0; diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index c4f95fe4..09f8d7ed 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -413,6 +413,7 @@ WP11_LOCAL int WP11_Slot_IsUserLoggedIn(WP11_Slot* slot); WP11_LOCAL void WP11_Slot_Logout(WP11_Slot* slot); #ifdef DEBUG_WOLFPKCS11 WP11_API int WP11_Slot_TokenKeyIsZero(CK_SLOT_ID slotId); +WP11_API int WP11_Slot_TokenDecodedObjectCount(CK_SLOT_ID slotId); #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 7976f1c4f79aedc2e78b43928d45160b5dbdd5b0 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 09:10:43 -0700 Subject: [PATCH 03/61] F-5080 - Keep the PIN lockout armed when failed logins race --- src/internal.c | 58 +++++++++++----- src/slot.c | 4 +- tests/login_pin_state_test.c | 131 +++++++++++++++++++++++++++++++++++ 3 files changed, 173 insertions(+), 20 deletions(-) diff --git a/src/internal.c b/src/internal.c index fd242e61..caf76825 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8486,7 +8486,7 @@ int WP11_Slot_CheckSOPinLockout(WP11_Slot* slot, char* pin, int pinLen) /* Check for too many fails and whether the timeout has elapsed. */ WP11_Lock_LockRW(&slot->lock); - if (slot->token.soFailedLogin == WP11_MAX_LOGIN_FAILS_SO) { + if (slot->token.soFailedLogin >= WP11_MAX_LOGIN_FAILS_SO) { allowed = slot->token.soLastFailedLogin + slot->token.soFailLoginTimeout; if (allowed < now) @@ -8504,7 +8504,8 @@ int WP11_Slot_CheckSOPinLockout(WP11_Slot* slot, char* pin, int pinLen) #ifndef WOLFPKCS11_NO_TIME WP11_Lock_LockRW(&slot->lock); /* PIN failed - update failure info. */ - if (ret == PIN_INVALID_E) { + if (ret == PIN_INVALID_E && + slot->token.soFailedLogin < WP11_MAX_LOGIN_FAILS_SO) { slot->token.soFailedLogin++; if (slot->token.soFailedLogin == WP11_MAX_LOGIN_FAILS_SO) { slot->token.soLastFailedLogin = now; @@ -8597,7 +8598,8 @@ int WP11_Slot_SOLogin(WP11_Slot* slot, char* pin, int pinLen) ret = PIN_INVALID_E; #endif - WP11_Lock_LockRO(&slot->lock); + /* Write lock: the lockout check below may reset the failure count. */ + WP11_Lock_LockRW(&slot->lock); if (ret == 0) { /* SO already logged in is the same user type; a logged-in USER is a * different one. */ @@ -8612,7 +8614,7 @@ int WP11_Slot_SOLogin(WP11_Slot* slot, char* pin, int pinLen) } #ifndef WOLFPKCS11_NO_TIME /* Check for too many fails and timeout. */ - if (ret == 0 && slot->token.soFailedLogin == WP11_MAX_LOGIN_FAILS_SO) { + if (ret == 0 && slot->token.soFailedLogin >= WP11_MAX_LOGIN_FAILS_SO) { allowed = slot->token.soLastFailedLogin + slot->token.soFailLoginTimeout; if (allowed < now) @@ -8638,7 +8640,7 @@ int WP11_Slot_SOLogin(WP11_Slot* slot, char* pin, int pinLen) ret = READ_ONLY_E; } #endif - WP11_Lock_UnlockRO(&slot->lock); + WP11_Lock_UnlockRW(&slot->lock); if (ret == 0) { ret = WP11_Slot_CheckSOPin(slot, pin, pinLen); @@ -8646,10 +8648,14 @@ int WP11_Slot_SOLogin(WP11_Slot* slot, char* pin, int pinLen) /* PIN Failed - Update failure info. */ if (ret == PIN_INVALID_E) { #ifndef WOLFPKCS11_NO_TIME - slot->token.soFailedLogin++; - if (slot->token.soFailedLogin == WP11_MAX_LOGIN_FAILS_SO) { - slot->token.soLastFailedLogin = now; - slot->token.soFailLoginTimeout += WP11_SO_LOGIN_FAIL_TIMEOUT; + /* Concurrent failures must not push the count past the limit. */ + if (slot->token.soFailedLogin < WP11_MAX_LOGIN_FAILS_SO) { + slot->token.soFailedLogin++; + if (slot->token.soFailedLogin == WP11_MAX_LOGIN_FAILS_SO) { + slot->token.soLastFailedLogin = now; + slot->token.soFailLoginTimeout += + WP11_SO_LOGIN_FAIL_TIMEOUT; + } } #endif } @@ -8719,7 +8725,7 @@ int WP11_Slot_UserLogin(WP11_Slot* slot, char* pin, int pinLen) } #ifndef WOLFPKCS11_NO_TIME /* Check for too many fails */ - if (ret == 0 && token->userFailedLogin == WP11_MAX_LOGIN_FAILS_USER) { + if (ret == 0 && token->userFailedLogin >= WP11_MAX_LOGIN_FAILS_USER) { allowed = token->userLastFailedLogin + token->userFailLoginTimeout; if (allowed < now) token->userFailedLogin = 0; @@ -8744,10 +8750,14 @@ int WP11_Slot_UserLogin(WP11_Slot* slot, char* pin, int pinLen) /* PIN Failed - Update failure info. */ if (ret == PIN_INVALID_E) { #ifndef WOLFPKCS11_NO_TIME - token->userFailedLogin++; - if (token->userFailedLogin == WP11_MAX_LOGIN_FAILS_USER) { - token->userLastFailedLogin = now; - token->userFailLoginTimeout += WP11_USER_LOGIN_FAIL_TIMEOUT; + /* Concurrent failures must not push the count past the limit. */ + if (token->userFailedLogin < WP11_MAX_LOGIN_FAILS_USER) { + token->userFailedLogin++; + if (token->userFailedLogin == WP11_MAX_LOGIN_FAILS_USER) { + token->userLastFailedLogin = now; + token->userFailLoginTimeout += + WP11_USER_LOGIN_FAIL_TIMEOUT; + } } #endif } @@ -9080,10 +9090,16 @@ int WP11_Slot_IsTokenInitialized(WP11_Slot* slot) */ int WP11_Slot_TokenFailedLogin(WP11_Slot* slot, int login) { + int ret; + + WP11_Lock_LockRO(&slot->lock); if (login == WP11_LOGIN_SO) - return slot->token.soFailedLogin; + ret = slot->token.soFailedLogin; else - return slot->token.userFailedLogin; + ret = slot->token.userFailedLogin; + WP11_Lock_UnlockRO(&slot->lock); + + return ret; } /** @@ -9096,12 +9112,18 @@ int WP11_Slot_TokenFailedLogin(WP11_Slot* slot, int login) */ time_t WP11_Slot_TokenFailedExpire(WP11_Slot* slot, int login) { + time_t ret; + + WP11_Lock_LockRO(&slot->lock); if (login == WP11_LOGIN_SO) - return slot->token.soLastFailedLogin + slot->token.soFailLoginTimeout; + ret = slot->token.soLastFailedLogin + slot->token.soFailLoginTimeout; else { - return slot->token.userLastFailedLogin + + ret = slot->token.userLastFailedLogin + slot->token.userFailLoginTimeout; } + WP11_Lock_UnlockRO(&slot->lock); + + return ret; } /** diff --git a/src/slot.c b/src/slot.c index 5f7a21bb..b8dcc429 100644 --- a/src/slot.c +++ b/src/slot.c @@ -274,7 +274,7 @@ CK_RV C_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pInfo) if (cnt == WP11_MAX_LOGIN_FAILS_SO - 1) pInfo->flags |= CKF_SO_PIN_FINAL_TRY; #ifndef WOLFPKCS11_NO_TIME - else if (cnt == WP11_MAX_LOGIN_FAILS_SO && now < expire) + else if (cnt >= WP11_MAX_LOGIN_FAILS_SO && now < expire) pInfo->flags |= CKF_SO_PIN_LOCKED; #endif @@ -287,7 +287,7 @@ CK_RV C_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pInfo) if (cnt == WP11_MAX_LOGIN_FAILS_USER - 1) pInfo->flags |= CKF_USER_PIN_FINAL_TRY; #ifndef WOLFPKCS11_NO_TIME - else if (cnt == WP11_MAX_LOGIN_FAILS_USER && now < expire) + else if (cnt >= WP11_MAX_LOGIN_FAILS_USER && now < expire) pInfo->flags |= CKF_USER_PIN_LOCKED; #endif diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index c6840aae..d4838cc6 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -43,6 +43,8 @@ #include #endif +#include + #include "testdata.h" #include "pkcs11_test_util.h" @@ -351,6 +353,132 @@ static void empty_pin_change_requires_login_test(void) } #endif +#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) +#define LOCKOUT_THREADS 6 +#define LOCKOUT_ROUNDS 4 + +static const char* wrongPin = "not-the-right-pin"; + +typedef struct login_ctx { + CK_SESSION_HANDLE session; + CK_USER_TYPE type; + CK_RV rv; +} login_ctx; + +static pthread_mutex_t goMutex = PTHREAD_MUTEX_INITIALIZER; +static pthread_cond_t goCond = PTHREAD_COND_INITIALIZER; +static int goFlag = 0; + +static void* wrong_login(void* arg) +{ + login_ctx* ctx = (login_ctx*)arg; + + pthread_mutex_lock(&goMutex); + while (!goFlag) + pthread_cond_wait(&goCond, &goMutex); + pthread_mutex_unlock(&goMutex); + + ctx->rv = funcList->C_Login(ctx->session, ctx->type, + (CK_UTF8CHAR_PTR)wrongPin, + (CK_ULONG)XSTRLEN(wrongPin)); + return NULL; +} + +/* Run simultaneous wrong-PIN logins, one per session. Returns 1 when every + * one of them was rejected as an incorrect PIN. */ +static int concurrent_wrong_logins(CK_SLOT_ID slot, CK_USER_TYPE type) +{ + int i; + int started = 0; + int rejected = 1; + pthread_t threads[LOCKOUT_THREADS]; + login_ctx ctx[LOCKOUT_THREADS]; + + goFlag = 0; + for (i = 0; i < LOCKOUT_THREADS; i++) { + ctx[i].session = CK_INVALID_HANDLE; + ctx[i].type = type; + ctx[i].rv = CKR_OK; + if (open_rw(slot, &ctx[i].session) != CKR_OK) + break; + if (pthread_create(&threads[i], NULL, wrong_login, &ctx[i]) != 0) { + funcList->C_CloseSession(ctx[i].session); + break; + } + started++; + } + pthread_mutex_lock(&goMutex); + goFlag = 1; + pthread_cond_broadcast(&goCond); + pthread_mutex_unlock(&goMutex); + for (i = 0; i < started; i++) { + pthread_join(threads[i], NULL); + funcList->C_CloseSession(ctx[i].session); + if (ctx[i].rv != CKR_PIN_INCORRECT) + rejected = 0; + } + CHECK_TRUE(started == LOCKOUT_THREADS, "start concurrent logins"); + return rejected; +} + +/* Failed logins that race each other still lock out the correct PIN. */ +static void lockout_after_concurrent_failures(CK_USER_TYPE type, + const char* pin, int maxFails, + const char* what) +{ + CK_RV rv = CKR_OK; + int i; + int round; + int locked = 1; + int rejected = 1; + CK_RV final; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + + for (round = 0; rv == CKR_OK && round < LOCKOUT_ROUNDS; round++) { + rv = token_setup(&slot, userPin); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + for (i = 0; rv == CKR_OK && i < maxFails - 1; i++) { + rv = funcList->C_Login(session, type, (CK_UTF8CHAR_PTR)wrongPin, + (CK_ULONG)XSTRLEN(wrongPin)); + if (rv == CKR_PIN_INCORRECT) + rv = CKR_OK; + } + if (rv == CKR_OK) { + if (!concurrent_wrong_logins(slot, type)) + rejected = 0; + final = funcList->C_Login(session, type, (CK_UTF8CHAR_PTR)pin, + (CK_ULONG)XSTRLEN(pin)); + if (final != CKR_PIN_INCORRECT && final != CKR_PIN_LOCKED) + locked = 0; + if (final == CKR_OK) + funcList->C_Logout(session); + } + if (session != CK_INVALID_HANDLE) { + funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; + } + funcList->C_Finalize(NULL); + /* The lockout is persisted; start each round from a fresh token. */ + cleanup_test_files(); + } + CHECK_RV(rv, "set up failed logins", CKR_OK); + CHECK_TRUE(rejected, "concurrent wrong PINs rejected"); + CHECK_TRUE(locked, what); +} + +static void concurrent_login_lockout_test(void) +{ + printf("--- concurrent failed logins lock out the PIN ---\n"); + lockout_after_concurrent_failures(CKU_USER, userPin, + WP11_MAX_LOGIN_FAILS_USER, + "user PIN locked after racing failures"); + lockout_after_concurrent_failures(CKU_SO, soPin, WP11_MAX_LOGIN_FAILS_SO, + "SO PIN locked after racing failures"); +} +#endif + static int run_test(void) { CK_RV rv; @@ -366,6 +494,9 @@ static int run_test(void) #ifdef LOGIN_TEST_FILE_STORE failed_login_leaves_no_token_key_test(); #endif +#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) + concurrent_login_lockout_test(); +#endif pkcs11_unload(); return 0; From 33fa0d8400d5061be1c0e35ede03b19160cd2fbd Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 09:22:56 -0700 Subject: [PATCH 04/61] F-4962 - Apply the SO login lockout to C_SetPIN --- src/slot.c | 2 +- tests/login_pin_state_test.c | 51 ++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 1 deletion(-) diff --git a/src/slot.c b/src/slot.c index b8dcc429..aa6748b8 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1494,7 +1494,7 @@ CK_RV C_SetPIN(CK_SESSION_HANDLE hSession, CK_UTF8CHAR_PTR pOldPin, slot = WP11_Session_GetSlot(session); if (state == WP11_APP_STATE_RW_SO) { - ret = WP11_Slot_CheckSOPin(slot, (char*)pOldPin, (int)ulOldLen); + ret = WP11_Slot_CheckSOPinLockout(slot, (char*)pOldPin, (int)ulOldLen); if (ret == PIN_NOT_SET_E) { rv = CKR_USER_PIN_NOT_INITIALIZED; WOLFPKCS11_LEAVE("C_SetPIN", rv); diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index d4838cc6..6cb4d591 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -72,6 +72,9 @@ static const char* soPin = "password123456"; static const char* userPin = "wolfpkcs11-test"; static const char tokenLabel[] = "login-pin-state"; +#ifndef WOLFPKCS11_NO_TIME +static const char* wrongOldPin = "wrong-old-pin"; +#endif /* Start from an unprovisioned token so earlier runs cannot affect this one. */ static void cleanup_test_files(void) @@ -353,6 +356,49 @@ static void empty_pin_change_requires_login_test(void) } #endif +#ifndef WOLFPKCS11_NO_TIME +/* Changing a PIN counts wrong old PINs toward the login lockout. */ +static void set_pin_lockout(CK_USER_TYPE type, const char* pin, int maxFails, + const char* what) +{ + CK_RV rv; + int i; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + const char* newPin = "replacement-pin"; + + rv = token_setup(&slot, userPin); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + if (rv == CKR_OK && type == CKU_SO) { + rv = funcList->C_Login(session, CKU_SO, (CK_UTF8CHAR_PTR)soPin, + (CK_ULONG)XSTRLEN(soPin)); + } + CHECK_RV(rv, "token setup", CKR_OK); + if (rv != CKR_OK) { + funcList->C_Finalize(NULL); + return; + } + for (i = 0; i < maxFails; i++) { + rv = funcList->C_SetPIN(session, (CK_UTF8CHAR_PTR)wrongOldPin, + (CK_ULONG)XSTRLEN(wrongOldPin), + (CK_UTF8CHAR_PTR)newPin, + (CK_ULONG)XSTRLEN(newPin)); + CHECK_RV(rv, "C_SetPIN with wrong old PIN", CKR_PIN_INCORRECT); + } + rv = funcList->C_SetPIN(session, (CK_UTF8CHAR_PTR)pin, + (CK_ULONG)XSTRLEN(pin), (CK_UTF8CHAR_PTR)newPin, + (CK_ULONG)XSTRLEN(newPin)); + CHECK_TRUE(rv == CKR_PIN_INCORRECT || rv == CKR_PIN_LOCKED, what); + if (type == CKU_SO) + funcList->C_Logout(session); + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); + /* The lockout is persisted; start later tests from a fresh token. */ + cleanup_test_files(); +} +#endif + #if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) #define LOCKOUT_THREADS 6 #define LOCKOUT_ROUNDS 4 @@ -497,6 +543,11 @@ static int run_test(void) #if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) concurrent_login_lockout_test(); #endif +#ifndef WOLFPKCS11_NO_TIME + printf("--- C_SetPIN counts failed SO PIN checks ---\n"); + set_pin_lockout(CKU_SO, soPin, WP11_MAX_LOGIN_FAILS_SO, + "SO C_SetPIN locked after failures"); +#endif pkcs11_unload(); return 0; From d0bc59ab947b826f33b538f8be5817873f3ac2a1 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 09:30:10 -0700 Subject: [PATCH 05/61] F-6495 - Apply the user login lockout to C_SetPIN --- src/internal.c | 63 ++++++++++++++++++++++++++++++++++++ src/slot.c | 3 +- tests/login_pin_state_test.c | 3 ++ wolfpkcs11/internal.h | 2 ++ 4 files changed, 70 insertions(+), 1 deletion(-) diff --git a/src/internal.c b/src/internal.c index caf76825..fe165957 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8572,6 +8572,69 @@ int WP11_Slot_CheckUserPin(WP11_Slot* slot, char* pin, int pinLen) return ret; } +/** + * Check the user PIN with the failed-login lockout applied, but without + * logging in. Wrong PINs count toward the same WP11_MAX_LOGIN_FAILS_USER limit + * that WP11_Slot_UserLogin enforces. + * + * @param slot [in] Slot object. + * @param pin [in] PIN to check. + * @param pinLen [in] Length of PIN. + * @return PIN_NOT_SET_E when the user PIN is not set. + * PIN_INVALID_E when the PIN is not correct or the user is locked out. + * Other -ve value when hashing PIN fails. + * 0 when PIN is correct. + */ +int WP11_Slot_CheckUserPinLockout(WP11_Slot* slot, char* pin, int pinLen) +{ + int ret; +#ifndef WOLFPKCS11_NO_TIME + time_t now; + time_t allowed; + + if (wc_GetTime(&now, sizeof(now)) != 0) + return PIN_INVALID_E; + + /* Check for too many fails and whether the timeout has elapsed. */ + WP11_Lock_LockRW(&slot->lock); + if (slot->token.userFailedLogin >= WP11_MAX_LOGIN_FAILS_USER) { + allowed = slot->token.userLastFailedLogin + + slot->token.userFailLoginTimeout; + if (allowed < now) + slot->token.userFailedLogin = 0; + else { + WP11_Lock_UnlockRW(&slot->lock); + return PIN_INVALID_E; + } + } + WP11_Lock_UnlockRW(&slot->lock); +#endif + + ret = WP11_Slot_CheckUserPin(slot, pin, pinLen); + +#ifndef WOLFPKCS11_NO_TIME + WP11_Lock_LockRW(&slot->lock); + /* PIN failed - update failure info. */ + if (ret == PIN_INVALID_E && + slot->token.userFailedLogin < WP11_MAX_LOGIN_FAILS_USER) { + slot->token.userFailedLogin++; + if (slot->token.userFailedLogin == WP11_MAX_LOGIN_FAILS_USER) { + slot->token.userLastFailedLogin = now; + slot->token.userFailLoginTimeout += WP11_USER_LOGIN_FAIL_TIMEOUT; + } + } + /* Worked - clear failure info. */ + else if (ret == 0) { + slot->token.userFailedLogin = 0; + slot->token.userLastFailedLogin = 0; + slot->token.userFailLoginTimeout = 0; + } + WP11_Lock_UnlockRW(&slot->lock); +#endif + + return ret; +} + /** * Log the SO (Security Officer) into the token. * diff --git a/src/slot.c b/src/slot.c index aa6748b8..95938e00 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1514,7 +1514,8 @@ CK_RV C_SetPIN(CK_SESSION_HANDLE hSession, CK_UTF8CHAR_PTR pOldPin, } } else { - ret = WP11_Slot_CheckUserPin(slot, (char*)pOldPin, (int)ulOldLen); + ret = WP11_Slot_CheckUserPinLockout(slot, (char*)pOldPin, + (int)ulOldLen); if (ret == PIN_NOT_SET_E) { rv = CKR_USER_PIN_NOT_INITIALIZED; WOLFPKCS11_LEAVE("C_SetPIN", rv); diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index 6cb4d591..787ef893 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -547,6 +547,9 @@ static int run_test(void) printf("--- C_SetPIN counts failed SO PIN checks ---\n"); set_pin_lockout(CKU_SO, soPin, WP11_MAX_LOGIN_FAILS_SO, "SO C_SetPIN locked after failures"); + printf("--- C_SetPIN counts failed user PIN checks ---\n"); + set_pin_lockout(CKU_USER, userPin, WP11_MAX_LOGIN_FAILS_USER, + "user C_SetPIN locked after failures"); #endif pkcs11_unload(); diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 09f8d7ed..313fe55c 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -404,6 +404,8 @@ WP11_LOCAL int WP11_Slot_CheckSOPin(WP11_Slot* slot, char* pin, int pinLen); WP11_LOCAL int WP11_Slot_CheckSOPinLockout(WP11_Slot* slot, char* pin, int pinLen); WP11_LOCAL int WP11_Slot_CheckUserPin(WP11_Slot* slot, char* pin, int pinLen); +WP11_LOCAL int WP11_Slot_CheckUserPinLockout(WP11_Slot* slot, char* pin, + int pinLen); WP11_LOCAL int WP11_Slot_Has_Empty_Pin(WP11_Slot* slot); WP11_LOCAL int WP11_Slot_SOPin_IsSet(WP11_Slot* slot); WP11_LOCAL int WP11_Slot_SOLogin(WP11_Slot* slot, char* pin, int pinLen); From f0084ebe0616c7a592569be95bf509e80e34f4a3 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 09:38:11 -0700 Subject: [PATCH 06/61] F-13244 - Decide and log out on last session close under one lock --- src/internal.c | 38 ++++++++++----- tests/login_pin_state_test.c | 94 ++++++++++++++++++++++++++++++++++++ 2 files changed, 119 insertions(+), 13 deletions(-) diff --git a/src/internal.c b/src/internal.c index fe165957..f5560927 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8178,6 +8178,8 @@ int WP11_Slot_OpenSession(WP11_Slot* slot, unsigned long flags, void* app, return ret; } +static void wp11_Slot_Logout(WP11_Slot* slot); + /** * Close a session associated with a slot. * @@ -8216,18 +8218,18 @@ void WP11_Slot_CloseSession(WP11_Slot* slot, WP11_Session* session) wp11_Slot_FreeSession(slot, session); else wp11_Session_Final(session); - WP11_Lock_UnlockRW(&slot->lock); - WP11_Lock_LockRO(&slot->lock); + /* Decide and log out under the same lock so a concurrent open is either + * seen here or opens after the logout. */ for (curr = slot->session; curr != NULL; curr = curr->next) { if (curr->inUse) { noMore = 0; break; } } - WP11_Lock_UnlockRO(&slot->lock); if (noMore) - WP11_Slot_Logout(slot); + wp11_Slot_Logout(slot); + WP11_Lock_UnlockRW(&slot->lock); } /** @@ -8252,13 +8254,10 @@ void WP11_Slot_CloseSessions(WP11_Slot* slot) /* Finalize the rest. */ for (curr = slot->session; curr != NULL; curr = curr->next) wp11_Session_Final(curr); - WP11_Lock_UnlockRW(&slot->lock); - /* PKCS#11: closing an application's last session with a token logs the - * application out. Mirror the single-session close path and reset the - * token login state (outside the slot lock, as WP11_Slot_Logout takes it). - */ - WP11_Slot_Logout(slot); + * application out. Done under the same lock as the close. */ + wp11_Slot_Logout(slot); + WP11_Lock_UnlockRW(&slot->lock); } /** @@ -9019,15 +9018,18 @@ int WP11_Slot_IsUserLoggedIn(WP11_Slot* slot) return wp11_LoginStateIsUser(state); } -void WP11_Slot_Logout(WP11_Slot* slot) +/** + * Logout of the token. Caller holds the slot lock for writing. + * + * @param slot [in] Slot object referencing token. + */ +static void wp11_Slot_Logout(WP11_Slot* slot) { #ifndef WOLFPKCS11_NO_STORE int state; int ret = 0; #endif - WP11_Lock_LockRW(&slot->lock); - #ifndef WOLFPKCS11_NO_STORE state = slot->token.loginState; if (state == WP11_APP_STATE_RO_USER || state == WP11_APP_STATE_RW_USER) { @@ -9042,7 +9044,17 @@ void WP11_Slot_Logout(WP11_Slot* slot) } #endif slot->token.loginState = WP11_APP_STATE_RW_PUBLIC; +} +/** + * Logout of the token. + * + * @param slot [in] Slot object referencing token. + */ +void WP11_Slot_Logout(WP11_Slot* slot) +{ + WP11_Lock_LockRW(&slot->lock); + wp11_Slot_Logout(slot); WP11_Lock_UnlockRW(&slot->lock); } diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index 787ef893..a964f9c2 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -525,6 +525,97 @@ static void concurrent_login_lockout_test(void) } #endif +#ifndef SINGLE_THREADED +#define CLOSE_OPEN_ROUNDS 10 + +static pthread_mutex_t openMutex = PTHREAD_MUTEX_INITIALIZER; +static pthread_cond_t openCond = PTHREAD_COND_INITIALIZER; +static int openFlag = 0; + +typedef struct open_ctx { + CK_SLOT_ID slot; + CK_SESSION_HANDLE session; + CK_STATE firstState; + CK_STATE lastState; + CK_RV rv; +} open_ctx; + +static void* open_during_close(void* arg) +{ + open_ctx* ctx = (open_ctx*)arg; + CK_SESSION_INFO info; + + pthread_mutex_lock(&openMutex); + while (!openFlag) + pthread_cond_wait(&openCond, &openMutex); + pthread_mutex_unlock(&openMutex); + + ctx->rv = open_rw(ctx->slot, &ctx->session); + if (ctx->rv == CKR_OK) + ctx->rv = funcList->C_GetSessionInfo(ctx->session, &info); + if (ctx->rv == CKR_OK) + ctx->firstState = info.state; + return NULL; +} + +/* A session opened while another one closes is never logged out after + * C_OpenSession reported it as logged in. */ +static void close_last_session_race_test(void) +{ + CK_RV rv; + int i; + int consistent = 1; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_SESSION_INFO info; + pthread_t thread; + open_ctx ctx; + + printf("--- closing the last session races an open ---\n"); + rv = token_setup(&slot, userPin); + CHECK_RV(rv, "token setup", CKR_OK); + for (i = 0; rv == CKR_OK && i < CLOSE_OPEN_ROUNDS; i++) { + rv = open_rw(slot, &session); + if (rv == CKR_OK) + rv = user_login(session, userPin); + if (rv != CKR_OK) + break; + + XMEMSET(&ctx, 0, sizeof(ctx)); + XMEMSET(&info, 0, sizeof(info)); + ctx.slot = slot; + ctx.session = CK_INVALID_HANDLE; + openFlag = 0; + if (pthread_create(&thread, NULL, open_during_close, &ctx) != 0) { + rv = CKR_GENERAL_ERROR; + break; + } + pthread_mutex_lock(&openMutex); + openFlag = 1; + pthread_cond_broadcast(&openCond); + pthread_mutex_unlock(&openMutex); + rv = funcList->C_CloseSession(session); + pthread_join(thread, NULL); + if (rv == CKR_OK) + rv = ctx.rv; + if (rv == CKR_OK) + rv = funcList->C_GetSessionInfo(ctx.session, &info); + if (rv == CKR_OK && ctx.firstState == CKS_RW_USER_FUNCTIONS && + info.state != CKS_RW_USER_FUNCTIONS) { + consistent = 0; + } + if (ctx.session != CK_INVALID_HANDLE) { + if (info.state == CKS_RW_USER_FUNCTIONS) + funcList->C_Logout(ctx.session); + funcList->C_CloseSession(ctx.session); + } + } + CHECK_RV(rv, "open and close sessions concurrently", CKR_OK); + CHECK_TRUE(consistent, "opened session keeps its reported login state"); + funcList->C_Finalize(NULL); +} +#endif + static int run_test(void) { CK_RV rv; @@ -540,6 +631,9 @@ static int run_test(void) #ifdef LOGIN_TEST_FILE_STORE failed_login_leaves_no_token_key_test(); #endif +#ifndef SINGLE_THREADED + close_last_session_race_test(); +#endif #if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) concurrent_login_lockout_test(); #endif From 4f844550c3fa397214514f5cc698931c6a2bf803 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:34:40 -0700 Subject: [PATCH 07/61] F-5253 - Hold the token lock while walking session objects in find --- src/internal.c | 11 ++--- tests/login_pin_state_test.c | 84 ++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+), 8 deletions(-) diff --git a/src/internal.c b/src/internal.c index f5560927..42055e45 100644 --- a/src/internal.c +++ b/src/internal.c @@ -10595,15 +10595,11 @@ static WP11_Object* wp11_Session_FindNext(WP11_Session* session, int onToken, * C_Login and enumerates private keys (e.g. certutil) from a public * session - matching the by-handle WP11_Object_Find check below. */ if ((ret->opFlag & WP11_FLAG_PRIVATE) == WP11_FLAG_PRIVATE) { - if (!onToken) - WP11_Lock_LockRO(&session->slot->token.lock); if (!wp11_LoginStateIsUser( session->slot->token.loginState)) { object = ret; ret = NULL; } - if (!onToken) - WP11_Lock_UnlockRO(&session->slot->token.lock); } #endif } @@ -10660,8 +10656,8 @@ int WP11_Session_Find(WP11_Session* session, int onToken, int i; CK_ATTRIBUTE* attr; - if (onToken) - WP11_Lock_LockRO(&session->slot->token.lock); + /* Session object lists change under the token lock too. */ + WP11_Lock_LockRO(&session->slot->token.lock); while (ret == 0 && (obj = wp11_Session_FindNext(session, onToken, obj)) != NULL) { for (i = 0; i < (int)ulCount; i++) { @@ -10675,8 +10671,7 @@ int WP11_Session_Find(WP11_Session* session, int onToken, if (i == (int)ulCount) ret = wp11_Session_FindMatched(session, obj); } - if (onToken) - WP11_Lock_UnlockRO(&session->slot->token.lock); + WP11_Lock_UnlockRO(&session->slot->token.lock); return ret; } diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index a964f9c2..bd60a9aa 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -616,6 +616,87 @@ static void close_last_session_race_test(void) } #endif +#ifndef SINGLE_THREADED +#define CHURN_ROUNDS 200 + +typedef struct churn_ctx { + CK_SESSION_HANDLE session; + CK_RV rv; +} churn_ctx; + +static void* churn_session_objects(void* arg) +{ + churn_ctx* ctx = (churn_ctx*)arg; + int i; + CK_OBJECT_HANDLE obj; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_BBOOL no = CK_FALSE; + byte value[4] = { 5, 6, 7, 8 }; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &no, sizeof(no) }, + { CKA_VALUE, value, sizeof(value) }, + }; + + for (i = 0; ctx->rv == CKR_OK && i < CHURN_ROUNDS; i++) { + ctx->rv = funcList->C_CreateObject(ctx->session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), &obj); + if (ctx->rv == CKR_OK) + ctx->rv = funcList->C_DestroyObject(ctx->session, obj); + } + return NULL; +} + +/* Finding session objects is safe while session objects come and go. */ +static void find_during_object_churn_test(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE found[8]; + CK_ULONG cnt; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_BBOOL no = CK_FALSE; + CK_ATTRIBUTE findTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &no, sizeof(no) }, + }; + pthread_t thread; + churn_ctx ctx; + int i; + + printf("--- find session objects while they change ---\n"); + rv = token_setup(&slot, userPin); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + CHECK_RV(rv, "token setup", CKR_OK); + if (rv != CKR_OK) { + funcList->C_Finalize(NULL); + return; + } + ctx.session = session; + ctx.rv = CKR_OK; + if (pthread_create(&thread, NULL, churn_session_objects, &ctx) != 0) { + CHECK_TRUE(0, "create object churn thread"); + funcList->C_Finalize(NULL); + return; + } + for (i = 0; rv == CKR_OK && i < CHURN_ROUNDS; i++) { + rv = funcList->C_FindObjectsInit(session, findTmpl, 2); + if (rv == CKR_OK) { + rv = funcList->C_FindObjects(session, found, 8, &cnt); + funcList->C_FindObjectsFinal(session); + } + } + pthread_join(thread, NULL); + CHECK_RV(rv, "find session objects concurrently", CKR_OK); + CHECK_RV(ctx.rv, "create and destroy session objects concurrently", + CKR_OK); + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + static int run_test(void) { CK_RV rv; @@ -637,6 +718,9 @@ static int run_test(void) #if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) concurrent_login_lockout_test(); #endif +#ifndef SINGLE_THREADED + find_during_object_churn_test(); +#endif #ifndef WOLFPKCS11_NO_TIME printf("--- C_SetPIN counts failed SO PIN checks ---\n"); set_pin_lockout(CKU_SO, soPin, WP11_MAX_LOGIN_FAILS_SO, From a433096c9dfc2111141921d0c2d3fe51f982ee6b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:57:25 -0700 Subject: [PATCH 08/61] F-8663 - Protect every token object on logout despite a failure --- src/internal.c | 40 +++++++++++-- tests/login_pin_state_test.c | 113 +++++++++++++++++++++++++++++++++++ 2 files changed, 148 insertions(+), 5 deletions(-) diff --git a/src/internal.c b/src/internal.c index 42055e45..90ee0a27 100644 --- a/src/internal.c +++ b/src/internal.c @@ -7067,6 +7067,31 @@ static void wp11_Object_Scrub(WP11_Object* object) } } +/** + * Encrypt the token's decoded objects with the current token key. + * + * @param [in, out] token Token object. + * @param [in] protect Unencrypted private key data is cleared. + * @return 0 on success. + * @return -ve on failure of any object. + */ +static int wp11_Token_EncodeObjects(WP11_Token* token, int protect) +{ + int ret = 0; + int err; + WP11_Object* object; + + for (object = token->object; object != NULL; object = object->next) { + if (wp11_Object_IsEncrypted(object) && !object->encoded) { + err = wp11_Object_Encode(object, protect); + if (ret == 0) + ret = err; + } + } + + return ret; +} + /** * Unstore a key object to storage. * @@ -9027,16 +9052,21 @@ static void wp11_Slot_Logout(WP11_Slot* slot) { #ifndef WOLFPKCS11_NO_STORE int state; - int ret = 0; + WP11_Object* object; #endif #ifndef WOLFPKCS11_NO_STORE state = slot->token.loginState; if (state == WP11_APP_STATE_RO_USER || state == WP11_APP_STATE_RW_USER) { - WP11_Object* object = slot->token.object; - while (ret == 0 && object != NULL) { - ret = wp11_Object_Encode(object, 1); - object = object->next; + /* Protect every decoded object; one failure must not stop the rest. */ + if (wp11_Token_EncodeObjects(&slot->token, 1) != 0) { + WOLFPKCS11_MSG("Logout: failed to protect a token object"); + /* Never let a later store encrypt it under the zeroed key. */ + for (object = slot->token.object; object != NULL; + object = object->next) { + if (wp11_Object_IsEncrypted(object) && !object->encoded) + wp11_Object_Scrub(object); + } } /* Zero token key only on user logout — SO logout must preserve it * for subsequent object encryption (e.g., empty-PIN flow). */ diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index bd60a9aa..b8548a1b 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -250,6 +250,116 @@ static void failed_login_leaves_no_token_key_test(void) } #endif +#if defined(LOGIN_TEST_FILE_STORE) && defined(HAVE_ECC) +static char ecLabel[] = "pin-state-ec-key"; +static CK_BYTE ecP256Params[] = { + 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07 +}; + +static CK_RV create_ec_key(CK_SESSION_HANDLE session) +{ + CK_MECHANISM mech = { CKM_EC_KEY_PAIR_GEN, NULL, 0 }; + CK_OBJECT_HANDLE pub = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE priv = CK_INVALID_HANDLE; + CK_ATTRIBUTE pubTmpl[] = { + { CKA_EC_PARAMS, ecP256Params, sizeof(ecP256Params) }, + { CKA_VERIFY, &ckTrue, sizeof(ckTrue) }, + }; + CK_ATTRIBUTE privTmpl[] = { + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + { CKA_SIGN, &ckTrue, sizeof(ckTrue) }, + { CKA_LABEL, ecLabel, sizeof(ecLabel) - 1 }, + }; + + return funcList->C_GenerateKeyPair(session, &mech, pubTmpl, + sizeof(pubTmpl) / sizeof(*pubTmpl), privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &pub, &priv); +} + +/* Flip a byte of the stored EC private key so it no longer authenticates. */ +static int damage_stored_ec_key(void) +{ + FILE* f; + char filepath[512]; + int id; + int ret = -1; + int c; + + for (id = 0; id < 3 && ret != 0; id++) { + snprintf(filepath, sizeof(filepath), "%s" PATH_SEP + "wp11_ecckey_priv_0000000000000001_%016x", TEST_DIR, id); + f = fopen(filepath, "r+b"); + if (f == NULL) + continue; + if (fseek(f, -1, SEEK_END) == 0 && (c = fgetc(f)) != EOF && + fseek(f, -1, SEEK_END) == 0 && fputc(c ^ 0xff, f) != EOF) { + ret = 0; + } + if (fclose(f) != 0) + ret = -1; + } + return ret; +} + +/* Logout protects every decoded token object even when one cannot be. */ +static void logout_protects_all_objects_test(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 keyTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_VALUE, aesValue, sizeof(aesValue) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + }; + + printf("--- logout protects all token objects ---\n"); + rv = token_setup(&slot, userPin); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + if (rv == CKR_OK) + rv = user_login(session, userPin); + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, keyTmpl, + sizeof(keyTmpl) / sizeof(*keyTmpl), &obj); + } + if (rv == CKR_OK) + rv = create_ec_key(session); + CHECK_RV(rv, "create private token keys", CKR_OK); + if (session != CK_INVALID_HANDLE) { + funcList->C_Logout(session); + funcList->C_CloseSession(session); + session = CK_INVALID_HANDLE; + } + funcList->C_Finalize(NULL); + if (rv != CKR_OK) + return; + + CHECK_TRUE(damage_stored_ec_key() == 0, "damage stored EC key"); + rv = lib_init(); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + if (rv == CKR_OK) + rv = user_login(session, userPin); + CHECK_RV(rv, "login with one undecodable object", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(WP11_Slot_TokenDecodedObjectCount(slot) > 0, + "objects decoded while logged in"); + funcList->C_Logout(session); + CHECK_TRUE(WP11_Slot_TokenDecodedObjectCount(slot) == 0, + "no decoded objects left after logout"); + } + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); + cleanup_test_files(); +} +#endif + #ifndef SINGLE_THREADED #define EMPTY_PIN_ROUNDS 8 @@ -721,6 +831,9 @@ static int run_test(void) #ifndef SINGLE_THREADED find_during_object_churn_test(); #endif +#if defined(LOGIN_TEST_FILE_STORE) && defined(HAVE_ECC) + logout_protects_all_objects_test(); +#endif #ifndef WOLFPKCS11_NO_TIME printf("--- C_SetPIN counts failed SO PIN checks ---\n"); set_pin_lockout(CKU_SO, soPin, WP11_MAX_LOGIN_FAILS_SO, From 03b7f2e6947ebfec18a27a4f27c0e8e48761ee28 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:02:55 -0700 Subject: [PATCH 09/61] F-8642 - Stop token reset when token initialization fails --- src/internal.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/internal.c b/src/internal.c index 90ee0a27..c37c5568 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8403,15 +8403,17 @@ int WP11_Slot_TokenReset(WP11_Slot* slot, char* pin, int pinLen, char* label) /* Zeroizes token. */ token = &slot->token; wp11_Token_Final(token); - wp11_Token_Init(token, label); + ret = wp11_Token_Init(token, label); /* C_InitToken is the canonical provisioning step. Mark the token as * initialized here rather than in wp11_Token_Init so a fresh slot stays * UNKNOWN until either init or load (Fenrir 3407). */ - token->state = WP11_TOKEN_STATE_INITIALIZED; + if (ret == 0) + token->state = WP11_TOKEN_STATE_INITIALIZED; WP11_Lock_UnlockRW(&slot->lock); /* Locking used in setting SO PIN. */ - ret = WP11_Slot_SetSOPin(slot, pin, pinLen); + if (ret == 0) + ret = WP11_Slot_SetSOPin(slot, pin, pinLen); return ret; } From fb344342783f07a313cabab0c71b25f899a08d5d Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:18:19 -0700 Subject: [PATCH 10/61] F-4958 - Read login state under the slot lock when finding objects --- src/internal.c | 45 +++++-- tests/login_pin_state_test.c | 239 +++++++++++++++++++++++++++++++++++ wolfpkcs11/internal.h | 1 + 3 files changed, 276 insertions(+), 9 deletions(-) diff --git a/src/internal.c b/src/internal.c index c37c5568..d576e4e9 100644 --- a/src/internal.c +++ b/src/internal.c @@ -9057,6 +9057,8 @@ static void wp11_Slot_Logout(WP11_Slot* slot) WP11_Object* object; #endif + /* Object state is guarded by the token lock. */ + WP11_Lock_LockRW(&slot->token.lock); #ifndef WOLFPKCS11_NO_STORE state = slot->token.loginState; if (state == WP11_APP_STATE_RO_USER || state == WP11_APP_STATE_RW_USER) { @@ -9076,6 +9078,7 @@ static void wp11_Slot_Logout(WP11_Slot* slot) } #endif slot->token.loginState = WP11_APP_STATE_RW_PUBLIC; + WP11_Lock_UnlockRW(&slot->token.lock); } /** @@ -10589,7 +10592,7 @@ int WP11_Session_FindInit(WP11_Session* session) * @return The next object in session or token. */ static WP11_Object* wp11_Session_FindNext(WP11_Session* session, int onToken, - WP11_Object* object) + WP11_Object* object, int userLoggedIn) { WP11_Object* ret = NULL; @@ -10626,13 +10629,13 @@ static WP11_Object* wp11_Session_FindNext(WP11_Session* session, int onToken, * mode, which operates as the internal crypto module without calling * C_Login and enumerates private keys (e.g. certutil) from a public * session - matching the by-handle WP11_Object_Find check below. */ - if ((ret->opFlag & WP11_FLAG_PRIVATE) == WP11_FLAG_PRIVATE) { - if (!wp11_LoginStateIsUser( - session->slot->token.loginState)) { - object = ret; - ret = NULL; - } + if ((ret->opFlag & WP11_FLAG_PRIVATE) == WP11_FLAG_PRIVATE && + !userLoggedIn) { + object = ret; + ret = NULL; } +#else + (void)userLoggedIn; #endif } @@ -10672,6 +10675,20 @@ static int wp11_Session_FindMatched(WP11_Session* session, WP11_Object* object) return ret; } +#ifdef DEBUG_WOLFPKCS11 +static void (*wp11_findHook)(void) = NULL; + +/** + * Test hook: called by WP11_Session_Find once it has read the login state. + * + * @param hook [in] Function to call, or NULL to remove the hook. + */ +WP11_API void WP11_Session_SetFindHook(void (*hook)(void)) +{ + wp11_findHook = hook; +} +#endif + /** * Find objects on session or token with attributes matching template. * @@ -10686,12 +10703,21 @@ int WP11_Session_Find(WP11_Session* session, int onToken, WP11_Object* obj = NULL; int ret = 0; int i; + int userLoggedIn; CK_ATTRIBUTE* attr; + /* Slot then token lock, held across the walk so logout cannot race it. */ + WP11_Lock_LockRO(&session->slot->lock); + userLoggedIn = wp11_LoginStateIsUser(session->slot->token.loginState); +#ifdef DEBUG_WOLFPKCS11 + if (wp11_findHook != NULL) + wp11_findHook(); +#endif + /* Session object lists change under the token lock too. */ WP11_Lock_LockRO(&session->slot->token.lock); - while (ret == 0 && - (obj = wp11_Session_FindNext(session, onToken, obj)) != NULL) { + while (ret == 0 && (obj = wp11_Session_FindNext(session, onToken, obj, + userLoggedIn)) != NULL) { for (i = 0; i < (int)ulCount; i++) { attr = &pTemplate[i]; if (!WP11_Object_MatchAttr(obj, attr->type, (byte*)attr->pValue, @@ -10704,6 +10730,7 @@ int WP11_Session_Find(WP11_Session* session, int onToken, ret = wp11_Session_FindMatched(session, obj); } WP11_Lock_UnlockRO(&session->slot->token.lock); + WP11_Lock_UnlockRO(&session->slot->lock); return ret; } diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index b8548a1b..a0c96b96 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -50,6 +50,7 @@ #ifndef SINGLE_THREADED #include +#include #endif #define TEST_DIR "./store/login_pin_state_test" @@ -807,6 +808,236 @@ static void find_during_object_churn_test(void) } #endif +#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_STORE) && \ + !defined(NO_AES) +#define FIND_LOGIN_ROUNDS 3 + +static pthread_mutex_t findMutex = PTHREAD_MUTEX_INITIALIZER; +static int findStop = 0; + +typedef struct find_ctx { + CK_SESSION_HANDLE session; + CK_RV rv; +} find_ctx; + +static int find_should_stop(void) +{ + int stop; + + pthread_mutex_lock(&findMutex); + stop = findStop; + pthread_mutex_unlock(&findMutex); + return stop; +} + +static void find_set_stop(int stop) +{ + pthread_mutex_lock(&findMutex); + findStop = stop; + pthread_mutex_unlock(&findMutex); +} + +static void* find_loop(void* arg) +{ + find_ctx* ctx = (find_ctx*)arg; + CK_OBJECT_HANDLE found[8]; + CK_ULONG cnt; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + }; + + while (ctx->rv == CKR_OK && !find_should_stop()) { + ctx->rv = funcList->C_FindObjectsInit(ctx->session, tmpl, 1); + if (ctx->rv == CKR_OK) { + ctx->rv = funcList->C_FindObjects(ctx->session, found, 8, &cnt); + funcList->C_FindObjectsFinal(ctx->session); + } + } + return NULL; +} + +/* Finding objects stays well behaved while the user logs in and out, and + * private objects are not listed once logged out. */ +static void find_during_login_changes_test(void) +{ + CK_RV rv; + int i; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_SESSION_HANDLE findSession = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE found[8]; + CK_ULONG cnt = 0; + pthread_t thread; + find_ctx ctx; + CK_ATTRIBUTE keyTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + { CKA_KEY_TYPE, &aesType, sizeof(aesType) }, + { CKA_VALUE, aesValue, sizeof(aesValue) }, + { CKA_TOKEN, &ckTrue, sizeof(ckTrue) }, + { CKA_PRIVATE, &ckTrue, sizeof(ckTrue) }, + }; + CK_ATTRIBUTE findTmpl[] = { + { CKA_CLASS, &secretClass, sizeof(secretClass) }, + }; + + printf("--- find objects while logging in and out ---\n"); + rv = token_setup(&slot, userPin); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + if (rv == CKR_OK) + rv = open_rw(slot, &findSession); + if (rv == CKR_OK) + rv = user_login(session, userPin); + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, keyTmpl, + sizeof(keyTmpl) / sizeof(*keyTmpl), &obj); + } + CHECK_RV(rv, "create private token key", CKR_OK); + if (rv != CKR_OK) { + funcList->C_Finalize(NULL); + return; + } + + ctx.session = findSession; + ctx.rv = CKR_OK; + find_set_stop(0); + if (pthread_create(&thread, NULL, find_loop, &ctx) != 0) { + CHECK_TRUE(0, "create find thread"); + funcList->C_Finalize(NULL); + return; + } + for (i = 0; rv == CKR_OK && i < FIND_LOGIN_ROUNDS; i++) { + rv = funcList->C_Logout(session); + if (rv == CKR_OK) + rv = user_login(session, userPin); + } + if (rv == CKR_OK) + rv = funcList->C_Logout(session); + find_set_stop(1); + pthread_join(thread, NULL); + CHECK_RV(rv, "log in and out while finding", CKR_OK); + CHECK_RV(ctx.rv, "find objects concurrently", CKR_OK); + + rv = funcList->C_FindObjectsInit(findSession, findTmpl, 1); + if (rv == CKR_OK) { + rv = funcList->C_FindObjects(findSession, found, 8, &cnt); + funcList->C_FindObjectsFinal(findSession); + } + CHECK_TRUE(rv == CKR_OK && cnt == 0, + "private object not listed after logout"); + funcList->C_Finalize(NULL); +} +#endif + +#if defined(DEBUG_WOLFPKCS11) && !defined(SINGLE_THREADED) && \ + !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_NSS) +#define FIND_HOOK_WAIT_MS 200 + +static pthread_mutex_t hookMutex = PTHREAD_MUTEX_INITIALIZER; +static CK_SESSION_HANDLE hookSession = CK_INVALID_HANDLE; +static pthread_t hookThread; +static int hookStarted = 0; +static int hookLogoutDone = 0; +static int hookLogoutBeforeWalk = 0; + +static int hook_logout_done(void) +{ + int done; + + pthread_mutex_lock(&hookMutex); + done = hookLogoutDone; + pthread_mutex_unlock(&hookMutex); + return done; +} + +static void* hook_logout(void* arg) +{ + (void)arg; + (void)funcList->C_Logout(hookSession); + pthread_mutex_lock(&hookMutex); + hookLogoutDone = 1; + pthread_mutex_unlock(&hookMutex); + return NULL; +} + +/* Runs in C_FindObjectsInit between the login state read and the walk. */ +static void find_hook_logout(void) +{ + int i; + + if (hookStarted) + return; + hookStarted = (pthread_create(&hookThread, NULL, hook_logout, NULL) == 0); + for (i = 0; hookStarted && i < FIND_HOOK_WAIT_MS && !hook_logout_done(); + i++) { + usleep(1000); + } + hookLogoutBeforeWalk = hook_logout_done(); +} + +/* A logout racing a find must not let the walk list private objects. */ +static void find_with_racing_logout_test(void) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_SESSION_HANDLE findSession = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE found[4]; + CK_ULONG cnt = 0; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_BBOOL isTrue = CK_TRUE; + static byte privData[] = "private data value"; + CK_ATTRIBUTE dataTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &isTrue, sizeof(isTrue) }, + { CKA_PRIVATE, &isTrue, sizeof(isTrue) }, + { CKA_VALUE, privData, sizeof(privData) - 1 }, + }; + CK_ATTRIBUTE findTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + }; + + printf("--- find with a logout racing the object walk ---\n"); + rv = token_setup(&slot, userPin); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + if (rv == CKR_OK) + rv = open_rw(slot, &findSession); + if (rv == CKR_OK) + rv = user_login(session, userPin); + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, dataTmpl, + sizeof(dataTmpl) / sizeof(*dataTmpl), &obj); + } + CHECK_RV(rv, "create private token data object", CKR_OK); + if (rv == CKR_OK) { + hookSession = session; + hookStarted = 0; + hookLogoutBeforeWalk = 0; + pthread_mutex_lock(&hookMutex); + hookLogoutDone = 0; + pthread_mutex_unlock(&hookMutex); + WP11_Session_SetFindHook(find_hook_logout); + rv = funcList->C_FindObjectsInit(findSession, findTmpl, 1); + WP11_Session_SetFindHook(NULL); + if (hookStarted) + pthread_join(hookThread, NULL); + if (rv == CKR_OK) { + rv = funcList->C_FindObjects(findSession, found, 4, &cnt); + funcList->C_FindObjectsFinal(findSession); + } + CHECK_RV(rv, "find objects with a racing logout", CKR_OK); + CHECK_TRUE(hookStarted && hook_logout_done(), "racing logout ran"); + CHECK_TRUE(!(hookLogoutBeforeWalk && cnt > 0), + "walk after logout lists no private object"); + } + funcList->C_Finalize(NULL); + cleanup_test_files(); +} +#endif + static int run_test(void) { CK_RV rv; @@ -831,6 +1062,14 @@ static int run_test(void) #ifndef SINGLE_THREADED find_during_object_churn_test(); #endif +#if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_STORE) && \ + !defined(NO_AES) + find_during_login_changes_test(); +#endif +#if defined(DEBUG_WOLFPKCS11) && !defined(SINGLE_THREADED) && \ + !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_NSS) + find_with_racing_logout_test(); +#endif #if defined(LOGIN_TEST_FILE_STORE) && defined(HAVE_ECC) logout_protects_all_objects_test(); #endif diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index 313fe55c..de846042 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -416,6 +416,7 @@ WP11_LOCAL void WP11_Slot_Logout(WP11_Slot* slot); #ifdef DEBUG_WOLFPKCS11 WP11_API int WP11_Slot_TokenKeyIsZero(CK_SLOT_ID slotId); WP11_API int WP11_Slot_TokenDecodedObjectCount(CK_SLOT_ID slotId); +WP11_API void WP11_Session_SetFindHook(void (*hook)(void)); #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 f286ea187750d1419f6fc4bd8dcaa5e12f4d19a6 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:27:26 -0700 Subject: [PATCH 11/61] F-4267 - Read object flags under the token lock in object lookup --- src/internal.c | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/src/internal.c b/src/internal.c index d576e4e9..a3addda3 100644 --- a/src/internal.c +++ b/src/internal.c @@ -11885,6 +11885,9 @@ int WP11_Object_Find(WP11_Session* session, CK_OBJECT_HANDLE objHandle, { int ret = BAD_FUNC_ARG; WP11_Object* obj; +#ifndef WOLFPKCS11_NSS + word32 opFlag = 0; +#endif #ifdef WOLFPKCS11_NSS WP11_Session* scan; #endif @@ -11906,6 +11909,9 @@ int WP11_Object_Find(WP11_Session* session, CK_OBJECT_HANDLE objHandle, obj = session->object; while (obj != NULL) { if (obj->handle == objHandle) { + #ifndef WOLFPKCS11_NSS + opFlag = obj->opFlag; + #endif ret = 0; break; } @@ -11936,6 +11942,9 @@ int WP11_Object_Find(WP11_Session* session, CK_OBJECT_HANDLE objHandle, obj = session->slot->token.object; while (obj != NULL) { if (obj->handle == objHandle) { + #ifndef WOLFPKCS11_NSS + opFlag = obj->opFlag; + #endif ret = 0; break; } @@ -11944,12 +11953,14 @@ int WP11_Object_Find(WP11_Session* session, CK_OBJECT_HANDLE objHandle, WP11_Lock_UnlockRO(&session->slot->token.lock); } - if (ret == 0 && obj != NULL && (obj->handle == objHandle)) { + /* The flags were captured under the token lock: the object may be freed + * by a concurrent destroy once the lock is released. */ + if (ret == 0 && obj != NULL) { #ifndef WOLFPKCS11_NSS /* Enforce CKA_PRIVATE: reject private objects from public sessions. * Skipped in NSS mode because NSS operates as the internal crypto * module without calling C_Login. */ - if ((obj->opFlag & WP11_FLAG_PRIVATE) == WP11_FLAG_PRIVATE) { + if ((opFlag & WP11_FLAG_PRIVATE) == WP11_FLAG_PRIVATE) { int loginState; WP11_Lock_LockRO(&session->slot->lock); loginState = session->slot->token.loginState; From 12f06a5ae8344902d4abd1859130bf86b1bf823a Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:37:52 -0700 Subject: [PATCH 12/61] F-11509 - Invalidate private session objects on logout --- src/crypto.c | 657 +++++++++++++++++++++++++++++------ src/internal.c | 365 ++++++++++++++++++- tests/include.am | 7 + tests/login_pin_state_test.c | 116 +++++++ tests/logout_retire_test.c | 643 ++++++++++++++++++++++++++++++++++ wolfpkcs11/internal.h | 6 + 6 files changed, 1691 insertions(+), 103 deletions(-) create mode 100644 tests/logout_retire_test.c diff --git a/src/crypto.c b/src/crypto.c index 1d10ec1d..c8d3c2e3 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -1567,8 +1567,9 @@ static CK_RV CreateObject(WP11_Session* session, CK_ATTRIBUTE_PTR pTemplate, * CKR_FUNCTION_FAILED when creating the object fails. * CKR_OK on success. */ -CK_RV C_CreateObject(CK_SESSION_HANDLE hSession, CK_ATTRIBUTE_PTR pTemplate, - CK_ULONG ulCount, CK_OBJECT_HANDLE_PTR phObject) +static CK_RV wp11_C_CreateObject(CK_SESSION_HANDLE hSession, + CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, + CK_OBJECT_HANDLE_PTR phObject) { CK_RV rv; WP11_Session* session; @@ -1647,6 +1648,18 @@ CK_RV C_CreateObject(CK_SESSION_HANDLE hSession, CK_ATTRIBUTE_PTR pTemplate, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_CreateObject(CK_SESSION_HANDLE hSession, CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulCount, CK_OBJECT_HANDLE_PTR phObject) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_CreateObject(hSession, pTemplate, ulCount, phObject); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Copy the object in the session or on the token associated with the session. * @@ -1670,9 +1683,10 @@ CK_RV C_CreateObject(CK_SESSION_HANDLE hSession, CK_ATTRIBUTE_PTR pTemplate, * CK_UNAVAILABLE_INFORMATION when an attribute type is not supported. * CKR_OK on success. */ -CK_RV C_CopyObject(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, - CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, - CK_OBJECT_HANDLE_PTR phNewObject) +static CK_RV wp11_C_CopyObject(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject, + CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, + CK_OBJECT_HANDLE_PTR phNewObject) { int ret; CK_RV rv; @@ -1826,6 +1840,19 @@ CK_RV C_CopyObject(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_CopyObject(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, + CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, + CK_OBJECT_HANDLE_PTR phNewObject) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_CopyObject(hSession, hObject, pTemplate, ulCount, phNewObject); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Destroy object in session or on token. * @@ -1837,8 +1864,8 @@ CK_RV C_CopyObject(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, * CKR_OBJECT_HANDLE_INVALID when handle is not to a valid object. * CKR_OK on success. */ -CK_RV C_DestroyObject(CK_SESSION_HANDLE hSession, - CK_OBJECT_HANDLE hObject) +static CK_RV wp11_C_DestroyObject(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject) { int ret; int onToken; @@ -1906,7 +1933,8 @@ CK_RV C_DestroyObject(CK_SESSION_HANDLE hSession, /* Drop any active-operation reference to this object before freeing it so a * pending operation cannot use freed memory. */ WP11_Slot_ClearActiveObject(WP11_Session_GetSlot(session), obj); - WP11_Object_Free(obj); + /* Freed once no call that looked the object up can still be using it. */ + WP11_Slot_DiscardObject(WP11_Session_GetSlot(session), obj); /* The object was unlinked; a negative status means persisting the token * afterwards failed. Surface it rather than reporting success. */ @@ -1915,6 +1943,18 @@ CK_RV C_DestroyObject(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_DestroyObject(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_DestroyObject(hSession, hObject); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Get the size of an specific object. * Not supported. @@ -1930,8 +1970,9 @@ CK_RV C_DestroyObject(CK_SESSION_HANDLE hSession, * CKR_OBJECT_HANDLE_INVALID when handle is not to a valid object. * CKR_OK on success. */ -CK_RV C_GetObjectSize(CK_SESSION_HANDLE hSession, - CK_OBJECT_HANDLE hObject, CK_ULONG_PTR pulSize) +static CK_RV wp11_C_GetObjectSize(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject, + CK_ULONG_PTR pulSize) { CK_RV rv; int ret; @@ -1975,6 +2016,18 @@ CK_RV C_GetObjectSize(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_GetObjectSize(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject, CK_ULONG_PTR pulSize) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_GetObjectSize(hSession, hObject, pulSize); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Get the values of the attributes from the object. @@ -1994,9 +2047,10 @@ CK_RV C_GetObjectSize(CK_SESSION_HANDLE hSession, * CKR_FUNCTION_FAILED when getting a value fails. * CKR_OK on success. */ -CK_RV C_GetAttributeValue(CK_SESSION_HANDLE hSession, - CK_OBJECT_HANDLE hObject, - CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount) +static CK_RV wp11_C_GetAttributeValue(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject, + CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulCount) { int ret; CK_RV rv; @@ -2080,6 +2134,19 @@ CK_RV C_GetAttributeValue(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_GetAttributeValue(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject, + CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_GetAttributeValue(hSession, hObject, pTemplate, ulCount); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Set the values of the attributes into the object. * @@ -2101,9 +2168,10 @@ CK_RV C_GetAttributeValue(CK_SESSION_HANDLE hSession, * CKR_FUNCTION_FAILED when getting a value fails. * CKR_OK on success. */ -CK_RV C_SetAttributeValue(CK_SESSION_HANDLE hSession, - CK_OBJECT_HANDLE hObject, - CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount) +static CK_RV wp11_C_SetAttributeValue(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject, + CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulCount) { CK_RV rv; int ret; @@ -2164,6 +2232,19 @@ CK_RV C_SetAttributeValue(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_SetAttributeValue(CK_SESSION_HANDLE hSession, + CK_OBJECT_HANDLE hObject, + CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_SetAttributeValue(hSession, hObject, pTemplate, ulCount); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Initialize the finding of an object associated with the session. * All matching objects are found by this call. @@ -2659,7 +2740,12 @@ static CK_RV EncryptInit(CK_SESSION_HANDLE hSession, CK_RV C_EncryptInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey) { - return EncryptInit(hSession, pMechanism, hKey, 0); + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = EncryptInit(hSession, pMechanism, hKey, 0); + WP11_Slot_ObjectCallLeave(calls); + return rv; } /** @@ -2683,9 +2769,9 @@ CK_RV C_EncryptInit(CK_SESSION_HANDLE hSession, * CKR_FUNCTION_FAILED when encrypting failed. * CKR_OK on success. */ -CK_RV C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, - CK_ULONG ulDataLen, CK_BYTE_PTR pEncryptedData, - CK_ULONG_PTR pulEncryptedDataLen) +static CK_RV wp11_C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, + CK_ULONG ulDataLen, CK_BYTE_PTR pEncryptedData, + CK_ULONG_PTR pulEncryptedDataLen) { CK_RV rv; int ret = 0; @@ -3029,6 +3115,20 @@ CK_RV C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, + CK_ULONG ulDataLen, CK_BYTE_PTR pEncryptedData, + CK_ULONG_PTR pulEncryptedDataLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_Encrypt(hSession, pData, ulDataLen, pEncryptedData, + pulEncryptedDataLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Continue encrypting multi-part data. * @@ -3050,9 +3150,10 @@ CK_RV C_Encrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, * CKR_FUNCTION_FAILED when encrypting failed. * CKR_OK on success. */ -CK_RV C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, - CK_ULONG ulPartLen, CK_BYTE_PTR pEncryptedPart, - CK_ULONG_PTR pulEncryptedPartLen) +static CK_RV wp11_C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, + CK_ULONG ulPartLen, + CK_BYTE_PTR pEncryptedPart, + CK_ULONG_PTR pulEncryptedPartLen) { int ret; WP11_Session* session; @@ -3244,6 +3345,20 @@ CK_RV C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, + CK_ULONG ulPartLen, CK_BYTE_PTR pEncryptedPart, + CK_ULONG_PTR pulEncryptedPartLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_EncryptUpdate(hSession, pPart, ulPartLen, pEncryptedPart, + pulEncryptedPartLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Finishes encrypting multi-part data. * @@ -3263,9 +3378,9 @@ CK_RV C_EncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, * CKR_FUNCTION_FAILED when encrypting failed. * CKR_OK on success. */ -CK_RV C_EncryptFinal(CK_SESSION_HANDLE hSession, - CK_BYTE_PTR pLastEncryptedPart, - CK_ULONG_PTR pulLastEncryptedPartLen) +static CK_RV wp11_C_EncryptFinal(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pLastEncryptedPart, + CK_ULONG_PTR pulLastEncryptedPartLen) { int ret; WP11_Session* session; @@ -3416,6 +3531,20 @@ CK_RV C_EncryptFinal(CK_SESSION_HANDLE hSession, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_EncryptFinal(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pLastEncryptedPart, + CK_ULONG_PTR pulLastEncryptedPartLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_EncryptFinal(hSession, pLastEncryptedPart, + pulLastEncryptedPartLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + static CK_RV DecryptInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey, byte skipOpCheck) @@ -3698,7 +3827,12 @@ static CK_RV DecryptInit(CK_SESSION_HANDLE hSession, CK_RV C_DecryptInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey) { - return DecryptInit(hSession, pMechanism, hKey, 0); + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = DecryptInit(hSession, pMechanism, hKey, 0); + WP11_Slot_ObjectCallLeave(calls); + return rv; } /** @@ -3723,9 +3857,10 @@ CK_RV C_DecryptInit(CK_SESSION_HANDLE hSession, * CKR_MECHANISM_INVALID when wrong initialization function was used. * CKR_OK on success. */ -CK_RV C_Decrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pEncryptedData, - CK_ULONG ulEncryptedDataLen, CK_BYTE_PTR pData, - CK_ULONG_PTR pulDataLen) +static CK_RV wp11_C_Decrypt(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pEncryptedData, + CK_ULONG ulEncryptedDataLen, CK_BYTE_PTR pData, + CK_ULONG_PTR pulDataLen) { int ret = 0; WP11_Session* session; @@ -4084,6 +4219,20 @@ CK_RV C_Decrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pEncryptedData, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_Decrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pEncryptedData, + CK_ULONG ulEncryptedDataLen, CK_BYTE_PTR pData, + CK_ULONG_PTR pulDataLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_Decrypt(hSession, pEncryptedData, ulEncryptedDataLen, pData, + pulDataLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Continue decrypting multi-part data. * @@ -4106,10 +4255,10 @@ CK_RV C_Decrypt(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pEncryptedData, * CKR_MECHANISM_INVALID when wrong initialization function was used. * CKR_OK on success. */ -CK_RV C_DecryptUpdate(CK_SESSION_HANDLE hSession, - CK_BYTE_PTR pEncryptedPart, - CK_ULONG ulEncryptedPartLen, CK_BYTE_PTR pPart, - CK_ULONG_PTR pulPartLen) +static CK_RV wp11_C_DecryptUpdate(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pEncryptedPart, + CK_ULONG ulEncryptedPartLen, + CK_BYTE_PTR pPart, CK_ULONG_PTR pulPartLen) { int ret; WP11_Session* session; @@ -4287,6 +4436,21 @@ CK_RV C_DecryptUpdate(CK_SESSION_HANDLE hSession, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_DecryptUpdate(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pEncryptedPart, + CK_ULONG ulEncryptedPartLen, CK_BYTE_PTR pPart, + CK_ULONG_PTR pulPartLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_DecryptUpdate(hSession, pEncryptedPart, ulEncryptedPartLen, + pPart, pulPartLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Finishes decrypting multi-part data. * @@ -4306,8 +4470,9 @@ CK_RV C_DecryptUpdate(CK_SESSION_HANDLE hSession, * CKR_MECHANISM_INVALID when wrong initialization function was used. * CKR_OK on success. */ -CK_RV C_DecryptFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pLastPart, - CK_ULONG_PTR pulLastPartLen) +static CK_RV wp11_C_DecryptFinal(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pLastPart, + CK_ULONG_PTR pulLastPartLen) { int ret; WP11_Session* session; @@ -4478,6 +4643,18 @@ CK_RV C_DecryptFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pLastPart, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_DecryptFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pLastPart, + CK_ULONG_PTR pulLastPartLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_DecryptFinal(hSession, pLastPart, pulLastPartLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Initialize digest operation. * No digest mechanisms are supported. @@ -4665,7 +4842,7 @@ CK_RV C_DigestUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, * CKR_OPERATION_NOT_INITIALIZED when C_DigestInit has not been * successfully called. */ -CK_RV C_DigestKey(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hKey) +static CK_RV wp11_C_DigestKey(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hKey) { int ret; WP11_Session* session; @@ -4711,6 +4888,17 @@ CK_RV C_DigestKey(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hKey) return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_DigestKey(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_DigestKey(hSession, hKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Finished digesting multi-part data. * No digest mechanisms are supported. @@ -4915,8 +5103,8 @@ static int GetInitValue(CK_MECHANISM_TYPE mechanism) { * CKR_FUNCTION_FAILED when initializing fails. * CKR_OK on success. */ -CK_RV C_SignInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, - CK_OBJECT_HANDLE hKey) +static CK_RV wp11_C_SignInit(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey) { int ret; WP11_Session* session; @@ -5235,6 +5423,18 @@ CK_RV C_SignInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_SignInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_SignInit(hSession, pMechanism, hKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Sign the single-part data. * @@ -5256,9 +5456,9 @@ CK_RV C_SignInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, * CKR_MECHANISM_INVALID when wrong initialization function was used. * CKR_OK on success. */ -CK_RV C_Sign(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, - CK_ULONG ulDataLen, CK_BYTE_PTR pSignature, - CK_ULONG_PTR pulSignatureLen) +static CK_RV wp11_C_Sign(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, + CK_ULONG ulDataLen, CK_BYTE_PTR pSignature, + CK_ULONG_PTR pulSignatureLen) { int ret = 0; #ifndef NO_RSA @@ -5609,6 +5809,19 @@ CK_RV C_Sign(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_Sign(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, + CK_ULONG ulDataLen, CK_BYTE_PTR pSignature, + CK_ULONG_PTR pulSignatureLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_Sign(hSession, pData, ulDataLen, pSignature, pulSignatureLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Continue signing the multi-part data. * @@ -5624,8 +5837,8 @@ CK_RV C_Sign(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, * CKR_MECHANISM_INVALID when wrong initialization function was used. * CKR_OK on success. */ -CK_RV C_SignUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, - CK_ULONG ulPartLen) +static CK_RV wp11_C_SignUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, + CK_ULONG ulPartLen) { int ret; WP11_Session* session; @@ -5737,6 +5950,18 @@ CK_RV C_SignUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_SignUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, + CK_ULONG ulPartLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_SignUpdate(hSession, pPart, ulPartLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Finish signing the multi-part data. * @@ -5757,8 +5982,9 @@ CK_RV C_SignUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, * CKR_MECHANISM_INVALID when wrong initialization function was used. * CKR_OK on success. */ -CK_RV C_SignFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSignature, - CK_ULONG_PTR pulSignatureLen) +static CK_RV wp11_C_SignFinal(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pSignature, + CK_ULONG_PTR pulSignatureLen) { int ret; WP11_Session* session; @@ -5900,6 +6126,18 @@ CK_RV C_SignFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSignature, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_SignFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSignature, + CK_ULONG_PTR pulSignatureLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_SignFinal(hSession, pSignature, pulSignatureLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Initialize signing operation that recovers data from signature. * No mechanisms are supported. @@ -5914,9 +6152,9 @@ CK_RV C_SignFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSignature, * CKR_MECHANISM_INVALID when the mechanism is not supported with this * type of operation. */ -CK_RV C_SignRecoverInit(CK_SESSION_HANDLE hSession, - CK_MECHANISM_PTR pMechanism, - CK_OBJECT_HANDLE hKey) +static CK_RV wp11_C_SignRecoverInit(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hKey) { int ret; WP11_Session* session; @@ -5958,6 +6196,19 @@ CK_RV C_SignRecoverInit(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_SignRecoverInit(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_SignRecoverInit(hSession, pMechanism, hKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Sign the data such that the data can be recovered from the signature. * @@ -6031,8 +6282,9 @@ CK_RV C_SignRecover(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, * CKR_FUNCTION_FAILED when initializing fails. * CKR_OK on success. */ -CK_RV C_VerifyInit(CK_SESSION_HANDLE hSession, - CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey) +static CK_RV wp11_C_VerifyInit(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hKey) { int ret; WP11_Session* session; @@ -6355,6 +6607,18 @@ CK_RV C_VerifyInit(CK_SESSION_HANDLE hSession, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_VerifyInit(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_VerifyInit(hSession, pMechanism, hKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Verify the single-part data. * @@ -6373,9 +6637,9 @@ CK_RV C_VerifyInit(CK_SESSION_HANDLE hSession, * CKR_SIGNATURE_INVALID when the signature does not verify the data. * CKR_OK on success. */ -CK_RV C_Verify(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, - CK_ULONG ulDataLen, CK_BYTE_PTR pSignature, - CK_ULONG ulSignatureLen) +static CK_RV wp11_C_Verify(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, + CK_ULONG ulDataLen, CK_BYTE_PTR pSignature, + CK_ULONG ulSignatureLen) { int ret = 0; int stat = 0; @@ -6685,6 +6949,19 @@ CK_RV C_Verify(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_Verify(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, + CK_ULONG ulDataLen, CK_BYTE_PTR pSignature, + CK_ULONG ulSignatureLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_Verify(hSession, pData, ulDataLen, pSignature, ulSignatureLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Continue verifying the multi-part data. * @@ -6700,8 +6977,8 @@ CK_RV C_Verify(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, * CKR_MECHANISM_INVALID when wrong initialization function was used. * CKR_OK on success. */ -CK_RV C_VerifyUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, - CK_ULONG ulPartLen) +static CK_RV wp11_C_VerifyUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, + CK_ULONG ulPartLen) { int ret; WP11_Session* session; @@ -6804,6 +7081,18 @@ CK_RV C_VerifyUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_VerifyUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, + CK_ULONG ulPartLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_VerifyUpdate(hSession, pPart, ulPartLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Finishes verifying the multi-part data. * @@ -6820,8 +7109,8 @@ CK_RV C_VerifyUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, * CKR_SIGNATURE_INVALID when the signature does not verify the data. * CKR_OK on success. */ -CK_RV C_VerifyFinal(CK_SESSION_HANDLE hSession, - CK_BYTE_PTR pSignature, CK_ULONG ulSignatureLen) +static CK_RV wp11_C_VerifyFinal(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pSignature, CK_ULONG ulSignatureLen) { int ret = 0; int stat = 0; @@ -6928,6 +7217,18 @@ CK_RV C_VerifyFinal(CK_SESSION_HANDLE hSession, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_VerifyFinal(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pSignature, CK_ULONG ulSignatureLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_VerifyFinal(hSession, pSignature, ulSignatureLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Initialize verification operation where data is recovered from the signature. * @@ -6941,9 +7242,9 @@ CK_RV C_VerifyFinal(CK_SESSION_HANDLE hSession, * CKR_MECHANISM_INVALID when the mechanism is not supported with this * type of operation. */ -CK_RV C_VerifyRecoverInit(CK_SESSION_HANDLE hSession, - CK_MECHANISM_PTR pMechanism, - CK_OBJECT_HANDLE hKey) +static CK_RV wp11_C_VerifyRecoverInit(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hKey) { int ret; int init = 0; @@ -7026,6 +7327,19 @@ CK_RV C_VerifyRecoverInit(CK_SESSION_HANDLE hSession, return CKR_OK; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_VerifyRecoverInit(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_VerifyRecoverInit(hSession, pMechanism, hKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Verify the signature where the data is recovered from the signature. * @@ -7043,9 +7357,10 @@ CK_RV C_VerifyRecoverInit(CK_SESSION_HANDLE hSession, * successfully called. * CKR_OK on success. */ -CK_RV C_VerifyRecover(CK_SESSION_HANDLE hSession, - CK_BYTE_PTR pSignature, CK_ULONG ulSignatureLen, - CK_BYTE_PTR pData, CK_ULONG_PTR pulDataLen) +static CK_RV wp11_C_VerifyRecover(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pSignature, + CK_ULONG ulSignatureLen, CK_BYTE_PTR pData, + CK_ULONG_PTR pulDataLen) { WP11_Session* session; #if !defined(NO_RSA) && defined(WC_RSA_DIRECT) @@ -7139,6 +7454,20 @@ CK_RV C_VerifyRecover(CK_SESSION_HANDLE hSession, #endif } +/* Logout must not free an object this call may still be using. */ +CK_RV C_VerifyRecover(CK_SESSION_HANDLE hSession, + CK_BYTE_PTR pSignature, CK_ULONG ulSignatureLen, + CK_BYTE_PTR pData, CK_ULONG_PTR pulDataLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_VerifyRecover(hSession, pSignature, ulSignatureLen, pData, + pulDataLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Continue digesting and encrypting multi-part data. * @@ -7384,10 +7713,10 @@ CK_RV C_DecryptVerifyUpdate(CK_SESSION_HANDLE hSession, * type of operation. * CKR_OK on success. */ -CK_RV C_GenerateKey(CK_SESSION_HANDLE hSession, - CK_MECHANISM_PTR pMechanism, - CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, - CK_OBJECT_HANDLE_PTR phKey) +static CK_RV wp11_C_GenerateKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, + CK_OBJECT_HANDLE_PTR phKey) { CK_RV rv = CKR_OK; WP11_Session* session = NULL; @@ -7843,6 +8172,20 @@ CK_RV C_GenerateKey(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_GenerateKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, + CK_OBJECT_HANDLE_PTR phKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_GenerateKey(hSession, pMechanism, pTemplate, ulCount, phKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Generate a public/private key pair into new key objects. @@ -7906,14 +8249,14 @@ static CK_RV CheckGenPairAttrs(CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, return CKR_OK; } -CK_RV C_GenerateKeyPair(CK_SESSION_HANDLE hSession, - CK_MECHANISM_PTR pMechanism, - CK_ATTRIBUTE_PTR pPublicKeyTemplate, - CK_ULONG ulPublicKeyAttributeCount, - CK_ATTRIBUTE_PTR pPrivateKeyTemplate, - CK_ULONG ulPrivateKeyAttributeCount, - CK_OBJECT_HANDLE_PTR phPublicKey, - CK_OBJECT_HANDLE_PTR phPrivateKey) +static CK_RV wp11_C_GenerateKeyPair(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_ATTRIBUTE_PTR pPublicKeyTemplate, + CK_ULONG ulPublicKeyAttributeCount, + CK_ATTRIBUTE_PTR pPrivateKeyTemplate, + CK_ULONG ulPrivateKeyAttributeCount, + CK_OBJECT_HANDLE_PTR phPublicKey, + CK_OBJECT_HANDLE_PTR phPrivateKey) { int ret; CK_RV rv = CKR_OK; @@ -8300,6 +8643,27 @@ CK_RV C_GenerateKeyPair(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_GenerateKeyPair(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_ATTRIBUTE_PTR pPublicKeyTemplate, + CK_ULONG ulPublicKeyAttributeCount, + CK_ATTRIBUTE_PTR pPrivateKeyTemplate, + CK_ULONG ulPrivateKeyAttributeCount, + CK_OBJECT_HANDLE_PTR phPublicKey, + CK_OBJECT_HANDLE_PTR phPrivateKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_GenerateKeyPair(hSession, pMechanism, pPublicKeyTemplate, + ulPublicKeyAttributeCount, pPrivateKeyTemplate, + ulPrivateKeyAttributeCount, phPublicKey, + phPrivateKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Wrap a key using another key. * @@ -8326,11 +8690,11 @@ CK_RV C_GenerateKeyPair(CK_SESSION_HANDLE hSession, * CKR_MECHANISM_INVALID when the mechanism is not supported with this * type of operation. */ -CK_RV C_WrapKey(CK_SESSION_HANDLE hSession, - CK_MECHANISM_PTR pMechanism, - CK_OBJECT_HANDLE hWrappingKey, CK_OBJECT_HANDLE hKey, - CK_BYTE_PTR pWrappedKey, - CK_ULONG_PTR pulWrappedKeyLen) +static CK_RV wp11_C_WrapKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hWrappingKey, + CK_OBJECT_HANDLE hKey, CK_BYTE_PTR pWrappedKey, + CK_ULONG_PTR pulWrappedKeyLen) { int ret; CK_RV rv; @@ -8567,6 +8931,22 @@ CK_RV C_WrapKey(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_WrapKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hWrappingKey, CK_OBJECT_HANDLE hKey, + CK_BYTE_PTR pWrappedKey, + CK_ULONG_PTR pulWrappedKeyLen) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_WrapKey(hSession, pMechanism, hWrappingKey, hKey, pWrappedKey, + pulWrappedKeyLen); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Unwrap a key using a wrap key. * Support only RSA private key wrapped by AESCBCPAD mechanism @@ -8588,13 +8968,13 @@ CK_RV C_WrapKey(CK_SESSION_HANDLE hSession, * CKR_MECHANISM_INVALID when the mechanism is not supported with this * type of operation. */ -CK_RV C_UnwrapKey(CK_SESSION_HANDLE hSession, - CK_MECHANISM_PTR pMechanism, - CK_OBJECT_HANDLE hUnwrappingKey, - CK_BYTE_PTR pWrappedKey, CK_ULONG ulWrappedKeyLen, - CK_ATTRIBUTE_PTR pTemplate, - CK_ULONG ulAttributeCount, - CK_OBJECT_HANDLE_PTR phKey) +static CK_RV wp11_C_UnwrapKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hUnwrappingKey, + CK_BYTE_PTR pWrappedKey, CK_ULONG ulWrappedKeyLen, + CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulAttributeCount, + CK_OBJECT_HANDLE_PTR phKey) { CK_RV rv; int ret; @@ -8819,6 +9199,24 @@ CK_RV C_UnwrapKey(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_UnwrapKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hUnwrappingKey, + CK_BYTE_PTR pWrappedKey, CK_ULONG ulWrappedKeyLen, + CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulAttributeCount, + CK_OBJECT_HANDLE_PTR phKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_UnwrapKey(hSession, pMechanism, hUnwrappingKey, pWrappedKey, + ulWrappedKeyLen, pTemplate, ulAttributeCount, phKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + #if defined(HAVE_ECC) || !defined(NO_DH) /** * Determine the key length of the object. @@ -9043,12 +9441,12 @@ static int Tls12_Extract_Keys(WP11_Session* session, * type of operation. * CKR_OK on success. */ -CK_RV C_DeriveKey(CK_SESSION_HANDLE hSession, - CK_MECHANISM_PTR pMechanism, - CK_OBJECT_HANDLE hBaseKey, - CK_ATTRIBUTE_PTR pTemplate, - CK_ULONG ulAttributeCount, - CK_OBJECT_HANDLE_PTR phKey) +static CK_RV wp11_C_DeriveKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hBaseKey, + CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulAttributeCount, + CK_OBJECT_HANDLE_PTR phKey) { int ret; CK_RV rv = CKR_OK; @@ -9490,6 +9888,23 @@ CK_RV C_DeriveKey(CK_SESSION_HANDLE hSession, return rv; } +/* Logout must not free an object this call may still be using. */ +CK_RV C_DeriveKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hBaseKey, + CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulAttributeCount, + CK_OBJECT_HANDLE_PTR phKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_DeriveKey(hSession, pMechanism, hBaseKey, pTemplate, + ulAttributeCount, phKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + /** * Seed the token's random number generator. * @@ -10021,10 +10436,14 @@ static CK_RV CheckPrivateObjectLogin(WP11_Session* session, } #endif /* WOLFPKCS11_MLKEM */ -CK_RV C_EncapsulateKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, - CK_OBJECT_HANDLE hPublicKey, CK_ATTRIBUTE_PTR pTemplate, - CK_ULONG ulAttributeCount, CK_BYTE_PTR pCiphertext, - CK_ULONG_PTR pulCiphertextLen, CK_OBJECT_HANDLE_PTR phKey) +static CK_RV wp11_C_EncapsulateKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hPublicKey, + CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulAttributeCount, + CK_BYTE_PTR pCiphertext, + CK_ULONG_PTR pulCiphertextLen, + CK_OBJECT_HANDLE_PTR phKey) { #ifdef WOLFPKCS11_MLKEM int ret; @@ -10141,10 +10560,30 @@ CK_RV C_EncapsulateKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, #endif } -CK_RV C_DecapsulateKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, - CK_OBJECT_HANDLE hPrivateKey, CK_ATTRIBUTE_PTR pTemplate, +/* Logout must not free an object this call may still be using. */ +CK_RV C_EncapsulateKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hPublicKey, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulAttributeCount, CK_BYTE_PTR pCiphertext, - CK_ULONG ulCiphertextLen, CK_OBJECT_HANDLE_PTR phKey) + CK_ULONG_PTR pulCiphertextLen, CK_OBJECT_HANDLE_PTR phKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_EncapsulateKey(hSession, pMechanism, hPublicKey, pTemplate, + ulAttributeCount, pCiphertext, pulCiphertextLen, + phKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + +static CK_RV wp11_C_DecapsulateKey(CK_SESSION_HANDLE hSession, + CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hPrivateKey, + CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulAttributeCount, + CK_BYTE_PTR pCiphertext, + CK_ULONG ulCiphertextLen, + CK_OBJECT_HANDLE_PTR phKey) { #ifdef WOLFPKCS11_MLKEM int ret; @@ -10255,6 +10694,22 @@ CK_RV C_DecapsulateKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, #endif } +/* Logout must not free an object this call may still be using. */ +CK_RV C_DecapsulateKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, + CK_OBJECT_HANDLE hPrivateKey, CK_ATTRIBUTE_PTR pTemplate, + CK_ULONG ulAttributeCount, CK_BYTE_PTR pCiphertext, + CK_ULONG ulCiphertextLen, CK_OBJECT_HANDLE_PTR phKey) +{ + CK_RV rv; + WP11_ObjectCalls* calls = WP11_Slot_ObjectCallEnter(hSession); + + rv = wp11_C_DecapsulateKey(hSession, pMechanism, hPrivateKey, pTemplate, + ulAttributeCount, pCiphertext, ulCiphertextLen, + phKey); + WP11_Slot_ObjectCallLeave(calls); + return rv; +} + CK_RV C_VerifySignatureInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey, CK_BYTE_PTR pSignature, CK_ULONG ulSignatureLen) diff --git a/src/internal.c b/src/internal.c index a3addda3..0884af37 100644 --- a/src/internal.c +++ b/src/internal.c @@ -304,6 +304,7 @@ struct WP11_Object { byte onToken:1; /* Object on token or session */ byte local:1; /* Locally created object */ word32 opFlag; /* Flags of operations allowed */ + word32 freeEpoch; /* Call epoch the object was unlinked */ char startDate[8]; /* Start date of usage */ char endDate[8]; /* End data of usage */ @@ -528,6 +529,8 @@ struct WP11_Session { int devId; WP11_Session* next; /* Next session for slot */ + WP11_Object* retired; /* Private objects invalidated by logout + * and freed once nothing uses them */ }; typedef struct WP11_Token { @@ -563,6 +566,11 @@ typedef struct WP11_Token { * 2 = not empty */ } WP11_Token; +struct WP11_ObjectCalls { + WP11_Slot* slot; /* Slot the calls are made on */ + int cnt; /* Calls in progress from this epoch */ +}; + struct WP11_Slot { CK_SLOT_ID id; /* CryptoKi API slot id value */ WP11_Token token; /* Token information for slot */ @@ -576,6 +584,10 @@ struct WP11_Slot { WOLFTPM2_SESSION tpmSession; TpmCryptoDevCtx tpmCtx; #endif + WP11_ObjectCalls calls[2]; /* Object calls of the last two epochs */ + word32 epoch; /* Current object call epoch */ + WP11_Object* discarded; /* Destroyed objects awaiting free */ + byte reclaim:1; /* Retired objects may await free */ }; #if defined(HAVE_FIPS) && FIPS_VERSION_LT(6,0) @@ -951,6 +963,7 @@ static int wp11_Slot_AddSession(WP11_Slot* slot, WP11_Session** session) static void wp11_Session_Final(WP11_Session* session) { WP11_Object* obj; + WP11_Object* retired; if (session->inUse) { /* Free objects in session. */ @@ -961,6 +974,15 @@ static void wp11_Session_Final(WP11_Session* session) } session->inUse = 0; } + /* Retired objects change only under the slot lock, which callers hold + * (or the library is being torn down). */ + retired = session->retired; + session->retired = NULL; + while (retired != NULL) { + obj = retired; + retired = retired->next; + WP11_Object_Free(obj); + } session->curr = NULL; /* Finalize any find. */ WP11_Session_FindFinal(session); @@ -7800,12 +7822,19 @@ static void wp11_TpmFinal(WP11_Slot* slot) */ static void wp11_Slot_Final(WP11_Slot* slot) { + WP11_Object* obj; + if (slot == NULL) { return; } while (slot->session != NULL) { wp11_Slot_FreeSession(slot, slot->session); } + while (slot->discarded != NULL) { + obj = slot->discarded; + slot->discarded = obj->next; + WP11_Object_Free(obj); + } wp11_Token_Final(&slot->token); #ifdef WOLFPKCS11_TPM wp11_TpmFinal(slot); @@ -7833,6 +7862,8 @@ static int wp11_Slot_Init(WP11_Slot* slot, int id) slot->id = id; slot->token.state = WP11_TOKEN_STATE_UNKNOWN; slot->token.tokenFlags = 0; + slot->calls[0].slot = slot; + slot->calls[1].slot = slot; ret = WP11_Lock_Init(&slot->lock); if (ret == 0) { @@ -8204,6 +8235,7 @@ int WP11_Slot_OpenSession(WP11_Slot* slot, unsigned long flags, void* app, } static void wp11_Slot_Logout(WP11_Slot* slot); +static void wp11_Slot_FreeDiscardedObjects(WP11_Slot* slot); /** * Close a session associated with a slot. @@ -8243,6 +8275,10 @@ void WP11_Slot_CloseSession(WP11_Slot* slot, WP11_Session* session) wp11_Slot_FreeSession(slot, session); else wp11_Session_Final(session); + /* Its operation no longer holds objects destroyed while it ran. */ + WP11_Lock_LockRW(&slot->token.lock); + wp11_Slot_FreeDiscardedObjects(slot); + WP11_Lock_UnlockRW(&slot->token.lock); /* Decide and log out under the same lock so a concurrent open is either * seen here or opens after the logout. */ @@ -8766,6 +8802,207 @@ int WP11_Slot_SOLogin(WP11_Slot* slot, char* pin, int pinLen) return ret; } +/** + * Check whether a session's initialized operation uses the object as its key. + * + * @param slot [in] Slot object. + * @param object [in] Object to look for. + * @return 1 when an operation key, 0 otherwise. + */ +static int wp11_Slot_ObjectIsActive(WP11_Slot* slot, WP11_Object* object) +{ + WP11_Session* sess; + + for (sess = slot->session; sess != NULL; sess = sess->next) { + if (sess->curr == object && sess->init != 0) + return 1; + } + return 0; +} + +/** + * Start a new object call epoch once no call from the previous one runs, so + * calls only ever run in the current and previous epochs. + * Caller holds the slot lock for writing. + * + * @param slot [in] Slot object. + */ +static void wp11_Slot_AdvanceEpoch(WP11_Slot* slot) +{ + if (slot->calls[(slot->epoch + 1) & 1].cnt == 0) + slot->epoch++; +} + +/** + * Check whether an unlinked object can be freed: every object call that began + * by the epoch it was unlinked in has ended and no operation uses it. + * Caller holds the slot and token locks for writing. + * + * @param slot [in] Slot object. + * @param object [in] Unlinked object. + * @return 1 when nothing can still use the object, 0 otherwise. + */ +static int wp11_Slot_ObjectFreeable(WP11_Slot* slot, WP11_Object* object) +{ + int done = 1; + + if (object->freeEpoch == slot->epoch) { + done = (slot->calls[0].cnt == 0) && (slot->calls[1].cnt == 0); + } + else if (object->freeEpoch == slot->epoch - 1) { + done = (slot->calls[object->freeEpoch & 1].cnt == 0); + } + if (done) + done = !wp11_Slot_ObjectIsActive(slot, object); + + return done; +} + +/** + * Free an object nothing uses any more, dropping stale operation pointers. + * Caller holds the slot and token locks for writing. + * + * @param slot [in] Slot object. + * @param object [in] Object to free. + */ +static void wp11_Slot_FreeUnused(WP11_Slot* slot, WP11_Object* object) +{ + WP11_Session* sess; + + for (sess = slot->session; sess != NULL; sess = sess->next) { + if (sess->curr == object) + sess->curr = NULL; + } + WP11_Object_Free(object); +} + +/** + * Free the destroyed objects that no object call or operation can still use. + * Caller holds the slot and token locks for writing. + * + * @param slot [in] Slot object. + */ +static void wp11_Slot_FreeDiscardedObjects(WP11_Slot* slot) +{ + WP11_Object** curr = &slot->discarded; + WP11_Object* obj; + + while (*curr != NULL) { + obj = *curr; + if (!wp11_Slot_ObjectFreeable(slot, obj)) { + curr = &obj->next; + } + else { + *curr = obj->next; + wp11_Slot_FreeUnused(slot, obj); + } + } +} + +/** + * Hand over an object that C_DestroyObject has unlinked. It is freed once no + * object call that began before the unlink and no operation can use it. + * + * @param slot [in] Slot object. + * @param object [in] Unlinked object. + */ +void WP11_Slot_DiscardObject(WP11_Slot* slot, WP11_Object* object) +{ + WP11_Lock_LockRW(&slot->lock); + WP11_Lock_LockRW(&slot->token.lock); + object->freeEpoch = slot->epoch; + object->next = slot->discarded; + slot->discarded = object; + wp11_Slot_AdvanceEpoch(slot); + wp11_Slot_FreeDiscardedObjects(slot); + WP11_Lock_UnlockRW(&slot->token.lock); + WP11_Lock_UnlockRW(&slot->lock); +} + +#ifndef WOLFPKCS11_NSS + +/** + * Free (and so zeroize) the retired objects that nothing can still use: every + * object call that began before logout retired them has ended and no + * operation uses them. Caller holds the slot and token locks for writing. + * + * @param slot [in] Slot object. + */ +static void wp11_Slot_FreeRetiredObjects(WP11_Slot* slot) +{ + WP11_Session* sess; + WP11_Object** curr; + WP11_Object* obj; + int left = 0; + + for (sess = slot->session; sess != NULL; sess = sess->next) { + curr = &sess->retired; + while (*curr != NULL) { + obj = *curr; + if (!wp11_Slot_ObjectFreeable(slot, obj)) { + curr = &obj->next; + left = 1; + } + else { + *curr = obj->next; + wp11_Slot_FreeUnused(slot, obj); + } + } + } + slot->reclaim = (byte)left; +} +#endif + +/** + * Note the start of a call that may use object pointers looked up by handle. + * Objects unlinked while it runs are not freed until it has finished. + * + * @param hSession [in] Session handle the call is made on. + * @return Calls to pass to WP11_Slot_ObjectCallLeave, or NULL. + */ +WP11_ObjectCalls* WP11_Slot_ObjectCallEnter(CK_SESSION_HANDLE hSession) +{ + WP11_Slot* slot = NULL; + WP11_ObjectCalls* calls = NULL; + + if (WP11_Library_IsInitialized() && + WP11_Slot_Get(SESS_HANDLE_SLOT_ID(hSession), &slot) == 0) { + WP11_Lock_LockRW(&slot->lock); + calls = &slot->calls[slot->epoch & 1]; + calls->cnt++; + WP11_Lock_UnlockRW(&slot->lock); + } + + return calls; +} + +/** + * Note the end of a call started with WP11_Slot_ObjectCallEnter and free what + * logout retired or destroy unlinked that no running call can still use. + * + * @param calls [in] Calls returned by WP11_Slot_ObjectCallEnter. + */ +void WP11_Slot_ObjectCallLeave(WP11_ObjectCalls* calls) +{ + WP11_Slot* slot; + + if (calls != NULL) { + slot = calls->slot; + WP11_Lock_LockRW(&slot->lock); + calls->cnt--; + wp11_Slot_AdvanceEpoch(slot); + if (slot->reclaim || slot->discarded != NULL) { + WP11_Lock_LockRW(&slot->token.lock); + #ifndef WOLFPKCS11_NSS + wp11_Slot_FreeRetiredObjects(slot); + #endif + wp11_Slot_FreeDiscardedObjects(slot); + WP11_Lock_UnlockRW(&slot->token.lock); + } + WP11_Lock_UnlockRW(&slot->lock); + } +} + /** * Log the user into the token. * @@ -8889,6 +9126,11 @@ int WP11_Slot_UserLogin(WP11_Slot* slot, char* pin, int pinLen) if (ret == 0) { WP11_Lock_LockRW(&slot->lock); token->loginState = WP11_APP_STATE_RW_USER; + #ifndef WOLFPKCS11_NSS + WP11_Lock_LockRW(&token->lock); + wp11_Slot_FreeRetiredObjects(slot); + WP11_Lock_UnlockRW(&token->lock); + #endif WP11_Lock_UnlockRW(&slot->lock); } @@ -9045,6 +9287,44 @@ int WP11_Slot_IsUserLoggedIn(WP11_Slot* slot) return wp11_LoginStateIsUser(state); } +#ifndef WOLFPKCS11_NSS +/** + * Invalidate the private session objects of all sessions on the slot, as + * logging out requires: their handles stop resolving immediately. They are + * freed, which zeroizes their key material, as soon as no object call is in + * progress and no operation uses them. Caller holds the slot and token locks + * for writing. + * + * @param slot [in] Slot object. + */ +static void wp11_Slot_RetirePrivateSessionObjects(WP11_Slot* slot) +{ + WP11_Session* sess; + WP11_Object** curr; + WP11_Object* obj; + + for (sess = slot->session; sess != NULL; sess = sess->next) { + curr = &sess->object; + while (*curr != NULL) { + obj = *curr; + if ((obj->opFlag & WP11_FLAG_PRIVATE) == WP11_FLAG_PRIVATE) { + *curr = obj->next; + sess->objCnt--; + obj->freeEpoch = slot->epoch; + obj->next = sess->retired; + sess->retired = obj; + slot->reclaim = 1; + } + else { + curr = &obj->next; + } + } + } + wp11_Slot_AdvanceEpoch(slot); + wp11_Slot_FreeRetiredObjects(slot); +} +#endif + /** * Logout of the token. Caller holds the slot lock for writing. * @@ -9076,6 +9356,9 @@ static void wp11_Slot_Logout(WP11_Slot* slot) * for subsequent object encryption (e.g., empty-PIN flow). */ wc_ForceZero(slot->token.key, sizeof(slot->token.key)); } +#endif +#ifndef WOLFPKCS11_NSS + wp11_Slot_RetirePrivateSessionObjects(slot); #endif slot->token.loginState = WP11_APP_STATE_RW_PUBLIC; WP11_Lock_UnlockRW(&slot->token.lock); @@ -10215,6 +10498,28 @@ int WP11_Session_SetCtsParams(WP11_Session* session, unsigned char* iv, #endif /* HAVE_AESCTS */ #endif /* !NO_AES */ +#ifndef WOLFPKCS11_NSS +/** + * Count the retired objects a session still holds because a call was in + * progress. The operation key is not counted: there is only one per session. + * Caller holds the token lock. + * + * @param session [in] Session object. + * @return Number of retired objects held. + */ +static int wp11_Session_RetiredHeld(WP11_Session* session) +{ + int cnt = 0; + WP11_Object* obj; + + for (obj = session->retired; obj != NULL; obj = obj->next) { + if (obj != session->curr || session->init == 0) + cnt++; + } + return cnt; +} +#endif + /** * Add object to the session or token. * @@ -10229,12 +10534,28 @@ int WP11_Session_AddObject(WP11_Session* session, int onToken, int ret = 0; WP11_Object* next; WP11_Token* token; +#ifndef WOLFPKCS11_NSS + int privSession; +#endif object->onToken = onToken; if (!onToken) object->session = session; token = &session->slot->token; +#ifndef WOLFPKCS11_NSS + privSession = !onToken && + (object->opFlag & WP11_FLAG_PRIVATE) == WP11_FLAG_PRIVATE; + if (privSession) { + /* Held to the add so a logout cannot slip between check and add. */ + WP11_Lock_LockRO(&session->slot->lock); + if ((token->tokenFlags & WP11_TOKEN_FLAG_USER_PIN_SET) && + token->userPinEmpty != 1 && + !wp11_LoginStateIsUser(token->loginState)) { + ret = PIN_INVALID_E; + } + } +#endif WP11_Lock_LockRW(&token->lock); if (onToken) { #ifndef WOLFPKCS11_NO_STORE @@ -10276,6 +10597,13 @@ int WP11_Session_AddObject(WP11_Session* session, int onToken, else { if (session->objCnt >= WP11_SESSION_OBJECT_CNT_MAX) ret = OBJ_COUNT_E; + #ifndef WOLFPKCS11_NSS + /* Retired objects awaiting free still use memory. */ + if (session->objCnt + wp11_Session_RetiredHeld(session) >= + WP11_SESSION_OBJECT_CNT_MAX) { + ret = OBJ_COUNT_E; + } + #endif if (ret == 0) { session->objCnt++; /* Get next item in list after this object has been added. */ @@ -10288,6 +10616,10 @@ int WP11_Session_AddObject(WP11_Session* session, int onToken, } } WP11_Lock_UnlockRW(&token->lock); +#ifndef WOLFPKCS11_NSS + if (privSession) + WP11_Lock_UnlockRO(&session->slot->lock); +#endif return ret; } @@ -10380,6 +10712,18 @@ int WP11_Session_RemoveObjectByHandle(WP11_Session* session, } } } +#endif +#ifndef WOLFPKCS11_NSS + /* Give cleanup back an object it added that logout then retired. */ + for (curr = &owner->retired; !found && !checkDestroyable && + *curr != NULL; curr = &(*curr)->next) { + if (*curr == object) { + *curr = object->next; + object->next = NULL; + WP11_Lock_UnlockRW(&token->lock); + return 0; + } + } #endif } @@ -11871,6 +12215,20 @@ int WP11_Object_HandleOnToken(CK_OBJECT_HANDLE handle) return OBJ_HANDLE_ON_TOKEN(handle); } +#ifdef DEBUG_WOLFPKCS11 +static void (*wp11_objectFindHook)(void) = NULL; + +/** + * Test hook: called by WP11_Object_Find before returning a found object. + * + * @param hook [in] Function to call, or NULL to remove the hook. + */ +WP11_API void WP11_Object_SetFindHook(void (*hook)(void)) +{ + wp11_objectFindHook = hook; +} +#endif + /** * Find an object based on the handle. * @@ -11953,8 +12311,7 @@ int WP11_Object_Find(WP11_Session* session, CK_OBJECT_HANDLE objHandle, WP11_Lock_UnlockRO(&session->slot->token.lock); } - /* The flags were captured under the token lock: the object may be freed - * by a concurrent destroy once the lock is released. */ + /* A destroyed object stays allocated until the caller's object call ends. */ if (ret == 0 && obj != NULL) { #ifndef WOLFPKCS11_NSS /* Enforce CKA_PRIVATE: reject private objects from public sessions. @@ -11976,6 +12333,10 @@ int WP11_Object_Find(WP11_Session* session, CK_OBJECT_HANDLE objHandle, if (ret == 0) *object = obj; } +#ifdef DEBUG_WOLFPKCS11 + if (ret == 0 && wp11_objectFindHook != NULL) + wp11_objectFindHook(); +#endif return ret; } diff --git a/tests/include.am b/tests/include.am index d3162c44..d7ef4a12 100644 --- a/tests/include.am +++ b/tests/include.am @@ -300,6 +300,11 @@ noinst_PROGRAMS += tests/nss_configdir_prefix_test tests_nss_configdir_prefix_test_SOURCES = tests/nss_configdir_prefix_test.c tests_nss_configdir_prefix_test_LDADD = +check_PROGRAMS += tests/logout_retire_test +noinst_PROGRAMS += tests/logout_retire_test +tests_logout_retire_test_SOURCES = tests/logout_retire_test.c +tests_logout_retire_test_LDADD = + check_PROGRAMS += tests/login_pin_state_test noinst_PROGRAMS += tests/login_pin_state_test tests_login_pin_state_test_SOURCES = tests/login_pin_state_test.c @@ -366,6 +371,7 @@ tests_copy_data_object_token_test_LDADD += src/libwolfpkcs11.la tests_data_object_partial_update_test_LDADD += src/libwolfpkcs11.la tests_wrapkey_length_query_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 else tests_object_id_uniqueness_test_LDADD += src/libwolfpkcs11.la @@ -420,6 +426,7 @@ tests_copy_data_object_token_test_LDADD += src/libwolfpkcs11.la tests_data_object_partial_update_test_LDADD += src/libwolfpkcs11.la tests_wrapkey_length_query_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 endif diff --git a/tests/login_pin_state_test.c b/tests/login_pin_state_test.c index a0c96b96..3f132961 100644 --- a/tests/login_pin_state_test.c +++ b/tests/login_pin_state_test.c @@ -930,6 +930,119 @@ static void find_during_login_changes_test(void) } #endif +#ifndef WOLFPKCS11_NSS +/* Logging out invalidates the handles of private session objects. */ +static void logout_drops_private_session_objects_test(void) +{ + CK_RV rv; + int i; + CK_SLOT_ID slot = 0; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE privObj = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE pubObj = CK_INVALID_HANDLE; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_BBOOL yes = CK_TRUE; + CK_BBOOL no = CK_FALSE; + byte value[4] = { 1, 2, 3, 4 }; + CK_ATTRIBUTE privTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &no, sizeof(no) }, + { CKA_PRIVATE, &yes, sizeof(yes) }, + { CKA_VALUE, value, sizeof(value) }, + }; + CK_ATTRIBUTE pubTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &no, sizeof(no) }, + { CKA_PRIVATE, &no, sizeof(no) }, + { CKA_VALUE, value, sizeof(value) }, + }; + CK_OBJECT_CLASS gotClass; +#if !defined(NO_AES) && defined(HAVE_AES_CBC) + CK_OBJECT_CLASS keyClass = CKO_SECRET_KEY; + CK_KEY_TYPE keyType = CKK_AES; + byte keyValue[16] = { 0 }; + CK_OBJECT_HANDLE keyObj = CK_INVALID_HANDLE; + CK_ATTRIBUTE keyTmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_VALUE, keyValue, sizeof(keyValue) }, + { CKA_TOKEN, &no, sizeof(no) }, + { CKA_PRIVATE, &yes, sizeof(yes) }, + { CKA_ENCRYPT, &yes, sizeof(yes) }, + }; + byte iv[16] = { 0 }; + byte plain[16] = { 0 }; + byte enc[16]; + CK_ULONG encLen = sizeof(enc); + CK_MECHANISM cbc = { CKM_AES_CBC, iv, sizeof(iv) }; +#endif + CK_ATTRIBUTE getTmpl[] = { + { CKA_CLASS, &gotClass, sizeof(gotClass) }, + }; + + printf("--- logout drops private session objects ---\n"); + rv = token_setup(&slot, userPin); + if (rv == CKR_OK) + rv = open_rw(slot, &session); + if (rv == CKR_OK) + rv = user_login(session, userPin); + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &privObj); + } + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, pubTmpl, + sizeof(pubTmpl) / sizeof(*pubTmpl), &pubObj); + } +#if !defined(NO_AES) && defined(HAVE_AES_CBC) + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(session, keyTmpl, + sizeof(keyTmpl) / sizeof(*keyTmpl), &keyObj); + } + if (rv == CKR_OK) + rv = funcList->C_EncryptInit(session, &cbc, keyObj); +#endif + if (rv == CKR_OK) + rv = funcList->C_Logout(session); + if (rv == CKR_OK) + rv = user_login(session, userPin); + CHECK_RV(rv, "create session objects, log out and back in", CKR_OK); +#if !defined(NO_AES) && defined(HAVE_AES_CBC) + /* PKCS#11 leaves it to the token whether the operation survives logout; + * either way it must complete safely. */ + if (rv == CKR_OK) { + rv = funcList->C_Encrypt(session, plain, sizeof(plain), enc, &encLen); + CHECK_TRUE(rv == CKR_OK || rv == CKR_OPERATION_NOT_INITIALIZED, + "operation started before logout completes safely"); + rv = CKR_OK; + } +#endif + if (rv == CKR_OK) { + rv = funcList->C_GetAttributeValue(session, privObj, getTmpl, 1); + CHECK_RV(rv, "private session object gone after logout", + CKR_OBJECT_HANDLE_INVALID); + rv = funcList->C_GetAttributeValue(session, pubObj, getTmpl, 1); + CHECK_RV(rv, "public session object kept after logout", CKR_OK); + rv = CKR_OK; + /* Logged-out private objects must not use up the session limit. */ + for (i = 0; rv == CKR_OK && i < WP11_SESSION_OBJECT_CNT_MAX + 2; i++) { + rv = funcList->C_CreateObject(session, privTmpl, + sizeof(privTmpl) / sizeof(*privTmpl), &privObj); + if (rv == CKR_OK) + rv = funcList->C_Logout(session); + if (rv == CKR_OK) + rv = user_login(session, userPin); + } + CHECK_RV(rv, "repeated private object create and logout cycles", + CKR_OK); + funcList->C_Logout(session); + } + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); + funcList->C_Finalize(NULL); +} +#endif + #if defined(DEBUG_WOLFPKCS11) && !defined(SINGLE_THREADED) && \ !defined(WOLFPKCS11_NO_STORE) && !defined(WOLFPKCS11_NSS) #define FIND_HOOK_WAIT_MS 200 @@ -1056,6 +1169,9 @@ static int run_test(void) #ifndef SINGLE_THREADED close_last_session_race_test(); #endif +#ifndef WOLFPKCS11_NSS + logout_drops_private_session_objects_test(); +#endif #if !defined(SINGLE_THREADED) && !defined(WOLFPKCS11_NO_TIME) concurrent_login_lockout_test(); #endif diff --git a/tests/logout_retire_test.c b/tests/logout_retire_test.c new file mode 100644 index 00000000..4c91fe39 --- /dev/null +++ b/tests/logout_retire_test.c @@ -0,0 +1,643 @@ +/* logout_retire_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 + * + * Checks that logging out clears the key material of private session objects + * and that the objects it retires do not pile up across login cycles. + */ + +#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/logout_retire_test" + +#if defined(DEBUG_WOLFPKCS11) && !defined(SINGLE_THREADED) && \ + !defined(WOLFPKCS11_SINGLE_THREADED) + #define RETIRE_TEST_THREADS + #include +#endif + +#ifndef WOLFPKCS11_NSS + +#define RETIRE_CYCLES 40 +#define RETIRE_SETTLE 5 + +static const char* soPin = "password123456"; +static const char* userPin = "wolfpkcs11-test"; +static const char tokenLabel[] = "logout-retire"; +static unsigned char keyValue[32] = "logout-retire-secret-key-012345"; + +/* Every live block is linked through its header so it can be scanned. */ +typedef struct TrackHdr { + struct TrackHdr* prev; + struct TrackHdr* next; + size_t sz; +} TrackHdr; + +#define TRACK_HDR_SZ 32 + +static TrackHdr* liveHead = NULL; +static long liveBlocks = 0; +#ifdef RETIRE_TEST_THREADS +static pthread_mutex_t trackMutex = PTHREAD_MUTEX_INITIALIZER; +#define TRACK_LOCK() pthread_mutex_lock(&trackMutex) +#define TRACK_UNLOCK() pthread_mutex_unlock(&trackMutex) +#else +#define TRACK_LOCK() +#define TRACK_UNLOCK() +#endif + +static void* track_malloc(size_t sz) +{ + unsigned char* p = (unsigned char*)malloc(sz + TRACK_HDR_SZ); + TrackHdr* hdr; + + if (p == NULL) + return NULL; + memset(p, 0, sz + TRACK_HDR_SZ); + hdr = (TrackHdr*)p; + hdr->sz = sz; + TRACK_LOCK(); + hdr->next = liveHead; + if (liveHead != NULL) + liveHead->prev = hdr; + liveHead = hdr; + liveBlocks++; + TRACK_UNLOCK(); + return p + TRACK_HDR_SZ; +} + +static void track_free(void* ptr) +{ + TrackHdr* hdr; + + if (ptr == NULL) + return; + hdr = (TrackHdr*)((unsigned char*)ptr - TRACK_HDR_SZ); + TRACK_LOCK(); + if (hdr->prev != NULL) + hdr->prev->next = hdr->next; + else + liveHead = hdr->next; + if (hdr->next != NULL) + hdr->next->prev = hdr->prev; + liveBlocks--; + TRACK_UNLOCK(); + /* Poison so a use after free reads garbage, not the old key. */ + memset(ptr, 0xA5, hdr->sz); + free(hdr); +} + +static void* track_realloc(void* ptr, size_t sz) +{ + void* np; + size_t old; + + if (ptr == NULL) + return track_malloc(sz); + np = track_malloc(sz); + if (np == NULL) + return NULL; + old = ((TrackHdr*)((unsigned char*)ptr - TRACK_HDR_SZ))->sz; + memcpy(np, ptr, old < sz ? old : sz); + track_free(ptr); + return np; +} + +static int live_holds_key(void) +{ + TrackHdr* hdr; + unsigned char* buf; + size_t i; + int found = 0; + + TRACK_LOCK(); + for (hdr = liveHead; hdr != NULL; hdr = hdr->next) { + buf = (unsigned char*)hdr + TRACK_HDR_SZ; + for (i = 0; hdr->sz >= sizeof(keyValue) && + i <= hdr->sz - sizeof(keyValue); i++) { + if (memcmp(buf + i, keyValue, sizeof(keyValue)) == 0) + found = 1; + } + } + TRACK_UNLOCK(); + return found; +} + +static CK_RV token_setup(CK_SLOT_ID* slot) +{ + CK_RV rv; + CK_C_INITIALIZE_ARGS args; + CK_SLOT_ID slotList[16]; + CK_ULONG slotCount = sizeof(slotList) / sizeof(slotList[0]); + CK_SESSION_HANDLE soSession = CK_INVALID_HANDLE; + unsigned char label[32]; + + 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, slotList, &slotCount); + if (rv == CKR_OK && slotCount == 0) + rv = CKR_TOKEN_NOT_PRESENT; + if (rv == CKR_OK) { + *slot = slotList[0]; + 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)); + funcList->C_Logout(soSession); + } + if (soSession != CK_INVALID_HANDLE) + funcList->C_CloseSession(soSession); + return rv; +} + +static CK_RV create_key(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE* key) +{ + CK_OBJECT_CLASS keyClass = CKO_SECRET_KEY; + CK_KEY_TYPE keyType = CKK_GENERIC_SECRET; + CK_BBOOL yes = CK_TRUE; + CK_BBOOL no = CK_FALSE; + CK_ATTRIBUTE tmpl[] = { + { CKA_CLASS, &keyClass, sizeof(keyClass) }, + { CKA_KEY_TYPE, &keyType, sizeof(keyType) }, + { CKA_TOKEN, &no, sizeof(no) }, + { CKA_PRIVATE, &yes, sizeof(yes) }, + { CKA_SENSITIVE, &no, sizeof(no) }, + { CKA_EXTRACTABLE, &yes, sizeof(yes) }, + { CKA_VALUE, keyValue, sizeof(keyValue) }, + }; + + return funcList->C_CreateObject(session, tmpl, + sizeof(tmpl) / sizeof(*tmpl), key); +} + +static CK_RV login_create_key(CK_SESSION_HANDLE session, + CK_OBJECT_HANDLE* key) +{ + CK_RV rv; + + rv = funcList->C_Login(session, CKU_USER, (CK_UTF8CHAR_PTR)userPin, + (CK_ULONG)XSTRLEN(userPin)); + if (rv == CKR_OK) + rv = create_key(session, key); + return rv; +} + +/* A private session key's bytes must not stay in memory after C_Logout. */ +static void logout_clears_retired_key_test(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE key = CK_INVALID_HANDLE; + + printf("--- logout clears retired session key material ---\n"); + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &session); + if (rv == CKR_OK) + rv = login_create_key(session, &key); + CHECK_RV(rv, "log in and create private session key", CKR_OK); + if (rv == CKR_OK) { + CHECK_TRUE(live_holds_key(), "key bytes held while logged in"); + rv = funcList->C_Logout(session); + CHECK_RV(rv, "C_Logout", CKR_OK); + CHECK_TRUE(!live_holds_key(), "no key bytes left after logout"); + } + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); +} + +/* Login, create and logout cycles on one session keep memory use flat. */ +static void retired_objects_bounded_test(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE key = CK_INVALID_HANDLE; + long settled = 0; + int i; + + printf("--- retired session objects stay bounded ---\n"); + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &session); + for (i = 0; rv == CKR_OK && i < RETIRE_CYCLES; i++) { + rv = login_create_key(session, &key); + if (rv == CKR_OK) + rv = funcList->C_Logout(session); + if (i == RETIRE_SETTLE) + settled = liveBlocks; + } + CHECK_RV(rv, "login, create and logout cycles", CKR_OK); + if (rv == CKR_OK) { + if (liveBlocks > settled) { + fprintf(stderr, " live blocks grew from %ld to %ld\n", settled, + liveBlocks); + } + CHECK_TRUE(liveBlocks <= settled, "retired objects do not accumulate"); + } + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); +} + +#ifdef DEBUG_WOLFPKCS11 +extern void WP11_Object_SetFindHook(void (*hook)(void)); + +static CK_SESSION_HANDLE hookLogoutSession = CK_INVALID_HANDLE; +static CK_RV hookLogoutRv = CKR_GENERAL_ERROR; + +/* Runs inside C_GetAttributeValue once it holds the object pointer. */ +static void hook_logout(void) +{ + WP11_Object_SetFindHook(NULL); + hookLogoutRv = funcList->C_Logout(hookLogoutSession); +} + +static CK_SESSION_HANDLE hookDestroySession = CK_INVALID_HANDLE; +static CK_OBJECT_HANDLE hookDestroyObject = CK_INVALID_HANDLE; +static CK_RV hookDestroyRv = CKR_GENERAL_ERROR; + +/* Runs inside C_GetAttributeValue once it holds the object pointer. */ +static void hook_destroy(void) +{ + WP11_Object_SetFindHook(NULL); + hookDestroyRv = funcList->C_DestroyObject(hookDestroySession, + hookDestroyObject); +} + +/* Destroying a key while a call uses it must not free it under that call. */ +static void destroy_during_call_test(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE key = CK_INVALID_HANDLE; + unsigned char value[sizeof(keyValue)]; + CK_ATTRIBUTE valAttr = { CKA_VALUE, value, sizeof(value) }; + + printf("--- destroy during a call keeps the key until the call ends ---\n"); + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &session); + if (rv == CKR_OK) + rv = login_create_key(session, &key); + CHECK_RV(rv, "log in and create session key", CKR_OK); + if (rv == CKR_OK) { + hookDestroySession = session; + hookDestroyObject = key; + hookDestroyRv = CKR_GENERAL_ERROR; + XMEMSET(value, 0, sizeof(value)); + WP11_Object_SetFindHook(hook_destroy); + rv = funcList->C_GetAttributeValue(session, key, &valAttr, 1); + WP11_Object_SetFindHook(NULL); + CHECK_RV(hookDestroyRv, "C_DestroyObject inside the call", CKR_OK); + CHECK_RV(rv, "C_GetAttributeValue", CKR_OK); + CHECK_TRUE(rv == CKR_OK && valAttr.ulValueLen == sizeof(keyValue) && + XMEMCMP(value, keyValue, sizeof(keyValue)) == 0, + "call reads the intact key"); + CHECK_TRUE(!live_holds_key(), "key freed once the call ends"); + funcList->C_Logout(session); + } + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); +} + +/* A logout while a call uses a private session key must not free the key. */ +static void logout_during_call_test(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_SESSION_HANDLE other = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE key = CK_INVALID_HANDLE; + unsigned char value[sizeof(keyValue)]; + CK_ATTRIBUTE valAttr = { CKA_VALUE, value, sizeof(value) }; + + printf("--- logout during a call keeps the key until the call ends ---\n"); + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &session); + if (rv == CKR_OK) { + rv = funcList->C_OpenSession(slot, + CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &other); + } + if (rv == CKR_OK) + rv = login_create_key(session, &key); + CHECK_RV(rv, "log in and create private session key", CKR_OK); + if (rv == CKR_OK) { + hookLogoutSession = other; + hookLogoutRv = CKR_GENERAL_ERROR; + XMEMSET(value, 0, sizeof(value)); + WP11_Object_SetFindHook(hook_logout); + rv = funcList->C_GetAttributeValue(session, key, &valAttr, 1); + WP11_Object_SetFindHook(NULL); + CHECK_RV(hookLogoutRv, "C_Logout inside the call", CKR_OK); + CHECK_RV(rv, "C_GetAttributeValue", CKR_OK); + CHECK_TRUE(rv == CKR_OK && valAttr.ulValueLen == sizeof(keyValue) && + XMEMCMP(value, keyValue, sizeof(keyValue)) == 0, + "call reads the intact key"); + CHECK_TRUE(!live_holds_key(), "key freed once the call ends"); + } + if (other != CK_INVALID_HANDLE) + funcList->C_CloseSession(other); + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); +} + +/* A logout while C_DestroyObject holds the key leaves one owner of the key. */ +static void logout_during_destroy_test(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_SESSION_HANDLE other = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE key = CK_INVALID_HANDLE; + + printf("--- logout during destroy frees the key once ---\n"); + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &session); + if (rv == CKR_OK) { + rv = funcList->C_OpenSession(slot, + CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &other); + } + if (rv == CKR_OK) + rv = login_create_key(session, &key); + CHECK_RV(rv, "log in and create private session key", CKR_OK); + if (rv == CKR_OK) { + hookLogoutSession = other; + hookLogoutRv = CKR_GENERAL_ERROR; + WP11_Object_SetFindHook(hook_logout); + rv = funcList->C_DestroyObject(session, key); + WP11_Object_SetFindHook(NULL); + CHECK_RV(hookLogoutRv, "C_Logout inside C_DestroyObject", CKR_OK); + CHECK_RV(rv, "C_DestroyObject of the retired key", + CKR_OBJECT_HANDLE_INVALID); + CHECK_TRUE(!live_holds_key(), "key freed once the call ends"); + } + if (other != CK_INVALID_HANDLE) + funcList->C_CloseSession(other); + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); +} + +#ifdef RETIRE_TEST_THREADS +#define OVERLAP_STEPS 5 +#define KEY_TAG_IDX (sizeof(keyValue) - 2) + +typedef struct HoldArg { + CK_SESSION_HANDLE session; + CK_OBJECT_HANDLE object; + CK_RV rv; +} HoldArg; + +static pthread_mutex_t holdMutex = PTHREAD_MUTEX_INITIALIZER; +static pthread_cond_t holdCond = PTHREAD_COND_INITIALIZER; +static int holdArmed = 0; +static int holdEntered[OVERLAP_STEPS]; +static int holdRelease[OVERLAP_STEPS]; + +/* The armed holder's call waits here, inside its object call. */ +static void hook_hold(void) +{ + int idx; + + pthread_mutex_lock(&holdMutex); + idx = holdArmed - 1; + holdArmed = 0; + if (idx >= 0) { + holdEntered[idx] = 1; + pthread_cond_broadcast(&holdCond); + while (!holdRelease[idx]) + pthread_cond_wait(&holdCond, &holdMutex); + } + pthread_mutex_unlock(&holdMutex); +} + +static void* hold_thread(void* p) +{ + HoldArg* arg = (HoldArg*)p; + CK_OBJECT_CLASS cls; + CK_ATTRIBUTE attr = { CKA_CLASS, &cls, sizeof(cls) }; + + arg->rv = funcList->C_GetAttributeValue(arg->session, arg->object, &attr, + 1); + return NULL; +} + +static int hold_start(pthread_t* th, HoldArg* arg, int idx) +{ + int ret; + + pthread_mutex_lock(&holdMutex); + holdArmed = idx + 1; + holdEntered[idx] = 0; + holdRelease[idx] = 0; + pthread_mutex_unlock(&holdMutex); + ret = pthread_create(th, NULL, hold_thread, arg); + if (ret == 0) { + pthread_mutex_lock(&holdMutex); + while (!holdEntered[idx]) + pthread_cond_wait(&holdCond, &holdMutex); + pthread_mutex_unlock(&holdMutex); + } + return ret; +} + +static void hold_end(pthread_t th, int idx) +{ + pthread_mutex_lock(&holdMutex); + holdRelease[idx] = 1; + pthread_cond_broadcast(&holdCond); + pthread_mutex_unlock(&holdMutex); + pthread_join(th, NULL); +} + +static int live_holds_tagged_key(int idx) +{ + unsigned char saved = keyValue[KEY_TAG_IDX]; + int found; + + keyValue[KEY_TAG_IDX] = (unsigned char)('a' + idx); + found = live_holds_key(); + keyValue[KEY_TAG_IDX] = saved; + return found; +} + +/* Overlapping calls that never all end at once must not hold destroyed keys: + * each one is freed once the calls that began before its destroy end. */ +static void destroy_while_calls_overlap_test(CK_SLOT_ID slot) +{ + CK_RV rv; + CK_SESSION_HANDLE session = CK_INVALID_HANDLE; + CK_SESSION_HANDLE other = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE key = CK_INVALID_HANDLE; + CK_OBJECT_HANDLE data = CK_INVALID_HANDLE; + CK_OBJECT_CLASS dataClass = CKO_DATA; + CK_BBOOL no = CK_FALSE; + unsigned char dataValue[] = "hold"; + CK_ATTRIBUTE dataTmpl[] = { + { CKA_CLASS, &dataClass, sizeof(dataClass) }, + { CKA_TOKEN, &no, sizeof(no) }, + { CKA_PRIVATE, &no, sizeof(no) }, + { CKA_VALUE, dataValue, sizeof(dataValue) }, + }; + pthread_t th[OVERLAP_STEPS]; + HoldArg arg[OVERLAP_STEPS]; + unsigned char saved = keyValue[KEY_TAG_IDX]; + int started = 0; + int i; + + printf("--- destroyed keys are freed while calls keep overlapping ---\n"); + rv = funcList->C_OpenSession(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, + NULL, NULL, &session); + if (rv == CKR_OK) { + rv = funcList->C_OpenSession(slot, + CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &other); + } + if (rv == CKR_OK) { + rv = funcList->C_CreateObject(other, dataTmpl, + sizeof(dataTmpl) / sizeof(*dataTmpl), &data); + } + if (rv == CKR_OK) { + rv = funcList->C_Login(session, CKU_USER, (CK_UTF8CHAR_PTR)userPin, + (CK_ULONG)XSTRLEN(userPin)); + } + CHECK_RV(rv, "open sessions, create data object and log in", CKR_OK); + if (rv == CKR_OK) + WP11_Object_SetFindHook(hook_hold); + for (i = 0; rv == CKR_OK && i < OVERLAP_STEPS; i++) { + arg[i].session = other; + arg[i].object = data; + arg[i].rv = CKR_GENERAL_ERROR; + if (hold_start(&th[i], &arg[i], i) != 0) { + rv = CKR_GENERAL_ERROR; + break; + } + started = i + 1; + if (i > 0) + hold_end(th[i - 1], i - 1); + if (i > 1) { + CHECK_TRUE(!live_holds_tagged_key(i - 2), + "key destroyed before two calls ended is freed"); + } + keyValue[KEY_TAG_IDX] = (unsigned char)('a' + i); + rv = create_key(session, &key); + keyValue[KEY_TAG_IDX] = saved; + if (rv == CKR_OK) + rv = funcList->C_DestroyObject(session, key); + } + CHECK_RV(rv, "create and destroy keys while calls overlap", CKR_OK); + if (started > 0) + hold_end(th[started - 1], started - 1); + WP11_Object_SetFindHook(NULL); + for (i = 0; i < started; i++) { + CHECK_RV(arg[i].rv, "held C_GetAttributeValue", CKR_OK); + CHECK_TRUE(!live_holds_tagged_key(i), "destroyed key freed at end"); + } + funcList->C_Logout(session); + if (other != CK_INVALID_HANDLE) + funcList->C_CloseSession(other); + if (session != CK_INVALID_HANDLE) + funcList->C_CloseSession(session); +} +#endif +#endif + +int main(int argc, char* argv[]) +{ + CK_RV rv; + CK_SLOT_ID slot = 0; + + (void)argc; + (void)argv; + +#ifndef WOLFPKCS11_NO_ENV + XSETENV("WOLFPKCS11_TOKEN_PATH", TEST_DIR, 1); +#endif + if (wolfSSL_SetAllocators(track_malloc, track_free, track_realloc) != 0) { + printf("Allocator hooks not available, skipping test\n"); + return 77; + } + + printf("=== wolfPKCS11 logout retire test ===\n"); + rv = pkcs11_load(); + CHECK_RV(rv, "load library", CKR_OK); + if (rv == CKR_OK) { + rv = token_setup(&slot); + CHECK_RV(rv, "token setup", CKR_OK); + } + if (rv == CKR_OK) { + logout_clears_retired_key_test(slot); + retired_objects_bounded_test(slot); +#ifdef DEBUG_WOLFPKCS11 + logout_during_call_test(slot); + destroy_during_call_test(slot); + logout_during_destroy_test(slot); +#endif +#ifdef RETIRE_TEST_THREADS + destroy_while_calls_overlap_test(slot); +#endif + } + if (funcList != NULL) + funcList->C_Finalize(NULL); + pkcs11_unload(); + return pkcs11_test_summary(); +} + +#else + +int main(int argc, char* argv[]) +{ + (void)argc; + (void)argv; + printf("NSS keeps private session objects across logout, skipping test\n"); + return 77; +} + +#endif diff --git a/wolfpkcs11/internal.h b/wolfpkcs11/internal.h index de846042..709e3da4 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -384,6 +384,7 @@ C_EXTRA_FLAGS="-DWOLFSSL_PUBLIC_MP -DWC_RSA_DIRECT" typedef struct WP11_Object WP11_Object; typedef struct WP11_Session WP11_Session; typedef struct WP11_Slot WP11_Slot; +typedef struct WP11_ObjectCalls WP11_ObjectCalls; WP11_LOCAL int WP11_Library_Init(void); @@ -413,10 +414,15 @@ WP11_LOCAL int WP11_Slot_UserLogin(WP11_Slot* slot, char* pin, int pinLen); WP11_LOCAL int WP11_Slot_IsLoggedIn(WP11_Slot* slot); WP11_LOCAL int WP11_Slot_IsUserLoggedIn(WP11_Slot* slot); WP11_LOCAL void WP11_Slot_Logout(WP11_Slot* slot); +WP11_LOCAL WP11_ObjectCalls* WP11_Slot_ObjectCallEnter( + CK_SESSION_HANDLE hSession); +WP11_LOCAL void WP11_Slot_ObjectCallLeave(WP11_ObjectCalls* calls); +WP11_LOCAL void WP11_Slot_DiscardObject(WP11_Slot* slot, WP11_Object* object); #ifdef DEBUG_WOLFPKCS11 WP11_API int WP11_Slot_TokenKeyIsZero(CK_SLOT_ID slotId); WP11_API int WP11_Slot_TokenDecodedObjectCount(CK_SLOT_ID slotId); WP11_API void WP11_Session_SetFindHook(void (*hook)(void)); +WP11_API void WP11_Object_SetFindHook(void (*hook)(void)); #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 77cc056b1c399ed41d3478338fd6c4d172d5b568 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 09:57:04 -0700 Subject: [PATCH 13/61] 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 0884af37..c955010b 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2445,6 +2445,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, @@ -2454,6 +2455,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 d7ef4a12..d5450066 100644 --- a/tests/include.am +++ b/tests/include.am @@ -310,6 +310,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 @@ -373,6 +378,7 @@ tests_wrapkey_length_query_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 @@ -428,6 +434,7 @@ tests_wrapkey_length_query_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 2ed90d391be2c5cabc4886de8c263f1d0e602e99 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:16:19 -0700 Subject: [PATCH 14/61] 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 c955010b..ddd8c747 100644 --- a/src/internal.c +++ b/src/internal.c @@ -142,6 +142,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. */ @@ -1962,6 +1967,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. * @@ -2063,6 +2098,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. * @@ -2452,6 +2507,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); @@ -2461,21 +2523,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 6725f114d8e8c48c799422f3c4d1af5f394e450f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:25:41 -0700 Subject: [PATCH 15/61] 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 ddd8c747..b1718d12 100644 --- a/src/internal.c +++ b/src/internal.c @@ -3579,7 +3579,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, @@ -3588,7 +3588,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. */ @@ -3596,7 +3597,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. */ @@ -3604,7 +3606,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 d45a0801c2fb2ec2c8dae7875afc652a840aba8a Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:45:11 -0700 Subject: [PATCH 16/61] 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 b1718d12..e536caff 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4215,11 +4215,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) { @@ -4563,11 +4566,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) { @@ -4803,11 +4809,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) { @@ -5020,11 +5029,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 c6de8820f405a27c681e66edbc86d06ebd267f3d Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:53:42 -0700 Subject: [PATCH 17/61] 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 e536caff..ba12bc5e 100644 --- a/src/internal.c +++ b/src/internal.c @@ -5044,6 +5044,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 fbbe1e89e02ac8532670830f1f4e3cbcd2454128 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:06:36 -0700 Subject: [PATCH 18/61] 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 ba12bc5e..a0c8141d 100644 --- a/src/internal.c +++ b/src/internal.c @@ -3494,14 +3494,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 @@ -3568,7 +3579,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; @@ -6945,8 +6960,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 340cc3750e28e2b07adbe6d071a84a0d3eb0b8aa Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:14:03 -0700 Subject: [PATCH 19/61] 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 a0c8141d..6cc5614d 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4135,15 +4135,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 b8000371efc85741dd85d44b418487eedbbfdc14 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:20:21 -0700 Subject: [PATCH 20/61] 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 6cc5614d..657addb2 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4321,7 +4321,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; } @@ -4663,7 +4666,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 3ba23ffc6ade58837cd89f0cbf4f80ceb69b9ae9 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:27:25 -0700 Subject: [PATCH 21/61] 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 657addb2..e9c3899a 100644 --- a/src/internal.c +++ b/src/internal.c @@ -5115,6 +5115,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; } @@ -6492,6 +6500,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 90210fe642fac2d102eb8310df82823c53182e2d Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:33:20 -0700 Subject: [PATCH 22/61] 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 e9c3899a..ac37db4b 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4355,6 +4355,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; @@ -4696,6 +4698,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; @@ -4946,6 +4950,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 b1b9fe55f519fa40c32bf163a60165e67453e888 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:47:05 -0700 Subject: [PATCH 23/61] 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 ac37db4b..b80d6de0 100644 --- a/src/internal.c +++ b/src/internal.c @@ -4249,16 +4249,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; @@ -4605,16 +4609,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; @@ -4862,10 +4870,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 d154dedd677249b906e4bde87b9bad0c94a9d796 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:53:02 -0700 Subject: [PATCH 24/61] 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 b80d6de0..edfc0fea 100644 --- a/src/internal.c +++ b/src/internal.c @@ -5076,6 +5076,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; @@ -6478,6 +6482,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 9bd0d5cc4af83a507399145f9eb743d47972496f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 17:11:24 -0700 Subject: [PATCH 25/61] F-10400 - Authenticate stored object policy with the key encryption --- src/crypto.c | 6 + src/internal.c | 939 ++++++++++++++-- tests/include.am | 8 + tests/object_policy_integrity_test.c | 1538 ++++++++++++++++++++++++++ wolfpkcs11/internal.h | 6 + 5 files changed, 2426 insertions(+), 71 deletions(-) create mode 100644 tests/object_policy_integrity_test.c diff --git a/src/crypto.c b/src/crypto.c index c8d3c2e3..2d0a2a4e 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -1184,6 +1184,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 edfc0fea..2b25a99a 100644 --- a/src/internal.c +++ b/src/internal.c @@ -298,6 +298,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 */ @@ -593,6 +595,9 @@ struct WP11_Slot { word32 epoch; /* Current object call epoch */ WP11_Object* discarded; /* Destroyed objects awaiting free */ byte reclaim:1; /* Retired objects may 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) @@ -1257,25 +1262,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; } @@ -1597,6 +1629,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) @@ -1897,8 +2401,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", @@ -2969,6 +3482,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; @@ -3414,11 +3929,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; @@ -3429,7 +3947,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); @@ -3448,12 +3966,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; @@ -3464,13 +3985,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); + /** * "Decode" the certificate. * @@ -4241,10 +4864,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. */ @@ -4340,10 +4960,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; @@ -4601,10 +5219,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. */ @@ -4690,10 +5305,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) { @@ -4853,10 +5466,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. */ @@ -4942,10 +5552,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) { @@ -5070,12 +5678,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)); @@ -5119,11 +5723,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; } @@ -5455,10 +6057,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, @@ -5538,10 +6137,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) { @@ -6477,11 +7074,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)); @@ -6514,11 +7109,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); if (ret == 0) object->keyDataLen = object->data.symmKey->len + AES_BLOCK_SIZE; } @@ -6794,6 +7387,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; } @@ -6911,10 +7506,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) { @@ -7064,6 +7664,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; @@ -7614,9 +8216,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, @@ -7771,7 +8380,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; @@ -7904,6 +8513,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 */ /** @@ -8023,6 +8660,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->lock); } @@ -8051,6 +8691,14 @@ static int wp11_Slot_Init(WP11_Slot* slot, int id) slot->calls[1].slot = slot; ret = WP11_Lock_Init(&slot->lock); +#ifndef WOLFPKCS11_NO_STORE + if (ret == 0) { + ret = WP11_Lock_Init(&slot->storeLock); + if (ret != 0) { + WP11_Lock_Free(&slot->lock); + } + } +#endif if (ret == 0) { #if defined(WOLFPKCS11_TPM) ret = wp11_TpmInit(slot); @@ -8619,6 +9267,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. */ @@ -8633,8 +9284,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; } @@ -9341,9 +10009,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, @@ -9362,9 +10042,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; } @@ -9383,9 +10076,29 @@ int WP11_Slot_SetUserPin(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]; + byte oldSeed[PIN_SEED_SZ]; + byte oldKey[AES_256_KEY_SIZE]; + int oldPinLen; + int oldFlags; + byte oldPinEmpty; + WP11_Object* object; + int rebind = 0; +#endif WP11_Lock_LockRW(&slot->lock); token = &slot->token; +#ifdef WP11_STORE_BATCH + XMEMCPY(oldPin, token->userPin, sizeof(oldPin)); + XMEMCPY(oldPinSeed, token->userPinSeed, sizeof(oldPinSeed)); + XMEMCPY(oldSeed, token->seed, sizeof(oldSeed)); + XMEMCPY(oldKey, token->key, sizeof(oldKey)); + oldPinLen = token->userPinLen; + oldFlags = token->tokenFlags; + oldPinEmpty = token->userPinEmpty; +#endif /* New seed each time. */ WP11_Lock_LockRW(&slot->token.rngLock); ret = wc_RNG_GenerateBlock(&slot->token.rng, token->userPinSeed, @@ -9416,10 +10129,47 @@ int WP11_Slot_SetUserPin(WP11_Slot* slot, char* pin, int pinLen) token->userPinLen = sizeof(token->userPin); token->tokenFlags |= WP11_TOKEN_FLAG_USER_PIN_SET; #ifndef WOLFPKCS11_NO_STORE + #ifdef WP11_STORE_BATCH + WP11_Lock_LockRO(&token->lock); + for (object = token->object; object != NULL && !rebind; + object = object->next) { + rebind = object->unbound && !object->encoded && + wp11_Object_IsEncrypted(object); + } + WP11_Lock_UnlockRO(&token->lock); + #endif ret = wp11_Token_Store(token, (int)slot->id); + #ifdef WP11_STORE_BATCH + if (ret != 0) { + /* Keep the PIN and key that are still in storage in effect. */ + XMEMCPY(token->userPin, oldPin, sizeof(oldPin)); + XMEMCPY(token->userPinSeed, oldPinSeed, sizeof(oldPinSeed)); + XMEMCPY(token->seed, oldSeed, sizeof(oldSeed)); + XMEMCPY(token->key, oldKey, sizeof(oldKey)); + token->userPinLen = oldPinLen; + token->tokenFlags = oldFlags; + token->userPinEmpty = oldPinEmpty; + /* The store may have rebound objects under the discarded key. */ + WP11_Lock_LockRW(&token->lock); + for (object = token->object; rebind && object != NULL; + object = object->next) { + if (wp11_Object_IsEncrypted(object) && !object->encoded && + wp11_Object_Encode(object, 0) != 0) { + WOLFPKCS11_MSG("SetUserPin: failed to re-encrypt object"); + } + } + WP11_Lock_UnlockRW(&token->lock); + } + #endif #endif } WP11_Lock_UnlockRW(&slot->lock); +#ifdef WP11_STORE_BATCH + wc_ForceZero(oldPin, sizeof(oldPin)); + wc_ForceZero(oldPinSeed, sizeof(oldPinSeed)); + wc_ForceZero(oldSeed, sizeof(oldSeed)); + wc_ForceZero(oldKey, sizeof(oldKey)); +#endif return ret; } @@ -13917,6 +14667,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. @@ -13927,15 +14711,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: @@ -14310,6 +15103,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 d5450066..06b40b95 100644 --- a/tests/include.am +++ b/tests/include.am @@ -315,6 +315,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 @@ -379,6 +385,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 @@ -435,6 +442,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 709e3da4..c851dad4 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -423,6 +423,12 @@ WP11_API int WP11_Slot_TokenKeyIsZero(CK_SLOT_ID slotId); WP11_API int WP11_Slot_TokenDecodedObjectCount(CK_SLOT_ID slotId); WP11_API void WP11_Session_SetFindHook(void (*hook)(void)); WP11_API void WP11_Object_SetFindHook(void (*hook)(void)); +#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 af26c4cd3bc64277064af774634baf26d3e0f8a9 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:55:08 -0700 Subject: [PATCH 26/61] F-5763 - Release the replaced operation when a new one is initialized --- src/internal.c | 86 ++++- tests/include.am | 7 + tests/session_op_lifecycle_test.c | 519 ++++++++++++++++++++++++++++++ wolfpkcs11/internal.h | 1 + 4 files changed, 601 insertions(+), 12 deletions(-) create mode 100644 tests/session_op_lifecycle_test.c diff --git a/src/internal.c b/src/internal.c index 2b25a99a..26144643 100644 --- a/src/internal.c +++ b/src/internal.c @@ -965,6 +965,8 @@ static int wp11_Slot_AddSession(WP11_Slot* slot, WP11_Session** session) return ret; } +static void wp11_Session_FreeOp(WP11_Session* session); + /** * Finalize a session - clean-up but don't clear out. * @@ -997,6 +999,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) { @@ -1025,8 +1038,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) { @@ -1086,6 +1102,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 @@ -10907,6 +10934,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; } @@ -11030,14 +11059,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; @@ -11073,13 +11110,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; } @@ -11100,7 +11143,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)); @@ -11162,6 +11206,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 */ @@ -11189,6 +11238,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)); @@ -11239,6 +11289,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) { @@ -11266,6 +11317,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) { @@ -11321,6 +11373,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); } @@ -11381,6 +11434,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); } @@ -11416,6 +11470,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) { @@ -19306,6 +19361,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); @@ -19490,6 +19546,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); } @@ -19716,12 +19773,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); @@ -19872,6 +19931,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 06b40b95..acfa182b 100644 --- a/tests/include.am +++ b/tests/include.am @@ -321,6 +321,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 @@ -386,6 +391,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 @@ -443,6 +449,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 c851dad4..976b12a5 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -456,6 +456,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 259e67c78605997f3b7769b8c1456cfcf8614777 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:31:07 -0700 Subject: [PATCH 27/61] 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 2d0a2a4e..85eb25cc 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -2885,7 +2885,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; } @@ -2909,12 +2909,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; } @@ -2962,7 +2962,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; } @@ -2987,7 +2987,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; } @@ -3012,7 +3012,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; } @@ -3056,7 +3056,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; } @@ -3081,7 +3081,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; } @@ -3111,7 +3111,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; } @@ -3206,7 +3206,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; } @@ -3228,7 +3228,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; @@ -3241,7 +3241,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; } @@ -3257,7 +3257,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; @@ -3283,7 +3283,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; @@ -3306,7 +3306,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; @@ -3328,7 +3328,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; @@ -3340,7 +3340,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; @@ -3436,7 +3436,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; @@ -3457,7 +3457,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; @@ -3474,7 +3474,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; @@ -3496,7 +3496,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; @@ -3518,7 +3518,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; @@ -3529,7 +3529,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; } @@ -3969,7 +3969,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; } @@ -3993,7 +3993,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; } @@ -4058,7 +4058,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 - @@ -4083,7 +4083,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 - @@ -4107,7 +4107,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; } @@ -4156,7 +4156,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); @@ -4182,7 +4182,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); @@ -4215,7 +4215,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; } @@ -4302,7 +4302,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; } @@ -4320,7 +4320,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; @@ -4331,7 +4331,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; } @@ -4358,7 +4358,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; @@ -4384,7 +4384,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; @@ -4402,7 +4402,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; @@ -4423,7 +4423,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; @@ -4435,7 +4435,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; } @@ -4528,7 +4528,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; @@ -4563,7 +4563,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; @@ -4581,7 +4581,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; @@ -4594,7 +4594,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) - @@ -4609,7 +4609,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; @@ -4630,7 +4630,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; @@ -4641,7 +4641,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; } @@ -4830,7 +4830,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; @@ -4874,21 +4874,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; @@ -5805,7 +5805,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); @@ -5936,7 +5936,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; } @@ -5945,11 +5945,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; } @@ -6122,7 +6122,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); @@ -6943,7 +6943,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); @@ -7076,11 +7076,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; } @@ -7211,7 +7211,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); @@ -8873,7 +8873,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 26144643..0e0b4d0b 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1098,6 +1098,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 2cd7e9a56204dec8c4fb7a17769d30fcafa2ca25 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:07:02 -0700 Subject: [PATCH 28/61] 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 0e0b4d0b..04383535 100644 --- a/src/internal.c +++ b/src/internal.c @@ -11379,6 +11379,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 907ac564f39e83f129c160858bad25be20c91e22 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:20:11 -0700 Subject: [PATCH 29/61] 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 04383535..eff7d39a 100644 --- a/src/internal.c +++ b/src/internal.c @@ -11233,6 +11233,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; @@ -11248,6 +11249,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, @@ -11264,6 +11267,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 */ @@ -11301,6 +11307,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)); @@ -11330,6 +11338,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) @@ -11491,6 +11501,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; @@ -19798,6 +19810,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 7bd40a4e84fb0ccb42b1f91e06dcbcc18c2eeff5 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 13:52:29 -0700 Subject: [PATCH 30/61] 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 eff7d39a..988152b4 100644 --- a/src/internal.c +++ b/src/internal.c @@ -10663,6 +10663,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. @@ -10678,6 +10692,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; @@ -11843,7 +11860,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 @@ -11856,18 +11875,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 @@ -11895,6 +11918,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 bbe87e41b0a4115123c022a3296429b664a4c400 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:04:35 -0700 Subject: [PATCH 31/61] 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 988152b4..af4125cf 100644 --- a/src/internal.c +++ b/src/internal.c @@ -533,6 +533,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 */ @@ -10704,31 +10705,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; } @@ -10744,9 +10750,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 38c005ecc19401b42b1b4fe0db84d74770ecef33 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:12:12 -0700 Subject: [PATCH 32/61] 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 af4125cf..01f6983c 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1099,6 +1099,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 f37f7533bdfaac310687ccda285237fd5d8cf5cf Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:20:46 -0700 Subject: [PATCH 33/61] 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 01f6983c..d709d9cc 100644 --- a/src/internal.c +++ b/src/internal.c @@ -20150,7 +20150,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 @@ -20186,7 +20189,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 1180d4389f045ee6221d76461dcd1ff63d8021c5 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:36:53 -0700 Subject: [PATCH 34/61] 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 d709d9cc..c66a00df 100644 --- a/src/internal.c +++ b/src/internal.c @@ -20258,6 +20258,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 9ad23fa49f93c1dc479b0451ad0726669d6f5c9f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:44:36 -0700 Subject: [PATCH 35/61] 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 c66a00df..8e77f043 100644 --- a/src/internal.c +++ b/src/internal.c @@ -20249,18 +20249,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); @@ -20295,16 +20295,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 913a2e6ab19010f12bb60a2062845cec3f601709 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 14:51:03 -0700 Subject: [PATCH 36/61] 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 95938e00..dab691a5 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1839,8 +1839,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 02662a29eea97ef0cfa56f97cafad549b9546c9b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 15:33:39 -0700 Subject: [PATCH 37/61] 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 85eb25cc..6aac5220 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -2447,6 +2447,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) @@ -2476,7 +2505,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; } @@ -2731,7 +2764,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). @@ -3576,8 +3610,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) @@ -3818,7 +3857,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). @@ -4669,7 +4709,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. */ @@ -4699,7 +4740,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; } @@ -5098,7 +5143,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). @@ -5133,8 +5179,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 @@ -6277,7 +6328,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). @@ -6317,7 +6369,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; } @@ -7243,7 +7299,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. @@ -7276,7 +7333,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 8e77f043..89a94dbe 100644 --- a/src/internal.c +++ b/src/internal.c @@ -10680,26 +10680,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 69cc03a6..d32d1750 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 abe51a06..6cfbcead 100644 --- a/tests/pkcs11test.c +++ b/tests/pkcs11test.c @@ -4809,8 +4809,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); @@ -4879,8 +4883,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); @@ -5353,7 +5361,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, @@ -5493,7 +5505,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); @@ -5559,7 +5575,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); @@ -5752,8 +5772,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 976b12a5..de0a4150 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -448,6 +448,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 e679458e8b0666bfba102ab93797b1f122bcbb87 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 08:40:21 -0700 Subject: [PATCH 38/61] 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 89a94dbe..3610d089 100644 --- a/src/internal.c +++ b/src/internal.c @@ -10422,6 +10422,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 dab691a5..5fd5375a 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 acfa182b..4c1dc9df 100644 --- a/tests/include.am +++ b/tests/include.am @@ -326,6 +326,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 @@ -392,6 +397,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 @@ -450,6 +456,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 de0a4150..a3f3a92c 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -439,6 +439,7 @@ WP11_LOCAL int WP11_Slot_SetUserPin(WP11_Slot* slot, char* pin, int pinLen); 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 718aee1433c22bd69f6aa5f606f0918aa8d582d3 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 08:55:03 -0700 Subject: [PATCH 39/61] 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 5fd5375a..87621d49 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 6cfbcead..426bfdc2 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 ff6ac8eca2d9930242e2759166ec5b95bf1336bd Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:04:28 -0700 Subject: [PATCH 40/61] 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 6aac5220..55cb0236 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -8773,6 +8773,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); @@ -8905,6 +8909,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) == @@ -9173,6 +9196,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 87621d49..9790a6c1 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 955d7853b712c61709f88d33f7edcf869c469c11 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:14:17 -0700 Subject: [PATCH 41/61] 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 3610d089..2e03d34e 100644 --- a/src/internal.c +++ b/src/internal.c @@ -127,17 +127,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 9790a6c1..38497006 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 a3f3a92c..a214ca86 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 cfe9def6e963d731813b165da3b331426551e69a Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:26:09 -0700 Subject: [PATCH 42/61] 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 38497006..b7c20331 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 00854e7fec8a792cadee05ac46b6f5d7c291255c Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:34:25 -0700 Subject: [PATCH 43/61] 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 b7c20331..cbd2c8a6 100644 --- a/src/slot.c +++ b/src/slot.c @@ -1595,6 +1595,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, @@ -1644,6 +1646,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 e96c802aefebc000d9a0634e10da6b6faec35cd2 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:38:53 -0700 Subject: [PATCH 44/61] 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 e91ec4b4021940940f34835d019b1e1b12a6929e Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:43:24 -0700 Subject: [PATCH 45/61] 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 cbd2c8a6..b39d3da2 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 75da0eb923c32cae7482606dec60c7f6d80d2c60 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:49:41 -0700 Subject: [PATCH 46/61] 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 b39d3da2..392ae07b 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 2ab8f0ce863744099d996959b94d27e2a2bb0e2a Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:54:18 -0700 Subject: [PATCH 47/61] 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 392ae07b..cc5210a2 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 5fcc280f542e0da5e0c6e07d248a39db1257a17f Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 09:59:03 -0700 Subject: [PATCH 48/61] 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 cc5210a2..4544d84f 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 ab24e280d945e68ce45bd15b675bc0f9059620c3 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Wed, 7 Oct 2026 10:03:10 -0700 Subject: [PATCH 49/61] 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 2e03d34e..3e1ab0e3 100644 --- a/src/internal.c +++ b/src/internal.c @@ -9882,7 +9882,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. * Other -ve value when hashing PIN fails. From 260edee0f75bbec09fbe1afa3ce53a577a1e7231 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 09:34:10 -0700 Subject: [PATCH 50/61] 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 8cfcb303..505a9a49 100644 --- a/.github/workflows/unit-test.yml +++ b/.github/workflows/unit-test.yml @@ -50,6 +50,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 3e1ab0e3..8ae4dcb0 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1474,14 +1474,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 @@ -1521,6 +1521,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; @@ -1544,6 +1545,7 @@ static int wolfPKCS11_Store_Name(int type, CK_ULONG id1, CK_ULONG id2, char* nam } #endif } +#endif #ifdef WOLFPKCS11_DEFAULT_TOKEN_PATH if (str == NULL) { From b3b36075fe855edfdc1d45db3a5f634c3dbbbb63 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 10:23:17 -0700 Subject: [PATCH 51/61] F-10379 - Keep token object count intact when an object store fails --- src/crypto.c | 2 + src/internal.c | 11 +- tests/include.am | 7 + tests/token_store_test.c | 309 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 323 insertions(+), 6 deletions(-) create mode 100644 tests/token_store_test.c diff --git a/src/crypto.c b/src/crypto.c index 55cb0236..11ac0c7e 100644 --- a/src/crypto.c +++ b/src/crypto.c @@ -9975,6 +9975,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 8ae4dcb0..566e7a8b 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8433,12 +8433,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; } @@ -11652,6 +11646,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 4c1dc9df..b995713e 100644 --- a/tests/include.am +++ b/tests/include.am @@ -260,6 +260,11 @@ noinst_PROGRAMS += tests/unique_id_test tests_unique_id_test_SOURCES = tests/unique_id_test.c tests_unique_id_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 tests_nss_email_store_test_SOURCES = tests/nss_email_store_test.c @@ -384,6 +389,7 @@ tests_concurrent_destroy_object_test_LDADD += src/libwolfpkcs11.la 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_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 @@ -443,6 +449,7 @@ tests_concurrent_destroy_object_test_LDADD += src/libwolfpkcs11.la 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_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 6ca778ea1c2e1690956f0bf31254ab54fe0ca134 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:21:42 -0700 Subject: [PATCH 52/61] F-10386 - Report token store commit failures to the caller --- src/internal.c | 79 +++++++++++++---- tests/token_store_test.c | 179 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 240 insertions(+), 18 deletions(-) diff --git a/src/internal.c b/src/internal.c index 566e7a8b..00108e55 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2396,10 +2396,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 @@ -2413,22 +2417,27 @@ 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) { - XFCLOSE(ctx->file); + if (XFCLOSE(ctx->file) != 0 && ctx->is_write) { + commit = 0; + ret = BUFFER_E; + } ctx->file = XBADFILE; } - if (ctx->is_write && ctx->has_temp) { + 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) @@ -2449,6 +2458,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); } /** @@ -2633,6 +2654,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. * @@ -4572,7 +4615,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 @@ -4611,7 +4654,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; @@ -4842,7 +4885,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; } @@ -5195,7 +5238,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; @@ -5424,7 +5467,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; @@ -5673,7 +5716,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; @@ -6021,7 +6064,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); @@ -6246,7 +6289,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; @@ -6428,7 +6471,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; } @@ -6874,7 +6917,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; } @@ -7207,7 +7250,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; @@ -7510,7 +7553,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; } @@ -8420,7 +8463,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; } @@ -8520,7 +8563,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 d03529ff37b1a75e8740e360674165b791176c4b Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:29:54 -0700 Subject: [PATCH 53/61] 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 00108e55..28de62ba 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8447,7 +8447,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; @@ -8457,7 +8457,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, @@ -8466,6 +8467,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 4fd257e2c08b97c75d09a59d31de300b932575e6 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:39:40 -0700 Subject: [PATCH 54/61] 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 28de62ba..c28fef3e 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8893,9 +8893,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; @@ -8904,7 +8909,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); @@ -8914,13 +8919,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 / @@ -8953,6 +8959,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 a214ca86..44d9db07 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 e1d073d05eb21d067b38f85522cf4c529c9bf962 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 11:53:16 -0700 Subject: [PATCH 55/61] 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 c28fef3e..fcb89420 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8834,6 +8834,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 @@ -8847,8 +8851,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); @@ -8865,17 +8871,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 26b4e7701d83428154535a1a02c0114fa4383b07 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:05:58 -0700 Subject: [PATCH 56/61] 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 fcb89420..f4d26810 100644 --- a/src/internal.c +++ b/src/internal.c @@ -3228,7 +3228,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; } @@ -12292,6 +12292,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 39cccd1ae8c5edfc3345ff01b7f226a9edd2344e Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:19:14 -0700 Subject: [PATCH 57/61] 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 f4d26810..fd45e049 100644 --- a/src/internal.c +++ b/src/internal.c @@ -2166,6 +2166,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); } @@ -11799,6 +11803,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 @@ -11890,13 +11897,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; @@ -11905,21 +11915,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 25a941571adc8adff3df03f72ede653dd70ca895 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:24:42 -0700 Subject: [PATCH 58/61] 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 fd45e049..0eeeaea0 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8126,7 +8126,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 ea58fe1b944daa93de2f013808adcc00b0e0c3aa Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:36:19 -0700 Subject: [PATCH 59/61] 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 0eeeaea0..84492598 100644 --- a/src/internal.c +++ b/src/internal.c @@ -8390,9 +8390,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 6b08c14dc8a1acaa44438f96432bcc75d037a4df Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 15:44:20 -0700 Subject: [PATCH 60/61] 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 | 30 ++-- tests/pkcs11mtt.c | 3 +- tests/token_store_test.c | 137 ++++++++++++++++- wolfpkcs11/internal.h | 3 + 10 files changed, 321 insertions(+), 68 deletions(-) diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml index 505a9a49..19df9f9c 100644 --- a/.github/workflows/unit-test.yml +++ b/.github/workflows/unit-test.yml @@ -21,6 +21,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 no_rsa: 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 84492598..42be3dbc 100644 --- a/src/internal.c +++ b/src/internal.c @@ -166,7 +166,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; @@ -648,7 +653,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 @@ -668,7 +673,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 @@ -683,7 +688,7 @@ static wolfSSL_Mutex storeDirLock #endif -#ifndef SINGLE_THREADED +#ifndef WP11_NO_LOCKING /** * Initialize a lock. * @@ -1134,6 +1139,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 */ @@ -2202,9 +2211,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"; @@ -2223,7 +2230,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; @@ -2234,39 +2240,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) { @@ -2396,6 +2389,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. @@ -2410,6 +2480,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 @@ -2419,9 +2490,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; @@ -2580,11 +2659,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) { @@ -2735,6 +2819,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. * @@ -2749,6 +2851,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 3f132961..c462c1dc 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 @@ -1160,29 +1164,29 @@ 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 +#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 d32d1750..62e71c91 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 3a980bed..d79b2b69 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) @@ -801,6 +814,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) { @@ -811,6 +936,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(); test_token_record_kept_on_failed_store(); @@ -827,6 +953,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; } @@ -856,7 +986,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 44d9db07..410f96c7 100644 --- a/wolfpkcs11/internal.h +++ b/wolfpkcs11/internal.h @@ -440,6 +440,9 @@ WP11_API void WP11_Object_SetFindHook(void (*hook)(void)); #define WP11_TEST_STORE_EXIT_CODE 75 WP11_API void WP11_Test_StoreExitAfterRenames(int renames); #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 eb5cd91c5f5058a192058567a83291b809d20ae8 Mon Sep 17 00:00:00 2001 From: Aidan Garske Date: Tue, 6 Oct 2026 12:43:50 -0700 Subject: [PATCH 61/61] 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 42be3dbc..95417745 100644 --- a/src/internal.c +++ b/src/internal.c @@ -1219,6 +1219,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; @@ -1234,9 +1240,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;