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_DSA_PUBLIC: return TYPE_AKEY_PUBLIC_DSA;
99 case CKM::DataType::KEY_RSA_PUBLIC: return TYPE_AKEY_PUBLIC_RSA;
101 ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported,
102 "Data type could not be imported by tz-backend");
106 tz_ec toTzEc(CKM::ElipticCurve ec)
109 case CKM::ElipticCurve::prime192v1: return EC_NIST_P192;
110 case CKM::ElipticCurve::prime256v1: return EC_NIST_P256;
111 case CKM::ElipticCurve::secp384r1: return EC_NIST_P384;
112 default: ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported, "EC not supported by tz-backend");
116 tz_prf toTzPrf(CKM::KdfPrf prf)
119 case CKM::KdfPrf::HMAC_SHA256: return PRF_HMAC_SHA256;
120 case CKM::KdfPrf::HMAC_SHA384: return PRF_HMAC_SHA384;
121 case CKM::KdfPrf::HMAC_SHA512: return PRF_HMAC_SHA512;
122 default: ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported, "PRF not supported by tz-backend");
126 tz_kbkdf_mode toTzKbkdfMode(CKM::KbkdfMode mode)
129 case CKM::KbkdfMode::COUNTER: return KBKDF_MODE_COUNTER;
131 ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported, "KBKDF mode not supported by tz-backend");
135 tz_kbkdf_ctr_loc toTzCtrLoc(CKM::KbkdfCounterLocation loc)
138 case CKM::KbkdfCounterLocation::BEFORE_FIXED: return KBKDF_LOC_BEFORE_FIXED;
139 case CKM::KbkdfCounterLocation::AFTER_FIXED: return KBKDF_LOC_AFTER_FIXED;
140 case CKM::KbkdfCounterLocation::MIDDLE_FIXED: return KBKDF_LOC_MIDDLE_FIXED;
142 ThrowErr(CKM::Exc::Crypto::DataTypeNotSupported,
143 "KBKDF counter location not supported by tz-backend");
152 namespace Internals {
154 tz_algo_type getGenSKeyType(AlgoType type)
158 case AlgoType::AES_GEN: return ALGO_AES_GEN;
159 default: ThrowErr(Exc::Crypto::OperationNotSupported, "Requested algorithm is not supported");
163 tz_algo_type getAlgType(AlgoType type)
167 case AlgoType::AES_CBC: return ALGO_AES_CBC;
168 case AlgoType::AES_CTR: return ALGO_AES_CTR;
169 case AlgoType::AES_CFB: return ALGO_AES_CFB;
170 case AlgoType::AES_GCM: return ALGO_AES_GCM;
171 case AlgoType::RSA_OAEP: return ALGO_RSA;
172 case AlgoType::RSA_SV: return ALGO_RSA_SV;
173 case AlgoType::DSA_SV: return ALGO_DSA_SV;
174 case AlgoType::ECDSA_SV: return ALGO_ECDSA_SV;
175 default: ThrowErr(Exc::Crypto::OperationNotSupported, "Requested algorithm is not supported");
179 tz_hash_type getHashType(HashAlgorithm hash)
183 case HashAlgorithm::SHA1: return HASH_SHA1;
184 case HashAlgorithm::SHA256: return HASH_SHA256;
185 case HashAlgorithm::SHA384: return HASH_SHA384;
186 case HashAlgorithm::SHA512: return HASH_SHA512;
188 ThrowErr(Exc::Crypto::OperationNotSupported, "Requested algorithm is not supported");
192 RawBuffer generateIV()
195 TrustZoneContext::Instance().generateIV(result);
199 void generateSKey(const CryptoAlgorithm &alg,
203 const RawBuffer &hash)
205 AlgoType keyType = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
206 int keyBits = unpack<int>(alg, ParamName::GEN_KEY_LEN);
210 ThrowErr(Exc::InputParam, "Key generation with password encryption requires an IV");
213 RawBuffer pwdBuf(pwd.begin(), pwd.end());
214 TrustZoneContext::Instance().generateSKeyPwd(getGenSKeyType(keyType),
218 TrustZoneContext::Instance().generateSKey(getGenSKeyType(keyType), keyBits,
224 AlgoType generateAKey(const CryptoAlgorithm &alg,
225 const Password &pubPwd,
226 const Password &privPwd,
227 const RawBuffer &pubPwdIv,
228 const RawBuffer &privPwdIv,
231 const RawBuffer &hashPriv,
232 const RawBuffer &hashPub)
234 AlgoType keyType = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
238 pubPwdBuf.assign(pubPwd.begin(), pubPwd.end());
240 RawBuffer privPwdBuf;
241 if (!privPwd.empty())
242 privPwdBuf.assign(privPwd.begin(), privPwd.end());
245 case AlgoType::RSA_GEN: {
246 int keyBits = unpack<int>(alg, ParamName::GEN_KEY_LEN);
247 TrustZoneContext::Instance().generateRSAKey(keyBits,
258 case AlgoType::DSA_GEN: {
259 int keyBits = unpack<int>(alg, ParamName::GEN_KEY_LEN);
263 generateDSAParams(keyBits, prime, subprime, base);
264 TrustZoneContext::Instance().generateDSAKey(keyBits,
278 case AlgoType::ECDSA_GEN: {
279 CKM::ElipticCurve ec = unpack<CKM::ElipticCurve>(alg, ParamName::GEN_EC);
280 TrustZoneContext::Instance().generateECKey(toTzEc(ec),
292 ThrowErr(Exc::Crypto::InputParam,
293 "Invalid algo type provided for generateAKey function");
300 void destroyKey(const RawBuffer &key)
302 TrustZoneContext::Instance().executeDestroy(key);
305 void importData(const Data &data,
306 const EncryptionParams &encData,
308 const RawBuffer &pwdIV,
310 const RawBuffer &hash)
313 const auto dataType = toTzDataType(data.type);
315 RawBuffer pwdBuf(pwd.begin(), pwd.end());
316 uint32_t keySizeBits = data.data.size() * 8;
317 TrustZoneContext::Instance().importData(dataType,
327 RawBuffer getData(const RawBuffer &dataId,
331 TrustZoneContext::Instance().getData(dataId,
337 void destroyData(const RawBuffer &dataId)
339 TrustZoneContext::Instance().destroyData(dataId);
342 BufferPair encryptDataAesGcm(const RawBuffer &key,
346 const RawBuffer &data,
347 const RawBuffer &aad)
352 TrustZoneContext::Instance().executeEncryptAE(key, pwd, iv, tagSize,
353 aad, data, result, tag);
355 return std::make_pair(result, tag);
358 RawBuffer encryptDataAesGcmPacked(const RawBuffer &key,
362 const RawBuffer &data,
363 const RawBuffer &aad)
365 auto pair = encryptDataAesGcm(key, pwd, iv, tagSize, data, aad);
366 std::copy(pair.second.begin(), pair.second.end(),
367 std::back_inserter(pair.first));
371 RawBuffer decryptDataAesGcm(const RawBuffer &key,
375 const RawBuffer &tag,
376 const RawBuffer &data,
377 const RawBuffer &aad)
381 TrustZoneContext::Instance().executeDecryptAE(key, pwd, iv, tagSizeBits,
382 tag, aad, data, result);
387 RawBuffer decryptDataAesGcmPacked(const RawBuffer &key,
391 const RawBuffer &data,
392 const RawBuffer &aad)
394 int tagSizeBytes = tagSizeBits / 8;
395 if (tagSizeBytes > static_cast<int>(data.size()))
396 ThrowErr(Exc::Crypto::InputParam, "Wrong size of tag");
398 auto tagPos = data.data() + data.size() - tagSizeBytes;
399 return decryptDataAesGcm(key,
403 RawBuffer(tagPos, data.data() + data.size()),
404 RawBuffer(data.data(), tagPos),
409 RawBuffer symmetricEncrypt(const RawBuffer &key,
411 const CryptoAlgorithm &alg,
412 const RawBuffer &data)
414 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
418 case AlgoType::AES_CTR: {
419 ctrLen = unpack<uint64_t>(alg, ParamName::ED_CTR_LEN);
420 // counter length is in bits
421 if (ctrLen != Params::DEFAULT_AES_IV_LEN * 8) {
422 LogError("CTR length invalid: " << std::to_string(ctrLen));
423 ThrowErr(Exc::Crypto::InputParam, "Invalid CTR length");
425 // no break here, we still need to slide down to executeCrypt
428 case AlgoType::AES_CBC:
429 case AlgoType::AES_CFB: {
431 TrustZoneContext::Instance().executeCrypt(CMD_ENCRYPT,
435 unpack<RawBuffer>(alg, ParamName::ED_IV),
440 case AlgoType::AES_GCM: {
441 int tagLenBits = Params::DEFAULT_AES_GCM_TAG_LEN_BITS;
442 alg.getParam(ParamName::ED_TAG_LEN, tagLenBits);
444 alg.getParam(ParamName::ED_AAD, aad);
445 return encryptDataAesGcmPacked(key,
447 unpack<RawBuffer>(alg, ParamName::ED_IV),
456 ThrowErr(Exc::Crypto::OperationNotSupported,
457 "Incorrect algorithm provided for symmetric crypto operation");
460 RawBuffer symmetricDecrypt(const RawBuffer &key,
462 const CryptoAlgorithm &alg,
463 const RawBuffer &data)
465 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
469 case AlgoType::AES_CTR: {
470 ctrLen = unpack<uint64_t>(alg, ParamName::ED_CTR_LEN);
471 // counter length is in bits
472 if (ctrLen != Params::DEFAULT_AES_IV_LEN * 8) {
473 LogError("CTR length invalid: " << std::to_string(ctrLen));
474 ThrowErr(Exc::Crypto::InputParam, "Invalid CTR length");
476 // no break here, we still need to slide down to executeCrypt
479 case AlgoType::AES_CBC:
480 case AlgoType::AES_CFB: {
482 TrustZoneContext::Instance().executeCrypt(CMD_DECRYPT,
486 unpack<RawBuffer>(alg, ParamName::ED_IV),
491 case AlgoType::AES_GCM: {
492 int tagSizeBits = Params::DEFAULT_AES_GCM_TAG_LEN_BITS;
493 alg.getParam(ParamName::ED_TAG_LEN, tagSizeBits);
495 alg.getParam(ParamName::ED_AAD, aad);
496 return decryptDataAesGcmPacked(key,
498 unpack<RawBuffer>(alg, ParamName::ED_IV),
507 ThrowErr(Exc::Crypto::OperationNotSupported,
508 "Incorrect algorithm provided for symmetric crypto operation");
511 RawBuffer asymmetricEncrypt(const RawBuffer &key,
513 const CryptoAlgorithm &alg,
514 const RawBuffer &data)
516 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
521 case AlgoType::RSA_OAEP: {
522 TrustZoneContext::Instance().executeCrypt(CMD_ENCRYPT,
526 result, // unused dummy
535 ThrowErr(Exc::Crypto::OperationNotSupported,
536 "Incorrect algorithm provided for asymmetric crypto operation");
539 RawBuffer asymmetricDecrypt(const RawBuffer &key,
541 const CryptoAlgorithm &alg,
542 const RawBuffer &cipher)
544 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
549 case AlgoType::RSA_OAEP: {
550 TrustZoneContext::Instance().executeCrypt(CMD_DECRYPT,
554 result, // unused dummy
563 ThrowErr(Exc::Crypto::OperationNotSupported,
564 "Incorrect algorithm provided for asymmetric crypto operation");
567 RawBuffer sign(const RawBuffer &pkey,
569 const CryptoAlgorithm &alg,
570 const RawBuffer &message)
572 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
573 HashAlgorithm hash = unpack<HashAlgorithm>(alg, ParamName::SV_HASH_ALGO);
574 if (algo != AlgoType::RSA_SV && hash == HashAlgorithm::NONE)
575 ThrowErr(Exc::Crypto::InputParam, "Only RSA supports no hash option");
578 TrustZoneContext::Instance().executeSign(getAlgType(algo),
587 int verify(const RawBuffer &pkey,
589 const CryptoAlgorithm &alg,
590 const RawBuffer &message,
591 const RawBuffer &signature)
593 AlgoType algo = unpack<AlgoType>(alg, ParamName::ALGO_TYPE);
594 HashAlgorithm hash = unpack<HashAlgorithm>(alg, ParamName::SV_HASH_ALGO);
595 if (algo != AlgoType::RSA_SV && hash == HashAlgorithm::NONE)
596 ThrowErr(Exc::Crypto::InputParam, "Only RSA supports no hash option");
598 return TrustZoneContext::Instance().executeVerify(getAlgType(algo),
606 void deriveECDH(const RawBuffer &prvKey,
607 const Pwd &prvKeyPwd,
608 const RawBuffer &pubKey,
609 const Password &secretPwd,
610 const RawBuffer &secretPwdIV,
611 RawBuffer &secretTag,
612 const RawBuffer &secretHash)
614 auto peerKey = std::make_shared<KeyImpl>(pubKey);
615 if (peerKey->getType() != KeyType::KEY_ECDSA_PUBLIC)
616 ThrowErr(Exc::Crypto::InputParam, "ECDH requires peer's public EC key");
617 auto peerEvp = peerKey->getEvpShPtr().get();
620 int subType = EVP_PKEY_type(EVP_PKEY_id(peerEvp));
621 if (subType != EVP_PKEY_EC)
622 ThrowErr(Exc::Crypto::InputParam, "Invalid key type: ", subType);
624 auto ecKey = EVP_PKEY_get0_EC_KEY(peerEvp);
626 ThrowErr(Exc::Crypto::InternalError, "Can't get EC key");
628 auto ecPoint = EC_KEY_get0_public_key(ecKey);
630 ThrowErr(Exc::Crypto::InternalError, "Can't get EC public key");
632 auto ecGroup = EC_KEY_get0_group(ecKey);
634 ThrowErr(Exc::Crypto::InternalError, "Can't get EC group");
636 BIGNUM *x = BN_new();
637 BIGNUM *y = BN_new();
638 if (!EC_POINT_get_affine_coordinates(ecGroup, ecPoint, x, y, NULL))
639 ThrowErr(Exc::Crypto::InternalError, "Failed to get EC pub key coordinates");
641 auto xBuf = extractBignumData(x);
642 auto yBuf = extractBignumData(y);
644 RawBuffer secretPwdBuf(secretPwd.begin(), secretPwd.end());
646 TrustZoneContext::Instance().executeEcdh(prvKey,
656 void deriveKBKDF(const RawBuffer &secret,
657 const CryptoAlgorithm &alg,
658 const Password &keyPwd,
659 const RawBuffer &keyPwdIV,
661 const RawBuffer &keyHash)
663 auto prf = unpack<KdfPrf>(alg, ParamName::KDF_PRF);
664 auto mode = unpack<KbkdfMode>(alg, ParamName::KBKDF_MODE);
665 auto location = unpack<KbkdfCounterLocation>(alg, ParamName::KBKDF_COUNTER_LOCATION);
667 size_t rlen = 32, llen = 32, dummy;
668 alg.getParam(ParamName::KBKDF_RLEN, rlen);
669 alg.getParam(ParamName::KBKDF_LLEN, llen);
670 bool noSeparator = alg.getParam(ParamName::KBKDF_NO_SEPARATOR, dummy);
672 RawBuffer keyPwdBuf(keyPwd.begin(), keyPwd.end());
674 TrustZoneContext::Instance().executeKbkdf(secret,
677 toTzCtrLoc(location),
688 } // namespace Internals
690 } // namespace Crypto