Policies.jsm 41.9 KB
Newer Older
1
2
3
4
5
6
/* 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 http://mozilla.org/MPL/2.0/. */

"use strict";

7
8
9
const {XPCOMUtils} = ChromeUtils.import("resource://gre/modules/XPCOMUtils.jsm");
const {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");
const {AppConstants} = ChromeUtils.import("resource://gre/modules/AppConstants.jsm");
10
11
12
13
14

XPCOMUtils.defineLazyServiceGetters(this, {
  gCertDB: ["@mozilla.org/security/x509certdb;1", "nsIX509CertDB"],
  gXulStore: ["@mozilla.org/xul/xulstore;1", "nsIXULStore"],
});
15

16
XPCOMUtils.defineLazyModuleGetters(this, {
17
  AddonManager: "resource://gre/modules/AddonManager.jsm",
18
  BookmarksPolicies: "resource:///modules/policies/BookmarksPolicies.jsm",
19
  CustomizableUI: "resource:///modules/CustomizableUI.jsm",
20
21
  ProxyPolicies: "resource:///modules/policies/ProxyPolicies.jsm",
  WebsiteFilter: "resource:///modules/policies/WebsiteFilter.jsm",
22
23
});

24
25
XPCOMUtils.defineLazyGlobalGetters(this, ["File", "FileReader"]);

26
const PREF_LOGLEVEL           = "browser.policies.loglevel";
27
const BROWSER_DOCUMENT_URL    = AppConstants.BROWSER_CHROME_URL;
28
29

XPCOMUtils.defineLazyGetter(this, "log", () => {
30
  let { ConsoleAPI } = ChromeUtils.import("resource://gre/modules/Console.jsm");
31
32
33
34
35
36
37
38
39
  return new ConsoleAPI({
    prefix: "Policies.jsm",
    // tip: set maxLogLevel to "debug" and use log.debug() to create detailed
    // messages during development. See LOG_LEVELS in Console.jsm for details.
    maxLogLevel: "error",
    maxLogLevelPref: PREF_LOGLEVEL,
  });
});

40
var EXPORTED_SYMBOLS = ["Policies"];
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
/*
 * ============================
 * = POLICIES IMPLEMENTATIONS =
 * ============================
 *
 * The Policies object below is where the implementation for each policy
 * happens. An object for each policy should be defined, containing
 * callback functions that will be called by the engine.
 *
 * See the _callbacks object in EnterprisePolicies.js for the list of
 * possible callbacks and an explanation of each.
 *
 * Each callback will be called with two parameters:
 * - manager
 *   This is the EnterprisePoliciesManager singleton object from
 *   EnterprisePolicies.js
 *
 * - param
 *   The parameter defined for this policy in policies-schema.json.
 *   It will be different for each policy. It could be a boolean,
 *   a string, an array or a complex object. All parameters have
 *   been validated according to the schema, and no unknown
 *   properties will be present on them.
 *
 * The callbacks will be bound to their parent policy object.
 */
68
var Policies = {
69
70
71
72
73
74
  "3rdparty": {
    onBeforeAddons(manager, param) {
      manager.setExtensionPolicies(param.Extensions);
    },
  },

75
76
77
  "AppUpdateURL": {
    onBeforeAddons(manager, param) {
      setDefaultPref("app.update.url", param.href);
78
    },
79
80
  },

81
82
83
84
85
86
87
88
89
90
91
  "Authentication": {
    onBeforeAddons(manager, param) {
      if ("SPNEGO" in param) {
        setAndLockPref("network.negotiate-auth.trusted-uris", param.SPNEGO.join(", "));
      }
      if ("Delegated" in param) {
        setAndLockPref("network.negotiate-auth.delegation-uris", param.Delegated.join(", "));
      }
      if ("NTLM" in param) {
        setAndLockPref("network.automatic-ntlm-auth.trusted-uris", param.NTLM.join(", "));
      }
92
93
94
95
96
97
98
99
      if ("AllowNonFQDN" in param) {
        if (param.AllowNonFQDN.NTLM) {
          setAndLockPref("network.automatic-ntlm-auth.allow-non-fqdn", param.AllowNonFQDN.NTLM);
        }
        if (param.AllowNonFQDN.SPNEGO) {
          setAndLockPref("network.negotiate-auth.allow-non-fqdn", param.AllowNonFQDN.SPNEGO);
        }
      }
100
    },
101
102
  },

103
104
105
  "BlockAboutAddons": {
    onBeforeUIStartup(manager, param) {
      if (param) {
106
        blockAboutPage(manager, "about:addons", true);
107
      }
108
    },
109
110
  },

111
  "BlockAboutConfig": {
112
    onBeforeUIStartup(manager, param) {
113
      if (param) {
114
        blockAboutPage(manager, "about:config");
115
        setAndLockPref("devtools.chrome.enabled", false);
116
      }
117
    },
118
  },
119

120
121
122
  "BlockAboutProfiles": {
    onBeforeUIStartup(manager, param) {
      if (param) {
123
        blockAboutPage(manager, "about:profiles");
124
      }
125
    },
126
127
  },

128
129
130
  "BlockAboutSupport": {
    onBeforeUIStartup(manager, param) {
      if (param) {
131
        blockAboutPage(manager, "about:support");
132
      }
133
    },
134
135
  },

136
137
138
  "Bookmarks": {
    onAllWindowsRestored(manager, param) {
      BookmarksPolicies.processBookmarks(param);
139
    },
140
141
  },

142
143
144
145
146
147
  "CaptivePortal": {
    onBeforeAddons(manager, param) {
      setAndLockPref("network.captive-portal-service.enabled", param);
    },
  },

148
149
150
  "Certificates": {
    onBeforeAddons(manager, param) {
      if ("ImportEnterpriseRoots" in param) {
151
        setAndLockPref("security.enterprise_roots.enabled", param.ImportEnterpriseRoots);
152
      }
153
154
155
156
157
158
      if ("Install" in param) {
        (async () => {
          let dirs = [];
          let platform = AppConstants.platform;
          if (platform == "win") {
            dirs = [
159
              // Ugly, but there is no official way to get %USERNAME\AppData\Roaming\Mozilla.
160
              Services.dirsvc.get("XREUSysExt", Ci.nsIFile).parent,
161
162
              // Even more ugly, but there is no official way to get %USERNAME\AppData\Local\Mozilla.
              Services.dirsvc.get("DefProfLRt", Ci.nsIFile).parent.parent,
163
164
165
166
167
168
169
170
            ];
          } else if (platform == "macosx" || platform == "linux") {
            dirs = [
              // These two keys are named wrong. They return the Mozilla directory.
              Services.dirsvc.get("XREUserNativeManifests", Ci.nsIFile),
              Services.dirsvc.get("XRESysNativeManifests", Ci.nsIFile),
            ];
          }
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
          dirs.unshift(Services.dirsvc.get("XREAppDist", Ci.nsIFile));
          for (let certfilename of param.Install) {
            let certfile;
            try {
              certfile = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
              certfile.initWithPath(certfilename);
            } catch (e) {
              for (let dir of dirs) {
                certfile = dir.clone();
                certfile.append(platform == "linux" ? "certificates" : "Certificates");
                certfile.append(certfilename);
                if (certfile.exists()) {
                  break;
                }
              }
            }
            let file;
            try {
              file = await File.createFromNsIFile(certfile);
            } catch (e) {
              log.error(`Unable to find certificate - ${certfilename}`);
              continue;
            }
            let reader = new FileReader();
            reader.onloadend = function() {
              if (reader.readyState != reader.DONE) {
                log.error(`Unable to read certificate - ${certfile.path}`);
                return;
              }
200
201
              let certFile = reader.result;
              let cert;
202
              try {
203
                cert = gCertDB.constructX509(certFile);
204
              } catch (e) {
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
                try {
                  // It might be PEM instead of DER.
                  cert = gCertDB.constructX509FromBase64(pemToBase64(certFile));
                } catch (ex) {
                  log.error(`Unable to add certificate - ${certfile.path}`);
                }
              }
              let now = Date.now() / 1000;
              if (cert) {
                gCertDB.asyncVerifyCertAtTime(cert, 0x0008 /* certificateUsageSSLCA */,
                                              0, null, now, (aPRErrorCode, aVerifiedChain, aHasEVPolicy) => {
                  if (aPRErrorCode == Cr.NS_OK) {
                    // Certificate is already installed.
                    return;
                  }
                  try {
                    gCertDB.addCert(certFile, "CT,CT,");
                  } catch (e) {
                    // It might be PEM instead of DER.
                    gCertDB.addCertFromBase64(pemToBase64(certFile), "CT,CT,");
                  }
                });
227
              }
228
229
            };
            reader.readAsBinaryString(file);
230
231
232
          }
        })();
      }
233
    },
234
235
  },

236
  "Cookies": {
237
    onBeforeUIStartup(manager, param) {
238
      addAllowDenyPermissions("cookie", param.Allow, param.Block);
239
240

      if (param.Block) {
241
        const hosts = param.Block.map(url => url.hostname).sort().join("\n");
242
243
        runOncePerModification("clearCookiesForBlockedHosts", hosts, () => {
          for (let blocked of param.Block) {
244
            Services.cookies.removeCookiesWithOriginAttributes("{}", blocked.hostname);
245
246
247
          }
        });
      }
248
249
250

      if (param.Default !== undefined ||
          param.AcceptThirdParty !== undefined ||
251
          param.RejectTracker !== undefined ||
252
253
254
255
256
          param.Locked) {
        const ACCEPT_COOKIES = 0;
        const REJECT_THIRD_PARTY_COOKIES = 1;
        const REJECT_ALL_COOKIES = 2;
        const REJECT_UNVISITED_THIRD_PARTY = 3;
257
        const REJECT_TRACKER = 4;
258
259
260
261
262

        let newCookieBehavior = ACCEPT_COOKIES;
        if (param.Default !== undefined && !param.Default) {
          newCookieBehavior = REJECT_ALL_COOKIES;
        } else if (param.AcceptThirdParty) {
263
          if (param.AcceptThirdParty == "never") {
264
265
266
267
            newCookieBehavior = REJECT_THIRD_PARTY_COOKIES;
          } else if (param.AcceptThirdParty == "from-visited") {
            newCookieBehavior = REJECT_UNVISITED_THIRD_PARTY;
          }
268
269
        } else if (param.RejectTracker !== undefined && param.RejectTracker) {
          newCookieBehavior = REJECT_TRACKER;
270
271
        }

272
        setDefaultPref("network.cookie.cookieBehavior", newCookieBehavior, param.Locked);
273
274
275
276
277
278
279
280
281
282
283
      }

      const KEEP_COOKIES_UNTIL_EXPIRATION = 0;
      const KEEP_COOKIES_UNTIL_END_OF_SESSION = 2;

      if (param.ExpireAtSessionEnd !== undefined || param.Locked) {
        let newLifetimePolicy = KEEP_COOKIES_UNTIL_EXPIRATION;
        if (param.ExpireAtSessionEnd) {
          newLifetimePolicy = KEEP_COOKIES_UNTIL_END_OF_SESSION;
        }

284
        setDefaultPref("network.cookie.lifetimePolicy", newLifetimePolicy, param.Locked);
285
      }
286
    },
287
288
  },

289
290
291
292
  "DisableAppUpdate": {
    onBeforeAddons(manager, param) {
      if (param) {
        manager.disallowFeature("appUpdate");
293
      }
294
    },
295
296
  },

297
  "DisableBuiltinPDFViewer": {
298
    onBeforeAddons(manager, param) {
299
      if (param) {
300
        setAndLockPref("pdfjs.disabled", true);
301
      }
302
    },
303
304
  },

305
306
307
308
309
310
311
  "DisableDeveloperTools": {
    onBeforeAddons(manager, param) {
      if (param) {
        setAndLockPref("devtools.policy.disabled", true);
        setAndLockPref("devtools.chrome.enabled", false);

        manager.disallowFeature("devtools");
312
313
314
        blockAboutPage(manager, "about:devtools");
        blockAboutPage(manager, "about:debugging");
        blockAboutPage(manager, "about:devtools-toolbox");
315
      }
316
    },
317
318
  },

319
320
321
322
323
  "DisableFeedbackCommands": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("feedbackCommands");
      }
324
    },
325
326
  },

327
328
329
330
331
  "DisableFirefoxAccounts": {
    onBeforeAddons(manager, param) {
      if (param) {
        setAndLockPref("identity.fxaccounts.enabled", false);
      }
332
    },
333
334
  },

335
336
  "DisableFirefoxScreenshots": {
    onBeforeAddons(manager, param) {
337
      if (param) {
338
339
        setAndLockPref("extensions.screenshots.disabled", true);
      }
340
    },
341
342
  },

343
344
  "DisableFirefoxStudies": {
    onBeforeAddons(manager, param) {
345
      if (param) {
346
        manager.disallowFeature("Shield");
347
348
        setAndLockPref("browser.newtabpage.activity-stream.asrouter.userprefs.cfr.addons", false);
        setAndLockPref("browser.newtabpage.activity-stream.asrouter.userprefs.cfr.features", false);
349
      }
350
    },
351
352
  },

353
354
355
  "DisableForgetButton": {
    onProfileAfterChange(manager, param) {
      if (param) {
356
        setAndLockPref("privacy.panicButton.enabled", false);
357
      }
358
    },
359
360
  },

361
362
  "DisableFormHistory": {
    onBeforeUIStartup(manager, param) {
363
      if (param) {
364
365
        setAndLockPref("browser.formfill.enable", false);
      }
366
    },
367
368
  },

369
370
371
372
373
  "DisableMasterPasswordCreation": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("createMasterPassword");
      }
374
    },
375
376
  },

377
378
379
380
381
  "DisablePocket": {
    onBeforeAddons(manager, param) {
      if (param) {
        setAndLockPref("extensions.pocket.enabled", false);
      }
382
    },
383
384
  },

385
386
387
388
  "DisablePrivateBrowsing": {
    onBeforeAddons(manager, param) {
      if (param) {
        manager.disallowFeature("privatebrowsing");
389
        blockAboutPage(manager, "about:privatebrowsing", true);
390
391
        setAndLockPref("browser.privatebrowsing.autostart", false);
      }
392
    },
393
394
  },

395
396
397
398
399
400
  "DisableProfileImport": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("profileImport");
        setAndLockPref("browser.newtabpage.activity-stream.migrationExpired", true);
      }
401
    },
402
403
  },

404
405
406
407
408
409
  "DisableProfileRefresh": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("profileRefresh");
        setAndLockPref("browser.disableResetPrompt", true);
      }
410
    },
411
412
  },

413
414
415
416
417
  "DisableSafeMode": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("safeMode");
      }
418
    },
419
420
  },

421
422
  "DisableSecurityBypass": {
    onBeforeUIStartup(manager, param) {
423
424
425
426
      if ("InvalidCertificate" in param) {
        setAndLockPref("security.certerror.hideAddException", param.InvalidCertificate);
      }

427
428
429
      if ("SafeBrowsing" in param) {
        setAndLockPref("browser.safebrowsing.allowOverride", !param.SafeBrowsing);
      }
430
    },
431
432
  },

433
434
435
  "DisableSetDesktopBackground": {
    onBeforeUIStartup(manager, param) {
      if (param) {
436
        manager.disallowFeature("setDesktopBackground");
437
      }
438
    },
439
440
441
  },

  "DisableSystemAddonUpdate": {
442
443
444
445
    onBeforeAddons(manager, param) {
      if (param) {
        manager.disallowFeature("SysAddonUpdate");
      }
446
    },
447
448
  },

449
450
451
452
453
  "DisableTelemetry": {
    onBeforeAddons(manager, param) {
      if (param) {
        setAndLockPref("datareporting.healthreport.uploadEnabled", false);
        setAndLockPref("datareporting.policy.dataSubmissionEnabled", false);
454
        blockAboutPage(manager, "about:telemetry");
455
      }
456
    },
457
458
  },

459
  "DisplayBookmarksToolbar": {
460
    onBeforeUIStartup(manager, param) {
461
462
463
464
465
466
467
      let value = (!param).toString();
      // This policy is meant to change the default behavior, not to force it.
      // If this policy was alreay applied and the user chose to re-hide the
      // bookmarks toolbar, do not show it again.
      runOncePerModification("displayBookmarksToolbar", value, () => {
        gXulStore.setValue(BROWSER_DOCUMENT_URL, "PersonalToolbar", "collapsed", value);
      });
468
    },
469
470
  },

471
  "DisplayMenuBar": {
472
    onBeforeUIStartup(manager, param) {
473
      let value = (!param).toString();
474
475
476
        // This policy is meant to change the default behavior, not to force it.
        // If this policy was alreay applied and the user chose to re-hide the
        // menu bar, do not show it again.
477
478
479
      runOncePerModification("displayMenuBar", value, () => {
        gXulStore.setValue(BROWSER_DOCUMENT_URL, "toolbar-menubar", "autohide", value);
      });
480
    },
481
482
  },

483
484
485
486
  "DNSOverHTTPS": {
    onBeforeAddons(manager, param) {
      if ("Enabled" in param) {
        let mode = param.Enabled ? 2 : 5;
487
        setDefaultPref("network.trr.mode", mode, param.Locked);
488
489
      }
      if (param.ProviderURL) {
490
        setDefaultPref("network.trr.uri", param.ProviderURL.href, param.Locked);
491
492
493
494
      }
    },
  },

495
  "DontCheckDefaultBrowser": {
496
    onBeforeUIStartup(manager, param) {
497
      setAndLockPref("browser.shell.checkDefaultBrowser", !param);
498
    },
499
500
  },

501
502
  "EnableTrackingProtection": {
    onBeforeUIStartup(manager, param) {
503
      if (param.Value) {
504
505
        setDefaultPref("privacy.trackingprotection.enabled", true, param.Locked);
        setDefaultPref("privacy.trackingprotection.pbmode.enabled", true, param.Locked);
506
      } else {
507
508
        setAndLockPref("privacy.trackingprotection.enabled", false);
        setAndLockPref("privacy.trackingprotection.pbmode.enabled", false);
509
      }
510
    },
511
512
  },

513
514
  "Extensions": {
    onBeforeUIStartup(manager, param) {
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
      let uninstallingPromise = Promise.resolve();
      if ("Uninstall" in param) {
        uninstallingPromise = runOncePerModification("extensionsUninstall", JSON.stringify(param.Uninstall), async () => {
          // If we're uninstalling add-ons, re-run the extensionsInstall runOnce even if it hasn't
          // changed, which will allow add-ons to be updated.
          Services.prefs.clearUserPref("browser.policies.runOncePerModification.extensionsInstall");
          let addons = await AddonManager.getAddonsByIDs(param.Uninstall);
          for (let addon of addons) {
            if (addon) {
              try {
                await addon.uninstall();
              } catch (e) {
                // This can fail for add-ons that can't be uninstalled.
                // Just ignore.
              }
            }
          }
        });
      }
534
      if ("Install" in param) {
535
536
        runOncePerModification("extensionsInstall", JSON.stringify(param.Install), async () => {
          await uninstallingPromise;
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
          for (let location of param.Install) {
            let url;
            if (location.includes("://")) {
              // Assume location is an URI
              url = location;
            } else {
              // Assume location is a file path
              let xpiFile = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
              try {
                xpiFile.initWithPath(location);
              } catch (e) {
                log.error(`Invalid extension path location - ${location}`);
                continue;
              }
              url = Services.io.newFileURI(xpiFile).spec;
            }
553
554
555
            AddonManager.getInstallForURL(url, {
              telemetryInfo: {source: "enterprise-policy"},
            }).then(install => {
556
557
558
559
560
              if (install.addon && install.addon.appDisabled) {
                log.error(`Incompatible add-on - ${location}`);
                install.cancel();
                return;
              }
561
              let listener = {
562
563
564
565
566
567
568
569
              /* eslint-disable-next-line no-shadow */
                onDownloadEnded: (install) => {
                  if (install.addon && install.addon.appDisabled) {
                    log.error(`Incompatible add-on - ${location}`);
                    install.removeListener(listener);
                    install.cancel();
                  }
                },
570
                onDownloadFailed: () => {
571
                  install.removeListener(listener);
572
                  log.error(`Download failed - ${location}`);
573
                  clearRunOnceModification("extensionsInstall");
574
575
                },
                onInstallFailed: () => {
576
                  install.removeListener(listener);
577
578
579
                  log.error(`Installation failed - ${location}`);
                },
                onInstallEnded: () => {
580
                  install.removeListener(listener);
581
                  log.debug(`Installation succeeded - ${location}`);
582
                },
583
584
585
              };
              install.addListener(listener);
              install.install();
586
            });
587
588
589
590
591
592
593
594
          }
        });
      }
      if ("Locked" in param) {
        for (let ID of param.Locked) {
          manager.disallowFeature(`modify-extension:${ID}`);
        }
      }
595
    },
596
597
  },

598
599
600
601
602
603
  "ExtensionSettings": {
    onBeforeAddons(manager, param) {
      manager.setExtensionSettings(param);
    },
  },

604
605
606
607
608
609
610
611
  "ExtensionUpdate": {
    onBeforeAddons(manager, param) {
      if (!param) {
        setAndLockPref("extensions.update.enabled", param);
      }
    },
  },

612
  "FlashPlugin": {
613
    onBeforeUIStartup(manager, param) {
614
      addAllowDenyPermissions("plugin:flash", param.Allow, param.Block);
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632

      const FLASH_NEVER_ACTIVATE = 0;
      const FLASH_ASK_TO_ACTIVATE = 1;
      const FLASH_ALWAYS_ACTIVATE = 2;

      let flashPrefVal;
      if (param.Default === undefined) {
        flashPrefVal = FLASH_ASK_TO_ACTIVATE;
      } else if (param.Default) {
        flashPrefVal = FLASH_ALWAYS_ACTIVATE;
      } else {
        flashPrefVal = FLASH_NEVER_ACTIVATE;
      }
      if (param.Locked) {
        setAndLockPref("plugin.state.flash", flashPrefVal);
      } else if (param.Default !== undefined) {
        setDefaultPref("plugin.state.flash", flashPrefVal);
      }
633
    },
634
635
  },

636
637
638
639
640
  "HardwareAcceleration": {
    onBeforeAddons(manager, param) {
      if (!param) {
        setAndLockPref("layers.acceleration.disabled", true);
      }
641
    },
642
643
  },

644
645
646
647
648
  "Homepage": {
    onBeforeUIStartup(manager, param) {
      // |homepages| will be a string containing a pipe-separated ('|') list of
      // URLs because that is what the "Home page" section of about:preferences
      // (and therefore what the pref |browser.startup.homepage|) accepts.
649
650
651
652
653
      if (param.URL) {
        let homepages = param.URL.href;
        if (param.Additional && param.Additional.length > 0) {
          homepages += "|" + param.Additional.map(url => url.href).join("|");
        }
654
        setDefaultPref("browser.startup.homepage", homepages, param.Locked);
655
656
657
658
659
660
661
662
663
        if (param.Locked) {
          setAndLockPref("pref.browser.homepage.disable_button.current_page", true);
          setAndLockPref("pref.browser.homepage.disable_button.bookmark_page", true);
          setAndLockPref("pref.browser.homepage.disable_button.restore_default", true);
        } else {
          runOncePerModification("setHomepage", homepages, () => {
            Services.prefs.clearUserPref("browser.startup.homepage");
          });
        }
664
      }
665
666
667
668
669
670
671
672
673
674
675
676
677
      if (param.StartPage) {
        let prefValue;
        switch (param.StartPage) {
          case "none":
            prefValue = 0;
            break;
          case "homepage":
            prefValue = 1;
            break;
          case "previous-session":
            prefValue = 3;
            break;
        }
678
        setDefaultPref("browser.startup.page", prefValue, param.Locked);
679
      }
680
    },
681
682
  },

683
  "InstallAddonsPermission": {
684
    onBeforeUIStartup(manager, param) {
685
686
687
688
689
      if ("Allow" in param) {
        addAllowDenyPermissions("install", param.Allow, null);
      }
      if ("Default" in param) {
        setAndLockPref("xpinstall.enabled", param.Default);
690
        if (!param.Default) {
691
          blockAboutPage(manager, "about:debugging");
692
693
          setAndLockPref("browser.newtabpage.activity-stream.asrouter.userprefs.cfr.addons", false);
          setAndLockPref("browser.newtabpage.activity-stream.asrouter.userprefs.cfr.features", false);
694
          manager.disallowFeature("xpinstall");
695
        }
696
      }
697
    },
698
699
  },

700
701
702
703
704
705
706
707
708
709
710
  "LocalFileLinks": {
    onBeforeAddons(manager, param) {
      // If there are existing capabilities, lock them with the policy pref.
      let policyNames = Services.prefs.getCharPref("capability.policy.policynames", "").split(" ");
      policyNames.push("localfilelinks_policy");
      setAndLockPref("capability.policy.policynames", policyNames.join(" "));
      setAndLockPref("capability.policy.localfilelinks_policy.checkloaduri.enabled", "allAccess");
      setAndLockPref("capability.policy.localfilelinks_policy.sites", param.join(" "));
    },
  },

711
712
713
714
715
716
717
  "NetworkPrediction": {
    onBeforeAddons(manager, param) {
      setAndLockPref("network.dns.disablePrefetch", !param);
      setAndLockPref("network.dns.disablePrefetchFromHTTPS", !param);
    },
  },

718
719
720
721
722
723
  "NewTabPage": {
    onBeforeAddons(manager, param) {
      setAndLockPref("browser.newtabpage.enabled", param);
    },
  },

724
725
726
727
728
  "NoDefaultBookmarks": {
    onProfileAfterChange(manager, param) {
      if (param) {
        manager.disallowFeature("defaultBookmarks");
      }
729
    },
730
731
  },

732
733
734
  "OfferToSaveLogins": {
    onBeforeUIStartup(manager, param) {
      setAndLockPref("signon.rememberSignons", param);
735
    },
736
737
  },

738
739
  "OverrideFirstRunPage": {
    onProfileAfterChange(manager, param) {
740
      let url = param ? param.href : "";
741
      setAndLockPref("startup.homepage_welcome_url", url);
742
    },
743
744
  },

745
746
  "OverridePostUpdatePage": {
    onProfileAfterChange(manager, param) {
747
      let url = param ? param.href : "";
748
749
750
751
752
      setAndLockPref("startup.homepage_override_url", url);
      // The pref startup.homepage_override_url is only used
      // as a fallback when the update.xml file hasn't provided
      // a specific post-update URL.
      manager.disallowFeature("postUpdateCustomPage");
753
    },
754
755
  },

756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
  "Permissions": {
    onBeforeUIStartup(manager, param) {
      if (param.Camera) {
        addAllowDenyPermissions("camera", param.Camera.Allow, param.Camera.Block);
        setDefaultPermission("camera", param.Camera);
      }

      if (param.Microphone) {
        addAllowDenyPermissions("microphone", param.Microphone.Allow, param.Microphone.Block);
        setDefaultPermission("microphone", param.Microphone);
      }

      if (param.Location) {
        addAllowDenyPermissions("geo", param.Location.Allow, param.Location.Block);
        setDefaultPermission("geo", param.Location);
      }

      if (param.Notifications) {
        addAllowDenyPermissions("desktop-notification", param.Notifications.Allow, param.Notifications.Block);
        setDefaultPermission("desktop-notification", param.Notifications);
      }
777
    },
778
779
  },

780
  "PopupBlocking": {
781
    onBeforeUIStartup(manager, param) {
782
      addAllowDenyPermissions("popup", param.Allow, null);
783
784
785
786
787
788
789
790
791
792

      if (param.Locked) {
        let blockValue = true;
        if (param.Default !== undefined && !param.Default) {
          blockValue = false;
        }
        setAndLockPref("dom.disable_open_during_load", blockValue);
      } else if (param.Default !== undefined) {
        setDefaultPref("dom.disable_open_during_load", !!param.Default);
      }
793
    },
794
795
  },

796
797
798
799
800
801
802
803
  "Preferences": {
    onBeforeAddons(manager, param) {
      for (let preference in param) {
        setAndLockPref(preference, param[preference]);
      }
    },
  },

804
805
806
807
808
809
810
811
  "Proxy": {
    onBeforeAddons(manager, param) {
      if (param.Locked) {
        manager.disallowFeature("changeProxySettings");
        ProxyPolicies.configureProxySettings(param, setAndLockPref);
      } else {
        ProxyPolicies.configureProxySettings(param, setDefaultPref);
      }
812
    },
813
  },
814

815
816
  "RequestedLocales": {
    onBeforeAddons(manager, param) {
817
818
819
820
821
      if (Array.isArray(param)) {
        Services.locale.requestedLocales = param;
      } else {
        Services.locale.requestedLocales = param.split(",");
      }
822
823
824
    },
  },

825
826
  "SanitizeOnShutdown": {
    onBeforeUIStartup(manager, param) {
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
      if (typeof param === "boolean") {
        setAndLockPref("privacy.sanitize.sanitizeOnShutdown", param);
        if (param) {
          setAndLockPref("privacy.clearOnShutdown.cache", true);
          setAndLockPref("privacy.clearOnShutdown.cookies", true);
          setAndLockPref("privacy.clearOnShutdown.downloads", true);
          setAndLockPref("privacy.clearOnShutdown.formdata", true);
          setAndLockPref("privacy.clearOnShutdown.history", true);
          setAndLockPref("privacy.clearOnShutdown.sessions", true);
          setAndLockPref("privacy.clearOnShutdown.siteSettings", true);
          setAndLockPref("privacy.clearOnShutdown.offlineApps", true);
        }
      } else {
        setAndLockPref("privacy.sanitize.sanitizeOnShutdown", true);
        if ("Cache" in param) {
          setAndLockPref("privacy.clearOnShutdown.cache", param.Cache);
        } else {
          setAndLockPref("privacy.clearOnShutdown.cache", false);
        }
        if ("Cookies" in param) {
          setAndLockPref("privacy.clearOnShutdown.cookies", param.Cookies);
        } else {
          setAndLockPref("privacy.clearOnShutdown.cookies", false);
        }
        if ("Downloads" in param) {
          setAndLockPref("privacy.clearOnShutdown.downloads", param.Downloads);
        } else {
          setAndLockPref("privacy.clearOnShutdown.downloads", false);
        }
        if ("FormData" in param) {
          setAndLockPref("privacy.clearOnShutdown.formdata", param.FormData);
        } else {
          setAndLockPref("privacy.clearOnShutdown.formdata", false);
        }
        if ("History" in param) {
          setAndLockPref("privacy.clearOnShutdown.history", param.History);
        } else {
          setAndLockPref("privacy.clearOnShutdown.history", false);
        }
        if ("Sessions" in param) {
          setAndLockPref("privacy.clearOnShutdown.sessions", param.Sessions);
        } else {
          setAndLockPref("privacy.clearOnShutdown.sessions", false);
        }
        if ("SiteSettings" in param) {
          setAndLockPref("privacy.clearOnShutdown.siteSettings", param.SiteSettings);
        }
        if ("OfflineApps" in param) {
          setAndLockPref("privacy.clearOnShutdown.offlineApps", param.OfflineApps);
        }
877
      }
878
    },
879
880
  },

881
882
883
884
885
886
887
888
889
890
891
892
893
  "SearchBar": {
    onAllWindowsRestored(manager, param) {
      // This policy is meant to change the default behavior, not to force it.
      // If this policy was already applied and the user chose move the search
      // bar, don't move it again.
      runOncePerModification("searchInNavBar", param, () => {
        if (param == "separate") {
          CustomizableUI.addWidgetToArea("search-container", CustomizableUI.AREA_NAVBAR,
          CustomizableUI.getPlacementOfWidget("urlbar-container").position + 1);
        } else if (param == "unified") {
          CustomizableUI.removeWidgetFromArea("search-container");
        }
      });
894
    },
895
896
  },

897
  "SearchEngines": {
898
899
900
901
902
    onBeforeUIStartup(manager, param) {
      if (param.PreventInstalls) {
        manager.disallowFeature("installSearchEngine", true);
      }
    },
903
    onAllWindowsRestored(manager, param) {
904
      Services.search.init().then(async () => {
905
906
        if (param.Remove) {
          // Only rerun if the list of engine names has changed.
907
908
909
          await runOncePerModification("removeSearchEngines",
                                       JSON.stringify(param.Remove),
                                       async function() {
910
911
912
913
            for (let engineName of param.Remove) {
              let engine = Services.search.getEngineByName(engineName);
              if (engine) {
                try {
914
                  await Services.search.removeEngine(engine);
915
916
917
918
919
920
921
                } catch (ex) {
                  log.error("Unable to remove the search engine", ex);
                }
              }
            }
          });
        }
922
923
924
        if (param.Add) {
          // Only rerun if the list of engine names has changed.
          let engineNameList = param.Add.map(engine => engine.Name);
925
926
927
          await runOncePerModification("addSearchEngines",
                                       JSON.stringify(engineNameList),
                                       async function() {
928
929
930
            for (let newEngine of param.Add) {
              let newEngineParameters = {
                template:    newEngine.URLTemplate,
931
                iconURL:     newEngine.IconURL ? newEngine.IconURL.href : null,
932
933
934
                alias:       newEngine.Alias,
                description: newEngine.Description,
                method:      newEngine.Method,
935
                postData:    newEngine.PostData,
936
                suggestURL:  newEngine.SuggestURLTemplate,
937
                extensionID: "set-via-policy",
938
                queryCharset: "UTF-8",
939
940
              };
              try {
941
942
                await Services.search.addEngineWithDetails(newEngine.Name,
                                                           newEngineParameters);
943
944
945
946
947
948
949
              } catch (ex) {
                log.error("Unable to add search engine", ex);
              }
            }
          });
        }
        if (param.Default) {
950
          await runOncePerModification("setDefaultSearchEngine", param.Default, async () => {
951
952
953
954
            let defaultEngine;
            try {
              defaultEngine = Services.search.getEngineByName(param.Default);
              if (!defaultEngine) {
955
                throw new Error("No engine by that name could be found");
956
957
958
959
960
961
962
963
              }
            } catch (ex) {
              log.error(`Search engine lookup failed when attempting to set ` +
                        `the default engine. Requested engine was ` +
                        `"${param.Default}".`, ex);
            }
            if (defaultEngine) {
              try {
964
                await Services.search.setDefault(defaultEngine);
965
966
967
968
969
970
971
              } catch (ex) {
                log.error("Unable to set the default search engine", ex);
              }
            }
          });
        }
      });
972
    },
973
974
  },

975
976
977
978
979
980
  "SearchSuggestEnabled": {
    onBeforeAddons(manager, param) {
      setAndLockPref("browser.urlbar.suggest.searches", param);
    },
  },

981
982
983
  "SecurityDevices": {
    onProfileAfterChange(manager, param) {
      let securityDevices = param;
984
985
986
987
988
989
990
991
      let pkcs11db = Cc["@mozilla.org/security/pkcs11moduledb;1"].getService(Ci.nsIPKCS11ModuleDB);
      let moduleList = pkcs11db.listModules();
      for (let deviceName in securityDevices) {
        let foundModule = false;
        for (let module of moduleList) {
          if (module && module.libName === securityDevices[deviceName]) {
            foundModule = true;
            break;
992
993
          }
        }
994
995
996
997
998
999
1000
1001
1002
1003
        if (foundModule) {
          continue;
        }
        try {
          pkcs11db.addModule(deviceName, securityDevices[deviceName], 0, 0);
        } catch (ex) {
          log.error(`Unable to add security device ${deviceName}`);
          log.debug(ex);
        }
      }
1004
1005
1006
    },
  },

1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
  "SSLVersionMax": {
    onBeforeAddons(manager, param) {
      let tlsVersion;
      switch (param) {
        case "tls1":
          tlsVersion = 1;
          break;
        case "tls1.1":
          tlsVersion = 2;
          break;
        case "tls1.2":
          tlsVersion = 3;
          break;
        case "tls1.3":
          tlsVersion = 4;
          break;
      }
      setAndLockPref("security.tls.version.max", tlsVersion);
    },
  },

  "SSLVersionMin": {
    onBeforeAddons(manager, param) {
      let tlsVersion;
      switch (param) {
        case "tls1":
          tlsVersion = 1;
          break;
        case "tls1.1":
          tlsVersion = 2;
          break;
        case "tls1.2":
          tlsVersion = 3;
          break;
        case "tls1.3":
          tlsVersion = 4;
          break;
      }
      setAndLockPref("security.tls.version.min", tlsVersion);
    },
  },

1049
1050
1051
1052
1053
1054
  "SupportMenu": {
    onProfileAfterChange(manager, param) {
      manager.setSupportMenu(param);
    },
  },

1055
1056
1057
  "WebsiteFilter": {
    onBeforeUIStartup(manager, param) {
      this.filter = new WebsiteFilter(param.Block || [], param.Exceptions || []);
1058
    },
1059
1060
  },

1061
};
1062
1063
1064
1065
1066
1067
1068
1069
1070

/*
 * ====================
 * = HELPER FUNCTIONS =
 * ====================
 *
 * The functions below are helpers to be used by several policies.
 */

1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
/**
 * setAndLockPref
 *
 * Sets the _default_ value of a pref, and locks it (meaning that
 * the default value will always be returned, independent from what
 * is stored as the user value).
 * The value is only changed in memory, and not stored to disk.
 *
 * @param {string} prefName
 *        The pref to be changed
 * @param {boolean,number,string} prefValue
 *        The value to set and lock
 */
1084
function setAndLockPref(prefName, prefValue) {
1085
  setDefaultPref(prefName, prefValue, true);
1086
1087
1088
1089
1090
}

/**
 * setDefaultPref
 *
1091
 * Sets the _default_ value of a pref and optionally locks it.
1092
1093
1094
1095
1096
1097
 * The value is only changed in memory, and not stored to disk.
 *
 * @param {string} prefName
 *        The pref to be changed
 * @param {boolean,number,string} prefValue
 *        The value to set
1098
1099
 * @param {boolean} locked
 *        Optionally lock the pref
1100
 */
1101
1102
1103
1104
1105
function setDefaultPref(prefName, prefValue, locked = false) {
  if (Services.prefs.prefIsLocked(prefName)) {
    Services.prefs.unlockPref(prefName);
  }

1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
  let defaults = Services.prefs.getDefaultBranch("");

  switch (typeof(prefValue)) {
    case "boolean":
      defaults.setBoolPref(prefName, prefValue);
      break;

    case "number":
      if (!Number.isInteger(prefValue)) {
        throw new Error(`Non-integer value for ${prefName}`);
      }

      defaults.setIntPref(prefName, prefValue);
      break;

    case "string":
      defaults.setStringPref(prefName, prefValue);
      break;
  }
1125
1126
1127
1128

  if (locked) {
    Services.prefs.lockPref(prefName);
  }
1129
}
1130

1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
/**
 * setDefaultPermission
 *
 * Helper function to set preferences appropriately for the policy
 *
 * @param {string} policyName
 *        The name of the policy to set
 * @param {object} policyParam
 *        The object containing param for the policy
 */
function setDefaultPermission(policyName, policyParam) {
  if ("BlockNewRequests" in policyParam) {
    let prefName = "permissions.default." + policyName;

    if (policyParam.BlockNewRequests) {
1146
      setDefaultPref(prefName, 2, policyParam.Locked);
1147
    } else {
1148
      setDefaultPref(prefName, 0, policyParam.Locked);
1149
1150
1151
1152
    }
  }
}

1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
/**
 * addAllowDenyPermissions
 *
 * Helper function to call the permissions manager (Services.perms.add)
 * for two arrays of URLs.
 *
 * @param {string} permissionName
 *        The name of the permission to change
 * @param {array} allowList
 *        The list of URLs to be set as ALLOW_ACTION for the chosen permission.
 * @param {array