Merge branch 'develop' into logging

Author: mus65

.editorconfig

@@ -195,6 +195,9 @@ dotnet_diagnostic.S2971.severity = none
 # This is rather harmless.
 dotnet_diagnostic.S3218.severity = none
 
+# S3236: Remove this argument from the method call; it hides the caller information.
+dotnet_diagnostic.S3236.severity = none
+
 # S3267: Loops should be simplified with "LINQ" expressions
 # https://rules.sonarsource.com/csharp/RSPEC-3267
 #

.github/workflows/build.yml

@@ -17,39 +17,39 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 8.0.x
+        dotnet-version: 9.0.x
 
     - name: Build Unit Tests .NET
-      run: dotnet build -f net8.0 test/Renci.SshNet.Tests/
+      run: dotnet build -f net9.0 test/Renci.SshNet.Tests/
 
     - name: Build IntegrationTests .NET
-      run: dotnet build -f net8.0 test/Renci.SshNet.IntegrationTests/
+      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 \
-          -f net8.0 \
+          -f net9.0 \
           --no-build \
           --logger "console;verbosity=normal" \
           --logger GitHubActions \
           -p:CollectCoverage=true \
           -p:CoverletOutputFormat=cobertura \
-          -p:CoverletOutput=../../coverlet/linux_unit_test_net_8_coverage.xml \
+          -p:CoverletOutput=../../coverlet/linux_unit_test_net_9_coverage.xml \
           test/Renci.SshNet.Tests/
 
     - name: Run Integration Tests .NET
       run: |
         dotnet test \
-          -f net8.0 \
+          -f net9.0 \
           --no-build \
           --logger "console;verbosity=normal" \
           --logger GitHubActions \
           -p:CollectCoverage=true \
           -p:CoverletOutputFormat=cobertura \
-          -p:CoverletOutput=../../coverlet/linux_integration_test_net_8_coverage.xml \
+          -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
@@ -111,13 +111,13 @@ jobs:
     - name: Run Unit Tests .NET
       run: |
         dotnet test `
-          -f net8.0 `
+          -f net9.0 `
           --no-build `
           --logger "console;verbosity=normal" `
           --logger GitHubActions `
           -p:CollectCoverage=true `
           -p:CoverletOutputFormat=cobertura `
-          -p:CoverletOutput=../../coverlet/windows_unit_test_net_8_coverage.xml `
+          -p:CoverletOutput=../../coverlet/windows_unit_test_net_9_coverage.xml `
           test/Renci.SshNet.Tests/
 
     - name: Run Unit Tests .NET Framework

global.json

@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "8.0.100",
+    "version": "9.0.100",
     "rollForward": "latestMajor"
   }
 }

src/Renci.SshNet/Channels/Channel.cs

@@ -15,8 +15,8 @@ namespace Renci.SshNet.Channels
     /// </summary>
     internal abstract class Channel : IChannel
     {
-        private readonly object _serverWindowSizeLock = new object();
-        private readonly object _messagingLock = new object();
+        private readonly Lock _serverWindowSizeLock = new Lock();
+        private readonly Lock _messagingLock = new Lock();
         private readonly uint _initialWindowSize;
         private readonly ISession _session;
         private readonly ILogger _logger;

src/Renci.SshNet/Channels/ChannelDirectTcpip.cs

@@ -16,9 +16,8 @@ namespace Renci.SshNet.Channels
     /// </summary>
     internal sealed class ChannelDirectTcpip : ClientChannel, IChannelDirectTcpip
     {
-        private readonly object _socketLock = new object();
+        private readonly Lock _socketLock = new Lock();
         private readonly ILogger _logger;
-
         private EventWaitHandle _channelOpen = new AutoResetEvent(initialState: false);
         private EventWaitHandle _channelData = new AutoResetEvent(initialState: false);
         private IForwardedPort _forwardedPort;

src/Renci.SshNet/Channels/ChannelForwardedTcpip.cs

@@ -1,6 +1,9 @@
 using System;
 using System.Net;
 using System.Net.Sockets;
+#if NET9_0_OR_GREATER
+using System.Threading;
+#endif
 
 using Microsoft.Extensions.Logging;
 
@@ -15,7 +18,7 @@ namespace Renci.SshNet.Channels
     /// </summary>
     internal sealed class ChannelForwardedTcpip : ServerChannel, IChannelForwardedTcpip
     {
-        private readonly object _socketShutdownAndCloseLock = new object();
+        private readonly Lock _socketShutdownAndCloseLock = new Lock();
         private readonly ILogger _logger;
         private Socket _socket;
         private IForwardedPort _forwardedPort;

src/Renci.SshNet/Common/Lock.cs

@@ -0,0 +1,19 @@
+#if !NET9_0_OR_GREATER
+using System.Threading;
+
+namespace Renci.SshNet.Common
+{
+    internal sealed class Lock
+    {
+        public bool TryEnter()
+        {
+            return Monitor.TryEnter(this);
+        }
+
+        public void Exit()
+        {
+            Monitor.Exit(this);
+        }
+    }
+}
+#endif

src/Renci.SshNet/Renci.SshNet.csproj

@@ -4,7 +4,7 @@
     <AssemblyName>Renci.SshNet</AssemblyName>
     <Product>SSH.NET</Product>
     <AssemblyTitle>SSH.NET</AssemblyTitle>
-    <TargetFrameworks>net462;netstandard2.0;netstandard2.1;net6.0;net7.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net462;netstandard2.0;netstandard2.1;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
   </PropertyGroup>
 
   <PropertyGroup>

src/Renci.SshNet/Session.cs

@@ -85,7 +85,7 @@ public class Session : ISession
         /// Holds an object that is used to ensure only a single thread can read from
         /// <see cref="_socket"/> at any given time.
         /// </summary>
-        private readonly object _socketReadLock = new object();
+        private readonly Lock _socketReadLock = new Lock();
 
         /// <summary>
         /// Holds an object that is used to ensure only a single thread can write to
@@ -95,7 +95,7 @@ public class Session : ISession
         /// This is also used to ensure that <see cref="_outboundPacketSequence"/> is
         /// incremented atomatically.
         /// </remarks>
-        private readonly object _socketWriteLock = new object();
+        private readonly Lock _socketWriteLock = new Lock();
 
         /// <summary>
         /// Holds an object that is used to ensure only a single thread can dispose
@@ -1911,7 +1911,7 @@ private bool IsSocketConnected()
                     return false;
                 }
 
-                if (!Monitor.TryEnter(_socketReadLock))
+                if (!_socketReadLock.TryEnter())
                 {
                     return true;
                 }
@@ -1923,7 +1923,7 @@ private bool IsSocketConnected()
                 }
                 finally
                 {
-                    Monitor.Exit(_socketReadLock);
+                    _socketReadLock.Exit();
                 }
             }
             finally

src/Renci.SshNet/Sftp/SftpFileStream.cs

@@ -18,7 +18,7 @@ namespace Renci.SshNet.Sftp
 #pragma warning restore IDE0079
     public class SftpFileStream : Stream
     {
-        private readonly object _lock = new object();
+        private readonly Lock _lock = new Lock();
         private readonly int _readBufferSize;
         private readonly int _writeBufferSize;