X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/0758105e0e9a42302e2530294f676e141d8aedda..4647126c83bd6eecccfa287fa8d0405b45de5e13:/README.md?ds=sidebyside diff --git a/README.md b/README.md index dfa49c9..4b85d07 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ 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. | **[`BlockAboutAddons`](#blockaboutaddons)** | Block access to the Add-ons Manager (about:addons). @@ -62,6 +63,7 @@ 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. | **[`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. @@ -96,11 +98,15 @@ Policies can be specified using the [Group Policy templates on Windows](https:// | **[`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. @@ -140,7 +146,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\ @@ -465,6 +471,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\ @@ -901,7 +909,7 @@ Value (string): } ``` ### DisableAppUpdate -Turn off application updates. +Turn off application updates within Firefox. **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** `disableFirefoxUpdates`\ @@ -1050,7 +1058,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, @@ -1059,8 +1067,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 } } @@ -1069,6 +1077,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 @@ -1646,11 +1656,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) ``` @@ -2162,6 +2174,8 @@ Enable policy support on macOS. ### 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. + `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. @@ -2256,19 +2270,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. +| `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.", @@ -2508,8 +2522,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) = +``` { "mimeTypes": { "application/msword": { @@ -2781,7 +2795,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`\ @@ -2989,6 +3003,165 @@ 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" + } + ] + } + ] + } +} +``` ### PrimaryPassword Require or prevent using a primary (formerly master) password. @@ -3204,7 +3377,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`\ @@ -3239,7 +3414,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`\ @@ -3639,7 +3814,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\ @@ -3647,12 +3822,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): ``` @@ -3662,14 +3840,22 @@ Value (string): ``` PictureInPicture - | + + Enabled + | + Locked + | + ``` #### policies.json ``` { "policies": { - "PictureInPicture": true | false + "PictureInPicture": { + "Enabled": true | false, + "Locked": true, false + } } } ``` @@ -3752,37 +3938,58 @@ 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: -``` -security.default_personal_cert -security.insecure_connection_text.enabled -security.insecure_connection_text.pbmode.enabled -security.insecure_field_warning.contextual.enabled -security.mixed_content.block_active_content -security.osclientcerts.autoload -security.ssl.errorReporting.enabled -security.tls.hello_downgrade_check -security.warn_submit_secure_to_insecure -``` +| 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" @@ -3805,8 +4012,8 @@ Status **Preferences Affected:** Many #### Windows (GPO) -``` Software\Policies\Mozilla\Firefox\Preferences (REG_MULTI_SZ) = +``` { "accessibility.force_disabled": { "Value": 1, @@ -3830,7 +4037,7 @@ OMA-URI: 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): @@ -4920,7 +5191,10 @@ Value (string): } ``` ### 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\