From 924f9c99de6f3223a46e472339c59726e60e5c79 Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 17:20:39 +0200 Subject: [PATCH 01/13] Point to local omni.ja files, not remote server This patch series tries to remove any network communication with Remote Settings [1], which can be used by Mozilla to silently push data to client browsers. This data can include references to nonfree software, for example, to search engines or other websites that contain nonfree JavaScript code. Without this patching, it would be hard to make sure the browser does not violate paragraph 4 of [2]: "Programs in the system should not suggest installing nonfree plugins, documentation, and so on." Changes in the current patch: First of all, replace every occurrence of Remote Settings server domain name with URIs that point to built-in local files within omni.ja. Some links to json files may point to non-existing files, but that's OK because it's better than leave them point to Remote Settings server. If necessary, missing files can be added later. [1] https://remote-settings.readthedocs.io/en/latest/introduction.html [2] https://www.gnu.org/distros/free-system-distribution-guidelines.en.html#license-rules --- .../components/ASRouterAdmin/ASRouterAdmin.jsx | 2 +- .../components/asrouter/content/asrouter-admin.bundle.js | 2 +- browser/components/newtab/bin/import-rollouts.js | 4 ++-- services/settings/Utils.sys.mjs | 2 +- services/settings/docs/index.rst | 4 ++-- .../periodic-updates/scripts/periodic_file_updates.sh | 2 +- third_party/rust/remote_settings/.cargo-checksum.json | 2 +- third_party/rust/remote_settings/src/client.rs | 4 ++-- .../components/antitracking/docs/query-stripping/index.md | 2 +- .../backgroundtasks/BackgroundTask_message.sys.mjs | 4 ++-- toolkit/components/search/SearchUtils.sys.mjs | 8 ++++---- toolkit/components/search/docs/DefaultSearchEngines.rst | 2 +- .../components/search/docs/SearchEngineConfiguration.rst | 2 +- toolkit/modules/AppConstants.sys.mjs | 4 ++-- 14 files changed, 22 insertions(+), 22 deletions(-) diff --git a/browser/components/asrouter/content-src/components/ASRouterAdmin/ASRouterAdmin.jsx b/browser/components/asrouter/content-src/components/ASRouterAdmin/ASRouterAdmin.jsx index 7d4484dc83..9346d518e6 100644 --- a/browser/components/asrouter/content-src/components/ASRouterAdmin/ASRouterAdmin.jsx +++ b/browser/components/asrouter/content-src/components/ASRouterAdmin/ASRouterAdmin.jsx @@ -874,7 +874,7 @@ export class ASRouterAdminInner extends React.PureComponent { nimbus-desktop-experiments diff --git a/browser/components/asrouter/content/asrouter-admin.bundle.js b/browser/components/asrouter/content/asrouter-admin.bundle.js index 614e8a62a1..3ce250c6ed 100644 --- a/browser/components/asrouter/content/asrouter-admin.bundle.js +++ b/browser/components/asrouter/content/asrouter-admin.bundle.js @@ -1641,7 +1641,7 @@ class ASRouterAdminInner extends (react__WEBPACK_IMPORTED_MODULE_1___default().P label = /*#__PURE__*/react__WEBPACK_IMPORTED_MODULE_1___default().createElement("span", null, "remote settings (", /*#__PURE__*/react__WEBPACK_IMPORTED_MODULE_1___default().createElement("a", { className: "providerUrl", target: "_blank", - href: "https://firefox.settings.services.mozilla.com/v1/buckets/main/collections/nimbus-desktop-experiments/records", + href: "resource://app/defaults/settings/main/nimbus-desktop-experiments.json", rel: "noopener noreferrer" }, "nimbus-desktop-experiments"), ")"); } diff --git a/browser/components/newtab/bin/import-rollouts.js b/browser/components/newtab/bin/import-rollouts.js index ce22d4a114..b2dc35e9d9 100644 --- a/browser/components/newtab/bin/import-rollouts.js +++ b/browser/components/newtab/bin/import-rollouts.js @@ -36,7 +36,7 @@ const jsonschema = require("../../../../third_party/js/cfworker/json-schema.js") const DEFAULT_COLLECTION_ID = "nimbus-desktop-experiments"; const BASE_URL = - "https://firefox.settings.services.mozilla.com/v1/buckets/main/collections/"; + "resource://app/defaults/settings/main/"; const EXPERIMENTER_URL = "https://experimenter.services.mozilla.com/nimbus/"; const OUTPUT_PATH = "./test/NimbusRolloutMessageProvider.sys.mjs"; const LICENSE_STRING = `/* This Source Code Form is subject to the terms of the Mozilla Public @@ -237,7 +237,7 @@ async function main() { } ); - const RECORDS_URL = `${BASE_URL}${cli.flags.collection}/records`; + const RECORDS_URL = `${BASE_URL}${cli.flags.collection}.json`; console.log(`Fetching records from ${chalk.underline.yellow(RECORDS_URL)}`); diff --git a/services/settings/Utils.sys.mjs b/services/settings/Utils.sys.mjs index 73c83e526b..653cabe7e1 100644 --- a/services/settings/Utils.sys.mjs +++ b/services/settings/Utils.sys.mjs @@ -100,7 +100,7 @@ export var Utils = { : AppConstants.REMOTE_SETTINGS_SERVER_URL; }, - CHANGES_PATH: "/buckets/monitor/collections/changes/changeset", + CHANGES_PATH: "/monitor/changes", /** * Logger instance. diff --git a/services/settings/docs/index.rst b/services/settings/docs/index.rst index 3e042f67e4..dc8584c318 100644 --- a/services/settings/docs/index.rst +++ b/services/settings/docs/index.rst @@ -177,11 +177,11 @@ It is possible to package a dump of the server records that will be loaded into The JSON dump will serve as the default dataset for ``.get()``, instead of doing a round-trip to pull the latest data. It will also reduce the amount of data to be downloaded on the first synchronization. -#. Place the JSON dump of the server records in the ``services/settings/dumps/main/`` folder. Using this command: +#. Place the JSON dump of the server records in the ``services/settings/dumps/main/`` folder. Using this command (replace 'https://settings.invalid' with your Remote Settings address): :: CID="your-collection" - curl "https://firefox.settings.services.mozilla.com/v1/buckets/main/collections/${CID}/changeset?_expected=0" | jq '{"data": .changes, "timestamp": .timestamp}' > services/settings/dumps/main/${CID}.json`` + curl "https://settings.invalid/v1/buckets/main/collections/${CID}/changeset?_expected=0" | jq '{"data": .changes, "timestamp": .timestamp}' > services/settings/dumps/main/${CID}.json`` #. Add the filename to the ``FINAL_TARGET_FILES`` list in ``services/settings/dumps/main/moz.build`` #. Add the filename to the ``[browser]`` section of ``mobile/android/installer/package-manifest.in`` IF the file should be bundled with Android. diff --git a/taskcluster/docker/periodic-updates/scripts/periodic_file_updates.sh b/taskcluster/docker/periodic-updates/scripts/periodic_file_updates.sh index 160b7fbc35..2e9dcde464 100755 --- a/taskcluster/docker/periodic-updates/scripts/periodic_file_updates.sh +++ b/taskcluster/docker/periodic-updates/scripts/periodic_file_updates.sh @@ -286,7 +286,7 @@ function compare_suffix_lists { } function compare_remote_settings_files { - REMOTE_SETTINGS_SERVER="https://firefox.settings.services.mozilla.com/v1" + REMOTE_SETTINGS_SERVER="resource://app/defaults/settings" # 1. List remote settings collections from server. echo "INFO: fetch remote settings list from server" diff --git a/third_party/rust/remote_settings/.cargo-checksum.json b/third_party/rust/remote_settings/.cargo-checksum.json index 28ac46a2c2..e8a54e1bac 100644 --- a/third_party/rust/remote_settings/.cargo-checksum.json +++ b/third_party/rust/remote_settings/.cargo-checksum.json @@ -1 +1 @@ -{"files":{"Cargo.toml":"cf0a08d6b0d6285a459b78115aa24818a04b5987652655e64b80ffd8c8ae0813","build.rs":"4326f03729cf8f1673e4228e6dc111de1ea4d8bcc06351f7ae563efb2613f866","src/client.rs":"3d87162e6913a81cc6f5178a7ca791e262d0d029e7dedf3df4fe2f66e5501185","src/config.rs":"7bb678addfae3b4ed5f2892d32263e5b33cc05e5a12a250f664150e78211f94a","src/error.rs":"192ca42af7c6b882f3129378c23b45dab8a0d2b179e23a8813a335ffd56b21dc","src/lib.rs":"416e99894e152f6cea7418ad2fabfd94bc3d907efd9f33fbd2a83fb99452b2df","src/remote_settings.udl":"e38758592ca75adbebb8fe688b10520d9931a5f3292d94f229cba05310756a43","uniffi.toml":"f8ec8dc593e0d501c2e9e40368ec93ec33b1edd8608e29495e0a54b63144e880"},"package":null} \ No newline at end of file +{"files":{"Cargo.toml":"cf0a08d6b0d6285a459b78115aa24818a04b5987652655e64b80ffd8c8ae0813","build.rs":"4326f03729cf8f1673e4228e6dc111de1ea4d8bcc06351f7ae563efb2613f866","src/client.rs":"ff1ab5961fe695989d1ff343c5042ce0f907dc323da2ba87005fc9437919b448","src/config.rs":"7bb678addfae3b4ed5f2892d32263e5b33cc05e5a12a250f664150e78211f94a","src/error.rs":"192ca42af7c6b882f3129378c23b45dab8a0d2b179e23a8813a335ffd56b21dc","src/lib.rs":"416e99894e152f6cea7418ad2fabfd94bc3d907efd9f33fbd2a83fb99452b2df","src/remote_settings.udl":"e38758592ca75adbebb8fe688b10520d9931a5f3292d94f229cba05310756a43","uniffi.toml":"f8ec8dc593e0d501c2e9e40368ec93ec33b1edd8608e29495e0a54b63144e880"},"package":null} diff --git a/third_party/rust/remote_settings/src/client.rs b/third_party/rust/remote_settings/src/client.rs index 9585a7cc7c..1c97208b82 100644 --- a/third_party/rust/remote_settings/src/client.rs +++ b/third_party/rust/remote_settings/src/client.rs @@ -33,7 +33,7 @@ impl Client { pub fn new(config: RemoteSettingsConfig) -> Result { let server_url = config .server_url - .unwrap_or_else(|| String::from("https://firefox.settings.services.mozilla.com")); + .unwrap_or_else(|| String::from("resource://app/defaults/settings")); let bucket_name = config.bucket_name.unwrap_or_else(|| String::from("main")); let base_url = Url::parse(&server_url)?; @@ -518,7 +518,7 @@ mod test { }; let client = Client::new(config).unwrap(); assert_eq!( - Url::parse("https://firefox.settings.services.mozilla.com").unwrap(), + Url::parse("resource://app/defaults/settings").unwrap(), client.base_url ); assert_eq!(String::from("main"), client.bucket_name); diff --git a/toolkit/components/antitracking/docs/query-stripping/index.md b/toolkit/components/antitracking/docs/query-stripping/index.md index e49d8513ba..c1c6ae5deb 100644 --- a/toolkit/components/antitracking/docs/query-stripping/index.md +++ b/toolkit/components/antitracking/docs/query-stripping/index.md @@ -63,7 +63,7 @@ of query params: It is enabled in Nightly by default in all modes with an extended strip-list. You can find the current list of parameters that are stripped -[here](https://firefox.settings.services.mozilla.com/v1/buckets/main/collections/query-stripping/records). +[here](resource://app/defaults/settings/main/collections/query-stripping/records). Note that some records have a *filter\_expression* that limits where they apply. diff --git a/toolkit/components/backgroundtasks/BackgroundTask_message.sys.mjs b/toolkit/components/backgroundtasks/BackgroundTask_message.sys.mjs index bb9d71b5c0..ec0c5f11d7 100644 --- a/toolkit/components/backgroundtasks/BackgroundTask_message.sys.mjs +++ b/toolkit/components/backgroundtasks/BackgroundTask_message.sys.mjs @@ -19,8 +19,8 @@ // environment variables still apply. // // --stage: use stage Remote Settings -// (`https://firefox.settings.services.allizom.org/v1`) rather than production -// (`https://firefox.settings.services.mozilla.com/v1`) +// (`resource://app/defaults/settings/`) rather than production +// (`resource://app/defaults/settings/`) // // --preview: enable Remote Settings and Experiment previews. // diff --git a/toolkit/components/search/SearchUtils.sys.mjs b/toolkit/components/search/SearchUtils.sys.mjs index 8e474b58a2..a8cd3cccac 100644 --- a/toolkit/components/search/SearchUtils.sys.mjs +++ b/toolkit/components/search/SearchUtils.sys.mjs @@ -193,13 +193,13 @@ export var SearchUtils = { ENGINES_URLS: { "prod-main": - "https://firefox.settings.services.mozilla.com/v1/buckets/main/collections/search-config/records", + "resource://app/defaults/settings/main/search-config.json", "prod-preview": - "https://firefox.settings.services.mozilla.com/v1/buckets/main-preview/collections/search-config/records", + "resource://app/defaults/settings/main/search-config.json", "stage-main": - "https://firefox.settings.services.allizom.org/v1/buckets/main/collections/search-config/records", + "resource://app/defaults/settings/main/search-config.json", "stage-preview": - "https://firefox.settings.services.allizom.org/v1/buckets/main-preview/collections/search-config/records", + "resource://app/defaults/settings/main/search-config.json", }, // The following constants are left undocumented in nsISearchService.idl diff --git a/toolkit/components/search/docs/DefaultSearchEngines.rst b/toolkit/components/search/docs/DefaultSearchEngines.rst index 3dfe68abb1..26d5f18a7b 100644 --- a/toolkit/components/search/docs/DefaultSearchEngines.rst +++ b/toolkit/components/search/docs/DefaultSearchEngines.rst @@ -99,4 +99,4 @@ is updated. .. _configuration schema: SearchConfigurationSchema.html .. _remote settings: /services/settings/index.html -.. _search-default-override-allowlist bucket: https://firefox.settings.services.mozilla.com/v1/buckets/main/collections/search-default-override-allowlist/records +.. _search-default-override-allowlist bucket: resource://app/defaults/settings/main/search-default-override-allowlist.json diff --git a/toolkit/components/search/docs/SearchEngineConfiguration.rst b/toolkit/components/search/docs/SearchEngineConfiguration.rst index c782f9f7c3..4d773d27c5 100644 --- a/toolkit/components/search/docs/SearchEngineConfiguration.rst +++ b/toolkit/components/search/docs/SearchEngineConfiguration.rst @@ -68,5 +68,5 @@ related. As a result several situations may occur: .. _JSON schema: https://json-schema.org/ .. _stored in mozilla-central: https://searchfox.org/mozilla-central/source/toolkit/components/search/schema/ .. _Search Configuration Schema: SearchConfigurationSchema.html -.. _viewed live: https://firefox.settings.services.mozilla.com/v1/buckets/main/collections/search-config/records +.. _viewed live: resource://app/defaults/settings/main/search-config.json .. _Normandy: /toolkit/components/normandy/normandy/services.html diff --git a/toolkit/modules/AppConstants.sys.mjs b/toolkit/modules/AppConstants.sys.mjs index 36b26056ec..ba54202045 100644 --- a/toolkit/modules/AppConstants.sys.mjs +++ b/toolkit/modules/AppConstants.sys.mjs @@ -416,9 +416,9 @@ export var AppConstants = Object.freeze({ REMOTE_SETTINGS_SERVER_URL: #ifdef MOZ_THUNDERBIRD - "https://thunderbird-settings.thunderbird.net/v1", + "resource://app/defaults/settings", #else - "https://firefox.settings.services.mozilla.com/v1", + "resource://app/defaults/settings", #endif REMOTE_SETTINGS_VERIFY_SIGNATURE: -- 2.43.0 From 3536b16aa46bda48ac8692ca72e978837fcef796 Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 17:34:08 +0200 Subject: [PATCH 02/13] Remove polling triggered by push broadcasts When initialized, remote-settings.sys.mjs adds a listener to push broadcasts, that let Remote Settings server send push messages to trigger polling for changes from the client side. This is not needed for local-only setup. Remove the record from broadcast-listeners.json file stored in the user profile, so that it doesn't get picked up by push broadcast service. --- dom/push/PushBroadcastService.sys.mjs | 13 +++++++++++++ services/settings/remote-settings.sys.mjs | 11 ++--------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/dom/push/PushBroadcastService.sys.mjs b/dom/push/PushBroadcastService.sys.mjs index eea31ef192..529ecd6917 100644 --- a/dom/push/PushBroadcastService.sys.mjs +++ b/dom/push/PushBroadcastService.sys.mjs @@ -168,6 +168,19 @@ export var BroadcastService = class { } } + async deleteListener(broadcastId) { + await this.initializePromise; + + if (this.jsonFile.data.listeners.hasOwnProperty(broadcastId)) { + console.info( + "deleteListener: deleting listener", + broadcastId + ); + delete this.jsonFile.data.listeners[broadcastId]; + this.jsonFile.saveSoon(); + } + } + /** * Call the listeners of the specified broadcasts. * diff --git a/services/settings/remote-settings.sys.mjs b/services/settings/remote-settings.sys.mjs index b93da0f0e4..8d59bc6b05 100644 --- a/services/settings/remote-settings.sys.mjs +++ b/services/settings/remote-settings.sys.mjs @@ -575,11 +575,7 @@ function remoteSettingsFunction() { moduleURI: import.meta.url, symbolName: "remoteSettingsBroadcastHandler", }; - lazy.pushBroadcastService.addListener( - BROADCAST_ID, - currentVersion, - moduleInfo - ); + lazy.pushBroadcastService.deleteListener(BROADCAST_ID); }; return remoteSettings; @@ -599,9 +595,6 @@ export var remoteSettingsBroadcastHandler = { `Push notification received (version=${version} phase=${phase})` ); - return RemoteSettings.pollChanges({ - expectedTimestamp: version, - trigger: isStartup ? "startup" : "broadcast", - }); + return; }, }; -- 2.43.0 From 528c5d6d9437c003b731b3531273dbeb10422a0c Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 17:41:54 +0200 Subject: [PATCH 03/13] Remove timer that triggers polling for changes That is not needed for local-only setup. --- services/settings/components.conf | 9 +-------- services/settings/servicesSettings.manifest | 4 ---- 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/services/settings/components.conf b/services/settings/components.conf index fbc4df9bfc..25109415a7 100644 --- a/services/settings/components.conf +++ b/services/settings/components.conf @@ -4,11 +4,4 @@ # 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/. -Classes = [ - { - 'cid': '{5e756573-234a-49ea-bbe4-59ec7a70657d}', - 'contract_ids': ['@mozilla.org/services/settings;1'], - 'esModule': 'resource://services-settings/RemoteSettingsComponents.sys.mjs', - 'constructor': 'RemoteSettingsTimer', - }, -] +Classes = [] diff --git a/services/settings/servicesSettings.manifest b/services/settings/servicesSettings.manifest index 3bfed26ea4..807eb220ec 100644 --- a/services/settings/servicesSettings.manifest +++ b/services/settings/servicesSettings.manifest @@ -1,7 +1,3 @@ # Register resource aliases resource services-settings resource://gre/modules/services-settings/ -# Schedule polling of remote settings changes -# (default 24H, max 72H) -# see syntax https://searchfox.org/mozilla-central/rev/cc280c4be94ff8cf64a27cc9b3d6831ffa49fa45/toolkit/components/timermanager/UpdateTimerManager.jsm#155 -category update-timer RemoteSettingsComponents @mozilla.org/services/settings;1,getService,services-settings-poll-changes,services.settings.poll_interval,86400,259200 -- 2.43.0 From d13036fd21af770da7d305d058ecedd560afba2f Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 17:47:41 +0200 Subject: [PATCH 04/13] Utils: fetch timestamps of each collection locally Utils.CHANGES_PATH points to services/settings/dumps/monitor/changes which will be generated later by JSON processing script. Fetch the timestamps from that file and mock response headers to not confuse any code that expects them. --- browser/installer/package-manifest.in | 1 + services/settings/Utils.sys.mjs | 28 ++++++++++++++++++++--- services/settings/dumps/monitor/moz.build | 8 +++++++ services/settings/dumps/moz.build | 1 + 4 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 services/settings/dumps/monitor/moz.build diff --git a/browser/installer/package-manifest.in b/browser/installer/package-manifest.in index b3213b8c44..0f953c3425 100644 --- a/browser/installer/package-manifest.in +++ b/browser/installer/package-manifest.in @@ -258,6 +258,7 @@ @RESPATH@/browser/defaults/settings/last_modified.json @RESPATH@/browser/defaults/settings/blocklists @RESPATH@/browser/defaults/settings/main +@RESPATH@/browser/defaults/settings/monitor @RESPATH@/browser/defaults/settings/security-state ; Warning: changing the path to channel-prefs.js can cause bugs (Bug 756325) diff --git a/services/settings/Utils.sys.mjs b/services/settings/Utils.sys.mjs index 653cabe7e1..e4d4247253 100644 --- a/services/settings/Utils.sys.mjs +++ b/services/settings/Utils.sys.mjs @@ -376,7 +376,7 @@ export var Utils = { async fetchLatestChanges(serverUrl, options = {}) { const { expectedTimestamp, lastEtag = "", filters = {} } = options; - let url = serverUrl + Utils.CHANGES_PATH; + let url = Utils.SERVER_URL + Utils.CHANGES_PATH; const params = { ...filters, _expected: expectedTimestamp ?? 0, @@ -391,7 +391,21 @@ export var Utils = { .map(([k, v]) => `${k}=${encodeURIComponent(v)}`) .join("&"); } - const response = await Utils.fetch(url); + const rawResponse = await fetch(url); + const responseDate = new Date().toUTCString(); + + const headers = new Headers(); + headers.set("Date", responseDate); + headers.set("Last-Modified", responseDate); + headers.set("Content-Type", "application/json"); + + const responseAttributes = { + status: rawResponse.status, + statusText: rawResponse.statusText, + headers, + }; + + const response = new Response(rawResponse.body, responseAttributes); if (response.status >= 500) { throw new Error(`Server error ${response.status} ${response.statusText}`); @@ -426,7 +440,15 @@ export var Utils = { } } - const { changes = [], timestamp } = payload; + const { timestamp } = payload; + const { bucket, collection } = filters; + if (!bucket || !collection) { + throw new Error('Unable to fetch latest change without bucket or collection'); + } + const change = payload.changes.find( + change => change.bucket === bucket && change.collection === collection + ) ?? { last_modified: 0, bucket, collection }; + const changes = [change]; let serverTimeMillis = Date.parse(response.headers.get("Date")); // Since the response is served via a CDN, the Date header value could have been cached. diff --git a/services/settings/dumps/monitor/moz.build b/services/settings/dumps/monitor/moz.build new file mode 100644 index 0000000000..25c53a2eeb --- /dev/null +++ b/services/settings/dumps/monitor/moz.build @@ -0,0 +1,8 @@ +# 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/. + +FINAL_TARGET_FILES.defaults.settings.monitor += ["changes"] + +if CONFIG["MOZ_BUILD_APP"] == "browser": + DIST_SUBDIR = "browser" diff --git a/services/settings/dumps/moz.build b/services/settings/dumps/moz.build index f407580bfa..53e9d8b45e 100644 --- a/services/settings/dumps/moz.build +++ b/services/settings/dumps/moz.build @@ -5,6 +5,7 @@ DIRS += [ "blocklists", "main", + "monitor", "security-state", ] -- 2.43.0 From b2a061b8b79988eeef189af214fa03e4d7c76153 Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 17:52:10 +0200 Subject: [PATCH 05/13] Utils: disable offline checking Since only local data is read now, it should always return false for the current and any future code that relies on it. --- services/settings/Utils.sys.mjs | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/services/settings/Utils.sys.mjs b/services/settings/Utils.sys.mjs index e4d4247253..296001536c 100644 --- a/services/settings/Utils.sys.mjs +++ b/services/settings/Utils.sys.mjs @@ -190,16 +190,6 @@ export var Utils = { * @return {bool} Whether network is down or not. */ get isOffline() { - try { - return ( - Services.io.offline || - lazy.CaptivePortalService.state == - lazy.CaptivePortalService.LOCKED_PORTAL || - !lazy.gNetworkLinkService.isLinkUp - ); - } catch (ex) { - log.warn("Could not determine network status.", ex); - } return false; }, -- 2.43.0 From 96d145c3ca83e835c4ec6711e75c01627e509ea0 Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 17:56:02 +0200 Subject: [PATCH 06/13] Refactor hashing logic to a separate function It is used instead of internal signature validation mechanism, for integrity checking of the locally cached data. --- services/settings/RemoteSettingsWorker.sys.mjs | 4 ++++ services/settings/SharedUtils.sys.mjs | 9 +++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/services/settings/RemoteSettingsWorker.sys.mjs b/services/settings/RemoteSettingsWorker.sys.mjs index 57bfb3f3d5..52a0b7961a 100644 --- a/services/settings/RemoteSettingsWorker.sys.mjs +++ b/services/settings/RemoteSettingsWorker.sys.mjs @@ -177,6 +177,10 @@ class Worker { // task on the current thread instead of the worker thread. return lazy.SharedUtils.checkContentHash(buffer, size, hash); } + + async getContentHash(bytes) { + return lazy.SharedUtils.getContentHash(bytes); + } } // Now, first add a shutdown blocker. If that fails, we must have diff --git a/services/settings/SharedUtils.sys.mjs b/services/settings/SharedUtils.sys.mjs index 1eeaf0bed9..d998a2d3b1 100644 --- a/services/settings/SharedUtils.sys.mjs +++ b/services/settings/SharedUtils.sys.mjs @@ -21,11 +21,16 @@ export var SharedUtils = { return false; } // Has expected content? + const hashStr = await this.getContentHash(bytes); + return hashStr == hash; + }, + + async getContentHash(bytes) { const hashBuffer = await crypto.subtle.digest("SHA-256", bytes); const hashBytes = new Uint8Array(hashBuffer); const toHex = b => b.toString(16).padStart(2, "0"); - const hashStr = Array.from(hashBytes, toHex).join(""); - return hashStr == hash; + + return Array.from(hashBytes, toHex).join(""); }, /** -- 2.43.0 From b612fe1de7381746ac51694a4110268d0769ca6c Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 18:05:02 +0200 Subject: [PATCH 07/13] Client: Fetch and hash records from local dump Read the records from local dumps. See [1] for details on how to prepare custom dumps). Records are cached in the local IndexedDB, and the client updates cached records each time there's a change. Also it verifies integrity of the data. Then the list of current / created / updated / deleted records is generated and emitted to every registered listener. Change upstream signature validation mechanism to a simpler one. Otherwise, it'd be necessary to sign local records, which is redundant, because the application package should be signed already by the distro. Instead of signature property from metadata records, json_dump_metadata has been introduced. It contains the checksum of the records and size in bytes. Also added app_build_id property for version checking and updates of cached data. Although it's possible to disable integrity checking via preference, it seems to be not a good idea, because the logic that detects invalid local data relies on it. In the context of local-only setup, data that has been received from real Remote Settings server will not contain the custom metadata, and thus will be considered invalid and then discarded, while the client gets a chance to gracefully inform registered listeners about these changes so that they can discard the data received before the upgrade to local-only setup. [1] https://firefox-source-docs.mozilla.org/services/common/services/RemoteSettings.html#initial-data --- .../settings/RemoteSettingsClient.sys.mjs | 66 ++++++++----------- 1 file changed, 28 insertions(+), 38 deletions(-) diff --git a/services/settings/RemoteSettingsClient.sys.mjs b/services/settings/RemoteSettingsClient.sys.mjs index 7e95b9baab..989a3180b8 100644 --- a/services/settings/RemoteSettingsClient.sys.mjs +++ b/services/settings/RemoteSettingsClient.sys.mjs @@ -706,11 +706,9 @@ export class RemoteSettingsClient extends EventEmitter { // If the data is up-to-date but don't have metadata (records loaded from dump), // we fetch them and validate the signature immediately. - if (this.verifySignature && lazy.ObjectUtils.isEmpty(localMetadata)) { + if (this.verifySignature && lazy.ObjectUtils.isEmpty(localMetadata?.json_dump_metadata)) { lazy.console.debug(`${this.identifier} pull collection metadata`); - const metadata = await this.httpClient().getData({ - query: { _expected: expectedTimestamp }, - }); + const { metadata } = await this._fetchChangeset(expectedTimestamp); await this.db.importChanges(metadata); // We don't bother validating the signature if the dump was just loaded. We do // if the dump was loaded at some other point (eg. from .get()). @@ -987,38 +985,28 @@ export class RemoteSettingsClient extends EventEmitter { * @returns {Promise} */ async _validateCollectionSignature(records, timestamp, metadata) { - if (!metadata?.signature) { + if (!metadata?.json_dump_metadata) { throw new MissingSignatureError(this.identifier); } - if (!this._verifier) { - this._verifier = Cc[ - "@mozilla.org/security/contentsignatureverifier;1" - ].createInstance(Ci.nsIContentSignatureVerifier); - } - - // This is a content-signature field from an autograph response. const { - signature: { x5u, signature }, + json_dump_metadata: { hash, size }, } = metadata; - const certChain = await (await lazy.Utils.fetch(x5u)).text(); // Merge remote records with local ones and serialize as canonical JSON. const serialized = await lazy.RemoteSettingsWorker.canonicalStringify( records, timestamp ); - lazy.console.debug(`${this.identifier} verify signature using ${x5u}`); + lazy.console.debug(`${this.identifier} verify signature using size ${size} and hash ${hash}`); if ( - !(await this._verifier.asyncVerifyContentSignature( - serialized, - "p384ecdsa=" + signature, - certChain, - this.signerName, - lazy.Utils.CERT_CHAIN_ROOT_IDENTIFIER + !(await lazy.RemoteSettingsWorker.checkContentHash( + new TextEncoder().encode(serialized), + size, + hash )) ) { - throw new InvalidSignatureError(this.identifier, x5u); + throw new InvalidSignatureError(this.identifier); } } @@ -1185,24 +1173,26 @@ export class RemoteSettingsClient extends EventEmitter { * @param since timestamp of last sync (optional) */ async _fetchChangeset(expectedTimestamp, since) { - const client = this.httpClient(); - const { - metadata, - timestamp: remoteTimestamp, - changes: remoteRecords, - } = await client.execute( - { - path: `/buckets/${this.bucketName}/collections/${this.collectionName}/changeset`, - }, - { - query: { - _expected: expectedTimestamp, - _since: since, - }, - } + const { data } = await lazy.SharedUtils.loadJSONDump( + this.bucketName, + this.collectionName ); + const remoteRecords = data ?? []; + + const serialized = await lazy.RemoteSettingsWorker.canonicalStringify( + remoteRecords, + expectedTimestamp + ); + const bytes = new TextEncoder().encode(serialized); + const metadata = { + app_build_id: Services.appinfo.appBuildID, + json_dump_metadata: { + hash: await lazy.RemoteSettingsWorker.getContentHash(bytes), + size: bytes.length, + }, + } return { - remoteTimestamp, + remoteTimestamp: expectedTimestamp, metadata, remoteRecords, }; -- 2.43.0 From 9eaa21162fc1e2abeb24381edd4bea01fd103065 Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 18:42:56 +0200 Subject: [PATCH 08/13] Client: start deferred sync on get() or on() The users of the RemoteSettingsClient.sys.mjs can receive records from it in two ways: by calling get(), and by subscribing to events by calling on(). So hook a deferred sync whenever something calls these methods. Because multiple of those calls can be made quite early and in very short time, set up a deferred task that will be armed only when needed and only once in a second. When the task is running it first checks if the local data came from the dump of the current app build, and no-ops if true. If false, it triggers a sync. Then adds a flag if the client has been correctly synchronized with the dump, so that no metadata checking occurs during the session. --- .../settings/RemoteSettingsClient.sys.mjs | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/services/settings/RemoteSettingsClient.sys.mjs b/services/settings/RemoteSettingsClient.sys.mjs index 989a3180b8..c2c2a5734b 100644 --- a/services/settings/RemoteSettingsClient.sys.mjs +++ b/services/settings/RemoteSettingsClient.sys.mjs @@ -12,6 +12,7 @@ ChromeUtils.defineESModuleGetters(lazy, { ClientEnvironmentBase: "resource://gre/modules/components-utils/ClientEnvironment.sys.mjs", Database: "resource://services-settings/Database.sys.mjs", + DeferredTask: "resource://gre/modules/DeferredTask.sys.mjs", IDBHelpers: "resource://services-settings/IDBHelpers.sys.mjs", KintoHttpClient: "resource://services-common/kinto-http-client.sys.mjs", ObjectUtils: "resource://gre/modules/ObjectUtils.sys.mjs", @@ -23,6 +24,7 @@ ChromeUtils.defineESModuleGetters(lazy, { }); const TELEMETRY_COMPONENT = "remotesettings"; +const DEFERRED_SYNC_DELAY_MILLISECONDS = 1000; ChromeUtils.defineLazyGetter(lazy, "console", () => lazy.Utils.log); @@ -334,6 +336,11 @@ export class RemoteSettingsClient extends EventEmitter { this._lastCheckTimePref = lastCheckTimePref; this._verifier = null; this._syncRunning = false; + this._deferredSync = new lazy.DeferredTask(async () => { + if (!this._syncRunning && !(await this._isSynced())) { + await this.sync(); + } + }, DEFERRED_SYNC_DELAY_MILLISECONDS); // This attribute allows signature verification to be disabled, when running tests // or when pulling data from a dev server. @@ -363,6 +370,11 @@ export class RemoteSettingsClient extends EventEmitter { this.db.identifier = this.identifier; } + on(event, callback) { + super.on(event, callback); + this._deferredSync.arm(); + } + get identifier() { return `${this.bucketName}/${this.collectionName}`; } @@ -436,6 +448,10 @@ export class RemoteSettingsClient extends EventEmitter { let lastModified = forceSync ? null : await this.db.getLastModified(); let hasLocalData = lastModified !== null; + if (!(await this._isSynced())) { + throw new MissingSignatureError(this.identifier); + } + if (forceSync) { if (!this._importingPromise) { this._importingPromise = (async () => { @@ -551,7 +567,10 @@ export class RemoteSettingsClient extends EventEmitter { // No need to verify signature on JSON dumps. // If local DB cannot be read, then we don't even try to do anything, // we return results early. - return this._filterEntries(data); + const filtered = this._filterEntries(data); + this._deferredSync.arm(); + + return filtered; } lazy.console.debug( @@ -591,6 +610,12 @@ export class RemoteSettingsClient extends EventEmitter { return final; } + async _isSynced() { + this._synced ||= + Services.appinfo.appBuildID === (await this.db?.getMetadata())?.app_build_id; + return this._synced; + } + /** * Synchronize the local database with the remote server. * -- 2.43.0 From 4598808209c3a9a8cd3902053b250c88861bced2 Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 18:53:51 +0200 Subject: [PATCH 09/13] Client: deep compare records if timestamps match When the list of current / updated / deleted records is generated, their modification timestamps are compared to detect the updates. Although in practice this is unlikely to happen, in theory the timestamp of some older record received from Remote Settings can match with the modified record in the dump. Although JSON processing script makes sure to add unique timestamps to each of the modified records, it's still possible to update dumps manually and simply forget to update timestamps. So serialize the records and compare them as strings to be on the safe side. This should happen only once after upgrading to each new version of the application, so is not likely to introduce any noticeable performance issues. --- services/settings/RemoteSettingsClient.sys.mjs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/services/settings/RemoteSettingsClient.sys.mjs b/services/settings/RemoteSettingsClient.sys.mjs index c2c2a5734b..ee612a049c 100644 --- a/services/settings/RemoteSettingsClient.sys.mjs +++ b/services/settings/RemoteSettingsClient.sys.mjs @@ -9,6 +9,7 @@ import { Downloader } from "resource://services-settings/Attachments.sys.mjs"; const lazy = {}; ChromeUtils.defineESModuleGetters(lazy, { + CanonicalJSON: "resource://gre/modules/CanonicalJSON.sys.mjs", ClientEnvironmentBase: "resource://gre/modules/components-utils/ClientEnvironment.sys.mjs", Database: "resource://services-settings/Database.sys.mjs", @@ -1173,7 +1174,10 @@ export class RemoteSettingsClient extends EventEmitter { const old = oldById.get(r.id); if (old) { oldById.delete(r.id); - if (r.last_modified != old.last_modified) { + if ( + r.last_modified != old.last_modified || + lazy.CanonicalJSON.stringify(r) != lazy.CanonicalJSON.stringify(old) + ) { syncResult.updated.push({ old, new: r }); } } else { -- 2.43.0 From 79445efeb9c18ad9c2e2c4070cdc72aa6b736d1e Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 19:01:39 +0200 Subject: [PATCH 10/13] Client: delete more data on cleanup When the client detects the local data is invalid (i.e. it came from real Remote Settings and can have unwanted records), delete not only the records, but also the attachments that came with them, because they too can be problematic. And last check time preference, because it's not useful anyway when remote-settings.sys.mjs doesn't do any polling for changes. Note that attachments should be deleted before the records, because the logic gets the data about the attachments from those records. --- services/settings/RemoteSettingsClient.sys.mjs | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/services/settings/RemoteSettingsClient.sys.mjs b/services/settings/RemoteSettingsClient.sys.mjs index ee612a049c..b3c6caebba 100644 --- a/services/settings/RemoteSettingsClient.sys.mjs +++ b/services/settings/RemoteSettingsClient.sys.mjs @@ -255,7 +255,7 @@ class AttachmentDownloader extends Downloader { allRecords .filter(r => !!r.attachment) .map(r => - Promise.all([this.deleteDownloaded(r), this.deleteFromDisk(r)]) + Promise.all([this.deleteDownloaded(r), this.deleteFromDisk(r), this.deleteCached(r.id)]) ) ); } @@ -1133,7 +1133,7 @@ export class RemoteSettingsClient extends EventEmitter { // Signature failed, clear local DB because it contains // bad data (local + remote changes). lazy.console.debug(`${this.identifier} clear local data`); - await this.db.clear(); + await this._clearAll(); // Local data was tampered, throw and it will retry from empty DB. lazy.console.error(`${this.identifier} local data was corrupted`); throw new CorruptedDataError(this.identifier); @@ -1155,7 +1155,7 @@ export class RemoteSettingsClient extends EventEmitter { // _importJSONDump() only clears DB if dump is available, // therefore do it here! if (imported < 0) { - await this.db.clear(); + await this._clearAll(); } } } @@ -1195,6 +1195,12 @@ export class RemoteSettingsClient extends EventEmitter { return syncResult; } + async _clearAll() { + await this.attachments.deleteAll(); + await this.db.clear(); + Services.prefs.clearUserPref(this.lastCheckTimePref); + } + /** * Fetch information from changeset endpoint. * -- 2.43.0 From 24ba3c8ca82381eba887a318fb09f6d24e07064c Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 19:07:56 +0200 Subject: [PATCH 11/13] Client: remove comparison of collection timestamps In case if the cached data that came from real Remote Settings server (before the upgrade to local-only setup) has collection timestamp, that is newer than the packaged local dump, then this comparison logic can lead to early return of old data, skipping the integrity checking and necessary cleanup. So remove the checks. --- services/settings/RemoteSettingsClient.sys.mjs | 5 ----- 1 file changed, 5 deletions(-) diff --git a/services/settings/RemoteSettingsClient.sys.mjs b/services/settings/RemoteSettingsClient.sys.mjs index b3c6caebba..264a6cc831 100644 --- a/services/settings/RemoteSettingsClient.sys.mjs +++ b/services/settings/RemoteSettingsClient.sys.mjs @@ -1075,14 +1075,9 @@ export class RemoteSettingsClient extends EventEmitter { updated: [], deleted: [], }; - // If data wasn't changed, return empty sync result. - // This can happen when we update the signature but not the data. lazy.console.debug( `${this.identifier} local timestamp: ${localTimestamp}, remote: ${remoteTimestamp}` ); - if (localTimestamp && remoteTimestamp < localTimestamp) { - return syncResult; - } await this.db.importChanges(metadata, remoteTimestamp, remoteRecords, { clear: retry, -- 2.43.0 From 633d8d40e00786b388e62898e32414d1305fa91f Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 19:15:44 +0200 Subject: [PATCH 12/13] Attachments: load only from dump and drop cached --- services/settings/Attachments.sys.mjs | 37 ++++++--------------------- 1 file changed, 8 insertions(+), 29 deletions(-) diff --git a/services/settings/Attachments.sys.mjs b/services/settings/Attachments.sys.mjs index 5ddc6bb046..f7888cb769 100644 --- a/services/settings/Attachments.sys.mjs +++ b/services/settings/Attachments.sys.mjs @@ -147,9 +147,10 @@ export class Downloader { retries, checkHash, attachmentId = record?.id, - fallbackToCache = false, fallbackToDump = false, } = options || {}; + const fallbackToCache = false; + if (!attachmentId) { // Check for pre-condition. This should not happen, but it is explicitly // checked to avoid mixing up attachments, which could be dangerous. @@ -200,6 +201,7 @@ export class Downloader { const newBuffer = await this.downloadAsBytes(record, { retries, checkHash, + dumpInfo, }); const blob = new Blob([newBuffer]); // Store in cache but don't wait for it before returning. @@ -233,7 +235,7 @@ export class Downloader { } try { - return { ...(await cacheInfo.getResult()), _source: "cache_fallback" }; + await this.cacheImpl.delete(attachmentId); } catch (e) { // Failed to read from cache, e.g. IndexedDB unusable. console.error(e); @@ -318,7 +320,7 @@ export class Downloader { * @returns {String} the absolute file path to the downloaded attachment. */ async downloadToDisk(record, options = {}) { - const { retries = 3 } = options; + const retries = 0; const { attachment: { filename, size, hash }, } = record; @@ -373,33 +375,10 @@ export class Downloader { */ async downloadAsBytes(record, options = {}) { const { - attachment: { location, hash, size }, - } = record; - - const remoteFileUrl = (await this._baseAttachmentsURL()) + location; + dumpInfo = new LazyRecordAndBuffer(() => this._readAttachmentDump(attachmentId)) + } = options; - const { retries = 3, checkHash = true } = options; - let retried = 0; - while (true) { - try { - const buffer = await this._fetchAttachment(remoteFileUrl); - if (!checkHash) { - return buffer; - } - if ( - await lazy.RemoteSettingsWorker.checkContentHash(buffer, size, hash) - ) { - return buffer; - } - // Content is corrupted. - throw new Downloader.BadContentError(location); - } catch (e) { - if (retried >= retries) { - throw e; - } - } - retried++; - } + return (await dumpInfo.getResult()).buffer; } /** -- 2.43.0 From c0b96623a42ed3c74218fcc2574f78196fd901ff Mon Sep 17 00:00:00 2001 From: grizzlyuser Date: Wed, 30 Dec 2020 19:22:20 +0200 Subject: [PATCH 13/13] Disable CRLite entirely for now It's designed to fetch the data from Remote Settings. One of the main selling points is that new revocations can be pushed to the clients within minutes. That won't work with local-only setup. Although (some?) of the JSON dumps for it are in place, obviously the updates won't happen that fast. Disable the preference right in the source code, so that the patch fails to apply when the upstream decides to set it to fully enforcing mode by default. The solution with CRLite is up for discussion. If necessary, it's possible to make clients for blessed collections to communicate to real Remote Settings server. For example, for collections related to certificate revocations. --- modules/libpref/init/StaticPrefList.yaml | 2 +- security/manager/ssl/nsNSSComponent.cpp | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/libpref/init/StaticPrefList.yaml b/modules/libpref/init/StaticPrefList.yaml index 592ddd3229..9688ee64fd 100644 --- a/modules/libpref/init/StaticPrefList.yaml +++ b/modules/libpref/init/StaticPrefList.yaml @@ -14167,7 +14167,7 @@ # 3: Consult CRLite and enforce "Not Revoked" results, but defer to OCSP for "Revoked". - name: security.pki.crlite_mode type: RelaxedAtomicUint32 - value: 3 + value: 0 mirror: always - name: security.tls.version.min diff --git a/security/manager/ssl/nsNSSComponent.cpp b/security/manager/ssl/nsNSSComponent.cpp index dd14b5c24c..90350be691 100644 --- a/security/manager/ssl/nsNSSComponent.cpp +++ b/security/manager/ssl/nsNSSComponent.cpp @@ -1129,6 +1129,7 @@ void nsNSSComponent::setValidationOptions( CRLiteMode defaultCRLiteMode = CRLiteMode::Disabled; CRLiteMode crliteMode = static_cast(StaticPrefs::security_pki_crlite_mode()); + // Adding a comment just in case so that the patch breaks as soon as any surrounding lines get changed switch (crliteMode) { case CRLiteMode::Disabled: case CRLiteMode::TelemetryOnly: -- 2.43.0