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.39.0
v3.40.0
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Class | Method | HTTP request | Description
*AnalysesSecurityChecksApi* | [**create_scurity_checks_task**](docs/AnalysesSecurityChecksApi.md#create_scurity_checks_task) | **POST** /v2/analyses/{analysis_id}/security-checks | Queues a security check process
*AnalysesSecurityChecksApi* | [**get_security_checks**](docs/AnalysesSecurityChecksApi.md#get_security_checks) | **GET** /v2/analyses/{analysis_id}/security-checks | Get Security Checks
*AnalysesSecurityChecksApi* | [**get_security_checks_task_status**](docs/AnalysesSecurityChecksApi.md#get_security_checks_task_status) | **GET** /v2/analyses/{analysis_id}/security-checks/status | Check the status of a security check process
*AnalysesXRefsApi* | [**get_xref_by_vaddr**](docs/AnalysesXRefsApi.md#get_xref_by_vaddr) | **GET** /v2/analyses/{analysis_id}/xrefs/{vaddr} | [Beta] Look up an xref by virtual address
*AuthenticationUsersApi* | [**get_requester_user_info**](docs/AuthenticationUsersApi.md#get_requester_user_info) | **GET** /v2/users/me | Get the requesters user information
*AuthenticationUsersApi* | [**get_user**](docs/AuthenticationUsersApi.md#get_user) | **GET** /v2/users/{user_id} | Get a user's public information
*AuthenticationUsersApi* | [**get_user_activity**](docs/AuthenticationUsersApi.md#get_user_activity) | **GET** /v2/users/activity | Get auth user activity
Expand Down Expand Up @@ -263,6 +264,7 @@ Class | Method | HTTP request | Description
- [BaseResponseTaskResponse](docs/BaseResponseTaskResponse.md)
- [BaseResponseUploadResponse](docs/BaseResponseUploadResponse.md)
- [BaseResponseVulnerabilities](docs/BaseResponseVulnerabilities.md)
- [BaseResponseXRef](docs/BaseResponseXRef.md)
- [Basic](docs/Basic.md)
- [BinariesRelatedStatusResponse](docs/BinariesRelatedStatusResponse.md)
- [BinariesTaskStatus](docs/BinariesTaskStatus.md)
Expand Down Expand Up @@ -419,6 +421,7 @@ Class | Method | HTTP request | Description
- [SecurityChecksResponse](docs/SecurityChecksResponse.md)
- [SecurityChecksResult](docs/SecurityChecksResult.md)
- [SecurityModel](docs/SecurityModel.md)
- [SegmentInfo](docs/SegmentInfo.md)
- [SeverityType](docs/SeverityType.md)
- [SingleCodeCertificateModel](docs/SingleCodeCertificateModel.md)
- [SingleCodeSignatureModel](docs/SingleCodeSignatureModel.md)
Expand Down Expand Up @@ -454,3 +457,4 @@ Class | Method | HTTP request | Description
- [Vulnerability](docs/Vulnerability.md)
- [VulnerabilityType](docs/VulnerabilityType.md)
- [Workspace](docs/Workspace.md)
- [XRef](docs/XRef.md)
92 changes: 92 additions & 0 deletions docs/AnalysesXRefsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# revengai.AnalysesXRefsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_xref_by_vaddr**](AnalysesXRefsApi.md#get_xref_by_vaddr) | **GET** /v2/analyses/{analysis_id}/xrefs/{vaddr} | [Beta] Look up an xref by virtual address


# **get_xref_by_vaddr**
> BaseResponseXRef get_xref_by_vaddr(analysis_id, vaddr)

[Beta] Look up an xref by virtual address

**This endpoint is in beta and may change without notice.**

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.base_response_x_ref import BaseResponseXRef
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.AnalysesXRefsApi(api_client)
analysis_id = 56 # int |
vaddr = 56 # int | Virtual address to match against xref_to

try:
# [Beta] Look up an xref by virtual address
api_response = api_instance.get_xref_by_vaddr(analysis_id, vaddr)
print("The response of AnalysesXRefsApi->get_xref_by_vaddr:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysesXRefsApi->get_xref_by_vaddr: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| |
**vaddr** | **int**| Virtual address to match against xref_to |

### Return type

[**BaseResponseXRef**](BaseResponseXRef.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 | - |
**404** | Xref or analysis cache not found | - |

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

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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **bool** | Response status on whether the request succeeded | [optional] [default to True]
**data** | [**XRef**](XRef.md) | | [optional]
**message** | **str** | | [optional]
**errors** | [**List[ErrorModel]**](ErrorModel.md) | | [optional]
**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional]

## Example

```python
from revengai.models.base_response_x_ref import BaseResponseXRef

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

# convert the object into a dict
base_response_x_ref_dict = base_response_x_ref_instance.to_dict()
# create an instance of BaseResponseXRef from a dict
base_response_x_ref_from_dict = BaseResponseXRef.from_dict(base_response_x_ref_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)


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

Represents the information about a segment. Attributes: name: The name of the segment. r: Determines if the segment has read permission. w: Determines if the segment has write permission. x: Determines if the segment has execute permission. start: The start address of the segment. end: The end address of the segment.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional] [default to '']
**r** | **bool** | | [optional]
**w** | **bool** | | [optional]
**x** | **bool** | | [optional]
**start** | **int** | | [optional] [default to 0]
**end** | **int** | | [optional] [default to 0]

## Example

```python
from revengai.models.segment_info import SegmentInfo

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

# convert the object into a dict
segment_info_dict = segment_info_instance.to_dict()
# create an instance of SegmentInfo from a dict
segment_info_from_dict = SegmentInfo.from_dict(segment_info_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | |
**xref_to** | **str** | |
**is_scalar** | **bool** | | [optional]
**is_call** | **bool** | | [optional]
**is_data** | **bool** | | [optional]
**is_string** | **bool** | | [optional]
**raw_data** | **bytearray** | | [optional]
**segment** | [**SegmentInfo**](SegmentInfo.md) | | [optional]
**orig_str_encoding** | **str** | | [optional]

## Example

```python
from revengai.models.x_ref import XRef

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

# convert the object into a dict
x_ref_dict = x_ref_instance.to_dict()
# create an instance of XRef from a dict
x_ref_from_dict = XRef.from_dict(x_ref_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)


10 changes: 9 additions & 1 deletion revengai/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
""" # noqa: E501


__version__ = "v3.39.0"
__version__ = "v3.40.0"

# Define package exports
__all__ = [
Expand All @@ -22,6 +22,7 @@
"AnalysesDynamicExecutionApi",
"AnalysesResultsMetadataApi",
"AnalysesSecurityChecksApi",
"AnalysesXRefsApi",
"AuthenticationUsersApi",
"BinariesApi",
"CollectionsApi",
Expand Down Expand Up @@ -155,6 +156,7 @@
"BaseResponseTaskResponse",
"BaseResponseUploadResponse",
"BaseResponseVulnerabilities",
"BaseResponseXRef",
"Basic",
"BinariesRelatedStatusResponse",
"BinariesTaskStatus",
Expand Down Expand Up @@ -311,6 +313,7 @@
"SecurityChecksResponse",
"SecurityChecksResult",
"SecurityModel",
"SegmentInfo",
"SeverityType",
"SingleCodeCertificateModel",
"SingleCodeSignatureModel",
Expand Down Expand Up @@ -346,6 +349,7 @@
"Vulnerability",
"VulnerabilityType",
"Workspace",
"XRef",
]

# import apis into sdk package
Expand All @@ -354,6 +358,7 @@
from revengai.api.analyses_dynamic_execution_api import AnalysesDynamicExecutionApi as AnalysesDynamicExecutionApi
from revengai.api.analyses_results_metadata_api import AnalysesResultsMetadataApi as AnalysesResultsMetadataApi
from revengai.api.analyses_security_checks_api import AnalysesSecurityChecksApi as AnalysesSecurityChecksApi
from revengai.api.analyses_x_refs_api import AnalysesXRefsApi as AnalysesXRefsApi
from revengai.api.authentication_users_api import AuthenticationUsersApi as AuthenticationUsersApi
from revengai.api.binaries_api import BinariesApi as BinariesApi
from revengai.api.collections_api import CollectionsApi as CollectionsApi
Expand Down Expand Up @@ -491,6 +496,7 @@
from revengai.models.base_response_task_response import BaseResponseTaskResponse as BaseResponseTaskResponse
from revengai.models.base_response_upload_response import BaseResponseUploadResponse as BaseResponseUploadResponse
from revengai.models.base_response_vulnerabilities import BaseResponseVulnerabilities as BaseResponseVulnerabilities
from revengai.models.base_response_x_ref import BaseResponseXRef as BaseResponseXRef
from revengai.models.basic import Basic as Basic
from revengai.models.binaries_related_status_response import BinariesRelatedStatusResponse as BinariesRelatedStatusResponse
from revengai.models.binaries_task_status import BinariesTaskStatus as BinariesTaskStatus
Expand Down Expand Up @@ -647,6 +653,7 @@
from revengai.models.security_checks_response import SecurityChecksResponse as SecurityChecksResponse
from revengai.models.security_checks_result import SecurityChecksResult as SecurityChecksResult
from revengai.models.security_model import SecurityModel as SecurityModel
from revengai.models.segment_info import SegmentInfo as SegmentInfo
from revengai.models.severity_type import SeverityType as SeverityType
from revengai.models.single_code_certificate_model import SingleCodeCertificateModel as SingleCodeCertificateModel
from revengai.models.single_code_signature_model import SingleCodeSignatureModel as SingleCodeSignatureModel
Expand Down Expand Up @@ -682,4 +689,5 @@
from revengai.models.vulnerability import Vulnerability as Vulnerability
from revengai.models.vulnerability_type import VulnerabilityType as VulnerabilityType
from revengai.models.workspace import Workspace as Workspace
from revengai.models.x_ref import XRef as XRef

1 change: 1 addition & 0 deletions revengai/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from revengai.api.analyses_dynamic_execution_api import AnalysesDynamicExecutionApi
from revengai.api.analyses_results_metadata_api import AnalysesResultsMetadataApi
from revengai.api.analyses_security_checks_api import AnalysesSecurityChecksApi
from revengai.api.analyses_x_refs_api import AnalysesXRefsApi
from revengai.api.authentication_users_api import AuthenticationUsersApi
from revengai.api.binaries_api import BinariesApi
from revengai.api.collections_api import CollectionsApi
Expand Down
Loading