Merge branch 'develop' into readallbytes

Author: Rob-Hague

.editorconfig

@@ -719,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
 #

src/Renci.SshNet/.editorconfig

@@ -194,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/Common/Extensions.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Globalization;
 #if !NET
 using System.IO;
@@ -9,7 +8,6 @@
 using System.Net.Sockets;
 using System.Numerics;
 using System.Runtime.CompilerServices;
-using System.Text;
 using System.Threading;
 
 using Renci.SshNet.Abstractions;
@@ -156,22 +154,6 @@ public static void SetIgnoringObjectDisposed(this EventWaitHandle waitHandle)
             }
         }
 
-        /// <summary>
-        /// Prints out the specified bytes.
-        /// </summary>
-        /// <param name="bytes">The bytes.</param>
-        internal static void DebugPrint(this IEnumerable<byte> bytes)
-        {
-            var sb = new StringBuilder();
-
-            foreach (var b in bytes)
-            {
-                _ = sb.AppendFormat(CultureInfo.CurrentCulture, "0x{0:x2}, ", b);
-            }
-
-            Debug.WriteLine(sb.ToString());
-        }
-
         internal static void ValidatePort(this uint value, [CallerArgumentExpression(nameof(value))] string argument = null)
         {
             if (value > IPEndPoint.MaxPort)

src/Renci.SshNet/ConnectionInfo.cs

@@ -7,6 +7,8 @@
 
 using Microsoft.Extensions.Logging;
 
+using Org.BouncyCastle.Crypto.Agreement;
+
 using Renci.SshNet.Common;
 using Renci.SshNet.Compression;
 using Renci.SshNet.Messages.Authentication;
@@ -357,12 +359,13 @@ public ConnectionInfo(string host, int port, string username, ProxyTypes proxyTy
                     { "ecdh-sha2-nistp256", () => new KeyExchangeECDH256() },
                     { "ecdh-sha2-nistp384", () => new KeyExchangeECDH384() },
                     { "ecdh-sha2-nistp521", () => new KeyExchangeECDH521() },
-                    { "diffie-hellman-group-exchange-sha256", () => new KeyExchangeDiffieHellmanGroupExchangeSha256() },
-                    { "diffie-hellman-group-exchange-sha1", () => new KeyExchangeDiffieHellmanGroupExchangeSha1() },
-                    { "diffie-hellman-group16-sha512", () => new KeyExchangeDiffieHellmanGroup16Sha512() },
-                    { "diffie-hellman-group14-sha256", () => new KeyExchangeDiffieHellmanGroup14Sha256() },
-                    { "diffie-hellman-group14-sha1", () => new KeyExchangeDiffieHellmanGroup14Sha1() },
-                    { "diffie-hellman-group1-sha1", () => new KeyExchangeDiffieHellmanGroup1Sha1() },
+                    { "diffie-hellman-group-exchange-sha256", () => new KeyExchangeDiffieHellmanGroupExchange("diffie-hellman-group-exchange-sha256", HashAlgorithmName.SHA256) },
+                    { "diffie-hellman-group16-sha512", () => new KeyExchangeDiffieHellman("diffie-hellman-group16-sha512", DHStandardGroups.rfc3526_4096, HashAlgorithmName.SHA512) },
+                    { "diffie-hellman-group18-sha512", () => new KeyExchangeDiffieHellman("diffie-hellman-group18-sha512", DHStandardGroups.rfc3526_8192, HashAlgorithmName.SHA512) },
+                    { "diffie-hellman-group14-sha256", () => new KeyExchangeDiffieHellman("diffie-hellman-group14-sha256", DHStandardGroups.rfc3526_2048, HashAlgorithmName.SHA256) },
+                    { "diffie-hellman-group-exchange-sha1", () => new KeyExchangeDiffieHellmanGroupExchange("diffie-hellman-group-exchange-sha1", HashAlgorithmName.SHA1) },
+                    { "diffie-hellman-group14-sha1", () => new KeyExchangeDiffieHellman("diffie-hellman-group14-sha1", DHStandardGroups.rfc3526_2048, HashAlgorithmName.SHA1) },
+                    { "diffie-hellman-group1-sha1", () => new KeyExchangeDiffieHellman("diffie-hellman-group1-sha1", DHStandardGroups.rfc2409_1024, HashAlgorithmName.SHA1) },
                 };
 
             Encryptions = new OrderedDictionary<string, CipherInfo>

src/Renci.SshNet/ISubsystemSession.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading;
+using System.Threading.Tasks;
 
 using Microsoft.Extensions.Logging;
 
@@ -49,66 +50,45 @@ internal interface ISubsystemSession : IDisposable
         void Disconnect();
 
         /// <summary>
-        /// Waits a specified time for a given <see cref="WaitHandle"/> to get signaled.
+        /// Waits a specified time for a given <see cref="WaitHandle"/> to be signaled.
         /// </summary>
         /// <param name="waitHandle">The handle to wait for.</param>
-        /// <param name="millisecondsTimeout">The number of milliseconds wait for <paramref name="waitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
+        /// <param name="millisecondsTimeout">The number of milliseconds to wait for <paramref name="waitHandle"/> to be signaled, or <c>-1</c> to wait indefinitely.</param>
         /// <exception cref="SshException">The connection was closed by the server.</exception>
         /// <exception cref="SshException">The channel was closed.</exception>
         /// <exception cref="SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
         void WaitOnHandle(WaitHandle waitHandle, int millisecondsTimeout);
 
         /// <summary>
-        /// Blocks the current thread until the specified <see cref="WaitHandle"/> gets signaled, using a
-        /// 32-bit signed integer to specify the time interval in milliseconds.
+        /// Asynchronously waits for a given <see cref="WaitHandle"/> to be signaled.
         /// </summary>
         /// <param name="waitHandle">The handle to wait for.</param>
-        /// <param name="millisecondsTimeout">To number of milliseconds to wait for <paramref name="waitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
-        /// <returns>
-        /// <see langword="true"/> if <paramref name="waitHandle"/> received a signal within the specified timeout;
-        /// otherwise, <see langword="false"/>.
-        /// </returns>
+        /// <param name="millisecondsTimeout">The number of milliseconds to wait for <paramref name="waitHandle"/> to be signaled, or <c>-1</c> to wait indefinitely.</param>
+        /// <param name="cancellationToken">The cancellation token to observe.</param>
         /// <exception cref="SshException">The connection was closed by the server.</exception>
         /// <exception cref="SshException">The channel was closed.</exception>
-        /// <remarks>
-        /// The blocking wait is also interrupted when either the established channel is closed, the current
-        /// session is disconnected or an unexpected <see cref="Exception"/> occurred while processing a channel
-        /// or session event.
-        /// </remarks>
-        bool WaitOne(WaitHandle waitHandle, int millisecondsTimeout);
+        /// <exception cref="SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
+        /// <returns>A <see cref="Task"/> representing the wait.</returns>
+        Task WaitOnHandleAsync(WaitHandle waitHandle, int millisecondsTimeout, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Blocks the current thread until the specified <see cref="WaitHandle"/> gets signaled, using a
-        /// 32-bit signed integer to specify the time interval in milliseconds.
+        /// Asynchronously waits for a given <see cref="TaskCompletionSource{T}"/> to complete.
         /// </summary>
-        /// <param name="waitHandleA">The first handle to wait for.</param>
-        /// <param name="waitHandleB">The second handle to wait for.</param>
-        /// <param name="millisecondsTimeout">To number of milliseconds to wait for a <see cref="WaitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
-        /// <returns>
-        /// <c>0</c> if <paramref name="waitHandleA"/> received a signal within the specified timeout and <c>1</c>
-        /// if <paramref name="waitHandleB"/> received a signal within the specified timeout, or <see cref="WaitHandle.WaitTimeout"/>
-        /// if no object satisfied the wait.
-        /// </returns>
+        /// <typeparam name="T">The type of the result which is being awaited.</typeparam>
+        /// <param name="tcs">The handle to wait for.</param>
+        /// <param name="millisecondsTimeout">The number of milliseconds to wait for <paramref name="tcs"/> to complete, or <c>-1</c> to wait indefinitely.</param>
+        /// <param name="cancellationToken">The cancellation token to observe.</param>
         /// <exception cref="SshException">The connection was closed by the server.</exception>
         /// <exception cref="SshException">The channel was closed.</exception>
-        /// <remarks>
-        /// <para>
-        /// The blocking wait is also interrupted when either the established channel is closed, the current
-        /// session is disconnected or an unexpected <see cref="Exception"/> occurred while processing a channel
-        /// or session event.
-        /// </para>
-        /// <para>
-        /// When both <paramref name="waitHandleA"/> and <paramref name="waitHandleB"/> are signaled during the call,
-        /// then <c>0</c> is returned.
-        /// </para>
-        /// </remarks>
-        int WaitAny(WaitHandle waitHandleA, WaitHandle waitHandleB, int millisecondsTimeout);
+        /// <exception cref="SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
+        /// <returns>A <see cref="Task"/> representing the wait.</returns>
+        Task<T> WaitOnHandleAsync<T>(TaskCompletionSource<T> tcs, int millisecondsTimeout, CancellationToken cancellationToken);
 
         /// <summary>
         /// Waits for any of the elements in the specified array to receive a signal, using a 32-bit signed
         /// integer to specify the time interval.
         /// </summary>
-        /// <param name="waitHandles">A <see cref="WaitHandle"/> array - constructed using <see cref="CreateWaitHandleArray(WaitHandle[])"/> - containing the objects to wait for.</param>
+        /// <param name="waitHandles">A <see cref="WaitHandle"/> array - constructed using <see cref="CreateWaitHandleArray"/> - containing the objects to wait for.</param>
         /// <param name="millisecondsTimeout">To number of milliseconds to wait for a <see cref="WaitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
         /// <returns>
         /// The array index of the first non-system object that satisfied the wait.
@@ -121,16 +101,6 @@ internal interface ISubsystemSession : IDisposable
         /// </remarks>
         int WaitAny(WaitHandle[] waitHandles, int millisecondsTimeout);
 
-        /// <summary>
-        /// Creates a <see cref="WaitHandle"/> array that is composed of system objects and the specified
-        /// elements.
-        /// </summary>
-        /// <param name="waitHandles">A <see cref="WaitHandle"/> array containing the objects to wait for.</param>
-        /// <returns>
-        /// A <see cref="WaitHandle"/> array that is composed of system objects and the specified elements.
-        /// </returns>
-        WaitHandle[] CreateWaitHandleArray(params WaitHandle[] waitHandles);
-
         /// <summary>
         /// Creates a <see cref="WaitHandle"/> array that is composed of system objects and the specified
         /// elements.

src/Renci.SshNet/Messages/Transport/KeyExchangeDhGroupExchangeGroup.cs

@@ -9,8 +9,8 @@ namespace Renci.SshNet.Messages.Transport
     /// </summary>
     public class KeyExchangeDhGroupExchangeGroup : Message
     {
-        private byte[] _safePrime;
-        private byte[] _subGroup;
+        internal byte[] SafePrimeBytes { get; private set; }
+        internal byte[] SubGroupBytes { get; private set; }
 
         /// <inheritdoc />
         public override string MessageName
@@ -38,7 +38,7 @@ public override byte MessageNumber
         /// </value>
         public BigInteger SafePrime
         {
-            get { return _safePrime.ToBigInteger(); }
+            get { return SafePrimeBytes.ToBigInteger(); }
         }
 
         /// <summary>
@@ -49,7 +49,7 @@ public BigInteger SafePrime
         /// </value>
         public BigInteger SubGroup
         {
-            get { return _subGroup.ToBigInteger(); }
+            get { return SubGroupBytes.ToBigInteger(); }
         }
 
         /// <summary>
@@ -64,9 +64,9 @@ protected override int BufferCapacity
             {
                 var capacity = base.BufferCapacity;
                 capacity += 4; // SafePrime length
-                capacity += _safePrime.Length; // SafePrime
+                capacity += SafePrimeBytes.Length; // SafePrime
                 capacity += 4; // SubGroup length
-                capacity += _subGroup.Length; // SubGroup
+                capacity += SubGroupBytes.Length; // SubGroup
 
                 return capacity;
             }
@@ -77,17 +77,17 @@ protected override int BufferCapacity
         /// </summary>
         protected override void LoadData()
         {
-            _safePrime = ReadBinary();
-            _subGroup = ReadBinary();
+            SafePrimeBytes = ReadBinary();
+            SubGroupBytes = ReadBinary();
         }
 
         /// <summary>
         /// Called when type specific data need to be saved.
         /// </summary>
         protected override void SaveData()
         {
-            WriteBinaryString(_safePrime);
-            WriteBinaryString(_subGroup);
+            WriteBinaryString(SafePrimeBytes);
+            WriteBinaryString(SubGroupBytes);
         }
 
         internal override void Process(Session session)

src/Renci.SshNet/Security/GroupExchangeHashData.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Numerics;
 
 using Renci.SshNet.Common;
 
@@ -9,8 +8,6 @@ internal sealed class GroupExchangeHashData : SshData
     {
         private byte[] _serverVersion;
         private byte[] _clientVersion;
-        private byte[] _prime;
-        private byte[] _subGroup;
 
         public string ServerVersion
         {
@@ -36,17 +33,9 @@ public string ClientVersion
 
         public uint MaximumGroupSize { get; set; }
 
-        public BigInteger Prime
-        {
-            private get { return _prime.ToBigInteger(); }
-            set { _prime = value.ToByteArray(isBigEndian: true); }
-        }
+        public byte[] Prime { get; set; }
 
-        public BigInteger SubGroup
-        {
-            private get { return _subGroup.ToBigInteger(); }
-            set { _subGroup = value.ToByteArray(isBigEndian: true); }
-        }
+        public byte[] SubGroup { get; set; }
 
         public byte[] ClientExchangeValue { get; set; }
 
@@ -79,9 +68,9 @@ protected override int BufferCapacity
                 capacity += 4; // PreferredGroupSize
                 capacity += 4; // MaximumGroupSize
                 capacity += 4; // Prime length
-                capacity += _prime.Length; // Prime
+                capacity += Prime.Length; // Prime
                 capacity += 4; // SubGroup length
-                capacity += _subGroup.Length; // SubGroup
+                capacity += SubGroup.Length; // SubGroup
                 capacity += 4; // ClientExchangeValue length
                 capacity += ClientExchangeValue.Length; // ClientExchangeValue
                 capacity += 4; // ServerExchangeValue length
@@ -107,8 +96,8 @@ protected override void SaveData()
             Write(MinimumGroupSize);
             Write(PreferredGroupSize);
             Write(MaximumGroupSize);
-            WriteBinaryString(_prime);
-            WriteBinaryString(_subGroup);
+            WriteBinaryString(Prime);
+            WriteBinaryString(SubGroup);
             WriteBinaryString(ClientExchangeValue);
             WriteBinaryString(ServerExchangeValue);
             WriteBinaryString(SharedKey);

src/Renci.SshNet/Security/KeyExchange.cs

@@ -482,7 +482,7 @@ protected bool CanTrustHostKey(KeyHostAlgorithm host)
         /// <summary>
         /// Validates the exchange hash.
         /// </summary>
-        /// <returns>true if exchange hash is valid; otherwise false.</returns>
+        /// <returns><see langword="true"/> if exchange hash is valid; otherwise <see langword="false"/>.</returns>
         protected abstract bool ValidateExchangeHash();
 
         private protected bool ValidateExchangeHash(byte[] encodedKey, byte[] encodedSignature)