Skip to content
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

Add WDAC Audit mode logging as experimental feature #19390

Closed
wants to merge 34 commits into from

Conversation

PaulHigin
Copy link
Contributor

@PaulHigin PaulHigin commented Mar 22, 2023

PR Summary

This PR adds a new language mode and logging messages to PowerShell restrictions when run under Windows WDAC (Windows Defender Application Control) policy.

This addresses Issue #18628

PR Context

PowerShell enforces language mode and other restrictions when it detects it is running under a WDAC (or deprecated AppLocker) system polices (Windows platform only). The enforced restrictions can cause existing script (written without the restrictions in mind) to break in unpredictable ways.

WDAC can run in Audit mode where policy restriction instances are not enforced but logged. These changes updates PowerShell so that when WDAC is in Audit mode, it too logs when restrictions would apply if the policy was being enforced. This will help users to understand what restrictions will apply when their script runs in policy enforcement mode.

PR Checklist

Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

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

Doesn't have to be code fenced, but we should advertise this as an Experimental Feature in case we need to change the trace messages based on user feedback

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Apr 3, 2023
@PaulHigin PaulHigin changed the title [WIP] Add WDAC Audit mode logging Add WDAC Audit mode logging Apr 26, 2023
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Apr 26, 2023
@PaulHigin PaulHigin changed the title Add WDAC Audit mode logging Add WDAC Audit mode logging as experimental feature Apr 26, 2023
@daxian-dbw daxian-dbw added WG-Engine core PowerShell engine, interpreter, and runtime Needs-Triage The issue is new and needs to be triaged by a work group. labels May 1, 2023
var er = new ErrorRecord(se, "Modules_CannotExportMembersAccrossLanguageBoundaries", ErrorCategory.SecurityError, this);
ThrowTerminatingError(er);
if (Context.LanguageMode != PSLanguageMode.ConstrainedLanguageAudit &&
Context.EngineSessionState.Module.LanguageMode != PSLanguageMode.ConstrainedLanguageAudit)
Copy link
Member

Choose a reason for hiding this comment

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

(note to myself) need to take a closer look at this.

@StevenBucher98 StevenBucher98 added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label May 8, 2023
@pull-request-quantifier-deprecated

This PR has 901 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Large
Size       : +714 -187
Percentile : 96.7%

Total files changed: 56

Change summary by file extension:
.cs : +546 -187
.resx : +168 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@daxian-dbw
Copy link
Member

@PaulHigin I'm closing this one assuming it's superseded by #19641

@daxian-dbw daxian-dbw closed this May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Extra Large Needs-Triage The issue is new and needs to be triaged by a work group. PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed WG-Engine core PowerShell engine, interpreter, and runtime
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants