Skip to content

Add a policy for profile sources #18009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DHowett merged 5 commits into from
Oct 15, 2024
+108 −11
Merged

Add a policy for profile sources #18009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e2f50e0
Add a policy for profile sources
lhecker Oct 8, 2024
f73c434
Write admx/adml templates
lhecker Oct 9, 2024
8b60bf4
spel
lhecker Oct 9, 2024
d12d336
Address feedback
lhecker Oct 9, 2024
40b7f19
Address htcfreek's feedback
lhecker Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .github/actions/spelling/expect/04cdb9b77d6827c0202f51acd4205b017015bfff.txt
View file
Open in desktop

This file was deleted.

8 changes: 8 additions & 0 deletions .github/actions/spelling/expect/expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ ADDALIAS
ADDREF
ADDSTRING
ADDTOOL
adml
admx
AFill
AFX
AHelper
Expand Down Expand Up @@ -564,6 +566,7 @@ entrypoints
ENU
ENUMLOGFONT
ENUMLOGFONTEX
EOB
EOK
EPres
EQU
Expand Down Expand Up @@ -782,6 +785,7 @@ HIWORD
HKCU
hkey
hkl
HKLM
hlocal
hlsl
HMB
Expand Down Expand Up @@ -1735,6 +1739,7 @@ swapchain
swapchainpanel
SWMR
SWP
swrapped
SYMED
SYNCPAINT
syscalls
Expand Down Expand Up @@ -2077,6 +2082,8 @@ WNDCLASSW
Wndproc
WNegative
WNull
wordi
wordiswrapped
workarea
WOutside
WOWARM
Expand All @@ -2090,6 +2097,7 @@ WPrep
WPresent
wprp
wprpi
wrappe
wregex
writeback
WRITECONSOLE
Expand Down
28 changes: 28 additions & 0 deletions policies/WindowsTerminal.admx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="utf-8"?>

Check failure

Code scanning / check-spelling

Check File Path

[admx](#security-tab) is not a recognized word. \(check-file-path\)
Copy link

@5345635386 5345635386 Nov 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check File Path

admx is not a recognized word. (check-file-path)

Show more details

c82ab28

<!-- (c) 2024 Microsoft Corporation -->
<policyDefinitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="1.0" schemaVersion="1.0" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
<policyNamespaces>
<target prefix="terminal" namespace="Microsoft.Policies.WindowsTerminal" />
<using prefix="windows" namespace="Microsoft.Policies.Windows" />
</policyNamespaces>
<resources minRequiredRevision="1.0" />
<supportedOn>
<definitions>
<definition name="SUPPORTED_WindowsTerminal_1_21" displayName="$(string.SUPPORTED_WindowsTerminal_1_21)" />
</definitions>
</supportedOn>
<categories>
<category name="WindowsTerminal" displayName="$(string.WindowsTerminal)">
<parentCategory ref="windows:WindowsComponents" />
</category>
</categories>
<policies>
<policy name="DisabledProfileSources" class="Both" displayName="$(string.DisabledProfileSources)" explainText="$(string.DisabledProfileSourcesText)" presentation="$(presentation.DisabledProfileSources)" key="Software\Policies\Microsoft\Windows Terminal">
<parentCategory ref="WindowsTerminal" />
<supportedOn ref="SUPPORTED_WindowsTerminal_1_21" />
<elements>
<multiText id="DisabledProfileSources" valueName="DisabledProfileSources" required="true" />
</elements>
</policy>
</policies>
</policyDefinitions>
28 changes: 28 additions & 0 deletions policies/en-US/WindowsTerminal.adml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- (c) 2024 Microsoft Corporation -->
<policyDefinitionResources xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="1.0" schemaVersion="1.0" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
<displayName>Windows Terminal</displayName>
<description>Windows Terminal</description>
<resources>
<stringTable>
<string id="WindowsTerminal">Windows Terminal</string>
<string id="SUPPORTED_WindowsTerminal_1_21">At least Windows Terminal 1.21</string>
<string id="DisabledProfileSources">Disabled Profile Sources</string>
<string id="DisabledProfileSourcesText">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.</string>
</stringTable>
<presentationTable>
<presentation id="DisabledProfileSources">
<multiTextBox refId="DisabledProfileSources">List of disabled sources (one per line)</multiTextBox>
</presentation>
</presentationTable>
</resources>
</policyDefinitionResources>
2 changes: 1 addition & 1 deletion src/cascadia/TerminalSettingsModel/CascadiaSettings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
void _addOrMergeUserColorScheme(const winrt::com_ptr<implementation::ColorScheme>& colorScheme);
void _executeGenerator(const IDynamicProfileGenerator& generator);

std::unordered_set<std::wstring_view> _ignoredNamespaces;
std::unordered_set<winrt::hstring, til::transparent_hstring_hash, til::transparent_hstring_equal_to> _ignoredNamespaces;
std::set<std::string> themesChangeLog;
// See _getNonUserOriginProfiles().
size_t _userProfileCount = 0;
Expand Down
28 changes: 23 additions & 5 deletions src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<uint32_t>(len));
p += len + 1;
}
break;
}
}

Expand Down Expand Up @@ -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 });
}
Expand Down Expand Up @@ -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;
}
Expand Down Expand Up @@ -914,7 +932,7 @@ void SettingsLoader::_addOrMergeUserColorScheme(const winrt::com_ptr<implementat
void SettingsLoader::_executeGenerator(const IDynamicProfileGenerator& generator)
{
const auto generatorNamespace = generator.GetNamespace();
if (_ignoredNamespaces.count(generatorNamespace))
if (_ignoredNamespaces.contains(generatorNamespace))
{
return;
}
Expand Down
20 changes: 20 additions & 0 deletions src/inc/til/winrt.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,24 @@ namespace til // Terminal Implementation Library. Also: "Today I Learned"
// Which is just silly

#endif

struct transparent_hstring_hash
{
using is_transparent = void;

size_t operator()(const auto& hstr) const noexcept
{
return std::hash<std::wstring_view>{}(hstr);
}
};

struct transparent_hstring_equal_to
{
using is_transparent = void;

bool operator()(const auto& lhs, const auto& rhs) const noexcept
{
return lhs == rhs;
}
};
}