blob: 4f69eb024968293c679500056d3e51308d6d63c2 [file] [log] [blame]
Darren Krahn69a3dbc2015-09-22 16:21:04 -07001// Copyright 2015 The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -080015#include <chrono>
Darren Krahn69a3dbc2015-09-22 16:21:04 -070016#include <cstdio>
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -080017#include <future>
Darren Krahn69a3dbc2015-09-22 16:21:04 -070018#include <memory>
19#include <string>
20#include <vector>
21
Shawn Willdenbb22a6c2017-12-06 19:35:28 -070022#include <base/command_line.h>
23#include <base/files/file_util.h>
David Zeuthenc6eb7cd2017-11-27 11:33:55 -050024#include <base/strings/string_number_conversions.h>
25#include <base/strings/string_split.h>
Shawn Willdenbb22a6c2017-12-06 19:35:28 -070026#include <base/strings/string_util.h>
David Zeuthenc6eb7cd2017-11-27 11:33:55 -050027#include <base/strings/utf_string_conversions.h>
28#include <base/threading/platform_thread.h>
Shawn Willdenbb22a6c2017-12-06 19:35:28 -070029#include <keystore/keymaster_types.h>
30#include <keystore/keystore_client_impl.h>
Darren Krahn69a3dbc2015-09-22 16:21:04 -070031
David Zeuthenc6eb7cd2017-11-27 11:33:55 -050032#include <android/hardware/confirmationui/1.0/types.h>
33#include <android/security/BnConfirmationPromptCallback.h>
Rob Barnesbb6cabd2018-10-04 17:10:37 -060034#include <android/security/keystore/IKeystoreService.h>
David Zeuthenc6eb7cd2017-11-27 11:33:55 -050035
36#include <binder/IPCThreadState.h>
37#include <binder/IServiceManager.h>
38
39//#include <keystore/keystore.h>
40
Darren Krahn69a3dbc2015-09-22 16:21:04 -070041using base::CommandLine;
Darren Krahn69a3dbc2015-09-22 16:21:04 -070042using keystore::KeystoreClient;
43
David Zeuthenc6eb7cd2017-11-27 11:33:55 -050044using android::sp;
45using android::String16;
Rob Barnesbb6cabd2018-10-04 17:10:37 -060046using android::security::keystore::IKeystoreService;
David Zeuthenc6eb7cd2017-11-27 11:33:55 -050047using base::CommandLine;
48using ConfirmationResponseCode = android::hardware::confirmationui::V1_0::ResponseCode;
49
Darren Krahn69a3dbc2015-09-22 16:21:04 -070050namespace {
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +010051using namespace keystore;
Darren Krahn69a3dbc2015-09-22 16:21:04 -070052
Darren Krahna9474ab2015-11-03 14:38:53 -080053struct TestCase {
54 std::string name;
55 bool required_for_brillo_pts;
56 AuthorizationSet parameters;
57};
58
Darren Krahn69a3dbc2015-09-22 16:21:04 -070059void PrintUsageAndExit() {
60 printf("Usage: keystore_client_v2 <command> [options]\n");
Darren Krahn82f4f5b2016-03-03 16:21:07 -080061 printf("Commands: brillo-platform-test [--prefix=<test_name_prefix>] [--test_for_0_3]\n"
Darren Krahna9474ab2015-11-03 14:38:53 -080062 " list-brillo-tests\n"
Janis Danisevskisc1460142017-12-18 16:48:46 -080063 " add-entropy --input=<entropy> [--seclevel=software|strongbox|tee(default)]\n"
64 " generate --name=<key_name> [--seclevel=software|strongbox|tee(default)]\n"
Darren Krahn69a3dbc2015-09-22 16:21:04 -070065 " get-chars --name=<key_name>\n"
66 " export --name=<key_name>\n"
67 " delete --name=<key_name>\n"
68 " delete-all\n"
69 " exists --name=<key_name>\n"
70 " list [--prefix=<key_name_prefix>]\n"
Rob Barneseb7f79b2018-11-08 15:44:10 -070071 " list-apps-with-keys\n"
Darren Krahn251cb282015-09-28 08:51:18 -070072 " sign-verify --name=<key_name>\n"
Janis Danisevskisc1460142017-12-18 16:48:46 -080073 " [en|de]crypt --name=<key_name> --in=<file> --out=<file>\n"
David Zeuthenc6eb7cd2017-11-27 11:33:55 -050074 " [--seclevel=software|strongbox|tee(default)]\n"
75 " confirmation --prompt_text=<PromptText> --extra_data=<hex>\n"
76 " --locale=<locale> [--ui_options=<list_of_ints>]\n"
77 " --cancel_after=<seconds>\n");
Darren Krahn69a3dbc2015-09-22 16:21:04 -070078 exit(1);
79}
80
81std::unique_ptr<KeystoreClient> CreateKeystoreInstance() {
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +010082 return std::unique_ptr<KeystoreClient>(
Shawn Willdenbb22a6c2017-12-06 19:35:28 -070083 static_cast<KeystoreClient*>(new keystore::KeystoreClientImpl));
Darren Krahn69a3dbc2015-09-22 16:21:04 -070084}
85
Darren Krahna9474ab2015-11-03 14:38:53 -080086void PrintTags(const AuthorizationSet& parameters) {
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +010087 for (auto iter = parameters.begin(); iter != parameters.end(); ++iter) {
Shawn Willdenbb22a6c2017-12-06 19:35:28 -070088 auto tag_str = toString(iter->tag);
89 printf(" %s\n", tag_str.c_str());
Darren Krahna9474ab2015-11-03 14:38:53 -080090 }
91}
92
93void PrintKeyCharacteristics(const AuthorizationSet& hardware_enforced_characteristics,
94 const AuthorizationSet& software_enforced_characteristics) {
95 printf("Hardware:\n");
96 PrintTags(hardware_enforced_characteristics);
97 printf("Software:\n");
98 PrintTags(software_enforced_characteristics);
99}
100
101bool TestKey(const std::string& name, bool required, const AuthorizationSet& parameters) {
102 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
103 AuthorizationSet hardware_enforced_characteristics;
104 AuthorizationSet software_enforced_characteristics;
Janis Danisevskisc1460142017-12-18 16:48:46 -0800105 auto result =
106 keystore->generateKey("tmp", parameters, 0 /*flags*/, &hardware_enforced_characteristics,
107 &software_enforced_characteristics);
Darren Krahn82f4f5b2016-03-03 16:21:07 -0800108 const char kBoldRedAbort[] = "\033[1;31mABORT\033[0m";
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100109 if (!result.isOk()) {
Darren Krahna9474ab2015-11-03 14:38:53 -0800110 LOG(ERROR) << "Failed to generate key: " << result;
Darren Krahn82f4f5b2016-03-03 16:21:07 -0800111 printf("[%s] %s\n", kBoldRedAbort, name.c_str());
Darren Krahna9474ab2015-11-03 14:38:53 -0800112 return false;
113 }
114 result = keystore->deleteKey("tmp");
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100115 if (!result.isOk()) {
Darren Krahna9474ab2015-11-03 14:38:53 -0800116 LOG(ERROR) << "Failed to delete key: " << result;
Darren Krahn82f4f5b2016-03-03 16:21:07 -0800117 printf("[%s] %s\n", kBoldRedAbort, name.c_str());
Darren Krahna9474ab2015-11-03 14:38:53 -0800118 return false;
119 }
120 printf("===============================================================\n");
121 printf("%s Key Characteristics:\n", name.c_str());
122 PrintKeyCharacteristics(hardware_enforced_characteristics, software_enforced_characteristics);
123 bool hardware_backed = (hardware_enforced_characteristics.size() > 0);
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100124 if (software_enforced_characteristics.GetTagCount(TAG_ALGORITHM) > 0 ||
125 software_enforced_characteristics.GetTagCount(TAG_KEY_SIZE) > 0 ||
126 software_enforced_characteristics.GetTagCount(TAG_RSA_PUBLIC_EXPONENT) > 0) {
Darren Krahna9474ab2015-11-03 14:38:53 -0800127 VLOG(1) << "Hardware-backed key but required characteristics enforced in software.";
128 hardware_backed = false;
129 }
130 const char kBoldRedFail[] = "\033[1;31mFAIL\033[0m";
131 const char kBoldGreenPass[] = "\033[1;32mPASS\033[0m";
132 const char kBoldYellowWarn[] = "\033[1;33mWARN\033[0m";
133 printf("[%s] %s\n",
134 hardware_backed ? kBoldGreenPass : (required ? kBoldRedFail : kBoldYellowWarn),
135 name.c_str());
136
137 return (hardware_backed || !required);
138}
139
140AuthorizationSet GetRSASignParameters(uint32_t key_size, bool sha256_only) {
141 AuthorizationSetBuilder parameters;
142 parameters.RsaSigningKey(key_size, 65537)
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100143 .Digest(Digest::SHA_2_256)
144 .Padding(PaddingMode::RSA_PKCS1_1_5_SIGN)
145 .Padding(PaddingMode::RSA_PSS)
146 .Authorization(TAG_NO_AUTH_REQUIRED);
Darren Krahna9474ab2015-11-03 14:38:53 -0800147 if (!sha256_only) {
Shawn Willdenbb22a6c2017-12-06 19:35:28 -0700148 parameters.Digest(Digest::SHA_2_224).Digest(Digest::SHA_2_384).Digest(Digest::SHA_2_512);
Darren Krahna9474ab2015-11-03 14:38:53 -0800149 }
Yi Kong53b02f72018-07-26 17:13:50 -0700150 return std::move(parameters);
Darren Krahna9474ab2015-11-03 14:38:53 -0800151}
152
153AuthorizationSet GetRSAEncryptParameters(uint32_t key_size) {
154 AuthorizationSetBuilder parameters;
155 parameters.RsaEncryptionKey(key_size, 65537)
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100156 .Padding(PaddingMode::RSA_PKCS1_1_5_ENCRYPT)
157 .Padding(PaddingMode::RSA_OAEP)
158 .Authorization(TAG_NO_AUTH_REQUIRED);
Yi Kong53b02f72018-07-26 17:13:50 -0700159 return std::move(parameters);
Darren Krahna9474ab2015-11-03 14:38:53 -0800160}
161
162AuthorizationSet GetECDSAParameters(uint32_t key_size, bool sha256_only) {
163 AuthorizationSetBuilder parameters;
164 parameters.EcdsaSigningKey(key_size)
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100165 .Digest(Digest::SHA_2_256)
166 .Authorization(TAG_NO_AUTH_REQUIRED);
Darren Krahna9474ab2015-11-03 14:38:53 -0800167 if (!sha256_only) {
Shawn Willdenbb22a6c2017-12-06 19:35:28 -0700168 parameters.Digest(Digest::SHA_2_224).Digest(Digest::SHA_2_384).Digest(Digest::SHA_2_512);
Darren Krahna9474ab2015-11-03 14:38:53 -0800169 }
Yi Kong53b02f72018-07-26 17:13:50 -0700170 return std::move(parameters);
Darren Krahna9474ab2015-11-03 14:38:53 -0800171}
172
173AuthorizationSet GetAESParameters(uint32_t key_size, bool with_gcm_mode) {
174 AuthorizationSetBuilder parameters;
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100175 parameters.AesEncryptionKey(key_size).Authorization(TAG_NO_AUTH_REQUIRED);
Darren Krahna9474ab2015-11-03 14:38:53 -0800176 if (with_gcm_mode) {
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100177 parameters.Authorization(TAG_BLOCK_MODE, BlockMode::GCM)
178 .Authorization(TAG_MIN_MAC_LENGTH, 128);
Darren Krahna9474ab2015-11-03 14:38:53 -0800179 } else {
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100180 parameters.Authorization(TAG_BLOCK_MODE, BlockMode::ECB);
181 parameters.Authorization(TAG_BLOCK_MODE, BlockMode::CBC);
182 parameters.Authorization(TAG_BLOCK_MODE, BlockMode::CTR);
183 parameters.Padding(PaddingMode::NONE);
Darren Krahna9474ab2015-11-03 14:38:53 -0800184 }
Yi Kong53b02f72018-07-26 17:13:50 -0700185 return std::move(parameters);
Darren Krahna9474ab2015-11-03 14:38:53 -0800186}
187
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100188AuthorizationSet GetHMACParameters(uint32_t key_size, Digest digest) {
Darren Krahna9474ab2015-11-03 14:38:53 -0800189 AuthorizationSetBuilder parameters;
190 parameters.HmacKey(key_size)
191 .Digest(digest)
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100192 .Authorization(TAG_MIN_MAC_LENGTH, 224)
193 .Authorization(TAG_NO_AUTH_REQUIRED);
Yi Kong53b02f72018-07-26 17:13:50 -0700194 return std::move(parameters);
Darren Krahna9474ab2015-11-03 14:38:53 -0800195}
196
197std::vector<TestCase> GetTestCases() {
198 TestCase test_cases[] = {
199 {"RSA-2048 Sign", true, GetRSASignParameters(2048, true)},
200 {"RSA-2048 Sign (more digests)", false, GetRSASignParameters(2048, false)},
201 {"RSA-3072 Sign", false, GetRSASignParameters(3072, false)},
202 {"RSA-4096 Sign", false, GetRSASignParameters(4096, false)},
203 {"RSA-2048 Encrypt", true, GetRSAEncryptParameters(2048)},
204 {"RSA-3072 Encrypt", false, GetRSAEncryptParameters(3072)},
205 {"RSA-4096 Encrypt", false, GetRSAEncryptParameters(4096)},
206 {"ECDSA-P256 Sign", true, GetECDSAParameters(256, true)},
207 {"ECDSA-P256 Sign (more digests)", false, GetECDSAParameters(256, false)},
208 {"ECDSA-P224 Sign", false, GetECDSAParameters(224, false)},
209 {"ECDSA-P384 Sign", false, GetECDSAParameters(384, false)},
210 {"ECDSA-P521 Sign", false, GetECDSAParameters(521, false)},
211 {"AES-128", true, GetAESParameters(128, false)},
212 {"AES-256", true, GetAESParameters(256, false)},
213 {"AES-128-GCM", false, GetAESParameters(128, true)},
214 {"AES-256-GCM", false, GetAESParameters(256, true)},
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100215 {"HMAC-SHA256-16", true, GetHMACParameters(16, Digest::SHA_2_256)},
216 {"HMAC-SHA256-32", true, GetHMACParameters(32, Digest::SHA_2_256)},
217 {"HMAC-SHA256-64", false, GetHMACParameters(64, Digest::SHA_2_256)},
218 {"HMAC-SHA224-32", false, GetHMACParameters(32, Digest::SHA_2_224)},
219 {"HMAC-SHA384-32", false, GetHMACParameters(32, Digest::SHA_2_384)},
220 {"HMAC-SHA512-32", false, GetHMACParameters(32, Digest::SHA_2_512)},
Darren Krahna9474ab2015-11-03 14:38:53 -0800221 };
222 return std::vector<TestCase>(&test_cases[0], &test_cases[arraysize(test_cases)]);
223}
224
Darren Krahn82f4f5b2016-03-03 16:21:07 -0800225int BrilloPlatformTest(const std::string& prefix, bool test_for_0_3) {
226 const char kBoldYellowWarning[] = "\033[1;33mWARNING\033[0m";
227 if (test_for_0_3) {
228 printf("%s: Testing for keymaster v0.3. "
Shawn Willdenbb22a6c2017-12-06 19:35:28 -0700229 "This does not meet Brillo requirements.\n",
230 kBoldYellowWarning);
Darren Krahn82f4f5b2016-03-03 16:21:07 -0800231 }
Darren Krahna9474ab2015-11-03 14:38:53 -0800232 int test_count = 0;
233 int fail_count = 0;
234 std::vector<TestCase> test_cases = GetTestCases();
235 for (const auto& test_case : test_cases) {
Darren Krahn82f4f5b2016-03-03 16:21:07 -0800236 if (!prefix.empty() &&
237 !base::StartsWith(test_case.name, prefix, base::CompareCase::SENSITIVE)) {
238 continue;
239 }
240 if (test_for_0_3 &&
241 (base::StartsWith(test_case.name, "AES", base::CompareCase::SENSITIVE) ||
242 base::StartsWith(test_case.name, "HMAC", base::CompareCase::SENSITIVE))) {
Darren Krahna9474ab2015-11-03 14:38:53 -0800243 continue;
244 }
245 ++test_count;
246 if (!TestKey(test_case.name, test_case.required_for_brillo_pts, test_case.parameters)) {
247 VLOG(1) << "Test failed: " << test_case.name;
248 ++fail_count;
249 }
250 }
251 return fail_count;
252}
253
254int ListTestCases() {
255 const char kBoldGreenRequired[] = "\033[1;32mREQUIRED\033[0m";
256 const char kBoldYellowRecommended[] = "\033[1;33mRECOMMENDED\033[0m";
257 std::vector<TestCase> test_cases = GetTestCases();
258 for (const auto& test_case : test_cases) {
259 printf("%s : %s\n", test_case.name.c_str(),
260 test_case.required_for_brillo_pts ? kBoldGreenRequired : kBoldYellowRecommended);
261 }
262 return 0;
263}
264
Darren Krahn251cb282015-09-28 08:51:18 -0700265std::string ReadFile(const std::string& filename) {
266 std::string content;
267 base::FilePath path(filename);
268 if (!base::ReadFileToString(path, &content)) {
269 printf("Failed to read file: %s\n", filename.c_str());
270 exit(1);
271 }
272 return content;
273}
274
275void WriteFile(const std::string& filename, const std::string& content) {
276 base::FilePath path(filename);
277 int size = content.size();
278 if (base::WriteFile(path, content.data(), size) != size) {
279 printf("Failed to write file: %s\n", filename.c_str());
280 exit(1);
281 }
282}
283
Janis Danisevskisc1460142017-12-18 16:48:46 -0800284int AddEntropy(const std::string& input, int32_t flags) {
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700285 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
Branden Archer70080742018-11-20 11:04:11 -0800286 int32_t result = keystore->addRandomNumberGeneratorEntropy(input, flags).getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700287 printf("AddEntropy: %d\n", result);
288 return result;
289}
290
Rob Barneseb7f79b2018-11-08 15:44:10 -0700291// Note: auth_bound keys created with this tool will not be usable.
292int GenerateKey(const std::string& name, int32_t flags, bool auth_bound) {
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700293 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
294 AuthorizationSetBuilder params;
295 params.RsaSigningKey(2048, 65537)
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100296 .Digest(Digest::SHA_2_224)
297 .Digest(Digest::SHA_2_256)
298 .Digest(Digest::SHA_2_384)
299 .Digest(Digest::SHA_2_512)
300 .Padding(PaddingMode::RSA_PKCS1_1_5_SIGN)
Rob Barneseb7f79b2018-11-08 15:44:10 -0700301 .Padding(PaddingMode::RSA_PSS);
302 if (auth_bound) {
303 // Gatekeeper normally generates the secure user id.
304 // Using zero allows the key to be created, but it will not be usuable.
305 params.Authorization(TAG_USER_SECURE_ID, 0);
306 } else {
307 params.Authorization(TAG_NO_AUTH_REQUIRED);
308 }
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700309 AuthorizationSet hardware_enforced_characteristics;
310 AuthorizationSet software_enforced_characteristics;
Janis Danisevskisc1460142017-12-18 16:48:46 -0800311 auto result = keystore->generateKey(name, params, flags, &hardware_enforced_characteristics,
Shawn Willdenbb22a6c2017-12-06 19:35:28 -0700312 &software_enforced_characteristics);
Branden Archer70080742018-11-20 11:04:11 -0800313 printf("GenerateKey: %d\n", result.getErrorCode());
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100314 if (result.isOk()) {
Darren Krahna9474ab2015-11-03 14:38:53 -0800315 PrintKeyCharacteristics(hardware_enforced_characteristics,
316 software_enforced_characteristics);
317 }
Branden Archer70080742018-11-20 11:04:11 -0800318 return result.getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700319}
320
321int GetCharacteristics(const std::string& name) {
322 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
323 AuthorizationSet hardware_enforced_characteristics;
324 AuthorizationSet software_enforced_characteristics;
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100325 auto result = keystore->getKeyCharacteristics(name, &hardware_enforced_characteristics,
Shawn Willdenbb22a6c2017-12-06 19:35:28 -0700326 &software_enforced_characteristics);
Branden Archer70080742018-11-20 11:04:11 -0800327 printf("GetCharacteristics: %d\n", result.getErrorCode());
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100328 if (result.isOk()) {
Darren Krahna9474ab2015-11-03 14:38:53 -0800329 PrintKeyCharacteristics(hardware_enforced_characteristics,
330 software_enforced_characteristics);
331 }
Branden Archer70080742018-11-20 11:04:11 -0800332 return result.getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700333}
334
335int ExportKey(const std::string& name) {
336 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
337 std::string data;
Branden Archer70080742018-11-20 11:04:11 -0800338 int32_t result = keystore->exportKey(KeyFormat::X509, name, &data).getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700339 printf("ExportKey: %d (%zu)\n", result, data.size());
340 return result;
341}
342
343int DeleteKey(const std::string& name) {
344 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
Branden Archer70080742018-11-20 11:04:11 -0800345 int32_t result = keystore->deleteKey(name).getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700346 printf("DeleteKey: %d\n", result);
347 return result;
348}
349
350int DeleteAllKeys() {
351 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
Branden Archer70080742018-11-20 11:04:11 -0800352 int32_t result = keystore->deleteAllKeys().getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700353 printf("DeleteAllKeys: %d\n", result);
354 return result;
355}
356
357int DoesKeyExist(const std::string& name) {
358 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
359 printf("DoesKeyExist: %s\n", keystore->doesKeyExist(name) ? "yes" : "no");
360 return 0;
361}
362
363int List(const std::string& prefix) {
364 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
365 std::vector<std::string> key_list;
366 if (!keystore->listKeys(prefix, &key_list)) {
367 printf("ListKeys failed.\n");
368 return 1;
369 }
370 printf("Keys:\n");
371 for (const auto& key_name : key_list) {
372 printf(" %s\n", key_name.c_str());
373 }
374 return 0;
375}
376
Rob Barneseb7f79b2018-11-08 15:44:10 -0700377int ListAppsWithKeys() {
378
379 sp<android::IServiceManager> sm = android::defaultServiceManager();
380 sp<android::IBinder> binder = sm->getService(String16("android.security.keystore"));
381 sp<IKeystoreService> service = android::interface_cast<IKeystoreService>(binder);
382 if (service == nullptr) {
383 fprintf(stderr, "Error connecting to keystore service.\n");
384 return 1;
385 }
386 int32_t aidl_return;
Rob Barnes5d59e632018-12-07 16:09:02 -0700387 ::std::vector<::std::string> uids;
Rob Barneseb7f79b2018-11-08 15:44:10 -0700388 android::binder::Status status = service->listUidsOfAuthBoundKeys(&uids, &aidl_return);
389 if (!status.isOk()) {
390 fprintf(stderr, "Requesting uids of auth bound keys failed with error %s.\n",
391 status.toString8().c_str());
392 return 1;
393 }
394 if (!KeyStoreNativeReturnCode(aidl_return).isOk()) {
395 fprintf(stderr, "Requesting uids of auth bound keys failed with code %d.\n", aidl_return);
396 return 1;
397 }
398 printf("Apps with auth bound keys:\n");
399 for (auto i = uids.begin(); i != uids.end(); ++i) {
Rob Barnes5d59e632018-12-07 16:09:02 -0700400 printf("%s\n", i->c_str());
Rob Barneseb7f79b2018-11-08 15:44:10 -0700401 }
402 return 0;
403}
404
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700405int SignAndVerify(const std::string& name) {
406 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
407 AuthorizationSetBuilder sign_params;
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100408 sign_params.Padding(PaddingMode::RSA_PKCS1_1_5_SIGN);
409 sign_params.Digest(Digest::SHA_2_256);
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700410 AuthorizationSet output_params;
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100411 uint64_t handle;
Shawn Willdenbb22a6c2017-12-06 19:35:28 -0700412 auto result =
413 keystore->beginOperation(KeyPurpose::SIGN, name, sign_params, &output_params, &handle);
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100414 if (!result.isOk()) {
Branden Archer70080742018-11-20 11:04:11 -0800415 printf("Sign: BeginOperation failed: %d\n", result.getErrorCode());
416 return result.getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700417 }
418 AuthorizationSet empty_params;
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700419 std::string output_data;
Rob Barnes3af223f2019-11-14 14:50:30 -0700420 result = keystore->finishOperation(handle, empty_params, "data_to_sign",
421 std::string() /*signature_to_verify*/, &output_params,
422 &output_data);
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100423 if (!result.isOk()) {
Branden Archer70080742018-11-20 11:04:11 -0800424 printf("Sign: FinishOperation failed: %d\n", result.getErrorCode());
425 return result.getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700426 }
427 printf("Sign: %zu bytes.\n", output_data.size());
428 // We have a signature, now verify it.
429 std::string signature_to_verify = output_data;
Darren Krahn251cb282015-09-28 08:51:18 -0700430 output_data.clear();
Shawn Willdenbb22a6c2017-12-06 19:35:28 -0700431 result =
432 keystore->beginOperation(KeyPurpose::VERIFY, name, sign_params, &output_params, &handle);
Rob Barnes3af223f2019-11-14 14:50:30 -0700433 result = keystore->finishOperation(handle, empty_params, "data_to_sign", signature_to_verify,
434 &output_params, &output_data);
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100435 if (result == ErrorCode::VERIFICATION_FAILED) {
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700436 printf("Verify: Failed to verify signature.\n");
Branden Archer70080742018-11-20 11:04:11 -0800437 return result.getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700438 }
Janis Danisevskisc7a9fa22016-10-13 18:43:45 +0100439 if (!result.isOk()) {
Branden Archer70080742018-11-20 11:04:11 -0800440 printf("Verify: FinishOperation failed: %d\n", result.getErrorCode());
441 return result.getErrorCode();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700442 }
443 printf("Verify: OK\n");
444 return 0;
445}
446
Darren Krahn251cb282015-09-28 08:51:18 -0700447int Encrypt(const std::string& key_name, const std::string& input_filename,
Janis Danisevskisc1460142017-12-18 16:48:46 -0800448 const std::string& output_filename, int32_t flags) {
Darren Krahn251cb282015-09-28 08:51:18 -0700449 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
450 std::string input = ReadFile(input_filename);
451 std::string output;
Janis Danisevskisc1460142017-12-18 16:48:46 -0800452 if (!keystore->encryptWithAuthentication(key_name, input, flags, &output)) {
Darren Krahn251cb282015-09-28 08:51:18 -0700453 printf("EncryptWithAuthentication failed.\n");
454 return 1;
455 }
456 WriteFile(output_filename, output);
457 return 0;
458}
459
460int Decrypt(const std::string& key_name, const std::string& input_filename,
461 const std::string& output_filename) {
462 std::unique_ptr<KeystoreClient> keystore = CreateKeystoreInstance();
463 std::string input = ReadFile(input_filename);
464 std::string output;
465 if (!keystore->decryptWithAuthentication(key_name, input, &output)) {
466 printf("DecryptWithAuthentication failed.\n");
467 return 1;
468 }
469 WriteFile(output_filename, output);
470 return 0;
471}
472
Janis Danisevskisc1460142017-12-18 16:48:46 -0800473uint32_t securityLevelOption2Flags(const CommandLine& cmd) {
474 if (cmd.HasSwitch("seclevel")) {
475 auto str = cmd.GetSwitchValueASCII("seclevel");
476 if (str == "strongbox") {
477 return KEYSTORE_FLAG_STRONGBOX;
478 } else if (str == "software") {
479 return KEYSTORE_FLAG_FALLBACK;
480 }
481 }
482 return KEYSTORE_FLAG_NONE;
483}
484
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -0800485class ConfirmationListener
486 : public android::security::BnConfirmationPromptCallback,
487 public std::promise<std::tuple<ConfirmationResponseCode, std::vector<uint8_t>>> {
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500488 public:
489 ConfirmationListener() {}
490
491 virtual ::android::binder::Status
492 onConfirmationPromptCompleted(int32_t result,
493 const ::std::vector<uint8_t>& dataThatWasConfirmed) override {
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -0800494 this->set_value({static_cast<ConfirmationResponseCode>(result), dataThatWasConfirmed});
495 return ::android::binder::Status::ok();
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500496 }
497};
498
499int Confirmation(const std::string& promptText, const std::string& extraDataHex,
500 const std::string& locale, const std::string& uiOptionsStr,
501 const std::string& cancelAfter) {
502 sp<android::IServiceManager> sm = android::defaultServiceManager();
503 sp<android::IBinder> binder = sm->getService(String16("android.security.keystore"));
504 sp<IKeystoreService> service = android::interface_cast<IKeystoreService>(binder);
Yi Konge353f252018-07-30 01:38:39 -0700505 if (service == nullptr) {
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500506 printf("error: could not connect to keystore service.\n");
507 return 1;
508 }
509
510 if (promptText.size() == 0) {
Janis Danisevskis1a8d5802018-03-14 13:38:07 -0700511 printf("The --prompt_text parameter cannot be empty.\n");
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500512 return 1;
513 }
514
515 std::vector<uint8_t> extraData;
516 if (!base::HexStringToBytes(extraDataHex, &extraData)) {
517 printf("The --extra_data parameter does not appear to be valid hexadecimal.\n");
518 return 1;
519 }
520
521 std::vector<std::string> pieces =
522 base::SplitString(uiOptionsStr, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_NONEMPTY);
523 int uiOptionsAsFlags = 0;
524 for (auto& p : pieces) {
525 int value;
526 if (!base::StringToInt(p, &value)) {
527 printf("Error parsing %s in --ui_options parameter as a number.\n", p.c_str());
528 return 1;
529 }
530 uiOptionsAsFlags |= (1 << value);
531 }
532
533 double cancelAfterValue = 0.0;
534
535 if (cancelAfter.size() > 0 && !base::StringToDouble(cancelAfter, &cancelAfterValue)) {
536 printf("Error parsing %s in --cancel_after parameter as a double.\n", cancelAfter.c_str());
537 return 1;
538 }
539
540 String16 promptText16(promptText.data(), promptText.size());
541 String16 locale16(locale.data(), locale.size());
542
543 sp<ConfirmationListener> listener = new ConfirmationListener();
544
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -0800545 auto future = listener->get_future();
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500546 int32_t aidl_return;
547 android::binder::Status status = service->presentConfirmationPrompt(
548 listener, promptText16, extraData, locale16, uiOptionsAsFlags, &aidl_return);
549 if (!status.isOk()) {
550 printf("Presenting confirmation prompt failed with binder status '%s'.\n",
551 status.toString8().c_str());
552 return 1;
553 }
554 ConfirmationResponseCode responseCode = static_cast<ConfirmationResponseCode>(aidl_return);
555 if (responseCode != ConfirmationResponseCode::OK) {
556 printf("Presenting confirmation prompt failed with response code %d.\n", responseCode);
557 return 1;
558 }
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -0800559 printf("Waiting for prompt to complete - use Ctrl+C to abort...\n");
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500560
561 if (cancelAfterValue > 0.0) {
562 printf("Sleeping %.1f seconds before canceling prompt...\n", cancelAfterValue);
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -0800563 auto fstatus =
564 future.wait_for(std::chrono::milliseconds(uint64_t(cancelAfterValue * 1000)));
565 if (fstatus == std::future_status::timeout) {
566 status = service->cancelConfirmationPrompt(listener, &aidl_return);
567 if (!status.isOk()) {
568 printf("Canceling confirmation prompt failed with binder status '%s'.\n",
569 status.toString8().c_str());
570 return 1;
571 }
572 responseCode = static_cast<ConfirmationResponseCode>(aidl_return);
573 if (responseCode == ConfirmationResponseCode::Ignored) {
574 // The confirmation was completed by the user so take the response
575 } else if (responseCode != ConfirmationResponseCode::OK) {
576 printf("Canceling confirmation prompt failed with response code %d.\n",
577 responseCode);
578 return 1;
579 }
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500580 }
581 }
582
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -0800583 future.wait();
584
585 auto [rc, dataThatWasConfirmed] = future.get();
586
587 printf("Confirmation prompt completed\n"
588 "responseCode = %d\n",
589 rc);
590 printf("dataThatWasConfirmed[%zd] = {", dataThatWasConfirmed.size());
591 size_t newLineCountDown = 16;
592 bool hasPrinted = false;
593 for (uint8_t element : dataThatWasConfirmed) {
594 if (hasPrinted) {
595 printf(", ");
596 }
597 if (newLineCountDown == 0) {
598 printf("\n ");
599 newLineCountDown = 32;
600 }
601 printf("0x%02x", element);
602 hasPrinted = true;
603 }
604 printf("}\n");
605
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500606 return 0;
607}
608
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700609} // namespace
610
611int main(int argc, char** argv) {
612 CommandLine::Init(argc, argv);
613 CommandLine* command_line = CommandLine::ForCurrentProcess();
614 CommandLine::StringVector args = command_line->GetArgs();
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -0800615
Janis Danisevskisba2985a2018-11-14 21:10:39 -0800616 android::ProcessState::self()->startThreadPool();
Janis Danisevskis4aec5bc2018-11-14 20:36:55 -0800617
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700618 if (args.empty()) {
619 PrintUsageAndExit();
620 }
Darren Krahna9474ab2015-11-03 14:38:53 -0800621 if (args[0] == "brillo-platform-test") {
Darren Krahn82f4f5b2016-03-03 16:21:07 -0800622 return BrilloPlatformTest(command_line->GetSwitchValueASCII("prefix"),
623 command_line->HasSwitch("test_for_0_3"));
Darren Krahna9474ab2015-11-03 14:38:53 -0800624 } else if (args[0] == "list-brillo-tests") {
625 return ListTestCases();
626 } else if (args[0] == "add-entropy") {
Janis Danisevskisc1460142017-12-18 16:48:46 -0800627 return AddEntropy(command_line->GetSwitchValueASCII("input"),
628 securityLevelOption2Flags(*command_line));
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700629 } else if (args[0] == "generate") {
Janis Danisevskisc1460142017-12-18 16:48:46 -0800630 return GenerateKey(command_line->GetSwitchValueASCII("name"),
Rob Barneseb7f79b2018-11-08 15:44:10 -0700631 securityLevelOption2Flags(*command_line),
632 command_line->HasSwitch("auth_bound"));
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700633 } else if (args[0] == "get-chars") {
634 return GetCharacteristics(command_line->GetSwitchValueASCII("name"));
635 } else if (args[0] == "export") {
636 return ExportKey(command_line->GetSwitchValueASCII("name"));
637 } else if (args[0] == "delete") {
638 return DeleteKey(command_line->GetSwitchValueASCII("name"));
639 } else if (args[0] == "delete-all") {
640 return DeleteAllKeys();
641 } else if (args[0] == "exists") {
642 return DoesKeyExist(command_line->GetSwitchValueASCII("name"));
643 } else if (args[0] == "list") {
644 return List(command_line->GetSwitchValueASCII("prefix"));
Rob Barneseb7f79b2018-11-08 15:44:10 -0700645 } else if (args[0] == "list-apps-with-keys") {
646 return ListAppsWithKeys();
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700647 } else if (args[0] == "sign-verify") {
648 return SignAndVerify(command_line->GetSwitchValueASCII("name"));
Darren Krahn251cb282015-09-28 08:51:18 -0700649 } else if (args[0] == "encrypt") {
Janis Danisevskisc1460142017-12-18 16:48:46 -0800650 return Encrypt(
651 command_line->GetSwitchValueASCII("name"), command_line->GetSwitchValueASCII("in"),
652 command_line->GetSwitchValueASCII("out"), securityLevelOption2Flags(*command_line));
Darren Krahn251cb282015-09-28 08:51:18 -0700653 } else if (args[0] == "decrypt") {
654 return Decrypt(command_line->GetSwitchValueASCII("name"),
655 command_line->GetSwitchValueASCII("in"),
656 command_line->GetSwitchValueASCII("out"));
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500657 } else if (args[0] == "confirmation") {
Janis Danisevskis1a8d5802018-03-14 13:38:07 -0700658 return Confirmation(command_line->GetSwitchValueNative("prompt_text"),
David Zeuthenc6eb7cd2017-11-27 11:33:55 -0500659 command_line->GetSwitchValueASCII("extra_data"),
660 command_line->GetSwitchValueASCII("locale"),
661 command_line->GetSwitchValueASCII("ui_options"),
662 command_line->GetSwitchValueASCII("cancel_after"));
Darren Krahn69a3dbc2015-09-22 16:21:04 -0700663 } else {
664 PrintUsageAndExit();
665 }
666 return 0;
667}