Add documentation for DisableEncryptedClientHello

[policy-templates.git] / docs / index.md

diff --git a/docs/index.md b/docs/index.md
index 4e59368ae94fa44711537b5be29e9068318d1269..7e12d6a92817f668e32159df5c3bf8817bdc1430 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -17,6 +17,7 @@ Unfortunately, JSON files do not support comments, but you can add extra entries
 | --- | --- |
 | **[`3rdparty`](#3rdparty)** | Set policies that WebExtensions can access via chrome.storage.managed.
 | **[`AllowedDomainsForApps`](#alloweddomainsforapps)** | Define domains allowed to access Google Workspace.
 | --- | --- |
 | **[`3rdparty`](#3rdparty)** | Set policies that WebExtensions can access via chrome.storage.managed.
 | **[`AllowedDomainsForApps`](#alloweddomainsforapps)** | Define domains allowed to access Google Workspace.

+| **[`AllowFileSelectionDialogs`](#allowfileselectiondialogs)** | Allow file selection dialogs.

 | **[`AppAutoUpdate`](#appautoupdate)** | Enable or disable automatic application update.
 | **[`AppUpdatePin`](#appupdatepin)** | Prevent Firefox from being updated beyond the specified version.
 | **[`AppUpdateURL`](#appupdateurl)** | Change the URL for application update.
 | **[`AppAutoUpdate`](#appautoupdate)** | Enable or disable automatic application update.
 | **[`AppUpdatePin`](#appupdatepin)** | Prevent Firefox from being updated beyond the specified version.
 | **[`AppUpdateURL`](#appupdateurl)** | Change the URL for application update.


@@ -40,6 +41,7 @@ Unfortunately, JSON files do not support comments, but you can add extra entries
 | **[`DisabledCiphers`](#disabledciphers)** | Disable ciphers.
 | **[`DisableDefaultBrowserAgent`](#disabledefaultbrowseragent)** | Prevent the default browser agent from taking any actions (Windows only).
 | **[`DisableDeveloperTools`](#disabledevelopertools)** | Remove access to all developer tools.
 | **[`DisabledCiphers`](#disabledciphers)** | Disable ciphers.
 | **[`DisableDefaultBrowserAgent`](#disabledefaultbrowseragent)** | Prevent the default browser agent from taking any actions (Windows only).
 | **[`DisableDeveloperTools`](#disabledevelopertools)** | Remove access to all developer tools.

+| **[`DisableEncryptedClientHello`](#disableencryptedclienthello)** | Disable the TLS Feature Encrypted Client Hello (ECH).

 | **[`DisableFeedbackCommands`](#disablefeedbackcommands)** | Disable the menus for reporting sites.
 | **[`DisableFirefoxAccounts`](#disablefirefoxaccounts)** | Disable Firefox Accounts integration (Sync).
 | **[`DisableFirefoxScreenshots`](#disablefirefoxscreenshots)** | Remove access to Firefox Screenshots.
 | **[`DisableFeedbackCommands`](#disablefeedbackcommands)** | Disable the menus for reporting sites.
 | **[`DisableFirefoxAccounts`](#disablefirefoxaccounts)** | Disable Firefox Accounts integration (Sync).
 | **[`DisableFirefoxScreenshots`](#disablefirefoxscreenshots)** | Remove access to Firefox Screenshots.


@@ -219,6 +221,42 @@ Value (string):
   }
 }
 ```
   }
 }
 ```

+### AllowFileSelectionDialogs
+
+Enable or disable file selection dialogs.
+
+**Compatibility:** Firefox 124\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** `widget.disable_file_pickers`
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\AllowFileSelectionDialogs = 0x1 | 0x0
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/AppAutoAllowFileSelectionDialogsUpdate
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+#### macOS
+```
+<dict>
+  <key>AllowFileSelectionDialogs</key>
+  <true/> | <false/>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "AllowFileSelectionDialogs": true | false
+  }
+}
+```

 ### AppAutoUpdate
 
 Enable or disable **automatic** application update.
 ### AppAutoUpdate
 
 Enable or disable **automatic** application update.


@@ -587,6 +625,8 @@ If set to false, the application will not try to install updates when the applic
 
 If you have disabled updates via `DisableAppUpdate` or disabled automatic updates via `AppAutoUpdate`, this policy has no effect.
 
 
 If you have disabled updates via `DisableAppUpdate` or disabled automatic updates via `AppAutoUpdate`, this policy has no effect.
 

+If you are having trouble getting the background task to run, verify your configuration with the ["Requirements to run" section in this support document](https://support.mozilla.org/en-US/kb/enable-background-updates-firefox-windows).
+

 **Compatibility:** Firefox 90 (Windows only)\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `app.update.background.enabled`
 **Compatibility:** Firefox 90 (Windows only)\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `app.update.background.enabled`


@@ -1546,6 +1586,76 @@ Value (string):
   }
 }
 ```
   }
 }
 ```

+### DisableDeveloperTools
+Remove access to all developer tools.
+
+**Compatibility:** Firefox 60, Firefox ESR 60\
+**CCK2 Equivalent:** `removeDeveloperTools`\
+**Preferences Affected:** `devtools.policy.disabled`
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\DisableDeveloperTools = 0x1 | 0x0`
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/DisableDeveloperTools
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+#### macOS
+```
+<dict>
+  <key>DisableDeveloperTools</key>
+  <true/> | <false/>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "DisableDeveloperTools": true | false
+  }
+}
+```
+### DisableEncryptedClientHello
+Disable the TLS Feature for Encrypted Client Hello. Note that TLS Client Hellos will still contain an ECH extension, but this extension will not be used by Firefox during the TLS handshake. 
+
+**Compatibility:** Firefox 127, Firefox ESR 128\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** `network.dns.echconfig.enabled`, `network.dns.http3_echconfig.enabled`
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\DisableEncryptedClientHello = 0x1 | 0x0
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/DisableEncryptedClientHello
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+#### macOS
+```
+<dict>
+  <key>DisableEncryptedClientHello</key>
+  <true/> | <false/>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "DisableEncryptedClientHello": true | false
+  }
+}
+```

 ### DisableFirefoxAccounts
 Disable Firefox Accounts integration (Sync).
 
 ### DisableFirefoxAccounts
 Disable Firefox Accounts integration (Sync).
 


@@ -2259,7 +2369,9 @@ Configure DNS over HTTPS.
 
 `ExcludedDomains` excludes domains from DNS over HTTPS.
 
 
 `ExcludedDomains` excludes domains from DNS over HTTPS.
 

-**Compatibility:** Firefox 63, Firefox ESR 68 (ExcludedDomains added in 75/68.7)\
+`Fallback` determines whether or not Firefox will use your default DNS resolver if there is a problem with the secure DNS provider.
+
+**Compatibility:** Firefox 63, Firefox ESR 68 (ExcludedDomains added in 75/68.7) (Fallback added in 124)\

 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `network.trr.mode`, `network.trr.uri`
 
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `network.trr.mode`, `network.trr.uri`
 


@@ -2269,6 +2381,7 @@ Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Enabled = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ProviderURL = "URL_TO_ALTERNATE_PROVIDER"
 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Locked = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ExcludedDomains\1 = "example.com"
 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ProviderURL = "URL_TO_ALTERNATE_PROVIDER"
 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Locked = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ExcludedDomains\1 = "example.com"

+Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Fallback = 0x1 | 0x0

 ```
 #### Windows (Intune)
 OMA-URI:
 ```
 #### Windows (Intune)
 OMA-URI:


@@ -2305,6 +2418,14 @@ Value (string):
 <enabled/>
 <data id="List" value="1&#xF000;example.com"/>
 ```
 <enabled/>
 <data id="List" value="1&#xF000;example.com"/>
 ```

+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~DNSOverHTTPS/DNSOverHTTPS_Fallback
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```

 #### macOS
 ```
 <dict>
 #### macOS
 ```
 <dict>


@@ -2320,6 +2441,8 @@ Value (string):
     <array>
       <string>example.com</string>
     </array>
     <array>
       <string>example.com</string>
     </array>

+    <key>Fallback</key>
+    <true/> | <false/>

   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```


@@ -2331,7 +2454,8 @@ Value (string):
       "Enabled":  true | false,
       "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
       "Locked": true | false,
       "Enabled":  true | false,
       "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
       "Locked": true | false,

-      "ExcludedDomains": ["example.com"]
+      "ExcludedDomains": ["example.com"],
+      "Fallback": true | false,

     }
   }
 }
     }
   }
 }


@@ -2652,7 +2776,9 @@ Value (string):
 ### Extensions
 Control the installation, uninstallation and locking of extensions.
 
 ### Extensions
 Control the installation, uninstallation and locking of extensions.
 

-While this policy is not technically deprecated, it is recommended that you use the **[`ExtensionSettings`](#extensionsettings)** policy. It has the same functionality and adds more. It does not support native paths, though, so you'll have to use file:/// URLs.
+We strongly recommend that you use the **[`ExtensionSettings`](#extensionsettings)** policy. It has the same functionality and adds more. It does not support native paths, though, so you'll have to use file:/// URLs.
+
+This method will be deprecated in the near future.

 
 `Install` is a list of URLs or native paths for extensions to be installed.
 
 
 `Install` is a list of URLs or native paths for extensions to be installed.
 


@@ -2775,7 +2901,8 @@ Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) =
     "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi"
   },
   "https-everywhere@eff.org": {
     "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi"
   },
   "https-everywhere@eff.org": {

-    "installation_mode": "allowed"
+    "installation_mode": "allowed",
+    "updates_disabled": false

   }
 }
 ```
   }
 }
 ```


@@ -2800,7 +2927,8 @@ Value (string):
     "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi"
   },
     "https-everywhere@eff.org": {
     "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi"
   },
     "https-everywhere@eff.org": {

-    "installation_mode": "allowed"
+    "installation_mode": "allowed",
+    "updates_disabled": false

   }
 }'/>
 ```
   }
 }'/>
 ```


@@ -2827,14 +2955,16 @@ Value (string):
     <key>uBlock0@raymondhill.net</key>
     <dict>
       <key>installation_mode</key>
     <key>uBlock0@raymondhill.net</key>
     <dict>
       <key>installation_mode</key>

-       <string>force_installed</string>
+      <string>force_installed</string>

       <key>install_url</key>
       <string>https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi</string>
     </dict>
     <key>https-everywhere@eff.org</key>
     <dict>
       <key>installation_mode</key>
       <key>install_url</key>
       <string>https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi</string>
     </dict>
     <key>https-everywhere@eff.org</key>
     <dict>
       <key>installation_mode</key>

-       <string>allowed</string>
+      <string>allowed</string>
+      <key>updates_disabled</key>
+      <true/> | <false/>

     </dict>
   </dict>
 </dict>
     </dict>
   </dict>
 </dict>


@@ -2855,7 +2985,8 @@ Value (string):
         "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi"
       },
       "https-everywhere@eff.org": {
         "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi"
       },
       "https-everywhere@eff.org": {

-        "installation_mode": "allowed"
+        "installation_mode": "allowed",
+        "updates_disabled": false

       }
     }
   }
       }
     }
   }


@@ -2899,7 +3030,7 @@ Value (string):
 ### FirefoxHome
 Customize the Firefox Home page.
 
 ### FirefoxHome
 Customize the Firefox Home page.
 

-**Compatibility:** Firefox 68, Firefox ESR 68 (SponsoredTopSites and SponsoredPocket were added in Firefox 95, Firefox ESR 91.4)
+**Compatibility:** Firefox 68, Firefox ESR 68 (SponsoredTopSites and SponsoredPocket were added in Firefox 95, Firefox ESR 91.4, Snippets was deprecated in Firefox 122)

 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `browser.newtabpage.activity-stream.showSearch`, `browser.newtabpage.activity-stream.feeds.topsites`, `browser.newtabpage.activity-stream.feeds.section.highlights`, `browser.newtabpage.activity-stream.feeds.section.topstories`, `browser.newtabpage.activity-stream.feeds.snippets`, `browser.newtabpage.activity-stream.showSponsoredTopSites`, `browser.newtabpage.activity-stream.showSponsored`
 
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `browser.newtabpage.activity-stream.showSearch`, `browser.newtabpage.activity-stream.feeds.topsites`, `browser.newtabpage.activity-stream.feeds.section.highlights`, `browser.newtabpage.activity-stream.feeds.section.topstories`, `browser.newtabpage.activity-stream.feeds.snippets`, `browser.newtabpage.activity-stream.showSponsoredTopSites`, `browser.newtabpage.activity-stream.showSponsored`
 


@@ -3776,12 +3907,32 @@ If this policy is enabled:
  2. Firefox will not check for updates in the background, though it will check automatically when an update UI is displayed (such as the one in the About dialog). This check will be used to show "Update to version X" in the UI, but will not automatically download the update or prompt the user to update in any other way.
  3. The update UI will work as expected, unlike when using DisableAppUpdate.
 
  2. Firefox will not check for updates in the background, though it will check automatically when an update UI is displayed (such as the one in the About dialog). This check will be used to show "Update to version X" in the UI, but will not automatically download the update or prompt the user to update in any other way.
  3. The update UI will work as expected, unlike when using DisableAppUpdate.
 

-This policy is primarily intended for advanced end users, not for enterprises.
+This policy is primarily intended for advanced end users, not for enterprises, but it is available via GPO.

 
 **Compatibility:** Firefox 87\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** N/A
 
 
 **Compatibility:** Firefox 87\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** N/A
 

+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\ManualAppUpdateOnly = 0x1 | 0x0
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/ManualAppUpdateOnly
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+#### macOS
+```
+<dict>
+  <key>ManualAppUpdateOnly</key>
+  <true/> | <false/>
+</dict>
+```

 #### policies.json
 ```
 {
 #### policies.json
 ```
 {


@@ -4129,7 +4280,7 @@ Note: DisableBuiltinPDFViewer has not been deprecated. You can either continue t
 
 **Compatibility:** Firefox 77, Firefox ESR 68.9\
 **CCK2 Equivalent:** N/A\
 
 **Compatibility:** Firefox 77, Firefox ESR 68.9\
 **CCK2 Equivalent:** N/A\

-**Preferences Affected:** `pdfjs.diabled`, `pdfjs.enablePermissions`
+**Preferences Affected:** `pdfjs.disabled`, `pdfjs.enablePermissions`

 
 #### Windows (GPO)
 ```
 
 #### Windows (GPO)
 ```


@@ -4581,7 +4732,8 @@ Previously you could only set and lock a subset of preferences. Starting with Fi
 Preferences that start with the following prefixes are supported:
 ```
 accessibility.
 Preferences that start with the following prefixes are supported:
 ```
 accessibility.

-app.update.* (Firefox 86, Firefox 78.8)
+alerts.* (Firefox 122, Firefox ESR 115.7)
+app.update.* (Firefox 86, Firefox ESR 78.8)

 browser.
 datareporting.policy.
 dom.
 browser.
 datareporting.policy.
 dom.


@@ -4660,6 +4812,8 @@ Using the preference as the key, set the `Value` to the corresponding preference
 
 `"user"` preferences persist even if the policy is removed, so if you need to remove them, you should use the clear policy.
 
 
 `"user"` preferences persist even if the policy is removed, so if you need to remove them, you should use the clear policy.
 

+You can also set the `Type` starting in Firefox 123 and Firefox ESR 115.8. It can be `number`, `boolean` or `string`. This is especially useful if you are seeing 0 or 1 values being converted to booleans when set as user preferences.
+

 See the examples below for more detail.
 
 IMPORTANT: Make sure you're only setting a particular preference using this mechanism and not some other way.
 See the examples below for more detail.
 
 IMPORTANT: Make sure you're only setting a particular preference using this mechanism and not some other way.


@@ -4675,7 +4829,9 @@ Software\Policies\Mozilla\Firefox\Preferences (REG_MULTI_SZ) =
 {
   "accessibility.force_disabled": {
     "Value": 1,
 {
   "accessibility.force_disabled": {
     "Value": 1,

-    "Status": "default"
+    "Status": "default",
+    "Type": "number"
+

   },
   "browser.cache.disk.parent_directory": {
     "Value": "SOME_NATIVE_PATH",
   },
   "browser.cache.disk.parent_directory": {
     "Value": "SOME_NATIVE_PATH",


@@ -4699,7 +4855,8 @@ Value (string):
 {
   "accessibility.force_disabled": {
     "Value": 1,
 {
   "accessibility.force_disabled": {
     "Value": 1,

-    "Status": "default"
+    "Status": "default",
+    "Type": "number"

   },
   "browser.cache.disk.parent_directory": {
     "Value": "SOME_NATIVE_PATH",
   },
   "browser.cache.disk.parent_directory": {
     "Value": "SOME_NATIVE_PATH",


@@ -4722,6 +4879,8 @@ Value (string):
       <integer>1</integer>
       <key>Status</key>
       <string>default</string>
       <integer>1</integer>
       <key>Status</key>
       <string>default</string>

+      <key>Type</key>
+      <string>number</string>

     </dict>
     <key>browser.cache.disk.parent_directory</key>
     <dict>
     </dict>
     <key>browser.cache.disk.parent_directory</key>
     <dict>


@@ -4748,6 +4907,7 @@ Value (string):
       "accessibility.force_disabled": {
         "Value": 1,
         "Status": "default"
       "accessibility.force_disabled": {
         "Value": 1,
         "Status": "default"

+        "Type": "number"

       },
       "browser.cache.disk.parent_directory": {
         "Value": "SOME_NATIVE_PATH",
       },
       "browser.cache.disk.parent_directory": {
         "Value": "SOME_NATIVE_PATH",