Files
hardware_interfaces/keymaster/4.0/support/Keymaster3.cpp
Brian C. Young d98dcfb331 Filter USER_ID tag from the hardware keystore
An as-yet-undiscovered mismatch between authorization sets that do or
don't have the USER_ID tag applied are causing failures for PIN setting
on the secondary account. This changes makes sure those tags are not
sent to the underlying keystore to fix the PIN failure, while we
diagnose the underlying cause.

Bug: 76460912

Test: Switch to guest account, set PIN, lock and unlock.
Change-Id: I880899af5095a95ae41b7a64c5a76329f0f78f4a
2018-03-27 17:36:23 -07:00

295 lines
11 KiB
C++

/*
**
** Copyright 2017, 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.
*/
#include <keymasterV4_0/Keymaster3.h>
#include <android-base/logging.h>
#include <keymasterV4_0/keymaster_utils.h>
namespace android {
namespace hardware {
namespace keymaster {
namespace V4_0 {
namespace support {
using android::hardware::details::StatusOf;
namespace {
ErrorCode convert(V3_0::ErrorCode error) {
return static_cast<ErrorCode>(error);
}
V3_0::KeyPurpose convert(KeyPurpose purpose) {
return static_cast<V3_0::KeyPurpose>(purpose);
}
V3_0::KeyFormat convert(KeyFormat purpose) {
return static_cast<V3_0::KeyFormat>(purpose);
}
V3_0::KeyParameter convert(const KeyParameter& param) {
V3_0::KeyParameter converted;
converted.tag = static_cast<V3_0::Tag>(param.tag);
static_assert(sizeof(converted.f) == sizeof(param.f), "This function assumes sizes match");
memcpy(&converted.f, &param.f, sizeof(param.f));
converted.blob = param.blob;
return converted;
}
KeyParameter convert(const V3_0::KeyParameter& param) {
KeyParameter converted;
converted.tag = static_cast<Tag>(param.tag);
static_assert(sizeof(converted.f) == sizeof(param.f), "This function assumes sizes match");
memcpy(&converted.f, &param.f, sizeof(param.f));
converted.blob = param.blob;
return converted;
}
hidl_vec<V3_0::KeyParameter> convert(const hidl_vec<KeyParameter>& params) {
std::vector<V3_0::KeyParameter> converted;
converted.reserve(params.size());
for (const auto& param : params) {
// Qualcomm's Keymaster3 implementation behaves oddly if Tag::USER_ID is provided. Filter it
// out. Revert this change when b/73286437 is fixed.
if (param.tag != Tag::USER_ID) converted.push_back(convert(param));
}
return converted;
}
hidl_vec<KeyParameter> convert(const hidl_vec<V3_0::KeyParameter>& params) {
hidl_vec<KeyParameter> converted(params.size());
for (size_t i = 0; i < params.size(); ++i) {
converted[i] = convert(params[i]);
}
return converted;
}
template <typename T, typename OutIter>
inline static OutIter copy_bytes_to_iterator(const T& value, OutIter dest) {
const uint8_t* value_ptr = reinterpret_cast<const uint8_t*>(&value);
return std::copy(value_ptr, value_ptr + sizeof(value), dest);
}
hidl_vec<V3_0::KeyParameter> convertAndAddAuthToken(const hidl_vec<KeyParameter>& params,
const HardwareAuthToken& authToken) {
hidl_vec<V3_0::KeyParameter> converted(params.size() + 1);
for (size_t i = 0; i < params.size(); ++i) {
converted[i] = convert(params[i]);
}
converted[params.size()].tag = V3_0::Tag::AUTH_TOKEN;
converted[params.size()].blob = authToken2HidlVec(authToken);
return converted;
}
KeyCharacteristics convert(const V3_0::KeyCharacteristics& chars) {
KeyCharacteristics converted;
converted.hardwareEnforced = convert(chars.teeEnforced);
converted.softwareEnforced = convert(chars.softwareEnforced);
return converted;
}
} // namespace
void Keymaster3::getVersionIfNeeded() {
if (haveVersion_) return;
auto rc = km3_dev_->getHardwareFeatures(
[&](bool isSecure, bool supportsEllipticCurve, bool supportsSymmetricCryptography,
bool supportsAttestation, bool supportsAllDigests, const hidl_string& keymasterName,
const hidl_string& keymasterAuthorName) {
version_ = {keymasterName, keymasterAuthorName, 0 /* major version, filled below */,
isSecure ? SecurityLevel::TRUSTED_ENVIRONMENT : SecurityLevel::SOFTWARE,
supportsEllipticCurve};
supportsSymmetricCryptography_ = supportsSymmetricCryptography;
supportsAttestation_ = supportsAttestation;
supportsAllDigests_ = supportsAllDigests;
});
CHECK(rc.isOk()) << "Got error " << rc.description() << " trying to get hardware features";
if (version_.securityLevel == SecurityLevel::SOFTWARE) {
version_.majorVersion = 3;
} else if (supportsAttestation_) {
version_.majorVersion = 3; // Could be 2, doesn't matter.
} else if (supportsSymmetricCryptography_) {
version_.majorVersion = 1;
} else {
version_.majorVersion = 0;
}
}
Return<void> Keymaster3::getHardwareInfo(Keymaster3::getHardwareInfo_cb _hidl_cb) {
getVersionIfNeeded();
_hidl_cb(version_.securityLevel,
std::string(version_.keymasterName) + " (wrapped by keystore::Keymaster3)",
version_.authorName);
return Void();
}
Return<ErrorCode> Keymaster3::addRngEntropy(const hidl_vec<uint8_t>& data) {
auto rc = km3_dev_->addRngEntropy(data);
if (!rc.isOk()) {
return StatusOf<V3_0::ErrorCode, ErrorCode>(rc);
}
return convert(rc);
}
Return<void> Keymaster3::generateKey(const hidl_vec<KeyParameter>& keyParams,
generateKey_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, const hidl_vec<uint8_t>& keyBlob,
const V3_0::KeyCharacteristics& characteristics) {
_hidl_cb(convert(error), keyBlob, convert(characteristics));
};
auto rc = km3_dev_->generateKey(convert(keyParams), cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<void> Keymaster3::getKeyCharacteristics(const hidl_vec<uint8_t>& keyBlob,
const hidl_vec<uint8_t>& clientId,
const hidl_vec<uint8_t>& appData,
getKeyCharacteristics_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, const V3_0::KeyCharacteristics& chars) {
_hidl_cb(convert(error), convert(chars));
};
auto rc = km3_dev_->getKeyCharacteristics(keyBlob, clientId, appData, cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<void> Keymaster3::importKey(const hidl_vec<KeyParameter>& params, KeyFormat keyFormat,
const hidl_vec<uint8_t>& keyData, importKey_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, const hidl_vec<uint8_t>& keyBlob,
const V3_0::KeyCharacteristics& chars) {
_hidl_cb(convert(error), keyBlob, convert(chars));
};
auto rc = km3_dev_->importKey(convert(params), convert(keyFormat), keyData, cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<void> Keymaster3::exportKey(KeyFormat exportFormat, const hidl_vec<uint8_t>& keyBlob,
const hidl_vec<uint8_t>& clientId,
const hidl_vec<uint8_t>& appData, exportKey_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, const hidl_vec<uint8_t>& keyMaterial) {
_hidl_cb(convert(error), keyMaterial);
};
auto rc = km3_dev_->exportKey(convert(exportFormat), keyBlob, clientId, appData, cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<void> Keymaster3::attestKey(const hidl_vec<uint8_t>& keyToAttest,
const hidl_vec<KeyParameter>& attestParams,
attestKey_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, const hidl_vec<hidl_vec<uint8_t>>& certChain) {
_hidl_cb(convert(error), certChain);
};
auto rc = km3_dev_->attestKey(keyToAttest, convert(attestParams), cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<void> Keymaster3::upgradeKey(const hidl_vec<uint8_t>& keyBlobToUpgrade,
const hidl_vec<KeyParameter>& upgradeParams,
upgradeKey_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, const hidl_vec<uint8_t>& upgradedKeyBlob) {
_hidl_cb(convert(error), upgradedKeyBlob);
};
auto rc = km3_dev_->upgradeKey(keyBlobToUpgrade, convert(upgradeParams), cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<ErrorCode> Keymaster3::deleteKey(const hidl_vec<uint8_t>& keyBlob) {
auto rc = km3_dev_->deleteKey(keyBlob);
if (!rc.isOk()) return StatusOf<V3_0::ErrorCode, ErrorCode>(rc);
return convert(rc);
}
Return<ErrorCode> Keymaster3::deleteAllKeys() {
auto rc = km3_dev_->deleteAllKeys();
if (!rc.isOk()) return StatusOf<V3_0::ErrorCode, ErrorCode>(rc);
return convert(rc);
}
Return<ErrorCode> Keymaster3::destroyAttestationIds() {
auto rc = km3_dev_->destroyAttestationIds();
if (!rc.isOk()) return StatusOf<V3_0::ErrorCode, ErrorCode>(rc);
return convert(rc);
}
Return<void> Keymaster3::begin(KeyPurpose purpose, const hidl_vec<uint8_t>& key,
const hidl_vec<KeyParameter>& inParams,
const HardwareAuthToken& authToken, begin_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, const hidl_vec<V3_0::KeyParameter>& outParams,
OperationHandle operationHandle) {
_hidl_cb(convert(error), convert(outParams), operationHandle);
};
auto rc =
km3_dev_->begin(convert(purpose), key, convertAndAddAuthToken(inParams, authToken), cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<void> Keymaster3::update(uint64_t operationHandle, const hidl_vec<KeyParameter>& inParams,
const hidl_vec<uint8_t>& input, const HardwareAuthToken& authToken,
const VerificationToken& /* verificationToken */,
update_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, uint32_t inputConsumed,
const hidl_vec<V3_0::KeyParameter>& outParams, const hidl_vec<uint8_t>& output) {
_hidl_cb(convert(error), inputConsumed, convert(outParams), output);
};
auto rc =
km3_dev_->update(operationHandle, convertAndAddAuthToken(inParams, authToken), input, cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<void> Keymaster3::finish(uint64_t operationHandle, const hidl_vec<KeyParameter>& inParams,
const hidl_vec<uint8_t>& input, const hidl_vec<uint8_t>& signature,
const HardwareAuthToken& authToken,
const VerificationToken& /* verificationToken */,
finish_cb _hidl_cb) {
auto cb = [&](V3_0::ErrorCode error, const hidl_vec<V3_0::KeyParameter>& outParams,
const hidl_vec<uint8_t>& output) {
_hidl_cb(convert(error), convert(outParams), output);
};
auto rc = km3_dev_->finish(operationHandle, convertAndAddAuthToken(inParams, authToken), input,
signature, cb);
rc.isOk(); // move ctor prereq
return rc;
}
Return<ErrorCode> Keymaster3::abort(uint64_t operationHandle) {
auto rc = km3_dev_->abort(operationHandle);
if (!rc.isOk()) return StatusOf<V3_0::ErrorCode, ErrorCode>(rc);
return convert(rc);
}
} // namespace support
} // namespace V4_0
} // namespace keymaster
} // namespace hardware
} // namespace android