Skip to content

Add Instrumentation to AmsiUtil and make the init variable readonly #18727

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

Jump to bottom
Merged
PaulHigin merged 8 commits into from
Dec 14, 2022
Merged

Add Instrumentation to AmsiUtil and make the init variable readonly #18727

PaulHigin merged 8 commits into from
Dec 14, 2022

Conversation

@suajose
Copy link
Contributor

@suajose suajose commented Dec 6, 2022 •
edited by TravisEz13
Loading

PR Summary

Add Instrumentation to AmsiUtil and make the init variable readonly

PR Context

PR Checklist

Making the variable readonly raises the bar for bypass AmsiScan, The new added events helps track tampering and initialization success.

@suajose suajose requested a review from PaulHigin as a code owner December 6, 2022 00:27
@ghost ghost assigned anmenaga Dec 6, 2022
@TravisEz13 TravisEz13 assigned TravisEz13 and unassigned anmenaga Dec 6, 2022
@TravisEz13 TravisEz13 added Backport-5.1-Consider Consider to backport to Windows PowerShell 5.1 due to impact Backport-7.3.x-Consider labels Dec 6, 2022
iSazonov
iSazonov reviewed Dec 6, 2022
View reviewed changes
PaulHigin
PaulHigin suggested changes Dec 6, 2022
View reviewed changes
@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 6, 2022
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 6, 2022
TravisEz13
TravisEz13 reviewed Dec 8, 2022
View reviewed changes
TravisEz13
TravisEz13 reviewed Dec 8, 2022
View reviewed changes
@TravisEz13 TravisEz13 enabled auto-merge (squash) December 9, 2022 16:53
@TravisEz13 TravisEz13 added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Dec 9, 2022
@suajose suajose requested a review from PaulHigin December 12, 2022 21:06
PaulHigin
PaulHigin suggested changes Dec 12, 2022
View reviewed changes
@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Dec 12, 2022
auto-merge was automatically disabled December 13, 2022 21:43

Head branch was pushed to by a user without write access

@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Dec 13, 2022

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

Quantification details 

Label      : Small
Size       : +76 -11
Percentile : 34.8%

Total files changed: 7

Change summary by file extension:
.man : +49 -3
.cs : +27 -8

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.

PaulHigin
PaulHigin approved these changes Dec 13, 2022
View reviewed changes
Copy link
Contributor

@PaulHigin PaulHigin left a comment

Choose a reason for hiding this comment

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

LGTM

@PaulHigin PaulHigin merged commit 36282c2 into PowerShell:master Dec 14, 2022
@adityapatwardhan
Copy link
Member

adityapatwardhan commented Jan 4, 2023

Maintainers discussed this for backport and recommend having more bake time in preview release before backporting.

@ghost
Copy link

ghost commented Apr 13, 2023

🎉v7.3.4 has been released which incorporates this pull request.:tada:

Handy links:

@Mirza-Numan Mirza-Numan mentioned this pull request Apr 17, 2023
Closed
Mirza-Numan
Mirza-Numan reviewed Apr 18, 2023
View reviewed changes
Copy link

@Mirza-Numan Mirza-Numan left a comment

Choose a reason for hiding this comment

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

Ishu solve

adityapatwardhan pushed a commit to adityapatwardhan/PowerShell that referenced this pull request Apr 25, 2023
@suajose @daxian-dbw
Add Instrumentation to AmsiUtil and make the init variable readonly (P…
f9dd349 
…owerShell#18727)

* Add Insturmentation to AmsiUtil and make the init variable readonly

* remove unwanted file

* Fix task to hex

* ingnore AsmiInit when not windows

* rename event name

* CR feedback

* the missing dot in the argument documentation because that is very very important.

* CR feedback

Co-authored-by: Jose Sua <josesua@ntdev.microsoft.com>
@TravisEz13 TravisEz13 mentioned this pull request Oct 11, 2023
Merged
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov left review comments

@TravisEz13 TravisEz13 TravisEz13 approved these changes

+2 more reviewers

@Mirza-Numan Mirza-Numan Mirza-Numan approved these changes

@PaulHigin PaulHigin PaulHigin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@TravisEz13 TravisEz13

Labels

Backport-5.1-Consider Consider to backport to Windows PowerShell 5.1 due to impact Backport-7.3.x-Done CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@suajose @adityapatwardhan @TravisEz13 @PaulHigin @iSazonov @Mirza-Numan @daxian-dbw @anmenaga