keymaster_enforcement.cpp revision 019db0d32168a2e9cf98ec8595aee52120cf8604
14dc536694c5044a624d112f69627856b91d3f82eShawn Willden/* 24dc536694c5044a624d112f69627856b91d3f82eShawn Willden * Copyright (C) 2014 The Android Open Source Project 34dc536694c5044a624d112f69627856b91d3f82eShawn Willden * 44dc536694c5044a624d112f69627856b91d3f82eShawn Willden * Licensed under the Apache License, Version 2.0 (the "License"); 54dc536694c5044a624d112f69627856b91d3f82eShawn Willden * you may not use this file except in compliance with the License. 64dc536694c5044a624d112f69627856b91d3f82eShawn Willden * You may obtain a copy of the License at 74dc536694c5044a624d112f69627856b91d3f82eShawn Willden * 84dc536694c5044a624d112f69627856b91d3f82eShawn Willden * http://www.apache.org/licenses/LICENSE-2.0 94dc536694c5044a624d112f69627856b91d3f82eShawn Willden * 104dc536694c5044a624d112f69627856b91d3f82eShawn Willden * Unless required by applicable law or agreed to in writing, software 114dc536694c5044a624d112f69627856b91d3f82eShawn Willden * distributed under the License is distributed on an "AS IS" BASIS, 124dc536694c5044a624d112f69627856b91d3f82eShawn Willden * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 134dc536694c5044a624d112f69627856b91d3f82eShawn Willden * See the License for the specific language governing permissions and 144dc536694c5044a624d112f69627856b91d3f82eShawn Willden * limitations under the License. 154dc536694c5044a624d112f69627856b91d3f82eShawn Willden */ 164dc536694c5044a624d112f69627856b91d3f82eShawn Willden 17b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden#include <keymaster/keymaster_enforcement.h> 18b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 19b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden#include <assert.h> 20ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden#include <limits.h> 214dc536694c5044a624d112f69627856b91d3f82eShawn Willden#include <string.h> 224dc536694c5044a624d112f69627856b91d3f82eShawn Willden 23b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden#include <openssl/evp.h> 24b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 25b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden#include <hardware/hw_auth_token.h> 26b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden#include <keymaster/android_keymaster_utils.h> 27b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden#include <keymaster/logger.h> 28b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 29ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden#include "List.h" 30ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 31b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenusing android::List; 324dc536694c5044a624d112f69627856b91d3f82eShawn Willden 334dc536694c5044a624d112f69627856b91d3f82eShawn Willdennamespace keymaster { 344dc536694c5044a624d112f69627856b91d3f82eShawn Willden 35ada4850659d484dd5ece26dde73072bef16c1517Shawn Willdenclass AccessTimeMap { 36ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden public: 3703d4b6d531eb8c2ebcb4d572a3bf118c70a83ff6Chih-Hung Hsieh explicit AccessTimeMap(uint32_t max_size) : max_size_(max_size) {} 38ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 39ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden /* If the key is found, returns true and fills \p last_access_time. If not found returns 40ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden * false. */ 41ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden bool LastKeyAccessTime(km_id_t keyid, uint32_t* last_access_time) const; 42ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 43ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden /* Updates the last key access time with the currentTime parameter. Adds the key if 44ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden * needed, returning false if key cannot be added because list is full. */ 45ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden bool UpdateKeyAccessTime(km_id_t keyid, uint32_t current_time, uint32_t timeout); 46ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 47ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden private: 48ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden struct AccessTime { 49ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden km_id_t keyid; 50ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden uint32_t access_time; 51ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden uint32_t timeout; 52ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden }; 53ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden android::List<AccessTime> last_access_list_; 54ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden const uint32_t max_size_; 55ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden}; 56ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 57ada4850659d484dd5ece26dde73072bef16c1517Shawn Willdenclass AccessCountMap { 58ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden public: 5903d4b6d531eb8c2ebcb4d572a3bf118c70a83ff6Chih-Hung Hsieh explicit AccessCountMap(uint32_t max_size) : max_size_(max_size) {} 60ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 61ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden /* If the key is found, returns true and fills \p count. If not found returns 62ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden * false. */ 63ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden bool KeyAccessCount(km_id_t keyid, uint32_t* count) const; 64ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 65ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden /* Increments key access count, adding an entry if the key has never been used. Returns 66ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden * false if the list has reached maximum size. */ 67ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden bool IncrementKeyAccessCount(km_id_t keyid); 68ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 69ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden private: 70ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden struct AccessCount { 71ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden km_id_t keyid; 72ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden uint64_t access_count; 73ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden }; 74ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden android::List<AccessCount> access_count_list_; 75ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden const uint32_t max_size_; 76ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden}; 77ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 78b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenbool is_public_key_algorithm(const AuthorizationSet& auth_set) { 79b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden keymaster_algorithm_t algorithm; 80b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return auth_set.GetTagValue(TAG_ALGORITHM, &algorithm) && 81b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden (algorithm == KM_ALGORITHM_RSA || algorithm == KM_ALGORITHM_EC); 824dc536694c5044a624d112f69627856b91d3f82eShawn Willden} 834dc536694c5044a624d112f69627856b91d3f82eShawn Willden 84b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenstatic keymaster_error_t authorized_purpose(const keymaster_purpose_t purpose, 85b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden const AuthorizationSet& auth_set) { 86b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden switch (purpose) { 87b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_PURPOSE_VERIFY: 88b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_PURPOSE_ENCRYPT: 89b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_PURPOSE_SIGN: 90b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_PURPOSE_DECRYPT: 91b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_set.Contains(TAG_PURPOSE, purpose)) 92b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_OK; 93b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_INCOMPATIBLE_PURPOSE; 944dc536694c5044a624d112f69627856b91d3f82eShawn Willden 95b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden default: 96b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_UNSUPPORTED_PURPOSE; 97b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 98b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden} 994dc536694c5044a624d112f69627856b91d3f82eShawn Willden 100b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdeninline bool is_origination_purpose(keymaster_purpose_t purpose) { 101b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return purpose == KM_PURPOSE_ENCRYPT || purpose == KM_PURPOSE_SIGN; 102b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden} 1034dc536694c5044a624d112f69627856b91d3f82eShawn Willden 104b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdeninline bool is_usage_purpose(keymaster_purpose_t purpose) { 105b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return purpose == KM_PURPOSE_DECRYPT || purpose == KM_PURPOSE_VERIFY; 106b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden} 1074dc536694c5044a624d112f69627856b91d3f82eShawn Willden 108ada4850659d484dd5ece26dde73072bef16c1517Shawn WilldenKeymasterEnforcement::KeymasterEnforcement(uint32_t max_access_time_map_size, 109ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden uint32_t max_access_count_map_size) 110ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden : access_time_map_(new (std::nothrow) AccessTimeMap(max_access_time_map_size)), 111ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden access_count_map_(new (std::nothrow) AccessCountMap(max_access_count_map_size)) {} 112ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 113ada4850659d484dd5ece26dde73072bef16c1517Shawn WilldenKeymasterEnforcement::~KeymasterEnforcement() { 114ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden delete access_time_map_; 115ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden delete access_count_map_; 116ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden} 117ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 118b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenkeymaster_error_t KeymasterEnforcement::AuthorizeOperation(const keymaster_purpose_t purpose, 119b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden const km_id_t keyid, 120b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden const AuthorizationSet& auth_set, 121b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden const AuthorizationSet& operation_params, 122b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden keymaster_operation_handle_t op_handle, 123b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden bool is_begin_operation) { 124fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden if (is_public_key_algorithm(auth_set)) { 125fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden switch (purpose) { 126fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden case KM_PURPOSE_ENCRYPT: 127fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden case KM_PURPOSE_VERIFY: 128fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden /* Public key operations are always authorized. */ 129fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden return KM_ERROR_OK; 130fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden 131fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden case KM_PURPOSE_DECRYPT: 132fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden case KM_PURPOSE_SIGN: 133d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden case KM_PURPOSE_DERIVE_KEY: 134fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden break; 135fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden }; 136fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden }; 137fafb4442bfc20df315c8427d60724623d1c525d5Shawn Willden 138bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden if (is_begin_operation) 139bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden return AuthorizeBegin(purpose, keyid, auth_set, operation_params); 140bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden else 141bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden return AuthorizeUpdateOrFinish(auth_set, operation_params, op_handle); 142bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden} 143bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden 144bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden// For update and finish the only thing to check is user authentication, and then only if it's not 145bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden// timeout-based. 146bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willdenkeymaster_error_t 147bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn WilldenKeymasterEnforcement::AuthorizeUpdateOrFinish(const AuthorizationSet& auth_set, 148bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden const AuthorizationSet& operation_params, 149bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden keymaster_operation_handle_t op_handle) { 150bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden int auth_type_index = -1; 151bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden for (size_t pos = 0; pos < auth_set.size(); ++pos) { 152bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden switch (auth_set[pos].tag) { 153bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden case KM_TAG_NO_AUTH_REQUIRED: 154bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden case KM_TAG_AUTH_TIMEOUT: 155bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // If no auth is required or if auth is timeout-based, we have nothing to check. 156bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden return KM_ERROR_OK; 157bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden 158bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden case KM_TAG_USER_AUTH_TYPE: 159bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden auth_type_index = pos; 160bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden break; 161bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden 162bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden default: 163bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden break; 164bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden } 165bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden } 166bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden 167bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // Note that at this point we should be able to assume that authentication is required, because 168bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // authentication is required if KM_TAG_NO_AUTH_REQUIRED is absent. However, there are legacy 169bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // keys which have no authentication-related tags, so we assume that absence is equivalent to 170bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // presence of KM_TAG_NO_AUTH_REQUIRED. 171bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // 172bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // So, if we found KM_TAG_USER_AUTH_TYPE or if we find KM_TAG_USER_SECURE_ID then authentication 173bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // is required. If we find neither, then we assume authentication is not required and return 174bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden // success. 175bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden bool authentication_required = (auth_type_index != -1); 176bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden for (auto& param : auth_set) { 177bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden if (param.tag == KM_TAG_USER_SECURE_ID) { 178bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden authentication_required = true; 179bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden int auth_timeout_index = -1; 180bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden if (AuthTokenMatches(auth_set, operation_params, param.long_integer, auth_type_index, 181bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden auth_timeout_index, op_handle, false /* is_begin_operation */)) 182bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden return KM_ERROR_OK; 183bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden } 184bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden } 185bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden 186bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden if (authentication_required) 187bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden return KM_ERROR_KEY_USER_NOT_AUTHENTICATED; 188bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden 189bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden return KM_ERROR_OK; 190bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden} 191bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden 192bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willdenkeymaster_error_t KeymasterEnforcement::AuthorizeBegin(const keymaster_purpose_t purpose, 193bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden const km_id_t keyid, 194bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden const AuthorizationSet& auth_set, 195bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden const AuthorizationSet& operation_params) { 196b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden // Find some entries that may be needed to handle KM_TAG_USER_SECURE_ID 197b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden int auth_timeout_index = -1; 198b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden int auth_type_index = -1; 199b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden int no_auth_required_index = -1; 200b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden for (size_t pos = 0; pos < auth_set.size(); ++pos) { 201b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden switch (auth_set[pos].tag) { 202b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_AUTH_TIMEOUT: 203b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden auth_timeout_index = pos; 204b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden break; 205b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_USER_AUTH_TYPE: 206b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden auth_type_index = pos; 207b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden break; 208b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_NO_AUTH_REQUIRED: 209b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden no_auth_required_index = pos; 210b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden break; 211b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden default: 212b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden break; 213b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 2144dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 2154dc536694c5044a624d112f69627856b91d3f82eShawn Willden 216b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden keymaster_error_t error = authorized_purpose(purpose, auth_set); 217b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (error != KM_ERROR_OK) 218b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return error; 219b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 220b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden // If successful, and if key has a min time between ops, this will be set to the time limit 221b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden uint32_t min_ops_timeout = UINT32_MAX; 2224dc536694c5044a624d112f69627856b91d3f82eShawn Willden 223b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden bool update_access_count = false; 22473e71591b28ac4615d03ca08ecab7f6358751bf4Shawn Willden bool caller_nonce_authorized_by_key = false; 225b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden bool authentication_required = false; 226b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden bool auth_token_matched = false; 227b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 228b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden for (auto& param : auth_set) { 229d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden 230d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden // KM_TAG_PADDING_OLD and KM_TAG_DIGEST_OLD aren't actually members of the enum, so we can't 231d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden // switch on them. There's nothing to validate for them, though, so just ignore them. 232d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden if (param.tag == KM_TAG_PADDING_OLD || param.tag == KM_TAG_DIGEST_OLD) 233d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden continue; 234d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden 2354dc536694c5044a624d112f69627856b91d3f82eShawn Willden switch (param.tag) { 236b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 2374dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_ACTIVE_DATETIME: 238b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (!activation_date_valid(param.date_time)) 239b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_KEY_NOT_YET_VALID; 2404dc536694c5044a624d112f69627856b91d3f82eShawn Willden break; 241b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 2424dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_ORIGINATION_EXPIRE_DATETIME: 243b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (is_origination_purpose(purpose) && expiration_date_passed(param.date_time)) 244b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_KEY_EXPIRED; 2454dc536694c5044a624d112f69627856b91d3f82eShawn Willden break; 246b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 2474dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_USAGE_EXPIRE_DATETIME: 248b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (is_usage_purpose(purpose) && expiration_date_passed(param.date_time)) 249b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_KEY_EXPIRED; 2504dc536694c5044a624d112f69627856b91d3f82eShawn Willden break; 251b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 2524dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_MIN_SECONDS_BETWEEN_OPS: 253b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden min_ops_timeout = param.integer; 254b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (!MinTimeBetweenOpsPassed(min_ops_timeout, keyid)) 255b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_KEY_RATE_LIMIT_EXCEEDED; 2564dc536694c5044a624d112f69627856b91d3f82eShawn Willden break; 257b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 2584dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_MAX_USES_PER_BOOT: 259b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden update_access_count = true; 260b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (!MaxUsesPerBootNotExceeded(keyid, param.integer)) 261b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_KEY_MAX_OPS_EXCEEDED; 2624dc536694c5044a624d112f69627856b91d3f82eShawn Willden break; 263b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 264eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden case KM_TAG_USER_SECURE_ID: 265b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (no_auth_required_index != -1) { 266b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden // Key has both KM_TAG_USER_SECURE_ID and KM_TAG_NO_AUTH_REQUIRED 267b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_INVALID_KEY_BLOB; 268bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden } 269bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden 270bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden if (auth_timeout_index != -1) { 271b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden authentication_required = true; 272b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (AuthTokenMatches(auth_set, operation_params, param.long_integer, 273bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden auth_type_index, auth_timeout_index, 0 /* op_handle */, 274bf9fa99611e64aa797c10d5458624ed93cc4f50bShawn Willden true /* is_begin_operation */)) 275b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden auth_token_matched = true; 276b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 2774dc536694c5044a624d112f69627856b91d3f82eShawn Willden break; 278b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 2794dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_CALLER_NONCE: 28073e71591b28ac4615d03ca08ecab7f6358751bf4Shawn Willden caller_nonce_authorized_by_key = true; 2814dc536694c5044a624d112f69627856b91d3f82eShawn Willden break; 2824dc536694c5044a624d112f69627856b91d3f82eShawn Willden 283b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden /* Tags should never be in key auths. */ 2844dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_INVALID: 285b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_AUTH_TOKEN: 286b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_ROOT_OF_TRUST: 287b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_APPLICATION_DATA: 28822dcdb75fc2d1aa9a25b9aadb65d4dcb31e8c647Shawn Willden case KM_TAG_ATTESTATION_CHALLENGE: 289019db0d32168a2e9cf98ec8595aee52120cf8604Janis Danisevskis case KM_TAG_ATTESTATION_APPLICATION_ID: 290b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_INVALID_KEY_BLOB; 2914dc536694c5044a624d112f69627856b91d3f82eShawn Willden 29233ab0389e908b98702806c746e7babc0d46eb452Shawn Willden /* Tags used for cryptographic parameters in keygen. Nothing to enforce. */ 2934dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_PURPOSE: 2944dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_ALGORITHM: 2954dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_KEY_SIZE: 2964dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_BLOCK_MODE: 2974dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_DIGEST: 2984dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_MAC_LENGTH: 2994dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_PADDING: 3004dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_NONCE: 30133ab0389e908b98702806c746e7babc0d46eb452Shawn Willden case KM_TAG_MIN_MAC_LENGTH: 302fabacaf3e6019804cc8a98a2b8296be1d0125519Thai Duong case KM_TAG_KDF: 303fabacaf3e6019804cc8a98a2b8296be1d0125519Thai Duong case KM_TAG_EC_CURVE: 3044dc536694c5044a624d112f69627856b91d3f82eShawn Willden 305125e4866f98eb1b5ad65a563afd34aca215d983dShawn Willden /* Tags not used for operations. */ 3064dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_BLOB_USAGE_REQUIREMENTS: 307d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden case KM_TAG_EXPORTABLE: 3084dc536694c5044a624d112f69627856b91d3f82eShawn Willden 3094dc536694c5044a624d112f69627856b91d3f82eShawn Willden /* Algorithm specific parameters not used for access control. */ 3104dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_RSA_PUBLIC_EXPONENT: 311fabacaf3e6019804cc8a98a2b8296be1d0125519Thai Duong case KM_TAG_ECIES_SINGLE_HASH_MODE: 3124dc536694c5044a624d112f69627856b91d3f82eShawn Willden 3134dc536694c5044a624d112f69627856b91d3f82eShawn Willden /* Informational tags. */ 3144dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_CREATION_DATETIME: 3154dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_ORIGIN: 3164dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_ROLLBACK_RESISTANT: 317b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 318b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden /* Tags handled when KM_TAG_USER_SECURE_ID is handled */ 319b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_NO_AUTH_REQUIRED: 320b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_USER_AUTH_TYPE: 321b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_AUTH_TIMEOUT: 3224dc536694c5044a624d112f69627856b91d3f82eShawn Willden 3234dc536694c5044a624d112f69627856b91d3f82eShawn Willden /* Tag to provide data to operations. */ 3244dc536694c5044a624d112f69627856b91d3f82eShawn Willden case KM_TAG_ASSOCIATED_DATA: 325b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 326d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden /* Tags that are implicitly verified by secure side */ 327b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_ALL_APPLICATIONS: 328b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_APPLICATION_ID: 329d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden case KM_TAG_OS_VERSION: 330d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden case KM_TAG_OS_PATCHLEVEL: 331d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden 332d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden /* Ignored pending removal */ 333b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_USER_ID: 334b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_ALL_USERS: 335d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden 336d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden /* TODO(swillden): Handle these */ 337d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden case KM_TAG_INCLUDE_UNIQUE_ID: 338d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden case KM_TAG_UNIQUE_ID: 339d4c83db6b3bbb83985715fa88fcec580594c1c9cShawn Willden case KM_TAG_RESET_SINCE_ID_ROTATION: 340b1e6758e2ff9ae632dfe327027e201326831538fShawn Willden case KM_TAG_ALLOW_WHILE_ON_BODY: 341bcd6b99ad5eb0e010f611facb55358e52cbde071Shawn Willden break; 3424dc536694c5044a624d112f69627856b91d3f82eShawn Willden 343b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden case KM_TAG_BOOTLOADER_ONLY: 344b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_INVALID_KEY_BLOB; 3454dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 3464dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 3474dc536694c5044a624d112f69627856b91d3f82eShawn Willden 348b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (authentication_required && !auth_token_matched) { 349b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Auth required but no matching auth token found", 0); 350b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_KEY_USER_NOT_AUTHENTICATED; 3514dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 3524dc536694c5044a624d112f69627856b91d3f82eShawn Willden 35373e71591b28ac4615d03ca08ecab7f6358751bf4Shawn Willden if (!caller_nonce_authorized_by_key && is_origination_purpose(purpose) && 35473e71591b28ac4615d03ca08ecab7f6358751bf4Shawn Willden operation_params.find(KM_TAG_NONCE) != -1) 355b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return KM_ERROR_CALLER_NONCE_PROHIBITED; 3564dc536694c5044a624d112f69627856b91d3f82eShawn Willden 357ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (min_ops_timeout != UINT32_MAX) { 358ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (!access_time_map_) { 359ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden LOG_S("Rate-limited keys table not allocated. Rate-limited keys disabled", 0); 360ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden return KM_ERROR_MEMORY_ALLOCATION_FAILED; 361ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden } 362ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 363ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (!access_time_map_->UpdateKeyAccessTime(keyid, get_current_time(), min_ops_timeout)) { 364ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden LOG_E("Rate-limited keys table full. Entries will time out.", 0); 365ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden return KM_ERROR_TOO_MANY_OPERATIONS; 366ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden } 3674dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 3684dc536694c5044a624d112f69627856b91d3f82eShawn Willden 369ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (update_access_count) { 370ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (!access_count_map_) { 371ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden LOG_S("Usage-count limited keys tabel not allocated. Count-limited keys disabled", 0); 372ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden return KM_ERROR_MEMORY_ALLOCATION_FAILED; 373ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden } 374ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 375ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (!access_count_map_->IncrementKeyAccessCount(keyid)) { 376ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden LOG_E("Usage count-limited keys table full, until reboot.", 0); 377ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden return KM_ERROR_TOO_MANY_OPERATIONS; 378ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden } 3794dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 380b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 3814dc536694c5044a624d112f69627856b91d3f82eShawn Willden return KM_ERROR_OK; 3824dc536694c5044a624d112f69627856b91d3f82eShawn Willden} 3834dc536694c5044a624d112f69627856b91d3f82eShawn Willden 384b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenclass EvpMdCtx { 385b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden public: 386b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden EvpMdCtx() { EVP_MD_CTX_init(&ctx_); } 387b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden ~EvpMdCtx() { EVP_MD_CTX_cleanup(&ctx_); } 3884dc536694c5044a624d112f69627856b91d3f82eShawn Willden 389b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden EVP_MD_CTX* get() { return &ctx_; } 3904dc536694c5044a624d112f69627856b91d3f82eShawn Willden 391b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden private: 392b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden EVP_MD_CTX ctx_; 393b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden}; 3944dc536694c5044a624d112f69627856b91d3f82eShawn Willden 395b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden/* static */ 396b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenbool KeymasterEnforcement::CreateKeyId(const keymaster_key_blob_t& key_blob, km_id_t* keyid) { 397b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden EvpMdCtx ctx; 3984dc536694c5044a624d112f69627856b91d3f82eShawn Willden 399b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden uint8_t hash[EVP_MAX_MD_SIZE]; 400b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden unsigned int hash_len; 401b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (EVP_DigestInit_ex(ctx.get(), EVP_sha256(), nullptr /* ENGINE */) && 402b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden EVP_DigestUpdate(ctx.get(), key_blob.key_material, key_blob.key_material_size) && 403b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden EVP_DigestFinal_ex(ctx.get(), hash, &hash_len)) { 404b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden assert(hash_len >= sizeof(*keyid)); 405b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden memcpy(keyid, hash, sizeof(*keyid)); 406b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 4074dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 408b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 409b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 4104dc536694c5044a624d112f69627856b91d3f82eShawn Willden} 4114dc536694c5044a624d112f69627856b91d3f82eShawn Willden 412b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenbool KeymasterEnforcement::MinTimeBetweenOpsPassed(uint32_t min_time_between, const km_id_t keyid) { 413ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (!access_time_map_) 414ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden return false; 415ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 416b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden uint32_t last_access_time; 417ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (!access_time_map_->LastKeyAccessTime(keyid, &last_access_time)) 418b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 419b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return min_time_between <= static_cast<int64_t>(get_current_time()) - last_access_time; 4204dc536694c5044a624d112f69627856b91d3f82eShawn Willden} 4214dc536694c5044a624d112f69627856b91d3f82eShawn Willden 422b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenbool KeymasterEnforcement::MaxUsesPerBootNotExceeded(const km_id_t keyid, uint32_t max_uses) { 423ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (!access_count_map_) 424ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden return false; 425ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden 426b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden uint32_t key_access_count; 427ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (!access_count_map_->KeyAccessCount(keyid, &key_access_count)) 428b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 429b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return key_access_count < max_uses; 430b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden} 4314dc536694c5044a624d112f69627856b91d3f82eShawn Willden 432b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willdenbool KeymasterEnforcement::AuthTokenMatches(const AuthorizationSet& auth_set, 433b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden const AuthorizationSet& operation_params, 434b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden const uint64_t user_secure_id, 435b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden const int auth_type_index, const int auth_timeout_index, 436b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden const keymaster_operation_handle_t op_handle, 437b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden bool is_begin_operation) const { 438b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden assert(auth_type_index < static_cast<int>(auth_set.size())); 439b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden assert(auth_timeout_index < static_cast<int>(auth_set.size())); 440b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 441b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden keymaster_blob_t auth_token_blob; 442b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (!operation_params.GetTagValue(TAG_AUTH_TOKEN, &auth_token_blob)) { 443b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Authentication required, but auth token not provided", 0); 444b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 4454dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 4464dc536694c5044a624d112f69627856b91d3f82eShawn Willden 447b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_token_blob.data_length != sizeof(hw_auth_token_t)) { 448b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Bug: Auth token is the wrong size (%d expected, %d found)", sizeof(hw_auth_token_t), 449b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden auth_token_blob.data_length); 450b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 4514dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 4524dc536694c5044a624d112f69627856b91d3f82eShawn Willden 453b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden hw_auth_token_t auth_token; 454b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden memcpy(&auth_token, auth_token_blob.data, sizeof(hw_auth_token_t)); 455b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_token.version != HW_AUTH_TOKEN_VERSION) { 456b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Bug: Auth token is the version %d (or is not an auth token). Expected %d", 457b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden auth_token.version, HW_AUTH_TOKEN_VERSION); 458b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 459b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 4604dc536694c5044a624d112f69627856b91d3f82eShawn Willden 461b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (!ValidateTokenSignature(auth_token)) { 462b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Auth token signature invalid", 0); 463b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 464b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 4654dc536694c5044a624d112f69627856b91d3f82eShawn Willden 466b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_timeout_index == -1 && op_handle && op_handle != auth_token.challenge) { 467b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Auth token has the challenge %llu, need %llu", auth_token.challenge, op_handle); 468b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 469b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 4704dc536694c5044a624d112f69627856b91d3f82eShawn Willden 471b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (user_secure_id != auth_token.user_id && user_secure_id != auth_token.authenticator_id) { 472b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_I("Auth token SIDs %llu and %llu do not match key SID %llu", auth_token.user_id, 473b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden auth_token.authenticator_id, user_secure_id); 474b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 475b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 4764dc536694c5044a624d112f69627856b91d3f82eShawn Willden 477b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_type_index < 0 || auth_type_index > static_cast<int>(auth_set.size())) { 478b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Auth required but no auth type found", 0); 479b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 480b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 4814dc536694c5044a624d112f69627856b91d3f82eShawn Willden 482b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden assert(auth_set[auth_type_index].tag == KM_TAG_USER_AUTH_TYPE); 483b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_set[auth_type_index].tag != KM_TAG_USER_AUTH_TYPE) 484b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 4854dc536694c5044a624d112f69627856b91d3f82eShawn Willden 486b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden uint32_t key_auth_type_mask = auth_set[auth_type_index].integer; 487b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden uint32_t token_auth_type = ntoh(auth_token.authenticator_type); 488b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if ((key_auth_type_mask & token_auth_type) == 0) { 489b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Key requires match of auth type mask 0%uo, but token contained 0%uo", 490b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden key_auth_type_mask, token_auth_type); 491b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 4924dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 4934dc536694c5044a624d112f69627856b91d3f82eShawn Willden 494b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_timeout_index != -1 && is_begin_operation) { 495b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden assert(auth_set[auth_timeout_index].tag == KM_TAG_AUTH_TIMEOUT); 496b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_set[auth_timeout_index].tag != KM_TAG_AUTH_TIMEOUT) 497b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 4984dc536694c5044a624d112f69627856b91d3f82eShawn Willden 499b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (auth_token_timed_out(auth_token, auth_set[auth_timeout_index].integer)) { 500b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden LOG_E("Auth token has timed out", 0); 5014dc536694c5044a624d112f69627856b91d3f82eShawn Willden return false; 5024dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 5034dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 5044dc536694c5044a624d112f69627856b91d3f82eShawn Willden 505b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden // Survived the whole gauntlet. We have authentage! 5064dc536694c5044a624d112f69627856b91d3f82eShawn Willden return true; 5074dc536694c5044a624d112f69627856b91d3f82eShawn Willden} 5084dc536694c5044a624d112f69627856b91d3f82eShawn Willden 509ada4850659d484dd5ece26dde73072bef16c1517Shawn Willdenbool AccessTimeMap::LastKeyAccessTime(km_id_t keyid, uint32_t* last_access_time) const { 510b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden for (auto& entry : last_access_list_) 511b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (entry.keyid == keyid) { 512b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden *last_access_time = entry.access_time; 513b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 514b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 515b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 516b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden} 5174dc536694c5044a624d112f69627856b91d3f82eShawn Willden 518ada4850659d484dd5ece26dde73072bef16c1517Shawn Willdenbool AccessTimeMap::UpdateKeyAccessTime(km_id_t keyid, uint32_t current_time, uint32_t timeout) { 519b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden List<AccessTime>::iterator iter; 520b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden for (iter = last_access_list_.begin(); iter != last_access_list_.end();) { 521b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (iter->keyid == keyid) { 522b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden iter->access_time = current_time; 523b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 5244dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 525b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden 526b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden // Expire entry if possible. 527b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden assert(current_time >= iter->access_time); 528b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (current_time - iter->access_time >= iter->timeout) 529b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden iter = last_access_list_.erase(iter); 530b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden else 531b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden ++iter; 5324dc536694c5044a624d112f69627856b91d3f82eShawn Willden } 5334dc536694c5044a624d112f69627856b91d3f82eShawn Willden 534b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (last_access_list_.size() >= max_size_) 535b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 5364dc536694c5044a624d112f69627856b91d3f82eShawn Willden 537b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden AccessTime new_entry; 538b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden new_entry.keyid = keyid; 539b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden new_entry.access_time = current_time; 540b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden new_entry.timeout = timeout; 541b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden last_access_list_.push_front(new_entry); 542b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 5434dc536694c5044a624d112f69627856b91d3f82eShawn Willden} 5444dc536694c5044a624d112f69627856b91d3f82eShawn Willden 545ada4850659d484dd5ece26dde73072bef16c1517Shawn Willdenbool AccessCountMap::KeyAccessCount(km_id_t keyid, uint32_t* count) const { 546b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden for (auto& entry : access_count_list_) 547b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (entry.keyid == keyid) { 548b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden *count = entry.access_count; 549b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 550b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 551b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 5524dc536694c5044a624d112f69627856b91d3f82eShawn Willden} 5534dc536694c5044a624d112f69627856b91d3f82eShawn Willden 554ada4850659d484dd5ece26dde73072bef16c1517Shawn Willdenbool AccessCountMap::IncrementKeyAccessCount(km_id_t keyid) { 555b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden for (auto& entry : access_count_list_) 556b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (entry.keyid == keyid) { 557ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden // Note that the 'if' below will always be true because KM_TAG_MAX_USES_PER_BOOT is a 558ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden // uint32_t, and as soon as entry.access_count reaches the specified maximum value 559ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden // operation requests will be rejected and access_count won't be incremented any more. 560ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden // And, besides, UINT64_MAX is huge. But we ensure that it doesn't wrap anyway, out of 561ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden // an abundance of caution. 562ada4850659d484dd5ece26dde73072bef16c1517Shawn Willden if (entry.access_count < UINT64_MAX) 563b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden ++entry.access_count; 564b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 565b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden } 5664dc536694c5044a624d112f69627856b91d3f82eShawn Willden 567b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden if (access_count_list_.size() >= max_size_) 568b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return false; 5694dc536694c5044a624d112f69627856b91d3f82eShawn Willden 570b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden AccessCount new_entry; 571b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden new_entry.keyid = keyid; 572b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden new_entry.access_count = 1; 573b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden access_count_list_.push_front(new_entry); 574b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden return true; 575b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden} 5764dc536694c5044a624d112f69627856b91d3f82eShawn Willden}; /* namespace keymaster */ 577