Policies.jsm 35.6 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
ChromeUtils.import("resource://gre/modules/XPCOMUtils.jsm");
ChromeUtils.import("resource://gre/modules/Services.jsm");
9
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
  "AppUpdateURL": {
    onBeforeAddons(manager, param) {
      setDefaultPref("app.update.url", param.href);
72
    },
73
74
  },

75
76
77
78
79
80
81
82
83
84
85
  "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(", "));
      }
86
87
88
89
90
91
92
93
      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);
        }
      }
94
    },
95
96
  },

97
98
99
  "BlockAboutAddons": {
    onBeforeUIStartup(manager, param) {
      if (param) {
100
        blockAboutPage(manager, "about:addons", true);
101
      }
102
    },
103
104
  },

105
  "BlockAboutConfig": {
106
    onBeforeUIStartup(manager, param) {
107
      if (param) {
108
        blockAboutPage(manager, "about:config");
109
        setAndLockPref("devtools.chrome.enabled", false);
110
      }
111
    },
112
  },
113

114
115
116
  "BlockAboutProfiles": {
    onBeforeUIStartup(manager, param) {
      if (param) {
117
        blockAboutPage(manager, "about:profiles");
118
      }
119
    },
120
121
  },

122
123
124
  "BlockAboutSupport": {
    onBeforeUIStartup(manager, param) {
      if (param) {
125
        blockAboutPage(manager, "about:support");
126
      }
127
    },
128
129
  },

130
131
132
  "Bookmarks": {
    onAllWindowsRestored(manager, param) {
      BookmarksPolicies.processBookmarks(param);
133
    },
134
135
  },

136
137
138
  "Certificates": {
    onBeforeAddons(manager, param) {
      if ("ImportEnterpriseRoots" in param) {
139
        setAndLockPref("security.enterprise_roots.enabled", param.ImportEnterpriseRoots);
140
      }
141
142
143
144
145
146
      if ("Install" in param) {
        (async () => {
          let dirs = [];
          let platform = AppConstants.platform;
          if (platform == "win") {
            dirs = [
147
              // Ugly, but there is no official way to get %USERNAME\AppData\Roaming\Mozilla.
148
              Services.dirsvc.get("XREUSysExt", Ci.nsIFile).parent,
149
150
              // Even more ugly, but there is no official way to get %USERNAME\AppData\Local\Mozilla.
              Services.dirsvc.get("DefProfLRt", Ci.nsIFile).parent.parent,
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
            ];
          } 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),
            ];
          }
          for (let dir of dirs) {
            dir.append(platform == "linux" ? "certificates" : "Certificates");
            for (let certfilename of param.Install) {
              let certfile = dir.clone();
              certfile.append(certfilename);
              let file;
              try {
                file = await File.createFromNsIFile(certfile);
              } catch (e) {
                log.info(`Unable to open certificate - ${certfile.path}`);
                continue;
              }
              let reader = new FileReader();
              reader.onloadend = function() {
                if (reader.readyState != reader.DONE) {
                  log.error(`Unable to read certificate - ${certfile.path}`);
                  return;
                }
                let cert = reader.result;
                try {
                  if (/-----BEGIN CERTIFICATE-----/.test(cert)) {
                    gCertDB.addCertFromBase64(pemToBase64(cert), "CTu,CTu,");
                  } else {
                    gCertDB.addCert(cert, "CTu,CTu,");
                  }
                } catch (e) {
                  log.error(`Unable to add certificate - ${certfile.path}`);
                }
              };
              reader.readAsBinaryString(file);
            }
          }
        })();
      }
193
    },
194
195
  },

196
  "Cookies": {
197
    onBeforeUIStartup(manager, param) {
198
      addAllowDenyPermissions("cookie", param.Allow, param.Block);
199
200

      if (param.Block) {
201
        const hosts = param.Block.map(url => url.hostname).sort().join("\n");
202
203
        runOncePerModification("clearCookiesForBlockedHosts", hosts, () => {
          for (let blocked of param.Block) {
204
            Services.cookies.removeCookiesWithOriginAttributes("{}", blocked.hostname);
205
206
207
          }
        });
      }
208
209
210

      if (param.Default !== undefined ||
          param.AcceptThirdParty !== undefined ||
211
          param.RejectTracker !== undefined ||
212
213
214
215
216
          param.Locked) {
        const ACCEPT_COOKIES = 0;
        const REJECT_THIRD_PARTY_COOKIES = 1;
        const REJECT_ALL_COOKIES = 2;
        const REJECT_UNVISITED_THIRD_PARTY = 3;
217
        const REJECT_TRACKER = 4;
218
219
220
221
222

        let newCookieBehavior = ACCEPT_COOKIES;
        if (param.Default !== undefined && !param.Default) {
          newCookieBehavior = REJECT_ALL_COOKIES;
        } else if (param.AcceptThirdParty) {
223
          if (param.AcceptThirdParty == "never") {
224
225
226
227
            newCookieBehavior = REJECT_THIRD_PARTY_COOKIES;
          } else if (param.AcceptThirdParty == "from-visited") {
            newCookieBehavior = REJECT_UNVISITED_THIRD_PARTY;
          }
228
229
        } else if (param.RejectTracker !== undefined && param.RejectTracker) {
          newCookieBehavior = REJECT_TRACKER;
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
        }

        if (param.Locked) {
          setAndLockPref("network.cookie.cookieBehavior", newCookieBehavior);
        } else {
          setDefaultPref("network.cookie.cookieBehavior", newCookieBehavior);
        }
      }

      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;
        }

        if (param.Locked) {
          setAndLockPref("network.cookie.lifetimePolicy", newLifetimePolicy);
        } else {
          setDefaultPref("network.cookie.lifetimePolicy", newLifetimePolicy);
        }
      }
254
    },
255
256
  },

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
  "DNSOverHTTPS": {
    onBeforeAddons(manager, param) {
      if ("Enabled" in param) {
        let mode = param.Enabled ? 2 : 5;
        if (param.Locked) {
          setAndLockPref("network.trr.mode", mode);
        } else {
          setDefaultPref("network.trr.mode", mode);
        }
      }
      if (param.ProviderURL) {
        if (param.Locked) {
          setAndLockPref("network.trr.uri", param.ProviderURL.href);
        } else {
          setDefaultPref("network.trr.uri", param.ProviderURL.href);
        }
      }
    },
  },

277
278
279
280
  "DisableAppUpdate": {
    onBeforeAddons(manager, param) {
      if (param) {
        manager.disallowFeature("appUpdate");
281
      }
282
    },
283
284
  },

285
  "DisableBuiltinPDFViewer": {
286
    onBeforeAddons(manager, param) {
287
      if (param) {
288
        setAndLockPref("pdfjs.disabled", true);
289
      }
290
    },
291
292
  },

293
294
295
296
297
298
299
  "DisableDeveloperTools": {
    onBeforeAddons(manager, param) {
      if (param) {
        setAndLockPref("devtools.policy.disabled", true);
        setAndLockPref("devtools.chrome.enabled", false);

        manager.disallowFeature("devtools");
300
301
302
        blockAboutPage(manager, "about:devtools");
        blockAboutPage(manager, "about:debugging");
        blockAboutPage(manager, "about:devtools-toolbox");
303
      }
304
    },
305
306
  },

307
308
309
310
311
  "DisableFeedbackCommands": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("feedbackCommands");
      }
312
    },
313
314
  },

315
316
317
318
319
  "DisableFirefoxAccounts": {
    onBeforeAddons(manager, param) {
      if (param) {
        setAndLockPref("identity.fxaccounts.enabled", false);
      }
320
    },
321
322
  },

323
324
  "DisableFirefoxScreenshots": {
    onBeforeAddons(manager, param) {
325
      if (param) {
326
327
        setAndLockPref("extensions.screenshots.disabled", true);
      }
328
    },
329
330
  },

331
332
  "DisableFirefoxStudies": {
    onBeforeAddons(manager, param) {
333
      if (param) {
334
335
        manager.disallowFeature("Shield");
      }
336
    },
337
338
  },

339
340
341
  "DisableForgetButton": {
    onProfileAfterChange(manager, param) {
      if (param) {
342
        setAndLockPref("privacy.panicButton.enabled", false);
343
      }
344
    },
345
346
  },

347
348
  "DisableFormHistory": {
    onBeforeUIStartup(manager, param) {
349
      if (param) {
350
351
        setAndLockPref("browser.formfill.enable", false);
      }
352
    },
353
354
  },

355
356
357
358
359
  "DisableMasterPasswordCreation": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("createMasterPassword");
      }
360
    },
361
362
  },

363
364
365
366
367
  "DisablePocket": {
    onBeforeAddons(manager, param) {
      if (param) {
        setAndLockPref("extensions.pocket.enabled", false);
      }
368
    },
369
370
  },

371
372
373
374
  "DisablePrivateBrowsing": {
    onBeforeAddons(manager, param) {
      if (param) {
        manager.disallowFeature("privatebrowsing");
375
        blockAboutPage(manager, "about:privatebrowsing", true);
376
377
        setAndLockPref("browser.privatebrowsing.autostart", false);
      }
378
    },
379
380
  },

381
382
383
384
385
386
  "DisableProfileImport": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("profileImport");
        setAndLockPref("browser.newtabpage.activity-stream.migrationExpired", true);
      }
387
    },
388
389
  },

390
391
392
393
394
395
  "DisableProfileRefresh": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("profileRefresh");
        setAndLockPref("browser.disableResetPrompt", true);
      }
396
    },
397
398
  },

399
400
401
402
403
  "DisableSafeMode": {
    onBeforeUIStartup(manager, param) {
      if (param) {
        manager.disallowFeature("safeMode");
      }
404
    },
405
406
  },

407
408
  "DisableSecurityBypass": {
    onBeforeUIStartup(manager, param) {
409
410
411
412
      if ("InvalidCertificate" in param) {
        setAndLockPref("security.certerror.hideAddException", param.InvalidCertificate);
      }

413
414
415
      if ("SafeBrowsing" in param) {
        setAndLockPref("browser.safebrowsing.allowOverride", !param.SafeBrowsing);
      }
416
    },
417
418
  },

419
420
421
  "DisableSetDesktopBackground": {
    onBeforeUIStartup(manager, param) {
      if (param) {
422
        manager.disallowFeature("setDesktopBackground");
423
      }
424
    },
425
426
427
  },

  "DisableSystemAddonUpdate": {
428
429
430
431
    onBeforeAddons(manager, param) {
      if (param) {
        manager.disallowFeature("SysAddonUpdate");
      }
432
    },
433
434
  },

435
436
437
438
439
  "DisableTelemetry": {
    onBeforeAddons(manager, param) {
      if (param) {
        setAndLockPref("datareporting.healthreport.uploadEnabled", false);
        setAndLockPref("datareporting.policy.dataSubmissionEnabled", false);
440
        blockAboutPage(manager, "about:telemetry");
441
      }
442
    },
443
444
  },

445
  "DisplayBookmarksToolbar": {
446
    onBeforeUIStartup(manager, param) {
447
448
449
450
451
452
453
      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);
      });
454
    },
455
456
  },

457
  "DisplayMenuBar": {
458
    onBeforeUIStartup(manager, param) {
459
      let value = (!param).toString();
460
461
462
        // 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.
463
464
465
      runOncePerModification("displayMenuBar", value, () => {
        gXulStore.setValue(BROWSER_DOCUMENT_URL, "toolbar-menubar", "autohide", value);
      });
466
    },
467
468
  },

469
  "DontCheckDefaultBrowser": {
470
    onBeforeUIStartup(manager, param) {
471
      setAndLockPref("browser.shell.checkDefaultBrowser", false);
472
    },
473
474
  },

475
476
  "EnableTrackingProtection": {
    onBeforeUIStartup(manager, param) {
477
478
479
480
481
482
483
484
      if (param.Value) {
        if (param.Locked) {
          setAndLockPref("privacy.trackingprotection.enabled", true);
          setAndLockPref("privacy.trackingprotection.pbmode.enabled", true);
        } else {
          setDefaultPref("privacy.trackingprotection.enabled", true);
          setDefaultPref("privacy.trackingprotection.pbmode.enabled", true);
        }
485
      } else {
486
487
        setAndLockPref("privacy.trackingprotection.enabled", false);
        setAndLockPref("privacy.trackingprotection.pbmode.enabled", false);
488
      }
489
    },
490
491
  },

492
493
494
  "Extensions": {
    onBeforeUIStartup(manager, param) {
      if ("Install" in param) {
495
        runOncePerModification("extensionsInstall", JSON.stringify(param.Install), () => {
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
          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;
            }
512
513
            AddonManager.getInstallForURL(url, "application/x-xpinstall", null, null, null, null, null,
                                          {source: "enterprise-policy"}).then(install => {
514
515
516
517
518
              if (install.addon && install.addon.appDisabled) {
                log.error(`Incompatible add-on - ${location}`);
                install.cancel();
                return;
              }
519
              let listener = {
520
521
522
523
524
525
526
527
              /* 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();
                  }
                },
528
                onDownloadFailed: () => {
529
                  install.removeListener(listener);
530
531
532
                  log.error(`Download failed - ${location}`);
                },
                onInstallFailed: () => {
533
                  install.removeListener(listener);
534
535
536
                  log.error(`Installation failed - ${location}`);
                },
                onInstallEnded: () => {
537
                  install.removeListener(listener);
538
                  log.debug(`Installation succeeded - ${location}`);
539
                },
540
541
542
              };
              install.addListener(listener);
              install.install();
543
            });
544
545
546
          }
        });
      }
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
      if ("Uninstall" in param) {
        runOncePerModification("extensionsUninstall", JSON.stringify(param.Uninstall), async () => {
          let addons = await AddonManager.getAddonsByIDs(param.Uninstall);
          for (let addon of addons) {
            if (addon) {
              try {
                addon.uninstall();
              } catch (e) {
                // This can fail for add-ons that can't be uninstalled.
                // Just ignore.
              }
            }
          }
        });
      }
562
563
564
565
566
      if ("Locked" in param) {
        for (let ID of param.Locked) {
          manager.disallowFeature(`modify-extension:${ID}`);
        }
      }
567
    },
568
569
  },

570
  "FlashPlugin": {
571
    onBeforeUIStartup(manager, param) {
572
      addAllowDenyPermissions("plugin:flash", param.Allow, param.Block);
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590

      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);
      }
591
    },
592
593
  },

594
595
596
597
598
  "HardwareAcceleration": {
    onBeforeAddons(manager, param) {
      if (!param) {
        setAndLockPref("layers.acceleration.disabled", true);
      }
599
    },
600
601
  },

602
603
604
605
606
  "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.
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
      if (param.URL) {
        let homepages = param.URL.href;
        if (param.Additional && param.Additional.length > 0) {
          homepages += "|" + param.Additional.map(url => url.href).join("|");
        }
        if (param.Locked) {
          setAndLockPref("browser.startup.homepage", homepages);
          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 {
          setDefaultPref("browser.startup.homepage", homepages);
          runOncePerModification("setHomepage", homepages, () => {
            Services.prefs.clearUserPref("browser.startup.homepage");
          });
        }
623
      }
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
      if (param.StartPage) {
        let prefValue;
        switch (param.StartPage) {
          case "none":
            prefValue = 0;
            break;
          case "homepage":
            prefValue = 1;
            break;
          case "previous-session":
            prefValue = 3;
            break;
        }
        if (param.Locked) {
          setAndLockPref("browser.startup.page", prefValue);
        } else {
          setDefaultPref("browser.startup.page", prefValue);
        }
642
      }
643
    },
644
645
  },

646
  "InstallAddonsPermission": {
647
    onBeforeUIStartup(manager, param) {
648
649
650
651
652
      if ("Allow" in param) {
        addAllowDenyPermissions("install", param.Allow, null);
      }
      if ("Default" in param) {
        setAndLockPref("xpinstall.enabled", param.Default);
653
        if (!param.Default) {
654
          blockAboutPage(manager, "about:debugging");
655
        }
656
      }
657
    },
658
659
  },

660
661
662
663
664
  "NoDefaultBookmarks": {
    onProfileAfterChange(manager, param) {
      if (param) {
        manager.disallowFeature("defaultBookmarks");
      }
665
    },
666
667
  },

668
669
670
  "OfferToSaveLogins": {
    onBeforeUIStartup(manager, param) {
      setAndLockPref("signon.rememberSignons", param);
671
    },
672
673
  },

674
675
  "OverrideFirstRunPage": {
    onProfileAfterChange(manager, param) {
676
      let url = param ? param.href : "";
677
      setAndLockPref("startup.homepage_welcome_url", url);
678
    },
679
680
  },

681
682
  "OverridePostUpdatePage": {
    onProfileAfterChange(manager, param) {
683
      let url = param ? param.href : "";
684
685
686
687
688
      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");
689
    },
690
691
  },

692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
  "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);
      }
713
    },
714
715
  },

716
  "PopupBlocking": {
717
    onBeforeUIStartup(manager, param) {
718
      addAllowDenyPermissions("popup", param.Allow, null);
719
720
721
722
723
724
725
726
727
728

      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);
      }
729
    },
730
731
  },

732
733
734
735
736
737
738
739
  "Proxy": {
    onBeforeAddons(manager, param) {
      if (param.Locked) {
        manager.disallowFeature("changeProxySettings");
        ProxyPolicies.configureProxySettings(param, setAndLockPref);
      } else {
        ProxyPolicies.configureProxySettings(param, setDefaultPref);
      }
740
    },
741
  },
742

743
744
745
746
747
748
  "RequestedLocales": {
    onBeforeAddons(manager, param) {
      Services.locale.requestedLocales = param;
    },
  },

749
750
751
752
753
754
755
756
757
758
759
760
761
  "SanitizeOnShutdown": {
    onBeforeUIStartup(manager, param) {
      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);
      }
762
    },
763
764
  },

765
766
767
768
769
770
771
772
773
774
775
776
777
  "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");
        }
      });
778
    },
779
780
  },

781
  "SearchEngines": {
782
783
784
785
786
    onBeforeUIStartup(manager, param) {
      if (param.PreventInstalls) {
        manager.disallowFeature("installSearchEngine", true);
      }
    },
787
788
    onAllWindowsRestored(manager, param) {
      Services.search.init(() => {
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
        if (param.Remove) {
          // Only rerun if the list of engine names has changed.
          runOncePerModification("removeSearchEngines",
                                 JSON.stringify(param.Remove),
                                 () => {
            for (let engineName of param.Remove) {
              let engine = Services.search.getEngineByName(engineName);
              if (engine) {
                try {
                  Services.search.removeEngine(engine);
                } catch (ex) {
                  log.error("Unable to remove the search engine", ex);
                }
              }
            }
          });
        }
806
807
808
809
810
811
812
813
814
        if (param.Add) {
          // Only rerun if the list of engine names has changed.
          let engineNameList = param.Add.map(engine => engine.Name);
          runOncePerModification("addSearchEngines",
                                 JSON.stringify(engineNameList),
                                 () => {
            for (let newEngine of param.Add) {
              let newEngineParameters = {
                template:    newEngine.URLTemplate,
815
                iconURL:     newEngine.IconURL ? newEngine.IconURL.href : null,
816
817
818
819
                alias:       newEngine.Alias,
                description: newEngine.Description,
                method:      newEngine.Method,
                suggestURL:  newEngine.SuggestURLTemplate,
820
                extensionID: "set-via-policy",
821
                queryCharset: "UTF-8",
822
823
824
825
826
827
828
829
830
831
832
              };
              try {
                Services.search.addEngineWithDetails(newEngine.Name,
                                                     newEngineParameters);
              } catch (ex) {
                log.error("Unable to add search engine", ex);
              }
            }
          });
        }
        if (param.Default) {
833
          runOncePerModification("setDefaultSearchEngine", param.Default, () => {
834
835
836
837
838
839
840
841
842
843
844
845
846
            let defaultEngine;
            try {
              defaultEngine = Services.search.getEngineByName(param.Default);
              if (!defaultEngine) {
                throw "No engine by that name could be found";
              }
            } catch (ex) {
              log.error(`Search engine lookup failed when attempting to set ` +
                        `the default engine. Requested engine was ` +
                        `"${param.Default}".`, ex);
            }
            if (defaultEngine) {
              try {
847
                Services.search.defaultEngine = defaultEngine;
848
849
850
851
852
853
854
              } catch (ex) {
                log.error("Unable to set the default search engine", ex);
              }
            }
          });
        }
      });
855
    },
856
857
  },

858
859
860
  "SecurityDevices": {
    onProfileAfterChange(manager, param) {
      let securityDevices = param;
861
862
863
864
865
866
867
868
      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;
869
870
          }
        }
871
872
873
874
875
876
877
878
879
880
        if (foundModule) {
          continue;
        }
        try {
          pkcs11db.addModule(deviceName, securityDevices[deviceName], 0, 0);
        } catch (ex) {
          log.error(`Unable to add security device ${deviceName}`);
          log.debug(ex);
        }
      }
881
882
883
    },
  },

884
885
886
  "WebsiteFilter": {
    onBeforeUIStartup(manager, param) {
      this.filter = new WebsiteFilter(param.Block || [], param.Exceptions || []);
887
    },
888
889
  },

890
};
891
892
893
894
895
896
897
898
899

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

900
901
902
903
904
905
906
907
908
909
910
911
912
/**
 * 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
 */
913
914
915
916
917
function setAndLockPref(prefName, prefValue) {
  if (Services.prefs.prefIsLocked(prefName)) {
    Services.prefs.unlockPref(prefName);
  }

918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
  setDefaultPref(prefName, prefValue);

  Services.prefs.lockPref(prefName);
}

/**
 * setDefaultPref
 *
 * Sets the _default_ value of a pref.
 * 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
 */
function setDefaultPref(prefName, prefValue) {
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
  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;
  }
}
955

956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
/**
 * 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) {
      if (policyParam.Locked) {
        setAndLockPref(prefName, 2);
      } else {
        setDefaultPref(prefName, 2);
      }
    } else if (policyParam.Locked) {
      setAndLockPref(prefName, 0);
    } else {
      setDefaultPref(prefName, 0);
    }
  }
}

984
985
986
987
988
989
990
991
992
993
994
995
996
/**
 * 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} blockList
 *        The list of URLs to be set as DENY_ACTION for the chosen permission.
 */
997
998
999
1000
function addAllowDenyPermissions(permissionName, allowList, blockList) {
  allowList = allowList || [];
  blockList = blockList || [];