reversinglabs-sdk-py3

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

reversinglabs-sdk-py3

★ 9 Open GitHub ↗

Python library for ReversingLabs services - Python 3 version.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ReversingLabs SDK &middot; [![RL Status Badge](https://secure.software/pypi/badge/reversinglabs-sdk-py3)](https://secure.software/pypi/packages/reversinglabs-sdk-py3)

The official Python SDK for using ReversingLabs services.

The idea behind this SDK is to enable easier out-of-the-box development of software integrations and automation services that need to interact with ReversingLabs.

The SDK consists of several modules, where each module represents either one ReversingLabs service, ReversingLabs appliance or the ReversingLabs Spectra Intelligence APIs.

> **ReversingLabs SDK Cookbook**  
For a simple and comprehensive guide on how to start using the ReversingLabs SDK, visit the [ReversingLabs SDK Cookbook](https://github.com/reversinglabs/reversinglabs-sdk-cookbook) 
> and explore the provided steps and examples.

## Table of contents
- [Spectra Analyze](#spectra-analyze)
- [Spectra Intelligence](#spectra-intelligence)
- [Spectra Detect](#spectra-detect)
- [File Inspection Engine](#file-inspection-engine)
- [Advanced](#advanced-actions-and-clients-for-other-services)

## Spectra Analyze
#### [API documentation](https://docs.reversinglabs.com/SpectraAnalyze/)

### Module: a1000
A Python module representing the ReversingLabs Spectra Analyze malware analysis platform.
#### Class:
```python
class A1000(object):
    def __init__(self, host, username, password, token, fields_v2, ticore_fields, wait_time_seconds, retries, verify, proxies, user_agent):
```

#### Parameters:
`host` - Spectra Analyze address  
`username` - Spectra Analyze username  
`password` - Spectra Analyze password  
`token` - Spectra Analyze user token for the REST API  
`fields_v2` - optional fields that will be returned in the analysis report  
`ticore_fields` - optional fields that will be returned in the report from the Spectra Detect endpoint  
`wait_time_seconds` - wait time between each report fetching retry  
`retries` - number of report fetching retries  
`verify` - verify SSL certificate  
`proxies` - optional proxies in use  
`user_agent` - optional user agent string

> *NOTE!*  
The default means of authorization on the ReversingLabs Spectra Analyze REST API is the token.  
If username and password are used instead, a token fetching request will be done so the token can be used in further actions without the user explicitly providing the token.

#### Class methods:
- `configuration_dump`
    - Returns the configuration of the instantiated A1000 object
- `test_connection`
    - Creates a request towards the Spectra Analyze Check Status API to test the connection with Spectra Analyze
- `check_submitted_url_status`
    - Accepts a task id returned by upload_sample_from_url and returns a response containing processing status and 
        report if the report is ready
- `file_analysis_status`
    - Accepts a list of file hashes and returns their analysis completion information.
- `get_submitted_url_report`
    - Accepts a task ID returned by upload_sample_from_url and returns a response
    - This method utilizes the set number of retries and wait time in seconds to time
        out if the analysis results are not ready
- `get_summary_report_v2`
  - Accepts a single hash or a list of hashes and returns JSON containing a summary report for each of them
  -  This method utilizes the set number of retries and wait time in seconds to time
        out if the analysis results are not ready
- `get_detailed_report_v2`
  - Accepts a single hash or a list of hashes and returns a detailed analysis report for the selected samples
  - This method utilizes the set number of retries and wait time in seconds and times out if the
        analysis results are not ready
- `get_classification_v3`
  - Get classification for one sample
- `reanalyze_samples_v2`
  - Accepts a single hash or a list of hashes of various types and reanalyzes the corresponding sample(s)
  - This method can be used for reanalyzing a single sample or a batch of samples, depending on the data type
        passed
- `list_extracted_files_v2`
  - Get a list of all files TitaniumCore engine extracted from the requested sample during static analysis
- `list_extracted_files_v2_aggregated`
  - Get a list of all files TitaniumCore engine extracted from the requested sample during static analysis
  - Paging is done automatically and results from individual responses aggregated into one list and returned
- `download_extracted_files`
    - Accepts a single hash string and returns a downloadable archive file containing files extracted from the desired sample
- `download_sample`
    - Accepts a single hash string and returns a downloadable sample
- `delete_samples`
    - Accepts a single hash string or a list of hashes and deletes the corresponding samples from A100Spectra Analyze0
- `check_sample_removal_status_v2`
  - "Accepts the task ID returned by the bulk sample removal endpoint and returns a response that
        indicates if the removal request was finished successfully and if all samples have been deleted
- `create_pdf_report`
  - Accepts a single hash string and initiates the creation of a PDF analysis report for the requested sample.
        The response includes links to the pdf creation status endpoint and pdf download ednpoint for the requested
        sample
- `check_pdf_report_creation`
  - Accepts a single hash string that should correspond to the hash used in the request with
        create_pdf_report method. The response includes an informative message about the status of the PDF
        report previously requested
- `download_pdf_report`
  - Accepts a single hash string that should correspond to the hash used in the request with
        create_pdf_report method
- `get_titanium_core_report_v2`
  - Accepts a single hash string and gets the full TitaniumCore static analysis report for the requested sample.
        The requested sample must be present on the appliance. If the optional fields parameter is not provided in the
        request, all available parts of the static analysis report are returned in the response
- `create_dynamic_analysis_report`
  - Accepts a single hash string and initiates the creation of PDF or HTML reports for samples that have gone
        through dynamic analysis in the ReversingLabs Cloud Sandbox.
        The response includes links to the report creation status endpoint and report download ednpoint for the
        requested sample
- `check_dynamic_analysis_report_status`
  - Accepts a single hash string and report format parameters that should correspond to the parameters used in
        the request with create_dynamic_analysis_report method. The response includes an informative
        message about the status of the report previously requested
- `download_dynamic_analysis_report`
  - Accepts a single hash string and report format parameters that should correspond to the parameters used in
        the request with create_dynamic_analysis_report method
- `set_classification`
  - Accepts a single hash string, allows the user to set the classification of a sample, either in Spectra Intelligence
        or locally on the Spectra Analyze. Returns a response containing a new classification
- `delete_classification`
  - Accepts a single hash string, allows the user to delete the classification of a sample, either in
        Spectra Intelligence or locally on the Spectra Analyze
- `get_user_tags`
  - Accepts a single hash string and returns lists of existing user tags for the requested sample
- `post_user_tags`
  - Accepts a single hash string and adds one or more user tags to the requested sample
- `delete_user_tags`
  - Accepts a single hash string and removes one or more user tags from the requested sample
- `get_yara_rulesets_on_the_appliance_v2`
  - Retrieves a list of YARA rulesets that are on the Spectra Analyze appliance
  - The list can be filtered by several criteria (ruleset status, source, and owner) using optional parameters
- `get_yara_ruleset_contents`
  - Retrieves the full contents of the requested ruleset in raw text/plain format
  - All rulesets can be retrieved, regardless of their current status on the appliance (enabled, disabled…)
- `get_yara_ruleset_matches_v2`
  - Retrieves the list of YARA matches (both local and cloud) for requested rulesets
  - If multiple rulesets are provided in the request, only the samples that match all requested rulesets are listed in
        the response.
- `create_or_update_yara_ruleset`
  - Creates a new YARA ruleset if it doesn’t exist
  - If a ruleset with the specified name already exists, a new revision (update) of the ruleset is created
- `delete_yara_ruleset`
  - Deletes the specified YARA ruleset and its matches from the appliance
- `enable_or_disable_yara_ruleset`
  - Enables/disables ruleset on the appliance
  - Administrators can manage any ruleset while regular Spectra Analyze users can only manage their own rulesets
- `get_yara_ruleset_synchronization_time`
  - Gets information about the current synchronization status for Spectra Intelligence-enabled rulesets
- `update_yara_ruleset_synchronization_time`
  - Updates the Spectra Intelligence synchronization time for Spectra Intelligence-enabled YARA rulesets
- `start_or_stop_yara_local_retro_scan`
  - Allows users to initiate the Local Retro scan on the Spectra Analyze appliance, and stop the Local Retro scan that is
        in progress on the appliance
- `get_yara_local_retro_scan_status`
  - Gets the status of Local Retro scan on the Spectra Analyze appliance
- `start_or_stop_yara_cloud_retro_scan`
  - Allows users to start and stop a Cloud Retro scan for a specified ruleset on the Spectra Analyze appliance, as well as
        to clear all Cloud Retro results for the ruleset
- `get_yara_cloud_retro_scan_status`
  - Gets the status of Cloud Retro for the specified YARA ruleset. The response indicates the
        current state of Cloud Retro       
- `advanced_search_v3`
  - Sends a query string to the Spectra Analyze Advanced Search API v3
- `advanced_search_v3_aggregated`
  - Sends a query string to the Spectra Analyze Advanced Search API v3
  - Paging is done automatically and results from individual
        responses aggregated into one list and returned
- `list_containers_for_hashes`
  - Gets a list of all top-level containers from which the requested sample has been extracted during analysis
  - This is a bulk API, meaning that a single request can be used to simultaneously query containers for multiple
        file hashes
- `network_url_report`
  - Accepts a URL string and returns a report about the requested URL
- `network_domain_report`
  - Accepts a domain string and returns a report about the requested domain
- `network_ip_addr_report`
  - Accepts an IP address string and returns a report about the requested IP address
- `network_ip_to_domain`
  - Accepts an IP address string and returns a list of IP-to-domain mappings
- `network_ip_to_domain_aggregated`
  - Accepts an IP address string and returns a list of IP-to-domain mappings. 
  - This method performs the paging automatically and returns a specified maximum number of records
- `network_urls_from_ip`
  - Accepts an IP address string and returns a list of URLs hosted on the requested IP address
- `network_urls_from_ip_aggregated`
  - Accepts an IP address string and returns a list of URLs hosted on the requested IP address
  - This method performs the paging automatically and returns a specified maximum number of records
- `network_files_from_ip`
  - Accepts an IP address string and returns a list of hashes and classifications for files found on the requested IP address
- `network_files_from_ip_aggregated`
  - Accepts an IP address string and returns a list of hashes and classifications for files found on the requested IP address
  - This method performs the paging automatically and returns a specified maximum number of records
- `submit_file_from_handle`
  - Accepts an open file handle for file upload and returns a response.
- `submit_file_from_path`
  - Accepts a file path string for file upload and returns a response.
- `submit_file_and_get_summary_report`
  - Accepts either a file path string or an open file in 'rb' mode for file upload and returns a summary analysis report response.
  - This method combines uploading a sample and obtaining the summary analysis report.
- `submit_file_and_get_detailed_report`
  - Accepts either a file path string or an open file in 'rb' mode for file upload and returns a detailed analysis report response.
  - This method combines uploading a sample and obtaining the detailed analysis report.
- `submit_url`
  - Sends a URL for analysis on Spectra Analyze.
- `submit_url_and_get_report`
  - Sends a URL for analysis on Spectra Analyze and fetches the analysis report.
  - This method combines submitting a URL for analysis and obtaining the summary analysis report.

***

## Spectra Intelligence
#### [API documentation](https://docs.reversinglabs.com/SpectraIntelligence/)

### Module: ticloud
A Python module representing the ReversingLabs Spectra Intelligence API-s.

Each class in this module represents one Spectra Intelligence API and can be instantiated using the same set of parameters:
```python
def __init__(self, host, username, password, verify, proxies, user_agent, allow_none_return)
```
#### Parameters:
`host` - Spectra Intelligence address  
`username` - Spectra Intelligence username  
`password` - Spectra Intelligence password  
`verify` - verify SSL certificate  
`proxies` - optional proxies in use  
`user_agent` - optional user agent string  
`allow_none_return` - if set to `True`, `404` response codes will return `None` instead of `NotFoundError`

#### Class:
```python
class FileReputation(TiCloudAPI)
```
_TCA-0101_
#### Methods:
- `get_file_reputation`
    - Accepts a hash string or a list of hash strings and returns file reputation
    - Hash strings in a passed list must all be of the same hashing algorithm

#### Class:
```python
class AVScanners(TiCloudAPI)
```
_TCA-0103_
#### Methods:
- `get_scan_results`
    - Accepts a hash string or a list of hash strings and returns AV scanner results
    - Hash strings in a passed list must all be of the same hashing algorithm

#### Class:
```python
class FileAnalysis(TiCloudAPI)
```
_TCA-0104_
#### Methods:
- `get_analysis_results`
    - Accepts a hash string or a list of hash strings and returns extended file analysis
- `extract_uri_list_from_report`
    - Accepts a list of entries from the FileAnalysis report and returns a list of URI-s from those entries.
- `get_file_type`
    - Accepts a sample hash and returns the file type string

#### Class:
```python
class RHA1FunctionalSimilarity(TiCloudAPI)
```
_TCA-0301_
#### Methods:
- `get_similar_hashes`
    - Accepts a hash string and returns a list of functionally similar hashes
    - Returns only one defined page of results using one request
- `get_similar_hashes_aggregated`
    - Accepts a hash string and returns a list of functionally similar hashes
    - Returns a list of results aggregated through multiple paginated requests

#### Class:
```python
class RHA1Analytics(TiCloudAPI)
```
_TCA-0321_
#### Methods:
- `get_rha1_analytics`
    - Accepts one or more hash strings and returns a count of functionally similar hashes grouped by classification

#### Class:
```python
class URIStatistics(TiCloudAPI)
````
_TCA-0402_
#### Methods:
- `get_uri_statistics`
    - Accepts a URI string and returns a count of files associated with that URI grouped by classification

#### Class:
```python
class URIIndex(TiCloudAPI)
````
_TCA-0401_
#### Methods:
- `get_uri_index`
    - Accepts a URI string and returns a list of files associated with this URI
    - Returns only one defined page of results using one request
- `get_uri_index_aggregated`
    - Accepts a URI string and returns a list of files associated with this URI
    - Returns a list of results aggregated through multiple paginated requests

#### Class:
```python
class AdvancedSearch(TiCloudAPI)
````
_TCA-0320_
#### Methods:
- `search`
    - Accepts a search query string and performs advanced search on the API
    - Returns only one defined page of results using one request
- `search_aggregated`
    - Accepts a search query string and performs advanced search on the API
    - Returns a list of results aggregated through multiple paginated requests

#### Class:
```python
class FileDownload(TiCloudAPI)
````
_TCA-0201_
#### Methods:
- `get_download_status`
    - Accepts a hash string and returns the sample's availability for download
- `download_sample`
    - Accepts a hash string and downloads the related sample from Spectra Intelligence
    
#### Class:
```python
class URLThreatIntelligence(TiCloudAPI)
````
_TCA-0403_
#### Methods:
- `get_url_report`
    - Accepts a URL string and returns detailed URL analysis info
- `get_downloaded_files`
    - Accepts a URL string and returns a list of files downloaded from that URL
- `get_latest_url_analysis_feed`
    - Returns the latest URL analysis reports
    - Returns only one defined page of results using one request
- `get_latest_url_analysis_feed_aggregated`
    - Returns the latest URL analysis reports
    - Returns a list of results aggregated through multiple paginated requests
- `get_url_analysis_feed_from_date`
    - Accepts time format and a start time and returns URL analysis reports from that defined time onward
    - It is possible to list analyses up to 90 days into the past
    - Returns only one defined page of results using one request
- `get_url_analysis_feed_from_date_aggregated`
    - Accepts time format and a start time and returns URL analysis reports from that defined time onward
    - It is possible to list analyses up to 90 days into the past
    - Returns a list of results aggregated through multiple paginated requests

#### Class:
```python
class AnalyzeURL(TiCloudAPI)
````
_TCA-0404_
#### Methods:
- `submit_url`
    - Sends a URL string for analysis and returns an analysis task ID

#### Class:
```python
class FileUpload(TiCloudAPI)
````
_TCA-0202 and TCA-0203_
#### Methods:
- `upload_sample_from_path`
    - Accepts a file path string and uploads the desired file to the File Upload API
- `upload_sample_from_file`
    - Accepts an open file handle and uploads the desired file to the File Upload API

#### Class:
```python
class DeleteFile(TiCloudAPI)
````
_TCA-0204_
#### Methods:
- `delete_samples`
  - Accepts a single hash string or a list of hash strings belonging to samples you want to delete from the cloud
  - You can only delete samples that were uploaded by the same cloud account

#### Class:
```python
class ReanalyzeFile(TiCloudAPI)
````
_TCA-0205_
#### Methods:
- `reanalyze_samples`
  - Accepts a single hash string or a list of hash strings belonging to samples in the cloud you want to reanalyze
  - The samples need to be already present in the cloud in order to be reanalyzed

#### Class:
```python
class DynamicAnalysis(TiCloudAPI)
````
_TCA-0207 and TCA-0106_
#### Methods:
- `detonate_sample`
    - Submits a sample available in the cloud for dynamic analysis and returns processing info
    - The sample needs to be available in Spectra Intelligence beforehand
- `detonate_url`
    - Submits a URL for dynamic analysis and returns processing info
- `get_dynamic_analysis_results`
    - Returns dynamic analysis results for a desired sample or URL
    - The analysis of the selected sample or URL must be finished for the results to be available

#### Class:
```python
class CertificateIndex(TiCloudAPI)
````
_TCA-0501_
#### Methods:
- `get_certificate_information`
    - Accepts a hash (thumbprint) and returns a list of SHA1 hashes for samples signed with the certificate matching the requested thumbprint
- `get_certificate_information_aggregated`
    - Accepts a hash (thumbprint) and returns a list of SHA1 hashes for samples signed with the certificate matching the requested thumbprint
    - This method automatically handles paging and returns a list of results instead of a Response object
    
#### Class:
```python
class CertificateAnalytics(TiCloudAPI)
````
_TCA-0502_
#### Methods:
- `get_certificate_analytics`
    - Accepts a certificate hash thumbprint (hash string) and returns certificate analytics results

#### Class:
```python
class CertificateThumbprintSearch(TiCloudAPI)
````
_TCA-0503_
#### Methods:
- `search_common_names`
    - Accepts a certificate common name and returns common names matching the request, along with the list of thumbprints of all the certificates sharing that common name
- `search_common_names_aggregated`
    - Accepts a certificate common name and returns common names matching the request, along with the list of thumbprints of all the certificates sharing that common name
    - This method automatically handles paging and returns a list of results instead of a Response object

#### Class:
```python
class RansomwareIndicators(TiCloudAPI)
````
_Ransomware Indicators Feed_
#### Methods:
- `get_indicators`
    - Accepts a list of indicator type strings and integers for historical hours, health check and returning only freemium indicators. Returns indicators of ransomware and related tools

#### Class:
```python
class NewMalwareFilesFeed(ContinuousFeed)
````
_TCF-0101_
#### Methods:
- `pull_with_timestamp`
    - Accepts a time format definition and a time value. Returns malware detections from the requested time
- `pull`
    - Returns a list of malware detections since the point in time set by the set_start method. If the user has not previously used this method, nor has the set_start method been called, it will return records starting with the current timestamp
- `set_start`
    - This method sets the starting time for the pull method

#### Class:
```python
class MWPChangeEventsFeed(ContinuousFeed)
````
_TCF-0111_
#### Methods:
- `pull_with_timestamp`
    - Accepts a time format definition and a time value. Returns samples with a newly calculated or changed malware presence (MWP) classification and threat name from the requested time
- `pull`
    - Returns a list of classification and threat name changes since the point in time set by the set_start() method
- `set_start`
    - This method sets the starting time for the pull() method

#### Class:
```python
class NewMalwareURIFeed(TiCloudAPI)
````
_TCF-0301_
#### Methods:
- `pull_with_timestamp`
    - Accepts a time format definition and a time value. Returns records with IPs, domains, URLs, emails, and sample hashes extracted from malware samples
- `pull_latest`
    - Returns a maximum of 1000 latest records with IPs, domains, URLs, emails, and sample hashes extracted from malware samples

#### Class:
```python
class NewFilesFirstScan(TiCloudAPI)
```
_TCF-0107_
#### Methods:
- `feed_query`
    - Accepts a time format definition and a time value. Optional arguments are available sample and result limit
    - Returns a list of hashes for samples collected from various sources and scanned for the frist time in Spectra Intelligence system
- `start_query`
    - Accepts a time format definition and a time value
    - Sets the starting timestamp for the pull_query
- `pull_query`
    - Returns the list of hashes for samples scanned for the first time starting with the timestamp defined with start_query

#### Class:
```python
class NewFilesFirstAndRescan(TiCloudAPI)
```
_TCF-0108_
#### Methods:
- `feed_query`
    - Accepts a time format definition and a time value. Optional arguments are available sample and result limit
    - Returns a continuous list of samples in the Spectra Intelligence system which have been scanned for the frist time or rescanned
- `start_query`
    - Accepts a time format definition and a time value
    - Sets the starting timestamp for the pull_query
- `pull_query`
    - Returns the list of hashes for scanned samples starting with the timestamp defined with the start_query

#### Class:
```python
class FilesWithDetectionChanges(TiCloudAPI)
```
_TCF-0109_
#### Methods:
- `feed_query`
    - Accepts a time format definition and a time value. Optional arguments are available sample and result limit
    - Returns a list of hashes for scanned samples (first time scan or detection changes), starting with the provided timestamp
- `start_query`
    - Accepts a time format definition and a time value
    - Sets the starting timestamp for the pull_query
- `pull_query`
    - Returns the list of hashes for scanned samples starting with the timestamp defined with the start_query

#### Class:
```python
class CvesExploitedInTheWild(TiCloudAPI)
```
_TCF-0202_
#### Methods:
- `pull_daily_cve_report`
    - Accepts a time format definition and a time value.
    - Returns a document containing the list of malware hashes (SHA1, SHA256, MD5), threat names, and threat counts associated with the CVE identifiers for the requested day
- `pull_latest_cve_report`
    - Returns a document containing the list of malware hashes (SHA1, SHA256, MD5), threat names, and threat counts associated with the CVE identifiers for the latest day for which we have data

#### Class:
```python
class NewExploitOrCveSamplesFoundInWildHourly(TiCloudAPI)
```
_TCF-0203_
#### Methods:
- `hourly_exploit_list_query`
    - Accepts a time format definition and a time value. Optional arguments are available sample and result limit
    - Returns a list of new file hashes that contain CVE or exploit identification and that are detected within the requested one-hour period in the Spectra Intelligence system
- `latest_hourly_exploit_list_query`
    - Returns the results from latest hour for which we have data

#### Class:
```python
class NewExploitAndCveSamplesFoundInWildDaily(TiCloudAPI)
```
_TCF-0204_
#### Methods:
- `daily_exploit_list_query`
    - Accepts a time format definition and a time value. Optional arguments are available sample and result limit
    - Returns a list of ne file hashes that contain CVE or exploit identification and that are detected per day period in th Spectra Intelligence system
- `latest_daily_exploit_list_query`
    - Returns the results from latest day for which we have data

#### Class:
```python
class NewWhitelistedFiles(TiCloudAPI)
```
_TCF-0501_
#### Methods:
- `feed_query`
    - Accepts a time definition and a time value. Optional arguments are available sample and result limit
    - Returns a list of newly whitelisted samples since the requested time
- `start_query`
    - Sets the starting timestamp for the pull_query
- `pull_query`
    - Returns the list of newly whitelisted samples, with the timestamp defined with the start_query

#### Class:
```python
class ChangesWhitelistedFiles(TiCloudAPI)
```
_TCF-0502_
#### Methods:
- `feed_query`
    - Accepts a time definition and a time value
    - Returns a list of the samples which changed their whitelist status since requested time
- `latest_query`
    - Returns the 1000 latest samples which changed their whitelist status

#### Class:
```python
class ImpHashSimilarity(TiCloudAPI)
````
_TCA-0302_
#### Methods:
- `get_imphash_index`
    - Accepts an imphash and returns a list of SHA-1 hashes of files sharing that imphash
- `get_imphash_index_aggregated`
    - Accepts an imphash and returns a list of SHA-1 hashes of files sharing that imphash
    - This method automatically handles paging and returns a list of results instead of a Response object
- `get_hash_index`
  - This query returns a response containing SHA1 hashes for the requested sample SHA1 value

#### Class:
```python
class YARAHunting(TiCloudAPI)
````
_TCA-0303_
#### Methods:
- `create_ruleset`
    - Creates a new YARA ruleset
    - The ruleset_text parameter needs to be a stringified YARA ruleset / a Unicode string
- `delete_ruleset`
    - Deletes a YARA ruleset
- `get_ruleset_info`
    - Get information for a specific YARA ruleset or all YARA rulesets in the collection
- `get_ruleset_text`
    - Get the text of a YARA ruleset
- `yara_matches_feed`
    - Returns a recordset of YARA ruleset matches in the specified time range

#### Class:
```python
class YARARetroHunting(TiCloudAPI)
````
_TCA-0319_
#### Methods:
- `enable_retro_hunt`
    - Enables the retro hunt for the specified ruleset that has been submitted to Spectra Intelligence prior to deployment of YARA retro
- `start_retro_hunt`
    - Starts the retro hunt for the specified ruleset
- `check_status`
    - Checks the retro hunt status for the specified ruleset
- `cancel_retro_hunt`
    - Cancels the retro hunt for the specified ruleset
- `yara_retro_matches_feed`
    - Returns a recordset of YARA ruleset matches in the specified time range

#### Class:
```python
class FileReputationUserOverride(TiCloudAPI)
````
_TCA-0102_
#### Methods:
- `override_classification`
    - Accepts two parameters
      - A list of samples whose classification needs to be overriden
      - A list of samples whose classification override needs to me removed
- `list_active_overrides`
    - Accepts a hash type designation and returns the hashes of all currently active classification overrides for the current organization.
- `list_active_overrides_aggregated`
    - Accepts a hash type designation and returns the hashes of all currently active classification overrides for the current organization. This method does the paging action automatically and a maximum number of results returned in the list can be defined with the max_results parameter.

#### Class:
```python
class DomainThreatIntelligence(TiCloudAPI)
````
_TCA-0405_
#### Methods:
- `get_domain_report`
    - Accepts a domain string and returns threat intelligence data for the submitted domain.
- `get_downloaded_files`
    - Accepts a domain string and retrieves a list of files downloaded from the submitted domain.
- `get_downloaded_files_aggregated`
  - Accepts a domain string and retrieves a list of files downloaded from the submitted domain. This method performs the paging automatically and returns a list of results. The maximum number of results to be returned can be set.
- `urls_from_domain`
  - Accepts a domain string and returns a list of URLs associated with the requested domain.
- `urls_from_domain_aggregated`
  - Accepts a domain string and returns a list of URLs associated with the requested domain. This method performs the paging automatically and returns a list of results. The maximum number of results to be returned can be set.
- `domain_to_ip_resolutions`
  - Accepts a domain string and returns a list of domain-to-IP mappings for the requested domain.
- `domain_to_ip_resolutions_aggregated`
  - Accepts a domain string and returns a list of domain-to-IP mappings for the requested domain. This method performs the paging automatically and returns a list of results. The maximum number of results to be returned can be set.
- `related_domains`
  - Accepts a domain string and returns a list of domains that have the same top parent domain as the requested domain.
- `related_domains_aggregated`
  - Accepts a domain string and returns a list of domains that have the same top parent domain as the requested domain. This method performs the paging automatically and returns a list of results. The maximum number of results to be returned can be set.

#### Class:
```python
class IPThreatIntelligence(TiCloudAPI)
````
_TCA-0406_
#### Methods:
- `get_ip_report`
    - Accepts an IP address as a string and returns threat intelligence data for the submitted IP address.
- `get_downloaded_files`
    - Accepts an IP address as a string and returns a list of files downloaded from the submitted IP address.
- `get_downloaded_files_aggregated`
  - Accepts an IP address as a string and returns a list of files downloaded from the submitted IP address. This method performs the paging automatically and returns a list of results. The maximum number of results to be returned can be set.
- `urls_from_ip`
  - Accepts an IP address as a string and returns a list of URLs associated with the requested IP.
- `urls_from_ip_aggregated`
  - Accepts an IP address as a string and returns a list of URLs associated with the requested IP. This method performs the paging automatically and returns a list of results. The maximum number of results to be returned can be set.
- `ip_to_domain_resolutions`
  - Accepts an IP address as a string and returns a list of IP-to-domain mappings for the specified IP address.
- `ip_to_domain_resolutions_aggregated`
  - Accepts an IP address as a string and returns a list of IP-to-domain mappings for the specified IP address. This method performs the paging automatically and returns a list of results. The maximum number of results to be returned can be set.

#### Class:
```python
class FileAnalysisNonMalicious(TiCloudAPI)
````
_TCA-0105_
#### Methods:
- `get_analysis_results`
    - Accepts a hash string or a list of hash strings and returns knowledge about the given samples if they are classified as goodware.

#### Class:
```python
class DataChangeSubscription(TiCloudAPI)
````
_TCA-0206_
#### Methods:
- `subscribe`
  - Subscribes to a list of samples (hashes) for which the changed data (if there are any) will be delivered in the Data Change Feed.
- `unsubscribe`
    - Unsubscribes from a list of samples that the user was previously subscribed to.
- `set_start_time`
  - Sets the starting point for the DataChangeSubscription.pull_from_feed method.
- `pull_from_feed`
  - Returns a recordset with samples to which the user is subscribed. The starting point for this action is set using the DataChangeSubscription.set_start_time method. If the starting point is not set, this method will return records starting with the current timestamp. Every subsequent request will continue from the timestamp where the previous request ended.
- `continuous_data_change_feed`
  - Returns a recordset with samples to which the user is subscribed from the timestamp stated in the request onwards. To fetch the next recordset, use the last_timestamp value from the response and submit it in a new request as the time_value parameter.

#### Class:
```python
class NewMalwarePlatformFiltered(TiCloudAPI)
````
_TCF-0102-0106_
#### Methods:
- `feed_query`
    - Returns a list of malware samples optionally filtered by platform since the requested timestamp.
- `start_query`
    - Sets the starting timestamp for the pull_query.
- `pull_query`
    - Returns the list of malware samples optionally filtered by platform since a point in time set by the start_query.

#### Class:
```python
class CustomerUsage(TiCloudAPI)
````
_TCA-9999_
#### Methods:
- `daily_usage`
    - Returns information about daily service usage for the Spectra Intelligence account that sent the
        request.
- `monthly_usage`
    - Returns information about monthly service usage for the Spectra Intelligence account that sent the
        request.
- `date_range_usage`
    - This method returns total usage for all product licenses with a fixed quota over a single date range.
- `active_yara_rulesets`
    - This method returns information about the number of active YARA rulesets for the Spectra Intelligence
        account that sent the request.
- `quota_limits`
    - This method returns current quota limits for API-s accessible to the authenticated user.
- `get_company_information`
  - Returns the number of users and the company name for the company the authenticated user belongs to
- `create_user`
  - Creates a new user. Make sure to store the returned password
- `list_users`
  - Returns a list of all users in the company
- `retrieve_user`
  - Retrieve the information of one user
- `update_user`
  - Updates an existing user
  - Any of the fields from the Retrieve User response can be updated
- `reset_password`
  - Resets the user's password
- `list_licenses`
  - Returns a list of all licenses for the company
- `create_limit`
  - Creates a new limit
- `read_license_limits`
  - Returns a list of limits created for a specific license
- `read_user_limits`
  - Returns a list of limits created for a specific user
- `update_limit`
  - Updates an existing limit
- `delete_limit`
  - Deletes an existing limit
- `list_email_alerts`
  - Returns a list of currently stored email alert configurations
- `create_or_update_alert`
  - This query creates a new alert configuration or updates an existing one for the same product ID

#### Class:
```python
class NetworkReputation(TiCloudAPI)
````
_TCA-0407_
#### Methods:
- `get_network_reputation`
    - Returns reputation information about queried URL-, domains and IP addresses.

#### Class:
```python
class MalwareFamilyDetection(TiCloudAPI)
```
_TCA-0305_
#### Methods:
- `get_malware_family`
    - Returns all malware families to which sample belongs based on the detections from the latest AV scan

#### Class:
```python
class VerticalFeedsStatistics(TiCloudAPI)
```

Vertical Feed Statistics API provides information about new malware samples detection in the ReversingLabs Spectra Intelligence system, filtered by category (industry). Categories and API codes correspond to the ReversingLabs Targeted and Industry-Specific File Indicator Feeds (e.g., Financial, Retail, Exploits...).

| Codes     | Feed Name                                     |
| --------- |:---------------------------------------------:|
| TCA-0307  | APT (Advanced Persistent Threats) Statistics  |
| TCA-0308  | Financial Services Malware Statistics         |
| TCA-0309  | Retail Sector Malware Statistics              |
| TCA-0310  | Ransomware Statistics                         |
| TCA-0311  | CVE Exploits Statistics                       |
| TCA-0317  | Malware configuration Statistics              |

#### Methods:
- `feed_query`
    - Returns information about new malware samples detected in Spectra Intelligence, filtered by category

#### Class:
```python
class VerticalFeedsSearch(TiCloudAPI)
```

Service can be used to retrieve information about new malware samples from ReversingLabs Targeted and Industry-Specific File Indicator Feeds by searching for malware family names. The feeds are specialized collections of malware families that are known to have significant impact within specific industries (Retail, Financial), as well as of malware families that share a common trait (exploits, ransomware). ReversingLabs carefully selects malware families for each feed based on public and internal research.

| Codes     | Feed name                                     | Malware Family Names                                  |
| --------- |:-------------------------------------:|:-------------------------------------------------------------:|
| TCA-0312  | APT (Advanced Persistent Threats)     | CosmicDuke, CozyBear, Stuxnet, Hellsing                       |
| TCA-0313  | Financial Services Malware            | Alice, Dorkbot, Ramnit, Ripper                                |
| TCA-0314  | Retail Sector Malware                 | AbaddonPOS, ChewBacca, Katrina, Poseidon                      |
| TCA-0315  | Ransomware                            | BitCrypt, Nanolocker, NotPetya, WannaCry                      |
| TCA-0316  | CVE Exploits                          | CVE-2008-4844, CVE-2014-0495, CVE-2017-0147, CVE-2017-8291    |
| TCA-0318  | Malware Configuration                 | DarkComet, PoisonIvy, XtremeRAT, CyberGate                    |

#### Methods:
- `latest_query`
    - Returns latest information about new malware samples from ReversingLabs Targeted and Industry-Specific File Indicator Feeds by searching for malware family names.
- `feed_query`
    - Retruns information about new malware samples from ReversingLabs Targeted and Industry-Specific File Indicator Feeds by searching for malware family names based on time when they are added to a particular feed

#### Class:
```python
class IocDataRetrieval(TiCloudAPI)
````
_TCA-0330_
#### Methods:
- `get_ioc_summary`
    - Accepts an IoC type and time range alongside filters and returns data summary for the filtered IoCs.
- `get_latest_iocs`
    - Accepts an IoC type alongside filters and returns a data for all the latest IoCs. Results can be paginated.
- `get_iocs_timerange`
    - Accepts an IoC type and time range alongside filters and returns data for the filtered IoCs. Results can be paginated

#### Class:
```python
class NetworkReputationUserOverride(TiCloudAPI)
````
_TCA-0408_
#### Methods:
- `reputation_override`
    - This method enables two actions in one request:
        1. Send a list of network locations whose classification needs to be overriden.
        2. Send a list of network locations whose classification override needs to be removed.
- `list_overrides`
    - Returns a list of overrides that the user has made.

#### Class:
```python
class TAXIIFeed(TiCloudAPI)
````
#### Methods:
- `discovery_info`
    - Returns the information from the TAXII Server's discovery endpoint. 
    - The returned info shows the available api roots.
- `api_root_info`
    - Returns information about a specific api root.
- `collections_info`
    - Returns information about available collections in an api root.
- `get_objects`
    - Returns objects from a TAXII collection. 
    - Results can be filtered using several parameters.
- `get_objects_aggregated`
    - Returns objects from a TAXII collection. 
    - This method does the paging automatically and returns a defined number of objects as a list in the end.

#### Class:
```python
class SupplyChainIoCFeed(TiCloudAPI)
````
#### Methods:
- `set_start_time`
  - Set starting time cursor for pulling indicators.
- `pull_from_feed`
  - Retrieve latest feed data, starting from the set start time.
- `pull_with_timestamp`
  - Retrieve feed data starting from a time specified in this request.
- `pull_with_timeframe`
  - Accepts a time format definition and a start and end time written in the defined format.
  - Returns a Python list of indicators for the selected time period.
- `pull_with_relative_time`
  - Pulls the indicators from the last <amount> <unit>.
  - e.g. Last 5 days worth of indicators.

***

## Spectra Detect
#### [API documentation](https://docs.reversinglabs.com/SpectraDetect/)

### Module: tiscale
A Python module representing the ReversingLabs Spectra Detect malware analysis appliance.
#### Class:
```python
class TitaniumScale(object):
    def __init__(self, host, token, wait_time_seconds, retries, verify, proxies, user_agent)
```
#### Parameters:
`host` - Spectra Detect address  
`token` - Spectra Detect user token for the REST API  
`wait_time_seconds` - wait time between each report fetching retry  
`retries` - number of report fetching retries  
`verify` - verify SSL certificate  
`proxies` - optional proxies in use  
`user_agent` - optional user agent string

#### Methods:
- `upload_sample_from_path`
    - Accepts a file path string for file upload and returns a response containing the analysis task URL
- `upload_sample_from_file`
    - Accepts a file opened in 'rb' mode for file upload and returns a response containing the analysis task URL
- `get_results`
    - Accepts an analysis task URL and returns a file analysis summary or a full analysis report
    - This method utilizes the set number of retries and wait time in seconds to time out if the analysis results are not ready
- `upload_sample_and_get_results`
    - Accepts a file path string or an opened file in 'rb' mode for file upload and returns a file analysis summary or a full analysis report
    - This method combines uploading a sample and obtaining the analysis results
    - The result obtaining action of this method utilizes the set number of retries and wait time in seconds to time out if the analysis results are not ready
- `list_processing_tasks`
  - Lists processing tasks generated by file submission requests.
- `get_processing_task_info`
  - Retrieves information about a completed file processing task
- `delete_processing_task`
  - Deletes a processing task record from the system.
- `delete_multiple_tasks`
  - Deletes multiple task records from the system based on the time when they were submitted.
- `get_yara_id`
  - Retrieves the identifier of the current set of YARA rules on the Spectra Detect Worker instance.

***

## File Inspection Engine
#### [API documentation](https://docs.reversinglabs.com/FileInspectionEngine/)

### Module: fie
A Python module representing the ReversingLabs File Inspection Engine platform.
#### Class:
```python
class FileInspectionEngine(object):
    def __init__(self, host, verify, proxies, user_agent)
```
#### Parameters:
`host` - File Inspection Engine address
`verify` - verify SSL certificate  
`proxies` - optional proxies in use  
`user_agent` - optional user agent string

#### Methods:
- `test_connection`
    - Creates a lightweight request towards the FIE scan API to test the connection.
- `scan_using_file_path`
    - Sends a file to the FIE for inspection and returns a simple verdict in the submit response.
    - Uses a file path string as input.
- `scan_using_open_file`
    - Sends a file to the FIE for inspection and returns a simple verdict in the submit response.
    - Uses an open file handle as input.
- `report_using_file_path`
    - Sends a file to the FIE for inspection and returns a more complex analysis report in the submit response.
    - Uses a file path string as input.
- `report_using_open_file`
    - Sends a file to the FIE for inspection and returns a more complex analysis report in the submit response.
    - Uses an open file handle as input.
  
***

## Advanced actions and clients for other services
### Module: advanced
A Python module containing advanced and combined actions utilizing various different classes.
#### Class:
```python
class AdvancedActions(object):
    def __init__(self, host, verify, proxies, user_agent)
```
#### Parameters:
`host` - Spectra Intelligence host
`username` - Spectra Intelligence username
`password` - Spectra Intelligence password
`verify` - verify SSL certificate  
`proxies` - optional proxies in use  
`user_agent` - optional user agent string

#### Methods:
- `enriched_file_analysis`
  - Accepts a sample hash and returns a TCA-0104 File Analysis report enriched with a TCA-0106 Dynamic Analysis report.
  - If a dynamic analysis report does not exist for the given hash, the method returns a regular file analysis report.
  - If not even a file analysis report exists for the given hash, the method returns an empty dict.

- `full_file_analysis`
  - Combines TCA-0101 File Reputation, TCA-0104 File Analysis and TCA-0106 Dynamic Analysis into one report.
  - Returns a combined analysis report whose form depends on the availability of singular analysis reports.

- `download_yara_matches`
  - Download all YARA matches from the defined timestamp to the current moment.
  
- `email_file_reputation`
  - This method accepts a hash string of an email file. 
  - If the email file has graphical attachments, the reputation of those attachments will be taken into account when returning the reputation verdict here.
  - If at least one attachment is classified as malicious, the returned verdict will be "MALICIOUS".
  - If there are no malicious attachments but there are suspicious ones, the returned verdict will be "SUSPICIOUS".

- `enriched_malware_detection_feed`
  - This method works the same way as the pull_with_timestamp method from the ticloud.NewMalwareFilesFeed class but adds File Reputation and File Analysis data to each returned hash.

- `enriched_mwp_change_feed`
  - This method works the same way as the pull_with_timestamp method from the ticloud.MWPChangeEventsFeed class but adds File Reputation and File Analysis data to each returned hash.

- `enriched_new_files_feed`
  - This method works the same way as the feed_query method from the ticloud.NewFilesFirstAndRescan class but adds File Reputation, File Analysis and Dynamic Analysis data to each returned hash. In case the Dynamic Analysis report is not available for a hash, it will be omitted.

- `enriched_network_iocs_feed`
  - This method accepts a time format, a time value and an optional list of IoC types.
  - The time format and time value are used for querying the pull_with_timestamp method from the ticloud.NewMalwareURIFeed class.
  - The optional IoC types list defines which IoC types you want returned and enriched with network analysis reports. IF the IoC types list is left as None, all IoC types will be returned. If there are no 'ip' or 'domain' type IoCs in the feed result, they will simply not be returned.

#### Class:
```python
class SpectraAssureScenarios(object):
    def __init__(self, spectra_assure_client, verify_certs)
```
A class for using ReversingLabs Spectra Assure scenarios.
#### Parameters:
`spectra_assure_client` - class SpectraAssureClient client
`verify_certs` - verify SSL certificates

### Methods:
- `a1000_upload_to_assure`
  - Fetches a list of samples defined in the hash_list from Spectra Analyze and submits them to Spectra Assure for analysis.
- `ticloud_upload_to_assure`
  - Fetches a list of samples defined in the hash_list from Spectra Intelligence and submits them to Spectra Assure for analysis.

#### Class:
```python
class SpectraAssureClient(object):
    def __init__(self, host, token, organization, group)
```
A client class for using the ReversingLabs Spectra Assure API.
#### Parameters:
`host` - Spectra Assure host
`token` - Your Spectra Assure user token  
`organization` - Your Spectra Assure organization
`group` - Your Spectra Assure group

### Methods:
- `submit_package`
- `get_analysis_status`
- `get_analysis_report`

***

## Examples
#### Spectra Analyze
```python
from ReversingLabs.SDK.a1000 import A1000

# Using username and password for authorization
a1000 = A1000(
    host="https://a1000.address",
    username="username",
    password="password",
    verify=True,
    wait_time_seconds=3,
    retries=10
)

response = a1000.submit_file_and_get_detailed_report(
    file_path="/path/to/file.exe",
    retry=True,
    custom_filename="CustomName",
    tags="custom,tags,go,here",
)

json_report = response.json()
```

```python
from ReversingLabs.SDK.a1000 import A1000

# Using the token for authorization
a1000 = A1000(
    host="http://a1000.address",
    token="1js76asmklaslk288japj29s89z",
    verify=False,
    wait_time_seconds=2,
    retries=15
)

response = a1000.list_extracted_files_v2(
    sample_hash="cf23df2207d99a74fbe169e3eba035e633b65d94",
    page_size=30
)

json_report = response.json()
```

#### Spectra Intelligence
```python
import base64
from ReversingLabs.SDK.ticloud import FileReputation, URIStatistics, FileDownload, FileUpload, CustomerUsage

host = "https://data.reversinglabs.com"
username = "username"
password = "password"
user_agent = "MyCustom App v0.0.1"

file_reputation = FileReputation(
    host=host,
    username=username,
    password=password,
    user_agent=user_agent
)

reputation = file_reputation.get_file_reputation(
    hash_input="cf23df2207d99a74fbe169e3eba035e633b65d94",
    extended_results=True,
    show_hashes_in_results=False
)

uri_statistics = URIStatistics(
    host=host,
    username=username,
    password=password,
    user_agent=user_agent
)

statistics = uri_statistics.get_uri_statistics(
    uri_input="youtube.com"
)

file_download = FileDownload(
    host=host,
    username=username,
    password=password,
    user_agent=user_agent
)

download = file_download.download_sample(
    hash_input="cf23df2207d99a74fbe169e3eba035e633b65d94"
)

with open("/path/to/file", "wb") as file_handle:
    file_handle.write(download.content)

file_upload = FileUpload(
    host=host,
    username=username,
    password=password,
    user_agent=user_agent
)

upload = file_upload.upload_sample_from_path(
    file_path="/path/to/file",
    sample_name="Custom Sample Name",
    sample_domain="webdomain.com"
)

customer_usage = CustomerUsage(
    host=host,
    username=username,
    password=password,
    user_agent=user_agent
)

# Encode username string in Base64
plain_username = "u/company/username"
plain_username_bytes = plain_username.encode("ascii")
base64_bytes = base64.b64encode(plain_username_bytes)
encoded_username = base64_bytes.decode("ascii")

reset_response = customer_usage.reset_password(
    username=encoded_username
)

```

#### Spectra Detect
```python
from ReversingLabs.SDK.tiscale import TitaniumScale

titanium_scale = TitaniumScale(
    host="https://tiscale.address",
    token="examplesecrettoken",  # replace with a proper token
    verify=True,
    wait_time_seconds=5,
    retries=6
)

results = titanium_scale.upload_sample_and_get_results(
    file_source=open("/path/to/file.exe", "rb"),
    full_report=True
)
```

#### File Inspection Engine
```python
from ReversingLabs.SDK.fie import FileInspectionEngine

fie = FileInspectionEngine(
    host="http://fie.address",
    verify=True
)

results = fie.scan_using_file_path(
    file_path="/local/path/to/file.exe"
)

print(results.json())
```

#### Error handling
Each module raises corresponding custom exceptions according to the error status code returned in the response. 
Custom exception classes that correspond to error status codes also carry the original response object in its entirety. 
To learn how to fetch and use the response object out of the exception object, see the following examples.
```python
from ReversingLabs.SDK.ticloud import FileReputation

file_rep = FileReputation(
    host="https://data.reversinglabs.com",
    username="u/username",
    password="password"
)

try:
    resp = file_rep.get_file_reputation(hash_input="cf23df2207d99a74fbe169e3eba035e633b65d94")
except Exception as e:
    if hasattr(e, "response_object"):
        print(e.response_object.content)
    else:
        raise 
```
Same approach can also be used for Spectra Analyze and Spectra Detect.

reversinglabs-sdk-py3

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README