Merge branch 'develop' into bcl-ciphermode

Author: scott-xu

.editorconfig

@@ -1,4 +1,4 @@
-// Avoid looking for .editorconfig files in parent directories
+# Avoid looking for .editorconfig files in parent directories
 root=true
 
 [*]
@@ -7,6 +7,9 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 tab_width = 4
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = exclusion.dic
+spelling_checkable_types = all
 
 [*.{xml,csproj,props}]
 
@@ -716,7 +719,7 @@ dotnet_code_quality.CA1828.api_surface = all
 dotnet_diagnostic.CA1852.severity = none
 
 # CA1848: don't enforce LoggerMessage pattern
-dotnet_diagnostic.CA1848.severity = suggestion
+dotnet_diagnostic.CA1848.severity = silent
 
 # CA1859: Change return type for improved performance
 #
@@ -776,14 +779,14 @@ dotnet_diagnostic.IDE0032.severity = suggestion
 dotnet_diagnostic.IDE0045.severity = none
 
 # IDE0046: Use conditional expression for return
-# 
+#
 # Using a conditional expression is not always a clear win for readability.
 #
 # Configured using 'dotnet_style_prefer_conditional_expression_over_return'
 dotnet_diagnostic.IDE0046.severity = suggestion
 
 # IDE0047: Remove unnecessary parentheses
-# 
+#
 # Removing "unnecessary" parentheses is not always a clear win for readability.
 dotnet_diagnostic.IDE0047.severity = suggestion
 
@@ -794,7 +797,7 @@ dotnet_diagnostic.IDE0047.severity = suggestion
 dotnet_diagnostic.IDE0130.severity = none
 
 # IDE0270: Null check can be simplified
-# 
+#
 # var inputPath = originalDossierPathList.Find(x => x.id == updatedPath.id);
 # if (inputPath is null)
 # {
@@ -938,7 +941,7 @@ csharp_new_line_before_catch = true
 csharp_new_line_before_finally = true
 # Enabling this setting breaks Resharper formatting for an enum field reference that is
 # deeply nested in an object initializer.
-# 
+#
 # For an example, see TDataExchangeGeneralEnricher_CernInfrastructureObstruction.
 #csharp_new_line_before_members_in_object_initializers = true
 csharp_new_line_before_members_in_anonymous_types = true
@@ -1021,19 +1024,19 @@ dotnet_naming_rule.private_const_fields_pascal_case.severity = warning
 
 dotnet_naming_symbols.interface.applicable_kinds = interface
 dotnet_naming_symbols.interface.applicable_accessibilities = *
-dotnet_naming_symbols.interface.required_modifiers = 
+dotnet_naming_symbols.interface.required_modifiers =
 
 dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
 dotnet_naming_symbols.types.applicable_accessibilities = *
-dotnet_naming_symbols.types.required_modifiers = 
+dotnet_naming_symbols.types.required_modifiers =
 
 dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
 dotnet_naming_symbols.non_field_members.applicable_accessibilities = *
-dotnet_naming_symbols.non_field_members.required_modifiers = 
+dotnet_naming_symbols.non_field_members.required_modifiers =
 
 dotnet_naming_symbols.private_fields.applicable_kinds = field
 dotnet_naming_symbols.private_fields.applicable_accessibilities = private
-dotnet_naming_symbols.private_fields.required_modifiers = 
+dotnet_naming_symbols.private_fields.required_modifiers =
 
 dotnet_naming_symbols.private_static_fields.applicable_kinds = field
 dotnet_naming_symbols.private_static_fields.applicable_accessibilities = private
@@ -1050,18 +1053,18 @@ dotnet_naming_symbols.private_const_fields.required_modifiers = const
 # Naming styles
 
 dotnet_naming_style.begins_with_i.required_prefix = I
-dotnet_naming_style.begins_with_i.required_suffix = 
-dotnet_naming_style.begins_with_i.word_separator = 
+dotnet_naming_style.begins_with_i.required_suffix =
+dotnet_naming_style.begins_with_i.word_separator =
 dotnet_naming_style.begins_with_i.capitalization = pascal_case
 
-dotnet_naming_style.pascal_case.required_prefix = 
-dotnet_naming_style.pascal_case.required_suffix = 
-dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.required_prefix =
+dotnet_naming_style.pascal_case.required_suffix =
+dotnet_naming_style.pascal_case.word_separator =
 dotnet_naming_style.pascal_case.capitalization = pascal_case
 
 dotnet_naming_style.camel_case_begins_with_underscore.required_prefix = _
-dotnet_naming_style.camel_case_begins_with_underscore.required_suffix = 
-dotnet_naming_style.camel_case_begins_with_underscore.word_separator = 
+dotnet_naming_style.camel_case_begins_with_underscore.required_suffix =
+dotnet_naming_style.camel_case_begins_with_underscore.word_separator =
 dotnet_naming_style.camel_case_begins_with_underscore.capitalization = camel_case
 
 #### .NET Compiler Platform general options ####

.github/workflows/build.yml

@@ -116,7 +116,7 @@ jobs:
       uses: actions/setup-dotnet@v4
 
     - name: Setup WSL2
-      uses: Vampire/setup-wsl@3b46b44374d5d0ae94654c45d114a3ed7a0e07a8 # v5.0.1
+      uses: Vampire/setup-wsl@6a8db447be7ed35f2f499c02c6e60ff77ef11278 # v6.0.0
       with:
         distribution: Ubuntu-24.04
 

Directory.Packages.props

@@ -4,25 +4,23 @@
     <CentralPackageVersionOverrideEnabled>false</CentralPackageVersionOverrideEnabled>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="BenchmarkDotNet" Version="0.15.0" />
-    <PackageVersion Include="BouncyCastle.Cryptography" Version="2.6.1" />
+    <PackageVersion Include="BenchmarkDotNet" Version="0.15.2" />
+    <PackageVersion Include="BouncyCastle.Cryptography" Version="2.6.2" />
     <PackageVersion Include="coverlet.collector" Version="6.0.4" />
     <PackageVersion Include="coverlet.msbuild" Version="6.0.4" />
     <PackageVersion Include="GitHubActionsTestLogger" Version="2.4.1" />
-    <PackageVersion Include="Meziantou.Analyzer" Version="2.0.201" />
-    
+    <PackageVersion Include="Meziantou.Analyzer" Version="2.0.210" />
     <!-- Should stay on LTS .NET releases. -->
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.3" />
-    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.5" />
-    <PackageVersion Include="MSTest" Version="3.9.1" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.7" />
+    <PackageVersion Include="MSTest" Version="3.10.0" />
     <PackageVersion Include="Moq" Version="4.20.72" />
     <PackageVersion Include="Nerdbank.GitVersioning" Version="3.7.115" />
     <PackageVersion Include="PolySharp" Version="1.15.0" />
-    <PackageVersion Include="SonarAnalyzer.CSharp" Version="10.10.0.116381" />
+    <PackageVersion Include="SonarAnalyzer.CSharp" Version="10.15.0.120848" />
     <PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />
-    
     <!-- Should stay on LTS .NET releases. -->
     <PackageVersion Include="System.Formats.Asn1" Version="8.0.2" />
-    <PackageVersion Include="Testcontainers" Version="4.5.0" />
+    <PackageVersion Include="Testcontainers" Version="4.6.0" />
   </ItemGroup>
-</Project>
+</Project>

Renci.SshNet.sln

@@ -14,6 +14,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		CONTRIBUTING.md = CONTRIBUTING.md
 		Directory.Build.props = Directory.Build.props
 		Directory.Packages.props = Directory.Packages.props
+		exclusion.dic = exclusion.dic
 		global.json = global.json
 		LICENSE = LICENSE
 		nuget.config = nuget.config

docfx/logging.md

@@ -1,7 +1,31 @@
 Logging
 =================
 
-SSH.NET uses the [Microsoft.Extensions.Logging](https://learn.microsoft.com/dotnet/core/extensions/logging) API to log diagnostic messages. In order to access the log messages of SSH.NET in your own application for diagnosis, register your own `ILoggerFactory` before using the SSH.NET APIs, for example:
+SSH.NET uses the [Microsoft.Extensions.Logging](https://learn.microsoft.com/dotnet/core/extensions/logging) API to log diagnostic messages. 
+
+It is possible to specify a logger in the `ConnectionInfo`, for example:
+
+```cs
+using Microsoft.Extensions.Logging;
+
+ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
+{
+    builder.SetMinimumLevel(LogLevel.Debug);
+    builder.AddConsole();
+});
+
+var connectionInfo = new ConnectionInfo("sftp.foo.com",
+                                        "guest",
+                                        new PasswordAuthenticationMethod("guest", "pwd"));
+										
+connectionInfo.LoggerFactory = loggerFactory;
+using (var client = new SftpClient(connectionInfo))
+{
+    client.Connect();
+}
+```
+
+You can also register an application-wide `ILoggerFactory` before using the SSH.NET APIs, this will be used as a fallback if the `ConnectionInfo` is not set, for example:
 
 ```cs
 using Microsoft.Extensions.Logging;

exclusion.dic

@@ -0,0 +1,53 @@
+args
+atime
+bcrypt
+bigint
+bourne
+cbc
+chacha
+csproj
+decryptor
+dest
+diffie
+docfx
+ecdh
+ecdsa
+emerle
+exe
+fallback
+github
+hmac
+hostbased
+identd
+ietf
+impl
+infocmp
+kewl
+kex
+mindrot
+mtime
+netconf
+nist
+nistp
+openssh
+pkcs
+posix
+privatekey
+protoversion
+pubkey
+publickey
+renci
+ripemd
+slen
+sntrup
+softwareversion
+sshd
+tcpip
+threadpool
+umac
+unpad
+unix
+waithandle
+xoff
+xmldoc
+zlib

src/Renci.SshNet/.editorconfig

@@ -1,4 +1,7 @@
 [*.cs]
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = ../exclusion.dic
+spelling_checkable_types = all
 
 #### Sonar rules ####
 
@@ -191,3 +194,6 @@ dotnet_diagnostic.MA0042.severity = none
 
 # S3236: Caller information arguments should not be provided explicitly
 dotnet_diagnostic.S3236.severity = none
+
+# S3358: Ternary operators should not be nested
+dotnet_diagnostic.S3358.severity = none

src/Renci.SshNet/Abstractions/SocketAbstraction.cs

@@ -350,7 +350,7 @@ public static void Send(Socket socket, byte[] data, int offset, int size)
                     }
                     else
                     {
-                        throw; // any serious error occurr
+                        throw; // any serious error occur
                     }
                 }
             }

src/Renci.SshNet/BaseClient.cs

@@ -192,7 +192,7 @@ private protected BaseClient(ConnectionInfo connectionInfo, bool ownsConnectionI
             _connectionInfo = connectionInfo;
             _ownsConnectionInfo = ownsConnectionInfo;
             _serviceFactory = serviceFactory;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
+            _logger = (connectionInfo.LoggerFactory ?? SshNetLoggingConfiguration.LoggerFactory).CreateLogger(GetType());
             _keepAliveInterval = Timeout.InfiniteTimeSpan;
         }
 
@@ -408,7 +408,7 @@ protected virtual void OnDisconnected()
         {
         }
 
-        private void Session_ErrorOccured(object? sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object? sender, ExceptionEventArgs e)
         {
             ErrorOccurred?.Invoke(this, e);
         }
@@ -558,7 +558,7 @@ private ISession CreateAndConnectSession()
             var session = _serviceFactory.CreateSession(ConnectionInfo, _serviceFactory.CreateSocketFactory());
             session.ServerIdentificationReceived += Session_ServerIdentificationReceived;
             session.HostKeyReceived += Session_HostKeyReceived;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
 
             try
             {
@@ -577,7 +577,7 @@ private async Task<ISession> CreateAndConnectSessionAsync(CancellationToken canc
             var session = _serviceFactory.CreateSession(ConnectionInfo, _serviceFactory.CreateSocketFactory());
             session.ServerIdentificationReceived += Session_ServerIdentificationReceived;
             session.HostKeyReceived += Session_HostKeyReceived;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
 
             try
             {
@@ -593,7 +593,7 @@ private async Task<ISession> CreateAndConnectSessionAsync(CancellationToken canc
 
         private void DisposeSession(ISession session)
         {
-            session.ErrorOccured -= Session_ErrorOccured;
+            session.ErrorOccured -= Session_ErrorOccurred;
             session.HostKeyReceived -= Session_HostKeyReceived;
             session.ServerIdentificationReceived -= Session_ServerIdentificationReceived;
             session.Dispose();

src/Renci.SshNet/Channels/Channel.cs

@@ -84,7 +84,7 @@ protected Channel(ISession session, uint localChannelNumber, uint localWindowSiz
             LocalChannelNumber = localChannelNumber;
             LocalPacketSize = localPacketSize;
             LocalWindowSize = localWindowSize;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
+            _logger = session.SessionLoggerFactory.CreateLogger(GetType());
 
             session.ChannelWindowAdjustReceived += OnChannelWindowAdjust;
             session.ChannelDataReceived += OnChannelData;
@@ -94,15 +94,15 @@ protected Channel(ISession session, uint localChannelNumber, uint localWindowSiz
             session.ChannelRequestReceived += OnChannelRequest;
             session.ChannelSuccessReceived += OnChannelSuccess;
             session.ChannelFailureReceived += OnChannelFailure;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
             session.Disconnected += Session_Disconnected;
         }
 
         /// <summary>
         /// Gets the session.
         /// </summary>
         /// <value>
-        ///  Thhe session.
+        ///  The session.
         /// </value>
         protected ISession Session
         {
@@ -328,7 +328,7 @@ public void SendData(byte[] data)
         /// multiple chunks and will wait for the remote window size to be adjusted when it's zero.
         /// </para>
         /// <para>
-        /// This is done to support SSH servers will a small window size that do not agressively
+        /// This is done to support SSH servers will a small window size that do not aggressively
         /// increase their window size. We need to take into account that there may be SSH servers
         /// that only increase their window size when it has reached zero.
         /// </para>
@@ -586,7 +586,7 @@ protected virtual void OnDisconnected()
         {
         }
 
-        protected virtual void OnErrorOccured(Exception exp)
+        protected virtual void OnErrorOccurred(Exception exp)
         {
         }
 
@@ -609,20 +609,20 @@ private void Session_Disconnected(object sender, EventArgs e)
         /// </summary>
         /// <param name="ex">The <see cref="Exception"/>.</param>
         /// <remarks>
-        /// This method will in turn invoke <see cref="OnErrorOccured(System.Exception)"/>, and
+        /// This method will in turn invoke <see cref="OnErrorOccurred(System.Exception)"/>, and
         /// raise the <see cref="Exception"/> event.
         /// </remarks>
         protected void OnChannelException(Exception ex)
         {
-            OnErrorOccured(ex);
+            OnErrorOccurred(ex);
             RaiseExceptionEvent(ex);
         }
 
-        private void Session_ErrorOccured(object sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             try
             {
-                OnErrorOccured(e.Exception);
+                OnErrorOccurred(e.Exception);
             }
             catch (Exception ex)
             {
@@ -854,7 +854,7 @@ protected virtual void Dispose(bool disposing)
                     session.ChannelRequestReceived -= OnChannelRequest;
                     session.ChannelSuccessReceived -= OnChannelSuccess;
                     session.ChannelFailureReceived -= OnChannelFailure;
-                    session.ErrorOccured -= Session_ErrorOccured;
+                    session.ErrorOccured -= Session_ErrorOccurred;
                     session.Disconnected -= Session_Disconnected;
                 }