X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/5d3a3bd20e409be6d181a217aed3d881e9c1cc55..de489b9046f7f8a7fe0f696d8d4d5b110518a82a:/README.md diff --git a/README.md b/README.md index 34bd487..7ccd504 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,11 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | Policy Name | Description | --- | --- | -| **[`AppAutoUpdate`](#appautoupdate)** | Enable or disable automatic application update. +| **[`3rdparty`](#3rdparty)** | Set policies that WebExtensions can access via chrome.storage.managed. +| **[`AppAutoUpdate`](#appautoupdate)** | Enable or disable automatic application update. | **[`AppUpdateURL`](#appupdateurl)** | Change the URL for application update. | **[`Authentication`](#authentication)** | Configure sites that support integrated authentication. +| **[`BackgroundAppUpdate`](#backgroundappupdate)** | Enable or disable automatic application update in the background, when the application is not running. | **[`BlockAboutAddons`](#blockaboutaddons)** | Block access to the Add-ons Manager (about:addons). | **[`BlockAboutConfig`](#blockaboutconfig)** | Block access to about:config. | **[`BlockAboutProfiles`](#blockaboutprofiles)** | Block access to About Profiles (about:profiles). @@ -19,8 +21,6 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`Certificates -> ImportEnterpriseRoots`](#certificates--importenterpriseroots)** | Trust certificates that have been added to the operating system certificate store by a user or administrator. | **[`Certificates -> Install`](#certificates--install)** | Install certificates into the Firefox certificate store. | **[`Cookies`](#cookies)** | Configure cookie preferences. -| **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image. -| **[`DisableMasterPasswordCreation`](#disablemasterpasswordcreation)** | Remove the master password functionality. | **[`DisableAppUpdate`](#disableappupdate)** | Turn off application updates. | **[`DisableBuiltinPDFViewer`](#disablebuiltinpdfviewer)** | Disable the built in PDF viewer. | **[`DisabledCiphers`](#disabledciphers)** | Disable ciphers. @@ -32,6 +32,7 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`DisableFirefoxStudies`](#disablefirefoxstudies)** | Disable Firefox studies (Shield). | **[`DisableForgetButton`](#disableforgetbutton)** | Disable the "Forget" button. | **[`DisableFormHistory`](#disableformhistory)** | Turn off saving information on web forms and the search bar. +| **[`DisableMasterPasswordCreation`](#disablemasterpasswordcreation)** | Remove the master password functionality. | **[`DisablePasswordReveal`](#disablepasswordreveal)** | Do not allow passwords to be revealed in saved logins. | **[`DisablePocket`](#disablepocket)** | Remove Pocket in the Firefox UI. | **[`DisablePrivateBrowsing`](#disableprivatebrowsing)** | Remove access to private browsing. @@ -39,6 +40,7 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`DisableProfileRefresh`](#disableprofilerefresh)** | Disable the Refresh Firefox button on about:support and support.mozilla.org | **[`DisableSafeMode`](#disablesafemode)** | Disable safe mode within the browser. | **[`DisableSecurityBypass`](#disablesecuritybypass)** | Prevent the user from bypassing security in certain cases. +| **[`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 update. | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar. @@ -62,6 +64,9 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`InstallAddonsPermission`](#installaddonspermission)** | Configure the default extension install policy as well as origins for extension installs are allowed. | **[`LegacyProfiles`](#legacyprofiles)** | Disable the feature enforcing a separate profile for each installation. | **[`LocalFileLinks`](#localfilelinks)** | Enable linking to local files by origin. +| **[`ManagedBookmarks`](#managedbookmarks)** | Configures a list of bookmarks managed by an administrator that cannot be changed by the user. +| **[`ManualAppUpdateOnly`](#manualappupdateonly)** | Allow manual updates only and do not notify the user about updates.. +| **[`PrimaryPassword`](#primarypassword)** | Require or prevent using a primary (formerly master) password. | **[`NetworkPrediction`](#networkprediction)** | Enable or disable network prediction (DNS prefetching). | **[`NewTabPage`](#newtabpage)** | Enable or disable the New Tab page. | **[`NoDefaultBookmarks`](#nodefaultbookmarks)** | Disable the creation of default bookmarks. @@ -74,7 +79,8 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`Permissions`](#permissions)** | Set permissions associated with camera, microphone, location, and notifications. | **[`PictureInPicture`](#pictureinpicture)** | Enable or disable Picture-in-Picture. | **[`PopupBlocking`](#popupblocking)** | Configure the default pop-up window policy as well as origins for which pop-up windows are allowed. -| **[`Preferences`](#preferences)** | Set and lock some preferences. +| **[`Preferences`](#preferences)** | Set and lock preferences. +| **[`Preferences (Deprecated)`](#preferences-deprecated)** | Set and lock some preferences. | **[`PromptForDownloadLocation`](#promptfordownloadlocation)** | Ask where to save each file before downloading. | **[`Proxy`](#proxy)** | Configure proxy settings. | **[`RequestedLocales`](#requestedlocales)** | Set the the list of requested locales for the application in order of preference. @@ -88,17 +94,22 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`SearchEngines -> Add`](#searchengines--add)** | Add new search engines. | **[`SearchSuggestEnabled`](#searchsuggestenabled)** | Enable search suggestions. | **[`SecurityDevices`](#securitydevices)** | Install PKCS #11 modules. +| **[`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. | **[`SupportMenu`](#supportmenu)** | Add a menuitem to the help menu for specifying support information. | **[`UserMessaging`](#usermessaging)** | Don't show certain messages to the user. | **[`WebsiteFilter`](#websitefilter)** | Block websites from being visited. +### 3rdparty + +Allow WebExtensions to configure policy. For more information, see [Adding policy support to your extension](https://extensionworkshop.com/documentation/enterprise/adding-policy-support-to-your-extension/). + ### AppAutoUpdate Enable or disable **automatic** application update. -If set to true, application updates are installed without user approval. +If set to true, application updates are installed without user approval within Firefox. The operating system might still require approval. If set to false, application updates are downloaded but the user can choose when to install the update. @@ -138,7 +149,7 @@ Value (string): ``` ### AppUpdateURL -Change the URL for application update. +Change the URL for application update if you are providing Firefox updates from a custom update server. **Compatibility:** Firefox 62, Firefox ESR 60.2\ **CCK2 Equivalent:** N/A\ @@ -179,7 +190,7 @@ Configure sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information. -`PrivateBrowsing` enables integrated authentication in prviate browsing. +`PrivateBrowsing` enables integrated authentication in private browsing. **Compatibility:** Firefox 60, Firefox ESR 60 (AllowNonFQDN added in 62/60.2, AllowProxies added in 70/68.2, Locked added in 71/68.3, PrivateBrowsing added in 77/68.9)\ **CCK2 Equivalent:** N/A\ @@ -317,6 +328,48 @@ Value (string): } } ``` +### BackgroundAppUpdate + +Enable or disable **automatic** application update **in the background**, when the application is not running. + +If set to true, application updates may be installed (without user approval) in the background, even when the application is not running. The operating system might still require approval. + +If set to false, the application will not try to install updates when the application is not running. + +If you have disabled updates via `DisableAppUpdate` or disabled automatic updates via `AppUpdateAuto`, this policy has no effect. + +**Compatibility:** Firefox 89\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `app.update.background.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\BackgroundAppUpdate = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/BackgroundAppUpdate +``` +Value (string): +``` + or +``` +#### macOS +``` + + BackgroundAppUpdate + | + +``` +#### policies.json +``` +{ + "policies": { + "BackgroundAppUpdate": true | false + } +} +``` ### BlockAboutAddons Block access to the Add-ons Manager (about:addons). @@ -463,6 +516,8 @@ Value (string): ``` ### Bookmarks +Note: [`ManagedBookmarks`](#managedbookmarks) is the new recommended way to add bookmarks. This policy will continue to be supported. + Add bookmarks in either the bookmarks toolbar or menu. Only `Title` and `URL` are required. If `Placement` is not specified, the bookmark will be placed on the toolbar. If `Folder` is specified, it is automatically created and bookmarks with the same folder name are grouped together. **Compatibility:** Firefox 60, Firefox ESR 60\ @@ -679,6 +734,8 @@ Configure cookie preferences. `Allow` is a list of origins (not domains) where cookies are always allowed. You must include http or https. +`AllowSession` is a list of origins (not domains) where cookies are only allowed for the current session. You must include http or https. + `Block` is a list of origins (not domains) where cookies are always blocked. You must include http or https. `Default` determines whether cookies are accepted at all. @@ -691,13 +748,14 @@ Configure cookie preferences. `Locked` prevents the user from changing cookie preferences. -**Compatibility:** Firefox 60, Firefox ESR 60 (RejectTracker was added in Firefox 63)\ +**Compatibility:** Firefox 60, Firefox ESR 60 (RejectTracker added in Firefox 63, AllowSession added in Firefox 79/78.1)\ **CCK2 Equivalent:** N/A\ **Preferences Affected:** `network.cookie.cookieBehavior`,`network.cookie.lifetimePolicy` #### Windows (GPO) ``` Software\Policies\Mozilla\Firefox\Cookies\Allow\1 = "https://example.com" +Software\Policies\Mozilla\Firefox\Cookies\AllowSession\1 = "https://example.edu" Software\Policies\Mozilla\Firefox\Cookies\Block\1 = "https://example.org" Software\Policies\Mozilla\Firefox\Cookies\Default = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\Cookies\AcceptThirdParty = "always" | "never" | "from-visited" @@ -717,6 +775,15 @@ Value (string): ``` OMA-URI: ``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Cookies/Cookies_AllowSession +``` +Value (string): +``` + + +``` +OMA-URI: +``` ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Cookies/Cookies_Block ``` Value (string): @@ -774,6 +841,10 @@ Value (string): http://example.com + AllowSession + + http://example.edu + Block http://example.org @@ -797,6 +868,7 @@ Value (string): "policies": { "Cookies": { "Allow": ["http://example.org/"], + "AllowSession": ["http://example.edu/"], "Block": ["http://example.edu/"], "Default": true | false, "AcceptThirdParty": "always" | "never" | "from-visited", @@ -845,6 +917,10 @@ Value (string): ### DisableMasterPasswordCreation Remove the master password functionality. +If this value is true, it works the same as setting [`PrimaryPassword`](#primarypassword) to false and removes the primary password functionality. + +If both DisableMasterPasswordCreation and PrimaryPassword are used, DisableMasterPasswordCreation takes precedent. + **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** `noMasterPassword`\ **Preferences Affected:** N/A @@ -878,7 +954,7 @@ Value (string): } ``` ### DisableAppUpdate -Turn off application updates. +Turn off application updates within Firefox. **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** `disableFirefoxUpdates`\ @@ -950,6 +1026,8 @@ Value (string): ### DisabledCiphers Disable specific cryptographic ciphers. +**Preferences Affected:** `security.ssl3.dhe_rsa_aes_128_sha`, `security.ssl3.dhe_rsa_aes_256_sha`, `security.ssl3.ecdhe_ecdsa_aes_128_gcm_sha256`, `security.ssl3.ecdhe_rsa_aes_128_gcm_sha256`, `security.ssl3.ecdhe_rsa_aes_128_sha`, `security.ssl3.ecdhe_rsa_aes_256_sha`, `security.ssl3.rsa_aes_128_gcm_sha256`, `security.ssl3.rsa_aes_128_sha`, `security.ssl3.rsa_aes_256_gcm_sha384`, `security.ssl3.rsa_aes_256_sha`, `security.ssl3.rsa_des_ede3_sha` + --- **Note:** @@ -1027,7 +1105,7 @@ Value (string): ``` { "policies": { - "DisabledCiphers" { + "DisabledCiphers": { "TLS_DHE_RSA_WITH_AES_128_CBC_SHA": true | false, "TLS_DHE_RSA_WITH_AES_256_CBC_SHA": true | false, "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": true | false, @@ -1036,8 +1114,8 @@ Value (string): "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256": true | false, "TLS_RSA_WITH_AES_128_CBC_SHA": true | false, "TLS_RSA_WITH_AES_256_CBC_SHA": true | false, - "TLS_RSA_WITH_3DES_EDE_CBC_SHA": true | false - "TLS_RSA_WITH_AES_128_GCM_SHA256": true | false + "TLS_RSA_WITH_3DES_EDE_CBC_SHA": true | false, + "TLS_RSA_WITH_AES_128_GCM_SHA256": true | false, "TLS_RSA_WITH_AES_256_GCM_SHA384": true | false } } @@ -1046,6 +1124,8 @@ Value (string): ### DisableDefaultBrowserAgent Prevent the default browser agent from taking any actions. Only applicable to Windows; other platforms don’t have the agent. +The browser agent is a Windows-only scheduled task which runs in the background to collect and submit data about the browser that the user has set as their OS default. More information is available [here](https://firefox-source-docs.mozilla.org/toolkit/mozapps/defaultagent/default-browser-agent/index.html). + **Compatibility:** Firefox 75, Firefox ESR 68.7 (Windows only)\ **CCK2 Equivalent:** N/A\ **Preferences Affected:** N/A @@ -1569,7 +1649,7 @@ Value (string): InvalidCertificate | - + SafeBrowsing | @@ -1623,11 +1703,13 @@ Value (string): ### DisableTelemetry Prevent the upload of telemetry data. +As of Firefox 83 and Firefox ESR 78.5, local storage of telemetry data is disabled as well. + Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours. **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** `disableTelemetry`\ -**Preferences Affected:** `datareporting.healthreport.uploadEnabled,datareporting.policy.dataSubmissionEnabled` +**Preferences Affected:** `datareporting.healthreport.uploadEnabled,datareporting.policy.dataSubmissionEnabled,toolkit.telemetry.archive.enabled` #### Windows (GPO) ``` @@ -2003,15 +2085,43 @@ Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Exceptions\1 = "https #### Windows (Intune) OMA-URI: ``` -./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/TrackingProtection +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~TrackingProtection/A_TrackingProtection_Value ``` Value (string): ``` - - - - - + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~TrackingProtection/B_TrackingProtection_Cryptomining +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~TrackingProtection/C_TrackingProtection_Fingerprinting +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~TrackingProtection/D_TrackingProtection_Exceptions +``` +Value (string): +``` + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~TrackingProtection/E_TrackingProtection_Locked +``` +Value (string): +``` + or ``` #### macOS ``` @@ -2020,11 +2130,11 @@ Value (string): Value | - + Locked | - + Cryptomining | - + Fingerprinting | Exceptions @@ -2079,7 +2189,7 @@ Value (string): Enabled | - + Locked | @@ -2111,7 +2221,9 @@ Enable policy support on macOS. ### Extensions Control the installation, uninstallation and locking of extensions. -`Install` is a list of URLs or native paths for extensions to be installed. +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. + +`Install` is a list of URLs or native paths for extensions to be installed. `Uninstall` is a list of extension IDs that should be uninstalled if found. @@ -2205,19 +2317,19 @@ The configuration for each extension is another dictionary that can contain the |         `blocked`| Blocks installation of the extension and removes it from the device if already installed. |         `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 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. If installing from the local file system, use a file:/// URL. 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. If you want to allow the install of extensions from the recommended add-ons page, you must add `about:addons` to this list. -| `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", "langpack" This setting can be used only for the default configuration. +| `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. +| `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. -**Compatibility:** Firefox 69, Firefox ESR 68.1\ +**Compatibility:** Firefox 69, Firefox ESR 68.1 (As of Firefox 85, Firefox ESR 78.7, installing a theme makes it the default.)\ **CCK2 Equivalent:** N/A\ **Preferences Affected:** N/A #### Windows (GPO) -``` Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = +``` { "*": { "blocked_install_message": "Custom error message.", @@ -2230,7 +2342,7 @@ 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": { - "installation_mode": "allowed", + "installation_mode": "allowed" } } ``` @@ -2243,6 +2355,7 @@ Value (string): ``` + "installation_mode": "allowed" + } +}'/> ``` #### macOS ``` @@ -2329,7 +2443,7 @@ Software\Policies\Mozilla\Firefox\ExtensionUpdate = 0x1 | 0x0 #### Windows (Intune) OMA-URI: ``` -./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/ExtensionUpdate +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/ExtensionUpdate ``` Value (string): ``` @@ -2455,8 +2569,8 @@ Within each handler type, you specify the given mimeType/extension/scheme as a k **Preferences Affected:** N/A #### Windows (GPO) +Software\Policies\Mozilla\Firefox\Handlers (REG_MULTI_SZ) = ``` -Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = { "mimeTypes": { "application/msword": { @@ -2728,7 +2842,7 @@ Configure the default homepage and how Firefox starts. `StartPage` is how Firefox starts. The choices are no homepage, the default homepage or the previous session. -With Firefox 78, an additional option as added for `Startpage`, `homepage-locked`. This allows for locking the homepage, but still allowing the user to choose whether or not they want to restore their session. +With Firefox 78, an additional option as added for `Startpage`, `homepage-locked`. If this is value is set for the Startpage, the user will always get the homepage at startup and cannot choose to restore their session. **Compatibility:** Firefox 60, Firefox ESR 60 (StartPage was added in Firefox 60, Firefox ESR 60.4, homepage-locked added in Firefox 78)\ **CCK2 Equivalent:** `homePage`,`lockHomePage`\ @@ -2936,6 +3050,227 @@ Value (string): } } ``` +### ManagedBookmarks +Configures a list of bookmarks managed by an administrator that cannot be changed by the user. + +The bookmarks are only added as a button on the personal toolbar. They are not in the bookmarks folder. + +The syntax of this policy is exactly the same as the [Chrome ManagedBookmarks policy](https://cloud.google.com/docs/chrome-enterprise/policies/?policy=ManagedBookmarks). The schema is: +``` +{ + "items": { + "id": "BookmarkType", + "properties": { + "children": { + "items": { + "$ref": "BookmarkType" + }, + "type": "array" + }, + "name": { + "type": "string" + }, + "toplevel_name": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" +} +``` +**Compatibility:** Firefox 83, Firefox ESR 78.5\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows (GPO) +Software\Policies\Mozilla\Firefox\ManagedBookmarks (REG_MULTI_SZ) = +``` +[ + { + "toplevel_name": "My managed bookmarks folder" + }, + { + "url": "example.com", + "name": "Example" + }, + { + "name": "Mozilla links", + "children": [ + { + "url": "https://mozilla.org", + "name": "Mozilla.org" + }, + { + "url": "https://support.mozilla.org/", + "name": "SUMO" + } + ] + } +] +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/ManagedBookmarks +``` +Value (string): +``` + + +``` +#### macOS +``` + + ManagedBookmarks + + + toplevel_name + My managed bookmarks folder + + url + example.com + name + Example + + + name + Mozilla links + children + + + url + https://mozilla.org + name + Mozilla + + + url + https://support.mozilla.org/ + name + SUMO + + + + + +``` +#### policies.json +``` +{ + "policies": { + "ManagedBookmarks": [ + { + "toplevel_name": "My managed bookmarks folder" + }, + { + "url": "example.com", + "name": "Example" + }, + { + "name": "Mozilla links", + "children": [ + { + "url": "https://mozilla.org", + "name": "Mozilla.org" + }, + { + "url": "https://support.mozilla.org/", + "name": "SUMO" + } + ] + } + ] + } +} +``` +### ManualAppUpdateOnly + +Switch to manual updates only. + +If this policy is enabled: + 1. The user will never be prompted to install updates + 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. + +**Compatibility:** Firefox 87\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### policies.json +``` +{ + "policies": { + "ManualAppUpdateOnly": true | false + } +} +``` +### PrimaryPassword +Require or prevent using a primary (formerly master) password. + +If this value is true, a primary password is required. If this value is false, it works the same as if [`DisableMasterPasswordCreation`](#disablemasterpasswordcreation) was true and removes the primary password functionality. + +If both DisableMasterPasswordCreation and PrimaryPassword are used, DisableMasterPasswordCreation takes precedent. + +**Compatibility:** Firefox 79, Firefox ESR 78.1\ +**CCK2 Equivalent:** `noMasterPassword`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\PrimaryPassword = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/PrimaryPassword +``` +Value (string): +``` + or +``` +#### macOS +``` + + PrimaryPassword + | + +``` +#### policies.json +``` +{ + "policies": { + "PrimaryPassword": true | false + } +} +``` ### NetworkPrediction Enable or disable network prediction (DNS prefetching). @@ -3112,7 +3447,9 @@ Value (string): } ``` ### OverrideFirstRunPage -Override the first run page. If the value is blank, no first run page is displayed. +Override the first run page. If the value is an empty string (""), the first run page is not displayed. + +Starting with Firefox 83, Firefox ESR 78.5, you can also specify multiple URLS separated by a vertical bar (|). **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** `welcomePage`,`noWelcomePage`\ @@ -3147,7 +3484,7 @@ Value (string): } ``` ### OverridePostUpdatePage -Override the upgrade page. If the value is blank, no upgrade page is displayed. +Override the upgrade page. If the value is an empty string (""), no extra pages are displayed when Firefox is upgraded. **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** `upgradePage`,`noUpgradePage`\ @@ -3251,7 +3588,7 @@ Value (string): Enabled | - + EnablePermissions | @@ -3267,7 +3604,7 @@ Value (string): } ``` ### Permissions -Set permissions associated with camera, microphone, location, notifications, and autoplay. Because these are origins, not domains, entries with unique ports must be specified separately. See examples below. +Set permissions associated with camera, microphone, location, notifications, autoplay, and virtual reality. Because these are origins, not domains, entries with unique ports must be specified separately. This explicitly means that it is not possible to add wildcards. See examples below. `Allow` is a list of origins where the feature is allowed. @@ -3279,9 +3616,9 @@ Set permissions associated with camera, microphone, location, notifications, and `Default` specifies the default value for Autoplay. block-audio-video is not supported on Firefox ESR 68. -**Compatibility:** Firefox 62, Firefox ESR 60.2 (Autoplay added in Firefox 74, Firefox ESR 68.6, Autoplay Default/Locked added in Firefox 76, Firefox ESR 68.8)\ +**Compatibility:** Firefox 62, Firefox ESR 60.2 (Autoplay added in Firefox 74, Firefox ESR 68.6, Autoplay Default/Locked added in Firefox 76, Firefox ESR 68.8, VirtualReality added in Firefox 80, Firefox ESR 78.2)\ **CCK2 Equivalent:** N/A\ -**Preferences Affected:** `permissions.default.camera`,`permissions.default.microphone`,`permissions.default.geo`,`permissions.default.desktop-notification`,`media.autoplay.default` +**Preferences Affected:** `permissions.default.camera`,`permissions.default.microphone`,`permissions.default.geo`,`permissions.default.desktop-notification`,`media.autoplay.default`.`permissions.default.xr` #### Windows (GPO) ``` @@ -3306,6 +3643,10 @@ Software\Policies\Mozilla\Firefox\Permissions\Autoplay\Allow\1 = "https://exampl Software\Policies\Mozilla\Firefox\Permissions\Autoplay\Block\1 = "https://example.edu" Software\Policies\Mozilla\Firefox\Permissions\Autoplay\Default = "allow-audio-video" | "block-audio" | "block-audio-video" Software\Policies\Mozilla\Firefox\Permissions\Autoplay\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\VirtualReality\Allow\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\Permissions\VirtualReality\Block\1 = "https://example.edu" +Software\Policies\Mozilla\Firefox\Permissions\VirtualReality\BlockNewRequests = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\VirtualReality\Locked = 0x1 | 0x0 ``` #### Windows (Intune) OMA-URI: @@ -3384,6 +3725,40 @@ Value (string): ``` or ``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Permissions~Notifications/VirtualReality_Allow +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Permissions~Notifications/VirtualReality_Block +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Permissions~Notifications/VirtualReality_BlockNewRequests +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Permissions~Notifications/VirtualReality_Locked +``` +Value (string): +``` + or +``` #### macOS ``` @@ -3509,7 +3884,7 @@ Value (string): ``` ### PictureInPicture -Enable or disable Picture-in-Picture. +Enable or disable Picture-in-Picture as well as prevent the user from enabling or disabling it (Locked). **Compatibility:** Firefox 78, Firefox ESR 78\ **CCK2 Equivalent:** N/A\ @@ -3517,12 +3892,15 @@ Enable or disable Picture-in-Picture. #### Windows (GPO) ``` -Software\Policies\Mozilla\Firefox\PictureInPicture = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\PictureInPicture\Enabled = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\PictureInPicture\Locked = 0x1 | 0x0 + ``` #### Windows (Intune) OMA-URI: ``` -./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/PictureInPicture +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~PictureInPicture/PictureInPicture_Enabled +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~PictureInPicture/PictureInPicture_Locked ``` Value (string): ``` @@ -3532,14 +3910,22 @@ Value (string): ``` PictureInPicture - | + + Enabled + | + Locked + | + ``` #### policies.json ``` { "policies": { - "PictureInPicture": true | false + "PictureInPicture": { + "Enabled": true | false, + "Locked": true, false + } } } ``` @@ -3620,6 +4006,174 @@ Value (string): } ``` ### Preferences +Set and lock preferences. + +**NOTE** On Windows, in order to use this policy, you must clear all settings in the old **Preferences (Deprecated)** section. + +Previously you could only set and lock a subset of preferences. Starting with Firefox 81 and Firefox ESR 78.3 you can set many more preferences. You can also set default preferences, user preferences and you can clear preferences. + +Preferences that start with the following prefixes are supported: +``` +accessibility. +app.update.* (Firefox 86, Firefox 78.8) +browser. +datareporting.policy. +dom. +extensions. +general.autoScroll (Firefox 83, Firefox ESR 78.5) +general.smoothScroll (Firefox 83, Firefox ESR 78.5) +geo. +intl. +layout. +media. +network. +pdfjs. (Firefox 84, Firefox ESR 78.6) +places. +print. +signon. (Firefox 83, Firefox ESR 78.5) +spellchecker. (Firefox 84, Firefox ESR 78.6) +ui. +widget. +``` +as well as the following security preferences: +| Preference | Type | Default +| --- | --- | --- +| security.default_personal_cert | string | Ask Every Time +|     If set to Select Automatically, Firefox automatically chooses the default personal certificate. +| security.insecure_connection_text.enabled | bool | false +|     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.ssl.errorReporting.enabled | boolean | true +|     If false, SSL errors cannot be sent to Mozilla. +| security.tls.hello_downgrade_check | boolean | true +|     If false, the TLS 1.3 downgrade check is disabled. +| security.tls.version.enable-deprecated | boolean | false +|     If true, browser will accept TLS 1.0. and TLS 1.1 (Firefox 86, Firefox 78.8) +| security.warn_submit_secure_to_insecure | boolean | true +|     If false, no warning is shown when submitting s form from https to http. +  + +Using the preference as the key, set the `Value` to the corresponding preference value. + +`Status` can be "default", "locked", "user" or "clear" + +Default preferences can be modified by the user. + +If a value is locked, it is also set as the default. + +User preferences persist across invocations of Firefox. It is the equivalent of a user setting the preference. They are most useful when a preference is needed very early in startup so it can't be set as default by policy. + +User preferences persist even if the policy is removed, so if you need to remove them, you should use the clear policy. + +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. + +Status +**Compatibility:** Firefox 81, Firefox ESR 78.3\ +**CCK2 Equivalent:** `preferences`\ +**Preferences Affected:** Many + +#### Windows (GPO) +Software\Policies\Mozilla\Firefox\Preferences (REG_MULTI_SZ) = +``` +{ + "accessibility.force_disabled": { + "Value": 1, + "Status": "default" + }, + "browser.cache.disk.parent_directory": { + "Value": "SOME_NATIVE_PATH", + "Status": "user" + }, + "browser.tabs.warnOnClose": { + "Value": false, + "Status": "locked" + } +} +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/Preferences +``` +Value (string): +``` + + +``` +#### macOS +``` + + Preferences + + accessibility.force_disabled + + Value + 1 + Status + default + + browser.cache.disk.parent_directory + + Value + SOME_NATIVE_PATH + Status + user + + browser.tabs.warnOnClose + + Value + + Status + locked + + + +``` +#### policies.json +``` +{ + "policies": { + "Preferences": { + "accessibility.force_disabled": { + "Value": 1, + "Status": "default" + }, + "browser.cache.disk.parent_directory": { + "Value": "SOME_NATIVE_PATH", + "Status": "user" + }, + "browser.tabs.warnOnClose": { + "Value": false, + "Status": "locked" + } + } + } +} +``` +### Preferences (Deprecated) Set and lock certain preferences. **Compatibility:** See below\ @@ -3645,7 +4199,7 @@ Set and lock certain preferences. | browser.fixup.dns_first_for_single_words | boolean | Firefox 68, Firefox ESR 68 | false |     If true, single words are sent to DNS, not directly to search. | browser.newtabpage.activity-stream.default.sites | string | Firefox 72, ESR 68.4 | Locale dependent -|     If set, a list of URLs to use as the default top sites on the new tab page. +|     If set, a list of URLs to use as the default top sites on the new tab page. Due to Firefox limitations, search sites can't be added. In addition, sites with the same name but different TLDs (example.org/example.com) will not display properly. | browser.places.importBookmarksHTML | boolean | Firefox 70, Firefox ESR 68.2 |     If true, bookmarks are always imported on startup. | browser.safebrowsing.phishing.enabled | boolean | Firefox 70, Firefox ESR 68.2 | true @@ -3711,7 +4265,7 @@ disabled | network.dns.disableIPv6 | boolean | Firefox 68, Firefox ESR 68 | false |     If true, IPv6 DNS lokoups are disabled. | network.IDN_show_punycode | boolean | Firefox 68, Firefox ESR 68 | false -|     If true, display the punycode version of internationalized domain names. +|     If true, display the punycode version of internationalized domain names. | places.history.enabled | boolean | Firefox 68, Firefox ESR 68 | true |     If false, history is not enabled. | print.save_print_settings | boolean | Firefox 70, Firefox ESR 68.2 | true @@ -3845,7 +4399,7 @@ To specify ports, append them to the hostnames with a colon (:). #### Windows (GPO) ``` -Software\Policies\Mozilla\Firefox\Proxy\Mode = "none", "system", "manual", "autoDetect", "autoConfig" +Software\Policies\Mozilla\Firefox\Proxy\Mode = "none" | "system" | "manual" | "autoDetect" | "autoConfig" Software\Policies\Mozilla\Firefox\Proxy\Locked = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\=Proxy\HTTPProxy = https://httpproxy.example.com Software\Policies\Mozilla\Firefox\Proxy\UseHTTPProxyForAllProtocols = 0x1 | 0x0 @@ -3916,7 +4470,7 @@ Value (string): { "policies": { "Proxy": { - "Mode": "none", "system", "manual", "autoDetect", "autoConfig", + "Mode": "none" | "system" | "manual" | "autoDetect" | "autoConfig", "Locked": true | false, "HTTPProxy": "hostname", "UseHTTPProxyForAllProtocols": true | false, @@ -4018,6 +4572,70 @@ Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Locked = 0x1 | 0x0 #### Windows (Intune) OMA-URI: ``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/A_SanitizeOnShutdown_Cache +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/B_SanitizeOnShutdown_Cookies +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/C_SanitizeOnShutdown_Downloads +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/D_SanitizeOnShutdown_FormData +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/E_SanitizeOnShutdown_History +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/F_SanitizeOnShutdown_Sessions +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/G_SanitizeOnShutdown_SiteSettings +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/H_SanitizeOnShutdown_OfflineApps +``` +Value (string): +``` + or +``` +OMA-URI: +``` ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/I_SanitizeOnShutdown_Locked ``` Value (string): @@ -4387,7 +5005,7 @@ Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0 #### Windows (Intune) OMA-URI: ``` -./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/SearchSuggestEnabled +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Search/SearchSuggestEnabled ``` Value (string): ``` @@ -4451,6 +5069,43 @@ Value (string): } } ``` +### ShowHomeButton +Show the home button on the toolbar. + +Future versions of Firefox will not show the home button by default. + +**Compatibility:** Firefox 88, Firefox ESR 78.10\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\ShowHomeButton = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/ShowHomeButton +``` +Value (string): +``` + or +``` +#### macOS +``` + + ShowHomeButton + | + +``` +#### policies.json +``` +{ + "policies": { + "ShowHomeButton": true | false + } +} +``` ### SSLVersionMax Set and lock the maximum version of TLS. @@ -4580,19 +5235,21 @@ Value (string): ``` ### UserMessaging -Prevent installing search engines from webpages. +Prevent Firefox from messaging the user in certain situations. -`WhatsNew` Remove the "What's New" icon and menuitem. (Firefox 75 only) +`WhatsNew` Remove the "What's New" icon and menuitem. -`ExtensionRecommendations` Don't recommend extensions. +`ExtensionRecommendations` If false, don't recommend extensions while the user is visiting web pages. -`FeatureRecommendations` Don't recommend browser features. +`FeatureRecommendations` IF false, don't recommend browser features. -`UrlbarInterventions` Don't offer Firefox specific suggestions in the URL bar. (Firefox 75 only) +`UrlbarInterventions` If false, Don't offer Firefox specific suggestions in the URL bar. + +`SkipOnboarding` If true, don't show onboarding messages on the new tab page. **Compatibility:** Firefox 75, Firefox ESR 68.7\ **CCK2 Equivalent:** N/A\ -**Preferences Affected:** `browser.messaging-system.whatsNewPanel.enabled`,`browser.newtabpage.activity-stream.asrouter.userprefs.cfr.addons`,`browser.newtabpage.activity-stream.asrouter.userprefs.cfr.features` +**Preferences Affected:** `browser.messaging-system.whatsNewPanel.enabled`,`browser.newtabpage.activity-stream.asrouter.userprefs.cfr.addons`,`browser.newtabpage.activity-stream.asrouter.userprefs.cfr.features`,`browser.aboutwelcome.enabled` #### Windows (GPO) ``` @@ -4600,6 +5257,7 @@ Software\Policies\Mozilla\Firefox\UserMessaging\WhatsNew = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\UserMessaging\ExtensionRecommendations = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\UserMessaging\FeatureRecommendations = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\UserMessaging\UrlbarInterventions = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\UserMessaging\SkipOnboarding = 0x1 | 0x0 ``` #### Windows (Intune) OMA-URI: @@ -4608,6 +5266,7 @@ OMA-URI: ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/UserMessaging_ExtensionRecommendations ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/UserMessaging_FeatureRecommendations ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/UserMessaging_UrlbarInterventions +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/UserMessaging_SkipOnboarding ``` Value (string): ``` @@ -4626,6 +5285,8 @@ Value (string): | UrlbarInterventions | + SkipOnboarding + | ``` @@ -4638,12 +5299,16 @@ Value (string): "ExtensionRecommendations": true | false, "FeatureRecommendations": true | false, "UrlbarInterventions": true | false + "SkipOnboarding": true | false } } } ``` ### WebsiteFilter -Block websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. Only http/https addresses are supported at the moment. The arrays are limited to 1000 entries each. +Block websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. +The arrays are limited to 1000 entries each. + +As of Firefox 83 and Firefox ESR 78.5, file URLs are supported. **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** N/A\