regscale-cli 6.18.0.0__py3-none-any.whl → 6.19.0.1__py3-none-any.whl

regscale/integrations/scanner_integration.py

@@ -50,11 +50,11 @@ def get_thread_workers_max() -> int:
 def issue_due_date(
     severity: regscale_models.IssueSeverity,
     created_date: str,
-    critical: int = ScannerVariables.issueDueDates.get("critical", 30),
-    high: int = ScannerVariables.issueDueDates.get("high", 60),
-    moderate: int = ScannerVariables.issueDueDates.get("moderate", 120),
-    low: int = ScannerVariables.issueDueDates.get("low", 364),
-    title: str = "",
+    critical: Optional[int] = None,
+    high: Optional[int] = None,
+    moderate: Optional[int] = None,
+    low: Optional[int] = None,
+    title: Optional[str] = "",
     config: Optional[Dict[str, Dict]] = None,
 ) -> str:
     """
@@ -62,15 +62,24 @@ def issue_due_date(
 
     :param regscale_models.IssueSeverity severity: The severity of the issue.
     :param str created_date: The creation date of the issue.
-    :param int critical: Days until due for high severity issues. Default is 30.
-    :param int high: Days until due for high severity issues. Default is 60.
-    :param int moderate: Days until due for moderate severity issues. Default is 210.
-    :param int low: Days until due for low severity issues. Default is 364.
-    :param str title: The title of the Integration.
-    :param Dict[str, Dict] config: Configuration options for the due date calculation.
+    :param Optional[int] critical: Days until due for high severity issues.
+    :param Optional[int] high: Days until due for high severity issues.
+    :param Optional[int] moderate: Days until due for moderate severity issues.
+    :param Optional[int] low: Days until due for low severity issues.
+    :param Optional[str] title: The title of the Integration.
+    :param Optional[Dict[str, Dict]] config: Configuration options for the due date calculation.
     :return: The due date for the issue.
     :rtype: str
     """
+    if critical is None:
+        critical = ScannerVariables.issueDueDates.get("critical", 30)
+    if high is None:
+        high = ScannerVariables.issueDueDates.get("high", 60)
+    if moderate is None:
+        moderate = ScannerVariables.issueDueDates.get("moderate", 120)
+    if low is None:
+        low = ScannerVariables.issueDueDates.get("low", 364)
+
     if config is None:
         config = {}
 
@@ -452,6 +461,21 @@ class IntegrationFinding:
     vpr_score: Optional[float] = None
 
     def __post_init__(self):
+        """Validate and adjust types after initialization."""
+        # Set default date values if empty
+        if not self.first_seen:
+            self.first_seen = get_current_datetime()
+        if not self.last_seen:
+            self.last_seen = get_current_datetime()
+        if not self.scan_date:
+            self.scan_date = get_current_datetime()
+
+        # Validate the values of the dataclass
+        if not self.title:
+            self.title = "Unknown Issue"
+        if not self.description:
+            self.description = "No description provided"
+
         if self.plugin_name is None:
             self.plugin_name = self.cve or self.title
         if self.plugin_id is None:
@@ -593,7 +617,7 @@ class ScannerIntegration(ABC):
     # Close Outdated Findings
     close_outdated_findings = True
 
-    def __init__(self, plan_id: int, tenant_id: int = 1, **kwargs):
+    def __init__(self, plan_id: int, tenant_id: int = 1, is_component: bool = False, **kwargs):
         """
         Initialize the ScannerIntegration.
 
@@ -607,6 +631,7 @@ class ScannerIntegration(ABC):
         logger.debug(f"RegScale Version: {self.regscale_version}")
         self.plan_id: int = plan_id
         self.tenant_id: int = tenant_id
+        self.is_component: bool = is_component
         self.components: ThreadSafeList[Any] = ThreadSafeList()
         self.asset_map_by_identifier: ThreadSafeDict[str, regscale_models.Asset] = ThreadSafeDict()
         self.software_to_create: ThreadSafeList[regscale_models.SoftwareInventory] = ThreadSafeList()
@@ -759,7 +784,9 @@ class ScannerIntegration(ABC):
         """
         if self.options_map_assets_to_components:
             # Fetches the asset map directly using a specified key field.
-            return regscale_models.Asset.get_map(plan_id=self.plan_id, key_field=self.asset_identifier_field)
+            return regscale_models.Asset.get_map(
+                plan_id=self.plan_id, key_field=self.asset_identifier_field, is_component=self.is_component
+            )
         else:
             # Constructs the asset map by fetching all assets under the plan and using the asset identifier field as
             # the key.
@@ -767,10 +794,27 @@ class ScannerIntegration(ABC):
                 getattr(x, self.asset_identifier_field): x
                 for x in regscale_models.Asset.get_all_by_parent(
                     parent_id=self.plan_id,
-                    parent_module=regscale_models.SecurityPlan.get_module_string(),
+                    parent_module=(
+                        regscale_models.Component.get_module_string()
+                        if self.is_component
+                        else regscale_models.SecurityPlan.get_module_string()
+                    ),
                 )
             }
 
+    def get_issues_map(self) -> dict[int, regscale_models.Issue]:
+        """
+        Gets the issues map
+
+        :return: The issues map
+        :rtype: dict[int, regscale_models.Issue]
+        """
+        all_issues = regscale_models.Issue.get_all_by_parent(
+            parent_id=self.plan_id,
+            parent_module=regscale_models.SecurityPlan.get_module_string(),
+        )
+        return {issue.integrationFindingId: issue for issue in all_issues}
+
     @abstractmethod
     def fetch_findings(self, *args, **kwargs) -> Iterator[IntegrationFinding]:
         """
@@ -882,10 +926,17 @@ class ScannerIntegration(ABC):
         """
         if any(self.components):
             return self.components
-        components: List[regscale_models.Component] = regscale_models.Component.get_all_by_parent(
-            parent_id=self.plan_id,
-            parent_module=regscale_models.SecurityPlan.get_module_string(),
-        )
+        if self.is_component:
+            components: List[regscale_models.Component] = [
+                regscale_models.Component.get_object(
+                    object_id=self.plan_id,
+                )
+            ]
+        else:
+            components: List[regscale_models.Component] = regscale_models.Component.get_all_by_parent(
+                parent_id=self.plan_id,
+                parent_module=regscale_models.SecurityPlan.get_module_string(),
+            )
         self.components = ThreadSafeList(components)
         return self.components
 
@@ -986,7 +1037,7 @@ class ScannerIntegration(ABC):
                     componentOwnerId=self.get_assessor_id(),
                 ).get_or_create()
                 self.components.append(component)
-            if component.securityPlansId:
+            if component.securityPlansId and not self.is_component:
                 component_mapping = regscale_models.ComponentMapping(
                     componentId=component.id,
                     securityPlanId=self.plan_id,
@@ -1038,7 +1089,7 @@ class ScannerIntegration(ABC):
             parentId=component.id if component else self.plan_id,
             parentModule=(
                 regscale_models.Component.get_module_string()
-                if component
+                if component or self.is_component
                 else regscale_models.SecurityPlan.get_module_string()
             ),
             assetType=asset.asset_type,
@@ -1222,6 +1273,10 @@ class ScannerIntegration(ABC):
         assets_processed = self._process_assets(assets, loading_assets)
 
         self._perform_batch_operations(self.asset_progress)
+        if self.num_assets_to_process and self.asset_progress.tasks[loading_assets].completed != float(
+            self.num_assets_to_process
+        ):
+            self.asset_progress.update(loading_assets, completed=self.num_assets_to_process)
 
         return assets_processed
 
@@ -1537,7 +1592,11 @@ class ScannerIntegration(ABC):
 
         # Update all fields
         issue.parentId = self.plan_id
-        issue.parentModule = regscale_models.SecurityPlan.get_module_string()
+        issue.parentModule = (
+            regscale_models.Component.get_module_string()
+            if self.is_component
+            else regscale_models.SecurityPlan.get_module_string()
+        )
         issue.vulnerabilityId = finding.vulnerability_id
         issue.title = issue_title
         issue.dateCreated = finding.date_created
@@ -1549,7 +1608,7 @@ class ScannerIntegration(ABC):
         )
         issue.severityLevel = finding.severity
         issue.issueOwnerId = self.assessor_id
-        issue.securityPlanId = self.plan_id
+        issue.securityPlanId = self.plan_id if not self.is_component else None
         issue.identification = "Vulnerability Assessment"
         issue.dateFirstDetected = finding.first_seen
         issue.dueDate = finding.due_date
@@ -1907,6 +1966,15 @@ class ScannerIntegration(ABC):
             self.log_error("1. Asset not found for identifier %s", identifier)
         return asset
 
+    def get_issue_by_integration_finding_id(self, integration_finding_id: str) -> Optional[regscale_models.Issue]:
+        """
+        Gets an issue by its integration finding ID
+
+        :param str integration_finding_id: The integration finding ID
+        :return: The issue
+        """
+        return self.issues_map.get(integration_finding_id)
+
     def process_checklist(self, finding: IntegrationFinding) -> int:
         """
         Processes a single checklist item based on the provided finding.
@@ -2103,7 +2171,11 @@ class ScannerIntegration(ABC):
         """
         scan_history = regscale_models.ScanHistory(
             parentId=self.plan_id,
-            parentModule=regscale_models.SecurityPlan.get_module_string(),
+            parentModule=(
+                regscale_models.Component.get_module_string()
+                if self.is_component
+                else regscale_models.SecurityPlan.get_module_string()
+            ),
             scanningTool=self.title,
             scanDate=self.scan_date if self.scan_date else get_current_datetime(),
             createdById=self.assessor_id,
@@ -2224,7 +2296,11 @@ class ScannerIntegration(ABC):
             description=finding.description,
             dateLastUpdated=finding.date_last_updated,
             parentId=self.plan_id,
-            parentModule=regscale_models.SecurityPlan.get_module_string(),
+            parentModule=(
+                regscale_models.Component.get_module_string()
+                if self.is_component
+                else regscale_models.SecurityPlan.get_module_string()
+            ),
             dns=asset.fqdn or "unknown",
             status=regscale_models.VulnerabilityStatus.Open,
             ipAddress=finding.ip_address or asset.ipAddress or "",
@@ -2253,7 +2329,7 @@ class ScannerIntegration(ABC):
             vulnerabilityId=vulnerability.id,
             assetId=asset.id,
             scanId=scan_history.id,
-            securityPlansId=self.plan_id,
+            securityPlansId=self.plan_id if not self.is_component else None,
             createdById=self.assessor_id,
             tenantsId=self.tenant_id,
             isPublic=True,
@@ -2712,7 +2788,7 @@ class ScannerIntegration(ABC):
         APIHandler().log_api_summary()
         created_count = instance._results.get("assets", {}).get("created_count", 0)
         updated_count = instance._results.get("assets", {}).get("updated_count", 0)
-        dedupe_count = assets_processed - (created_count + updated_count)
+        dedupe_count = (instance.num_assets_to_process or assets_processed) - (created_count + updated_count)
         # Ensure dedupe_count is always a positive value
         dedupe_count = dedupe_count if dedupe_count >= 0 else dedupe_count * -1
         logger.info(

regscale/integrations/transformer/__init__.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Transformer package for RegScale integrations.
+
+This package provides data transformation capabilities for RegScale integrations,
+enabling the conversion of external data formats into IntegrationAsset and
+IntegrationFinding objects.
+"""
+
+from regscale.integrations.transformer.data_transformer import DataTransformer, DataMapping, TENABLE_SC_MAPPING
+
+__all__ = [
+    "DataTransformer",
+    "DataMapping",
+    "TENABLE_SC_MAPPING",
+]