X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/e0e0f4346a774542d6d867868463b49d99ee1081..40e626d79ba59a3011de3170f0d86b5140b4c667:/README.md?ds=inline diff --git a/README.md b/README.md index 4216c47..2ffe598 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,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 +30,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 +38,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. @@ -75,7 +75,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. @@ -180,7 +181,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\ @@ -863,6 +864,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 @@ -2021,15 +2026,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 ``` @@ -2225,7 +2258,7 @@ The configuration for each extension is another dictionary that can contain the |         `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. +| `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. @@ -2261,6 +2294,7 @@ Value (string): ``` + } +}'/> ``` #### macOS ``` @@ -2347,7 +2382,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): ``` @@ -2474,7 +2509,7 @@ Within each handler type, you specify the given mimeType/extension/scheme as a k #### Windows (GPO) ``` -Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = +Software\Policies\Mozilla\Firefox\Handlers (REG_MULTI_SZ) = { "mimeTypes": { "application/msword": { @@ -2957,7 +2992,9 @@ Value (string): ### 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 `DisableMasterPasswordCreation` and removes the primary password functionality. +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`\ @@ -3322,7 +3359,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. See examples below. `Allow` is a list of origins where the feature is allowed. @@ -3334,9 +3371,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) ``` @@ -3361,6 +3398,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: @@ -3439,6 +3480,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 ``` @@ -3675,6 +3750,151 @@ Value (string): } ``` ### Preferences +Set and lock preferences. + +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. +browser. +datareporting.policy. +dom. +extensions. +geo. +intl. +layout. +media. +network. +places. +print. +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 +``` +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 a default by 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\ @@ -3700,7 +3920,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 @@ -3900,7 +4120,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 @@ -3971,7 +4191,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, @@ -4442,7 +4662,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): ``` @@ -4635,11 +4855,11 @@ 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) -`ExtensionRecommendations` Don't recommend extensions. +`ExtensionRecommendations` Don't recommend extensions while the user is visiting web pages. `FeatureRecommendations` Don't recommend browser features.