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 @@
v3.51.0
v3.55.2
8 changes: 4 additions & 4 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 All @@ -69,7 +70,6 @@ Class | Method | HTTP request | Description
*AnalysesDynamicExecutionApi* | [**get_ttps**](docs/AnalysesDynamicExecutionApi.md#get_ttps) | **GET** /v2/analyses/{analysis_id}/dynamic-execution/ttps | Get the dynamic execution results for ttps
*AnalysesResultsMetadataApi* | [**get_analysis_functions_paginated**](docs/AnalysesResultsMetadataApi.md#get_analysis_functions_paginated) | **GET** /v2/analyses/{analysis_id}/functions | Get functions from analysis
*AnalysesResultsMetadataApi* | [**get_capabilities**](docs/AnalysesResultsMetadataApi.md#get_capabilities) | **GET** /v2/analyses/{analysis_id}/capabilities | Gets the capabilities from the analysis
*AnalysesResultsMetadataApi* | [**get_communities**](docs/AnalysesResultsMetadataApi.md#get_communities) | **GET** /v2/analyses/{analysis_id}/communities | Gets the communities found in the analysis
*AnalysesResultsMetadataApi* | [**get_functions_list**](docs/AnalysesResultsMetadataApi.md#get_functions_list) | **GET** /v2/analyses/{analysis_id}/functions/list | Gets functions from analysis
*AnalysesResultsMetadataApi* | [**get_pdf**](docs/AnalysesResultsMetadataApi.md#get_pdf) | **GET** /v2/analyses/{analysis_id}/pdf | Gets the PDF found in the analysis
*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
Expand Down Expand Up @@ -178,6 +178,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 @@ -225,7 +226,6 @@ Class | Method | HTTP request | Description
- [BaseResponseCollectionSearchResponse](docs/BaseResponseCollectionSearchResponse.md)
- [BaseResponseCollectionTagsUpdateResponse](docs/BaseResponseCollectionTagsUpdateResponse.md)
- [BaseResponseCommentResponse](docs/BaseResponseCommentResponse.md)
- [BaseResponseCommunities](docs/BaseResponseCommunities.md)
- [BaseResponseConfigResponse](docs/BaseResponseConfigResponse.md)
- [BaseResponseCreated](docs/BaseResponseCreated.md)
- [BaseResponseDict](docs/BaseResponseDict.md)
Expand Down Expand Up @@ -309,8 +309,6 @@ Class | Method | HTTP request | Description
- [CommentBase](docs/CommentBase.md)
- [CommentResponse](docs/CommentResponse.md)
- [CommentUpdateRequest](docs/CommentUpdateRequest.md)
- [Communities](docs/Communities.md)
- [CommunityMatchPercentages](docs/CommunityMatchPercentages.md)
- [ConfidenceType](docs/ConfidenceType.md)
- [ConfigResponse](docs/ConfigResponse.md)
- [Context](docs/Context.md)
Expand Down Expand Up @@ -417,6 +415,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 +441,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
84 changes: 84 additions & 0 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 @@ -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
81 changes: 0 additions & 81 deletions docs/AnalysesResultsMetadataApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**get_analysis_functions_paginated**](AnalysesResultsMetadataApi.md#get_analysis_functions_paginated) | **GET** /v2/analyses/{analysis_id}/functions | Get functions from analysis
[**get_capabilities**](AnalysesResultsMetadataApi.md#get_capabilities) | **GET** /v2/analyses/{analysis_id}/capabilities | Gets the capabilities from the analysis
[**get_communities**](AnalysesResultsMetadataApi.md#get_communities) | **GET** /v2/analyses/{analysis_id}/communities | Gets the communities found in the analysis
[**get_functions_list**](AnalysesResultsMetadataApi.md#get_functions_list) | **GET** /v2/analyses/{analysis_id}/functions/list | Gets functions from analysis
[**get_pdf**](AnalysesResultsMetadataApi.md#get_pdf) | **GET** /v2/analyses/{analysis_id}/pdf | Gets the PDF found in the analysis
[**get_sbom**](AnalysesResultsMetadataApi.md#get_sbom) | **GET** /v2/analyses/{analysis_id}/sbom | Gets the software-bill-of-materials (SBOM) found in the analysis
Expand Down Expand Up @@ -176,86 +175,6 @@ 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_communities**
> BaseResponseCommunities get_communities(analysis_id, user_name=user_name)

Gets the communities found in the analysis

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.base_response_communities import BaseResponseCommunities
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.AnalysesResultsMetadataApi(api_client)
analysis_id = 56 # int |
user_name = 'user_name_example' # str | The user name to limit communities to (optional)

try:
# Gets the communities found in the analysis
api_response = api_instance.get_communities(analysis_id, user_name=user_name)
print("The response of AnalysesResultsMetadataApi->get_communities:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysesResultsMetadataApi->get_communities: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| |
**user_name** | **str**| The user name to limit communities to | [optional]

### Return type

[**BaseResponseCommunities**](BaseResponseCommunities.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **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)

# **get_functions_list**
> 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)

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

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90.0]
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90]
**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]
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 30 | [optional] [default to 1]
**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]
**status_only** | **bool** | If set to true, only returns the status of the matching operation without the actual results | [optional] [default to False]
Expand Down
32 changes: 32 additions & 0 deletions docs/AnalysisStringInput.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AnalysisStringInput

Input model for inserting a string into an analysis.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | The string literal value |
**vaddr** | **int** | The virtual address of the string |
**source** | [**StringSource**](StringSource.md) | The source of the string |

## Example

```python
from revengai.models.analysis_string_input import AnalysisStringInput

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

# convert the object into a dict
analysis_string_input_dict = analysis_string_input_instance.to_dict()
# create an instance of AnalysisStringInput from a dict
analysis_string_input_from_dict = AnalysisStringInput.from_dict(analysis_string_input_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)


4 changes: 2 additions & 2 deletions docs/AutoUnstripRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90.0]
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90]
**apply** | **bool** | Whether to apply the matched function names to the target binary, default is False | [optional] [default to False]
**confidence_threshold** | **float** | Confidence threshold for applying function names as a percentage, default is 90 | [optional] [default to 90.0]
**confidence_threshold** | **float** | Confidence threshold for applying function names as a percentage, default is 90 | [optional] [default to 90]
**min_group_size** | **int** | Minimum number of matching functions required to consider for a match, default is 10 | [optional] [default to 10]
**status_only** | **bool** | If set to true, only returns the status of the auto-unstrip 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]
Expand Down
33 changes: 0 additions & 33 deletions docs/BaseResponseCommunities.md

This file was deleted.

32 changes: 0 additions & 32 deletions docs/Communities.md

This file was deleted.

Loading