X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/f98a0670d1e871d1451892211c72b860cb2ff75c..9568f4e3cf4c700d6a92c3d1f2a1f59704f91289:/docs/index.md diff --git a/docs/index.md b/docs/index.md index f609f82..1537dba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,6 +16,7 @@ Note: The `policies.json` must use the UTF-8 encoding. | Policy Name | Description | --- | --- | | **[`3rdparty`](#3rdparty)** | Set policies that WebExtensions can access via chrome.storage.managed. +| **[`AIControls`](#aicontrols)** | Configure AI controls. | **[`AllowedDomainsForApps`](#alloweddomainsforapps)** | Define domains allowed to access Google Workspace. | **[`AllowFileSelectionDialogs`](#allowfileselectiondialogs)** | Allow file selection dialogs. | **[`AppAutoUpdate`](#appautoupdate)** | Enable or disable automatic application update. @@ -58,6 +59,7 @@ Note: The `policies.json` must use the UTF-8 encoding. | **[`DisablePrivateBrowsing`](#disableprivatebrowsing)** | Remove access to private browsing. | **[`DisableProfileImport`](#disableprofileimport)** | Remove the ability to import data from other browers. | **[`DisableProfileRefresh`](#disableprofilerefresh)** | Disable the Refresh Firefox button on about:support and support.mozilla.org +| **[`DisableRemoteImprovements`](#disableremoteimprovements)** | Prevent Firefox from applying performance, stability, and feature changes between updates. | **[`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. @@ -86,6 +88,7 @@ Note: The `policies.json` must use the UTF-8 encoding. | **[`HttpAllowlist`](#httpallowlist)** | Configure origins that will not be upgraded to HTTPS. | **[`HttpsOnlyMode`](#httpsonlymode)** | Configure HTTPS-Only Mode. | **[`InstallAddonsPermission`](#installaddonspermission)** | Configure the default extension install policy as well as origins for extension installs are allowed. +| **[`IPProtectionAvailable`](#ipprotectionavailable)** | Prevent the built-in VPN from being available to users. | **[`LegacyProfiles`](#legacyprofiles)** | Disable the feature enforcing a separate profile for each installation. | **[`LegacySameSiteCookieBehaviorEnabled`](#legacysamesitecookiebehaviorenabled)** | Enable default legacy SameSite cookie behavior setting. | **[`LegacySameSiteCookieBehaviorEnabledForDomainList`](#legacysamesitecookiebehaviorenabledfordomainlist)** | Revert to legacy SameSite behavior for cookies on specified sites. @@ -193,6 +196,262 @@ For GPO and Intune, the extension developer should provide an ADMX file. } ``` +### AIControls +Configure AI controls. +For more information, see [Block generative AI features with Firefox AI controls](https://support.mozilla.org/en-US/kb/firefox-ai-controls) on support.mozilla.org. + +Each key controls the availability of a specific AI feature. The following AI feature keys are available: + +- `Default`: Controls the default state for AI features listed below, unless they are explicitly configured in the policy. +- `Translations`: Controls AI-powered page translations. +- `PDFAltText`: Controls AI-generated alt text for images in PDF documents. +- `SmartTabGroups`: Controls AI-powered tab grouping suggestions. +- `LinkPreviewKeyPoints`: Controls AI-generated key point summaries shown in link previews. +- `SidebarChatbot`: Controls the AI chatbot panel in the Firefox sidebar. +- `SmartWindow`: Controls AI-powered window arrangement features. (Firefox 150) + +All keys accept the following sub-keys: + +- `Value`: + - `available` makes the feature accessible to users and it can be enabled or disabled. + - `blocked` disables the feature and users won't see it. For on-device AI, any models already downloaded are removed. +- `Locked`: if `true`, the user cannot change the setting. + +**Compatibility:** Firefox 149.0.2 (SmartWindow: Firefox 150)\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.ml.chat.enabled`, `browser.ml.chat.page`, `browser.ai.control.sidebarChatbot`, `browser.translations.enable`, `browser.ai.control.translations`, `pdfjs.enableAltText`, `browser.ai.control.pdfjsAltText`, `browser.ml.linkPreview.enabled`, `browser.ai.control.linkPreviewKeyPoints`, `browser.tabs.groups.smart.userEnabled`, `browser.ai.control.smartTabGroups`, `browser.ai.control.smartWindow` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\AIControls\Default\Value = "available" | "blocked" +Software\Policies\Mozilla\Firefox\AIControls\Default\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIControls\Translations\Value = "available" | "blocked" +Software\Policies\Mozilla\Firefox\AIControls\Translations\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIControls\PDFAltText\Value = "available" | "blocked" +Software\Policies\Mozilla\Firefox\AIControls\PDFAltText\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIControls\SmartTabGroups\Value = "available" | "blocked" +Software\Policies\Mozilla\Firefox\AIControls\SmartTabGroups\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIControls\LinkPreviewKeyPoints\Value = "available" | "blocked" +Software\Policies\Mozilla\Firefox\AIControls\LinkPreviewKeyPoints\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIControls\SidebarChatbot\Value = "available" | "blocked" +Software\Policies\Mozilla\Firefox\AIControls\SidebarChatbot\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIControls\SmartWindow\Value = "available" | "blocked" +Software\Policies\Mozilla\Firefox\AIControls\SmartWindow\Locked = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~Default/Default_Value +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~Default/Default_Locked +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~Translations/Translations_Value +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~Translations/Translations_Locked +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~PDFAltText/PDFAltText_Value +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~PDFAltText/PDFAltText_Locked +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~SmartTabGroups/SmartTabGroups_Value +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~SmartTabGroups/SmartTabGroups_Locked +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~LinkPreviewKeyPoints/LinkPreviewKeyPoints_Value +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~LinkPreviewKeyPoints/LinkPreviewKeyPoints_Locked +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~SidebarChatbot/SidebarChatbot_Value +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~SidebarChatbot/SidebarChatbot_Locked +``` +Value (string): +``` + or +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~SmartWindow/SmartWindow_Value +``` +Value (string): +``` + + +``` +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~AIControls~SmartWindow/SmartWindow_Locked +``` +Value (string): +``` + or +``` +#### macOS +``` + + AIControls + + Default + + Value + available | blocked + Locked + | + + Translations + + Value + available | blocked + Locked + | + + PDFAltText + + Value + available | blocked + Locked + | + + SmartTabGroups + + Value + available | blocked + Locked + | + + LinkPreviewKeyPoints + + Value + available | blocked + Locked + | + + SidebarChatbot + + Value + available | blocked + Locked + | + + SmartWindow + + Value + available | blocked + Locked + | + + + +``` +#### policies.json +``` +{ + "policies": { + "AIControls": { + "Default": { + "Value": "available" | "blocked", + "Locked": true | false + }, + "Translations": { + "Value": "available" | "blocked", + "Locked": true | false + }, + "PDFAltText": { + "Value": "available" | "blocked", + "Locked": true | false + }, + "SmartTabGroups": { + "Value": "available" | "blocked", + "Locked": true | false + }, + "LinkPreviewKeyPoints": { + "Value": "available" | "blocked", + "Locked": true | false + }, + "SidebarChatbot": { + "Value": "available" | "blocked", + "Locked": true | false + }, + "SmartWindow": { + "Value": "available" | "blocked", + "Locked": true | false + } + } + } +} +``` ### AllowedDomainsForApps Define domains allowed to access Google Workspace. @@ -316,7 +575,7 @@ Value (string): Prevent Firefox from being updated beyond the specified version. -You can specify the any version as ```xx.``` and Firefox will be updated with all minor versions, but will not be updated beyond the major version. +You can specify the version as ```xx.``` and Firefox will be updated with all minor versions, but will not be updated beyond the major version. You can also specify the version as ```xx.xx.``` and Firefox will be updated with all patch versions, but will not be updated beyond the minor version. @@ -2444,6 +2703,45 @@ Value (string): } } ``` +### DisableRemoteImprovements +Prevent Firefox from applying performance, stability, and feature changes between updates. + +For more information, see [Manage remote improvements settings in Firefox](https://support.mozilla.org/en-US/kb/remote-improvements). + +Note: This policy is not correctly reflected in preferences. This will be fixed soon. + +**Compatibility:** Firefox 148\ +**CCK2 Equivalent:** N/A +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableRemoteImprovements = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/DisableRemoteImprovements +``` +Value (string): +``` + or +``` +#### macOS +``` + + DisableRemoteImprovements + | + +``` +#### policies.json +``` +{ + "policies": { + "DisableRemoteImprovements": true | false + } +} +``` ### DisableSafeMode Disable safe mode within the browser. @@ -2965,7 +3263,7 @@ IF `BaselineExceptions` is true, Firefox will automatically apply exceptions req If `ConvenienceExceptions`is true, Firefox will apply exceptions automatically that are only required to fix minor issues and make convenience features available. (Firefox 145) -Note: Users can change `BaselineExceptions` and `ConvenienceExceptions` even when `Category` is set to ```strict``` unless `Locked` is set to true. +Note: Users can change `BaselineExceptions` and `ConvenienceExceptions` even when `Category` is set to ```strict``` unless `Locked` is set to true. If `Locked` is set to true, the defaults are used unless a different value is specified in policy for `BaselineExceptions` and `ConvenienceExceptions`. **Compatibility:** Firefox 60, Firefox ESR 60 (Cryptomining and Fingerprinting added in 70/68.2, Exceptions added in 73/68.5. Category added in Firefox 142/140.2. BaselineExceptions and ConvenienceExceptions added in Firefox 145)\ **CCK2 Equivalent:** N/A\ @@ -3344,32 +3642,37 @@ Value (string): ### ExtensionSettings Manage all aspects of extensions. This policy is based heavily on the [Chrome policy](https://dev.chromium.org/administrators/policy-list-3/extension-settings-full) of the same name. -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. +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. 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). -Or you can ask the Mozilla Addons API, see [docs](https://mozilla.github.io/addons-server/topics/api/addons.html#detail), which returns the ID as `guid`: https://addons.mozilla.org/api/v5/addons/addon/ublock-origin/ +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). **Note:** -If the extension ID is a UUID ({12345678-1234-1234-1234-1234567890ab}), you must include the curly braces around the ID. +If the extension ID is a UUID (for example `{12345678-1234-1234-1234-1234567890ab}`), you must include the curly braces around the ID. 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. 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 local file system, use a [```file:///``` URL](https://en.wikipedia.org/wiki/File_URI_scheme). If installing from the addons.mozilla.org, use the following URL (substituting ID with the extension ID or with the short name from the URL on AMO), https://addons.mozilla.org/firefox/downloads/latest/ID/latest.xpi. 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 using URL match patterns. **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. -| `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 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. -| `updates_disabled` | (Firefox 89, Firefox ESR 78.11) Boolean that indicates whether or not to disable automatic updates for an individual extension. -| `default_area` | (Firefox 113) String that indicates where to place the extension icon by default. Possible values are `navbar` and `menupanel`. -| `temporarily_allow_weak_signatures`| (Firefox 127) A boolean that indicates whether to allow installing extensions signed using deprecated signature algorithms. -| `private_browsing`| (Firefox 136, Firefox ESR 128.8) A boolean that indicates whether or not this extension should be enabled in private browsing. +| `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. 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. If used in the default (`"*"`) configuration, it blocks all extensions that do not have an explicit configuration with a different `installation_mode`. | +|         `force_installed` | Automatically installs the extension and prevents it from being removed by the user. This option is not valid for the default configuration and requires an `install_url`. | +|         `normal_installed` | Automatically installs the extension but allows it to be disabled by the user. This option is not valid for the default configuration and requires an `install_url`. | +|`install_url` | The URL from which Firefox can download a `force_installed` or `normal_installed` extension. Firefox automatically installs, updates, or re-installs the extension when the XPI file’s internal [`version`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/version) changes.
  • If installing from `addons.mozilla.org`, use `https://addons.mozilla.org/firefox/downloads/latest/ADDON_ID/latest.xpi` and substitute **ADDON_ID** with the extension’s ID (for example, `uBlock0@raymondhill.net` or `{446900e4-71c2-419f-a6a7-df9c091e268b}`). Using the AMO ID ensures Firefox always downloads the latest version that matches the user’s platform.
  • If installing from the local file system, use a [`file:///` URL](https://en.wikipedia.org/wiki/File_URI_scheme). Firefox will update or re-install the extension whenever the XPI file at that path changes. You can also manually trigger an update by changing the file name or path.
  • Language packs are available from `https://releases.mozilla.org/pub/firefox/releases/VERSION/PLATFORM/xpi/LANGUAGE.xpi` (for example, `https://releases.mozilla.org/pub/firefox/releases/111.0.1/win64/xpi/en-US.xpi`). These URLs can be used as `install_url` values for managing language pack installation.
+| `install_sources` | A list of sources from which installing extensions is allowed using URL match patterns. **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 (the referrer) must be allowed by these patterns. This setting can be used only for the default configuration. | +| `allowed_types` | Restricts which types of add-ons can be installed. Accepts a list of one or more of: `"extension"`, `"theme"`, `"dictionary"`, `"locale"`, `"sitepermission"`.

**Note:** This setting only applies when installation is otherwise allowed. If `"installation_mode": "blocked"` is set (either for a specific ID or for `"*"`), extensions remain blocked regardless of `allowed_types`. This setting can be used only for the default configuration. | +| `blocked_install_message` | 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 an extension is blocked. This could be used to direct users to your help desk, explain why a particular extension is blocked, or something similar. 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. | +| `updates_disabled` | (Firefox 89, Firefox ESR 78.11) Boolean that indicates whether or not to disable automatic updates for an individual extension. | +| `default_area` | (Firefox 113) String that indicates where to place the extension icon by default. Possible values are `navbar` and `menupanel`. | +| `temporarily_allow_weak_signatures` | (Firefox 127) A boolean that indicates whether to allow installing extensions signed using deprecated signature algorithms. | +| `private_browsing` | (Firefox 136, Firefox ESR 128.8) A boolean that indicates whether or not this extension should be enabled in private browsing. | + +#### Interaction Notes +- `"installation_mode": "blocked"` takes precedence over all other settings. When set, extensions cannot be installed regardless of `allowed_types` or `install_sources`. A configuration for a specific extension ID still overrides the `"*"` configuration. +- To block all extensions except a few, use `"installation_mode": "blocked"` for `"*"` and explicitly override it for allowed or force-installed extensions. +- To block extensions but allow themes, dictionaries, language packs, and site permissions, leave the default (`"*"` ) `installation_mode` as `"allowed"` and set `"allowed_types": ["theme", "dictionary", "locale", "sitepermission"]`. (`"locale"` corresponds to Firefox language packs.) + **Do not set `"installation_mode": "blocked"` in this scenario**, because `allowed_types` is ignored when installation is blocked. **Compatibility:** Firefox 69, Firefox ESR 68.1 (As of Firefox 85, Firefox ESR 78.7, installing a theme makes it the default.)\ **CCK2 Equivalent:** N/A\ @@ -3382,8 +3685,7 @@ Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = "*": { "blocked_install_message": "Custom error message.", "install_sources": ["https://yourwebsite.com/*"], - "installation_mode": "blocked", - "allowed_types": ["extension"] + "installation_mode": "blocked" }, "uBlock0@raymondhill.net": { "installation_mode": "force_installed", @@ -3412,8 +3714,7 @@ Value (string): "*": { "blocked_install_message": "Custom error message.", "install_sources": ["https://yourwebsite.com/*"], - "installation_mode": "blocked", - "allowed_types": ["extension"] + "installation_mode": "blocked" }, "uBlock0@raymondhill.net": { "installation_mode": "force_installed", @@ -3430,7 +3731,7 @@ Value (string): }'/> ``` If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead -to workaround the limit on the length of strings. Put all of your JSON on one line. +to work around the limit on the length of strings. Put all of your JSON on one line. OMA-URI: ``` @@ -3456,10 +3757,6 @@ Value (string): installation_mode blocked - allowed_types - - extension - uBlock0@raymondhill.net @@ -3493,8 +3790,7 @@ Value (string): "*": { "blocked_install_message": "Custom error message.", "install_sources": ["https://yourwebsite.com/*"], - "installation_mode": "blocked", - "allowed_types": ["extension"] + "installation_mode": "blocked" }, "uBlock0@raymondhill.net": { "installation_mode": "force_installed", @@ -4295,6 +4591,40 @@ Value (string): } } ``` +### IPProtectionAvailable +Prevent the built-in VPN from being available to users. + +**Compatibility:** Firefox 149.0.2\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.ipProtection.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\IPProtectionAvailable = = 0x1 | 0x0 +``` +#### Windows (Intune) +OMA-URI: +``` +./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/IPProtectionAvailable +``` +Value (string): +``` + or +``` +#### macOS +``` + + IPProtectionAvailable + | + +``` +#### policies.json +``` +{ + "policies": { + "IPProtectionAvailable": true | false +} +``` ### LegacyProfiles Disable the feature enforcing a separate profile for each installation.