Skip to content

Commit 123ed1b

Browse files
authored
Merge pull request #122 from RevEngAI/sdk-update-v3.55.2
πŸ€– Update SDK to version v3.55.2
2 parents 09a3534 + 44aebba commit 123ed1b

52 files changed

Lines changed: 721 additions & 867 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

β€Ž.sdk-versionβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v3.51.0
1+
v3.55.2

β€ŽREADME.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Class | Method | HTTP request | Description
5656
*AnalysesCoreApi* | [**insert_analysis_log**](docs/AnalysesCoreApi.md#insert_analysis_log) | **POST** /v2/analyses/{analysis_id}/logs | Insert a log entry for an analysis
5757
*AnalysesCoreApi* | [**list_analyses**](docs/AnalysesCoreApi.md#list_analyses) | **GET** /v2/analyses/list | Gets the most recent analyses
5858
*AnalysesCoreApi* | [**lookup_binary_id**](docs/AnalysesCoreApi.md#lookup_binary_id) | **GET** /v2/analyses/lookup/{binary_id} | Gets the analysis ID from binary ID
59+
*AnalysesCoreApi* | [**put_analysis_strings**](docs/AnalysesCoreApi.md#put_analysis_strings) | **PUT** /v2/analyses/{analysis_id}/strings | Add strings to the analysis
5960
*AnalysesCoreApi* | [**requeue_analysis**](docs/AnalysesCoreApi.md#requeue_analysis) | **POST** /v2/analyses/{analysis_id}/requeue | Requeue Analysis
6061
*AnalysesCoreApi* | [**update_analysis**](docs/AnalysesCoreApi.md#update_analysis) | **PATCH** /v2/analyses/{analysis_id} | Update Analysis
6162
*AnalysesCoreApi* | [**update_analysis_tags**](docs/AnalysesCoreApi.md#update_analysis_tags) | **PATCH** /v2/analyses/{analysis_id}/tags | Update Analysis Tags
@@ -69,7 +70,6 @@ Class | Method | HTTP request | Description
6970
*AnalysesDynamicExecutionApi* | [**get_ttps**](docs/AnalysesDynamicExecutionApi.md#get_ttps) | **GET** /v2/analyses/{analysis_id}/dynamic-execution/ttps | Get the dynamic execution results for ttps
7071
*AnalysesResultsMetadataApi* | [**get_analysis_functions_paginated**](docs/AnalysesResultsMetadataApi.md#get_analysis_functions_paginated) | **GET** /v2/analyses/{analysis_id}/functions | Get functions from analysis
7172
*AnalysesResultsMetadataApi* | [**get_capabilities**](docs/AnalysesResultsMetadataApi.md#get_capabilities) | **GET** /v2/analyses/{analysis_id}/capabilities | Gets the capabilities from the analysis
72-
*AnalysesResultsMetadataApi* | [**get_communities**](docs/AnalysesResultsMetadataApi.md#get_communities) | **GET** /v2/analyses/{analysis_id}/communities | Gets the communities found in the analysis
7373
*AnalysesResultsMetadataApi* | [**get_functions_list**](docs/AnalysesResultsMetadataApi.md#get_functions_list) | **GET** /v2/analyses/{analysis_id}/functions/list | Gets functions from analysis
7474
*AnalysesResultsMetadataApi* | [**get_pdf**](docs/AnalysesResultsMetadataApi.md#get_pdf) | **GET** /v2/analyses/{analysis_id}/pdf | Gets the PDF found in the analysis
7575
*AnalysesResultsMetadataApi* | [**get_sbom**](docs/AnalysesResultsMetadataApi.md#get_sbom) | **GET** /v2/analyses/{analysis_id}/sbom | Gets the software-bill-of-materials (SBOM) found in the analysis
@@ -178,6 +178,7 @@ Class | Method | HTTP request | Description
178178
- [AnalysisStage](docs/AnalysisStage.md)
179179
- [AnalysisStageStatus](docs/AnalysisStageStatus.md)
180180
- [AnalysisStagesResponse](docs/AnalysisStagesResponse.md)
181+
- [AnalysisStringInput](docs/AnalysisStringInput.md)
181182
- [AnalysisStringsResponse](docs/AnalysisStringsResponse.md)
182183
- [AnalysisStringsStatusResponse](docs/AnalysisStringsStatusResponse.md)
183184
- [AnalysisTags](docs/AnalysisTags.md)
@@ -225,7 +226,6 @@ Class | Method | HTTP request | Description
225226
- [BaseResponseCollectionSearchResponse](docs/BaseResponseCollectionSearchResponse.md)
226227
- [BaseResponseCollectionTagsUpdateResponse](docs/BaseResponseCollectionTagsUpdateResponse.md)
227228
- [BaseResponseCommentResponse](docs/BaseResponseCommentResponse.md)
228-
- [BaseResponseCommunities](docs/BaseResponseCommunities.md)
229229
- [BaseResponseConfigResponse](docs/BaseResponseConfigResponse.md)
230230
- [BaseResponseCreated](docs/BaseResponseCreated.md)
231231
- [BaseResponseDict](docs/BaseResponseDict.md)
@@ -309,8 +309,6 @@ Class | Method | HTTP request | Description
309309
- [CommentBase](docs/CommentBase.md)
310310
- [CommentResponse](docs/CommentResponse.md)
311311
- [CommentUpdateRequest](docs/CommentUpdateRequest.md)
312-
- [Communities](docs/Communities.md)
313-
- [CommunityMatchPercentages](docs/CommunityMatchPercentages.md)
314312
- [ConfidenceType](docs/ConfidenceType.md)
315313
- [ConfigResponse](docs/ConfigResponse.md)
316314
- [Context](docs/Context.md)
@@ -417,6 +415,7 @@ Class | Method | HTTP request | Description
417415
- [ProcessDumpsData](docs/ProcessDumpsData.md)
418416
- [ProcessRegistry](docs/ProcessRegistry.md)
419417
- [ProcessTree](docs/ProcessTree.md)
418+
- [PutAnalysisStringsRequest](docs/PutAnalysisStringsRequest.md)
420419
- [QueuedSecurityChecksTaskResponse](docs/QueuedSecurityChecksTaskResponse.md)
421420
- [ReAnalysisForm](docs/ReAnalysisForm.md)
422421
- [Recent](docs/Recent.md)
@@ -442,6 +441,7 @@ Class | Method | HTTP request | Description
442441
- [StatusInput](docs/StatusInput.md)
443442
- [StatusOutput](docs/StatusOutput.md)
444443
- [StringFunctions](docs/StringFunctions.md)
444+
- [StringSource](docs/StringSource.md)
445445
- [Structure](docs/Structure.md)
446446
- [StructureMember](docs/StructureMember.md)
447447
- [Symbols](docs/Symbols.md)

β€Ždocs/AnalysesCoreApi.mdβ€Ž

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Method | HTTP request | Description
1515
[**insert_analysis_log**](AnalysesCoreApi.md#insert_analysis_log) | **POST** /v2/analyses/{analysis_id}/logs | Insert a log entry for an analysis
1616
[**list_analyses**](AnalysesCoreApi.md#list_analyses) | **GET** /v2/analyses/list | Gets the most recent analyses
1717
[**lookup_binary_id**](AnalysesCoreApi.md#lookup_binary_id) | **GET** /v2/analyses/lookup/{binary_id} | Gets the analysis ID from binary ID
18+
[**put_analysis_strings**](AnalysesCoreApi.md#put_analysis_strings) | **PUT** /v2/analyses/{analysis_id}/strings | Add strings to the analysis
1819
[**requeue_analysis**](AnalysesCoreApi.md#requeue_analysis) | **POST** /v2/analyses/{analysis_id}/requeue | Requeue Analysis
1920
[**update_analysis**](AnalysesCoreApi.md#update_analysis) | **PATCH** /v2/analyses/{analysis_id} | Update Analysis
2021
[**update_analysis_tags**](AnalysesCoreApi.md#update_analysis_tags) | **PATCH** /v2/analyses/{analysis_id}/tags | Update Analysis Tags
@@ -937,6 +938,89 @@ Name | Type | Description | Notes
937938

938939
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
939940

941+
# **put_analysis_strings**
942+
> BaseResponse put_analysis_strings(analysis_id, put_analysis_strings_request)
943+
944+
Add strings to the analysis
945+
946+
Add strings to the analysis. Rejects if any string already exists at the given vaddr.
947+
948+
### Example
949+
950+
* Api Key Authentication (APIKey):
951+
952+
```python
953+
import revengai
954+
from revengai.models.base_response import BaseResponse
955+
from revengai.models.put_analysis_strings_request import PutAnalysisStringsRequest
956+
from revengai.rest import ApiException
957+
from pprint import pprint
958+
959+
# Defining the host is optional and defaults to https://api.reveng.ai
960+
# See configuration.py for a list of all supported configuration parameters.
961+
configuration = revengai.Configuration(
962+
host = "https://api.reveng.ai"
963+
)
964+
965+
# The client must configure the authentication and authorization parameters
966+
# in accordance with the API server security policy.
967+
# Examples for each auth method are provided below, use the example that
968+
# satisfies your auth use case.
969+
970+
# Configure API key authorization: APIKey
971+
configuration.api_key['APIKey'] = os.environ["API_KEY"]
972+
973+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
974+
# configuration.api_key_prefix['APIKey'] = 'Bearer'
975+
976+
# Enter a context with an instance of the API client
977+
with revengai.ApiClient(configuration) as api_client:
978+
# Create an instance of the API class
979+
api_instance = revengai.AnalysesCoreApi(api_client)
980+
analysis_id = 56 # int |
981+
put_analysis_strings_request = revengai.PutAnalysisStringsRequest() # PutAnalysisStringsRequest |
982+
983+
try:
984+
# Add strings to the analysis
985+
api_response = api_instance.put_analysis_strings(analysis_id, put_analysis_strings_request)
986+
print("The response of AnalysesCoreApi->put_analysis_strings:\n")
987+
pprint(api_response)
988+
except Exception as e:
989+
print("Exception when calling AnalysesCoreApi->put_analysis_strings: %s\n" % e)
990+
```
991+
992+
993+
994+
### Parameters
995+
996+
997+
Name | Type | Description | Notes
998+
------------- | ------------- | ------------- | -------------
999+
**analysis_id** | **int**| |
1000+
**put_analysis_strings_request** | [**PutAnalysisStringsRequest**](PutAnalysisStringsRequest.md)| |
1001+
1002+
### Return type
1003+
1004+
[**BaseResponse**](BaseResponse.md)
1005+
1006+
### Authorization
1007+
1008+
[APIKey](../README.md#APIKey)
1009+
1010+
### HTTP request headers
1011+
1012+
- **Content-Type**: application/json
1013+
- **Accept**: application/json
1014+
1015+
### HTTP response details
1016+
1017+
| Status code | Description | Response headers |
1018+
|-------------|-------------|------------------|
1019+
**201** | Successful Response | - |
1020+
**422** | Invalid request parameters | - |
1021+
1022+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1023+
9401024
# **requeue_analysis**
9411025
> BaseResponseCreated requeue_analysis(analysis_id, re_analysis_form, x_rev_eng_application=x_rev_eng_application)
9421026

β€Ždocs/AnalysesResultsMetadataApi.mdβ€Ž

Lines changed: 0 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**get_analysis_functions_paginated**](AnalysesResultsMetadataApi.md#get_analysis_functions_paginated) | **GET** /v2/analyses/{analysis_id}/functions | Get functions from analysis
88
[**get_capabilities**](AnalysesResultsMetadataApi.md#get_capabilities) | **GET** /v2/analyses/{analysis_id}/capabilities | Gets the capabilities from the analysis
9-
[**get_communities**](AnalysesResultsMetadataApi.md#get_communities) | **GET** /v2/analyses/{analysis_id}/communities | Gets the communities found in the analysis
109
[**get_functions_list**](AnalysesResultsMetadataApi.md#get_functions_list) | **GET** /v2/analyses/{analysis_id}/functions/list | Gets functions from analysis
1110
[**get_pdf**](AnalysesResultsMetadataApi.md#get_pdf) | **GET** /v2/analyses/{analysis_id}/pdf | Gets the PDF found in the analysis
1211
[**get_sbom**](AnalysesResultsMetadataApi.md#get_sbom) | **GET** /v2/analyses/{analysis_id}/sbom | Gets the software-bill-of-materials (SBOM) found in the analysis
@@ -176,86 +175,6 @@ Name | Type | Description | Notes
176175

177176
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
178177

179-
# **get_communities**
180-
> BaseResponseCommunities get_communities(analysis_id, user_name=user_name)
181-
182-
Gets the communities found in the analysis
183-
184-
### Example
185-
186-
* Api Key Authentication (APIKey):
187-
188-
```python
189-
import revengai
190-
from revengai.models.base_response_communities import BaseResponseCommunities
191-
from revengai.rest import ApiException
192-
from pprint import pprint
193-
194-
# Defining the host is optional and defaults to https://api.reveng.ai
195-
# See configuration.py for a list of all supported configuration parameters.
196-
configuration = revengai.Configuration(
197-
host = "https://api.reveng.ai"
198-
)
199-
200-
# The client must configure the authentication and authorization parameters
201-
# in accordance with the API server security policy.
202-
# Examples for each auth method are provided below, use the example that
203-
# satisfies your auth use case.
204-
205-
# Configure API key authorization: APIKey
206-
configuration.api_key['APIKey'] = os.environ["API_KEY"]
207-
208-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
209-
# configuration.api_key_prefix['APIKey'] = 'Bearer'
210-
211-
# Enter a context with an instance of the API client
212-
with revengai.ApiClient(configuration) as api_client:
213-
# Create an instance of the API class
214-
api_instance = revengai.AnalysesResultsMetadataApi(api_client)
215-
analysis_id = 56 # int |
216-
user_name = 'user_name_example' # str | The user name to limit communities to (optional)
217-
218-
try:
219-
# Gets the communities found in the analysis
220-
api_response = api_instance.get_communities(analysis_id, user_name=user_name)
221-
print("The response of AnalysesResultsMetadataApi->get_communities:\n")
222-
pprint(api_response)
223-
except Exception as e:
224-
print("Exception when calling AnalysesResultsMetadataApi->get_communities: %s\n" % e)
225-
```
226-
227-
228-
229-
### Parameters
230-
231-
232-
Name | Type | Description | Notes
233-
------------- | ------------- | ------------- | -------------
234-
**analysis_id** | **int**| |
235-
**user_name** | **str**| The user name to limit communities to | [optional]
236-
237-
### Return type
238-
239-
[**BaseResponseCommunities**](BaseResponseCommunities.md)
240-
241-
### Authorization
242-
243-
[APIKey](../README.md#APIKey)
244-
245-
### HTTP request headers
246-
247-
- **Content-Type**: Not defined
248-
- **Accept**: application/json
249-
250-
### HTTP response details
251-
252-
| Status code | Description | Response headers |
253-
|-------------|-------------|------------------|
254-
**200** | Successful Response | - |
255-
**422** | Invalid request parameters | - |
256-
257-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
258-
259178
# **get_functions_list**
260179
> BaseResponseAnalysisFunctions get_functions_list(analysis_id, search_term=search_term, min_v_addr=min_v_addr, max_v_addr=max_v_addr, include_embeddings=include_embeddings, page=page, page_size=page_size)
261180

β€Ždocs/AnalysisFunctionMatchingRequest.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90.0]
8+
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90]
99
**filters** | [**FunctionMatchingFilters**](FunctionMatchingFilters.md) | | [optional]
10-
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 10 | [optional] [default to 1]
10+
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 30 | [optional] [default to 1]
1111
**page** | **int** | Page number for paginated results, default is 1 (first page) | [optional] [default to 1]
1212
**page_size** | **int** | Number of functions to return per page, default is 0 (all functions), max is 1000 | [optional] [default to 0]
1313
**status_only** | **bool** | If set to true, only returns the status of the matching operation without the actual results | [optional] [default to False]

β€Ždocs/AnalysisStringInput.mdβ€Ž

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# AnalysisStringInput
2+
3+
Input model for inserting a string into an analysis.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**value** | **str** | The string literal value |
10+
**vaddr** | **int** | The virtual address of the string |
11+
**source** | [**StringSource**](StringSource.md) | The source of the string |
12+
13+
## Example
14+
15+
```python
16+
from revengai.models.analysis_string_input import AnalysisStringInput
17+
18+
# TODO update the JSON string below
19+
json = "{}"
20+
# create an instance of AnalysisStringInput from a JSON string
21+
analysis_string_input_instance = AnalysisStringInput.from_json(json)
22+
# print the JSON string representation of the object
23+
print(AnalysisStringInput.to_json())
24+
25+
# convert the object into a dict
26+
analysis_string_input_dict = analysis_string_input_instance.to_dict()
27+
# create an instance of AnalysisStringInput from a dict
28+
analysis_string_input_from_dict = AnalysisStringInput.from_dict(analysis_string_input_dict)
29+
```
30+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31+
32+

β€Ždocs/AutoUnstripRequest.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90.0]
8+
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90]
99
**apply** | **bool** | Whether to apply the matched function names to the target binary, default is False | [optional] [default to False]
10-
**confidence_threshold** | **float** | Confidence threshold for applying function names as a percentage, default is 90 | [optional] [default to 90.0]
10+
**confidence_threshold** | **float** | Confidence threshold for applying function names as a percentage, default is 90 | [optional] [default to 90]
1111
**min_group_size** | **int** | Minimum number of matching functions required to consider for a match, default is 10 | [optional] [default to 10]
1212
**status_only** | **bool** | If set to true, only returns the status of the auto-unstrip operation without the actual results | [optional] [default to False]
1313
**no_cache** | **bool** | If set to true, forces the system to bypass any cached results and perform a fresh computation | [optional] [default to False]

β€Ždocs/BaseResponseCommunities.mdβ€Ž

Lines changed: 0 additions & 33 deletions
This file was deleted.

β€Ždocs/Communities.mdβ€Ž

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
Β (0)