Bug 1776109 - Part 3: Hide caches/indexedDB/serviceWorker in PBMode r=asuth,twisniewski

Differential Revision: https://phabricator.services.mozilla.com/D150064
2022-06-30 01:35:13 +00:00 · 2022-06-30 01:35:13 +00:00 · 30b8df0dc0
--- a/dom/base/nsGlobalWindowInner.cpp
+++ b/dom/base/nsGlobalWindowInner.cpp
@ -3253,6 +3253,14 @@ bool nsGlobalWindowInner::CachesEnabled(JSContext* aCx, JSObject*) {
  if (!StaticPrefs::dom_caches_enabled()) {
    return false;
  }
+  if (StaticPrefs::dom_caches_hide_in_pbmode_enabled()) {
+    if (const nsCOMPtr<nsIGlobalObject> global =
+            xpc::CurrentNativeGlobal(aCx)) {
+      if (global->GetStorageAccess() == StorageAccess::ePrivateBrowsing) {
+        return false;
+      }
+    }
+  }
  if (!JS::GetIsSecureContext(js::GetContextRealm(aCx))) {
    return StaticPrefs::dom_caches_testing_enabled() ||
           StaticPrefs::dom_serviceWorkers_testing_enabled();
--- a/dom/base/test/chrome/chrome.ini
+++ b/dom/base/test/chrome/chrome.ini
@ -82,3 +82,6 @@ support-files = file_title.xhtml
 [test_swapFrameLoaders.xhtml]
 skip-if = os == 'mac' # bug 1674413
 [test_bug1339722.html]
+[test_hide_in_pbmode.html]
+support-files =
+  file_hide_in_pbmode.js
--- a/dom/base/test/chrome/file_hide_in_pbmode.js
+++ b/dom/base/test/chrome/file_hide_in_pbmode.js
@ -0,0 +1,68 @@
+/* global importScripts */
+
+const isWorker = typeof DedicatedWorkerGlobalScope === "function";
+
+function check(content, expected, item) {
+  const exposed = expected ? "is exposed without" : "is not exposed with";
+  const worker = isWorker ? "in worker" : "in window";
+  is(
+    content.eval(`!!globalThis.${item}`),
+    expected,
+    `${item} ${exposed} pbmode ${worker}`
+  );
+}
+
+function checkCaches(content, expected) {
+  check(content, expected, "caches");
+  check(content, expected, "Cache");
+  check(content, expected, "CacheStorage");
+}
+
+function checkIDB(content, expected) {
+  check(content, expected, "indexedDB");
+  check(content, expected, "IDBCursor");
+  check(content, expected, "IDBDatabase");
+  check(content, expected, "IDBFactory");
+  check(content, expected, "IDBIndex");
+  check(content, expected, "IDBKeyRange");
+  check(content, expected, "IDBObjectStore");
+  check(content, expected, "IDBOpenDBRequest");
+  check(content, expected, "IDBRequest");
+  check(content, expected, "IDBTransaction");
+  check(content, expected, "IDBVersionChangeEvent");
+}
+
+function checkSW(content, expected) {
+  if (isWorker) {
+    // Currently not supported. Bug 1131324
+    return;
+  }
+  check(content, expected, "navigator.serviceWorker");
+  check(content, expected, "ServiceWorker");
+  check(content, expected, "ServiceWorkerContainer");
+  check(content, expected, "ServiceWorkerRegistration");
+  check(content, expected, "NavigationPreloadManager");
+  check(content, expected, "PushManager");
+  check(content, expected, "PushSubscription");
+  check(content, expected, "PushSubscriptionOptions");
+}
+
+function checkAll(content, expected) {
+  checkCaches(content, expected);
+  checkIDB(content, expected);
+  checkSW(content, expected);
+}
+
+if (isWorker) {
+  importScripts("/tests/SimpleTest/WorkerSimpleTest.js");
+
+  globalThis.onmessage = ev => {
+    const { expected } = ev.data;
+    checkAll(globalThis, expected);
+    postMessage({
+      kind: "info",
+      next: true,
+      description: "Worker test finished",
+    });
+  };
+}
--- a/dom/base/test/chrome/test_hide_in_pbmode.html
+++ b/dom/base/test/chrome/test_hide_in_pbmode.html
@ -0,0 +1,70 @@
+<!DOCTYPE html>
+<title>Test for hiding features in Private Browsing</title>
+<script src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"></script>
+<script src="chrome://mochikit/content/tests/SimpleTest/WorkerHandler.js"></script>
+<script src="file_hide_in_pbmode.js"></script>
+<link rel="stylesheet" href="chrome://mochikit/content/tests/SimpleTest/test.css">
+<script>
+  const { BrowserTestUtils } = ChromeUtils.import("resource://testing-common/BrowserTestUtils.jsm");
+
+  const contentPage = "https://example.org/chrome/dom/workers/test/empty.html";
+
+  function openBrowserWindow(url, { private }) {
+    return new Promise(resolve => {
+      const win = window.browsingContext.topChromeWindow.OpenBrowserWindow({ private });
+      win.addEventListener("load", () => {
+        const listener = () => {
+          if (win.content.location.href != contentPage) {
+            BrowserTestUtils.loadURI(win.gBrowser, contentPage);
+            return;
+          }
+
+          win.removeEventListener("DOMContentLoaded", listener);
+          resolve(win);
+        }
+        win.addEventListener("DOMContentLoaded", listener);
+      }, { once: true });
+    });
+  }
+
+  function runWorkerTest(content, expected) {
+    return new Promise((resolve, reject) => {
+      /** @type {Worker} */
+      const worker = content.eval("new Worker('/chrome/dom/base/test/chrome/file_hide_in_pbmode.js')");
+      worker.postMessage({ expected });
+      worker.onerror = reject;
+      listenForTests(worker);
+      worker.addEventListener("message", ev => {
+        if (ev.data.next) {
+          worker.terminate();
+          resolve();
+        }
+      });
+    });
+  }
+
+  async function runTest() {
+    // sanity check
+    let win = await openBrowserWindow(contentPage, { private: false });
+    checkAll(win.content, true);
+    await runWorkerTest(win.content, true);
+    win.close();
+
+    win = await openBrowserWindow(contentPage, { private: true });
+    checkAll(win.content, false);
+    await runWorkerTest(win.content, false);
+    win.close();
+
+    SimpleTest.finish();
+  }
+
+  SimpleTest.waitForExplicitFinish();
+  SpecialPowers.pushPrefEnv({
+    set: [
+      ["dom.caches.hide_in_pbmode.enabled", true],
+      ["dom.indexedDB.hide_in_pbmode.enabled", true],
+      ["dom.serviceWorkers.hide_in_pbmode.enabled", true],
+    ]
+  }, runTest);
+
+</script>
--- a/dom/cache/test/browser/browser.ini
+++ b/dom/cache/test/browser/browser.ini
@ -1 +1,5 @@
+[DEFAULT]
+prefs =
+  dom.caches.hide_in_pbmode.enabled=false
+
 [browser_cache_pb_window.js]
--- a/dom/indexedDB/IDBFactory.cpp
+++ b/dom/indexedDB/IDBFactory.cpp
@ -359,6 +359,21 @@ bool IDBFactory::AllowedForPrincipal(nsIPrincipal* aPrincipal,
  return !aPrincipal->GetIsNullPrincipal();
 }

+bool IDBFactory::IsEnabled(JSContext* aCx, JSObject* aGlobal) {
+  if (StaticPrefs::dom_indexedDB_privateBrowsing_enabled()) {
+    return true;
+  }
+  if (StaticPrefs::dom_indexedDB_hide_in_pbmode_enabled()) {
+    if (const nsCOMPtr<nsIGlobalObject> global =
+            xpc::CurrentNativeGlobal(aCx)) {
+      if (global->GetStorageAccess() == StorageAccess::ePrivateBrowsing) {
+        return false;
+      }
+    }
+  }
+  return true;
+}
+
 void IDBFactory::UpdateActiveTransactionCount(int32_t aDelta) {
  AssertIsOnOwningThread();
  MOZ_DIAGNOSTIC_ASSERT(aDelta > 0 || (mActiveTransactionCount + aDelta) <
--- a/dom/indexedDB/IDBFactory.h
+++ b/dom/indexedDB/IDBFactory.h
@ -97,6 +97,8 @@ class IDBFactory final : public nsISupports, public nsWrapperCache {
  static bool AllowedForPrincipal(nsIPrincipal* aPrincipal,
                                  bool* aIsSystemPrincipal = nullptr);

+  static bool IsEnabled(JSContext* aCx, JSObject* aGlobal);
+
  void AssertIsOnOwningThread() const { NS_ASSERT_OWNINGTHREAD(IDBFactory); }

  nsISerialEventTarget* EventTarget() const {
--- a/dom/indexedDB/test/browser.ini
+++ b/dom/indexedDB/test/browser.ini
@ -1,6 +1,7 @@
 [DEFAULT]
 prefs =
  dom.indexedDB.storageOption.enabled=true
+  dom.indexedDB.hide_in_pbmode.enabled=false
 skip-if = (buildapp != "browser")
 support-files =
  head.js
--- a/dom/serviceworkers/ServiceWorker.cpp
+++ b/dom/serviceworkers/ServiceWorker.cpp
@ -53,11 +53,14 @@ bool ServiceWorkersEnabled(JSContext* aCx, JSObject* aGlobal) {
  // xpc::CurrentNativeGlobal below requires rooting
  JS::Rooted<JSObject*> global(aCx, aGlobal);

-  if (const nsCOMPtr<nsIGlobalObject> global = xpc::CurrentNativeGlobal(aCx)) {
+  if (StaticPrefs::dom_serviceWorkers_hide_in_pbmode_enabled()) {
+    if (const nsCOMPtr<nsIGlobalObject> global =
+            xpc::CurrentNativeGlobal(aCx)) {
      if (global->GetStorageAccess() == StorageAccess::ePrivateBrowsing) {
        return false;
      }
    }
+  }

  // Allow a webextension principal to register a service worker script with
  // a moz-extension url only if 'extensions.service_worker_register.allowed'
--- a/dom/webidl/IDBCursor.webidl
+++ b/dom/webidl/IDBCursor.webidl
@ -14,7 +14,7 @@ enum IDBCursorDirection {
    "prevunique"
 };

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBCursor {
    readonly    attribute (IDBObjectStore or IDBIndex) source;

@ -45,7 +45,7 @@ interface IDBCursor {
    IDBRequest delete ();
 };

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBCursorWithValue : IDBCursor {
    [Throws]
    readonly    attribute any value;
--- a/dom/webidl/IDBDatabase.webidl
+++ b/dom/webidl/IDBDatabase.webidl
@ -10,7 +10,7 @@
 * liability, trademark and document use rules apply.
 */

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBDatabase : EventTarget {
    readonly    attribute DOMString          name;
    readonly    attribute unsigned long long version;
--- a/dom/webidl/IDBFactory.webidl
+++ b/dom/webidl/IDBFactory.webidl
@ -23,7 +23,7 @@ dictionary IDBOpenDBOptions
 * http://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#idl-def-IDBFactory
 * for more information.
 */
-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBFactory {
  [Throws, NeedsCallerType]
  IDBOpenDBRequest
--- a/dom/webidl/IDBIndex.webidl
+++ b/dom/webidl/IDBIndex.webidl
@ -18,7 +18,7 @@ dictionary IDBIndexParameters {
    DOMString? locale = null;
 };

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBIndex {
    [SetterThrows]
    attribute DOMString name;
--- a/dom/webidl/IDBKeyRange.webidl
+++ b/dom/webidl/IDBKeyRange.webidl
@ -9,7 +9,7 @@
 * liability, trademark and document use rules apply.
 */

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBKeyRange {
  [Throws]
  readonly attribute any     lower;
--- a/dom/webidl/IDBObjectStore.webidl
+++ b/dom/webidl/IDBObjectStore.webidl
@ -12,7 +12,7 @@ dictionary IDBObjectStoreParameters {
    boolean                             autoIncrement = false;
 };

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBObjectStore {
    [SetterThrows]
    attribute DOMString name;
--- a/dom/webidl/IDBOpenDBRequest.webidl
+++ b/dom/webidl/IDBOpenDBRequest.webidl
@ -7,7 +7,7 @@
 * https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#idl-def-IDBOpenDBRequest
 */

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBOpenDBRequest : IDBRequest {
                attribute EventHandler onblocked;

--- a/dom/webidl/IDBRequest.webidl
+++ b/dom/webidl/IDBRequest.webidl
@ -13,7 +13,7 @@ enum IDBRequestReadyState {
    "done"
 };

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBRequest : EventTarget {
    [Throws]
    readonly    attribute any                  result;
--- a/dom/webidl/IDBTransaction.webidl
+++ b/dom/webidl/IDBTransaction.webidl
@ -19,7 +19,7 @@ enum IDBTransactionMode {
    "versionchange"
 };

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBTransaction : EventTarget {
    [Throws]
    readonly    attribute IDBTransactionMode mode;
--- a/dom/webidl/IDBVersionChangeEvent.webidl
+++ b/dom/webidl/IDBVersionChangeEvent.webidl
@ -15,7 +15,7 @@ dictionary IDBVersionChangeEventInit : EventInit {
    unsigned long long? newVersion = null;
 };

-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker), Func="IDBFactory::IsEnabled"]
 interface IDBVersionChangeEvent : Event {
    constructor(DOMString type,
                optional IDBVersionChangeEventInit eventInitDict = {});
--- a/dom/webidl/WindowOrWorkerGlobalScope.webidl
+++ b/dom/webidl/WindowOrWorkerGlobalScope.webidl
@ -69,8 +69,8 @@ partial interface mixin WindowOrWorkerGlobalScope {

 // http://w3c.github.io/IndexedDB/#factory-interface
 partial interface mixin WindowOrWorkerGlobalScope {
-   // readonly attribute IDBFactory indexedDB;
-   [Throws]
+  // readonly attribute IDBFactory indexedDB; // bug 1776789
+  [Throws, Func="IDBFactory::IsEnabled"]
  readonly attribute IDBFactory? indexedDB;
 };

--- a/modules/libpref/init/StaticPrefList.yaml
+++ b/modules/libpref/init/StaticPrefList.yaml
@ -2051,6 +2051,12 @@
  value: false
  mirror: always

+# Disable CacheStorage in private browsing mode.
+- name: dom.caches.hide_in_pbmode.enabled
+  type: RelaxedAtomicBool
+  value: @IS_NIGHTLY_BUILD@
+  mirror: always
+
 # Disable capture attribute for input elements; only supported on GeckoView.
 - name: dom.capture.enabled
  type: bool
@ -2534,12 +2540,18 @@
  value: false
  mirror: always

-# Enable indexedDB in private browsing mode.
+# Enable indexedDB in private browsing mode with encryption
 - name: dom.indexedDB.privateBrowsing.enabled
  type: RelaxedAtomicBool
  value: false
  mirror: always

+# Disable IndexedDB in private browsing mode.
+- name: dom.indexedDB.hide_in_pbmode.enabled
+  type: RelaxedAtomicBool
+  value: @IS_NIGHTLY_BUILD@
+  mirror: always
+
 - name: dom.input_events.beforeinput.enabled
  type: bool
  value: true
@ -3594,6 +3606,12 @@
  value: false
  mirror: always

+# Disable ServiceWorker in private browsing mode.
+- name: dom.serviceWorkers.hide_in_pbmode.enabled
+  type: RelaxedAtomicBool
+  value: true
+  mirror: always
+
 - name: dom.workers.requestAnimationFrame
  type: RelaxedAtomicBool
  value: true
--- a/toolkit/components/antitracking/test/browser/browser_blockingIndexedDb.js
+++ b/toolkit/components/antitracking/test/browser/browser_blockingIndexedDb.js
@ -26,7 +26,8 @@ AntiTracking.runTestInNormalAndPrivateMode(
        resolve()
      );
    });
-  }
+  },
+  [["dom.indexedDB.hide_in_pbmode.enabled", false]]
 );

 AntiTracking.runTestInNormalAndPrivateMode(
@ -97,7 +98,7 @@ AntiTracking.runTestInNormalAndPrivateMode(
      );
    });
  },
-  null,
+  [["dom.indexedDB.hide_in_pbmode.enabled", false]],
  false,
  false
 );
--- a/toolkit/components/antitracking/test/browser/browser_blockingIndexedDbInWorkers.js
+++ b/toolkit/components/antitracking/test/browser/browser_blockingIndexedDbInWorkers.js
@ -70,5 +70,6 @@ AntiTracking.runTestInNormalAndPrivateMode(
        resolve()
      );
    });
-  }
+  },
+  [["dom.indexedDB.hide_in_pbmode.enabled", false]]
 );
--- a/toolkit/components/antitracking/test/browser/browser_blockingIndexedDbInWorkers2.js
+++ b/toolkit/components/antitracking/test/browser/browser_blockingIndexedDbInWorkers2.js
@ -148,7 +148,7 @@ AntiTracking.runTestInNormalAndPrivateMode(
      );
    });
  },
-  null,
+  [["dom.indexedDB.hide_in_pbmode.enabled", false]],
  false,
  false
 );