Merge branch 'develop' into net7

# Conflicts:
#	src/Renci.SshNet/BaseClient.cs
#	src/Renci.SshNet/Common/ThrowHelper.cs
#	src/Renci.SshNet/SubsystemSession.cs

Author: Rob-Hague

.editorconfig

@@ -29,6 +29,12 @@ dotnet_diagnostic.S101.severity = none
 # This is a duplicate of CA2201 and MA0012.
 dotnet_diagnostic.S112.severity = none
 
+# S127: "for" loop stop conditions should be invariant
+# https://rules.sonarsource.com/csharp/RSPEC-127
+#
+# Limited use.
+dotnet_diagnostic.S127.severity = none
+
 # S907: Remove use of 'goto'
 # https://rules.sonarsource.com/csharp/RSPEC-907
 #
@@ -87,6 +93,10 @@ dotnet_diagnostic.S1144.severity = none
 # This is a duplicate of IDE0060.
 dotnet_diagnostic.S1172.severity = none
 
+# S1199: Nested code blocks should not be used
+# https://rules.sonarsource.com/csharp/RSPEC-1199
+dotnet_diagnostic.S1199.severity = none
+
 # S1481: Unused local variables should be removed
 # https://rules.sonarsource.com/csharp/RSPEC-1481
 #
@@ -124,6 +134,12 @@ dotnet_diagnostic.S2259.severity = none
 # This is a duplicate of IDE0032.
 dotnet_diagnostic.S2292.severity = none
 
+# S2325: Methods and properties that don't access instance data should be static
+# https://rules.sonarsource.com/csharp/RSPEC-2325
+#
+# This is a duplicate of CA1822
+dotnet_diagnostic.S2325.severity = none
+
 # S2445: Blocks should be synchronized on read-only fields
 # https://rules.sonarsource.com/csharp/RSPEC-2445
 #

Directory.Build.props

@@ -32,7 +32,7 @@
         Disable nullable warnings on old frameworks because of missing annotations.
   -->
   <PropertyGroup Condition=" !$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0')) ">
-    <NoWarn>$(NoWarn);CS8602</NoWarn>
+    <NoWarn>$(NoWarn);CS8602;CS8604;CS8777</NoWarn>
   </PropertyGroup>
 
   <!--
@@ -46,8 +46,8 @@
         Use fixed version of analyzers.
     -->
   <ItemGroup>
-    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" PrivateAssets="all" />
-    <PackageReference Include="Meziantou.Analyzer" Version="2.0.141" PrivateAssets="all" />
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="9.19.0.84025" PrivateAssets="all" />
+    <PackageReference Include="StyleCop.Analyzers" PrivateAssets="all" />
+    <PackageReference Include="Meziantou.Analyzer" PrivateAssets="all" />
+    <PackageReference Include="SonarAnalyzer.CSharp" PrivateAssets="all" />
   </ItemGroup>
 </Project>

Directory.Packages.props

@@ -0,0 +1,27 @@
+<Project>
+  <PropertyGroup>
+    <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
+    <CentralPackageVersionOverrideEnabled>false</CentralPackageVersionOverrideEnabled>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageVersion Include="Appveyor.TestLogger" Version="2.0.0" />
+    <PackageVersion Include="BenchmarkDotNet" Version="0.14.0" />
+    <PackageVersion Include="BouncyCastle.Cryptography" Version="2.4.0" />
+    <PackageVersion Include="coverlet.collector" Version="6.0.2" />
+    <PackageVersion Include="coverlet.msbuild" Version="6.0.2" />
+    <PackageVersion Include="LiquidTestReports.Markdown" Version="1.0.9" />
+    <PackageVersion Include="Meziantou.Analyzer" Version="2.0.163" />
+    <!-- Must be kept at version 1.0.0 or higher, see https://github.com/sshnet/SSH.NET/pull/1288 for details. -->
+    <PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="1.0.0" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageVersion Include="MSTest.TestAdapter" Version="3.6.0" />
+    <PackageVersion Include="MSTest.TestFramework" Version="3.6.0" />
+    <PackageVersion Include="Moq" Version="4.20.72" />
+    <PackageVersion Include="Nerdbank.GitVersioning" Version="3.7.70-alpha" />
+    <PackageVersion Include="PolySharp" Version="1.14.1" />
+    <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.32.0.97167" />
+    <PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />
+    <PackageVersion Include="System.Formats.Asn1" Version="8.0.1" />
+    <PackageVersion Include="Testcontainers" Version="3.10.0" />
+  </ItemGroup>
+</Project>

README.md

@@ -70,8 +70,8 @@ The main types provided by this library are:
 * aes128-ctr
 * aes192-ctr
 * aes256-ctr
-* aes128-gcm<span></span>@openssh.com (.NET 6 and higher)
-* aes256-gcm<span></span>@openssh.com (.NET 6 and higher)
+* aes128-gcm<span></span>@openssh.com
+* aes256-gcm<span></span>@openssh.com
 * chacha20-poly1305<span></span>@openssh.com
 * aes128-cbc
 * aes192-cbc
@@ -96,19 +96,48 @@ The main types provided by this library are:
 ## Public Key Authentication
 
 **SSH.NET** supports the following private key formats:
-* RSA in OpenSSL PEM ("BEGIN RSA PRIVATE KEY") and ssh.com ("BEGIN SSH2 ENCRYPTED PRIVATE KEY") format
-* DSA in OpenSSL PEM ("BEGIN DSA PRIVATE KEY") and ssh.com ("BEGIN SSH2 ENCRYPTED PRIVATE KEY") format
-* ECDSA 256/384/521 in OpenSSL PEM format ("BEGIN EC PRIVATE KEY")
-* ECDSA 256/384/521, ED25519 and RSA in OpenSSH key format ("BEGIN OPENSSH PRIVATE KEY")
-
-Private keys can be encrypted using one of the following cipher methods:
+* RSA in
+  * OpenSSL traditional PEM format ("BEGIN RSA PRIVATE KEY")
+  * OpenSSL PKCS#8 PEM format ("BEGIN PRIVATE KEY", "BEGIN ENCRYPTED PRIVATE KEY")
+  * ssh.com format ("BEGIN SSH2 ENCRYPTED PRIVATE KEY")
+  * OpenSSH key format ("BEGIN OPENSSH PRIVATE KEY")
+* DSA in
+  * OpenSSL traditional PEM format ("BEGIN DSA PRIVATE KEY")
+  * OpenSSL PKCS#8 PEM format ("BEGIN PRIVATE KEY", "BEGIN ENCRYPTED PRIVATE KEY")
+  * ssh.com format ("BEGIN SSH2 ENCRYPTED PRIVATE KEY")
+* ECDSA 256/384/521 in
+  * OpenSSL traditional PEM format ("BEGIN EC PRIVATE KEY")
+  * OpenSSL PKCS#8 PEM format ("BEGIN PRIVATE KEY", "BEGIN ENCRYPTED PRIVATE KEY")
+  * OpenSSH key format ("BEGIN OPENSSH PRIVATE KEY")
+* ED25519 in
+  * OpenSSL PKCS#8 PEM format ("BEGIN PRIVATE KEY", "BEGIN ENCRYPTED PRIVATE KEY")
+  * OpenSSH key format ("BEGIN OPENSSH PRIVATE KEY")
+
+Private keys in OpenSSL traditional PEM format can be encrypted using one of the following cipher methods:
 * DES-EDE3-CBC
 * DES-EDE3-CFB
 * DES-CBC
 * AES-128-CBC
 * AES-192-CBC
 * AES-256-CBC
 
+Private keys in OpenSSL PKCS#8 PEM format can be encrypted using any cipher method BouncyCastle supports.
+
+Private keys in ssh.com format can be encrypted using one of the following cipher methods:
+* 3des-cbc
+
+Private keys in OpenSSH key format can be encrypted using one of the following cipher methods:
+* 3des-cbc
+* aes128-cbc
+* aes192-cbc
+* aes256-cbc
+* aes128-ctr
+* aes192-ctr
+* aes256-ctr
+* aes128-gcm<span></span>@openssh.com
+* aes256-gcm<span></span>@openssh.com
+* chacha20-poly1305<span></span>@openssh.com
+
 ## Host Key Algorithms
 
 **SSH.NET** supports the following host key algorithms:

Renci.SshNet.sln

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

appveyor.yml

@@ -32,7 +32,7 @@ for:
     # 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
-    - sh: dotnet test -f net48 -c Debug --no-restore --no-build --results-directory artifacts --logger Appveyor --logger "console;verbosity=normal" --logger "liquid.md;LogFileName=linux_integration_test_net_48_report.md" -p:CollectCoverage=true -p:CoverletOutputFormat=cobertura -p:CoverletOutput=../../artifacts/linux_integration_test_net_48_coverage.xml --filter "Name~Ecdh|Name~Zlib" test/Renci.SshNet.IntegrationTests/Renci.SshNet.IntegrationTests.csproj
+    - sh: dotnet test -f net48 -c Debug --no-restore --no-build --results-directory artifacts --logger Appveyor --logger "console;verbosity=normal" --logger "liquid.md;LogFileName=linux_integration_test_net_48_report.md" -p:CollectCoverage=true -p:CoverletOutputFormat=cobertura -p:CoverletOutput=../../artifacts/linux_integration_test_net_48_coverage.xml --filter "Name~Ecdh|Name~ECDsa|Name~Zlib|Name~Gcm" test/Renci.SshNet.IntegrationTests/Renci.SshNet.IntegrationTests.csproj
 
 -
   matrix:

src/Renci.SshNet/.editorconfig

@@ -188,3 +188,6 @@ dotnet_diagnostic.MA0040.severity = none
 # MA0042: Do not use blocking calls in an async method
 # duplicate of CA1849
 dotnet_diagnostic.MA0042.severity = none
+
+# S3236: Caller information arguments should not be provided explicitly
+dotnet_diagnostic.S3236.severity = none

src/Renci.SshNet/Abstractions/CancellationTokenSourceExtensions.cs

@@ -0,0 +1,16 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Renci.SshNet.Abstractions
+{
+    internal static class CancellationTokenSourceExtensions
+    {
+#if !NET8_OR_GREATER
+        public static Task CancelAsync(this CancellationTokenSource cancellationTokenSource)
+        {
+            cancellationTokenSource.Cancel();
+            return Task.CompletedTask;
+        }
+#endif
+    }
+}

src/Renci.SshNet/Abstractions/SocketAbstraction.cs

@@ -129,7 +129,7 @@ public static void ClearReadBuffer(Socket socket)
 
         public static int ReadPartial(Socket socket, byte[] buffer, int offset, int size, TimeSpan timeout)
         {
-            socket.ReceiveTimeout = timeout.AsTimeout(nameof(timeout));
+            socket.ReceiveTimeout = timeout.AsTimeout();
 
             try
             {
@@ -274,7 +274,7 @@ public static int Read(Socket socket, byte[] buffer, int offset, int size, TimeS
             var totalBytesRead = 0;
             var totalBytesToRead = size;
 
-            socket.ReceiveTimeout = readTimeout.AsTimeout(nameof(readTimeout));
+            socket.ReceiveTimeout = readTimeout.AsTimeout();
 
             do
             {
@@ -292,7 +292,7 @@ public static int Read(Socket socket, byte[] buffer, int offset, int size, TimeS
                 {
                     if (IsErrorResumable(ex.SocketErrorCode))
                     {
-                        ThreadAbstraction.Sleep(30);
+                        Thread.Sleep(30);
                         continue;
                     }
 
@@ -346,7 +346,7 @@ public static void Send(Socket socket, byte[] data, int offset, int size)
                     if (IsErrorResumable(ex.SocketErrorCode))
                     {
                         // socket buffer is probably full, wait and try again
-                        ThreadAbstraction.Sleep(30);
+                        Thread.Sleep(30);
                     }
                     else
                     {

src/Renci.SshNet/Abstractions/StreamExtensions.cs

@@ -0,0 +1,18 @@
+#if !NET && !NETSTANDARD2_1_OR_GREATER
+using System.IO;
+using System.Threading.Tasks;
+#endif
+
+namespace Renci.SshNet.Abstractions
+{
+    internal static class StreamExtensions
+    {
+#if !NET && !NETSTANDARD2_1_OR_GREATER
+        public static ValueTask DisposeAsync(this Stream stream)
+        {
+            stream.Dispose();
+            return default;
+        }
+#endif
+    }
+}