2 * Copyright (c) 2017-2020 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 Krzysztof Dynowski (k.dynowski@samsung.com)
19 * @author Lukasz Kostyra (l.kostyra@samsung.com)
23 #include <generic-backend/exception.h>
24 #include <generic-backend/algo-validation.h>
25 #include <generic-backend/crypto-params.h>
26 #include <dpl/log/log.h>
28 #include <openssl/evp.h>
29 #include <openssl/dsa.h>
30 #include <openssl/ec.h>
31 #include <openssl/bio.h>
32 #include <openssl/bn.h>
34 #include <tz-backend/internals.h>
35 #include <tz-backend/tz-context.h>
36 #include <openssl-error-handler.h>
37 #include <km_ta_defines.h>
42 #ifndef __has_cpp_attribute
43 #define __has_cpp_attribute(_) 0
46 #if __has_cpp_attribute(fallthrough)
47 #define fallthru [[fallthrough]]
49 #define fallthru ((void)0)
54 CKM::RawBuffer extractBignumData(const BIGNUM* bn)
56 size_t size = static_cast<size_t>(BN_num_bytes(bn));
58 CKM::RawBuffer result(size);
59 int ret = BN_bn2bin(bn, result.data());
60 if (ret != static_cast<int>(size)) {
61 ThrowErr(CKM::Exc::Crypto::InternalError,
62 "Error while converting bignums - expected "
63 + std::to_string(size) + " bytes of data, got " + std::to_string(ret));
69 void generateDSAParams(const int sizeBits, CKM::RawBuffer &prime,
70 CKM::RawBuffer &subprime, CKM::RawBuffer &base)
72 auto dsa = uptr<DSA_free>(DSA_new());
74 ThrowErr(CKM::Exc::Crypto::InternalError,
75 "Failed to create DSA context for parameter gen");
78 if (DSA_generate_parameters_ex(dsa.get(), sizeBits, NULL, 0, NULL, NULL, NULL) == 0) {
79 ThrowErr(CKM::Exc::Crypto::InternalError,
80 "Failed to generate DSA params, err = " + std::to_string(ERR_get_error()));
83 // at this stage dsa->p, dsa->q & dsa->r should contain our params
84 // extract them into buffers
85 const BIGNUM *p, *q, *g;
86 DSA_get0_pqg(dsa.get(), &p, &q, &g);
87 prime = extractBignumData(p);
88 subprime = extractBignumData(q);
89 base = extractBignumData(g);
92 tz_data_type toTzDataType(const CKM::DataType dataType) {
94 case CKM::DataType::BINARY_DATA: return TYPE_GENERIC_SECRET;
95 case CKM::DataType::KEY_AES: return TYPE_SKEY;
96 case CKM::DataType::KEY_DSA_PRIVATE: return TYPE_AKEY_PRIVATE_DSA;
97 case CKM::DataType::KEY_RSA_PRIVATE: return TYPE_AKEY_PRIVATE_RSA;
98 case CKM::DataType::KEY_ECDSA_PRIVATE: return TYPE_AKEY_PRIVATE_EC;
99 case CKM::DataType::KEY_DSA_PUBLIC: return TYPE_AKEY_PUBLIC_DSA;
100 case CKM::DataType::KEY_RSA_PUBLIC: return TYPE_AKEY_PUBLIC_RSA;
101 case CKM::DataType::KEY_ECDSA_PUBLIC: return TYPE_AKEY_PUBLIC_EC;
103 ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported,
104 "Data type could not be imported by tz-backend");
108 tz_ec toTzEc(CKM::ElipticCurve ec)
111 case CKM::ElipticCurve::prime192v1: return EC_NIST_P192;
112 case CKM::ElipticCurve::prime256v1: return EC_NIST_P256;
113 case CKM::ElipticCurve::secp384r1: return EC_NIST_P384;
114 default: ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported, "EC not supported by tz-backend");
118 tz_prf toTzPrf(CKM::KdfPrf prf)
121 case CKM::KdfPrf::HMAC_SHA256: return PRF_HMAC_SHA256;
122 case CKM::KdfPrf::HMAC_SHA384: return PRF_HMAC_SHA384;
123 case CKM::KdfPrf::HMAC_SHA512: return PRF_HMAC_SHA512;
124 default: ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported, "PRF not supported by tz-backend");
128 tz_kbkdf_mode toTzKbkdfMode(CKM::KbkdfMode mode)
131 case CKM::KbkdfMode::COUNTER: return KBKDF_MODE_COUNTER;
133 ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported, "KBKDF mode not supported by tz-backend");
137 tz_kbkdf_ctr_loc toTzCtrLoc(CKM::KbkdfCounterLocation loc)
140 case CKM::KbkdfCounterLocation::BEFORE_FIXED: return KBKDF_LOC_BEFORE_FIXED;
141 case CKM::KbkdfCounterLocation::AFTER_FIXED: return KBKDF_LOC_AFTER_FIXED;
142 case CKM::KbkdfCounterLocation::MIDDLE_FIXED: return KBKDF_LOC_MIDDLE_FIXED;
144 ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported,
145 "KBKDF counter location not supported by tz-backend");
154 namespace Internals {
158 tz_algo_type getGenSKeyType(AlgoType type)
162 case AlgoType::AES_GEN: return ALGO_AES_GEN;
163 default: ThrowErr(Exc::Crypto::OperationNotSupported, "Requested algorithm is not supported");
167 tz_algo_type getAlgType(AlgoType type)
171 case AlgoType::AES_CBC: return ALGO_AES_CBC;
172 case AlgoType::AES_CTR: return ALGO_AES_CTR;
173 case AlgoType::AES_CFB: return ALGO_AES_CFB;
174 case AlgoType::AES_GCM: return ALGO_AES_GCM;
175 case AlgoType::RSA_OAEP: return ALGO_RSA;
176 case AlgoType::RSA_SV: return ALGO_RSA_SV;
177 case AlgoType::DSA_SV: return ALGO_DSA_SV;
178 case AlgoType::ECDSA_SV: return ALGO_ECDSA_SV;
179 default: ThrowErr(Exc::Crypto::OperationNotSupported, "Requested algorithm is not supported");
183 tz_hash_type getHashType(HashAlgorithm hash)
187 case HashAlgorithm::SHA1: return HASH_SHA1;
188 case HashAlgorithm::SHA256: return HASH_SHA256;
189 case HashAlgorithm::SHA384: return HASH_SHA384;
190 case HashAlgorithm::SHA512: return HASH_SHA512;
192 ThrowErr(Exc::Crypto::OperationNotSupported, "Requested algorithm is not supported");
196 void decompose(const CryptoAlgorithm &alg,
198 uint32_t &ctrLenOrTagSizeBits,
202 algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
204 case AlgoType::AES_CTR:
205 iv = unpack<RawBuffer>(alg, ParamName::ED_IV);
206 ctrLenOrTagSizeBits = unpack<uint64_t>(alg, ParamName::ED_CTR_LEN);
207 // counter length is in bits
208 if (ctrLenOrTagSizeBits != Params::DEFAULT_AES_IV_LEN * 8) {
209 LogError("CTR length invalid: " << std::to_string(ctrLenOrTagSizeBits));
210 ThrowErr(Exc::Crypto::InputParam, "Invalid CTR length");
213 case AlgoType::AES_CBC:
214 iv = unpack<RawBuffer>(alg, ParamName::ED_IV);
216 case AlgoType::AES_CFB:
217 iv = unpack<RawBuffer>(alg, ParamName::ED_IV);
219 case AlgoType::AES_GCM:
220 iv = unpack<RawBuffer>(alg, ParamName::ED_IV);
221 ctrLenOrTagSizeBits = Params::DEFAULT_AES_GCM_TAG_LEN_BITS;
222 alg.getParam(ParamName::ED_TAG_LEN, ctrLenOrTagSizeBits);
223 alg.getParam(ParamName::ED_AAD, aad);
225 case AlgoType::RSA_OAEP:
228 ThrowErr(Exc::Crypto::InputParam, "Invalid decryption algorithm");
235 RawBuffer generateIV()
238 TrustZoneContext::Instance().generateIV(result);
242 void generateSKey(const CryptoAlgorithm &alg,
246 const RawBuffer &hash)
248 AlgoType keyType = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
249 int keyBits = unpack<int>(alg, ParamName::GEN_KEY_LEN);
253 ThrowErr(Exc::InputParam, "Key generation with password encryption requires an IV");
256 RawBuffer pwdBuf(pwd.begin(), pwd.end());
257 TrustZoneContext::Instance().generateSKeyPwd(getGenSKeyType(keyType),
261 TrustZoneContext::Instance().generateSKey(getGenSKeyType(keyType), keyBits,
267 AlgoType generateAKey(const CryptoAlgorithm &alg,
268 const Password &pubPwd,
269 const Password &privPwd,
270 const RawBuffer &pubPwdIv,
271 const RawBuffer &privPwdIv,
274 const RawBuffer &hashPriv,
275 const RawBuffer &hashPub)
277 AlgoType keyType = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
281 pubPwdBuf.assign(pubPwd.begin(), pubPwd.end());
283 RawBuffer privPwdBuf;
284 if (!privPwd.empty())
285 privPwdBuf.assign(privPwd.begin(), privPwd.end());
288 case AlgoType::RSA_GEN: {
289 int keyBits = unpack<int>(alg, ParamName::GEN_KEY_LEN);
290 TrustZoneContext::Instance().generateRSAKey(keyBits,
301 case AlgoType::DSA_GEN: {
302 int keyBits = unpack<int>(alg, ParamName::GEN_KEY_LEN);
306 generateDSAParams(keyBits, prime, subprime, base);
307 TrustZoneContext::Instance().generateDSAKey(keyBits,
321 case AlgoType::ECDSA_GEN: {
322 CKM::ElipticCurve ec = unpack<CKM::ElipticCurve>(alg, ParamName::GEN_EC);
323 TrustZoneContext::Instance().generateECKey(toTzEc(ec),
335 ThrowErr(Exc::Crypto::InputParam,
336 "Invalid algo type provided for generateAKey function");
343 void destroyKey(const RawBuffer &keyId)
345 TrustZoneContext::Instance().executeDestroy(keyId);
348 void importData(const Data &data,
349 const EncryptionParams &encData,
351 const RawBuffer &pwdIV,
353 const RawBuffer &hash)
356 const auto dataType = toTzDataType(data.type);
358 RawBuffer pwdBuf(pwd.begin(), pwd.end());
359 uint32_t keySizeBits = data.data.size() * 8;
360 TrustZoneContext::Instance().importData(dataType,
370 void importWrappedKey(const RawBuffer &wrappingKeyId,
371 const Pwd &wrappingKeyPwd,
372 const CryptoAlgorithm &alg,
373 const Data &encryptedKey,
374 const Password &encryptedKeyPassword,
375 const RawBuffer &encryptedKeyIV,
376 RawBuffer &encryptedKeyTag,
377 const RawBuffer &encryptedKeyId)
379 RawBuffer encryptedKeyPwdBuf(encryptedKeyPassword.begin(), encryptedKeyPassword.end());
382 uint32_t ctrLenOrTagSizeBits = 0;
385 decompose(alg, algo, ctrLenOrTagSizeBits, iv, aad);
388 TrustZoneContext::Instance().importWrappedKey(wrappingKeyId,
394 toTzDataType(encryptedKey.type),
402 RawBuffer exportWrappedKey(const RawBuffer &wrappingKeyId,
403 const Pwd &wrappingKeyPwd,
404 const CryptoAlgorithm &alg,
405 const RawBuffer &keyToWrapId,
406 const Pwd &keyToWrapPwd,
407 const DataType &keyToWrapType)
410 uint32_t ctrLenOrTagSizeBits = 0;
413 decompose(alg, algo, ctrLenOrTagSizeBits, iv, aad);
416 return TrustZoneContext::Instance().exportWrappedKey(wrappingKeyId,
424 toTzDataType(keyToWrapType));
427 RawBuffer getData(const RawBuffer &dataId,
429 const DataType &type)
432 TrustZoneContext::Instance().getData(dataId,
439 void destroyData(const RawBuffer &dataId)
441 TrustZoneContext::Instance().destroyData(dataId);
444 BufferPair encryptDataAesGcm(const RawBuffer &keyId,
448 const RawBuffer &data,
449 const RawBuffer &aad)
454 TrustZoneContext::Instance().executeEncryptAE(keyId, pwd, iv, tagSize,
455 aad, data, result, tag);
457 return std::make_pair(result, tag);
460 RawBuffer encryptDataAesGcmPacked(const RawBuffer &keyId,
464 const RawBuffer &data,
465 const RawBuffer &aad)
467 auto pair = encryptDataAesGcm(keyId, pwd, iv, tagSize, data, aad);
468 std::copy(pair.second.begin(), pair.second.end(),
469 std::back_inserter(pair.first));
473 RawBuffer decryptDataAesGcm(const RawBuffer &keyId,
477 const RawBuffer &tag,
478 const RawBuffer &data,
479 const RawBuffer &aad)
483 TrustZoneContext::Instance().executeDecryptAE(keyId, pwd, iv, tagSizeBits,
484 tag, aad, data, result);
489 RawBuffer decryptDataAesGcmPacked(const RawBuffer &keyId,
493 const RawBuffer &data,
494 const RawBuffer &aad)
496 int tagSizeBytes = tagSizeBits / 8;
497 if (tagSizeBytes > static_cast<int>(data.size()))
498 ThrowErr(Exc::Crypto::InputParam, "Wrong size of tag");
500 auto tagPos = data.data() + data.size() - tagSizeBytes;
501 return decryptDataAesGcm(keyId,
505 RawBuffer(tagPos, data.data() + data.size()),
506 RawBuffer(data.data(), tagPos),
511 RawBuffer symmetricEncrypt(const RawBuffer &keyId,
513 const CryptoAlgorithm &alg,
514 const RawBuffer &data)
516 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
520 case AlgoType::AES_CTR: {
521 ctrLen = unpack<uint64_t>(alg, ParamName::ED_CTR_LEN);
522 // counter length is in bits
523 if (ctrLen != Params::DEFAULT_AES_IV_LEN * 8) {
524 LogError("CTR length invalid: " << std::to_string(ctrLen));
525 ThrowErr(Exc::Crypto::InputParam, "Invalid CTR length");
527 // no break here, we still need to slide down to executeCrypt
530 case AlgoType::AES_CBC:
531 case AlgoType::AES_CFB: {
533 TrustZoneContext::Instance().executeCrypt(CMD_ENCRYPT,
537 unpack<RawBuffer>(alg, ParamName::ED_IV),
542 case AlgoType::AES_GCM: {
543 int tagLenBits = Params::DEFAULT_AES_GCM_TAG_LEN_BITS;
544 alg.getParam(ParamName::ED_TAG_LEN, tagLenBits);
546 alg.getParam(ParamName::ED_AAD, aad);
547 return encryptDataAesGcmPacked(keyId,
549 unpack<RawBuffer>(alg, ParamName::ED_IV),
558 ThrowErr(Exc::Crypto::OperationNotSupported,
559 "Incorrect algorithm provided for symmetric crypto operation");
562 RawBuffer symmetricDecrypt(const RawBuffer &keyId,
564 const CryptoAlgorithm &alg,
565 const RawBuffer &data)
567 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
571 case AlgoType::AES_CTR: {
572 ctrLen = unpack<uint64_t>(alg, ParamName::ED_CTR_LEN);
573 // counter length is in bits
574 if (ctrLen != Params::DEFAULT_AES_IV_LEN * 8) {
575 LogError("CTR length invalid: " << std::to_string(ctrLen));
576 ThrowErr(Exc::Crypto::InputParam, "Invalid CTR length");
578 // no break here, we still need to slide down to executeCrypt
581 case AlgoType::AES_CBC:
582 case AlgoType::AES_CFB: {
584 TrustZoneContext::Instance().executeCrypt(CMD_DECRYPT,
588 unpack<RawBuffer>(alg, ParamName::ED_IV),
593 case AlgoType::AES_GCM: {
594 int tagSizeBits = Params::DEFAULT_AES_GCM_TAG_LEN_BITS;
595 alg.getParam(ParamName::ED_TAG_LEN, tagSizeBits);
597 alg.getParam(ParamName::ED_AAD, aad);
598 return decryptDataAesGcmPacked(keyId,
600 unpack<RawBuffer>(alg, ParamName::ED_IV),
609 ThrowErr(Exc::Crypto::OperationNotSupported,
610 "Incorrect algorithm provided for symmetric crypto operation");
613 RawBuffer asymmetricEncrypt(const RawBuffer &keyId,
615 const CryptoAlgorithm &alg,
616 const RawBuffer &data)
618 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
623 case AlgoType::RSA_OAEP: {
624 TrustZoneContext::Instance().executeCrypt(CMD_ENCRYPT,
628 result, // unused dummy
637 ThrowErr(Exc::Crypto::OperationNotSupported,
638 "Incorrect algorithm provided for asymmetric crypto operation");
641 RawBuffer asymmetricDecrypt(const RawBuffer &keyId,
643 const CryptoAlgorithm &alg,
644 const RawBuffer &cipher)
646 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
651 case AlgoType::RSA_OAEP: {
652 TrustZoneContext::Instance().executeCrypt(CMD_DECRYPT,
656 result, // unused dummy
665 ThrowErr(Exc::Crypto::OperationNotSupported,
666 "Incorrect algorithm provided for asymmetric crypto operation");
669 uint32_t initCipher(const RawBuffer &keyId,
671 const CryptoAlgorithm &alg,
674 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
678 case AlgoType::AES_GCM: {
679 int tagSizeBits = Params::DEFAULT_AES_GCM_TAG_LEN_BITS;
680 alg.getParam(ParamName::ED_TAG_LEN, tagSizeBits);
682 alg.getParam(ParamName::ED_AAD, aad);
683 return TrustZoneContext::Instance().initGcmCipher(encrypt ? CIPHER_ENCRYPT : CIPHER_DECRYPT,
686 unpack<RawBuffer>(alg, ParamName::ED_IV),
690 case AlgoType::AES_CBC:
691 case AlgoType::AES_CTR:
692 case AlgoType::AES_CFB:
693 // TODO optionally implement above modes as well
698 ThrowErr(Exc::Crypto::OperationNotSupported,
699 "Incorrect algorithm provided for symmetric crypto operation");
702 void addAAD(uint32_t opId,
703 const RawBuffer &aad)
705 TrustZoneContext::Instance().addGcmAAD(opId, aad);
708 RawBuffer updateCipher(uint32_t opId,
709 const RawBuffer &data)
711 return TrustZoneContext::Instance().updateGcmCipher(opId, data);
714 RawBuffer finalizeCipher(uint32_t opId,
715 const RawBuffer &data)
717 return TrustZoneContext::Instance().finalizeGcmCipher(opId, data);
720 RawBuffer sign(const RawBuffer &pkeyId,
722 const CryptoAlgorithm &alg,
723 const RawBuffer &message)
725 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
726 HashAlgorithm hash = unpack<HashAlgorithm>(alg, ParamName::SV_HASH_ALGO);
727 if (algo != AlgoType::RSA_SV && hash == HashAlgorithm::NONE)
728 ThrowErr(Exc::Crypto::InputParam, "Only RSA supports no hash option");
731 TrustZoneContext::Instance().executeSign(getAlgType(algo),
740 int verify(const RawBuffer &pkeyId,
742 const CryptoAlgorithm &alg,
743 const RawBuffer &message,
744 const RawBuffer &signature)
746 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
747 HashAlgorithm hash = unpack<HashAlgorithm>(alg, ParamName::SV_HASH_ALGO);
748 if (algo != AlgoType::RSA_SV && hash == HashAlgorithm::NONE)
749 ThrowErr(Exc::Crypto::InputParam, "Only RSA supports no hash option");
751 return TrustZoneContext::Instance().executeVerify(getAlgType(algo),
759 void deriveECDH(const RawBuffer &prvKeyId,
760 const Pwd &prvKeyPwd,
761 const RawBuffer &pubKey,
762 const Password &secretPwd,
763 const RawBuffer &secretPwdIV,
764 RawBuffer &secretTag,
765 const RawBuffer &secretHash)
767 auto peerKey = std::make_shared<KeyImpl>(pubKey);
768 if (peerKey->getType() != KeyType::KEY_ECDSA_PUBLIC)
769 ThrowErr(Exc::Crypto::InputParam, "ECDH requires peer's public EC key");
770 auto peerEvp = peerKey->getEvpShPtr().get();
773 int subType = EVP_PKEY_type(EVP_PKEY_id(peerEvp));
774 if (subType != EVP_PKEY_EC)
775 ThrowErr(Exc::Crypto::InputParam, "Invalid key type: ", subType);
777 auto ecKey = EVP_PKEY_get0_EC_KEY(peerEvp);
779 ThrowErr(Exc::Crypto::InternalError, "Can't get EC key");
781 auto ecPoint = EC_KEY_get0_public_key(ecKey);
783 ThrowErr(Exc::Crypto::InternalError, "Can't get EC public key");
785 auto ecGroup = EC_KEY_get0_group(ecKey);
787 ThrowErr(Exc::Crypto::InternalError, "Can't get EC group");
789 BIGNUM *x = BN_new();
790 BIGNUM *y = BN_new();
791 if (!EC_POINT_get_affine_coordinates(ecGroup, ecPoint, x, y, NULL))
792 ThrowErr(Exc::Crypto::InternalError, "Failed to get EC pub key coordinates");
794 auto xBuf = extractBignumData(x);
795 auto yBuf = extractBignumData(y);
797 RawBuffer secretPwdBuf(secretPwd.begin(), secretPwd.end());
799 TrustZoneContext::Instance().executeEcdh(prvKeyId,
809 void deriveKBKDF(const RawBuffer &secretId,
810 const Pwd &secretPwd,
811 const CryptoAlgorithm &alg,
812 const Password &keyPwd,
813 const RawBuffer &keyPwdIV,
815 const RawBuffer &keyHash)
817 RawBuffer label, context, fixed;
819 alg.getParam(ParamName::KDF_LEN, length);
820 alg.getParam(ParamName::KBKDF_LABEL, label);
821 alg.getParam(ParamName::KBKDF_CONTEXT, context);
822 alg.getParam(ParamName::KBKDF_FIXED_INPUT, fixed);
823 auto prf = unpack<KdfPrf>(alg, ParamName::KDF_PRF);
824 auto mode = unpack<KbkdfMode>(alg, ParamName::KBKDF_MODE);
825 auto location = unpack<KbkdfCounterLocation>(alg, ParamName::KBKDF_COUNTER_LOCATION);
827 size_t rlen = 32, llen = 32, dummy;
828 alg.getParam(ParamName::KBKDF_RLEN, rlen);
829 alg.getParam(ParamName::KBKDF_LLEN, llen);
830 bool noSeparator = alg.getParam(ParamName::KBKDF_NO_SEPARATOR, dummy);
832 RawBuffer keyPwdBuf(keyPwd.begin(), keyPwd.end());
834 TrustZoneContext::Instance().executeKbkdf(secretId,
842 toTzCtrLoc(location),
852 size_t maxChunkSize()
854 return TrustZoneContext::Instance().getMaxChunkSize();
857 } // namespace Internals
859 } // namespace Crypto