Merge remote-tracking branch 'upstream/develop' into feature_AES_CSP

Author: Rob-Hague

.editorconfig

@@ -572,6 +572,13 @@ dotnet_diagnostic.CA5401.severity = none
 
 #### Roslyn IDE analyser rules ####
 
+# IDE0028: Simplify collection initialization; and
+# IDE0305: Simplify collection initialization
+#
+# Temporarily suppressing collection expression recommendations coming from .NET 8 SDK
+dotnet_diagnostic.IDE0028.severity = none
+dotnet_diagnostic.IDE0305.severity = none
+
 # IDE0032: Use auto-implemented property
 #
 # For performance reasons, we do not always want to enforce the use of

.gitattributes

@@ -15,3 +15,6 @@
 *.nupkg binary
 *.pdf binary
 *.snk binary
+
+# Ensure key files have LF endings for easier usage with ssh-keygen
+test/Data/* eol=lf

global.json

@@ -1,6 +1,6 @@
 {
   "sdk": {
     "version": "7.0.403",
-    "rollForward": "disable"
+    "rollForward": "latestMajor"
   }
 }

src/Renci.SshNet/Abstractions/DiagnosticAbstraction.cs

@@ -1,27 +1,65 @@
-using System.Diagnostics;
+using System.ComponentModel;
+using System.Diagnostics;
 
 namespace Renci.SshNet.Abstractions
 {
-    internal static class DiagnosticAbstraction
+    /// <summary>
+    /// Provides access to the <see cref="System.Diagnostics"/> internals of SSH.NET.
+    /// </summary>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public static class DiagnosticAbstraction
     {
-        private static readonly SourceSwitch SourceSwitch = new SourceSwitch("SshNetSwitch");
-
-        public static bool IsEnabled(TraceEventType traceEventType)
-        {
-            return SourceSwitch.ShouldTrace(traceEventType);
-        }
-
-        private static readonly TraceSource Loggging =
 #if DEBUG
-            new TraceSource("SshNet.Logging", SourceLevels.All);
-#else
-            new TraceSource("SshNet.Logging");
-#endif // DEBUG
+        /// <summary>
+        /// The <see cref="TraceSource"/> instance used by SSH.NET.
+        /// </summary>
+        /// <remarks>
+        /// <para>
+        /// Configuration on .NET Core must be done programmatically, e.g.
+        /// <code>
+        /// DiagnosticAbstraction.Source.Switch = new SourceSwitch("sourceSwitch", "Verbose");
+        /// DiagnosticAbstraction.Source.Listeners.Remove("Default");
+        /// DiagnosticAbstraction.Source.Listeners.Add(new ConsoleTraceListener());
+        /// DiagnosticAbstraction.Source.Listeners.Add(new TextWriterTraceListener("trace.log"));
+        /// </code>
+        /// </para>
+        /// <para>
+        /// On .NET Framework, it is possible to configure via App.config, e.g.
+        /// <code>
+        /// <![CDATA[
+        /// <configuration>
+        ///     <system.diagnostics>
+        ///         <trace autoflush="true"/>
+        ///         <sources>
+        ///             <source name="SshNet.Logging" switchValue="Verbose">
+        ///                 <listeners>
+        ///                     <remove name="Default" />
+        ///                     <add name="console"
+        ///                          type="System.Diagnostics.ConsoleTraceListener" />
+        ///                     <add name="logFile"
+        ///                          type="System.Diagnostics.TextWriterTraceListener"
+        ///                          initializeData="SshNetTrace.log" />
+        ///                 </listeners>
+        ///             </source>
+        ///         </sources>
+        ///     </system.diagnostics>
+        /// </configuration>
+        /// ]]>
+        /// </code>
+        /// </para>
+        /// </remarks>
+        public static readonly TraceSource Source = new TraceSource("SshNet.Logging");
+#endif
 
+        /// <summary>
+        /// Logs a message to <see cref="Source"/> at the <see cref="TraceEventType.Verbose"/>
+        /// level.
+        /// </summary>
+        /// <param name="text">The message to log.</param>
         [Conditional("DEBUG")]
         public static void Log(string text)
         {
-            Loggging.TraceEvent(TraceEventType.Verbose,
+            Source.TraceEvent(TraceEventType.Verbose,
                                 System.Environment.CurrentManagedThreadId,
                                 text);
         }

src/Renci.SshNet/Connection/ConnectorBase.cs

@@ -49,7 +49,7 @@ protected Socket SocketConnect(string host, int port, TimeSpan timeout)
             {
                 SocketAbstraction.Connect(socket, ep, timeout);
 
-                const int socketBufferSize = 2 * Session.MaximumSshPacketSize;
+                const int socketBufferSize = 10 * Session.MaximumSshPacketSize;
                 socket.SendBufferSize = socketBufferSize;
                 socket.ReceiveBufferSize = socketBufferSize;
                 return socket;

src/Renci.SshNet/Messages/Authentication/FailureMessage.cs

@@ -60,5 +60,13 @@ internal override void Process(Session session)
         {
             session.OnUserAuthenticationFailureReceived(this);
         }
+
+        /// <inheritdoc/>
+        public override string ToString()
+        {
+#pragma warning disable MA0089 // Optimize string method usage
+            return $"SSH_MSG_USERAUTH_FAILURE {string.Join(",", AllowedAuthentications)} ({nameof(PartialSuccess)}:{PartialSuccess})";
+#pragma warning restore MA0089 // Optimize string method usage
+        }
     }
 }

src/Renci.SshNet/Messages/Authentication/PublicKeyMessage.cs

@@ -60,5 +60,11 @@ protected override void SaveData()
             WriteBinaryString(PublicKeyAlgorithmName);
             WriteBinaryString(PublicKeyData);
         }
+
+        /// <inheritdoc/>
+        public override string ToString()
+        {
+            return $"SSH_MSG_USERAUTH_PK_OK ({Ascii.GetString(PublicKeyAlgorithmName)})";
+        }
     }
 }

src/Renci.SshNet/Messages/Authentication/RequestMessage.cs

@@ -106,5 +106,11 @@ internal override void Process(Session session)
         {
             throw new NotImplementedException();
         }
+
+        /// <inheritdoc/>
+        public override string ToString()
+        {
+            return $"SSH_MSG_USERAUTH_REQUEST ({MethodName})";
+        }
     }
 }

src/Renci.SshNet/Messages/Authentication/RequestMessagePublicKey.cs

@@ -96,5 +96,11 @@ protected override void SaveData()
                 WriteBinaryString(Signature);
             }
         }
+
+        /// <inheritdoc/>
+        public override string ToString()
+        {
+            return $"{base.ToString()} {Ascii.GetString(PublicKeyAlgorithmName)} {(Signature != null ? "with" : "without")} signature.";
+        }
     }
 }

src/Renci.SshNet/Renci.SshNet.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(TargetFramework)' == 'net462' ">
-    <DefineConstants>FEATURE_BINARY_SERIALIZATION;FEATURE_SOCKET_EAP;FEATURE_SOCKET_APM;FEATURE_DNS_SYNC;FEATURE_HASH_RIPEMD160_CREATE;FEATURE_HMAC_RIPEMD160</DefineConstants>
+    <DefineConstants>$(DefineConstants);FEATURE_BINARY_SERIALIZATION;FEATURE_SOCKET_EAP;FEATURE_SOCKET_APM;FEATURE_DNS_SYNC;FEATURE_HASH_RIPEMD160_CREATE;FEATURE_HMAC_RIPEMD160</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' or '$(TargetFramework)' == 'netstandard2.1' or '$(TargetFramework)' == 'net6.0' or '$(TargetFramework)' == 'net7.0' ">
@@ -18,6 +18,6 @@
   </ItemGroup>
 
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' or '$(TargetFramework)' == 'netstandard2.1' or '$(TargetFramework)' == 'net6.0' or '$(TargetFramework)' == 'net7.0' ">
-    <DefineConstants>FEATURE_SOCKET_TAP;FEATURE_SOCKET_APM;FEATURE_SOCKET_EAP;FEATURE_DNS_SYNC;FEATURE_DNS_APM;FEATURE_DNS_TAP</DefineConstants>
+    <DefineConstants>$(DefineConstants);FEATURE_SOCKET_TAP;FEATURE_SOCKET_APM;FEATURE_SOCKET_EAP;FEATURE_DNS_SYNC;FEATURE_DNS_APM;FEATURE_DNS_TAP</DefineConstants>
   </PropertyGroup>
 </Project>