X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/3c7696d8b11f98428941004f7137d468d350f6db..3e0b841565f8ecc9a691bef81d87b36eb116198d:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 5dbf334..dfa49c9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ **These policies are in active development and so might contain changes that do not work with current versions of Firefox.** -**You should use the officially released versions (https://github.com/mozilla/policy-templates/releases) if you are deploying changes.** +**You should use the [officially released versions](https://github.com/mozilla/policy-templates/releases) if you are deploying changes.** -Policies can be specified using the Group Policy templates on Windows (https://github.com/mozilla/policy-templates/tree/master/windows), 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. +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`. | Policy Name | Description | --- | --- | @@ -19,8 +19,6 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`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://g | **[`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://g | **[`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. @@ -49,6 +49,7 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`DefaultDownloadDirectory`](#defaultdownloaddirectory)** | Set the default download directory. | **[`DownloadDirectory`](#downloaddirectory)** | Set and lock the download directory. | **[`EnableTrackingProtection`](#enabletrackingprotection)** | Configure tracking protection. +| **[`EncryptedMediaExtensions`](#encryptedmediaextensions)** | Enable or disable Encrypted Media Extensions and optionally lock it. | **[`EnterprisePoliciesEnabled`](#enterprisepoliciesenabled)** | Enable policy support on macOS. | **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking of extensions. | **[`ExtensionSettings`](#extensionsettings)** | Manage all aspects of extensions. @@ -56,10 +57,12 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`FlashPlugin`](#flashplugin)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed. | **[`FirefoxHome`](#firefoxhome)** | Customize the Firefox Home page. | **[`HardwareAcceleration`](#hardwareacceleration)** | Control hardware acceleration. +| **[`Handlers`](#handlers)** | Configure default application handlers. | **[`Homepage`](#homepage)** | Configure the default homepage and how Firefox starts. | **[`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. +| **[`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. @@ -68,9 +71,12 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`OverrideFirstRunPage`](#overridefirstrunpage)** | Override the first run page. | **[`OverridePostUpdatePage`](#overridepostupdatepage)** | Override the upgrade page. | **[`PasswordManagerEnabled`](#passwordmanagerenabled)** | Remove (some) access to the password manager. +| **[`PDFjs`](#pdfjs)** | Disable or configure PDF.js, the built-in PDF viewer. | **[`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. @@ -175,9 +181,11 @@ Configure sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information. -**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` 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\ -**Preferences Affected:** `network.negotiate-auth.trusted-uris`,`network.negotiate-auth.delegation-uris`,`network.automatic-ntlm-auth.trusted-uris`,`network.automatic-ntlm-auth.allow-non-fqdn`,`network.negotiate-auth.allow-non-fqdn`,`network.automatic-ntlm-auth.allow-proxies`,`network.negotiate-auth.allow-proxies` +**Preferences Affected:** `network.negotiate-auth.trusted-uris`,`network.negotiate-auth.delegation-uris`,`network.automatic-ntlm-auth.trusted-uris`,`network.automatic-ntlm-auth.allow-non-fqdn`,`network.negotiate-auth.allow-non-fqdn`,`network.automatic-ntlm-auth.allow-proxies`,`network.negotiate-auth.allow-proxies`,`network.auth.private-browsing-sso` #### Windows (GPO) ``` @@ -192,6 +200,7 @@ Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\NTLM = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\Authentication\AllowProxies\SPNEGO = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\Authentication\AllowProxies\NTLM = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\Authentication\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Authentication\PrivateBrowsing = 0x1 | 0x0 ``` #### Windows (Intune) OMA-URI: @@ -233,12 +242,19 @@ Value (string): ``` OMA-URI: ``` -./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Homepage/HomepageStartPage +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Authentication/Authentication_Locked ``` Value (string): ``` - - + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Authentication/Authentication_PrivateBrowsing +``` +Value (string): +``` + or ``` #### macOS ``` @@ -276,6 +292,8 @@ Value (string): Locked | + PrivateBrowsing + | ``` @@ -295,7 +313,8 @@ Value (string): "SPNEGO": true | false, "NTLM": true | false }, - "Locked": true | false + "Locked": true | false, + "PrivateBrowsing": true | false } } } @@ -551,6 +570,8 @@ Value (string): Trust certificates that have been added to the operating system certificate store by a user or administrator. +Note: This policy only works on Windows and macOS. For Linux discussion, see [bug 1600509](https://bugzilla.mozilla.org/show_bug.cgi?id=1600509). + See https://support.mozilla.org/kb/setting-certificate-authorities-firefox for more detail. **Compatibility:** Firefox 60, Firefox ESR 60 (macOS support in Firefox 63, Firefox ESR 68)\ @@ -660,6 +681,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. @@ -672,13 +695,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" @@ -698,6 +722,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): @@ -755,6 +788,10 @@ Value (string): http://example.com + AllowSession + + http://example.edu + Block http://example.org @@ -778,6 +815,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", @@ -826,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 @@ -931,7 +973,13 @@ Value (string): ### DisabledCiphers Disable specific cryptographic ciphers. -**Compatibility:** Firefox 76, Firefox ESR 68.8\ +--- +**Note:** + +This policy was updated in Firefox 78 to allow enabling ciphers as well. Setting the value to true disables the cipher, setting the value to false enables the cipher. Previously setting the value to true or false disabled the cipher. + +--- +**Compatibility:** Firefox 76, Firefox ESR 68.8 (TLS_RSA_WITH_AES_128_GCM_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384 were added in Firefox 78)\ **CCK2 Equivalent:** N/A\ **Preferences Affected:** N/A @@ -946,6 +994,8 @@ Software\Policies\Mozilla\Firefox\DisabledCiphers\TLS_ECDHE_ECDSA_WITH_AES_128_G Software\Policies\Mozilla\Firefox\DisabledCiphers\TLS_RSA_WITH_AES_128_CBC_SHA = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\DisabledCiphers\TLS_RSA_WITH_AES_256_CBC_SHA = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\DisabledCiphers\TLS_RSA_WITH_3DES_EDE_CBC_SHA = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\DisabledCiphers\TLS_RSA_WITH_AES_128_GCM_SHA256 = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\DisabledCiphers\TLS_RSA_WITH_AES_256_GCM_SHA384 = 0x1 | 0x0 ``` #### Windows (Intune) OMA-URI: @@ -959,6 +1009,8 @@ OMA-URI: ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~DisabledCiphers/DisabledCiphers_TLS_RSA_WITH_AES_128_CBC_SHA ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~DisabledCiphers/DisabledCiphers_TLS_RSA_WITH_AES_256_CBC_SHA ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~DisabledCiphers/DisabledCiphers_TLS_RSA_WITH_3DES_EDE_CBC_SHA +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~DisabledCiphers/DisabledCiphers_TLS_RSA_WITH_AES_128_GCM_SHA256 +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~DisabledCiphers/DisabledCiphers_TLS_RSA_WITH_AES_256_GCM_SHA384 ``` Value (string): ``` @@ -987,6 +1039,10 @@ Value (string): | TLS_RSA_WITH_3DES_EDE_CBC_SHA | + TLS_RSA_WITH_AES_128_GCM_SHA256 + | + TLS_RSA_WITH_AES_256_GCM_SHA384 + | ``` @@ -1004,6 +1060,8 @@ Value (string): "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_AES_256_GCM_SHA384": true | false } } } @@ -1534,7 +1592,7 @@ Value (string): InvalidCertificate | - + SafeBrowsing | @@ -1544,8 +1602,8 @@ Value (string): { "policies": { "DisableSecurityBypass": { - "InvalidCertificate": true false, - "SafeBrowsing": true false + "InvalidCertificate": true | false, + "SafeBrowsing": true | false } } } @@ -1968,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 ``` @@ -1985,11 +2071,11 @@ Value (string): Value | - + Locked | - + Cryptomining | - + Fingerprinting | Exceptions @@ -2003,14 +2089,62 @@ Value (string): { "policies": { "EnableTrackingProtection": { - "Value": [true, false], - "Locked": [true, false], - "Cryptomining": [true, false], - "Fingerprinting": [true, false], + "Value": true | false, + "Locked": true | false, + "Cryptomining": true | false, + "Fingerprinting": true | false, "Exceptions": ["https://example.com"] } } ``` +### EncryptedMediaExtensions +Enable or disable Encrypted Media Extensions and optionally lock it. + +If `Enabled` is set to false, encrypted media extensions (like Widevine) are not downloaded by Firefox unless the user consents to installing them. + +If `Locked` is set to true and `Enabled` is set to false, Firefox will not download encrypted media extensions (like Widevine) or ask the user to install them. + +**Compatibility:** Firefox 77, Firefox ESR 68.9\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `media.eme.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\EncryptedMediaExtensions\Enabled = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\EncryptedMediaExtensions\Locked = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~EncryptedMediaExtensions/EncryptedMediaExtensions_Enabled +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~EncryptedMediaExtensions/EncryptedMediaExtensions_Locked +``` +Value (string): +``` +or +``` +#### macOS +``` + + EncryptedMediaExtensions + + Enabled + | + Locked + | + + +``` +#### policies.json +``` +{ + "policies": { + "EncryptedMediaExtensions": { + "Enabled": true | false, + "Locked": true | false + } +} +``` ### EnterprisePoliciesEnabled Enable policy support on macOS. @@ -2045,6 +2179,34 @@ Software\Policies\Mozilla\Firefox\Extensions\Install\2 = "//path/to/xpi" Software\Policies\Mozilla\Firefox\Extensions\Uninstall\1 = "bad_addon_id@mozilla.org" Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org" ``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/Extensions_Install +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/Extensions_Uninstall +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/Extensions_Locked +``` +Value (string): +``` + + +``` #### macOS ``` @@ -2083,21 +2245,22 @@ Manage all aspects of extensions. This policy is based heavily on the [Chrome po This policy maps an extension ID to its configuration. With an extension ID, the configuration will be applied to the specified extension only. A default configuration can be set for the special ID "*", which will apply to all extensions that don't have a custom configuration set in this policy. -To obtain an extension ID, install the extension and go to about:support. You will see the ID in the Extensions section. +To obtain an extension ID, install the extension and go to about:support. You will see the ID in the Extensions section. I've also created an extension that makes it easy to find the ID of extensions on AMO. You can download it [here](https://github.com/mkaply/queryamoid/releases/tag/v0.1). The configuration for each extension is another dictionary that can contain the fields documented below. | Name | Description | | --- | --- | | `installation_mode` | Maps to a string indicating the installation mode for the extension. The valid strings are `allowed`,`blocked`,`force_installed`, and `normal_installed`. -|         `allowed` | Allows the extension to be installed by the user. This is the default behavior. +|         `allowed` | Allows the extension to be installed by the user. This is the default behavior. There is no need for an install_url; it will automatically be allowed based on the ID. |         `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. -| `install_sources` | 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", "langpack" 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. +| `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", "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\ **CCK2 Equivalent:** N/A\ @@ -2109,13 +2272,16 @@ Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = { "*": { "blocked_install_message": "Custom error message.", - "install_sources": ["https://addons.mozilla.org/"], + "install_sources": ["about:addons","https://addons.mozilla.org/"], "installation_mode": "blocked", "allowed_types": ["extension"] }, "uBlock0@raymondhill.net": { "installation_mode": "force_installed", "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi" + }, + "https-everywhere@eff.org": { + "installation_mode": "allowed", } } ``` @@ -2128,16 +2294,21 @@ Value (string): ``` + "blocked_install_message": "Custom error message.", + "install_sources": ["about:addons","https://addons.mozilla.org/"], + "installation_mode": "blocked", + "allowed_types": ["extension"] + }, + "uBlock0@raymondhill.net": { + "installation_mode": "force_installed", + "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi" + }, + "https-everywhere@eff.org": { + "installation_mode": "allowed", + } +}'/> ``` #### macOS ``` @@ -2150,6 +2321,7 @@ Value (string): Custom error message. install_sources + about:addons https://addons.mozilla.org/ installation_mode @@ -2166,6 +2338,11 @@ Value (string): install_url https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi + https-everywhere@eff.org + + installation_mode + allowed + ``` @@ -2176,13 +2353,16 @@ Value (string): "ExtensionSettings": { "*": { "blocked_install_message": "Custom error message.", - "install_sources": ["https://addons.mozilla.org/"], + "install_sources": ["about:addons","https://addons.mozilla.org/"], "installation_mode": "blocked", "allowed_types": ["extension"] }, "uBlock0@raymondhill.net": { "installation_mode": "force_installed", "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi" + }, + "https-everywhere@eff.org": { + "installation_mode": "allowed" } } } @@ -2202,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): ``` @@ -2304,6 +2484,191 @@ Value (string): } } ``` + + + +### Handlers +Configure default application handlers. This policy is based on the internal format of `handlers.json`. + +You can configure handlers based on a mime type (`mimeTypes`), a file's extension (`extensions`), or a protocol (`schemes`). + +Within each handler type, you specify the given mimeType/extension/scheme as a key and use the following subkeys to describe how it is handled. + +| Name | Description | +| --- | --- | +| `action`| Can be either `saveToDisk`, `useHelperApp`, `useSystemDefault`. +| `ask` | If `true`, the user is asked if what they want to do with the file. If `false`, the action is taken without user intervention. +| `handlers` | An array of handlers with the first one being the default. If you don't want to have a default handler, use an empty object for the first handler. Choose between path or uriTemplate. +|         `name` | The display name of the handler (might not be used). +|         `path`| The native path to the executable to be used. +|         `uriTemplate`| A url to a web based application handler. The URL must be https and contain a %s to be used for substitution. + +**Compatibility:** Firefox 78, Firefox ESR 78\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Handlers (REG_MULTI_SZ) = +{ + "mimeTypes": { + "application/msword": { + "action": "useSystemDefault", + "ask": true | false + } + }, + "schemes": { + "mailto": { + "action": "useHelperApp", + "ask": true | false, + "handlers": [{ + "name": "Gmail", + "uriTemplate": "https://mail.google.com/mail/?extsrc=mailto&url=%s" + }] + } + }, + "extensions": { + "pdf": { + "action": "useHelperApp", + "ask": true | false, + "handlers": [{ + "name": "Adobe Acrobat", + "path": "C:\\Program Files (x86)\\Adobe\\Acrobat Reader DC\\Reader\\AcroRd32.exe" + }] + } + } +} +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/Handlers +``` +Value (string): +``` + + +``` +#### macOS +``` + + Handlers + + mimeTypes + + application/msword + + action + useSystemDefault + ask + | + + + schemes + + mailto + + action + useHelperApp + ask + | + handlers + + + name + Gmail + uriTemplate + https://mail.google.com/mail/?extsrc=mailto&url=%s + + + + + extensions + + pdf + + action + useHelperApp + ask + | + handlers + + + name + Adobe Acrobat + path + /System/Applications/Preview.app + + + + + + +``` +#### policies.json +``` +{ + "policies": { + "Handlers": { + "mimeTypes": { + "application/msword": { + "action": "useSystemDefault", + "ask": false + } + }, + "schemes": { + "mailto": { + "action": "useHelperApp", + "ask": true | false, + "handlers": [{ + "name": "Gmail", + "uriTemplate": "https://mail.google.com/mail/?extsrc=mailto&url=%s" + }] + } + }, + "extensions": { + "pdf": { + "action": "useHelperApp", + "ask": true | false, + "handlers": [{ + "name": "Adobe Acrobat", + "path": "/usr/bin/acroread" + }] + } + } + } + } +} +``` ### FirefoxHome Customize the Firefox Home page. @@ -2416,7 +2781,9 @@ 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. -**Compatibility:** Firefox 60, Firefox ESR 60 (StartPage was added in Firefox 60, Firefox ESR 60.4)\ +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. + +**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`\ **Preferences Affected:** `browser.startup.homepage`,`browser.startup.page` @@ -2426,7 +2793,7 @@ Software\Policies\Mozilla\Firefox\Homepage\URL = "https://example.com" Software\Policies\Mozilla\Firefox\Homepage\Locked = 0x1 | 0x0 Software\Policies\Mozilla\Firefox\Homepage\Additional\1 = "https://example.org" Software\Policies\Mozilla\Firefox\Homepage\Additional\2 = "https://example.edu" -Software\Policies\Mozilla\Firefox\Homepage\StartPage = "none" | "homepage" | "previous-session" +Software\Policies\Mozilla\Firefox\Homepage\StartPage = "none" | "homepage" | "previous-session" | "homepage-locked" ``` #### Windows (Intune) OMA-URI: @@ -2475,7 +2842,7 @@ Value (string): http://example.edu StartPage - none | homepage | previous-session + none | homepage | previous-session | homepage-locked ``` @@ -2488,7 +2855,7 @@ Value (string): "Locked": true | false, "Additional": ["http://example.org/", "http://example.edu/"], - "StartPage": "none" | "homepage" | "previous-session" + "StartPage": "none" | "homepage" | "previous-session" | "homepage-locked" } } } @@ -2622,6 +2989,45 @@ 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 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). @@ -2902,8 +3308,58 @@ Value (string): } } ``` +### PDFjs +Disable or configure PDF.js, the built-in PDF viewer. + +If `Enabled` is set to false, the built-in PDF viewer is disabled. + +If `EnablePermissions` is set to true, the built-in PDF viewer will honor document permissions like preventing the copying of text. + +Note: DisableBuiltinPDFViewer has not been deprecated. You can either continue to use it, or switch to using PDFjs->Enabled to disable the built-in PDF viewer. This new permission was added because we needed a place for PDFjs->EnabledPermissions. + +**Compatibility:** Firefox 77, Firefox ESR 68.9\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `pdfjs.diabled`,`pdfjs.enablePermissions` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\PDFjs\Enabled = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\PDFjs\EnablePermissions = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~PDFjs/PDFjs_Enabled +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~PDFjs/PDFjs_EnablePermissions +``` +Value (string): +``` +or +``` +#### macOS +``` + + PDFjs + + Enabled + | + EnablePermissions + | + + +``` +#### policies.json +``` +{ + "policies": { + "PSFjs": { + "Enabled": true | false, + "EnablePermissions": true | false + } +} +``` ### 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. @@ -2915,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) ``` @@ -2942,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: @@ -3020,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 ``` @@ -3143,6 +3637,42 @@ Value (string): } } ``` +### PictureInPicture + +Enable or disable Picture-in-Picture. + +**Compatibility:** Firefox 78, Firefox ESR 78\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `media.videocontrols.picture-in-picture.video-toggle.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\PictureInPicture = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/PictureInPicture +``` +Value (string): +``` + or +``` +#### macOS +``` + + PictureInPicture + | + +``` +#### policies.json +``` +{ + "policies": { + "PictureInPicture": true | false + } +} +``` ### PopupBlocking Configure the default pop-up window policy as well as origins for which pop-up windows are allowed. @@ -3220,6 +3750,153 @@ 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 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\ @@ -3245,7 +3922,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 @@ -3294,7 +3971,7 @@ Set and lock certain preferences. |     If false, the geolocation API is disabled. | Language dependent | intl.accept_languages | string | Firefox 70, Firefox ESR 68.2 |     If set, preferred language for web pages. -| media.eme.enabled | boolean | Firefox 70, Firefox ESR 68.2 | true +| media.eme.enabled (Deprecated - Switch to EncryptedMediaExtensions policy) | boolean | Firefox 70, Firefox ESR 68.2 | true |     If false, Encrypted Media Extensions are not enabled. | media.gmp-gmpopenh264.enabled | boolean | Firefox 68, Firefox ESR 68 | true |     If false, the OpenH264 plugin is not downloaded. @@ -3302,7 +3979,10 @@ Set and lock certain preferences. |     If false, the Widevine plugin is not downloaded. | media.peerconnection.enabled | boolean | Firefox 72, Firefox ESR 68.4 | true |     If false, WebRTC is disabled -| media.peerconnection.ice.obfuscate_host_addresses.whitelist | string | Firefox 72, Firefox ESR 68.4 | N/A +| media.peerconnection.ice.obfuscate_host_addresses.whitelist (Deprecated) | string | Firefox 72, Firefox ESR 68.4 | N/A +|     If set, a list of domains for which mDNS hostname obfuscation is +disabled +| media.peerconnection.ice.obfuscate_host_addresses.blocklist | string | Firefox 79, Firefox ESR 78.1 | N/A |     If set, a list of domains for which mDNS hostname obfuscation is disabled | network.dns.disableIPv6 | boolean | Firefox 68, Firefox ESR 68 | false @@ -3341,6 +4021,15 @@ Value (string): ``` or ``` +OMA-URI: (periods are replaced by underscores) +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Preferences/string_preference_name +``` +Value (string): +``` + + +``` #### macOS ``` @@ -3433,7 +4122,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 @@ -3504,18 +4193,18 @@ Value (string): { "policies": { "Proxy": { - "Mode": "none", "system", "manual", "autoDetect", "autoConfig", - "Locked": [true, false], + "Mode": "none" | "system" | "manual" | "autoDetect" | "autoConfig", + "Locked": true | false, "HTTPProxy": "hostname", - "UseHTTPProxyForAllProtocols": [true, false], + "UseHTTPProxyForAllProtocols": true | false, "SSLProxy": "hostname", "FTPProxy": "hostname", "SOCKSProxy": "hostname", "SOCKSVersion": 4 | 5 "Passthrough": "", "AutoConfigURL": "URL_TO_AUTOCONFIG", - "AutoLogin": [true, false], - "UseProxyForDNS": [true, false] + "AutoLogin": true | false, + "UseProxyForDNS": true | false } } } @@ -3711,6 +4400,7 @@ Value (string): ``` +``` #### macOS ``` @@ -3974,7 +4664,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): ``` @@ -4167,11 +4857,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.