Skip to content

Commit a00d998

Browse files
author
Antoine Lochet
committed
Fix issue 655 by supporting encryption for END_DATE and START_DATE for private keys
1 parent 28c67fe commit a00d998

File tree

5 files changed

+210
-4
lines changed

5 files changed

+210
-4
lines changed

‎src/lib/P11Attributes.cpp‎

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1164,7 +1164,7 @@ bool P11AttrStartDate::setDefault()
11641164
}
11651165

11661166
// Update the value if allowed
1167-
CK_RV P11AttrStartDate::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
1167+
CK_RV P11AttrStartDate::updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op)
11681168
{
11691169
// Attribute specific checks
11701170

@@ -1173,8 +1173,35 @@ CK_RV P11AttrStartDate::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID
11731173
return CKR_ATTRIBUTE_VALUE_INVALID;
11741174
}
11751175

1176+
ByteString plaintext((unsigned char*)pValue, ulValueLen);
1177+
ByteString value;
1178+
1179+
// Encrypt if private
1180+
1181+
if (isPrivate)
1182+
{
1183+
if (!token->encrypt(plaintext, value))
1184+
return CKR_GENERAL_ERROR;
1185+
}
1186+
else
1187+
value = plaintext;
1188+
1189+
// Attribute specific checks
1190+
1191+
if (value.size() < ulValueLen)
1192+
return CKR_GENERAL_ERROR;
1193+
11761194
// Store data
1177-
osobject->setAttribute(type, ByteString((unsigned char*)pValue, ulValueLen));
1195+
1196+
osobject->setAttribute(type, value);
1197+
1198+
// Set the CKA_START_DATE during C_CreateObject
1199+
1200+
if (op == OBJECT_OP_CREATE && osobject->attributeExists(CKA_START_DATE))
1201+
{
1202+
OSAttribute osAttribute(value);
1203+
osobject->setAttribute(CKA_START_DATE, osAttribute);
1204+
}
11781205

11791206
return CKR_OK;
11801207
}
@@ -1191,7 +1218,7 @@ bool P11AttrEndDate::setDefault()
11911218
}
11921219

11931220
// Update the value if allowed
1194-
CK_RV P11AttrEndDate::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
1221+
CK_RV P11AttrEndDate::updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op)
11951222
{
11961223
// Attribute specific checks
11971224

@@ -1200,8 +1227,35 @@ CK_RV P11AttrEndDate::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_P
12001227
return CKR_ATTRIBUTE_VALUE_INVALID;
12011228
}
12021229

1230+
ByteString plaintext((unsigned char*)pValue, ulValueLen);
1231+
ByteString value;
1232+
1233+
// Encrypt if private
1234+
1235+
if (isPrivate)
1236+
{
1237+
if (!token->encrypt(plaintext, value))
1238+
return CKR_GENERAL_ERROR;
1239+
}
1240+
else
1241+
value = plaintext;
1242+
1243+
// Attribute specific checks
1244+
1245+
if (value.size() < ulValueLen)
1246+
return CKR_GENERAL_ERROR;
1247+
12031248
// Store data
1204-
osobject->setAttribute(type, ByteString((unsigned char*)pValue, ulValueLen));
1249+
1250+
osobject->setAttribute(type, value);
1251+
1252+
// Set the CKA_END_DATE during C_CreateObject
1253+
1254+
if (op == OBJECT_OP_CREATE && osobject->attributeExists(CKA_END_DATE))
1255+
{
1256+
OSAttribute osAttribute(value);
1257+
osobject->setAttribute(CKA_END_DATE, osAttribute);
1258+
}
12051259

12061260
return CKR_OK;
12071261
}

‎src/lib/P11Objects.cpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ CK_RV P11Object::loadTemplate(Token *token, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG
158158
}
159159

160160
// case 1,3,4 and 5 of the attribute checks are done while retrieving the attribute itself.
161+
DEBUG_MSG("Attribute 0x%lx = (%p) @ %d", pTemplate[i].type, pTemplate[i].pValue, i);
161162
CK_RV retrieve_rv = attr->retrieve(token, isPrivate, pTemplate[i].pValue, &pTemplate[i].ulValueLen);
162163
if (retrieve_rv == CKR_ATTRIBUTE_SENSITIVE) {
163164
// If case 1 applies to any of the requested attributes, then the call should
@@ -168,6 +169,7 @@ CK_RV P11Object::loadTemplate(Token *token, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG
168169
// return the value CKR_BUFFER_TOO_SMALL.
169170
buffer_too_small = true;
170171
} else if (retrieve_rv != CKR_OK) {
172+
ERROR_MSG("Could not update Attribute in loadTemplate 0x%lx = (%x) @ %d", pTemplate[i].type, pTemplate[i].pValue, i);
171173
return CKR_GENERAL_ERROR;
172174
}
173175

@@ -231,9 +233,11 @@ CK_RV P11Object::saveTemplate(Token *token, bool isPrivate, CK_ATTRIBUTE_PTR pTe
231233
}
232234

233235
// Additonal checks are done while updating the attributes themselves.
236+
DEBUG_MSG("Attribute 0x%lx = (%x)", pTemplate[i].type, pTemplate[i].pValue);
234237
CK_RV rv = attr->update(token,isPrivate, pTemplate[i].pValue, pTemplate[i].ulValueLen, op);
235238
if (rv != CKR_OK)
236239
{
240+
ERROR_MSG("Could not update Attribute in saveTemplate 0x%lx = (%x) @ %d", pTemplate[i].type, pTemplate[i].pValue, i);
237241
osobject->abortTransaction();
238242
return rv;
239243
}

‎src/lib/data_mgr/SecureDataManager.cpp‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,7 @@ void SecureDataManager::logout()
397397
// Decrypt the supplied data
398398
bool SecureDataManager::decrypt(const ByteString& encrypted, ByteString& plaintext)
399399
{
400+
DEBUG_MSG("encrypted %s", encrypted.const_byte_str());
400401
// Check the object logged in state
401402
if ((!userLoggedIn && !soLoggedIn) || (maskedKey.size() != 32))
402403
{
@@ -424,6 +425,7 @@ bool SecureDataManager::decrypt(const ByteString& encrypted, ByteString& plainte
424425
}
425426

426427
// Take the IV from the input data
428+
DEBUG_MSG("AES block size %d", aes->getBlockSize());
427429
ByteString IV = encrypted.substr(0, aes->getBlockSize());
428430

429431
if (IV.size() != aes->getBlockSize())
@@ -433,17 +435,22 @@ bool SecureDataManager::decrypt(const ByteString& encrypted, ByteString& plainte
433435
return false;
434436
}
435437

438+
DEBUG_MSG("IV %s", IV.const_byte_str());
439+
436440
ByteString finalBlock;
437441

438442
if (!aes->decryptInit(&theKey, SymMode::CBC, IV) ||
439443
!aes->decryptUpdate(encrypted.substr(aes->getBlockSize()), plaintext) ||
440444
!aes->decryptFinal(finalBlock))
441445
{
446+
ERROR_MSG("Error when decrypting data");
442447
return false;
443448
}
444449

445450
plaintext += finalBlock;
446451

452+
DEBUG_MSG("plaintext %s", plaintext.const_byte_str());
453+
447454
return true;
448455
}
449456

‎src/lib/test/ObjectTests.cpp‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1724,6 +1724,69 @@ void ObjectTests::testDefaultRSAPubAttributes()
17241724
checkCommonRSAPublicKeyAttributes(hSession, hObject, pN, sizeof(pN), 512, pE, sizeof(pE));
17251725
}
17261726

1727+
void ObjectTests::testDefaultRSAPubAttributesWithDates()
1728+
{
1729+
CK_RV rv;
1730+
CK_SESSION_HANDLE hSession;
1731+
CK_OBJECT_HANDLE hObject = CK_INVALID_HANDLE;
1732+
1733+
// Minimal RSA public key object
1734+
CK_OBJECT_CLASS objClass = CKO_PUBLIC_KEY;
1735+
CK_KEY_TYPE objType = CKK_RSA;
1736+
CK_BYTE pN[] = { 0xC6, 0x47, 0xDD, 0x74, 0x3B, 0xCB, 0xDC, 0x6F, 0xCE, 0xA7,
1737+
0xF0, 0x5F, 0x29, 0x4B, 0x27, 0x00, 0xCC, 0x92, 0xE9, 0x20,
1738+
0x8A, 0x2C, 0x87, 0x36, 0x47, 0x24, 0xB0, 0xD5, 0x7D, 0xB0,
1739+
0x92, 0x01, 0xA0, 0xA3, 0x55, 0x2E, 0x3F, 0xFE, 0xA7, 0x4C,
1740+
0x4B, 0x3F, 0x9D, 0x4E, 0xCB, 0x78, 0x12, 0xA9, 0x42, 0xAD,
1741+
0x51, 0x1F, 0x3B, 0xBD, 0x3D, 0x6A, 0xE5, 0x38, 0xB7, 0x45,
1742+
0x65, 0x50, 0x30, 0x35 };
1743+
CK_BYTE pE[] = { 0x01, 0x00, 0x01 };
1744+
CK_DATE startDate = {
1745+
{'2', '0', '2', '2'},
1746+
{'0', '1'},
1747+
{'0', '1'}
1748+
};
1749+
CK_DATE endDate = {
1750+
{'3', '9', '9', '9'},
1751+
{'1', '2'},
1752+
{'3', '1'}
1753+
};
1754+
CK_ATTRIBUTE objTemplate[] = {
1755+
{ CKA_CLASS, &objClass, sizeof(objClass) },
1756+
{ CKA_KEY_TYPE, &objType, sizeof(objType) },
1757+
{ CKA_MODULUS, pN, sizeof(pN) },
1758+
{ CKA_PUBLIC_EXPONENT, pE, sizeof(pE) },
1759+
{ CKA_START_DATE, &startDate, sizeof(startDate) },
1760+
{ CKA_END_DATE, &endDate, sizeof(endDate) }
1761+
};
1762+
1763+
// Just make sure that we finalize any previous tests
1764+
CRYPTOKI_F_PTR( C_Finalize(NULL_PTR) );
1765+
1766+
// Initialize the library and start the test.
1767+
rv = CRYPTOKI_F_PTR( C_Initialize(NULL_PTR) );
1768+
CPPUNIT_ASSERT(rv == CKR_OK);
1769+
1770+
// Open read-write session
1771+
rv = CRYPTOKI_F_PTR( C_OpenSession(m_initializedTokenSlotID, CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL_PTR, NULL_PTR, &hSession) );
1772+
CPPUNIT_ASSERT(rv == CKR_OK);
1773+
1774+
// Login USER into the sessions so we can create a private objects
1775+
rv = CRYPTOKI_F_PTR( C_Login(hSession, CKU_USER, m_userPin1, m_userPin1Length) );
1776+
CPPUNIT_ASSERT(rv == CKR_OK);
1777+
1778+
// Create minimal RSA public key object
1779+
rv = CRYPTOKI_F_PTR( C_CreateObject(hSession, objTemplate, sizeof(objTemplate)/sizeof(CK_ATTRIBUTE), &hObject) );
1780+
CPPUNIT_ASSERT(rv == CKR_OK);
1781+
1782+
// Check attributes in RSA public key object
1783+
checkCommonObjectAttributes(hSession, hObject, objClass);
1784+
checkCommonStorageObjectAttributes(hSession, hObject, CK_FALSE, CK_FALSE, CK_TRUE, NULL_PTR, 0, CK_TRUE, CK_TRUE);
1785+
checkCommonKeyAttributes(hSession, hObject, objType, NULL_PTR, 0, startDate, sizeof(&startDate), endDate, sizeof(&endDate), CK_FALSE, CK_FALSE, CK_UNAVAILABLE_INFORMATION, NULL_PTR, 0);
1786+
checkCommonPublicKeyAttributes(hSession, hObject, NULL_PTR, 0, CK_TRUE, CK_TRUE, CK_TRUE, CK_TRUE, CK_FALSE, NULL_PTR, 0);
1787+
checkCommonRSAPublicKeyAttributes(hSession, hObject, pN, sizeof(pN), 512, pE, sizeof(pE));
1788+
}
1789+
17271790
void ObjectTests::testDefaultRSAPrivAttributes()
17281791
{
17291792
CK_RV rv;
@@ -1788,6 +1851,80 @@ void ObjectTests::testDefaultRSAPrivAttributes()
17881851
checkCommonRSAPrivateKeyAttributes(hSession, hObject, pN, sizeof(pN), NULL_PTR, 0, pD, sizeof(pD), NULL_PTR, 0, NULL_PTR, 0, NULL_PTR, 0, NULL_PTR, 0, NULL_PTR, 0);
17891852
}
17901853

1854+
void ObjectTests::testDefaultRSAPrivAttributesWithDates()
1855+
{
1856+
CK_RV rv;
1857+
CK_SESSION_HANDLE hSession;
1858+
CK_OBJECT_HANDLE hObject = CK_INVALID_HANDLE;
1859+
1860+
// Minimal RSA private key object
1861+
CK_OBJECT_CLASS objClass = CKO_PRIVATE_KEY;
1862+
CK_KEY_TYPE objType = CKK_RSA;
1863+
CK_BBOOL bTrue = CK_TRUE;
1864+
CK_BBOOL bFalse = CK_FALSE;
1865+
CK_BYTE pN[] = { 0xC6, 0x47, 0xDD, 0x74, 0x3B, 0xCB, 0xDC, 0x6F, 0xCE, 0xA7,
1866+
0xF0, 0x5F, 0x29, 0x4B, 0x27, 0x00, 0xCC, 0x92, 0xE9, 0x20,
1867+
0x8A, 0x2C, 0x87, 0x36, 0x47, 0x24, 0xB0, 0xD5, 0x7D, 0xB0,
1868+
0x92, 0x01, 0xA0, 0xA3, 0x55, 0x2E, 0x3F, 0xFE, 0xA7, 0x4C,
1869+
0x4B, 0x3F, 0x9D, 0x4E, 0xCB, 0x78, 0x12, 0xA9, 0x42, 0xAD,
1870+
0x51, 0x1F, 0x3B, 0xBD, 0x3D, 0x6A, 0xE5, 0x38, 0xB7, 0x45,
1871+
0x65, 0x50, 0x30, 0x35 };
1872+
CK_BYTE pD[] = { 0x6D, 0x94, 0x6B, 0xEB, 0xFF, 0xDC, 0x03, 0x80, 0x7B, 0x0A,
1873+
0x4F, 0x0A, 0x98, 0x6C, 0xA3, 0x2A, 0x8A, 0xE4, 0xAA, 0x18,
1874+
0x44, 0xA4, 0xA5, 0x39, 0x37, 0x0A, 0x2C, 0xFC, 0x5F, 0xD1,
1875+
0x44, 0x6E, 0xCE, 0x25, 0x9B, 0xE5, 0xD1, 0x51, 0xAF, 0xA8,
1876+
0x30, 0xD1, 0x4D, 0x3C, 0x60, 0x33, 0xB5, 0xED, 0x4C, 0x39,
1877+
0xDA, 0x68, 0x78, 0xF9, 0x6B, 0x4F, 0x47, 0x55, 0xB2, 0x02,
1878+
0x00, 0x7E, 0x9C, 0x05 };
1879+
CK_DATE startDate = {
1880+
{'2', '0', '2', '2'},
1881+
{'0', '1'},
1882+
{'0', '1'}
1883+
};
1884+
CK_DATE endDate = {
1885+
{'3', '9', '9', '9'},
1886+
{'1', '2'},
1887+
{'3', '1'}
1888+
};
1889+
// Make the key non-sensitive and extractable so that we can test it.
1890+
CK_ATTRIBUTE objTemplate[] = {
1891+
{ CKA_CLASS, &objClass, sizeof(objClass) },
1892+
{ CKA_KEY_TYPE, &objType, sizeof(objType) },
1893+
{ CKA_SENSITIVE, &bFalse, sizeof(bFalse) },
1894+
{ CKA_EXTRACTABLE, &bTrue, sizeof(bTrue) },
1895+
{ CKA_MODULUS, pN, sizeof(pN) },
1896+
{ CKA_PRIVATE_EXPONENT, pD, sizeof(pD) },
1897+
{ CKA_START_DATE, &startDate, sizeof(startDate) },
1898+
{ CKA_END_DATE, &endDate, sizeof(endDate) }
1899+
};
1900+
1901+
// Just make sure that we finalize any previous tests
1902+
CRYPTOKI_F_PTR( C_Finalize(NULL_PTR) );
1903+
1904+
// Initialize the library and start the test.
1905+
rv = CRYPTOKI_F_PTR( C_Initialize(NULL_PTR) );
1906+
CPPUNIT_ASSERT(rv == CKR_OK);
1907+
1908+
// Open read-write session
1909+
rv = CRYPTOKI_F_PTR( C_OpenSession(m_initializedTokenSlotID, CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL_PTR, NULL_PTR, &hSession) );
1910+
CPPUNIT_ASSERT(rv == CKR_OK);
1911+
1912+
// Login USER into the sessions so we can create a private objects
1913+
rv = CRYPTOKI_F_PTR( C_Login(hSession, CKU_USER, m_userPin1, m_userPin1Length) );
1914+
CPPUNIT_ASSERT(rv == CKR_OK);
1915+
1916+
// Create minimal RSA public key object
1917+
rv = CRYPTOKI_F_PTR( C_CreateObject(hSession, objTemplate, sizeof(objTemplate)/sizeof(CK_ATTRIBUTE), &hObject) );
1918+
CPPUNIT_ASSERT(rv == CKR_OK);
1919+
1920+
// Check attributes in RSA public key object
1921+
checkCommonObjectAttributes(hSession, hObject, objClass);
1922+
checkCommonStorageObjectAttributes(hSession, hObject, CK_FALSE, CK_TRUE, CK_TRUE, NULL_PTR, 0, CK_TRUE, CK_TRUE);
1923+
checkCommonKeyAttributes(hSession, hObject, objType, NULL_PTR, 0, startDate, sizeof(&startDate), endDate, sizeof(&endDate), CK_FALSE, CK_FALSE, CK_UNAVAILABLE_INFORMATION, NULL_PTR, 0);
1924+
checkCommonPrivateKeyAttributes(hSession, hObject, NULL_PTR, 0, CK_FALSE, CK_TRUE, CK_TRUE, CK_TRUE, CK_TRUE, CK_TRUE, CK_FALSE, CK_FALSE, CK_FALSE, NULL_PTR, 0, CK_FALSE);
1925+
checkCommonRSAPrivateKeyAttributes(hSession, hObject, pN, sizeof(pN), NULL_PTR, 0, pD, sizeof(pD), NULL_PTR, 0, NULL_PTR, 0, NULL_PTR, 0, NULL_PTR, 0, NULL_PTR, 0);
1926+
}
1927+
17911928
void ObjectTests::testAlwaysNeverAttribute()
17921929
{
17931930
CK_RV rv;

‎src/lib/test/ObjectTests.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ class ObjectTests : public TestsBase
6161
CPPUNIT_TEST(testReAuthentication);
6262
CPPUNIT_TEST(testTemplateAttribute);
6363
CPPUNIT_TEST(testCreateSecretKey);
64+
CPPUNIT_TEST(testDefaultRSAPubAttributesWithDates);
65+
CPPUNIT_TEST(testDefaultRSAPrivAttributesWithDates);
6466
CPPUNIT_TEST_SUITE_END();
6567

6668
public:
@@ -84,6 +86,8 @@ class ObjectTests : public TestsBase
8486
void testAllowedMechanisms();
8587
void testTemplateAttribute();
8688
void testCreateSecretKey();
89+
void testDefaultRSAPubAttributesWithDates();
90+
void testDefaultRSAPrivAttributesWithDates();
8791

8892
protected:
8993
void checkCommonObjectAttributes

0 commit comments

Comments
 (0)