summaryrefslogtreecommitdiffstats
path: root/toolkit/components/antitracking/test/browser/browser_AntiTrackingETPHeuristic.js
blob: f5274d8ba9ae934988bbf6c2b1bdd0c53c794c2b (plain)
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
"use strict";

const TEST_PAGE = TEST_DOMAIN + TEST_PATH + "page.html";
const TEST_REDIRECT_PAGE = TEST_DOMAIN + TEST_PATH + "redirect.sjs";
const TEST_TRACKING_PAGE = TEST_3RD_PARTY_DOMAIN + TEST_PATH + "page.html";
const TEST_TRACKING_REDIRECT_PAGE =
  TEST_3RD_PARTY_DOMAIN + TEST_PATH + "redirect.sjs";
const TEST_ANOTHER_TRACKING_REDIRECT_PAGE =
  TEST_ANOTHER_3RD_PARTY_DOMAIN_HTTPS + TEST_PATH + "redirect.sjs";

const TEST_CASES = [
  // Tracker(Interacted) -> Non-Tracker
  {
    trackersHasUserInteraction: [TEST_3RD_PARTY_DOMAIN],
    redirects: [TEST_TRACKING_REDIRECT_PAGE, TEST_PAGE],
    expectedPermissionNumber: 1,
    expects: [
      [
        TEST_DOMAIN,
        TEST_3RD_PARTY_DOMAIN,
        Ci.nsIPermissionManager.ALLOW_ACTION,
      ],
    ],
  },
  // Tracker(No interaction) -> Non-Tracker
  {
    trackersHasUserInteraction: [],
    redirects: [TEST_TRACKING_REDIRECT_PAGE, TEST_PAGE],
    expectedPermissionNumber: 0,
    expects: [
      [
        TEST_DOMAIN,
        TEST_3RD_PARTY_DOMAIN,
        Ci.nsIPermissionManager.UNKNOWN_ACTION,
      ],
    ],
  },
  // Non-Tracker -> Tracker(Interacted) -> Non-Tracker
  {
    trackersHasUserInteraction: [TEST_3RD_PARTY_DOMAIN],
    redirects: [TEST_REDIRECT_PAGE, TEST_TRACKING_REDIRECT_PAGE, TEST_PAGE],
    expectedPermissionNumber: 1,
    expects: [
      [
        TEST_DOMAIN,
        TEST_3RD_PARTY_DOMAIN,
        Ci.nsIPermissionManager.ALLOW_ACTION,
      ],
    ],
  },
  // Tracker(Interacted) -> Tracker(Interacted) -> Tracker(Interacted)
  {
    trackersHasUserInteraction: [TEST_3RD_PARTY_DOMAIN],
    redirects: [
      TEST_TRACKING_REDIRECT_PAGE,
      TEST_TRACKING_REDIRECT_PAGE,
      TEST_TRACKING_PAGE,
    ],
    expectedPermissionNumber: 0,
    expects: [
      [
        TEST_3RD_PARTY_DOMAIN,
        TEST_3RD_PARTY_DOMAIN,
        Ci.nsIPermissionManager.UNKNOWN_ACTION,
      ],
    ],
  },
  // Tracker1(Interacted) -> Tracker2(Interacted) -> Non-Tracker
  {
    trackersHasUserInteraction: [
      TEST_3RD_PARTY_DOMAIN,
      TEST_ANOTHER_3RD_PARTY_DOMAIN_HTTPS,
    ],
    redirects: [
      TEST_TRACKING_REDIRECT_PAGE,
      TEST_ANOTHER_TRACKING_REDIRECT_PAGE,
      TEST_PAGE,
    ],
    expectedPermissionNumber: 1,
    expects: [
      [
        TEST_DOMAIN,
        TEST_ANOTHER_3RD_PARTY_DOMAIN_HTTPS,
        Ci.nsIPermissionManager.ALLOW_ACTION,
      ],
    ],
  },
  // Tracker1(Interacted) -> Non-Tracker -> Tracker2(No interaction) -> Non-Tracker
  {
    trackersHasUserInteraction: [TEST_3RD_PARTY_DOMAIN],
    redirects: [
      TEST_TRACKING_REDIRECT_PAGE,
      TEST_REDIRECT_PAGE,
      TEST_ANOTHER_TRACKING_REDIRECT_PAGE,
      TEST_PAGE,
    ],
    expectedPermissionNumber: 1,
    expects: [
      [
        TEST_DOMAIN,
        TEST_3RD_PARTY_DOMAIN,
        Ci.nsIPermissionManager.ALLOW_ACTION,
      ],
    ],
  },
  // Tracker1(Interacted) -> Non-Tracker -> Tracker2(Interacted) -> Non-Tracker
  // Note that the result is not quite correct in this case. We are supposed to
  // grant access to the least tracker instead of the first one. But, this is
  // the behavior how we act so far. We would fix this in another bug.
  {
    trackersHasUserInteraction: [
      TEST_3RD_PARTY_DOMAIN,
      TEST_ANOTHER_3RD_PARTY_DOMAIN_HTTPS,
    ],
    redirects: [
      TEST_TRACKING_REDIRECT_PAGE,
      TEST_REDIRECT_PAGE,
      TEST_ANOTHER_TRACKING_REDIRECT_PAGE,
      TEST_PAGE,
    ],
    expectedPermissionNumber: 1,
    expects: [
      [
        TEST_DOMAIN,
        TEST_3RD_PARTY_DOMAIN,
        Ci.nsIPermissionManager.ALLOW_ACTION,
      ],
    ],
  },
  // Tracker(Interacted) -> Non-Tracker (heuristic disabled)
  {
    trackersHasUserInteraction: [TEST_3RD_PARTY_DOMAIN],
    redirects: [TEST_TRACKING_REDIRECT_PAGE, TEST_PAGE],
    expectedPermissionNumber: 0,
    expects: [
      [
        TEST_DOMAIN,
        TEST_3RD_PARTY_DOMAIN,
        Ci.nsIPermissionManager.UNKNOWN_ACTION,
      ],
    ],
    extraPrefs: [["privacy.antitracking.enableWebcompat", false]],
  },
];

async function interactWithSpecificTracker(aTracker) {
  let win = await BrowserTestUtils.openNewBrowserWindow();
  await BrowserTestUtils.withNewTab(
    { gBrowser: win.gBrowser, url: aTracker },
    async function (browser) {
      info("Let's interact with the tracker");

      await SpecialPowers.spawn(browser, [], async function () {
        SpecialPowers.wrap(content.document).userInteractionForTesting();
      });
    }
  );
  await BrowserTestUtils.closeWindow(win);
}

function getNumberOfStorageAccessPermissions() {
  let num = 0;
  for (let perm of Services.perms.all) {
    if (perm.type.startsWith("3rdPartyStorage^")) {
      num++;
    }
  }
  return num;
}

async function verifyStorageAccessPermission(aExpects) {
  for (let expect of aExpects) {
    let uri = Services.io.newURI(expect[0]);
    let principal = Services.scriptSecurityManager.createContentPrincipal(
      uri,
      {}
    );
    let access = Services.perms.testPermissionFromPrincipal(
      principal,
      `3rdPartyStorage^${expect[1].slice(0, -1)}`
    );

    is(access, expect[2], "The storage access is set correctly");
  }
}

add_setup(async function () {
  await SpecialPowers.pushPrefEnv({
    set: [
      ["network.cookie.cookieBehavior", BEHAVIOR_REJECT_TRACKER],
      ["privacy.trackingprotection.annotate_channels", true],
      [
        "privacy.restrict3rdpartystorage.userInteractionRequiredForHosts",
        "tracking.example.com,tracking.example.org",
      ],
      ["privacy.restrict3rdpartystorage.heuristic.redirect", true],
    ],
  });

  await UrlClassifierTestUtils.addTestTrackers();

  registerCleanupFunction(_ => {
    Services.perms.removeAll();
  });
});

add_task(async function testETPRedirectHeuristic() {
  info("Starting testing ETP redirect heuristic ...");

  for (const test of TEST_CASES) {
    let { extraPrefs } = test;
    if (extraPrefs) {
      await SpecialPowers.pushPrefEnv({
        set: extraPrefs,
      });
    }

    // First, clear all permissions.
    Services.perms.removeAll();

    for (const tracker of test.trackersHasUserInteraction) {
      info(`Interact with ${tracker} in top-level.`);
      await interactWithSpecificTracker(tracker);
    }

    info("Creating a new tab");
    let tab = BrowserTestUtils.addTab(gBrowser, TEST_PAGE);
    gBrowser.selectedTab = tab;

    let browser = gBrowser.getBrowserForTab(tab);
    await BrowserTestUtils.browserLoaded(browser);

    info("Loading the tracking page and trigger the top-level redirect.");
    SpecialPowers.spawn(browser, [test.redirects], async redirects => {
      let link = content.document.createElement("a");
      link.appendChild(content.document.createTextNode("click me!"));
      link.href = redirects.shift() + "?" + redirects.join("|");
      content.document.body.appendChild(link);
      link.click();
    });

    let finalRedirectDest = test.redirects[test.redirects.length - 1];

    await BrowserTestUtils.browserLoaded(browser, false, finalRedirectDest);

    is(
      getNumberOfStorageAccessPermissions(),
      test.expectedPermissionNumber,
      "The number of storage permissions is correct."
    );

    await verifyStorageAccessPermission(test.expects);

    info("Removing the tab");
    BrowserTestUtils.removeTab(tab);

    if (extraPrefs) {
      await SpecialPowers.popPrefEnv();
    }
  }
});