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
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .sdk-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.51.0
v3.55.0
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Class | Method | HTTP request | Description
*AnalysesCoreApi* | [**insert_analysis_log**](docs/AnalysesCoreApi.md#insert_analysis_log) | **POST** /v2/analyses/{analysis_id}/logs | Insert a log entry for an analysis
*AnalysesCoreApi* | [**list_analyses**](docs/AnalysesCoreApi.md#list_analyses) | **GET** /v2/analyses/list | Gets the most recent analyses
*AnalysesCoreApi* | [**lookup_binary_id**](docs/AnalysesCoreApi.md#lookup_binary_id) | **GET** /v2/analyses/lookup/{binary_id} | Gets the analysis ID from binary ID
*AnalysesCoreApi* | [**put_analysis_strings**](docs/AnalysesCoreApi.md#put_analysis_strings) | **PUT** /v2/analyses/{analysis_id}/strings | Add strings to the analysis
*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
Expand Down Expand Up @@ -178,6 +179,7 @@ Class | Method | HTTP request | Description
- [AnalysisStage](docs/AnalysisStage.md)
- [AnalysisStageStatus](docs/AnalysisStageStatus.md)
- [AnalysisStagesResponse](docs/AnalysisStagesResponse.md)
- [AnalysisStringInput](docs/AnalysisStringInput.md)
- [AnalysisStringsResponse](docs/AnalysisStringsResponse.md)
- [AnalysisStringsStatusResponse](docs/AnalysisStringsStatusResponse.md)
- [AnalysisTags](docs/AnalysisTags.md)
Expand Down Expand Up @@ -417,6 +419,7 @@ Class | Method | HTTP request | Description
- [ProcessDumpsData](docs/ProcessDumpsData.md)
- [ProcessRegistry](docs/ProcessRegistry.md)
- [ProcessTree](docs/ProcessTree.md)
- [PutAnalysisStringsRequest](docs/PutAnalysisStringsRequest.md)
- [QueuedSecurityChecksTaskResponse](docs/QueuedSecurityChecksTaskResponse.md)
- [ReAnalysisForm](docs/ReAnalysisForm.md)
- [Recent](docs/Recent.md)
Expand All @@ -442,6 +445,7 @@ Class | Method | HTTP request | Description
- [StatusInput](docs/StatusInput.md)
- [StatusOutput](docs/StatusOutput.md)
- [StringFunctions](docs/StringFunctions.md)
- [StringSource](docs/StringSource.md)
- [Structure](docs/Structure.md)
- [StructureMember](docs/StructureMember.md)
- [Symbols](docs/Symbols.md)
Expand Down
10 changes: 5 additions & 5 deletions docs/AnalysesCommentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Successful Response | - |
**422** | Invalid request parameters | - |
**400** | Bad Request | - |
**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)

Expand Down Expand Up @@ -172,9 +172,9 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Invalid request parameters | - |
**403** | You can only delete your own comments | - |
**400** | Bad Request | - |
**403** | You can only delete your own comments | - |
**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)

Expand Down Expand Up @@ -339,9 +339,9 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Invalid request parameters | - |
**403** | You can only update your own comments | - |
**400** | Bad Request | - |
**403** | You can only update your own comments | - |
**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)

104 changes: 94 additions & 10 deletions docs/AnalysesCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Method | HTTP request | Description
[**insert_analysis_log**](AnalysesCoreApi.md#insert_analysis_log) | **POST** /v2/analyses/{analysis_id}/logs | Insert a log entry for an analysis
[**list_analyses**](AnalysesCoreApi.md#list_analyses) | **GET** /v2/analyses/list | Gets the most recent analyses
[**lookup_binary_id**](AnalysesCoreApi.md#lookup_binary_id) | **GET** /v2/analyses/lookup/{binary_id} | Gets the analysis ID from binary ID
[**put_analysis_strings**](AnalysesCoreApi.md#put_analysis_strings) | **PUT** /v2/analyses/{analysis_id}/strings | Add strings to the analysis
[**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
Expand Down Expand Up @@ -181,9 +182,9 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Successful Response | - |
**422** | Invalid request parameters | - |
**404** | Not Found | - |
**400** | Bad Request | - |
**404** | Not Found | - |
**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)

Expand Down Expand Up @@ -263,9 +264,9 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Invalid request parameters | - |
**404** | Not Found | - |
**403** | Forbidden | - |
**404** | Not Found | - |
**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)

Expand Down Expand Up @@ -937,6 +938,89 @@ 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)

# **put_analysis_strings**
> BaseResponse put_analysis_strings(analysis_id, put_analysis_strings_request)

Add strings to the analysis

Add strings to the analysis. Rejects if any string already exists at the given vaddr.

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.base_response import BaseResponse
from revengai.models.put_analysis_strings_request import PutAnalysisStringsRequest
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)
analysis_id = 56 # int |
put_analysis_strings_request = revengai.PutAnalysisStringsRequest() # PutAnalysisStringsRequest |

try:
# Add strings to the analysis
api_response = api_instance.put_analysis_strings(analysis_id, put_analysis_strings_request)
print("The response of AnalysesCoreApi->put_analysis_strings:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysesCoreApi->put_analysis_strings: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| |
**put_analysis_strings_request** | [**PutAnalysisStringsRequest**](PutAnalysisStringsRequest.md)| |

### Return type

[**BaseResponse**](BaseResponse.md)

### Authorization

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

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | 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)

# **requeue_analysis**
> BaseResponseCreated requeue_analysis(analysis_id, re_analysis_form, x_rev_eng_application=x_rev_eng_application)

Expand Down Expand Up @@ -1018,9 +1102,9 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Successful Response | - |
**422** | Invalid request parameters | - |
**404** | Not Found | - |
**400** | Bad Request | - |
**404** | Not Found | - |
**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)

Expand Down Expand Up @@ -1191,7 +1275,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)

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

Upload File

Expand Down Expand Up @@ -1227,14 +1311,14 @@ configuration.api_key['APIKey'] = os.environ["API_KEY"]
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 |
upload_file_type = revengai.UploadFileType() # UploadFileType |
packed_password = 'packed_password_example' # str | (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, force_overwrite=force_overwrite)
api_response = api_instance.upload_file(file, upload_file_type, packed_password=packed_password, force_overwrite=force_overwrite)
print("The response of AnalysesCoreApi->upload_file:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -1248,8 +1332,8 @@ with revengai.ApiClient(configuration) as api_client:

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

Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysesSecurityChecksApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | Successful Response | - |
**422** | Invalid request parameters | - |
**409** | Security checks already extracted or queued | - |
**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)

Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysesXRefsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Invalid request parameters | - |
**404** | Xref or analysis cache not found | - |
**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)

2 changes: 1 addition & 1 deletion docs/AnalysisBulkAddTagsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tags** | **List[str]** | |
**analysis_ids** | **List[int]** | |
**tags** | **List[str]** | |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysisBulkAddTagsResponseItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**analysis_id** | **int** | |
**message** | **str** | |
**error** | **str** | | [optional]
**message** | **str** | |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/AnalysisConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**scrape_third_party_config** | [**ScrapeThirdPartyConfig**](ScrapeThirdPartyConfig.md) | Settings to scrape third party sources | [optional]
**advanced_analysis** | **bool** | Enables an advanced security analysis. | [optional] [default to False]
**generate_capabilities** | **bool** | A configuration option for generating capabilities of a binary | [optional] [default to False]
**generate_cves** | **bool** | A configuration option for fetching CVEs data. | [optional] [default to False]
**generate_sbom** | **bool** | A configuration option for generating software bill of materials data. | [optional] [default to False]
**generate_capabilities** | **bool** | A configuration option for generating capabilities of a binary | [optional] [default to False]
**no_cache** | **bool** | When enabled, skips using cached data within the processing. | [optional] [default to False]
**advanced_analysis** | **bool** | Enables an advanced security analysis. | [optional] [default to False]
**sandbox_config** | [**SandboxOptions**](SandboxOptions.md) | Including a sandbox config enables the dynamic execution sandbox | [optional]
**scrape_third_party_config** | [**ScrapeThirdPartyConfig**](ScrapeThirdPartyConfig.md) | Settings to scrape third party sources | [optional]

## Example

Expand Down
12 changes: 6 additions & 6 deletions docs/AnalysisCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**analysis_config** | [**AnalysisConfig**](AnalysisConfig.md) | The analysis config enables the configuration of optional analysis stages | [optional]
**analysis_scope** | [**AnalysisScope**](AnalysisScope.md) | The scope of the analysis determines who can access it | [optional]
**auto_run_agents** | [**AutoRunAgents**](AutoRunAgents.md) | | [optional]
**binary_config** | [**BinaryConfig**](BinaryConfig.md) | The binary config can override automatically determined values such as ISA, Platform, File Format, etc | [optional]
**debug_hash** | **str** | | [optional]
**filename** | **str** | The name of the file |
**sha_256_hash** | **str** | The name of the file |
**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]
**analysis_config** | [**AnalysisConfig**](AnalysisConfig.md) | The analysis config enables the configuration of optional analysis stages | [optional]
**binary_config** | [**BinaryConfig**](BinaryConfig.md) | The binary config can override automatically determined values such as ISA, Platform, File Format, etc | [optional]
**auto_run_agents** | [**AutoRunAgents**](AutoRunAgents.md) | | [optional]
**tags** | [**List[Tag]**](Tag.md) | List of community tags to assign to an analysis | [optional] [default to []]

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysisDetailResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**analysis_id** | **int** | |
**analysis_scope** | **str** | |
**architecture** | **str** | |
**auto_run_agents** | [**AutoRunAgents**](AutoRunAgents.md) | |
**binary_dynamic** | **bool** | |
**binary_format** | **str** | |
**binary_name** | **str** | |
Expand All @@ -20,7 +21,6 @@ Name | Type | Description | Notes
**model_name** | **str** | |
**sbom** | **Dict[str, object]** | | [optional]
**sha_256_hash** | **str** | |
**auto_run_agents** | [**AutoRunAgents**](AutoRunAgents.md) | |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/AnalysisFunctionMatchingRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90.0]
**filters** | [**FunctionMatchingFilters**](FunctionMatchingFilters.md) | | [optional]
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 10 | [optional] [default to 1]
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90]
**no_cache** | **bool** | If set to true, forces the system to bypass any cached results and perform a fresh computation | [optional] [default to False]
**page** | **int** | Page number for paginated results, default is 1 (first page) | [optional] [default to 1]
**page_size** | **int** | Number of functions to return per page, default is 0 (all functions), max is 1000 | [optional] [default to 0]
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 10 | [optional] [default to 1]
**status_only** | **bool** | If set to true, only returns the status of the matching operation without the actual results | [optional] [default to False]
**no_cache** | **bool** | If set to true, forces the system to bypass any cached results and perform a fresh computation | [optional] [default to False]
**use_canonical_names** | **bool** | Whether to use canonical function names during function matching for confidence results, default is False | [optional] [default to False]

## Example
Expand Down
Loading