Skip to content

Optimize Windows Defender exclusion script with native PowerShell #2930 #2939

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -342,14 +342,12 @@ public static String createAddExclusionsPowershellCommand(String extraSeparator)
//
// For .NET's stream API called LINQ see:
// https://learn.microsoft.com/en-us/dotnet/api/system.linq.enumerable
Copy link
Member

Choose a reason for hiding this comment

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

This entire comment block (starting at its first line) can be replaced by the following:

		// For detailed explanations about how to add new exclusions see:
		// https://learn.microsoft.com/en-us/powershell/module/defender/add-mppreference?view=windowsserver2019-ps

String excludedPaths = paths.stream().map(Path::toString).map(p -> '"' + p + '"')
.collect(Collectors.joining(',' + extraSeparator));
final String exclusionType = "ExclusionProcess"; //$NON-NLS-1$
return String.join(';' + extraSeparator, "$exclusions=@(" + extraSeparator + excludedPaths + ')', //$NON-NLS-1$
"$existingExclusions=[Collections.Generic.HashSet[String]](Get-MpPreference)." + exclusionType, //$NON-NLS-1$
"if($existingExclusions -eq $null) { $existingExclusions = New-Object Collections.Generic.HashSet[String] }", //$NON-NLS-1$
"$exclusionsToAdd=[Linq.Enumerable]::ToArray([Linq.Enumerable]::Where($exclusions,[Func[object,bool]]{param($ex)!$existingExclusions.Contains($ex)}))", //$NON-NLS-1$
"if($exclusionsToAdd.Length -gt 0){ Add-MpPreference -" + exclusionType + " $exclusionsToAdd }"); //$NON-NLS-1$ //$NON-NLS-2$
String excludedPaths = paths.stream().map(Path::toString).map(p -> "'" + p.replace("'", "''") + "'")
Copy link
Member

Choose a reason for hiding this comment

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

Can you please explain the advantage of using single-quotes (and escaping them) over double-quotes in a powershell script? As far as I can tell double-quotes are not allowed in Windows paths and therefore don't have to be escaped.

.collect(Collectors.joining(','));
Copy link
Member

Choose a reason for hiding this comment

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

Please keep the addition of the extraSeparator as otherwise the formatting in the preferences view doesn't look good.

Suggested change
.collect(Collectors.joining(','));
.collect(Collectors.joining(',' + extraSeparator));

return String.join(";",
"$pathsToExclude = @(" + excludedPaths + ")",
"Add-MpPreference -ExclusionProcess $pathsToExclude"
Comment on lines +347 to +349
Copy link
Member

Choose a reason for hiding this comment

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

Please keep the extraSeparators here as well and keep the name of the name of the variable:

Suggested change
return String.join(";",
"$pathsToExclude = @(" + excludedPaths + ")",
"Add-MpPreference -ExclusionProcess $pathsToExclude"
return String.join(';' + extraSeparator, "$exclusions=@(" + extraSeparator + excludedPaths + ')', //$NON-NLS-1$
"Add-MpPreference -ExclusionProcess $pathsToExclude"

Alternatively, as the script seems now easy enough, we could skip the creation of a variable and just pass the string-array directly to make it even more compact:

Suggested change
return String.join(";",
"$pathsToExclude = @(" + excludedPaths + ")",
"Add-MpPreference -ExclusionProcess $pathsToExclude"
return "Add-MpPreference -ExclusionProcess " + extraSeparator + excludedPaths; //$NON-NLS-1$

);
}

private static void excludeDirectoryFromScanning(IProgressMonitor monitor) throws IOException {
Expand Down
Loading