Skip to content

Update PowerShell Direct to try pwsh then fallback to powershell #7241

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 13 commits into from
Jul 11, 2018
Merged

Update PowerShell Direct to try pwsh then fallback to powershell #7241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ec7a234
Port change to use pwsh and then to fall back to Windows PowerShell i…
TravisEz13 Jul 6, 2018
20dde80
make the process a property
TravisEz13 Jul 9, 2018
06a3f77
Convert CreateContainerProcessInternal to use a loop
TravisEz13 Jul 9, 2018
9bed542
Add comments
TravisEz13 Jul 9, 2018
4e0530c
Add error code to cannot create process resource
TravisEz13 Jul 9, 2018
1b3cd96
format cannot create process resource with error code
TravisEz13 Jul 9, 2018
74b597c
expand -so to -SocketServerMode
TravisEz13 Jul 9, 2018
8e370cc
simplify comments about cannot find file case
TravisEz13 Jul 9, 2018
bf06fc7
add const for file not found hresult
TravisEz13 Jul 9, 2018
99acff5
make executable array static readyonly
TravisEz13 Jul 10, 2018
239f8a7
pass executableToTry to function to generate command
TravisEz13 Jul 9, 2018
e7c32b1
make sure we return an error if we not found any PowerShell host
TravisEz13 Jul 10, 2018
b638ecd
Fix StyleCop issues
TravisEz13 Jul 11, 2018
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
110 changes: 79 additions & 31 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 @@ -2953,57 +2953,67 @@ internal class ContainerProcess
private const uint ContainersFeatureNotEnabled = 2;
private const uint OtherError = 9999;

private const uint FileNotFoundHResult = 0x80070002;

// The list of executable to try in order
private static readonly string[] Executables = new string[] { "pwsh.exe", "powershell.exe"};

#endregion

#region Properties

/// <summary>
/// For Hyper-V container, it is Guid of utility VM hosting Hyper-V container.
/// Gets or Sets, for Hyper-V container, the Guid of utility VM hosting Hyper-V container.
/// For Windows Server Container, it is empty.
/// </summary>
public Guid RuntimeId { get; set; }

/// <summary>
/// OB root of the container.
/// Gets or sets the OB root of the container.
/// </summary>
public string ContainerObRoot { get; set; }

/// <summary>
/// ID of the container.
/// Gets or sets the ID of the container.
/// </summary>
public string ContainerId { get; set; }

/// <summary>
/// Process ID of the process created in container.
/// Gets or sets the process ID of the process created in container.
/// </summary>
internal int ProcessId { get; set; }

/// <summary>
/// Whether the process in container should be launched as high privileged account
/// Gets or sets whether the process in container should be launched as high privileged account
/// (RunAsAdmin being true) or low privileged account (RunAsAdmin being false).
/// </summary>
internal bool RunAsAdmin { get; set; } = false;

/// <summary>
/// The configuration name of the container session.
/// Gets or sets the configuration name of the container session.
/// </summary>
internal string ConfigurationName { get; set; }

/// <summary>
/// Whether the process in container has terminated.
/// Gets or sets whether the process in container has terminated.
/// </summary>
internal bool ProcessTerminated { get; set; } = false;

/// <summary>
/// The error code.
/// Gets or sets the error code.
/// </summary>
internal uint ErrorCode { get; set; } = 0;

/// <summary>
/// The error message for other errors.
/// Gets or sets the error message for other errors.
/// </summary>
internal string ErrorMessage { get; set; } = string.Empty;

/// <summary>
/// Gets or sets the PowerShell executable being used to host the runspace.
/// </summary>
internal string Executable { get; set; } = string.Empty;

#endregion

#region Native HCS (i.e., host compute service) methods
Expand Down Expand Up @@ -3123,7 +3133,9 @@ public void CreateContainerProcess()
// other errors caught without exception
default:
throw new PSInvalidOperationException(StringUtil.Format(RemotingErrorIdStrings.CannotCreateProcessInContainer,
ContainerId));
ContainerId,
Executable,
ErrorCode));
}
}

Expand Down Expand Up @@ -3207,30 +3219,49 @@ private void CreateContainerProcessInternal()
//
// Hyper-V container (i.e., RuntimeId is not empty) uses Hyper-V socket transport.
// Windows Server container (i.e., RuntimeId is empty) uses named pipe transport for now.
// This code executes `powershell.exe` as it exists in the container which currently is
// expected to be Windows PowerShell as it's inbox in the container.
// This code executes `pwsh.exe` as it exists in the container which currently is
// expected to be PowerShell Core as it's inbox in the container.
// If `pwsh.exe` does not exist, fall back to `powershell.exe` which is Windows PowerShell.
//
cmd = string.Format(System.Globalization.CultureInfo.InvariantCulture,
@"{{""CommandLine"": ""powershell.exe {0} -NoLogo {1}"",""RestrictedToken"": {2}}}",
(RuntimeId != Guid.Empty) ? "-so -NoProfile" : "-NamedPipeServerMode",
String.IsNullOrEmpty(ConfigurationName) ? String.Empty : String.Concat("-Config ", ConfigurationName),
(RunAsAdmin) ? "false" : "true");
foreach (string executableToTry in Executables)
{
cmd = GetContainerProcessCommand(executableToTry);

HCS_PROCESS_INFORMATION ProcessInformation = new HCS_PROCESS_INFORMATION();
IntPtr Process = IntPtr.Zero;
HCS_PROCESS_INFORMATION ProcessInformation = new HCS_PROCESS_INFORMATION();
IntPtr Process = IntPtr.Zero;

//
// Create PowerShell process inside the container.
//
result = HcsCreateProcess(ComputeSystem, cmd, ref ProcessInformation, ref Process, ref resultString);
if (result != 0)
{
processId = 0;
error = result;
}
else
{
processId = Convert.ToInt32(ProcessInformation.ProcessId);
//
// Create PowerShell process inside the container.
//
result = HcsCreateProcess(ComputeSystem, cmd, ref ProcessInformation, ref Process, ref resultString);
if (result == 0)
{
processId = Convert.ToInt32(ProcessInformation.ProcessId);

// Reset error to 0 in case this is not the first iteration of the loop.
error = 0;

// the process was started, exit the loop.
break;
}
else if (result == FileNotFoundHResult)
{
// "The system cannot find the file specified", try the next one
// or exit the loop of none are left to try.
// Set the process and error information in case we exit the loop.
processId = 0;
error = result;
continue;
}
else
{
processId = 0;
error = result;

// the executable was found but did not work
// exit the loop with the error state.
break;
}
}
}
}
Expand Down Expand Up @@ -3260,6 +3291,23 @@ private void CreateContainerProcessInternal()
ErrorCode = error;
}

/// <summary>
/// Get Command to launch container process based on instance properties.
/// </summary>
/// <param name="executable">The name of the executable to use in the command.</param>
/// <returns>The command to launch the container process.</returns>
private string GetContainerProcessCommand(string executable)
{
Executable = executable;
return string.Format(
System.Globalization.CultureInfo.InvariantCulture,
@"{{""CommandLine"": ""{0} {1} -NoLogo {2}"",""RestrictedToken"": {3}}}",
Executable,
(RuntimeId != Guid.Empty) ? "-SocketServerMode -NoProfile" : "-NamedPipeServerMode",
string.IsNullOrEmpty(ConfigurationName) ? string.Empty : string.Concat("-Config ", ConfigurationName),
RunAsAdmin ? "false" : "true");
}

/// <summary>
/// Terminate the process inside container.
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/resources/RemotingErrorIdStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1199,7 +1199,7 @@ All WinRM sessions connected to PowerShell session configurations, such as Micro
<value>The Hyper-V Module for PowerShell is not available on this machine.</value>
</data>
<data name="CannotCreateProcessInContainer" xml:space="preserve">
<value>Failed to launch PowerShell process inside container with id {0}.</value>
<value>Failed to launch PowerShell process ({1}) inside container with id {0} with error: {2}.</value>
</data>
<data name="ContainersFeatureNotEnabled" xml:space="preserve">
<value>The Containers feature may not be enabled on this machine.</value>
Expand Down