1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/trusted_vault/icloud_keychain_recovery_factor.h"
#include <algorithm>
#include <optional>
#include "base/functional/callback_helpers.h"
#include "base/strings/strcat.h"
#include "base/task/bind_post_task.h"
#include "components/trusted_vault/icloud_recovery_key_mac.h"
#include "components/trusted_vault/proto/vault.pb.h"
#include "components/trusted_vault/securebox.h"
#include "components/trusted_vault/trusted_vault_connection.h"
#include "components/trusted_vault/trusted_vault_crypto.h"
#include "components/trusted_vault/trusted_vault_histograms.h"
#include "components/trusted_vault/trusted_vault_server_constants.h"
namespace trusted_vault {
namespace {
constexpr char kICloudKeychainRecoveryKeyAccessGroupSuffix[] =
".com.google.common.folsom";
std::optional<std::vector<std::vector<uint8_t>>> DecryptTrustedVaultWrappedKeys(
const SecureBoxPrivateKey& private_key,
const std::vector<MemberKeys>& member_keys) {
std::vector<std::vector<uint8_t>> decrypted_keys;
for (const auto& member_key : member_keys) {
std::optional<std::vector<uint8_t>> decrypted_key =
DecryptTrustedVaultWrappedKey(private_key, member_key.wrapped_key);
if (!decrypted_key) {
return std::nullopt;
}
decrypted_keys.emplace_back(*decrypted_key);
}
return decrypted_keys;
}
} // namespace
ICloudKeychainRecoveryFactor::ICloudKeychainRecoveryFactor(
const std::string& icloud_keychain_access_group_prefix,
SecurityDomainId security_domain_id,
StandaloneTrustedVaultStorage* storage,
TrustedVaultThrottlingConnection* connection,
CoreAccountInfo primary_account)
: icloud_keychain_access_group_(
base::StrCat({icloud_keychain_access_group_prefix,
kICloudKeychainRecoveryKeyAccessGroupSuffix})),
security_domain_id_(security_domain_id),
storage_(storage),
connection_(connection),
primary_account_(primary_account) {
CHECK(storage_);
CHECK(connection_);
}
ICloudKeychainRecoveryFactor::~ICloudKeychainRecoveryFactor() = default;
LocalRecoveryFactorType ICloudKeychainRecoveryFactor::GetRecoveryFactorType()
const {
return LocalRecoveryFactorType::kICloudKeychain;
}
void ICloudKeychainRecoveryFactor::AttemptRecovery(AttemptRecoveryCallback cb) {
auto* per_user_vault = GetPrimaryAccountVault();
if (StandaloneTrustedVaultStorage::HasNonConstantKey(*per_user_vault)) {
// iCloud Keychain is only used to recover keys if there were no
// non-constant keys available previously.
FulfillRecoveryWithFailure(
TrustedVaultDownloadKeysStatusForUMA::kKeyProofVerificationNotSupported,
std::move(cb));
return;
}
// ICloudRecoveryKey::Retrieve() can't be cancelled, so we use a weak pointer
// for the callback.
ICloudRecoveryKey::Retrieve(
base::BindOnce(
&ICloudKeychainRecoveryFactor::OnICloudKeysRetrievedForRecovery,
weak_ptr_factory_.GetWeakPtr(), std::move(cb)),
security_domain_id_, icloud_keychain_access_group_);
}
void ICloudKeychainRecoveryFactor::OnICloudKeysRetrievedForRecovery(
AttemptRecoveryCallback cb,
std::vector<std::unique_ptr<ICloudRecoveryKey>> local_icloud_keys) {
if (local_icloud_keys.empty()) {
MarkAsNotRegistered();
FulfillRecoveryWithFailure(
TrustedVaultDownloadKeysStatusForUMA::kDeviceNotRegistered,
std::move(cb));
return;
}
if (connection_->AreRequestsThrottled(primary_account_)) {
// Keys download attempt is not possible.
FulfillRecoveryWithFailure(
TrustedVaultDownloadKeysStatusForUMA::kThrottledClientSide,
std::move(cb));
return;
}
ongoing_download_registration_state_request_for_recovery_ =
connection_->DownloadAuthenticationFactorsRegistrationState(
primary_account_,
{trusted_vault_pb::SecurityDomainMember::MEMBER_TYPE_ICLOUD_KEYCHAIN},
base::BindOnce(&ICloudKeychainRecoveryFactor::
OnRecoveryFactorStateDownloadedForRecovery,
// `this` outlives `ongoing_request_for_recovery_`.
base::Unretained(this), std::move(cb),
std::move(local_icloud_keys)),
base::NullCallback());
CHECK(ongoing_download_registration_state_request_for_recovery_);
}
void ICloudKeychainRecoveryFactor::OnRecoveryFactorStateDownloadedForRecovery(
AttemptRecoveryCallback cb,
std::vector<std::unique_ptr<ICloudRecoveryKey>> local_icloud_keys,
DownloadAuthenticationFactorsRegistrationStateResult result) {
// This method should be called only as a result of
// `ongoing_request_for_recovery_` completion/failure, verify this condition
// and destroy `ongoing_request_for_recovery_` as it's not needed anymore.
CHECK(ongoing_download_registration_state_request_for_recovery_);
ongoing_download_registration_state_request_for_recovery_ = nullptr;
if (result.state ==
DownloadAuthenticationFactorsRegistrationStateResult::State::kError) {
connection_->RecordFailedRequestForThrottling(primary_account_);
FulfillRecoveryWithFailure(
TrustedVaultDownloadKeysStatusForUMA::kNetworkError, std::move(cb));
return;
}
TrustedVaultDownloadKeysStatusForUMA last_status =
TrustedVaultDownloadKeysStatusForUMA::kDeviceNotRegistered;
for (const VaultMember& recovery_icloud_key : result.icloud_keys) {
if (recovery_icloud_key.member_keys.size() == 0) {
last_status = TrustedVaultDownloadKeysStatusForUMA::kMembershipEmpty;
continue;
}
const std::vector<uint8_t> public_key =
recovery_icloud_key.public_key->ExportToBytes();
const auto local_icloud_key_it = std::ranges::find_if(
local_icloud_keys,
[&public_key](const auto& key) { return key->id() == public_key; });
if (local_icloud_key_it != local_icloud_keys.end()) {
std::optional<std::vector<std::vector<uint8_t>>> new_vault_keys =
DecryptTrustedVaultWrappedKeys(
(*local_icloud_key_it)->key()->private_key(),
recovery_icloud_key.member_keys);
if (!new_vault_keys) {
last_status =
TrustedVaultDownloadKeysStatusForUMA::kMembershipCorrupted;
continue;
}
// Success: all keys were successfully decrypted.
RecordTrustedVaultDownloadKeysStatus(
LocalRecoveryFactorType::kICloudKeychain, security_domain_id_,
TrustedVaultDownloadKeysStatusForUMA::kSuccess);
int last_vault_key_version =
std::ranges::max_element(recovery_icloud_key.member_keys, {},
&MemberKeys::version)
->version;
MarkAsRegistered();
std::move(cb).Run(RecoveryStatus::kSuccess, *new_vault_keys,
last_vault_key_version);
return;
}
}
// None of the retrieved iCloud Keychain keys is in the security domain -
// fail with the last status. This makes sure to record that status only once
// per recovery attempt rather than once per vault member, which could skew
// the metrics.
MarkAsNotRegistered();
FulfillRecoveryWithFailure(last_status, std::move(cb));
}
void ICloudKeychainRecoveryFactor::FulfillRecoveryWithFailure(
TrustedVaultDownloadKeysStatusForUMA status_for_uma,
AttemptRecoveryCallback cb) {
RecordTrustedVaultDownloadKeysStatus(LocalRecoveryFactorType::kICloudKeychain,
security_domain_id_, status_for_uma);
base::BindPostTaskToCurrentDefault(
base::BindOnce(std::move(cb), RecoveryStatus::kFailure,
/*new_vault_keys=*/std::vector<std::vector<uint8_t>>(),
/*last_vault_key_version=*/0))
.Run();
}
bool ICloudKeychainRecoveryFactor::IsRegistered() {
auto* per_user_vault = GetPrimaryAccountVault();
return per_user_vault->icloud_keychain_registration_info().registered();
}
void ICloudKeychainRecoveryFactor::MarkAsNotRegistered() {
auto* per_user_vault = GetPrimaryAccountVault();
per_user_vault->mutable_icloud_keychain_registration_info()->set_registered(
false);
storage_->WriteDataToDisk();
}
void ICloudKeychainRecoveryFactor::MarkAsRegistered() {
auto* per_user_vault = GetPrimaryAccountVault();
per_user_vault->mutable_icloud_keychain_registration_info()->set_registered(
true);
storage_->WriteDataToDisk();
}
TrustedVaultRecoveryFactorRegistrationStateForUMA
ICloudKeychainRecoveryFactor::MaybeRegister(RegisterCallback cb) {
auto* per_user_vault = GetPrimaryAccountVault();
if (per_user_vault->icloud_keychain_registration_info().registered()) {
return TrustedVaultRecoveryFactorRegistrationStateForUMA::
kAlreadyRegisteredV1;
}
if (per_user_vault->last_registration_returned_local_data_obsolete()) {
// Client already knows that existing vault keys (or their absence) isn't
// sufficient for registration. Fresh keys should be obtained first.
return TrustedVaultRecoveryFactorRegistrationStateForUMA::
kLocalKeysAreStale;
}
if (connection_->AreRequestsThrottled(primary_account_)) {
return TrustedVaultRecoveryFactorRegistrationStateForUMA::
kThrottledClientSide;
}
if (!StandaloneTrustedVaultStorage::HasNonConstantKey(*per_user_vault)) {
// Registration without non-constant keys isn't supported for iCloud
// Keychain.
return TrustedVaultRecoveryFactorRegistrationStateForUMA::
kRegistrationWithConstantKeyNotSupported;
}
// ICloudRecoveryKey::Retrieve() can't be cancelled, so we use a weak pointer
// for the callback.
ICloudRecoveryKey::Retrieve(
base::BindOnce(
&ICloudKeychainRecoveryFactor::OnICloudKeysRetrievedForRegistration,
weak_ptr_factory_.GetWeakPtr(), std::move(cb)),
security_domain_id_, icloud_keychain_access_group_);
// We don't know yet whether there's an existing key pair in iCloud Keychain.
// However, if there is one that's not yet registered with the security
// domain, then we have to create a new key pair anyways. Thus, returning
// `kAttemptingRegistrationWithNewKeyPair` is the most appropriate status
// here.
return TrustedVaultRecoveryFactorRegistrationStateForUMA::
kAttemptingRegistrationWithNewKeyPair;
}
void ICloudKeychainRecoveryFactor::OnICloudKeysRetrievedForRegistration(
RegisterCallback cb,
std::vector<std::unique_ptr<ICloudRecoveryKey>> local_icloud_keys) {
if (local_icloud_keys.empty()) {
// No local iCloud Keychain key. We need to create a new one and register
// it.
ICloudRecoveryKey::Create(
base::BindOnce(
&ICloudKeychainRecoveryFactor::OnICloudKeyCreatedForRegistration,
weak_ptr_factory_.GetWeakPtr(), std::move(cb)),
security_domain_id_, icloud_keychain_access_group_);
return;
}
ongoing_download_registration_state_request_for_registration_ =
connection_->DownloadAuthenticationFactorsRegistrationState(
primary_account_,
{trusted_vault_pb::SecurityDomainMember::MEMBER_TYPE_ICLOUD_KEYCHAIN},
base::BindOnce(&ICloudKeychainRecoveryFactor::
OnRecoveryFactorStateDownloadedForRegistration,
// `this` outlives `ongoing_request_for_registration_`.
base::Unretained(this), std::move(cb),
std::move(local_icloud_keys)),
base::NullCallback());
CHECK(ongoing_download_registration_state_request_for_registration_);
}
void ICloudKeychainRecoveryFactor::
OnRecoveryFactorStateDownloadedForRegistration(
RegisterCallback cb,
std::vector<std::unique_ptr<ICloudRecoveryKey>> local_icloud_keys,
DownloadAuthenticationFactorsRegistrationStateResult result) {
// This method should be called only as a result of
// `ongoing_request_for_registration_` completion/failure, verify this
// condition and destroy `ongoing_request_for_registration_` as it's not
// needed anymore.
CHECK(ongoing_download_registration_state_request_for_registration_);
ongoing_download_registration_state_request_for_registration_ = nullptr;
if (result.state ==
DownloadAuthenticationFactorsRegistrationStateResult::State::kError) {
connection_->RecordFailedRequestForThrottling(primary_account_);
FulfillRegistrationWithFailure(
TrustedVaultRegistrationStatus::kNetworkError, std::move(cb));
return;
}
for (const VaultMember& recovery_icloud_key : result.icloud_keys) {
std::vector<uint8_t> public_key =
recovery_icloud_key.public_key->ExportToBytes();
const auto local_icloud_key_it = std::ranges::find_if(
local_icloud_keys,
[&public_key](const auto& key) { return key->id() == public_key; });
if (local_icloud_key_it != local_icloud_keys.end()) {
MarkAsRegistered();
int last_vault_key_version =
std::ranges::max_element(recovery_icloud_key.member_keys, {},
&MemberKeys::version)
->version;
base::BindPostTaskToCurrentDefault(
base::BindOnce(std::move(cb),
TrustedVaultRegistrationStatus::kAlreadyRegistered,
last_vault_key_version, /*had_local_keys=*/true))
.Run();
return;
}
}
// None of the retrieved iCloud Keychain keys is in the security domain. We
// need to create a new one and register it.
ICloudRecoveryKey::Create(
base::BindOnce(
&ICloudKeychainRecoveryFactor::OnICloudKeyCreatedForRegistration,
weak_ptr_factory_.GetWeakPtr(), std::move(cb)),
security_domain_id_, icloud_keychain_access_group_);
}
void ICloudKeychainRecoveryFactor::OnICloudKeyCreatedForRegistration(
RegisterCallback cb,
std::unique_ptr<ICloudRecoveryKey> local_icloud_key) {
if (!local_icloud_key) {
FulfillRegistrationWithFailure(TrustedVaultRegistrationStatus::kOtherError,
std::move(cb));
return;
}
auto* per_user_vault = GetPrimaryAccountVault();
ongoing_registration_request_ = connection_->RegisterAuthenticationFactor(
primary_account_,
GetTrustedVaultKeysWithVersions(
StandaloneTrustedVaultStorage::GetAllVaultKeys(*per_user_vault),
per_user_vault->last_vault_key_version()),
local_icloud_key->key()->public_key(), ICloudKeychain(),
base::BindOnce(&ICloudKeychainRecoveryFactor::OnRegistered,
base::Unretained(this), std::move(cb)));
CHECK(ongoing_registration_request_);
}
void ICloudKeychainRecoveryFactor::OnRegistered(
RegisterCallback cb,
TrustedVaultRegistrationStatus status,
int key_version) {
// This method should be called only as a result of
// `ongoing_registration_request_` completion/failure, verify this
// condition and destroy `ongoing_registration_request_` as it's not
// needed anymore.
CHECK(ongoing_registration_request_);
ongoing_registration_request_ = nullptr;
auto* per_user_vault = GetPrimaryAccountVault();
switch (status) {
case TrustedVaultRegistrationStatus::kSuccess:
case TrustedVaultRegistrationStatus::kAlreadyRegistered:
// kAlreadyRegistered handled as success, because it only means that
// client doesn't fully handled successful device registration before.
per_user_vault->mutable_icloud_keychain_registration_info()
->set_registered(true);
per_user_vault->clear_last_registration_returned_local_data_obsolete();
storage_->WriteDataToDisk();
break;
case TrustedVaultRegistrationStatus::kLocalDataObsolete:
per_user_vault->set_last_registration_returned_local_data_obsolete(true);
storage_->WriteDataToDisk();
break;
case TrustedVaultRegistrationStatus::kTransientAccessTokenFetchError:
case TrustedVaultRegistrationStatus::kPersistentAccessTokenFetchError:
case TrustedVaultRegistrationStatus::
kPrimaryAccountChangeAccessTokenFetchError:
case TrustedVaultRegistrationStatus::kNetworkError:
case TrustedVaultRegistrationStatus::kOtherError:
break;
}
std::move(cb).Run(status,
/*key_version=*/key_version,
/*had_local_keys=*/true);
}
void ICloudKeychainRecoveryFactor::FulfillRegistrationWithFailure(
TrustedVaultRegistrationStatus status,
RegisterCallback cb) {
std::move(cb).Run(status,
/*key_version=*/0,
/*had_local_keys=*/true);
}
trusted_vault_pb::LocalTrustedVaultPerUser*
ICloudKeychainRecoveryFactor::GetPrimaryAccountVault() {
auto* per_user_vault = storage_->FindUserVault(primary_account_.gaia);
// ICloudKeychainRecoveryFactor is only constructed by
// StandaloneTrustedVaultBackend when a primary account is set, and it also
// ensures that there is a user vault in storage at the same time.
CHECK(per_user_vault);
return per_user_vault;
}
} // namespace trusted_vault
|