Skip to content

Commit bbc38c3

Browse files
Merge branch 'develop' into 'main'
develop into main See merge request integrations/sdk/reversinglabs-sdk-py3!29
2 parents 220aa2d + 862917d commit bbc38c3

File tree

7 files changed

+563
-50
lines changed

7 files changed

+563
-50
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ __pycache__/
1010
*.pyc
1111
.pytest_cache
1212
.coverage
13-
.idea
13+
.idea

CHANGELOG.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,9 @@ v2.5.1 (2024-04-02)
409409
-------------------
410410

411411
#### Improvements
412+
- **ticloud** module:
413+
- Added the `TAXIIFeed` class which will replace the `TAXIIRansomwareFeed` class in all its use cases in the future.
414+
412415
- **advanced** module:
413416
- Created a new module called `advanced`. This module will hold various actions and scenarios that include multiple platforms and APIs.
414417
- The `AdvancedActions` class was moved from the `ticloud` module into `advanced`.
@@ -423,7 +426,45 @@ v2.5.1 (2024-04-02)
423426

424427
- **Scenarios and Workflows** notebooks:
425428
- Added the `advanced_search_using_network_indicators.ipynb` notebook.
426-
429+
430+
431+
432+
2.10.0 (2025-06-24)
433+
-------------------
434+
435+
#### Improvements
436+
- **a1000** module:
437+
- Added the `submit_file_from_handle`, `submit_file_from_path`, `submit_file_and_get_summary_report`, `submit_file_and_get_detailed_report`, `submit_url` and `submit_url_and_get_report` methods.
438+
439+
- **ticloud** module:
440+
- Added additional result filtering options to the `TAXIIFeed.get_objects_aggregated` method.
441+
442+
#### Deprecations
443+
- **a1000** module:
444+
- Deprecated the `upload_sample_from_path`, `upload_sample_from_file`, `submit_url_for_analysis`, `submit_url_for_analysis_and_get_report`, `upload_sample_and_get_summary_report_v2` and `upload_sample_and_get_detailed_report_v2` methods.
445+
446+
- **ticloud** module:
447+
- Deprecated the `TAXIIRansomwareFeed` class.
448+
449+
450+
### ReversingLabs SDK Cookbook changes
451+
### Improvements
452+
- **Scenarios and Workflows** notebooks:
453+
- Added the `TAXII_data_filtering` notebook.
454+
455+
456+
457+
458+
459+
-------------------
460+
### Scheduled removals
461+
- **December 2025.**:
462+
- **a1000** module:
463+
- `upload_sample_from_path`, `upload_sample_from_file`, `submit_url_for_analysis`, `submit_url_for_analysis_and_get_report`, `upload_sample_and_get_summary_report_v2` and `upload_sample_and_get_detailed_report_v2` methods.
464+
- **ticloud** module:
465+
- `TAXIIRansomwareFeed` class.
466+
467+
427468
Starting with ReversingLabs SDK version 2.8.0, the **ReversingLabs SDK Cookbook** project's release cycle and versioning are closely tied to this project.
428469
This changelog will also be keeping track of changes made to the ReversingLabs SDK Cookbook project.
429470

README.md

Lines changed: 72 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,6 @@ If username and password are used instead, a token fetching request will be done
4040
- Returns the configuration of the instantiated A1000 object
4141
- `test_connection`
4242
- Creates a request towards the A1000 Check Status API to test the connection with A1000
43-
- `upload_sample_from_path`
44-
- Accepts a file path string and returns a response containing the analysis task ID
45-
- `upload_sample_from_file`
46-
- Accepts a file open in 'rb' mode and returns a response containing the analysis task ID
47-
- `submit_url_for_analysis`
48-
- Sends a URL for analysis on A1000.
4943
- `check_submitted_url_status`
5044
- Accepts a task id returned by upload_sample_from_url and returns a response containing processing status and
5145
report if the report is ready
@@ -55,31 +49,14 @@ If username and password are used instead, a token fetching request will be done
5549
- Accepts a task ID returned by upload_sample_from_url and returns a response
5650
- This method utilizes the set number of retries and wait time in seconds to time
5751
out if the analysis results are not ready
58-
- `submit_url_for_analysis_and_get_report`
59-
- Sends a URL for analysis on A1000.
60-
- The result fetching action of this method utilizes the set number of retries and wait time in seconds to time
61-
out if the analysis results are not ready
6252
- `get_summary_report_v2`
6353
- Accepts a single hash or a list of hashes and returns JSON containing a summary report for each of them
6454
- This method utilizes the set number of retries and wait time in seconds to time
6555
out if the analysis results are not ready
66-
- `upload_sample_and_get_summary_report_v2`
67-
- Accepts either a file path string or an open file in 'rb' mode for file upload and returns a summary analysis
68-
report response
69-
- This method combines uploading a sample and obtaining the summary analysis report
70-
- The result fetching action of this method utilizes the set number of retries and wait time in seconds to time
71-
out if the analysis results are not ready
7256
- `get_detailed_report_v2`
7357
- Accepts a single hash or a list of hashes and returns a detailed analysis report for the selected samples
7458
- This method utilizes the set number of retries and wait time in seconds and times out if the
7559
analysis results are not ready
76-
- `upload_sample_and_get_detailed_report_v2`
77-
- Accepts either a file path string or an open file in 'rb' mode for file upload and returns a detailed
78-
analysis report response.
79-
- This method combines uploading a sample and obtaining the detailed analysis report.
80-
- Additional fields can be provided.
81-
- The result fetching action of this method utilizes the set number of retries and wait time in seconds to time
82-
out if the analysis results are not ready.
8360
- `get_classification_v3`
8461
- Get classification for one sample
8562
- `reanalyze_samples_v2`
@@ -203,6 +180,21 @@ If username and password are used instead, a token fetching request will be done
203180
- `network_files_from_ip_aggregated`
204181
- Accepts an IP address string and returns a list of hashes and classifications for files found on the requested IP address
205182
- This method performs the paging automatically and returns a specified maximum number of records
183+
- `submit_file_from_handle`
184+
- Accepts an open file handle for file upload and returns a response.
185+
- `submit_file_from_path`
186+
- Accepts a file path string for file upload and returns a response.
187+
- `submit_file_and_get_summary_report`
188+
- Accepts either a file path string or an open file in 'rb' mode for file upload and returns a summary analysis report response.
189+
- This method combines uploading a sample and obtaining the summary analysis report.
190+
- `submit_file_and_get_detailed_report`
191+
- Accepts either a file path string or an open file in 'rb' mode for file upload and returns a detailed analysis report response.
192+
- This method combines uploading a sample and obtaining the detailed analysis report.
193+
- `submit_url`
194+
- Sends a URL for analysis on A1000.
195+
- `submit_url_and_get_report`
196+
- Sends a URL for analysis on A1000 and fetches the analysis report.
197+
- This method combines submitting a URL for analysis and obtaining the summary analysis report.
206198

207199
***
208200

@@ -860,7 +852,7 @@ _TCA-0408_
860852

861853
#### Class:
862854
```python
863-
class TAXIIRansomwareFeed(TiCloudAPI)
855+
class TAXIIFeed(TiCloudAPI)
864856
````
865857
#### Methods:
866858
- `discovery_info`
@@ -877,14 +869,6 @@ class TAXIIRansomwareFeed(TiCloudAPI)
877869
- Returns objects from a TAXII collection.
878870
- This method does the paging automatically and returns a defined number of objects as a list in the end.
879871

880-
#### Class:
881-
```python
882-
class AdvancedActions(object)
883-
````
884-
#### Methods:
885-
- `enriched_file_analysis`
886-
- Accepts a sample hash and returns a TCA-0104 File Analysis report enriched with a TCA-0106 Dynamic Analysis report.
887-
888872
***
889873

890874
## Module: tiscale
@@ -959,6 +943,62 @@ class FileInspectionEngine(object):
959943

960944
***
961945

946+
## Module: advanced
947+
A Python module containing advanced and combined actions utilizing various different classes.
948+
#### Class:
949+
```python
950+
class AdvancedActions(object):
951+
def __init__(self, host, verify, proxies, user_agent)
952+
```
953+
#### Parameters:
954+
`host` - Spectra Intelligence host
955+
`username` - Spectra Intelligence username
956+
`password` - Spectra Intelligence password
957+
`verify` - verify SSL certificate
958+
`proxies` - optional proxies in use
959+
`user_agent` - optional user agent string
960+
961+
#### Methods:
962+
- `enriched_file_analysis`
963+
- Accepts a sample hash and returns a TCA-0104 File Analysis report enriched with a TCA-0106 Dynamic Analysis report.
964+
965+
966+
#### Class:
967+
```python
968+
class SpectraAssureScenarios(object):
969+
def __init__(self, spectra_assure_client, verify_certs)
970+
```
971+
A class for using ReversingLabs Spectra Assure scenarios.
972+
#### Parameters:
973+
`spectra_assure_client` - class SpectraAssureClient client
974+
`verify_certs` - verify SSL certificates
975+
976+
### Methods:
977+
- `a1000_upload_to_assure`
978+
- Fetches a list of samples defined in the hash_list from Spectra Analyze and submits them to Spectra Assure for analysis.
979+
- `ticloud_upload_to_assure`
980+
- Fetches a list of samples defined in the hash_list from Spectra Intelligence and submits them to Spectra Assure for analysis.
981+
982+
983+
#### Class:
984+
```python
985+
class SpectraAssureClient(object):
986+
def __init__(self, host, token, organization, group)
987+
```
988+
A client class for using the ReversingLabs Spectra Assure API.
989+
#### Parameters:
990+
`host` - Spectra Assure host
991+
`token` - Your Spectra Assure user token
992+
`organization` - Your Spectra Assure organization
993+
`group` - Your Spectra Assure group
994+
995+
### Methods:
996+
- `submit_package`
997+
- `get_analysis_status`
998+
- `get_analysis_report`
999+
1000+
***
1001+
9621002
## Examples
9631003
#### A1000
9641004
```python

ReversingLabs/SDK/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
A Python SDK for communicating with ReversingLabs services.
66
"""
77

8-
__version__ = "2.9.0"
8+
__version__ = "2.10.0"

0 commit comments

Comments
 (0)