Skip to content

Fix CKA_NEVER_EXTRACTABLE of keys derived with CKM_CONCATENATE_BASE_AND_KEY #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juvex-fi wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix CKA_NEVER_EXTRACTABLE of keys derived with CKM_CONCATENATE_BASE_AND_KEY #905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e60fbfc
Fix CKA_NEVER_EXTRACTABLE of keys derived with CKM_CONCATENATE_BASE_A…
juvex-fi Sep 28, 2026
e597425
Test CKA_ALWAYS_SENSITIVE of a key derived from a non-sensitive key
juvex-fi Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/lib/SoftHSM.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14224,7 +14224,7 @@ CK_RV SoftHSM::deriveSymmetric
// attributes set to CK_TRUE
bool bNeverExtractable = baseKey->getBooleanValue(CKA_NEVER_EXTRACTABLE, false) &&
otherKey->getBooleanValue(CKA_NEVER_EXTRACTABLE, false);
bOK = bOK && osobject->setAttribute(CKA_ALWAYS_SENSITIVE, bNeverExtractable);
bOK = bOK && osobject->setAttribute(CKA_NEVER_EXTRACTABLE, bNeverExtractable);
}
else if (pMechanism->mechanism == CKM_CONCATENATE_BASE_AND_DATA ||
pMechanism->mechanism == CKM_CONCATENATE_DATA_AND_BASE)
Expand Down
64 changes: 64 additions & 0 deletions src/lib/test/DeriveTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1102,6 +1102,70 @@ void DeriveTests::testMiscDerivations() {
ASSERT_KEY_IS_NOT_EXTRACTABLE("Derived key should be extractable if base key is extractable", hDerive);
ASSERT_KEY_IS_SENSITIVE("Derived key should be sensitive if one of the keys is sensitive", hDerive);

// CKA_ALWAYS_SENSITIVE and CKA_NEVER_EXTRACTABLE are set only on generated keys
CK_MECHANISM genMechanism = { CKM_AES_KEY_GEN, NULL_PTR, 0 };
CK_ULONG genBytes = 16;
CK_ATTRIBUTE genAttribs[] = {
{ CKA_TOKEN, &bFalse, sizeof(bFalse) },
{ CKA_PRIVATE, &bFalse, sizeof(bFalse) },
{ CKA_SENSITIVE, &bTrue, sizeof(bTrue) },
{ CKA_EXTRACTABLE, &bFalse, sizeof(bFalse) },
{ CKA_DERIVE, &bTrue, sizeof(bTrue) },
{ CKA_VALUE_LEN, &genBytes, sizeof(genBytes) }
};
CK_OBJECT_HANDLE hNeverExtractable1 = CK_INVALID_HANDLE;
CK_OBJECT_HANDLE hNeverExtractable2 = CK_INVALID_HANDLE;
CK_OBJECT_HANDLE hExtractable = CK_INVALID_HANDLE;
rv = CRYPTOKI_F_PTR( C_GenerateKey(hSessionRW, &genMechanism, genAttribs, sizeof(genAttribs)/sizeof(CK_ATTRIBUTE), &hNeverExtractable1) );
CPPUNIT_ASSERT(rv == CKR_OK);
rv = CRYPTOKI_F_PTR( C_GenerateKey(hSessionRW, &genMechanism, genAttribs, sizeof(genAttribs)/sizeof(CK_ATTRIBUTE), &hNeverExtractable2) );
CPPUNIT_ASSERT(rv == CKR_OK);
genAttribs[3].pValue = &bTrue;
rv = CRYPTOKI_F_PTR( C_GenerateKey(hSessionRW, &genMechanism, genAttribs, sizeof(genAttribs)/sizeof(CK_ATTRIBUTE), &hExtractable) );
CPPUNIT_ASSERT(rv == CKR_OK);

CK_BBOOL bAlwaysSensitive;
CK_BBOOL bNeverExtractable;
CK_ATTRIBUTE derivedAttribs[] = {
{ CKA_ALWAYS_SENSITIVE, &bAlwaysSensitive, sizeof(bAlwaysSensitive) },
{ CKA_NEVER_EXTRACTABLE, &bNeverExtractable, sizeof(bNeverExtractable) }
};

// Both keys are always sensitive and never extractable, so is the derived key
mechanism.pParameter = &hNeverExtractable2;
rv = CRYPTOKI_F_PTR( C_DeriveKey(hSessionRW, &mechanism, hNeverExtractable1,
keyAttribs, 1, &hDerive) );
CPPUNIT_ASSERT(rv == CKR_OK);
rv = CRYPTOKI_F_PTR( C_GetAttributeValue(hSessionRW, hDerive, derivedAttribs, sizeof(derivedAttribs)/sizeof(CK_ATTRIBUTE)) );
CPPUNIT_ASSERT(rv == CKR_OK);
CPPUNIT_ASSERT_MESSAGE("Derived key should be always sensitive if both keys are", bAlwaysSensitive == CK_TRUE);
CPPUNIT_ASSERT_MESSAGE("Derived key should be never extractable if both keys are", bNeverExtractable == CK_TRUE);

// The other key has been extractable, so the derived key is not never extractable
mechanism.pParameter = &hExtractable;
rv = CRYPTOKI_F_PTR( C_DeriveKey(hSessionRW, &mechanism, hNeverExtractable1,
keyAttribs, 1, &hDerive) );
CPPUNIT_ASSERT(rv == CKR_OK);
rv = CRYPTOKI_F_PTR( C_GetAttributeValue(hSessionRW, hDerive, derivedAttribs, sizeof(derivedAttribs)/sizeof(CK_ATTRIBUTE)) );
CPPUNIT_ASSERT(rv == CKR_OK);
CPPUNIT_ASSERT_MESSAGE("Derived key should be always sensitive if both keys are", bAlwaysSensitive == CK_TRUE);
CPPUNIT_ASSERT_MESSAGE("Derived key should not be never extractable if one key is not", bNeverExtractable == CK_FALSE);

// The other key has not been sensitive, so the derived key is not always sensitive
CK_OBJECT_HANDLE hNotSensitive = CK_INVALID_HANDLE;
genAttribs[2].pValue = &bFalse;
genAttribs[3].pValue = &bFalse;
rv = CRYPTOKI_F_PTR( C_GenerateKey(hSessionRW, &genMechanism, genAttribs, sizeof(genAttribs)/sizeof(CK_ATTRIBUTE), &hNotSensitive) );
CPPUNIT_ASSERT(rv == CKR_OK);
mechanism.pParameter = &hNotSensitive;
rv = CRYPTOKI_F_PTR( C_DeriveKey(hSessionRW, &mechanism, hNeverExtractable1,
keyAttribs, 1, &hDerive) );
CPPUNIT_ASSERT(rv == CKR_OK);
rv = CRYPTOKI_F_PTR( C_GetAttributeValue(hSessionRW, hDerive, derivedAttribs, sizeof(derivedAttribs)/sizeof(CK_ATTRIBUTE)) );
CPPUNIT_ASSERT(rv == CKR_OK);
CPPUNIT_ASSERT_MESSAGE("Derived key should not be always sensitive if one key is not", bAlwaysSensitive == CK_FALSE);
CPPUNIT_ASSERT_MESSAGE("Derived key should be never extractable if both keys are", bNeverExtractable == CK_TRUE);

#undef ASSERT_KEY_IS_NOT_EXTRACTABLE
#undef ASSERT_KEY_IS_EXTRACTABLE
}
Expand Down
7 changes: 4 additions & 3 deletions src/lib/test/SymmetricAlgorithmTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1291,15 +1291,16 @@ void SymmetricAlgorithmTests::aesWrapUnwrapNonModifiableGeneric(CK_MECHANISM_TYP
CPPUNIT_ASSERT(rv == CKR_OK);
CPPUNIT_ASSERT(hNew != CK_INVALID_HANDLE);

CK_BBOOL bModifiable = CK_TRUE;
CK_ATTRIBUTE modifiableAttribs[] = {
{ CKA_MODIFIABLE, &bFalse, sizeof(bFalse) }
{ CKA_MODIFIABLE, &bModifiable, sizeof(bModifiable) }
};

rv = CRYPTOKI_F_PTR( C_GetAttributeValue(hSession, hNew, modifiableAttribs, sizeof(modifiableAttribs)/sizeof(CK_ATTRIBUTE)) );
CPPUNIT_ASSERT(rv == CKR_OK);

CPPUNIT_ASSERT(modifiableAttribs[0].ulValueLen == sizeof(bFalse));
CPPUNIT_ASSERT(*(CK_BBOOL*)modifiableAttribs[0].pValue == bFalse);
CPPUNIT_ASSERT(modifiableAttribs[0].ulValueLen == sizeof(bModifiable));
CPPUNIT_ASSERT(bModifiable == CK_FALSE);

free(wrappedPtr);
wrappedPtr = NULL_PTR;
Expand Down