File: test_usercharping.cpp

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (222 lines) | stat: -rw-r--r-- 8,436 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
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
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

#include "gtest/gtest.h"
#include "mozilla/gtest/nsUserCharacteristics.h"

#include "mozilla/glean/GleanPings.h"
#include "mozilla/glean/ResistfingerprintingMetrics.h"

using namespace mozilla;

const auto* const kUUIDPref =
    "toolkit.telemetry.user_characteristics_ping.uuid";

TEST(ResistFingerprinting, UserCharacteristics_Simple)
{
  mozilla::glean::characteristics::max_touch_points.Set(7);

  ASSERT_TRUE(mozilla::glean_pings::UserCharacteristics.TestSubmission(
      [](const nsACString& aReason) {
        ASSERT_EQ(
            7, mozilla::glean::characteristics::max_touch_points.TestGetValue()
                   .unwrap()
                   .ref());
      },
      []() { mozilla::glean_pings::UserCharacteristics.Submit(); }));
}

TEST(ResistFingerprinting, UserCharacteristics_Complex)
{
  nsUserCharacteristics::PopulateDataAndEventuallySubmit(
      /* aUpdatePref = */ false, /* aTesting = */ true);

  ASSERT_TRUE(mozilla::glean_pings::UserCharacteristics.TestSubmission(
      [](const nsACString& aReason) {
        ASSERT_STRNE("", mozilla::glean::characteristics::client_identifier
                             .TestGetValue()
                             .unwrap()
                             .value()
                             .get());

        nsCString fullUuidStr;
        Preferences::GetCString(kUUIDPref, fullUuidStr);

        // Remove the '{' and '}'
        nsAutoCString uuidString;
        uuidString = Substring(fullUuidStr, 1, NSID_LENGTH - 3);

        ASSERT_STREQ(
            uuidString.get(),
            mozilla::glean::characteristics::client_identifier.TestGetValue()
                .unwrap()
                .value()
                .get());
        ASSERT_EQ(
            testing::MaxTouchPoints(),
            mozilla::glean::characteristics::max_touch_points.TestGetValue()
                .unwrap()
                .ref());

        // Test FPU control state metric to ensure code runs and doesn't crash
        auto fpuState =
            mozilla::glean::characteristics::fpu_control_state.TestGetValue()
                .unwrap()
                .value();
        ASSERT_STRNE("", fpuState.get());
        ASSERT_TRUE(strstr(fpuState.get(), "std:") != nullptr);
      },
      []() { nsUserCharacteristics::SubmitPing(); }));
}

TEST(ResistFingerprinting, UserCharacteristics_ClearPref)
{
  nsCString originalUUID;

  ASSERT_TRUE(mozilla::glean_pings::UserCharacteristics.TestSubmission(
      [&originalUUID](const nsACString& aReason) {
        originalUUID =
            mozilla::glean::characteristics::client_identifier.TestGetValue()
                .unwrap()
                .value()
                .get();
        ASSERT_STRNE("", mozilla::glean::characteristics::client_identifier
                             .TestGetValue()
                             .unwrap()
                             .value()
                             .get());

        nsCString fullUuidStr;
        Preferences::GetCString(kUUIDPref, fullUuidStr);

        // Remove the '{' and '}'
        nsAutoCString uuidString;
        uuidString = Substring(fullUuidStr, 1, NSID_LENGTH - 3);

        ASSERT_STREQ(
            uuidString.get(),
            mozilla::glean::characteristics::client_identifier.TestGetValue()
                .unwrap()
                .value()
                .get());
      },
      []() {
        nsUserCharacteristics::PopulateDataAndEventuallySubmit(
            /* aUpdatePref = */ false, /* aTesting = */ true);
        nsUserCharacteristics::SubmitPing();
      }));

  auto original_value =
      Preferences::GetBool("datareporting.healthreport.uploadEnabled");
  Preferences::SetBool("datareporting.healthreport.uploadEnabled", true);
  Preferences::SetBool("datareporting.healthreport.uploadEnabled", false);

  ASSERT_TRUE(mozilla::glean_pings::UserCharacteristics.TestSubmission(
      [](const nsACString& aReason) {
        // Assert that the pref is blank
        nsAutoCString uuidValue;
        Preferences::GetCString(kUUIDPref, uuidValue);
        ASSERT_STREQ("", uuidValue.get());
      },
      []() { nsUserCharacteristics::SubmitPing(); }));

  Preferences::SetBool("datareporting.healthreport.uploadEnabled", true);
  ASSERT_TRUE(mozilla::glean_pings::UserCharacteristics.TestSubmission(
      [&originalUUID](const nsACString& aReason) {
        // Assert that the new UUID is different from the old one
        ASSERT_STRNE(
            originalUUID.get(),
            mozilla::glean::characteristics::client_identifier.TestGetValue()
                .unwrap()
                .value()
                .get());

        // Assert that the pref is not blank
        nsAutoCString uuidValue;
        Preferences::GetCString(kUUIDPref, uuidValue);
        ASSERT_STRNE("", uuidValue.get());
      },
      []() {
        nsUserCharacteristics::PopulateDataAndEventuallySubmit(
            /* aUpdatePref = */ false, /* aTesting = */ true);
        nsUserCharacteristics::SubmitPing();
      }));

  Preferences::SetBool("datareporting.healthreport.uploadEnabled",
                       original_value);
}

const auto* const kLastVersionPref =
    "toolkit.telemetry.user_characteristics_ping.last_version_sent";
const auto* const kCurrentVersionPref =
    "toolkit.telemetry.user_characteristics_ping.current_version";
const auto* const kOptOutPref =
    "toolkit.telemetry.user_characteristics_ping.opt-out";
const auto* const kSendOncePref =
    "toolkit.telemetry.user_characteristics_ping.send-once";
const auto* const kResistFingerprintingPref = "privacy.resistFingerprinting";
const auto* const kResistFingerprintingPrefPBMode =
    "privacy.resistFingerprinting.pbmode";
const auto* const kFingerprintingProtectionOverrides =
    "privacy.fingerprintingProtection.overrides";
const auto* const kBaselineFPPOverridesPref =
    "privacy.baselineFingerprintingProtection.overrides";

TEST(ResistFingerprinting, UserCharacteristics_ShouldSubmit)
{
  // Test nsUserCharacteristics::ShouldSubmit()

  // Make sure kCurrentVersionPref > kLastVersionPref and kCurrentVersionPref !=
  // 0
  Preferences::SetInt(kCurrentVersionPref, 1);
  Preferences::SetInt(kLastVersionPref, 0);

  // Verify ShouldSubmit returns true when kCurrentVersionPref >
  // kLastVersionPref
  ASSERT_TRUE(nsUserCharacteristics::ShouldSubmit());

  // Verify opting-out works
  Preferences::SetBool(kOptOutPref, true);
  ASSERT_FALSE(nsUserCharacteristics::ShouldSubmit());

  Preferences::SetBool(kOptOutPref, false);
  ASSERT_TRUE(nsUserCharacteristics::ShouldSubmit());

  // Verify ShouldSubmit returns false when kCurrentVersionPref = 0
  Preferences::SetInt(kCurrentVersionPref, 0);
  ASSERT_FALSE(nsUserCharacteristics::ShouldSubmit());

  // Verify sending a ping once regardless of version works
  Preferences::SetBool(kSendOncePref, true);
  ASSERT_TRUE(nsUserCharacteristics::ShouldSubmit());
  Preferences::SetInt(kCurrentVersionPref, 1);

  // Verify precedence
  Preferences::SetBool(kOptOutPref, true);
  ASSERT_FALSE(nsUserCharacteristics::ShouldSubmit());
  Preferences::SetBool(kOptOutPref, false);

  // Verify resistFingerprinting prevents submission
  Preferences::SetBool(kResistFingerprintingPref, true);
  ASSERT_FALSE(nsUserCharacteristics::ShouldSubmit());
  Preferences::SetBool(kResistFingerprintingPref, false);

  Preferences::SetBool(kResistFingerprintingPrefPBMode, true);
  ASSERT_FALSE(nsUserCharacteristics::ShouldSubmit());
  Preferences::SetBool(kResistFingerprintingPrefPBMode, false);

  // Verify non-empty fingerprintingProtection overrides prevent submission
  Preferences::SetCString(kFingerprintingProtectionOverrides, "test");
  ASSERT_FALSE(nsUserCharacteristics::ShouldSubmit());
  Preferences::ClearUser(kFingerprintingProtectionOverrides);
  ASSERT_TRUE(nsUserCharacteristics::ShouldSubmit());

  // Verify non-empty baselineFPP overrides prevent submission
  Preferences::SetCString(kBaselineFPPOverridesPref, "test");
  ASSERT_FALSE(nsUserCharacteristics::ShouldSubmit());
  Preferences::ClearUser(kBaselineFPPOverridesPref);
  ASSERT_TRUE(nsUserCharacteristics::ShouldSubmit());
}