blob: 4ab989bcbcb7b3e1195f0138f56ebe90b2ea9f78 [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
anil.hiranniah19a4ca12022-03-03 17:39:30 +0530668void KeyMintAidlTestBase::CheckAesIncrementalEncryptOperation(BlockMode block_mode,
669 int message_size) {
David Drysdale1a637192022-03-14 09:11:29 +0000670 auto builder = AuthorizationSetBuilder()
671 .Authorization(TAG_NO_AUTH_REQUIRED)
672 .AesEncryptionKey(128)
673 .BlockMode(block_mode)
674 .Padding(PaddingMode::NONE);
675 if (block_mode == BlockMode::GCM) {
676 builder.Authorization(TAG_MIN_MAC_LENGTH, 128);
677 }
678 ASSERT_EQ(ErrorCode::OK, GenerateKey(builder));
anil.hiranniah19a4ca12022-03-03 17:39:30 +0530679
680 for (int increment = 1; increment <= message_size; ++increment) {
681 string message(message_size, 'a');
682 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(PaddingMode::NONE);
683 if (block_mode == BlockMode::GCM) {
684 params.Authorization(TAG_MAC_LENGTH, 128) /* for GCM */;
685 }
686
687 AuthorizationSet output_params;
688 EXPECT_EQ(ErrorCode::OK, Begin(KeyPurpose::ENCRYPT, params, &output_params));
689
690 string ciphertext;
691 string to_send;
692 for (size_t i = 0; i < message.size(); i += increment) {
693 EXPECT_EQ(ErrorCode::OK, Update(message.substr(i, increment), &ciphertext));
694 }
695 EXPECT_EQ(ErrorCode::OK, Finish(to_send, &ciphertext))
696 << "Error sending " << to_send << " with block mode " << block_mode;
697
698 switch (block_mode) {
699 case BlockMode::GCM:
700 EXPECT_EQ(message.size() + 16, ciphertext.size());
701 break;
702 case BlockMode::CTR:
703 EXPECT_EQ(message.size(), ciphertext.size());
704 break;
705 case BlockMode::CBC:
706 case BlockMode::ECB:
707 EXPECT_EQ(message.size() + message.size() % 16, ciphertext.size());
708 break;
709 }
710
711 auto iv = output_params.GetTagValue(TAG_NONCE);
712 switch (block_mode) {
713 case BlockMode::CBC:
714 case BlockMode::GCM:
715 case BlockMode::CTR:
716 ASSERT_TRUE(iv) << "No IV for block mode " << block_mode;
717 EXPECT_EQ(block_mode == BlockMode::GCM ? 12U : 16U, iv->get().size());
718 params.push_back(TAG_NONCE, iv->get());
719 break;
720
721 case BlockMode::ECB:
722 EXPECT_FALSE(iv) << "ECB mode should not generate IV";
723 break;
724 }
725
726 EXPECT_EQ(ErrorCode::OK, Begin(KeyPurpose::DECRYPT, params))
727 << "Decrypt begin() failed for block mode " << block_mode;
728
729 string plaintext;
730 for (size_t i = 0; i < ciphertext.size(); i += increment) {
731 EXPECT_EQ(ErrorCode::OK, Update(ciphertext.substr(i, increment), &plaintext));
732 }
733 ErrorCode error = Finish(to_send, &plaintext);
734 ASSERT_EQ(ErrorCode::OK, error) << "Decryption failed for block mode " << block_mode
735 << " and increment " << increment;
736 if (error == ErrorCode::OK) {
737 ASSERT_EQ(message, plaintext) << "Decryption didn't match for block mode " << block_mode
738 << " and increment " << increment;
739 }
740 }
741}
742
Selene Huang31ab4042020-04-29 04:22:39 -0700743void KeyMintAidlTestBase::CheckHmacTestVector(const string& key, const string& message,
744 Digest digest, const string& expected_mac) {
745 SCOPED_TRACE("CheckHmacTestVector");
746 ASSERT_EQ(ErrorCode::OK,
747 ImportKey(AuthorizationSetBuilder()
748 .Authorization(TAG_NO_AUTH_REQUIRED)
749 .HmacKey(key.size() * 8)
750 .Authorization(TAG_MIN_MAC_LENGTH, expected_mac.size() * 8)
751 .Digest(digest),
752 KeyFormat::RAW, key));
753 string signature = MacMessage(message, digest, expected_mac.size() * 8);
754 EXPECT_EQ(expected_mac, signature)
755 << "Test vector didn't match for key of size " << key.size() << " message of size "
756 << message.size() << " and digest " << digest;
757 CheckedDeleteKey();
758}
759
760void KeyMintAidlTestBase::CheckAesCtrTestVector(const string& key, const string& nonce,
761 const string& message,
762 const string& expected_ciphertext) {
763 SCOPED_TRACE("CheckAesCtrTestVector");
764 ASSERT_EQ(ErrorCode::OK, ImportKey(AuthorizationSetBuilder()
765 .Authorization(TAG_NO_AUTH_REQUIRED)
766 .AesEncryptionKey(key.size() * 8)
767 .BlockMode(BlockMode::CTR)
768 .Authorization(TAG_CALLER_NONCE)
769 .Padding(PaddingMode::NONE),
770 KeyFormat::RAW, key));
771
772 auto params = AuthorizationSetBuilder()
773 .Authorization(TAG_NONCE, nonce.data(), nonce.size())
774 .BlockMode(BlockMode::CTR)
775 .Padding(PaddingMode::NONE);
776 AuthorizationSet out_params;
777 string ciphertext = EncryptMessage(key_blob_, message, params, &out_params);
778 EXPECT_EQ(expected_ciphertext, ciphertext);
779}
780
781void KeyMintAidlTestBase::CheckTripleDesTestVector(KeyPurpose purpose, BlockMode block_mode,
782 PaddingMode padding_mode, const string& key,
783 const string& iv, const string& input,
784 const string& expected_output) {
785 auto authset = AuthorizationSetBuilder()
786 .TripleDesEncryptionKey(key.size() * 7)
787 .BlockMode(block_mode)
788 .Authorization(TAG_NO_AUTH_REQUIRED)
789 .Padding(padding_mode);
790 if (iv.size()) authset.Authorization(TAG_CALLER_NONCE);
791 ASSERT_EQ(ErrorCode::OK, ImportKey(authset, KeyFormat::RAW, key));
792 ASSERT_GT(key_blob_.size(), 0U);
793
794 auto begin_params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding_mode);
795 if (iv.size()) begin_params.Authorization(TAG_NONCE, iv.data(), iv.size());
796 AuthorizationSet output_params;
797 string output = ProcessMessage(key_blob_, purpose, input, begin_params, &output_params);
798 EXPECT_EQ(expected_output, output);
799}
800
801void KeyMintAidlTestBase::VerifyMessage(const vector<uint8_t>& key_blob, const string& message,
802 const string& signature, const AuthorizationSet& params) {
803 SCOPED_TRACE("VerifyMessage");
804 AuthorizationSet begin_out_params;
805 ASSERT_EQ(ErrorCode::OK, Begin(KeyPurpose::VERIFY, key_blob, params, &begin_out_params));
806
807 string output;
Shawn Willden92d79c02021-02-19 07:31:55 -0700808 EXPECT_EQ(ErrorCode::OK, Finish(message, signature, &output));
Selene Huang31ab4042020-04-29 04:22:39 -0700809 EXPECT_TRUE(output.empty());
Shawn Willden92d79c02021-02-19 07:31:55 -0700810 op_ = {};
Selene Huang31ab4042020-04-29 04:22:39 -0700811}
812
813void KeyMintAidlTestBase::VerifyMessage(const string& message, const string& signature,
814 const AuthorizationSet& params) {
815 SCOPED_TRACE("VerifyMessage");
816 VerifyMessage(key_blob_, message, signature, params);
817}
818
David Drysdaledf8f52e2021-05-06 08:10:58 +0100819void KeyMintAidlTestBase::LocalVerifyMessage(const string& message, const string& signature,
820 const AuthorizationSet& params) {
821 SCOPED_TRACE("LocalVerifyMessage");
822
823 // Retrieve the public key from the leaf certificate.
824 ASSERT_GT(cert_chain_.size(), 0);
825 X509_Ptr key_cert(parse_cert_blob(cert_chain_[0].encodedCertificate));
826 ASSERT_TRUE(key_cert.get());
827 EVP_PKEY_Ptr pub_key(X509_get_pubkey(key_cert.get()));
828 ASSERT_TRUE(pub_key.get());
829
830 Digest digest = params.GetTagValue(TAG_DIGEST).value();
831 PaddingMode padding = PaddingMode::NONE;
832 auto tag = params.GetTagValue(TAG_PADDING);
833 if (tag.has_value()) {
834 padding = tag.value();
835 }
836
837 if (digest == Digest::NONE) {
838 switch (EVP_PKEY_id(pub_key.get())) {
David Drysdale42fe1892021-10-14 14:43:46 +0100839 case EVP_PKEY_ED25519: {
840 ASSERT_EQ(64, signature.size());
841 uint8_t pub_keydata[32];
842 size_t pub_len = sizeof(pub_keydata);
843 ASSERT_EQ(1, EVP_PKEY_get_raw_public_key(pub_key.get(), pub_keydata, &pub_len));
844 ASSERT_EQ(sizeof(pub_keydata), pub_len);
845 ASSERT_EQ(1, ED25519_verify(reinterpret_cast<const uint8_t*>(message.data()),
846 message.size(),
847 reinterpret_cast<const uint8_t*>(signature.data()),
848 pub_keydata));
849 break;
850 }
851
David Drysdaledf8f52e2021-05-06 08:10:58 +0100852 case EVP_PKEY_EC: {
853 vector<uint8_t> data((EVP_PKEY_bits(pub_key.get()) + 7) / 8);
854 size_t data_size = std::min(data.size(), message.size());
855 memcpy(data.data(), message.data(), data_size);
856 EC_KEY_Ptr ecdsa(EVP_PKEY_get1_EC_KEY(pub_key.get()));
857 ASSERT_TRUE(ecdsa.get());
858 ASSERT_EQ(1,
859 ECDSA_verify(0, reinterpret_cast<const uint8_t*>(data.data()), data_size,
860 reinterpret_cast<const uint8_t*>(signature.data()),
861 signature.size(), ecdsa.get()));
862 break;
863 }
864 case EVP_PKEY_RSA: {
865 vector<uint8_t> data(EVP_PKEY_size(pub_key.get()));
866 size_t data_size = std::min(data.size(), message.size());
867 memcpy(data.data(), message.data(), data_size);
868
869 RSA_Ptr rsa(EVP_PKEY_get1_RSA(const_cast<EVP_PKEY*>(pub_key.get())));
870 ASSERT_TRUE(rsa.get());
871
872 size_t key_len = RSA_size(rsa.get());
873 int openssl_padding = RSA_NO_PADDING;
874 switch (padding) {
875 case PaddingMode::NONE:
876 ASSERT_TRUE(data_size <= key_len);
877 ASSERT_EQ(key_len, signature.size());
878 openssl_padding = RSA_NO_PADDING;
879 break;
880 case PaddingMode::RSA_PKCS1_1_5_SIGN:
881 ASSERT_TRUE(data_size + kPkcs1UndigestedSignaturePaddingOverhead <=
882 key_len);
883 openssl_padding = RSA_PKCS1_PADDING;
884 break;
885 default:
886 ADD_FAILURE() << "Unsupported RSA padding mode " << padding;
887 }
888
889 vector<uint8_t> decrypted_data(key_len);
890 int bytes_decrypted = RSA_public_decrypt(
891 signature.size(), reinterpret_cast<const uint8_t*>(signature.data()),
892 decrypted_data.data(), rsa.get(), openssl_padding);
893 ASSERT_GE(bytes_decrypted, 0);
894
895 const uint8_t* compare_pos = decrypted_data.data();
896 size_t bytes_to_compare = bytes_decrypted;
897 uint8_t zero_check_result = 0;
898 if (padding == PaddingMode::NONE && data_size < bytes_to_compare) {
899 // If the data is short, for "unpadded" signing we zero-pad to the left. So
900 // during verification we should have zeros on the left of the decrypted data.
901 // Do a constant-time check.
902 const uint8_t* zero_end = compare_pos + bytes_to_compare - data_size;
903 while (compare_pos < zero_end) zero_check_result |= *compare_pos++;
904 ASSERT_EQ(0, zero_check_result);
905 bytes_to_compare = data_size;
906 }
907 ASSERT_EQ(0, memcmp(compare_pos, data.data(), bytes_to_compare));
908 break;
909 }
910 default:
911 ADD_FAILURE() << "Unknown public key type";
912 }
913 } else {
914 EVP_MD_CTX digest_ctx;
915 EVP_MD_CTX_init(&digest_ctx);
916 EVP_PKEY_CTX* pkey_ctx;
917 const EVP_MD* md = openssl_digest(digest);
918 ASSERT_NE(md, nullptr);
919 ASSERT_EQ(1, EVP_DigestVerifyInit(&digest_ctx, &pkey_ctx, md, nullptr, pub_key.get()));
920
921 if (padding == PaddingMode::RSA_PSS) {
922 EXPECT_GT(EVP_PKEY_CTX_set_rsa_padding(pkey_ctx, RSA_PKCS1_PSS_PADDING), 0);
923 EXPECT_GT(EVP_PKEY_CTX_set_rsa_pss_saltlen(pkey_ctx, EVP_MD_size(md)), 0);
David Drysdalec6b89072021-12-14 14:32:51 +0000924 EXPECT_GT(EVP_PKEY_CTX_set_rsa_mgf1_md(pkey_ctx, md), 0);
David Drysdaledf8f52e2021-05-06 08:10:58 +0100925 }
926
927 ASSERT_EQ(1, EVP_DigestVerifyUpdate(&digest_ctx,
928 reinterpret_cast<const uint8_t*>(message.data()),
929 message.size()));
930 ASSERT_EQ(1, EVP_DigestVerifyFinal(&digest_ctx,
931 reinterpret_cast<const uint8_t*>(signature.data()),
932 signature.size()));
933 EVP_MD_CTX_cleanup(&digest_ctx);
934 }
935}
936
David Drysdale59cae642021-05-12 13:52:03 +0100937string KeyMintAidlTestBase::LocalRsaEncryptMessage(const string& message,
938 const AuthorizationSet& params) {
939 SCOPED_TRACE("LocalRsaEncryptMessage");
940
941 // Retrieve the public key from the leaf certificate.
942 if (cert_chain_.empty()) {
943 ADD_FAILURE() << "No public key available";
944 return "Failure";
945 }
946 X509_Ptr key_cert(parse_cert_blob(cert_chain_[0].encodedCertificate));
947 EVP_PKEY_Ptr pub_key(X509_get_pubkey(key_cert.get()));
948 RSA_Ptr rsa(EVP_PKEY_get1_RSA(const_cast<EVP_PKEY*>(pub_key.get())));
949
950 // Retrieve relevant tags.
951 Digest digest = Digest::NONE;
952 Digest mgf_digest = Digest::NONE;
953 PaddingMode padding = PaddingMode::NONE;
954
955 auto digest_tag = params.GetTagValue(TAG_DIGEST);
956 if (digest_tag.has_value()) digest = digest_tag.value();
957 auto pad_tag = params.GetTagValue(TAG_PADDING);
958 if (pad_tag.has_value()) padding = pad_tag.value();
959 auto mgf_tag = params.GetTagValue(TAG_RSA_OAEP_MGF_DIGEST);
960 if (mgf_tag.has_value()) mgf_digest = mgf_tag.value();
961
962 const EVP_MD* md = openssl_digest(digest);
963 const EVP_MD* mgf_md = openssl_digest(mgf_digest);
964
965 // Set up encryption context.
966 EVP_PKEY_CTX_Ptr ctx(EVP_PKEY_CTX_new(pub_key.get(), /* engine= */ nullptr));
967 if (EVP_PKEY_encrypt_init(ctx.get()) <= 0) {
968 ADD_FAILURE() << "Encryption init failed: " << ERR_peek_last_error();
969 return "Failure";
970 }
971
972 int rc = -1;
973 switch (padding) {
974 case PaddingMode::NONE:
975 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_NO_PADDING);
976 break;
977 case PaddingMode::RSA_PKCS1_1_5_ENCRYPT:
978 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_PKCS1_PADDING);
979 break;
980 case PaddingMode::RSA_OAEP:
981 rc = EVP_PKEY_CTX_set_rsa_padding(ctx.get(), RSA_PKCS1_OAEP_PADDING);
982 break;
983 default:
984 break;
985 }
986 if (rc <= 0) {
987 ADD_FAILURE() << "Set padding failed: " << ERR_peek_last_error();
988 return "Failure";
989 }
990 if (padding == PaddingMode::RSA_OAEP) {
991 if (!EVP_PKEY_CTX_set_rsa_oaep_md(ctx.get(), md)) {
992 ADD_FAILURE() << "Set digest failed: " << ERR_peek_last_error();
993 return "Failure";
994 }
995 if (!EVP_PKEY_CTX_set_rsa_mgf1_md(ctx.get(), mgf_md)) {
996 ADD_FAILURE() << "Set MGF digest failed: " << ERR_peek_last_error();
997 return "Failure";
998 }
999 }
1000
1001 // Determine output size.
1002 size_t outlen;
1003 if (EVP_PKEY_encrypt(ctx.get(), nullptr /* out */, &outlen,
1004 reinterpret_cast<const uint8_t*>(message.data()), message.size()) <= 0) {
1005 ADD_FAILURE() << "Determine output size failed: " << ERR_peek_last_error();
1006 return "Failure";
1007 }
1008
1009 // Left-zero-pad the input if necessary.
1010 const uint8_t* to_encrypt = reinterpret_cast<const uint8_t*>(message.data());
1011 size_t to_encrypt_len = message.size();
1012
1013 std::unique_ptr<string> zero_padded_message;
1014 if (padding == PaddingMode::NONE && to_encrypt_len < outlen) {
1015 zero_padded_message.reset(new string(outlen, '\0'));
1016 memcpy(zero_padded_message->data() + (outlen - to_encrypt_len), message.data(),
1017 message.size());
1018 to_encrypt = reinterpret_cast<const uint8_t*>(zero_padded_message->data());
1019 to_encrypt_len = outlen;
1020 }
1021
1022 // Do the encryption.
1023 string output(outlen, '\0');
1024 if (EVP_PKEY_encrypt(ctx.get(), reinterpret_cast<uint8_t*>(output.data()), &outlen, to_encrypt,
1025 to_encrypt_len) <= 0) {
1026 ADD_FAILURE() << "Encryption failed: " << ERR_peek_last_error();
1027 return "Failure";
1028 }
1029 return output;
1030}
1031
Selene Huang31ab4042020-04-29 04:22:39 -07001032string KeyMintAidlTestBase::EncryptMessage(const vector<uint8_t>& key_blob, const string& message,
1033 const AuthorizationSet& in_params,
1034 AuthorizationSet* out_params) {
1035 SCOPED_TRACE("EncryptMessage");
1036 return ProcessMessage(key_blob, KeyPurpose::ENCRYPT, message, in_params, out_params);
1037}
1038
1039string KeyMintAidlTestBase::EncryptMessage(const string& message, const AuthorizationSet& params,
1040 AuthorizationSet* out_params) {
1041 SCOPED_TRACE("EncryptMessage");
1042 return EncryptMessage(key_blob_, message, params, out_params);
1043}
1044
1045string KeyMintAidlTestBase::EncryptMessage(const string& message, const AuthorizationSet& params) {
1046 SCOPED_TRACE("EncryptMessage");
1047 AuthorizationSet out_params;
1048 string ciphertext = EncryptMessage(message, params, &out_params);
1049 EXPECT_TRUE(out_params.empty()) << "Output params should be empty. Contained: " << out_params;
1050 return ciphertext;
1051}
1052
1053string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1054 PaddingMode padding) {
1055 SCOPED_TRACE("EncryptMessage");
1056 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding);
1057 AuthorizationSet out_params;
1058 string ciphertext = EncryptMessage(message, params, &out_params);
1059 EXPECT_TRUE(out_params.empty()) << "Output params should be empty. Contained: " << out_params;
1060 return ciphertext;
1061}
1062
1063string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1064 PaddingMode padding, vector<uint8_t>* iv_out) {
1065 SCOPED_TRACE("EncryptMessage");
1066 auto params = AuthorizationSetBuilder().BlockMode(block_mode).Padding(padding);
1067 AuthorizationSet out_params;
1068 string ciphertext = EncryptMessage(message, params, &out_params);
1069 EXPECT_EQ(1U, out_params.size());
1070 auto ivVal = out_params.GetTagValue(TAG_NONCE);
Janis Danisevskis5ba09332020-12-17 10:05:15 -08001071 EXPECT_TRUE(ivVal);
1072 if (ivVal) *iv_out = *ivVal;
Selene Huang31ab4042020-04-29 04:22:39 -07001073 return ciphertext;
1074}
1075
1076string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1077 PaddingMode padding, const vector<uint8_t>& iv_in) {
1078 SCOPED_TRACE("EncryptMessage");
1079 auto params = AuthorizationSetBuilder()
1080 .BlockMode(block_mode)
1081 .Padding(padding)
1082 .Authorization(TAG_NONCE, iv_in);
1083 AuthorizationSet out_params;
1084 string ciphertext = EncryptMessage(message, params, &out_params);
1085 return ciphertext;
1086}
1087
1088string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1089 PaddingMode padding, uint8_t mac_length_bits,
1090 const vector<uint8_t>& iv_in) {
1091 SCOPED_TRACE("EncryptMessage");
1092 auto params = AuthorizationSetBuilder()
1093 .BlockMode(block_mode)
1094 .Padding(padding)
1095 .Authorization(TAG_MAC_LENGTH, mac_length_bits)
1096 .Authorization(TAG_NONCE, iv_in);
1097 AuthorizationSet out_params;
1098 string ciphertext = EncryptMessage(message, params, &out_params);
1099 return ciphertext;
1100}
1101
David Drysdaled2cc8c22021-04-15 13:29:45 +01001102string KeyMintAidlTestBase::EncryptMessage(const string& message, BlockMode block_mode,
1103 PaddingMode padding, uint8_t mac_length_bits) {
1104 SCOPED_TRACE("EncryptMessage");
1105 auto params = AuthorizationSetBuilder()
1106 .BlockMode(block_mode)
1107 .Padding(padding)
1108 .Authorization(TAG_MAC_LENGTH, mac_length_bits);
1109 AuthorizationSet out_params;
1110 string ciphertext = EncryptMessage(message, params, &out_params);
1111 return ciphertext;
1112}
1113
Selene Huang31ab4042020-04-29 04:22:39 -07001114string KeyMintAidlTestBase::DecryptMessage(const vector<uint8_t>& key_blob,
1115 const string& ciphertext,
1116 const AuthorizationSet& params) {
1117 SCOPED_TRACE("DecryptMessage");
1118 AuthorizationSet out_params;
1119 string plaintext =
1120 ProcessMessage(key_blob, KeyPurpose::DECRYPT, ciphertext, params, &out_params);
1121 EXPECT_TRUE(out_params.empty());
1122 return plaintext;
1123}
1124
1125string KeyMintAidlTestBase::DecryptMessage(const string& ciphertext,
1126 const AuthorizationSet& params) {
1127 SCOPED_TRACE("DecryptMessage");
1128 return DecryptMessage(key_blob_, ciphertext, params);
1129}
1130
1131string KeyMintAidlTestBase::DecryptMessage(const string& ciphertext, BlockMode block_mode,
1132 PaddingMode padding_mode, const vector<uint8_t>& iv) {
1133 SCOPED_TRACE("DecryptMessage");
1134 auto params = AuthorizationSetBuilder()
1135 .BlockMode(block_mode)
1136 .Padding(padding_mode)
1137 .Authorization(TAG_NONCE, iv);
1138 return DecryptMessage(key_blob_, ciphertext, params);
1139}
1140
1141std::pair<ErrorCode, vector<uint8_t>> KeyMintAidlTestBase::UpgradeKey(
1142 const vector<uint8_t>& key_blob) {
1143 std::pair<ErrorCode, vector<uint8_t>> retval;
1144 vector<uint8_t> outKeyBlob;
1145 Status result = keymint_->upgradeKey(key_blob, vector<KeyParameter>(), &outKeyBlob);
1146 ErrorCode errorcode = GetReturnErrorCode(result);
1147 retval = std::tie(errorcode, outKeyBlob);
1148
1149 return retval;
1150}
1151vector<uint32_t> KeyMintAidlTestBase::ValidKeySizes(Algorithm algorithm) {
1152 switch (algorithm) {
1153 case Algorithm::RSA:
1154 switch (SecLevel()) {
1155 case SecurityLevel::SOFTWARE:
1156 case SecurityLevel::TRUSTED_ENVIRONMENT:
1157 return {2048, 3072, 4096};
1158 case SecurityLevel::STRONGBOX:
1159 return {2048};
1160 default:
1161 ADD_FAILURE() << "Invalid security level " << uint32_t(SecLevel());
1162 break;
1163 }
1164 break;
1165 case Algorithm::EC:
David Drysdaledf09e542021-06-08 15:46:11 +01001166 ADD_FAILURE() << "EC keys must be specified by curve not size";
Selene Huang31ab4042020-04-29 04:22:39 -07001167 break;
1168 case Algorithm::AES:
1169 return {128, 256};
1170 case Algorithm::TRIPLE_DES:
1171 return {168};
1172 case Algorithm::HMAC: {
1173 vector<uint32_t> retval((512 - 64) / 8 + 1);
1174 uint32_t size = 64 - 8;
1175 std::generate(retval.begin(), retval.end(), [&]() { return (size += 8); });
1176 return retval;
1177 }
1178 default:
1179 ADD_FAILURE() << "Invalid Algorithm: " << algorithm;
1180 return {};
1181 }
1182 ADD_FAILURE() << "Should be impossible to get here";
1183 return {};
1184}
1185
1186vector<uint32_t> KeyMintAidlTestBase::InvalidKeySizes(Algorithm algorithm) {
1187 if (SecLevel() == SecurityLevel::STRONGBOX) {
1188 switch (algorithm) {
1189 case Algorithm::RSA:
1190 return {3072, 4096};
1191 case Algorithm::EC:
1192 return {224, 384, 521};
1193 case Algorithm::AES:
1194 return {192};
David Drysdale7de9feb2021-03-05 14:56:19 +00001195 case Algorithm::TRIPLE_DES:
1196 return {56};
1197 default:
1198 return {};
1199 }
1200 } else {
1201 switch (algorithm) {
Prashant Patild72b3512021-11-16 08:19:19 +00001202 case Algorithm::AES:
1203 return {64, 96, 131, 512};
David Drysdale7de9feb2021-03-05 14:56:19 +00001204 case Algorithm::TRIPLE_DES:
1205 return {56};
Selene Huang31ab4042020-04-29 04:22:39 -07001206 default:
1207 return {};
1208 }
1209 }
1210 return {};
1211}
1212
David Drysdale7de9feb2021-03-05 14:56:19 +00001213vector<BlockMode> KeyMintAidlTestBase::ValidBlockModes(Algorithm algorithm) {
1214 switch (algorithm) {
1215 case Algorithm::AES:
1216 return {
1217 BlockMode::CBC,
1218 BlockMode::CTR,
1219 BlockMode::ECB,
1220 BlockMode::GCM,
1221 };
1222 case Algorithm::TRIPLE_DES:
1223 return {
1224 BlockMode::CBC,
1225 BlockMode::ECB,
1226 };
1227 default:
1228 return {};
1229 }
1230}
1231
1232vector<PaddingMode> KeyMintAidlTestBase::ValidPaddingModes(Algorithm algorithm,
1233 BlockMode blockMode) {
1234 switch (algorithm) {
1235 case Algorithm::AES:
1236 switch (blockMode) {
1237 case BlockMode::CBC:
1238 case BlockMode::ECB:
1239 return {PaddingMode::NONE, PaddingMode::PKCS7};
1240 case BlockMode::CTR:
1241 case BlockMode::GCM:
1242 return {PaddingMode::NONE};
1243 default:
1244 return {};
1245 };
1246 case Algorithm::TRIPLE_DES:
1247 switch (blockMode) {
1248 case BlockMode::CBC:
1249 case BlockMode::ECB:
1250 return {PaddingMode::NONE, PaddingMode::PKCS7};
1251 default:
1252 return {};
1253 };
1254 default:
1255 return {};
1256 }
1257}
1258
1259vector<PaddingMode> KeyMintAidlTestBase::InvalidPaddingModes(Algorithm algorithm,
1260 BlockMode blockMode) {
1261 switch (algorithm) {
1262 case Algorithm::AES:
1263 switch (blockMode) {
1264 case BlockMode::CTR:
1265 case BlockMode::GCM:
1266 return {PaddingMode::PKCS7};
1267 default:
1268 return {};
1269 };
1270 default:
1271 return {};
1272 }
1273}
1274
Selene Huang31ab4042020-04-29 04:22:39 -07001275vector<EcCurve> KeyMintAidlTestBase::ValidCurves() {
1276 if (securityLevel_ == SecurityLevel::STRONGBOX) {
1277 return {EcCurve::P_256};
David Drysdale42fe1892021-10-14 14:43:46 +01001278 } else if (Curve25519Supported()) {
1279 return {EcCurve::P_224, EcCurve::P_256, EcCurve::P_384, EcCurve::P_521,
1280 EcCurve::CURVE_25519};
Selene Huang31ab4042020-04-29 04:22:39 -07001281 } else {
David Drysdale42fe1892021-10-14 14:43:46 +01001282 return {
1283 EcCurve::P_224,
1284 EcCurve::P_256,
1285 EcCurve::P_384,
1286 EcCurve::P_521,
1287 };
Selene Huang31ab4042020-04-29 04:22:39 -07001288 }
1289}
1290
1291vector<EcCurve> KeyMintAidlTestBase::InvalidCurves() {
David Drysdaledf09e542021-06-08 15:46:11 +01001292 if (SecLevel() == SecurityLevel::STRONGBOX) {
David Drysdale42fe1892021-10-14 14:43:46 +01001293 // Curve 25519 is not supported, either because:
1294 // - KeyMint v1: it's an unknown enum value
1295 // - KeyMint v2+: it's not supported by StrongBox.
1296 return {EcCurve::P_224, EcCurve::P_384, EcCurve::P_521, EcCurve::CURVE_25519};
David Drysdaledf09e542021-06-08 15:46:11 +01001297 } else {
David Drysdale42fe1892021-10-14 14:43:46 +01001298 if (Curve25519Supported()) {
1299 return {};
1300 } else {
1301 return {EcCurve::CURVE_25519};
1302 }
David Drysdaledf09e542021-06-08 15:46:11 +01001303 }
Selene Huang31ab4042020-04-29 04:22:39 -07001304}
1305
subrahmanyaman05642492022-02-05 07:10:56 +00001306vector<uint64_t> KeyMintAidlTestBase::ValidExponents() {
1307 if (SecLevel() == SecurityLevel::STRONGBOX) {
1308 return {65537};
1309 } else {
1310 return {3, 65537};
1311 }
1312}
1313
Selene Huang31ab4042020-04-29 04:22:39 -07001314vector<Digest> KeyMintAidlTestBase::ValidDigests(bool withNone, bool withMD5) {
1315 switch (SecLevel()) {
1316 case SecurityLevel::SOFTWARE:
1317 case SecurityLevel::TRUSTED_ENVIRONMENT:
1318 if (withNone) {
1319 if (withMD5)
1320 return {Digest::NONE, Digest::MD5, Digest::SHA1,
1321 Digest::SHA_2_224, Digest::SHA_2_256, Digest::SHA_2_384,
1322 Digest::SHA_2_512};
1323 else
1324 return {Digest::NONE, Digest::SHA1, Digest::SHA_2_224,
1325 Digest::SHA_2_256, Digest::SHA_2_384, Digest::SHA_2_512};
1326 } else {
1327 if (withMD5)
1328 return {Digest::MD5, Digest::SHA1, Digest::SHA_2_224,
1329 Digest::SHA_2_256, Digest::SHA_2_384, Digest::SHA_2_512};
1330 else
1331 return {Digest::SHA1, Digest::SHA_2_224, Digest::SHA_2_256, Digest::SHA_2_384,
1332 Digest::SHA_2_512};
1333 }
1334 break;
1335 case SecurityLevel::STRONGBOX:
1336 if (withNone)
1337 return {Digest::NONE, Digest::SHA_2_256};
1338 else
1339 return {Digest::SHA_2_256};
1340 break;
1341 default:
1342 ADD_FAILURE() << "Invalid security level " << uint32_t(SecLevel());
1343 break;
1344 }
1345 ADD_FAILURE() << "Should be impossible to get here";
1346 return {};
1347}
1348
Shawn Willden7f424372021-01-10 18:06:50 -07001349static const vector<KeyParameter> kEmptyAuthList{};
1350
1351const vector<KeyParameter>& KeyMintAidlTestBase::SecLevelAuthorizations(
1352 const vector<KeyCharacteristics>& key_characteristics) {
1353 auto found = std::find_if(key_characteristics.begin(), key_characteristics.end(),
1354 [this](auto& entry) { return entry.securityLevel == SecLevel(); });
1355 return (found == key_characteristics.end()) ? kEmptyAuthList : found->authorizations;
1356}
1357
Qi Wubeefae42021-01-28 23:16:37 +08001358const vector<KeyParameter>& KeyMintAidlTestBase::SecLevelAuthorizations(
1359 const vector<KeyCharacteristics>& key_characteristics, SecurityLevel securityLevel) {
1360 auto found = std::find_if(
1361 key_characteristics.begin(), key_characteristics.end(),
1362 [securityLevel](auto& entry) { return entry.securityLevel == securityLevel; });
Shawn Willden0e80b5d2020-12-17 09:07:27 -07001363 return (found == key_characteristics.end()) ? kEmptyAuthList : found->authorizations;
1364}
1365
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001366ErrorCode KeyMintAidlTestBase::UseAesKey(const vector<uint8_t>& aesKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001367 auto [result, ciphertext] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001368 aesKeyBlob, KeyPurpose::ENCRYPT, "1234567890123456",
1369 AuthorizationSetBuilder().BlockMode(BlockMode::ECB).Padding(PaddingMode::NONE));
1370 return result;
1371}
1372
1373ErrorCode KeyMintAidlTestBase::UseHmacKey(const vector<uint8_t>& hmacKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001374 auto [result, mac] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001375 hmacKeyBlob, KeyPurpose::SIGN, "1234567890123456",
1376 AuthorizationSetBuilder().Authorization(TAG_MAC_LENGTH, 128).Digest(Digest::SHA_2_256));
1377 return result;
1378}
1379
1380ErrorCode KeyMintAidlTestBase::UseRsaKey(const vector<uint8_t>& rsaKeyBlob) {
1381 std::string message(2048 / 8, 'a');
Shawn Willden92d79c02021-02-19 07:31:55 -07001382 auto [result, signature] = ProcessMessage(
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001383 rsaKeyBlob, KeyPurpose::SIGN, message,
1384 AuthorizationSetBuilder().Digest(Digest::NONE).Padding(PaddingMode::NONE));
1385 return result;
1386}
1387
1388ErrorCode KeyMintAidlTestBase::UseEcdsaKey(const vector<uint8_t>& ecdsaKeyBlob) {
Shawn Willden92d79c02021-02-19 07:31:55 -07001389 auto [result, signature] = ProcessMessage(ecdsaKeyBlob, KeyPurpose::SIGN, "a",
1390 AuthorizationSetBuilder().Digest(Digest::SHA_2_256));
Chirag Pathak9ea6a0a2021-02-01 23:54:27 +00001391 return result;
1392}
1393
Selene Huang6e46f142021-04-20 19:20:11 -07001394void verify_serial(X509* cert, const uint64_t expected_serial) {
1395 BIGNUM_Ptr ser(BN_new());
1396 EXPECT_TRUE(ASN1_INTEGER_to_BN(X509_get_serialNumber(cert), ser.get()));
1397
1398 uint64_t serial;
1399 EXPECT_TRUE(BN_get_u64(ser.get(), &serial));
1400 EXPECT_EQ(serial, expected_serial);
1401}
1402
1403// Please set self_signed to true for fake certificates or self signed
1404// certificates
1405void verify_subject(const X509* cert, //
1406 const string& subject, //
1407 bool self_signed) {
1408 char* cert_issuer = //
1409 X509_NAME_oneline(X509_get_issuer_name(cert), nullptr, 0);
1410
1411 char* cert_subj = X509_NAME_oneline(X509_get_subject_name(cert), nullptr, 0);
1412
1413 string expected_subject("/CN=");
1414 if (subject.empty()) {
1415 expected_subject.append("Android Keystore Key");
1416 } else {
1417 expected_subject.append(subject);
1418 }
1419
1420 EXPECT_STREQ(expected_subject.c_str(), cert_subj) << "Cert has wrong subject." << cert_subj;
1421
1422 if (self_signed) {
1423 EXPECT_STREQ(cert_issuer, cert_subj)
1424 << "Cert issuer and subject mismatch for self signed certificate.";
1425 }
1426
1427 OPENSSL_free(cert_subj);
1428 OPENSSL_free(cert_issuer);
1429}
1430
1431vector<uint8_t> build_serial_blob(const uint64_t serial_int) {
1432 BIGNUM_Ptr serial(BN_new());
1433 EXPECT_TRUE(BN_set_u64(serial.get(), serial_int));
1434
1435 int len = BN_num_bytes(serial.get());
1436 vector<uint8_t> serial_blob(len);
1437 if (BN_bn2bin(serial.get(), serial_blob.data()) != len) {
1438 return {};
1439 }
1440
David Drysdaledb0dcf52021-05-18 11:43:31 +01001441 if (serial_blob.empty() || serial_blob[0] & 0x80) {
1442 // An empty blob is OpenSSL's encoding of the zero value; we need single zero byte.
1443 // Top bit being set indicates a negative number in two's complement, but our input
1444 // was positive.
1445 // In either case, prepend a zero byte.
1446 serial_blob.insert(serial_blob.begin(), 0x00);
1447 }
1448
Selene Huang6e46f142021-04-20 19:20:11 -07001449 return serial_blob;
1450}
1451
1452void verify_subject_and_serial(const Certificate& certificate, //
1453 const uint64_t expected_serial, //
1454 const string& subject, bool self_signed) {
1455 X509_Ptr cert(parse_cert_blob(certificate.encodedCertificate));
1456 ASSERT_TRUE(!!cert.get());
1457
1458 verify_serial(cert.get(), expected_serial);
1459 verify_subject(cert.get(), subject, self_signed);
1460}
1461
David Drysdale7dff4fc2021-12-10 10:10:52 +00001462bool verify_attestation_record(int32_t aidl_version, //
1463 const string& challenge, //
Shawn Willden7c130392020-12-21 09:58:22 -07001464 const string& app_id, //
1465 AuthorizationSet expected_sw_enforced, //
1466 AuthorizationSet expected_hw_enforced, //
1467 SecurityLevel security_level,
David Drysdale565ccc72021-10-11 12:49:50 +01001468 const vector<uint8_t>& attestation_cert,
1469 vector<uint8_t>* unique_id) {
Shawn Willden7c130392020-12-21 09:58:22 -07001470 X509_Ptr cert(parse_cert_blob(attestation_cert));
1471 EXPECT_TRUE(!!cert.get());
1472 if (!cert.get()) return false;
1473
1474 ASN1_OCTET_STRING* attest_rec = get_attestation_record(cert.get());
1475 EXPECT_TRUE(!!attest_rec);
1476 if (!attest_rec) return false;
1477
1478 AuthorizationSet att_sw_enforced;
1479 AuthorizationSet att_hw_enforced;
1480 uint32_t att_attestation_version;
David Drysdale37af4b32021-05-14 16:46:59 +01001481 uint32_t att_keymint_version;
Shawn Willden7c130392020-12-21 09:58:22 -07001482 SecurityLevel att_attestation_security_level;
David Drysdale37af4b32021-05-14 16:46:59 +01001483 SecurityLevel att_keymint_security_level;
Shawn Willden7c130392020-12-21 09:58:22 -07001484 vector<uint8_t> att_challenge;
1485 vector<uint8_t> att_unique_id;
1486 vector<uint8_t> att_app_id;
1487
1488 auto error = parse_attestation_record(attest_rec->data, //
1489 attest_rec->length, //
1490 &att_attestation_version, //
1491 &att_attestation_security_level, //
David Drysdale37af4b32021-05-14 16:46:59 +01001492 &att_keymint_version, //
1493 &att_keymint_security_level, //
Shawn Willden7c130392020-12-21 09:58:22 -07001494 &att_challenge, //
1495 &att_sw_enforced, //
1496 &att_hw_enforced, //
1497 &att_unique_id);
1498 EXPECT_EQ(ErrorCode::OK, error);
1499 if (error != ErrorCode::OK) return false;
1500
David Drysdale7dff4fc2021-12-10 10:10:52 +00001501 check_attestation_version(att_attestation_version, aidl_version);
Selene Huang4f64c222021-04-13 19:54:36 -07001502 vector<uint8_t> appId(app_id.begin(), app_id.end());
Shawn Willden7c130392020-12-21 09:58:22 -07001503
Selene Huang4f64c222021-04-13 19:54:36 -07001504 // check challenge and app id only if we expects a non-fake certificate
1505 if (challenge.length() > 0) {
1506 EXPECT_EQ(challenge.length(), att_challenge.size());
1507 EXPECT_EQ(0, memcmp(challenge.data(), att_challenge.data(), challenge.length()));
1508
1509 expected_sw_enforced.push_back(TAG_ATTESTATION_APPLICATION_ID, appId);
1510 }
Shawn Willden7c130392020-12-21 09:58:22 -07001511
David Drysdale7dff4fc2021-12-10 10:10:52 +00001512 check_attestation_version(att_keymint_version, aidl_version);
David Drysdale37af4b32021-05-14 16:46:59 +01001513 EXPECT_EQ(security_level, att_keymint_security_level);
Shawn Willden7c130392020-12-21 09:58:22 -07001514 EXPECT_EQ(security_level, att_attestation_security_level);
1515
Shawn Willden7c130392020-12-21 09:58:22 -07001516
1517 char property_value[PROPERTY_VALUE_MAX] = {};
1518 // TODO(b/136282179): When running under VTS-on-GSI the TEE-backed
David Drysdale37af4b32021-05-14 16:46:59 +01001519 // keymint implementation will report YYYYMM dates instead of YYYYMMDD
Shawn Willden7c130392020-12-21 09:58:22 -07001520 // for the BOOT_PATCH_LEVEL.
1521 if (avb_verification_enabled()) {
1522 for (int i = 0; i < att_hw_enforced.size(); i++) {
1523 if (att_hw_enforced[i].tag == TAG_BOOT_PATCHLEVEL ||
1524 att_hw_enforced[i].tag == TAG_VENDOR_PATCHLEVEL) {
1525 std::string date =
Tommy Chiuf00d8f12021-04-08 11:07:48 +08001526 std::to_string(att_hw_enforced[i].value.get<KeyParameterValue::integer>());
David Drysdale168228a2021-10-05 08:43:52 +01001527
Shawn Willden7c130392020-12-21 09:58:22 -07001528 // strptime seems to require delimiters, but the tag value will
1529 // be YYYYMMDD
David Drysdale168228a2021-10-05 08:43:52 +01001530 if (date.size() != 8) {
1531 ADD_FAILURE() << "Tag " << att_hw_enforced[i].tag
1532 << " with invalid format (not YYYYMMDD): " << date;
1533 return false;
1534 }
Shawn Willden7c130392020-12-21 09:58:22 -07001535 date.insert(6, "-");
1536 date.insert(4, "-");
Shawn Willden7c130392020-12-21 09:58:22 -07001537 struct tm time;
1538 strptime(date.c_str(), "%Y-%m-%d", &time);
1539
1540 // Day of the month (0-31)
1541 EXPECT_GE(time.tm_mday, 0);
1542 EXPECT_LT(time.tm_mday, 32);
1543 // Months since Jan (0-11)
1544 EXPECT_GE(time.tm_mon, 0);
1545 EXPECT_LT(time.tm_mon, 12);
1546 // Years since 1900
1547 EXPECT_GT(time.tm_year, 110);
1548 EXPECT_LT(time.tm_year, 200);
1549 }
1550 }
1551 }
1552
1553 // Check to make sure boolean values are properly encoded. Presence of a boolean tag
1554 // indicates true. A provided boolean tag that can be pulled back out of the certificate
1555 // indicates correct encoding. No need to check if it's in both lists, since the
1556 // AuthorizationSet compare below will handle mismatches of tags.
1557 if (security_level == SecurityLevel::SOFTWARE) {
1558 EXPECT_TRUE(expected_sw_enforced.Contains(TAG_NO_AUTH_REQUIRED));
1559 } else {
1560 EXPECT_TRUE(expected_hw_enforced.Contains(TAG_NO_AUTH_REQUIRED));
1561 }
1562
Shawn Willden7c130392020-12-21 09:58:22 -07001563 if (att_hw_enforced.Contains(TAG_ALGORITHM, Algorithm::EC)) {
1564 // For ECDSA keys, either an EC_CURVE or a KEY_SIZE can be specified, but one must be.
1565 EXPECT_TRUE(att_hw_enforced.Contains(TAG_EC_CURVE) ||
1566 att_hw_enforced.Contains(TAG_KEY_SIZE));
1567 }
1568
1569 // Test root of trust elements
1570 vector<uint8_t> verified_boot_key;
1571 VerifiedBoot verified_boot_state;
1572 bool device_locked;
1573 vector<uint8_t> verified_boot_hash;
1574 error = parse_root_of_trust(attest_rec->data, attest_rec->length, &verified_boot_key,
1575 &verified_boot_state, &device_locked, &verified_boot_hash);
1576 EXPECT_EQ(ErrorCode::OK, error);
1577
1578 if (avb_verification_enabled()) {
1579 EXPECT_NE(property_get("ro.boot.vbmeta.digest", property_value, ""), 0);
1580 string prop_string(property_value);
1581 EXPECT_EQ(prop_string.size(), 64);
1582 EXPECT_EQ(prop_string, bin2hex(verified_boot_hash));
1583
1584 EXPECT_NE(property_get("ro.boot.vbmeta.device_state", property_value, ""), 0);
1585 if (!strcmp(property_value, "unlocked")) {
1586 EXPECT_FALSE(device_locked);
1587 } else {
1588 EXPECT_TRUE(device_locked);
1589 }
1590
1591 // Check that the device is locked if not debuggable, e.g., user build
1592 // images in CTS. For VTS, debuggable images are used to allow adb root
1593 // and the device is unlocked.
1594 if (!property_get_bool("ro.debuggable", false)) {
1595 EXPECT_TRUE(device_locked);
1596 } else {
1597 EXPECT_FALSE(device_locked);
1598 }
1599 }
1600
1601 // Verified boot key should be all 0's if the boot state is not verified or self signed
1602 std::string empty_boot_key(32, '\0');
1603 std::string verified_boot_key_str((const char*)verified_boot_key.data(),
1604 verified_boot_key.size());
1605 EXPECT_NE(property_get("ro.boot.verifiedbootstate", property_value, ""), 0);
1606 if (!strcmp(property_value, "green")) {
1607 EXPECT_EQ(verified_boot_state, VerifiedBoot::VERIFIED);
1608 EXPECT_NE(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1609 verified_boot_key.size()));
1610 } else if (!strcmp(property_value, "yellow")) {
1611 EXPECT_EQ(verified_boot_state, VerifiedBoot::SELF_SIGNED);
1612 EXPECT_NE(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1613 verified_boot_key.size()));
1614 } else if (!strcmp(property_value, "orange")) {
1615 EXPECT_EQ(verified_boot_state, VerifiedBoot::UNVERIFIED);
1616 EXPECT_EQ(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
1617 verified_boot_key.size()));
1618 } else if (!strcmp(property_value, "red")) {
1619 EXPECT_EQ(verified_boot_state, VerifiedBoot::FAILED);
1620 } else {
1621 EXPECT_EQ(verified_boot_state, VerifiedBoot::UNVERIFIED);
Tri Voaf291412022-03-08 10:06:00 -08001622 EXPECT_EQ(0, memcmp(verified_boot_key.data(), empty_boot_key.data(),
Shawn Willden7c130392020-12-21 09:58:22 -07001623 verified_boot_key.size()));
1624 }
1625
1626 att_sw_enforced.Sort();
1627 expected_sw_enforced.Sort();
David Drysdale37af4b32021-05-14 16:46:59 +01001628 EXPECT_EQ(filtered_tags(expected_sw_enforced), filtered_tags(att_sw_enforced));
Shawn Willden7c130392020-12-21 09:58:22 -07001629
1630 att_hw_enforced.Sort();
1631 expected_hw_enforced.Sort();
1632 EXPECT_EQ(filtered_tags(expected_hw_enforced), filtered_tags(att_hw_enforced));
1633
David Drysdale565ccc72021-10-11 12:49:50 +01001634 if (unique_id != nullptr) {
1635 *unique_id = att_unique_id;
1636 }
1637
Shawn Willden7c130392020-12-21 09:58:22 -07001638 return true;
1639}
1640
1641string bin2hex(const vector<uint8_t>& data) {
1642 string retval;
1643 retval.reserve(data.size() * 2 + 1);
1644 for (uint8_t byte : data) {
1645 retval.push_back(nibble2hex[0x0F & (byte >> 4)]);
1646 retval.push_back(nibble2hex[0x0F & byte]);
1647 }
1648 return retval;
1649}
1650
David Drysdalef0d516d2021-03-22 07:51:43 +00001651AuthorizationSet HwEnforcedAuthorizations(const vector<KeyCharacteristics>& key_characteristics) {
1652 AuthorizationSet authList;
1653 for (auto& entry : key_characteristics) {
1654 if (entry.securityLevel == SecurityLevel::STRONGBOX ||
1655 entry.securityLevel == SecurityLevel::TRUSTED_ENVIRONMENT) {
1656 authList.push_back(AuthorizationSet(entry.authorizations));
1657 }
1658 }
1659 return authList;
1660}
1661
1662AuthorizationSet SwEnforcedAuthorizations(const vector<KeyCharacteristics>& key_characteristics) {
1663 AuthorizationSet authList;
1664 for (auto& entry : key_characteristics) {
1665 if (entry.securityLevel == SecurityLevel::SOFTWARE ||
1666 entry.securityLevel == SecurityLevel::KEYSTORE) {
1667 authList.push_back(AuthorizationSet(entry.authorizations));
1668 }
1669 }
1670 return authList;
1671}
1672
Eran Messeri03d7a1a2021-07-06 12:07:57 +01001673AssertionResult ChainSignaturesAreValid(const vector<Certificate>& chain,
1674 bool strict_issuer_check) {
Shawn Willden7c130392020-12-21 09:58:22 -07001675 std::stringstream cert_data;
1676
1677 for (size_t i = 0; i < chain.size(); ++i) {
1678 cert_data << bin2hex(chain[i].encodedCertificate) << std::endl;
1679
1680 X509_Ptr key_cert(parse_cert_blob(chain[i].encodedCertificate));
1681 X509_Ptr signing_cert;
1682 if (i < chain.size() - 1) {
1683 signing_cert = parse_cert_blob(chain[i + 1].encodedCertificate);
1684 } else {
1685 signing_cert = parse_cert_blob(chain[i].encodedCertificate);
1686 }
1687 if (!key_cert.get() || !signing_cert.get()) return AssertionFailure() << cert_data.str();
1688
1689 EVP_PKEY_Ptr signing_pubkey(X509_get_pubkey(signing_cert.get()));
1690 if (!signing_pubkey.get()) return AssertionFailure() << cert_data.str();
1691
1692 if (!X509_verify(key_cert.get(), signing_pubkey.get())) {
1693 return AssertionFailure()
1694 << "Verification of certificate " << i << " failed "
1695 << "OpenSSL error string: " << ERR_error_string(ERR_get_error(), NULL) << '\n'
1696 << cert_data.str();
1697 }
1698
1699 string cert_issuer = x509NameToStr(X509_get_issuer_name(key_cert.get()));
1700 string signer_subj = x509NameToStr(X509_get_subject_name(signing_cert.get()));
Eran Messeri03d7a1a2021-07-06 12:07:57 +01001701 if (cert_issuer != signer_subj && strict_issuer_check) {
Selene Huang8f9494c2021-04-21 15:10:36 -07001702 return AssertionFailure() << "Cert " << i << " has wrong issuer.\n"
1703 << " Signer subject is " << signer_subj
1704 << " Issuer subject is " << cert_issuer << endl
1705 << cert_data.str();
Shawn Willden7c130392020-12-21 09:58:22 -07001706 }
Shawn Willden7c130392020-12-21 09:58:22 -07001707 }
1708
1709 if (KeyMintAidlTestBase::dump_Attestations) std::cout << cert_data.str();
1710 return AssertionSuccess();
1711}
1712
1713X509_Ptr parse_cert_blob(const vector<uint8_t>& blob) {
1714 const uint8_t* p = blob.data();
1715 return X509_Ptr(d2i_X509(nullptr /* allocate new */, &p, blob.size()));
1716}
1717
David Drysdalef0d516d2021-03-22 07:51:43 +00001718vector<uint8_t> make_name_from_str(const string& name) {
1719 X509_NAME_Ptr x509_name(X509_NAME_new());
1720 EXPECT_TRUE(x509_name.get() != nullptr);
1721 if (!x509_name) return {};
1722
1723 EXPECT_EQ(1, X509_NAME_add_entry_by_txt(x509_name.get(), //
1724 "CN", //
1725 MBSTRING_ASC,
1726 reinterpret_cast<const uint8_t*>(name.c_str()),
1727 -1, // len
1728 -1, // loc
1729 0 /* set */));
1730
1731 int len = i2d_X509_NAME(x509_name.get(), nullptr /* only return length */);
1732 EXPECT_GT(len, 0);
1733
1734 vector<uint8_t> retval(len);
1735 uint8_t* p = retval.data();
1736 i2d_X509_NAME(x509_name.get(), &p);
1737
1738 return retval;
1739}
1740
David Drysdale4dc01072021-04-01 12:17:35 +01001741namespace {
1742
1743void check_cose_key(const vector<uint8_t>& data, bool testMode) {
1744 auto [parsedPayload, __, payloadParseErr] = cppbor::parse(data);
1745 ASSERT_TRUE(parsedPayload) << "Key parse failed: " << payloadParseErr;
1746
1747 // The following check assumes that canonical CBOR encoding is used for the COSE_Key.
1748 if (testMode) {
1749 EXPECT_THAT(cppbor::prettyPrint(parsedPayload.get()),
1750 MatchesRegex("{\n"
1751 " 1 : 2,\n" // kty: EC2
1752 " 3 : -7,\n" // alg: ES256
1753 " -1 : 1,\n" // EC id: P256
1754 // The regex {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}} matches a
1755 // sequence of 32 hexadecimal bytes, enclosed in braces and
1756 // separated by commas. In this case, some Ed25519 public key.
1757 " -2 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_x: data
1758 " -3 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_y: data
1759 " -70000 : null,\n" // test marker
1760 "}"));
1761 } else {
1762 EXPECT_THAT(cppbor::prettyPrint(parsedPayload.get()),
1763 MatchesRegex("{\n"
1764 " 1 : 2,\n" // kty: EC2
1765 " 3 : -7,\n" // alg: ES256
1766 " -1 : 1,\n" // EC id: P256
1767 // The regex {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}} matches a
1768 // sequence of 32 hexadecimal bytes, enclosed in braces and
1769 // separated by commas. In this case, some Ed25519 public key.
1770 " -2 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_x: data
1771 " -3 : {(0x[0-9a-f]{2}, ){31}0x[0-9a-f]{2}},\n" // pub_y: data
1772 "}"));
1773 }
1774}
1775
1776} // namespace
1777
1778void check_maced_pubkey(const MacedPublicKey& macedPubKey, bool testMode,
1779 vector<uint8_t>* payload_value) {
1780 auto [coseMac0, _, mac0ParseErr] = cppbor::parse(macedPubKey.macedKey);
1781 ASSERT_TRUE(coseMac0) << "COSE Mac0 parse failed " << mac0ParseErr;
1782
1783 ASSERT_NE(coseMac0->asArray(), nullptr);
1784 ASSERT_EQ(coseMac0->asArray()->size(), kCoseMac0EntryCount);
1785
1786 auto protParms = coseMac0->asArray()->get(kCoseMac0ProtectedParams)->asBstr();
1787 ASSERT_NE(protParms, nullptr);
1788
1789 // Header label:value of 'alg': HMAC-256
1790 ASSERT_EQ(cppbor::prettyPrint(protParms->value()), "{\n 1 : 5,\n}");
1791
1792 auto unprotParms = coseMac0->asArray()->get(kCoseMac0UnprotectedParams)->asMap();
1793 ASSERT_NE(unprotParms, nullptr);
1794 ASSERT_EQ(unprotParms->size(), 0);
1795
1796 // The payload is a bstr holding an encoded COSE_Key
1797 auto payload = coseMac0->asArray()->get(kCoseMac0Payload)->asBstr();
1798 ASSERT_NE(payload, nullptr);
1799 check_cose_key(payload->value(), testMode);
1800
1801 auto coseMac0Tag = coseMac0->asArray()->get(kCoseMac0Tag)->asBstr();
1802 ASSERT_TRUE(coseMac0Tag);
1803 auto extractedTag = coseMac0Tag->value();
1804 EXPECT_EQ(extractedTag.size(), 32U);
1805
1806 // Compare with tag generated with kTestMacKey. Should only match in test mode
Seth Moore026bb742021-04-30 11:41:18 -07001807 auto macFunction = [](const cppcose::bytevec& input) {
1808 return cppcose::generateHmacSha256(remote_prov::kTestMacKey, input);
1809 };
1810 auto testTag =
1811 cppcose::generateCoseMac0Mac(macFunction, {} /* external_aad */, payload->value());
David Drysdale4dc01072021-04-01 12:17:35 +01001812 ASSERT_TRUE(testTag) << "Tag calculation failed: " << testTag.message();
1813
1814 if (testMode) {
Seth Moore026bb742021-04-30 11:41:18 -07001815 EXPECT_THAT(*testTag, ElementsAreArray(extractedTag));
David Drysdale4dc01072021-04-01 12:17:35 +01001816 } else {
Seth Moore026bb742021-04-30 11:41:18 -07001817 EXPECT_THAT(*testTag, Not(ElementsAreArray(extractedTag)));
David Drysdale4dc01072021-04-01 12:17:35 +01001818 }
1819 if (payload_value != nullptr) {
1820 *payload_value = payload->value();
1821 }
1822}
1823
1824void p256_pub_key(const vector<uint8_t>& coseKeyData, EVP_PKEY_Ptr* signingKey) {
1825 // Extract x and y affine coordinates from the encoded Cose_Key.
1826 auto [parsedPayload, __, payloadParseErr] = cppbor::parse(coseKeyData);
1827 ASSERT_TRUE(parsedPayload) << "Key parse failed: " << payloadParseErr;
1828 auto coseKey = parsedPayload->asMap();
1829 const std::unique_ptr<cppbor::Item>& xItem = coseKey->get(cppcose::CoseKey::PUBKEY_X);
1830 ASSERT_NE(xItem->asBstr(), nullptr);
1831 vector<uint8_t> x = xItem->asBstr()->value();
1832 const std::unique_ptr<cppbor::Item>& yItem = coseKey->get(cppcose::CoseKey::PUBKEY_Y);
1833 ASSERT_NE(yItem->asBstr(), nullptr);
1834 vector<uint8_t> y = yItem->asBstr()->value();
1835
1836 // Concatenate: 0x04 (uncompressed form marker) | x | y
1837 vector<uint8_t> pubKeyData{0x04};
1838 pubKeyData.insert(pubKeyData.end(), x.begin(), x.end());
1839 pubKeyData.insert(pubKeyData.end(), y.begin(), y.end());
1840
1841 EC_KEY_Ptr ecKey = EC_KEY_Ptr(EC_KEY_new());
1842 ASSERT_NE(ecKey, nullptr);
1843 EC_GROUP_Ptr group = EC_GROUP_Ptr(EC_GROUP_new_by_curve_name(NID_X9_62_prime256v1));
1844 ASSERT_NE(group, nullptr);
1845 ASSERT_EQ(EC_KEY_set_group(ecKey.get(), group.get()), 1);
1846 EC_POINT_Ptr point = EC_POINT_Ptr(EC_POINT_new(group.get()));
1847 ASSERT_NE(point, nullptr);
1848 ASSERT_EQ(EC_POINT_oct2point(group.get(), point.get(), pubKeyData.data(), pubKeyData.size(),
1849 nullptr),
1850 1);
1851 ASSERT_EQ(EC_KEY_set_public_key(ecKey.get(), point.get()), 1);
1852
1853 EVP_PKEY_Ptr pubKey = EVP_PKEY_Ptr(EVP_PKEY_new());
1854 ASSERT_NE(pubKey, nullptr);
1855 EVP_PKEY_assign_EC_KEY(pubKey.get(), ecKey.release());
1856 *signingKey = std::move(pubKey);
1857}
1858
Selene Huang31ab4042020-04-29 04:22:39 -07001859} // namespace test
Shawn Willden08a7e432020-12-11 13:05:27 +00001860
Janis Danisevskis24c04702020-12-16 18:28:39 -08001861} // namespace aidl::android::hardware::security::keymint