Skip to content

[release/v7.4.3] Fix Test-Path -IsValid to check for invalid path and filename characters #23931

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 1 commit into from
Jun 11, 2024
Merged

[release/v7.4.3] Fix Test-Path -IsValid to check for invalid path and filename characters #23931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions src/System.Management.Automation/namespaces/FileSystemProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1080,6 +1080,21 @@ protected override bool IsValidPath(string path)
}
}

// .NET introduced a change where invalid characters are accepted https://learn.microsoft.com/en-us/dotnet/core/compatibility/2.1#path-apis-dont-throw-an-exception-for-invalid-characters
// We need to check for invalid characters ourselves. `Path.GetInvalidFileNameChars()` is a supserset of `Path.GetInvalidPathChars()`

// Remove drive root first
string pathWithoutDriveRoot = path.Substring(Path.GetPathRoot(path).Length);
char[] invalidFileChars = Path.GetInvalidFileNameChars();

foreach (string segment in pathWithoutDriveRoot.Split(Path.DirectorySeparatorChar))
{
if (segment.IndexOfAny(invalidFileChars) != -1)
{
return false;
}
}

return true;
}

Expand Down
42 changes: 42 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Management/Test-Path.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,48 @@ Describe "Test-Path" -Tags "CI" {
Test-Path -Path $badPath -IsValid | Should -BeFalse
}

It 'Windows paths should be valid: <path>' -skip:(!$IsWindows) -TestCases @(
@{ path = "C:\Program Files" }
@{ path = "C:\Program Files (x86)\" }
@{ path = "filesystem::z:\foo" }
@{ path = "filesystem::z:\foo\" }
@{ path = "variable::psversiontable" }
@{ path = "c:\windows\cmd.exe:test" }
) {
param($path)
Test-Path -Path $path -IsValid | Should -BeTrue
}

It 'Windows paths should be inavlid: <variant>' -Skip:(!$IsWindows) -TestCases @(
@{ variant = "wildcard"; path = "C:\Program Files\foo*" }
@{ variant = "pipe symbol"; path = "C:\Program Files|p\foo" }
@{ variant = "null char"; path = "C:\Win`u{0000}dows\System32" }
) {
param($path)
Test-Path -Path $path -IsValid | Should -BeFalse
}

It 'Unix paths should be valid: <path>' -Skip:($IsWindows) -TestCases @(
@{ path = "/usr/bin" }
@{ path = "/usr/bin/" }
@{ path = "filesystem::/usr/bin" }
@{ path = "filesystem::/usr/bin/" }
@{ path = "variable::psversiontable" }
@{ path = "/usr/bi*n/test" }
@{ path = "/usr/bin/tes*t" }
) {
param($path)
Test-Path -Path $path -IsValid | Should -BeTrue
}

It 'Unix paths should be invalid: <variant>' -Skip:($IsWindows) -TestCases @(
@{ variant = "null in path"; path = "/usr/bi`u{0000}n/test" }
@{ variant = "null in filename"; path = "/usr/bin/t`u{0000}est" }
) {
param($path)
Test-Path -Path $path -IsValid | Should -BeFalse
}

It "Should return true on paths containing spaces when the path is surrounded in quotes" {
Test-Path -Path "/totally a valid/path" -IsValid | Should -BeTrue
}
Expand Down