enabled flag

Author: bhillkeyfactor

aruba-clearpass-caplugin/ArubaClearPassCAPlugin.cs

@@ -1,4 +1,4 @@
-using Keyfactor.AnyGateway.Extensions;
+using Keyfactor.AnyGateway.Extensions;
 using Keyfactor.Extensions.CAPlugin.ArubaClearPass.Client;
 using Keyfactor.Logging;
 using Keyfactor.PKI.Enums.EJBCA;
@@ -128,6 +128,13 @@ public async Task<EnrollmentResult> Enroll(string csr, string subject, Dictionar
         public async Task Ping()
         {
             _logger.MethodEntry(LogLevel.Trace);
+            if (!_config.Enabled)
+            {
+                _logger.LogWarning($"The CA is currently in the Disabled state. It must be Enabled to perform operations. Skipping connectivity test...");
+                _logger.MethodExit(LogLevel.Trace);
+                return;
+            }
+
             try
             {
                 _logger.LogInformation($"Attempting to authenticate");
@@ -159,7 +166,21 @@ public async Task Ping()
 
         public async Task ValidateCAConnectionInfo(Dictionary<string, object> connectionInfo)
         {
-            _logger.LogInformation("Validation successful");
+            try
+            {
+                if (!(bool)connectionInfo[ArubaClearPassConstants.Config.Enabled])
+                {
+                    _logger.LogWarning($"The CA is currently in the Disabled state. It must be Enabled to perform operations. Skipping validation...");
+                    _logger.MethodExit(LogLevel.Trace);
+                    return;
+                }
+            }
+            catch (Exception ex)
+            {
+                _logger.LogError($"Exception: {LogHandler.FlattenException(ex)}");
+            }
+
+            _logger.LogInformation("Validating CA Connection Info");
 
             List<string> errors = new List<string>();
 
@@ -181,7 +202,7 @@ public async Task ValidateCAConnectionInfo(Dictionary<string, object> connection
                 errors.Add("The Base URL needs http:// or https://");
             }
 
-            _logger.LogTrace("Checking the API Secret.");
+            _logger.LogTrace("Checking the API Client.");
             string apiClient = connectionInfo.ContainsKey(ArubaClearPassConstants.Config.ClearPassApiClient) ? (string)connectionInfo[ArubaClearPassConstants.Config.ClearPassApiClient] : string.Empty;
             if (string.IsNullOrWhiteSpace(apiClient))
             {
@@ -245,6 +266,13 @@ public Dictionary<string, PropertyConfigInfo> GetCAConnectorAnnotations()
                     Hidden = false,
                     DefaultValue = "",
                     Type = "String"
+                },
+                [ArubaClearPassConstants.Config.Enabled] = new PropertyConfigInfo() //No Call Available to get a list of the CAs with Ids in API so...
+                {
+                    Comments = "Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available.",
+                    Hidden = false,
+                    DefaultValue = true,
+                    Type = "Boolean"
                 }
             };
         }
@@ -280,5 +308,4 @@ Task<AnyCAPluginCertificate> IAnyCAPlugin.GetSingleRecord(string caRequestID)
         }
 
     }
-}
-
+}

aruba-clearpass-caplugin/ArubaClearPassConfig.cs

@@ -11,5 +11,6 @@ public ArubaClearPassConfig()
 		public string BaseUrl { get; set; }
 		public string ClearPassApiClient {  get; set; }
         public string ClearPassCaId { get; set; }
+		public bool Enabled { get; set; } = true;
     }
-}
+}

aruba-clearpass-caplugin/Constants.cs

@@ -8,6 +8,7 @@ public class Config
 			public const string ClearPassApiClient = "ClearPassApiClient";
 			public const string ClientSecret = "ClientSecret";
             public const string ClearPassCaId = "ClearPassCaId";
+            public const string Enabled = "Enabled";
 		}
 
         public class Products
@@ -24,4 +25,4 @@ public class ProductParams
             public const string NumberOfDaysValid = "NumberOfDaysValid";
         }
     }
-}
+}