feat(logging): Capture resolved store properties after mapping

Signed-off-by: Matthew H. Irby <[email protected]>

Author: irby

RemoteFile/RemoteFileJobTypeBase.cs

@@ -11,6 +11,7 @@
 using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
+using Keyfactor.Logging;
 
 namespace Keyfactor.Extensions.Orchestrator.RemoteFile
 {
@@ -35,6 +36,8 @@ public abstract class RemoteFileJobTypeBase
 
         internal void SetJobProperties(JobConfiguration config, CertificateStore certificateStoreDetails, ILogger logger)
         {
+            logger.MethodEntry(LogLevel.Debug);
+            
             logger.LogDebug($"Begin {config.Capability} for job id {config.JobId}...");
             logger.LogDebug($"Server: {certificateStoreDetails.ClientMachine}");
             logger.LogDebug($"Store Path: {certificateStoreDetails.StorePath}");
@@ -73,17 +76,43 @@ internal void SetJobProperties(JobConfiguration config, CertificateStore certifi
             FileTransferProtocol = ApplicationSettings.FileTransferProtocol;
             if (properties.FileTransferProtocol != null && !string.IsNullOrEmpty(properties.FileTransferProtocol.Value))
             {
+                logger.LogDebug($"Attempting to map file transfer protocol from properties. Current Value: {FileTransferProtocol}, Property Value: {properties.FileTransferProtocol.Value}");
                 ApplicationSettings.FileTransferProtocolEnum fileTransferProtocol;
                 if (Enum.TryParse(properties.FileTransferProtocol.Value, out fileTransferProtocol))
+                {
+                    logger.LogDebug("Successfully mapped file transfer protocol from properties");
                     FileTransferProtocol = fileTransferProtocol;
+                }
+                    
             }
 
             if (config.JobProperties != null)
             {
                 KeyType = !config.JobProperties.ContainsKey("keyType") || config.JobProperties["keyType"] == null || string.IsNullOrEmpty(config.JobProperties["keyType"].ToString()) ? string.Empty : config.JobProperties["keyType"].ToString();
                 KeySize = !config.JobProperties.ContainsKey("keySize") || config.JobProperties["keySize"] == null || string.IsNullOrEmpty(config.JobProperties["keySize"].ToString()) || !int.TryParse(config.JobProperties["keySize"].ToString(), out int notUsed2) ? 2048 : Convert.ToInt32(config.JobProperties["keySize"]);
                 SubjectText = !config.JobProperties.ContainsKey("subjectText") || config.JobProperties["subjectText"] == null || string.IsNullOrEmpty(config.JobProperties["subjectText"].ToString()) ? string.Empty : config.JobProperties["subjectText"].ToString();
-            }        
+            }
+            
+            logger.LogDebug("Store properties have been configured successfully. Property values:");
+            logger.LogDebug($"UserName: {UserName}");
+            logger.LogDebug($"UserPassword: {LogSensitiveField(UserPassword)}");
+            logger.LogDebug($"StorePassword: {LogSensitiveField(StorePassword)}");
+            logger.LogDebug($"SudoImpersonatedUser: {SudoImpersonatedUser}");
+            logger.LogDebug($"RemoveRootCertificate: {RemoveRootCertificate}");
+            logger.LogDebug($"SSHPort: {SSHPort}");
+            logger.LogDebug($"IncludePortInSPN: {IncludePortInSPN}");
+            logger.LogDebug($"FileTransferProtocol: {FileTransferProtocol}");
+            logger.LogDebug($"CreateCSROnDevice: {CreateCSROnDevice}");
+            logger.LogDebug($"KeyType: {KeyType}");
+            logger.LogDebug($"KeySize: {KeySize}");
+            logger.LogDebug($"SubjectText: {SubjectText}");
+            
+            logger.MethodExit(LogLevel.Debug);
+        }
+
+        private string LogSensitiveField(string input)
+        {
+            return string.IsNullOrWhiteSpace(input) ? "" : "(hidden)";
         }
     }
 }

RemoteFile/RemoteHandlers/SSHHandler.cs

@@ -251,6 +251,7 @@ public override byte[] DownloadCertificateFile(string path)
 
             if (!string.IsNullOrEmpty(ApplicationSettings.SeparateUploadFilePath) && IsStoreServerLinux)
             {
+                _logger.LogDebug("Splitting store path");
                 SplitStorePathFile(path, out altPathOnly, out altFileNameOnly);
                 downloadPath = ApplicationSettings.SeparateUploadFilePath + altFileNameOnly;
                 RunCommand($"cp {path} {downloadPath}", null, ApplicationSettings.UseSudo, null);