File: cloned_install_detector.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (106 lines) | stat: -rw-r--r-- 4,221 bytes parent folder | download | duplicates (2)
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
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_METRICS_CLONED_INSTALL_DETECTOR_H_
#define COMPONENTS_METRICS_CLONED_INSTALL_DETECTOR_H_

#include "base/callback_list.h"
#include "base/functional/callback_forward.h"
#include "base/gtest_prod_util.h"
#include "base/memory/weak_ptr.h"

class PrefRegistrySimple;
class PrefService;

namespace metrics {

// A struct that holds cloned install related fields in prefs that need to be
// reported in the system_profile.
struct ClonedInstallInfo {
  int64_t last_reset_timestamp;
  int64_t first_reset_timestamp;
  int reset_count;
};

// A class for detecting if an install is cloned. It does this by detecting
// when the hardware running Chrome changes.
class ClonedInstallDetector {
 public:
  ClonedInstallDetector();

  ClonedInstallDetector(const ClonedInstallDetector&) = delete;
  ClonedInstallDetector& operator=(const ClonedInstallDetector&) = delete;

  virtual ~ClonedInstallDetector();

  // Posts a task to |task_runner| to generate a machine ID and store it to a
  // local state pref. If the newly generated ID is different than the
  // previously stored one, then the install is considered cloned. The ID is a
  // 24-bit value based off of machine characteristics. This value should never
  // be sent over the network.
  void CheckForClonedInstall(PrefService* local_state);

  static void RegisterPrefs(PrefRegistrySimple* registry);

  // Reads cloned install info fields from |local_state| and returns them in
  // a ClonedInstallInfo.
  static ClonedInstallInfo ReadClonedInstallInfo(PrefService* local_state);

  // Clears cloned install info fields from |local_state|.
  static void ClearClonedInstallInfo(PrefService* local_state);

  // Updates cloned install info fields in |local_state| on reset.
  static void RecordClonedInstallInfo(PrefService* local_state);

  // Returns true for the whole session if we detected a cloned install during
  // the construction of a client id.
  bool ShouldResetClientIds(PrefService* local_state);

  // Returns true for the whole session if we detect a cloned install this
  // session.
  bool ClonedInstallDetectedInCurrentSession() const;

  // Adds a callback that is run if this install is detected as cloned during
  // this session. If this is called after the detection had already occurred,
  // the callback is run immediately.
  base::CallbackListSubscription AddOnClonedInstallDetectedCallback(
      base::OnceClosure callback);

  // Wrapper around SaveMachineId(). Used for testing in UKM (the tests cannot
  // be declared as friends since they live in a different namespace).
  void SaveMachineIdForTesting(PrefService* local_state,
                               const std::string& raw_id);

 private:
  FRIEND_TEST_ALL_PREFIXES(ClonedInstallDetectorTest, SaveId);
  FRIEND_TEST_ALL_PREFIXES(ClonedInstallDetectorTest, DetectClone);
  FRIEND_TEST_ALL_PREFIXES(ClonedInstallDetectorTest, ShouldResetClientIds);
  FRIEND_TEST_ALL_PREFIXES(ClonedInstallDetectorTest,
                           ClonedInstallDetectedInCurrentSession);
  FRIEND_TEST_ALL_PREFIXES(ClonedInstallDetectorTest,
                           ClonedInstallDetectedCallback);
  FRIEND_TEST_ALL_PREFIXES(MetricsStateManagerTest, CheckProviderResetIds);
  FRIEND_TEST_ALL_PREFIXES(MetricsServiceTestWithFeatures,
                           PurgeLogsOnClonedInstallDetected);

  // Converts raw_id into a 24-bit hash and stores the hash in |local_state|.
  // |raw_id| is not a const ref because it's passed from a cross-thread post
  // task.
  void SaveMachineId(PrefService* local_state, const std::string& raw_id);

  // Indicates that we detected a cloned install during the current session.
  bool detected_this_session_ = false;

  // Indicates that we detected a cloned install during the construction of a
  // client id and should reset client ids as a result.
  bool should_reset_client_ids_ = false;

  base::OnceClosureList callback_list_;

  base::WeakPtrFactory<ClonedInstallDetector> weak_ptr_factory_{this};
};

}  // namespace metrics

#endif  // COMPONENTS_METRICS_CLONED_INSTALL_DETECTOR_H_