Correct typo

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index bf538fe4eefb9a11d6950d58ea24365f2fa707bf..e660b84e0d37e6da8502dbb06ae40fd037c2a79d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,11 @@
 
 **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 or you can specify system-wide policy by placing the file in `/etc/firefox/policies`.
+Official policy documentation has been moved to https://mozilla.github.io/policy-templates/.
+
+I'm maintaining things in the README.md until we can update links in Firefox.
+
+Firefox 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`.

 
 Unfortunately, JSON files do not support comments, but you can add extra entries to the JSON to use as comments. You will see an error in about:policies, but the policies will still work properly. For example:
 
 
 Unfortunately, JSON files do not support comments, but you can add extra entries to the JSON to use as comments. You will see an error in about:policies, but the policies will still work properly. For example:
 


@@ -1100,7 +1104,7 @@ Configure cookie preferences.
 `BehaviorPrivateBrowsing` sets the default behavior for cookies in private browsing based on the values below.
 
 | Value | Description
 `BehaviorPrivateBrowsing` sets the default behavior for cookies in private browsing based on the values below.
 
 | Value | Description

-| --- | ---
+| --- | --- |

 | accept | Accept all cookies
 | reject-foreign | Reject third party cookies
 | reject | Reject all cookies
 | accept | Accept all cookies
 | reject-foreign | Reject third party cookies
 | reject | Reject all cookies


@@ -4684,8 +4688,9 @@ widget.
 xpinstall.signatures.required (Firefox ESR 102.10, Firefox ESR only)
 ```
 as well as the following security preferences:
 xpinstall.signatures.required (Firefox ESR 102.10, Firefox ESR only)
 ```
 as well as the following security preferences:

+

 | Preference | Type | Default
 | Preference | Type | Default

-| --- | --- | ---
+| --- | --- | --- |

 | security.default_personal_cert | string | Ask Every Time
 |     If set to Select Automatically, Firefox automatically chooses the default personal certificate.
 | security.insecure_connection_text.enabled | bool | false
 | security.default_personal_cert | string | Ask Every Time
 |     If set to Select Automatically, Firefox automatically chooses the default personal certificate.
 | security.insecure_connection_text.enabled | bool | false


@@ -4700,6 +4705,8 @@ as well as the following security preferences:
 |     If 0, do not fetch OCSP. If 1, fetch OCSP for DV and EV certificates. If 2, fetch OCSP only for EV certificates
 | security.OCSP.require | boolean | false
 |      If true, if an OCSP request times out, the connection fails.
 |     If 0, do not fetch OCSP. If 1, fetch OCSP for DV and EV certificates. If 2, fetch OCSP only for EV certificates
 | security.OCSP.require | boolean | false
 |      If true, if an OCSP request times out, the connection fails.

+| security.osclientcerts.assume_rsa_pss_support | boolean | true
+|      If false, we don't assume an RSA key can do RSA-PSS (Firefox 114, Firefox ESR 102.12).

 | security.ssl.enable_ocsp_stapling | boolean | true
 |      If false, OCSP stapling is not enabled.
 | security.ssl.errorReporting.enabled | boolean | true
 | security.ssl.enable_ocsp_stapling | boolean | true
 |      If false, OCSP stapling is not enabled.
 | security.ssl.errorReporting.enabled | boolean | true


@@ -4712,7 +4719,6 @@ as well as the following security preferences:
 |     If true, browser will accept TLS 1.0. and TLS 1.1 (Firefox 86, Firefox 78.8).
 | security.warn_submit_secure_to_insecure | boolean | true
 |     If false, no warning is shown when submitting a form from https to http.
 |     If true, browser will accept TLS 1.0. and TLS 1.1 (Firefox 86, Firefox 78.8).
 | security.warn_submit_secure_to_insecure | boolean | true
 |     If false, no warning is shown when submitting a form from https to http.

- 

 
 Using the preference as the key, set the `Value` to the corresponding preference value.
 
 
 Using the preference as the key, set the `Value` to the corresponding preference value.
 


@@ -4836,7 +4842,7 @@ Set and lock certain preferences.
 **Preferences Affected:** See below
 
 | Preference | Type | Compatibility | Default
 **Preferences Affected:** See below
 
 | Preference | Type | Compatibility | Default

-| --- | --- | --- | ---
+| --- | --- | --- | --- |

 | accessibility.force_disabled | integer | Firefox 70, Firefox ESR 68.2 | 0
 |     If set to 1, platform accessibility is disabled.
 | app.update.auto (Deprecated - Switch to AppAutoUpdate policy) | boolean | Firefox 68, Firefox ESR 68 | true
 | accessibility.force_disabled | integer | Firefox 70, Firefox ESR 68.2 | 0
 |     If set to 1, platform accessibility is disabled.
 | app.update.auto (Deprecated - Switch to AppAutoUpdate policy) | boolean | Firefox 68, Firefox ESR 68 | true


@@ -4939,6 +4945,7 @@ disabled
 |     If false, the Alt key doesn't show the menubar on Windows.
 | widget.content.gtk-theme-override | string | Firefox 72, Firefox ESR 68.4 (Linux only) | N/A
 |     If set, overrides the GTK theme for widgets.
 |     If false, the Alt key doesn't show the menubar on Windows.
 | widget.content.gtk-theme-override | string | Firefox 72, Firefox ESR 68.4 (Linux only) | N/A
 |     If set, overrides the GTK theme for widgets.

+

 #### Windows (GPO)
 ```
 Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0
 #### Windows (GPO)
 ```
 Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0


@@ -5818,6 +5825,68 @@ Value (string):
 ```
 ### SecurityDevices
 
 ```
 ### SecurityDevices
 

+Add or delete PKCS #11 modules.
+
+**Compatibility:** Firefox 114, Firefox ESR 112.12\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** N/A
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\SecurityDevices\Add\NAME_OF_DEVICE_TO_ADD = PATH_TO_LIBRARY_FOR_DEVICE
+Software\Policies\Mozilla\Firefox\SecurityDevices\Remove\1 = NAME_OF_DEVICE_TO_REMOVE
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/SecurityDevices/SecurityDevices_Add
+```
+Value (string):
+```
+<enabled/>
+<data id="SecurityDevices" value="NAME_OF_DEVICE_TO_ADD&#xF000;PATH_TO_LIBRARY_FOR_DEVICE"/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/SecurityDevices/SecurityDevices_Delete
+```
+Value (string):
+```
+<enabled/>
+<data id="SecurityDevices" value="1&#xF000;NAME_OF_DEVICE_TO_REMOVE"/>
+```
+#### macOS
+```
+<dict>
+  <key>SecurityDevices</key>
+  <dict>
+    <key>Add<key>
+    <dict>
+      <key>NAME_OF_DEVICE_TO_ADD</key>
+      <string>PATH_TO_LIBRARY_FOR_DEVICE</string>
+    </dict>
+    <key>Delete</add>
+    <array>
+      <string>NAME_OF_DEVICE_TO_DELETE</string>
+    </array>
+  </dict>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "SecurityDevices": {
+      "Add": {
+        "NAME_OF_DEVICE_TO_ADD": "PATH_TO_LIBRARY_FOR_DEVICE"
+      },
+      "Delete": ["NAME_OF_DEVICE_TO_DELETE"]
+    }
+  }
+}
+```
+### SecurityDevices (Deprecated)
+

 Install PKCS #11 modules.
 
 **Compatibility:** Firefox 64, Firefox ESR 60.4\
 Install PKCS #11 modules.
 
 **Compatibility:** Firefox 64, Firefox ESR 60.4\


@@ -5848,7 +5917,6 @@ Value (string):
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-

 #### policies.json
 ```
 {
 #### policies.json
 ```
 {


@@ -6073,6 +6141,8 @@ Prevent Firefox from messaging the user in certain situations.
 
 `MoreFromMozilla` If false, don't show the "More from Mozilla" section in Preferences. (Firefox 98)
 
 
 `MoreFromMozilla` If false, don't show the "More from Mozilla" section in Preferences. (Firefox 98)
 

+`Locked` prevents the user from changing user messaging preferences.
+

 **Compatibility:** Firefox 75, Firefox ESR 68.7\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `browser.messaging-system.whatsNewPanel.enabled`, `browser.newtabpage.activity-stream.asrouter.userprefs.cfr.addons`, `browser.newtabpage.activity-stream.asrouter.userprefs.cfr.features`, `browser.aboutwelcome.enabled`, `browser.preferences.moreFromMozilla`
 **Compatibility:** Firefox 75, Firefox ESR 68.7\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `browser.messaging-system.whatsNewPanel.enabled`, `browser.newtabpage.activity-stream.asrouter.userprefs.cfr.addons`, `browser.newtabpage.activity-stream.asrouter.userprefs.cfr.features`, `browser.aboutwelcome.enabled`, `browser.preferences.moreFromMozilla`


@@ -6085,6 +6155,7 @@ Software\Policies\Mozilla\Firefox\UserMessaging\FeatureRecommendations = 0x1 | 0
 Software\Policies\Mozilla\Firefox\UserMessaging\UrlbarInterventions = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\UserMessaging\SkipOnboarding = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\UserMessaging\MoreFromMozilla = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\UserMessaging\UrlbarInterventions = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\UserMessaging\SkipOnboarding = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\UserMessaging\MoreFromMozilla = 0x1 | 0x0

+Software\Policies\Mozilla\Firefox\UserMessaging\Locked = 0x1 | 0x0

 ```
 #### Windows (Intune)
 OMA-URI:
 ```
 #### Windows (Intune)
 OMA-URI:


@@ -6095,6 +6166,7 @@ OMA-URI:
 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~UserMessaging/UserMessaging_UrlbarInterventions
 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~UserMessaging/UserMessaging_SkipOnboarding
 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~UserMessaging/UserMessaging_MoreFromMozilla
 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~UserMessaging/UserMessaging_UrlbarInterventions
 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~UserMessaging/UserMessaging_SkipOnboarding
 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~UserMessaging/UserMessaging_MoreFromMozilla

+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~UserMessaging/UserMessaging_Locked

 ```
 Value (string):
 ```
 ```
 Value (string):
 ```


@@ -6117,6 +6189,8 @@ Value (string):
     <true/> | <false/>
     <key>MoreFromMozilla</key>
     <true/> | <false/>
     <true/> | <false/>
     <key>MoreFromMozilla</key>
     <true/> | <false/>

+    <key>Locked</key>
+    <true/> | <false/>

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


@@ -6130,7 +6204,8 @@ Value (string):
       "FeatureRecommendations": true | false,
       "UrlbarInterventions": true | false,
       "SkipOnboarding": true | false,
       "FeatureRecommendations": true | false,
       "UrlbarInterventions": true | false,
       "SkipOnboarding": true | false,

-      "MoreFromMozilla": true | false
+      "MoreFromMozilla": true | false,
+      "Locked": true | false

     }
   }
 }
     }
   }
 }


@@ -6265,3 +6340,4 @@ Value (string):
   }
 }
 ```
   }
 }
 ```

+