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.85.1
v3.86.3
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,11 +170,15 @@ Class | Method | HTTP request | Description
*SearchApi* | [**search_collections**](docs/SearchApi.md#search_collections) | **GET** /v2/search/collections | Collections search
*SearchApi* | [**search_functions**](docs/SearchApi.md#search_functions) | **GET** /v2/search/functions | Functions search
*SearchApi* | [**search_tags**](docs/SearchApi.md#search_tags) | **GET** /v2/search/tags | Tags search
*StringsApi* | [**add_user_string_to_analysis**](docs/StringsApi.md#add_user_string_to_analysis) | **POST** /v3/analyses/{analysis_id}/user-provided-strings | Add a user-provided string to an analysis.
*StringsApi* | [**add_user_string_to_function**](docs/StringsApi.md#add_user_string_to_function) | **POST** /v3/functions/{function_id}/user-provided-strings | Add a user-provided string to a function.


## Documentation For Models

- [APIError](docs/APIError.md)
- [AddUserStringInputBody](docs/AddUserStringInputBody.md)
- [AddUserStringToFunctionInputBody](docs/AddUserStringToFunctionInputBody.md)
- [AdditionalDetailsStatusResponse](docs/AdditionalDetailsStatusResponse.md)
- [Addr](docs/Addr.md)
- [AiDecompilationRating](docs/AiDecompilationRating.md)
Expand Down Expand Up @@ -380,6 +384,7 @@ Class | Method | HTTP request | Description
- [EventWarning](docs/EventWarning.md)
- [ExportModel](docs/ExportModel.md)
- [ExternalResponse](docs/ExternalResponse.md)
- [ExtractedFileEntry](docs/ExtractedFileEntry.md)
- [ExtractedURL](docs/ExtractedURL.md)
- [FileActivityEntry](docs/FileActivityEntry.md)
- [FileFormat](docs/FileFormat.md)
Expand Down Expand Up @@ -465,6 +470,7 @@ Class | Method | HTTP request | Description
- [PatchCommentBody](docs/PatchCommentBody.md)
- [Platform](docs/Platform.md)
- [ProcessActivityEntry](docs/ProcessActivityEntry.md)
- [ProcessExtractedFiles](docs/ProcessExtractedFiles.md)
- [ProcessMemdumps](docs/ProcessMemdumps.md)
- [ProcessNode](docs/ProcessNode.md)
- [ProcessTree](docs/ProcessTree.md)
Expand Down
30 changes: 30 additions & 0 deletions docs/AddUserStringInputBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AddUserStringInputBody


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**string** | **str** | String literal |
**virtual_address** | **int** | Virtual address at which this string is defined. |

## Example

```python
from revengai.models.add_user_string_input_body import AddUserStringInputBody

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

# convert the object into a dict
add_user_string_input_body_dict = add_user_string_input_body_instance.to_dict()
# create an instance of AddUserStringInputBody from a dict
add_user_string_input_body_from_dict = AddUserStringInputBody.from_dict(add_user_string_input_body_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**string** | **str** | String literal |
**virtual_address** | **int** | Virtual address at which this string is defined. |

## Example

```python
from revengai.models.add_user_string_to_function_input_body import AddUserStringToFunctionInputBody

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

# convert the object into a dict
add_user_string_to_function_input_body_dict = add_user_string_to_function_input_body_instance.to_dict()
# create an instance of AddUserStringToFunctionInputBody from a dict
add_user_string_to_function_input_body_from_dict = AddUserStringToFunctionInputBody.from_dict(add_user_string_to_function_input_body_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/AnalysesCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1407,7 +1407,7 @@ 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 = 'file_example' # str |
file = None # bytearray |
packed_password = 'packed_password_example' # str | (optional)
force_overwrite = False # bool | (optional) (default to False)

Expand All @@ -1428,7 +1428,7 @@ with revengai.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**upload_file_type** | [**UploadFileType**](UploadFileType.md)| |
**file** | **str**| |
**file** | **bytearray**| |
**packed_password** | **str**| | [optional]
**force_overwrite** | **bool**| | [optional] [default to False]

Expand Down
1 change: 1 addition & 0 deletions docs/AnalysisReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**extracted_files** | [**List[ProcessExtractedFiles]**](ProcessExtractedFiles.md) | | [optional]
**file_activity** | [**List[FileActivityEntry]**](FileActivityEntry.md) | | [optional]
**info** | [**ReportInfo**](ReportInfo.md) | |
**memdumps** | [**List[ProcessMemdumps]**](ProcessMemdumps.md) | | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/ELFRelocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**symbol_name** | **str** | |
**is_dynamic** | **bool** | |
**is_pltgot** | **bool** | |
**is_unicode_symbol_name** | **bool** | | [optional] [default to True]

## Example

Expand Down
1 change: 1 addition & 0 deletions docs/ELFSymbol.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**binding** | **str** | |
**visibility** | **str** | |
**section_index** | **int** | |
**is_unicode_name** | **bool** | | [optional] [default to True]

## Example

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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file_hash** | **str** | | [optional]
**file_size** | **int** | |
**file_type** | **str** | | [optional]
**filename** | **str** | |
**is_pe** | **bool** | | [optional]
**mime_type** | **str** | | [optional]
**reason** | **str** | | [optional]
**seq_num** | **int** | |
**sha256** | **str** | | [optional]
**zip_filename** | **str** | |

## Example

```python
from revengai.models.extracted_file_entry import ExtractedFileEntry

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

# convert the object into a dict
extracted_file_entry_dict = extracted_file_entry_instance.to_dict()
# create an instance of ExtractedFileEntry from a dict
extracted_file_entry_from_dict = ExtractedFileEntry.from_dict(extracted_file_entry_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**files** | [**List[ExtractedFileEntry]**](ExtractedFileEntry.md) | | [optional]
**process_seqid** | **int** | |

## Example

```python
from revengai.models.process_extracted_files import ProcessExtractedFiles

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

# convert the object into a dict
process_extracted_files_dict = process_extracted_files_instance.to_dict()
# create an instance of ProcessExtractedFiles from a dict
process_extracted_files_from_dict = ProcessExtractedFiles.from_dict(process_extracted_files_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)


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

All URIs are relative to *https://api.reveng.ai*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_user_string_to_analysis**](StringsApi.md#add_user_string_to_analysis) | **POST** /v3/analyses/{analysis_id}/user-provided-strings | Add a user-provided string to an analysis.
[**add_user_string_to_function**](StringsApi.md#add_user_string_to_function) | **POST** /v3/functions/{function_id}/user-provided-strings | Add a user-provided string to a function.


# **add_user_string_to_analysis**
> Dict[str, object] add_user_string_to_analysis(analysis_id, add_user_string_input_body)

Add a user-provided string to an analysis.

Attaches a user-provided string to an analysis at the given virtual address. The string is stored with source `USER` and complements strings discovered automatically during analysis.

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

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.add_user_string_input_body import AddUserStringInputBody
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.StringsApi(api_client)
analysis_id = 56 # int | Analysis ID
add_user_string_input_body = revengai.AddUserStringInputBody() # AddUserStringInputBody |

try:
# Add a user-provided string to an analysis.
api_response = api_instance.add_user_string_to_analysis(analysis_id, add_user_string_input_body)
print("The response of StringsApi->add_user_string_to_analysis:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StringsApi->add_user_string_to_analysis: %s\n" % e)
```



### Parameters


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

### Return type

**Dict[str, object]**

### Authorization

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

### HTTP request headers

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

### HTTP response details

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

# **add_user_string_to_function**
> Dict[str, object] add_user_string_to_function(function_id, add_user_string_to_function_input_body)

Add a user-provided string to a function.

Attaches a user-provided string to a function at the given virtual address. The string is stored with source `USER` and complements strings discovered automatically during analysis.

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

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.add_user_string_to_function_input_body import AddUserStringToFunctionInputBody
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.StringsApi(api_client)
function_id = 56 # int | Function ID
add_user_string_to_function_input_body = revengai.AddUserStringToFunctionInputBody() # AddUserStringToFunctionInputBody |

try:
# Add a user-provided string to a function.
api_response = api_instance.add_user_string_to_function(function_id, add_user_string_to_function_input_body)
print("The response of StringsApi->add_user_string_to_function:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StringsApi->add_user_string_to_function: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**function_id** | **int**| Function ID |
**add_user_string_to_function_input_body** | [**AddUserStringToFunctionInputBody**](AddUserStringToFunctionInputBody.md)| |

### Return type

**Dict[str, object]**

### Authorization

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

### HTTP request headers

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

### HTTP response details

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

Loading