Merge pull request #664 from clear-code/fix-issue-663

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index cd5ffba19fe948c7464b3d32a68b6e27dd9be181..f68860620f3ff9de5b24a0ef7bd7fbda053912e4 100644 (file)
--- 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.
 | **[`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.
 | **[`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.
 | **[`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.
 | **[`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.
 | **[`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.
 | **[`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 +62,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.
 | **[`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.
 | **[`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.


@@ -679,6 +680,8 @@ Configure cookie preferences.
 
 `Allow` is a list of origins (not domains) where cookies are always allowed. You must include http or https.
 
 
 `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.
 `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 +694,14 @@ Configure cookie preferences.
 
 `Locked` prevents the user from changing 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"
 **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"
 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 +721,15 @@ Value (string):
 ```
 OMA-URI:
 ```
 ```
 OMA-URI:
 ```

+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Cookies/Cookies_AllowSession
+```
+Value (string):
+```
+<enabled/>
+<data id="Cookies_Allow" value="1&#xF000;https://example.edu"/>
+```
+OMA-URI:
+```

 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Cookies/Cookies_Block
 ```
 Value (string):
 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Cookies/Cookies_Block
 ```
 Value (string):


@@ -774,6 +787,10 @@ Value (string):
     <array>
       <string>http://example.com</string>
     </array>
     <array>
       <string>http://example.com</string>
     </array>

+    <key>AllowSession</key>
+    <array>
+      <string>http://example.edu</string>
+    </array>

     <key>Block</key>
     <array>
       <string>http://example.org</string>
     <key>Block</key>
     <array>
       <string>http://example.org</string>


@@ -797,6 +814,7 @@ Value (string):
   "policies": {
     "Cookies": {
       "Allow": ["http://example.org/"],
   "policies": {
     "Cookies": {
       "Allow": ["http://example.org/"],

+      "AllowSession": ["http://example.edu/"],

       "Block": ["http://example.edu/"],
       "Default": true | false,
       "AcceptThirdParty": "always" | "never" | "from-visited",
       "Block": ["http://example.edu/"],
       "Default": true | false,
       "AcceptThirdParty": "always" | "never" | "from-visited",


@@ -845,6 +863,10 @@ Value (string):
 ### DisableMasterPasswordCreation
 Remove the master password functionality.
 
 ### 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
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `noMasterPassword`\
 **Preferences Affected:** N/A


@@ -2456,7 +2478,7 @@ Within each handler type, you specify the given mimeType/extension/scheme as a k
 
 #### Windows (GPO)
 ```
 
 #### Windows (GPO)
 ```

-Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) =
+Software\Policies\Mozilla\Firefox\Handlers (REG_MULTI_SZ) =

 {
   "mimeTypes": {
     "application/msword": {
 {
   "mimeTypes": {
     "application/msword": {


@@ -2936,6 +2958,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):
+```
+<enabled/> or <disabled/>
+```
+#### macOS
+```
+<dict>
+  <key>PrimaryPassword</key>
+  <true/> | <false/>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "PrimaryPassword": true | false
+  }
+}
+```

 ### NetworkPrediction
 Enable or disable network prediction (DNS prefetching).
 
 ### NetworkPrediction
 Enable or disable network prediction (DNS prefetching).
 


@@ -3702,7 +3763,10 @@ Set and lock certain preferences.
 | &nbsp;&nbsp;&nbsp;&nbsp;If false, the Widevine plugin is not downloaded.
 | media.peerconnection.enabled | boolean | Firefox 72, Firefox ESR 68.4 | true
 | &nbsp;&nbsp;&nbsp;&nbsp;If false, WebRTC is disabled
 | &nbsp;&nbsp;&nbsp;&nbsp;If false, the Widevine plugin is not downloaded.
 | media.peerconnection.enabled | boolean | Firefox 72, Firefox ESR 68.4 | true
 | &nbsp;&nbsp;&nbsp;&nbsp;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
+| &nbsp;&nbsp;&nbsp;&nbsp;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

 | &nbsp;&nbsp;&nbsp;&nbsp;If set, a list of domains for which mDNS hostname obfuscation is
 disabled
 | network.dns.disableIPv6 | boolean | Firefox 68, Firefox ESR 68 | false
 | &nbsp;&nbsp;&nbsp;&nbsp;If set, a list of domains for which mDNS hostname obfuscation is
 disabled
 | network.dns.disableIPv6 | boolean | Firefox 68, Firefox ESR 68 | false


@@ -3842,7 +3906,7 @@ To specify ports, append them to the hostnames with a colon (:).
 
 #### Windows (GPO)
 ```
 
 #### 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
 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


@@ -3913,7 +3977,7 @@ Value (string):
 {
   "policies": {
     "Proxy": {
 {
   "policies": {
     "Proxy": {

-      "Mode": "none", "system", "manual", "autoDetect", "autoConfig",
+      "Mode": "none" | "system" | "manual" | "autoDetect" | "autoConfig",

       "Locked": true | false,
       "HTTPProxy": "hostname",
       "UseHTTPProxyForAllProtocols": true | false,
       "Locked": true | false,
       "HTTPProxy": "hostname",
       "UseHTTPProxyForAllProtocols": true | false,


@@ -4577,11 +4641,11 @@ Value (string):
 ```
 ### UserMessaging
 
 ```
 ### 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. (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.
 
 
 `FeatureRecommendations` Don't recommend browser features.