Skip to content
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.

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

Don't enable/disable admin settings if group policy prevents it #2683

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions src/AppInstallerCLICore/Resources.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,10 @@ namespace AppInstaller::CLI::Resource
WINGET_DEFINE_RESOURCE_STRINGID(DependenciesManagementError);
WINGET_DEFINE_RESOURCE_STRINGID(DependenciesManagementExitMessage);
WINGET_DEFINE_RESOURCE_STRINGID(DisabledByGroupPolicy);
WINGET_DEFINE_RESOURCE_STRINGID(DisableAdminSettingFailed);
WINGET_DEFINE_RESOURCE_STRINGID(DisableInteractivityArgumentDescription);
WINGET_DEFINE_RESOURCE_STRINGID(Done);
WINGET_DEFINE_RESOURCE_STRINGID(EnableAdminSettingFailed);
WINGET_DEFINE_RESOURCE_STRINGID(ExactArgumentDescription);
WINGET_DEFINE_RESOURCE_STRINGID(ExperimentalArgumentDescription);
WINGET_DEFINE_RESOURCE_STRINGID(ExperimentalCommandLongDescription);
Expand Down
32 changes: 27 additions & 5 deletions src/AppInstallerCLICore/Workflows/SettingsFlow.cpp
Original file line number Diff line number Diff line change
@@ -1,25 +1,47 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#include "pch.h"
#include "Resources.h"
#include "SettingsFlow.h"
#include <AppInstallerStrings.h>
#include <winget/UserSettings.h>
#include <winget/AdminSettings.h>
#include "Resources.h"

namespace AppInstaller::CLI::Workflow
{
using namespace AppInstaller::Settings;
using namespace AppInstaller::Utility;

void EnableAdminSetting(Execution::Context& context)
{
Settings::EnableAdminSetting(Settings::StringToAdminSetting(context.Args.GetArg(Execution::Args::Type::AdminSettingEnable)));
context.Reporter.Info() << Resource::String::AdminSettingEnabled;
std::string_view adminSettingString = context.Args.GetArg(Execution::Args::Type::AdminSettingEnable);
AdminSetting adminSetting = Settings::StringToAdminSetting(adminSettingString);
if (Settings::EnableAdminSetting(adminSetting))
{
context.Reporter.Info() << Resource::String::AdminSettingEnabled;
}
else
{
std::string adminSettingErrorMessage = Resource::LocString{ Resource::String::EnableAdminSettingFailed };
context.Reporter.Error() <<
Utility::LocIndString{ FindAndReplaceMessageToken(adminSettingErrorMessage, adminSettingString) };
}
}

void DisableAdminSetting(Execution::Context& context)
{
Settings::DisableAdminSetting(Settings::StringToAdminSetting(context.Args.GetArg(Execution::Args::Type::AdminSettingDisable)));
context.Reporter.Info() << Resource::String::AdminSettingDisabled;
std::string_view adminSettingString = context.Args.GetArg(Execution::Args::Type::AdminSettingDisable);
AdminSetting adminSetting = Settings::StringToAdminSetting(adminSettingString);
if (Settings::DisableAdminSetting(adminSetting))
{
context.Reporter.Info() << Resource::String::AdminSettingDisabled;
}
else
{
std::string adminSettingErrorMessage = Resource::LocString{ Resource::String::DisableAdminSettingFailed };
context.Reporter.Error() <<
Utility::LocIndString{ FindAndReplaceMessageToken(adminSettingErrorMessage, adminSettingString) };
}
}

void OpenUserSetting(Execution::Context& context)
Expand Down
8 changes: 8 additions & 0 deletions src/AppInstallerCLIPackage/Shared/Strings/en-us/winget.resw
Original file line number Diff line number Diff line change
Expand Up @@ -1475,4 +1475,12 @@ Please specify one of them using the `--source` option to proceed.</value>
<data name="PackageAlreadyInstalled" xml:space="preserve">
<value>A package version is already installed. Installation cancelled.</value>
</data>
<data name="EnableAdminSettingFailed" xml:space="preserve">
<value>Cannot enable %1. This setting is controlled by policy. For more information contact your system administrator.</value>
AmelBawa-msft marked this conversation as resolved.
Show resolved Hide resolved
<comment>{Locked="%1"} The value will be replaced with the feature name</comment>
</data>
<data name="DisableAdminSettingFailed" xml:space="preserve">
<value>Cannot disable %1. This setting is controlled by policy. For more information contact your system administrator.</value>
<comment>{Locked="%1"} The value will be replaced with the feature name</comment>
</data>
</root>
63 changes: 63 additions & 0 deletions src/AppInstallerCLITests/AdminSettings.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#include "pch.h"
#include "TestCommon.h"
#include "TestSettings.h"
#include <winget/AdminSettings.h>

using namespace AppInstaller::Settings;
using namespace TestCommon;

TEST_CASE("AdminSetting_Enable", "[adminSettings]")
{
WHEN("Group policy")
{
SECTION("Not configured")
{
GroupPolicyTestOverride policies;
policies.SetState(TogglePolicy::Policy::LocalManifestFiles, PolicyState::NotConfigured);
REQUIRE(EnableAdminSetting(AdminSetting::LocalManifestFiles));
}

SECTION("Enabled")
{
GroupPolicyTestOverride policies;
policies.SetState(TogglePolicy::Policy::LocalManifestFiles, PolicyState::Enabled);
REQUIRE(EnableAdminSetting(AdminSetting::LocalManifestFiles));
}

SECTION("Disabled")
{
GroupPolicyTestOverride policies;
policies.SetState(TogglePolicy::Policy::LocalManifestFiles, PolicyState::Disabled);
REQUIRE_FALSE(EnableAdminSetting(AdminSetting::LocalManifestFiles));
}
}
}

TEST_CASE("AdminSetting_Disable", "[adminSettings]")
{
WHEN("Group policy")
{
SECTION("Not configured")
{
GroupPolicyTestOverride policies;
policies.SetState(TogglePolicy::Policy::LocalManifestFiles, PolicyState::NotConfigured);
REQUIRE(DisableAdminSetting(AdminSetting::LocalManifestFiles));
}

SECTION("Enabled")
{
GroupPolicyTestOverride policies;
policies.SetState(TogglePolicy::Policy::LocalManifestFiles, PolicyState::Enabled);
REQUIRE_FALSE(DisableAdminSetting(AdminSetting::LocalManifestFiles));
}

SECTION("Disabled")
{
GroupPolicyTestOverride policies;
policies.SetState(TogglePolicy::Policy::LocalManifestFiles, PolicyState::Disabled);
REQUIRE(DisableAdminSetting(AdminSetting::LocalManifestFiles));
}
}
}
1 change: 1 addition & 0 deletions src/AppInstallerCLITests/AppInstallerCLITests.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@
<ClInclude Include="TestSource.h" />
</ItemGroup>
<ItemGroup>
<ClCompile Include="AdminSettings.cpp" />
<ClCompile Include="Archive.cpp" />
<ClCompile Include="ARPChanges.cpp" />
<ClCompile Include="Certificates.cpp" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,9 @@
<ClCompile Include="RestInterface_1_4.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="AdminSettings.cpp">
<Filter>Source Files\Common</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<None Include="PropertySheet.props" />
Expand Down
38 changes: 26 additions & 12 deletions src/AppInstallerCommonCore/AdminSettings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -181,18 +181,6 @@ namespace AppInstaller::Settings
}
}

void EnableAdminSetting(AdminSetting setting)
{
AdminSettingsInternal adminSettingsInternal;
adminSettingsInternal.SetAdminSetting(setting, true);
}

void DisableAdminSetting(AdminSetting setting)
{
AdminSettingsInternal adminSettingsInternal;
adminSettingsInternal.SetAdminSetting(setting, false);
}

TogglePolicy::Policy GetAdminSettingPolicy(AdminSetting setting)
{
switch (setting)
Expand All @@ -206,6 +194,32 @@ namespace AppInstaller::Settings
}
}

bool EnableAdminSetting(AdminSetting setting)
{
auto policy = GetAdminSettingPolicy(setting);
if (GroupPolicies().GetState(policy) == PolicyState::Disabled)
{
return false;
}

AdminSettingsInternal adminSettingsInternal;
adminSettingsInternal.SetAdminSetting(setting, true);
return true;
}

bool DisableAdminSetting(AdminSetting setting)
{
auto policy = GetAdminSettingPolicy(setting);
if (GroupPolicies().GetState(policy) == PolicyState::Enabled)
{
return false;
}

AdminSettingsInternal adminSettingsInternal;
adminSettingsInternal.SetAdminSetting(setting, false);
return true;
}

bool IsAdminSettingEnabled(AdminSetting setting)
{
// Check for a policy that overrides this setting.
Expand Down
4 changes: 2 additions & 2 deletions src/AppInstallerCommonCore/Public/winget/AdminSettings.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ namespace AppInstaller::Settings

std::string_view AdminSettingToString(AdminSetting setting);

void EnableAdminSetting(AdminSetting setting);
bool EnableAdminSetting(AdminSetting setting);

void DisableAdminSetting(AdminSetting setting);
bool DisableAdminSetting(AdminSetting setting);

bool IsAdminSettingEnabled(AdminSetting setting);
}