Subrahmanyaman | afb7487 | 2022-07-21 03:24:48 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2022 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 | #define LOG_TAG "gatekeeper_aidl_hal_test" |
| 18 | |
| 19 | #include <inttypes.h> |
| 20 | #include <unistd.h> |
| 21 | |
| 22 | #include <algorithm> |
| 23 | #include <cmath> |
| 24 | #include <string> |
| 25 | #include <vector> |
| 26 | |
| 27 | #include <aidl/Gtest.h> |
| 28 | #include <aidl/Vintf.h> |
| 29 | #include <aidl/android/hardware/gatekeeper/GatekeeperEnrollResponse.h> |
| 30 | #include <aidl/android/hardware/gatekeeper/GatekeeperVerifyResponse.h> |
| 31 | #include <aidl/android/hardware/gatekeeper/IGatekeeper.h> |
| 32 | #include <aidl/android/hardware/security/keymint/HardwareAuthToken.h> |
| 33 | #include <android-base/endian.h> |
| 34 | #include <android/binder_manager.h> |
| 35 | #include <android/binder_process.h> |
| 36 | #include <hardware/hw_auth_token.h> |
| 37 | |
| 38 | #include <log/log.h> |
| 39 | |
| 40 | using aidl::android::hardware::gatekeeper::GatekeeperEnrollResponse; |
| 41 | using aidl::android::hardware::gatekeeper::GatekeeperVerifyResponse; |
| 42 | using aidl::android::hardware::gatekeeper::IGatekeeper; |
| 43 | using aidl::android::hardware::security::keymint::HardwareAuthToken; |
| 44 | using Status = ::ndk::ScopedAStatus; |
| 45 | |
| 46 | struct GatekeeperRequest { |
| 47 | uint32_t uid; |
| 48 | uint64_t challenge; |
| 49 | std::vector<uint8_t> curPwdHandle; |
| 50 | std::vector<uint8_t> curPwd; |
| 51 | std::vector<uint8_t> newPwd; |
| 52 | GatekeeperRequest() : uid(0), challenge(0) {} |
| 53 | }; |
| 54 | |
| 55 | // ASSERT_* macros generate return "void" internally |
| 56 | // we have to use EXPECT_* if we return anything but "void" |
| 57 | static void verifyAuthToken(GatekeeperVerifyResponse& rsp) { |
| 58 | uint32_t auth_type = static_cast<uint32_t>(rsp.hardwareAuthToken.authenticatorType); |
| 59 | uint64_t auth_tstamp = static_cast<uint64_t>(rsp.hardwareAuthToken.timestamp.milliSeconds); |
| 60 | |
| 61 | EXPECT_EQ(HW_AUTH_PASSWORD, auth_type); |
| 62 | EXPECT_NE(UINT64_C(~0), auth_tstamp); |
| 63 | ALOGI("Authenticator ID: %016" PRIX64, rsp.hardwareAuthToken.authenticatorId); |
| 64 | EXPECT_NE(UINT32_C(0), rsp.hardwareAuthToken.userId); |
| 65 | } |
| 66 | |
| 67 | // The main test class for Gatekeeper AIDL HAL. |
| 68 | class GatekeeperAidlTest : public ::testing::TestWithParam<std::string> { |
| 69 | protected: |
| 70 | void setUid(uint32_t uid) { uid_ = uid; } |
| 71 | |
| 72 | Status doEnroll(GatekeeperRequest& req, GatekeeperEnrollResponse& rsp) { |
| 73 | Status ret; |
| 74 | while (true) { |
| 75 | ret = gatekeeper_->enroll(uid_, req.curPwdHandle, req.curPwd, req.newPwd, &rsp); |
| 76 | if (ret.isOk()) break; |
| 77 | if (getReturnStatusCode(ret) != IGatekeeper::ERROR_RETRY_TIMEOUT) break; |
| 78 | ALOGI("%s: got retry code; retrying in 1 sec", __func__); |
| 79 | sleep(1); |
| 80 | } |
| 81 | return ret; |
| 82 | } |
| 83 | |
| 84 | Status doVerify(GatekeeperRequest& req, GatekeeperVerifyResponse& rsp) { |
| 85 | Status ret; |
| 86 | while (true) { |
| 87 | ret = gatekeeper_->verify(uid_, req.challenge, req.curPwdHandle, req.newPwd, &rsp); |
| 88 | if (ret.isOk()) break; |
| 89 | if (getReturnStatusCode(ret) != IGatekeeper::ERROR_RETRY_TIMEOUT) break; |
| 90 | ALOGI("%s: got retry code; retrying in 1 sec", __func__); |
| 91 | sleep(1); |
| 92 | } |
| 93 | return ret; |
| 94 | } |
| 95 | |
| 96 | Status doDeleteUser() { return gatekeeper_->deleteUser(uid_); } |
| 97 | |
| 98 | Status doDeleteAllUsers() { return gatekeeper_->deleteAllUsers(); } |
| 99 | |
| 100 | void generatePassword(std::vector<uint8_t>& password, uint8_t seed) { |
| 101 | password.resize(16); |
| 102 | memset(password.data(), seed, password.size()); |
| 103 | } |
| 104 | |
| 105 | void checkEnroll(GatekeeperEnrollResponse& rsp, Status& ret, bool expectSuccess) { |
| 106 | if (expectSuccess) { |
| 107 | EXPECT_TRUE(ret.isOk()); |
| 108 | EXPECT_EQ(IGatekeeper::STATUS_OK, rsp.statusCode); |
| 109 | EXPECT_NE(nullptr, rsp.data.data()); |
| 110 | EXPECT_GT(rsp.data.size(), UINT32_C(0)); |
| 111 | EXPECT_NE(UINT32_C(0), rsp.secureUserId); |
| 112 | } else { |
| 113 | EXPECT_EQ(IGatekeeper::ERROR_GENERAL_FAILURE, getReturnStatusCode(ret)); |
| 114 | EXPECT_EQ(UINT32_C(0), rsp.data.size()); |
| 115 | } |
| 116 | } |
| 117 | |
| 118 | void checkVerify(GatekeeperVerifyResponse& rsp, Status& ret, uint64_t challenge, |
| 119 | bool expectSuccess) { |
| 120 | if (expectSuccess) { |
| 121 | EXPECT_TRUE(ret.isOk()); |
| 122 | EXPECT_GE(rsp.statusCode, IGatekeeper::STATUS_OK); |
| 123 | EXPECT_LE(rsp.statusCode, IGatekeeper::STATUS_REENROLL); |
| 124 | |
| 125 | verifyAuthToken(rsp); |
| 126 | EXPECT_EQ(challenge, rsp.hardwareAuthToken.challenge); |
| 127 | } else { |
| 128 | EXPECT_EQ(IGatekeeper::ERROR_GENERAL_FAILURE, getReturnStatusCode(ret)); |
| 129 | } |
| 130 | } |
| 131 | |
| 132 | void enrollNewPassword(std::vector<uint8_t>& password, GatekeeperEnrollResponse& rsp, |
| 133 | bool expectSuccess) { |
| 134 | GatekeeperRequest req; |
| 135 | req.newPwd = password; |
| 136 | Status ret = doEnroll(req, rsp); |
| 137 | checkEnroll(rsp, ret, expectSuccess); |
| 138 | } |
| 139 | |
| 140 | void verifyPassword(std::vector<uint8_t>& password, std::vector<uint8_t>& passwordHandle, |
| 141 | uint64_t challenge, GatekeeperVerifyResponse& verifyRsp, |
| 142 | bool expectSuccess) { |
| 143 | GatekeeperRequest verifyReq; |
| 144 | |
| 145 | // build verify request for the same password (we want it to succeed) |
| 146 | verifyReq.newPwd = password; |
| 147 | // use enrolled password handle we've got |
| 148 | verifyReq.curPwdHandle = passwordHandle; |
| 149 | verifyReq.challenge = challenge; |
| 150 | Status ret = doVerify(verifyReq, verifyRsp); |
| 151 | checkVerify(verifyRsp, ret, challenge, expectSuccess); |
| 152 | } |
| 153 | |
| 154 | int32_t getReturnStatusCode(const Status& result) { |
| 155 | if (!result.isOk()) { |
| 156 | if (result.getExceptionCode() == EX_SERVICE_SPECIFIC) { |
| 157 | return result.getServiceSpecificError(); |
| 158 | } |
| 159 | return IGatekeeper::ERROR_GENERAL_FAILURE; |
| 160 | } |
| 161 | return IGatekeeper::STATUS_OK; |
| 162 | } |
| 163 | |
| 164 | protected: |
| 165 | std::shared_ptr<IGatekeeper> gatekeeper_; |
| 166 | uint32_t uid_; |
| 167 | |
| 168 | public: |
| 169 | GatekeeperAidlTest() : uid_(0) {} |
| 170 | virtual void SetUp() override { |
| 171 | gatekeeper_ = IGatekeeper::fromBinder( |
| 172 | ndk::SpAIBinder(AServiceManager_waitForService(GetParam().c_str()))); |
| 173 | ASSERT_NE(nullptr, gatekeeper_.get()); |
| 174 | doDeleteAllUsers(); |
| 175 | } |
| 176 | |
| 177 | virtual void TearDown() override { doDeleteAllUsers(); } |
| 178 | }; |
| 179 | |
| 180 | /** |
| 181 | * Ensure we can enroll new password |
| 182 | */ |
| 183 | TEST_P(GatekeeperAidlTest, EnrollSuccess) { |
| 184 | std::vector<uint8_t> password; |
| 185 | GatekeeperEnrollResponse rsp; |
| 186 | ALOGI("Testing Enroll (expected success)"); |
| 187 | generatePassword(password, 0); |
| 188 | enrollNewPassword(password, rsp, true); |
| 189 | ALOGI("Testing Enroll done"); |
| 190 | } |
| 191 | |
| 192 | /** |
| 193 | * Ensure we can not enroll empty password |
| 194 | */ |
| 195 | TEST_P(GatekeeperAidlTest, EnrollNoPassword) { |
| 196 | std::vector<uint8_t> password; |
| 197 | GatekeeperEnrollResponse rsp; |
| 198 | ALOGI("Testing Enroll (expected failure)"); |
| 199 | enrollNewPassword(password, rsp, false); |
| 200 | ALOGI("Testing Enroll done"); |
| 201 | } |
| 202 | |
| 203 | /** |
| 204 | * Ensure we can successfully verify previously enrolled password |
| 205 | */ |
| 206 | TEST_P(GatekeeperAidlTest, VerifySuccess) { |
| 207 | GatekeeperEnrollResponse enrollRsp; |
| 208 | GatekeeperVerifyResponse verifyRsp; |
| 209 | std::vector<uint8_t> password; |
| 210 | |
| 211 | ALOGI("Testing Enroll+Verify (expected success)"); |
| 212 | generatePassword(password, 0); |
| 213 | enrollNewPassword(password, enrollRsp, true); |
| 214 | verifyPassword(password, enrollRsp.data, 1, verifyRsp, true); |
| 215 | |
| 216 | ALOGI("Testing unenrolled password doesn't verify"); |
| 217 | verifyRsp = {0, 0, {}}; |
| 218 | generatePassword(password, 1); |
| 219 | verifyPassword(password, enrollRsp.data, 1, verifyRsp, false); |
| 220 | ALOGI("Testing Enroll+Verify done"); |
| 221 | } |
| 222 | |
| 223 | /** |
| 224 | * Ensure we can securely update password (keep the same |
| 225 | * secure user_id) if we prove we know old password |
| 226 | */ |
| 227 | TEST_P(GatekeeperAidlTest, TrustedReenroll) { |
| 228 | GatekeeperEnrollResponse enrollRsp; |
| 229 | GatekeeperRequest reenrollReq; |
| 230 | GatekeeperEnrollResponse reenrollRsp; |
| 231 | GatekeeperVerifyResponse verifyRsp; |
| 232 | GatekeeperVerifyResponse reenrollVerifyRsp; |
| 233 | std::vector<uint8_t> password; |
| 234 | std::vector<uint8_t> newPassword; |
| 235 | |
| 236 | generatePassword(password, 0); |
| 237 | |
| 238 | ALOGI("Testing Trusted Reenroll (expected success)"); |
| 239 | enrollNewPassword(password, enrollRsp, true); |
| 240 | verifyPassword(password, enrollRsp.data, 0, verifyRsp, true); |
| 241 | ALOGI("Primary Enroll+Verify done"); |
| 242 | |
| 243 | generatePassword(newPassword, 1); |
| 244 | reenrollReq.newPwd = newPassword; |
| 245 | reenrollReq.curPwd = password; |
| 246 | reenrollReq.curPwdHandle = enrollRsp.data; |
| 247 | |
| 248 | Status ret = doEnroll(reenrollReq, reenrollRsp); |
| 249 | checkEnroll(reenrollRsp, ret, true); |
| 250 | verifyPassword(newPassword, reenrollRsp.data, 0, reenrollVerifyRsp, true); |
| 251 | ALOGI("Trusted ReEnroll+Verify done"); |
| 252 | |
| 253 | verifyAuthToken(verifyRsp); |
| 254 | verifyAuthToken(reenrollVerifyRsp); |
| 255 | EXPECT_EQ(verifyRsp.hardwareAuthToken.userId, reenrollVerifyRsp.hardwareAuthToken.userId); |
| 256 | ALOGI("Testing Trusted Reenroll done"); |
| 257 | } |
| 258 | |
| 259 | /** |
| 260 | * Ensure we can update password (and get new |
| 261 | * secure user_id) if we don't know old password |
| 262 | */ |
| 263 | TEST_P(GatekeeperAidlTest, UntrustedReenroll) { |
| 264 | GatekeeperEnrollResponse enrollRsp; |
| 265 | GatekeeperEnrollResponse reenrollRsp; |
| 266 | GatekeeperVerifyResponse verifyRsp; |
| 267 | GatekeeperVerifyResponse reenrollVerifyRsp; |
| 268 | std::vector<uint8_t> password; |
| 269 | std::vector<uint8_t> newPassword; |
| 270 | |
| 271 | ALOGI("Testing Untrusted Reenroll (expected success)"); |
| 272 | generatePassword(password, 0); |
| 273 | enrollNewPassword(password, enrollRsp, true); |
| 274 | verifyPassword(password, enrollRsp.data, 0, verifyRsp, true); |
| 275 | ALOGI("Primary Enroll+Verify done"); |
| 276 | |
| 277 | generatePassword(newPassword, 1); |
| 278 | enrollNewPassword(newPassword, reenrollRsp, true); |
| 279 | verifyPassword(newPassword, reenrollRsp.data, 0, reenrollVerifyRsp, true); |
| 280 | ALOGI("Untrusted ReEnroll+Verify done"); |
| 281 | |
| 282 | verifyAuthToken(verifyRsp); |
| 283 | verifyAuthToken(reenrollVerifyRsp); |
| 284 | EXPECT_NE(verifyRsp.hardwareAuthToken.userId, reenrollVerifyRsp.hardwareAuthToken.userId); |
| 285 | ALOGI("Testing Untrusted Reenroll done"); |
| 286 | } |
| 287 | |
| 288 | /** |
| 289 | * Ensure we don't get successful verify with invalid data |
| 290 | */ |
| 291 | TEST_P(GatekeeperAidlTest, VerifyNoData) { |
| 292 | std::vector<uint8_t> password; |
| 293 | std::vector<uint8_t> passwordHandle; |
| 294 | GatekeeperVerifyResponse verifyRsp; |
| 295 | |
| 296 | ALOGI("Testing Verify (expected failure)"); |
| 297 | verifyPassword(password, passwordHandle, 0, verifyRsp, false); |
| 298 | ALOGI("Testing Verify done"); |
| 299 | } |
| 300 | |
| 301 | /** |
| 302 | * Ensure we can not verify password after we enrolled it and then deleted user |
| 303 | */ |
| 304 | TEST_P(GatekeeperAidlTest, DeleteUserTest) { |
| 305 | std::vector<uint8_t> password; |
| 306 | GatekeeperEnrollResponse enrollRsp; |
| 307 | GatekeeperVerifyResponse verifyRsp; |
| 308 | ALOGI("Testing deleteUser (expected success)"); |
| 309 | setUid(10001); |
| 310 | generatePassword(password, 0); |
| 311 | enrollNewPassword(password, enrollRsp, true); |
| 312 | verifyPassword(password, enrollRsp.data, 0, verifyRsp, true); |
| 313 | ALOGI("Enroll+Verify done"); |
| 314 | auto result = doDeleteUser(); |
| 315 | EXPECT_TRUE(result.isOk() || |
| 316 | (getReturnStatusCode(result) == IGatekeeper::ERROR_NOT_IMPLEMENTED)); |
| 317 | ALOGI("DeleteUser done"); |
| 318 | if (result.isOk()) { |
| 319 | verifyRsp = {0, 0, {}}; |
| 320 | verifyPassword(password, enrollRsp.data, 0, verifyRsp, false); |
| 321 | ALOGI("Verify after Delete done (must fail)"); |
| 322 | } |
| 323 | ALOGI("Testing deleteUser done: rsp=%" PRIi32, getReturnStatusCode(result)); |
| 324 | } |
| 325 | |
| 326 | /** |
| 327 | * Ensure we can not delete a user that does not exist |
| 328 | */ |
| 329 | TEST_P(GatekeeperAidlTest, DeleteInvalidUserTest) { |
| 330 | std::vector<uint8_t> password; |
| 331 | GatekeeperEnrollResponse enrollRsp; |
| 332 | GatekeeperVerifyResponse verifyRsp; |
| 333 | ALOGI("Testing deleteUser (expected failure)"); |
| 334 | setUid(10002); |
| 335 | generatePassword(password, 0); |
| 336 | enrollNewPassword(password, enrollRsp, true); |
| 337 | verifyPassword(password, enrollRsp.data, 0, verifyRsp, true); |
| 338 | ALOGI("Enroll+Verify done"); |
| 339 | |
| 340 | // Delete the user |
| 341 | Status result1 = doDeleteUser(); |
| 342 | EXPECT_TRUE(result1.isOk() || |
| 343 | (getReturnStatusCode(result1) == IGatekeeper::ERROR_NOT_IMPLEMENTED)); |
| 344 | |
| 345 | // Delete the user again |
| 346 | Status result2 = doDeleteUser(); |
| 347 | int32_t retCode2 = getReturnStatusCode(result2); |
| 348 | EXPECT_TRUE((retCode2 == IGatekeeper::ERROR_NOT_IMPLEMENTED) || |
| 349 | (retCode2 == IGatekeeper::ERROR_GENERAL_FAILURE)); |
| 350 | ALOGI("DeleteUser done"); |
| 351 | ALOGI("Testing deleteUser done: rsp=%" PRIi32, retCode2); |
| 352 | } |
| 353 | |
| 354 | /** |
| 355 | * Ensure we can not verify passwords after we enrolled them and then deleted |
| 356 | * all users |
| 357 | */ |
| 358 | TEST_P(GatekeeperAidlTest, DeleteAllUsersTest) { |
| 359 | struct UserData { |
| 360 | uint32_t userId; |
| 361 | std::vector<uint8_t> password; |
| 362 | GatekeeperEnrollResponse enrollRsp; |
| 363 | GatekeeperVerifyResponse verifyRsp; |
| 364 | UserData(int id) { userId = id; } |
| 365 | } users[3]{10001, 10002, 10003}; |
| 366 | ALOGI("Testing deleteAllUsers (expected success)"); |
| 367 | |
| 368 | // enroll multiple users |
| 369 | for (size_t i = 0; i < sizeof(users) / sizeof(users[0]); ++i) { |
| 370 | setUid(users[i].userId); |
| 371 | generatePassword(users[i].password, (i % 255) + 1); |
| 372 | enrollNewPassword(users[i].password, users[i].enrollRsp, true); |
| 373 | } |
| 374 | ALOGI("Multiple users enrolled"); |
| 375 | |
| 376 | // verify multiple users |
| 377 | for (size_t i = 0; i < sizeof(users) / sizeof(users[0]); ++i) { |
| 378 | setUid(users[i].userId); |
| 379 | verifyPassword(users[i].password, users[i].enrollRsp.data, 0, users[i].verifyRsp, true); |
| 380 | } |
| 381 | ALOGI("Multiple users verified"); |
| 382 | |
| 383 | Status result = doDeleteAllUsers(); |
| 384 | EXPECT_TRUE(result.isOk() || |
| 385 | (getReturnStatusCode(result) == IGatekeeper::ERROR_NOT_IMPLEMENTED)); |
| 386 | ALOGI("All users deleted"); |
| 387 | |
| 388 | if (result.isOk()) { |
| 389 | // verify multiple users after they are deleted; all must fail |
| 390 | for (size_t i = 0; i < sizeof(users) / sizeof(users[0]); ++i) { |
| 391 | setUid(users[i].userId); |
| 392 | users[i].verifyRsp = {0, 0, {}}; |
| 393 | verifyPassword(users[i].password, users[i].enrollRsp.data, 0, users[i].verifyRsp, |
| 394 | false); |
| 395 | } |
| 396 | ALOGI("Multiple users verified after delete (all must fail)"); |
| 397 | } |
| 398 | |
| 399 | ALOGI("Testing deleteAllUsers done: rsp=%" PRIi32, getReturnStatusCode(result)); |
| 400 | } |
| 401 | |
| 402 | GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(GatekeeperAidlTest); |
| 403 | INSTANTIATE_TEST_SUITE_P( |
| 404 | PerInstance, GatekeeperAidlTest, |
| 405 | testing::ValuesIn(android::getAidlHalInstanceNames(IGatekeeper::descriptor)), |
| 406 | android::PrintInstanceNameToString); |
| 407 | |
| 408 | int main(int argc, char** argv) { |
| 409 | ::testing::InitGoogleTest(&argc, argv); |
| 410 | ABinderProcess_setThreadPoolMaxThreadCount(1); |
| 411 | ABinderProcess_startThreadPool(); |
| 412 | return RUN_ALL_TESTS(); |
| 413 | } |