SEBWIN-401: Implemented fix for VMware issue: The registry values wil…

…l now only be set if the active configuration explicity says so.

SafeExamBrowser.Configuration/ConfigurationData/DataMapping/ServiceDataMapper.cs

@@ -46,12 +46,15 @@ internal override void Map(string key, object value, AppSettings settings)
 				case Keys.Service.EnableUserSwitch:
 					MapEnableUserSwitch(settings, value);
 					break;
-				case Keys.Service.EnableVmWareOverlay:
-					MapEnableVmWareOverlay(settings, value);
+				case Keys.Service.EnableVmwareOverlay:
+					MapEnableVmwareOverlay(settings, value);
 					break;
 				case Keys.Service.EnableWindowsUpdate:
 					MapEnableWindowsUpdate(settings, value);
 					break;
+				case Keys.Service.SetVmwareConfiguration:
+					MapSetVmwareConfiguration(settings, value);
+					break;
 			}
 		}
 
@@ -135,7 +138,7 @@ private void MapEnableUserSwitch(AppSettings settings, object value)
 			}
 		}
 
-		private void MapEnableVmWareOverlay(AppSettings settings, object value)
+		private void MapEnableVmwareOverlay(AppSettings settings, object value)
 		{
 			if (value is bool enable)
 			{
@@ -150,5 +153,13 @@ private void MapEnableWindowsUpdate(AppSettings settings, object value)
 				settings.Service.DisableWindowsUpdate = !enable;
 			}
 		}
+
+		private void MapSetVmwareConfiguration(AppSettings settings, object value)
+		{
+			if (value is bool set)
+			{
+				settings.Service.SetVmwareConfiguration = set;
+			}
+		}
 	}
 }

SafeExamBrowser.Configuration/ConfigurationData/DataValues.cs

@@ -185,6 +185,7 @@ internal AppSettings LoadDefaultSettings()
 			settings.Service.DisableVmwareOverlay = true;
 			settings.Service.DisableWindowsUpdate = true;
 			settings.Service.Policy = ServicePolicy.Mandatory;
+			settings.Service.SetVmwareConfiguration = false;
 
 			settings.Taskbar.EnableTaskbar = true;
 			settings.Taskbar.ShowApplicationInfo = false;

SafeExamBrowser.Configuration/ConfigurationData/Keys.cs

@@ -228,8 +228,9 @@ internal static class Service
 			internal const string EnableTaskManager = "insideSebEnableStartTaskManager";
 			internal const string EnableUserLock = "insideSebEnableLockThisComputer";
 			internal const string EnableUserSwitch = "insideSebEnableSwitchUser";
-			internal const string EnableVmWareOverlay = "insideSebEnableVmWareClientShade";
+			internal const string EnableVmwareOverlay = "insideSebEnableVmWareClientShade";
 			internal const string EnableWindowsUpdate = "enableWindowsUpdate";
+			internal const string SetVmwareConfiguration = "setVmwareConfiguration";
 		}
 
 		internal static class UserInterface

SafeExamBrowser.Service.UnitTests/Operations/LockdownOperationTests.cs

@@ -12,11 +12,11 @@
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Moq;
 using SafeExamBrowser.Configuration.Contracts;
-using SafeExamBrowser.Settings;
 using SafeExamBrowser.Core.Contracts.OperationModel;
 using SafeExamBrowser.Lockdown.Contracts;
 using SafeExamBrowser.Logging.Contracts;
 using SafeExamBrowser.Service.Operations;
+using SafeExamBrowser.Settings;
 
 namespace SafeExamBrowser.Service.UnitTests.Operations
 {
@@ -58,6 +58,7 @@ public void Perform_MustSetConfigurationsCorrectly()
 			settings.Service.DisableChromeNotifications = true;
 			settings.Service.DisableEaseOfAccessOptions = true;
 			settings.Service.DisableSignout = true;
+			settings.Service.SetVmwareConfiguration = true;
 
 			var result = sut.Perform();
 
@@ -72,6 +73,28 @@ public void Perform_MustSetConfigurationsCorrectly()
 			Assert.AreEqual(OperationResult.Success, result);
 		}
 
+		[TestMethod]
+		public void Perform_MustOnlySetVmwareConfigurationIfEnabled()
+		{
+			var configuration = new Mock<IFeatureConfiguration>();
+
+			configuration.SetReturnsDefault(true);
+			factory.SetReturnsDefault(configuration.Object);
+			settings.Service.SetVmwareConfiguration = true;
+
+			sut.Perform();
+
+			factory.Verify(f => f.CreateVmwareOverlayConfiguration(It.IsAny<Guid>(), It.IsAny<string>(), It.IsAny<string>()), Times.Once);
+
+			factory.Reset();
+			factory.SetReturnsDefault(configuration.Object);
+			settings.Service.SetVmwareConfiguration = false;
+
+			sut.Perform();
+
+			factory.Verify(f => f.CreateVmwareOverlayConfiguration(It.IsAny<Guid>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never);
+		}
+
 		[TestMethod]
 		public void Perform_MustUseSameGroupForAllConfigurations()
 		{
@@ -84,6 +107,7 @@ public void Perform_MustUseSameGroupForAllConfigurations()
 				.Returns(configuration.Object)
 				.Callback<Guid, string, string>((id, name, sid) => groupId = id);
 			factory.SetReturnsDefault(configuration.Object);
+			settings.Service.SetVmwareConfiguration = true;
 
 			sut.Perform();
 

SafeExamBrowser.Service/Operations/LockdownOperation.cs

@@ -7,6 +7,7 @@
  */
 
 using System;
+using System.Collections.Generic;
 using SafeExamBrowser.Core.Contracts.OperationModel;
 using SafeExamBrowser.Lockdown.Contracts;
 using SafeExamBrowser.Logging.Contracts;
@@ -41,7 +42,7 @@ public override OperationResult Perform()
 			var success = true;
 			var sid = Context.Configuration.UserSid;
 			var userName = Context.Configuration.UserName;
-			var configurations = new []
+			var configurations = new List<(IFeatureConfiguration, bool)>
 			{
 				(factory.CreateChangePasswordConfiguration(groupId, sid, userName), Context.Configuration.Settings.Service.DisablePasswordChange),
 				(factory.CreateChromeNotificationConfiguration(groupId, sid, userName), Context.Configuration.Settings.Service.DisableChromeNotifications),
@@ -54,10 +55,14 @@ public override OperationResult Perform()
 				(factory.CreateSwitchUserConfiguration(groupId), Context.Configuration.Settings.Service.DisableUserSwitch),
 				(factory.CreateTaskManagerConfiguration(groupId, sid, userName), Context.Configuration.Settings.Service.DisableTaskManager),
 				(factory.CreateUserPowerOptionsConfiguration(groupId, sid, userName), Context.Configuration.Settings.Service.DisablePowerOptions),
-				(factory.CreateVmwareOverlayConfiguration(groupId, sid, userName), Context.Configuration.Settings.Service.DisableVmwareOverlay),
 				(factory.CreateWindowsUpdateConfiguration(groupId), Context.Configuration.Settings.Service.DisableWindowsUpdate)
 			};
 
+			if (Context.Configuration.Settings.Service.SetVmwareConfiguration)
+			{
+				configurations.Add((factory.CreateVmwareOverlayConfiguration(groupId, sid, userName), Context.Configuration.Settings.Service.DisableVmwareOverlay));
+			}
+
 			logger.Info($"Attempting to perform lockdown (feature configuration group: {groupId})...");
 
 			foreach (var (configuration, disable) in configurations)

SafeExamBrowser.Settings/Service/ServiceSettings.cs

@@ -77,5 +77,10 @@ public class ServiceSettings
 		/// The active policy for the service component.
 		/// </summary>
 		public ServicePolicy Policy { get; set; }
+
+		/// <summary>
+		/// Determines whether the VMware configuration will be set by the service.
+		/// </summary>
+		public bool SetVmwareConfiguration { get; set; }
 	}
 }

SebWindowsConfig/SEBSettings.cs

@@ -386,6 +386,7 @@ public class SEBSettings
 		public const String KeyInsideSebEnableEaseOfAccess      = "insideSebEnableEaseOfAccess";
 		public const String KeyInsideSebEnableVmWareClientShade = "insideSebEnableVmWareClientShade";
 		public const String KeyInsideSebEnableNetworkConnectionSelector = "insideSebEnableNetworkConnectionSelector";
+		public const String KeySetVmwareConfiguration = "setVmwareConfiguration";
 
 		// Group "Hooked Keys"
 		public const String KeyHookKeys = "hookKeys";
@@ -929,6 +930,7 @@ public static void CreateDefaultAndCurrentSettingsFromScratch()
 			SEBSettings.settingsDefault.Add(SEBSettings.KeyInsideSebEnableEaseOfAccess     , false);
 			SEBSettings.settingsDefault.Add(SEBSettings.KeyInsideSebEnableVmWareClientShade, false);
 			SEBSettings.settingsDefault.Add(SEBSettings.KeyInsideSebEnableNetworkConnectionSelector, false);
+			SEBSettings.settingsDefault.Add(SEBSettings.KeySetVmwareConfiguration, false);
 
 			// Default settings for group "Hooked Keys"
 			SEBSettings.settingsDefault.Add(SEBSettings.KeyHookKeys, true);

SebWindowsConfig/SebWindowsConfigForm.cs

@@ -805,6 +805,8 @@ private void UpdateAllWidgetsOfProgram()
 			checkBoxInsideSebEnableLogOff           .Checked = (Boolean)SEBSettings.settingsCurrent[SEBSettings.KeyInsideSebEnableLogOff];
 			checkBoxInsideSebEnableShutDown         .Checked = (Boolean)SEBSettings.settingsCurrent[SEBSettings.KeyInsideSebEnableShutDown];
 			checkBoxInsideSebEnableEaseOfAccess     .Checked = (Boolean)SEBSettings.settingsCurrent[SEBSettings.KeyInsideSebEnableEaseOfAccess];
+			checkBoxSetVmwareConfiguration.Checked = (Boolean)SEBSettings.settingsCurrent[SEBSettings.KeySetVmwareConfiguration];
+			checkBoxInsideSebEnableVmWareClientShade.Enabled = checkBoxSetVmwareConfiguration.Checked;
 			checkBoxInsideSebEnableVmWareClientShade.Checked = (Boolean)SEBSettings.settingsCurrent[SEBSettings.KeyInsideSebEnableVmWareClientShade];
 			checkBoxInsideSebEnableNetworkConnectionSelector.Checked = (Boolean)SEBSettings.settingsCurrent[SEBSettings.KeyInsideSebEnableNetworkConnectionSelector];
 
@@ -4550,5 +4552,11 @@ private void checkBoxAllowPdfReaderToolbar_CheckedChanged(object sender, EventAr
 		{
 			SEBSettings.settingsCurrent[SEBSettings.KeyAllowPDFReaderToolbar] = checkBoxAllowPdfReaderToolbar.Checked;
 		}
+
+		private void checkBoxSetVmwareConfiguration_CheckedChanged(object sender, EventArgs e)
+		{
+			SEBSettings.settingsCurrent[SEBSettings.KeySetVmwareConfiguration] = checkBoxSetVmwareConfiguration.Checked;
+			checkBoxInsideSebEnableVmWareClientShade.Enabled = checkBoxSetVmwareConfiguration.Checked;
+		}
 	}
 }