blob: 146a5275613a0dbb4451c1020379aa443695cec5 [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>
Shawn Willden7f424372021-01-10 18:06:50 -070020#include <unordered_set>
Selene Huang31ab4042020-04-29 04:22:39 -070021#include <vector>
22
23#include <android-base/logging.h>
Janis Danisevskis24c04702020-12-16 18:28:39 -080024#include <android/binder_manager.h>
David Drysdale4dc01072021-04-01 12:17:35 +010025#include <cppbor_parse.h>
Shawn Willden7c130392020-12-21 09:58:22 -070026#include <cutils/properties.h>
David Drysdale4dc01072021-04-01 12:17:35 +010027#include <gmock/gmock.h>
David Drysdale42fe1892021-10-14 14:43:46 +010028#include <openssl/evp.h>
Shawn Willden7c130392020-12-21 09:58:22 -070029#include <openssl/mem.h>
David Drysdale4dc01072021-04-01 12:17:35 +010030#include <remote_prov/remote_prov_utils.h>
Selene Huang31ab4042020-04-29 04:22:39 -070031
Max Bires9704ff62021-04-07 11:12:01 -070032#include <keymaster/cppcose/cppcose.h>
Shawn Willden7c130392020-12-21 09:58:22 -070033#include <keymint_support/attestation_record.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
David Drysdale42fe1892021-10-14 14:43:46 +0100210bool KeyMintAidlTestBase::Curve25519Supported() {
211 // Strongbox never supports curve 25519.
212 if (SecLevel() == SecurityLevel::STRONGBOX) {
213 return false;
214 }
215
216 // Curve 25519 was included in version 2 of the KeyMint interface.
217 int32_t version = 0;
218 auto status = keymint_->getInterfaceVersion(&version);
219 if (!status.isOk()) {
220 ADD_FAILURE() << "Failed to determine interface version";
221 }
222 return version >= 2;
223}
224
Janis Danisevskis24c04702020-12-16 18:28:39 -0800225ErrorCode KeyMintAidlTestBase::GetReturnErrorCode(const Status& result) {
Selene Huang31ab4042020-04-29 04:22:39 -0700226 if (result.isOk()) return ErrorCode::OK;
227
Janis Danisevskis24c04702020-12-16 18:28:39 -0800228 if (result.getExceptionCode() == EX_SERVICE_SPECIFIC) {
229 return static_cast<ErrorCode>(result.getServiceSpecificError());
Selene Huang31ab4042020-04-29 04:22:39 -0700230 }
231
232 return ErrorCode::UNKNOWN_ERROR;
233}
234
Janis Danisevskis24c04702020-12-16 18:28:39 -0800235void KeyMintAidlTestBase::InitializeKeyMint(std::shared_ptr<IKeyMintDevice> keyMint) {
Selene Huang31ab4042020-04-29 04:22:39 -0700236 ASSERT_NE(keyMint, nullptr);
Janis Danisevskis24c04702020-12-16 18:28:39 -0800237 keymint_ = std::move(keyMint);
Selene Huang31ab4042020-04-29 04:22:39 -0700238
239 KeyMintHardwareInfo info;
240 ASSERT_TRUE(keymint_->getHardwareInfo(&info).isOk());
241
242 securityLevel_ = info.securityLevel;
243 name_.assign(info.keyMintName.begin(), info.keyMintName.end());
244 author_.assign(info.keyMintAuthorName.begin(), info.keyMintAuthorName.end());
David Drysdaled2cc8c22021-04-15 13:29:45 +0100245 timestamp_token_required_ = info.timestampTokenRequired;
Selene Huang31ab4042020-04-29 04:22:39 -0700246
247 os_version_ = getOsVersion();
248 os_patch_level_ = getOsPatchlevel();
David Drysdalebb3d85e2021-04-13 11:15:51 +0100249 vendor_patch_level_ = getVendorPatchlevel();
Selene Huang31ab4042020-04-29 04:22:39 -0700250}
251
David Drysdale7dff4fc2021-12-10 10:10:52 +0000252int32_t KeyMintAidlTestBase::AidlVersion() {
253 int32_t version = 0;
254 auto status = keymint_->getInterfaceVersion(&version);
255 if (!status.isOk()) {
256 ADD_FAILURE() << "Failed to determine interface version";
257 }
258 return version;
259}
260
Selene Huang31ab4042020-04-29 04:22:39 -0700261void KeyMintAidlTestBase::SetUp() {
Janis Danisevskis24c04702020-12-16 18:28:39 -0800262 if (AServiceManager_isDeclared(GetParam().c_str())) {
263 ::ndk::SpAIBinder binder(AServiceManager_waitForService(GetParam().c_str()));
264 InitializeKeyMint(IKeyMintDevice::fromBinder(binder));
265 } else {
266 InitializeKeyMint(nullptr);
267 }
Selene Huang31ab4042020-04-29 04:22:39 -0700268}
269
270ErrorCode KeyMintAidlTestBase::GenerateKey(const AuthorizationSet& key_desc,
Shawn Willden7c130392020-12-21 09:58:22 -0700271 const optional<AttestationKey>& attest_key,
Shawn Willden7f424372021-01-10 18:06:50 -0700272 vector<uint8_t>* key_blob,
Shawn Willden7c130392020-12-21 09:58:22 -0700273 vector<KeyCharacteristics>* key_characteristics,
274 vector<Certificate>* cert_chain) {
Shawn Willden7f424372021-01-10 18:06:50 -0700275 EXPECT_NE(key_blob, nullptr) << "Key blob pointer must not be null. Test bug";
276 EXPECT_NE(key_characteristics, nullptr)
Selene Huang31ab4042020-04-29 04:22:39 -0700277 << "Previous characteristics not deleted before generating key. Test bug.";
278
Shawn Willden7f424372021-01-10 18:06:50 -0700279 KeyCreationResult creationResult;
Shawn Willden7c130392020-12-21 09:58:22 -0700280 Status result = keymint_->generateKey(key_desc.vector_data(), attest_key, &creationResult);
Selene Huang31ab4042020-04-29 04:22:39 -0700281 if (result.isOk()) {
Shawn Willden7f424372021-01-10 18:06:50 -0700282 EXPECT_PRED2(KeyCharacteristicsBasicallyValid, SecLevel(),
283 creationResult.keyCharacteristics);
284 EXPECT_GT(creationResult.keyBlob.size(), 0);
285 *key_blob = std::move(creationResult.keyBlob);
286 *key_characteristics = std::move(creationResult.keyCharacteristics);
Shawn Willden7c130392020-12-21 09:58:22 -0700287 *cert_chain = std::move(creationResult.certificateChain);
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700288
289 auto algorithm = key_desc.GetTagValue(TAG_ALGORITHM);
290 EXPECT_TRUE(algorithm);
291 if (algorithm &&
292 (algorithm.value() == Algorithm::RSA || algorithm.value() == Algorithm::EC)) {
Shawn Willden7c130392020-12-21 09:58:22 -0700293 EXPECT_GE(cert_chain->size(), 1);
294 if (key_desc.Contains(TAG_ATTESTATION_CHALLENGE)) {
295 if (attest_key) {
296 EXPECT_EQ(cert_chain->size(), 1);
297 } else {
298 EXPECT_GT(cert_chain->size(), 1);
299 }
300 }
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700301 } else {
302 // For symmetric keys there should be no certificates.
Shawn Willden7c130392020-12-21 09:58:22 -0700303 EXPECT_EQ(cert_chain->size(), 0);
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700304 }
Selene Huang31ab4042020-04-29 04:22:39 -0700305 }
306
307 return GetReturnErrorCode(result);
308}
309
Shawn Willden7c130392020-12-21 09:58:22 -0700310ErrorCode KeyMintAidlTestBase::GenerateKey(const AuthorizationSet& key_desc,
311 const optional<AttestationKey>& attest_key) {
312 return GenerateKey(key_desc, attest_key, &key_blob_, &key_characteristics_, &cert_chain_);
Selene Huang31ab4042020-04-29 04:22:39 -0700313}
314
315ErrorCode KeyMintAidlTestBase::ImportKey(const AuthorizationSet& key_desc, KeyFormat format,
316 const string& key_material, vector<uint8_t>* key_blob,
Shawn Willden7f424372021-01-10 18:06:50 -0700317 vector<KeyCharacteristics>* key_characteristics) {
Selene Huang31ab4042020-04-29 04:22:39 -0700318 Status result;
319
Shawn Willden7f424372021-01-10 18:06:50 -0700320 cert_chain_.clear();
321 key_characteristics->clear();
Selene Huang31ab4042020-04-29 04:22:39 -0700322 key_blob->clear();
323
Shawn Willden7f424372021-01-10 18:06:50 -0700324 KeyCreationResult creationResult;
Selene Huang31ab4042020-04-29 04:22:39 -0700325 result = keymint_->importKey(key_desc.vector_data(), format,
Shawn Willden7f424372021-01-10 18:06:50 -0700326 vector<uint8_t>(key_material.begin(), key_material.end()),
Shawn Willden7c130392020-12-21 09:58:22 -0700327 {} /* attestationSigningKeyBlob */, &creationResult);
Selene Huang31ab4042020-04-29 04:22:39 -0700328
329 if (result.isOk()) {
Shawn Willden7f424372021-01-10 18:06:50 -0700330 EXPECT_PRED2(KeyCharacteristicsBasicallyValid, SecLevel(),
331 creationResult.keyCharacteristics);
332 EXPECT_GT(creationResult.keyBlob.size(), 0);
333
334 *key_blob = std::move(creationResult.keyBlob);
335 *key_characteristics = std::move(creationResult.keyCharacteristics);
336 cert_chain_ = std::move(creationResult.certificateChain);
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700337
338 auto algorithm = key_desc.GetTagValue(TAG_ALGORITHM);
339 EXPECT_TRUE(algorithm);
340 if (algorithm &&
341 (algorithm.value() == Algorithm::RSA || algorithm.value() == Algorithm::EC)) {
342 EXPECT_GE(cert_chain_.size(), 1);
343 if (key_desc.Contains(TAG_ATTESTATION_CHALLENGE)) EXPECT_GT(cert_chain_.size(), 1);
344 } else {
345 // For symmetric keys there should be no certificates.
346 EXPECT_EQ(cert_chain_.size(), 0);
347 }
Selene Huang31ab4042020-04-29 04:22:39 -0700348 }
349
350 return GetReturnErrorCode(result);
351}
352
353ErrorCode KeyMintAidlTestBase::ImportKey(const AuthorizationSet& key_desc, KeyFormat format,
354 const string& key_material) {
355 return ImportKey(key_desc, format, key_material, &key_blob_, &key_characteristics_);
356}
357
358ErrorCode KeyMintAidlTestBase::ImportWrappedKey(string wrapped_key, string wrapping_key,
359 const AuthorizationSet& wrapping_key_desc,
360 string masking_key,
David Drysdaled2cc8c22021-04-15 13:29:45 +0100361 const AuthorizationSet& unwrapping_params,
362 int64_t password_sid, int64_t biometric_sid) {
Selene Huang31ab4042020-04-29 04:22:39 -0700363 EXPECT_EQ(ErrorCode::OK, ImportKey(wrapping_key_desc, KeyFormat::PKCS8, wrapping_key));
364
Shawn Willden7f424372021-01-10 18:06:50 -0700365 key_characteristics_.clear();
Selene Huang31ab4042020-04-29 04:22:39 -0700366
Shawn Willden7f424372021-01-10 18:06:50 -0700367 KeyCreationResult creationResult;
368 Status result = keymint_->importWrappedKey(
369 vector<uint8_t>(wrapped_key.begin(), wrapped_key.end()), key_blob_,
370 vector<uint8_t>(masking_key.begin(), masking_key.end()),
David Drysdaled2cc8c22021-04-15 13:29:45 +0100371 unwrapping_params.vector_data(), password_sid, biometric_sid, &creationResult);
Selene Huang31ab4042020-04-29 04:22:39 -0700372
373 if (result.isOk()) {
Shawn Willden7f424372021-01-10 18:06:50 -0700374 EXPECT_PRED2(KeyCharacteristicsBasicallyValid, SecLevel(),
375 creationResult.keyCharacteristics);
376 EXPECT_GT(creationResult.keyBlob.size(), 0);
377
378 key_blob_ = std::move(creationResult.keyBlob);
379 key_characteristics_ = std::move(creationResult.keyCharacteristics);
380 cert_chain_ = std::move(creationResult.certificateChain);
Shawn Willden0e80b5d2020-12-17 09:07:27 -0700381
382 AuthorizationSet allAuths;
383 for (auto& entry : key_characteristics_) {
384 allAuths.push_back(AuthorizationSet(entry.authorizations));
385 }
386 auto algorithm = allAuths.GetTagValue(TAG_ALGORITHM);
387 EXPECT_TRUE(algorithm);
388 if (algorithm &&
389 (algorithm.value() == Algorithm::RSA || algorithm.value() == Algorithm::EC)) {
390 EXPECT_GE(cert_chain_.size(), 1);
391 } else {
392 // For symmetric keys there should be no certificates.
393 EXPECT_EQ(cert_chain_.size(), 0);
394 }
Selene Huang31ab4042020-04-29 04:22:39 -0700395 }
396
397 return GetReturnErrorCode(result);
398}
399
David Drysdale300b5552021-05-20 12:05:26 +0100400ErrorCode KeyMintAidlTestBase::GetCharacteristics(const vector<uint8_t>& key_blob,
401 const vector<uint8_t>& app_id,
402 const vector<uint8_t>& app_data,
403 vector<KeyCharacteristics>* key_characteristics) {
404 Status result =
405 keymint_->getKeyCharacteristics(key_blob, app_id, app_data, key_characteristics);
406 return GetReturnErrorCode(result);
407}
408
409ErrorCode KeyMintAidlTestBase::GetCharacteristics(const vector<uint8_t>& key_blob,
410 vector<KeyCharacteristics>* key_characteristics) {
411 vector<uint8_t> empty_app_id, empty_app_data;
412 return GetCharacteristics(key_blob, empty_app_id, empty_app_data, key_characteristics);
413}
414
415void KeyMintAidlTestBase::CheckCharacteristics(
416 const vector<uint8_t>& key_blob,
417 const vector<KeyCharacteristics>& generate_characteristics) {
418 // Any key characteristics that were in SecurityLevel::KEYSTORE when returned from
419 // generateKey() should be excluded, as KeyMint will have no record of them.
420 // This applies to CREATION_DATETIME in particular.
421 vector<KeyCharacteristics> expected_characteristics(generate_characteristics);
422 strip_keystore_tags(&expected_characteristics);
423
424 vector<KeyCharacteristics> retrieved;
425 ASSERT_EQ(ErrorCode::OK, GetCharacteristics(key_blob, &retrieved));
426 EXPECT_EQ(expected_characteristics, retrieved);
427}
428
429void KeyMintAidlTestBase::CheckAppIdCharacteristics(
430 const vector<uint8_t>& key_blob, std::string_view app_id_string,
431 std::string_view app_data_string,
432 const vector<KeyCharacteristics>& generate_characteristics) {
433 // Exclude any SecurityLevel::KEYSTORE characteristics for comparisons.
434 vector<KeyCharacteristics> expected_characteristics(generate_characteristics);
435 strip_keystore_tags(&expected_characteristics);
436
437 vector<uint8_t> app_id(app_id_string.begin(), app_id_string.end());
438 vector<uint8_t> app_data(app_data_string.begin(), app_data_string.end());
439 vector<KeyCharacteristics> retrieved;
440 ASSERT_EQ(ErrorCode::OK, GetCharacteristics(key_blob, app_id, app_data, &retrieved));
441 EXPECT_EQ(expected_characteristics, retrieved);
442
443 // Check that key characteristics can't be retrieved if the app ID or app data is missing.
444 vector<uint8_t> empty;
445 vector<KeyCharacteristics> not_retrieved;
446 EXPECT_EQ(ErrorCode::INVALID_KEY_BLOB,
447 GetCharacteristics(key_blob, empty, app_data, &not_retrieved));
448 EXPECT_EQ(not_retrieved.size(), 0);
449
450 EXPECT_EQ(ErrorCode::INVALID_KEY_BLOB,
451 GetCharacteristics(key_blob, app_id, empty, &not_retrieved));
452 EXPECT_EQ(not_retrieved.size(), 0);
453
454 EXPECT_EQ(ErrorCode::INVALID_KEY_BLOB,
455 GetCharacteristics(key_blob, empty, empty, &not_retrieved));
456 EXPECT_EQ(not_retrieved.size(), 0);
457}
458
Selene Huang31ab4042020-04-29 04:22:39 -0700459ErrorCode KeyMintAidlTestBase::DeleteKey(vector<uint8_t>* key_blob, bool keep_key_blob) {
460 Status result = keymint_->deleteKey(*key_blob);
461 if (!keep_key_blob) {
462 *key_blob = vector<uint8_t>();
463 }
464
Janis Danisevskis24c04702020-12-16 18:28:39 -0800465 EXPECT_TRUE(result.isOk()) << result.getServiceSpecificError() << endl;
Selene Huang31ab4042020-04-29 04:22:39 -0700466 return GetReturnErrorCode(result);
467}
468
469ErrorCode KeyMintAidlTestBase::DeleteKey(bool keep_key_blob) {
470 return DeleteKey(&key_blob_, keep_key_blob);
471}
472
473ErrorCode KeyMintAidlTestBase::DeleteAllKeys() {
474 Status result = keymint_->deleteAllKeys();
Janis Danisevskis24c04702020-12-16 18:28:39 -0800475 EXPECT_TRUE(result.isOk()) << result.getServiceSpecificError() << endl;
Selene Huang31ab4042020-04-29 04:22:39 -0700476 return GetReturnErrorCode(result);
477}
478
David Drysdaled2cc8c22021-04-15 13:29:45 +0100479ErrorCode KeyMintAidlTestBase::DestroyAttestationIds() {
480 Status result = keymint_->destroyAttestationIds();
481 return GetReturnErrorCode(result);
482}
483
Selene Huang31ab4042020-04-29 04:22:39 -0700484void KeyMintAidlTestBase::CheckedDeleteKey(vector<uint8_t>* key_blob, bool keep_key_blob) {
485 ErrorCode result = DeleteKey(key_blob, keep_key_blob);
486 EXPECT_TRUE(result == ErrorCode::OK || result == ErrorCode::UNIMPLEMENTED) << result << endl;
487}
488
489void KeyMintAidlTestBase::CheckedDeleteKey() {
490 CheckedDeleteKey(&key_blob_);
491}
492
493ErrorCode KeyMintAidlTestBase::Begin(KeyPurpose purpose, const vector<uint8_t>& key_blob,
494 const AuthorizationSet& in_params,
Janis Danisevskis24c04702020-12-16 18:28:39 -0800495 AuthorizationSet* out_params,
496 std::shared_ptr<IKeyMintOperation>& op) {
Selene Huang31ab4042020-04-29 04:22:39 -0700497 SCOPED_TRACE("Begin");
498 Status result;
499 BeginResult out;
David Drysdale56ba9122021-04-19 19:10:47 +0100500 result = keymint_->begin(purpose, key_blob, in_params.vector_data(), std::nullopt, &out);
Selene Huang31ab4042020-04-29 04:22:39 -0700501
502 if (result.isOk()) {
503 *out_params = out.params;
504 challenge_ = out.challenge;
505 op = out.operation;
506 }
507
508 return GetReturnErrorCode(result);
509}
510
511ErrorCode KeyMintAidlTestBase::Begin(KeyPurpose purpose, const vector<uint8_t>& key_blob,
512 const AuthorizationSet& in_params,
513 AuthorizationSet* out_params) {
514 SCOPED_TRACE("Begin");
515 Status result;
516 BeginResult out;
517
David Drysdale56ba9122021-04-19 19:10:47 +0100518 result = keymint_->begin(purpose, key_blob, in_params.vector_data(), std::nullopt, &out);
Selene Huang31ab4042020-04-29 04:22:39 -0700519
520 if (result.isOk()) {
521 *out_params = out.params;
522 challenge_ = out.challenge;
523 op_ = out.operation;
524 }
525
526 return GetReturnErrorCode(result);
527}
528
529ErrorCode KeyMintAidlTestBase::Begin(KeyPurpose purpose, const AuthorizationSet& in_params,
530 AuthorizationSet* out_params) {
531 SCOPED_TRACE("Begin");
532 EXPECT_EQ(nullptr, op_);
533 return Begin(purpose, key_blob_, in_params, out_params);
534}
535
536ErrorCode KeyMintAidlTestBase::Begin(KeyPurpose purpose, const AuthorizationSet& in_params) {
537 SCOPED_TRACE("Begin");
538 AuthorizationSet out_params;
539 ErrorCode result = Begin(purpose, in_params, &out_params);
540 EXPECT_TRUE(out_params.empty());
541 return result;
542}
543
Shawn Willden92d79c02021-02-19 07:31:55 -0700544ErrorCode KeyMintAidlTestBase::UpdateAad(const string& input) {
545 return GetReturnErrorCode(op_->updateAad(vector<uint8_t>(input.begin(), input.end()),
546 {} /* hardwareAuthToken */,
547 {} /* verificationToken */));
548}
549
550ErrorCode KeyMintAidlTestBase::Update(const string& input, string* output) {
Selene Huang31ab4042020-04-29 04:22:39 -0700551 SCOPED_TRACE("Update");
552
553 Status result;
Shawn Willden92d79c02021-02-19 07:31:55 -0700554 if (!output) return ErrorCode::UNEXPECTED_NULL_POINTER;
Selene Huang31ab4042020-04-29 04:22:39 -0700555
Brian J Murrayeabd9d62022-01-06 15:13:51 -0800556 EXPECT_NE(op_, nullptr);
557 if (!op_) return ErrorCode::UNEXPECTED_NULL_POINTER;
558
Shawn Willden92d79c02021-02-19 07:31:55 -0700559 std::vector<uint8_t> o_put;
560 result = op_->update(vector<uint8_t>(input.begin(), input.end()), {}, {}, &o_put);
Selene Huang31ab4042020-04-29 04:22:39 -0700561
David Drysdalefeab5d92022-01-06 15:46:23 +0000562 if (result.isOk()) {
563 output->append(o_put.begin(), o_put.end());
564 } else {
565 // Failure always terminates the operation.
566 op_ = {};
567 }
Selene Huang31ab4042020-04-29 04:22:39 -0700568
569 return GetReturnErrorCode(result);
570}
571
Shawn Willden92d79c02021-02-19 07:31:55 -0700572ErrorCode KeyMintAidlTestBase::Finish(const string& input, const string& signature,
Selene Huang31ab4042020-04-29 04:22:39 -0700573 string* output) {
574 SCOPED_TRACE("Finish");
575 Status result;
576
577 EXPECT_NE(op_, nullptr);
Shawn Willden92d79c02021-02-19 07:31:55 -0700578 if (!op_) return ErrorCode::UNEXPECTED_NULL_POINTER;
Selene Huang31ab4042020-04-29 04:22:39 -0700579
580 vector<uint8_t> oPut;
Shawn Willden92d79c02021-02-19 07:31:55 -0700581 result = op_->finish(vector<uint8_t>(input.begin(), input.end()),
582 vector<uint8_t>(signature.begin(), signature.end()), {} /* authToken */,
583 {} /* timestampToken */, {} /* confirmationToken */, &oPut);
Selene Huang31ab4042020-04-29 04:22:39 -0700584
Shawn Willden92d79c02021-02-19 07:31:55 -0700585 if (result.isOk()) output->append(oPut.begin(), oPut.end());
Selene Huang31ab4042020-04-29 04:22:39 -0700586
Shawn Willden92d79c02021-02-19 07:31:55 -0700587 op_ = {};
Selene Huang31ab4042020-04-29 04:22:39 -0700588 return GetReturnErrorCode(result);
589}
590
Janis Danisevskis24c04702020-12-16 18:28:39 -0800591ErrorCode KeyMintAidlTestBase::Abort(const std::shared_ptr<IKeyMintOperation>& op) {
Selene Huang31ab4042020-04-29 04:22:39 -0700592 SCOPED_TRACE("Abort");
593
594 EXPECT_NE(op, nullptr);
Shawn Willden92d79c02021-02-19 07:31:55 -0700595 if (!op) return ErrorCode::UNEXPECTED_NULL_POINTER;
Selene Huang31ab4042020-04-29 04:22:39 -0700596
597 Status retval = op->abort();
598 EXPECT_TRUE(retval.isOk());
Janis Danisevskis24c04702020-12-16 18:28:39 -0800599 return static_cast<ErrorCode>(retval.getServiceSpecificError());
Selene Huang31ab4042020-04-29 04:22:39 -0700600}
601
602ErrorCode KeyMintAidlTestBase::Abort() {
603 SCOPED_TRACE("Abort");
604
605 EXPECT_NE(op_, nullptr);
Shawn Willden92d79c02021-02-19 07:31:55 -0700606 if (!op_) return ErrorCode::UNEXPECTED_NULL_POINTER;
Selene Huang31ab4042020-04-29 04:22:39 -0700607
608 Status retval = op_->abort();
Janis Danisevskis24c04702020-12-16 18:28:39 -0800609 return static_cast<ErrorCode>(retval.getServiceSpecificError());
Selene Huang31ab4042020-04-29 04:22:39 -0700610}
611
612void KeyMintAidlTestBase::AbortIfNeeded() {
613 SCOPED_TRACE("AbortIfNeeded");
614 if (op_) {
615 EXPECT_EQ(ErrorCode::OK, Abort());
Janis Danisevskis24c04702020-12-16 18:28:39 -0800616 op_.reset();
Selene Huang31ab4042020-04-29 04:22:39 -0700617 }
618}
619
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +0000620auto KeyMintAidlTestBase::ProcessMessage(const vector<uint8_t>& key_blob, KeyPurpose operation,
621 const string& message, const AuthorizationSet& in_params)
Shawn Willden92d79c02021-02-19 07:31:55 -0700622 -> std::tuple<ErrorCode, string> {
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +0000623 AuthorizationSet begin_out_params;
624 ErrorCode result = Begin(operation, key_blob, in_params, &begin_out_params);
Shawn Willden92d79c02021-02-19 07:31:55 -0700625 if (result != ErrorCode::OK) return {result, {}};
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +0000626
627 string output;
Shawn Willden92d79c02021-02-19 07:31:55 -0700628 return {Finish(message, &output), output};
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +0000629}
630
Selene Huang31ab4042020-04-29 04:22:39 -0700631string KeyMintAidlTestBase::ProcessMessage(const vector<uint8_t>& key_blob, KeyPurpose operation,
632 const string& message, const AuthorizationSet& in_params,
633 AuthorizationSet* out_params) {
634 SCOPED_TRACE("ProcessMessage");
635 AuthorizationSet begin_out_params;
Shawn Willden92d79c02021-02-19 07:31:55 -0700636 ErrorCode result = Begin(operation, key_blob, in_params, out_params);
Selene Huang31ab4042020-04-29 04:22:39 -0700637 EXPECT_EQ(ErrorCode::OK, result);
638 if (result != ErrorCode::OK) {
639 return "";
640 }
641
642 string output;
Shawn Willden92d79c02021-02-19 07:31:55 -0700643 EXPECT_EQ(ErrorCode::OK, Finish(message, &output));
Selene Huang31ab4042020-04-29 04:22:39 -0700644 return output;
645}
646
647string KeyMintAidlTestBase::SignMessage(const vector<uint8_t>& key_blob, const string& message,
648 const AuthorizationSet& params) {
649 SCOPED_TRACE("SignMessage");
650 AuthorizationSet out_params;
651 string signature = ProcessMessage(key_blob, KeyPurpose::SIGN, message, params, &out_params);
652 EXPECT_TRUE(out_params.empty());
653 return signature;
654}
655
656string KeyMintAidlTestBase::SignMessage(const string& message, const AuthorizationSet& params) {
657 SCOPED_TRACE("SignMessage");
658 return SignMessage(key_blob_, message, params);
659}
660
661string KeyMintAidlTestBase::MacMessage(const string& message, Digest digest, size_t mac_length) {
662 SCOPED_TRACE("MacMessage");
663 return SignMessage(
664 key_blob_, message,
665 AuthorizationSetBuilder().Digest(digest).Authorization(TAG_MAC_LENGTH, mac_length));
666}
667
668void KeyMintAidlTestBase::CheckHmacTestVector(const string& key, const string& message,
669 Digest digest, const string& expected_mac) {
670 SCOPED_TRACE("CheckHmacTestVector");
671 ASSERT_EQ(ErrorCode::OK,
672 ImportKey(AuthorizationSetBuilder()
673 .Authorization(TAG_NO_AUTH_REQUIRED)
674 .HmacKey(key.size() * 8)
675 .Authorization(TAG_MIN_MAC_LENGTH, expected_mac.size() * 8)
676 .Digest(digest),
677 KeyFormat::RAW, key));
678 string signature = MacMessage(message, digest, expected_mac.size() * 8);
679 EXPECT_EQ(expected_mac, signature)
680 << "Test vector didn't match for key of size " << key.size() << " message of size "
681 << message.size() << " and digest " << digest;
682 CheckedDeleteKey();
683}
684
685void KeyMintAidlTestBase::CheckAesCtrTestVector(const string& key, const string& nonce,
686 const string& message,
687 const string& expected_ciphertext) {
688 SCOPED_TRACE("CheckAesCtrTestVector");
689 ASSERT_EQ(ErrorCode::OK, ImportKey(AuthorizationSetBuilder()
690 .Authorization(TAG_NO_AUTH_REQUIRED)
691 .AesEncryptionKey(key.size() * 8)
692 .BlockMode(BlockMode::CTR)
693 .Authorization(TAG_CALLER_NONCE)
694 .Padding(PaddingMode::NONE),
695 KeyFormat::RAW, key));
696
697 auto params = AuthorizationSetBuilder()
698 .Authorization(TAG_NONCE, nonce.data(), nonce.size())
699 .BlockMode(BlockMode::CTR)
700 .Padding(PaddingMode::NONE);
701 AuthorizationSet out_params;
702 string ciphertext = EncryptMessage(key_blob_, message, params, &out_params);
703 EXPECT_EQ(expected_ciphertext, ciphertext);
704}
705
706void KeyMintAidlTestBase::CheckTripleDesTestVector(KeyPurpose purpose, BlockMode block_mode,
707 PaddingMode padding_mode, const string& key,
708 const string& iv, const string& input,
709 const string& expected_output) {
710 auto authset = AuthorizationSetBuilder()
711 .TripleDesEncryptionKey(key.size() * 7)
712 .BlockMode(block_mode)
713 .Authorization(TAG_NO_AUTH_REQUIRED)
714 .Padding(padding_mode);
715 if (iv.size()) authset.Authorization(TAG_CALLER_NONCE);
716 ASSERT_EQ(ErrorCode::OK, ImportKey(authset, KeyFormat::RAW, key));
717 ASSERT_GT(key_blob_.size(), 0U);
718
719 auto begin_params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding_mode);
720 if (iv.size()) begin_params.Authorization(TAG_NONCE, iv.data(), iv.size());
721 AuthorizationSet output_params;
722 string output = ProcessMessage(key_blob_, purpose, input, begin_params, &output_params);
723 EXPECT_EQ(expected_output, output);
724}
725
726void KeyMintAidlTestBase::VerifyMessage(const vector<uint8_t>& key_blob, const string& message,
727 const string& signature, const AuthorizationSet& params) {
728 SCOPED_TRACE("VerifyMessage");
729 AuthorizationSet begin_out_params;
730 ASSERT_EQ(ErrorCode::OK, Begin(KeyPurpose::VERIFY, key_blob, params, &begin_out_params));
731
732 string output;
Shawn Willden92d79c02021-02-19 07:31:55 -0700733 EXPECT_EQ(ErrorCode::OK, Finish(message, signature, &output));
Selene Huang31ab4042020-04-29 04:22:39 -0700734 EXPECT_TRUE(output.empty());
Shawn Willden92d79c02021-02-19 07:31:55 -0700735 op_ = {};
Selene Huang31ab4042020-04-29 04:22:39 -0700736}
737
738void KeyMintAidlTestBase::VerifyMessage(const string& message, const string& signature,
739 const AuthorizationSet& params) {
740 SCOPED_TRACE("VerifyMessage");
741 VerifyMessage(key_blob_, message, signature, params);
742}
743
David Drysdaledf8f52e2021-05-06 08:10:58 +0100744void KeyMintAidlTestBase::LocalVerifyMessage(const string& message, const string& signature,
745 const AuthorizationSet& params) {
746 SCOPED_TRACE("LocalVerifyMessage");
747
748 // Retrieve the public key from the leaf certificate.
749 ASSERT_GT(cert_chain_.size(), 0);
750 X509_Ptr key_cert(parse_cert_blob(cert_chain_[0].encodedCertificate));
751 ASSERT_TRUE(key_cert.get());
752 EVP_PKEY_Ptr pub_key(X509_get_pubkey(key_cert.get()));
753 ASSERT_TRUE(pub_key.get());
754
755 Digest digest = params.GetTagValue(TAG_DIGEST).value();
756 PaddingMode padding = PaddingMode::NONE;
757 auto tag = params.GetTagValue(TAG_PADDING);
758 if (tag.has_value()) {
759 padding = tag.value();
760 }
761
762 if (digest == Digest::NONE) {
763 switch (EVP_PKEY_id(pub_key.get())) {
David Drysdale42fe1892021-10-14 14:43:46 +0100764 case EVP_PKEY_ED25519: {
765 ASSERT_EQ(64, signature.size());
766 uint8_t pub_keydata[32];
767 size_t pub_len = sizeof(pub_keydata);
768 ASSERT_EQ(1, EVP_PKEY_get_raw_public_key(pub_key.get(), pub_keydata, &pub_len));
769 ASSERT_EQ(sizeof(pub_keydata), pub_len);
770 ASSERT_EQ(1, ED25519_verify(reinterpret_cast<const uint8_t*>(message.data()),
771 message.size(),
772 reinterpret_cast<const uint8_t*>(signature.data()),
773 pub_keydata));
774 break;
775 }
776
David Drysdaledf8f52e2021-05-06 08:10:58 +0100777 case EVP_PKEY_EC: {
778 vector<uint8_t> data((EVP_PKEY_bits(pub_key.get()) + 7) / 8);
779 size_t data_size = std::min(data.size(), message.size());
780 memcpy(data.data(), message.data(), data_size);
781 EC_KEY_Ptr ecdsa(EVP_PKEY_get1_EC_KEY(pub_key.get()));
782 ASSERT_TRUE(ecdsa.get());
783 ASSERT_EQ(1,
784 ECDSA_verify(0, reinterpret_cast<const uint8_t*>(data.data()), data_size,
785 reinterpret_cast<const uint8_t*>(signature.data()),
786 signature.size(), ecdsa.get()));
787 break;
788 }
789 case EVP_PKEY_RSA: {
790 vector<uint8_t> data(EVP_PKEY_size(pub_key.get()));
791 size_t data_size = std::min(data.size(), message.size());
792 memcpy(data.data(), message.data(), data_size);
793
794 RSA_Ptr rsa(EVP_PKEY_get1_RSA(const_cast<EVP_PKEY*>(pub_key.get())));
795 ASSERT_TRUE(rsa.get());
796
797 size_t key_len = RSA_size(rsa.get());
798 int openssl_padding = RSA_NO_PADDING;
799 switch (padding) {
800 case PaddingMode::NONE:
801 ASSERT_TRUE(data_size <= key_len);
802 ASSERT_EQ(key_len, signature.size());
803 openssl_padding = RSA_NO_PADDING;
804 break;
805 case PaddingMode::RSA_PKCS1_1_5_SIGN:
806 ASSERT_TRUE(data_size + kPkcs1UndigestedSignaturePaddingOverhead <=
807 key_len);
808 openssl_padding = RSA_PKCS1_PADDING;
809 break;
810 default:
811 ADD_FAILURE() << "Unsupported RSA padding mode " << padding;
812 }
813
814 vector<uint8_t> decrypted_data(key_len);
815 int bytes_decrypted = RSA_public_decrypt(
816 signature.size(), reinterpret_cast<const uint8_t*>(signature.data()),
817 decrypted_data.data(), rsa.get(), openssl_padding);
818 ASSERT_GE(bytes_decrypted, 0);
819
820 const uint8_t* compare_pos = decrypted_data.data();
821 size_t bytes_to_compare = bytes_decrypted;
822 uint8_t zero_check_result = 0;
823 if (padding == PaddingMode::NONE && data_size < bytes_to_compare) {
824 // If the data is short, for "unpadded" signing we zero-pad to the left. So
825 // during verification we should have zeros on the left of the decrypted data.
826 // Do a constant-time check.
827 const uint8_t* zero_end = compare_pos + bytes_to_compare - data_size;
828 while (compare_pos < zero_end) zero_check_result |= *compare_pos++;
829 ASSERT_EQ(0, zero_check_result);
830 bytes_to_compare = data_size;
831 }
832 ASSERT_EQ(0, memcmp(compare_pos, data.data(), bytes_to_compare));
833 break;
834 }
835 default:
836 ADD_FAILURE() << "Unknown public key type";
837 }
838 } else {
839 EVP_MD_CTX digest_ctx;
840 EVP_MD_CTX_init(&digest_ctx);
841 EVP_PKEY_CTX* pkey_ctx;
842 const EVP_MD* md = openssl_digest(digest);
843 ASSERT_NE(md, nullptr);
844 ASSERT_EQ(1, EVP_DigestVerifyInit(&digest_ctx, &pkey_ctx, md, nullptr, pub_key.get()));
845
846 if (padding == PaddingMode::RSA_PSS) {
847 EXPECT_GT(EVP_PKEY_CTX_set_rsa_padding(pkey_ctx, RSA_PKCS1_PSS_PADDING), 0);
848 EXPECT_GT(EVP_PKEY_CTX_set_rsa_pss_saltlen(pkey_ctx, EVP_MD_size(md)), 0);
David Drysdalec6b89072021-12-14 14:32:51 +0000849 EXPECT_GT(EVP_PKEY_CTX_set_rsa_mgf1_md(pkey_ctx, md), 0);
David Drysdaledf8f52e2021-05-06 08:10:58 +0100850 }
851
852 ASSERT_EQ(1, EVP_DigestVerifyUpdate(&digest_ctx,
853 reinterpret_cast<const uint8_t*>(message.data()),
854 message.size()));
855 ASSERT_EQ(1, EVP_DigestVerifyFinal(&digest_ctx,
856 reinterpret_cast<const uint8_t*>(signature.data()),
857 signature.size()));
858 EVP_MD_CTX_cleanup(&digest_ctx);
859 }
860}
861
David Drysdale59cae642021-05-12 13:52:03 +0100862string KeyMintAidlTestBase::LocalRsaEncryptMessage(const string& message,
863 const AuthorizationSet& params) {
864 SCOPED_TRACE("LocalRsaEncryptMessage");
865
866 // Retrieve the public key from the leaf certificate.
867 if (cert_chain_.empty()) {
868 ADD_FAILURE() << "No public key available";
869 return "Failure";
870 }
871 X509_Ptr key_cert(parse_cert_blob(cert_chain_[0].encodedCertificate));
872 EVP_PKEY_Ptr pub_key(X509_get_pubkey(key_cert.get()));
873 RSA_Ptr rsa(EVP_PKEY_get1_RSA(const_cast<EVP_PKEY*>(pub_key.get())));
874
875 // Retrieve relevant tags.
876 Digest digest = Digest::NONE;
877 Digest mgf_digest = Digest::NONE;
878 PaddingMode padding = PaddingMode::NONE;
879
880 auto digest_tag = params.GetTagValue(TAG_DIGEST);
881 if (digest_tag.has_value()) digest = digest_tag.value();
882 auto pad_tag = params.GetTagValue(TAG_PADDING);
883 if (pad_tag.has_value()) padding = pad_tag.value();
884 auto mgf_tag = params.GetTagValue(TAG_RSA_OAEP_MGF_DIGEST);
885 if (mgf_tag.has_value()) mgf_digest = mgf_tag.value();
886
887 const EVP_MD* md = openssl_digest(digest);
888 const EVP_MD* mgf_md = openssl_digest(mgf_digest);
889
890 // Set up encryption context.
891 EVP_PKEY_CTX_Ptr ctx(EVP_PKEY_CTX_new(pub_key.get(), /* engine= */ nullptr));
892 if (EVP_PKEY_encrypt_init(ctx.get()) <= 0) {
893 ADD_FAILURE() << "Encryption init failed: " << ERR_peek_last_error();
894 return "Failure";
895 }
896
897 int rc = -1;
898 switch (padding) {
899 case PaddingMode::NONE:
900 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_NO_PADDING);
901 break;
902 case PaddingMode::RSA_PKCS1_1_5_ENCRYPT:
903 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_PKCS1_PADDING);
904 break;
905 case PaddingMode::RSA_OAEP:
906 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_PKCS1_OAEP_PADDING);
907 break;
908 default:
909 break;
910 }
911 if (rc <= 0) {
912 ADD_FAILURE() << "Set padding failed: " << ERR_peek_last_error();
913 return "Failure";
914 }
915 if (padding == PaddingMode::RSA_OAEP) {
916 if (!EVP_PKEY_CTX_set_rsa_oaep_md(ctx.get(), md)) {
917 ADD_FAILURE() << "Set digest failed: " << ERR_peek_last_error();
918 return "Failure";
919 }
920 if (!EVP_PKEY_CTX_set_rsa_mgf1_md(ctx.get(), mgf_md)) {
921 ADD_FAILURE() << "Set MGF digest failed: " << ERR_peek_last_error();
922 return "Failure";
923 }
924 }
925
926 // Determine output size.
927 size_t outlen;
928 if (EVP_PKEY_encrypt(ctx.get(), nullptr /* out */, &outlen,
929 reinterpret_cast<const uint8_t*>(message.data()), message.size()) <= 0) {
930 ADD_FAILURE() << "Determine output size failed: " << ERR_peek_last_error();
931 return "Failure";
932 }
933
934 // Left-zero-pad the input if necessary.
935 const uint8_t* to_encrypt = reinterpret_cast<const uint8_t*>(message.data());
936 size_t to_encrypt_len = message.size();
937
938 std::unique_ptr<string> zero_padded_message;
939 if (padding == PaddingMode::NONE && to_encrypt_len < outlen) {
940 zero_padded_message.reset(new string(outlen, '\0'));
941 memcpy(zero_padded_message->data() + (outlen - to_encrypt_len), message.data(),
942 message.size());
943 to_encrypt = reinterpret_cast<const uint8_t*>(zero_padded_message->data());
944 to_encrypt_len = outlen;
945 }
946
947 // Do the encryption.
948 string output(outlen, '\0');
949 if (EVP_PKEY_encrypt(ctx.get(), reinterpret_cast<uint8_t*>(output.data()), &outlen, to_encrypt,
950 to_encrypt_len) <= 0) {
951 ADD_FAILURE() << "Encryption failed: " << ERR_peek_last_error();
952 return "Failure";
953 }
954 return output;
955}
956
Selene Huang31ab4042020-04-29 04:22:39 -0700957string KeyMintAidlTestBase::EncryptMessage(const vector<uint8_t>& key_blob, const string& message,
958 const AuthorizationSet& in_params,
959 AuthorizationSet* out_params) {
960 SCOPED_TRACE("EncryptMessage");
961 return ProcessMessage(key_blob, KeyPurpose::ENCRYPT, message, in_params, out_params);
962}
963
964string KeyMintAidlTestBase::EncryptMessage(const string& message, const AuthorizationSet& params,
965 AuthorizationSet* out_params) {
966 SCOPED_TRACE("EncryptMessage");
967 return EncryptMessage(key_blob_, message, params, out_params);
968}
969
970string KeyMintAidlTestBase::EncryptMessage(const string& message, const AuthorizationSet& params) {
971 SCOPED_TRACE("EncryptMessage");
972 AuthorizationSet out_params;
973 string ciphertext = EncryptMessage(message, params, &out_params);
974 EXPECT_TRUE(out_params.empty()) << "Output params should be empty. Contained: " << out_params;
975 return ciphertext;
976}
977
978string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
979 PaddingMode padding) {
980 SCOPED_TRACE("EncryptMessage");
981 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding);
982 AuthorizationSet out_params;
983 string ciphertext = EncryptMessage(message, params, &out_params);
984 EXPECT_TRUE(out_params.empty()) << "Output params should be empty. Contained: " << out_params;
985 return ciphertext;
986}
987
988string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
989 PaddingMode padding, vector<uint8_t>* iv_out) {
990 SCOPED_TRACE("EncryptMessage");
991 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding);
992 AuthorizationSet out_params;
993 string ciphertext = EncryptMessage(message, params, &out_params);
994 EXPECT_EQ(1U, out_params.size());
995 auto ivVal = out_params.GetTagValue(TAG_NONCE);
Janis Danisevskis5ba09332020-12-17 10:05:15 -0800996 EXPECT_TRUE(ivVal);
997 if (ivVal) *iv_out = *ivVal;
Selene Huang31ab4042020-04-29 04:22:39 -0700998 return ciphertext;
999}
1000
1001string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1002 PaddingMode padding, const vector<uint8_t>& iv_in) {
1003 SCOPED_TRACE("EncryptMessage");
1004 auto params = AuthorizationSetBuilder()
1005 .BlockMode(block_mode)
1006 .Padding(padding)
1007 .Authorization(TAG_NONCE, iv_in);
1008 AuthorizationSet out_params;
1009 string ciphertext = EncryptMessage(message, params, &out_params);
1010 return ciphertext;
1011}
1012
1013string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1014 PaddingMode padding, uint8_t mac_length_bits,
1015 const vector<uint8_t>& iv_in) {
1016 SCOPED_TRACE("EncryptMessage");
1017 auto params = AuthorizationSetBuilder()
1018 .BlockMode(block_mode)
1019 .Padding(padding)
1020 .Authorization(TAG_MAC_LENGTH, mac_length_bits)
1021 .Authorization(TAG_NONCE, iv_in);
1022 AuthorizationSet out_params;
1023 string ciphertext = EncryptMessage(message, params, &out_params);
1024 return ciphertext;
1025}
1026
David Drysdaled2cc8c22021-04-15 13:29:45 +01001027string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1028 PaddingMode padding, uint8_t mac_length_bits) {
1029 SCOPED_TRACE("EncryptMessage");
1030 auto params = AuthorizationSetBuilder()
1031 .BlockMode(block_mode)
1032 .Padding(padding)
1033 .Authorization(TAG_MAC_LENGTH, mac_length_bits);
1034 AuthorizationSet out_params;
1035 string ciphertext = EncryptMessage(message, params, &out_params);
1036 return ciphertext;
1037}
1038
Selene Huang31ab4042020-04-29 04:22:39 -07001039string KeyMintAidlTestBase::DecryptMessage(const vector<uint8_t>& key_blob,
1040 const string& ciphertext,
1041 const AuthorizationSet& params) {
1042 SCOPED_TRACE("DecryptMessage");
1043 AuthorizationSet out_params;
1044 string plaintext =
1045 ProcessMessage(key_blob, KeyPurpose::DECRYPT, ciphertext, params, &out_params);
1046 EXPECT_TRUE(out_params.empty());
1047 return plaintext;
1048}
1049
1050string KeyMintAidlTestBase::DecryptMessage(const string& ciphertext,
1051 const AuthorizationSet& params) {
1052 SCOPED_TRACE("DecryptMessage");
1053 return DecryptMessage(key_blob_, ciphertext, params);
1054}
1055
1056string KeyMintAidlTestBase::DecryptMessage(const string& ciphertext, BlockMode block_mode,
1057 PaddingMode padding_mode, const vector<uint8_t>& iv) {
1058 SCOPED_TRACE("DecryptMessage");
1059 auto params = AuthorizationSetBuilder()
1060 .BlockMode(block_mode)
1061 .Padding(padding_mode)
1062 .Authorization(TAG_NONCE, iv);
1063 return DecryptMessage(key_blob_, ciphertext, params);
1064}
1065
1066std::pair<ErrorCode, vector<uint8_t>> KeyMintAidlTestBase::UpgradeKey(
1067 const vector<uint8_t>& key_blob) {
1068 std::pair<ErrorCode, vector<uint8_t>> retval;
1069 vector<uint8_t> outKeyBlob;
1070 Status result = keymint_->upgradeKey(key_blob, vector<KeyParameter>(), &outKeyBlob);
1071 ErrorCode errorcode = GetReturnErrorCode(result);
1072 retval = std::tie(errorcode, outKeyBlob);
1073
1074 return retval;
1075}
1076vector<uint32_t> KeyMintAidlTestBase::ValidKeySizes(Algorithm algorithm) {
1077 switch (algorithm) {
1078 case Algorithm::RSA:
1079 switch (SecLevel()) {
1080 case SecurityLevel::SOFTWARE:
1081 case SecurityLevel::TRUSTED_ENVIRONMENT:
1082 return {2048, 3072, 4096};
1083 case SecurityLevel::STRONGBOX:
1084 return {2048};
1085 default:
1086 ADD_FAILURE() << "Invalid security level " << uint32_t(SecLevel());
1087 break;
1088 }
1089 break;
1090 case Algorithm::EC:
David Drysdaledf09e542021-06-08 15:46:11 +01001091 ADD_FAILURE() << "EC keys must be specified by curve not size";
Selene Huang31ab4042020-04-29 04:22:39 -07001092 break;
1093 case Algorithm::AES:
1094 return {128, 256};
1095 case Algorithm::TRIPLE_DES:
1096 return {168};
1097 case Algorithm::HMAC: {
1098 vector<uint32_t> retval((512 - 64) / 8 + 1);
1099 uint32_t size = 64 - 8;
1100 std::generate(retval.begin(), retval.end(), [&]() { return (size += 8); });
1101 return retval;
1102 }
1103 default:
1104 ADD_FAILURE() << "Invalid Algorithm: " << algorithm;
1105 return {};
1106 }
1107 ADD_FAILURE() << "Should be impossible to get here";
1108 return {};
1109}
1110
1111vector<uint32_t> KeyMintAidlTestBase::InvalidKeySizes(Algorithm algorithm) {
1112 if (SecLevel() == SecurityLevel::STRONGBOX) {
1113 switch (algorithm) {
1114 case Algorithm::RSA:
1115 return {3072, 4096};
1116 case Algorithm::EC:
1117 return {224, 384, 521};
1118 case Algorithm::AES:
1119 return {192};
David Drysdale7de9feb2021-03-05 14:56:19 +00001120 case Algorithm::TRIPLE_DES:
1121 return {56};
1122 default:
1123 return {};
1124 }
1125 } else {
1126 switch (algorithm) {
Prashant Patild72b3512021-11-16 08:19:19 +00001127 case Algorithm::AES:
1128 return {64, 96, 131, 512};
David Drysdale7de9feb2021-03-05 14:56:19 +00001129 case Algorithm::TRIPLE_DES:
1130 return {56};
Selene Huang31ab4042020-04-29 04:22:39 -07001131 default:
1132 return {};
1133 }
1134 }
1135 return {};
1136}
1137
David Drysdale7de9feb2021-03-05 14:56:19 +00001138vector<BlockMode> KeyMintAidlTestBase::ValidBlockModes(Algorithm algorithm) {
1139 switch (algorithm) {
1140 case Algorithm::AES:
1141 return {
1142 BlockMode::CBC,
1143 BlockMode::CTR,
1144 BlockMode::ECB,
1145 BlockMode::GCM,
1146 };
1147 case Algorithm::TRIPLE_DES:
1148 return {
1149 BlockMode::CBC,
1150 BlockMode::ECB,
1151 };
1152 default:
1153 return {};
1154 }
1155}
1156
1157vector<PaddingMode> KeyMintAidlTestBase::ValidPaddingModes(Algorithm algorithm,
1158 BlockMode blockMode) {
1159 switch (algorithm) {
1160 case Algorithm::AES:
1161 switch (blockMode) {
1162 case BlockMode::CBC:
1163 case BlockMode::ECB:
1164 return {PaddingMode::NONE, PaddingMode::PKCS7};
1165 case BlockMode::CTR:
1166 case BlockMode::GCM:
1167 return {PaddingMode::NONE};
1168 default:
1169 return {};
1170 };
1171 case Algorithm::TRIPLE_DES:
1172 switch (blockMode) {
1173 case BlockMode::CBC:
1174 case BlockMode::ECB:
1175 return {PaddingMode::NONE, PaddingMode::PKCS7};
1176 default:
1177 return {};
1178 };
1179 default:
1180 return {};
1181 }
1182}
1183
1184vector<PaddingMode> KeyMintAidlTestBase::InvalidPaddingModes(Algorithm algorithm,
1185 BlockMode blockMode) {
1186 switch (algorithm) {
1187 case Algorithm::AES:
1188 switch (blockMode) {
1189 case BlockMode::CTR:
1190 case BlockMode::GCM:
1191 return {PaddingMode::PKCS7};
1192 default:
1193 return {};
1194 };
1195 default:
1196 return {};
1197 }
1198}
1199
Selene Huang31ab4042020-04-29 04:22:39 -07001200vector<EcCurve> KeyMintAidlTestBase::ValidCurves() {
1201 if (securityLevel_ == SecurityLevel::STRONGBOX) {
1202 return {EcCurve::P_256};
David Drysdale42fe1892021-10-14 14:43:46 +01001203 } else if (Curve25519Supported()) {
1204 return {EcCurve::P_224, EcCurve::P_256, EcCurve::P_384, EcCurve::P_521,
1205 EcCurve::CURVE_25519};
Selene Huang31ab4042020-04-29 04:22:39 -07001206 } else {
David Drysdale42fe1892021-10-14 14:43:46 +01001207 return {
1208 EcCurve::P_224,
1209 EcCurve::P_256,
1210 EcCurve::P_384,
1211 EcCurve::P_521,
1212 };
Selene Huang31ab4042020-04-29 04:22:39 -07001213 }
1214}
1215
1216vector<EcCurve> KeyMintAidlTestBase::InvalidCurves() {
David Drysdaledf09e542021-06-08 15:46:11 +01001217 if (SecLevel() == SecurityLevel::STRONGBOX) {
David Drysdale42fe1892021-10-14 14:43:46 +01001218 // Curve 25519 is not supported, either because:
1219 // - KeyMint v1: it's an unknown enum value
1220 // - KeyMint v2+: it's not supported by StrongBox.
1221 return {EcCurve::P_224, EcCurve::P_384, EcCurve::P_521, EcCurve::CURVE_25519};
David Drysdaledf09e542021-06-08 15:46:11 +01001222 } else {
David Drysdale42fe1892021-10-14 14:43:46 +01001223 if (Curve25519Supported()) {
1224 return {};
1225 } else {
1226 return {EcCurve::CURVE_25519};
1227 }
David Drysdaledf09e542021-06-08 15:46:11 +01001228 }
Selene Huang31ab4042020-04-29 04:22:39 -07001229}
1230
1231vector<Digest> KeyMintAidlTestBase::ValidDigests(bool withNone, bool withMD5) {
1232 switch (SecLevel()) {
1233 case SecurityLevel::SOFTWARE:
1234 case SecurityLevel::TRUSTED_ENVIRONMENT:
1235 if (withNone) {
1236 if (withMD5)
1237 return {Digest::NONE, Digest::MD5, Digest::SHA1,
1238 Digest::SHA_2_224, Digest::SHA_2_256, Digest::SHA_2_384,
1239 Digest::SHA_2_512};
1240 else
1241 return {Digest::NONE, Digest::SHA1, Digest::SHA_2_224,
1242 Digest::SHA_2_256, Digest::SHA_2_384, Digest::SHA_2_512};
1243 } else {
1244 if (withMD5)
1245 return {Digest::MD5, Digest::SHA1, Digest::SHA_2_224,
1246 Digest::SHA_2_256, Digest::SHA_2_384, Digest::SHA_2_512};
1247 else
1248 return {Digest::SHA1, Digest::SHA_2_224, Digest::SHA_2_256, Digest::SHA_2_384,
1249 Digest::SHA_2_512};
1250 }
1251 break;
1252 case SecurityLevel::STRONGBOX:
1253 if (withNone)
1254 return {Digest::NONE, Digest::SHA_2_256};
1255 else
1256 return {Digest::SHA_2_256};
1257 break;
1258 default:
1259 ADD_FAILURE() << "Invalid security level " << uint32_t(SecLevel());
1260 break;
1261 }
1262 ADD_FAILURE() << "Should be impossible to get here";
1263 return {};
1264}
1265
Shawn Willden7f424372021-01-10 18:06:50 -07001266static const vector<KeyParameter> kEmptyAuthList{};
1267
1268const vector<KeyParameter>& KeyMintAidlTestBase::SecLevelAuthorizations(
1269 const vector<KeyCharacteristics>& key_characteristics) {
1270 auto found = std::find_if(key_characteristics.begin(), key_characteristics.end(),
1271 [this](auto& entry) { return entry.securityLevel == SecLevel(); });
1272 return (found == key_characteristics.end()) ? kEmptyAuthList : found->authorizations;
1273}
1274
Qi Wubeefae42021-01-28 23:16:37 +08001275const vector<KeyParameter>& KeyMintAidlTestBase::SecLevelAuthorizations(
1276 const vector<KeyCharacteristics>& key_characteristics, SecurityLevel securityLevel) {
1277 auto found = std::find_if(
1278 key_characteristics.begin(), key_characteristics.end(),
1279 [securityLevel](auto& entry) { return entry.securityLevel == securityLevel; });
Shawn Willden0e80b5d2020-12-17 09:07:27 -07001280 return (found == key_characteristics.end()) ? kEmptyAuthList : found->authorizations;
1281}
1282
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001283ErrorCode KeyMintAidlTestBase::UseAesKey(const vector<uint8_t>& aesKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001284 auto [result, ciphertext] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001285 aesKeyBlob, KeyPurpose::ENCRYPT, "1234567890123456",
1286 AuthorizationSetBuilder().BlockMode(BlockMode::ECB).Padding(PaddingMode::NONE));
1287 return result;
1288}
1289
1290ErrorCode KeyMintAidlTestBase::UseHmacKey(const vector<uint8_t>& hmacKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001291 auto [result, mac] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001292 hmacKeyBlob, KeyPurpose::SIGN, "1234567890123456",
1293 AuthorizationSetBuilder().Authorization(TAG_MAC_LENGTH, 128).Digest(Digest::SHA_2_256));
1294 return result;
1295}
1296
1297ErrorCode KeyMintAidlTestBase::UseRsaKey(const vector<uint8_t>& rsaKeyBlob) {
1298 std::string message(2048 / 8, 'a');
Shawn Willden92d79c02021-02-19 07:31:55 -07001299 auto [result, signature] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001300 rsaKeyBlob, KeyPurpose::SIGN, message,
1301 AuthorizationSetBuilder().Digest(Digest::NONE).Padding(PaddingMode::NONE));
1302 return result;
1303}
1304
1305ErrorCode KeyMintAidlTestBase::UseEcdsaKey(const vector<uint8_t>& ecdsaKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001306 auto [result, signature] = ProcessMessage(ecdsaKeyBlob, KeyPurpose::SIGN, "a",
1307 AuthorizationSetBuilder().Digest(Digest::SHA_2_256));
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001308 return result;
1309}
1310
Selene Huang6e46f142021-04-20 19:20:11 -07001311void verify_serial(X509* cert, const uint64_t expected_serial) {
1312 BIGNUM_Ptr ser(BN_new());
1313 EXPECT_TRUE(ASN1_INTEGER_to_BN(X509_get_serialNumber(cert), ser.get()));
1314
1315 uint64_t serial;
1316 EXPECT_TRUE(BN_get_u64(ser.get(), &serial));
1317 EXPECT_EQ(serial, expected_serial);
1318}
1319
1320// Please set self_signed to true for fake certificates or self signed
1321// certificates
1322void verify_subject(const X509* cert, //
1323 const string& subject, //
1324 bool self_signed) {
1325 char* cert_issuer = //
1326 X509_NAME_oneline(X509_get_issuer_name(cert), nullptr, 0);
1327
1328 char* cert_subj = X509_NAME_oneline(X509_get_subject_name(cert), nullptr, 0);
1329
1330 string expected_subject("/CN=");
1331 if (subject.empty()) {
1332 expected_subject.append("Android Keystore Key");
1333 } else {
1334 expected_subject.append(subject);
1335 }
1336
1337 EXPECT_STREQ(expected_subject.c_str(), cert_subj) << "Cert has wrong subject." << cert_subj;
1338
1339 if (self_signed) {
1340 EXPECT_STREQ(cert_issuer, cert_subj)
1341 << "Cert issuer and subject mismatch for self signed certificate.";
1342 }
1343
1344 OPENSSL_free(cert_subj);
1345 OPENSSL_free(cert_issuer);
1346}
1347
1348vector<uint8_t> build_serial_blob(const uint64_t serial_int) {
1349 BIGNUM_Ptr serial(BN_new());
1350 EXPECT_TRUE(BN_set_u64(serial.get(), serial_int));
1351
1352 int len = BN_num_bytes(serial.get());
1353 vector<uint8_t> serial_blob(len);
1354 if (BN_bn2bin(serial.get(), serial_blob.data()) != len) {
1355 return {};
1356 }
1357
David Drysdaledb0dcf52021-05-18 11:43:31 +01001358 if (serial_blob.empty() || serial_blob[0] & 0x80) {
1359 // An empty blob is OpenSSL's encoding of the zero value; we need single zero byte.
1360 // Top bit being set indicates a negative number in two's complement, but our input
1361 // was positive.
1362 // In either case, prepend a zero byte.
1363 serial_blob.insert(serial_blob.begin(), 0x00);
1364 }
1365
Selene Huang6e46f142021-04-20 19:20:11 -07001366 return serial_blob;
1367}
1368
1369void verify_subject_and_serial(const Certificate& certificate, //
1370 const uint64_t expected_serial, //
1371 const string& subject, bool self_signed) {
1372 X509_Ptr cert(parse_cert_blob(certificate.encodedCertificate));
1373 ASSERT_TRUE(!!cert.get());
1374
1375 verify_serial(cert.get(), expected_serial);
1376 verify_subject(cert.get(), subject, self_signed);
1377}
1378
David Drysdale7dff4fc2021-12-10 10:10:52 +00001379bool verify_attestation_record(int32_t aidl_version, //
1380 const string& challenge, //
Shawn Willden7c130392020-12-21 09:58:22 -07001381 const string& app_id, //
1382 AuthorizationSet expected_sw_enforced, //
1383 AuthorizationSet expected_hw_enforced, //
1384 SecurityLevel security_level,
David Drysdale565ccc72021-10-11 12:49:50 +01001385 const vector<uint8_t>& attestation_cert,
1386 vector<uint8_t>* unique_id) {
Shawn Willden7c130392020-12-21 09:58:22 -07001387 X509_Ptr cert(parse_cert_blob(attestation_cert));
1388 EXPECT_TRUE(!!cert.get());
1389 if (!cert.get()) return false;
1390
1391 ASN1_OCTET_STRING* attest_rec = get_attestation_record(cert.get());
1392 EXPECT_TRUE(!!attest_rec);
1393 if (!attest_rec) return false;
1394
1395 AuthorizationSet att_sw_enforced;
1396 AuthorizationSet att_hw_enforced;
1397 uint32_t att_attestation_version;
David Drysdale37af4b32021-05-14 16:46:59 +01001398 uint32_t att_keymint_version;
Shawn Willden7c130392020-12-21 09:58:22 -07001399 SecurityLevel att_attestation_security_level;
David Drysdale37af4b32021-05-14 16:46:59 +01001400 SecurityLevel att_keymint_security_level;
Shawn Willden7c130392020-12-21 09:58:22 -07001401 vector<uint8_t> att_challenge;
1402 vector<uint8_t> att_unique_id;
1403 vector<uint8_t> att_app_id;
1404
1405 auto error = parse_attestation_record(attest_rec->data, //
1406 attest_rec->length, //
1407 &att_attestation_version, //
1408 &att_attestation_security_level, //
David Drysdale37af4b32021-05-14 16:46:59 +01001409 &att_keymint_version, //
1410 &att_keymint_security_level, //
Shawn Willden7c130392020-12-21 09:58:22 -07001411 &att_challenge, //
1412 &att_sw_enforced, //
1413 &att_hw_enforced, //
1414 &att_unique_id);
1415 EXPECT_EQ(ErrorCode::OK, error);
1416 if (error != ErrorCode::OK) return false;
1417
David Drysdale7dff4fc2021-12-10 10:10:52 +00001418 check_attestation_version(att_attestation_version, aidl_version);
Selene Huang4f64c222021-04-13 19:54:36 -07001419 vector<uint8_t> appId(app_id.begin(), app_id.end());
Shawn Willden7c130392020-12-21 09:58:22 -07001420
Selene Huang4f64c222021-04-13 19:54:36 -07001421 // check challenge and app id only if we expects a non-fake certificate
1422 if (challenge.length() > 0) {
1423 EXPECT_EQ(challenge.length(), att_challenge.size());
1424 EXPECT_EQ(0, memcmp(challenge.data(), att_challenge.data(), challenge.length()));
1425
1426 expected_sw_enforced.push_back(TAG_ATTESTATION_APPLICATION_ID, appId);
1427 }
Shawn Willden7c130392020-12-21 09:58:22 -07001428
David Drysdale7dff4fc2021-12-10 10:10:52 +00001429 check_attestation_version(att_keymint_version, aidl_version);
David Drysdale37af4b32021-05-14 16:46:59 +01001430 EXPECT_EQ(security_level, att_keymint_security_level);
Shawn Willden7c130392020-12-21 09:58:22 -07001431 EXPECT_EQ(security_level, att_attestation_security_level);
1432
Shawn Willden7c130392020-12-21 09:58:22 -07001433
1434 char property_value[PROPERTY_VALUE_MAX] = {};
1435 // TODO(b/136282179): When running under VTS-on-GSI the TEE-backed
David Drysdale37af4b32021-05-14 16:46:59 +01001436 // keymint implementation will report YYYYMM dates instead of YYYYMMDD
Shawn Willden7c130392020-12-21 09:58:22 -07001437 // for the BOOT_PATCH_LEVEL.
1438 if (avb_verification_enabled()) {
1439 for (int i = 0; i < att_hw_enforced.size(); i++) {
1440 if (att_hw_enforced[i].tag == TAG_BOOT_PATCHLEVEL ||
1441 att_hw_enforced[i].tag == TAG_VENDOR_PATCHLEVEL) {
1442 std::string date =
Tommy Chiuf00d8f12021-04-08 11:07:48 +08001443 std::to_string(att_hw_enforced[i].value.get<KeyParameterValue::integer>());
David Drysdale168228a2021-10-05 08:43:52 +01001444
Shawn Willden7c130392020-12-21 09:58:22 -07001445 // strptime seems to require delimiters, but the tag value will
1446 // be YYYYMMDD
David Drysdale168228a2021-10-05 08:43:52 +01001447 if (date.size() != 8) {
1448 ADD_FAILURE() << "Tag " << att_hw_enforced[i].tag
1449 << " with invalid format (not YYYYMMDD): " << date;
1450 return false;
1451 }
Shawn Willden7c130392020-12-21 09:58:22 -07001452 date.insert(6, "-");
1453 date.insert(4, "-");
Shawn Willden7c130392020-12-21 09:58:22 -07001454 struct tm time;
1455 strptime(date.c_str(), "%Y-%m-%d", &time);
1456
1457 // Day of the month (0-31)
1458 EXPECT_GE(time.tm_mday, 0);
1459 EXPECT_LT(time.tm_mday, 32);
1460 // Months since Jan (0-11)
1461 EXPECT_GE(time.tm_mon, 0);
1462 EXPECT_LT(time.tm_mon, 12);
1463 // Years since 1900
1464 EXPECT_GT(time.tm_year, 110);
1465 EXPECT_LT(time.tm_year, 200);
1466 }
1467 }
1468 }
1469
1470 // Check to make sure boolean values are properly encoded. Presence of a boolean tag
1471 // indicates true. A provided boolean tag that can be pulled back out of the certificate
1472 // indicates correct encoding. No need to check if it's in both lists, since the
1473 // AuthorizationSet compare below will handle mismatches of tags.
1474 if (security_level == SecurityLevel::SOFTWARE) {
1475 EXPECT_TRUE(expected_sw_enforced.Contains(TAG_NO_AUTH_REQUIRED));
1476 } else {
1477 EXPECT_TRUE(expected_hw_enforced.Contains(TAG_NO_AUTH_REQUIRED));
1478 }
1479
Shawn Willden7c130392020-12-21 09:58:22 -07001480 if (att_hw_enforced.Contains(TAG_ALGORITHM, Algorithm::EC)) {
1481 // For ECDSA keys, either an EC_CURVE or a KEY_SIZE can be specified, but one must be.
1482 EXPECT_TRUE(att_hw_enforced.Contains(TAG_EC_CURVE) ||
1483 att_hw_enforced.Contains(TAG_KEY_SIZE));
1484 }
1485
1486 // Test root of trust elements
1487 vector<uint8_t> verified_boot_key;
1488 VerifiedBoot verified_boot_state;
1489 bool device_locked;
1490 vector<uint8_t> verified_boot_hash;
1491 error = parse_root_of_trust(attest_rec->data, attest_rec->length, &verified_boot_key,
1492 &verified_boot_state, &device_locked, &verified_boot_hash);
1493 EXPECT_EQ(ErrorCode::OK, error);
1494
1495 if (avb_verification_enabled()) {
1496 EXPECT_NE(property_get("ro.boot.vbmeta.digest", property_value, ""), 0);
1497 string prop_string(property_value);
1498 EXPECT_EQ(prop_string.size(), 64);
1499 EXPECT_EQ(prop_string, bin2hex(verified_boot_hash));
1500
1501 EXPECT_NE(property_get("ro.boot.vbmeta.device_state", property_value, ""), 0);
1502 if (!strcmp(property_value, "unlocked")) {
1503 EXPECT_FALSE(device_locked);
1504 } else {
1505 EXPECT_TRUE(device_locked);
1506 }
1507
1508 // Check that the device is locked if not debuggable, e.g., user build
1509 // images in CTS. For VTS, debuggable images are used to allow adb root
1510 // and the device is unlocked.
1511 if (!property_get_bool("ro.debuggable", false)) {
1512 EXPECT_TRUE(device_locked);
1513 } else {
1514 EXPECT_FALSE(device_locked);
1515 }
1516 }
1517
1518 // Verified boot key should be all 0's if the boot state is not verified or self signed
1519 std::string empty_boot_key(32, '\0');
1520 std::string verified_boot_key_str((const char*)verified_boot_key.data(),
1521 verified_boot_key.size());
1522 EXPECT_NE(property_get("ro.boot.verifiedbootstate", property_value, ""), 0);
1523 if (!strcmp(property_value, "green")) {
1524 EXPECT_EQ(verified_boot_state, VerifiedBoot::VERIFIED);
1525 EXPECT_NE(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1526 verified_boot_key.size()));
1527 } else if (!strcmp(property_value, "yellow")) {
1528 EXPECT_EQ(verified_boot_state, VerifiedBoot::SELF_SIGNED);
1529 EXPECT_NE(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1530 verified_boot_key.size()));
1531 } else if (!strcmp(property_value, "orange")) {
1532 EXPECT_EQ(verified_boot_state, VerifiedBoot::UNVERIFIED);
1533 EXPECT_EQ(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1534 verified_boot_key.size()));
1535 } else if (!strcmp(property_value, "red")) {
1536 EXPECT_EQ(verified_boot_state, VerifiedBoot::FAILED);
1537 } else {
1538 EXPECT_EQ(verified_boot_state, VerifiedBoot::UNVERIFIED);
1539 EXPECT_NE(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1540 verified_boot_key.size()));
1541 }
1542
1543 att_sw_enforced.Sort();
1544 expected_sw_enforced.Sort();
David Drysdale37af4b32021-05-14 16:46:59 +01001545 EXPECT_EQ(filtered_tags(expected_sw_enforced), filtered_tags(att_sw_enforced));
Shawn Willden7c130392020-12-21 09:58:22 -07001546
1547 att_hw_enforced.Sort();
1548 expected_hw_enforced.Sort();
1549 EXPECT_EQ(filtered_tags(expected_hw_enforced), filtered_tags(att_hw_enforced));
1550
David Drysdale565ccc72021-10-11 12:49:50 +01001551 if (unique_id != nullptr) {
1552 *unique_id = att_unique_id;
1553 }
1554
Shawn Willden7c130392020-12-21 09:58:22 -07001555 return true;
1556}
1557
1558string bin2hex(const vector<uint8_t>& data) {
1559 string retval;
1560 retval.reserve(data.size() * 2 + 1);
1561 for (uint8_t byte : data) {
1562 retval.push_back(nibble2hex[0x0F & (byte >> 4)]);
1563 retval.push_back(nibble2hex[0x0F & byte]);
1564 }
1565 return retval;
1566}
1567
David Drysdalef0d516d2021-03-22 07:51:43 +00001568AuthorizationSet HwEnforcedAuthorizations(const vector<KeyCharacteristics>& key_characteristics) {
1569 AuthorizationSet authList;
1570 for (auto& entry : key_characteristics) {
1571 if (entry.securityLevel == SecurityLevel::STRONGBOX ||
1572 entry.securityLevel == SecurityLevel::TRUSTED_ENVIRONMENT) {
1573 authList.push_back(AuthorizationSet(entry.authorizations));
1574 }
1575 }
1576 return authList;
1577}
1578
1579AuthorizationSet SwEnforcedAuthorizations(const vector<KeyCharacteristics>& key_characteristics) {
1580 AuthorizationSet authList;
1581 for (auto& entry : key_characteristics) {
1582 if (entry.securityLevel == SecurityLevel::SOFTWARE ||
1583 entry.securityLevel == SecurityLevel::KEYSTORE) {
1584 authList.push_back(AuthorizationSet(entry.authorizations));
1585 }
1586 }
1587 return authList;
1588}
1589
Eran Messeri03d7a1a2021-07-06 12:07:57 +01001590AssertionResult ChainSignaturesAreValid(const vector<Certificate>& chain,
1591 bool strict_issuer_check) {
Shawn Willden7c130392020-12-21 09:58:22 -07001592 std::stringstream cert_data;
1593
1594 for (size_t i = 0; i < chain.size(); ++i) {
1595 cert_data << bin2hex(chain[i].encodedCertificate) << std::endl;
1596
1597 X509_Ptr key_cert(parse_cert_blob(chain[i].encodedCertificate));
1598 X509_Ptr signing_cert;
1599 if (i < chain.size() - 1) {
1600 signing_cert = parse_cert_blob(chain[i + 1].encodedCertificate);
1601 } else {
1602 signing_cert = parse_cert_blob(chain[i].encodedCertificate);
1603 }
1604 if (!key_cert.get() || !signing_cert.get()) return AssertionFailure() << cert_data.str();
1605
1606 EVP_PKEY_Ptr signing_pubkey(X509_get_pubkey(signing_cert.get()));
1607 if (!signing_pubkey.get()) return AssertionFailure() << cert_data.str();
1608
1609 if (!X509_verify(key_cert.get(), signing_pubkey.get())) {
1610 return AssertionFailure()
1611 << "Verification of certificate " << i << " failed "
1612 << "OpenSSL error string: " << ERR_error_string(ERR_get_error(), NULL) << '\n'
1613 << cert_data.str();
1614 }
1615
1616 string cert_issuer = x509NameToStr(X509_get_issuer_name(key_cert.get()));
1617 string signer_subj = x509NameToStr(X509_get_subject_name(signing_cert.get()));
Eran Messeri03d7a1a2021-07-06 12:07:57 +01001618 if (cert_issuer != signer_subj && strict_issuer_check) {
Selene Huang8f9494c2021-04-21 15:10:36 -07001619 return AssertionFailure() << "Cert " << i << " has wrong issuer.\n"
1620 << " Signer subject is " << signer_subj
1621 << " Issuer subject is " << cert_issuer << endl
1622 << cert_data.str();
Shawn Willden7c130392020-12-21 09:58:22 -07001623 }
Shawn Willden7c130392020-12-21 09:58:22 -07001624 }
1625
1626 if (KeyMintAidlTestBase::dump_Attestations) std::cout << cert_data.str();
1627 return AssertionSuccess();
1628}
1629
1630X509_Ptr parse_cert_blob(const vector<uint8_t>& blob) {
1631 const uint8_t* p = blob.data();
1632 return X509_Ptr(d2i_X509(nullptr /* allocate new */, &p, blob.size()));
1633}
1634
David Drysdalef0d516d2021-03-22 07:51:43 +00001635vector<uint8_t> make_name_from_str(const string& name) {
1636 X509_NAME_Ptr x509_name(X509_NAME_new());
1637 EXPECT_TRUE(x509_name.get() != nullptr);
1638 if (!x509_name) return {};
1639
1640 EXPECT_EQ(1, X509_NAME_add_entry_by_txt(x509_name.get(), //
1641 "CN", //
1642 MBSTRING_ASC,
1643 reinterpret_cast<const uint8_t*>(name.c_str()),
1644 -1, // len
1645 -1, // loc
1646 0 /* set */));
1647
1648 int len = i2d_X509_NAME(x509_name.get(), nullptr /* only return length */);
1649 EXPECT_GT(len, 0);
1650
1651 vector<uint8_t> retval(len);
1652 uint8_t* p = retval.data();
1653 i2d_X509_NAME(x509_name.get(), &p);
1654
1655 return retval;
1656}
1657
David Drysdale4dc01072021-04-01 12:17:35 +01001658namespace {
1659
1660void check_cose_key(const vector<uint8_t>& data, bool testMode) {
1661 auto [parsedPayload, __, payloadParseErr] = cppbor::parse(data);
1662 ASSERT_TRUE(parsedPayload) << "Key parse failed: " << payloadParseErr;
1663
1664 // The following check assumes that canonical CBOR encoding is used for the COSE_Key.
1665 if (testMode) {
1666 EXPECT_THAT(cppbor::prettyPrint(parsedPayload.get()),
1667 MatchesRegex("{\n"
1668 " 1 : 2,\n" // kty: EC2
1669 " 3 : -7,\n" // alg: ES256
1670 " -1 : 1,\n" // EC id: P256
1671 // The regex {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}} matches a
1672 // sequence of 32 hexadecimal bytes, enclosed in braces and
1673 // separated by commas. In this case, some Ed25519 public key.
1674 " -2 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_x: data
1675 " -3 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_y: data
1676 " -70000 : null,\n" // test marker
1677 "}"));
1678 } else {
1679 EXPECT_THAT(cppbor::prettyPrint(parsedPayload.get()),
1680 MatchesRegex("{\n"
1681 " 1 : 2,\n" // kty: EC2
1682 " 3 : -7,\n" // alg: ES256
1683 " -1 : 1,\n" // EC id: P256
1684 // The regex {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}} matches a
1685 // sequence of 32 hexadecimal bytes, enclosed in braces and
1686 // separated by commas. In this case, some Ed25519 public key.
1687 " -2 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_x: data
1688 " -3 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_y: data
1689 "}"));
1690 }
1691}
1692
1693} // namespace
1694
1695void check_maced_pubkey(const MacedPublicKey& macedPubKey, bool testMode,
1696 vector<uint8_t>* payload_value) {
1697 auto [coseMac0, _, mac0ParseErr] = cppbor::parse(macedPubKey.macedKey);
1698 ASSERT_TRUE(coseMac0) << "COSE Mac0 parse failed " << mac0ParseErr;
1699
1700 ASSERT_NE(coseMac0->asArray(), nullptr);
1701 ASSERT_EQ(coseMac0->asArray()->size(), kCoseMac0EntryCount);
1702
1703 auto protParms = coseMac0->asArray()->get(kCoseMac0ProtectedParams)->asBstr();
1704 ASSERT_NE(protParms, nullptr);
1705
1706 // Header label:value of 'alg': HMAC-256
1707 ASSERT_EQ(cppbor::prettyPrint(protParms->value()), "{\n 1 : 5,\n}");
1708
1709 auto unprotParms = coseMac0->asArray()->get(kCoseMac0UnprotectedParams)->asMap();
1710 ASSERT_NE(unprotParms, nullptr);
1711 ASSERT_EQ(unprotParms->size(), 0);
1712
1713 // The payload is a bstr holding an encoded COSE_Key
1714 auto payload = coseMac0->asArray()->get(kCoseMac0Payload)->asBstr();
1715 ASSERT_NE(payload, nullptr);
1716 check_cose_key(payload->value(), testMode);
1717
1718 auto coseMac0Tag = coseMac0->asArray()->get(kCoseMac0Tag)->asBstr();
1719 ASSERT_TRUE(coseMac0Tag);
1720 auto extractedTag = coseMac0Tag->value();
1721 EXPECT_EQ(extractedTag.size(), 32U);
1722
1723 // Compare with tag generated with kTestMacKey. Should only match in test mode
Seth Moore026bb742021-04-30 11:41:18 -07001724 auto macFunction = [](const cppcose::bytevec& input) {
1725 return cppcose::generateHmacSha256(remote_prov::kTestMacKey, input);
1726 };
1727 auto testTag =
1728 cppcose::generateCoseMac0Mac(macFunction, {} /* external_aad */, payload->value());
David Drysdale4dc01072021-04-01 12:17:35 +01001729 ASSERT_TRUE(testTag) << "Tag calculation failed: " << testTag.message();
1730
1731 if (testMode) {
Seth Moore026bb742021-04-30 11:41:18 -07001732 EXPECT_THAT(*testTag, ElementsAreArray(extractedTag));
David Drysdale4dc01072021-04-01 12:17:35 +01001733 } else {
Seth Moore026bb742021-04-30 11:41:18 -07001734 EXPECT_THAT(*testTag, Not(ElementsAreArray(extractedTag)));
David Drysdale4dc01072021-04-01 12:17:35 +01001735 }
1736 if (payload_value != nullptr) {
1737 *payload_value = payload->value();
1738 }
1739}
1740
1741void p256_pub_key(const vector<uint8_t>& coseKeyData, EVP_PKEY_Ptr* signingKey) {
1742 // Extract x and y affine coordinates from the encoded Cose_Key.
1743 auto [parsedPayload, __, payloadParseErr] = cppbor::parse(coseKeyData);
1744 ASSERT_TRUE(parsedPayload) << "Key parse failed: " << payloadParseErr;
1745 auto coseKey = parsedPayload->asMap();
1746 const std::unique_ptr<cppbor::Item>& xItem = coseKey->get(cppcose::CoseKey::PUBKEY_X);
1747 ASSERT_NE(xItem->asBstr(), nullptr);
1748 vector<uint8_t> x = xItem->asBstr()->value();
1749 const std::unique_ptr<cppbor::Item>& yItem = coseKey->get(cppcose::CoseKey::PUBKEY_Y);
1750 ASSERT_NE(yItem->asBstr(), nullptr);
1751 vector<uint8_t> y = yItem->asBstr()->value();
1752
1753 // Concatenate: 0x04 (uncompressed form marker) | x | y
1754 vector<uint8_t> pubKeyData{0x04};
1755 pubKeyData.insert(pubKeyData.end(), x.begin(), x.end());
1756 pubKeyData.insert(pubKeyData.end(), y.begin(), y.end());
1757
1758 EC_KEY_Ptr ecKey = EC_KEY_Ptr(EC_KEY_new());
1759 ASSERT_NE(ecKey, nullptr);
1760 EC_GROUP_Ptr group = EC_GROUP_Ptr(EC_GROUP_new_by_curve_name(NID_X9_62_prime256v1));
1761 ASSERT_NE(group, nullptr);
1762 ASSERT_EQ(EC_KEY_set_group(ecKey.get(), group.get()), 1);
1763 EC_POINT_Ptr point = EC_POINT_Ptr(EC_POINT_new(group.get()));
1764 ASSERT_NE(point, nullptr);
1765 ASSERT_EQ(EC_POINT_oct2point(group.get(), point.get(), pubKeyData.data(), pubKeyData.size(),
1766 nullptr),
1767 1);
1768 ASSERT_EQ(EC_KEY_set_public_key(ecKey.get(), point.get()), 1);
1769
1770 EVP_PKEY_Ptr pubKey = EVP_PKEY_Ptr(EVP_PKEY_new());
1771 ASSERT_NE(pubKey, nullptr);
1772 EVP_PKEY_assign_EC_KEY(pubKey.get(), ecKey.release());
1773 *signingKey = std::move(pubKey);
1774}
1775
Selene Huang31ab4042020-04-29 04:22:39 -07001776} // namespace test
Shawn Willden08a7e432020-12-11 13:05:27 +00001777
Janis Danisevskis24c04702020-12-16 18:28:39 -08001778} // namespace aidl::android::hardware::security::keymint