Add remote port parameter to TCP listener factory

src/cs/Ssh.Tcp/DefaultTcpListenerFactory.cs

@@ -16,9 +16,10 @@ internal class DefaultTcpListenerFactory : ITcpListenerFactory
 {
 	/// <inheritdoc />
 	public Task<TcpListener> CreateTcpListenerAsync(
+		int? remotePort,
 		IPAddress localIPAddress,
 		int localPort,
-		bool canChangePort,
+		bool canChangeLocalPort,
 		TraceSource trace,
 		CancellationToken cancellation)
 	{

src/cs/Ssh.Tcp/ITcpListenerFactory.cs

@@ -18,11 +18,13 @@ public interface ITcpListenerFactory
 	/// Creates and starts a TCP listener for the specified local network address and port
 	/// number.
 	/// </summary>
+	/// <param name="remotePort">The remote port that this local port will connect to (if known).
+	/// </param>
 	/// <param name="localIPAddress">Local IP address to listen on.</param>
 	/// <param name="localPort">Requested local port to listen on, or 0 to use a random
 	/// available port number.</param>
-	/// <param name="canChangePort">True if the factory is allowed to select a different
-	/// port number than the one that was requested; if false then the factory must either
+	/// <param name="canChangeLocalPort">True if the factory is allowed to select a different
+	/// local port number than the one that was requested; if false then the factory must either
 	/// use the requested port or throw an exception.</param>
 	/// <param name="trace">Trace source.</param>
 	/// <param name="cancellation">Cancellation token.</param>
@@ -43,9 +45,10 @@ public interface ITcpListenerFactory
 	/// <see cref="TcpListener.LocalEndpoint"/> property.
 	/// </remarks>
 	Task<TcpListener> CreateTcpListenerAsync(
+		int? remotePort,
 		IPAddress localIPAddress,
 		int localPort,
-		bool canChangePort,
+		bool canChangeLocalPort,
 		TraceSource trace,
 		CancellationToken cancellation);
 }

src/cs/Ssh.Tcp/Services/LocalPortForwarder.cs

@@ -76,8 +76,12 @@ internal async Task StartForwardingAsync(CancellationToken cancellation)
 		{
 			var trace = this.pfs.Session.Trace;
 			this.listener = await this.pfs.TcpListenerFactory.CreateTcpListenerAsync(
-				listenAddress, LocalPort, canChangePort: true, trace, cancellation)
-				.ConfigureAwait(false);
+				RemotePort,
+				listenAddress,
+				LocalPort,
+				canChangeLocalPort: true,
+				trace,
+				cancellation).ConfigureAwait(false);
 
 			LocalPort = ((IPEndPoint)this.listener.LocalEndpoint).Port;
 
@@ -94,8 +98,12 @@ internal async Task StartForwardingAsync(CancellationToken cancellation)
 				try
 				{
 					this.listener2 = await this.pfs.TcpListenerFactory.CreateTcpListenerAsync(
-						listenAddress, LocalPort, canChangePort: false, trace, cancellation)
-						.ConfigureAwait(false);
+						RemotePort,
+						listenAddress,
+						LocalPort,
+						canChangeLocalPort: false,
+						trace,
+						cancellation).ConfigureAwait(false);
 				}
 				catch (SocketException sockex)
 				when (sockex.SocketErrorCode == SocketError.AddressNotAvailable)

src/cs/Ssh.Tcp/SshServer.cs

@@ -79,9 +79,10 @@ public async Task AcceptSessionsAsync(
 		try
 		{
 			listener = await TcpListenerFactory.CreateTcpListenerAsync(
+				remotePort: null,
 				localAddress,
 				localPort,
-				canChangePort: false,
+				canChangeLocalPort: false,
 				this.trace,
 				CancellationToken.None)
 				.ConfigureAwait(false);

src/ts/ssh-tcp/services/localPortForwarder.ts

@@ -77,6 +77,7 @@ export class LocalPortForwarder extends SshService {
 		let listenAddress = this.localIPAddress;
 		try {
 			this.tcpListener = await this.pfs.tcpListenerFactory.createTcpListener(
+				this.remotePort,
 				listenAddress,
 				this.port,
 				true,
@@ -97,6 +98,7 @@ export class LocalPortForwarder extends SshService {
 				listenAddress = this.localIPAddress === '0.0.0.0' ? '::' : '::1';
 				try {
 					this.tcpListener2 = await this.pfs.tcpListenerFactory.createTcpListener(
+						this.remotePort,
 						listenAddress,
 						this.port,
 						false,

src/ts/ssh-tcp/sshServer.ts

@@ -81,6 +81,7 @@ export class SshServer implements Disposable {
 
 		try {
 			this.tcpListener = await this.tcpListenerFactory.createTcpListener(
+				undefined, // remotePort
 				localAddress,
 				localPort,
 				false,

src/ts/ssh-tcp/tcpListenerFactory.ts

@@ -10,11 +10,12 @@ export interface TcpListenerFactory {
 	 * Creates and starts a TCP listener for the specified local network address and port
 	 * number.
 	 *
+	 * @param remotePort The remote port that this local port will connect to (if known).
 	 * @param localIPAddress Local IP address to listen on.
 	 * @param localPort Requested local port to listen on, or 0 to use a random
 	 * available port number.
-	 * @param canChangePort True if the factory is allowed to select a different
-	 * port number than the one that was requested; if false then the factory must either
+	 * @param canChangeLocalPort True if the factory is allowed to select a different
+	 * local port number than the one that was requested; if false then the factory must either
 	 * use the requested port or throw an exception.</param>
 	 * @param cancellation">Cancellation token.</param>
 	 * @returns TCP listener object that has started listening.</returns>
@@ -33,6 +34,7 @@ export interface TcpListenerFactory {
 	 * obtain the actual port from the returned listener's `localEndpoint` property.
 	 */
 	createTcpListener(
+		remotePort: number | undefined,
 		localIPAddress: string,
 		localPort: number,
 		canChangePort: boolean,
@@ -42,6 +44,7 @@ export interface TcpListenerFactory {
 
 export class DefaultTcpListenerFactory implements TcpListenerFactory {
 	public async createTcpListener(
+		remotePort: number | undefined,
 		localIPAddress: string,
 		localPort: number,
 		canChangePort: boolean,

test/cs/Ssh.Test/PortForwardingTests.cs

@@ -159,6 +159,7 @@ public TestTcpListenerFactory(int localPortOverride, bool autoIncrement = false)
 		}
 
 		public Task<TcpListener> CreateTcpListenerAsync(
+			int? remotePort,
 			IPAddress localIPAddress,
 			int localPort,
 			bool canChangePort,

test/ts/ssh-test/portForwardingTests.ts

@@ -50,6 +50,7 @@ class TestTcpListenerFactory implements TcpListenerFactory {
 	public constructor(public readonly localPortOverride: number) { }
 
 	public async createTcpListener(
+		remotePort: number | undefined,
 		localIPAddress: string,
 		localPort: number,
 		canChangePort: boolean,

version.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json",
-	"version": "3.11",
+	"version": "3.12",
 	"publicReleaseRefSpec": [
 		"^refs/heads/main$",
 		"^refs/heads/releases/.+$"