devsecops-engine-tools 1.30.2__tar.gz → 1.31.0__tar.gz

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devsecops-engine-tools
-Version: 1.30.2
+Version: 1.31.0
 Summary: Tool for DevSecOps strategy
 Home-page: https://github.com/bancolombia/devsecops-engine-tools
 Author: Bancolombia DevSecOps Team
@@ -36,6 +36,7 @@ Requires-Dist: packageurl-python==0.15.6
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bancolombia_devsecops-engine-tools&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=bancolombia_devsecops-engine-tools)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=bancolombia_devsecops-engine-tools&metric=coverage)](https://sonarcloud.io/summary/new_code?id=bancolombia_devsecops-engine-tools)
 [![Python Version](https://img.shields.io/badge/python%20-%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20-blue)](#)
+[![PyPI](https://img.shields.io/pypi/v/devsecops-engine-tools)](https://pypi.org/project/devsecops-engine-tools/)
 [![Docker Pulls](https://img.shields.io/docker/pulls/bancolombia/devsecops-engine-tools
 )](https://hub.docker.com/r/bancolombia/devsecops-engine-tools)
 

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/devsecops_engine_tools/engine_core/src/infrastructure/driven_adapters/defect_dojo/defect_dojo.py

@@ -13,6 +13,7 @@ from devsecops_engine_tools.engine_utilities.defect_dojo import (
     Engagement,
     Product,
     Component,
+    FindingExclusion
 )
 from devsecops_engine_tools.engine_core.src.domain.model.exclusions import Exclusions
 from devsecops_engine_tools.engine_core.src.domain.model.report import Report
@@ -42,9 +43,11 @@ logger = MyLogger.__call__(**settings.SETTING_LOGGER).get_logger()
 @dataclass
 class DefectDojoPlatform(VulnerabilityManagementGateway):
 
+    RISK_ACCEPTED = "Risk Accepted"
     OUT_OF_SCOPE = "Out of Scope"
     FALSE_POSITIVE = "False Positive"
     TRANSFERRED_FINDING = "Transferred Finding"
+    ON_WHITELIST = "On Whitelist"
 
     def send_vulnerability_management(
         self, vulnerability_management: VulnerabilityManagement
@@ -203,6 +206,11 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
                 "tags": tool,
                 "limit": dd_limits_query,
             }
+            white_list_query_params = {
+                "risk_status": self.ON_WHITELIST,
+                "tags": tool,
+                "limit": dd_limits_query,
+            }
 
             exclusions_risk_accepted = self._get_findings_with_exclusions(
                 session_manager,
@@ -211,7 +219,7 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
                 risk_accepted_query_params,
                 tool,
                 self._format_date_to_dd_format,
-                "Risk Accepted",
+                self.RISK_ACCEPTED,
             )
 
             exclusions_false_positive = self._get_findings_with_exclusions(
@@ -244,11 +252,29 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
                 self.TRANSFERRED_FINDING,
             )
 
+            white_list = self._get_finding_exclusion(
+                session_manager, dd_max_retries, {
+                    "type": "white_list",
+                }
+            )
+
+            exclusions_white_list = self._get_findings_with_exclusions(
+                session_manager,
+                service,
+                dd_max_retries,
+                white_list_query_params,
+                tool,
+                self._format_date_to_dd_format,
+                self.ON_WHITELIST,
+                white_list=white_list,
+            )
+
             return (
                 list(exclusions_risk_accepted)
                 + list(exclusions_false_positive)
                 + list(exclusions_out_of_scope)
                 + list(exclusions_transfer_finding)
+                + list(exclusions_white_list)
             )
         except Exception as ex:
             raise ExceptionFindingsExcepted(
@@ -272,8 +298,10 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
                 "HOST_DEFECT_DOJO"
             ]
 
+            session_manager = self._get_session_manager(dict_args, secret_tool, config_tool)
+
             findings = self._get_findings(
-                self._get_session_manager(dict_args, secret_tool, config_tool),
+                session_manager,
                 service,
                 max_retries,
                 all_findings_query_params,
@@ -286,8 +314,14 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
                 )
             )
 
+            white_list = self._get_finding_exclusion(
+                session_manager, max_retries, {
+                    "type": "white_list",
+                }
+            )
+
             all_exclusions = self._get_report_exclusions(
-                all_findings, self._format_date_to_dd_format, host_dd=host_dd
+                all_findings, self._format_date_to_dd_format, host_dd=host_dd, white_list=white_list
             )
 
             return all_findings, all_exclusions
@@ -461,25 +495,25 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
             config_tool["VULNERABILITY_MANAGER"]["DEFECT_DOJO"]["HOST_DEFECT_DOJO"],
         )
 
-    def _get_report_exclusions(self, total_findings, date_fn, host_dd):
+    def _get_report_exclusions(self, total_findings, date_fn, host_dd, **kwargs):
         exclusions = []
         for finding in total_findings:
             if finding.risk_accepted:
                 exclusions.append(
                     self._create_report_exclusion(
-                        finding, date_fn, "engine_risk", "Risk Accepted", host_dd
+                        finding, date_fn, "engine_risk", self.RISK_ACCEPTED, host_dd, **kwargs
                     )
                 )
             elif finding.false_p:
                 exclusions.append(
                     self._create_report_exclusion(
-                        finding, date_fn, "engine_risk", self.FALSE_POSITIVE, host_dd
+                        finding, date_fn, "engine_risk", self.FALSE_POSITIVE, host_dd, **kwargs
                     )
                 )
             elif finding.out_of_scope:
                 exclusions.append(
                     self._create_report_exclusion(
-                        finding, date_fn, "engine_risk", self.OUT_OF_SCOPE, host_dd
+                        finding, date_fn, "engine_risk", self.OUT_OF_SCOPE, host_dd, **kwargs
                     )
                 )
             elif finding.risk_status == "Transfer Accepted":
@@ -490,18 +524,26 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
                         "engine_risk",
                         self.TRANSFERRED_FINDING,
                         host_dd,
+                        **kwargs
+                    )
+                )
+            elif finding.risk_status == self.ON_WHITELIST:
+                exclusions.append(
+                    self._create_report_exclusion(
+                        finding, date_fn, "engine_risk", self.ON_WHITELIST, host_dd, **kwargs
                     )
                 )
         return exclusions
 
     def _get_findings_with_exclusions(
-        self, session_manager, service, max_retries, query_params, tool, date_fn, reason
+        self, session_manager, service, max_retries, query_params, tool, date_fn, reason, **kwargs
     ):
         findings = self._get_findings(
             session_manager, service, max_retries, query_params
         )
+
         return map(
-            partial(self._create_exclusion, date_fn=date_fn, tool=tool, reason=reason),
+            partial(self._create_exclusion, date_fn=date_fn, tool=tool, reason=reason, **kwargs),
             findings,
         )
 
@@ -512,6 +554,14 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
             ).results
 
         return self._retries_requests(request_func, max_retries, retry_delay=5)
+    
+    def _get_finding_exclusion(self, session_manager, max_retries, query_params):
+        def request_func():
+            return FindingExclusion.get_finding_exclusion(
+                session=session_manager, **query_params
+            ).results
+
+        return self._retries_requests(request_func, max_retries, retry_delay=5)
 
     def _retries_requests(self, request_func, max_retries, retry_delay):
         for attempt in range(max_retries):
@@ -526,23 +576,34 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
                     logger.error("Maximum number of retries reached, aborting.")
                     raise e
 
-    def _date_reason_based(self, finding, date_fn, reason):
-        if reason in [self.FALSE_POSITIVE, self.OUT_OF_SCOPE]:
-            create_date = date_fn(finding.last_status_update)
-            expired_date = date_fn(None)
-        elif reason == self.TRANSFERRED_FINDING:
-            create_date = date_fn(finding.transfer_finding.date)
-            expired_date = date_fn(finding.transfer_finding.expiration_date)
-        else:
-            last_accepted_risk = finding.accepted_risks[-1]
-            create_date = date_fn(last_accepted_risk["created"])
-            expired_date = date_fn(last_accepted_risk["expiration_date"])
 
-        return create_date, expired_date
+    def _date_reason_based(self, finding, date_fn, reason, tool, **kwargs):
+        def get_vuln_id(finding, tool):
+            if tool == "engine_risk":
+                return finding.id[0]["vulnerability_id"] if finding.id else finding.vuln_id_from_tool
+            else:
+                return finding.vulnerability_ids[0]["vulnerability_id"] if finding.vulnerability_ids else finding.vuln_id_from_tool
+
+        def get_dates_from_whitelist(vuln_id, white_list):
+            matching_finding = next(filter(lambda x: x.unique_id_from_tool == vuln_id, white_list), None)
+            if matching_finding:
+                return date_fn(matching_finding.create_date), date_fn(matching_finding.expiration_date)
+            return date_fn(None), date_fn(None)
+
+        reason_to_dates = {
+            self.FALSE_POSITIVE: lambda: (date_fn(finding.last_status_update), date_fn(None)),
+            self.OUT_OF_SCOPE: lambda: (date_fn(finding.last_status_update), date_fn(None)),
+            self.TRANSFERRED_FINDING: lambda: (date_fn(finding.transfer_finding.date), date_fn(finding.transfer_finding.expiration_date)),
+            self.RISK_ACCEPTED: lambda: (date_fn(finding.accepted_risks[-1]["created"]), date_fn(finding.accepted_risks[-1]["expiration_date"])),
+            self.ON_WHITELIST: lambda: get_dates_from_whitelist(get_vuln_id(finding, tool), kwargs.get("white_list", [])),
+        }
 
-    def _create_exclusion(self, finding, date_fn, tool, reason):
-        create_date, expired_date = self._date_reason_based(finding, date_fn, reason)
+        create_date, expired_date = reason_to_dates.get(reason, lambda: (date_fn(None), date_fn(None)))()
+        return create_date, expired_date
 
+    def _create_exclusion(self, finding, date_fn, tool, reason, **kwargs):
+        create_date, expired_date = self._date_reason_based(finding, date_fn, reason, tool, **kwargs)
+            
         return Exclusions(
             id=(
                 finding.vuln_id_from_tool
@@ -560,8 +621,8 @@ class DefectDojoPlatform(VulnerabilityManagementGateway):
             reason=reason,
         )
 
-    def _create_report_exclusion(self, finding, date_fn, tool, reason, host_dd):
-        create_date, expired_date = self._date_reason_based(finding, date_fn, reason)
+    def _create_report_exclusion(self, finding, date_fn, tool, reason, host_dd, **kwargs):
+        create_date, expired_date = self._date_reason_based(finding, date_fn, reason, tool, **kwargs)
 
         return Exclusions(
             id=(

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/devsecops_engine_tools/engine_utilities/defect_dojo/__init__.py

@@ -5,4 +5,5 @@ from .applications.finding import Finding
 from .applications.connect import Connect
 from .applications.engagement import Engagement
 from .applications.product import Product
-from .applications.component import Component
+from .applications.component import Component
+from .applications.finding_exclusion import FindingExclusion

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/devsecops_engine_tools/engine_utilities/defect_dojo/applications/component.py

@@ -25,5 +25,4 @@ class Component:
             uc = ComponentUserCase(rest_component)
             return uc.post(request)
         except ApiError as e:
-            logger.error(f"Error during create component: {e}")
             raise e

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/devsecops_engine_tools/engine_utilities/defect_dojo/applications/finding.py

@@ -1,9 +1,6 @@
-from devsecops_engine_tools.engine_utilities.defect_dojo.domain.request_objects.finding import FindingRequest
 from devsecops_engine_tools.engine_utilities.defect_dojo.domain.serializers.finding import FindingSerializer
 from devsecops_engine_tools.engine_utilities.defect_dojo.infraestructure.driver_adapters.finding import FindingRestConsumer
 from devsecops_engine_tools.engine_utilities.defect_dojo.domain.user_case.finding import FindingUserCase, FindingGetUserCase
-from devsecops_engine_tools.engine_utilities.utils.session_manager import SessionManager
-from devsecops_engine_tools.engine_utilities.utils.api_error import ApiError
 from devsecops_engine_tools.engine_utilities.utils.logger_info import MyLogger
 from devsecops_engine_tools.engine_utilities import settings
 

devsecops_engine_tools-1.31.0/devsecops_engine_tools/engine_utilities/defect_dojo/applications/finding_exclusion.py

@@ -0,0 +1,14 @@
+from devsecops_engine_tools.engine_utilities.utils.api_error import ApiError
+from devsecops_engine_tools.engine_utilities.defect_dojo.domain.user_case.finding_exclusion import FindingExclusionUserCase
+from devsecops_engine_tools.engine_utilities.defect_dojo.infraestructure.driver_adapters.finding_exclusion import FindingExclusionRestConsumer
+
+class FindingExclusion:
+    @staticmethod
+    def get_finding_exclusion(session, **request):
+        try:
+            rest_finding_exclusion = FindingExclusionRestConsumer(session=session)
+
+            uc = FindingExclusionUserCase(rest_finding_exclusion)
+            return uc.execute(request)
+        except ApiError as e:
+            raise e

devsecops_engine_tools-1.31.0/devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/finding_exclusion.py

@@ -0,0 +1,20 @@
+import dataclasses
+from typing import List
+from devsecops_engine_tools.engine_utilities.utils.dataclass_classmethod import FromDictMixin
+
+
+@dataclasses.dataclass
+class FindingExclusion(FromDictMixin):
+    uuid: str = ""
+    unique_id_from_tool: str = ""
+    type: str = ""
+    create_date: str = ""
+    expiration_date: str = ""
+
+
+@dataclasses.dataclass
+class FindingExclusionList(FromDictMixin):
+    count: int = 0
+    next = None
+    previous = None
+    results: List[FindingExclusion] = dataclasses.field(default_factory=list)

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/devsecops_engine_tools/engine_utilities/defect_dojo/domain/serializers/finding.py

@@ -63,7 +63,7 @@ class FindingSerializer(Schema):
     reviewers = fields.List(fields.Int, requerided=False)
     risk_accetance = fields.Int(requerided=False)
     risk_status = fields.Str(
-        required=False, validate=validate.OneOf(["Risk Pending", "Risk Rejected", "Risk Expired", "Risk Accepted", "Risk Active", "Transfer Pending", "Transfer Rejected", "Transfer Expired", "Transfer Accepted"])
+        required=False, validate=validate.OneOf(["Risk Pending", "Risk Rejected", "Risk Expired", "Risk Accepted", "Risk Active", "Transfer Pending", "Transfer Rejected", "Transfer Expired", "Transfer Accepted", "On Whitelist", "On Blacklist"])
     )
     risk_accepted = fields.Bool(requerided=False)
     sast_sink_object = fields.Str(requeride=False)

devsecops_engine_tools-1.31.0/devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/finding_exclusion.py

@@ -0,0 +1,9 @@
+from devsecops_engine_tools.engine_utilities.defect_dojo.infraestructure.driver_adapters.finding_exclusion import FindingExclusionRestConsumer
+
+class FindingExclusionUserCase:
+    def __init__(self, rest_finding_exclusion: FindingExclusionRestConsumer):
+        self.__rest_finding_exclusion = rest_finding_exclusion
+
+    def execute(self, request):
+        response = self.__rest_finding_exclusion.get_finding_exclusions(request)
+        return response

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/import_scan.py

@@ -66,12 +66,12 @@ class ImportScanUserCase:
                         with id {product_type_id}"
                 )
 
-                product = self.__rest_product.post_product(request, product_type_id)
-                product_id = product.id
-                logger.info(
-                    f"product created: {product.name}\
-                        found with id: {product.id}"
-                )
+            product = self.__rest_product.post_product(request, product_type_id)
+            product_id = product.id
+            logger.info(
+                f"product created: {product.name}\
+                    found with id: {product.id}"
+            )
 
         api_scan_bool = re.search(" API ", request.scan_type)
         if api_scan_bool:

devsecops_engine_tools-1.31.0/devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapters/finding_exclusion.py

@@ -0,0 +1,28 @@
+from devsecops_engine_tools.engine_utilities.utils.api_error import ApiError
+from devsecops_engine_tools.engine_utilities.utils.logger_info import MyLogger
+from devsecops_engine_tools.engine_utilities.defect_dojo.domain.models.finding_exclusion import FindingExclusionList
+from devsecops_engine_tools.engine_utilities.defect_dojo.infraestructure.driver_adapters.settings.settings import VERIFY_CERTIFICATE
+from devsecops_engine_tools.engine_utilities.utils.session_manager import SessionManager
+from devsecops_engine_tools.engine_utilities.settings import SETTING_LOGGER
+
+logger = MyLogger.__call__(**SETTING_LOGGER).get_logger()
+
+class FindingExclusionRestConsumer:
+    def __init__(self, session: SessionManager):
+        self.__token = session._token
+        self.__host = session._host
+        self.__session = session._instance
+
+
+    def get_finding_exclusions(self, request) -> FindingExclusionList:
+        url = f"{self.__host}/api/v2/finding_exclusions/"
+        headers = {"Authorization": f"Token {self.__token}", "Content-Type": "application/json"}
+        try:
+            response = self.__session.get(url, headers=headers, params=request, verify=VERIFY_CERTIFICATE)
+            if response.status_code != 200:
+                raise ApiError(response.json())
+            finding_exclusions_object = FindingExclusionList.from_dict(response.json())
+        except Exception as e:
+            logger.error(f"from dict FindingExclusion: {e}")
+            raise ApiError(e)
+        return finding_exclusions_object

devsecops_engine_tools-1.31.0/devsecops_engine_tools/version.py

@@ -0,0 +1 @@
+version = '1.31.0'

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/devsecops_engine_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devsecops-engine-tools
-Version: 1.30.2
+Version: 1.31.0
 Summary: Tool for DevSecOps strategy
 Home-page: https://github.com/bancolombia/devsecops-engine-tools
 Author: Bancolombia DevSecOps Team
@@ -36,6 +36,7 @@ Requires-Dist: packageurl-python==0.15.6
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bancolombia_devsecops-engine-tools&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=bancolombia_devsecops-engine-tools)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=bancolombia_devsecops-engine-tools&metric=coverage)](https://sonarcloud.io/summary/new_code?id=bancolombia_devsecops-engine-tools)
 [![Python Version](https://img.shields.io/badge/python%20-%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20-blue)](#)
+[![PyPI](https://img.shields.io/pypi/v/devsecops-engine-tools)](https://pypi.org/project/devsecops-engine-tools/)
 [![Docker Pulls](https://img.shields.io/docker/pulls/bancolombia/devsecops-engine-tools
 )](https://hub.docker.com/r/bancolombia/devsecops-engine-tools)
 

{devsecops_engine_tools-1.30.2 → devsecops_engine_tools-1.31.0}/devsecops_engine_tools.egg-info/SOURCES.txt

@@ -242,6 +242,7 @@ devsecops_engine_tools/engine_utilities/defect_dojo/applications/connect.py
 devsecops_engine_tools/engine_utilities/defect_dojo/applications/defect_dojo.py
 devsecops_engine_tools/engine_utilities/defect_dojo/applications/engagement.py
 devsecops_engine_tools/engine_utilities/defect_dojo/applications/finding.py
+devsecops_engine_tools/engine_utilities/defect_dojo/applications/finding_exclusion.py
 devsecops_engine_tools/engine_utilities/defect_dojo/applications/product.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/__init__.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/__init__.py
@@ -249,6 +250,7 @@ devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/cmdb.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/component.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/engagement.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/finding.py
+devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/finding_exclusion.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/product.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/product_list.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/models/product_type.py
@@ -265,6 +267,7 @@ devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/cmdb.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/component.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/engagement.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/finding.py
+devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/finding_exclusion.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/import_scan.py
 devsecops_engine_tools/engine_utilities/defect_dojo/domain/user_case/product.py
 devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/__init__.py
@@ -273,6 +276,7 @@ devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapt
 devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapters/component.py
 devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapters/engagement.py
 devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapters/finding.py
+devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapters/finding_exclusion.py
 devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapters/import_scan.py
 devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapters/product.py
 devsecops_engine_tools/engine_utilities/defect_dojo/infraestructure/driver_adapters/product_type.py

devsecops_engine_tools-1.30.2/devsecops_engine_tools/version.py

@@ -1 +0,0 @@
-version = '1.30.2'