From 3ace5785cd289721e1bdfb16bdcf78faddeb6227 Mon Sep 17 00:00:00 2001 From: Leonard Hecker Date: Tue, 15 Oct 2024 23:48:09 +0200 Subject: [PATCH] Add a policy for profile sources (#18009) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This adds a basic policy check for DisabledProfileSources, so that organizations can easily disable certain profiles like the Azure one. Closes #17964 ## Validation Steps Performed * Add a policy to disable Azure under HKCU. Disabled ✅ * Add a policy to disable nothing under HKLM. Enabled ✅ (...because it overrides the HKCU setting.) (cherry picked from commit 3a06826915d11ee2124de9b35e42300e1c3f68d5) Service-Card-Id: PVTI_lADOAF3p4s4AmhmQzgT6i0c Service-Version: 1.22 --- ...cdb9b77d6827c0202f51acd4205b017015bfff.txt | 5 ---- .github/actions/spelling/expect/expect.txt | 8 ++++++ policies/WindowsTerminal.admx | 28 +++++++++++++++++++ policies/en-US/WindowsTerminal.adml | 28 +++++++++++++++++++ .../TerminalSettingsModel/CascadiaSettings.h | 2 +- .../CascadiaSettingsSerialization.cpp | 28 +++++++++++++++---- src/inc/til/winrt.h | 20 +++++++++++++ 7 files changed, 108 insertions(+), 11 deletions(-) delete mode 100644 .github/actions/spelling/expect/04cdb9b77d6827c0202f51acd4205b017015bfff.txt create mode 100644 policies/WindowsTerminal.admx create mode 100644 policies/en-US/WindowsTerminal.adml diff --git a/.github/actions/spelling/expect/04cdb9b77d6827c0202f51acd4205b017015bfff.txt b/.github/actions/spelling/expect/04cdb9b77d6827c0202f51acd4205b017015bfff.txt deleted file mode 100644 index f117f5081da..00000000000 --- a/.github/actions/spelling/expect/04cdb9b77d6827c0202f51acd4205b017015bfff.txt +++ /dev/null @@ -1,5 +0,0 @@ -EOB -swrapped -wordi -wordiswrapped -wrappe diff --git a/.github/actions/spelling/expect/expect.txt b/.github/actions/spelling/expect/expect.txt index 6d5ae8b95f4..f46a0e88d0d 100644 --- a/.github/actions/spelling/expect/expect.txt +++ b/.github/actions/spelling/expect/expect.txt @@ -16,6 +16,8 @@ ADDALIAS ADDREF ADDSTRING ADDTOOL +adml +admx AFill AFX AHelper @@ -564,6 +566,7 @@ entrypoints ENU ENUMLOGFONT ENUMLOGFONTEX +EOB EOK EPres EQU @@ -782,6 +785,7 @@ HIWORD HKCU hkey hkl +HKLM hlocal hlsl HMB @@ -1734,6 +1738,7 @@ swapchain swapchainpanel SWMR SWP +swrapped SYMED SYNCPAINT syscalls @@ -2076,6 +2081,8 @@ WNDCLASSW Wndproc WNegative WNull +wordi +wordiswrapped workarea WOutside WOWARM @@ -2089,6 +2096,7 @@ WPrep WPresent wprp wprpi +wrappe wregex writeback WRITECONSOLE diff --git a/policies/WindowsTerminal.admx b/policies/WindowsTerminal.admx new file mode 100644 index 00000000000..48c36aec7eb --- /dev/null +++ b/policies/WindowsTerminal.admx @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/policies/en-US/WindowsTerminal.adml b/policies/en-US/WindowsTerminal.adml new file mode 100644 index 00000000000..5516292e123 --- /dev/null +++ b/policies/en-US/WindowsTerminal.adml @@ -0,0 +1,28 @@ + + + + Windows Terminal + Windows Terminal + + + Windows Terminal + At least Windows Terminal 1.21 + Disabled Profile Sources + Profiles will not be generated from any sources listed here. Source names can be arbitrary strings. Potential candidates can be found as the "source" property on profile definitions in Windows Terminal's settings.json file. + +Common sources are: +- Windows.Terminal.Azure +- Windows.Terminal.PowershellCore +- Windows.Terminal.Wsl + +For instance, setting this policy to Windows.Terminal.Wsl will disable the builtin WSL integration of Windows Terminal. + +Note: Existing profiles will disappear from Windows Terminal after adding their source to this policy. + + + + List of disabled sources (one per line) + + + + diff --git a/src/cascadia/TerminalSettingsModel/CascadiaSettings.h b/src/cascadia/TerminalSettingsModel/CascadiaSettings.h index 75eb9ee96ee..e91c43885e9 100644 --- a/src/cascadia/TerminalSettingsModel/CascadiaSettings.h +++ b/src/cascadia/TerminalSettingsModel/CascadiaSettings.h @@ -96,7 +96,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation void _addOrMergeUserColorScheme(const winrt::com_ptr& colorScheme); void _executeGenerator(const IDynamicProfileGenerator& generator); - std::unordered_set _ignoredNamespaces; + std::unordered_set _ignoredNamespaces; std::set themesChangeLog; // See _getNonUserOriginProfiles(). size_t _userProfileCount = 0; diff --git a/src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp b/src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp index 5ec7275b05c..1039bf4343d 100644 --- a/src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp +++ b/src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp @@ -146,9 +146,27 @@ SettingsLoader::SettingsLoader(const std::string_view& userJSON, const std::stri if (const auto sources = userSettings.globals->DisabledProfileSources()) { _ignoredNamespaces.reserve(sources.Size()); - for (const auto& id : sources) + for (auto&& id : sources) { - _ignoredNamespaces.emplace(id); + _ignoredNamespaces.emplace(std::move(id)); + } + } + + // Apply DisabledProfileSources policy setting. Pick whatever policy is set first. + // In most cases HKCU settings take precedence over HKLM settings, but the inverse is true for policies. + for (const auto key : { HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER }) + { + wchar_t buffer[512]; // "640K ought to be enough for anyone" + DWORD bufferSize = sizeof(buffer); + if (RegGetValueW(key, LR"(Software\Policies\Microsoft\Windows Terminal)", L"DisabledProfileSources", RRF_RT_REG_MULTI_SZ, nullptr, buffer, &bufferSize) == 0) + { + for (auto p = buffer; *p;) + { + const auto len = wcslen(p); + _ignoredNamespaces.emplace(p, gsl::narrow_cast(len)); + p += len + 1; + } + break; } } @@ -260,7 +278,7 @@ void SettingsLoader::FindFragmentsAndMergeIntoUserSettings() const auto filename = fragmentExtFolder.path().filename(); const auto& source = filename.native(); - if (!_ignoredNamespaces.count(std::wstring_view{ source }) && fragmentExtFolder.is_directory()) + if (!_ignoredNamespaces.contains(std::wstring_view{ source }) && fragmentExtFolder.is_directory()) { parseAndLayerFragmentFiles(fragmentExtFolder.path(), winrt::hstring{ source }); } @@ -295,7 +313,7 @@ void SettingsLoader::FindFragmentsAndMergeIntoUserSettings() for (const auto& ext : extensions) { const auto packageName = ext.Package().Id().FamilyName(); - if (_ignoredNamespaces.count(std::wstring_view{ packageName })) + if (_ignoredNamespaces.contains(std::wstring_view{ packageName })) { continue; } @@ -914,7 +932,7 @@ void SettingsLoader::_addOrMergeUserColorScheme(const winrt::com_ptr{}(hstr); + } + }; + + struct transparent_hstring_equal_to + { + using is_transparent = void; + + bool operator()(const auto& lhs, const auto& rhs) const noexcept + { + return lhs == rhs; + } + }; }