feat(handlers): Add Warnings array to IRemoteHandler interface for returning warning messages to job results.

Author: spbsoluble

CHANGELOG.md

@@ -1,3 +1,16 @@
+v2.11.4
+- Bug Fix: Handle condition where a certificate store definition that contains an invalid value for `FileTransferProtocol` 
+would return empty inventory. If no value is set or an invalid value is set, the default value of `Both` will be used 
+and a warning status will be returned for the job.
+
+> [!IMPORTANT]
+> Due to an issue in Keyfactor Command versions through 25.2.1, when adding multiple choice store properties to exiting 
+> certificate store types, existing certificate stores receive incorrect initialization data for the new property. 
+> If you have upgraded your store type from something prior to version 2.10.0, ensure that each existing certificate 
+> store has a valid value for `FileTransferProtocol`. Valid values are `SCP`, `SFTP`, `Both`, otherwise inventory jobs **may report 
+> empty certificate store inventories**. Extension version 2.11.4 compensates for this, but upgrading customers should 
+> check their store’s configuration for proper `FileTransferProtocol` values.
+
 v2.11.3
 - Change returned result of a Management-Create job for a store that already exists from 'Failure' to 'Warning'
 

RemoteFile/InventoryBase.cs

@@ -7,6 +7,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Security.Cryptography.X509Certificates;
 
 using Keyfactor.Orchestrators.Extensions;
@@ -73,7 +74,12 @@ public JobResult ProcessJob(InventoryJobConfiguration config, SubmitInventoryUpd
             catch (Exception ex)
             {
                 logger.LogError($"Exception for {config.Capability}: {RemoteFileException.FlattenExceptionMessages(ex, string.Empty)} for job id {config.JobId}");
-                return new JobResult() { Result = OrchestratorJobStatusJobResult.Failure, JobHistoryId = config.JobHistoryId, FailureMessage = RemoteFileException.FlattenExceptionMessages(ex, $"Site {config.CertificateStoreDetails.StorePath} on server {config.CertificateStoreDetails.ClientMachine}:") };
+                return new JobResult 
+                    { 
+                        Result = OrchestratorJobStatusJobResult.Failure, 
+                        JobHistoryId = config.JobHistoryId, 
+                        FailureMessage = RemoteFileException.FlattenExceptionMessages(ex, $"Site {config.CertificateStoreDetails.StorePath} on server {config.CertificateStoreDetails.ClientMachine}:") 
+                    };
             }
             finally
             {
@@ -84,14 +90,31 @@ public JobResult ProcessJob(InventoryJobConfiguration config, SubmitInventoryUpd
             try
             {
                 submitInventory.Invoke(inventoryItems);
-                logger.LogDebug($"...End {config.Capability} job for job id {config.JobId}");
-                return new JobResult() { Result = OrchestratorJobStatusJobResult.Success, JobHistoryId = config.JobHistoryId };
+                logger.LogDebug("...End {ConfigCapability} job for job id {ConfigJobId}", config.Capability, config.JobId);
+                var jobResultStatus = OrchestratorJobStatusJobResult.Success;
+                var jobMsg = string.Empty;
+                if (certificateStore.RemoteHandler != null && certificateStore.RemoteHandler.Warnings.Length > 0)
+                {
+                    jobResultStatus = OrchestratorJobStatusJobResult.Warning;
+                    jobMsg = certificateStore.RemoteHandler.Warnings.Aggregate(jobMsg, (current, warning) => current + (warning + Environment.NewLine));
+                }
+                return new JobResult
+                {
+                    Result = jobResultStatus, 
+                    JobHistoryId = config.JobHistoryId,
+                    FailureMessage = jobMsg
+                };
             }
             catch (Exception ex)
             {
                 string errorMessage = RemoteFileException.FlattenExceptionMessages(ex, string.Empty);
                 logger.LogError($"Exception returning certificates for {config.Capability}: {errorMessage} for job id {config.JobId}");
-                return new JobResult() { Result = OrchestratorJobStatusJobResult.Failure, JobHistoryId = config.JobHistoryId, FailureMessage = RemoteFileException.FlattenExceptionMessages(ex, $"Site {config.CertificateStoreDetails.StorePath} on server {config.CertificateStoreDetails.ClientMachine}:") };
+                return new JobResult
+                {
+                    Result = OrchestratorJobStatusJobResult.Failure, 
+                    JobHistoryId = config.JobHistoryId, 
+                    FailureMessage = RemoteFileException.FlattenExceptionMessages(ex, $"Site {config.CertificateStoreDetails.StorePath} on server {config.CertificateStoreDetails.ClientMachine}:")
+                };
             }
         }
     }

RemoteFile/RemoteHandlers/BaseRemoteHandler.cs

@@ -5,6 +5,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 // and limitations under the License.
 
+using System;
 using Keyfactor.Logging;
 
 using Microsoft.Extensions.Logging;
@@ -18,6 +19,8 @@ abstract class BaseRemoteHandler : IRemoteHandler
         internal const string PASSWORD_MASK_VALUE = "[PASSWORD]";
         internal const int PASSWORD_LENGTH_MAX = 100;
         internal const string LINUX_PERMISSION_REGEXP = "^[0-7]{3}$";
+        
+        public string[] Warnings { get; set; } = Array.Empty<string>();
 
         public string Server { get; set; }
 

RemoteFile/RemoteHandlers/IRemoteHandler.cs

@@ -13,6 +13,8 @@ namespace Keyfactor.Extensions.Orchestrator.RemoteFile.RemoteHandlers
     /// </summary>
     interface IRemoteHandler
     {
+        
+        string [] Warnings { get; set; }
         void Terminate();
 
         string RunCommand(string commandText, object[] arguments, bool withSudo, string[] passwordsToMaskInLog);

RemoteFile/RemoteHandlers/SSHHandler.cs

@@ -8,6 +8,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Security.Cryptography;
 using System.Text;
 
@@ -334,7 +335,11 @@ public override byte[] DownloadCertificateFile(string path)
             if (!attemptedDownload)
             {
                 FileTransferProtocol = ApplicationSettings.FileTransferProtocolEnum.Both;
-                _logger.LogDebug($"No download attempted.  Setting FileTransferProtocol to Both and retrying download.");
+                var warningMsg = "No download attempted.  Setting FileTransferProtocol to 'Both' and retrying download.";
+                _logger.LogWarning(warningMsg);
+                // append to Warnings global array
+               Warnings = Warnings.Length == 0 ? new[] { warningMsg } : Warnings.Append(warningMsg).ToArray();
+                
                 return DownloadCertificateFile(path);
             }