X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/8dcf0729293dec2b12f813bf8eb650d9a66d01ed..a55a57c7b6748276b477861958b7a028ed9e3ab2:/README.md diff --git a/README.md b/README.md index 1a4fcb6..efde516 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,25 @@ Policies can be specified using the [Group Policy templates on Windows](https://github.com/mozilla/policy-templates/tree/master/windows), [Intune on Windows](https://support.mozilla.org/kb/managing-firefox-intune), [configuration profiles on macOS](https://github.com/mozilla/policy-templates/tree/master/mac), or by creating a file called `policies.json`. On Windows, create a directory called `distribution` where the EXE is located and place the file there. On Mac, the file goes into `Firefox.app/Contents/Resources/distribution`. On Linux, the file goes into `firefox/distribution`, where `firefox` is the installation directory for firefox, which varies by distribution or you can specify system-wide policy by placing the file in `/etc/firefox/policies`. +Unfortunately, JSON files do not support comments, but you can add extra entries to the JSON to use as comments. You will see an error in about:policies, but the policies will still work properly. For example: + +``` +{ + "policies": { + "Authentication": { + "SPNEGO": ["mydomain.com", "https://myotherdomain.com"] + } + "Authentication_Comment": "These domains are required for us" + } +} +``` + | Policy Name | Description | --- | --- | | **[`3rdparty`](#3rdparty)** | Set policies that WebExtensions can access via chrome.storage.managed. | **[`AllowedDomainsForApps`](#alloweddomainsforapps)** | Define domains allowed to access Google Workspace. | **[`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. | **[`Authentication`](#authentication)** | Configure sites that support integrated authentication. | **[`AutoLaunchProtocolsFromOrigins`](#autolaunchprotocolsfromorigins)** | Define a list of external protocols that can be used from listed origins without prompting the user. @@ -46,7 +60,9 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image. | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or updated. | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry +| **[`DisableThirdPartyModuleBlocking`](#disablethirdpartymoduleblocking)** | Do not allow blocking third-party modules. | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar. +| **[`DisplayBookmarksToolbar (Deprecated)`](#displaybookmarkstoolbar-deprecated)** | Set the initial state of the bookmarks toolbar. | **[`DisplayMenuBar`](#displaymenubar)** | Set the state of the menubar. | **[`DisplayMenuBar (Deprecated)`](#displaymenubar-deprecated)** | Set the initial state of the menubar. | **[`DNSOverHTTPS`](#dnsoverhttps)** | Configure DNS over HTTPS. @@ -61,6 +77,7 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates. | **[`FirefoxHome`](#firefoxhome)** | Customize the Firefox Home page. | **[`FlashPlugin (Deprecated)`](#flashplugin-deprecated)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed. +| **[`GoToIntranetSiteForSingleWordEntryInAddressBar`](#gotointranetsiteforsinglewordentryinaddressbar)** | Force direct intranet site navigation instead of searching when typing single word entries in the address bar. | **[`Handlers`](#handlers)** | Configure default application handlers. | **[`HardwareAcceleration`](#hardwareacceleration)** | Control hardware acceleration. | **[`Homepage`](#homepage)** | Configure the default homepage and how Firefox starts. @@ -103,6 +120,7 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`ShowHomeButton`](#showhomebutton)** | Show the home button on the toolbar. | **[`SSLVersionMax`](#sslversionmax)** | Set and lock the maximum version of TLS. | **[`SSLVersionMin`](#sslversionmin)** | Set and lock the minimum version of TLS. +| **[`StartDownloadsInTempDirectory`](#startdownloadsintempdirectory)** | Force downloads to start off in a local, temporary location rather than the default download directory. | **[`SupportMenu`](#supportmenu)** | Add a menuitem to the help menu for specifying support information. | **[`UserMessaging`](#usermessaging)** | Don't show certain messages to the user. | **[`UseSystemPrintDialog`](#usesystemprintdialog)** | Print using the system print dialog instead of print preview. @@ -248,6 +266,49 @@ Value (string): } } ``` +### AppUpdatePin + +Prevent Firefox from being updated beyond the specified version. + +You can specify the any version as ```xx.``` and Firefox will be updated with all minor versions, but will not be updated beyond the major version. + +You can also specify the version as ```xx.xx``` and Firefox will be updated with all patch versions, but will not be updated beyond the minor version. + +You should specify a version that exists or is guaranteed to exist. If you specify a version that doesn't end up existing, Firefox will update beyond that version. + +**Compatibility:** Firefox 102,\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\AppUpdatePin = "106." +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/AppUpdatePin +``` +Value (string): +``` + + +``` +#### macOS +``` + + AppUpdatePin + 106. + +``` +#### policies.json +``` +{ + "policies": { + "AppUpdatePin": "106." + } +} +``` ### AppUpdateURL Change the URL for application update if you are providing Firefox updates from a custom update server. @@ -1163,6 +1224,7 @@ Value (string): { "policies": { "DefaultDownloadDirectory": "${home}/Downloads" + } } ``` #### policies.json (Windows) @@ -1170,6 +1232,7 @@ Value (string): { "policies": { "DefaultDownloadDirectory": "${home}\\Downloads" + } } ``` ### DisableAppUpdate @@ -2003,7 +2066,71 @@ Value (string): } } ``` +### DisableThirdPartyModuleBlocking +Do not allow blocking third-party modules from the `about:third-party` page. + +This policy only works on Windows through GPO (not policies.json). + +**Compatibility:** Firefox 110 (Windows only, GPO only)\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableThirdPartyModuleBlocking = = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/DisableThirdPartyModuleBlocking +``` +Value (string): +``` + or +``` ### DisplayBookmarksToolbar +Set the initial state of the bookmarks toolbar. A user can still change how it is displayed. + +`always` means the bookmarks toolbar is always shown. + +`never` means the bookmarks toolbar is not shown. + +`newtab` means the bookmarks toolbar is only shown on the new tab page. + +**Compatibility:** Firefox 109, Firefox ESR 102.7\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisplayBookmarksToolbar = "always", "never", "newtab" +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/DisplayBookmarksToolbar_Enum +``` +Value (string): +``` + + +``` +#### macOS +``` + + DisplayBookmarksToolbar + always | never | newtab + +``` +#### policies.json +``` +{ + "policies": { + "DisplayBookmarksToolbar": "always" | "never" | "newtab" + } +} +``` +### DisplayBookmarksToolbar (Deprecated) Set the initial state of the bookmarks toolbar. A user can still hide it and it will stay hidden. **Compatibility:** Firefox 60, Firefox ESR 60\ @@ -2288,6 +2415,8 @@ If `Cryptomining` is set to true, cryptomining scripts on websites are blocked. If `Fingerprinting` is set to true, fingerprinting scripts on websites are blocked. +If `EmailTracking` is set to true, hidden email tracking pixels and scripts on websites are blocked. (Firefox 112) + `Exceptions` are origins for which tracking protection is not enabled. **Compatibility:** Firefox 60, Firefox ESR 60 (Cryptomining and Fingerprinting added in 70/68.2, Exceptions added in 73/68.5)\ @@ -2333,6 +2462,7 @@ OMA-URI: ``` Value (string): ``` + ``` OMA-URI: @@ -2453,7 +2583,7 @@ Important: The documentation for the policy for both Edge and Chrome is incorrec **Preferences Affected:** N/A #### Windows (GPO) -Software\Policies\Mozilla\Firefox\Handlers (REG_MULTI_SZ) = +Software\Policies\Mozilla\Firefox\ExemptDomainFileTypePairsFromFileTypeDownloadWarnings (REG_MULTI_SZ) = ``` [ { @@ -2606,7 +2736,7 @@ The configuration for each extension is another dictionary that can contain the |         `force_installed`| The extension is automatically installed and can't be removed by the user. This option is not valid for the default configuration and requires an install_url. |         `normal_installed`| The extension is automatically installed but can be disabled by the user. This option is not valid for the default configuration and requires an install_url. | `install_url`| Maps to a URL indicating where Firefox can download a force_installed or normal_installed extension. If installing from the local file system, use a [```file:///``` URL](https://en.wikipedia.org/wiki/File_URI_scheme). If installing from the addons.mozilla.org, use the following URL (substituting SHORT_NAME from the URL on AMO), https://addons.mozilla.org/firefox/downloads/latest/SHORT_NAME/latest.xpi. Languages packs are available from https://releases.mozilla.org/pub/firefox/releases/VERSION/PLATFORM/xpi/LANGUAGE.xpi. If you need to update the extension, you can change the name of the extension and it will be automatically updated. Extensions installed from file URLs will additional be updated when their internal version changes. -| `install_sources` | A list of sources from which installing extensions is allowed. **This is unnecessary if you are only allowing the installation of certain extensions by ID.** Each item in this list is an extension-style match pattern. Users will be able to easily install items from any URL that matches an item in this list. Both the location of the *.xpi file and the page where the download is started from (i.e. the referrer) must be allowed by these patterns. This setting can be used only for the default configuration. +| `install_sources` | A list of sources from which installing extensions is allowed using URL match patterns. **This is unnecessary if you are only allowing the installation of certain extensions by ID.** Each item in this list is an extension-style match pattern. Users will be able to easily install items from any URL that matches an item in this list. Both the location of the *.xpi file and the page where the download is started from (i.e. the referrer) must be allowed by these patterns. This setting can be used only for the default configuration. | `allowed_types` | This setting whitelists the allowed types of extension/apps that can be installed in Firefox. The value is a list of strings, each of which should be one of the following: "extension", "theme", "dictionary", "locale" This setting can be used only for the default configuration. | `blocked_install_message` | This maps to a string specifying the error message to display to users if they're blocked from installing an extension. This setting allows you to append text to the generic error message displayed when the extension is blocked. This could be be used to direct users to your help desk, explain why a particular extension is blocked, or something else. This setting can be used only for the default configuration. | `restricted_domains` | An array of domains on which content scripts can't be run. This setting can be used only for the default configuration. @@ -2622,7 +2752,7 @@ Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = { "*": { "blocked_install_message": "Custom error message.", - "install_sources": ["about:addons","https://addons.mozilla.org/"], + "install_sources": ["https://yourwebsite.com/*"], "installation_mode": "blocked", "allowed_types": ["extension"] }, @@ -2647,7 +2777,7 @@ Value (string): { "*": { "blocked_install_message": "Custom error message.", - "install_sources": ["about:addons","https://addons.mozilla.org/"], + "install_sources": ["https://yourwebsite.com/*"], "installation_mode": "blocked", "allowed_types": ["extension"] }, @@ -2671,8 +2801,7 @@ Value (string): Custom error message. install_sources - about:addons - https://addons.mozilla.org/ + "https://yourwebsite.com/*" installation_mode blocked @@ -2703,7 +2832,7 @@ Value (string): "ExtensionSettings": { "*": { "blocked_install_message": "Custom error message.", - "install_sources": ["about:addons","https://addons.mozilla.org/"], + "install_sources": ["https://yourwebsite.com/*"], "installation_mode": "blocked", "allowed_types": ["extension"] }, @@ -2910,6 +3039,51 @@ Value (string): } } ``` +### GoToIntranetSiteForSingleWordEntryInAddressBar +Whether to always go through the DNS server before sending a single word search string to a search engine. + +If the site exists, it will navigate to the website. If the intranet responds with a 404, the page will show a 404. If the intranet does not respond, the browser will attempt a search. + +The second result in the URL bar will be a search result to allow users to conduct a web search exactly as it was entered. + +If instead you would like to enable the ability to have your domain appear as a valid URL and to disallow the browser from ever searching that term using the first result that matches it, add the pref `browser.fixup.domainwhitelist.YOUR_DOMAIN` (where `YOUR_DOMAIN` is the name of the domain you'd like to add), and set the pref to `true`. The URL bar will then suggest `YOUR_DOMAIN` when the user fully types `YOUR_DOMAIN`. If the user attempts to load that domain and it fails to load, it will show an "Unable to connect" error page. + +You can also whitelist a domain suffix that is not part of the [Public Suffix List](https://publicsuffix.org/) by adding the pref `browser.fixup.domainsuffixwhitelist.YOUR_DOMAIN_SUFFIX` with a value of `true`. + +Additionally, if you want users to see a "Did you mean to go to 'YOUR_DOMAIN'" prompt below the URL bar if they land on a search results page instead of an intranet domain that provides a response, set the pref `browser.urlbar.dnsResolveSingleWordsAfterSearch` to `1`. Enabling this will cause the browser to commit a DNS check after every single word search. If the browser receives a response from the intranet, a prompt will ask the user if they'd like to instead navigate to `YOUR_DOMAIN`. If the user presses the **yes** button, `browser.fixup.domainwhitelist.YOUR_DOMAIN` will be set to `true`. + +**Compatibility:** Firefox 104, Firefox ESR 102.2\ +**CCK2 Equivalent:** `N/A`\ +**Preferences Affected:** `browser.fixup.dns_first_for_single_words` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\GoToIntranetSiteForSingleWordEntryInAddressBar = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/GoToIntranetSiteForSingleWordEntryInAddressBar +``` +Value (string): +``` + or +``` +#### macOS +``` + + GoToIntranetSiteForSingleWordEntryInAddressBar + | + +``` +#### policies.json +``` +{ + "policies": { + "GoToIntranetSiteForSingleWordEntryInAddressBar": true | false + } +} +``` ### Handlers Configure default application handlers. This policy is based on the internal format of `handlers.json`. @@ -4421,6 +4595,7 @@ spellchecker. (Firefox 84, Firefox ESR 78.6) toolkit.legacyUserProfileCustomizations.stylesheets (Firefox 95, Firefox ESR 91.4) ui. widget. +xpinstall.signatures.required (Firefox ESR 102.10, Firefox ESR only) ``` as well as the following security preferences: | Preference | Type | Default @@ -4431,12 +4606,16 @@ as well as the following security preferences: |     If set to true, adds the words "Not Secure" for insecure sites. | security.insecure_connection_text.pbmode.enabled | bool | false |     If set to true, adds the words "Not Secure" for insecure sites in private browsing. -| security.insecure_field_warning.contextual.enabled | bool | true -|     If set to false, remove the warning for inscure login fields. | security.mixed_content.block_active_content | boolean | true |     If false, mixed active content (HTTP and HTTPS) is not blocked. | security.osclientcerts.autoload | boolean | false |     If true, client certificates are loaded from the operating system certificate store. +| security.OCSP.enabled | integer | 1 +|     If 0, do not fetch OCSP. If 1, fetch OCSP for DV and EV certificates. If 2, fetch OCSP only for EV certificates +| security.OCSP.require | boolean | false +|      If true, if an OCSP request times out, the connection fails. +| security.ssl.enable_ocsp_stapling | boolean | true +|      If false, OCSP stapling is not enabled. | security.ssl.errorReporting.enabled | boolean | true |     If false, SSL errors cannot be sent to Mozilla. | security.tls.enable_0rtt_data | boolean | true @@ -4798,6 +4977,8 @@ Value (string): Configure proxy settings. These settings correspond to the connection settings in Firefox preferences. To specify ports, append them to the hostnames with a colon (:). +Unless you lock this policy, changes the user already has in place will take effect. + `Mode` is the proxy method being used. `Locked` is whether or not proxy settings can be changed. @@ -4842,8 +5023,98 @@ Software\Policies\Mozilla\Firefox\Proxy\AutoLogin = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0 ``` #### Windows (Intune) +**Note** +These setttings were moved to a category to make them easier to configure via Intune. + +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_Locked +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_ConnectionType +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_HTTPProxy +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_UseHTTPProxyForAllProtocols +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_SSLProxy +``` +Value (string): +``` + + +``` OMA-URI: ``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_SOCKSProxy +``` +Value (string): +``` + + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_AutoConfigURL +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_Passthrough +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_AutoLogin +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_UseProxyForDNS +``` +Value (string): +``` + or +``` +OMA-URI (Old way): +``` ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/Proxy ``` Value (string): @@ -4851,11 +5122,11 @@ Value (string): - + - - - + + + @@ -5638,7 +5909,7 @@ Value (string): - + ``` #### macOS ``` @@ -5666,6 +5937,40 @@ Value (string): } } ``` +### StartDownloadsInTempDirectory +Force downloads to start off in a local, temporary location rather than the default download directory. + +**Compatibility:** Firefox 102\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.download.start_downloads_in_tmp_dir` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\StartDownloadsInTempDirectory = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/StartDownloadsInTempDirectory +``` +Value (string): +``` + or +``` +#### macOS +``` + + StartDownloadsInTempDirectory + | + +``` +#### policies.json +``` +{ + "policies": { + "StartDownloadsInTempDirectory": true | false +} +``` ### UserMessaging Prevent Firefox from messaging the user in certain situations.