2 * Copyright (c) 2014-2021 Samsung Electronics Co., Ltd. All rights reserved
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License
18 * @author Bartlomiej Grzelewski (b.grzelewski@samsung.com)
20 * @brief Sample service implementation.
22 #include <dpl/serialization.h>
23 #include <dpl/log/log.h>
24 #include <ckm/ckm-error.h>
25 #include <ckm/ckm-type.h>
26 #include <key-provider.h>
27 #include <file-system.h>
28 #include <ckm-logic.h>
30 #include <key-aes-impl.h>
31 #include <certificate-config.h>
32 #include <certificate-store.h>
34 #include <sw-backend/store.h>
35 #include <generic-backend/exception.h>
36 #include <ss-migrate.h>
39 const char *const CERT_SYSTEM_DIR = CA_CERTS_DIR;
40 const char *const DEFAULT_UNLOCK_STRING = "cAtRugU7";
42 bool isClientValid(const CKM::ClientId &client)
44 if (client.find(CKM::ALIAS_SEPARATOR) != CKM::ClientId::npos)
50 bool isNameValid(const CKM::Name &name)
52 if (name.find(CKM::ALIAS_SEPARATOR) != CKM::Name::npos)
58 // keypair data type, having private key data type and public key data type
59 // private is assumed to be .first, public .second
60 using DataTypePair = std::pair<CKM::DataType, CKM::DataType>;
62 const std::map<CKM::AlgoType, DataTypePair> ALGO_TYPE_TO_DATA_TYPE_PAIR_MAP = {
63 { CKM::AlgoType::RSA_GEN, { CKM::DataType(CKM::KeyType::KEY_RSA_PRIVATE), CKM::DataType(CKM::KeyType::KEY_RSA_PUBLIC) } },
64 { CKM::AlgoType::DSA_GEN, { CKM::DataType(CKM::KeyType::KEY_DSA_PRIVATE), CKM::DataType(CKM::KeyType::KEY_DSA_PUBLIC) } },
65 { CKM::AlgoType::ECDSA_GEN, { CKM::DataType(CKM::KeyType::KEY_ECDSA_PRIVATE), CKM::DataType(CKM::KeyType::KEY_ECDSA_PUBLIC) } },
68 } // anonymous namespace
74 template <int ERROR_ON_CKM_EXCEPTION = CKM_API_ERROR_SERVER_ERROR, class F>
78 static_assert(std::is_same_v<decltype(std::forward<F>(f)()), int>);
79 return std::forward<F>(f)();
80 } catch (const Exc::Exception &e) {
82 } catch (const CKM::Exception &e) {
83 LogError("CKM::Exception: " << e.GetMessage());
84 return ERROR_ON_CKM_EXCEPTION;
88 int toBinaryData(const Crypto::Data &input, Crypto::Data &output)
90 // verify the data integrity
91 if (input.type.isKey()) {
94 if (input.type.isSKey())
95 output_key = CKM::Key::createAES(input.data);
97 output_key = CKM::Key::create(input.data);
99 if (output_key.get() == NULL) {
100 LogDebug("provided binary data is not valid key data");
101 return CKM_API_ERROR_INPUT_PARAM;
104 output = Crypto::Data(input.type, output_key->getDER());
105 } else if (input.type.isCertificate() || input.type.isChainCert()) {
106 CertificateShPtr cert = CKM::Certificate::create(input.data, DataFormat::FORM_DER);
108 if (cert.get() == NULL) {
109 LogDebug("provided binary data is not valid certificate data");
110 return CKM_API_ERROR_INPUT_PARAM;
113 output = Crypto::Data(input.type, cert->getDER());
118 // TODO: add here BINARY_DATA verification, i.e: max size etc.
119 return CKM_API_SUCCESS;
122 int verifyBinaryData(const Crypto::Data &input)
125 return toBinaryData(input, dummy);
128 int readSingleRow(const Name &name,
129 const ClientId &owner,
131 DB::Crypto &database,
134 DB::Crypto::RowOptional row_optional;
136 if (dataType.isKey()) {
137 // read all key types
138 row_optional = database.getRow(name,
140 DataType::DB_KEY_FIRST,
141 DataType::DB_KEY_LAST);
143 // read anything else
144 row_optional = database.getRow(name,
150 LogDebug("No row for given name, owner and type");
151 return CKM_API_ERROR_DB_ALIAS_UNKNOWN;
156 return CKM_API_SUCCESS;
159 int readMultiRow(const Name &name,
160 const ClientId &owner,
162 DB::Crypto &database,
163 DB::RowVector &output)
165 if (dataType.isKey())
166 // read all key types
167 database.getRows(name,
169 DataType::DB_KEY_FIRST,
170 DataType::DB_KEY_LAST,
172 else if (dataType.isChainCert())
173 // read all key types
174 database.getRows(name,
176 DataType::DB_CHAIN_FIRST,
177 DataType::DB_CHAIN_LAST,
180 // read anything else
181 database.getRows(name,
186 if (!output.size()) {
187 LogDebug("No row for given name, owner and type");
188 return CKM_API_ERROR_DB_ALIAS_UNKNOWN;
191 return CKM_API_SUCCESS;
196 const uid_t CKMLogic::SYSTEM_DB_UID = 0;
197 const uid_t CKMLogic::ADMIN_USER_DB_UID = 5001;
201 CertificateConfig::addSystemCertificateDir(CERT_SYSTEM_DIR);
203 m_accessControl.updateCCMode();
206 CKMLogic::~CKMLogic() {}
208 void CKMLogic::loadDKEKFile(uid_t user, const Password &password)
210 auto &handle = m_userDataMap[user];
214 auto wrappedDKEK = fs.getDKEK();
216 if (wrappedDKEK.empty()) {
217 wrappedDKEK = KeyProvider::generateDomainKEK(std::to_string(user), password);
218 fs.saveDKEK(wrappedDKEK);
221 handle.keyProvider = KeyProvider(wrappedDKEK, password);
222 if (!handle.keyProvider.isInitialized()) {
223 handle.keyProvider.migrateDomainKEK(wrappedDKEK, password);
224 fs.saveDKEK(handle.keyProvider.getWrappedDomainKEK(password));
225 LogInfo("DKEK migrated");
229 void CKMLogic::saveDKEKFile(uid_t user, const Password &password)
231 auto &handle = m_userDataMap[user];
234 fs.saveDKEK(handle.keyProvider.getWrappedDomainKEK(password));
237 void CKMLogic::migrateSecureStorageData(bool isAdminUser)
239 SsMigration::migrate(isAdminUser, [this](const std::string &name,
240 const Crypto::Data &data,
241 bool adminUserFlag) {
242 LogInfo("Migrate data called with name: " << name);
243 auto ownerId = adminUserFlag ? CLIENT_ID_ADMIN_USER : CLIENT_ID_SYSTEM;
244 auto uid = adminUserFlag ? ADMIN_USER_DB_UID : SYSTEM_DB_UID;
246 int ret = verifyAndSaveDataHelper(Credentials(uid, ownerId), name, ownerId, data,
247 PolicySerializable());
249 if (ret == CKM_API_ERROR_DB_ALIAS_EXISTS)
250 LogWarning("Alias already exist for migrated name: " << name);
251 else if (ret != CKM_API_SUCCESS)
252 LogError("Failed to migrate secure-storage data. name: " << name <<
257 int CKMLogic::unlockDatabase(uid_t user, const Password &password)
259 if (0 < m_userDataMap.count(user) &&
260 m_userDataMap[user].keyProvider.isInitialized())
261 return CKM_API_SUCCESS;
263 int retCode = tryRet([&] {
264 auto &handle = m_userDataMap[user];
267 loadDKEKFile(user, password);
269 auto wrappedDatabaseDEK = fs.getDBDEK();
271 if (wrappedDatabaseDEK.empty()) {
272 wrappedDatabaseDEK = handle.keyProvider.generateDEK(std::to_string(user));
273 fs.saveDBDEK(wrappedDatabaseDEK);
276 RawBuffer key = handle.keyProvider.getPureDEK(wrappedDatabaseDEK);
278 handle.database = DB::Crypto(fs.getLegacyDBPath(), fs.getDBPath(), key);
279 handle.crypto = CryptoLogic();
281 if (!m_accessControl.isSystemService(user)) {
282 // remove data of removed apps during locked state
283 ClientIdVector removedApps = fs.clearRemovedsApps();
285 for (auto &app : removedApps) {
286 handle.crypto.removeKey(app);
287 handle.database.deleteKey(app);
291 if (user == SYSTEM_DB_UID && SsMigration::hasData())
292 migrateSecureStorageData(false);
293 else if (user == ADMIN_USER_DB_UID && SsMigration::hasData())
294 migrateSecureStorageData(true);
296 return CKM_API_SUCCESS;
299 if (CKM_API_SUCCESS != retCode)
300 m_userDataMap.erase(user);
305 int CKMLogic::unlockSystemDB()
307 return unlockDatabase(SYSTEM_DB_UID, DEFAULT_UNLOCK_STRING);
310 UserData &CKMLogic::selectDatabase(const Credentials &cred,
311 const ClientId &owner)
313 // if user trying to access system service - check:
314 // * if user database is unlocked [mandatory]
315 // * if not - proceed with regular user database
316 // * if explicit system database owner given -> switch to system DB
317 if (!m_accessControl.isSystemService(cred)) {
318 if (0 == m_userDataMap.count(cred.clientUid))
319 ThrowErr(Exc::DatabaseLocked, "database with UID: ", cred.clientUid, " locked");
321 if (0 != owner.compare(CLIENT_ID_SYSTEM))
322 return m_userDataMap[cred.clientUid];
325 // system database selected, modify the owner id
326 if (CKM_API_SUCCESS != unlockSystemDB())
327 ThrowErr(Exc::DatabaseLocked, "can not unlock system database");
329 return m_userDataMap[SYSTEM_DB_UID];
332 RawBuffer CKMLogic::unlockUserKey(uid_t user, const Password &password)
334 int retCode = CKM_API_SUCCESS;
336 if (!m_accessControl.isSystemService(user))
337 retCode = unlockDatabase(user, password);
338 else // do not allow lock/unlock operations for system users
339 retCode = CKM_API_ERROR_INPUT_PARAM;
341 return SerializeMessage(retCode);
344 RawBuffer CKMLogic::updateCCMode()
346 m_accessControl.updateCCMode();
347 return SerializeMessage(CKM_API_SUCCESS);
350 RawBuffer CKMLogic::lockUserKey(uid_t user)
352 int retCode = CKM_API_SUCCESS;
354 if (!m_accessControl.isSystemService(user))
355 m_userDataMap.erase(user);
356 else // do not allow lock/unlock operations for system users
357 retCode = CKM_API_ERROR_INPUT_PARAM;
359 return SerializeMessage(retCode);
362 RawBuffer CKMLogic::removeUserData(uid_t user)
364 if (m_accessControl.isSystemService(user))
365 user = SYSTEM_DB_UID;
367 m_userDataMap.erase(user);
369 const int retCode = FileSystem(user).removeUserData()
370 ? CKM_API_ERROR_FILE_SYSTEM
373 return SerializeMessage(retCode);
376 RawBuffer CKMLogic::changeUserPassword(
378 const Password &oldPassword,
379 const Password &newPassword)
381 return SerializeMessage(tryRet([&] {
382 // do not allow to change system database password
383 if (m_accessControl.isSystemService(user))
384 return CKM_API_ERROR_INPUT_PARAM;
386 loadDKEKFile(user, oldPassword);
387 saveDKEKFile(user, newPassword);
389 return CKM_API_SUCCESS;
393 RawBuffer CKMLogic::resetUserPassword(
395 const Password &newPassword)
397 return SerializeMessage(tryRet([&] {
398 // do not allow to reset system database password
399 if (m_accessControl.isSystemService(user))
400 return CKM_API_ERROR_INPUT_PARAM;
402 int retCode = CKM_API_SUCCESS;
404 if (0 == m_userDataMap.count(user)) {
405 // Check if key exists. If exists we must return error
407 auto wrappedDKEKMain = fs.getDKEK();
409 if (!wrappedDKEKMain.empty())
410 retCode = CKM_API_ERROR_BAD_REQUEST;
412 saveDKEKFile(user, newPassword);
419 RawBuffer CKMLogic::removeApplicationData(const ClientId &owner)
421 return SerializeMessage(tryRet([&] {
423 return CKM_API_ERROR_INPUT_PARAM;
425 UidVector uids = FileSystem::getUIDsFromDBFile();
427 for (auto userId : uids) {
428 if (0 == m_userDataMap.count(userId)) {
429 FileSystem fs(userId);
430 fs.addRemovedApp(owner);
432 auto &handle = m_userDataMap[userId];
433 handle.crypto.removeKey(owner);
434 handle.database.deleteKey(owner);
438 return CKM_API_SUCCESS;
442 int CKMLogic::verifyAndSaveDataHelper(
443 const Credentials &cred,
445 const ClientId &owner,
446 const Crypto::Data &data,
447 const PolicySerializable &policy)
450 // check if data is correct
451 Crypto::Data binaryData;
452 int retCode = toBinaryData(data, binaryData);
453 if (retCode != CKM_API_SUCCESS)
456 auto [dbOp, digest, ret] = beginSaveAndGetHash(cred, name, owner);
457 if (ret != CKM_API_SUCCESS)
460 Crypto::GStore &store = m_decider.getStore(binaryData.type, policy);
462 // do not encrypt data with password during cc_mode on
463 Token token = store.import(binaryData,
464 m_accessControl.isCCMode() ? "" : policy.password,
465 Crypto::EncryptionParams(), digest);
466 dbOp.finalize(std::move(token), policy);
467 return CKM_API_SUCCESS;
471 int CKMLogic::getKeyForService(
472 const Credentials &cred,
474 const ClientId &owner,
475 const Password &pass,
476 Crypto::GObjShPtr &key)
479 // Key is for internal service use. It won't be exported to the client
480 Crypto::GObjUPtr obj;
481 int retCode = readDataHelper(false, cred, DataType::DB_KEY_FIRST, name, owner, pass, obj);
482 if (retCode == CKM_API_SUCCESS)
483 key = std::move(obj);
489 RawBuffer CKMLogic::saveData(
490 const Credentials &cred,
493 const ClientId &owner,
494 const Crypto::Data &data,
495 const PolicySerializable &policy)
497 int retCode = verifyAndSaveDataHelper(cred, name, owner, data, policy);
498 return SerializeMessage(msgId, retCode, data.type);
501 RawBuffer CKMLogic::savePKCS12(
502 const Credentials &cred,
505 const ClientId &owner,
506 const PKCS12Serializable &pkcs,
507 const PolicySerializable &keyPolicy,
508 const PolicySerializable &certPolicy)
510 return SerializeMessage(msgId, tryRet([&] {
511 auto [dbOp, retCode] = beginSave(cred, name, owner);
512 if (retCode != CKM_API_SUCCESS)
515 // extract and encrypt the data
516 DB::RowVector encryptedRows;
518 auto import = [&](const Crypto::Data &data, const Policy& policy){
519 retCode = verifyBinaryData(data);
520 if (retCode != CKM_API_SUCCESS)
523 auto digest = CryptoLogic::makeHash(name, owner, cred.clientUid, data.type);
525 return CKM_API_ERROR_HASH_ERROR;
527 Crypto::GStore &store = m_decider.getStore(data.type, policy);
529 // do not encrypt data with password during cc_mode on
530 Token token = store.import(data,
531 m_accessControl.isCCMode() ? "" : policy.password,
532 Crypto::EncryptionParams(), digest);
534 encryptedRows.push_back(dbOp.encryptOne(std::move(token), policy));
535 return CKM_API_SUCCESS;
538 // private key is mandatory
539 auto key = pkcs.getKey();
541 LogError("Failed to get private key from pkcs");
542 return CKM_API_ERROR_INVALID_FORMAT;
545 Crypto::Data keyData(DataType(key->getType()), key->getDER());
546 retCode = import(keyData, keyPolicy);
547 if (retCode != CKM_API_SUCCESS)
550 // certificate is mandatory
551 auto cert = pkcs.getCertificate();
553 LogError("Failed to get certificate from pkcs");
554 return CKM_API_ERROR_INVALID_FORMAT;
557 Crypto::Data certData(DataType::CERTIFICATE, cert->getDER());
558 retCode = import(certData, certPolicy);
559 if (retCode != CKM_API_SUCCESS)
563 unsigned int cert_index = 0;
564 for (const auto &ca : pkcs.getCaCertificateShPtrVector()) {
565 Crypto::Data caCertData(DataType::getChainDatatype(cert_index ++), ca->getDER());
566 retCode = import(caCertData, certPolicy);
567 if (retCode != CKM_API_SUCCESS)
572 dbOp.database().saveRows(name, owner, encryptedRows);
573 dbOp.transaction().commit();
575 return CKM_API_SUCCESS;
579 RawBuffer CKMLogic::removeData(
580 const Credentials &cred,
583 const ClientId &owner)
585 return SerializeMessage(msgId, tryRet([&] {
586 auto [dbOp, permission, retCode] = beginAndGetPerm(cred, name, owner);
587 if (retCode != CKM_API_SUCCESS)
590 retCode = m_accessControl.canDelete(cred, permission);
591 if (retCode != CKM_API_SUCCESS) {
592 LogWarning("access control check result: " << retCode);
596 // get all matching rows
598 dbOp.database().getRows(name, owner, DataType::DB_FIRST, DataType::DB_LAST, rows);
600 LogDebug("No row for given name and owner");
601 return CKM_API_ERROR_DB_ALIAS_UNKNOWN;
604 retCode = dbOp.loadAppKey();
605 if (retCode != CKM_API_SUCCESS)
608 // destroy it in store
609 for (auto &r : rows) {
611 dbOp.handler().crypto.decryptRow(Password(), r);
612 m_decider.getStore(r).destroy(r);
613 } catch (const Exc::AuthenticationFailed &) {
614 LogDebug("Authentication failed when removing data. Ignored.");
619 dbOp.database().deleteRow(name, owner);
620 dbOp.transaction().commit();
622 return CKM_API_SUCCESS;
627 int CKMLogic::checkDataPermissionsHelper(const Credentials &accessorCred,
630 const PermissionMask& permission)
633 return m_accessControl.canExport(accessorCred, row, permission);
635 return m_accessControl.canRead(accessorCred, permission);
638 Crypto::GObjUPtr CKMLogic::rowToObject(
641 const Password &password,
642 const RawBuffer &hash)
644 Crypto::GStore &store = m_decider.getStore(row);
646 Password pass = m_accessControl.isCCMode() ? "" : password;
649 Crypto::GObjUPtr obj;
651 if (CryptoLogic::getSchemeVersion(row.encryptionScheme) ==
652 CryptoLogic::ENCRYPTION_V2) {
653 handler.crypto.decryptRow(Password(), row);
655 obj = store.getObject(row, pass);
657 // decrypt entirely with old scheme: b64(pass(appkey(data))) -> data
658 handler.crypto.decryptRow(pass, row);
659 // destroy it in store
662 // import it to store with new scheme: data -> pass(data)
663 Token token = store.import(Crypto::Data(row.dataType, row.data),
665 Crypto::EncryptionParams(),
668 // get it from the store (it can be different than the data we imported into store)
669 obj = store.getObject(token, pass);
671 // update row with new token
672 *static_cast<Token *>(&row) = std::move(token);
674 // encrypt it with app key: pass(data) -> b64(appkey(pass(data))
675 handler.crypto.encryptRow(row);
678 handler.database.updateRow(row);
684 int CKMLogic::readDataHelper(
686 const Credentials &cred,
689 const ClientId &owner,
690 const Password &password,
691 Crypto::GObjUPtrVector &objs)
693 auto [dbOp, permission, retCode] = beginAndGetPerm(cred, name, owner);
694 if (retCode != CKM_API_SUCCESS)
699 retCode = readMultiRow(name, owner, dataType, dbOp.database(), rows);
700 if (CKM_API_SUCCESS != retCode)
703 // all read rows belong to the same owner
704 DB::Row &firstRow = rows.at(0);
706 // check access rights
707 retCode = checkDataPermissionsHelper(cred, firstRow, exportFlag, permission);
708 if (CKM_API_SUCCESS != retCode)
711 // for multiple objects add type as hash input (see pkcs12)
712 bool multiple = rows.size() > 1;
716 retCode = dbOp.loadAppKey();
717 if (retCode != CKM_API_SUCCESS)
721 for (auto &row : rows) {
723 digest = CryptoLogic::makeHash(name, owner, cred.clientUid, row.dataType);
725 digest = CryptoLogic::makeHash(name, owner, cred.clientUid);
728 return CKM_API_ERROR_HASH_ERROR;
730 objs.push_back(rowToObject(dbOp.handler(), std::move(row), password, digest));
733 // rowToObject may modify db
734 dbOp.transaction().commit();
736 return CKM_API_SUCCESS;
739 int CKMLogic::readDataHelper(
741 const Credentials &cred,
744 const ClientId &owner,
745 const Password &password,
746 Crypto::GObjUPtr &obj)
748 DataType objDataType;
749 return readDataHelper(exportFlag, cred, dataType, name, owner,
750 password, obj, objDataType);
753 int CKMLogic::readDataHelper(
755 const Credentials &cred,
758 const ClientId &owner,
759 const Password &password,
760 Crypto::GObjUPtr &obj,
761 DataType &objDataType)
763 auto [dbOp, permission, retCode] = beginAndGetPerm(cred, name, owner);
764 if (retCode != CKM_API_SUCCESS)
768 retCode = readSingleRow(name, owner, dataType, dbOp.database(), row);
769 if (CKM_API_SUCCESS != retCode)
772 retCode = dbOp.loadAppKey();
773 if (retCode != CKM_API_SUCCESS)
776 objDataType = row.dataType;
778 // check access rights
779 retCode = checkDataPermissionsHelper(cred, row, exportFlag, permission);
780 if (CKM_API_SUCCESS != retCode)
783 auto digest = CryptoLogic::makeHash(name, owner, cred.clientUid);
785 return CKM_API_ERROR_HASH_ERROR;
787 obj = rowToObject(dbOp.handler(), std::move(row), password, digest);
788 // rowToObject may modify db
789 dbOp.transaction().commit();
791 return CKM_API_SUCCESS;
794 RawBuffer CKMLogic::getData(
795 const Credentials &cred,
799 const ClientId &owner,
800 const Password &password)
803 DataType objDataType;
805 int retCode = tryRet([&] {
806 Crypto::GObjUPtr obj;
807 int retCode = readDataHelper(true, cred, dataType, name, owner,
808 password, obj, objDataType);
810 if (retCode == CKM_API_SUCCESS)
811 rowData = obj->getBinary();
816 if (CKM_API_SUCCESS != retCode)
819 return SerializeMessage(msgId, retCode, objDataType, rowData);
822 RawBuffer CKMLogic::getDataProtectionStatus(
823 const Credentials &cred,
827 const ClientId &owner)
830 DataType objDataType;
833 int retCode = tryRet([&] {
834 Crypto::GObjUPtr obj;
835 return readDataHelper(false, cred, dataType, name, owner, password, obj, objDataType);
838 if (retCode == CKM_API_ERROR_AUTHENTICATION_FAILED) {
840 retCode = CKM_API_SUCCESS;
843 return SerializeMessage(msgId, retCode, objDataType, status);
846 RawBuffer CKMLogic::getPKCS12(
847 const Credentials &cred,
850 const ClientId &owner,
851 const Password &keyPassword,
852 const Password &certPassword)
854 PKCS12Serializable output;
856 int retCode = tryRet([&] {
858 CertificateShPtr cert;
859 CertificateShPtrVector caChain;
861 // read private key (mandatory)
862 Crypto::GObjUPtr keyObj;
863 int retCode = readDataHelper(true, cred, DataType::DB_KEY_FIRST, name, owner,
864 keyPassword, keyObj);
866 if (retCode != CKM_API_SUCCESS) {
867 if (retCode != CKM_API_ERROR_NOT_EXPORTABLE)
870 privKey = CKM::Key::create(keyObj->getBinary());
873 // read certificate (mandatory)
874 Crypto::GObjUPtr certObj;
875 retCode = readDataHelper(true, cred, DataType::CERTIFICATE, name, owner,
876 certPassword, certObj);
878 if (retCode != CKM_API_SUCCESS) {
879 if (retCode != CKM_API_ERROR_NOT_EXPORTABLE)
882 cert = CKM::Certificate::create(certObj->getBinary(), DataFormat::FORM_DER);
885 // read CA cert chain (optional)
886 Crypto::GObjUPtrVector caChainObjs;
887 retCode = readDataHelper(true, cred, DataType::DB_CHAIN_FIRST, name, owner,
888 certPassword, caChainObjs);
890 if (retCode != CKM_API_SUCCESS && retCode != CKM_API_ERROR_DB_ALIAS_UNKNOWN) {
891 if (retCode != CKM_API_ERROR_NOT_EXPORTABLE)
894 for (auto &caCertObj : caChainObjs)
895 caChain.push_back(CKM::Certificate::create(caCertObj->getBinary(),
896 DataFormat::FORM_DER));
899 // if anything found, return it
900 if (privKey || cert || caChain.size() > 0)
901 retCode = CKM_API_SUCCESS;
904 if (retCode != CKM_API_SUCCESS)
907 output = PKCS12Serializable(std::move(privKey), std::move(cert), std::move(caChain));
908 return CKM_API_SUCCESS;
911 return SerializeMessage(msgId, retCode, output);
914 int CKMLogic::getDataListHelper(const Credentials &cred,
915 const DataType dataType,
916 OwnerNameVector &ownerNameVector)
918 int retCode = CKM_API_ERROR_DB_LOCKED;
920 if (0 < m_userDataMap.count(cred.clientUid)) {
921 auto &database = m_userDataMap[cred.clientUid].database;
923 retCode = tryRet<CKM_API_ERROR_DB_ERROR>([&] {
924 OwnerNameVector tmpVector;
926 if (dataType.isKey()) {
927 // list all key types
928 database.listNames(cred.client,
930 DataType::DB_KEY_FIRST,
931 DataType::DB_KEY_LAST);
933 // list anything else
934 database.listNames(cred.client,
939 ownerNameVector.insert(ownerNameVector.end(), tmpVector.begin(),
941 return CKM_API_SUCCESS;
948 RawBuffer CKMLogic::getDataList(
949 const Credentials &cred,
953 OwnerNameVector systemVector;
954 OwnerNameVector userVector;
955 OwnerNameVector ownerNameVector;
957 int retCode = unlockSystemDB();
959 if (CKM_API_SUCCESS == retCode) {
961 if (m_accessControl.isSystemService(cred)) {
963 retCode = getDataListHelper(Credentials(SYSTEM_DB_UID, CLIENT_ID_SYSTEM),
967 // user - lookup system, then client DB
968 retCode = getDataListHelper(Credentials(SYSTEM_DB_UID, cred.client),
973 if (retCode == CKM_API_SUCCESS) {
974 retCode = getDataListHelper(cred,
981 if (retCode == CKM_API_SUCCESS) {
982 ownerNameVector.insert(ownerNameVector.end(), systemVector.begin(),
984 ownerNameVector.insert(ownerNameVector.end(), userVector.begin(),
988 return SerializeMessage(msgId, retCode, dataType, ownerNameVector);
991 int CKMLogic::importInitialData(
993 const Crypto::Data &data,
994 const Crypto::EncryptionParams &encParams,
995 const Policy &policy)
999 if (encParams.iv.empty() != encParams.tag.empty()) {
1000 LogError("Both iv and tag must be empty or set");
1001 return CKM_API_ERROR_INPUT_PARAM;
1004 // Inital values are always imported with root credentials. Client id is not important.
1005 Credentials rootCred(0, "whatever");
1006 ClientId owner(CLIENT_ID_SYSTEM);
1008 auto [dbOp, digest, retCode] = beginSaveAndGetHash(rootCred, name, owner);
1009 if (retCode != CKM_API_SUCCESS)
1012 Crypto::GStore &store = m_decider.getStore(data.type, policy, !encParams.iv.empty());
1015 if (encParams.iv.empty()) {
1016 // Data are not encrypted, let's try to verify them
1017 Crypto::Data binaryData;
1019 if (CKM_API_SUCCESS != (retCode = toBinaryData(data, binaryData)))
1022 token = store.import(binaryData,
1023 m_accessControl.isCCMode() ? "" : policy.password,
1026 token = store.import(data,
1027 m_accessControl.isCCMode() ? "" : policy.password,
1031 dbOp.finalize(std::move(token), policy);
1033 return CKM_API_SUCCESS;
1035 } catch (const std::exception &e) {
1036 LogError("Std::exception: " << e.what());
1037 return CKM_API_ERROR_SERVER_ERROR;
1041 int CKMLogic::DBOperation::loadAppKey(bool keyRequired)
1043 if (!m_handler.crypto.haveKey(m_owner)) {
1044 RawBuffer wrappedDEK;
1045 auto wrappedDEKOptional = m_handler.database.getKey(m_owner);
1047 if (!wrappedDEKOptional) {
1049 LogError("No key for given owner in database");
1050 return CKM_API_ERROR_DB_ERROR;
1052 LogDebug("No Key in database found. Generating new one for client: " << m_owner);
1053 wrappedDEK = m_handler.keyProvider.generateDEK(m_owner);
1054 m_handler.database.saveKey(m_owner, wrappedDEK);
1056 wrappedDEK = *wrappedDEKOptional;
1059 m_handler.crypto.pushKey(m_owner, m_handler.keyProvider.getPureDEK(wrappedDEK));
1062 return CKM_API_SUCCESS;
1065 std::tuple<CKMLogic::DBOperation, int> CKMLogic::begin(
1066 const Credentials &cred,
1068 const ClientId &owner)
1070 auto &handler = selectDatabase(cred, owner);
1071 DBOperation op(handler, name, owner);
1073 if (cred.client.empty() || !isClientValid(cred.client) ||
1074 !isNameValid(name) || !isClientValid(owner))
1075 return std::make_tuple(std::move(op), CKM_API_ERROR_INPUT_PARAM);
1077 return std::make_tuple(std::move(op), CKM_API_SUCCESS);
1080 std::tuple<CKMLogic::DBOperation, PermissionMask, int> CKMLogic::beginAndGetPerm(
1081 const Credentials &cred,
1083 const ClientId &owner)
1085 PermissionMask permission;
1086 auto [dbOp, retCode] = begin(cred, name, owner);
1087 if (retCode == CKM_API_SUCCESS)
1088 permission = toPermissionMask(dbOp.database().getPermissionRow(name, owner, cred.client));
1090 return std::make_tuple(std::move(dbOp), permission, retCode);
1093 std::tuple<CKMLogic::DBOperation, int> CKMLogic::beginSave(
1094 const Credentials &cred,
1096 const ClientId &owner)
1098 auto [dbOp, retCode] = begin(cred, name, owner);
1099 if (retCode != CKM_API_SUCCESS)
1100 return std::make_tuple(std::move(dbOp), retCode);
1102 retCode = dbOp.loadAppKey(false);
1103 if (retCode != CKM_API_SUCCESS)
1104 return std::make_tuple(std::move(dbOp), retCode);
1106 // check if accessor is allowed to save owner's items
1107 retCode = m_accessControl.canSave(cred, owner);
1108 if (retCode != CKM_API_SUCCESS) {
1109 LogDebug("accessor " << cred.client << " can not save rows owned by " << owner);
1110 return std::make_tuple(std::move(dbOp), retCode);
1113 if (dbOp.database().isNameOwnerPresent(name, owner))
1114 retCode = CKM_API_ERROR_DB_ALIAS_EXISTS;
1116 return std::make_tuple(std::move(dbOp), retCode);
1119 std::tuple<CKMLogic::DBOperation, RawBuffer, int> CKMLogic::beginSaveAndGetHash(
1120 const Credentials &cred,
1122 const ClientId &owner)
1125 auto [dbOp, retCode] = beginSave(cred, name, owner);
1126 if (retCode == CKM_API_SUCCESS) {
1127 digest = CryptoLogic::makeHash(name, owner, cred.clientUid);
1129 retCode = CKM_API_ERROR_HASH_ERROR;
1132 return std::make_tuple(std::move(dbOp), std::move(digest), retCode);
1135 RawBuffer CKMLogic::createKeyPair(
1136 const Credentials &cred,
1138 const CryptoAlgorithmSerializable &keyGenParams,
1139 const Name &namePrv,
1140 const ClientId &ownerPrv,
1141 const Name &namePub,
1142 const ClientId &ownerPub,
1143 const PolicySerializable &policyPrv,
1144 const PolicySerializable &policyPub)
1146 return SerializeMessage(msgId, tryRet([&] {
1147 auto [dbOpPrv, digestPrv, retCodePrv] = beginSaveAndGetHash(cred, namePrv, ownerPrv);
1148 if (retCodePrv != CKM_API_SUCCESS)
1151 auto [dbOpPub, digestPub, retCodePub] = beginSaveAndGetHash(cred, namePub, ownerPub);
1152 if (retCodePub != CKM_API_SUCCESS)
1155 AlgoType keyType = AlgoType::RSA_GEN;
1157 if (!keyGenParams.getParam(ParamName::ALGO_TYPE, keyType))
1158 ThrowErr(Exc::InputParam, "Error, parameter ALGO_TYPE not found.");
1160 const auto dtIt = ALGO_TYPE_TO_DATA_TYPE_PAIR_MAP.find(keyType);
1161 if (dtIt == ALGO_TYPE_TO_DATA_TYPE_PAIR_MAP.end())
1162 ThrowErr(Exc::InputParam, "Error, parameter ALGO_TYPE with wrong value.");
1163 const DataTypePair& dt = dtIt->second;
1165 if (policyPrv.backend != policyPub.backend)
1166 ThrowErr(Exc::InputParam, "Error, key pair must be supported with the same backend.");
1168 bool exportable = policyPrv.extractable || policyPub.extractable;
1169 Policy lessRestricted(Password(), exportable, policyPrv.backend);
1171 TokenPair keys = m_decider.getStore(policyPrv, dt.first, dt.second).generateAKey(
1175 digestPrv, digestPub);
1177 dbOpPrv.finalize(std::move(keys.first), policyPrv);
1178 dbOpPub.finalize(std::move(keys.second), policyPub);
1180 return CKM_API_SUCCESS;
1184 RawBuffer CKMLogic::createKeyAES(
1185 const Credentials &cred,
1189 const ClientId &owner,
1190 const PolicySerializable &policy)
1192 int retCode = CKM_API_SUCCESS;
1195 retCode = tryRet([&] {
1196 auto [dbOp, digest, retCode] = beginSaveAndGetHash(cred, name, owner);
1197 if (retCode != CKM_API_SUCCESS)
1200 // create key in store
1201 CryptoAlgorithm keyGenAlgorithm;
1202 keyGenAlgorithm.setParam(ParamName::ALGO_TYPE, AlgoType::AES_GEN);
1203 keyGenAlgorithm.setParam(ParamName::GEN_KEY_LEN, size);
1204 Token key = m_decider.getStore(DataType::KEY_AES, policy).generateSKey(keyGenAlgorithm,
1208 dbOp.finalize(std::move(key), policy);
1209 return CKM_API_SUCCESS;
1211 } catch (std::invalid_argument &e) {
1212 LogDebug("invalid argument error: " << e.what());
1213 retCode = CKM_API_ERROR_INPUT_PARAM;
1216 return SerializeMessage(msgId, retCode);
1219 int CKMLogic::readCertificateHelper(
1220 const Credentials &cred,
1221 const OwnerNameVector &ownerNameVector,
1222 CertificateImplVector &certVector)
1224 for (auto &i : ownerNameVector) {
1225 // certificates can't be protected with custom user password
1226 Crypto::GObjUPtr obj;
1228 ec = readDataHelper(true,
1230 DataType::CERTIFICATE,
1232 cred.effectiveOwner(i.first),
1236 if (ec != CKM_API_SUCCESS)
1239 certVector.emplace_back(obj->getBinary(), DataFormat::FORM_DER);
1241 // try to read chain certificates (if present)
1242 Crypto::GObjUPtrVector caChainObjs;
1243 ec = readDataHelper(true,
1245 DataType::DB_CHAIN_FIRST,
1247 cred.effectiveOwner(i.first),
1251 if (ec != CKM_API_SUCCESS && ec != CKM_API_ERROR_DB_ALIAS_UNKNOWN)
1254 for (auto &caCertObj : caChainObjs)
1255 certVector.emplace_back(caCertObj->getBinary(), DataFormat::FORM_DER);
1258 return CKM_API_SUCCESS;
1261 int CKMLogic::getCertificateChainHelper(
1262 const CertificateImpl &cert,
1263 const RawBufferVector &untrustedCertificates,
1264 const RawBufferVector &trustedCertificates,
1265 bool useTrustedSystemCertificates,
1266 RawBufferVector &chainRawVector)
1268 CertificateImplVector untrustedCertVector;
1269 CertificateImplVector trustedCertVector;
1270 CertificateImplVector chainVector;
1273 return CKM_API_ERROR_INPUT_PARAM;
1275 for (auto &e : untrustedCertificates) {
1276 CertificateImpl c(e, DataFormat::FORM_DER);
1279 return CKM_API_ERROR_INPUT_PARAM;
1281 untrustedCertVector.push_back(std::move(c));
1284 for (auto &e : trustedCertificates) {
1285 CertificateImpl c(e, DataFormat::FORM_DER);
1288 return CKM_API_ERROR_INPUT_PARAM;
1290 trustedCertVector.push_back(std::move(c));
1293 CertificateStore store;
1294 int retCode = store.verifyCertificate(cert,
1295 untrustedCertVector,
1297 useTrustedSystemCertificates,
1298 m_accessControl.isCCMode(),
1301 if (retCode != CKM_API_SUCCESS)
1304 for (auto &e : chainVector)
1305 chainRawVector.push_back(e.getDER());
1307 return CKM_API_SUCCESS;
1310 int CKMLogic::getCertificateChainHelper(
1311 const Credentials &cred,
1312 const CertificateImpl &cert,
1313 const OwnerNameVector &untrusted,
1314 const OwnerNameVector &trusted,
1315 bool useTrustedSystemCertificates,
1316 RawBufferVector &chainRawVector)
1318 CertificateImplVector untrustedCertVector;
1319 CertificateImplVector trustedCertVector;
1320 CertificateImplVector chainVector;
1323 return CKM_API_ERROR_INPUT_PARAM;
1325 int retCode = readCertificateHelper(cred, untrusted, untrustedCertVector);
1327 if (retCode != CKM_API_SUCCESS)
1330 retCode = readCertificateHelper(cred, trusted, trustedCertVector);
1332 if (retCode != CKM_API_SUCCESS)
1335 CertificateStore store;
1336 retCode = store.verifyCertificate(cert,
1337 untrustedCertVector,
1339 useTrustedSystemCertificates,
1340 m_accessControl.isCCMode(),
1343 if (retCode != CKM_API_SUCCESS)
1346 for (auto &i : chainVector)
1347 chainRawVector.push_back(i.getDER());
1349 return CKM_API_SUCCESS;
1352 RawBuffer CKMLogic::getCertificateChain(
1353 const Credentials & /*cred*/,
1355 const RawBuffer &certificate,
1356 const RawBufferVector &untrustedCertificates,
1357 const RawBufferVector &trustedCertificates,
1358 bool useTrustedSystemCertificates)
1360 CertificateImpl cert(certificate, DataFormat::FORM_DER);
1361 RawBufferVector chainRawVector;
1362 int retCode = CKM_API_ERROR_UNKNOWN;
1365 retCode = getCertificateChainHelper(cert,
1366 untrustedCertificates,
1367 trustedCertificates,
1368 useTrustedSystemCertificates,
1370 } catch (const Exc::Exception &e) {
1371 retCode = e.error();
1372 } catch (const std::exception &e) {
1373 LogError("STD exception " << e.what());
1374 retCode = CKM_API_ERROR_SERVER_ERROR;
1376 LogError("Unknown error.");
1379 return SerializeMessage(msgId, retCode, chainRawVector);
1382 RawBuffer CKMLogic::getCertificateChain(
1383 const Credentials &cred,
1385 const RawBuffer &certificate,
1386 const OwnerNameVector &untrustedCertificates,
1387 const OwnerNameVector &trustedCertificates,
1388 bool useTrustedSystemCertificates)
1390 int retCode = CKM_API_ERROR_UNKNOWN;
1391 CertificateImpl cert(certificate, DataFormat::FORM_DER);
1392 RawBufferVector chainRawVector;
1395 retCode = getCertificateChainHelper(cred,
1397 untrustedCertificates,
1398 trustedCertificates,
1399 useTrustedSystemCertificates,
1401 } catch (const Exc::Exception &e) {
1402 retCode = e.error();
1403 } catch (const std::exception &e) {
1404 LogError("STD exception " << e.what());
1405 retCode = CKM_API_ERROR_SERVER_ERROR;
1407 LogError("Unknown error.");
1410 return SerializeMessage(msgId, retCode, chainRawVector);
1413 RawBuffer CKMLogic::createSignature(
1414 const Credentials &cred,
1416 const Name &privateKeyName,
1417 const ClientId &owner,
1418 const Password &password, // password for private_key
1419 const RawBuffer &message,
1420 const CryptoAlgorithm &cryptoAlg)
1422 RawBuffer signature;
1424 int retCode = CKM_API_SUCCESS;
1427 retCode = tryRet([&] {
1428 Crypto::GObjUPtr obj;
1429 int retCode = readDataHelper(false, cred, DataType::DB_KEY_FIRST, privateKeyName,
1430 owner, password, obj);
1432 if (retCode == CKM_API_SUCCESS)
1433 signature = obj->sign(cryptoAlg, message);
1437 } catch (const std::exception &e) {
1438 LogError("STD exception " << e.what());
1439 retCode = CKM_API_ERROR_SERVER_ERROR;
1442 return SerializeMessage(msgId, retCode, signature);
1445 RawBuffer CKMLogic::verifySignature(
1446 const Credentials &cred,
1448 const Name &publicKeyOrCertName,
1449 const ClientId &owner,
1450 const Password &password, // password for public_key (optional)
1451 const RawBuffer &message,
1452 const RawBuffer &signature,
1453 const CryptoAlgorithm ¶ms)
1455 return SerializeMessage(msgId, tryRet([&] {
1456 // try certificate first - looking for a public key.
1457 // in case of PKCS, pub key from certificate will be found first
1458 // rather than private key from the same PKCS.
1459 Crypto::GObjUPtr obj;
1460 int retCode = readDataHelper(false, cred, DataType::CERTIFICATE,
1461 publicKeyOrCertName, owner, password, obj);
1463 if (retCode == CKM_API_ERROR_DB_ALIAS_UNKNOWN)
1464 retCode = readDataHelper(false, cred, DataType::DB_KEY_FIRST,
1465 publicKeyOrCertName, owner, password, obj);
1467 if (retCode == CKM_API_SUCCESS)
1468 retCode = obj->verify(params, message, signature);
1474 int CKMLogic::setPermissionHelper(
1475 const Credentials &cred, // who's the client
1477 const ClientId &owner, // who's the owner
1478 const ClientId &accessor, // who will get the access
1479 const PermissionMask permissionMask)
1481 auto [dbOp, retCode] = beginSave(cred, name, owner);
1482 // Normally, saving requires alias to be unoccupied. When changing permissions it's the opposite
1483 if (retCode != CKM_API_ERROR_DB_ALIAS_EXISTS) {
1484 if (retCode == CKM_API_SUCCESS)
1485 retCode = CKM_API_ERROR_DB_ALIAS_UNKNOWN;
1489 // currently we don't support modification of owner's permissions to his own rows
1490 if (owner == accessor)
1491 return CKM_API_ERROR_INPUT_PARAM;
1493 // system database does not support write/remove permissions
1494 if ((0 == owner.compare(CLIENT_ID_SYSTEM)) && (permissionMask & Permission::REMOVE))
1495 return CKM_API_ERROR_INPUT_PARAM;
1497 // set permissions to the row owned by owner for accessor
1498 dbOp.database().setPermission(name, owner, accessor, permissionMask);
1499 dbOp.transaction().commit();
1501 return CKM_API_SUCCESS;
1504 RawBuffer CKMLogic::setPermission(
1505 const Credentials &cred,
1508 const ClientId &owner,
1509 const ClientId &accessor,
1510 const PermissionMask permissionMask)
1512 return SerializeMessage(msgID, tryRet([&] {
1513 return setPermissionHelper(cred, name, owner, accessor, permissionMask);