Skip to content

Fix key exchange hang for outofproc transports #11380

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
anmenaga merged 6 commits into from
Dec 18, 2019
Merged

Fix key exchange hang for outofproc transports #11380

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ca0980a
Fix key exchange hang for outofproc transports by using separate proc…
PaulHigin Dec 16, 2019
55ab0c1
Address CodeFactor issues
PaulHigin Dec 17, 2019
3f7558e
Merge remote-tracking branch 'upstream/master' into fix-outofproc-tra…
PaulHigin Dec 17, 2019
4863655
Add clarifying comment per CR.
PaulHigin Dec 17, 2019
005a7f2
Merge remote-tracking branch 'upstream/master' into fix-outofproc-tra…
PaulHigin Dec 17, 2019
1553b85
Merge remote-tracking branch 'upstream/master' into fix-outofproc-tra…
PaulHigin Dec 17, 2019
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
96 changes: 87 additions & 9 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 @@ -9,6 +9,7 @@
* elevation to support local machine remoting).
*/

using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
Expand Down Expand Up @@ -463,6 +464,8 @@ internal abstract class OutOfProcessClientSessionTransportManagerBase : BaseClie
{
#region Data

private readonly BlockingCollection<string> _sessionMessageQueue;
private readonly BlockingCollection<string> _commandMessageQueue;
private PrioritySendDataCollection.OnDataAvailableCallback _onDataAvailableToSendCallback;
private OutOfProcessUtils.DataProcessingDelegates _dataProcessingCallbacks;
private Dictionary<Guid, OutOfProcessClientCommandTransportManager> _cmdTransportManagers;
Expand Down Expand Up @@ -507,6 +510,20 @@ internal OutOfProcessClientSessionTransportManagerBase(
// timers initialization
_closeTimeOutTimer = new Timer(OnCloseTimeOutTimerElapsed, null, Timeout.Infinite, Timeout.Infinite);

// Session message processing
_sessionMessageQueue = new BlockingCollection<string>();
var sessionThread = new Thread(ProcessMessageProc);
sessionThread.Name = "SessionMessageProcessing";
sessionThread.IsBackground = true;
sessionThread.Start(_sessionMessageQueue);

// Command message processing
_commandMessageQueue = new BlockingCollection<string>();
var commandThread = new Thread(ProcessMessageProc);
commandThread.Name = "CommandMessageProcessing";
commandThread.IsBackground = true;
commandThread.Start(_commandMessageQueue);

_tracer = PowerShellTraceSourceFactory.GetTraceSource();
}

Expand Down Expand Up @@ -601,7 +618,7 @@ internal override BaseClientCommandTransportManager CreateClientCommandTransport
}

/// <summary>
/// Kills the server process and disposes other resources.
/// Terminates the server process and disposes other resources.
/// </summary>
/// <param name="isDisposing"></param>
internal override void Dispose(bool isDisposing)
Expand All @@ -611,6 +628,8 @@ internal override void Dispose(bool isDisposing)
{
_cmdTransportManagers.Clear();
_closeTimeOutTimer.Dispose();
_sessionMessageQueue.Dispose();
_commandMessageQueue.Dispose();
}
}

Expand Down Expand Up @@ -663,29 +682,88 @@ private void OnCloseSessionCompleted()
{
// stop timer
_closeTimeOutTimer.Change(Timeout.Infinite, Timeout.Infinite);

// Stop protocol message processing threads.
_sessionMessageQueue.CompleteAdding();
_commandMessageQueue.CompleteAdding();

RaiseCloseCompleted();
CleanupConnection();
}

protected abstract void CleanupConnection();

private void ProcessMessageProc(object state)
{
var messageQueue = state as BlockingCollection<string>;

try
{
while (true)
{
var data = messageQueue.Take();
try
{
OutOfProcessUtils.ProcessData(data, _dataProcessingCallbacks);
}
catch (Exception exception)
{
PSRemotingTransportException psrte =
new PSRemotingTransportException(
PSRemotingErrorId.IPCErrorProcessingServerData,
RemotingErrorIdStrings.IPCErrorProcessingServerData,
exception.Message);
RaiseErrorHandler(new TransportErrorOccuredEventArgs(psrte, TransportMethodEnum.ReceiveShellOutputEx));
}
}
}
catch (InvalidOperationException)
{
// Normal session message processing thread end.
}
}

private const string GUIDTAG = "PSGuid='";
private const int GUID_STR_LEN = 36; // GUID string: 32 digits plus 4 dashes

private Guid GetMessageGuid(string data)
{
// Perform quick scan for data packet for a GUID, ignoring any errors.
var iTag = data.IndexOf(GUIDTAG, StringComparison.OrdinalIgnoreCase);
if (iTag > -1)
{
try
{
var psGuidString = data.Substring(iTag + GUIDTAG.Length, GUID_STR_LEN);
return new Guid(psGuidString);
}
catch
{
// Ignore any malformed packet errors here and return an empty Guid.
// Packet errors will be reported later during message processing.
}
}

return Guid.Empty;
}

#endregion

#region Event Handlers

protected void HandleOutputDataReceived(string data)
{
try
// Route protocol message based on whether it is a session or command message.
// Session messages have empty Guid values.
if (Guid.Equals(GetMessageGuid(data), Guid.Empty))
{
OutOfProcessUtils.ProcessData(data, _dataProcessingCallbacks);
// Session message
_sessionMessageQueue.Add(data);
}
catch (Exception exception)
else
{
PSRemotingTransportException psrte =
new PSRemotingTransportException(PSRemotingErrorId.IPCErrorProcessingServerData,
RemotingErrorIdStrings.IPCErrorProcessingServerData,
exception.Message);
RaiseErrorHandler(new TransportErrorOccuredEventArgs(psrte, TransportMethodEnum.ReceiveShellOutputEx));
// Command message
_commandMessageQueue.Add(data);
}
}

Expand Down