Reverting sensitive str handling (#38203)

JasBeilin · RosenbergYehuda · sdaniel6 · commit 115adadc2bc4 · 2025-01-27T11:14:09.000+02:00
* fixing performance issue

* RN

* fix

* fix

* wip

* fix

* wip

* remove gsuite

* remove test

* remove lats func

* rn

* pre commit

---------

Co-authored-by: yrosenberg &lt;yrosenberg@paloaltonetworks.com&gt;
diff --git a/Packs/ApiModules/Scripts/GSuiteApiModule/GSuiteApiModule.py b/Packs/ApiModules/Scripts/GSuiteApiModule/GSuiteApiModule.py
@@ -137,11 +137,7 @@ def http_exception_handler():
             raise DemistoException(COMMON_MESSAGES['TRANSPORT_ERROR'].format(error))
         except exceptions.RefreshError as error:
             if error.args:
-                # masking the token present in the error message
-                error_msg = error.args[0]
-                find_and_remove_sensitive_text(text=error_msg,
-                                               pattern=r'(token:\s*)(\S+)')
-                raise DemistoException(COMMON_MESSAGES['REFRESH_ERROR'].format(error_msg))
+                raise DemistoException(COMMON_MESSAGES['REFRESH_ERROR'].format(error.args[0]))
             raise DemistoException(error)
         except TimeoutError as error:
             raise DemistoException(COMMON_MESSAGES['TIMEOUT_ERROR'].format(error))
diff --git a/Packs/Base/ReleaseNotes/1_39_16.md b/Packs/Base/ReleaseNotes/1_39_16.md
@@ -0,0 +1,6 @@
+
+#### Scripts
+
+##### CommonServerPython
+
+- Fixed performance issues.
diff --git a/Packs/Base/Scripts/CommonServerPython/CommonServerPython.py b/Packs/Base/Scripts/CommonServerPython/CommonServerPython.py
@@ -1615,19 +1615,6 @@ def stringUnEscape(st):
     return st.replace('\\r', '\r').replace('\\n', '\n').replace('\\t', '\t')
 
 
-def doubleBackslashes(st):
-    """
-       Double any backslashes in the given string if it contains two backslashes.
-
-       :type st: ``str``
-       :param st: The string to be modified (required).
-
-       :return: A modified string with doubled backslashes.
-       :rtype: ``str``
-    """
-    return st.replace('\\', '\\\\')
-
-
 class IntegrationLogger(object):
     """
       a logger for python integrations:
@@ -1708,7 +1695,6 @@ def add_replace_strs(self, *args):
                 a = self.encode(a)
                 to_add.append(stringEscape(a))
                 to_add.append(stringUnEscape(a))
-                to_add.append(doubleBackslashes(a))
                 js = json.dumps(a)
                 if js.startswith('"'):
                     js = js[1:]
@@ -12649,47 +12635,7 @@ def function_runner(func, profiler, signal_event,
     return profiler_wrapper
 
 
-def find_and_remove_sensitive_text(text, pattern):
-    r"""
-    Finds all appearances of sensitive information in a string using regex and adds the sensitive
-    information to the list of strings that should not appear in any logs.
-    The regex pattern can be used to search for a specific word, or a pattern such as a word after a given word.
-        Examples:
-    >>> text = "first secret is ID123 and the second secret is id321 and the token: ABC"
-    >>> pattern = r'(token:\s*)(\S+)'  # Capturing groups: (token:\s*) and (\S+)
-    >>> find_and_remove_sensitive_text(text, pattern)
-    Sensitive text added to be masked in the logs: ABC
-
-    >>> pattern = r'\bid\w*\b'  # Match words starting with "id", case insensitive
-    >>> find_and_remove_sensitive_text(text, pattern)
-    Sensitive text added to be masked in the logs: ID123 and id321
-
-    :param text: The input text containing the sensitive information.
-    :type text: str
-    :param pattern: The regex pattern to match the sensitive information.
-    :type pattern: str
-
-    :return: None
-    :rtype: ``None``
-    """
-
-    sensitive_pattern = re.compile(pattern)
-    matches = sensitive_pattern.findall(text)
-    if not matches:
-        return
-
-    for match in matches:
-        # in case the regex serches for a group pattern
-        if isinstance(match, tuple):
-            sensitive_text = match[1]
-        else:
-            # in case the regex serches for a specific word
-            sensitive_text = match
-        add_sensitive_log_strs(sensitive_text)
-    return
-
-
-from DemistoClassApiModule import *  # type:ignore [no-redef]  # noqa:E402the
+from DemistoClassApiModule import *  # type:ignore [no-redef]  # noqa:E402
 
 ###########################################
 #     DO NOT ADD LINES AFTER THIS ONE     #
diff --git a/Packs/Base/Scripts/CommonServerPython/CommonServerPython_test.py b/Packs/Base/Scripts/CommonServerPython/CommonServerPython_test.py
@@ -18,7 +18,7 @@
 
 import CommonServerPython
 import demistomock as demisto
-from CommonServerPython import (find_and_remove_sensitive_text, xml2json, json2xml, entryTypes, formats, tableToMarkdown, underscoreToCamelCase,
+from CommonServerPython import (xml2json, json2xml, entryTypes, formats, tableToMarkdown, underscoreToCamelCase,
                                 flattenCell, date_to_timestamp, datetime, timedelta, camelize, pascalToSpace, argToList,
                                 remove_nulls_from_dictionary, is_error, get_error, hash_djb2, fileResult, is_ip_valid,
                                 get_demisto_version, IntegrationLogger, parse_date_string, IS_PY3, PY_VER_MINOR, DebugLogger,
@@ -10010,73 +10010,3 @@ def test_get_engine_base_url(mocker):
     mocker.patch.object(demisto, 'internalHttpRequest', return_value=mock_response)
     res = get_engine_base_url('1111')
     assert res == '11.111.111.33:443'
-
-
-@pytest.mark.parametrize('input_text, pattern, expected_output, call_count', [
-    pytest.param('invalid_grant: java.security.SignatureException: Invalid signature for token: 1234',
-                 r'(token:\s*)(\S+)', '1234', 1, id='Match token value'),
-    pytest.param('invalid_grant: java.security.SignatureException: Invalid signature for token: 1234', r'(invalid_grant: java.security.SignatureException: Invalid signature for token: 1234)',
-                 'invalid_grant: java.security.SignatureException: Invalid signature for token: 1234', 1, id='Match entire string')
-])
-def test_find_and_remove_sensitive_text__found_onc(input_text, pattern, expected_output, call_count, mocker):
-    """
-    Given:
-    - Input text that includes sensitive information.
-
-    When:
-    - Invoking the `find_and_remove_sensitive_text` method with a regex pattern to search for sensitive information.
-
-    Then:
-    - Verify that the function responsible for removing sensitive information from the logs is called with the sensitive data as an argument.
-    - Verify that the function is called the correct number of times.
-
-    """
-    input_text = 'invalid_grant: java.security.SignatureException: Invalid signature for token: 1234'
-    mock_remove_from_logs = mocker.patch('CommonServerPython.add_sensitive_log_strs', return_value=None)
-    find_and_remove_sensitive_text(input_text, pattern)
-
-    assert mock_remove_from_logs.call_count == call_count
-    assert mock_remove_from_logs.call_args[0][0] == expected_output
-
-
-@pytest.mark.parametrize('pattern, expected_output, call_count', [
-    pytest.param(r'n', ['n', 'n', 'n', 'n', 'n', 'n', 'n'], 7, id='Match character "n"'),
-    pytest.param(r'(?i)invalid', ['invalid', 'Invalid'], 2, id='Match word "invalid" case insensitive')
-])
-def test_find_and_remove_sensitive_text__found_multiple(pattern, expected_output, call_count, mocker):
-    """
-    Given:
-    - Input text that includes sensitive information.
-
-    When:
-    - Invoking the `find_and_remove_sensitive_text` method with a regex pattern to search for a sensitive information.
-
-    Then:
-        verify that the function responsible for removing sensitive information from the logs is called with the sensitive data as an argument.
-        verify that the function is called the correct number of times.
-    """
-    input_text = 'invalid_grant: java.security.SignatureException: Invalid signature for token: 1234'
-    mock_remove_from_logs = mocker.patch('CommonServerPython.add_sensitive_log_strs', return_value=None)
-    find_and_remove_sensitive_text(input_text, pattern)
-    assert mock_remove_from_logs.call_count == call_count
-    for x in range(call_count):
-        assert mock_remove_from_logs.call_args_list[x][0][0] == expected_output[x]
-
-
-def test_find_and_remove_sensitive_text__not_found(mocker):
-    """
-    Given:
-    - Input text that does not contain any sensitive information (e.g., no word following "token:").
-
-    When:
-    - Invoking the `find_and_remove_sensitive_text` method with a regex pattern to search for a sensitive information (the word following "token:").
-
-    Then:
-    - Ensure that the function does not remove anything from the logs.
-    """
-
-    input_text = 'invalid_grant: java.security.SignatureException: Invalid signature for text: 1234'
-    mock_remove_from_logs = mocker.patch('CommonServerPython.add_sensitive_log_strs', return_value=None)
-    find_and_remove_sensitive_text(input_text, r'(token:\s*)(\S+)')
-
-    mock_remove_from_logs.assert_not_called()
diff --git a/Packs/Base/pack_metadata.json b/Packs/Base/pack_metadata.json
@@ -2,7 +2,7 @@
     "name": "Base",
     "description": "The base pack for Cortex XSOAR.",
     "support": "xsoar",
-    "currentVersion": "1.39.15",
+    "currentVersion": "1.39.16",
     "author": "Cortex XSOAR",
     "serverMinVersion": "6.0.0",
     "url": "https://www.paloaltonetworks.com/cortex",
diff --git a/Packs/GSuiteAdmin/ReleaseNotes/1_2_6.md b/Packs/GSuiteAdmin/ReleaseNotes/1_2_6.md
@@ -0,0 +1,6 @@
+
+#### Integrations
+
+##### Google Workspace Admin
+
+Fixed performance issues.
diff --git a/Packs/GSuiteAdmin/pack_metadata.json b/Packs/GSuiteAdmin/pack_metadata.json
@@ -2,7 +2,7 @@
     "name": "G Suite Admin",
     "description": "G Suite Admin integration with Cortex XSOAR. G Suite or Google Workspace Admin is an integration to perform an action on IT infrastructure, create users, update settings, and more administrative tasks.",
     "support": "xsoar",
-    "currentVersion": "1.2.5",
+    "currentVersion": "1.2.6",
     "author": "Cortex XSOAR",
     "url": "https://www.paloaltonetworks.com/cortex",
     "email": "",
diff --git a/Packs/GSuiteSecurityAlertCenter/ReleaseNotes/1_1_49.md b/Packs/GSuiteSecurityAlertCenter/ReleaseNotes/1_1_49.md
@@ -0,0 +1,6 @@
+
+#### Integrations
+
+##### G Suite Security Alert Center
+
+Fixed performance issues.
diff --git a/Packs/GSuiteSecurityAlertCenter/pack_metadata.json b/Packs/GSuiteSecurityAlertCenter/pack_metadata.json
@@ -2,7 +2,7 @@
     "name": "G Suite Security Alert Center",
     "description": "Fetch alert types, delete or recover alerts, retrieve an alert's metadata, and create or view alert feedback.",
     "support": "xsoar",
-    "currentVersion": "1.1.48",
+    "currentVersion": "1.1.49",
     "author": "Cortex XSOAR",
     "url": "https://www.paloaltonetworks.com/cortex",
     "email": "",
diff --git a/Packs/GoogleCalendar/ReleaseNotes/1_1_51.md b/Packs/GoogleCalendar/ReleaseNotes/1_1_51.md
@@ -0,0 +1,6 @@
+
+#### Integrations
+
+##### Google Calendar
+
+Fixed performance issues.
diff --git a/Packs/GoogleCalendar/pack_metadata.json b/Packs/GoogleCalendar/pack_metadata.json
@@ -2,7 +2,7 @@
     "name": "Google Calendar",
     "description": "Google Calendar integration with Cortex XSOAR.",
     "support": "xsoar",
-    "currentVersion": "1.1.50",
+    "currentVersion": "1.1.51",
     "author": "Cortex XSOAR",
     "url": "https://www.paloaltonetworks.com/cortex",
     "email": "",
diff --git a/Packs/GoogleCloudLogging/ReleaseNotes/1_0_19.md b/Packs/GoogleCloudLogging/ReleaseNotes/1_0_19.md
@@ -0,0 +1,6 @@
+
+#### Integrations
+
+##### Google Cloud Logging
+
+Fixed performance issues.
diff --git a/Packs/GoogleCloudLogging/pack_metadata.json b/Packs/GoogleCloudLogging/pack_metadata.json
@@ -2,7 +2,7 @@
     "name": "Google Cloud Logging",
     "description": "Google Cloud Logging is a managed logging solution provided by Google Cloud Platform (GCP) that allows users to collect, store, search, analyze, and monitor logs generated by GCP services, third-party applications, and custom applications running on GCP.",
     "support": "xsoar",
-    "currentVersion": "1.0.18",
+    "currentVersion": "1.0.19",
     "author": "Cortex XSOAR",
     "url": "https://www.paloaltonetworks.com/cortex",
     "email": "",
diff --git a/Packs/GoogleDrive/ReleaseNotes/1_3_13.md b/Packs/GoogleDrive/ReleaseNotes/1_3_13.md
@@ -0,0 +1,6 @@
+
+#### Integrations
+
+##### Google Drive
+
+Fixed performance issues.
diff --git a/Packs/GoogleDrive/pack_metadata.json b/Packs/GoogleDrive/pack_metadata.json
@@ -2,7 +2,7 @@
     "name": "Google Drive",
     "description": "Google Drive allows users to store files on their servers, synchronize files across devices, and share files. This integration helps you to create a new drive, query past activity and view change logs performed by the users, as well as list drives and files, and manage their permissions.",
     "support": "xsoar",
-    "currentVersion": "1.3.12",
+    "currentVersion": "1.3.13",
     "author": "Cortex XSOAR",
     "url": "https://www.paloaltonetworks.com/cortex",
     "email": "",
diff --git a/Packs/GsuiteAuditor/ReleaseNotes/1_0_28.md b/Packs/GsuiteAuditor/ReleaseNotes/1_0_28.md
@@ -0,0 +1,6 @@
+
+#### Integrations
+
+##### G Suite Auditor
+
+Fixed performance issues.
diff --git a/Packs/GsuiteAuditor/pack_metadata.json b/Packs/GsuiteAuditor/pack_metadata.json
@@ -2,7 +2,7 @@
     "name": "GsuiteAuditor",
     "description": "G Suite Auditor integration with Cortex XSOAR. G Suite Auditor is an integration to recieve audit log data from G Suite services like drive,gmail and more. The integration uses Google Admin SDK",
     "support": "xsoar",
-    "currentVersion": "1.0.27",
+    "currentVersion": "1.0.28",
     "author": "Cortex XSOAR",
     "url": "https://www.paloaltonetworks.com/cortex",
     "email": "",
