Skip to content

Commit db03356

Browse files
Update readme
1 parent 01cb266 commit db03356

File tree

1 file changed

+72
-32
lines changed

1 file changed

+72
-32
lines changed

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

0 commit comments

Comments
 (0)