blob: 1aa2a94eb1c6c685f252f09c78e8f8a2930a40fe [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <memory>
#include <string>
#include "base/lazy_instance.h"
#include "base/macros.h"
#include "base/observer_list.h"
#include "base/strings/string16.h"
#include "base/values.h"
#include "chromeos/components/proximity_auth/public/interfaces/auth_type.mojom.h"
#include "components/account_id/account_id.h"
namespace proximity_auth {
// ScreenlockBridge brings together the screenLockPrivate API and underlying
// support. It delegates calls to the ScreenLocker.
// TODO(tbarzic): Rename ScreenlockBridge to SignInScreenBridge, as this is not
// used solely for the lock screen anymore.
// TODO(jhawkins): Rationalize this class now that it is CrOS only and most of
// its functionality is not useful.
class ScreenlockBridge {
// User pod icons supported by lock screen / signin screen UI.
enum UserPodCustomIcon {
// TODO(isherman): The "locked with proximity hint" icon is currently the
// same as the "locked" icon. It's treated as a separate case to allow an
// easy asset swap without changing the code, in case we decide to use a
// different icon for this case. If we definitely decide against that, then
// this enum entry should be removed.
// Class containing parameters describing the custom icon that should be
// shown on a user's screen lock pod next to the input field.
class UserPodCustomIconOptions {
// Converts parameters to a dictionary values that can be sent to the
// screenlock web UI.
std::unique_ptr<base::DictionaryValue> ToDictionaryValue() const;
// Sets the icon that should be shown in the UI.
void SetIcon(UserPodCustomIcon icon);
// Sets the icon tooltip. If |autoshow| is set the tooltip is automatically
// shown with the icon.
void SetTooltip(const base::string16& tooltip, bool autoshow);
// Sets the accessibility label of the icon. If this attribute is not
// provided, then the tooltip will be used.
void SetAriaLabel(const base::string16& aria_label);
// If hardlock on click is set, clicking the icon in the screenlock will
// go to state where password is required for unlock.
void SetHardlockOnClick();
std::string GetIDString() const;
UserPodCustomIcon icon() const { return icon_; }
const base::string16 tooltip() const { return tooltip_; }
bool autoshow_tooltip() const { return autoshow_tooltip_; }
const base::string16 aria_label() const { return aria_label_; }
bool hardlock_on_click() const { return hardlock_on_click_; }
UserPodCustomIcon icon_;
base::string16 tooltip_;
bool autoshow_tooltip_;
base::string16 aria_label_;
bool hardlock_on_click_;
class LockHandler {
enum ScreenType { SIGNIN_SCREEN = 0, LOCK_SCREEN = 1, OTHER_SCREEN = 2 };
// Displays |message| in a banner on the lock screen.
virtual void ShowBannerMessage(const base::string16& message,
bool is_warning) = 0;
// Shows a custom icon in the user pod on the lock screen.
virtual void ShowUserPodCustomIcon(
const AccountId& account_id,
const UserPodCustomIconOptions& icon) = 0;
// Hides the custom icon in user pod for a user.
virtual void HideUserPodCustomIcon(const AccountId& account_id) = 0;
// (Re)enable lock screen UI.
// TODO( Remove TestLockHandler dependency on this, and
// then remove this method.
virtual void EnableInput() = 0;
// Set the authentication type to be used on the lock screen.
virtual void SetAuthType(const AccountId& account_id,
proximity_auth::mojom::AuthType auth_type,
const base::string16& auth_value) = 0;
// Returns the authentication type used for a user.
virtual proximity_auth::mojom::AuthType GetAuthType(
const AccountId& account_id) const = 0;
// Returns the type of the screen -- a signin or a lock screen.
virtual ScreenType GetScreenType() const = 0;
// Unlocks from easy unlock app for a user.
virtual void Unlock(const AccountId& account_id) = 0;
// Attempts to login the user using an easy unlock key.
virtual void AttemptEasySignin(const AccountId& account_id,
const std::string& secret,
const std::string& key_label) = 0;
virtual ~LockHandler() {}
class Observer {
// Invoked after the screen is locked.
virtual void OnScreenDidLock(LockHandler::ScreenType screen_type) = 0;
// Invoked after the screen lock is dismissed.
virtual void OnScreenDidUnlock(LockHandler::ScreenType screen_type) = 0;
// Invoked when the user focused on the lock screen changes.
virtual void OnFocusedUserChanged(const AccountId& account_id) = 0;
virtual ~Observer() {}
static ScreenlockBridge* Get();
void SetLockHandler(LockHandler* lock_handler);
void SetFocusedUser(const AccountId& account_id);
bool IsLocked() const;
void Lock();
// Unlocks the screen for the authenticated user with the given |user_id|.
void Unlock(const AccountId& account_id);
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
LockHandler* lock_handler() { return lock_handler_; }
const AccountId& focused_account_id() const { return focused_account_id_; }
friend struct base::LazyInstanceTraitsBase<ScreenlockBridge>;
friend std::default_delete<ScreenlockBridge>;
LockHandler* lock_handler_; // Not owned
// The last focused user's id.
AccountId focused_account_id_;
base::ObserverList<Observer, true>::Unchecked observers_;
} // namespace proximity_auth