/* * Copyright 2021, The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #define LOG_TAG "javacard.keymint.device.rkp.strongbox-impl" #include "JavacardRemotelyProvisionedComponentDevice.h" #include #include #include #include #include namespace aidl::android::hardware::security::keymint { using cppbor::Array; using cppbor::EncodedItem; using cppcose::kCoseMac0EntryCount; using cppcose::kCoseMac0Payload; using ::keymint::javacard::Instruction; using std::string; // RKP error codes defined in keymint applet. constexpr int32_t kStatusFailed = 32000; constexpr int32_t kStatusInvalidMac = 32001; constexpr int32_t kStatusProductionKeyInTestRequest = 32002; constexpr int32_t kStatusTestKeyInProductionRequest = 32003; constexpr int32_t kStatusInvalidEek = 32004; constexpr int32_t kStatusInvalidState = 32005; namespace { keymaster_error_t translateRkpErrorCode(int32_t error) { switch (-error) { case kStatusFailed: case kStatusInvalidState: return static_cast(BnRemotelyProvisionedComponent::STATUS_FAILED); case kStatusInvalidMac: return static_cast(BnRemotelyProvisionedComponent::STATUS_INVALID_MAC); case kStatusProductionKeyInTestRequest: return static_cast( BnRemotelyProvisionedComponent::STATUS_PRODUCTION_KEY_IN_TEST_REQUEST); case kStatusTestKeyInProductionRequest: return static_cast( BnRemotelyProvisionedComponent::STATUS_TEST_KEY_IN_PRODUCTION_REQUEST); case kStatusInvalidEek: return static_cast(BnRemotelyProvisionedComponent::STATUS_INVALID_EEK); } return static_cast(error); } ScopedAStatus defaultHwInfo(RpcHardwareInfo* info) { info->versionNumber = 2; info->rpcAuthorName = "Google"; info->supportedEekCurve = RpcHardwareInfo::CURVE_P256; info->uniqueId = "strongbox keymint"; return ScopedAStatus::ok(); } uint32_t coseKeyEncodedSize(const std::vector& keysToSign) { uint32_t size = 0; for (auto& macKey : keysToSign) { auto [macedKeyItem, _, coseMacErrMsg] = cppbor::parse(macKey.macedKey); if (!macedKeyItem || !macedKeyItem->asArray() || macedKeyItem->asArray()->size() != kCoseMac0EntryCount) { LOG(ERROR) << "Invalid COSE_Mac0 structure"; return 0; } auto payload = macedKeyItem->asArray()->get(kCoseMac0Payload)->asBstr(); if (!payload) return 0; size += payload->value().size(); } return size; } } // namespace ScopedAStatus JavacardRemotelyProvisionedComponentDevice::getHardwareInfo(RpcHardwareInfo* info) { auto [item, err] = card_->sendRequest(Instruction::INS_GET_RKP_HARDWARE_INFO); std::optional optVersionNumber; std::optional optSupportedEekCurve; std::optional optRpcAuthorName; std::optional optUniqueId; if (err != KM_ERROR_OK || !(optVersionNumber = cbor_.getUint64(item, 1)) || !(optRpcAuthorName = cbor_.getByteArrayStr(item, 2)) || !(optSupportedEekCurve = cbor_.getUint64(item, 3)) || !(optUniqueId = cbor_.getByteArrayStr(item, 4))) { LOG(ERROR) << "Error in response of getHardwareInfo."; LOG(INFO) << "Returning defaultHwInfo in getHardwareInfo."; return defaultHwInfo(info); } info->rpcAuthorName = std::move(optRpcAuthorName.value()); info->versionNumber = static_cast(std::move(optVersionNumber.value())); info->supportedEekCurve = static_cast(std::move(optSupportedEekCurve.value())); info->uniqueId = std::move(optUniqueId.value()); return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::generateEcdsaP256KeyPair( bool testMode, MacedPublicKey* macedPublicKey, std::vector* privateKeyHandle) { cppbor::Array array; array.add(testMode); auto [item, err] = card_->sendRequest(Instruction::INS_GENERATE_RKP_KEY_CMD, array); if (err != KM_ERROR_OK) { LOG(ERROR) << "Error in sending generateEcdsaP256KeyPair."; return km_utils::kmError2ScopedAStatus(translateRkpErrorCode(err)); } std::optional> optMacedKey; std::optional> optPKeyHandle; if (!(optMacedKey = cbor_.getByteArrayVec(item, 1)) || !(optPKeyHandle = cbor_.getByteArrayVec(item, 2))) { LOG(ERROR) << "Error in decoding og response in generateEcdsaP256KeyPair."; return km_utils::kmError2ScopedAStatus(KM_ERROR_UNKNOWN_ERROR); } *privateKeyHandle = std::move(optPKeyHandle.value()); macedPublicKey->macedKey = std::move(optMacedKey.value()); return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::beginSendData( bool testMode, const std::vector& keysToSign) { uint32_t totalEncodedSize = coseKeyEncodedSize(keysToSign); cppbor::Array array; array.add(keysToSign.size()); array.add(totalEncodedSize); array.add(testMode); auto [_, err] = card_->sendRequest(Instruction::INS_BEGIN_SEND_DATA_CMD, array); if (err != KM_ERROR_OK) { LOG(ERROR) << "Error in beginSendData."; return km_utils::kmError2ScopedAStatus(translateRkpErrorCode(err)); } return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::updateMacedKey( const std::vector& keysToSign) { for (auto& macedPublicKey : keysToSign) { cppbor::Array array; array.add(EncodedItem(macedPublicKey.macedKey)); auto [_, err] = card_->sendRequest(Instruction::INS_UPDATE_KEY_CMD, array); if (err != KM_ERROR_OK) { LOG(ERROR) << "Error in updateMacedKey."; return km_utils::kmError2ScopedAStatus(translateRkpErrorCode(err)); } } return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::updateChallenge(const std::vector& challenge) { Array array; array.add(challenge); auto [_, err] = card_->sendRequest(Instruction::INS_UPDATE_CHALLENGE_CMD, array); if (err != KM_ERROR_OK) { LOG(ERROR) << "Error in updateChallenge."; return km_utils::kmError2ScopedAStatus(translateRkpErrorCode(err)); } return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::updateEEK( const std::vector& endpointEncCertChain) { std::vector eekChain = endpointEncCertChain; auto [_, err] = card_->sendRequest(Instruction::INS_UPDATE_EEK_CHAIN_CMD, eekChain); if (err != KM_ERROR_OK) { LOG(ERROR) << "Error in updateEEK."; return km_utils::kmError2ScopedAStatus(translateRkpErrorCode(err)); } return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::finishSendData( std::vector* keysToSignMac, DeviceInfo* deviceInfo, std::vector& coseEncryptProtectedHeader, cppbor::Map& coseEncryptUnProtectedHeader, std::vector& partialCipheredData, uint32_t& respFlag) { auto [item, err] = card_->sendRequest(Instruction::INS_FINISH_SEND_DATA_CMD); if (err != KM_ERROR_OK) { LOG(ERROR) << "Error in finishSendData."; return km_utils::kmError2ScopedAStatus(translateRkpErrorCode(err)); } auto optDecodedKeysToSignMac = cbor_.getByteArrayVec(item, 1); auto optDecodedDeviceInfo = cbor_.getByteArrayVec(item, 2); auto optCEncryptProtectedHeader = cbor_.getByteArrayVec(item, 3); auto optCEncryptUnProtectedHeader = cbor_.getMapItem(item, 4); auto optPCipheredData = cbor_.getByteArrayVec(item, 5); auto optRespFlag = cbor_.getUint64(item, 6); if (!optDecodedKeysToSignMac || !optDecodedDeviceInfo || !optCEncryptProtectedHeader || !optCEncryptUnProtectedHeader || !optPCipheredData || !optRespFlag) { LOG(ERROR) << "Error in decoding og response in finishSendData."; return km_utils::kmError2ScopedAStatus(KM_ERROR_UNKNOWN_ERROR); } *keysToSignMac = std::move(optDecodedKeysToSignMac.value()); deviceInfo->deviceInfo = std::move(optDecodedDeviceInfo.value()); coseEncryptProtectedHeader = std::move(optCEncryptProtectedHeader.value()); coseEncryptUnProtectedHeader = std::move(optCEncryptUnProtectedHeader.value()); partialCipheredData.insert(partialCipheredData.end(), optPCipheredData->begin(), optPCipheredData->end()); respFlag = std::move(optRespFlag.value()); return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::getResponse(std::vector& partialCipheredData, cppbor::Array& recepientStructure, uint32_t& respFlag) { auto [item, err] = card_->sendRequest(Instruction::INS_GET_RESPONSE_CMD); if (err != KM_ERROR_OK) { LOG(ERROR) << "Error in getResponse."; return km_utils::kmError2ScopedAStatus(translateRkpErrorCode(err)); } auto optPCipheredData = cbor_.getByteArrayVec(item, 1); auto optArray = cbor_.getArrayItem(item, 2); auto optRespFlag = cbor_.getUint64(item, 3); if (!optPCipheredData || !optArray || !optRespFlag) { LOG(ERROR) << "Error in decoding og response in getResponse."; return km_utils::kmError2ScopedAStatus(KM_ERROR_UNKNOWN_ERROR); } recepientStructure = std::move(optArray.value()); partialCipheredData.insert(partialCipheredData.end(), optPCipheredData->begin(), optPCipheredData->end()); respFlag = std::move(optRespFlag.value()); return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::generateCertificateRequest( bool testMode, const std::vector& keysToSign, const std::vector& endpointEncCertChain, const std::vector& challenge, DeviceInfo* deviceInfo, ProtectedData* protectedData, std::vector* keysToSignMac) { std::vector coseEncryptProtectedHeader; cppbor::Map coseEncryptUnProtectedHeader; cppbor::Array recipients; std::vector cipheredData; uint32_t respFlag; auto ret = beginSendData(testMode, keysToSign); if (!ret.isOk()) return ret; ret = updateMacedKey(keysToSign); if (!ret.isOk()) return ret; ret = updateChallenge(challenge); if (!ret.isOk()) return ret; ret = updateEEK(endpointEncCertChain); if (!ret.isOk()) return ret; ret = finishSendData(keysToSignMac, deviceInfo, coseEncryptProtectedHeader, coseEncryptUnProtectedHeader, cipheredData, respFlag); if (!ret.isOk()) return ret; while (respFlag != 0) { // more data is pending to receive ret = getResponse(cipheredData, recipients, respFlag); if (!ret.isOk()) return ret; } // Create ConseEncrypt structure. protectedData->protectedData = cppbor::Array() .add(coseEncryptProtectedHeader) // Protected .add(std::move(coseEncryptUnProtectedHeader)) // Unprotected .add(cipheredData) // Payload .add(std::move(recipients)) .encode(); return ScopedAStatus::ok(); } ScopedAStatus JavacardRemotelyProvisionedComponentDevice::generateCertificateRequestV2( const std::vector& /*keysToSign*/, const std::vector& /*challenge*/, std::vector* /*csr*/) { return km_utils::kmError2ScopedAStatus(KM_ERROR_UNIMPLEMENTED); } } // namespace aidl::android::hardware::security::keymint