Merge branch 'develop' into aesgcm-netframework

Author: scott-xu

.github/workflows/build.yml

@@ -25,9 +25,6 @@ jobs:
     - name: Build IntegrationTests .NET
       run: dotnet build -f net9.0 test/Renci.SshNet.IntegrationTests/
 
-    - name: Build IntegrationTests .NET Framework
-      run:  dotnet build -f net48 test/Renci.SshNet.IntegrationTests/
-
     - name: Run Unit Tests .NET
       run: |
         dotnet test \
@@ -52,36 +49,14 @@ jobs:
           -p:CoverletOutput=../../coverlet/linux_integration_test_net_9_coverage.xml \
           test/Renci.SshNet.IntegrationTests/
 
-    # Also run a subset of the integration tests targeting netfx using mono. This is a temporary measure to get
-    # some coverage until a proper solution for running the .NET Framework integration tests in CI is found.
-    # Running all the tests causes problems which are not worth solving in this rare configuration.
-    # See https://github.com/sshnet/SSH.NET/pull/1462 and related links
-    - name: Run Integration Tests Mono
-      run: |
-        sudo apt-get install ca-certificates gnupg
-        sudo gpg --homedir /tmp --no-default-keyring --keyring /usr/share/keyrings/mono-official-archive-keyring.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
-        echo "deb [signed-by=/usr/share/keyrings/mono-official-archive-keyring.gpg] https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
-        sudo apt-get update
-        sudo apt-get install mono-devel
-        dotnet test \
-          -f net48 \
-          --no-build \
-          --logger "console;verbosity=normal" \
-          --logger GitHubActions \
-          -p:CollectCoverage=true \
-          -p:CoverletOutputFormat=cobertura \
-          -p:CoverletOutput=../../coverlet/linux_integration_test_net_48_coverage.xml \
-          --filter "Name~Ecdh|Name~ECDsa|Name~Zlib|Name~Gcm" \
-          test/Renci.SshNet.IntegrationTests/
-
     - name: Archive Coverlet Results
       uses: actions/upload-artifact@v4
       with:
           name: Coverlet Results Linux
           path: coverlet
 
   Windows:
-    runs-on: windows-2022
+    runs-on: windows-2025
     steps:
     - name: Checkout
       uses: actions/checkout@v4
@@ -132,6 +107,44 @@ jobs:
           -p:CoverletOutput=../../coverlet/windows_unit_test_net_4_6_2_coverage.xml `
           test/Renci.SshNet.Tests/
 
+  Windows-Integration-Tests:
+    name: Windows Integration Tests
+    runs-on: windows-2025
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0 # needed for Nerdbank.GitVersioning
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 9.0.x
+
+    - name: Setup WSL2
+      uses: Vampire/setup-wsl@v5
+      with:
+        distribution: Ubuntu-24.04
+
+    - name: Setup SSH Server
+      shell: wsl-bash {0}
+      run: |
+        apt-get update && apt-get upgrade -y
+        apt-get install -y podman
+        podman build -t renci-ssh-tests-server-image -f test/Renci.SshNet.IntegrationTests/Dockerfile test/Renci.SshNet.IntegrationTests/
+        podman run --rm -h renci-ssh-tests-server -d -p 2222:22 renci-ssh-tests-server-image
+
+    - name: Run Integration Tests .NET Framework
+      run:
+        dotnet test `
+          -f net48 `
+          --logger "console;verbosity=normal" `
+          --logger GitHubActions `
+          -p:CollectCoverage=true `
+          -p:CoverletOutputFormat=cobertura `
+          -p:CoverletOutput=..\..\coverlet\windows_integration_test_net_4_8_coverage.xml `
+          test\Renci.SshNet.IntegrationTests\
+
     - name: Archive Coverlet Results
       uses: actions/upload-artifact@v4
       with:

src/Renci.SshNet/Common/ChannelInputStream.cs

@@ -101,17 +101,10 @@ public override int Read(byte[] buffer, int offset, int count)
         /// <exception cref="ArgumentOutOfRangeException">offset or count is negative.</exception>
         public override void Write(byte[] buffer, int offset, int count)
         {
-            ThrowHelper.ThrowIfNull(buffer);
-
-            if (offset + count > buffer.Length)
-            {
-                throw new ArgumentException("The sum of offset and count is greater than the buffer length.");
-            }
-
-            if (offset < 0 || count < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(offset), "offset or count is negative.");
-            }
+#if !NET
+            ThrowHelper.
+#endif
+            ValidateBufferArguments(buffer, offset, count);
 
             ThrowHelper.ThrowObjectDisposedIf(_isDisposed, this);
 

src/Renci.SshNet/Common/PacketDump.cs

@@ -15,11 +15,7 @@ public static string Create(List<byte> data, int indentLevel)
         public static string Create(byte[] data, int indentLevel)
         {
             ThrowHelper.ThrowIfNull(data);
-
-            if (indentLevel < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(indentLevel), "Cannot be less than zero.");
-            }
+            ThrowHelper.ThrowIfNegative(indentLevel);
 
             const int lineWidth = 16;
 

src/Renci.SshNet/Common/PipeStream.cs

@@ -64,6 +64,11 @@ public override void SetLength(long value)
         /// <inheritdoc/>
         public override int Read(byte[] buffer, int offset, int count)
         {
+#if !NET
+            ThrowHelper.
+#endif
+            ValidateBufferArguments(buffer, offset, count);
+
             lock (_sync)
             {
                 while (_head == _tail && !_disposed)
@@ -88,6 +93,11 @@ public override int Read(byte[] buffer, int offset, int count)
         /// <inheritdoc/>
         public override void Write(byte[] buffer, int offset, int count)
         {
+#if !NET
+            ThrowHelper.
+#endif
+            ValidateBufferArguments(buffer, offset, count);
+
             lock (_sync)
             {
                 ThrowHelper.ThrowObjectDisposedIf(_disposed, this);

src/Renci.SshNet/Common/ThrowHelper.cs

@@ -77,6 +77,48 @@ static void Throw(string? argument, string? paramName)
                     throw new ArgumentException("The value cannot be an empty string.", paramName);
                 }
             }
+#endif
+        }
+
+#if !NET
+        // A rough copy of
+        // https://github.com/dotnet/runtime/blob/1d1bf92fcf43aa6981804dc53c5174445069c9e4/src/libraries/System.Private.CoreLib/src/System/IO/Stream.cs#L960C13-L974C10
+        // for lower targets.
+        public static void ValidateBufferArguments(byte[] buffer, int offset, int count)
+        {
+            ThrowIfNull(buffer);
+            ThrowIfNegative(offset);
+
+            if ((uint)count > buffer.Length - offset)
+            {
+                Throw();
+
+                [DoesNotReturn]
+                static void Throw()
+                {
+                    throw new ArgumentOutOfRangeException(
+                        nameof(count),
+                        "Offset and length were out of bounds for the array or count is greater than the number of elements from index to the end of the source collection.");
+                }
+            }
+        }
+#endif
+
+        public static void ThrowIfNegative(long value, [CallerArgumentExpression(nameof(value))] string? paramName = null)
+        {
+#if NET
+            ArgumentOutOfRangeException.ThrowIfNegative(value, paramName);
+#else
+            if (value < 0)
+            {
+                Throw(value, paramName);
+
+                [DoesNotReturn]
+                static void Throw(long value, string? paramName)
+                {
+                    throw new ArgumentOutOfRangeException(paramName, value, "Value must be non-negative.");
+                }
+            }
 #endif
         }
     }

src/Renci.SshNet/Security/KeyExchange.cs

@@ -63,7 +63,10 @@ public byte[] ExchangeHash
         /// </summary>
         public event EventHandler<HostKeyEventArgs> HostKeyReceived;
 
-        private protected KeyExchange()
+        /// <summary>
+        /// Initializes a new instance of the <see cref="KeyExchange"/> class.
+        /// </summary>
+        protected KeyExchange()
         {
             _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
         }

src/Renci.SshNet/Sftp/SftpFileStream.cs

@@ -511,28 +511,12 @@ public override Task FlushAsync(CancellationToken cancellationToken)
         /// </remarks>
         public override int Read(byte[] buffer, int offset, int count)
         {
-            var readLen = 0;
-
-            ThrowHelper.ThrowIfNull(buffer);
-
-#if NET
-            ArgumentOutOfRangeException.ThrowIfNegative(offset);
-            ArgumentOutOfRangeException.ThrowIfNegative(count);
-#else
-            if (offset < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(offset));
-            }
-
-            if (count < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(count));
-            }
+#if !NET
+            ThrowHelper.
 #endif
-            if ((buffer.Length - offset) < count)
-            {
-                throw new ArgumentException("Invalid array range.");
-            }
+            ValidateBufferArguments(buffer, offset, count);
+
+            var readLen = 0;
 
             // Lock down the file stream while we do this.
             lock (_lock)
@@ -653,28 +637,14 @@ public override int Read(byte[] buffer, int offset, int count)
         /// <returns>A <see cref="Task" /> that represents the asynchronous read operation.</returns>
         public override async Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
         {
-            var readLen = 0;
-
-            ThrowHelper.ThrowIfNull(buffer);
+#if !NET
+            ThrowHelper.
+#endif
+            ValidateBufferArguments(buffer, offset, count);
 
-#if NET
-            ArgumentOutOfRangeException.ThrowIfNegative(offset);
-            ArgumentOutOfRangeException.ThrowIfNegative(count);
-#else
-            if (offset < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(offset));
-            }
+            cancellationToken.ThrowIfCancellationRequested();
 
-            if (count < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(count));
-            }
-#endif
-            if ((buffer.Length - offset) < count)
-            {
-                throw new ArgumentException("Invalid array range.");
-            }
+            var readLen = 0;
 
             CheckSessionIsOpen();
 
@@ -952,14 +922,7 @@ public override long Seek(long offset, SeekOrigin origin)
         /// </remarks>
         public override void SetLength(long value)
         {
-#if NET
-            ArgumentOutOfRangeException.ThrowIfNegative(value);
-#else
-            if (value < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(value));
-            }
-#endif
+            ThrowHelper.ThrowIfNegative(value);
 
             // Lock down the file stream while we do this.
             lock (_lock)
@@ -1005,26 +968,10 @@ public override void SetLength(long value)
         /// <exception cref="ObjectDisposedException">Methods were called after the stream was closed.</exception>
         public override void Write(byte[] buffer, int offset, int count)
         {
-            ThrowHelper.ThrowIfNull(buffer);
-
-#if NET
-            ArgumentOutOfRangeException.ThrowIfNegative(offset);
-            ArgumentOutOfRangeException.ThrowIfNegative(count);
-#else
-            if (offset < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(offset));
-            }
-
-            if (count < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(count));
-            }
+#if !NET
+            ThrowHelper.
 #endif
-            if ((buffer.Length - offset) < count)
-            {
-                throw new ArgumentException("Invalid array range.");
-            }
+            ValidateBufferArguments(buffer, offset, count);
 
             // Lock down the file stream while we do this.
             lock (_lock)
@@ -1105,26 +1052,12 @@ public override void Write(byte[] buffer, int offset, int count)
         /// <exception cref="ObjectDisposedException">Methods were called after the stream was closed.</exception>
         public override async Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
         {
-            ThrowHelper.ThrowIfNull(buffer);
-
-#if NET
-            ArgumentOutOfRangeException.ThrowIfNegative(offset);
-            ArgumentOutOfRangeException.ThrowIfNegative(count);
-#else
-            if (offset < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(offset));
-            }
-
-            if (count < 0)
-            {
-                throw new ArgumentOutOfRangeException(nameof(count));
-            }
+#if !NET
+            ThrowHelper.
 #endif
-            if ((buffer.Length - offset) < count)
-            {
-                throw new ArgumentException("Invalid array range.");
-            }
+            ValidateBufferArguments(buffer, offset, count);
+
+            cancellationToken.ThrowIfCancellationRequested();
 
             CheckSessionIsOpen();
 

src/Renci.SshNet/ShellStream.cs

@@ -789,6 +789,11 @@ public string Read()
         /// <inheritdoc/>
         public override int Read(byte[] buffer, int offset, int count)
         {
+#if !NET
+            ThrowHelper.
+#endif
+            ValidateBufferArguments(buffer, offset, count);
+
             lock (_sync)
             {
                 while (_readHead == _readTail && !_disposed)
@@ -835,6 +840,11 @@ public void Write(string? text)
         /// <inheritdoc/>
         public override void Write(byte[] buffer, int offset, int count)
         {
+#if !NET
+            ThrowHelper.
+#endif
+            ValidateBufferArguments(buffer, offset, count);
+
             ThrowHelper.ThrowObjectDisposedIf(_disposed, this);
 
             while (count > 0)

test/Renci.SshNet.IntegrationTests/OldIntegrationTests/SftpClientTest.Upload.cs

@@ -77,6 +77,11 @@ public void Test_Sftp_Upload_Forbidden()
         [TestCategory("Sftp")]
         public void Test_Sftp_Multiple_Async_Upload_And_Download_10Files_5MB_Each()
         {
+            if (Environment.GetEnvironmentVariable("CI") == "true")
+            {
+                Assert.Inconclusive("Skipping because of failures in CI, see #1253");
+            }
+
             var maxFiles = 10;
             var maxSize = 5;