Support OpenSSH options for PSRP over SSH commands (PowerShell#12802)

Add an -Options parameter to Invoke-Command and Start-PSSession to pass SSH options

Options parameter added to Invoke-Command
Options parameter added to Start-PSSession
Options parameter added to Enter-PSSession
Options parameter added to SSHConnection Hashtable

Author: BrannenGH

src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs

@@ -858,6 +858,25 @@ public override Hashtable[] SSHConnection
             set;
         }
 
+        /// <summary>
+        /// Hashtable containing options to be passed to OpenSSH.
+        /// </summary>
+        [Parameter(ParameterSetName = InvokeCommandCommand.SSHHostParameterSet)]
+        [Parameter(ParameterSetName = InvokeCommandCommand.FilePathSSHHostParameterSet)]
+        [ValidateNotNullOrEmpty]
+        public override Hashtable Options
+        {
+            get 
+            {
+                return base.Options;
+            }
+
+            set 
+            {
+                base.Options = value;
+            }
+        }
+
         #endregion
 
         #region Remote Debug Parameters

src/System.Management.Automation/engine/remoting/commands/PSRemotingCmdlet.cs

@@ -287,6 +287,7 @@ internal struct SSHConnection
         public int Port;
         public string Subsystem;
         public int ConnectingTimeout;
+        public Hashtable Options;
     }
 
     /// <summary>
@@ -805,6 +806,13 @@ public virtual Hashtable[] SSHConnection
             set;
         }
 
+        /// <summary>
+        /// Gets or sets the Hashtable containing options to be passed to OpenSSH.
+        /// </summary>
+        [Parameter(ParameterSetName = InvokeCommandCommand.SSHHostParameterSet)]
+        [ValidateNotNullOrEmpty]
+        public virtual Hashtable Options { get; set; }
+
         #endregion
 
         #endregion Properties
@@ -866,6 +874,7 @@ internal static void ValidateSpecifiedAuthentication(PSCredential credential, st
         private const string PortParameter = "Port";
         private const string SubsystemParameter = "Subsystem";
         private const string ConnectingTimeoutParameter = "ConnectingTimeout";
+        private const string OptionsParameter = "Options";
 
         #endregion
 
@@ -969,6 +978,10 @@ internal SSHConnection[] ParseSSHConnectionHashTable()
                     {
                         connectionInfo.ConnectingTimeout = GetSSHConnectionIntParameter(item[paramName]);
                     }
+                    else if (paramName.Equals(OptionsParameter, StringComparison.OrdinalIgnoreCase))
+                    {
+                        connectionInfo.Options = item[paramName] as Hashtable;
+                    }
                     else
                     {
                         throw new PSArgumentException(
@@ -1462,7 +1475,7 @@ protected void CreateHelpersForSpecifiedSSHComputerNames()
             {
                 ParseSshHostName(computerName, out string host, out string userName, out int port);
 
-                var sshConnectionInfo = new SSHConnectionInfo(userName, host, KeyFilePath, port, Subsystem, ConnectingTimeout);
+                var sshConnectionInfo = new SSHConnectionInfo(userName, host, KeyFilePath, port, Subsystem, ConnectingTimeout, Options);
                 var typeTable = TypeTable.LoadDefaultTypeFiles();
                 var remoteRunspace = RunspaceFactory.CreateRunspace(sshConnectionInfo, Host, typeTable) as RemoteRunspace;
                 var pipeline = CreatePipeline(remoteRunspace);

src/System.Management.Automation/engine/remoting/commands/PushRunspaceCommand.cs

@@ -58,6 +58,24 @@ public class EnterPSSessionCommand : PSRemotingBaseCmdlet
         [ValidateNotNullOrEmpty()]
         public new string HostName { get; set; }
 
+        /// <summary>
+        /// Gets or sets the Hashtable containing options to be passed to OpenSSH.
+        /// </summary>
+        [Parameter(ParameterSetName = PSRemotingBaseCmdlet.SSHHostParameterSet)]
+        [ValidateNotNullOrEmpty]
+        public override Hashtable Options 
+        { 
+            get 
+            {
+                return base.Options;
+            }
+
+            set
+            {
+                base.Options = value;
+            }
+        }
+
         #endregion
 
         /// <summary>
@@ -1262,7 +1280,7 @@ private RemoteRunspace GetRunspaceForContainerSession()
         private RemoteRunspace GetRunspaceForSSHSession()
         {
             ParseSshHostName(HostName, out string host, out string userName, out int port);
-            var sshConnectionInfo = new SSHConnectionInfo(userName, host, KeyFilePath, port, Subsystem, ConnectingTimeout);
+            var sshConnectionInfo = new SSHConnectionInfo(userName, host, KeyFilePath, port, Subsystem, ConnectingTimeout, Options);
             var typeTable = TypeTable.LoadDefaultTypeFiles();
 
             // Use the class _tempRunspace field while the runspace is being opened so that StopProcessing can be handled at that time.

src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs

@@ -1093,7 +1093,8 @@ private List<RemoteRunspace> CreateRunspacesForSSHHostParameterSet()
                     this.KeyFilePath,
                     port,
                     Subsystem,
-                    ConnectingTimeout);
+                    ConnectingTimeout,
+                    Options);
                 var typeTable = TypeTable.LoadDefaultTypeFiles();
                 string rsName = GetRunspaceName(index, out int rsIdUnused);
                 index++;
@@ -1120,7 +1121,8 @@ private List<RemoteRunspace> CreateRunspacesForSSHHostHashParameterSet()
                     sshConnection.KeyFilePath,
                     sshConnection.Port,
                     sshConnection.Subsystem,
-                    sshConnection.ConnectingTimeout);
+                    sshConnection.ConnectingTimeout,
+                    sshConnection.Options);
                 var typeTable = TypeTable.LoadDefaultTypeFiles();
                 string rsName = GetRunspaceName(index, out int rsIdUnused);
                 index++;

src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System.Collections;
 using System.Collections.Generic;
 using System.ComponentModel; // Win32Exception
 using System.Diagnostics;
@@ -1969,18 +1970,27 @@ public int ConnectingTimeout
             set;
         }
 
+        /// The SSH options to pass to OpenSSH.
+        /// Gets or sets the SSH options to pass to OpenSSH.
+        /// </summary>
+        private Hashtable Options
+        {
+            get;
+            set;
+        }
+
         #endregion
 
         #region Constructors
 
         /// <summary>
-        /// Constructor.
+        /// Initializes a new instance of the <see cref="SSHConnectionInfo" /> class.
         /// </summary>
         private SSHConnectionInfo()
         { }
 
         /// <summary>
-        /// Constructor.
+        /// Initializes a new instance of the <see cref="SSHConnectionInfo" /> class.
         /// </summary>
         /// <param name="userName">User Name.</param>
         /// <param name="computerName">Computer Name.</param>
@@ -2001,7 +2011,7 @@ public SSHConnectionInfo(
         }
 
         /// <summary>
-        /// Constructor.
+        /// Initializes a new instance of the <see cref="SSHConnectionInfo" /> class.
         /// </summary>
         /// <param name="userName">User Name.</param>
         /// <param name="computerName">Computer Name.</param>
@@ -2018,7 +2028,7 @@ public SSHConnectionInfo(
         }
 
         /// <summary>
-        /// Constructor.
+        /// Initializes a new instance of the <see cref="SSHConnectionInfo" /> class.
         /// </summary>
         /// <param name="userName">User Name.</param>
         /// <param name="computerName">Computer Name.</param>
@@ -2055,6 +2065,28 @@ public SSHConnectionInfo(
             ConnectingTimeout = connectingTimeout;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="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="connectingTimeout">Timeout time for terminating connection attempt.</param>
+        /// <param name="options">Options for the SSH connection.</param>
+        public SSHConnectionInfo(
+            string userName,
+            string computerName,
+            string keyFilePath,
+            int port,
+            string subsystem,
+            int connectingTimeout,
+            Hashtable options) : this(userName, computerName, keyFilePath, port, subsystem, connectingTimeout)
+        {
+           Options = options;
+        }
+
         #endregion
 
         #region Overrides
@@ -2111,6 +2143,7 @@ internal override RunspaceConnectionInfo InternalCopy()
             newCopy.Port = Port;
             newCopy.Subsystem = Subsystem;
             newCopy.ConnectingTimeout = ConnectingTimeout;
+            newCopy.Options = Options;
 
             return newCopy;
         }
@@ -2163,9 +2196,9 @@ internal int StartSSHProcess(
             //
             // Local ssh invoked as:
             //   windows:
-            //     ssh.exe [-i identity_file] [-l login_name] [-p port] -s <destination> <command>
+            //     ssh.exe [-i identity_file] [-l login_name] [-p port] [-o option] -s <destination> <command>
             //   linux|macos:
-            //     ssh [-i identity_file] [-l login_name] [-p port] -s <destination> <command>
+            //     ssh [-i identity_file] [-l login_name] [-p port] [-o option] -s <destination> <command>
             // where <command> is interpreted as the subsystem due to the -s flag.
             //
             // Remote sshd configured for PowerShell Remoting Protocol (PSRP) over Secure Shell Protocol (SSH)
@@ -2216,6 +2249,15 @@ internal int StartSSHProcess(
                 startInfo.ArgumentList.Add(string.Format(CultureInfo.InvariantCulture, @"-p {0}", this.Port));
             }
 
+            // pass "-o option=value" command line argument to ssh if options are provided
+            if (this.Options != null) 
+            {
+                foreach (DictionaryEntry pair in this.Options) 
+                {
+                    startInfo.ArgumentList.Add(string.Format(CultureInfo.InvariantCulture, @"-o {0}={1}", pair.Key, pair.Value));
+                }
+            }
+
             // pass "-s destination command" command line arguments to ssh where command is the subsystem to invoke on the destination
             // note that ssh expects IPv6 addresses to not be enclosed in square brackets so trim them if present
             startInfo.ArgumentList.Add(string.Format(CultureInfo.InvariantCulture, @"-s {0} {1}", this.ComputerName.TrimStart('[').TrimEnd(']'), this.Subsystem));

test/SSHRemoting/SSHRemoting.Basic.Tests.ps1

@@ -179,6 +179,13 @@ Describe "SSHRemoting Basic Tests" -tags CI {
             Write-Verbose -Verbose "It Complete"
         }
 
+        It "Verifies explicit Options parameter" {
+            $options = @{"Port"="22"}
+            $script:session = New-PSSession -HostName localhost -Options $options -ErrorVariable err
+            $err | Should -HaveCount 0
+            VerifySession $script:session
+        }
+
         It "Verifies explicit Subsystem parameter" {
             Write-Verbose -Verbose "It Starting: Verifies explicit Subsystem parameter"
             $portNum = 22