multidevice_setup_impl.cc 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  1. // Copyright 2018 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include <utility>
  5. #include <vector>
  6. #include "ash/services/multidevice_setup/multidevice_setup_impl.h"
  7. #include "ash/components/multidevice/logging/logging.h"
  8. #include "ash/constants/ash_features.h"
  9. #include "ash/services/multidevice_setup/account_status_change_delegate_notifier_impl.h"
  10. #include "ash/services/multidevice_setup/android_sms_app_installing_status_observer.h"
  11. #include "ash/services/multidevice_setup/eligible_host_devices_provider_impl.h"
  12. #include "ash/services/multidevice_setup/feature_state_manager_impl.h"
  13. #include "ash/services/multidevice_setup/global_state_feature_manager.h"
  14. #include "ash/services/multidevice_setup/global_state_feature_manager_impl.h"
  15. #include "ash/services/multidevice_setup/grandfathered_easy_unlock_host_disabler.h"
  16. #include "ash/services/multidevice_setup/host_backend_delegate_impl.h"
  17. #include "ash/services/multidevice_setup/host_device_timestamp_manager_impl.h"
  18. #include "ash/services/multidevice_setup/host_status_provider_impl.h"
  19. #include "ash/services/multidevice_setup/host_verifier_impl.h"
  20. #include "ash/services/multidevice_setup/public/cpp/android_sms_app_helper_delegate.h"
  21. #include "ash/services/multidevice_setup/public/cpp/android_sms_pairing_state_tracker.h"
  22. #include "ash/services/multidevice_setup/public/cpp/auth_token_validator.h"
  23. #include "ash/services/multidevice_setup/public/cpp/oobe_completion_tracker.h"
  24. #include "ash/services/multidevice_setup/public/mojom/multidevice_setup.mojom.h"
  25. #include "ash/services/multidevice_setup/wifi_sync_notification_controller.h"
  26. #include "base/containers/contains.h"
  27. #include "base/containers/flat_set.h"
  28. #include "base/memory/ptr_util.h"
  29. #include "base/metrics/histogram_functions.h"
  30. #include "base/metrics/histogram_macros.h"
  31. #include "base/time/default_clock.h"
  32. namespace ash {
  33. namespace multidevice_setup {
  34. namespace {
  35. const char kTestDeviceNameForDebugNotification[] = "Test Device";
  36. // This enum is tied directly to a UMA enum defined in
  37. // //tools/metrics/histograms/enums.xml, and should always reflect it (do not
  38. // change one without changing the other). Entries should be never modified
  39. // or deleted. Only additions possible.
  40. enum class VerifyAndForgetHostConfirmationState {
  41. kButtonClickedState = 0,
  42. kCompletedSetupState = 1,
  43. kMaxValue = kCompletedSetupState,
  44. };
  45. static void LogForgetHostConfirmed(VerifyAndForgetHostConfirmationState state) {
  46. UMA_HISTOGRAM_ENUMERATION("MultiDevice.ForgetHostConfirmed", state);
  47. }
  48. static void LogVerifyButtonClicked(VerifyAndForgetHostConfirmationState state) {
  49. UMA_HISTOGRAM_ENUMERATION("MultiDevice.VerifyButtonClicked", state);
  50. }
  51. } // namespace
  52. // static
  53. MultiDeviceSetupImpl::Factory* MultiDeviceSetupImpl::Factory::test_factory_ =
  54. nullptr;
  55. // static
  56. std::unique_ptr<MultiDeviceSetupBase> MultiDeviceSetupImpl::Factory::Create(
  57. PrefService* pref_service,
  58. device_sync::DeviceSyncClient* device_sync_client,
  59. AuthTokenValidator* auth_token_validator,
  60. OobeCompletionTracker* oobe_completion_tracker,
  61. AndroidSmsAppHelperDelegate* android_sms_app_helper_delegate,
  62. AndroidSmsPairingStateTracker* android_sms_pairing_state_tracker,
  63. const device_sync::GcmDeviceInfoProvider* gcm_device_info_provider,
  64. bool is_secondary_user) {
  65. if (test_factory_) {
  66. return test_factory_->CreateInstance(
  67. pref_service, device_sync_client, auth_token_validator,
  68. oobe_completion_tracker, android_sms_app_helper_delegate,
  69. android_sms_pairing_state_tracker, gcm_device_info_provider,
  70. is_secondary_user);
  71. }
  72. return base::WrapUnique(new MultiDeviceSetupImpl(
  73. pref_service, device_sync_client, auth_token_validator,
  74. oobe_completion_tracker, android_sms_app_helper_delegate,
  75. android_sms_pairing_state_tracker, gcm_device_info_provider,
  76. is_secondary_user));
  77. }
  78. // static
  79. void MultiDeviceSetupImpl::Factory::SetFactoryForTesting(
  80. Factory* test_factory) {
  81. test_factory_ = test_factory;
  82. }
  83. MultiDeviceSetupImpl::Factory::~Factory() = default;
  84. MultiDeviceSetupImpl::MultiDeviceSetupImpl(
  85. PrefService* pref_service,
  86. device_sync::DeviceSyncClient* device_sync_client,
  87. AuthTokenValidator* auth_token_validator,
  88. OobeCompletionTracker* oobe_completion_tracker,
  89. AndroidSmsAppHelperDelegate* android_sms_app_helper_delegate,
  90. AndroidSmsPairingStateTracker* android_sms_pairing_state_tracker,
  91. const device_sync::GcmDeviceInfoProvider* gcm_device_info_provider,
  92. bool is_secondary_user)
  93. : eligible_host_devices_provider_(
  94. EligibleHostDevicesProviderImpl::Factory::Create(device_sync_client)),
  95. host_backend_delegate_(HostBackendDelegateImpl::Factory::Create(
  96. eligible_host_devices_provider_.get(),
  97. pref_service,
  98. device_sync_client)),
  99. host_verifier_(
  100. HostVerifierImpl::Factory::Create(host_backend_delegate_.get(),
  101. device_sync_client,
  102. pref_service)),
  103. host_status_provider_(HostStatusProviderImpl::Factory::Create(
  104. eligible_host_devices_provider_.get(),
  105. host_backend_delegate_.get(),
  106. host_verifier_.get(),
  107. device_sync_client)),
  108. grandfathered_easy_unlock_host_disabler_(
  109. GrandfatheredEasyUnlockHostDisabler::Factory::Create(
  110. host_backend_delegate_.get(),
  111. device_sync_client,
  112. pref_service)),
  113. host_device_timestamp_manager_(
  114. HostDeviceTimestampManagerImpl::Factory::Create(
  115. host_status_provider_.get(),
  116. pref_service,
  117. base::DefaultClock::GetInstance())),
  118. delegate_notifier_(
  119. AccountStatusChangeDelegateNotifierImpl::Factory::Create(
  120. host_status_provider_.get(),
  121. pref_service,
  122. host_device_timestamp_manager_.get(),
  123. oobe_completion_tracker,
  124. base::DefaultClock::GetInstance())),
  125. wifi_sync_feature_manager_(GlobalStateFeatureManagerImpl::Factory::Create(
  126. GlobalStateFeatureManagerImpl::Factory::Option::kWifiSync,
  127. host_status_provider_.get(),
  128. pref_service,
  129. device_sync_client)),
  130. wifi_sync_notification_controller_(
  131. WifiSyncNotificationController::Factory::Create(
  132. wifi_sync_feature_manager_.get(),
  133. host_status_provider_.get(),
  134. pref_service,
  135. device_sync_client,
  136. delegate_notifier_.get())),
  137. feature_state_manager_(FeatureStateManagerImpl::Factory::Create(
  138. pref_service,
  139. host_status_provider_.get(),
  140. device_sync_client,
  141. android_sms_pairing_state_tracker,
  142. {{mojom::Feature::kWifiSync, wifi_sync_feature_manager_.get()}},
  143. is_secondary_user)),
  144. android_sms_app_installing_host_observer_(
  145. android_sms_app_helper_delegate
  146. ? AndroidSmsAppInstallingStatusObserver::Factory::Create(
  147. host_status_provider_.get(),
  148. feature_state_manager_.get(),
  149. android_sms_app_helper_delegate,
  150. pref_service)
  151. : nullptr),
  152. auth_token_validator_(auth_token_validator) {
  153. host_status_provider_->AddObserver(this);
  154. feature_state_manager_->AddObserver(this);
  155. }
  156. MultiDeviceSetupImpl::~MultiDeviceSetupImpl() {
  157. host_status_provider_->RemoveObserver(this);
  158. feature_state_manager_->RemoveObserver(this);
  159. }
  160. void MultiDeviceSetupImpl::SetAccountStatusChangeDelegate(
  161. mojo::PendingRemote<mojom::AccountStatusChangeDelegate> delegate) {
  162. delegate_notifier_->SetAccountStatusChangeDelegateRemote(std::move(delegate));
  163. }
  164. void MultiDeviceSetupImpl::AddHostStatusObserver(
  165. mojo::PendingRemote<mojom::HostStatusObserver> observer) {
  166. host_status_observers_.Add(std::move(observer));
  167. }
  168. void MultiDeviceSetupImpl::AddFeatureStateObserver(
  169. mojo::PendingRemote<mojom::FeatureStateObserver> observer) {
  170. feature_state_observers_.Add(std::move(observer));
  171. }
  172. void MultiDeviceSetupImpl::GetEligibleHostDevices(
  173. GetEligibleHostDevicesCallback callback) {
  174. std::vector<multidevice::RemoteDevice> eligible_remote_devices;
  175. for (const auto& remote_device_ref :
  176. eligible_host_devices_provider_->GetEligibleHostDevices()) {
  177. eligible_remote_devices.push_back(remote_device_ref.GetRemoteDevice());
  178. }
  179. std::move(callback).Run(eligible_remote_devices);
  180. }
  181. void MultiDeviceSetupImpl::GetEligibleActiveHostDevices(
  182. GetEligibleActiveHostDevicesCallback callback) {
  183. // For metrics.
  184. bool has_duplicate_host_name = false;
  185. base::flat_set<std::string> name_set;
  186. std::vector<mojom::HostDevicePtr> eligible_active_hosts;
  187. for (const auto& host_device :
  188. eligible_host_devices_provider_->GetEligibleActiveHostDevices()) {
  189. // For metrics.
  190. if (base::Contains(name_set, host_device.remote_device.name())) {
  191. has_duplicate_host_name = true;
  192. PA_LOG(WARNING) << "MultiDeviceSetupImpl::GetEligibleActiveHostDevices: "
  193. << "Detected duplicate eligible host device name \""
  194. << host_device.remote_device.name() << "\"";
  195. } else {
  196. name_set.insert(host_device.remote_device.name());
  197. }
  198. eligible_active_hosts.push_back(
  199. mojom::HostDevice::New(host_device.remote_device.GetRemoteDevice(),
  200. host_device.connectivity_status));
  201. }
  202. base::UmaHistogramBoolean(
  203. "MultiDevice.Setup.HasDuplicateEligibleHostDeviceNames",
  204. has_duplicate_host_name);
  205. std::move(callback).Run(std::move(eligible_active_hosts));
  206. }
  207. void MultiDeviceSetupImpl::SetHostDevice(
  208. const std::string& host_instance_id_or_legacy_device_id,
  209. const std::string& auth_token,
  210. SetHostDeviceCallback callback) {
  211. if (!auth_token_validator_->IsAuthTokenValid(auth_token)) {
  212. std::move(callback).Run(false /* success */);
  213. return;
  214. }
  215. std::move(callback).Run(AttemptSetHost(host_instance_id_or_legacy_device_id));
  216. }
  217. void MultiDeviceSetupImpl::RemoveHostDevice() {
  218. LogForgetHostConfirmed(
  219. VerifyAndForgetHostConfirmationState::kButtonClickedState);
  220. host_backend_delegate_->AttemptToSetMultiDeviceHostOnBackend(
  221. absl::nullopt /* host_device */);
  222. }
  223. void MultiDeviceSetupImpl::GetHostStatus(GetHostStatusCallback callback) {
  224. HostStatusProvider::HostStatusWithDevice host_status_with_device =
  225. host_status_provider_->GetHostWithStatus();
  226. // The Mojo API requires a raw multidevice::RemoteDevice instead of a
  227. // multidevice::RemoteDeviceRef.
  228. absl::optional<multidevice::RemoteDevice> device_for_callback;
  229. if (host_status_with_device.host_device()) {
  230. device_for_callback =
  231. host_status_with_device.host_device()->GetRemoteDevice();
  232. }
  233. std::move(callback).Run(host_status_with_device.host_status(),
  234. device_for_callback);
  235. }
  236. void MultiDeviceSetupImpl::SetFeatureEnabledState(
  237. mojom::Feature feature,
  238. bool enabled,
  239. const absl::optional<std::string>& auth_token,
  240. SetFeatureEnabledStateCallback callback) {
  241. if (IsAuthTokenRequiredForFeatureStateChange(feature, enabled) &&
  242. (!auth_token || !auth_token_validator_->IsAuthTokenValid(*auth_token))) {
  243. PA_LOG(ERROR) << __func__ << " Cannot " << (enabled ? "enable" : "disable")
  244. << " " << feature << "; auth token invalid";
  245. std::move(callback).Run(false /* success */);
  246. return;
  247. }
  248. std::move(callback).Run(
  249. feature_state_manager_->SetFeatureEnabledState(feature, enabled));
  250. }
  251. void MultiDeviceSetupImpl::GetFeatureStates(GetFeatureStatesCallback callback) {
  252. std::move(callback).Run(feature_state_manager_->GetFeatureStates());
  253. }
  254. void MultiDeviceSetupImpl::RetrySetHostNow(RetrySetHostNowCallback callback) {
  255. LogVerifyButtonClicked(
  256. VerifyAndForgetHostConfirmationState::kButtonClickedState);
  257. HostStatusProvider::HostStatusWithDevice host_status_with_device =
  258. host_status_provider_->GetHostWithStatus();
  259. if (host_status_with_device.host_status() ==
  260. mojom::HostStatus::kHostSetLocallyButWaitingForBackendConfirmation) {
  261. host_backend_delegate_->AttemptToSetMultiDeviceHostOnBackend(
  262. *host_backend_delegate_->GetPendingHostRequest());
  263. std::move(callback).Run(true /* success */);
  264. return;
  265. }
  266. if (host_status_with_device.host_status() ==
  267. mojom::HostStatus::kHostSetButNotYetVerified) {
  268. host_verifier_->AttemptVerificationNow();
  269. std::move(callback).Run(true /* success */);
  270. return;
  271. }
  272. // RetrySetHostNow() was called when there was nothing to retry.
  273. std::move(callback).Run(false /* success */);
  274. }
  275. void MultiDeviceSetupImpl::TriggerEventForDebugging(
  276. mojom::EventTypeForDebugging type,
  277. TriggerEventForDebuggingCallback callback) {
  278. if (!delegate_notifier_->delegate_remote_) {
  279. PA_LOG(ERROR) << "MultiDeviceSetupImpl::TriggerEventForDebugging(): No "
  280. << "delgate has been set; cannot proceed.";
  281. std::move(callback).Run(false /* success */);
  282. return;
  283. }
  284. PA_LOG(VERBOSE) << "MultiDeviceSetupImpl::TriggerEventForDebugging(" << type
  285. << ") called.";
  286. mojom::AccountStatusChangeDelegate* delegate =
  287. delegate_notifier_->delegate_remote_.get();
  288. switch (type) {
  289. case mojom::EventTypeForDebugging::kNewUserPotentialHostExists:
  290. delegate->OnPotentialHostExistsForNewUser();
  291. break;
  292. case mojom::EventTypeForDebugging::kExistingUserConnectedHostSwitched:
  293. delegate->OnConnectedHostSwitchedForExistingUser(
  294. kTestDeviceNameForDebugNotification);
  295. break;
  296. case mojom::EventTypeForDebugging::kExistingUserNewChromebookAdded:
  297. delegate->OnNewChromebookAddedForExistingUser(
  298. kTestDeviceNameForDebugNotification);
  299. break;
  300. default:
  301. NOTREACHED();
  302. }
  303. std::move(callback).Run(true /* success */);
  304. }
  305. void MultiDeviceSetupImpl::SetHostDeviceWithoutAuthToken(
  306. const std::string& host_instance_id_or_legacy_device_id,
  307. mojom::PrivilegedHostDeviceSetter::SetHostDeviceCallback callback) {
  308. std::move(callback).Run(AttemptSetHost(host_instance_id_or_legacy_device_id));
  309. }
  310. void MultiDeviceSetupImpl::OnHostStatusChange(
  311. const HostStatusProvider::HostStatusWithDevice& host_status_with_device) {
  312. mojom::HostStatus status_for_callback = host_status_with_device.host_status();
  313. // The Mojo API requires a raw multidevice::RemoteDevice instead of a
  314. // multidevice::RemoteDeviceRef.
  315. absl::optional<multidevice::RemoteDevice> device_for_callback;
  316. if (host_status_with_device.host_device()) {
  317. device_for_callback =
  318. host_status_with_device.host_device()->GetRemoteDevice();
  319. }
  320. for (auto& observer : host_status_observers_)
  321. observer->OnHostStatusChanged(status_for_callback, device_for_callback);
  322. }
  323. void MultiDeviceSetupImpl::OnFeatureStatesChange(
  324. const FeatureStateManager::FeatureStatesMap& feature_states_map) {
  325. for (auto& observer : feature_state_observers_)
  326. observer->OnFeatureStatesChanged(feature_states_map);
  327. }
  328. bool MultiDeviceSetupImpl::AttemptSetHost(
  329. const std::string& host_instance_id_or_legacy_device_id) {
  330. DCHECK(!host_instance_id_or_legacy_device_id.empty());
  331. multidevice::RemoteDeviceRefList eligible_devices =
  332. eligible_host_devices_provider_->GetEligibleHostDevices();
  333. auto it = std::find_if(
  334. eligible_devices.begin(), eligible_devices.end(),
  335. [&host_instance_id_or_legacy_device_id](const auto& eligible_device) {
  336. if (features::ShouldUseV1DeviceSync()) {
  337. return eligible_device.instance_id() ==
  338. host_instance_id_or_legacy_device_id ||
  339. eligible_device.GetDeviceId() ==
  340. host_instance_id_or_legacy_device_id;
  341. }
  342. return eligible_device.instance_id() ==
  343. host_instance_id_or_legacy_device_id;
  344. });
  345. if (it == eligible_devices.end())
  346. return false;
  347. LogForgetHostConfirmed(
  348. VerifyAndForgetHostConfirmationState::kCompletedSetupState);
  349. LogVerifyButtonClicked(
  350. VerifyAndForgetHostConfirmationState::kCompletedSetupState);
  351. host_backend_delegate_->AttemptToSetMultiDeviceHostOnBackend(*it);
  352. return true;
  353. }
  354. bool MultiDeviceSetupImpl::IsAuthTokenRequiredForFeatureStateChange(
  355. mojom::Feature feature,
  356. bool enabled) {
  357. // Disabling a feature never requires authentication.
  358. if (!enabled)
  359. return false;
  360. // Enabling SmartLock always requires authentication.
  361. if (feature == mojom::Feature::kSmartLock)
  362. return true;
  363. // Enabling any feature besides SmartLock and the Better Together suite does
  364. // not require authentication.
  365. if (feature != mojom::Feature::kBetterTogetherSuite)
  366. return false;
  367. mojom::FeatureState smart_lock_state =
  368. feature_state_manager_->GetFeatureStates()[mojom::Feature::kSmartLock];
  369. // If the user is enabling the Better Together suite and this change would
  370. // result in SmartLock being implicitly enabled, authentication is required.
  371. // SmartLock is implicitly enabled if it is only currently not enabled due
  372. // to the suite being disabled or due to the SmartLock host device not
  373. // having a lock screen set.
  374. return smart_lock_state == mojom::FeatureState::kUnavailableSuiteDisabled ||
  375. smart_lock_state ==
  376. mojom::FeatureState::kUnavailableInsufficientSecurity;
  377. }
  378. void MultiDeviceSetupImpl::FlushForTesting() {
  379. host_status_observers_.FlushForTesting();
  380. feature_state_observers_.FlushForTesting();
  381. }
  382. } // namespace multidevice_setup
  383. } // namespace ash