Skip to content

Commit 2a4d742

Browse files
authored
Merge pull request #207 from RevEngAI/sdk-update-v4.5.0
🤖 Update SDK to version v4.5.0
2 parents d0a9348 + 082622b commit 2a4d742

33 files changed

Lines changed: 2814 additions & 65 deletions

.sdk-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v4.4.0
1+
v4.5.0

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,11 @@ Class | Method | HTTP request | Description
5454
*AgentApi* | [**get_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_get**](docs/AgentApi.md#get_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_get) | **GET** /v2/analyses/{analysis_id}/agent/report-analysis | Get Report Analysis Result
5555
*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
5656
*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.
57+
*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.
5758
*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.
5859
*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.
60+
*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.
61+
*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.
5962
*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.
6063
*AnalysesBulkActionsApi* | [**bulk_add_analysis_tags**](docs/AnalysesBulkActionsApi.md#bulk_add_analysis_tags) | **PATCH** /v2/analyses/tags/add | Bulk Add Analysis Tags
6164
*AnalysesBulkActionsApi* | [**bulk_delete_analyses**](docs/AnalysesBulkActionsApi.md#bulk_delete_analyses) | **PATCH** /v2/analyses/delete | Bulk Delete Analyses
@@ -457,6 +460,7 @@ Class | Method | HTTP request | Description
457460
- [EventCONTEXTCOMPACTED](docs/EventCONTEXTCOMPACTED.md)
458461
- [EventDecompFailed](docs/EventDecompFailed.md)
459462
- [EventDecompFinished](docs/EventDecompFinished.md)
463+
- [EventNamesFinished](docs/EventNamesFinished.md)
460464
- [EventProse](docs/EventProse.md)
461465
- [EventRUNCANCELLED](docs/EventRUNCANCELLED.md)
462466
- [EventRUNERROR](docs/EventRUNERROR.md)
@@ -481,6 +485,7 @@ Class | Method | HTTP request | Description
481485
- [Example](docs/Example.md)
482486
- [ExportModel](docs/ExportModel.md)
483487
- [ExternalResponse](docs/ExternalResponse.md)
488+
- [ExtractedBinary](docs/ExtractedBinary.md)
484489
- [ExtractedURL](docs/ExtractedURL.md)
485490
- [FileActivityEntry](docs/FileActivityEntry.md)
486491
- [FileFormat](docs/FileFormat.md)
@@ -544,6 +549,7 @@ Class | Method | HTTP request | Description
544549
- [IndirectCallSite](docs/IndirectCallSite.md)
545550
- [IndirectCallSitesOutputBody](docs/IndirectCallSitesOutputBody.md)
546551
- [InlineComment](docs/InlineComment.md)
552+
- [InputBody](docs/InputBody.md)
547553
- [InsertAnalysisLogRequest](docs/InsertAnalysisLogRequest.md)
548554
- [InviteUserInputBody](docs/InviteUserInputBody.md)
549555
- [IssuerAllowedDomain](docs/IssuerAllowedDomain.md)
@@ -576,8 +582,11 @@ Class | Method | HTTP request | Description
576582
- [MutexEntry](docs/MutexEntry.md)
577583
- [NameConfidence](docs/NameConfidence.md)
578584
- [NameSourceType](docs/NameSourceType.md)
585+
- [NamesFinishedEvent](docs/NamesFinishedEvent.md)
579586
- [NetworkActivity](docs/NetworkActivity.md)
580587
- [OIDCCallbackInputBody](docs/OIDCCallbackInputBody.md)
588+
- [OperationSecurityScanMetadataSecurityScanResult](docs/OperationSecurityScanMetadataSecurityScanResult.md)
589+
- [OperationWorkflowProgressResultBody](docs/OperationWorkflowProgressResultBody.md)
581590
- [Order](docs/Order.md)
582591
- [Organisation](docs/Organisation.md)
583592
- [OrganisationGroup](docs/OrganisationGroup.md)
@@ -631,6 +640,7 @@ Class | Method | HTTP request | Description
631640
- [ReportInfo](docs/ReportInfo.md)
632641
- [ReportOptions](docs/ReportOptions.md)
633642
- [ResolvedEntity](docs/ResolvedEntity.md)
643+
- [ResultBody](docs/ResultBody.md)
634644
- [RevokeBody](docs/RevokeBody.md)
635645
- [SSOProvider](docs/SSOProvider.md)
636646
- [SSOProvidersOutputBody](docs/SSOProvidersOutputBody.md)
@@ -641,6 +651,8 @@ Class | Method | HTTP request | Description
641651
- [ScrapeThirdPartyConfig](docs/ScrapeThirdPartyConfig.md)
642652
- [SectionModel](docs/SectionModel.md)
643653
- [SecurityModel](docs/SecurityModel.md)
654+
- [SecurityScanMetadata](docs/SecurityScanMetadata.md)
655+
- [SecurityScanResult](docs/SecurityScanResult.md)
644656
- [SegmentInfo](docs/SegmentInfo.md)
645657
- [SendMessageRequest](docs/SendMessageRequest.md)
646658
- [ServiceEntry](docs/ServiceEntry.md)
@@ -677,6 +689,7 @@ Class | Method | HTTP request | Description
677689
- [StartMatchingForFunctionsInputBody](docs/StartMatchingForFunctionsInputBody.md)
678690
- [StartMatchingOutputBody](docs/StartMatchingOutputBody.md)
679691
- [StartupInfo](docs/StartupInfo.md)
692+
- [Status](docs/Status.md)
680693
- [StatusBody](docs/StatusBody.md)
681694
- [StatusInput](docs/StatusInput.md)
682695
- [StatusOutput](docs/StatusOutput.md)
@@ -710,6 +723,7 @@ Class | Method | HTTP request | Description
710723
- [TriageReportResponse](docs/TriageReportResponse.md)
711724
- [TriggerDynamicExecutionInputBody](docs/TriggerDynamicExecutionInputBody.md)
712725
- [TriggerRenameUnnamedFunctionsInputBody](docs/TriggerRenameUnnamedFunctionsInputBody.md)
726+
- [TriggerSecurityScanInputBody](docs/TriggerSecurityScanInputBody.md)
713727
- [Ttp](docs/Ttp.md)
714728
- [TypedefDataType](docs/TypedefDataType.md)
715729
- [TypedefDefinition](docs/TypedefDefinition.md)

docs/AgentApi.md

Lines changed: 285 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@ Method | HTTP request | Description
1717
[**get_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_get**](AgentApi.md#get_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_get) | **GET** /v2/analyses/{analysis_id}/agent/report-analysis | Get Report Analysis Result
1818
[**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
1919
[**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.
20+
[**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.
2021
[**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.
2122
[**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.
23+
[**v3_get_security_scan_operation**](AgentApi.md#v3_get_security_scan_operation) | **GET** /v3/operations/security-scan/{analysis_id} | Get a security-scan operation.
24+
[**v3_run_security_scan**](AgentApi.md#v3_run_security_scan) | **POST** /v3/analyses/{analysis_id}/security-scan:run | Run the security-scan agent.
2225
[**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.
2326

2427

@@ -1103,6 +1106,97 @@ with revengai.ApiClient(configuration) as api_client:
11031106

11041107

11051108

1109+
### Parameters
1110+
1111+
1112+
Name | Type | Description | Notes
1113+
------------- | ------------- | ------------- | -------------
1114+
**analysis_id** | **int**| Analysis ID |
1115+
1116+
### Return type
1117+
1118+
void (empty response body)
1119+
1120+
### Authorization
1121+
1122+
[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth)
1123+
1124+
### HTTP request headers
1125+
1126+
- **Content-Type**: Not defined
1127+
- **Accept**: application/json
1128+
1129+
### HTTP response details
1130+
1131+
| Status code | Description | Response headers |
1132+
|-------------|-------------|------------------|
1133+
**204** | No Content | - |
1134+
**403** | Forbidden | - |
1135+
**404** | Not Found | - |
1136+
**422** | Unprocessable Entity | - |
1137+
**500** | Internal Server Error | - |
1138+
1139+
[[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)
1140+
1141+
# **v3_cancel_security_scan_operation**
1142+
> v3_cancel_security_scan_operation(analysis_id)
1143+
1144+
Cancel a security-scan operation.
1145+
1146+
Requests cancellation of the currently running security-scan run for the analysis. Returns 404 if no run is in progress.
1147+
1148+
**Error codes:**
1149+
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found
1150+
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied
1151+
- `404` [`NO_ACTIVE_RUN`](/errors/NO_ACTIVE_RUN) — No Active Run
1152+
1153+
### Example
1154+
1155+
* Api Key Authentication (APIKey):
1156+
* Bearer Authentication (bearerAuth):
1157+
1158+
```python
1159+
import revengai
1160+
from revengai.rest import ApiException
1161+
from pprint import pprint
1162+
1163+
# Defining the host is optional and defaults to https://api.reveng.ai
1164+
# See configuration.py for a list of all supported configuration parameters.
1165+
configuration = revengai.Configuration(
1166+
host = "https://api.reveng.ai"
1167+
)
1168+
1169+
# The client must configure the authentication and authorization parameters
1170+
# in accordance with the API server security policy.
1171+
# Examples for each auth method are provided below, use the example that
1172+
# satisfies your auth use case.
1173+
1174+
# Configure API key authorization: APIKey
1175+
configuration.api_key['APIKey'] = os.environ["API_KEY"]
1176+
1177+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1178+
# configuration.api_key_prefix['APIKey'] = 'Bearer'
1179+
1180+
# Configure Bearer authorization: bearerAuth
1181+
configuration = revengai.Configuration(
1182+
access_token = os.environ["BEARER_TOKEN"]
1183+
)
1184+
1185+
# Enter a context with an instance of the API client
1186+
with revengai.ApiClient(configuration) as api_client:
1187+
# Create an instance of the API class
1188+
api_instance = revengai.AgentApi(api_client)
1189+
analysis_id = 56 # int | Analysis ID
1190+
1191+
try:
1192+
# Cancel a security-scan operation.
1193+
api_instance.v3_cancel_security_scan_operation(analysis_id)
1194+
except Exception as e:
1195+
print("Exception when calling AgentApi->v3_cancel_security_scan_operation: %s\n" % e)
1196+
```
1197+
1198+
1199+
11061200
### Parameters
11071201

11081202

@@ -1323,6 +1417,197 @@ Name | Type | Description | Notes
13231417

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

1420+
# **v3_get_security_scan_operation**
1421+
> OperationSecurityScanMetadataSecurityScanResult v3_get_security_scan_operation(analysis_id)
1422+
1423+
Get a security-scan operation.
1424+
1425+
Returns the current state of the security-scan run for this analysis.
1426+
1427+
**Error codes:**
1428+
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found
1429+
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied
1430+
1431+
### Example
1432+
1433+
* Api Key Authentication (APIKey):
1434+
* Bearer Authentication (bearerAuth):
1435+
1436+
```python
1437+
import revengai
1438+
from revengai.models.operation_security_scan_metadata_security_scan_result import OperationSecurityScanMetadataSecurityScanResult
1439+
from revengai.rest import ApiException
1440+
from pprint import pprint
1441+
1442+
# Defining the host is optional and defaults to https://api.reveng.ai
1443+
# See configuration.py for a list of all supported configuration parameters.
1444+
configuration = revengai.Configuration(
1445+
host = "https://api.reveng.ai"
1446+
)
1447+
1448+
# The client must configure the authentication and authorization parameters
1449+
# in accordance with the API server security policy.
1450+
# Examples for each auth method are provided below, use the example that
1451+
# satisfies your auth use case.
1452+
1453+
# Configure API key authorization: APIKey
1454+
configuration.api_key['APIKey'] = os.environ["API_KEY"]
1455+
1456+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1457+
# configuration.api_key_prefix['APIKey'] = 'Bearer'
1458+
1459+
# Configure Bearer authorization: bearerAuth
1460+
configuration = revengai.Configuration(
1461+
access_token = os.environ["BEARER_TOKEN"]
1462+
)
1463+
1464+
# Enter a context with an instance of the API client
1465+
with revengai.ApiClient(configuration) as api_client:
1466+
# Create an instance of the API class
1467+
api_instance = revengai.AgentApi(api_client)
1468+
analysis_id = 56 # int | Analysis ID
1469+
1470+
try:
1471+
# Get a security-scan operation.
1472+
api_response = api_instance.v3_get_security_scan_operation(analysis_id)
1473+
print("The response of AgentApi->v3_get_security_scan_operation:\n")
1474+
pprint(api_response)
1475+
except Exception as e:
1476+
print("Exception when calling AgentApi->v3_get_security_scan_operation: %s\n" % e)
1477+
```
1478+
1479+
1480+
1481+
### Parameters
1482+
1483+
1484+
Name | Type | Description | Notes
1485+
------------- | ------------- | ------------- | -------------
1486+
**analysis_id** | **int**| Analysis ID |
1487+
1488+
### Return type
1489+
1490+
[**OperationSecurityScanMetadataSecurityScanResult**](OperationSecurityScanMetadataSecurityScanResult.md)
1491+
1492+
### Authorization
1493+
1494+
[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth)
1495+
1496+
### HTTP request headers
1497+
1498+
- **Content-Type**: Not defined
1499+
- **Accept**: application/json
1500+
1501+
### HTTP response details
1502+
1503+
| Status code | Description | Response headers |
1504+
|-------------|-------------|------------------|
1505+
**200** | OK | - |
1506+
**403** | Forbidden | - |
1507+
**404** | Not Found | - |
1508+
**422** | Unprocessable Entity | - |
1509+
**500** | Internal Server Error | - |
1510+
1511+
[[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)
1512+
1513+
# **v3_run_security_scan**
1514+
> OperationSecurityScanMetadataSecurityScanResult v3_run_security_scan(analysis_id, trigger_security_scan_input_body)
1515+
1516+
Run the security-scan agent.
1517+
1518+
Starts an agent that decompiles the analysis' functions and runs a security scan over the decompiled source, and returns the operation to poll for its outcome. Each function costs an AI decompilation, so a whole-analysis run can be expensive — use `max_functions_to_scan` to bound it. Returns 409 while a run is already in progress for this analysis.
1519+
1520+
**Error codes:**
1521+
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found
1522+
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied
1523+
- `409` [`CONFLICT`](/errors/CONFLICT) — Conflict
1524+
1525+
### Example
1526+
1527+
* Api Key Authentication (APIKey):
1528+
* Bearer Authentication (bearerAuth):
1529+
1530+
```python
1531+
import revengai
1532+
from revengai.models.operation_security_scan_metadata_security_scan_result import OperationSecurityScanMetadataSecurityScanResult
1533+
from revengai.models.trigger_security_scan_input_body import TriggerSecurityScanInputBody
1534+
from revengai.rest import ApiException
1535+
from pprint import pprint
1536+
1537+
# Defining the host is optional and defaults to https://api.reveng.ai
1538+
# See configuration.py for a list of all supported configuration parameters.
1539+
configuration = revengai.Configuration(
1540+
host = "https://api.reveng.ai"
1541+
)
1542+
1543+
# The client must configure the authentication and authorization parameters
1544+
# in accordance with the API server security policy.
1545+
# Examples for each auth method are provided below, use the example that
1546+
# satisfies your auth use case.
1547+
1548+
# Configure API key authorization: APIKey
1549+
configuration.api_key['APIKey'] = os.environ["API_KEY"]
1550+
1551+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1552+
# configuration.api_key_prefix['APIKey'] = 'Bearer'
1553+
1554+
# Configure Bearer authorization: bearerAuth
1555+
configuration = revengai.Configuration(
1556+
access_token = os.environ["BEARER_TOKEN"]
1557+
)
1558+
1559+
# Enter a context with an instance of the API client
1560+
with revengai.ApiClient(configuration) as api_client:
1561+
# Create an instance of the API class
1562+
api_instance = revengai.AgentApi(api_client)
1563+
analysis_id = 56 # int | Analysis ID
1564+
trigger_security_scan_input_body = revengai.TriggerSecurityScanInputBody() # TriggerSecurityScanInputBody |
1565+
1566+
try:
1567+
# Run the security-scan agent.
1568+
api_response = api_instance.v3_run_security_scan(analysis_id, trigger_security_scan_input_body)
1569+
print("The response of AgentApi->v3_run_security_scan:\n")
1570+
pprint(api_response)
1571+
except Exception as e:
1572+
print("Exception when calling AgentApi->v3_run_security_scan: %s\n" % e)
1573+
```
1574+
1575+
1576+
1577+
### Parameters
1578+
1579+
1580+
Name | Type | Description | Notes
1581+
------------- | ------------- | ------------- | -------------
1582+
**analysis_id** | **int**| Analysis ID |
1583+
**trigger_security_scan_input_body** | [**TriggerSecurityScanInputBody**](TriggerSecurityScanInputBody.md)| |
1584+
1585+
### Return type
1586+
1587+
[**OperationSecurityScanMetadataSecurityScanResult**](OperationSecurityScanMetadataSecurityScanResult.md)
1588+
1589+
### Authorization
1590+
1591+
[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth)
1592+
1593+
### HTTP request headers
1594+
1595+
- **Content-Type**: application/json
1596+
- **Accept**: application/json
1597+
1598+
### HTTP response details
1599+
1600+
| Status code | Description | Response headers |
1601+
|-------------|-------------|------------------|
1602+
**200** | OK | - |
1603+
**403** | Forbidden | - |
1604+
**404** | Not Found | - |
1605+
**409** | Conflict | - |
1606+
**422** | Unprocessable Entity | - |
1607+
**500** | Internal Server Error | - |
1608+
1609+
[[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)
1610+
13261611
# **v3_trigger_rename_unnamed_functions**
13271612
> StatusBody v3_trigger_rename_unnamed_functions(analysis_id, trigger_rename_unnamed_functions_input_body)
13281613

0 commit comments

Comments
 (0)