Productsyncfilter

README.md

@@ -91,6 +91,7 @@ An API Key within your Digicert account that has the necessary permissions to en
         * **RevokeCertificateOnly** - Default DigiCert behavior on revocation requests is to revoke the entire order. If this value is changed to 'true', revocation requests will instead just revoke the individual certificate. 
         * **SyncCAFilter** - If you list one or more CA IDs here (comma-separated), the sync process will only sync records from those CAs. If you want to sync all CA IDs, leave this field empty. 
         * **SyncDivisionFilter** - If you list one or more Divison IDs (also known as Container IDs) here (comma-separated), the sync process will filter records to only return orders from those divisions. If you want to sync all divisions, leave this field empty. Note that this has no relationship to the value of the DivisionId config field. 
+        * **SyncProductFilter** - If you list one or more Product IDs here (comma-separated), the sync process will filter records to only return orders of those product types. Leave empty to sync all products. 
         * **FilterExpiredOrders** - If set to 'true', syncing will apply a filter to not return orders that are expired for longer than specified in SyncExpirationDays. 
         * **SyncExpirationDays** - If FilterExpiredOrders is set to true, this setting determines how many days in the past to still return expired orders. For example, a value of 30 means the sync will return any certs that expired within the past 30 days. A value of 0 means the sync will not return any certs that expired before the current day. This value is ignored if FilterExpiredOrders is false. 
         * **Enabled** - Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available. 

digicert-certcentral-caplugin/API/ListCertificateOrders.cs

@@ -29,7 +29,8 @@ public ListCertificateOrdersRequest(bool ignoreExpired = false)
 
 		public bool ignoreExpired { get; set; }
 		public int expiredWindow { get; set; } = 0;
-		public string divID { get; set; } = string.Empty;
+		public List<string> divIDs { get; set; } = new List<string>();
+		public List<string> productIDs { get; set; } = new List<string>();
 
 		public new string BuildParameters()
 		{
@@ -38,9 +39,13 @@ public ListCertificateOrdersRequest(bool ignoreExpired = false)
 			sbParamters.Append("limit=").Append(this.limit.ToString());
 			sbParamters.Append("&offset=").Append(HttpUtility.UrlEncode(this.offset.ToString()));
 
-			if (!string.IsNullOrEmpty(divID))
+			foreach (string divID in this.divIDs)
 			{
-				sbParamters.Append("&filters[container_id]=").Append(this.divID);
+				sbParamters.Append("&filters[container_id]=").Append(divID);
+			}
+			foreach (string productID in productIDs)
+			{
+				sbParamters.Append("&filters[product_name_id]=").Append(productID);
 			}
 			if (ignoreExpired)
 			{

digicert-certcentral-caplugin/CertCentralCAPlugin.cs

@@ -476,6 +476,13 @@ public Dictionary<string, PropertyConfigInfo> GetCAConnectorAnnotations()
 					DefaultValue = "",
 					Type = "String"
 				},
+				[CertCentralConstants.Config.SYNC_PROD_FILTER] = new PropertyConfigInfo()
+				{
+					Comments = "If you list one or more Product IDs here (comma-separated), the sync process will filter records to only return orders of those product types. Leave empty to sync all products.",
+					Hidden = false,
+					DefaultValue = "",
+					Type = "String"
+				},
 				[CertCentralConstants.Config.FILTER_EXPIRED] = new PropertyConfigInfo()
 				{
 					Comments = "If set to 'true', syncing will apply a filter to not return orders that are expired for longer than specified in SyncExpirationDays.",
@@ -834,12 +841,17 @@ public async Task Synchronize(BlockingCollection<AnyCAPluginCertificate> blockin
 
 			caList.ForEach(c => c.ToUpper());
 
-			List<string> divFilters = null;
+			List<string> divFilters = new List<string>();
 			if (!string.IsNullOrEmpty(_config.SyncDivisionFilter))
 			{
-				divFilters = new List<string>();
 				divFilters.AddRange(_config.SyncDivisionFilter.Split(','));
 			}
+			List<string> productFilters = new List<string>();
+			if (!string.IsNullOrEmpty(_config.SyncProductFilter))
+			{
+				_logger.LogTrace($"Sync Products: {_config.SyncProductFilter}");
+				productFilters = _config.SyncProducts;
+			}
 
 			if (fullSync)
 			{
@@ -857,37 +869,20 @@ public async Task Synchronize(BlockingCollection<AnyCAPluginCertificate> blockin
 				long starttime = time;
 				_logger.LogDebug($"SYNC: Starting sync at time {time}");
 				List<Order> allOrders = new List<Order>();
-				if (divFilters != null)
+
+				ListCertificateOrdersResponse ordersResponse = client.ListAllCertificateOrders(ignoreExpired, expiredWindow, divFilters, productFilters);
+				if (ordersResponse.Status == CertCentralBaseResponse.StatusType.ERROR)
 				{
-					foreach (string div in divFilters)
-					{
-						ListCertificateOrdersResponse ordersResponse = client.ListAllCertificateOrders(ignoreExpired, expiredWindow, div);
-						if (ordersResponse.Status == CertCentralBaseResponse.StatusType.ERROR)
-						{
-							Error error = ordersResponse.Errors[0];
-							_logger.LogError("Error in listing all certificate orders");
-							throw new Exception($"DigiCert CertCentral web service returned {error.code} - {error.message} when retrieving all rows");
-						}
-						else
-						{
-							allOrders.AddRange(ordersResponse.orders);
-						}
-					}
+					Error error = ordersResponse.Errors[0];
+					_logger.LogError("Error in listing all certificate orders");
+					throw new Exception($"DigiCert CertCentral web service returned {error.code} - {error.message} when retrieving all rows");
 				}
 				else
 				{
-					ListCertificateOrdersResponse ordersResponse = client.ListAllCertificateOrders(ignoreExpired, expiredWindow, null);
-					if (ordersResponse.Status == CertCentralBaseResponse.StatusType.ERROR)
-					{
-						Error error = ordersResponse.Errors[0];
-						_logger.LogError("Error in listing all certificate orders");
-						throw new Exception($"DigiCert CertCentral web service returned {error.code} - {error.message} when retrieving all rows");
-					}
-					else
-					{
-						allOrders.AddRange(ordersResponse.orders);
-					}
+					allOrders.AddRange(ordersResponse.orders);
 				}
+
+
 				_logger.LogDebug($"SYNC: Found {allOrders.Count} records");
 				foreach (var orderDetails in allOrders)
 				{
@@ -897,7 +892,7 @@ public async Task Synchronize(BlockingCollection<AnyCAPluginCertificate> blockin
 						cancelToken.ThrowIfCancellationRequested();
 						string caReqId = orderDetails.id + "-" + orderDetails.certificate.id;
 						_logger.LogDebug($"SYNC: Retrieving certs for order id {orderDetails.id}");
-						orderCerts = GetAllConnectorCertsForOrder(caReqId, caList, divFilters);
+						orderCerts = GetAllConnectorCertsForOrder(caReqId, caList, divFilters, productFilters);
 						if (orderCerts == null || orderCerts.Count == 0)
 						{
 							continue;
@@ -939,7 +934,7 @@ public async Task Synchronize(BlockingCollection<AnyCAPluginCertificate> blockin
 						{
 							cancelToken.ThrowIfCancellationRequested();
 							string caReqId = order.order_id + "-" + order.certificate_id;
-							orderCerts = GetAllConnectorCertsForOrder(caReqId, caList, divFilters);
+							orderCerts = GetAllConnectorCertsForOrder(caReqId, caList, divFilters, productFilters);
 							if (orderCerts == null || orderCerts.Count > 0)
 							{
 								continue;
@@ -1639,7 +1634,7 @@ string FormatSyncDate(DateTime? syncTime)
 		/// </summary>
 		/// <param name="caRequestID"></param>
 		/// <returns></returns>
-		private List<AnyCAPluginCertificate> GetAllConnectorCertsForOrder(string caRequestID, List<string> caFilterIds, List<string> divIds)
+		private List<AnyCAPluginCertificate> GetAllConnectorCertsForOrder(string caRequestID, List<string> caFilterIds, List<string> divIds, List<string> productIds)
 		{
 			_logger.MethodEntry(LogLevel.Trace);
 			// Split ca request id into order and cert id
@@ -1662,6 +1657,10 @@ private List<AnyCAPluginCertificate> GetAllConnectorCertsForOrder(string caReque
 				_logger.LogTrace($"Found order ID {orderId} that does not match Division filter. Division ID: {orderResponse.container.Id.ToString()} Skipping...");
 				return null;
 			}
+			if (productIds != null && productIds.Count > 0 && !productIds.Contains(orderResponse.product.name_id.ToString()))
+			{
+				_logger.LogTrace($"Found order ID {orderId} that does not match Product filter. Product ID: {orderResponse.product.name_id.ToString()} Skipping...");
+			}
 
 			var orderCerts = GetAllCertsForOrder(orderId);
 

digicert-certcentral-caplugin/CertCentralConfig.cs

@@ -33,6 +33,21 @@ public List<string> SyncCAs
 				}	
 			}
 		}
+		public string SyncProductFilter { get; set; }
+		public List<string> SyncProducts
+		{
+			get
+			{
+				if (!string.IsNullOrEmpty(SyncProductFilter))
+				{
+					return SyncProductFilter.Split(",").ToList();
+				}
+				else
+				{
+					return new List<string>();
+				}
+			}
+		}
 
 		public bool? FilterExpiredOrders { get; set; }
 		public int? SyncExpirationDays { get; set; }

digicert-certcentral-caplugin/Client/CertCentralClient.cs

@@ -97,7 +97,7 @@
 
 				Logger.LogTrace($"Entered CertCentral Request (ID: {reqID}) Method: {request.Method} - URL: {targetURI}");
 
 				HttpWebRequest objRequest = (HttpWebRequest)WebRequest.Create(targetURI);
 				objRequest.Method = request.Method;
 				objRequest.Headers.Add("X-DC-DEVKEY", this.CertCentralCreds.APIKey);
 
@@ -148,13 +148,13 @@
 				}
 				else
 				{
 					Logger.LogDebug("CertCentral Response Error", wex);
 					throw new Exception("Unable to establish connection to CertCentral web service", wex);
 				}
 			}
 			catch (Exception ex)
 			{
 				Logger.LogError("CertCentral Response Error", ex);
 				throw new Exception("Unable to establish connection to CertCentral web service", ex);
 			}
 
@@ -523,7 +523,7 @@
 			return dlCertificateRequestResponse;
 		}
 
-		public ListCertificateOrdersResponse ListAllCertificateOrders(bool ignoreExpired = false, int expiredWindow = 0, string divId = "")
+		public ListCertificateOrdersResponse ListAllCertificateOrders(bool ignoreExpired, int expiredWindow, List<string> divIds, List<string> productIds)
 		{
 			int batch = 1000;
 			ListCertificateOrdersResponse totalResponse = new ListCertificateOrdersResponse();
@@ -536,7 +536,8 @@
 					offset = totalResponse.orders.Count,
 					ignoreExpired = ignoreExpired,
 					expiredWindow = expiredWindow,
-					divID = divId
+					divIDs = divIds,
+					productIDs = productIds
 				};
 
 				CertCentralResponse response = Request(request, request.BuildParameters());

digicert-certcentral-caplugin/Constants.cs

@@ -30,6 +30,7 @@ public class Config
 			public const string ENABLED = "Enabled";
 			public const string SYNC_CA_FILTER = "SyncCAFilter";
 			public const string SYNC_DIV_FILTER = "SyncDivisionFilter";
+			public const string SYNC_PROD_FILTER = "SyncProductFilter";
 			public const string FILTER_EXPIRED = "FilterExpiredOrders";
 			public const string SYNC_EXPIRATION_DAYS = "SyncExpirationDays";
 			public const string CERT_TYPE = "CertType";

integration-manifest.json

@@ -38,6 +38,10 @@
                     "name": "SyncDivisionFilter",
                     "description": "If you list one or more Divison IDs (also known as Container IDs) here (comma-separated), the sync process will filter records to only return orders from those divisions. If you want to sync all divisions, leave this field empty. Note that this has no relationship to the value of the DivisionId config field."
                 },
+                {
+                    "name": "SyncProductFilter",
+                    "description": "If you list one or more Product IDs here (comma-separated), the sync process will filter records to only return orders of those product types. Leave empty to sync all products."
+                },
                 {
                     "name": "FilterExpiredOrders",
                     "description": "If set to 'true', syncing will apply a filter to not return orders that are expired for longer than specified in SyncExpirationDays."