Skip to content

Fix webcmdlets so that an empty Get does not include a content-length header #16587

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

Merged
adityapatwardhan merged 9 commits into from
Jan 3, 2022
Merged

Fix webcmdlets so that an empty Get does not include a content-length header #16587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f8e6d80
Fix webcmdlets so that an empty `Get` does not include a zero content…
SteveL-MSFT Dec 9, 2021
6f7ad24
Fix handling of empty content
SteveL-MSFT Dec 9, 2021
38aa7ff
update cgmanifest
SteveL-MSFT Dec 9, 2021
0ca465f
move check for Get to only have one check for null
SteveL-MSFT Dec 9, 2021
bdf6dd2
handle case where ContentType is specified
SteveL-MSFT Dec 9, 2021
a2264db
fix test
SteveL-MSFT Dec 9, 2021
b0a6580
update dotnet URLs
SteveL-MSFT Dec 10, 2021
1b624e1
revert changes to cgmanifest and docs
SteveL-MSFT Dec 10, 2021
823f305
fix to support custom `Get`
SteveL-MSFT Dec 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions ...owerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1277,9 +1277,15 @@ internal virtual void FillRequestStream(HttpRequestMessage request)
}
}

// Add the content headers
if (request.Content == null)
// For other methods like Put where empty content has meaning, we need to fill in the content
if (request.Content is null)
{
// If this is a Get request and there is no content, then don't fill in the content as empty content gets rejected by some web services per RFC7230
if ((IsStandardMethodSet() && request.Method == HttpMethod.Get && ContentType is null) || (IsCustomMethodSet() && CustomMethod.ToUpperInvariant() == "GET"))
{
return;
}

request.Content = new StringContent(string.Empty);
request.Content.Headers.Clear();
}
Expand Down
36 changes: 36 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,8 @@ $redirectTests = @(

Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {
BeforeAll {
$oldProgress = $ProgressPreference
$ProgressPreference = 'SilentlyContinue'
$WebListener = Start-WebListener
$NotFoundQuery = @{
statuscode = 404
Expand All @@ -380,6 +382,10 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {
}
}

AfterAll {
$ProgressPreference = $oldProgress
}

# Validate the output of Invoke-WebRequest
#
function ValidateResponse {
Expand Down Expand Up @@ -456,6 +462,8 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {

# Validate response
ValidateResponse -response $result

$result.Output.Headers.'Content-Length' | Should -BeNullOrEmpty
}

It "Validate Invoke-WebRequest -DisableKeepAlive" {
Expand Down Expand Up @@ -705,6 +713,13 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {
($result.Output.Content | ConvertFrom-Json).args.testparam | Should -Be "testvalue"
}

It 'Validate Invoke-WebRequest empty body CustomMethod GET' {
$uri = Get-WebListenerUrl -Test 'Get'
$command = "Invoke-WebRequest -Uri '$uri' -CustomMethod GET"
$result = ExecuteWebCommand -command $command
$result.Output.Headers.'Content-Length' | Should -BeNullOrEmpty
}

It "Validate Invoke-WebRequest body is converted to query params for CustomMethod GET and -NoProxy" {
$uri = Get-WebListenerUrl -Test 'Get'
$command = "Invoke-WebRequest -Uri '$uri' -CustomMethod GET -Body @{'testparam'='testvalue'} -NoProxy"
Expand Down Expand Up @@ -2061,6 +2076,9 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {

Describe "Invoke-RestMethod tests" -Tags "Feature", "RequireAdminOnWindows" {
BeforeAll {
$oldProgress = $ProgressPreference
$ProgressPreference = 'SilentlyContinue'

$WebListener = Start-WebListener

$NotFoundQuery = @{
Expand All @@ -2072,6 +2090,10 @@ Describe "Invoke-RestMethod tests" -Tags "Feature", "RequireAdminOnWindows" {
}
}

AfterAll {
$ProgressPreference = $oldProgress
}

#User-Agent changes on different platforms, so tests should only be run if on the correct platform
It "Invoke-RestMethod returns Correct User-Agent on MacOSX" -Skip:(!$IsMacOS) {
$uri = Get-WebListenerUrl -Test 'Get'
Expand Down Expand Up @@ -2111,6 +2133,7 @@ Describe "Invoke-RestMethod tests" -Tags "Feature", "RequireAdminOnWindows" {

# Validate response
$result.Error | Should -BeNullOrEmpty
$result.Output.headers.'Content-Length' | Should -Be 0
}

It "Invoke-RestMethod returns headers dictionary" {
Expand Down Expand Up @@ -2350,6 +2373,13 @@ Describe "Invoke-RestMethod tests" -Tags "Feature", "RequireAdminOnWindows" {
$result.Output.args.testparam | Should -Be "testvalue"
}

It 'Validate Invoke-RestMethod empty body CustomMethod GET' {
$uri = Get-WebListenerUrl -Test 'Get'
$command = "Invoke-RestMethod -Uri '$uri' -CustomMethod GET"
$result = ExecuteWebCommand -command $command
$result.Output.Headers.'Content-Length' | Should -BeNullOrEmpty
}

It "Validate Invoke-RestMethod body is converted to query params for CustomMethod GET and -NoProxy" {
$uri = Get-WebListenerUrl -Test 'Get'
$command = "Invoke-RestMethod -Uri '$uri' -CustomMethod GET -Body @{'testparam'='testvalue'} -NoProxy"
Expand Down Expand Up @@ -3528,9 +3558,15 @@ Describe "Invoke-RestMethod tests" -Tags "Feature", "RequireAdminOnWindows" {

Describe "Validate Invoke-WebRequest and Invoke-RestMethod -InFile" -Tags "Feature", "RequireAdminOnWindows" {
BeforeAll {
$oldProgress = $ProgressPreference
$ProgressPreference = 'SilentlyContinue'
$WebListener = Start-WebListener
}

AfterAll {
$ProgressPreference = $oldProgress
}

Context "InFile parameter negative tests" {
BeforeAll {
$uri = Get-WebListenerUrl -Test 'Post'
Expand Down