Merge pull request #629 from mozilla/ExtensionSettings

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 0e795918174a4b90e72fc3d6e96b33ab89564210..243049bbd1ae50821360e77a8e6a56911a8806f1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 **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), [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.
+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
 | --- | --- |
 
 | Policy Name | Description
 | --- | --- |


@@ -61,6 +61,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.

+| **[`MasterPassword`](#masterpassword)** | Require or prevent using a 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.


@@ -71,6 +72,7 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`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.
 | **[`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.
 | **[`PromptForDownloadLocation`](#promptfordownloadlocation)** | Ask where to save each file before downloading.
 | **[`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.
 | **[`PromptForDownloadLocation`](#promptfordownloadlocation)** | Ask where to save each file before downloading.


@@ -946,7 +948,13 @@ Value (string):
 ### DisabledCiphers
 Disable specific cryptographic ciphers.
 
 ### 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
 
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** N/A
 


@@ -961,6 +969,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_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:
 ```
 #### Windows (Intune)
 OMA-URI:


@@ -974,6 +984,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_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):
 ```
 ```
 Value (string):
 ```


@@ -1002,6 +1014,10 @@ Value (string):
       <true/> | <false/>
       <key>TLS_RSA_WITH_3DES_EDE_CBC_SHA</key>
       <true/> | <false/>
       <true/> | <false/>
       <key>TLS_RSA_WITH_3DES_EDE_CBC_SHA</key>
       <true/> | <false/>

+      <key>TLS_RSA_WITH_AES_128_GCM_SHA256</key>
+      <true/> | <false/>
+      <key>TLS_RSA_WITH_AES_256_GCM_SHA384</key>
+      <true/> | <false/>

     </dict>
 </dict>
 ```
     </dict>
 </dict>
 ```


@@ -1019,6 +1035,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_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

     }
   }
 }
     }
   }
 }


@@ -2158,9 +2176,10 @@ The configuration for each extension is another dictionary that can contain the
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`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.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`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.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`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.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`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.
+| `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", "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.
+| `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\
 
 **Compatibility:** Firefox 69, Firefox ESR 68.1\
 **CCK2 Equivalent:** N/A\


@@ -2172,7 +2191,7 @@ Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) =
 {
   "*": {
     "blocked_install_message": "Custom error message.",
 {
   "*": {
     "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"]
   },
     "installation_mode": "blocked",
     "allowed_types": ["extension"]
   },


@@ -2193,7 +2212,7 @@ Value (string):
 <data id="ExtensionSettings" value='
   "*": {
       "blocked_install_message": "Custom error message.",
 <data id="ExtensionSettings" value='
   "*": {
       "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"]
     },
       "installation_mode": "blocked",
       "allowed_types": ["extension"]
     },


@@ -2213,6 +2232,7 @@ Value (string):
       <string>Custom error message.</string>
       <key>install_sources</key>
       <array>
       <string>Custom error message.</string>
       <key>install_sources</key>
       <array>

+        <string>about:addons</string>

         <string>https://addons.mozilla.org/</string>
       </array>
       <key>installation_mode</key>
         <string>https://addons.mozilla.org/</string>
       </array>
       <key>installation_mode</key>


@@ -2239,7 +2259,7 @@ Value (string):
     "ExtensionSettings": {
       "*": {
         "blocked_install_message": "Custom error message.",
     "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"]
       },
         "installation_mode": "blocked",
         "allowed_types": ["extension"]
       },


@@ -2479,7 +2499,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.
 
 
 `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`
 
 **CCK2 Equivalent:** `homePage`,`lockHomePage`\
 **Preferences Affected:** `browser.startup.homepage`,`browser.startup.page`
 


@@ -2489,7 +2511,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\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:
 ```
 #### Windows (Intune)
 OMA-URI:


@@ -2538,7 +2560,7 @@ Value (string):
       <string>http://example.edu</string>
     </array>
     <key>StartPage</key>
       <string>http://example.edu</string>
     </array>
     <key>StartPage</key>

-    <string>none | homepage | previous-session</string>
+    <string>none | homepage | previous-session | homepage-locked</string>

   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```


@@ -2551,7 +2573,7 @@ Value (string):
       "Locked": true | false,
       "Additional": ["http://example.org/",
                      "http://example.edu/"],
       "Locked": true | false,
       "Additional": ["http://example.org/",
                      "http://example.edu/"],

-      "StartPage": "none" | "homepage" | "previous-session"
+      "StartPage": "none" | "homepage" | "previous-session" | "homepage-locked"

     }
   }
 }
     }
   }
 }


@@ -2685,6 +2707,43 @@ Value (string):
   }
 }
 ```
   }
 }
 ```

+### MasterPassword
+Require or prevent using a master password.
+
+If this value is true, a master password is required. If this values is false, it works the same as `DisableMasterPasswordCreation` and removes the master password functionality.
+
+**Compatibility:** Firefox 78, Firefox ESR 78\
+**CCK2 Equivalent:** `noMasterPassword`\
+**Preferences Affected:** N/A
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\MasterPassword = 0x1 | 0x0
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/MasterPassword
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+#### macOS
+```
+<dict>
+  <key>MasterPassword</key>
+  <true/> | <false/>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "MasterPassword": true | false
+  }
+}
+```

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


@@ -2972,6 +3031,8 @@ 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.
 
 
 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`
 **Compatibility:** Firefox 77, Firefox ESR 68.9\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `pdfjs.diabled`,`pdfjs.enablePermissions`


@@ -3254,6 +3315,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):
+```
+<enabled/> or <disabled/>
+```
+#### macOS
+```
+<dict>
+  <key>PictureInPicture</key>
+  <true/> | <false/>
+</dict>
+```
+#### 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.
 
 ### PopupBlocking
 Configure the default pop-up window policy as well as origins for which pop-up windows are allowed.
 


@@ -3822,6 +3919,7 @@ Value (string):
 ```
 <enabled/>
 <data id="Permissions" value="unified | separate"/>
 ```
 <enabled/>
 <data id="Permissions" value="unified | separate"/>

+```

 #### macOS
 ```
 <dict>
 #### macOS
 ```
 <dict>