/*
|
* Copyright 2014 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 <keymaster/android_keymaster.h>
|
|
#include <assert.h>
|
#include <string.h>
|
|
#include <stddef.h>
|
|
#include <keymaster/UniquePtr.h>
|
#include <keymaster/android_keymaster_utils.h>
|
#include <keymaster/key.h>
|
#include <keymaster/key_blob_utils/ae.h>
|
#include <keymaster/key_factory.h>
|
#include <keymaster/keymaster_context.h>
|
#include <keymaster/km_openssl/openssl_err.h>
|
#include <keymaster/operation.h>
|
#include <keymaster/operation_table.h>
|
|
namespace keymaster {
|
|
namespace {
|
|
const uint8_t MAJOR_VER = 2;
|
const uint8_t MINOR_VER = 0;
|
const uint8_t SUBMINOR_VER = 0;
|
|
keymaster_error_t CheckVersionInfo(const AuthorizationSet& tee_enforced,
|
const AuthorizationSet& sw_enforced,
|
const KeymasterContext& context) {
|
uint32_t os_version;
|
uint32_t os_patchlevel;
|
context.GetSystemVersion(&os_version, &os_patchlevel);
|
|
uint32_t key_os_patchlevel;
|
if (tee_enforced.GetTagValue(TAG_OS_PATCHLEVEL, &key_os_patchlevel) ||
|
sw_enforced.GetTagValue(TAG_OS_PATCHLEVEL, &key_os_patchlevel)) {
|
if (key_os_patchlevel < os_patchlevel)
|
return KM_ERROR_KEY_REQUIRES_UPGRADE;
|
else if (key_os_patchlevel > os_patchlevel)
|
return KM_ERROR_INVALID_KEY_BLOB;
|
}
|
|
return KM_ERROR_OK;
|
}
|
|
} // anonymous namespace
|
|
AndroidKeymaster::AndroidKeymaster(KeymasterContext* context, size_t operation_table_size)
|
: context_(context), operation_table_(new(std::nothrow) OperationTable(operation_table_size)) {}
|
|
AndroidKeymaster::~AndroidKeymaster() {}
|
|
AndroidKeymaster::AndroidKeymaster(AndroidKeymaster&& other)
|
: context_(move(other.context_)), operation_table_(move(other.operation_table_)) {}
|
|
// TODO(swillden): Unify support analysis. Right now, we have per-keytype methods that determine if
|
// specific modes, padding, etc. are supported for that key type, and AndroidKeymaster also has
|
// methods that return the same information. They'll get out of sync. Best to put the knowledge in
|
// the keytypes and provide some mechanism for AndroidKeymaster to query the keytypes for the
|
// information.
|
|
template <typename T>
|
bool check_supported(const KeymasterContext& context, keymaster_algorithm_t algorithm,
|
SupportedResponse<T>* response) {
|
if (context.GetKeyFactory(algorithm) == nullptr) {
|
response->error = KM_ERROR_UNSUPPORTED_ALGORITHM;
|
return false;
|
}
|
return true;
|
}
|
|
void AndroidKeymaster::GetVersion(const GetVersionRequest&, GetVersionResponse* rsp) {
|
if (rsp == nullptr)
|
return;
|
|
rsp->major_ver = MAJOR_VER;
|
rsp->minor_ver = MINOR_VER;
|
rsp->subminor_ver = SUBMINOR_VER;
|
rsp->error = KM_ERROR_OK;
|
}
|
|
void AndroidKeymaster::SupportedAlgorithms(const SupportedAlgorithmsRequest& /* request */,
|
SupportedAlgorithmsResponse* response) {
|
if (response == nullptr)
|
return;
|
|
response->error = KM_ERROR_OK;
|
|
size_t algorithm_count = 0;
|
const keymaster_algorithm_t* algorithms = context_->GetSupportedAlgorithms(&algorithm_count);
|
if (algorithm_count == 0)
|
return;
|
response->results_length = algorithm_count;
|
response->results = dup_array(algorithms, algorithm_count);
|
if (!response->results)
|
response->error = KM_ERROR_MEMORY_ALLOCATION_FAILED;
|
}
|
|
template <typename T>
|
void GetSupported(const KeymasterContext& context, keymaster_algorithm_t algorithm,
|
keymaster_purpose_t purpose,
|
const T* (OperationFactory::*get_supported_method)(size_t* count) const,
|
SupportedResponse<T>* response) {
|
if (response == nullptr || !check_supported(context, algorithm, response))
|
return;
|
|
const OperationFactory* factory = context.GetOperationFactory(algorithm, purpose);
|
if (!factory) {
|
response->error = KM_ERROR_UNSUPPORTED_PURPOSE;
|
return;
|
}
|
|
size_t count;
|
const T* supported = (factory->*get_supported_method)(&count);
|
response->SetResults(supported, count);
|
}
|
|
void AndroidKeymaster::SupportedBlockModes(const SupportedBlockModesRequest& request,
|
SupportedBlockModesResponse* response) {
|
GetSupported(*context_, request.algorithm, request.purpose,
|
&OperationFactory::SupportedBlockModes, response);
|
}
|
|
void AndroidKeymaster::SupportedPaddingModes(const SupportedPaddingModesRequest& request,
|
SupportedPaddingModesResponse* response) {
|
GetSupported(*context_, request.algorithm, request.purpose,
|
&OperationFactory::SupportedPaddingModes, response);
|
}
|
|
void AndroidKeymaster::SupportedDigests(const SupportedDigestsRequest& request,
|
SupportedDigestsResponse* response) {
|
GetSupported(*context_, request.algorithm, request.purpose, &OperationFactory::SupportedDigests,
|
response);
|
}
|
|
void AndroidKeymaster::SupportedImportFormats(const SupportedImportFormatsRequest& request,
|
SupportedImportFormatsResponse* response) {
|
if (response == nullptr || !check_supported(*context_, request.algorithm, response))
|
return;
|
|
size_t count;
|
const keymaster_key_format_t* formats =
|
context_->GetKeyFactory(request.algorithm)->SupportedImportFormats(&count);
|
response->SetResults(formats, count);
|
}
|
|
void AndroidKeymaster::SupportedExportFormats(const SupportedExportFormatsRequest& request,
|
SupportedExportFormatsResponse* response) {
|
if (response == nullptr || !check_supported(*context_, request.algorithm, response))
|
return;
|
|
size_t count;
|
const keymaster_key_format_t* formats =
|
context_->GetKeyFactory(request.algorithm)->SupportedExportFormats(&count);
|
response->SetResults(formats, count);
|
}
|
|
GetHmacSharingParametersResponse AndroidKeymaster::GetHmacSharingParameters() {
|
GetHmacSharingParametersResponse response;
|
KeymasterEnforcement* policy = context_->enforcement_policy();
|
if (!policy) {
|
response.error = KM_ERROR_UNIMPLEMENTED;
|
return response;
|
}
|
|
response.error = policy->GetHmacSharingParameters(&response.params);
|
return response;
|
}
|
|
ComputeSharedHmacResponse
|
AndroidKeymaster::ComputeSharedHmac(const ComputeSharedHmacRequest& request) {
|
ComputeSharedHmacResponse response;
|
KeymasterEnforcement* policy = context_->enforcement_policy();
|
if (!policy) {
|
response.error = KM_ERROR_UNIMPLEMENTED;
|
return response;
|
}
|
|
response.error = policy->ComputeSharedHmac(request.params_array, &response.sharing_check);
|
return response;
|
}
|
|
VerifyAuthorizationResponse
|
AndroidKeymaster::VerifyAuthorization(const VerifyAuthorizationRequest& request) {
|
KeymasterEnforcement* policy = context_->enforcement_policy();
|
if (!policy) {
|
VerifyAuthorizationResponse response;
|
response.error = KM_ERROR_UNIMPLEMENTED;
|
return response;
|
}
|
|
return policy->VerifyAuthorization(request);
|
}
|
|
void AndroidKeymaster::AddRngEntropy(const AddEntropyRequest& request,
|
AddEntropyResponse* response) {
|
response->error = context_->AddRngEntropy(request.random_data.peek_read(),
|
request.random_data.available_read());
|
}
|
|
void AndroidKeymaster::GenerateKey(const GenerateKeyRequest& request,
|
GenerateKeyResponse* response) {
|
if (response == nullptr)
|
return;
|
|
keymaster_algorithm_t algorithm;
|
const KeyFactory* factory = nullptr;
|
UniquePtr<Key> key;
|
if (!request.key_description.GetTagValue(TAG_ALGORITHM, &algorithm) ||
|
!(factory = context_->GetKeyFactory(algorithm)))
|
response->error = KM_ERROR_UNSUPPORTED_ALGORITHM;
|
else {
|
KeymasterKeyBlob key_blob;
|
response->enforced.Clear();
|
response->unenforced.Clear();
|
response->error = factory->GenerateKey(request.key_description, &key_blob,
|
&response->enforced, &response->unenforced);
|
if (response->error == KM_ERROR_OK)
|
response->key_blob = key_blob.release();
|
}
|
}
|
|
void AndroidKeymaster::GetKeyCharacteristics(const GetKeyCharacteristicsRequest& request,
|
GetKeyCharacteristicsResponse* response) {
|
if (response == nullptr)
|
return;
|
|
UniquePtr<Key> key;
|
response->error =
|
context_->ParseKeyBlob(KeymasterKeyBlob(request.key_blob), request.additional_params,
|
&key);
|
if (response->error != KM_ERROR_OK)
|
return;
|
|
// scavenge the key object for the auth lists
|
response->enforced = move(key->hw_enforced());
|
response->unenforced = move(key->sw_enforced());
|
|
response->error = CheckVersionInfo(response->enforced, response->unenforced, *context_);
|
}
|
|
void AndroidKeymaster::BeginOperation(const BeginOperationRequest& request,
|
BeginOperationResponse* response) {
|
if (response == nullptr)
|
return;
|
response->op_handle = 0;
|
|
const KeyFactory* key_factory;
|
UniquePtr<Key> key;
|
response->error = LoadKey(request.key_blob, request.additional_params, &key_factory, &key);
|
if (response->error != KM_ERROR_OK)
|
return;
|
|
response->error = KM_ERROR_UNKNOWN_ERROR;
|
keymaster_algorithm_t key_algorithm;
|
if (!key->authorizations().GetTagValue(TAG_ALGORITHM, &key_algorithm))
|
return;
|
|
response->error = KM_ERROR_UNSUPPORTED_PURPOSE;
|
OperationFactory* factory = key_factory->GetOperationFactory(request.purpose);
|
if (!factory) return;
|
|
OperationPtr operation(
|
factory->CreateOperation(move(*key), request.additional_params, &response->error));
|
if (operation.get() == nullptr) return;
|
|
if (context_->enforcement_policy()) {
|
km_id_t key_id;
|
response->error = KM_ERROR_UNKNOWN_ERROR;
|
if (!context_->enforcement_policy()->CreateKeyId(request.key_blob, &key_id)) return;
|
operation->set_key_id(key_id);
|
response->error = context_->enforcement_policy()->AuthorizeOperation(
|
request.purpose, key_id, operation->authorizations(), request.additional_params,
|
0 /* op_handle */, true /* is_begin_operation */);
|
if (response->error != KM_ERROR_OK) return;
|
}
|
|
response->output_params.Clear();
|
response->error = operation->Begin(request.additional_params, &response->output_params);
|
if (response->error != KM_ERROR_OK)
|
return;
|
|
response->op_handle = operation->operation_handle();
|
response->error = operation_table_->Add(move(operation));
|
}
|
|
void AndroidKeymaster::UpdateOperation(const UpdateOperationRequest& request,
|
UpdateOperationResponse* response) {
|
if (response == nullptr)
|
return;
|
|
response->error = KM_ERROR_INVALID_OPERATION_HANDLE;
|
Operation* operation = operation_table_->Find(request.op_handle);
|
if (operation == nullptr)
|
return;
|
|
if (context_->enforcement_policy()) {
|
response->error = context_->enforcement_policy()->AuthorizeOperation(
|
operation->purpose(), operation->key_id(), operation->authorizations(),
|
request.additional_params, request.op_handle, false /* is_begin_operation */);
|
if (response->error != KM_ERROR_OK) {
|
operation_table_->Delete(request.op_handle);
|
return;
|
}
|
}
|
|
response->error =
|
operation->Update(request.additional_params, request.input, &response->output_params,
|
&response->output, &response->input_consumed);
|
if (response->error != KM_ERROR_OK) {
|
// Any error invalidates the operation.
|
operation_table_->Delete(request.op_handle);
|
}
|
}
|
|
void AndroidKeymaster::FinishOperation(const FinishOperationRequest& request,
|
FinishOperationResponse* response) {
|
if (response == nullptr)
|
return;
|
|
response->error = KM_ERROR_INVALID_OPERATION_HANDLE;
|
Operation* operation = operation_table_->Find(request.op_handle);
|
if (operation == nullptr)
|
return;
|
|
if (context_->enforcement_policy()) {
|
response->error = context_->enforcement_policy()->AuthorizeOperation(
|
operation->purpose(), operation->key_id(), operation->authorizations(),
|
request.additional_params, request.op_handle, false /* is_begin_operation */);
|
if (response->error != KM_ERROR_OK) {
|
operation_table_->Delete(request.op_handle);
|
return;
|
}
|
}
|
|
response->error = operation->Finish(request.additional_params, request.input, request.signature,
|
&response->output_params, &response->output);
|
operation_table_->Delete(request.op_handle);
|
}
|
|
void AndroidKeymaster::AbortOperation(const AbortOperationRequest& request,
|
AbortOperationResponse* response) {
|
if (!response)
|
return;
|
|
Operation* operation = operation_table_->Find(request.op_handle);
|
if (!operation) {
|
response->error = KM_ERROR_INVALID_OPERATION_HANDLE;
|
return;
|
}
|
|
response->error = operation->Abort();
|
operation_table_->Delete(request.op_handle);
|
}
|
|
void AndroidKeymaster::ExportKey(const ExportKeyRequest& request, ExportKeyResponse* response) {
|
if (response == nullptr)
|
return;
|
|
UniquePtr<Key> key;
|
response->error =
|
context_->ParseKeyBlob(KeymasterKeyBlob(request.key_blob), request.additional_params, &key);
|
if (response->error != KM_ERROR_OK)
|
return;
|
|
UniquePtr<uint8_t[]> out_key;
|
size_t size;
|
response->error = key->formatted_key_material(request.key_format, &out_key, &size);
|
if (response->error == KM_ERROR_OK) {
|
response->key_data = out_key.release();
|
response->key_data_length = size;
|
}
|
}
|
|
void AndroidKeymaster::AttestKey(const AttestKeyRequest& request, AttestKeyResponse* response) {
|
if (!response)
|
return;
|
|
const KeyFactory* key_factory;
|
UniquePtr<Key> key;
|
response->error = LoadKey(request.key_blob, request.attest_params,
|
&key_factory, &key);
|
if (response->error != KM_ERROR_OK)
|
return;
|
|
keymaster_blob_t attestation_application_id;
|
if (request.attest_params.GetTagValue(TAG_ATTESTATION_APPLICATION_ID,
|
&attestation_application_id)) {
|
key->sw_enforced().push_back(TAG_ATTESTATION_APPLICATION_ID, attestation_application_id);
|
}
|
|
CertChainPtr certchain;
|
response->error = context_->GenerateAttestation(*key, request.attest_params, &certchain);
|
if (response->error == KM_ERROR_OK) {
|
response->certificate_chain = *certchain;
|
// response->certificate_chain took possession of secondary resources. So we shallowly
|
// delete the keymaster_cert_chain_t object, but nothing else.
|
// TODO Can we switch to managed types eventually?
|
delete certchain.release();
|
}
|
}
|
|
void AndroidKeymaster::UpgradeKey(const UpgradeKeyRequest& request, UpgradeKeyResponse* response) {
|
if (!response)
|
return;
|
|
KeymasterKeyBlob upgraded_key;
|
response->error = context_->UpgradeKeyBlob(KeymasterKeyBlob(request.key_blob),
|
request.upgrade_params, &upgraded_key);
|
if (response->error != KM_ERROR_OK)
|
return;
|
response->upgraded_key = upgraded_key.release();
|
}
|
|
void AndroidKeymaster::ImportKey(const ImportKeyRequest& request, ImportKeyResponse* response) {
|
if (response == nullptr)
|
return;
|
|
keymaster_algorithm_t algorithm;
|
const KeyFactory* factory = nullptr;
|
UniquePtr<Key> key;
|
if (!request.key_description.GetTagValue(TAG_ALGORITHM, &algorithm) ||
|
!(factory = context_->GetKeyFactory(algorithm)))
|
response->error = KM_ERROR_UNSUPPORTED_ALGORITHM;
|
else {
|
keymaster_key_blob_t key_material = {request.key_data, request.key_data_length};
|
KeymasterKeyBlob key_blob;
|
response->error = factory->ImportKey(request.key_description, request.key_format,
|
KeymasterKeyBlob(key_material), &key_blob,
|
&response->enforced, &response->unenforced);
|
if (response->error == KM_ERROR_OK)
|
response->key_blob = key_blob.release();
|
}
|
}
|
|
void AndroidKeymaster::DeleteKey(const DeleteKeyRequest& request, DeleteKeyResponse* response) {
|
if (!response)
|
return;
|
response->error = context_->DeleteKey(KeymasterKeyBlob(request.key_blob));
|
}
|
|
void AndroidKeymaster::DeleteAllKeys(const DeleteAllKeysRequest&, DeleteAllKeysResponse* response) {
|
if (!response)
|
return;
|
response->error = context_->DeleteAllKeys();
|
}
|
|
void AndroidKeymaster::Configure(const ConfigureRequest& request, ConfigureResponse* response) {
|
if (!response)
|
return;
|
response->error = context_->SetSystemVersion(request.os_version, request.os_patchlevel);
|
}
|
|
bool AndroidKeymaster::has_operation(keymaster_operation_handle_t op_handle) const {
|
return operation_table_->Find(op_handle) != nullptr;
|
}
|
|
keymaster_error_t AndroidKeymaster::LoadKey(const keymaster_key_blob_t& key_blob,
|
const AuthorizationSet& additional_params,
|
const KeyFactory** factory, UniquePtr<Key>* key) {
|
KeymasterKeyBlob key_material;
|
keymaster_error_t error = context_->ParseKeyBlob(KeymasterKeyBlob(key_blob), additional_params,
|
key);
|
if (error != KM_ERROR_OK)
|
return error;
|
if (factory) *factory = (*key)->key_factory();
|
return CheckVersionInfo((*key)->hw_enforced(), (*key)->sw_enforced(), *context_);
|
}
|
|
void AndroidKeymaster::ImportWrappedKey(const ImportWrappedKeyRequest& request,
|
ImportWrappedKeyResponse* response) {
|
if (!response) return;
|
|
KeymasterKeyBlob secret_key;
|
AuthorizationSet key_description;
|
keymaster_key_format_t key_format;
|
|
response->error =
|
context_->UnwrapKey(request.wrapped_key, request.wrapping_key, request.additional_params,
|
request.masking_key, &key_description, &key_format, &secret_key);
|
|
if (response->error != KM_ERROR_OK) {
|
return;
|
}
|
|
int sid_idx = key_description.find(TAG_USER_SECURE_ID);
|
if (sid_idx != -1) {
|
uint8_t sids = key_description[sid_idx].long_integer;
|
if (!key_description.erase(sid_idx)) {
|
response->error = KM_ERROR_UNKNOWN_ERROR;
|
return;
|
}
|
if (sids & HW_AUTH_PASSWORD) {
|
key_description.push_back(TAG_USER_SECURE_ID, request.password_sid);
|
}
|
if (sids & HW_AUTH_FINGERPRINT) {
|
key_description.push_back(TAG_USER_SECURE_ID, request.biometric_sid);
|
}
|
}
|
|
keymaster_algorithm_t algorithm;
|
const KeyFactory* factory = nullptr;
|
if (!key_description.GetTagValue(TAG_ALGORITHM, &algorithm) ||
|
!(factory = context_->GetKeyFactory(algorithm))) {
|
response->error = KM_ERROR_UNSUPPORTED_ALGORITHM;
|
} else {
|
KeymasterKeyBlob key_blob;
|
response->error =
|
factory->ImportKey(key_description, key_format, KeymasterKeyBlob(secret_key), &key_blob,
|
&response->enforced, &response->unenforced);
|
if (response->error == KM_ERROR_OK) {
|
response->key_blob = key_blob;
|
}
|
}
|
}
|
|
} // namespace keymaster
|
