Skip to content
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .sdk-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v4.13.0
v4.20.0
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,11 @@ Class | Method | HTTP request | Description
*AgentApi* | [**get_triage_result_v2_analyses_analysis_id_agent_triage_get**](docs/AgentApi.md#get_triage_result_v2_analyses_analysis_id_agent_triage_get) | **GET** /v2/analyses/{analysis_id}/agent/triage | Get Triage Result
*AgentApi* | [**v3_cancel_rename_unnamed_functions**](docs/AgentApi.md#v3_cancel_rename_unnamed_functions) | **POST** /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/cancel | Cancel the rename-unnamed-functions agent.
*AgentApi* | [**v3_cancel_security_scan_operation**](docs/AgentApi.md#v3_cancel_security_scan_operation) | **POST** /v3/operations/security-scan/{analysis_id}:cancel | Cancel a security-scan operation.
*AgentApi* | [**v3_get_crypto_scan_operation**](docs/AgentApi.md#v3_get_crypto_scan_operation) | **GET** /v3/operations/crypto-scan/{analysis_id} | Get a crypto-scan operation.
*AgentApi* | [**v3_get_rename_unnamed_functions_result**](docs/AgentApi.md#v3_get_rename_unnamed_functions_result) | **GET** /v3/analyses/{analysis_id}/agents/rename-unnamed-functions | Get rename-unnamed-functions agent result.
*AgentApi* | [**v3_get_rename_unnamed_functions_status**](docs/AgentApi.md#v3_get_rename_unnamed_functions_status) | **GET** /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/status | Get rename-unnamed-functions agent status.
*AgentApi* | [**v3_get_security_scan_operation**](docs/AgentApi.md#v3_get_security_scan_operation) | **GET** /v3/operations/security-scan/{analysis_id} | Get a security-scan operation.
*AgentApi* | [**v3_run_crypto_scan**](docs/AgentApi.md#v3_run_crypto_scan) | **POST** /v3/analyses/{analysis_id}/crypto-scan:run | Run the crypto-scan agent.
*AgentApi* | [**v3_run_security_scan**](docs/AgentApi.md#v3_run_security_scan) | **POST** /v3/analyses/{analysis_id}/security-scan:run | Run the security-scan agent.
*AgentApi* | [**v3_trigger_rename_unnamed_functions**](docs/AgentApi.md#v3_trigger_rename_unnamed_functions) | **POST** /v3/analyses/{analysis_id}/agents/rename-unnamed-functions | Run the rename-unnamed-functions agent.
*AnalysesBulkActionsApi* | [**bulk_add_analysis_tags**](docs/AnalysesBulkActionsApi.md#bulk_add_analysis_tags) | **PATCH** /v2/analyses/tags/add | Bulk Add Analysis Tags
Expand Down Expand Up @@ -167,6 +169,7 @@ Class | Method | HTTP request | Description
*FunctionsAIDecompilationApi* | [**upsert_ai_decompilation_rating**](docs/FunctionsAIDecompilationApi.md#upsert_ai_decompilation_rating) | **PATCH** /v2/functions/{function_id}/ai-decompilation/rating | Upsert rating for AI decompilation
*FunctionsAIDecompilationApi* | [**v3_get_ai_decompilation_line_attributions**](docs/FunctionsAIDecompilationApi.md#v3_get_ai_decompilation_line_attributions) | **GET** /v3/functions/{function_id}/ai-decompilation/line-attributions | Get AI decompilation line attributions
*FunctionsAIDecompilationApi* | [**v3_get_ai_decompilation_tokens**](docs/FunctionsAIDecompilationApi.md#v3_get_ai_decompilation_tokens) | **GET** /v3/functions/{function_id}/ai-decompilation/tokens | Get AI decompilation tokens and user overrides
*FunctionsAIDecompilationApi* | [**v3_get_ai_decompilation_type_suggestions**](docs/FunctionsAIDecompilationApi.md#v3_get_ai_decompilation_type_suggestions) | **GET** /v3/functions/{function_id}/ai-decompilation/type-suggestions | Get AI decompilation type suggestions
*FunctionsAIDecompilationApi* | [**v3_upsert_ai_decompilation_overrides**](docs/FunctionsAIDecompilationApi.md#v3_upsert_ai_decompilation_overrides) | **PATCH** /v3/functions/{function_id}/ai-decompilation/overrides | Upsert variable/function name overrides
*FunctionsCoreApi* | [**add_function_callee**](docs/FunctionsCoreApi.md#add_function_callee) | **POST** /v3/functions/{function_id}/callees | Add a callee to a function
*FunctionsCoreApi* | [**add_user_string_to_function**](docs/FunctionsCoreApi.md#add_user_string_to_function) | **POST** /v3/functions/{function_id}/user-provided-strings | Add a user-provided string to a function.
Expand Down Expand Up @@ -423,6 +426,11 @@ Class | Method | HTTP request | Description
- [CreateUnknownDataType](docs/CreateUnknownDataType.md)
- [CreateUserInputBody](docs/CreateUserInputBody.md)
- [Created](docs/Created.md)
- [CryptoCall](docs/CryptoCall.md)
- [CryptoDirectMatch](docs/CryptoDirectMatch.md)
- [CryptoFinding](docs/CryptoFinding.md)
- [CryptoScanMetadata](docs/CryptoScanMetadata.md)
- [CryptoScanResult](docs/CryptoScanResult.md)
- [DataTypeEntry](docs/DataTypeEntry.md)
- [DataTypeEnumValueEntry](docs/DataTypeEnumValueEntry.md)
- [DataTypeFunctionEntry](docs/DataTypeFunctionEntry.md)
Expand Down Expand Up @@ -479,6 +487,7 @@ Class | Method | HTTP request | Description
- [EventTOOLCALLRESULT](docs/EventTOOLCALLRESULT.md)
- [EventTOOLCALLSTART](docs/EventTOOLCALLSTART.md)
- [EventTOOLCONFIRMATIONREQUIRED](docs/EventTOOLCONFIRMATIONREQUIRED.md)
- [EventTypesSuggested](docs/EventTypesSuggested.md)
- [EventWarning](docs/EventWarning.md)
- [Example](docs/Example.md)
- [ExportModel](docs/ExportModel.md)
Expand Down Expand Up @@ -583,6 +592,7 @@ Class | Method | HTTP request | Description
- [NamesFinishedEvent](docs/NamesFinishedEvent.md)
- [NetworkActivity](docs/NetworkActivity.md)
- [OIDCCallbackInputBody](docs/OIDCCallbackInputBody.md)
- [OperationCryptoScanMetadataCryptoScanResult](docs/OperationCryptoScanMetadataCryptoScanResult.md)
- [OperationSecurityScanMetadataSecurityScanResult](docs/OperationSecurityScanMetadataSecurityScanResult.md)
- [OperationWorkflowProgressResultBody](docs/OperationWorkflowProgressResultBody.md)
- [Order](docs/Order.md)
Expand Down Expand Up @@ -700,6 +710,9 @@ Class | Method | HTTP request | Description
- [StructDataType](docs/StructDataType.md)
- [StructDefinition](docs/StructDefinition.md)
- [SubmitUserFeedbackRequest](docs/SubmitUserFeedbackRequest.md)
- [SuggestedHole](docs/SuggestedHole.md)
- [SuggestedMemberView](docs/SuggestedMemberView.md)
- [SuggestedTypeView](docs/SuggestedTypeView.md)
- [SummaryData](docs/SummaryData.md)
- [Symbols](docs/Symbols.md)
- [Tag](docs/Tag.md)
Expand All @@ -720,12 +733,15 @@ Class | Method | HTTP request | Description
- [TokenisedData](docs/TokenisedData.md)
- [TriageFunctionResponse](docs/TriageFunctionResponse.md)
- [TriageReportResponse](docs/TriageReportResponse.md)
- [TriggerCryptoScanInputBody](docs/TriggerCryptoScanInputBody.md)
- [TriggerDynamicExecutionInputBody](docs/TriggerDynamicExecutionInputBody.md)
- [TriggerRenameUnnamedFunctionsInputBody](docs/TriggerRenameUnnamedFunctionsInputBody.md)
- [TriggerSecurityScanInputBody](docs/TriggerSecurityScanInputBody.md)
- [Ttp](docs/Ttp.md)
- [TypeSuggestionsData](docs/TypeSuggestionsData.md)
- [TypedefDataType](docs/TypedefDataType.md)
- [TypedefDefinition](docs/TypedefDefinition.md)
- [TypesSuggestedEvent](docs/TypesSuggestedEvent.md)
- [UnionDataType](docs/UnionDataType.md)
- [UnionDefinition](docs/UnionDefinition.md)
- [UnknownDataType](docs/UnknownDataType.md)
Expand Down
193 changes: 193 additions & 0 deletions docs/AgentApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ Method | HTTP request | Description
[**get_triage_result_v2_analyses_analysis_id_agent_triage_get**](AgentApi.md#get_triage_result_v2_analyses_analysis_id_agent_triage_get) | **GET** /v2/analyses/{analysis_id}/agent/triage | Get Triage Result
[**v3_cancel_rename_unnamed_functions**](AgentApi.md#v3_cancel_rename_unnamed_functions) | **POST** /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/cancel | Cancel the rename-unnamed-functions agent.
[**v3_cancel_security_scan_operation**](AgentApi.md#v3_cancel_security_scan_operation) | **POST** /v3/operations/security-scan/{analysis_id}:cancel | Cancel a security-scan operation.
[**v3_get_crypto_scan_operation**](AgentApi.md#v3_get_crypto_scan_operation) | **GET** /v3/operations/crypto-scan/{analysis_id} | Get a crypto-scan operation.
[**v3_get_rename_unnamed_functions_result**](AgentApi.md#v3_get_rename_unnamed_functions_result) | **GET** /v3/analyses/{analysis_id}/agents/rename-unnamed-functions | Get rename-unnamed-functions agent result.
[**v3_get_rename_unnamed_functions_status**](AgentApi.md#v3_get_rename_unnamed_functions_status) | **GET** /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/status | Get rename-unnamed-functions agent status.
[**v3_get_security_scan_operation**](AgentApi.md#v3_get_security_scan_operation) | **GET** /v3/operations/security-scan/{analysis_id} | Get a security-scan operation.
[**v3_run_crypto_scan**](AgentApi.md#v3_run_crypto_scan) | **POST** /v3/analyses/{analysis_id}/crypto-scan:run | Run the crypto-scan agent.
[**v3_run_security_scan**](AgentApi.md#v3_run_security_scan) | **POST** /v3/analyses/{analysis_id}/security-scan:run | Run the security-scan agent.
[**v3_trigger_rename_unnamed_functions**](AgentApi.md#v3_trigger_rename_unnamed_functions) | **POST** /v3/analyses/{analysis_id}/agents/rename-unnamed-functions | Run the rename-unnamed-functions agent.

Expand Down Expand Up @@ -1229,6 +1231,99 @@ void (empty response body)

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

# **v3_get_crypto_scan_operation**
> OperationCryptoScanMetadataCryptoScanResult v3_get_crypto_scan_operation(analysis_id)

Get a crypto-scan operation.

Returns the current state of the crypto-scan run for this analysis.

**Error codes:**
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) β€” Not Found
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) β€” Access Denied

### Example

* Api Key Authentication (APIKey):
* Bearer Authentication (bearerAuth):

```python
import revengai
from revengai.models.operation_crypto_scan_metadata_crypto_scan_result import OperationCryptoScanMetadataCryptoScanResult
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'

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# 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.AgentApi(api_client)
analysis_id = 56 # int | Analysis ID

try:
# Get a crypto-scan operation.
api_response = api_instance.v3_get_crypto_scan_operation(analysis_id)
print("The response of AgentApi->v3_get_crypto_scan_operation:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AgentApi->v3_get_crypto_scan_operation: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| Analysis ID |

### Return type

[**OperationCryptoScanMetadataCryptoScanResult**](OperationCryptoScanMetadataCryptoScanResult.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**403** | Forbidden | - |
**404** | Not Found | - |
**422** | Unprocessable Entity | - |
**500** | Internal Server Error | - |

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

# **v3_get_rename_unnamed_functions_result**
> RenameUnnamedFunctionsResult v3_get_rename_unnamed_functions_result(analysis_id)

Expand Down Expand Up @@ -1510,6 +1605,104 @@ 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)

# **v3_run_crypto_scan**
> OperationCryptoScanMetadataCryptoScanResult v3_run_crypto_scan(analysis_id, trigger_crypto_scan_input_body)

Run the crypto-scan agent.

Starts an agent that name-matches the analysis' functions and their callees against known crypto-library APIs, and returns the operation to poll for its outcome. Purely name-based β€” never triggers AI decompilation, so it costs no credits and runs in seconds. Returns 409 while a run is already in progress for this analysis.

**Error codes:**
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) β€” Not Found
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) β€” Access Denied
- `409` [`CONFLICT`](/errors/CONFLICT) β€” Conflict

### Example

* Api Key Authentication (APIKey):
* Bearer Authentication (bearerAuth):

```python
import revengai
from revengai.models.operation_crypto_scan_metadata_crypto_scan_result import OperationCryptoScanMetadataCryptoScanResult
from revengai.models.trigger_crypto_scan_input_body import TriggerCryptoScanInputBody
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'

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# 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.AgentApi(api_client)
analysis_id = 56 # int | Analysis ID
trigger_crypto_scan_input_body = revengai.TriggerCryptoScanInputBody() # TriggerCryptoScanInputBody |

try:
# Run the crypto-scan agent.
api_response = api_instance.v3_run_crypto_scan(analysis_id, trigger_crypto_scan_input_body)
print("The response of AgentApi->v3_run_crypto_scan:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AgentApi->v3_run_crypto_scan: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| Analysis ID |
**trigger_crypto_scan_input_body** | [**TriggerCryptoScanInputBody**](TriggerCryptoScanInputBody.md)| |

### Return type

[**OperationCryptoScanMetadataCryptoScanResult**](OperationCryptoScanMetadataCryptoScanResult.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**403** | Forbidden | - |
**404** | Not Found | - |
**409** | Conflict | - |
**422** | Unprocessable Entity | - |
**500** | Internal Server Error | - |

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

# **v3_run_security_scan**
> OperationSecurityScanMetadataSecurityScanResult v3_run_security_scan(analysis_id, trigger_security_scan_input_body)

Expand Down
33 changes: 33 additions & 0 deletions docs/CryptoCall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# CryptoCall


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**callee_name** | **str** | Name of the called function |
**category** | **str** | Crypto category of the match |
**how** | **str** | Detection tier that produced the match |
**library** | **str** | Crypto library the match belongs to |
**matched_name** | **str** | Name or token that matched |

## Example

```python
from revengai.models.crypto_call import CryptoCall

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

# convert the object into a dict
crypto_call_dict = crypto_call_instance.to_dict()
# create an instance of CryptoCall from a dict
crypto_call_from_dict = CryptoCall.from_dict(crypto_call_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)


32 changes: 32 additions & 0 deletions docs/CryptoDirectMatch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# CryptoDirectMatch


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **str** | Crypto category of the match |
**how** | **str** | Detection tier that produced the match |
**library** | **str** | Crypto library the match belongs to |
**matched_name** | **str** | Name or token that matched |

## Example

```python
from revengai.models.crypto_direct_match import CryptoDirectMatch

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

# convert the object into a dict
crypto_direct_match_dict = crypto_direct_match_instance.to_dict()
# create an instance of CryptoDirectMatch from a dict
crypto_direct_match_from_dict = CryptoDirectMatch.from_dict(crypto_direct_match_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