Fix problem with loading SSH private keys (#61)

MichaelKoster70 · web-flow · commit c0769f9853c5 · 2025-08-06T19:40:08.000+02:00
* Upgrade to SSH.NET 2025.0.0, fixed spelling
* Disable VS 2022 Spell Checker
diff --git a/.editorconfig b/.editorconfig
@@ -1213,24 +1213,7 @@ dotnet_diagnostic.ISB001.severity = error
 dotnet_diagnostic.ISB002.severity = warning
 dotnet_diagnostic.MsgPack001.severity = warning
 dotnet_diagnostic.MsgPack002.severity = warning
-dotnet_style_operator_placement_when_wrapping = beginning_of_line
-tab_width = 3
-indent_size = 3
-end_of_line = crlf
-dotnet_style_coalesce_expression = true:suggestion
-dotnet_style_null_propagation = true:suggestion
-dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
-dotnet_style_prefer_auto_properties = true:silent
-dotnet_style_object_initializer = true:suggestion
-dotnet_style_collection_initializer = true:suggestion
-dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
-dotnet_style_prefer_conditional_expression_over_assignment = true:silent
-dotnet_style_prefer_conditional_expression_over_return = true:silent
-dotnet_style_explicit_tuple_names = true:suggestion
-dotnet_style_prefer_inferred_tuple_names = true:suggestion
-dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
-dotnet_style_prefer_compound_assignment = true:suggestion
-dotnet_style_prefer_simplified_interpolation = true:suggestion
-dotnet_style_namespace_match_folder = true:suggestion
-indent_style = space
 
+# Disable the VS Spell Checker for now until the problem with the exclusion dictionary is fixed
+spelling_checkable_types = none
+spelling_error_severity = none
diff --git a/RemoteDebuggerLauncherExtension.sln.GhostDoc.user.dic b/RemoteDebuggerLauncherExtension.sln.GhostDoc.user.dic
@@ -8,6 +8,7 @@ github
 https
 joinable
 json
+Koster
 launchjson
 launchsettings
 localappdata
@@ -16,14 +17,19 @@ mkdir
 msedge
 omnisharp
 pkgdef
+plugin
 runspace
 staticwebassets
+Statusbar
 stdin
 uname
 unconfigured
+Username
 userprofile
 vscode
 vsct
 vsdbg
 vsixmanifest
+vsui
+webtools
 wwwroot
diff --git a/src/Extension/RemoteDebuggerLauncher/PackageConstants.cs b/src/Extension/RemoteDebuggerLauncher/PackageConstants.cs
@@ -15,7 +15,7 @@ namespace RemoteDebuggerLauncher
    internal static class PackageConstants
    {
       /// <summary>
-      /// Common Project System relalated constants
+      /// Common Project System related constants
       /// </summary>
       public static class CPS
       {
diff --git a/src/Extension/RemoteDebuggerLauncher/ProjectSystem/Build/DotnetPublishService.cs b/src/Extension/RemoteDebuggerLauncher/ProjectSystem/Build/DotnetPublishService.cs
@@ -76,7 +76,7 @@ public async Task StartAsync()
                case PublishMode.FrameworkDependant:
                   arguments += " --no-build";
 
-                  if (await SupportsFrameworkDependantAsync())
+                  if (await SupportsFrameworkDependentAsync())
                   {
                      arguments += " --no-self-contained";
                   }
@@ -176,14 +176,14 @@ private async Task<string> GetPublishedOutputDirectoryPathAsync()
          // Append the deploy/publish base 
          var publishPath = PathHelper.Combine(baseOutputPath, PackageConstants.Publish.OutDir);
 
-         // append the $(Configuration)/$(TargetFramework) dirs
+         // append the $(Configuration)/$(TargetFramework) directories
          publishPath = PathHelper.Combine(publishPath, configuration);
          publishPath = PathHelper.Combine(publishPath, targetFramework);
 
          return publishPath;
       }
 
-      private async Task<bool> SupportsFrameworkDependantAsync()
+      private async Task<bool> SupportsFrameworkDependentAsync()
       {
          // Web Assembly Publish operations require self contained 
          var isWasm = configuredProject.Services.Capabilities.AppliesTo("WebAssembly");
@@ -196,7 +196,7 @@ private async Task<bool> SupportsFrameworkDependantAsync()
             isWasm |= project != null && project.Services.Capabilities.AppliesTo("WebAssembly");
          }
 
-         // every other project type is fine with framework dependant
+         // every other project type is fine with framework dependent
          return !isWasm;
       }
    }
diff --git a/src/Extension/RemoteDebuggerLauncher/ProjectSystem/Debugger/SecureShellRemoteLaunchTargetsProvider.cs b/src/Extension/RemoteDebuggerLauncher/ProjectSystem/Debugger/SecureShellRemoteLaunchTargetsProvider.cs
@@ -165,7 +165,7 @@ private async Task AddSshLaunchTargetAsync(List<IDebugLaunchSettings> debugLaunc
          }
          else
          {
-            // in all otger cases, debug as framwork dependant
+            // in all other cases, debug as framework dependent
             launchSettings.Options = await AdapterLaunchConfiguration.CreateFrameworkDependantAsync(factory.Configuration, configuredProject, factory.OutputPane, remoteOperations);
          }
 
diff --git a/src/Extension/RemoteDebuggerLauncher/ProjectSystem/IPackageServiceFactory.cs b/src/Extension/RemoteDebuggerLauncher/ProjectSystem/IPackageServiceFactory.cs
@@ -26,7 +26,7 @@ internal interface IPackageServiceFactory
       ConfigurationAggregator Configuration { get; }
 
       /// <summary>
-      /// Gets the configured VS ouput pane writer.
+      /// Gets the configured VS output pane writer.
       /// </summary>
       IOutputPaneWriterService OutputPane { get; }
 
diff --git a/src/Extension/RemoteDebuggerLauncher/ProjectSystem/PackageServiceFactory.cs b/src/Extension/RemoteDebuggerLauncher/ProjectSystem/PackageServiceFactory.cs
@@ -86,7 +86,7 @@ public async Task<ISecureShellRemoteOperationsService> GetSecureShellRemoteOpera
       /// </summary>
       /// <param name="configurationAggregator">The configuration object.</param>
       /// <param name="outputPaneWriter">The VS output pane writer.</param>
-      /// <param name="configuredProject">The configired project</param>
+      /// <param name="configuredProject">The configured project</param>
       /// <returns></returns>
       protected bool Configure(ConfigurationAggregator configurationAggregator, IOutputPaneWriterService outputPaneWriter, ConfiguredProject configuredProject)
       {
diff --git a/src/Extension/RemoteDebuggerLauncher/RemoteDebuggerLauncher.csproj b/src/Extension/RemoteDebuggerLauncher/RemoteDebuggerLauncher.csproj
@@ -243,7 +243,7 @@
     <PackageReference Include="Microsoft.VisualStudio.LanguageServices" Version="4.4.0" ExcludeAssets="runtime" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="NuGet.VisualStudio" Version="17.4.0" ExcludeAssets="runtime" />
-    <PackageReference Include="SSH.NET" Version="2020.0.2" />
+    <PackageReference Include="SSH.NET" Version="2025.0.0" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\Tools\SourceGenerators\SourceGenerators.csproj" OutputItemType="Analyzer" PrivateAssets="all" ReferenceOutputAssembly="false">
diff --git a/src/Extension/RemoteDebuggerLauncher/SecureShell/SecureShellRemoteOperationsService.cs b/src/Extension/RemoteDebuggerLauncher/SecureShell/SecureShellRemoteOperationsService.cs
@@ -342,7 +342,7 @@ public Task TryInstallDotNetOfflineAsync(DotnetInstallationKind kind, string cha
       /// <inheritdoc />
       public async Task SetupAspNetDeveloperCertificateAsync(SetupMode mode, byte[] certificate, string password)
       {
-         // Path for the 'donet' executable
+         // Path for the 'dotnet' executable
          string dotnetExecutable = UnixPath.Combine(configurationAggregator.QueryDotNetInstallFolderPath(), "dotnet");
 
          //Check if ASP.NET runtime is installed
diff --git a/src/Extension/RemoteDebuggerLauncher/SecureShell/SecureShellSessionCommandingService.cs b/src/Extension/RemoteDebuggerLauncher/SecureShell/SecureShellSessionCommandingService.cs
@@ -44,9 +44,9 @@ public Task<string> ExecuteCommandAsync(string commandText)
 
                using (var command = client.RunCommand(commandText))
                {
-                  if (command.ExitStatus != 0)
+                  if (command.ExitStatus.HasValue && command.ExitStatus.Value != 0)
                   {
-                     throw new SecureShellSessionException(command.Error, command.ExitStatus);
+                     throw new SecureShellSessionException(command.Error, command.ExitStatus.Value);
                   }
 
                   return command.Result;
@@ -76,7 +76,7 @@ public Task<string> ExecuteCommandAsync(string commandText)
 
                using (var command = client.RunCommand(commandText))
                {
-                  return (command.ExitStatus, command.Result, command.Error);
+                  return (command.ExitStatus ?? 0, command.Result, command.Error);
                }
             }
             catch (SshException e)
diff --git a/src/Extension/RemoteDebuggerLauncher/WebTools/CertificateService.cs b/src/Extension/RemoteDebuggerLauncher/WebTools/CertificateService.cs
@@ -22,7 +22,7 @@ internal class CertificateService : ICertificateService
       // RSA key size
       private const int RsaKeySize = 4096;
 
-      // the current cert version used by ASP.NET 'dontet dev-certs
+      // the current cert version used by ASP.NET 'dotnet dev-certs
       private const int CurrentCertificateVersion = 2;
 
       // Localhost DNS and CN
@@ -43,7 +43,7 @@ internal class CertificateService : ICertificateService
       private const string ServerAuthenticationEnhancedKeyUsageOidFriendlyName = "Server Authentication";
 
       // Hresult when the user cancels trusting a certificate
-      private const int UserCancelledErrorCode = unchecked((int)0x800704C7);
+      private const int UserCanceledErrorCode = unchecked((int)0x800704C7);
 
       [ImportingConstructor]
       public CertificateService()
@@ -77,7 +77,7 @@ public X509Certificate2 CreateDevelopmentCertificate(string deviceName)
                csr.CertificateExtensions.Add(new X509Extension(new AsnEncodedData(
                   new Oid(AspNetHttpsOid, AspNetHttpsOidFriendlyName), new byte[] { CurrentCertificateVersion }), false));
 
-               // Create the Cert serial numbert
+               // Create the Cert serial number
                byte[] serialNumber = new byte[9];
                using (RandomNumberGenerator randomNumberGenerator = RandomNumberGenerator.Create())
                {
@@ -122,7 +122,7 @@ public void EnsureSelfSignedRootPresentAndTrusted()
       /// <inheritdoc />
       public bool IsSelfSignedRootPresent()
       {
-         using (var cert = LoadeSelfSignedRootCertificate())
+         using (var cert = LoadSelfSignedRootCertificate())
          {
             return cert != null;
          }
@@ -131,7 +131,7 @@ public bool IsSelfSignedRootPresent()
       private static X509Certificate2 LoadOrCreateRootCertificate()
       {
          // try to load an existing cert
-         var certificate = LoadeSelfSignedRootCertificate();
+         var certificate = LoadSelfSignedRootCertificate();
 
          if (certificate == null)
          {
@@ -149,7 +149,7 @@ private static X509Certificate2 LoadOrCreateRootCertificate()
          return certificate;
       }
 
-      private static X509Certificate2 LoadeSelfSignedRootCertificate()
+      private static X509Certificate2 LoadSelfSignedRootCertificate()
       {
          X509Certificate2 root = null;
 
@@ -189,7 +189,7 @@ private static X509Certificate2 LoadeSelfSignedRootCertificate()
          }
          catch(CryptographicException)
          {
-            // trown when the find type is invalid -> treat this as cert not present.
+            // thrown when the find type is invalid -> treat this as cert not present.
             root = null;
          }
 
@@ -198,7 +198,7 @@ private static X509Certificate2 LoadeSelfSignedRootCertificate()
 
       private static X509Certificate2 CreateSelfSignedRootCertificate()
       {
-         // Create a RSA keypair
+         // Create a RSA key pair
          using (var keyPair = RSA.Create(RsaKeySize))
          {
             // create a CSR
@@ -280,7 +280,7 @@ private static void TrustSelfSignedPublicRootCertificate(X509Certificate2 certif
                   store.Add(publicCertificate);
 #pragma warning restore CA5380
                }
-               catch (CryptographicException e) when (e.HResult == UserCancelledErrorCode)
+               catch (CryptographicException e) when (e.HResult == UserCanceledErrorCode)
                {
                   throw new RemoteDebuggerLauncherException(Resources.CertificateServicesTrustCancelledByUser, e);
                }
diff --git a/src/Extension/RemoteDebuggerLauncherShared/SecureShell/ISecureShellKeyPairCreatorService.cs b/src/Extension/RemoteDebuggerLauncherShared/SecureShell/ISecureShellKeyPairCreatorService.cs
@@ -25,7 +25,7 @@ public interface ISecureShellKeyPairCreatorService
       string DefaultPublicKeyPath { get; }
 
       /// <summary>
-      /// Create a new RSA key pair, if there is no key pair availble with the default name.
+      /// Create a new RSA key pair, if there is no key pair available with the default name.
       /// </summary>
       /// <returns><c>true</c> if successful or the file exists; else <c>false</c></returns>
       Task<bool> CreateAsync();
diff --git a/src/Extension/RemoteDebuggerLauncherShared/Shared/Constants.cs b/src/Extension/RemoteDebuggerLauncherShared/Shared/Constants.cs
@@ -40,11 +40,11 @@ public static class Dotnet
       }
       public static class RegexExpressions
       {
-         /// <summary>Regex to validate a linux username.</summary>
+         /// <summary>Regex to validate a Linux username.</summary>
          public const string LinuxUsernameAlternate = "^[a-z][-a-z0-9_]*$?$";
          public const string LinuxUsername = "^[a-z_]([a-z0-9_-]{0,31}|[a-z0-9_-]{0,30}$)$";
 
-         /// <summary>Regex to validate a linux password.</summary>
+         /// <summary>Regex to validate a Linux password.</summary>
          public const string LinuxPassword = "^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[@#$%^&-+=()])(?=\\S+$).{8,20}$";
       }
    }
diff --git a/src/Extension/RemoteDebuggerLauncherUI/Commands/ViewModels/SetupSshViewModel.cs b/src/Extension/RemoteDebuggerLauncherUI/Commands/ViewModels/SetupSshViewModel.cs
@@ -281,7 +281,7 @@ private void AddErrors(string propertyName, IEnumerable<object> newErrors)
       /// <summary>
       /// Removes all errors of the specified property.Raises the ErrorsChanged event if the Errors collection changes. 
       /// </summary>
-      /// <param name="propertyName">The property name to creal the errors</param>
+      /// <param name="propertyName">The property name to clear the errors</param>
       /// <returns></returns>
       private bool ClearErrors(string propertyName)
       {

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ namespace RemoteDebuggerLauncher`
`15`	`15`	`internal static class PackageConstants`
`16`	`16`	`{`
`17`	`17`	`/// <summary>`
`18`		`- /// Common Project System relalated constants`
	`18`	`+ /// Common Project System related constants`
`19`	`19`	`/// </summary>`
`20`	`20`	`public static class CPS`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public async Task StartAsync()`
`76`	`76`	`case PublishMode.FrameworkDependant:`
`77`	`77`	`arguments += " --no-build";`
`78`	`78`
`79`		`- if (await SupportsFrameworkDependantAsync())`
	`79`	`+ if (await SupportsFrameworkDependentAsync())`
`80`	`80`	`{`
`81`	`81`	`arguments += " --no-self-contained";`
`82`	`82`	`}`
`@@ -176,14 +176,14 @@ private async Task<string> GetPublishedOutputDirectoryPathAsync()`
`176`	`176`	`// Append the deploy/publish base`
`177`	`177`	`var publishPath = PathHelper.Combine(baseOutputPath, PackageConstants.Publish.OutDir);`
`178`	`178`
`179`		`- // append the $(Configuration)/$(TargetFramework) dirs`
	`179`	`+ // append the $(Configuration)/$(TargetFramework) directories`
`180`	`180`	`publishPath = PathHelper.Combine(publishPath, configuration);`
`181`	`181`	`publishPath = PathHelper.Combine(publishPath, targetFramework);`
`182`	`182`
`183`	`183`	`return publishPath;`
`184`	`184`	`}`
`185`	`185`
`186`		`- private async Task<bool> SupportsFrameworkDependantAsync()`
	`186`	`+ private async Task<bool> SupportsFrameworkDependentAsync()`
`187`	`187`	`{`
`188`	`188`	`// Web Assembly Publish operations require self contained`
`189`	`189`	`var isWasm = configuredProject.Services.Capabilities.AppliesTo("WebAssembly");`
`@@ -196,7 +196,7 @@ private async Task<bool> SupportsFrameworkDependantAsync()`
`196`	`196`	`isWasm \|= project != null && project.Services.Capabilities.AppliesTo("WebAssembly");`
`197`	`197`	`}`
`198`	`198`
`199`		`- // every other project type is fine with framework dependant`
	`199`	`+ // every other project type is fine with framework dependent`
`200`	`200`	`return !isWasm;`
`201`	`201`	`}`
`202`	`202`	`}`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ private async Task AddSshLaunchTargetAsync(List<IDebugLaunchSettings> debugLaunc`
`165`	`165`	`}`
`166`	`166`	`else`
`167`	`167`	`{`
`168`		`- // in all otger cases, debug as framwork dependant`
	`168`	`+ // in all other cases, debug as framework dependent`
`169`	`169`	`launchSettings.Options = await AdapterLaunchConfiguration.CreateFrameworkDependantAsync(factory.Configuration, configuredProject, factory.OutputPane, remoteOperations);`
`170`	`170`	`}`
`171`	`171`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public async Task<ISecureShellRemoteOperationsService> GetSecureShellRemoteOpera`
`86`	`86`	`/// </summary>`
`87`	`87`	`/// <param name="configurationAggregator">The configuration object.</param>`
`88`	`88`	`/// <param name="outputPaneWriter">The VS output pane writer.</param>`
`89`		`- /// <param name="configuredProject">The configired project</param>`
	`89`	`+ /// <param name="configuredProject">The configured project</param>`
`90`	`90`	`/// <returns></returns>`
`91`	`91`	`protected bool Configure(ConfigurationAggregator configurationAggregator, IOutputPaneWriterService outputPaneWriter, ConfiguredProject configuredProject)`
`92`	`92`	`{`
Original file line number	Diff line number	Diff line change
`@@ -342,7 +342,7 @@ public Task TryInstallDotNetOfflineAsync(DotnetInstallationKind kind, string cha`
`342`	`342`	`/// <inheritdoc />`
`343`	`343`	`public async Task SetupAspNetDeveloperCertificateAsync(SetupMode mode, byte[] certificate, string password)`
`344`	`344`	`{`
`345`		`- // Path for the 'donet' executable`
	`345`	`+ // Path for the 'dotnet' executable`
`346`	`346`	`string dotnetExecutable = UnixPath.Combine(configurationAggregator.QueryDotNetInstallFolderPath(), "dotnet");`
`347`	`347`
`348`	`348`	`//Check if ASP.NET runtime is installed`
Original file line number	Diff line number	Diff line change
`@@ -44,9 +44,9 @@ public Task<string> ExecuteCommandAsync(string commandText)`
`44`	`44`
`45`	`45`	`using (var command = client.RunCommand(commandText))`
`46`	`46`	`{`
`47`		`- if (command.ExitStatus != 0)`
	`47`	`+ if (command.ExitStatus.HasValue && command.ExitStatus.Value != 0)`
`48`	`48`	`{`
`49`		`- throw new SecureShellSessionException(command.Error, command.ExitStatus);`
	`49`	`+ throw new SecureShellSessionException(command.Error, command.ExitStatus.Value);`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`return command.Result;`
`@@ -76,7 +76,7 @@ public Task<string> ExecuteCommandAsync(string commandText)`
`76`	`76`
`77`	`77`	`using (var command = client.RunCommand(commandText))`
`78`	`78`	`{`
`79`		`- return (command.ExitStatus, command.Result, command.Error);`
	`79`	`+ return (command.ExitStatus ?? 0, command.Result, command.Error);`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`	`catch (SshException e)`