summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/xpcshell/test_QuarantinedDomains.js
blob: fdb243150bc44065723056820b36429e914bba7e (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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
"use strict";

AddonTestUtils.init(this);
AddonTestUtils.createAppInfo(
  "xpcshell@tests.mozilla.org",
  "XPCShell",
  "1",
  "43"
);

AddonTestUtils.overrideCertDB();
AddonTestUtils.usePrivilegedSignatures = id => id.startsWith("privileged");

add_setup(async () => {
  await AddonTestUtils.promiseStartupManager();
});

const server = createHttpServer({ hosts: ["example.org", "example.net"] });
server.registerPathHandler("/", (request, response) => {
  response.setStatusLine(request.httpVersion, 200, "OK");
  response.setHeader("Content-Type", "text/html; charset=utf-8", false);
  response.write("<!DOCTYPE html><html></html>");
});

const ADDONS_RESTRICTED_DOMAINS_PREF =
  "extensions.webextensions.addons-restricted-domains@mozilla.com.disabled";

const DOMAINS = [
  "addons-dev.allizom.org",
  "mixed.badssl.com",
  "careers.mozilla.com",
  "developer.mozilla.org",
  "test.example.com",
];

const CAN_ACCESS_ALL = DOMAINS.reduce((map, domain) => {
  return { ...map, [domain]: true };
}, {});

function makePolicy(options) {
  return new WebExtensionPolicy({
    baseURL: "file:///foo/",
    localizeCallback: str => str,
    allowedOrigins: new MatchPatternSet(["<all_urls>"], { ignorePath: true }),
    mozExtensionHostname: Services.uuid.generateUUID().toString().slice(1, -1),
    ...options,
  });
}

function makeCS(policy) {
  return new WebExtensionContentScript(policy, {
    matches: new MatchPatternSet(["<all_urls>"]),
  });
}

function makeExtension({ id }) {
  return ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: { gecko: { id } },
      permissions: ["<all_urls>"],
      content_scripts: [
        {
          js: ["script.js"],
          matches: ["<all_urls>"],
        },
      ],
    },
    useAddonManager: "permanent",
    files: {
      "script.js": `
        browser.test.sendMessage("tld", location.host.split(".").at(-1));
        browser.test.sendMessage("cs");
      `,
    },
  });
}

function expectQuarantined(expectedDomains) {
  for (let domain of DOMAINS) {
    let uri = Services.io.newURI(`https://${domain}/`);
    let quarantined = expectedDomains.includes(domain);

    equal(
      quarantined,
      WebExtensionPolicy.isQuarantinedURI(uri),
      `Expect ${uri.spec} to ${quarantined ? "" : "not"} be quarantined.`
    );
  }
}

function expectAccess(policy, cs, expected) {
  for (let domain of Object.keys(expected)) {
    let uri = Services.io.newURI(`https://${domain}/`);
    let access = expected[domain];
    let match = access;

    equal(
      access,
      !policy.quarantinedFromURI(uri),
      `${policy.id} is ${access ? "not" : ""} quarantined from ${uri.spec}.`
    );
    equal(
      access,
      policy.canAccessURI(uri),
      `Expect ${policy.id} ${access ? "can" : "can't"} access ${uri.spec}.`
    );

    equal(
      match,
      cs.matchesURI(uri),
      `Expect ${cs.extension.id} to ${match ? "" : "not"} match ${uri.spec}.`
    );
  }
}

function expectHost(desc, host, quarantined) {
  let uri = Services.io.newURI(`https://${host}/`);
  equal(
    quarantined,
    WebExtensionPolicy.isQuarantinedURI(uri),
    `Expect ${desc} "${host}" to ${quarantined ? "" : "not"} be quarantined.`
  );
}

function makePolicies() {
  const plain = makePolicy({ id: "plain@test" });
  const system = makePolicy({ id: "system@test", isPrivileged: true });
  const exempt = makePolicy({ id: "exempt@test", ignoreQuarantine: true });

  return { plain, system, exempt };
}

function makeContentScripts(policies) {
  return policies.map(makeCS);
}

add_task(async function test_QuarantinedDomains() {
  const { plain, system, exempt } = makePolicies();
  const [plainCS, systemCS, exemptCS] = makeContentScripts([
    plain,
    system,
    exempt,
  ]);

  info("Initial pref state is an empty list.");
  expectQuarantined([]);

  expectAccess(plain, plainCS, CAN_ACCESS_ALL);
  expectAccess(system, systemCS, CAN_ACCESS_ALL);
  expectAccess(exempt, exemptCS, CAN_ACCESS_ALL);

  info("Default test domain list.");
  Services.prefs.setStringPref(
    "extensions.quarantinedDomains.list",
    "addons-dev.allizom.org,mixed.badssl.com,test.example.com"
  );

  expectQuarantined([
    "addons-dev.allizom.org",
    "mixed.badssl.com",
    "test.example.com",
  ]);

  const EXPECT_DEFAULTS = {
    "addons-dev.allizom.org": false,
    "mixed.badssl.com": false,
    "careers.mozilla.com": true,
    "developer.mozilla.org": true,
    "test.example.com": false,
  };

  expectAccess(plain, plainCS, EXPECT_DEFAULTS);
  expectAccess(system, systemCS, CAN_ACCESS_ALL);
  expectAccess(exempt, exemptCS, CAN_ACCESS_ALL);

  info("Test changing policy.ignoreQuarantine after creation.");

  ok(!plain.ignoreQuarantine, "plain policy does not ignore quarantine.");
  ok(system.ignoreQuarantine, "system policy does ignore quarantine.");
  ok(exempt.ignoreQuarantine, "exempt policy does ignore quarantine.");

  plain.ignoreQuarantine = true;
  system.ignoreQuarantine = false;
  exempt.ignoreQuarantine = false;

  ok(plain.ignoreQuarantine, "expect plain.ignoreQuarantine to be true.");
  ok(!system.ignoreQuarantine, "expect system.ignoreQuarantine to be false.");
  ok(!exempt.ignoreQuarantine, "expect exempt.ignoreQuarantine to be false.");

  expectAccess(plain, plainCS, CAN_ACCESS_ALL);
  expectAccess(system, systemCS, EXPECT_DEFAULTS);
  expectAccess(exempt, exemptCS, EXPECT_DEFAULTS);

  plain.ignoreQuarantine = false;
  system.ignoreQuarantine = true;
  exempt.ignoreQuarantine = true;

  expectAccess(plain, plainCS, EXPECT_DEFAULTS);
  expectAccess(system, systemCS, CAN_ACCESS_ALL);
  expectAccess(exempt, exemptCS, CAN_ACCESS_ALL);

  info("Disable the Quarantined Domains feature.");
  Services.prefs.setBoolPref("extensions.quarantinedDomains.enabled", false);
  expectQuarantined([]);

  expectAccess(plain, plainCS, CAN_ACCESS_ALL);
  expectAccess(system, systemCS, CAN_ACCESS_ALL);
  expectAccess(exempt, exemptCS, CAN_ACCESS_ALL);

  info(
    "Enable again, drop addons-dev.allizom.org and add developer.mozilla.org to the pref."
  );
  Services.prefs.setBoolPref("extensions.quarantinedDomains.enabled", true);

  Services.prefs.setStringPref(
    "extensions.quarantinedDomains.list",
    "mixed.badssl.com,developer.mozilla.org,test.example.com"
  );
  expectQuarantined([
    "mixed.badssl.com",
    "developer.mozilla.org",
    "test.example.com",
  ]);

  expectAccess(plain, plainCS, {
    "addons-dev.allizom.org": true,
    "mixed.badssl.com": false,
    "careers.mozilla.com": true,
    "developer.mozilla.org": false,
    "test.example.com": false,
  });

  expectAccess(system, systemCS, CAN_ACCESS_ALL);
  expectAccess(exempt, exemptCS, CAN_ACCESS_ALL);

  expectHost("host with a port", "test.example.com:1025", true);

  expectHost("FQDN", "test.example.com.", false);
  expectHost("subdomain", "subdomain.test.example.com", false);
  expectHost("domain with prefix", "pretest.example.com", false);
  expectHost("domain with suffix", "test.example.comsuf", false);
});

function setIgnorePref(id, value = false) {
  Services.prefs.setBoolPref(`extensions.quarantineIgnoredByUser.${id}`, value);
}

// Test that ignore prefs take effect in the content process.
add_task(
  { pref_set: [["extensions.quarantinedDomains.list", "example.net"]] },
  async function test_QuarantinedDomains_ignored() {
    const EXPECT_DEFAULTS = { "example.org": true, "example.net": false };
    const CAN_ACCESS_ALL = { "example.org": true, "example.net": true };

    let alpha = makeExtension({ id: "alpha@test" });
    let beta = makeExtension({ id: "beta@test" });
    let system = makeExtension({ id: "privileged@test" });

    let page = await ExtensionTestUtils.loadContentPage("about:blank");

    await alpha.startup();
    await beta.startup();
    await system.startup();

    equal(system.extension.isPrivileged, true, "is privileged");

    let alphaPolicy = alpha.extension.policy;
    let betaPolicy = beta.extension.policy;

    let alphaCounters = { org: 0, net: 0 };
    let betaCounters = { org: 0, net: 0 };

    alpha.onMessage("tld", tld => alphaCounters[tld]++);
    beta.onMessage("tld", tld => betaCounters[tld]++);
    system.onMessage("tld", () => {});

    async function testTLD(tld, expectAlpha, expectBeta) {
      let alphaCount = alphaCounters[tld];
      let betaCount = betaCounters[tld];

      await page.loadURL(`http://example.${tld}/`);
      if (expectAlpha) {
        await alpha.awaitMessage("cs");
        alphaCount++;
      }
      if (expectBeta) {
        await beta.awaitMessage("cs");
        betaCount++;
      }
      // Sanity check, plus always having something to await.
      await system.awaitMessage("cs");

      equal(alphaCount, alphaCounters[tld], `Expected ${tld} alpha CS counter`);
      equal(betaCount, betaCounters[tld], `Expected ${tld} beta CS counter`);
    }

    info("Test defaults, example.org is accessible, example.net is not.");

    await testTLD("org", true, true);
    await testTLD("net", false, false);

    expectAccess(alphaPolicy, alphaPolicy.contentScripts[0], EXPECT_DEFAULTS);
    expectAccess(betaPolicy, betaPolicy.contentScripts[0], EXPECT_DEFAULTS);

    info("Test setting the pref for alpha@test.");
    setIgnorePref("alpha@test", true);

    await testTLD("net", true, false);
    await testTLD("org", true, true);

    expectAccess(alphaPolicy, alphaPolicy.contentScripts[0], CAN_ACCESS_ALL);
    expectAccess(betaPolicy, betaPolicy.contentScripts[0], EXPECT_DEFAULTS);

    info("Test setting the pref for beta@test.");
    setIgnorePref("beta@test", true);

    await testTLD("org", true, true);
    await testTLD("net", true, true);
    expectAccess(betaPolicy, betaPolicy.contentScripts[0], CAN_ACCESS_ALL);

    info("Test unsetting the pref for alpha@test.");
    setIgnorePref("alpha@test", false);

    await testTLD("net", false, true);
    await testTLD("org", true, true);

    info("Test unsetting the pref for beta@test.");
    setIgnorePref("beta@test", false);

    await testTLD("org", true, true);
    await testTLD("net", false, false);

    expectAccess(alphaPolicy, alphaPolicy.contentScripts[0], EXPECT_DEFAULTS);
    expectAccess(betaPolicy, betaPolicy.contentScripts[0], EXPECT_DEFAULTS);

    Assert.deepEqual(
      alphaCounters,
      { org: 5, net: 2 },
      "Expected final Alpha content script counters."
    );

    Assert.deepEqual(
      betaCounters,
      { org: 5, net: 2 },
      "Expected final Beta content script counters."
    );

    await system.unload();
    await beta.unload();
    await alpha.unload();

    await page.close();
  }
);

// Make sure we honor the system add-on pref.
add_task(
  {
    pref_set: [
      [ADDONS_RESTRICTED_DOMAINS_PREF, true],
      [
        "extensions.quarantinedDomains.list",
        "addons-dev.allizom.org,mixed.badssl.com,test.example.com",
      ],
    ],
  },
  async function test_QuarantinedDomains_with_system_addon_disabled() {
    await AddonTestUtils.promiseRestartManager();

    const { plain, system, exempt } = makePolicies();
    const [plainCS, systemCS, exemptCS] = makeContentScripts([
      plain,
      system,
      exempt,
    ]);

    expectQuarantined([]);
    expectAccess(plain, plainCS, CAN_ACCESS_ALL);
    expectAccess(system, systemCS, CAN_ACCESS_ALL);
    expectAccess(exempt, exemptCS, CAN_ACCESS_ALL);

    // When the user changes this pref to re-enable the system add-on...
    Services.prefs.setBoolPref(ADDONS_RESTRICTED_DOMAINS_PREF, false);
    // ...after a AOM restart...
    await AddonTestUtils.promiseRestartManager();
    // ...we expect no change.
    expectQuarantined([]);
    expectAccess(plain, plainCS, CAN_ACCESS_ALL);
    expectAccess(system, systemCS, CAN_ACCESS_ALL);
    expectAccess(exempt, exemptCS, CAN_ACCESS_ALL);
  }
);