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

Block getting help from network locations in restricted remoting session #20593

Merged
merged 1 commit into from Oct 31, 2023

Conversation

TravisEz13
Copy link
Member

@TravisEz13 TravisEz13 commented Oct 27, 2023

PR Summary

Block getting help from network locations in restricted remoting session (JEA, exchange remoting, and similar custom remoting sessions)

PR Context

This was already released in the servicing releases.

This is mitigated if the restricted proxy is used for get-help or if the file system provider is hidden for the session, but not all customers implemented this way.

We have already documented that you should have these other protections in place to protect these scenarios:
https://learn.microsoft.com/en-us/powershell/scripting/dev-cross-plat/security/securing-restricted-sessions?view=powershell-7.3

Defense in depth security fix

Conflicts:

  • src/System.Management.Automation/engine/Utils.cs
  • test/tools/Modules/HelpersCommon/HelpersCommon.psd1
  • test/tools/Modules/HelpersCommon/HelpersCommon.psm1

PR Checklist

…ions

Cherry picked from !27698

# Conflicts:
#	src/System.Management.Automation/engine/Utils.cs
#	test/tools/Modules/HelpersCommon/HelpersCommon.psd1
#	test/tools/Modules/HelpersCommon/HelpersCommon.psm1
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Medium
Size       : +110 -13
Percentile : 44.6%

Total files changed: 9

Change summary by file extension:
.cs : +15 -13
.resx : +3 -0
.ps1 : +30 -0
.psd1 : +1 -0
.psm1 : +61 -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.

@@ -1256,7 +1256,8 @@ internal static bool PathIsDevicePath(string path)
#if UNIX
return false;
#else
return path.StartsWith(@"\\.\") || path.StartsWith(@"\\?\");
// device paths can be network paths, we would need windows to parse it.
Copy link
Member Author

Choose a reason for hiding this comment

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

This had a merge conflict, I could not find a good reason why.

@@ -48,6 +48,7 @@ FunctionsToExport = @(
'Test-PSDefaultParameterValue'
'Push-DefaultParameterValueStack'
'Pop-DefaultParameterValueStack'
'Get-HelpNetworkTestCases'
Copy link
Member Author

Choose a reason for hiding this comment

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

This had a merge conflict because this branch has new changes.

@@ -533,3 +533,87 @@ function Pop-DefaultParameterValueStack {
return $false
}
}

Copy link
Member Author

Choose a reason for hiding this comment

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

This had a merge conflict because this branch has new changes.

@adityapatwardhan adityapatwardhan merged commit 687383b into PowerShell:master Oct 31, 2023
39 checks passed
@adityapatwardhan adityapatwardhan added CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log BackPort-7.4.x-Done and removed BackPort-7.4.x-Approved labels Nov 1, 2023
VindSkyggen pushed a commit to VindSkyggen/PowerShell that referenced this pull request Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BackPort-7.4.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Medium MustHave
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants