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 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chromeos/ash/components/proximity_auth/unlock_manager_impl.h"
#include <memory>
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/default_clock.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "chromeos/ash/components/multidevice/logging/logging.h"
#include "chromeos/ash/components/multidevice/remote_device_ref.h"
#include "chromeos/ash/components/proximity_auth/messenger.h"
#include "chromeos/ash/components/proximity_auth/metrics.h"
#include "chromeos/ash/components/proximity_auth/proximity_auth_client.h"
#include "chromeos/ash/components/proximity_auth/proximity_monitor_impl.h"
#include "chromeos/ash/services/secure_channel/public/cpp/client/client_channel.h"
#include "device/bluetooth/bluetooth_adapter_factory.h"
namespace proximity_auth {
namespace {
using SmartLockState = ash::SmartLockState;
// This enum is tied directly to the SmartLockFindAndConnectToHostResult UMA
// enum defined in //tools/metrics/histograms/metadata/cross_device/enums.xml,
// and should always reflect it (do not change one without changing the other).
// Entries should be never modified or deleted. Only additions possible.
//
// LINT.IfChange(SmartLockFindAndConnectToHostResult)
enum class FindAndConnectToHostResult {
kFoundAndConnectedToHost = 0,
kCanceledBluetoothDisabled = 1,
kCanceledUserEnteredPassword = 2,
kSecureChannelConnectionAttemptFailure = 3,
kTimedOut = 4,
kMaxValue = kTimedOut
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/cross_device/enums.xml:SmartLockFindAndConnectToHostResult)
// The maximum amount of time that the unlock manager can stay in the 'waking
// up' state after resuming from sleep.
constexpr base::TimeDelta kWakingUpDuration = base::Seconds(15);
// The maximum amount of time that we wait for the BluetoothAdapter to be
// fully initialized after resuming from sleep.
// TODO(crbug.com/986896): This is necessary because the BluetoothAdapter
// returns incorrect presence and power values directly after resume, and does
// not return correct values until about 1-2 seconds later. Remove this once
// the bug is fixed.
constexpr base::TimeDelta kBluetoothAdapterResumeMaxDuration = base::Seconds(3);
// The limit on the elapsed time for an auth attempt. If an auth attempt exceeds
// this limit, it will time out and be rejected. This is provided as a failsafe,
// in case something goes wrong.
constexpr base::TimeDelta kAuthAttemptTimeout = base::Seconds(5);
constexpr base::TimeDelta kMinExtendedDuration = base::Milliseconds(1);
constexpr base::TimeDelta kMaxExtendedDuration = base::Seconds(15);
const int kNumDurationMetricBuckets = 100;
const char kGetRemoteStatusNone[] = "none";
const char kGetRemoteStatusSuccess[] = "success";
// The subset of SmartLockStates that represent the first non-trival status
// shown to the user. Entries persisted to UMA histograms; do not reorder or
// delete enum values. Keep in sync with FirstSmartLockStatus in
// //tools/metrics/histograms/metadata/cross_device/enums.xml.
//
// LINT.IfChange(FirstSmartLockStatus)
enum class FirstSmartLockStatus {
kBluetoothDisabled = 0,
kPhoneNotLockable = 1,
kPhoneNotFound = 2,
kPhoneNotAuthenticated = 3,
kPhoneFoundLockedAndDistant = 4,
kPhoneFoundLockedAndProximate = 5,
kPhoneFoundUnlockedAndDistant = 6,
kPhoneAuthenticated = 7,
kPrimaryUserAbsent = 8,
kMaxValue = kPrimaryUserAbsent
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/cross_device/enums.xml:FirstSmartLockStatus)
std::optional<FirstSmartLockStatus> GetFirstSmartLockStatus(
SmartLockState state) {
switch (state) {
case SmartLockState::kBluetoothDisabled:
return FirstSmartLockStatus::kBluetoothDisabled;
case SmartLockState::kPhoneNotLockable:
return FirstSmartLockStatus::kPhoneNotLockable;
case SmartLockState::kPhoneNotFound:
return FirstSmartLockStatus::kPhoneNotFound;
case SmartLockState::kPhoneNotAuthenticated:
return FirstSmartLockStatus::kPhoneNotAuthenticated;
case SmartLockState::kPhoneFoundLockedAndDistant:
return FirstSmartLockStatus::kPhoneFoundLockedAndDistant;
case SmartLockState::kPhoneFoundLockedAndProximate:
return FirstSmartLockStatus::kPhoneFoundLockedAndProximate;
case SmartLockState::kPhoneFoundUnlockedAndDistant:
return FirstSmartLockStatus::kPhoneFoundUnlockedAndDistant;
case SmartLockState::kPhoneAuthenticated:
return FirstSmartLockStatus::kPhoneAuthenticated;
case SmartLockState::kPrimaryUserAbsent:
return FirstSmartLockStatus::kPrimaryUserAbsent;
default:
return std::nullopt;
}
}
// Returns the remote device's security settings state, for metrics,
// corresponding to a remote status update.
metrics::RemoteSecuritySettingsState GetRemoteSecuritySettingsState(
const RemoteStatusUpdate& status_update) {
switch (status_update.secure_screen_lock_state) {
case SECURE_SCREEN_LOCK_STATE_UNKNOWN:
return metrics::RemoteSecuritySettingsState::UNKNOWN;
case SECURE_SCREEN_LOCK_DISABLED:
switch (status_update.trust_agent_state) {
case TRUST_AGENT_UNSUPPORTED:
return metrics::RemoteSecuritySettingsState::
SCREEN_LOCK_DISABLED_TRUST_AGENT_UNSUPPORTED;
case TRUST_AGENT_DISABLED:
return metrics::RemoteSecuritySettingsState::
SCREEN_LOCK_DISABLED_TRUST_AGENT_DISABLED;
case TRUST_AGENT_ENABLED:
return metrics::RemoteSecuritySettingsState::
SCREEN_LOCK_DISABLED_TRUST_AGENT_ENABLED;
}
case SECURE_SCREEN_LOCK_ENABLED:
switch (status_update.trust_agent_state) {
case TRUST_AGENT_UNSUPPORTED:
return metrics::RemoteSecuritySettingsState::
SCREEN_LOCK_ENABLED_TRUST_AGENT_UNSUPPORTED;
case TRUST_AGENT_DISABLED:
return metrics::RemoteSecuritySettingsState::
SCREEN_LOCK_ENABLED_TRUST_AGENT_DISABLED;
case TRUST_AGENT_ENABLED:
return metrics::RemoteSecuritySettingsState::
SCREEN_LOCK_ENABLED_TRUST_AGENT_ENABLED;
}
}
NOTREACHED();
}
std::string GetHistogramStatusSuffix(bool unlockable) {
return unlockable ? "Unlockable" : "Other";
}
void RecordFindAndConnectToHostResult(FindAndConnectToHostResult result) {
base::UmaHistogramEnumeration("SmartLock.FindAndConnectToHostResult.Unlock",
result);
}
void RecordAuthResultFailure(
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason failure_reason) {
SmartLockMetricsRecorder::RecordAuthResultUnlockFailure(failure_reason);
}
void RecordExtendedDurationTimerMetric(const std::string& histogram_name,
base::TimeDelta duration) {
// Use a custom |max| to account for Smart Lock's timeout (larger than the
// default 10 seconds).
base::UmaHistogramCustomTimes(
histogram_name, duration, kMinExtendedDuration /* min */,
kMaxExtendedDuration /* max */, kNumDurationMetricBuckets /* buckets */);
}
bool HasCommunicatedWithPhone(SmartLockState state) {
switch (state) {
case SmartLockState::kDisabled:
[[fallthrough]];
case SmartLockState::kInactive:
[[fallthrough]];
case SmartLockState::kBluetoothDisabled:
[[fallthrough]];
case SmartLockState::kPhoneNotFound:
[[fallthrough]];
case SmartLockState::kConnectingToPhone:
return false;
case SmartLockState::kPhoneNotLockable:
[[fallthrough]];
case SmartLockState::kPhoneNotAuthenticated:
[[fallthrough]];
case SmartLockState::kPhoneFoundLockedAndDistant:
[[fallthrough]];
case SmartLockState::kPhoneFoundLockedAndProximate:
[[fallthrough]];
case SmartLockState::kPhoneFoundUnlockedAndDistant:
[[fallthrough]];
case SmartLockState::kPhoneAuthenticated:
[[fallthrough]];
case SmartLockState::kPrimaryUserAbsent:
return true;
}
}
} // namespace
UnlockManagerImpl::UnlockManagerImpl(ProximityAuthClient* proximity_auth_client)
: proximity_auth_client_(proximity_auth_client),
bluetooth_suspension_recovery_timer_(
std::make_unique<base::OneShotTimer>()) {
chromeos::PowerManagerClient::Get()->AddObserver(this);
if (device::BluetoothAdapterFactory::IsBluetoothSupported()) {
device::BluetoothAdapterFactory::Get()->GetAdapter(
base::BindOnce(&UnlockManagerImpl::OnBluetoothAdapterInitialized,
weak_ptr_factory_.GetWeakPtr()));
}
}
UnlockManagerImpl::~UnlockManagerImpl() {
if (life_cycle_)
life_cycle_->RemoveObserver(this);
if (GetMessenger())
GetMessenger()->RemoveObserver(this);
if (proximity_monitor_)
proximity_monitor_->RemoveObserver(this);
chromeos::PowerManagerClient::Get()->RemoveObserver(this);
if (bluetooth_adapter_)
bluetooth_adapter_->RemoveObserver(this);
}
bool UnlockManagerImpl::IsUnlockAllowed() {
return (remote_screenlock_state_ &&
*remote_screenlock_state_ == RemoteScreenlockState::UNLOCKED &&
is_bluetooth_connection_to_phone_active_ && proximity_monitor_ &&
proximity_monitor_->IsUnlockAllowed());
}
void UnlockManagerImpl::SetRemoteDeviceLifeCycle(
RemoteDeviceLifeCycle* life_cycle) {
PA_LOG(VERBOSE) << "Request received to change scan state to: "
<< (life_cycle == nullptr ? "inactive" : "active") << ".";
if (life_cycle_)
life_cycle_->RemoveObserver(this);
if (GetMessenger())
GetMessenger()->RemoveObserver(this);
life_cycle_ = life_cycle;
if (life_cycle_) {
life_cycle_->AddObserver(this);
is_bluetooth_connection_to_phone_active_ = false;
show_lock_screen_time_ = base::DefaultClock::GetInstance()->Now();
has_user_been_shown_first_status_ = false;
if (IsBluetoothPresentAndPowered()) {
SetIsPerformingInitialScan(true /* is_performing_initial_scan */);
AttemptToStartRemoteDeviceLifecycle();
} else {
RecordFindAndConnectToHostResult(
FindAndConnectToHostResult::kCanceledBluetoothDisabled);
SetIsPerformingInitialScan(false /* is_performing_initial_scan */);
}
} else {
ResetPerformanceMetricsTimestamps();
if (proximity_monitor_)
proximity_monitor_->RemoveObserver(this);
proximity_monitor_.reset();
UpdateLockScreen();
}
}
void UnlockManagerImpl::OnLifeCycleStateChanged(
RemoteDeviceLifeCycle::State old_state,
RemoteDeviceLifeCycle::State new_state) {
remote_screenlock_state_.reset();
if (new_state == RemoteDeviceLifeCycle::State::SECURE_CHANNEL_ESTABLISHED) {
DCHECK(life_cycle_->GetChannel());
DCHECK(GetMessenger());
if (!proximity_monitor_) {
proximity_monitor_ = CreateProximityMonitor(life_cycle_);
proximity_monitor_->AddObserver(this);
proximity_monitor_->Start();
}
GetMessenger()->AddObserver(this);
is_bluetooth_connection_to_phone_active_ = true;
attempt_get_remote_status_start_time_ =
base::DefaultClock::GetInstance()->Now();
PA_LOG(VERBOSE) << "Successfully connected to host; waiting for remote "
"status update.";
if (is_performing_initial_scan_) {
RecordFindAndConnectToHostResult(
FindAndConnectToHostResult::kFoundAndConnectedToHost);
}
} else {
is_bluetooth_connection_to_phone_active_ = false;
if (proximity_monitor_) {
proximity_monitor_->RemoveObserver(this);
proximity_monitor_->Stop();
proximity_monitor_.reset();
}
}
// Note: though the name is AUTHENTICATION_FAILED, this state actually
// encompasses any connection failure in
// `ash::secure_channel::mojom::ConnectionAttemptFailureReason` beside
// Bluetooth becoming disabled. See https://crbug.com/991644 for more.
if (new_state == RemoteDeviceLifeCycle::State::AUTHENTICATION_FAILED) {
PA_LOG(ERROR) << "Connection attempt to host failed.";
if (is_performing_initial_scan_) {
RecordFindAndConnectToHostResult(
FindAndConnectToHostResult::kSecureChannelConnectionAttemptFailure);
SetIsPerformingInitialScan(false /* is_performing_initial_scan */);
}
}
if (new_state == RemoteDeviceLifeCycle::State::FINDING_CONNECTION &&
old_state == RemoteDeviceLifeCycle::State::SECURE_CHANNEL_ESTABLISHED) {
PA_LOG(ERROR) << "Secure channel dropped for unknown reason; potentially "
"due to Bluetooth being disabled.";
if (is_performing_initial_scan_) {
OnDisconnected();
SetIsPerformingInitialScan(false /* is_performing_initial_scan */);
}
}
UpdateLockScreen();
}
void UnlockManagerImpl::OnUnlockEventSent(bool success) {
if (!is_attempting_auth_) {
PA_LOG(ERROR) << "Sent easy_unlock event, but no auth attempted.";
FinalizeAuthAttempt(
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason::
kUnlockEventSentButNotAttemptingAuth);
} else if (success) {
FinalizeAuthAttempt(std::nullopt /* failure_reason */);
} else {
FinalizeAuthAttempt(
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason::
kFailedtoNotifyHostDeviceThatSmartLockWasUsed);
}
}
void UnlockManagerImpl::OnRemoteStatusUpdate(
const RemoteStatusUpdate& status_update) {
PA_LOG(VERBOSE) << "Status Update: ("
<< "user_present=" << status_update.user_presence << ", "
<< "secure_screen_lock="
<< status_update.secure_screen_lock_state << ", "
<< "trust_agent=" << status_update.trust_agent_state << ")";
metrics::RecordRemoteSecuritySettingsState(
GetRemoteSecuritySettingsState(status_update));
remote_screenlock_state_ = std::make_unique<RemoteScreenlockState>(
GetScreenlockStateFromRemoteUpdate(status_update));
// Only record these metrics within the initial period of opening the laptop
// displaying the lock screen.
if (is_performing_initial_scan_) {
RecordFirstRemoteStatusReceived(
*remote_screenlock_state_ ==
RemoteScreenlockState::UNLOCKED /* unlockable */);
}
// This also calls |UpdateLockScreen()|
SetIsPerformingInitialScan(false /* is_performing_initial_scan */);
}
void UnlockManagerImpl::OnUnlockResponse(bool success) {
if (!is_attempting_auth_) {
FinalizeAuthAttempt(
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason::
kUnlockRequestSentButNotAttemptingAuth);
PA_LOG(ERROR) << "Unlock request sent but not attempting auth.";
return;
}
PA_LOG(INFO) << "Received unlock response from device: "
<< (success ? "yes" : "no") << ".";
if (success && GetMessenger()) {
GetMessenger()->DispatchUnlockEvent();
} else {
FinalizeAuthAttempt(
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason::
kFailedToSendUnlockRequest);
}
}
void UnlockManagerImpl::OnDisconnected() {
if (is_attempting_auth_) {
RecordAuthResultFailure(
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason::
kAuthenticatedChannelDropped);
} else if (is_performing_initial_scan_) {
RecordGetRemoteStatusResultFailure(
GetRemoteStatusResultFailureReason::kAuthenticatedChannelDropped);
}
if (GetMessenger())
GetMessenger()->RemoveObserver(this);
}
void UnlockManagerImpl::OnProximityStateChanged() {
PA_LOG(VERBOSE) << "Proximity state changed.";
UpdateLockScreen();
}
void UnlockManagerImpl::OnBluetoothAdapterInitialized(
scoped_refptr<device::BluetoothAdapter> adapter) {
bluetooth_adapter_ = adapter;
bluetooth_adapter_->AddObserver(this);
}
void UnlockManagerImpl::AdapterPresentChanged(device::BluetoothAdapter* adapter,
bool present) {
if (!IsBluetoothAdapterRecoveringFromSuspend())
OnBluetoothAdapterPresentAndPoweredChanged();
}
void UnlockManagerImpl::AdapterPoweredChanged(device::BluetoothAdapter* adapter,
bool powered) {
if (!IsBluetoothAdapterRecoveringFromSuspend())
OnBluetoothAdapterPresentAndPoweredChanged();
}
void UnlockManagerImpl::SuspendImminent(
power_manager::SuspendImminent::Reason reason) {
// TODO(crbug.com/986896): For a short time window after resuming from
// suspension, BluetoothAdapter returns incorrect presence and power values.
// Cache the correct values now, in case we need to check those values during
// that time window when the device resumes.
was_bluetooth_present_and_powered_before_last_suspend_ =
IsBluetoothPresentAndPowered();
bluetooth_suspension_recovery_timer_->Stop();
}
void UnlockManagerImpl::SuspendDone(base::TimeDelta sleep_duration) {
bluetooth_suspension_recovery_timer_->Start(
FROM_HERE, kBluetoothAdapterResumeMaxDuration,
base::BindOnce(
&UnlockManagerImpl::OnBluetoothAdapterPresentAndPoweredChanged,
weak_ptr_factory_.GetWeakPtr()));
// The next scan after resuming is expected to be triggered by calling
// SetRemoteDeviceLifeCycle().
}
bool UnlockManagerImpl::IsBluetoothPresentAndPowered() const {
// TODO(crbug.com/986896): If the BluetoothAdapter is still "resuming after
// suspension" at this time, it's prone to this bug, meaning we cannot trust
// its returned presence and power values. If this is the case, depend on
// the cached |was_bluetooth_present_and_powered_before_last_suspend_| to
// signal if Bluetooth is enabled; otherwise, directly check request values
// from BluetoothAdapter. Remove this check once the bug is fixed.
if (IsBluetoothAdapterRecoveringFromSuspend())
return was_bluetooth_present_and_powered_before_last_suspend_;
return bluetooth_adapter_ && bluetooth_adapter_->IsPresent() &&
bluetooth_adapter_->IsPowered();
}
void UnlockManagerImpl::OnBluetoothAdapterPresentAndPoweredChanged() {
DCHECK(!IsBluetoothAdapterRecoveringFromSuspend());
if (IsBluetoothPresentAndPowered()) {
if (!is_performing_initial_scan_ &&
!is_bluetooth_connection_to_phone_active_) {
SetIsPerformingInitialScan(true /* is_performing_initial_scan */);
}
return;
}
if (is_performing_initial_scan_) {
if (is_bluetooth_connection_to_phone_active_ &&
!has_received_first_remote_status_) {
RecordGetRemoteStatusResultFailure(
GetRemoteStatusResultFailureReason::kCanceledBluetoothDisabled);
} else {
RecordFindAndConnectToHostResult(
FindAndConnectToHostResult::kCanceledBluetoothDisabled);
}
SetIsPerformingInitialScan(false /* is_performing_initial_scan */);
return;
}
// If Bluetooth is off but no initial scan is active, still ensure that the
// lock screen UI reflects that Bluetooth is off.
UpdateLockScreen();
}
bool UnlockManagerImpl::IsBluetoothAdapterRecoveringFromSuspend() const {
return bluetooth_suspension_recovery_timer_->IsRunning();
}
void UnlockManagerImpl::AttemptToStartRemoteDeviceLifecycle() {
if (IsBluetoothPresentAndPowered() && life_cycle_ &&
life_cycle_->GetState() == RemoteDeviceLifeCycle::State::STOPPED) {
// If Bluetooth is disabled after this, |life_cycle_| will be notified by
// SecureChannel that the connection attempt failed. From that point on,
// |life_cycle_| will wait to be started again by UnlockManager.
life_cycle_->Start();
}
}
void UnlockManagerImpl::OnAuthAttempted(mojom::AuthType auth_type) {
if (is_attempting_auth_) {
PA_LOG(VERBOSE) << "Already attempting auth.";
return;
}
if (auth_type != mojom::AuthType::USER_CLICK)
return;
is_attempting_auth_ = true;
if (!life_cycle_ || !GetMessenger()) {
PA_LOG(ERROR) << "No life_cycle active when auth was attempted";
FinalizeAuthAttempt(
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason::
kNoPendingOrActiveHost);
UpdateLockScreen();
return;
}
if (!IsUnlockAllowed()) {
FinalizeAuthAttempt(
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason::
kUnlockNotAllowed);
UpdateLockScreen();
return;
}
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(
&UnlockManagerImpl::FinalizeAuthAttempt,
reject_auth_attempt_weak_ptr_factory_.GetWeakPtr(),
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason::
kAuthAttemptTimedOut),
kAuthAttemptTimeout);
GetMessenger()->RequestUnlock();
}
void UnlockManagerImpl::CancelConnectionAttempt() {
PA_LOG(VERBOSE) << "User entered password.";
bluetooth_suspension_recovery_timer_->Stop();
// Note: There is no need to record metrics here if Bluetooth isn't present
// and powered; that has already been handled at this point in
// OnBluetoothAdapterPresentAndPoweredChanged().
if (!IsBluetoothPresentAndPowered())
return;
if (is_performing_initial_scan_) {
if (is_bluetooth_connection_to_phone_active_ &&
!has_received_first_remote_status_) {
RecordGetRemoteStatusResultFailure(
GetRemoteStatusResultFailureReason::kCanceledUserEnteredPassword);
} else {
RecordFindAndConnectToHostResult(
FindAndConnectToHostResult::kCanceledUserEnteredPassword);
}
SetIsPerformingInitialScan(false /* is_performing_initial_scan */);
}
}
std::unique_ptr<ProximityMonitor> UnlockManagerImpl::CreateProximityMonitor(
RemoteDeviceLifeCycle* life_cycle) {
return std::make_unique<ProximityMonitorImpl>(life_cycle->GetRemoteDevice(),
life_cycle->GetChannel());
}
SmartLockState UnlockManagerImpl::GetSmartLockState() {
if (!life_cycle_)
return SmartLockState::kInactive;
if (!IsBluetoothPresentAndPowered())
return SmartLockState::kBluetoothDisabled;
if (IsUnlockAllowed())
return SmartLockState::kPhoneAuthenticated;
RemoteDeviceLifeCycle::State life_cycle_state = life_cycle_->GetState();
if (life_cycle_state == RemoteDeviceLifeCycle::State::AUTHENTICATION_FAILED)
return SmartLockState::kPhoneNotAuthenticated;
if (is_performing_initial_scan_)
return SmartLockState::kConnectingToPhone;
Messenger* messenger = GetMessenger();
// Show a timeout state if we can not connect to the remote device in a
// reasonable amount of time.
if (!messenger)
return SmartLockState::kPhoneNotFound;
// If the RSSI is too low, then the remote device is nowhere near the local
// device. This message should take priority over messages about Smart Lock
// states.
if (proximity_monitor_ && !proximity_monitor_->IsUnlockAllowed()) {
if (remote_screenlock_state_ &&
*remote_screenlock_state_ == RemoteScreenlockState::UNLOCKED) {
return SmartLockState::kPhoneFoundUnlockedAndDistant;
} else {
return SmartLockState::kPhoneFoundLockedAndDistant;
}
}
if (remote_screenlock_state_) {
switch (*remote_screenlock_state_) {
case RemoteScreenlockState::DISABLED:
return SmartLockState::kPhoneNotLockable;
case RemoteScreenlockState::LOCKED:
return SmartLockState::kPhoneFoundLockedAndProximate;
case RemoteScreenlockState::PRIMARY_USER_ABSENT:
return SmartLockState::kPrimaryUserAbsent;
case RemoteScreenlockState::UNKNOWN:
case RemoteScreenlockState::UNLOCKED:
// Handled by the code below.
break;
}
}
if (messenger) {
PA_LOG(WARNING) << "Connection to host established, but remote screenlock "
<< "state was either malformed or not received.";
}
// TODO(crbug.com/1233587): Add more granular error states
return SmartLockState::kPhoneNotFound;
}
void UnlockManagerImpl::UpdateLockScreen() {
AttemptToStartRemoteDeviceLifecycle();
SmartLockState new_state = GetSmartLockState();
if (smartlock_state_ == new_state)
return;
PA_LOG(INFO) << "Updating Smart Lock state from " << smartlock_state_
<< " to " << new_state;
RecordFirstStatusShownToUser(new_state);
proximity_auth_client_->UpdateSmartLockState(new_state);
smartlock_state_ = new_state;
}
void UnlockManagerImpl::SetIsPerformingInitialScan(
bool is_performing_initial_scan) {
PA_LOG(VERBOSE) << "Initial scan state is ["
<< (is_performing_initial_scan_ ? "active" : "inactive")
<< "]. Requesting state ["
<< (is_performing_initial_scan ? "active" : "inactive")
<< "].";
is_performing_initial_scan_ = is_performing_initial_scan;
// Clear the waking up state after a timeout.
initial_scan_timeout_weak_ptr_factory_.InvalidateWeakPtrs();
if (is_performing_initial_scan_) {
initial_scan_start_time_ = base::DefaultClock::GetInstance()->Now();
has_received_first_remote_status_ = false;
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&UnlockManagerImpl::OnInitialScanTimeout,
initial_scan_timeout_weak_ptr_factory_.GetWeakPtr()),
kWakingUpDuration);
}
UpdateLockScreen();
}
void UnlockManagerImpl::OnInitialScanTimeout() {
// Note: There is no need to record metrics here if Bluetooth isn't present
// and powered; that has already been handled at this point in
// OnBluetoothAdapterPresentAndPoweredChanged().
if (!IsBluetoothPresentAndPowered())
return;
if (is_bluetooth_connection_to_phone_active_) {
PA_LOG(ERROR) << "Successfully connected to host, but it did not provide "
"remote status update.";
RecordGetRemoteStatusResultFailure(
GetRemoteStatusResultFailureReason::
kTimedOutDidNotReceiveRemoteStatusUpdate);
} else {
PA_LOG(INFO) << "Initial scan for host returned no result.";
RecordFindAndConnectToHostResult(FindAndConnectToHostResult::kTimedOut);
}
SetIsPerformingInitialScan(false /* is_performing_initial_scan */);
}
void UnlockManagerImpl::FinalizeAuthAttempt(
const std::optional<
SmartLockMetricsRecorder::SmartLockAuthResultFailureReason>& error) {
if (error) {
RecordAuthResultFailure(*error);
}
if (!is_attempting_auth_)
return;
// Cancel the pending task to time out the auth attempt.
reject_auth_attempt_weak_ptr_factory_.InvalidateWeakPtrs();
bool should_accept = !error;
if (should_accept && proximity_monitor_)
proximity_monitor_->RecordProximityMetricsOnAuthSuccess();
is_attempting_auth_ = false;
PA_LOG(VERBOSE) << "Finalizing unlock...";
proximity_auth_client_->FinalizeUnlock(should_accept);
}
UnlockManagerImpl::RemoteScreenlockState
UnlockManagerImpl::GetScreenlockStateFromRemoteUpdate(
RemoteStatusUpdate update) {
switch (update.secure_screen_lock_state) {
case SECURE_SCREEN_LOCK_DISABLED:
return RemoteScreenlockState::DISABLED;
case SECURE_SCREEN_LOCK_ENABLED:
if (update.user_presence == USER_PRESENCE_SECONDARY ||
update.user_presence == USER_PRESENCE_BACKGROUND) {
return RemoteScreenlockState::PRIMARY_USER_ABSENT;
}
if (update.user_presence == USER_PRESENT)
return RemoteScreenlockState::UNLOCKED;
return RemoteScreenlockState::LOCKED;
case SECURE_SCREEN_LOCK_STATE_UNKNOWN:
return RemoteScreenlockState::UNKNOWN;
}
NOTREACHED();
}
Messenger* UnlockManagerImpl::GetMessenger() {
// TODO(tengs): We should use a weak pointer to hold the Messenger instance
// instead.
if (!life_cycle_)
return nullptr;
return life_cycle_->GetMessenger();
}
void UnlockManagerImpl::RecordFirstRemoteStatusReceived(bool unlockable) {
if (has_received_first_remote_status_)
return;
has_received_first_remote_status_ = true;
RecordGetRemoteStatusResultSuccess();
if (initial_scan_start_time_.is_null() ||
attempt_get_remote_status_start_time_.is_null()) {
NOTREACHED() << "Attempted to RecordFirstRemoteStatusReceived() "
"without initial timestamps recorded.";
}
const std::string histogram_status_suffix =
GetHistogramStatusSuffix(unlockable);
base::Time now = base::DefaultClock::GetInstance()->Now();
base::TimeDelta start_scan_to_receive_first_remote_status_duration =
now - initial_scan_start_time_;
base::TimeDelta authentication_to_receive_first_remote_status_duration =
now - attempt_get_remote_status_start_time_;
RecordExtendedDurationTimerMetric(
"SmartLock.Performance.StartScanToReceiveFirstRemoteStatusDuration."
"Unlock",
start_scan_to_receive_first_remote_status_duration);
RecordExtendedDurationTimerMetric(
"SmartLock.Performance.StartScanToReceiveFirstRemoteStatusDuration."
"Unlock." +
histogram_status_suffix,
start_scan_to_receive_first_remote_status_duration);
// This should be much less than 10 seconds, so use UmaHistogramTimes.
base::UmaHistogramTimes(
"SmartLock.Performance."
"AuthenticationToReceiveFirstRemoteStatusDuration.Unlock",
authentication_to_receive_first_remote_status_duration);
base::UmaHistogramTimes(
"SmartLock.Performance."
"AuthenticationToReceiveFirstRemoteStatusDuration.Unlock." +
histogram_status_suffix,
authentication_to_receive_first_remote_status_duration);
}
void UnlockManagerImpl::RecordFirstStatusShownToUser(SmartLockState new_state) {
std::optional<FirstSmartLockStatus> first_status =
GetFirstSmartLockStatus(new_state);
if (!first_status.has_value()) {
return;
}
if (has_user_been_shown_first_status_) {
return;
}
has_user_been_shown_first_status_ = true;
if (show_lock_screen_time_.is_null()) {
NOTREACHED() << "Attempted to RecordFirstStatusShownToUser() "
"without initial timestamp recorded.";
}
base::UmaHistogramEnumeration("SmartLock.FirstStatusToUser",
first_status.value());
base::Time now = base::DefaultClock::GetInstance()->Now();
base::TimeDelta show_lock_screen_to_show_first_status_to_user_duration =
now - show_lock_screen_time_;
RecordExtendedDurationTimerMetric(
"SmartLock.Performance.ShowLockScreenToShowFirstStatusToUserDuration."
"Unlock",
show_lock_screen_to_show_first_status_to_user_duration);
if (new_state == SmartLockState::kPhoneAuthenticated) {
RecordExtendedDurationTimerMetric(
"SmartLock.Performance.ShowLockScreenToShowFirstStatusToUserDuration."
"Unlock.Unlockable",
show_lock_screen_to_show_first_status_to_user_duration);
} else if (HasCommunicatedWithPhone(new_state)) {
// Only log to Unlock.Other if we aren't in an unlockable state since
// that's covered by the other metric, and only if we are in a state that
// indicates we were able to communicate with the phone over Bluetooth
// since in all other cases the time to show the first status is highly
// deterministic.
RecordExtendedDurationTimerMetric(
"SmartLock.Performance.ShowLockScreenToShowFirstStatusToUserDuration."
"Unlock.Other",
show_lock_screen_to_show_first_status_to_user_duration);
}
}
void UnlockManagerImpl::ResetPerformanceMetricsTimestamps() {
show_lock_screen_time_ = base::Time();
initial_scan_start_time_ = base::Time();
attempt_get_remote_status_start_time_ = base::Time();
}
void UnlockManagerImpl::SetBluetoothSuspensionRecoveryTimerForTesting(
std::unique_ptr<base::OneShotTimer> timer) {
bluetooth_suspension_recovery_timer_ = std::move(timer);
}
void UnlockManagerImpl::RecordGetRemoteStatusResultSuccess(bool success) {
base::UmaHistogramBoolean("SmartLock.GetRemoteStatus.Unlock", success);
get_remote_status_unlock_success_ = success;
}
void UnlockManagerImpl::RecordGetRemoteStatusResultFailure(
GetRemoteStatusResultFailureReason failure_reason) {
RecordGetRemoteStatusResultSuccess(false /* success */);
base::UmaHistogramEnumeration("SmartLock.GetRemoteStatus.Unlock.Failure",
failure_reason);
get_remote_status_unlock_failure_reason_ = failure_reason;
}
std::string UnlockManagerImpl::GetRemoteStatusResultFailureReasonToString(
GetRemoteStatusResultFailureReason reason) {
switch (reason) {
case GetRemoteStatusResultFailureReason::kCanceledBluetoothDisabled:
return "CanceledBluetoothDisabled";
case GetRemoteStatusResultFailureReason::
kDeprecatedTimedOutCouldNotEstablishAuthenticatedChannel:
return "DeprecatedTimedOutCouldNotEstablishAuthenticatedChannel";
case GetRemoteStatusResultFailureReason::
kTimedOutDidNotReceiveRemoteStatusUpdate:
return "TimedOutDidNotReceiveRemoteStatusUpdate";
case GetRemoteStatusResultFailureReason::
kDeprecatedUserEnteredPasswordWhileBluetoothDisabled:
return "DeprecatedUserEnteredPasswordWhileBluetoothDisabled";
case GetRemoteStatusResultFailureReason::kCanceledUserEnteredPassword:
return "CanceledUserEnteredPassword";
case GetRemoteStatusResultFailureReason::kAuthenticatedChannelDropped:
return "AuthenticatedChannelDropped";
}
}
std::string UnlockManagerImpl::GetLastRemoteStatusUnlockForLogging() {
if (!get_remote_status_unlock_success_.has_value()) {
return kGetRemoteStatusNone;
}
if (*get_remote_status_unlock_success_) {
return kGetRemoteStatusSuccess;
}
if (!get_remote_status_unlock_failure_reason_.has_value()) {
return kGetRemoteStatusNone;
}
return GetRemoteStatusResultFailureReasonToString(
*get_remote_status_unlock_failure_reason_);
}
} // namespace proximity_auth
|