blob: b8016eb32b1a328bf608420240169ba1303db797 [file] [log] [blame]
Selene Huang31ab4042020-04-29 04:22:39 -07001/*
2 * Copyright (C) 2020 The Android Open Source Project
3 *
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
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
15 */
16
17#include "KeyMintAidlTestBase.h"
18
19#include <chrono>
David Drysdale555ba002022-05-03 18:48:57 +010020#include <fstream>
Shawn Willden7f424372021-01-10 18:06:50 -070021#include <unordered_set>
Selene Huang31ab4042020-04-29 04:22:39 -070022#include <vector>
23
24#include <android-base/logging.h>
Janis Danisevskis24c04702020-12-16 18:28:39 -080025#include <android/binder_manager.h>
David Drysdale4dc01072021-04-01 12:17:35 +010026#include <cppbor_parse.h>
Shawn Willden7c130392020-12-21 09:58:22 -070027#include <cutils/properties.h>
David Drysdale4dc01072021-04-01 12:17:35 +010028#include <gmock/gmock.h>
David Drysdale42fe1892021-10-14 14:43:46 +010029#include <openssl/evp.h>
Shawn Willden7c130392020-12-21 09:58:22 -070030#include <openssl/mem.h>
David Drysdale4dc01072021-04-01 12:17:35 +010031#include <remote_prov/remote_prov_utils.h>
Selene Huang31ab4042020-04-29 04:22:39 -070032
Max Bires9704ff62021-04-07 11:12:01 -070033#include <keymaster/cppcose/cppcose.h>
Shawn Willden08a7e432020-12-11 13:05:27 +000034#include <keymint_support/key_param_output.h>
35#include <keymint_support/keymint_utils.h>
Shawn Willden7c130392020-12-21 09:58:22 -070036#include <keymint_support/openssl_utils.h>
Selene Huang31ab4042020-04-29 04:22:39 -070037
Janis Danisevskis24c04702020-12-16 18:28:39 -080038namespace aidl::android::hardware::security::keymint {
Selene Huang31ab4042020-04-29 04:22:39 -070039
David Drysdale4dc01072021-04-01 12:17:35 +010040using namespace cppcose;
Selene Huang31ab4042020-04-29 04:22:39 -070041using namespace std::literals::chrono_literals;
42using std::endl;
43using std::optional;
Shawn Willden7c130392020-12-21 09:58:22 -070044using std::unique_ptr;
45using ::testing::AssertionFailure;
46using ::testing::AssertionResult;
47using ::testing::AssertionSuccess;
Seth Moore026bb742021-04-30 11:41:18 -070048using ::testing::ElementsAreArray;
David Drysdale4dc01072021-04-01 12:17:35 +010049using ::testing::MatchesRegex;
Seth Moore026bb742021-04-30 11:41:18 -070050using ::testing::Not;
Selene Huang31ab4042020-04-29 04:22:39 -070051
52::std::ostream& operator<<(::std::ostream& os, const AuthorizationSet& set) {
53 if (set.size() == 0)
54 os << "(Empty)" << ::std::endl;
55 else {
56 os << "\n";
Shawn Willden0e80b5d2020-12-17 09:07:27 -070057 for (auto& entry : set) os << entry << ::std::endl;
Selene Huang31ab4042020-04-29 04:22:39 -070058 }
59 return os;
60}
61
62namespace test {
63
Shawn Willden7f424372021-01-10 18:06:50 -070064namespace {
David Drysdaledf8f52e2021-05-06 08:10:58 +010065
David Drysdale37af4b32021-05-14 16:46:59 +010066// Invalid value for a patchlevel (which is of form YYYYMMDD).
67const uint32_t kInvalidPatchlevel = 99998877;
68
David Drysdaledf8f52e2021-05-06 08:10:58 +010069// Overhead for PKCS#1 v1.5 signature padding of undigested messages. Digested messages have
70// additional overhead, for the digest algorithmIdentifier required by PKCS#1.
71const size_t kPkcs1UndigestedSignaturePaddingOverhead = 11;
72
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +000073typedef KeyMintAidlTestBase::KeyData KeyData;
Shawn Willden7f424372021-01-10 18:06:50 -070074// Predicate for testing basic characteristics validity in generation or import.
75bool KeyCharacteristicsBasicallyValid(SecurityLevel secLevel,
76 const vector<KeyCharacteristics>& key_characteristics) {
77 if (key_characteristics.empty()) return false;
78
79 std::unordered_set<SecurityLevel> levels_seen;
80 for (auto& entry : key_characteristics) {
Seth Moore2a9a00e2021-08-04 16:31:52 -070081 if (entry.authorizations.empty()) {
82 GTEST_LOG_(ERROR) << "empty authorizations for " << entry.securityLevel;
83 return false;
84 }
Shawn Willden7f424372021-01-10 18:06:50 -070085
Qi Wubeefae42021-01-28 23:16:37 +080086 // Just ignore the SecurityLevel::KEYSTORE as the KM won't do any enforcement on this.
87 if (entry.securityLevel == SecurityLevel::KEYSTORE) continue;
88
Seth Moore2a9a00e2021-08-04 16:31:52 -070089 if (levels_seen.find(entry.securityLevel) != levels_seen.end()) {
90 GTEST_LOG_(ERROR) << "duplicate authorizations for " << entry.securityLevel;
91 return false;
92 }
Shawn Willden7f424372021-01-10 18:06:50 -070093 levels_seen.insert(entry.securityLevel);
94
95 // Generally, we should only have one entry, at the same security level as the KM
96 // instance. There is an exception: StrongBox KM can have some authorizations that are
97 // enforced by the TEE.
98 bool isExpectedSecurityLevel = secLevel == entry.securityLevel ||
99 (secLevel == SecurityLevel::STRONGBOX &&
100 entry.securityLevel == SecurityLevel::TRUSTED_ENVIRONMENT);
101
Seth Moore2a9a00e2021-08-04 16:31:52 -0700102 if (!isExpectedSecurityLevel) {
103 GTEST_LOG_(ERROR) << "Unexpected security level " << entry.securityLevel;
104 return false;
105 }
Shawn Willden7f424372021-01-10 18:06:50 -0700106 }
107 return true;
108}
109
Shawn Willden7c130392020-12-21 09:58:22 -0700110// Extract attestation record from cert. Returned object is still part of cert; don't free it
111// separately.
112ASN1_OCTET_STRING* get_attestation_record(X509* certificate) {
113 ASN1_OBJECT_Ptr oid(OBJ_txt2obj(kAttestionRecordOid, 1 /* dotted string format */));
114 EXPECT_TRUE(!!oid.get());
115 if (!oid.get()) return nullptr;
116
117 int location = X509_get_ext_by_OBJ(certificate, oid.get(), -1 /* search from beginning */);
118 EXPECT_NE(-1, location) << "Attestation extension not found in certificate";
119 if (location == -1) return nullptr;
120
121 X509_EXTENSION* attest_rec_ext = X509_get_ext(certificate, location);
122 EXPECT_TRUE(!!attest_rec_ext)
123 << "Found attestation extension but couldn't retrieve it? Probably a BoringSSL bug.";
124 if (!attest_rec_ext) return nullptr;
125
126 ASN1_OCTET_STRING* attest_rec = X509_EXTENSION_get_data(attest_rec_ext);
127 EXPECT_TRUE(!!attest_rec) << "Attestation extension contained no data";
128 return attest_rec;
129}
130
David Drysdale7dff4fc2021-12-10 10:10:52 +0000131void check_attestation_version(uint32_t attestation_version, int32_t aidl_version) {
132 // Version numbers in attestation extensions should be a multiple of 100.
133 EXPECT_EQ(attestation_version % 100, 0);
134
135 // The multiplier should never be higher than the AIDL version, but can be less
136 // (for example, if the implementation is from an earlier version but the HAL service
137 // uses the default libraries and so reports the current AIDL version).
138 EXPECT_TRUE((attestation_version / 100) <= aidl_version);
139}
140
Shawn Willden7c130392020-12-21 09:58:22 -0700141bool avb_verification_enabled() {
142 char value[PROPERTY_VALUE_MAX];
143 return property_get("ro.boot.vbmeta.device_state", value, "") != 0;
144}
145
146char nibble2hex[16] = {'0', '1', '2', '3', '4', '5', '6', '7',
147 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
148
149// Attestations don't contain everything in key authorization lists, so we need to filter the key
150// lists to produce the lists that we expect to match the attestations.
151auto kTagsToFilter = {
David Drysdale37af4b32021-05-14 16:46:59 +0100152 Tag::CREATION_DATETIME,
153 Tag::HARDWARE_TYPE,
154 Tag::INCLUDE_UNIQUE_ID,
Shawn Willden7c130392020-12-21 09:58:22 -0700155};
156
157AuthorizationSet filtered_tags(const AuthorizationSet& set) {
158 AuthorizationSet filtered;
159 std::remove_copy_if(
160 set.begin(), set.end(), std::back_inserter(filtered), [](const auto& entry) -> bool {
161 return std::find(kTagsToFilter.begin(), kTagsToFilter.end(), entry.tag) !=
162 kTagsToFilter.end();
163 });
164 return filtered;
165}
166
David Drysdale300b5552021-05-20 12:05:26 +0100167// Remove any SecurityLevel::KEYSTORE entries from a list of key characteristics.
168void strip_keystore_tags(vector<KeyCharacteristics>* characteristics) {
169 characteristics->erase(std::remove_if(characteristics->begin(), characteristics->end(),
170 [](const auto& entry) {
171 return entry.securityLevel == SecurityLevel::KEYSTORE;
172 }),
173 characteristics->end());
174}
175
Shawn Willden7c130392020-12-21 09:58:22 -0700176string x509NameToStr(X509_NAME* name) {
177 char* s = X509_NAME_oneline(name, nullptr, 0);
178 string retval(s);
179 OPENSSL_free(s);
180 return retval;
181}
182
Shawn Willden7f424372021-01-10 18:06:50 -0700183} // namespace
184
Shawn Willden7c130392020-12-21 09:58:22 -0700185bool KeyMintAidlTestBase::arm_deleteAllKeys = false;
186bool KeyMintAidlTestBase::dump_Attestations = false;
187
David Drysdale37af4b32021-05-14 16:46:59 +0100188uint32_t KeyMintAidlTestBase::boot_patch_level(
189 const vector<KeyCharacteristics>& key_characteristics) {
190 // The boot patchlevel is not available as a property, but should be present
191 // in the key characteristics of any created key.
192 AuthorizationSet allAuths;
193 for (auto& entry : key_characteristics) {
194 allAuths.push_back(AuthorizationSet(entry.authorizations));
195 }
196 auto patchlevel = allAuths.GetTagValue(TAG_BOOT_PATCHLEVEL);
197 if (patchlevel.has_value()) {
198 return patchlevel.value();
199 } else {
200 // No boot patchlevel is available. Return a value that won't match anything
201 // and so will trigger test failures.
202 return kInvalidPatchlevel;
203 }
204}
205
206uint32_t KeyMintAidlTestBase::boot_patch_level() {
207 return boot_patch_level(key_characteristics_);
208}
209
Prashant Patil88ad1892022-03-15 16:31:02 +0000210/**
211 * An API to determine device IDs attestation is required or not,
212 * which is mandatory for KeyMint version 2 or first_api_level 33 or greater.
213 */
214bool KeyMintAidlTestBase::isDeviceIdAttestationRequired() {
215 return AidlVersion() >= 2 || property_get_int32("ro.vendor.api_level", 0) >= 33;
216}
217
David Drysdale42fe1892021-10-14 14:43:46 +0100218bool KeyMintAidlTestBase::Curve25519Supported() {
219 // Strongbox never supports curve 25519.
220 if (SecLevel() == SecurityLevel::STRONGBOX) {
221 return false;
222 }
223
224 // Curve 25519 was included in version 2 of the KeyMint interface.
225 int32_t version = 0;
226 auto status = keymint_->getInterfaceVersion(&version);
227 if (!status.isOk()) {
228 ADD_FAILURE() << "Failed to determine interface version";
229 }
230 return version >= 2;
231}
232
Janis Danisevskis24c04702020-12-16 18:28:39 -0800233ErrorCode KeyMintAidlTestBase::GetReturnErrorCode(const Status& result) {
Selene Huang31ab4042020-04-29 04:22:39 -0700234 if (result.isOk()) return ErrorCode::OK;
235
Janis Danisevskis24c04702020-12-16 18:28:39 -0800236 if (result.getExceptionCode() == EX_SERVICE_SPECIFIC) {
237 return static_cast<ErrorCode>(result.getServiceSpecificError());
Selene Huang31ab4042020-04-29 04:22:39 -0700238 }
239
240 return ErrorCode::UNKNOWN_ERROR;
241}
242
Janis Danisevskis24c04702020-12-16 18:28:39 -0800243void KeyMintAidlTestBase::InitializeKeyMint(std::shared_ptr<IKeyMintDevice> keyMint) {
Selene Huang31ab4042020-04-29 04:22:39 -0700244 ASSERT_NE(keyMint, nullptr);
Janis Danisevskis24c04702020-12-16 18:28:39 -0800245 keymint_ = std::move(keyMint);
Selene Huang31ab4042020-04-29 04:22:39 -0700246
247 KeyMintHardwareInfo info;
248 ASSERT_TRUE(keymint_->getHardwareInfo(&info).isOk());
249
250 securityLevel_ = info.securityLevel;
251 name_.assign(info.keyMintName.begin(), info.keyMintName.end());
252 author_.assign(info.keyMintAuthorName.begin(), info.keyMintAuthorName.end());
David Drysdaled2cc8c22021-04-15 13:29:45 +0100253 timestamp_token_required_ = info.timestampTokenRequired;
Selene Huang31ab4042020-04-29 04:22:39 -0700254
255 os_version_ = getOsVersion();
256 os_patch_level_ = getOsPatchlevel();
David Drysdalebb3d85e2021-04-13 11:15:51 +0100257 vendor_patch_level_ = getVendorPatchlevel();
Selene Huang31ab4042020-04-29 04:22:39 -0700258}
259
David Drysdale7dff4fc2021-12-10 10:10:52 +0000260int32_t KeyMintAidlTestBase::AidlVersion() {
261 int32_t version = 0;
262 auto status = keymint_->getInterfaceVersion(&version);
263 if (!status.isOk()) {
264 ADD_FAILURE() << "Failed to determine interface version";
265 }
266 return version;
267}
268
Selene Huang31ab4042020-04-29 04:22:39 -0700269void KeyMintAidlTestBase::SetUp() {
Janis Danisevskis24c04702020-12-16 18:28:39 -0800270 if (AServiceManager_isDeclared(GetParam().c_str())) {
271 ::ndk::SpAIBinder binder(AServiceManager_waitForService(GetParam().c_str()));
272 InitializeKeyMint(IKeyMintDevice::fromBinder(binder));
273 } else {
274 InitializeKeyMint(nullptr);
275 }
Selene Huang31ab4042020-04-29 04:22:39 -0700276}
277
278ErrorCode KeyMintAidlTestBase::GenerateKey(const AuthorizationSet& key_desc,
Shawn Willden7c130392020-12-21 09:58:22 -0700279 const optional<AttestationKey>& attest_key,
Shawn Willden7f424372021-01-10 18:06:50 -0700280 vector<uint8_t>* key_blob,
Shawn Willden7c130392020-12-21 09:58:22 -0700281 vector<KeyCharacteristics>* key_characteristics,
282 vector<Certificate>* cert_chain) {
Shawn Willden7f424372021-01-10 18:06:50 -0700283 EXPECT_NE(key_blob, nullptr) << "Key blob pointer must not be null. Test bug";
284 EXPECT_NE(key_characteristics, nullptr)
Selene Huang31ab4042020-04-29 04:22:39 -0700285 << "Previous characteristics not deleted before generating key. Test bug.";
286
Shawn Willden7f424372021-01-10 18:06:50 -0700287 KeyCreationResult creationResult;
Shawn Willden7c130392020-12-21 09:58:22 -0700288 Status result = keymint_->generateKey(key_desc.vector_data(), attest_key, &creationResult);
Selene Huang31ab4042020-04-29 04:22:39 -0700289 if (result.isOk()) {
Shawn Willden7f424372021-01-10 18:06:50 -0700290 EXPECT_PRED2(KeyCharacteristicsBasicallyValid, SecLevel(),
291 creationResult.keyCharacteristics);
292 EXPECT_GT(creationResult.keyBlob.size(), 0);
293 *key_blob = std::move(creationResult.keyBlob);
294 *key_characteristics = std::move(creationResult.keyCharacteristics);
Shawn Willden7c130392020-12-21 09:58:22 -0700295 *cert_chain = std::move(creationResult.certificateChain);
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700296
297 auto algorithm = key_desc.GetTagValue(TAG_ALGORITHM);
298 EXPECT_TRUE(algorithm);
299 if (algorithm &&
300 (algorithm.value() == Algorithm::RSA || algorithm.value() == Algorithm::EC)) {
Shawn Willden7c130392020-12-21 09:58:22 -0700301 EXPECT_GE(cert_chain->size(), 1);
302 if (key_desc.Contains(TAG_ATTESTATION_CHALLENGE)) {
303 if (attest_key) {
304 EXPECT_EQ(cert_chain->size(), 1);
305 } else {
306 EXPECT_GT(cert_chain->size(), 1);
307 }
308 }
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700309 } else {
310 // For symmetric keys there should be no certificates.
Shawn Willden7c130392020-12-21 09:58:22 -0700311 EXPECT_EQ(cert_chain->size(), 0);
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700312 }
Selene Huang31ab4042020-04-29 04:22:39 -0700313 }
314
315 return GetReturnErrorCode(result);
316}
317
Shawn Willden7c130392020-12-21 09:58:22 -0700318ErrorCode KeyMintAidlTestBase::GenerateKey(const AuthorizationSet& key_desc,
319 const optional<AttestationKey>& attest_key) {
320 return GenerateKey(key_desc, attest_key, &key_blob_, &key_characteristics_, &cert_chain_);
Selene Huang31ab4042020-04-29 04:22:39 -0700321}
322
subrahmanyaman7d9bc462022-03-16 01:40:39 +0000323ErrorCode KeyMintAidlTestBase::GenerateKeyWithSelfSignedAttestKey(
324 const AuthorizationSet& attest_key_desc, const AuthorizationSet& key_desc,
325 vector<uint8_t>* key_blob, vector<KeyCharacteristics>* key_characteristics,
326 vector<Certificate>* cert_chain) {
327 AttestationKey attest_key;
328 vector<Certificate> attest_cert_chain;
329 vector<KeyCharacteristics> attest_key_characteristics;
330 // Generate a key with self signed attestation.
331 auto error = GenerateKey(attest_key_desc, std::nullopt, &attest_key.keyBlob,
332 &attest_key_characteristics, &attest_cert_chain);
333 if (error != ErrorCode::OK) {
334 return error;
335 }
336
337 attest_key.issuerSubjectName = make_name_from_str("Android Keystore Key");
338 // Generate a key, by passing the above self signed attestation key as attest key.
339 error = GenerateKey(key_desc, attest_key, key_blob, key_characteristics, cert_chain);
340 if (error == ErrorCode::OK) {
341 // Append the attest_cert_chain to the attested cert_chain to yield a valid cert chain.
342 cert_chain->push_back(attest_cert_chain[0]);
343 }
344 return error;
345}
346
Selene Huang31ab4042020-04-29 04:22:39 -0700347ErrorCode KeyMintAidlTestBase::ImportKey(const AuthorizationSet& key_desc, KeyFormat format,
348 const string& key_material, vector<uint8_t>* key_blob,
Shawn Willden7f424372021-01-10 18:06:50 -0700349 vector<KeyCharacteristics>* key_characteristics) {
Selene Huang31ab4042020-04-29 04:22:39 -0700350 Status result;
351
Shawn Willden7f424372021-01-10 18:06:50 -0700352 cert_chain_.clear();
353 key_characteristics->clear();
Selene Huang31ab4042020-04-29 04:22:39 -0700354 key_blob->clear();
355
Shawn Willden7f424372021-01-10 18:06:50 -0700356 KeyCreationResult creationResult;
Selene Huang31ab4042020-04-29 04:22:39 -0700357 result = keymint_->importKey(key_desc.vector_data(), format,
Shawn Willden7f424372021-01-10 18:06:50 -0700358 vector<uint8_t>(key_material.begin(), key_material.end()),
Shawn Willden7c130392020-12-21 09:58:22 -0700359 {} /* attestationSigningKeyBlob */, &creationResult);
Selene Huang31ab4042020-04-29 04:22:39 -0700360
361 if (result.isOk()) {
Shawn Willden7f424372021-01-10 18:06:50 -0700362 EXPECT_PRED2(KeyCharacteristicsBasicallyValid, SecLevel(),
363 creationResult.keyCharacteristics);
364 EXPECT_GT(creationResult.keyBlob.size(), 0);
365
366 *key_blob = std::move(creationResult.keyBlob);
367 *key_characteristics = std::move(creationResult.keyCharacteristics);
368 cert_chain_ = std::move(creationResult.certificateChain);
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700369
370 auto algorithm = key_desc.GetTagValue(TAG_ALGORITHM);
371 EXPECT_TRUE(algorithm);
372 if (algorithm &&
373 (algorithm.value() == Algorithm::RSA || algorithm.value() == Algorithm::EC)) {
374 EXPECT_GE(cert_chain_.size(), 1);
375 if (key_desc.Contains(TAG_ATTESTATION_CHALLENGE)) EXPECT_GT(cert_chain_.size(), 1);
376 } else {
377 // For symmetric keys there should be no certificates.
378 EXPECT_EQ(cert_chain_.size(), 0);
379 }
Selene Huang31ab4042020-04-29 04:22:39 -0700380 }
381
382 return GetReturnErrorCode(result);
383}
384
385ErrorCode KeyMintAidlTestBase::ImportKey(const AuthorizationSet& key_desc, KeyFormat format,
386 const string& key_material) {
387 return ImportKey(key_desc, format, key_material, &key_blob_, &key_characteristics_);
388}
389
390ErrorCode KeyMintAidlTestBase::ImportWrappedKey(string wrapped_key, string wrapping_key,
391 const AuthorizationSet& wrapping_key_desc,
392 string masking_key,
David Drysdaled2cc8c22021-04-15 13:29:45 +0100393 const AuthorizationSet& unwrapping_params,
394 int64_t password_sid, int64_t biometric_sid) {
Selene Huang31ab4042020-04-29 04:22:39 -0700395 EXPECT_EQ(ErrorCode::OK, ImportKey(wrapping_key_desc, KeyFormat::PKCS8, wrapping_key));
396
Shawn Willden7f424372021-01-10 18:06:50 -0700397 key_characteristics_.clear();
Selene Huang31ab4042020-04-29 04:22:39 -0700398
Shawn Willden7f424372021-01-10 18:06:50 -0700399 KeyCreationResult creationResult;
400 Status result = keymint_->importWrappedKey(
401 vector<uint8_t>(wrapped_key.begin(), wrapped_key.end()), key_blob_,
402 vector<uint8_t>(masking_key.begin(), masking_key.end()),
David Drysdaled2cc8c22021-04-15 13:29:45 +0100403 unwrapping_params.vector_data(), password_sid, biometric_sid, &creationResult);
Selene Huang31ab4042020-04-29 04:22:39 -0700404
405 if (result.isOk()) {
Shawn Willden7f424372021-01-10 18:06:50 -0700406 EXPECT_PRED2(KeyCharacteristicsBasicallyValid, SecLevel(),
407 creationResult.keyCharacteristics);
408 EXPECT_GT(creationResult.keyBlob.size(), 0);
409
410 key_blob_ = std::move(creationResult.keyBlob);
411 key_characteristics_ = std::move(creationResult.keyCharacteristics);
412 cert_chain_ = std::move(creationResult.certificateChain);
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700413
414 AuthorizationSet allAuths;
415 for (auto& entry : key_characteristics_) {
416 allAuths.push_back(AuthorizationSet(entry.authorizations));
417 }
418 auto algorithm = allAuths.GetTagValue(TAG_ALGORITHM);
419 EXPECT_TRUE(algorithm);
420 if (algorithm &&
421 (algorithm.value() == Algorithm::RSA || algorithm.value() == Algorithm::EC)) {
422 EXPECT_GE(cert_chain_.size(), 1);
423 } else {
424 // For symmetric keys there should be no certificates.
425 EXPECT_EQ(cert_chain_.size(), 0);
426 }
Selene Huang31ab4042020-04-29 04:22:39 -0700427 }
428
429 return GetReturnErrorCode(result);
430}
431
David Drysdale300b5552021-05-20 12:05:26 +0100432ErrorCode KeyMintAidlTestBase::GetCharacteristics(const vector<uint8_t>& key_blob,
433 const vector<uint8_t>& app_id,
434 const vector<uint8_t>& app_data,
435 vector<KeyCharacteristics>* key_characteristics) {
436 Status result =
437 keymint_->getKeyCharacteristics(key_blob, app_id, app_data, key_characteristics);
438 return GetReturnErrorCode(result);
439}
440
441ErrorCode KeyMintAidlTestBase::GetCharacteristics(const vector<uint8_t>& key_blob,
442 vector<KeyCharacteristics>* key_characteristics) {
443 vector<uint8_t> empty_app_id, empty_app_data;
444 return GetCharacteristics(key_blob, empty_app_id, empty_app_data, key_characteristics);
445}
446
447void KeyMintAidlTestBase::CheckCharacteristics(
448 const vector<uint8_t>& key_blob,
449 const vector<KeyCharacteristics>& generate_characteristics) {
450 // Any key characteristics that were in SecurityLevel::KEYSTORE when returned from
451 // generateKey() should be excluded, as KeyMint will have no record of them.
452 // This applies to CREATION_DATETIME in particular.
453 vector<KeyCharacteristics> expected_characteristics(generate_characteristics);
454 strip_keystore_tags(&expected_characteristics);
455
456 vector<KeyCharacteristics> retrieved;
457 ASSERT_EQ(ErrorCode::OK, GetCharacteristics(key_blob, &retrieved));
458 EXPECT_EQ(expected_characteristics, retrieved);
459}
460
461void KeyMintAidlTestBase::CheckAppIdCharacteristics(
462 const vector<uint8_t>& key_blob, std::string_view app_id_string,
463 std::string_view app_data_string,
464 const vector<KeyCharacteristics>& generate_characteristics) {
465 // Exclude any SecurityLevel::KEYSTORE characteristics for comparisons.
466 vector<KeyCharacteristics> expected_characteristics(generate_characteristics);
467 strip_keystore_tags(&expected_characteristics);
468
469 vector<uint8_t> app_id(app_id_string.begin(), app_id_string.end());
470 vector<uint8_t> app_data(app_data_string.begin(), app_data_string.end());
471 vector<KeyCharacteristics> retrieved;
472 ASSERT_EQ(ErrorCode::OK, GetCharacteristics(key_blob, app_id, app_data, &retrieved));
473 EXPECT_EQ(expected_characteristics, retrieved);
474
475 // Check that key characteristics can't be retrieved if the app ID or app data is missing.
476 vector<uint8_t> empty;
477 vector<KeyCharacteristics> not_retrieved;
478 EXPECT_EQ(ErrorCode::INVALID_KEY_BLOB,
479 GetCharacteristics(key_blob, empty, app_data, &not_retrieved));
480 EXPECT_EQ(not_retrieved.size(), 0);
481
482 EXPECT_EQ(ErrorCode::INVALID_KEY_BLOB,
483 GetCharacteristics(key_blob, app_id, empty, &not_retrieved));
484 EXPECT_EQ(not_retrieved.size(), 0);
485
486 EXPECT_EQ(ErrorCode::INVALID_KEY_BLOB,
487 GetCharacteristics(key_blob, empty, empty, &not_retrieved));
488 EXPECT_EQ(not_retrieved.size(), 0);
489}
490
Selene Huang31ab4042020-04-29 04:22:39 -0700491ErrorCode KeyMintAidlTestBase::DeleteKey(vector<uint8_t>* key_blob, bool keep_key_blob) {
492 Status result = keymint_->deleteKey(*key_blob);
493 if (!keep_key_blob) {
494 *key_blob = vector<uint8_t>();
495 }
496
Janis Danisevskis24c04702020-12-16 18:28:39 -0800497 EXPECT_TRUE(result.isOk()) << result.getServiceSpecificError() << endl;
Selene Huang31ab4042020-04-29 04:22:39 -0700498 return GetReturnErrorCode(result);
499}
500
501ErrorCode KeyMintAidlTestBase::DeleteKey(bool keep_key_blob) {
502 return DeleteKey(&key_blob_, keep_key_blob);
503}
504
505ErrorCode KeyMintAidlTestBase::DeleteAllKeys() {
506 Status result = keymint_->deleteAllKeys();
Janis Danisevskis24c04702020-12-16 18:28:39 -0800507 EXPECT_TRUE(result.isOk()) << result.getServiceSpecificError() << endl;
Selene Huang31ab4042020-04-29 04:22:39 -0700508 return GetReturnErrorCode(result);
509}
510
David Drysdaled2cc8c22021-04-15 13:29:45 +0100511ErrorCode KeyMintAidlTestBase::DestroyAttestationIds() {
512 Status result = keymint_->destroyAttestationIds();
513 return GetReturnErrorCode(result);
514}
515
Selene Huang31ab4042020-04-29 04:22:39 -0700516void KeyMintAidlTestBase::CheckedDeleteKey(vector<uint8_t>* key_blob, bool keep_key_blob) {
517 ErrorCode result = DeleteKey(key_blob, keep_key_blob);
518 EXPECT_TRUE(result == ErrorCode::OK || result == ErrorCode::UNIMPLEMENTED) << result << endl;
519}
520
521void KeyMintAidlTestBase::CheckedDeleteKey() {
522 CheckedDeleteKey(&key_blob_);
523}
524
525ErrorCode KeyMintAidlTestBase::Begin(KeyPurpose purpose, const vector<uint8_t>& key_blob,
526 const AuthorizationSet& in_params,
Janis Danisevskis24c04702020-12-16 18:28:39 -0800527 AuthorizationSet* out_params,
528 std::shared_ptr<IKeyMintOperation>& op) {
Selene Huang31ab4042020-04-29 04:22:39 -0700529 SCOPED_TRACE("Begin");
530 Status result;
531 BeginResult out;
David Drysdale56ba9122021-04-19 19:10:47 +0100532 result = keymint_->begin(purpose, key_blob, in_params.vector_data(), std::nullopt, &out);
Selene Huang31ab4042020-04-29 04:22:39 -0700533
534 if (result.isOk()) {
535 *out_params = out.params;
536 challenge_ = out.challenge;
537 op = out.operation;
538 }
539
540 return GetReturnErrorCode(result);
541}
542
543ErrorCode KeyMintAidlTestBase::Begin(KeyPurpose purpose, const vector<uint8_t>& key_blob,
544 const AuthorizationSet& in_params,
545 AuthorizationSet* out_params) {
546 SCOPED_TRACE("Begin");
547 Status result;
548 BeginResult out;
549
David Drysdale56ba9122021-04-19 19:10:47 +0100550 result = keymint_->begin(purpose, key_blob, in_params.vector_data(), std::nullopt, &out);
Selene Huang31ab4042020-04-29 04:22:39 -0700551
552 if (result.isOk()) {
553 *out_params = out.params;
554 challenge_ = out.challenge;
555 op_ = out.operation;
556 }
557
558 return GetReturnErrorCode(result);
559}
560
561ErrorCode KeyMintAidlTestBase::Begin(KeyPurpose purpose, const AuthorizationSet& in_params,
562 AuthorizationSet* out_params) {
563 SCOPED_TRACE("Begin");
564 EXPECT_EQ(nullptr, op_);
565 return Begin(purpose, key_blob_, in_params, out_params);
566}
567
568ErrorCode KeyMintAidlTestBase::Begin(KeyPurpose purpose, const AuthorizationSet& in_params) {
569 SCOPED_TRACE("Begin");
570 AuthorizationSet out_params;
571 ErrorCode result = Begin(purpose, in_params, &out_params);
572 EXPECT_TRUE(out_params.empty());
573 return result;
574}
575
Shawn Willden92d79c02021-02-19 07:31:55 -0700576ErrorCode KeyMintAidlTestBase::UpdateAad(const string& input) {
577 return GetReturnErrorCode(op_->updateAad(vector<uint8_t>(input.begin(), input.end()),
578 {} /* hardwareAuthToken */,
579 {} /* verificationToken */));
580}
581
582ErrorCode KeyMintAidlTestBase::Update(const string& input, string* output) {
Selene Huang31ab4042020-04-29 04:22:39 -0700583 SCOPED_TRACE("Update");
584
585 Status result;
Shawn Willden92d79c02021-02-19 07:31:55 -0700586 if (!output) return ErrorCode::UNEXPECTED_NULL_POINTER;
Selene Huang31ab4042020-04-29 04:22:39 -0700587
Brian J Murrayeabd9d62022-01-06 15:13:51 -0800588 EXPECT_NE(op_, nullptr);
589 if (!op_) return ErrorCode::UNEXPECTED_NULL_POINTER;
590
Shawn Willden92d79c02021-02-19 07:31:55 -0700591 std::vector<uint8_t> o_put;
592 result = op_->update(vector<uint8_t>(input.begin(), input.end()), {}, {}, &o_put);
Selene Huang31ab4042020-04-29 04:22:39 -0700593
David Drysdalefeab5d92022-01-06 15:46:23 +0000594 if (result.isOk()) {
595 output->append(o_put.begin(), o_put.end());
596 } else {
597 // Failure always terminates the operation.
598 op_ = {};
599 }
Selene Huang31ab4042020-04-29 04:22:39 -0700600
601 return GetReturnErrorCode(result);
602}
603
Shawn Willden92d79c02021-02-19 07:31:55 -0700604ErrorCode KeyMintAidlTestBase::Finish(const string& input, const string& signature,
Selene Huang31ab4042020-04-29 04:22:39 -0700605 string* output) {
606 SCOPED_TRACE("Finish");
607 Status result;
608
609 EXPECT_NE(op_, nullptr);
Shawn Willden92d79c02021-02-19 07:31:55 -0700610 if (!op_) return ErrorCode::UNEXPECTED_NULL_POINTER;
Selene Huang31ab4042020-04-29 04:22:39 -0700611
612 vector<uint8_t> oPut;
Shawn Willden92d79c02021-02-19 07:31:55 -0700613 result = op_->finish(vector<uint8_t>(input.begin(), input.end()),
614 vector<uint8_t>(signature.begin(), signature.end()), {} /* authToken */,
615 {} /* timestampToken */, {} /* confirmationToken */, &oPut);
Selene Huang31ab4042020-04-29 04:22:39 -0700616
Shawn Willden92d79c02021-02-19 07:31:55 -0700617 if (result.isOk()) output->append(oPut.begin(), oPut.end());
Selene Huang31ab4042020-04-29 04:22:39 -0700618
Shawn Willden92d79c02021-02-19 07:31:55 -0700619 op_ = {};
Selene Huang31ab4042020-04-29 04:22:39 -0700620 return GetReturnErrorCode(result);
621}
622
Janis Danisevskis24c04702020-12-16 18:28:39 -0800623ErrorCode KeyMintAidlTestBase::Abort(const std::shared_ptr<IKeyMintOperation>& op) {
Selene Huang31ab4042020-04-29 04:22:39 -0700624 SCOPED_TRACE("Abort");
625
626 EXPECT_NE(op, nullptr);
Shawn Willden92d79c02021-02-19 07:31:55 -0700627 if (!op) return ErrorCode::UNEXPECTED_NULL_POINTER;
Selene Huang31ab4042020-04-29 04:22:39 -0700628
629 Status retval = op->abort();
630 EXPECT_TRUE(retval.isOk());
Janis Danisevskis24c04702020-12-16 18:28:39 -0800631 return static_cast<ErrorCode>(retval.getServiceSpecificError());
Selene Huang31ab4042020-04-29 04:22:39 -0700632}
633
634ErrorCode KeyMintAidlTestBase::Abort() {
635 SCOPED_TRACE("Abort");
636
637 EXPECT_NE(op_, nullptr);
Shawn Willden92d79c02021-02-19 07:31:55 -0700638 if (!op_) return ErrorCode::UNEXPECTED_NULL_POINTER;
Selene Huang31ab4042020-04-29 04:22:39 -0700639
640 Status retval = op_->abort();
Janis Danisevskis24c04702020-12-16 18:28:39 -0800641 return static_cast<ErrorCode>(retval.getServiceSpecificError());
Selene Huang31ab4042020-04-29 04:22:39 -0700642}
643
644void KeyMintAidlTestBase::AbortIfNeeded() {
645 SCOPED_TRACE("AbortIfNeeded");
646 if (op_) {
647 EXPECT_EQ(ErrorCode::OK, Abort());
Janis Danisevskis24c04702020-12-16 18:28:39 -0800648 op_.reset();
Selene Huang31ab4042020-04-29 04:22:39 -0700649 }
650}
651
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +0000652auto KeyMintAidlTestBase::ProcessMessage(const vector<uint8_t>& key_blob, KeyPurpose operation,
653 const string& message, const AuthorizationSet& in_params)
Shawn Willden92d79c02021-02-19 07:31:55 -0700654 -> std::tuple<ErrorCode, string> {
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +0000655 AuthorizationSet begin_out_params;
656 ErrorCode result = Begin(operation, key_blob, in_params, &begin_out_params);
Shawn Willden92d79c02021-02-19 07:31:55 -0700657 if (result != ErrorCode::OK) return {result, {}};
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +0000658
659 string output;
Shawn Willden92d79c02021-02-19 07:31:55 -0700660 return {Finish(message, &output), output};
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +0000661}
662
Selene Huang31ab4042020-04-29 04:22:39 -0700663string KeyMintAidlTestBase::ProcessMessage(const vector<uint8_t>& key_blob, KeyPurpose operation,
664 const string& message, const AuthorizationSet& in_params,
665 AuthorizationSet* out_params) {
666 SCOPED_TRACE("ProcessMessage");
667 AuthorizationSet begin_out_params;
Shawn Willden92d79c02021-02-19 07:31:55 -0700668 ErrorCode result = Begin(operation, key_blob, in_params, out_params);
Selene Huang31ab4042020-04-29 04:22:39 -0700669 EXPECT_EQ(ErrorCode::OK, result);
670 if (result != ErrorCode::OK) {
671 return "";
672 }
673
674 string output;
Shawn Willden92d79c02021-02-19 07:31:55 -0700675 EXPECT_EQ(ErrorCode::OK, Finish(message, &output));
Selene Huang31ab4042020-04-29 04:22:39 -0700676 return output;
677}
678
679string KeyMintAidlTestBase::SignMessage(const vector<uint8_t>& key_blob, const string& message,
680 const AuthorizationSet& params) {
681 SCOPED_TRACE("SignMessage");
682 AuthorizationSet out_params;
683 string signature = ProcessMessage(key_blob, KeyPurpose::SIGN, message, params, &out_params);
684 EXPECT_TRUE(out_params.empty());
685 return signature;
686}
687
688string KeyMintAidlTestBase::SignMessage(const string& message, const AuthorizationSet& params) {
689 SCOPED_TRACE("SignMessage");
690 return SignMessage(key_blob_, message, params);
691}
692
693string KeyMintAidlTestBase::MacMessage(const string& message, Digest digest, size_t mac_length) {
694 SCOPED_TRACE("MacMessage");
695 return SignMessage(
696 key_blob_, message,
697 AuthorizationSetBuilder().Digest(digest).Authorization(TAG_MAC_LENGTH, mac_length));
698}
699
anil.hiranniah19a4ca12022-03-03 17:39:30 +0530700void KeyMintAidlTestBase::CheckAesIncrementalEncryptOperation(BlockMode block_mode,
701 int message_size) {
David Drysdale1a637192022-03-14 09:11:29 +0000702 auto builder = AuthorizationSetBuilder()
703 .Authorization(TAG_NO_AUTH_REQUIRED)
704 .AesEncryptionKey(128)
705 .BlockMode(block_mode)
706 .Padding(PaddingMode::NONE);
707 if (block_mode == BlockMode::GCM) {
708 builder.Authorization(TAG_MIN_MAC_LENGTH, 128);
709 }
710 ASSERT_EQ(ErrorCode::OK, GenerateKey(builder));
anil.hiranniah19a4ca12022-03-03 17:39:30 +0530711
712 for (int increment = 1; increment <= message_size; ++increment) {
713 string message(message_size, 'a');
714 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(PaddingMode::NONE);
715 if (block_mode == BlockMode::GCM) {
716 params.Authorization(TAG_MAC_LENGTH, 128) /* for GCM */;
717 }
718
719 AuthorizationSet output_params;
720 EXPECT_EQ(ErrorCode::OK, Begin(KeyPurpose::ENCRYPT, params, &output_params));
721
722 string ciphertext;
723 string to_send;
724 for (size_t i = 0; i < message.size(); i += increment) {
725 EXPECT_EQ(ErrorCode::OK, Update(message.substr(i, increment), &ciphertext));
726 }
727 EXPECT_EQ(ErrorCode::OK, Finish(to_send, &ciphertext))
728 << "Error sending " << to_send << " with block mode " << block_mode;
729
730 switch (block_mode) {
731 case BlockMode::GCM:
732 EXPECT_EQ(message.size() + 16, ciphertext.size());
733 break;
734 case BlockMode::CTR:
735 EXPECT_EQ(message.size(), ciphertext.size());
736 break;
737 case BlockMode::CBC:
738 case BlockMode::ECB:
739 EXPECT_EQ(message.size() + message.size() % 16, ciphertext.size());
740 break;
741 }
742
743 auto iv = output_params.GetTagValue(TAG_NONCE);
744 switch (block_mode) {
745 case BlockMode::CBC:
746 case BlockMode::GCM:
747 case BlockMode::CTR:
748 ASSERT_TRUE(iv) << "No IV for block mode " << block_mode;
749 EXPECT_EQ(block_mode == BlockMode::GCM ? 12U : 16U, iv->get().size());
750 params.push_back(TAG_NONCE, iv->get());
751 break;
752
753 case BlockMode::ECB:
754 EXPECT_FALSE(iv) << "ECB mode should not generate IV";
755 break;
756 }
757
758 EXPECT_EQ(ErrorCode::OK, Begin(KeyPurpose::DECRYPT, params))
759 << "Decrypt begin() failed for block mode " << block_mode;
760
761 string plaintext;
762 for (size_t i = 0; i < ciphertext.size(); i += increment) {
763 EXPECT_EQ(ErrorCode::OK, Update(ciphertext.substr(i, increment), &plaintext));
764 }
765 ErrorCode error = Finish(to_send, &plaintext);
766 ASSERT_EQ(ErrorCode::OK, error) << "Decryption failed for block mode " << block_mode
767 << " and increment " << increment;
768 if (error == ErrorCode::OK) {
769 ASSERT_EQ(message, plaintext) << "Decryption didn't match for block mode " << block_mode
770 << " and increment " << increment;
771 }
772 }
773}
774
Prashant Patildd5f7f02022-07-06 18:58:07 +0000775void KeyMintAidlTestBase::AesCheckEncryptOneByteAtATime(const string& key, BlockMode block_mode,
776 PaddingMode padding_mode, const string& iv,
777 const string& plaintext,
778 const string& exp_cipher_text) {
779 bool is_authenticated_cipher = (block_mode == BlockMode::GCM);
780 auto auth_set = AuthorizationSetBuilder()
781 .Authorization(TAG_NO_AUTH_REQUIRED)
782 .AesEncryptionKey(key.size() * 8)
783 .BlockMode(block_mode)
784 .Padding(padding_mode);
785 if (iv.size() > 0) auth_set.Authorization(TAG_CALLER_NONCE);
786 if (is_authenticated_cipher) auth_set.Authorization(TAG_MIN_MAC_LENGTH, 128);
787 ASSERT_EQ(ErrorCode::OK, ImportKey(auth_set, KeyFormat::RAW, key));
788
789 CheckEncryptOneByteAtATime(block_mode, 16 /*block_size*/, padding_mode, iv, plaintext,
790 exp_cipher_text);
791}
792
793void KeyMintAidlTestBase::CheckEncryptOneByteAtATime(BlockMode block_mode, const int block_size,
794 PaddingMode padding_mode, const string& iv,
795 const string& plaintext,
796 const string& exp_cipher_text) {
797 bool is_stream_cipher = (block_mode == BlockMode::CTR || block_mode == BlockMode::GCM);
798 bool is_authenticated_cipher = (block_mode == BlockMode::GCM);
799 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding_mode);
800 if (iv.size() > 0) params.Authorization(TAG_NONCE, iv.data(), iv.size());
801 if (is_authenticated_cipher) params.Authorization(TAG_MAC_LENGTH, 128);
802
803 AuthorizationSet output_params;
804 EXPECT_EQ(ErrorCode::OK, Begin(KeyPurpose::ENCRYPT, params, &output_params));
805
806 string actual_ciphertext;
807 if (is_stream_cipher) {
808 // Assert that a 1 byte of output is produced for 1 byte of input.
809 // Every input byte produces an output byte.
810 for (int plaintext_index = 0; plaintext_index < plaintext.size(); plaintext_index++) {
811 string ciphertext;
812 EXPECT_EQ(ErrorCode::OK, Update(plaintext.substr(plaintext_index, 1), &ciphertext));
813 // Some StrongBox implementations cannot support 1:1 input:output lengths, so
814 // we relax this API restriction for them.
815 if (SecLevel() != SecurityLevel::STRONGBOX) {
816 EXPECT_EQ(1, ciphertext.size()) << "plaintext index: " << plaintext_index;
817 }
818 actual_ciphertext.append(ciphertext);
819 }
820 string ciphertext;
821 EXPECT_EQ(ErrorCode::OK, Finish(&ciphertext));
822 if (SecLevel() != SecurityLevel::STRONGBOX) {
823 string expected_final_output;
824 if (is_authenticated_cipher) {
825 expected_final_output = exp_cipher_text.substr(plaintext.size());
826 }
827 EXPECT_EQ(expected_final_output, ciphertext);
828 }
829 actual_ciphertext.append(ciphertext);
830 } else {
831 // Assert that a block of output is produced once a full block of input is provided.
832 // Every input block produces an output block.
833 bool compare_output = true;
834 string additional_information;
835 int vendor_api_level = property_get_int32("ro.vendor.api_level", 0);
836 if (SecLevel() == SecurityLevel::STRONGBOX) {
837 // This is known to be broken on older vendor implementations.
838 if (vendor_api_level < 33) {
839 compare_output = false;
840 } else {
841 additional_information = " (b/194134359) ";
842 }
843 }
844 for (int plaintext_index = 0; plaintext_index < plaintext.size(); plaintext_index++) {
845 string ciphertext;
846 EXPECT_EQ(ErrorCode::OK, Update(plaintext.substr(plaintext_index, 1), &ciphertext));
847 if (compare_output) {
848 if ((plaintext_index % block_size) == block_size - 1) {
849 // Update is expected to have output a new block
850 EXPECT_EQ(block_size, ciphertext.size())
851 << "plaintext index: " << plaintext_index << additional_information;
852 } else {
853 // Update is expected to have produced no output
854 EXPECT_EQ(0, ciphertext.size())
855 << "plaintext index: " << plaintext_index << additional_information;
856 }
857 }
858 actual_ciphertext.append(ciphertext);
859 }
860 string ciphertext;
861 EXPECT_EQ(ErrorCode::OK, Finish(&ciphertext));
862 actual_ciphertext.append(ciphertext);
863 }
864 // Regardless of how the completed ciphertext got accumulated, it should match the expected
865 // ciphertext.
866 EXPECT_EQ(exp_cipher_text, actual_ciphertext);
867}
868
Selene Huang31ab4042020-04-29 04:22:39 -0700869void KeyMintAidlTestBase::CheckHmacTestVector(const string& key, const string& message,
870 Digest digest, const string& expected_mac) {
871 SCOPED_TRACE("CheckHmacTestVector");
872 ASSERT_EQ(ErrorCode::OK,
873 ImportKey(AuthorizationSetBuilder()
874 .Authorization(TAG_NO_AUTH_REQUIRED)
875 .HmacKey(key.size() * 8)
876 .Authorization(TAG_MIN_MAC_LENGTH, expected_mac.size() * 8)
877 .Digest(digest),
878 KeyFormat::RAW, key));
879 string signature = MacMessage(message, digest, expected_mac.size() * 8);
880 EXPECT_EQ(expected_mac, signature)
881 << "Test vector didn't match for key of size " << key.size() << " message of size "
882 << message.size() << " and digest " << digest;
883 CheckedDeleteKey();
884}
885
886void KeyMintAidlTestBase::CheckAesCtrTestVector(const string& key, const string& nonce,
887 const string& message,
888 const string& expected_ciphertext) {
889 SCOPED_TRACE("CheckAesCtrTestVector");
890 ASSERT_EQ(ErrorCode::OK, ImportKey(AuthorizationSetBuilder()
891 .Authorization(TAG_NO_AUTH_REQUIRED)
892 .AesEncryptionKey(key.size() * 8)
893 .BlockMode(BlockMode::CTR)
894 .Authorization(TAG_CALLER_NONCE)
895 .Padding(PaddingMode::NONE),
896 KeyFormat::RAW, key));
897
898 auto params = AuthorizationSetBuilder()
899 .Authorization(TAG_NONCE, nonce.data(), nonce.size())
900 .BlockMode(BlockMode::CTR)
901 .Padding(PaddingMode::NONE);
902 AuthorizationSet out_params;
903 string ciphertext = EncryptMessage(key_blob_, message, params, &out_params);
904 EXPECT_EQ(expected_ciphertext, ciphertext);
905}
906
907void KeyMintAidlTestBase::CheckTripleDesTestVector(KeyPurpose purpose, BlockMode block_mode,
908 PaddingMode padding_mode, const string& key,
909 const string& iv, const string& input,
910 const string& expected_output) {
911 auto authset = AuthorizationSetBuilder()
912 .TripleDesEncryptionKey(key.size() * 7)
913 .BlockMode(block_mode)
914 .Authorization(TAG_NO_AUTH_REQUIRED)
915 .Padding(padding_mode);
916 if (iv.size()) authset.Authorization(TAG_CALLER_NONCE);
917 ASSERT_EQ(ErrorCode::OK, ImportKey(authset, KeyFormat::RAW, key));
918 ASSERT_GT(key_blob_.size(), 0U);
919
920 auto begin_params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding_mode);
921 if (iv.size()) begin_params.Authorization(TAG_NONCE, iv.data(), iv.size());
922 AuthorizationSet output_params;
923 string output = ProcessMessage(key_blob_, purpose, input, begin_params, &output_params);
924 EXPECT_EQ(expected_output, output);
925}
926
927void KeyMintAidlTestBase::VerifyMessage(const vector<uint8_t>& key_blob, const string& message,
928 const string& signature, const AuthorizationSet& params) {
929 SCOPED_TRACE("VerifyMessage");
930 AuthorizationSet begin_out_params;
931 ASSERT_EQ(ErrorCode::OK, Begin(KeyPurpose::VERIFY, key_blob, params, &begin_out_params));
932
933 string output;
Shawn Willden92d79c02021-02-19 07:31:55 -0700934 EXPECT_EQ(ErrorCode::OK, Finish(message, signature, &output));
Selene Huang31ab4042020-04-29 04:22:39 -0700935 EXPECT_TRUE(output.empty());
Shawn Willden92d79c02021-02-19 07:31:55 -0700936 op_ = {};
Selene Huang31ab4042020-04-29 04:22:39 -0700937}
938
939void KeyMintAidlTestBase::VerifyMessage(const string& message, const string& signature,
940 const AuthorizationSet& params) {
941 SCOPED_TRACE("VerifyMessage");
942 VerifyMessage(key_blob_, message, signature, params);
943}
944
David Drysdaledf8f52e2021-05-06 08:10:58 +0100945void KeyMintAidlTestBase::LocalVerifyMessage(const string& message, const string& signature,
946 const AuthorizationSet& params) {
947 SCOPED_TRACE("LocalVerifyMessage");
948
949 // Retrieve the public key from the leaf certificate.
950 ASSERT_GT(cert_chain_.size(), 0);
951 X509_Ptr key_cert(parse_cert_blob(cert_chain_[0].encodedCertificate));
952 ASSERT_TRUE(key_cert.get());
953 EVP_PKEY_Ptr pub_key(X509_get_pubkey(key_cert.get()));
954 ASSERT_TRUE(pub_key.get());
955
956 Digest digest = params.GetTagValue(TAG_DIGEST).value();
957 PaddingMode padding = PaddingMode::NONE;
958 auto tag = params.GetTagValue(TAG_PADDING);
959 if (tag.has_value()) {
960 padding = tag.value();
961 }
962
963 if (digest == Digest::NONE) {
964 switch (EVP_PKEY_id(pub_key.get())) {
David Drysdale42fe1892021-10-14 14:43:46 +0100965 case EVP_PKEY_ED25519: {
966 ASSERT_EQ(64, signature.size());
967 uint8_t pub_keydata[32];
968 size_t pub_len = sizeof(pub_keydata);
969 ASSERT_EQ(1, EVP_PKEY_get_raw_public_key(pub_key.get(), pub_keydata, &pub_len));
970 ASSERT_EQ(sizeof(pub_keydata), pub_len);
971 ASSERT_EQ(1, ED25519_verify(reinterpret_cast<const uint8_t*>(message.data()),
972 message.size(),
973 reinterpret_cast<const uint8_t*>(signature.data()),
974 pub_keydata));
975 break;
976 }
977
David Drysdaledf8f52e2021-05-06 08:10:58 +0100978 case EVP_PKEY_EC: {
979 vector<uint8_t> data((EVP_PKEY_bits(pub_key.get()) + 7) / 8);
980 size_t data_size = std::min(data.size(), message.size());
981 memcpy(data.data(), message.data(), data_size);
982 EC_KEY_Ptr ecdsa(EVP_PKEY_get1_EC_KEY(pub_key.get()));
983 ASSERT_TRUE(ecdsa.get());
984 ASSERT_EQ(1,
985 ECDSA_verify(0, reinterpret_cast<const uint8_t*>(data.data()), data_size,
986 reinterpret_cast<const uint8_t*>(signature.data()),
987 signature.size(), ecdsa.get()));
988 break;
989 }
990 case EVP_PKEY_RSA: {
991 vector<uint8_t> data(EVP_PKEY_size(pub_key.get()));
992 size_t data_size = std::min(data.size(), message.size());
993 memcpy(data.data(), message.data(), data_size);
994
995 RSA_Ptr rsa(EVP_PKEY_get1_RSA(const_cast<EVP_PKEY*>(pub_key.get())));
996 ASSERT_TRUE(rsa.get());
997
998 size_t key_len = RSA_size(rsa.get());
999 int openssl_padding = RSA_NO_PADDING;
1000 switch (padding) {
1001 case PaddingMode::NONE:
1002 ASSERT_TRUE(data_size <= key_len);
1003 ASSERT_EQ(key_len, signature.size());
1004 openssl_padding = RSA_NO_PADDING;
1005 break;
1006 case PaddingMode::RSA_PKCS1_1_5_SIGN:
1007 ASSERT_TRUE(data_size + kPkcs1UndigestedSignaturePaddingOverhead <=
1008 key_len);
1009 openssl_padding = RSA_PKCS1_PADDING;
1010 break;
1011 default:
1012 ADD_FAILURE() << "Unsupported RSA padding mode " << padding;
1013 }
1014
1015 vector<uint8_t> decrypted_data(key_len);
1016 int bytes_decrypted = RSA_public_decrypt(
1017 signature.size(), reinterpret_cast<const uint8_t*>(signature.data()),
1018 decrypted_data.data(), rsa.get(), openssl_padding);
1019 ASSERT_GE(bytes_decrypted, 0);
1020
1021 const uint8_t* compare_pos = decrypted_data.data();
1022 size_t bytes_to_compare = bytes_decrypted;
1023 uint8_t zero_check_result = 0;
1024 if (padding == PaddingMode::NONE && data_size < bytes_to_compare) {
1025 // If the data is short, for "unpadded" signing we zero-pad to the left. So
1026 // during verification we should have zeros on the left of the decrypted data.
1027 // Do a constant-time check.
1028 const uint8_t* zero_end = compare_pos + bytes_to_compare - data_size;
1029 while (compare_pos < zero_end) zero_check_result |= *compare_pos++;
1030 ASSERT_EQ(0, zero_check_result);
1031 bytes_to_compare = data_size;
1032 }
1033 ASSERT_EQ(0, memcmp(compare_pos, data.data(), bytes_to_compare));
1034 break;
1035 }
1036 default:
1037 ADD_FAILURE() << "Unknown public key type";
1038 }
1039 } else {
1040 EVP_MD_CTX digest_ctx;
1041 EVP_MD_CTX_init(&digest_ctx);
1042 EVP_PKEY_CTX* pkey_ctx;
1043 const EVP_MD* md = openssl_digest(digest);
1044 ASSERT_NE(md, nullptr);
1045 ASSERT_EQ(1, EVP_DigestVerifyInit(&digest_ctx, &pkey_ctx, md, nullptr, pub_key.get()));
1046
1047 if (padding == PaddingMode::RSA_PSS) {
1048 EXPECT_GT(EVP_PKEY_CTX_set_rsa_padding(pkey_ctx, RSA_PKCS1_PSS_PADDING), 0);
1049 EXPECT_GT(EVP_PKEY_CTX_set_rsa_pss_saltlen(pkey_ctx, EVP_MD_size(md)), 0);
David Drysdalec6b89072021-12-14 14:32:51 +00001050 EXPECT_GT(EVP_PKEY_CTX_set_rsa_mgf1_md(pkey_ctx, md), 0);
David Drysdaledf8f52e2021-05-06 08:10:58 +01001051 }
1052
1053 ASSERT_EQ(1, EVP_DigestVerifyUpdate(&digest_ctx,
1054 reinterpret_cast<const uint8_t*>(message.data()),
1055 message.size()));
1056 ASSERT_EQ(1, EVP_DigestVerifyFinal(&digest_ctx,
1057 reinterpret_cast<const uint8_t*>(signature.data()),
1058 signature.size()));
1059 EVP_MD_CTX_cleanup(&digest_ctx);
1060 }
1061}
1062
David Drysdale59cae642021-05-12 13:52:03 +01001063string KeyMintAidlTestBase::LocalRsaEncryptMessage(const string& message,
1064 const AuthorizationSet& params) {
1065 SCOPED_TRACE("LocalRsaEncryptMessage");
1066
1067 // Retrieve the public key from the leaf certificate.
1068 if (cert_chain_.empty()) {
1069 ADD_FAILURE() << "No public key available";
1070 return "Failure";
1071 }
1072 X509_Ptr key_cert(parse_cert_blob(cert_chain_[0].encodedCertificate));
1073 EVP_PKEY_Ptr pub_key(X509_get_pubkey(key_cert.get()));
1074 RSA_Ptr rsa(EVP_PKEY_get1_RSA(const_cast<EVP_PKEY*>(pub_key.get())));
1075
1076 // Retrieve relevant tags.
1077 Digest digest = Digest::NONE;
1078 Digest mgf_digest = Digest::NONE;
1079 PaddingMode padding = PaddingMode::NONE;
1080
1081 auto digest_tag = params.GetTagValue(TAG_DIGEST);
1082 if (digest_tag.has_value()) digest = digest_tag.value();
1083 auto pad_tag = params.GetTagValue(TAG_PADDING);
1084 if (pad_tag.has_value()) padding = pad_tag.value();
1085 auto mgf_tag = params.GetTagValue(TAG_RSA_OAEP_MGF_DIGEST);
1086 if (mgf_tag.has_value()) mgf_digest = mgf_tag.value();
1087
1088 const EVP_MD* md = openssl_digest(digest);
1089 const EVP_MD* mgf_md = openssl_digest(mgf_digest);
1090
1091 // Set up encryption context.
1092 EVP_PKEY_CTX_Ptr ctx(EVP_PKEY_CTX_new(pub_key.get(), /* engine= */ nullptr));
1093 if (EVP_PKEY_encrypt_init(ctx.get()) <= 0) {
1094 ADD_FAILURE() << "Encryption init failed: " << ERR_peek_last_error();
1095 return "Failure";
1096 }
1097
1098 int rc = -1;
1099 switch (padding) {
1100 case PaddingMode::NONE:
1101 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_NO_PADDING);
1102 break;
1103 case PaddingMode::RSA_PKCS1_1_5_ENCRYPT:
1104 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_PKCS1_PADDING);
1105 break;
1106 case PaddingMode::RSA_OAEP:
1107 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_PKCS1_OAEP_PADDING);
1108 break;
1109 default:
1110 break;
1111 }
1112 if (rc <= 0) {
1113 ADD_FAILURE() << "Set padding failed: " << ERR_peek_last_error();
1114 return "Failure";
1115 }
1116 if (padding == PaddingMode::RSA_OAEP) {
1117 if (!EVP_PKEY_CTX_set_rsa_oaep_md(ctx.get(), md)) {
1118 ADD_FAILURE() << "Set digest failed: " << ERR_peek_last_error();
1119 return "Failure";
1120 }
1121 if (!EVP_PKEY_CTX_set_rsa_mgf1_md(ctx.get(), mgf_md)) {
1122 ADD_FAILURE() << "Set MGF digest failed: " << ERR_peek_last_error();
1123 return "Failure";
1124 }
1125 }
1126
1127 // Determine output size.
1128 size_t outlen;
1129 if (EVP_PKEY_encrypt(ctx.get(), nullptr /* out */, &outlen,
1130 reinterpret_cast<const uint8_t*>(message.data()), message.size()) <= 0) {
1131 ADD_FAILURE() << "Determine output size failed: " << ERR_peek_last_error();
1132 return "Failure";
1133 }
1134
1135 // Left-zero-pad the input if necessary.
1136 const uint8_t* to_encrypt = reinterpret_cast<const uint8_t*>(message.data());
1137 size_t to_encrypt_len = message.size();
1138
1139 std::unique_ptr<string> zero_padded_message;
1140 if (padding == PaddingMode::NONE && to_encrypt_len < outlen) {
1141 zero_padded_message.reset(new string(outlen, '\0'));
1142 memcpy(zero_padded_message->data() + (outlen - to_encrypt_len), message.data(),
1143 message.size());
1144 to_encrypt = reinterpret_cast<const uint8_t*>(zero_padded_message->data());
1145 to_encrypt_len = outlen;
1146 }
1147
1148 // Do the encryption.
1149 string output(outlen, '\0');
1150 if (EVP_PKEY_encrypt(ctx.get(), reinterpret_cast<uint8_t*>(output.data()), &outlen, to_encrypt,
1151 to_encrypt_len) <= 0) {
1152 ADD_FAILURE() << "Encryption failed: " << ERR_peek_last_error();
1153 return "Failure";
1154 }
1155 return output;
1156}
1157
Selene Huang31ab4042020-04-29 04:22:39 -07001158string KeyMintAidlTestBase::EncryptMessage(const vector<uint8_t>& key_blob, const string& message,
1159 const AuthorizationSet& in_params,
1160 AuthorizationSet* out_params) {
1161 SCOPED_TRACE("EncryptMessage");
1162 return ProcessMessage(key_blob, KeyPurpose::ENCRYPT, message, in_params, out_params);
1163}
1164
1165string KeyMintAidlTestBase::EncryptMessage(const string& message, const AuthorizationSet& params,
1166 AuthorizationSet* out_params) {
1167 SCOPED_TRACE("EncryptMessage");
1168 return EncryptMessage(key_blob_, message, params, out_params);
1169}
1170
1171string KeyMintAidlTestBase::EncryptMessage(const string& message, const AuthorizationSet& params) {
1172 SCOPED_TRACE("EncryptMessage");
1173 AuthorizationSet out_params;
1174 string ciphertext = EncryptMessage(message, params, &out_params);
1175 EXPECT_TRUE(out_params.empty()) << "Output params should be empty. Contained: " << out_params;
1176 return ciphertext;
1177}
1178
1179string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1180 PaddingMode padding) {
1181 SCOPED_TRACE("EncryptMessage");
1182 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding);
1183 AuthorizationSet out_params;
1184 string ciphertext = EncryptMessage(message, params, &out_params);
1185 EXPECT_TRUE(out_params.empty()) << "Output params should be empty. Contained: " << out_params;
1186 return ciphertext;
1187}
1188
1189string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1190 PaddingMode padding, vector<uint8_t>* iv_out) {
1191 SCOPED_TRACE("EncryptMessage");
1192 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding);
1193 AuthorizationSet out_params;
1194 string ciphertext = EncryptMessage(message, params, &out_params);
1195 EXPECT_EQ(1U, out_params.size());
1196 auto ivVal = out_params.GetTagValue(TAG_NONCE);
Janis Danisevskis5ba09332020-12-17 10:05:15 -08001197 EXPECT_TRUE(ivVal);
1198 if (ivVal) *iv_out = *ivVal;
Selene Huang31ab4042020-04-29 04:22:39 -07001199 return ciphertext;
1200}
1201
1202string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1203 PaddingMode padding, const vector<uint8_t>& iv_in) {
1204 SCOPED_TRACE("EncryptMessage");
1205 auto params = AuthorizationSetBuilder()
1206 .BlockMode(block_mode)
1207 .Padding(padding)
1208 .Authorization(TAG_NONCE, iv_in);
1209 AuthorizationSet out_params;
1210 string ciphertext = EncryptMessage(message, params, &out_params);
1211 return ciphertext;
1212}
1213
1214string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1215 PaddingMode padding, uint8_t mac_length_bits,
1216 const vector<uint8_t>& iv_in) {
1217 SCOPED_TRACE("EncryptMessage");
1218 auto params = AuthorizationSetBuilder()
1219 .BlockMode(block_mode)
1220 .Padding(padding)
1221 .Authorization(TAG_MAC_LENGTH, mac_length_bits)
1222 .Authorization(TAG_NONCE, iv_in);
1223 AuthorizationSet out_params;
1224 string ciphertext = EncryptMessage(message, params, &out_params);
1225 return ciphertext;
1226}
1227
David Drysdaled2cc8c22021-04-15 13:29:45 +01001228string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1229 PaddingMode padding, uint8_t mac_length_bits) {
1230 SCOPED_TRACE("EncryptMessage");
1231 auto params = AuthorizationSetBuilder()
1232 .BlockMode(block_mode)
1233 .Padding(padding)
1234 .Authorization(TAG_MAC_LENGTH, mac_length_bits);
1235 AuthorizationSet out_params;
1236 string ciphertext = EncryptMessage(message, params, &out_params);
1237 return ciphertext;
1238}
1239
Selene Huang31ab4042020-04-29 04:22:39 -07001240string KeyMintAidlTestBase::DecryptMessage(const vector<uint8_t>& key_blob,
1241 const string& ciphertext,
1242 const AuthorizationSet& params) {
1243 SCOPED_TRACE("DecryptMessage");
1244 AuthorizationSet out_params;
1245 string plaintext =
1246 ProcessMessage(key_blob, KeyPurpose::DECRYPT, ciphertext, params, &out_params);
1247 EXPECT_TRUE(out_params.empty());
1248 return plaintext;
1249}
1250
1251string KeyMintAidlTestBase::DecryptMessage(const string& ciphertext,
1252 const AuthorizationSet& params) {
1253 SCOPED_TRACE("DecryptMessage");
1254 return DecryptMessage(key_blob_, ciphertext, params);
1255}
1256
1257string KeyMintAidlTestBase::DecryptMessage(const string& ciphertext, BlockMode block_mode,
1258 PaddingMode padding_mode, const vector<uint8_t>& iv) {
1259 SCOPED_TRACE("DecryptMessage");
1260 auto params = AuthorizationSetBuilder()
1261 .BlockMode(block_mode)
1262 .Padding(padding_mode)
1263 .Authorization(TAG_NONCE, iv);
1264 return DecryptMessage(key_blob_, ciphertext, params);
1265}
1266
1267std::pair<ErrorCode, vector<uint8_t>> KeyMintAidlTestBase::UpgradeKey(
1268 const vector<uint8_t>& key_blob) {
1269 std::pair<ErrorCode, vector<uint8_t>> retval;
1270 vector<uint8_t> outKeyBlob;
1271 Status result = keymint_->upgradeKey(key_blob, vector<KeyParameter>(), &outKeyBlob);
1272 ErrorCode errorcode = GetReturnErrorCode(result);
1273 retval = std::tie(errorcode, outKeyBlob);
1274
1275 return retval;
1276}
1277vector<uint32_t> KeyMintAidlTestBase::ValidKeySizes(Algorithm algorithm) {
1278 switch (algorithm) {
1279 case Algorithm::RSA:
1280 switch (SecLevel()) {
1281 case SecurityLevel::SOFTWARE:
1282 case SecurityLevel::TRUSTED_ENVIRONMENT:
1283 return {2048, 3072, 4096};
1284 case SecurityLevel::STRONGBOX:
1285 return {2048};
1286 default:
1287 ADD_FAILURE() << "Invalid security level " << uint32_t(SecLevel());
1288 break;
1289 }
1290 break;
1291 case Algorithm::EC:
David Drysdaledf09e542021-06-08 15:46:11 +01001292 ADD_FAILURE() << "EC keys must be specified by curve not size";
Selene Huang31ab4042020-04-29 04:22:39 -07001293 break;
1294 case Algorithm::AES:
1295 return {128, 256};
1296 case Algorithm::TRIPLE_DES:
1297 return {168};
1298 case Algorithm::HMAC: {
1299 vector<uint32_t> retval((512 - 64) / 8 + 1);
1300 uint32_t size = 64 - 8;
1301 std::generate(retval.begin(), retval.end(), [&]() { return (size += 8); });
1302 return retval;
1303 }
1304 default:
1305 ADD_FAILURE() << "Invalid Algorithm: " << algorithm;
1306 return {};
1307 }
1308 ADD_FAILURE() << "Should be impossible to get here";
1309 return {};
1310}
1311
1312vector<uint32_t> KeyMintAidlTestBase::InvalidKeySizes(Algorithm algorithm) {
1313 if (SecLevel() == SecurityLevel::STRONGBOX) {
1314 switch (algorithm) {
1315 case Algorithm::RSA:
1316 return {3072, 4096};
1317 case Algorithm::EC:
1318 return {224, 384, 521};
1319 case Algorithm::AES:
1320 return {192};
David Drysdale7de9feb2021-03-05 14:56:19 +00001321 case Algorithm::TRIPLE_DES:
1322 return {56};
1323 default:
1324 return {};
1325 }
1326 } else {
1327 switch (algorithm) {
Prashant Patild72b3512021-11-16 08:19:19 +00001328 case Algorithm::AES:
1329 return {64, 96, 131, 512};
David Drysdale7de9feb2021-03-05 14:56:19 +00001330 case Algorithm::TRIPLE_DES:
1331 return {56};
Selene Huang31ab4042020-04-29 04:22:39 -07001332 default:
1333 return {};
1334 }
1335 }
1336 return {};
1337}
1338
David Drysdale7de9feb2021-03-05 14:56:19 +00001339vector<BlockMode> KeyMintAidlTestBase::ValidBlockModes(Algorithm algorithm) {
1340 switch (algorithm) {
1341 case Algorithm::AES:
1342 return {
1343 BlockMode::CBC,
1344 BlockMode::CTR,
1345 BlockMode::ECB,
1346 BlockMode::GCM,
1347 };
1348 case Algorithm::TRIPLE_DES:
1349 return {
1350 BlockMode::CBC,
1351 BlockMode::ECB,
1352 };
1353 default:
1354 return {};
1355 }
1356}
1357
1358vector<PaddingMode> KeyMintAidlTestBase::ValidPaddingModes(Algorithm algorithm,
1359 BlockMode blockMode) {
1360 switch (algorithm) {
1361 case Algorithm::AES:
1362 switch (blockMode) {
1363 case BlockMode::CBC:
1364 case BlockMode::ECB:
1365 return {PaddingMode::NONE, PaddingMode::PKCS7};
1366 case BlockMode::CTR:
1367 case BlockMode::GCM:
1368 return {PaddingMode::NONE};
1369 default:
1370 return {};
1371 };
1372 case Algorithm::TRIPLE_DES:
1373 switch (blockMode) {
1374 case BlockMode::CBC:
1375 case BlockMode::ECB:
1376 return {PaddingMode::NONE, PaddingMode::PKCS7};
1377 default:
1378 return {};
1379 };
1380 default:
1381 return {};
1382 }
1383}
1384
1385vector<PaddingMode> KeyMintAidlTestBase::InvalidPaddingModes(Algorithm algorithm,
1386 BlockMode blockMode) {
1387 switch (algorithm) {
1388 case Algorithm::AES:
1389 switch (blockMode) {
1390 case BlockMode::CTR:
1391 case BlockMode::GCM:
1392 return {PaddingMode::PKCS7};
1393 default:
1394 return {};
1395 };
1396 default:
1397 return {};
1398 }
1399}
1400
Selene Huang31ab4042020-04-29 04:22:39 -07001401vector<EcCurve> KeyMintAidlTestBase::ValidCurves() {
1402 if (securityLevel_ == SecurityLevel::STRONGBOX) {
1403 return {EcCurve::P_256};
David Drysdale42fe1892021-10-14 14:43:46 +01001404 } else if (Curve25519Supported()) {
1405 return {EcCurve::P_224, EcCurve::P_256, EcCurve::P_384, EcCurve::P_521,
1406 EcCurve::CURVE_25519};
Selene Huang31ab4042020-04-29 04:22:39 -07001407 } else {
David Drysdale42fe1892021-10-14 14:43:46 +01001408 return {
1409 EcCurve::P_224,
1410 EcCurve::P_256,
1411 EcCurve::P_384,
1412 EcCurve::P_521,
1413 };
Selene Huang31ab4042020-04-29 04:22:39 -07001414 }
1415}
1416
1417vector<EcCurve> KeyMintAidlTestBase::InvalidCurves() {
David Drysdaledf09e542021-06-08 15:46:11 +01001418 if (SecLevel() == SecurityLevel::STRONGBOX) {
David Drysdale42fe1892021-10-14 14:43:46 +01001419 // Curve 25519 is not supported, either because:
1420 // - KeyMint v1: it's an unknown enum value
1421 // - KeyMint v2+: it's not supported by StrongBox.
1422 return {EcCurve::P_224, EcCurve::P_384, EcCurve::P_521, EcCurve::CURVE_25519};
David Drysdaledf09e542021-06-08 15:46:11 +01001423 } else {
David Drysdale42fe1892021-10-14 14:43:46 +01001424 if (Curve25519Supported()) {
1425 return {};
1426 } else {
1427 return {EcCurve::CURVE_25519};
1428 }
David Drysdaledf09e542021-06-08 15:46:11 +01001429 }
Selene Huang31ab4042020-04-29 04:22:39 -07001430}
1431
subrahmanyaman05642492022-02-05 07:10:56 +00001432vector<uint64_t> KeyMintAidlTestBase::ValidExponents() {
1433 if (SecLevel() == SecurityLevel::STRONGBOX) {
1434 return {65537};
1435 } else {
1436 return {3, 65537};
1437 }
1438}
1439
Selene Huang31ab4042020-04-29 04:22:39 -07001440vector<Digest> KeyMintAidlTestBase::ValidDigests(bool withNone, bool withMD5) {
1441 switch (SecLevel()) {
1442 case SecurityLevel::SOFTWARE:
1443 case SecurityLevel::TRUSTED_ENVIRONMENT:
1444 if (withNone) {
1445 if (withMD5)
1446 return {Digest::NONE, Digest::MD5, Digest::SHA1,
1447 Digest::SHA_2_224, Digest::SHA_2_256, Digest::SHA_2_384,
1448 Digest::SHA_2_512};
1449 else
1450 return {Digest::NONE, Digest::SHA1, Digest::SHA_2_224,
1451 Digest::SHA_2_256, Digest::SHA_2_384, Digest::SHA_2_512};
1452 } else {
1453 if (withMD5)
1454 return {Digest::MD5, Digest::SHA1, Digest::SHA_2_224,
1455 Digest::SHA_2_256, Digest::SHA_2_384, Digest::SHA_2_512};
1456 else
1457 return {Digest::SHA1, Digest::SHA_2_224, Digest::SHA_2_256, Digest::SHA_2_384,
1458 Digest::SHA_2_512};
1459 }
1460 break;
1461 case SecurityLevel::STRONGBOX:
1462 if (withNone)
1463 return {Digest::NONE, Digest::SHA_2_256};
1464 else
1465 return {Digest::SHA_2_256};
1466 break;
1467 default:
1468 ADD_FAILURE() << "Invalid security level " << uint32_t(SecLevel());
1469 break;
1470 }
1471 ADD_FAILURE() << "Should be impossible to get here";
1472 return {};
1473}
1474
Shawn Willden7f424372021-01-10 18:06:50 -07001475static const vector<KeyParameter> kEmptyAuthList{};
1476
1477const vector<KeyParameter>& KeyMintAidlTestBase::SecLevelAuthorizations(
1478 const vector<KeyCharacteristics>& key_characteristics) {
1479 auto found = std::find_if(key_characteristics.begin(), key_characteristics.end(),
1480 [this](auto& entry) { return entry.securityLevel == SecLevel(); });
1481 return (found == key_characteristics.end()) ? kEmptyAuthList : found->authorizations;
1482}
1483
Qi Wubeefae42021-01-28 23:16:37 +08001484const vector<KeyParameter>& KeyMintAidlTestBase::SecLevelAuthorizations(
1485 const vector<KeyCharacteristics>& key_characteristics, SecurityLevel securityLevel) {
1486 auto found = std::find_if(
1487 key_characteristics.begin(), key_characteristics.end(),
1488 [securityLevel](auto& entry) { return entry.securityLevel == securityLevel; });
Shawn Willden0e80b5d2020-12-17 09:07:27 -07001489 return (found == key_characteristics.end()) ? kEmptyAuthList : found->authorizations;
1490}
1491
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001492ErrorCode KeyMintAidlTestBase::UseAesKey(const vector<uint8_t>& aesKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001493 auto [result, ciphertext] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001494 aesKeyBlob, KeyPurpose::ENCRYPT, "1234567890123456",
1495 AuthorizationSetBuilder().BlockMode(BlockMode::ECB).Padding(PaddingMode::NONE));
1496 return result;
1497}
1498
1499ErrorCode KeyMintAidlTestBase::UseHmacKey(const vector<uint8_t>& hmacKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001500 auto [result, mac] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001501 hmacKeyBlob, KeyPurpose::SIGN, "1234567890123456",
1502 AuthorizationSetBuilder().Authorization(TAG_MAC_LENGTH, 128).Digest(Digest::SHA_2_256));
1503 return result;
1504}
1505
1506ErrorCode KeyMintAidlTestBase::UseRsaKey(const vector<uint8_t>& rsaKeyBlob) {
1507 std::string message(2048 / 8, 'a');
Shawn Willden92d79c02021-02-19 07:31:55 -07001508 auto [result, signature] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001509 rsaKeyBlob, KeyPurpose::SIGN, message,
1510 AuthorizationSetBuilder().Digest(Digest::NONE).Padding(PaddingMode::NONE));
1511 return result;
1512}
1513
1514ErrorCode KeyMintAidlTestBase::UseEcdsaKey(const vector<uint8_t>& ecdsaKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001515 auto [result, signature] = ProcessMessage(ecdsaKeyBlob, KeyPurpose::SIGN, "a",
1516 AuthorizationSetBuilder().Digest(Digest::SHA_2_256));
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001517 return result;
1518}
1519
Selene Huang6e46f142021-04-20 19:20:11 -07001520void verify_serial(X509* cert, const uint64_t expected_serial) {
1521 BIGNUM_Ptr ser(BN_new());
1522 EXPECT_TRUE(ASN1_INTEGER_to_BN(X509_get_serialNumber(cert), ser.get()));
1523
1524 uint64_t serial;
1525 EXPECT_TRUE(BN_get_u64(ser.get(), &serial));
1526 EXPECT_EQ(serial, expected_serial);
1527}
1528
1529// Please set self_signed to true for fake certificates or self signed
1530// certificates
1531void verify_subject(const X509* cert, //
1532 const string& subject, //
1533 bool self_signed) {
1534 char* cert_issuer = //
1535 X509_NAME_oneline(X509_get_issuer_name(cert), nullptr, 0);
1536
1537 char* cert_subj = X509_NAME_oneline(X509_get_subject_name(cert), nullptr, 0);
1538
1539 string expected_subject("/CN=");
1540 if (subject.empty()) {
1541 expected_subject.append("Android Keystore Key");
1542 } else {
1543 expected_subject.append(subject);
1544 }
1545
1546 EXPECT_STREQ(expected_subject.c_str(), cert_subj) << "Cert has wrong subject." << cert_subj;
1547
1548 if (self_signed) {
1549 EXPECT_STREQ(cert_issuer, cert_subj)
1550 << "Cert issuer and subject mismatch for self signed certificate.";
1551 }
1552
1553 OPENSSL_free(cert_subj);
1554 OPENSSL_free(cert_issuer);
1555}
1556
Shawn Willden22fb9c12022-06-02 14:04:33 -06001557int get_vsr_api_level() {
Shawn Willden35db3492022-06-16 12:50:40 -06001558 int vendor_api_level = ::android::base::GetIntProperty("ro.vendor.api_level", -1);
1559 if (vendor_api_level != -1) {
1560 return vendor_api_level;
Shawn Willden22fb9c12022-06-02 14:04:33 -06001561 }
Shawn Willden35db3492022-06-16 12:50:40 -06001562
1563 // Android S and older devices do not define ro.vendor.api_level
1564 vendor_api_level = ::android::base::GetIntProperty("ro.board.api_level", -1);
1565 if (vendor_api_level == -1) {
1566 vendor_api_level = ::android::base::GetIntProperty("ro.board.first_api_level", -1);
Shawn Willden22fb9c12022-06-02 14:04:33 -06001567 }
Shawn Willden35db3492022-06-16 12:50:40 -06001568
1569 int product_api_level = ::android::base::GetIntProperty("ro.product.first_api_level", -1);
1570 if (product_api_level == -1) {
1571 product_api_level = ::android::base::GetIntProperty("ro.build.version.sdk", -1);
1572 EXPECT_NE(product_api_level, -1) << "Could not find ro.build.version.sdk";
Shawn Willden22fb9c12022-06-02 14:04:33 -06001573 }
Shawn Willden35db3492022-06-16 12:50:40 -06001574
1575 // VSR API level is the minimum of vendor_api_level and product_api_level.
1576 if (vendor_api_level == -1 || vendor_api_level > product_api_level) {
1577 return product_api_level;
Shawn Willden22fb9c12022-06-02 14:04:33 -06001578 }
Shawn Willden35db3492022-06-16 12:50:40 -06001579 return vendor_api_level;
Shawn Willden22fb9c12022-06-02 14:04:33 -06001580}
1581
David Drysdale555ba002022-05-03 18:48:57 +01001582bool is_gsi_image() {
1583 std::ifstream ifs("/system/system_ext/etc/init/init.gsi.rc");
1584 return ifs.good();
1585}
1586
Selene Huang6e46f142021-04-20 19:20:11 -07001587vector<uint8_t> build_serial_blob(const uint64_t serial_int) {
1588 BIGNUM_Ptr serial(BN_new());
1589 EXPECT_TRUE(BN_set_u64(serial.get(), serial_int));
1590
1591 int len = BN_num_bytes(serial.get());
1592 vector<uint8_t> serial_blob(len);
1593 if (BN_bn2bin(serial.get(), serial_blob.data()) != len) {
1594 return {};
1595 }
1596
David Drysdaledb0dcf52021-05-18 11:43:31 +01001597 if (serial_blob.empty() || serial_blob[0] & 0x80) {
1598 // An empty blob is OpenSSL's encoding of the zero value; we need single zero byte.
1599 // Top bit being set indicates a negative number in two's complement, but our input
1600 // was positive.
1601 // In either case, prepend a zero byte.
1602 serial_blob.insert(serial_blob.begin(), 0x00);
1603 }
1604
Selene Huang6e46f142021-04-20 19:20:11 -07001605 return serial_blob;
1606}
1607
1608void verify_subject_and_serial(const Certificate& certificate, //
1609 const uint64_t expected_serial, //
1610 const string& subject, bool self_signed) {
1611 X509_Ptr cert(parse_cert_blob(certificate.encodedCertificate));
1612 ASSERT_TRUE(!!cert.get());
1613
1614 verify_serial(cert.get(), expected_serial);
1615 verify_subject(cert.get(), subject, self_signed);
1616}
1617
Shawn Willden4315e132022-03-20 12:49:46 -06001618void verify_root_of_trust(const vector<uint8_t>& verified_boot_key, bool device_locked,
1619 VerifiedBoot verified_boot_state,
1620 const vector<uint8_t>& verified_boot_hash) {
1621 char property_value[PROPERTY_VALUE_MAX] = {};
1622
1623 if (avb_verification_enabled()) {
1624 EXPECT_NE(property_get("ro.boot.vbmeta.digest", property_value, ""), 0);
1625 string prop_string(property_value);
1626 EXPECT_EQ(prop_string.size(), 64);
1627 EXPECT_EQ(prop_string, bin2hex(verified_boot_hash));
1628
1629 EXPECT_NE(property_get("ro.boot.vbmeta.device_state", property_value, ""), 0);
1630 if (!strcmp(property_value, "unlocked")) {
1631 EXPECT_FALSE(device_locked);
1632 } else {
1633 EXPECT_TRUE(device_locked);
1634 }
1635
1636 // Check that the device is locked if not debuggable, e.g., user build
1637 // images in CTS. For VTS, debuggable images are used to allow adb root
1638 // and the device is unlocked.
1639 if (!property_get_bool("ro.debuggable", false)) {
1640 EXPECT_TRUE(device_locked);
1641 } else {
1642 EXPECT_FALSE(device_locked);
1643 }
1644 }
1645
1646 // Verified boot key should be all 0's if the boot state is not verified or self signed
1647 std::string empty_boot_key(32, '\0');
1648 std::string verified_boot_key_str((const char*)verified_boot_key.data(),
1649 verified_boot_key.size());
1650 EXPECT_NE(property_get("ro.boot.verifiedbootstate", property_value, ""), 0);
1651 if (!strcmp(property_value, "green")) {
1652 EXPECT_EQ(verified_boot_state, VerifiedBoot::VERIFIED);
1653 EXPECT_NE(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1654 verified_boot_key.size()));
1655 } else if (!strcmp(property_value, "yellow")) {
1656 EXPECT_EQ(verified_boot_state, VerifiedBoot::SELF_SIGNED);
1657 EXPECT_NE(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1658 verified_boot_key.size()));
1659 } else if (!strcmp(property_value, "orange")) {
1660 EXPECT_EQ(verified_boot_state, VerifiedBoot::UNVERIFIED);
1661 EXPECT_EQ(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1662 verified_boot_key.size()));
1663 } else if (!strcmp(property_value, "red")) {
1664 EXPECT_EQ(verified_boot_state, VerifiedBoot::FAILED);
1665 } else {
1666 EXPECT_EQ(verified_boot_state, VerifiedBoot::UNVERIFIED);
1667 EXPECT_EQ(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1668 verified_boot_key.size()));
1669 }
1670}
1671
David Drysdale7dff4fc2021-12-10 10:10:52 +00001672bool verify_attestation_record(int32_t aidl_version, //
1673 const string& challenge, //
Shawn Willden7c130392020-12-21 09:58:22 -07001674 const string& app_id, //
1675 AuthorizationSet expected_sw_enforced, //
1676 AuthorizationSet expected_hw_enforced, //
1677 SecurityLevel security_level,
David Drysdale565ccc72021-10-11 12:49:50 +01001678 const vector<uint8_t>& attestation_cert,
1679 vector<uint8_t>* unique_id) {
Shawn Willden7c130392020-12-21 09:58:22 -07001680 X509_Ptr cert(parse_cert_blob(attestation_cert));
1681 EXPECT_TRUE(!!cert.get());
1682 if (!cert.get()) return false;
1683
1684 ASN1_OCTET_STRING* attest_rec = get_attestation_record(cert.get());
1685 EXPECT_TRUE(!!attest_rec);
1686 if (!attest_rec) return false;
1687
1688 AuthorizationSet att_sw_enforced;
1689 AuthorizationSet att_hw_enforced;
1690 uint32_t att_attestation_version;
David Drysdale37af4b32021-05-14 16:46:59 +01001691 uint32_t att_keymint_version;
Shawn Willden7c130392020-12-21 09:58:22 -07001692 SecurityLevel att_attestation_security_level;
David Drysdale37af4b32021-05-14 16:46:59 +01001693 SecurityLevel att_keymint_security_level;
Shawn Willden7c130392020-12-21 09:58:22 -07001694 vector<uint8_t> att_challenge;
1695 vector<uint8_t> att_unique_id;
1696 vector<uint8_t> att_app_id;
1697
1698 auto error = parse_attestation_record(attest_rec->data, //
1699 attest_rec->length, //
1700 &att_attestation_version, //
1701 &att_attestation_security_level, //
David Drysdale37af4b32021-05-14 16:46:59 +01001702 &att_keymint_version, //
1703 &att_keymint_security_level, //
Shawn Willden7c130392020-12-21 09:58:22 -07001704 &att_challenge, //
1705 &att_sw_enforced, //
1706 &att_hw_enforced, //
1707 &att_unique_id);
1708 EXPECT_EQ(ErrorCode::OK, error);
1709 if (error != ErrorCode::OK) return false;
1710
David Drysdale7dff4fc2021-12-10 10:10:52 +00001711 check_attestation_version(att_attestation_version, aidl_version);
Selene Huang4f64c222021-04-13 19:54:36 -07001712 vector<uint8_t> appId(app_id.begin(), app_id.end());
Shawn Willden7c130392020-12-21 09:58:22 -07001713
Selene Huang4f64c222021-04-13 19:54:36 -07001714 // check challenge and app id only if we expects a non-fake certificate
1715 if (challenge.length() > 0) {
1716 EXPECT_EQ(challenge.length(), att_challenge.size());
1717 EXPECT_EQ(0, memcmp(challenge.data(), att_challenge.data(), challenge.length()));
1718
1719 expected_sw_enforced.push_back(TAG_ATTESTATION_APPLICATION_ID, appId);
1720 }
Shawn Willden7c130392020-12-21 09:58:22 -07001721
David Drysdale7dff4fc2021-12-10 10:10:52 +00001722 check_attestation_version(att_keymint_version, aidl_version);
David Drysdale37af4b32021-05-14 16:46:59 +01001723 EXPECT_EQ(security_level, att_keymint_security_level);
Shawn Willden7c130392020-12-21 09:58:22 -07001724 EXPECT_EQ(security_level, att_attestation_security_level);
1725
Shawn Willden7c130392020-12-21 09:58:22 -07001726 // TODO(b/136282179): When running under VTS-on-GSI the TEE-backed
David Drysdale37af4b32021-05-14 16:46:59 +01001727 // keymint implementation will report YYYYMM dates instead of YYYYMMDD
Shawn Willden7c130392020-12-21 09:58:22 -07001728 // for the BOOT_PATCH_LEVEL.
1729 if (avb_verification_enabled()) {
1730 for (int i = 0; i < att_hw_enforced.size(); i++) {
1731 if (att_hw_enforced[i].tag == TAG_BOOT_PATCHLEVEL ||
1732 att_hw_enforced[i].tag == TAG_VENDOR_PATCHLEVEL) {
1733 std::string date =
Tommy Chiuf00d8f12021-04-08 11:07:48 +08001734 std::to_string(att_hw_enforced[i].value.get<KeyParameterValue::integer>());
David Drysdale168228a2021-10-05 08:43:52 +01001735
Shawn Willden7c130392020-12-21 09:58:22 -07001736 // strptime seems to require delimiters, but the tag value will
1737 // be YYYYMMDD
David Drysdale168228a2021-10-05 08:43:52 +01001738 if (date.size() != 8) {
1739 ADD_FAILURE() << "Tag " << att_hw_enforced[i].tag
1740 << " with invalid format (not YYYYMMDD): " << date;
1741 return false;
1742 }
Shawn Willden7c130392020-12-21 09:58:22 -07001743 date.insert(6, "-");
1744 date.insert(4, "-");
Shawn Willden7c130392020-12-21 09:58:22 -07001745 struct tm time;
1746 strptime(date.c_str(), "%Y-%m-%d", &time);
1747
1748 // Day of the month (0-31)
1749 EXPECT_GE(time.tm_mday, 0);
1750 EXPECT_LT(time.tm_mday, 32);
1751 // Months since Jan (0-11)
1752 EXPECT_GE(time.tm_mon, 0);
1753 EXPECT_LT(time.tm_mon, 12);
1754 // Years since 1900
1755 EXPECT_GT(time.tm_year, 110);
1756 EXPECT_LT(time.tm_year, 200);
1757 }
1758 }
1759 }
1760
1761 // Check to make sure boolean values are properly encoded. Presence of a boolean tag
1762 // indicates true. A provided boolean tag that can be pulled back out of the certificate
1763 // indicates correct encoding. No need to check if it's in both lists, since the
1764 // AuthorizationSet compare below will handle mismatches of tags.
1765 if (security_level == SecurityLevel::SOFTWARE) {
1766 EXPECT_TRUE(expected_sw_enforced.Contains(TAG_NO_AUTH_REQUIRED));
1767 } else {
1768 EXPECT_TRUE(expected_hw_enforced.Contains(TAG_NO_AUTH_REQUIRED));
1769 }
1770
Shawn Willden7c130392020-12-21 09:58:22 -07001771 if (att_hw_enforced.Contains(TAG_ALGORITHM, Algorithm::EC)) {
1772 // For ECDSA keys, either an EC_CURVE or a KEY_SIZE can be specified, but one must be.
1773 EXPECT_TRUE(att_hw_enforced.Contains(TAG_EC_CURVE) ||
1774 att_hw_enforced.Contains(TAG_KEY_SIZE));
1775 }
1776
1777 // Test root of trust elements
1778 vector<uint8_t> verified_boot_key;
1779 VerifiedBoot verified_boot_state;
1780 bool device_locked;
1781 vector<uint8_t> verified_boot_hash;
1782 error = parse_root_of_trust(attest_rec->data, attest_rec->length, &verified_boot_key,
1783 &verified_boot_state, &device_locked, &verified_boot_hash);
1784 EXPECT_EQ(ErrorCode::OK, error);
Shawn Willden4315e132022-03-20 12:49:46 -06001785 verify_root_of_trust(verified_boot_key, device_locked, verified_boot_state, verified_boot_hash);
Shawn Willden7c130392020-12-21 09:58:22 -07001786
1787 att_sw_enforced.Sort();
1788 expected_sw_enforced.Sort();
David Drysdale37af4b32021-05-14 16:46:59 +01001789 EXPECT_EQ(filtered_tags(expected_sw_enforced), filtered_tags(att_sw_enforced));
Shawn Willden7c130392020-12-21 09:58:22 -07001790
1791 att_hw_enforced.Sort();
1792 expected_hw_enforced.Sort();
1793 EXPECT_EQ(filtered_tags(expected_hw_enforced), filtered_tags(att_hw_enforced));
1794
David Drysdale565ccc72021-10-11 12:49:50 +01001795 if (unique_id != nullptr) {
1796 *unique_id = att_unique_id;
1797 }
1798
Shawn Willden7c130392020-12-21 09:58:22 -07001799 return true;
1800}
1801
1802string bin2hex(const vector<uint8_t>& data) {
1803 string retval;
1804 retval.reserve(data.size() * 2 + 1);
1805 for (uint8_t byte : data) {
1806 retval.push_back(nibble2hex[0x0F & (byte >> 4)]);
1807 retval.push_back(nibble2hex[0x0F & byte]);
1808 }
1809 return retval;
1810}
1811
David Drysdalef0d516d2021-03-22 07:51:43 +00001812AuthorizationSet HwEnforcedAuthorizations(const vector<KeyCharacteristics>& key_characteristics) {
1813 AuthorizationSet authList;
1814 for (auto& entry : key_characteristics) {
1815 if (entry.securityLevel == SecurityLevel::STRONGBOX ||
1816 entry.securityLevel == SecurityLevel::TRUSTED_ENVIRONMENT) {
1817 authList.push_back(AuthorizationSet(entry.authorizations));
1818 }
1819 }
1820 return authList;
1821}
1822
1823AuthorizationSet SwEnforcedAuthorizations(const vector<KeyCharacteristics>& key_characteristics) {
1824 AuthorizationSet authList;
1825 for (auto& entry : key_characteristics) {
1826 if (entry.securityLevel == SecurityLevel::SOFTWARE ||
1827 entry.securityLevel == SecurityLevel::KEYSTORE) {
1828 authList.push_back(AuthorizationSet(entry.authorizations));
1829 }
1830 }
1831 return authList;
1832}
1833
Eran Messeri03d7a1a2021-07-06 12:07:57 +01001834AssertionResult ChainSignaturesAreValid(const vector<Certificate>& chain,
1835 bool strict_issuer_check) {
Shawn Willden7c130392020-12-21 09:58:22 -07001836 std::stringstream cert_data;
1837
1838 for (size_t i = 0; i < chain.size(); ++i) {
1839 cert_data << bin2hex(chain[i].encodedCertificate) << std::endl;
1840
1841 X509_Ptr key_cert(parse_cert_blob(chain[i].encodedCertificate));
1842 X509_Ptr signing_cert;
1843 if (i < chain.size() - 1) {
1844 signing_cert = parse_cert_blob(chain[i + 1].encodedCertificate);
1845 } else {
1846 signing_cert = parse_cert_blob(chain[i].encodedCertificate);
1847 }
1848 if (!key_cert.get() || !signing_cert.get()) return AssertionFailure() << cert_data.str();
1849
1850 EVP_PKEY_Ptr signing_pubkey(X509_get_pubkey(signing_cert.get()));
1851 if (!signing_pubkey.get()) return AssertionFailure() << cert_data.str();
1852
1853 if (!X509_verify(key_cert.get(), signing_pubkey.get())) {
1854 return AssertionFailure()
1855 << "Verification of certificate " << i << " failed "
1856 << "OpenSSL error string: " << ERR_error_string(ERR_get_error(), NULL) << '\n'
1857 << cert_data.str();
1858 }
1859
1860 string cert_issuer = x509NameToStr(X509_get_issuer_name(key_cert.get()));
1861 string signer_subj = x509NameToStr(X509_get_subject_name(signing_cert.get()));
Eran Messeri03d7a1a2021-07-06 12:07:57 +01001862 if (cert_issuer != signer_subj && strict_issuer_check) {
Selene Huang8f9494c2021-04-21 15:10:36 -07001863 return AssertionFailure() << "Cert " << i << " has wrong issuer.\n"
1864 << " Signer subject is " << signer_subj
1865 << " Issuer subject is " << cert_issuer << endl
1866 << cert_data.str();
Shawn Willden7c130392020-12-21 09:58:22 -07001867 }
Shawn Willden7c130392020-12-21 09:58:22 -07001868 }
1869
1870 if (KeyMintAidlTestBase::dump_Attestations) std::cout << cert_data.str();
1871 return AssertionSuccess();
1872}
1873
1874X509_Ptr parse_cert_blob(const vector<uint8_t>& blob) {
1875 const uint8_t* p = blob.data();
1876 return X509_Ptr(d2i_X509(nullptr /* allocate new */, &p, blob.size()));
1877}
1878
David Drysdalef0d516d2021-03-22 07:51:43 +00001879vector<uint8_t> make_name_from_str(const string& name) {
1880 X509_NAME_Ptr x509_name(X509_NAME_new());
1881 EXPECT_TRUE(x509_name.get() != nullptr);
1882 if (!x509_name) return {};
1883
1884 EXPECT_EQ(1, X509_NAME_add_entry_by_txt(x509_name.get(), //
1885 "CN", //
1886 MBSTRING_ASC,
1887 reinterpret_cast<const uint8_t*>(name.c_str()),
1888 -1, // len
1889 -1, // loc
1890 0 /* set */));
1891
1892 int len = i2d_X509_NAME(x509_name.get(), nullptr /* only return length */);
1893 EXPECT_GT(len, 0);
1894
1895 vector<uint8_t> retval(len);
1896 uint8_t* p = retval.data();
1897 i2d_X509_NAME(x509_name.get(), &p);
1898
1899 return retval;
1900}
1901
David Drysdale4dc01072021-04-01 12:17:35 +01001902namespace {
1903
1904void check_cose_key(const vector<uint8_t>& data, bool testMode) {
1905 auto [parsedPayload, __, payloadParseErr] = cppbor::parse(data);
1906 ASSERT_TRUE(parsedPayload) << "Key parse failed: " << payloadParseErr;
1907
1908 // The following check assumes that canonical CBOR encoding is used for the COSE_Key.
1909 if (testMode) {
1910 EXPECT_THAT(cppbor::prettyPrint(parsedPayload.get()),
1911 MatchesRegex("{\n"
1912 " 1 : 2,\n" // kty: EC2
1913 " 3 : -7,\n" // alg: ES256
1914 " -1 : 1,\n" // EC id: P256
1915 // The regex {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}} matches a
1916 // sequence of 32 hexadecimal bytes, enclosed in braces and
1917 // separated by commas. In this case, some Ed25519 public key.
1918 " -2 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_x: data
1919 " -3 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_y: data
1920 " -70000 : null,\n" // test marker
1921 "}"));
1922 } else {
1923 EXPECT_THAT(cppbor::prettyPrint(parsedPayload.get()),
1924 MatchesRegex("{\n"
1925 " 1 : 2,\n" // kty: EC2
1926 " 3 : -7,\n" // alg: ES256
1927 " -1 : 1,\n" // EC id: P256
1928 // The regex {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}} matches a
1929 // sequence of 32 hexadecimal bytes, enclosed in braces and
1930 // separated by commas. In this case, some Ed25519 public key.
1931 " -2 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_x: data
1932 " -3 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_y: data
1933 "}"));
1934 }
1935}
1936
1937} // namespace
1938
1939void check_maced_pubkey(const MacedPublicKey& macedPubKey, bool testMode,
1940 vector<uint8_t>* payload_value) {
1941 auto [coseMac0, _, mac0ParseErr] = cppbor::parse(macedPubKey.macedKey);
1942 ASSERT_TRUE(coseMac0) << "COSE Mac0 parse failed " << mac0ParseErr;
1943
1944 ASSERT_NE(coseMac0->asArray(), nullptr);
1945 ASSERT_EQ(coseMac0->asArray()->size(), kCoseMac0EntryCount);
1946
1947 auto protParms = coseMac0->asArray()->get(kCoseMac0ProtectedParams)->asBstr();
1948 ASSERT_NE(protParms, nullptr);
1949
1950 // Header label:value of 'alg': HMAC-256
1951 ASSERT_EQ(cppbor::prettyPrint(protParms->value()), "{\n 1 : 5,\n}");
1952
1953 auto unprotParms = coseMac0->asArray()->get(kCoseMac0UnprotectedParams)->asMap();
1954 ASSERT_NE(unprotParms, nullptr);
1955 ASSERT_EQ(unprotParms->size(), 0);
1956
1957 // The payload is a bstr holding an encoded COSE_Key
1958 auto payload = coseMac0->asArray()->get(kCoseMac0Payload)->asBstr();
1959 ASSERT_NE(payload, nullptr);
1960 check_cose_key(payload->value(), testMode);
1961
1962 auto coseMac0Tag = coseMac0->asArray()->get(kCoseMac0Tag)->asBstr();
1963 ASSERT_TRUE(coseMac0Tag);
1964 auto extractedTag = coseMac0Tag->value();
1965 EXPECT_EQ(extractedTag.size(), 32U);
1966
1967 // Compare with tag generated with kTestMacKey. Should only match in test mode
Seth Moore026bb742021-04-30 11:41:18 -07001968 auto macFunction = [](const cppcose::bytevec& input) {
1969 return cppcose::generateHmacSha256(remote_prov::kTestMacKey, input);
1970 };
1971 auto testTag =
1972 cppcose::generateCoseMac0Mac(macFunction, {} /* external_aad */, payload->value());
David Drysdale4dc01072021-04-01 12:17:35 +01001973 ASSERT_TRUE(testTag) << "Tag calculation failed: " << testTag.message();
1974
1975 if (testMode) {
Seth Moore026bb742021-04-30 11:41:18 -07001976 EXPECT_THAT(*testTag, ElementsAreArray(extractedTag));
David Drysdale4dc01072021-04-01 12:17:35 +01001977 } else {
Seth Moore026bb742021-04-30 11:41:18 -07001978 EXPECT_THAT(*testTag, Not(ElementsAreArray(extractedTag)));
David Drysdale4dc01072021-04-01 12:17:35 +01001979 }
1980 if (payload_value != nullptr) {
1981 *payload_value = payload->value();
1982 }
1983}
1984
1985void p256_pub_key(const vector<uint8_t>& coseKeyData, EVP_PKEY_Ptr* signingKey) {
1986 // Extract x and y affine coordinates from the encoded Cose_Key.
1987 auto [parsedPayload, __, payloadParseErr] = cppbor::parse(coseKeyData);
1988 ASSERT_TRUE(parsedPayload) << "Key parse failed: " << payloadParseErr;
1989 auto coseKey = parsedPayload->asMap();
1990 const std::unique_ptr<cppbor::Item>& xItem = coseKey->get(cppcose::CoseKey::PUBKEY_X);
1991 ASSERT_NE(xItem->asBstr(), nullptr);
1992 vector<uint8_t> x = xItem->asBstr()->value();
1993 const std::unique_ptr<cppbor::Item>& yItem = coseKey->get(cppcose::CoseKey::PUBKEY_Y);
1994 ASSERT_NE(yItem->asBstr(), nullptr);
1995 vector<uint8_t> y = yItem->asBstr()->value();
1996
1997 // Concatenate: 0x04 (uncompressed form marker) | x | y
1998 vector<uint8_t> pubKeyData{0x04};
1999 pubKeyData.insert(pubKeyData.end(), x.begin(), x.end());
2000 pubKeyData.insert(pubKeyData.end(), y.begin(), y.end());
2001
2002 EC_KEY_Ptr ecKey = EC_KEY_Ptr(EC_KEY_new());
2003 ASSERT_NE(ecKey, nullptr);
2004 EC_GROUP_Ptr group = EC_GROUP_Ptr(EC_GROUP_new_by_curve_name(NID_X9_62_prime256v1));
2005 ASSERT_NE(group, nullptr);
2006 ASSERT_EQ(EC_KEY_set_group(ecKey.get(), group.get()), 1);
2007 EC_POINT_Ptr point = EC_POINT_Ptr(EC_POINT_new(group.get()));
2008 ASSERT_NE(point, nullptr);
2009 ASSERT_EQ(EC_POINT_oct2point(group.get(), point.get(), pubKeyData.data(), pubKeyData.size(),
2010 nullptr),
2011 1);
2012 ASSERT_EQ(EC_KEY_set_public_key(ecKey.get(), point.get()), 1);
2013
2014 EVP_PKEY_Ptr pubKey = EVP_PKEY_Ptr(EVP_PKEY_new());
2015 ASSERT_NE(pubKey, nullptr);
2016 EVP_PKEY_assign_EC_KEY(pubKey.get(), ecKey.release());
2017 *signingKey = std::move(pubKey);
2018}
2019
Selene Huang31ab4042020-04-29 04:22:39 -07002020} // namespace test
Shawn Willden08a7e432020-12-11 13:05:27 +00002021
Janis Danisevskis24c04702020-12-16 18:28:39 -08002022} // namespace aidl::android::hardware::security::keymint