regscale-cli 6.16.0.0__py3-none-any.whl → 6.16.2.0__py3-none-any.whl

regscale/integrations/public/fedramp/fedramp_common.py

@@ -1878,11 +1878,11 @@ def check_control_list_length(ssp_obj: SSP, mapping: dict) -> Optional[list]:
         return missing_controls
 
 
-def log_controls_info(ssp_obj: dict, current_imps: List[dict]) -> None:
+def log_controls_info(ssp_obj: SSP, current_imps: List[dict]) -> None:
     """
     Log controls info
 
-    :param dict ssp_obj: SSP object
+    :param SSP ssp_obj: SSP object
     :param List[dict] current_imps: List of current implementations
     :return None:
     :rtype None:
@@ -2305,8 +2305,8 @@ def fetch_existing_stakeholders(api: Api, config: dict, regscale_ssp: dict) -> l
     if response.ok:
         logger.info(
             f"Found {len(response.json())} existing stakeholders",
-            record_type="stackholders",
-            model_layer="stackholders",
+            record_type="stakeholders",
+            model_layer="stakeholders",
         )
         return response.json()
     return []

regscale/integrations/public/fedramp/import_workbook.py

@@ -217,7 +217,7 @@ def map_inventory_to_asset(
             "ram": 0,
             "diskStorage": 0,
             "description": "",
-            "endOfLifeDate": date_str(mapping.get_value(inventory, "End-of-Life ", "", warnings=False)),
+            "endOfLifeDate": date_str(mapping.get_value(inventory, "End-of-Life ", "")),
             "purchaseDate": None,
             "status": "Active (On Network)",
             "wizId": "",

regscale/integrations/public/fedramp/inventory_items.py

@@ -59,7 +59,7 @@ def get_dict_value(outer_key: str, inner_key: str, source_dict: Dict) -> Optiona
     outer_dict = source_dict.get(outer_key, None)
     if outer_dict is not None and isinstance(outer_dict, dict):
         val = outer_dict.get(inner_key, None)
-        logger.info(f"{val}")
+        logger.debug(f"{val=}")
         return val
     return None
 
@@ -205,8 +205,8 @@ def parse_inventory_items(trv: FedrampTraversal, components_dict: Dict):
 
                 for imp_component in implemented_components:
                     if not isinstance(components_dict, dict):
-                        logger.info(components_dict)
-                        logger.info("components do not exist yet")
+                        logger.debug(components_dict)
+                        logger.info("Components do not exist yet.")
                         continue
                     comp = components_dict.get(imp_component.get("component_uuid"))
                     comp_id = comp.get("id") if comp else None

regscale/integrations/public/fedramp/poam/scanner.py

@@ -4,7 +4,10 @@
 
 import logging
 import re
-from typing import Iterator, List, Optional
+from typing import Iterator, List, Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    import numpy
 
 from openpyxl import load_workbook  # type: ignore
 from openpyxl.utils import column_index_from_string  # type: ignore
@@ -25,6 +28,14 @@ from regscale.validation.address import validate_ip_address, validate_mac_addres
 
 logger = logging.getLogger("regscale")
 
+WEAKNESS_DETECTOR_SOURCE = "Weakness Detector Source"
+ASSET_IDENTIFIER = "Asset Identifier"
+SCHEDULED_COMPLETION_DATE = "Scheduled Completion Date"
+MILESTONE_CHANGES = "Milestone Changes"
+ORIGINAL_RISK_RATING = "Original Risk Rating"
+ADJUSTED_RISK_RATING = "Adjusted Risk Rating"
+FILE_PATH_ERROR = "File path is required."
+
 
 class FedrampPoamIntegration(ScannerIntegration):
     """Integration class for FedRAMP POAM scanning."""
@@ -50,40 +61,43 @@ class FedrampPoamIntegration(ScannerIntegration):
     skipped_records: int = 0
     processed_assets: set[str] = set()  # Track processed assets across all methods
 
-    # TODO: Pair this down to only usable data
     fedramp_poam_columns = [
         "POAM ID",
         "Weakness Name",
         "Weakness Description",
-        "Weakness Detector Source",
+        WEAKNESS_DETECTOR_SOURCE,
         "Weakness Source Identifier",
-        "Asset Identifier",
+        ASSET_IDENTIFIER,
         "Point of Contact",
         "Resources Required",
         "Overall Remediation Plan",
         "Original Detection Date",
-        "Scheduled Completion Date",
+        SCHEDULED_COMPLETION_DATE,
         "Planned Milestones",
-        "Milestone Changes",
+        MILESTONE_CHANGES,
         "Status Date",
-        # "Vendor Dependency",
-        # "Last Vendor Check-in Date",
-        # "Vendor Dependent Product Name",
-        "Original Risk Rating",
-        "Adjusted Risk Rating",
+        ORIGINAL_RISK_RATING,
+        ADJUSTED_RISK_RATING,
         "Risk Adjustment",
         "False Positive",
         "Operational Requirement",
         "Deviation Rationale",
-        # "Supporting Documents",
         "Comments",
-        # "Auto-Approve",
-        # "Binding Operational Directive 22-01 tracking",
-        # "Binding Operational Directive 22-01 Due Date",
-        # "CVE",
-        # "Service Name",
     ]
 
+    """
+    Unused columns:
+    # "Vendor Dependency",
+    # "Last Vendor Check-in Date",
+    # "Vendor Dependent Product Name",
+    # "Supporting Documents",
+    # "Auto-Approve",
+    # "Binding Operational Directive 22-01 tracking",
+    # "Binding Operational Directive 22-01 Due Date",
+    # "CVE",
+    # "Service Name",
+    """
+
     def __init__(self, plan_id: int, **kwargs: dict):
         super().__init__(plan_id=plan_id)
         try:
@@ -91,7 +105,7 @@ class FedrampPoamIntegration(ScannerIntegration):
             if "file_path" in kwargs:
                 self.file_path = kwargs["file_path"]
             if not self.file_path:
-                raise ValueError("File path is required")
+                error_and_exit(FILE_PATH_ERROR)
             self.workbook = self.workbook or load_workbook(filename=self.file_path, data_only=True, read_only=True)
             self.poam_sheets = kwargs.get("poam_sheets") or [
                 sheet for sheet in self.workbook.sheetnames if re.search("POA&M Items", sheet)
@@ -130,11 +144,10 @@ class FedrampPoamIntegration(ScannerIntegration):
         """
         Fetches findings from FedRAMP POAM files.
 
-        :raises ValueError: If file path is not set
         :yield: Iterator of validated integration findings
         """
         if not self.file_path:
-            raise ValueError("File path is required")
+            error_and_exit(FILE_PATH_ERROR)
 
         findings = []
         try:
@@ -256,7 +269,7 @@ class FedrampPoamIntegration(ScannerIntegration):
             "critical": IssueSeverity.High.name,
             "low": IssueSeverity.Low.name,
         }
-        res = validator.mapping.get_value(data, "Original Risk Rating")
+        res = validator.mapping.get_value(data, ORIGINAL_RISK_RATING)
         if res.lower() not in [mem.lower() for mem in IssueSeverity.__members__]:
             res = dat_map.get(res.lower(), IssueSeverity.Low.name)
         return res
@@ -345,7 +358,7 @@ class FedrampPoamIntegration(ScannerIntegration):
                 plugin_id_int = abs(hash(poam_id)) % (10**9)
 
             # Get asset identifiers
-            asset_ids = val_mapping.get_value(data, "Asset Identifier")
+            asset_ids = val_mapping.get_value(data, ASSET_IDENTIFIER)
             if not asset_ids:
                 logger.warning(f"No asset identifier found on row {index}, sheet {sheet}. Skipping.")
                 yield from findings
@@ -374,8 +387,8 @@ class FedrampPoamIntegration(ScannerIntegration):
                         date_str(val_mapping.get_value(data, "Original Detection Date")) or get_current_datetime()
                     )
                     due_date = date_str(
-                        val_mapping.get_value(data, "Scheduled Completion Date")
-                        if val_mapping.get_value(data, "Scheduled Completion Date") != "#REF!"
+                        val_mapping.get_value(data, SCHEDULED_COMPLETION_DATE)
+                        if val_mapping.get_value(data, SCHEDULED_COMPLETION_DATE) != "#REF!"
                         else ""
                     )
                     severity: IssueSeverity = getattr(IssueSeverity, category.title(), IssueSeverity.NotAssigned)
@@ -408,18 +421,18 @@ class FedrampPoamIntegration(ScannerIntegration):
                         date_last_updated=status_date,
                         due_date=due_date,
                         cve=cve,  # Single CVE per finding
-                        plugin_name=val_mapping.get_value(data, "Weakness Detector Source") or "",
+                        plugin_name=val_mapping.get_value(data, WEAKNESS_DETECTOR_SOURCE) or "",
                         plugin_id=str(unique_plugin_id),
-                        observations=str(val_mapping.get_value(data, "Milestone Changes")) or "",
+                        observations=str(val_mapping.get_value(data, MILESTONE_CHANGES)) or "",
                         poam_comments=self.empty(val_mapping.get_value(data, "Comments")),
                         remediation=self.empty(val_mapping.get_value(data, "Overall Remediation Plan")),
                         basis_for_adjustment=str(self.get_basis_for_adjustment(val_mapping=val_mapping, data=data)),
                         vulnerability_type="FedRAMP",
-                        source_report=str(val_mapping.get_value(data, "Weakness Detector Source")),
+                        source_report=str(val_mapping.get_value(data, WEAKNESS_DETECTOR_SOURCE)),
                         point_of_contact=str(val_mapping.get_value(data, "Point of Contact")),
-                        milestone_changes=str(val_mapping.get_value(data, "Milestone Changes")),
+                        milestone_changes=str(val_mapping.get_value(data, MILESTONE_CHANGES)),
                         planned_milestone_changes=str(val_mapping.get_value(data, "Planned Milestones")),
-                        adjusted_risk_rating=val_mapping.get_value(data, "Adjusted Risk Rating"),
+                        adjusted_risk_rating=val_mapping.get_value(data, ADJUSTED_RISK_RATING),
                         risk_adjustment=self.determine_risk_adjustment(val_mapping.get_value(data, "Risk Adjustment")),
                         operational_requirements=str(val_mapping.get_value(data, "Operational Requirement")),
                         deviation_rationale=str(val_mapping.get_value(data, "Deviation Rationale")),
@@ -452,7 +465,7 @@ class FedrampPoamIntegration(ScannerIntegration):
         res = date_str(status_map.get(resolve_status), "%m-%d-%Y")
         if res:
             logger.warning(
-                f"Status Date missing on row %i, sheet %s, defaulting to %s: %s",
+                "Status Date missing on row %i, sheet %s, defaulting to %s: %s",
                 index,
                 sheet,
                 resolve_status.lower().replace("_", " "),
@@ -482,7 +495,7 @@ class FedrampPoamIntegration(ScannerIntegration):
             else:
                 logger.error("Validator mapping is None")
                 return row_assets
-            asset_ids = val_mapping.get_value(data, "Asset Identifier")
+            asset_ids = val_mapping.get_value(data, ASSET_IDENTIFIER)
             if not asset_ids:
                 return row_assets
             asset_id_list = self.gen_asset_list(asset_ids)
@@ -643,8 +656,8 @@ class FedrampPoamIntegration(ScannerIntegration):
         :rtype: Optional[str]
         """
         basis_for_adjustment = self.empty(val_mapping.get_value(data, "Comments"))  # e.g. row 23
-        risk_rating = val_mapping.get_value(data, "Original Risk Rating")
-        adjusted_risk_rating = val_mapping.get_value(data, "Adjusted Risk Rating")
+        risk_rating = val_mapping.get_value(data, ORIGINAL_RISK_RATING)
+        adjusted_risk_rating = val_mapping.get_value(data, ADJUSTED_RISK_RATING)
 
         if (adjusted_risk_rating != risk_rating) and not basis_for_adjustment:
             return "POAM Import"
@@ -745,19 +758,12 @@ class FedrampPoamIntegration(ScannerIntegration):
         """
         Fetch assets from FedRAMP POAM files.
 
-        Args:
-            *args: Variable length argument list
-            **kwargs: Arbitrary keyword arguments
-
-        Returns:
-            Iterator[IntegrationAsset]: Iterator of parsed integration assets
-
-        Raises:
-            ValueError: If file_path is not set
-            POAMProcessingError: If there's an error processing the POAM file
+        :raises POAMProcessingError: If there's an error processing the POAM file
+        :return: Iterator of parsed integration assets
+        :rtype: Iterator[IntegrationAsset]
         """
         if not self.file_path:
-            raise ValueError("File path is required")
+            error_and_exit(FILE_PATH_ERROR)
 
         assets = []
         total_processed = 0
@@ -808,6 +814,7 @@ class FedrampPoamIntegration(ScannerIntegration):
         finally:
             logger.info(f"Completed processing with {total_processed} assets and {self.error_records} errors")
 
+        self.num_assets_to_process = len(assets)
         return iter(assets)
 
     def find_max_row(self, start_row: int, ws: Worksheet) -> int:

regscale/integrations/public/fedramp/ssp_logger.py

@@ -8,23 +8,22 @@ import logging
 from regscale.core.app.logz import create_logger
 
 
-class CaptureEventsHandler:
+class CaptureEventsHandler(logging.Handler):
     def __init__(self, events, errors, infos):
-        self.handler = logging.Handler()
         self.events = events
         self.errors = errors
         self.infos = infos
+        super().__init__()
 
     def emit(self, record):
-        self.handler.emit(record)
         try:
-            log_entry = self.handler.format(record)
+            log_entry = self.format(record)
             if record.levelname == "INFO":
                 self.events.append(log_entry)
             elif record.levelname == "ERROR":
                 self.errors.append(log_entry)
         except Exception:
-            self.handler.handleError(record)
+            self.handleError(record)
 
 
 class SSPLogger:
@@ -33,7 +32,8 @@ class SSPLogger:
         self.errors = []
         self.infos = []
         self.capture_handler = CaptureEventsHandler(self.events, self.errors, self.infos)
-        self.logger = create_logger(custom_handler=self.capture_handler)
+        logger = create_logger(custom_handler=self.capture_handler)
+        self.logger = logger
 
     def create_logger(self):
         return self.logger