Merge branch 'develop' into 'main'

2.8.0

See merge request integrations/sdk/reversinglabs-sdk-py3!12

Author: MislavReversingLabs

CHANGELOG.md

@@ -361,12 +361,26 @@ v2.5.1 (2024-04-02)
 #### Improvements
 - **ticloud** module:
   - Corrected a typo in the docstrings and the README.
-  
 
 
+2.8.0 (2024-12-24)
+-------------------
+
+#### Removals
+- **ticloud** module:
+  - Removed the deprecated `sample_sha1` parameter from the `ticloud.DynamicAnalysis.detonate_sample` method.
 
-### Scheduled removals
-- **December 2024.**:
-  - Parameter `sample_sha1` from the `ticloud.DynamicAnalysis.detonate_sample` method will be removed. Parameter `sample_hash` should be used instead.
-- **March 2025.**:
-  - Parameters `internet_simulation` and `sample_name` from the `ticloud.DynamicAnalysis.detonate_sample` method will be removed and should be further used through `**optional_parameters`.
+#### Improvements
+- **ticloud** module:
+  - Parameters `internet_simulation` and `sample_name` from the `ticloud.DynamicAnalysis.detonate_sample` method are now used through the `**optiona_parameters` key-value parameter instead of as individual named parameters.
+
+### Reversinglabs SDK Cookbook changes
+#### Improvements
+- **Scenarios and Workflows** notebooks:
+  - Added the `download_advanced_search_matches_a1000.ipynb`, `download_advanced_search_matches_titaniumcloud.ipynb`, `download_yara_retro_matches_a1000.ipynb` and `download_yara_retro_matches_titaniumcloud.ipynb` notebooks.
+
+- **Command line tools and scripts**:
+  - Added the `cyber_defense_alliance.py` command line tool.
+  
+Starting with ReversingLabs SDK version 2.8.0, the **ReversingLabs SDK Cookbook** project's release cycle and versioning are closely tied to this project.  
+This changelog will also be keeping track of changes made to the ReversingLabs SDK Cookbook project.

ReversingLabs/SDK/__init__.py

@@ -5,4 +5,4 @@
 A Python SDK for communicating with ReversingLabs services.
 """
 
-__version__ = "2.7.2"
+__version__ = "2.8.0"

ReversingLabs/SDK/a1000.py

@@ -1407,7 +1407,7 @@ def get_yara_ruleset_contents(self, ruleset_name):
             :param ruleset_name: name of the YARA ruleset to retrieve. Ruleset names are case-sensitive
             :type ruleset_name: str
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         if not isinstance(ruleset_name, str):
             raise WrongInputError("ruleset_name parameter must be a string")
@@ -1432,7 +1432,7 @@ def get_yara_ruleset_matches_v2(self, ruleset_name, page=None, page_size=None):
             :param page_size: parameter that controls how many results to return per page in the response
             :type page_size: str
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         param_list = []
 
@@ -1479,7 +1479,7 @@ def create_or_update_yara_ruleset(self, name, content, publish=None, ticloud=Non
             :param ticloud: determines whether the ruleset should be synchronized with TitaniumCloud or not
             :type ticloud: bool
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         data = self.__create_post_payload(
             name=name,
@@ -1506,7 +1506,7 @@ def delete_yara_ruleset(self, name, publish=None):
             C1000 cluster
             :type publish: bool
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         post_json = self.__create_post_payload(
             name=name,
@@ -1534,7 +1534,7 @@ def enable_or_disable_yara_ruleset(self, enabled, name, publish=None):
             C1000 cluster
             :type publish: bool
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         data = self.__create_post_payload(
             name=name,
@@ -1557,7 +1557,7 @@ def enable_or_disable_yara_ruleset(self, enabled, name, publish=None):
     def get_yara_ruleset_synchronization_time(self):
         """Gets information about the current synchronization status for TitaniumCloud-enabled rulesets.
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         endpoint = self.__GET_OR_SET_YARA_RULESET_SYNCHRONIZATION_TIME_ENDPOINT
 
@@ -1574,7 +1574,7 @@ def update_yara_ruleset_synchronization_time(self, sync_time):
             :param sync_time: format should be UTC (YYYY-MM-DD hh:mm)
             :type sync_time: str
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         try:
             datetime.datetime.strptime(sync_time, '%Y-%m-%d %H:%M')
@@ -1597,7 +1597,7 @@ def start_or_stop_yara_local_retro_scan(self, operation):
             :param operation: accepted values: START, STOP (case-sensitive)
             :type operation: str
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         if operation not in ("START", "STOP"):
             raise WrongInputError("operation parameter must be either 'START' or 'STOP'")
@@ -1617,7 +1617,7 @@ def get_yara_local_retro_scan_status(self):
         state of Local Retro, time and date when the latest Local Retro scan was started and/or stopped, and a list of
         previous Local Retro scans with the same details.
             :return: response
-            :rtype: requests.Response:
+            :rtype: requests.Response
         """
         endpoint = self.__YARA_LOCAL_RETROSCAN_ENDPOINT
 

ReversingLabs/SDK/ticloud.py

@@ -3198,7 +3198,6 @@ def detonate_url(self, url_string, platform, **optional_parameters):
 
         return response
 
-    @deprecated_args(dpr_args=["internet_simulation", "sample_name", "sample_sha1"])
     def detonate_sample(self, sample_hash=None, platform=None, is_archive=False, **optional_parameters):
         """Submits a sample or a file archive available in the cloud for dynamic analysis and returns processing info.
             :param sample_hash: SHA1, MD5 or SHA256 hash of the sample or archive
@@ -3217,10 +3216,7 @@ def detonate_sample(self, sample_hash=None, platform=None, is_archive=False, **o
             :rtype: requests.Response
         """
         if "sample_sha1" in optional_parameters:
-            if not sample_hash:
-                sample_hash = optional_parameters.get("sample_sha1")
-
-            del optional_parameters["sample_sha1"]
+            raise WrongInputError("sample_sha1 parameter was removed. Use sample_hash instead.")
 
         validate_hashes(
             hash_input=[sample_hash],