Skip to content

Remove native named pipes implementation #878

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
merged 2 commits into from
May 7, 2019
Merged

Remove native named pipes implementation #878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05f47a0
remove native named pipes impl
TylerLeonhardt Mar 15, 2019
5d11aee
stop supporting 6.0.0
TylerLeonhardt May 3, 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
32 changes: 2 additions & 30 deletions module/PowerShellEditorServices/Start-EditorServices.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ function WriteSessionFile($sessionInfo) {
}

# Are we running in PowerShell 2 or earlier?
if ($PSVersionTable.PSVersion.Major -le 2) {
$version = $PSVersionTable.PSVersion
if (($version.Major -le 2) -or ($version.Major -eq 6 -and $version.Minor -eq 0)) {
# No ConvertTo-Json on PSv2 and below, so write out the JSON manually
"{`"status`": `"failed`", `"reason`": `"unsupported`", `"powerShellVersion`": `"$($PSVersionTable.PSVersion.ToString())`"}" |
Microsoft.PowerShell.Management\Set-Content -Force -Path "$SessionDetailsPath" -ErrorAction Stop
Expand Down Expand Up @@ -257,32 +258,6 @@ function Test-NamedPipeName {
return !(Test-Path $path)
}

function Set-NamedPipeMode {
param(
[Parameter(Mandatory=$true)]
[ValidateNotNullOrEmpty()]
[string]
$PipeFile
)

if (($PSVersionTable.PSVersion.Major -le 5) -or $IsWindows) {
return
}

chmod $DEFAULT_USER_MODE $PipeFile

if ($IsLinux) {
$mode = /usr/bin/stat -c "%a" $PipeFile
}
elseif ($IsMacOS) {
$mode = /usr/bin/stat -f "%A" $PipeFile
}

if ($mode -ne $DEFAULT_USER_MODE) {
ExitWithError "Permissions to the pipe file were not set properly. Expected: $DEFAULT_USER_MODE Actual: $mode for file: $PipeFile"
}
}

LogSection "Console Encoding"
Log $OutputEncoding

Expand Down Expand Up @@ -316,9 +291,6 @@ function Set-PipeFileResult {
)

$ResultTable[$PipeNameKey] = Get-NamedPipePath -PipeName $PipeNameValue
if (($PSVersionTable.PSVersion.Major -ge 6) -and ($IsLinux -or $IsMacOS)) {
Set-NamedPipeMode -PipeFile $ResultTable[$PipeNameKey]
}
}

# Add BundledModulesPath to $env:PSModulePath
Expand Down
8 changes: 6 additions & 2 deletions src/PowerShellEditorServices.Protocol/MessageProtocol/Channel/NamedPipeClientChannel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ public class NamedPipeClientChannel : ChannelBase
private ILogger logger;
private NamedPipeClientStream pipeClient;

// This int will be casted to a PipeOptions enum that only exists in .NET Core 2.1 and up which is why it's not available to us in .NET Standard.
private const int CurrentUserOnly = 536870912;

private const string NAMED_PIPE_UNIX_PREFIX = "CoreFxPipe_";

public NamedPipeClientChannel(
Expand Down Expand Up @@ -56,18 +59,20 @@ public static async Task<NamedPipeClientChannel> ConnectAsync(
{
string pipeName = System.IO.Path.GetFileName(pipeFile);

var options = PipeOptions.Asynchronous;
// on macOS and Linux, the named pipe name is prefixed by .NET Core
if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
pipeName = pipeFile.Split(new [] {NAMED_PIPE_UNIX_PREFIX}, StringSplitOptions.None)[1];
options |= (PipeOptions)CurrentUserOnly;
}

var pipeClient =
new NamedPipeClientStream(
".",
pipeName,
PipeDirection.InOut,
PipeOptions.Asynchronous);
options);

await pipeClient.ConnectAsync();
var clientChannel = new NamedPipeClientChannel(pipeClient, logger);
Expand All @@ -77,4 +82,3 @@ public static async Task<NamedPipeClientChannel> ConnectAsync(
}
}
}

188 changes: 37 additions & 151 deletions src/PowerShellEditorServices.Protocol/MessageProtocol/Channel/NamedPipeServerListener.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using System.Collections.Generic;
using System.IO;
using System.IO.Pipes;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Security.AccessControl;
using System.Security.Principal;
Expand All @@ -18,6 +19,15 @@ namespace Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol.Channel
{
public class NamedPipeServerListener : ServerListenerBase<NamedPipeServerChannel>
{
// This int will be casted to a PipeOptions enum that only exists in .NET Core 2.1 and up which is why it's not available to us in .NET Standard.
private const int CurrentUserOnly = 536870912;

// In .NET Framework, NamedPipeServerStream has a constructor that takes in a PipeSecurity object. We will use reflection to call the constructor,
// since .NET Framework doesn't have the `CurrentUserOnly` PipeOption.
// doc: https://docs.microsoft.com/en-us/dotnet/api/system.io.pipes.namedpipeserverstream.-ctor?view=netframework-4.7.2#System_IO_Pipes_NamedPipeServerStream__ctor_System_String_System_IO_Pipes_PipeDirection_System_Int32_System_IO_Pipes_PipeTransmissionMode_System_IO_Pipes_PipeOptions_System_Int32_System_Int32_System_IO_Pipes_PipeSecurity_
private static ConstructorInfo _netFrameworkPipeServerConstructor =
typeof(NamedPipeServerStream).GetConstructor(new [] { typeof(string), typeof(PipeDirection), typeof(int), typeof(PipeTransmissionMode), typeof(PipeOptions), typeof(int), typeof(int), typeof(PipeSecurity) });

private ILogger logger;
private string inOutPipeName;
private readonly string outPipeName;
Expand Down Expand Up @@ -50,7 +60,8 @@ public override void Start()
{
try
{
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
// If we're running in Windows PowerShell, we use the constructor via Reflection
if (RuntimeInformation.FrameworkDescription.StartsWith(".NET Framework"))
{
PipeSecurity pipeSecurity = new PipeSecurity();

Expand All @@ -72,35 +83,49 @@ public override void Start()
PipeAccessRights.ReadWrite, AccessControlType.Allow));
}

// Unfortunately, .NET Core does not support passing in a PipeSecurity object into the constructor for
// NamedPipeServerStream so we are creating native Named Pipes and securing them using native APIs. The
// issue on .NET Core regarding Named Pipe security is here: https://github.com/dotnet/corefx/issues/30170
// 99% of this code was borrowed from PowerShell here:
// https://github.com/PowerShell/PowerShell/blob/master/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs#L124-L256
this.inOutPipeServer = NamedPipeNative.CreateNamedPipe(inOutPipeName, pipeSecurity);
_netFrameworkPipeServerConstructor.Invoke(new object[]
{
inOutPipeName,
PipeDirection.InOut,
1, // maxNumberOfServerInstances
PipeTransmissionMode.Byte,
PipeOptions.Asynchronous,
1024, // inBufferSize
1024, // outBufferSize
pipeSecurity
});

if (this.outPipeName != null)
{
this.outPipeServer = NamedPipeNative.CreateNamedPipe(outPipeName, pipeSecurity);
_netFrameworkPipeServerConstructor.Invoke(new object[]
{
outPipeName,
PipeDirection.InOut,
1, // maxNumberOfServerInstances
PipeTransmissionMode.Byte,
PipeOptions.Asynchronous,
1024, // inBufferSize
1024, // outBufferSize
pipeSecurity
});
}
}
else
{
// This handles the Unix case since PipeSecurity is not supported on Unix.
// Instead, we use chmod in Start-EditorServices.ps1
this.inOutPipeServer = new NamedPipeServerStream(
pipeName: inOutPipeName,
direction: PipeDirection.InOut,
maxNumberOfServerInstances: 1,
transmissionMode: PipeTransmissionMode.Byte,
options: PipeOptions.Asynchronous);
options: PipeOptions.Asynchronous | (PipeOptions)CurrentUserOnly);
if (this.outPipeName != null)
{
this.outPipeServer = new NamedPipeServerStream(
pipeName: outPipeName,
direction: PipeDirection.Out,
maxNumberOfServerInstances: 1,
transmissionMode: PipeTransmissionMode.Byte,
options: PipeOptions.None);
options: (PipeOptions)CurrentUserOnly);
}
}
ListenForConnection();
Expand Down Expand Up @@ -171,143 +196,4 @@ private static async Task WaitForConnectionAsync(NamedPipeServerStream pipeServe
await pipeServerStream.FlushAsync();
}
}

/// <summary>
/// Native API for Named Pipes
/// This code was borrowed from PowerShell here:
/// https://github.com/PowerShell/PowerShell/blob/master/src/System.Management.Automation/engine/remoting/common/RemoteSessionNamedPipe.cs#L124-L256
/// </summary>
internal static class NamedPipeNative
{
#region Pipe constants

// Pipe open mode
internal const uint PIPE_ACCESS_DUPLEX = 0x00000003;

// Pipe modes
internal const uint PIPE_TYPE_BYTE = 0x00000000;
internal const uint FILE_FLAG_OVERLAPPED = 0x40000000;
internal const uint FILE_FLAG_FIRST_PIPE_INSTANCE = 0x00080000;
internal const uint PIPE_READMODE_BYTE = 0x00000000;

#endregion

#region Data structures

[StructLayout(LayoutKind.Sequential)]
internal class SECURITY_ATTRIBUTES
{
/// <summary>
/// The size, in bytes, of this structure. Set this value to the size of the SECURITY_ATTRIBUTES structure.
/// </summary>
public int NLength;

/// <summary>
/// A pointer to a security descriptor for the object that controls the sharing of it.
/// </summary>
public IntPtr LPSecurityDescriptor = IntPtr.Zero;

/// <summary>
/// A Boolean value that specifies whether the returned handle is inherited when a new process is created.
/// </summary>
public bool InheritHandle;

/// <summary>
/// Initializes a new instance of the SECURITY_ATTRIBUTES class
/// </summary>
public SECURITY_ATTRIBUTES()
{
this.NLength = 12;
}
}

#endregion

#region Pipe methods

[DllImport("kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]
internal static extern SafePipeHandle CreateNamedPipe(
string lpName,
uint dwOpenMode,
uint dwPipeMode,
uint nMaxInstances,
uint nOutBufferSize,
uint nInBufferSize,
uint nDefaultTimeOut,
SECURITY_ATTRIBUTES securityAttributes);

internal static SECURITY_ATTRIBUTES GetSecurityAttributes(GCHandle securityDescriptorPinnedHandle, bool inheritHandle = false)
{
SECURITY_ATTRIBUTES securityAttributes = new NamedPipeNative.SECURITY_ATTRIBUTES();
securityAttributes.InheritHandle = inheritHandle;
securityAttributes.NLength = (int)Marshal.SizeOf(securityAttributes);
securityAttributes.LPSecurityDescriptor = securityDescriptorPinnedHandle.AddrOfPinnedObject();
return securityAttributes;
}

/// <summary>
/// Helper method to create a PowerShell transport named pipe via native API, along
/// with a returned .Net NamedPipeServerStream object wrapping the named pipe.
/// </summary>
/// <param name="pipeName">Named pipe core name.</param>
/// <param name="securityDesc"></param>
/// <returns>NamedPipeServerStream</returns>
internal static NamedPipeServerStream CreateNamedPipe(
string pipeName,
PipeSecurity pipeSecurity)

{
string fullPipeName = @"\\.\pipe\" + pipeName;
CommonSecurityDescriptor securityDesc = new CommonSecurityDescriptor(false, false, pipeSecurity.GetSecurityDescriptorBinaryForm(), 0);

// Create optional security attributes based on provided PipeSecurity.
NamedPipeNative.SECURITY_ATTRIBUTES securityAttributes = null;
GCHandle? securityDescHandle = null;
if (securityDesc != null)
{
byte[] securityDescBuffer = new byte[securityDesc.BinaryLength];
securityDesc.GetBinaryForm(securityDescBuffer, 0);

securityDescHandle = GCHandle.Alloc(securityDescBuffer, GCHandleType.Pinned);
securityAttributes = NamedPipeNative.GetSecurityAttributes(securityDescHandle.Value);
}

// Create named pipe.
SafePipeHandle pipeHandle = NamedPipeNative.CreateNamedPipe(
fullPipeName,
NamedPipeNative.PIPE_ACCESS_DUPLEX | NamedPipeNative.FILE_FLAG_FIRST_PIPE_INSTANCE | NamedPipeNative.FILE_FLAG_OVERLAPPED,
NamedPipeNative.PIPE_TYPE_BYTE | NamedPipeNative.PIPE_READMODE_BYTE,
1,
1024,
1024,
0,
securityAttributes);

int lastError = Marshal.GetLastWin32Error();
if (securityDescHandle != null)
{
securityDescHandle.Value.Free();
}

if (pipeHandle.IsInvalid)
{
throw new InvalidOperationException();
}
// Create the .Net NamedPipeServerStream wrapper.
try
{
return new NamedPipeServerStream(
PipeDirection.InOut,
true, // IsAsync
false, // IsConnected
pipeHandle);
}
catch (Exception)
{
pipeHandle.Dispose();
throw;
}
}
#endregion
}
}
11 changes: 5 additions & 6 deletions src/PowerShellEditorServices.Protocol/Server/DebugAdapter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,13 +160,12 @@ private async Task OnExecutionCompletedAsync(Task executeTask)
// Respond to the disconnect request and stop the server
await _disconnectRequestContext.SendResultAsync(null);
Stop();
return;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

}
else
{
await _messageSender.SendEventAsync(
TerminatedEvent.Type,
new TerminatedEvent());
}

await _messageSender.SendEventAsync(
TerminatedEvent.Type,
new TerminatedEvent());
}

protected void Stop()
Expand Down