Skip to content

WIP: Add -SSHTransportPath Parameter #14462

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

Closed
Justin Grote (JustinGrote) wants to merge 5 commits into from
Closed

WIP: Add -SSHTransportPath Parameter #14462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c5273a
Change SSHCommand from const to string to make it configurable
Dec 18, 2020
198b913
Add SSHTransportName parameter
Dec 18, 2020
f8c0953
Add SSHTransportPath, related constructor, and update runspace Copy f…
Dec 18, 2020
ee9de8e
CodeFactor Linting Cleanup
Dec 18, 2020
5f7ed89
Further codefactor cleanup
Dec 18, 2020
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
12 changes: 12 additions & 0 deletions src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,6 +753,18 @@ public override SwitchParameter SSHTransport
set { base.SSHTransport = value; }
}

/// <summary>
/// This parameter allows you to specify a custom executable name to use for the SSH transport. The executable must be on the path.
/// </summary>
[Parameter(ParameterSetName = PSRemotingBaseCmdlet.SSHHostParameterSet)]
[Parameter(ParameterSetName = InvokeCommandCommand.FilePathSSHHostParameterSet)]
public override string SSHTransportPath
{
get { return base.SSHTransportPath; }

set { base.SSHTransportPath = value; }
}

/// <summary>
/// Hashtable array containing SSH connection parameters for each remote target
/// ComputerName (Alias: HostName) (required)
Expand Down
10 changes: 10 additions & 0 deletions src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -769,6 +769,16 @@ public virtual SwitchParameter SSHTransport
set;
}

/// <summary>
/// Gets or sets a custom executable name to use for the SSH transport. The executable must be on the path.
/// </summary>
[Parameter(ParameterSetName = PSRemotingBaseCmdlet.SSHHostParameterSet)]
public virtual string SSHTransportPath
{
get;
set;
}

/// <summary>
/// Hashtable array containing SSH connection parameters for each remote target
/// ComputerName (Alias: HostName) (required)
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/engine/remoting/commands/PushRunspaceCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1262,7 +1262,7 @@ private RemoteRunspace GetRunspaceForContainerSession()
private RemoteRunspace GetRunspaceForSSHSession()
{
ParseSshHostName(HostName, out string host, out string userName, out int port);
var sshConnectionInfo = new SSHConnectionInfo(userName, host, this.KeyFilePath, port, this.Subsystem);
var sshConnectionInfo = new SSHConnectionInfo(userName, host, KeyFilePath, port, Subsystem, SSHTransportPath);
var typeTable = TypeTable.LoadDefaultTypeFiles();

// Use the class _tempRunspace field while the runspace is being opened so that StopProcessing can be handled at that time.
Expand Down
46 changes: 40 additions & 6 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 @@ -1892,6 +1892,15 @@ private string Subsystem
set;
}

/// <summary>
/// Gets or sets the name of the ssh executable to use.
/// </summary>
private string SshPath
{
get;
set;
}

#endregion

#region Constructors
Expand Down Expand Up @@ -1960,6 +1969,26 @@ public SSHConnectionInfo(
this.Port = port;
this.Subsystem = (string.IsNullOrEmpty(subsystem)) ? DefaultSubsystem : subsystem;
}

/// <summary>
/// Initializes a new instance of the SSHConnectionInfo class.
/// </summary>
/// <param name="userName">User Name.</param>
/// <param name="computerName">Computer Name.</param>
/// <param name="keyFilePath">Key File Path.</param>
/// <param name="port">Port number for connection (default 22).</param>
/// <param name="subsystem">Subsystem to use (default 'powershell').</param>
/// <param name="sshPath">Name or path to ssh executable (default 'ssh' or 'ssh.exe')'.</param>
public SSHConnectionInfo(
string userName,
string computerName,
string keyFilePath,
int port,
string subsystem,
string sshPath) : this(userName, computerName, keyFilePath, port, subsystem)
{
this.SshPath = sshPath;
}

#endregion

Expand Down Expand Up @@ -2016,6 +2045,7 @@ internal override RunspaceConnectionInfo InternalCopy()
newCopy.KeyFilePath = this.KeyFilePath;
newCopy.Port = this.Port;
newCopy.Subsystem = this.Subsystem;
newCopy.SshPath = this.SshPath;

return newCopy;
}
Expand Down Expand Up @@ -2049,15 +2079,19 @@ internal int StartSSHProcess(
out StreamReader stdErrReaderVar)
{
string filePath = string.Empty;
#if UNIX
const string sshCommand = "ssh";
#else
const string sshCommand = "ssh.exe";
#endif
if (SshPath == null)
{
#if UNIX
SshPath = "ssh";
#else
SshPath = "ssh.exe";
#endif
}

var context = Runspaces.LocalPipeline.GetExecutionContextFromTLS();
if (context != null)
{
var cmdInfo = context.CommandDiscovery.LookupCommandInfo(sshCommand, CommandOrigin.Internal) as ApplicationInfo;
var cmdInfo = context.CommandDiscovery.LookupCommandInfo(SshPath, CommandOrigin.Internal) as ApplicationInfo;
if (cmdInfo != null)
{
filePath = cmdInfo.Path;
Expand Down