Fix bug with managing redirection and keepAuthorization in Web cmdlets #18902

CarloToso · 2023-01-07T15:30:54Z

PR Summary

The current behaviour of if (keepAuthorization && IsRedirectCode(response.StatusCode) && response.Headers.Location is not null) is wrong, I tested it by setting keepAuthorization = true --> this sets handleRetirect = true --> and then sets handler.AllowAutoRedirect = false. Without sessionRedirect (we can choose a better name) it ignores the MaximumRedirection parameter.

Test: maunally set keepAuthorization = true before the if, then
Invoke-WebRequest "http://mockbin.org/redirect/308?to=https://mockbin.org/redirect/302?to=https://mockbin.org/status/200" -MaximumRedirection 0 -SkipHttpErrorCheck --> expected 308, result 200

Proposed fix -->

bool sessionRedirect = WebSession.MaximumRedirection > 0 || WebSession.MaximumRedirection == -1;
if (keepAuthorization  && sessionRedirect && IsRedirectCode(response.StatusCode) && response.Headers.Location is not null)

PR Context

Fix Bug, merge before #18546 and #18894

iSazonov · 2023-01-07T17:56:29Z

@CarloToso Can you enhance our helper test tool - WebListener - to cover the scenario? Currently it supports redirection but not take into account authorization header (I guess we could use -Authentication Bear?). WebListener could return the auth token as-is and we could add tests to check that the header is removed by default and isn't removed with PreserveAuthorizationOnRedirect.

I see only reason we do custom redirection processing is that we want to keep the auth header. So I suggest rename keepAuthorization and handleRedirect parameters to keepAuthorizationOnRedirect. This simplify understanding the code.

CarloToso · 2023-01-07T18:14:02Z

@iSazonov we also need to handle redirection for #18546 and #18894, I can change keepAuthorization to keepAuthorizationOnRedirect but i think handleRedirect should stay as it is.

I don't know much about the helper tool test but I can look into it

iSazonov · 2023-01-07T19:20:04Z

but i think handleRedirect should stay as it is.

It is the same as keepAuthorization - we assign keepAuthorization to handleRedirect - this mislead.

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

…Cmdlet/Common/WebRequestPSCmdlet.Common.cs Co-authored-by: xtqqczze <45661989+xtqqczze@users.noreply.github.com>

CarloToso · 2023-01-08T01:28:38Z

If we change it handleRedirect to keepAuthorization, it will be misleading after we add -PreserveHTTPMethodOnRedirect or -AllowInsicureRedirect. We could add something like this bool handleRedirect = keepAuthorizationOnRedirect || AllowInsicureRedirect || PreserveHTTPMethodOnRedirect

iSazonov · 2023-01-08T06:47:27Z

If we change it handleRedirect to keepAuthorization, it will be misleading after we add -PreserveHTTPMethodOnRedirect or -AllowInsicureRedirect. We could add something like this bool handleRedirect = keepAuthorizationOnRedirect || AllowInsicureRedirect || PreserveHTTPMethodOnRedirect

I don't see a problem here. As I said only reason we do manual redirect processing is that we want to keep auth header. So variable names should reflect to our intention. And comments could be updated too.

iSazonov · 2023-01-08T06:48:58Z

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

@@ -533,7 +533,7 @@ internal virtual void ValidateParameters()
            }

            // Resume requires OutFile.
-            if (Resume.IsPresent && OutFile is null)
+            if (Resume && OutFile is null)


This reduces readability. 😕

CarloToso · 2023-01-10T22:39:56Z

@iSazonov It looks like there already are some tests that cover -PreserveAuthorizationOnRedirect

iSazonov · 2023-01-11T09:46:19Z

@iSazonov It looks like there already are some tests that cover -PreserveAuthorizationOnRedirect

Can you point these tests? I see there is Authorization controller but it doesn't cover redirection scenario.

CarloToso · 2023-01-11T12:17:38Z

@iSazonov I found the -PreserveAuthorizationOnRedirect parameter in WebCmdlet.Tests.ps1 and I think it covers this case

iSazonov · 2023-01-11T12:24:26Z

If the test is passed before the PR it is a broken test.

CarloToso · 2023-01-11T18:31:52Z

I think the tests are not broken, they just never checked for -MaximumRedirection + -PreserveAuthorizationOnRedirect

iSazonov

Please confirm that the new tests fail before the PR.

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

iSazonov · 2023-01-12T10:48:51Z

@CarloToso Please resolve merge conflicts.

iSazonov · 2023-01-12T12:10:02Z

@CarloToso Please resolve merge conflict again.

iSazonov · 2023-01-12T17:04:21Z

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

+                bool keepAuthorizationOnRedirect = WebSession is not null
+                                                   && WebSession.Headers is not null
+                                                   && PreserveAuthorizationOnRedirect.IsPresent
+                                                   && WebSession.Headers.ContainsKey(HttpKnownHeaderNames.Authorization);
+


It seems PreserveAuthorizationOnRedirect.IsPresent should be on first place.

iSazonov · 2023-01-12T17:42:27Z

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

+                if (handleRedirect
+                    && WebSession.MaximumRedirection is not 0
+                    && IsRedirectCode(response.StatusCode)
+                    && response.Headers.Location is not null)


Why is AllowInsecureRedirect removed?

We merged #18546 without tests. Time to add tests for AllowInsecureRedirect

Added some tests #18939, AllowInsecureRedirect is in handleRedirect after this PR (line 1422)

iSazonov · 2023-01-13T12:38:41Z

/rebase

iSazonov · 2023-01-13T12:45:46Z

@CarloToso Please rebase to get tests.

…Redirection

pull-request-quantifier-deprecated · 2023-01-13T12:47:48Z

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

Quantification details

Label      : Extra Small
Size       : +28 -19
Percentile : 18.8%

Total files changed: 2

Change summary by file extension:
.cs : +16 -17
.ps1 : +12 -2

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.

ghost · 2023-03-14T22:27:46Z

🎉v7.4.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

fix bug with managing redirection

4ad575b

CarloToso requested a review from PaulHigin as a code owner January 7, 2023 15:30

pull-request-quantifier-deprecated bot added the Extra Small label Jan 7, 2023

ghost assigned adityapatwardhan Jan 7, 2023

iSazonov requested a review from adityapatwardhan January 7, 2023 17:15

iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jan 7, 2023

xtqqczze reviewed Jan 7, 2023

View reviewed changes

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Outdated Show resolved Hide resolved

CarloToso and others added 5 commits January 8, 2023 00:48

Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Web…

a1671df

…Cmdlet/Common/WebRequestPSCmdlet.Common.cs Co-authored-by: xtqqczze <45661989+xtqqczze@users.noreply.github.com>

keepAuthorization --> keepAuthorizationOnRedirect

8510729

remove useless IsPresent

e378ef2

missed two keepAuthorizationOnRedirect

2a9f147

bool handleRedirect = keepAuthorizationOnRedirect

f5b6d1d

better handleRedirect if logic

e48bd39

iSazonov reviewed Jan 8, 2023

View reviewed changes

CarloToso added 2 commits January 8, 2023 13:12

revert Resume.IsPresent

1345784

keepAuthorizationOnRedirect --> handleRedirect

3ed7bd7

CarloToso mentioned this pull request Jan 8, 2023

Add PreserveHttpMethodOnRedirect switch to Web cmdlets #18894

Merged

22 tasks

iSazonov changed the title ~~fix bug with managing redirection~~ Fix bug with managing redirection Jan 9, 2023

add test

c2d3399

iSazonov reviewed Jan 12, 2023

View reviewed changes

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Outdated Show resolved Hide resolved

test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1 Outdated Show resolved Hide resolved

iSazonov approved these changes Jan 12, 2023

View reviewed changes

xtqqczze suggested changes Jan 12, 2023

View reviewed changes

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Outdated Show resolved Hide resolved

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

remove comment

7f3fd07

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

Merge branch 'master' into Fix-handleRedirect-with-MaximumRedirection

bcfcfc1

Merge branch 'master' into Fix-handleRedirect-with-MaximumRedirection

536de9d

iSazonov reviewed Jan 12, 2023

View reviewed changes

CarloToso added 2 commits January 12, 2023 18:12

reorder keepAuthorizationOnRedirect

2771457

fix error

7a8daeb

iSazonov self-requested a review January 12, 2023 17:40

iSazonov requested changes Jan 12, 2023

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 12, 2023

CarloToso mentioned this pull request Jan 13, 2023

Add tests for Allowinsecureredirect parameter in Web cmdlets #18939

Merged

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

Merge branch 'PowerShell:master' into Fix-handleRedirect-with-Maximum…

289f5e8

…Redirection

iSazonov approved these changes Jan 13, 2023

View reviewed changes

iSazonov assigned iSazonov and unassigned adityapatwardhan Jan 13, 2023

iSazonov changed the title ~~Fix bug with managing redirection~~ Fix bug with managing redirection and keepAuthorization in Web cmdlets Jan 13, 2023

iSazonov merged commit 282fc5f into PowerShell:master Jan 13, 2023

CarloToso deleted the Fix-handleRedirect-with-MaximumRedirection branch January 13, 2023 14:16

Fix bug with managing redirection and keepAuthorization in Web cmdlets #18902

Fix bug with managing redirection and keepAuthorization in Web cmdlets #18902

Uh oh!

Conversation

CarloToso commented Jan 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

Uh oh!

iSazonov commented Jan 7, 2023

Uh oh!

CarloToso commented Jan 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iSazonov commented Jan 7, 2023

Uh oh!

Uh oh!

CarloToso commented Jan 8, 2023

Uh oh!

iSazonov commented Jan 8, 2023

Uh oh!

iSazonov Jan 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CarloToso Jan 8, 2023

Choose a reason for hiding this comment

Uh oh!

CarloToso commented Jan 10, 2023

Uh oh!

iSazonov commented Jan 11, 2023

Uh oh!

CarloToso commented Jan 11, 2023

Uh oh!

iSazonov commented Jan 11, 2023

Uh oh!

CarloToso commented Jan 11, 2023

Uh oh!

iSazonov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iSazonov commented Jan 12, 2023

Uh oh!

iSazonov commented Jan 12, 2023

Uh oh!

iSazonov Jan 12, 2023

Choose a reason for hiding this comment

Uh oh!

iSazonov Jan 12, 2023

Choose a reason for hiding this comment

Uh oh!

CarloToso Jan 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iSazonov commented Jan 13, 2023

Uh oh!

iSazonov commented Jan 13, 2023

Uh oh!

pull-request-quantifier-deprecated bot commented Jan 13, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Mar 14, 2023

Uh oh!

Uh oh!

CarloToso commented Jan 7, 2023 •

edited

Loading

CarloToso commented Jan 7, 2023 •

edited

Loading

iSazonov Jan 8, 2023 •

edited

Loading

CarloToso Jan 13, 2023 •

edited

Loading