Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Close pipe client handles after creating the child ssh process #26491

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
TravisEz13 merged 7 commits into from
Nov 24, 2025
Merged

Close pipe client handles after creating the child ssh process #26491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e960631
Close streams when the ssh process exits on Windows to avoid hang
daxian-dbw Nov 19, 2025
cdafc25
Address a copilot comment
daxian-dbw Nov 20, 2025
5dcebf3
Remove 'SafeDispose'
daxian-dbw Nov 20, 2025
53b45e1
Actually remove the method
daxian-dbw Nov 20, 2025
8280e6c
Fix the root problem -- close the client pipe handle after its inheri…
daxian-dbw Nov 20, 2025
e9c438b
Dipose the parent side pipe client handles by disposing 'lpStartupInfo'
daxian-dbw Nov 21, 2025
e334ddb
Change to '-Tags'
daxian-dbw Nov 24, 2025
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
34 changes: 16 additions & 18 deletions src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2211,11 +2211,11 @@ internal int StartSSHProcess(
CommandTypes.Application,
SearchResolutionOptions.None,
CommandOrigin.Internal,
context) as ApplicationInfo;
context);

if (cmdInfo != null)
if (cmdInfo is ApplicationInfo appInfo)
{
filePath = cmdInfo.Path;
filePath = appInfo.Path;
}
}
else
Expand Down Expand Up @@ -2273,13 +2273,13 @@ internal int StartSSHProcess(
// Subsystem powershell /usr/local/bin/pwsh -SSHServerMode -NoLogo -NoProfile

// codeql[cs/microsoft/command-line-injection-shell-execution] - This is expected Poweshell behavior where user inputted paths are supported for the context of this method. The user assumes trust for the file path specified, so any file executed in the runspace would be in the user's local system/process or a system they have access to in which case restricted remoting security guidelines should be used.
System.Diagnostics.ProcessStartInfo startInfo = new System.Diagnostics.ProcessStartInfo(filePath);
ProcessStartInfo startInfo = new(filePath);

// pass "-i identity_file" command line argument to ssh if KeyFilePath is set
// if KeyFilePath is not set, then ssh will use IdentityFile / IdentityAgent from ssh_config if defined else none by default
if (!string.IsNullOrEmpty(this.KeyFilePath))
{
if (!System.IO.File.Exists(this.KeyFilePath))
if (!File.Exists(this.KeyFilePath))
{
throw new FileNotFoundException(
StringUtil.Format(RemotingErrorIdStrings.KeyFileNotFound, this.KeyFilePath));
Expand Down Expand Up @@ -2326,7 +2326,7 @@ internal int StartSSHProcess(
// note that ssh expects IPv6 addresses to not be enclosed in square brackets so trim them if present
startInfo.ArgumentList.Add(string.Create(CultureInfo.InvariantCulture, $@"-s {this.ComputerName.TrimStart('[').TrimEnd(']')} {this.Subsystem}"));

startInfo.WorkingDirectory = System.IO.Path.GetDirectoryName(filePath);
startInfo.WorkingDirectory = Path.GetDirectoryName(filePath);
startInfo.CreateNoWindow = true;
startInfo.UseShellExecute = false;

Expand Down Expand Up @@ -2580,7 +2580,7 @@ private static unsafe void AllocNullTerminatedArray(string[] arr, ref byte** arr
// Allocate the unmanaged array to hold each string pointer.
// It needs to have an extra element to null terminate the array.
arrPtr = (byte**)Marshal.AllocHGlobal(sizeof(IntPtr) * arrLength);
System.Diagnostics.Debug.Assert(arrPtr != null, "Invalid array ptr");
Debug.Assert(arrPtr != null, "Invalid array ptr");

// Zero the memory so that if any of the individual string allocations fails,
// we can loop through the array to free any that succeeded.
Expand All @@ -2597,7 +2597,7 @@ private static unsafe void AllocNullTerminatedArray(string[] arr, ref byte** arr
byte[] byteArr = System.Text.Encoding.UTF8.GetBytes(arr[i]);

arrPtr[i] = (byte*)Marshal.AllocHGlobal(byteArr.Length + 1); // +1 for null termination
System.Diagnostics.Debug.Assert(arrPtr[i] != null, "Invalid array ptr");
Debug.Assert(arrPtr[i] != null, "Invalid array ptr");

Marshal.Copy(byteArr, 0, (IntPtr)arrPtr[i], byteArr.Length); // copy over the data from the managed byte array
arrPtr[i][byteArr.Length] = (byte)'\0'; // null terminate
Expand Down Expand Up @@ -2641,13 +2641,13 @@ internal static extern unsafe int ForkAndExecProcess(
/// P-Invoking native APIs.
/// </summary>
private static int StartSSHProcessImpl(
System.Diagnostics.ProcessStartInfo startInfo,
ProcessStartInfo startInfo,
out StreamWriter stdInWriterVar,
out StreamReader stdOutReaderVar,
out StreamReader stdErrReaderVar)
{
Exception ex = null;
System.Diagnostics.Process sshProcess = null;
Process sshProcess = null;
//
// These std pipe handles are bound to managed Reader/Writer objects and returned to the transport
// manager object, which uses them for PSRP communication. The lifetime of these handles are then
Expand All @@ -2668,7 +2668,7 @@ private static int StartSSHProcessImpl(
catch (InvalidOperationException e) { ex = e; }
catch (ArgumentException e) { ex = e; }
catch (FileNotFoundException e) { ex = e; }
catch (System.ComponentModel.Win32Exception e) { ex = e; }
catch (Win32Exception e) { ex = e; }

if ((ex != null) ||
(sshProcess == null) ||
Expand All @@ -2693,9 +2693,9 @@ private static int StartSSHProcessImpl(
{
if (stdInWriterVar != null) { stdInWriterVar.Dispose(); } else { stdInPipeServer.Dispose(); }

if (stdOutReaderVar != null) { stdInWriterVar.Dispose(); } else { stdOutPipeServer.Dispose(); }
if (stdOutReaderVar != null) { stdOutReaderVar.Dispose(); } else { stdOutPipeServer.Dispose(); }

if (stdErrReaderVar != null) { stdInWriterVar.Dispose(); } else { stdErrPipeServer.Dispose(); }
if (stdErrReaderVar != null) { stdErrReaderVar.Dispose(); } else { stdErrPipeServer.Dispose(); }

throw;
}
Expand All @@ -2705,7 +2705,7 @@ private static int StartSSHProcessImpl(

private static void KillSSHProcessImpl(int pid)
{
using (var sshProcess = System.Diagnostics.Process.GetProcessById(pid))
using (var sshProcess = Process.GetProcessById(pid))
{
if ((sshProcess != null) && (sshProcess.Handle != IntPtr.Zero) && !sshProcess.HasExited)
{
Expand Down Expand Up @@ -2736,7 +2736,7 @@ private static Process CreateProcessWithRedirectedStd(
SafeFileHandle stdInPipeClient = null;
SafeFileHandle stdOutPipeClient = null;
SafeFileHandle stdErrPipeClient = null;
string randomName = System.IO.Path.GetFileNameWithoutExtension(System.IO.Path.GetRandomFileName());
string randomName = Path.GetFileNameWithoutExtension(Path.GetRandomFileName());

try
{
Expand Down Expand Up @@ -2829,16 +2829,14 @@ private static Process CreateProcessWithRedirectedStd(
catch (Exception)
{
stdInPipeServer?.Dispose();
stdInPipeClient?.Dispose();
stdOutPipeServer?.Dispose();
stdOutPipeClient?.Dispose();
stdErrPipeServer?.Dispose();
stdErrPipeClient?.Dispose();

throw;
}
finally
{
lpStartupInfo.Dispose();
lpProcessInformation.Dispose();
}
}
Expand Down
8 changes: 4 additions & 4 deletions src/System.Management.Automation/engine/remoting/fanin/OutOfProcTransportManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1733,7 +1733,7 @@ public override void CreateAsync()
bool sshTerminated = false;
try
{
using (var sshProcess = System.Diagnostics.Process.GetProcessById(_sshProcessId))
using (var sshProcess = Process.GetProcessById(_sshProcessId))
{
sshTerminated = sshProcess == null || sshProcess.Handle == IntPtr.Zero || sshProcess.HasExited;
}
Expand Down Expand Up @@ -1847,7 +1847,7 @@ private void ProcessErrorThread(object state)
// Messages in error stream from ssh are unreliable, and may just be warnings or
// banner text.
// So just report the messages but don't act on them.
System.Console.WriteLine(error);
Console.WriteLine(error);
}
catch (IOException)
{ }
Expand Down Expand Up @@ -1907,10 +1907,10 @@ private void ProcessReaderThread(object state)
break;
}

if (data.StartsWith(System.Management.Automation.Remoting.Server.FormattedErrorTextWriter.ErrorPrefix, StringComparison.OrdinalIgnoreCase))
if (data.StartsWith(OutOfProcessTextWriter.ErrorPrefix, StringComparison.OrdinalIgnoreCase))
{
// Error message from the server.
string errorData = data.Substring(System.Management.Automation.Remoting.Server.FormattedErrorTextWriter.ErrorPrefix.Length);
string errorData = data.Substring(OutOfProcessTextWriter.ErrorPrefix.Length);
HandleErrorDataReceived(errorData);
}
else
Expand Down
21 changes: 21 additions & 0 deletions test/powershell/engine/Remoting/SSHRemotingCmdlets.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,24 @@ Describe "SSHConnection parameter hashtable type conversions" -Tags 'Feature', '
$err.FullyQualifiedErrorId | Should -Match 'PSSessionOpenFailed'
}
}

Describe "No hangs when host doesn't exist" -Tags "CI" {
$testCases = @(
@{
Name = 'Verifies no hang for New-PSSession with non-existing host name'
ScriptBlock = { New-PSSession -HostName "test-notexist" -UserName "test" -ErrorAction Stop }
FullyQualifiedErrorId = 'PSSessionOpenFailed'
},
@{
Name = 'Verifies no hang for Invoke-Command with non-existing host name'
ScriptBlock = { Invoke-Command -HostName "test-notexist" -UserName "test" -ScriptBlock { 1 } -ErrorAction Stop }
FullyQualifiedErrorId = 'PSSessionStateBroken'
}
)

It "<Name>" -TestCases $testCases {
param ($ScriptBlock, $FullyQualifiedErrorId)

$ScriptBlock | Should -Throw -ErrorId $FullyQualifiedErrorId -ExceptionType 'System.Management.Automation.Remoting.PSRemotingTransportException'
}
}
Loading