-
Notifications
You must be signed in to change notification settings - Fork 327
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement GPO and add administrative templates (#3965)
- Loading branch information
Showing
6 changed files
with
185 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
// Copyright (c) Microsoft Corporation. | ||
// Licensed under the MIT License. | ||
|
||
using Microsoft.Win32; | ||
using Serilog; | ||
|
||
namespace DevHome.Common.Helpers; | ||
|
||
public class GPOHelper | ||
{ | ||
private static readonly ILogger _log = Log.ForContext("SourceContext", nameof(GPOHelper)); | ||
|
||
private enum GpoRuleConfigured | ||
{ | ||
WrongValue = -3, // The policy is set to an unrecognized value | ||
Unavailable = -2, // Couldn't access registry | ||
NotConfigured = -1, // Policy is not configured | ||
Disabled = 0, // Policy is disabled | ||
Enabled = 1, // Policy is enabled | ||
} | ||
|
||
// Registry path where gpo policy values are stored | ||
private const string PoliciesScopeMachine = "HKEY_LOCAL_MACHINE"; | ||
private const string PoliciesPath = @"\SOFTWARE\Policies\DevHome"; | ||
|
||
// Registry value names | ||
private const string PolicyConfigureEnabledDevHome = "ConfigureEnabledDevHome"; | ||
|
||
private static GpoRuleConfigured GetConfiguredValue(string registryValueName) | ||
{ | ||
try | ||
{ | ||
var rawValue = Registry.GetValue( | ||
keyName: PoliciesScopeMachine + PoliciesPath, | ||
valueName: registryValueName, | ||
defaultValue: GpoRuleConfigured.NotConfigured); | ||
|
||
_log.Error($"Registry value {registryValueName} set to {rawValue}"); | ||
|
||
// Value will be null if the subkey specified by keyName does not exist. | ||
if (rawValue == null) | ||
{ | ||
return GpoRuleConfigured.NotConfigured; | ||
} | ||
else if (rawValue is not int && rawValue is not GpoRuleConfigured) | ||
{ | ||
return GpoRuleConfigured.WrongValue; | ||
} | ||
else | ||
{ | ||
return (GpoRuleConfigured)rawValue; | ||
} | ||
} | ||
catch (System.Security.SecurityException) | ||
{ | ||
// The user does not have the permissions required to read from the registry key. | ||
return GpoRuleConfigured.Unavailable; | ||
} | ||
catch (System.IO.IOException) | ||
{ | ||
// The RegistryKey that contains the specified value has been marked for deletion. | ||
return GpoRuleConfigured.Unavailable; | ||
} | ||
catch (System.ArgumentException) | ||
{ | ||
// keyName does not begin with a valid registry root. | ||
return GpoRuleConfigured.NotConfigured; | ||
} | ||
} | ||
|
||
private static bool EvaluateConfiguredValue(string registryValueName, GpoRuleConfigured defaultValue) | ||
{ | ||
var configuredValue = GetConfiguredValue(registryValueName); | ||
if (configuredValue < 0) | ||
{ | ||
_log.Error($"Registry value {registryValueName} set to {configuredValue}, using default {defaultValue} instead."); | ||
configuredValue = defaultValue; | ||
} | ||
|
||
return configuredValue == GpoRuleConfigured.Enabled; | ||
} | ||
|
||
public static bool GetConfiguredEnabledDevHomeValue() | ||
{ | ||
var defaultValue = GpoRuleConfigured.Enabled; | ||
return EvaluateConfiguredValue(PolicyConfigureEnabledDevHome, defaultValue); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<!-- Copyright (c) Microsoft Corporation. | ||
Licensed under the MIT License. --> | ||
<policyDefinitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="0.1900" schemaVersion="1.0" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions"> | ||
<policyNamespaces> | ||
<target prefix="devhome" namespace="Microsoft.Policies.DevHome" /> | ||
</policyNamespaces> | ||
<resources minRequiredRevision="0.1900"/> | ||
<supportedOn> | ||
<definitions> | ||
<definition name="SUPPORTED_DEVHOME_0_1900" displayName="$(string.SUPPORTED_DEVHOME_0_1900)"/> | ||
</definitions> | ||
</supportedOn> | ||
<categories> | ||
<category name="DevHome" displayName="$(string.DevHome)" /> | ||
</categories> | ||
|
||
<policies> | ||
|
||
<!--The name (id) of the policy is different from the valueName to sort it as first policy in edit dialog. The order is sorted alphabetically based on the "name" property.--> | ||
<policy name="ConfigureAllDevHomeEnabledState" class="Both" displayName="$(string.ConfigureAllDevHomeEnabledState)" explainText="$(string.ConfigureAllDevHomeEnabledStateDescription)" key="Software\Policies\DevHome" valueName="ConfigureEnabledDevHome"> | ||
<parentCategory ref="DevHome" /> | ||
<supportedOn ref="SUPPORTED_DEVHOME_0_1901" /> | ||
<enabledValue> | ||
<decimal value="1" /> | ||
</enabledValue> | ||
<disabledValue> | ||
<decimal value="0" /> | ||
</disabledValue> | ||
</policy> | ||
</policies> | ||
</policyDefinitions> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<!-- Copyright (c) Microsoft Corporation. | ||
Licensed under the MIT License. --> | ||
<policyDefinitionResources xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="0.1900" schemaVersion="1.0" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions"> | ||
<displayName>Dev Home</displayName> | ||
<description>Dev Home</description> | ||
<resources> | ||
<stringTable> | ||
<string id="DevHome">Microsoft Dev Home</string> | ||
|
||
<string id="SUPPORTED_DEVHOME_0_1900">Dev Home version 0.1900.* or later</string> | ||
|
||
<string id="ConfigureAllDevHomeEnabledStateDescription">This policy configures the enabled state for Dev Home. | ||
|
||
If you enable this setting, Dev Home will be always enabled and the user won't be able to disable it. | ||
|
||
If you disable this setting, Dev Home will be always disabled and the user won't be able to enable it. | ||
|
||
If you don't configure this setting, users are able to enable or disable Dev Home. | ||
|
||
This policy will override any enabled state policies for individual Dev Home features. | ||
</string> | ||
|
||
<string id="ConfigureAllDevHomeEnabledState">Configure Dev Home enabled state</string> | ||
</stringTable> | ||
|
||
</resources> | ||
</policyDefinitionResources> | ||
|