Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .sdk-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v1.72.0
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Class | Method | HTTP request | Description
*AnalysesCoreApi* | [**requeue_analysis**](docs/AnalysesCoreApi.md#requeue_analysis) | **POST** /v2/analyses/{analysis_id}/requeue | Requeue Analysis
*AnalysesCoreApi* | [**update_analysis**](docs/AnalysesCoreApi.md#update_analysis) | **PATCH** /v2/analyses/{analysis_id} | Update Analysis
*AnalysesCoreApi* | [**update_analysis_tags**](docs/AnalysesCoreApi.md#update_analysis_tags) | **PATCH** /v2/analyses/{analysis_id}/tags | Update Analysis Tags
*AnalysesCoreApi* | [**upload_file**](docs/AnalysesCoreApi.md#upload_file) | **POST** /v2/upload | Upload File
*AnalysesDynamicExecutionApi* | [**get_dynamic_execution_status**](docs/AnalysesDynamicExecutionApi.md#get_dynamic_execution_status) | **GET** /v2/analyses/{analysis_id}/dynamic-execution/status | Get the status of a dynamic execution task
*AnalysesDynamicExecutionApi* | [**get_network_overview**](docs/AnalysesDynamicExecutionApi.md#get_network_overview) | **GET** /v2/analyses/{analysis_id}/dynamic-execution/network-overview | Get the dynamic execution results for network overview
*AnalysesDynamicExecutionApi* | [**get_process_dump**](docs/AnalysesDynamicExecutionApi.md#get_process_dump) | **GET** /v2/analyses/{analysis_id}/dynamic-execution/process-dumps/{dump_name} | Get the dynamic execution results for a specific process dump
Expand Down Expand Up @@ -119,13 +120,18 @@ Class | Method | HTTP request | Description
*FunctionsBlockCommentsApi* | [**generate_block_comments_for_block_in_function**](docs/FunctionsBlockCommentsApi.md#generate_block_comments_for_block_in_function) | **POST** /v2/functions/{function_id}/block-comments/single | Generate block comments for a specific block in a function
*FunctionsBlockCommentsApi* | [**generate_block_comments_for_function**](docs/FunctionsBlockCommentsApi.md#generate_block_comments_for_function) | **POST** /v2/functions/{function_id}/block-comments | Generate block comments for a function
*FunctionsBlockCommentsApi* | [**generate_overview_comment_for_function**](docs/FunctionsBlockCommentsApi.md#generate_overview_comment_for_function) | **POST** /v2/functions/{function_id}/block-comments/overview | Generate overview comment for a function
*FunctionsCoreApi* | [**ai_unstrip**](docs/FunctionsCoreApi.md#ai_unstrip) | **POST** /v2/analyses/{analysis_id}/functions/ai-unstrip | Performs matching and auto-unstrip for an analysis and its functions
*FunctionsCoreApi* | [**auto_unstrip**](docs/FunctionsCoreApi.md#auto_unstrip) | **POST** /v2/analyses/{analysis_id}/functions/auto-unstrip | Performs matching and auto-unstrip for an analysis and its functions
*FunctionsCoreApi* | [**cancel_ai_unstrip**](docs/FunctionsCoreApi.md#cancel_ai_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/ai-unstrip/cancel | Cancels a running ai-unstrip
*FunctionsCoreApi* | [**cancel_auto_unstrip**](docs/FunctionsCoreApi.md#cancel_auto_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/unstrip/cancel | Cancels a running auto-unstrip
*FunctionsCoreApi* | [**get_analysis_strings**](docs/FunctionsCoreApi.md#get_analysis_strings) | **GET** /v2/analyses/{analysis_id}/functions/strings | Get string information found in the Analysis
*FunctionsCoreApi* | [**get_function_blocks**](docs/FunctionsCoreApi.md#get_function_blocks) | **GET** /v2/functions/{function_id}/blocks | Get disassembly blocks related to the function
*FunctionsCoreApi* | [**get_function_callees_callers**](docs/FunctionsCoreApi.md#get_function_callees_callers) | **GET** /v2/functions/{function_id}/callees_callers | Get list of functions that call or are called by the specified function
*FunctionsCoreApi* | [**get_function_capabilities**](docs/FunctionsCoreApi.md#get_function_capabilities) | **GET** /v2/functions/{function_id}/capabilities | Retrieve a functions capabilities
*FunctionsCoreApi* | [**get_function_details**](docs/FunctionsCoreApi.md#get_function_details) | **GET** /v2/functions/{function_id} | Get function details
*FunctionsCoreApi* | [**get_function_strings**](docs/FunctionsCoreApi.md#get_function_strings) | **GET** /v2/functions/{function_id}/strings | Get string information found in the function
*FunctionsCoreApi* | [**get_similar_functions**](docs/FunctionsCoreApi.md#get_similar_functions) | **GET** /v2/functions/{function_id}/similar-functions | Get list of similar functions
*FunctionsCoreApi* | [**unstrip**](docs/FunctionsCoreApi.md#unstrip) | **POST** /v2/analyses/{analysis_id}/functions/unstrip | Performs matching and auto-unstrip for an analysis and its functions
*FunctionsDataTypesApi* | [**generate_function_data_types_for_analysis**](docs/FunctionsDataTypesApi.md#generate_function_data_types_for_analysis) | **POST** /v2/analyses/{analysis_id}/functions/data_types | Generate Function Data Types
*FunctionsDataTypesApi* | [**generate_function_data_types_for_functions**](docs/FunctionsDataTypesApi.md#generate_function_data_types_for_functions) | **POST** /v2/functions/data_types | Generate Function Data Types for an arbitrary list of functions
*FunctionsDataTypesApi* | [**get_function_data_types**](docs/FunctionsDataTypesApi.md#get_function_data_types) | **GET** /v2/analyses/{analysis_id}/functions/{function_id}/data_types | Get Function Data Types
Expand Down Expand Up @@ -157,6 +163,7 @@ Class | Method | HTTP request | Description
- [ANNFunction](docs/ANNFunction.md)
- [Addr](docs/Addr.md)
- [AiDecompilationRating](docs/AiDecompilationRating.md)
- [AiUnstripRequest](docs/AiUnstripRequest.md)
- [AnalysisAccessInfo](docs/AnalysisAccessInfo.md)
- [AnalysisConfig](docs/AnalysisConfig.md)
- [AnalysisCreateRequest](docs/AnalysisCreateRequest.md)
Expand All @@ -166,28 +173,29 @@ Class | Method | HTTP request | Description
- [AnalysisRecord](docs/AnalysisRecord.md)
- [AnalysisScope](docs/AnalysisScope.md)
- [AnalysisStringsResponse](docs/AnalysisStringsResponse.md)
- [AnalysisTags](docs/AnalysisTags.md)
- [AnalysisThreatScoreData](docs/AnalysisThreatScoreData.md)
- [AnalysisUpdateRequest](docs/AnalysisUpdateRequest.md)
- [AnalysisUpdateTagsRequest](docs/AnalysisUpdateTagsRequest.md)
- [AnalysisUpdateTagsResponse](docs/AnalysisUpdateTagsResponse.md)
- [AppApiRestV2AnalysesEnumsDynamicExecutionStatus](docs/AppApiRestV2AnalysesEnumsDynamicExecutionStatus.md)
- [AppApiRestV2AnalysesEnumsOrderBy](docs/AppApiRestV2AnalysesEnumsOrderBy.md)
- [AppApiRestV2AnalysesResponsesAnalysisTags](docs/AppApiRestV2AnalysesResponsesAnalysisTags.md)
- [AppApiRestV2AnalysesResponsesTagItem](docs/AppApiRestV2AnalysesResponsesTagItem.md)
- [AppApiRestV2CollectionsEnumsOrderBy](docs/AppApiRestV2CollectionsEnumsOrderBy.md)
- [AppApiRestV2FunctionsResponsesFunction](docs/AppApiRestV2FunctionsResponsesFunction.md)
- [AppApiRestV2FunctionsTypesFunction](docs/AppApiRestV2FunctionsTypesFunction.md)
- [AppApiRestV2InfoResponsesAnalysisTags](docs/AppApiRestV2InfoResponsesAnalysisTags.md)
- [AppCoreResponsesBaseBaseResponseAnalysisTags1](docs/AppCoreResponsesBaseBaseResponseAnalysisTags1.md)
- [AppCoreResponsesBaseBaseResponseAnalysisTags2](docs/AppCoreResponsesBaseBaseResponseAnalysisTags2.md)
- [AppServicesBinaryAnnSchemaTagItem](docs/AppServicesBinaryAnnSchemaTagItem.md)
- [AppServicesDynamicExecutionSchemasDynamicExecutionStatus](docs/AppServicesDynamicExecutionSchemasDynamicExecutionStatus.md)
- [Argument](docs/Argument.md)
- [AutoUnstripByGroupResponse](docs/AutoUnstripByGroupResponse.md)
- [AutoUnstripRequest](docs/AutoUnstripRequest.md)
- [AutoUnstripResponse](docs/AutoUnstripResponse.md)
- [BaseResponse](docs/BaseResponse.md)
- [BaseResponseAnalysisCreateResponse](docs/BaseResponseAnalysisCreateResponse.md)
- [BaseResponseAnalysisDetailResponse](docs/BaseResponseAnalysisDetailResponse.md)
- [BaseResponseAnalysisFunctions](docs/BaseResponseAnalysisFunctions.md)
- [BaseResponseAnalysisStringsResponse](docs/BaseResponseAnalysisStringsResponse.md)
- [BaseResponseAnalysisTags](docs/BaseResponseAnalysisTags.md)
- [BaseResponseAnalysisThreatScoreData](docs/BaseResponseAnalysisThreatScoreData.md)
- [BaseResponseAnalysisUpdateTagsResponse](docs/BaseResponseAnalysisUpdateTagsResponse.md)
- [BaseResponseBasic](docs/BaseResponseBasic.md)
Expand Down Expand Up @@ -258,6 +266,7 @@ Class | Method | HTTP request | Description
- [BaseResponseTTPS](docs/BaseResponseTTPS.md)
- [BaseResponseTagSearchResponse](docs/BaseResponseTagSearchResponse.md)
- [BaseResponseTaskResponse](docs/BaseResponseTaskResponse.md)
- [BaseResponseUploadResponse](docs/BaseResponseUploadResponse.md)
- [BaseResponseVulnerabilities](docs/BaseResponseVulnerabilities.md)
- [Basic](docs/Basic.md)
- [BinaryAdditionalDetailsDataResponse](docs/BinaryAdditionalDetailsDataResponse.md)
Expand Down Expand Up @@ -378,6 +387,8 @@ Class | Method | HTTP request | Description
- [LoginRequest](docs/LoginRequest.md)
- [LoginResponse](docs/LoginResponse.md)
- [Logs](docs/Logs.md)
- [MatchedFunctionGroup](docs/MatchedFunctionGroup.md)
- [MatchedFunctionSuggestion](docs/MatchedFunctionSuggestion.md)
- [MetaModel](docs/MetaModel.md)
- [ModelName](docs/ModelName.md)
- [ModelsResponse](docs/ModelsResponse.md)
Expand Down Expand Up @@ -434,10 +445,9 @@ Class | Method | HTTP request | Description
- [TTPSData](docs/TTPSData.md)
- [TTPSElement](docs/TTPSElement.md)
- [TTPSOccurance](docs/TTPSOccurance.md)
- [Tag](docs/Tag.md)
- [TagConfidenceBody](docs/TagConfidenceBody.md)
- [TagInput](docs/TagInput.md)
- [TagOriginBoxPlotConfidence](docs/TagOriginBoxPlotConfidence.md)
- [TagOutput](docs/TagOutput.md)
- [TagResponse](docs/TagResponse.md)
- [TagSearchResponse](docs/TagSearchResponse.md)
- [TagSearchResult](docs/TagSearchResult.md)
Expand All @@ -447,7 +457,10 @@ Class | Method | HTTP request | Description
- [ThreatScoreFunctionBody](docs/ThreatScoreFunctionBody.md)
- [TimestampModel](docs/TimestampModel.md)
- [TypeDefinition](docs/TypeDefinition.md)
- [UnstripRequest](docs/UnstripRequest.md)
- [UpdateFunctionDataTypes](docs/UpdateFunctionDataTypes.md)
- [UploadFileType](docs/UploadFileType.md)
- [UploadResponse](docs/UploadResponse.md)
- [UpsertAiDecomplationRatingRequest](docs/UpsertAiDecomplationRatingRequest.md)
- [UserActivityResponse](docs/UserActivityResponse.md)
- [Vulnerabilities](docs/Vulnerabilities.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/ANNFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**limit** | **int** | The amount of neighbours per function ID | [optional] [default to 5]
**distance** | **float** | The distance between two neighbours | [optional] [default to 0.1]
**analysis_search_ids** | **List[Optional[int]]** | Perform a search on functions within a list of analyses | [optional] [default to []]
**collection_search_ids** | **List[Optional[int]]** | Search only within these collections | [optional] [default to []]
**analysis_search_ids** | **List[int]** | Perform a search on functions within a list of analyses | [optional] [default to []]
**collection_search_ids** | **List[int]** | Search only within these collections | [optional] [default to []]
**search_binary_ids** | [**SearchBinaryIds**](SearchBinaryIds.md) | | [optional]
**search_function_ids** | [**SearchFunctionIds**](SearchFunctionIds.md) | | [optional]
**debug_only** | **bool** | Searches for only functions which are debug | [optional] [default to False]
Expand Down
29 changes: 29 additions & 0 deletions docs/AiUnstripRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# AiUnstripRequest


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**apply** | **bool** | Whether to apply the suggested function names to the target functions, default is False | [optional] [default to False]

## Example

```python
from revengai.models.ai_unstrip_request import AiUnstripRequest

# TODO update the JSON string below
json = "{}"
# create an instance of AiUnstripRequest from a JSON string
ai_unstrip_request_instance = AiUnstripRequest.from_json(json)
# print the JSON string representation of the object
print(AiUnstripRequest.to_json())

# convert the object into a dict
ai_unstrip_request_dict = ai_unstrip_request_instance.to_dict()
# create an instance of AiUnstripRequest from a dict
ai_unstrip_request_from_dict = AiUnstripRequest.from_dict(ai_unstrip_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


88 changes: 88 additions & 0 deletions docs/AnalysesCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Method | HTTP request | Description
[**requeue_analysis**](AnalysesCoreApi.md#requeue_analysis) | **POST** /v2/analyses/{analysis_id}/requeue | Requeue Analysis
[**update_analysis**](AnalysesCoreApi.md#update_analysis) | **PATCH** /v2/analyses/{analysis_id} | Update Analysis
[**update_analysis_tags**](AnalysesCoreApi.md#update_analysis_tags) | **PATCH** /v2/analyses/{analysis_id}/tags | Update Analysis Tags
[**upload_file**](AnalysesCoreApi.md#upload_file) | **POST** /v2/upload | Upload File


# **create_analysis**
Expand Down Expand Up @@ -1215,3 +1216,90 @@ Name | Type | Description | Notes

[[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)

# **upload_file**
> BaseResponseUploadResponse upload_file(upload_file_type, file, packed_password=packed_password, authorization=authorization, force_overwrite=force_overwrite)

Upload File

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.base_response_upload_response import BaseResponseUploadResponse
from revengai.models.upload_file_type import UploadFileType
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
host = "https://api.reveng.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = revengai.AnalysesCoreApi(api_client)
upload_file_type = revengai.UploadFileType() # UploadFileType |
file = None # bytearray |
packed_password = 'packed_password_example' # str | (optional)
authorization = 'authorization_example' # str | API Key bearer token (optional)
force_overwrite = False # bool | (optional) (default to False)

try:
# Upload File
api_response = api_instance.upload_file(upload_file_type, file, packed_password=packed_password, authorization=authorization, force_overwrite=force_overwrite)
print("The response of AnalysesCoreApi->upload_file:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysesCoreApi->upload_file: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**upload_file_type** | [**UploadFileType**](UploadFileType.md)| |
**file** | **bytearray**| |
**packed_password** | **str**| | [optional]
**authorization** | **str**| API Key bearer token | [optional]
**force_overwrite** | **bool**| | [optional] [default to False]

### Return type

[**BaseResponseUploadResponse**](BaseResponseUploadResponse.md)

### Authorization

[APIKey](../README.md#APIKey)

### HTTP request headers

- **Content-Type**: multipart/form-data
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Invalid request parameters | - |

[[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)

6 changes: 3 additions & 3 deletions docs/AnalysesResultsMetadataApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ Name | Type | Description | Notes
[[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)

# **get_tags**
> AppCoreResponsesBaseBaseResponseAnalysisTags2 get_tags(analysis_id, authorization=authorization)
> BaseResponseAnalysisTags get_tags(analysis_id, authorization=authorization)

Get function tags with maliciousness score

Expand All @@ -434,7 +434,7 @@ Get function tags with maliciousness score

```python
import revengai
from revengai.models.app_core_responses_base_base_response_analysis_tags2 import AppCoreResponsesBaseBaseResponseAnalysisTags2
from revengai.models.base_response_analysis_tags import BaseResponseAnalysisTags
from revengai.rest import ApiException
from pprint import pprint

Expand Down Expand Up @@ -483,7 +483,7 @@ Name | Type | Description | Notes

### Return type

[**AppCoreResponsesBaseBaseResponseAnalysisTags2**](AppCoreResponsesBaseBaseResponseAnalysisTags2.md)
[**BaseResponseAnalysisTags**](BaseResponseAnalysisTags.md)

### Authorization

Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysisCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filename** | **str** | The name of the file |
**sha_256_hash** | **str** | The name of the file |
**tags** | [**List[TagInput]**](TagInput.md) | List of community tags to assign to an analysis | [optional] [default to []]
**tags** | [**List[Tag]**](Tag.md) | List of community tags to assign to an analysis | [optional] [default to []]
**analysis_scope** | [**AnalysisScope**](AnalysisScope.md) | The scope of the analysis determines who can access it | [optional]
**symbols** | [**Symbols**](Symbols.md) | | [optional]
**debug_hash** | **str** | | [optional]
Expand Down
30 changes: 30 additions & 0 deletions docs/AnalysisTags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AnalysisTags


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**analysis_tags** | [**List[AppApiRestV2AnalysesResponsesTagItem]**](AppApiRestV2AnalysesResponsesTagItem.md) | |
**suggested_tags** | [**List[AppApiRestV2AnalysesResponsesTagItem]**](AppApiRestV2AnalysesResponsesTagItem.md) | |

## Example

```python
from revengai.models.analysis_tags import AnalysisTags

# TODO update the JSON string below
json = "{}"
# create an instance of AnalysisTags from a JSON string
analysis_tags_instance = AnalysisTags.from_json(json)
# print the JSON string representation of the object
print(AnalysisTags.to_json())

# convert the object into a dict
analysis_tags_dict = analysis_tags_instance.to_dict()
# create an instance of AnalysisTags from a dict
analysis_tags_from_dict = AnalysisTags.from_dict(analysis_tags_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading