Add WinCompat deny list support using a setting in powershell.config.json by anmenaga · Pull Request #11726 · PowerShell/PowerShell · GitHub

PR Summary

Some Windows PowerShell modules don't work well with de/serialized objects, so they can not be used with WinCompat.
This PR adds support for an optional WindowsPowerShellCompatibilityModuleDenyList setting (a string array) in powershell.config.json so that a user can prevent specified modules from being loaded using WinCompat.
If WinCompat feature is enabled and it tries to load a module mentioned in the DenyList, then an error is generated.
Module name comparison is case-insensitive.
By default, in PowerShell packages for Windows OS, this setting will contain PSScheduledJob,BestPractices and UpdateServices modules (this list most likely will be extended in future).

Fix #11687

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- Documentation needed
  - Issue filed: Add docs about WinCompat DenyList MicrosoftDocs/PowerShell-Docs#5373
Testing - New and feature
- N/A or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

Is this needed for GA?

PoshChan-Bot (@PoshChan) Please remind me in 1 day

Codacy issue Make 'IsModuleInDenyList' a static method is wrong as it doesn't detect a call to non-static WriteError.

Paul Higinbotham (@PaulHigin) Can you update your review?

Travis Plunk (@TravisEz13), this is the reminder you requested 1 day ago

My earlier comment may have gotten buried - the WSUS module should be added to the WInCompat deny list.

Pending adding UpdateServices module to the list

…/PowerShell into WinCompatModuleDenyList

Steve Lee (@SteveL-MSFT) Please update your review?

PoshChan-Bot (@PoshChan) Please remind me in 1 hour

One NIT

Travis Plunk (@TravisEz13), this is the reminder you requested 1 hour ago

PoshChan-Bot (@PoshChan) Please remind me in 1 hour

Travis Plunk (@TravisEz13), this is the reminder you requested 1 hour ago

…rShell#11726) # Conflicts: # build.psm1 # src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs

🎉v7.0.0-rc.3 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

…rShell#11726)

WinCompat DenyList

1f0a1b5

Andrew (anmenaga) added WG-Engine core PowerShell engine, interpreter, and runtime CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log labels Jan 29, 2020

Andrew (anmenaga) requested review from Steve Lee (SteveL-MSFT) and Dongbo Wang (daxian-dbw) January 29, 2020 22:47

Andrew (anmenaga) requested review from Travis Plunk (TravisEz13) and Aditya Patwardhan (adityapatwardhan) as code owners January 29, 2020 22:47

Andrew (anmenaga) assigned Aditya Patwardhan (adityapatwardhan) Jan 29, 2020

Steve Lee (SteveL-MSFT) requested changes Jan 30, 2020

View reviewed changes

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 30, 2020

Steve Lee (SteveL-MSFT) requested a review from Rob Holt (rjmholt) January 30, 2020 00:48

Ilya (iSazonov) reviewed Jan 30, 2020

View reviewed changes

Comment thread src/System.Management.Automation/engine/PSConfiguration.cs Outdated

Comment thread src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs Outdated

Comment thread src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs Outdated

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 30, 2020

Andrew Menagarishvili added 2 commits January 30, 2020 13:47

Feedback

f1a8a00

fix Codefactor issue

7389a11

Steve Lee (SteveL-MSFT) added this to the GA-consider milestone Jan 30, 2020

Steve Lee (SteveL-MSFT) approved these changes Jan 30, 2020

View reviewed changes

Ilya (iSazonov) reviewed Jan 31, 2020

View reviewed changes

Comment thread build.psm1 Outdated

Paul Higinbotham (PaulHigin) suggested changes Jan 31, 2020

View reviewed changes

Comment thread src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs Outdated

Comment thread src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs Outdated

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 31, 2020

Dongbo Wang (daxian-dbw) modified the milestones: GA-consider, GA-approved Jan 31, 2020

Code refactoring

c630e19

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 31, 2020

Paul Higinbotham (PaulHigin) suggested changes Jan 31, 2020

View reviewed changes

Comment thread src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs Outdated

Comment thread src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs Outdated

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 31, 2020

Merge branch 'master' into WinCompatModuleDenyList

5df47e0

Ilya (iSazonov) mentioned this pull request Feb 3, 2020

Bug in 7.0.0-rc.2: Register-ScheduledJob ScriptBlock parameter doesn't work #11687

Closed

Steve Lee (SteveL-MSFT) requested changes Feb 3, 2020

View reviewed changes

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Feb 3, 2020

Andrew Menagarishvili added 2 commits February 4, 2020 10:55

Added UpdateServices to default list

b287250

Merge branch 'WinCompatModuleDenyList' of https://github.com/anmenaga…

3235e10

…/PowerShell into WinCompatModuleDenyList

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Feb 4, 2020

Travis Plunk (TravisEz13) approved these changes Feb 4, 2020

View reviewed changes

Steve Lee (SteveL-MSFT) requested changes Feb 4, 2020

View reviewed changes

Comment thread src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs Outdated

Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/CompatiblePSEditions.Module.Tests.ps1 Outdated

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Feb 4, 2020

feedback

4299a8e

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Feb 4, 2020

Steve Lee (SteveL-MSFT) approved these changes Feb 4, 2020

View reviewed changes

Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/CompatiblePSEditions.Module.Tests.ps1 Outdated

Updated tests

e13d92c

Travis Plunk (TravisEz13) merged commit 43c88a4 into PowerShell:master Feb 5, 2020

Travis Plunk (TravisEz13) modified the milestones: GA-approved, 7.0.0 Feb 8, 2020

Travis Plunk (TravisEz13) mentioned this pull request Oct 12, 2022

Back-port to 7.0: Update list of PowerShell team members in release tools #18266

Merged

22 tasks

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026

Add WinCompat deny list support using a setting in powershell.… (Powe…

0941f65

…rShell#11726)

Add WinCompat deny list support using a setting in powershell.config.json by anmenaga · Pull Request #11726 · PowerShell/PowerShell · GitHub

Uh oh!

Add WinCompat deny list support using a setting in powershell.config.json - #11726

Add WinCompat deny list support using a setting in powershell.config.json#11726Travis Plunk (TravisEz13) merged 10 commits intoPowerShell:masterPowerShell/PowerShell:masterfrom anmenaga:WinCompatModuleDenyListanmenaga/PowerShell:WinCompatModuleDenyListCopy head branch name to clipboard

Conversation

Andrew (anmenaga) commented Jan 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Travis Plunk (TravisEz13) commented Jan 30, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Travis Plunk (TravisEz13) commented Jan 31, 2020

Uh oh!

Andrew (anmenaga) commented Jan 31, 2020

Uh oh!

Travis Plunk (TravisEz13) commented Jan 31, 2020

Uh oh!

Uh oh!

Uh oh!

PoshChan-Bot (PoshChan) commented Feb 1, 2020

Uh oh!

Thomas Lee (doctordns) commented Feb 1, 2020

Uh oh!

Steve Lee (SteveL-MSFT) left a comment

Choose a reason for hiding this comment

Uh oh!

Travis Plunk (TravisEz13) commented Feb 4, 2020

Uh oh!

Uh oh!

Uh oh!

Travis Plunk (TravisEz13) commented Feb 4, 2020

Uh oh!

Steve Lee (SteveL-MSFT) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

PoshChan-Bot (PoshChan) commented Feb 4, 2020

Uh oh!

Travis Plunk (TravisEz13) commented Feb 4, 2020

Uh oh!

PoshChan-Bot (PoshChan) commented Feb 5, 2020

Uh oh!

Deleted user (ghost) commented Feb 21, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Add WinCompat deny list support using a setting in powershell.config.json#11726
Travis Plunk (TravisEz13) merged 10 commits into
PowerShell:masterfrom
anmenaga:WinCompatModuleDenyList

Andrew (anmenaga) commented Jan 29, 2020 •
edited
Loading