| // Copyright 2018 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. |
| |
| #ifndef COMPONENTS_SYNC_DRIVER_SYNC_USER_SETTINGS_H_ |
| #define COMPONENTS_SYNC_DRIVER_SYNC_USER_SETTINGS_H_ |
| |
| #include <string> |
| #include <vector> |
| |
| #include "base/compiler_specific.h" |
| #include "base/time/time.h" |
| #include "components/sync/base/model_type.h" |
| #include "components/sync/base/passphrase_enums.h" |
| #include "components/sync/base/user_selectable_type.h" |
| |
| namespace syncer { |
| |
| // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser |
| // These values are persisted to logs. Entries should not be renumbered and |
| // numeric values should never be reused. |
| enum class SyncFirstSetupCompleteSource { |
| BASIC_FLOW = 0, |
| ADVANCED_FLOW_CONFIRM = 1, |
| ADVANCED_FLOW_INTERRUPTED_TURN_SYNC_ON = 2, |
| ADVANCED_FLOW_INTERRUPTED_LEAVE_SYNC_OFF = 3, |
| ENGINE_INITIALIZED_WITH_AUTO_START = 4, |
| kMaxValue = ENGINE_INITIALIZED_WITH_AUTO_START, |
| }; |
| |
| // This class encapsulates all the user-configurable bits of Sync. |
| class SyncUserSettings { |
| public: |
| virtual ~SyncUserSettings() = default; |
| |
| // Whether the user wants Sync to run. This is false by default, but gets set |
| // to true early in the Sync setup flow, after the user has pressed "turn on |
| // Sync" but before they have actually confirmed the settings (that's |
| // IsFirstSetupComplete()). After Sync is enabled, this can get set to false |
| // by the Sync feature toggle in settings, or when Sync gets reset from the |
| // dashboard. This maps to DISABLE_REASON_USER_CHOICE. |
| virtual bool IsSyncRequested() const = 0; |
| virtual void SetSyncRequested(bool requested) = 0; |
| |
| // Whether Sync is allowed at the platform level (e.g. Android's "MasterSync" |
| // toggle). Maps to DISABLE_REASON_PLATFORM_OVERRIDE. |
| virtual bool IsSyncAllowedByPlatform() const = 0; |
| virtual void SetSyncAllowedByPlatform(bool allowed) = 0; |
| |
| // Whether the initial Sync setup has been completed, meaning the user has |
| // consented to Sync. |
| // NOTE: On Android and ChromeOS, this gets set automatically, so it doesn't |
| // really mean anything. See |browser_defaults::kSyncAutoStarts|. |
| virtual bool IsFirstSetupComplete() const = 0; |
| virtual void SetFirstSetupComplete(SyncFirstSetupCompleteSource source) = 0; |
| |
| // The user's selected types. The "sync everything" flag means to sync all |
| // current and future data types. If it is set, then GetSelectedTypes() will |
| // always return "all types". |
| // NOTE: By default, GetSelectedTypes() returns "all types", even if the user |
| // has never enabled Sync, or if only Sync-the-transport is running. |
| virtual bool IsSyncEverythingEnabled() const = 0; |
| virtual UserSelectableTypeSet GetSelectedTypes() const = 0; |
| virtual void SetSelectedTypes(bool sync_everything, |
| UserSelectableTypeSet types) = 0; |
| // Registered user selectable types are derived from registered model types. |
| // UserSelectableType is registered iff main corresponding ModelType is |
| // registered. |
| virtual UserSelectableTypeSet GetRegisteredSelectableTypes() const = 0; |
| // Returns the set of types which are enforced programmatically and can not |
| // be disabled by the user (e.g. enforced for supervised users). Types are |
| // not guaranteed to be registered. |
| virtual UserSelectableTypeSet GetForcedTypes() const = 0; |
| |
| #if defined(OS_CHROMEOS) |
| // As above, but for Chrome OS-specific data types. These are controlled by |
| // toggles in the OS Settings UI. |
| virtual bool IsSyncAllOsTypesEnabled() const = 0; |
| virtual UserSelectableOsTypeSet GetSelectedOsTypes() const = 0; |
| virtual void SetSelectedOsTypes(bool sync_all_os_types, |
| UserSelectableOsTypeSet types) = 0; |
| virtual UserSelectableOsTypeSet GetRegisteredSelectableOsTypes() const = 0; |
| |
| // Whether the OS sync feature is enabled. Implies the user has consented. |
| // Exists in this interface for easier mocking in tests. |
| virtual bool GetOsSyncFeatureEnabled() const = 0; |
| virtual void SetOsSyncFeatureEnabled(bool enabled) = 0; |
| #endif // defined(OS_CHROMEOS) |
| |
| // Encryption state. |
| // Note that all of this state may only be queried or modified if the Sync |
| // engine is initialized. |
| |
| // Whether the user is allowed to encrypt all their Sync data. For example, |
| // child accounts are not allowed to encrypt their data. |
| virtual bool IsEncryptEverythingAllowed() const = 0; |
| // Whether we are currently set to encrypt all the Sync data. |
| virtual bool IsEncryptEverythingEnabled() const = 0; |
| // Turns on encryption for all data. Callers must call SetChosenDataTypes() |
| // after calling this to force the encryption to occur. |
| virtual void EnableEncryptEverything() = 0; |
| |
| // The current set of encrypted data types. |
| virtual ModelTypeSet GetEncryptedDataTypes() const = 0; |
| // Whether a passphrase is required for encryption or decryption to proceed. |
| // Note that Sync might still be working fine if the user has disabled all |
| // encrypted data types. |
| virtual bool IsPassphraseRequired() const = 0; |
| // Whether a passphrase is required to decrypt the data for any currently |
| // enabled data type. |
| virtual bool IsPassphraseRequiredForPreferredDataTypes() const = 0; |
| // Whether trusted vault keys are required for encryption or decryption to |
| // proceed for any currently enabled data type. |
| virtual bool IsTrustedVaultKeyRequiredForPreferredDataTypes() const = 0; |
| // Whether a "secondary" passphrase is in use (aka explicit passphrase), which |
| // means either a custom or a frozen implicit passphrase. |
| virtual bool IsUsingSecondaryPassphrase() const = 0; |
| // The time the current explicit passphrase (if any) was set. If no secondary |
| // passphrase is in use, or no time is available, returns an unset base::Time. |
| virtual base::Time GetExplicitPassphraseTime() const = 0; |
| // The type of the passphrase currently in use. |
| virtual PassphraseType GetPassphraseType() const = 0; |
| |
| // Asynchronously sets the passphrase to |passphrase| for encryption. |
| virtual void SetEncryptionPassphrase(const std::string& passphrase) = 0; |
| // Asynchronously decrypts pending keys using |passphrase|. Returns false |
| // immediately if the passphrase could not be used to decrypt a locally cached |
| // copy of encrypted keys; returns true otherwise. |
| virtual bool SetDecryptionPassphrase(const std::string& passphrase) |
| WARN_UNUSED_RESULT = 0; |
| // Analogous to SetDecryptionPassphrase but specifically for |
| // TRUSTED_VAULT_PASSPHRASE: it provides new decryption keys that could |
| // allow decrypting pending Nigori keys. |
| virtual void AddTrustedVaultDecryptionKeys( |
| const std::string& gaia_id, |
| const std::vector<std::string>& keys) = 0; |
| }; |
| |
| } // namespace syncer |
| |
| #endif // COMPONENTS_SYNC_DRIVER_SYNC_USER_SETTINGS_H_ |
