Skip to content

refactor(agent-installer): deduplicate helper registry values #1992

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

Open
Benoît Cortier (CBenoit) wants to merge 1 commit into
base: cbenoit-agent-policy-consent-helper
Choose a base branch
from
Open

refactor(agent-installer): deduplicate helper registry values #1992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
62 changes: 55 additions & 7 deletions package/AgentWindowsManaged.Tests/PolicyConsentDiscoveryTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,22 @@ public void DiscoveryUsesTheConsumerNativeRegistryView(Platform platform, bool e
}

[Theory]
[InlineData(Platform.x86, 0)]
[InlineData(Platform.x64, 7)]
[InlineData(Platform.arm64, 7)]
public void NativeAgentMsiPublishesDiscoveryFor32BitConsumers(Platform platform, int expectedCount)
[InlineData(Platform.x86, 7)]
[InlineData(Platform.x64, 14)]
[InlineData(Platform.arm64, 14)]
public void AgentMsiPublishesDiscoveryInRequiredRegistryViews(
Platform platform,
int expectedCount)
{
Type program = System.Reflection.Assembly
.Load("DevolutionsAgent")
.GetType("DevolutionsAgent.Program", throwOnError: true);
MethodInfo method = program.GetMethod(
"CreatePolicyConsentRegistryValuesFor32BitConsumers",
BindingFlags.Static | BindingFlags.NonPublic);
"CreatePolicyConsentRegistryValues",
BindingFlags.Static | BindingFlags.NonPublic,
binder: null,
types: [typeof(Platform?), typeof(Version)],
modifiers: null);

RegValue[] values = Assert.IsAssignableFrom<System.Collections.Generic.IEnumerable<RegValue>>(
method.Invoke(null, [platform, new Version(2026, 3, 0)]))
Expand All @@ -62,9 +67,52 @@ public void NativeAgentMsiPublishesDiscoveryFor32BitConsumers(Platform platform,
Assert.Equal(expectedCount, values.Length);
Assert.All(values, value =>
{
Assert.False(value.Win64);
Assert.Equal(RegistryKeyAction.createAndRemoveOnUninstall, value.RegistryKeyAction);
});
Assert.Equal(
new[]
{
"ProtocolVersion",
"ExecutableName",
"ExecutablePath",
"ProductName",
"ProductVersion",
"BrokerPipeName",
"CurrentUiSignerSpkiSha256",
},
values.Take(7).Select(value => value.Name));
Assert.Equal(
new[]
{
"2.0",
"DevolutionsAgentPolicyConsent.exe",
"[INSTALLDIR]DevolutionsAgentPolicyConsent.exe",
"Devolutions Agent Policy Consent",
"2026.3.0",
@"\\.\pipe\Devolutions.Now.PackageBroker.v1",
"e43ed3368eaabff61abc79eb338cba9da88a80d93b751735ff417f26afa579a8",
},
values.Take(7).Select(value => value.Value));
Assert.All(values.Take(7), value =>
{
Assert.Equal(platform != Platform.x86, value.Win64);
Assert.Equal(
platform == Platform.x86 ? "Type=string" : "Type=string; Component:Win64=yes",
value.AttributesDefinition);
});

if (platform == Platform.x86)
{
return;
}

Assert.Equal(values.Take(7).Select(value => value.Name), values.Skip(7).Select(value => value.Name));
Assert.Equal(values.Take(7).Select(value => value.Value), values.Skip(7).Select(value => value.Value));
Assert.All(values.Skip(7), value =>
{
Assert.False(value.Win64);
Assert.Equal("Type=string", value.AttributesDefinition);
});
}

[Fact]
Expand Down
89 changes: 34 additions & 55 deletions package/AgentWindowsManaged/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,34 +339,6 @@ static void Main()
Win64 = project.Platform == Platform.x64,
RegistryKeyAction = RegistryKeyAction.create,
},
CreatePolicyConsentRegistryValue(
"ProtocolVersion",
Includes.POLICY_CONSENT_PROTOCOL_VERSION,
Use64BitRegistryView(project.Platform)),
CreatePolicyConsentRegistryValue(
"ExecutableName",
Includes.POLICY_CONSENT_EXECUTABLE_NAME,
Use64BitRegistryView(project.Platform)),
CreatePolicyConsentRegistryValue(
"ExecutablePath",
$"[{AgentProperties.InstallDir}]{Includes.POLICY_CONSENT_EXECUTABLE_NAME}",
Use64BitRegistryView(project.Platform)),
CreatePolicyConsentRegistryValue(
"ProductName",
Includes.POLICY_CONSENT_PRODUCT_NAME,
Use64BitRegistryView(project.Platform)),
CreatePolicyConsentRegistryValue(
"ProductVersion",
DevolutionsAgentProductVersion.ToString(),
Use64BitRegistryView(project.Platform)),
CreatePolicyConsentRegistryValue(
"BrokerPipeName",
Includes.POLICY_CONSENT_DEFAULT_BROKER_PIPE_NAME,
Use64BitRegistryView(project.Platform)),
CreatePolicyConsentRegistryValue(
"CurrentUiSignerSpkiSha256",
Includes.POLICY_CONSENT_CURRENT_UI_SIGNER_SPKI_SHA256,
Use64BitRegistryView(project.Platform)),
new (RegistryHive.LocalMachine, "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run", Includes.SERVICE_NAME, $"[{AgentProperties.InstallDir}]{Includes.DESKTOP_DIRECTORY_NAME}\\{Includes.DESKTOP_EXECUTABLE_NAME}")
{
Win64 = project.Platform == Platform.x64,
Expand Down Expand Up @@ -394,7 +366,7 @@ static void Main()
CreateEventLogSourceRegistryValue(project.Platform == Platform.x64),
};
project.RegValues = project.RegValues
.Concat(CreatePolicyConsentRegistryValuesFor32BitConsumers(project.Platform, DevolutionsAgentProductVersion))
.Concat(CreatePolicyConsentRegistryValues(project.Platform, DevolutionsAgentProductVersion))
.ToArray();

List<Property> projectProperties = AgentProperties.Properties.Select(x => x.ToWixSharpProperty()).ToList();
Expand Down Expand Up @@ -498,47 +470,54 @@ internal static RegValue CreatePolicyConsentRegistryValue(string name, string va
internal static bool Use64BitRegistryView(Platform? platform) =>
platform is Platform.x64 or Platform.arm64;

internal static IEnumerable<RegValue> CreatePolicyConsentRegistryValuesFor32BitConsumers(
internal static IEnumerable<RegValue> CreatePolicyConsentRegistryValues(
Platform? platform,
Version productVersion)
{
if (!Use64BitRegistryView(platform))
bool nativeRegistryViewIs64Bit = Use64BitRegistryView(platform);
IEnumerable<RegValue> nativeRegistryValues = CreatePolicyConsentRegistryValues(
productVersion,
nativeRegistryViewIs64Bit);

if (!nativeRegistryViewIs64Bit)
{
return [];
return nativeRegistryValues;
}

return
return nativeRegistryValues.Concat(CreatePolicyConsentRegistryValues(productVersion, false));
}

private static IEnumerable<RegValue> CreatePolicyConsentRegistryValues(
Version productVersion,
bool win64) =>
CreatePolicyConsentDiscoveryValues(productVersion)
.Select(value => CreatePolicyConsentRegistryValue(value.Name, value.Value, win64));

private static IEnumerable<(string Name, string Value)> CreatePolicyConsentDiscoveryValues(
Version productVersion) =>
[
CreatePolicyConsentRegistryValue(
(
"ProtocolVersion",
Includes.POLICY_CONSENT_PROTOCOL_VERSION,
false),
CreatePolicyConsentRegistryValue(
Includes.POLICY_CONSENT_PROTOCOL_VERSION),
(
"ExecutableName",
Includes.POLICY_CONSENT_EXECUTABLE_NAME,
false),
CreatePolicyConsentRegistryValue(
Includes.POLICY_CONSENT_EXECUTABLE_NAME),
(
"ExecutablePath",
$"[{AgentProperties.InstallDir}]{Includes.POLICY_CONSENT_EXECUTABLE_NAME}",
false),
CreatePolicyConsentRegistryValue(
$"[{AgentProperties.InstallDir}]{Includes.POLICY_CONSENT_EXECUTABLE_NAME}"),
(
"ProductName",
Includes.POLICY_CONSENT_PRODUCT_NAME,
false),
CreatePolicyConsentRegistryValue(
Includes.POLICY_CONSENT_PRODUCT_NAME),
(
"ProductVersion",
productVersion.ToString(),
false),
CreatePolicyConsentRegistryValue(
productVersion.ToString()),
(
"BrokerPipeName",
Includes.POLICY_CONSENT_DEFAULT_BROKER_PIPE_NAME,
false),
CreatePolicyConsentRegistryValue(
Includes.POLICY_CONSENT_DEFAULT_BROKER_PIPE_NAME),
(
"CurrentUiSignerSpkiSha256",
Includes.POLICY_CONSENT_CURRENT_UI_SIGNER_SPKI_SHA256,
false),
Includes.POLICY_CONSENT_CURRENT_UI_SIGNER_SPKI_SHA256),
];
}

private static void Project_UnhandledException(ExceptionEventArgs e)
{
Expand Down
Loading