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
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>ai.reveng</groupId>
<artifactId>sdk</artifactId>
<version>3.51.0</version>
<version>3.55.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -31,7 +31,7 @@ repositories {
}

dependencies {
implementation "ai.reveng:sdk:3.51.0"
implementation "ai.reveng:sdk:3.55.0"
}
```

Expand Down Expand Up @@ -91,6 +91,7 @@ Class | Method | HTTP request | Description
*AnalysesCoreApi* | [**insertAnalysisLog**](docs/AnalysesCoreApi.md#insertAnalysisLog) | **POST** /v2/analyses/{analysis_id}/logs | Insert a log entry for an analysis
*AnalysesCoreApi* | [**listAnalyses**](docs/AnalysesCoreApi.md#listAnalyses) | **GET** /v2/analyses/list | Gets the most recent analyses
*AnalysesCoreApi* | [**lookupBinaryId**](docs/AnalysesCoreApi.md#lookupBinaryId) | **GET** /v2/analyses/lookup/{binary_id} | Gets the analysis ID from binary ID
*AnalysesCoreApi* | [**putAnalysisStrings**](docs/AnalysesCoreApi.md#putAnalysisStrings) | **PUT** /v2/analyses/{analysis_id}/strings | Add strings to the analysis
*AnalysesCoreApi* | [**requeueAnalysis**](docs/AnalysesCoreApi.md#requeueAnalysis) | **POST** /v2/analyses/{analysis_id}/requeue | Requeue Analysis
*AnalysesCoreApi* | [**updateAnalysis**](docs/AnalysesCoreApi.md#updateAnalysis) | **PATCH** /v2/analyses/{analysis_id} | Update Analysis
*AnalysesCoreApi* | [**updateAnalysisTags**](docs/AnalysesCoreApi.md#updateAnalysisTags) | **PATCH** /v2/analyses/{analysis_id}/tags | Update Analysis Tags
Expand Down Expand Up @@ -213,6 +214,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 @@ -452,6 +454,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 @@ -477,6 +480,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
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ apply plugin: 'java'
apply plugin: 'com.diffplug.spotless'

group = 'ai.reveng'
version = '3.51.0'
version = '3.55.0'



Expand Down Expand Up @@ -171,7 +171,7 @@ mavenPublishing {
publishToMavenCentral(true)
signAllPublications()

coordinates("ai.reveng", "sdk", "3.51.0")
coordinates("ai.reveng", "sdk", "3.55.0")

pom {
name = "sdk"
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "ai.reveng",
name := "sdk",
version := "3.51.0",
version := "3.55.0",
scalaVersion := "2.11.12",
scalacOptions ++= Seq("-feature"),
compile / javacOptions ++= Seq("-Xlint:deprecation"),
Expand Down
10 changes: 5 additions & 5 deletions docs/AnalysesCommentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ public class Example {
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Successful Response | - |
| **422** | Invalid request parameters | - |
| **400** | Bad Request | - |
| **422** | Invalid request parameters | - |

<a id="deleteAnalysisComment"></a>
# **deleteAnalysisComment**
Expand Down Expand Up @@ -153,9 +153,9 @@ public class Example {
| 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 | - |

<a id="getAnalysisComments"></a>
# **getAnalysisComments**
Expand Down Expand Up @@ -299,7 +299,7 @@ public class Example {
| 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 | - |

93 changes: 83 additions & 10 deletions docs/AnalysesCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ All URIs are relative to *https://api.reveng.ai*
| [**insertAnalysisLog**](AnalysesCoreApi.md#insertAnalysisLog) | **POST** /v2/analyses/{analysis_id}/logs | Insert a log entry for an analysis |
| [**listAnalyses**](AnalysesCoreApi.md#listAnalyses) | **GET** /v2/analyses/list | Gets the most recent analyses |
| [**lookupBinaryId**](AnalysesCoreApi.md#lookupBinaryId) | **GET** /v2/analyses/lookup/{binary_id} | Gets the analysis ID from binary ID |
| [**putAnalysisStrings**](AnalysesCoreApi.md#putAnalysisStrings) | **PUT** /v2/analyses/{analysis_id}/strings | Add strings to the analysis |
| [**requeueAnalysis**](AnalysesCoreApi.md#requeueAnalysis) | **POST** /v2/analyses/{analysis_id}/requeue | Requeue Analysis |
| [**updateAnalysis**](AnalysesCoreApi.md#updateAnalysis) | **PATCH** /v2/analyses/{analysis_id} | Update Analysis |
| [**updateAnalysisTags**](AnalysesCoreApi.md#updateAnalysisTags) | **PATCH** /v2/analyses/{analysis_id}/tags | Update Analysis Tags |
Expand Down Expand Up @@ -161,9 +162,9 @@ public class Example {
| 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 | - |

<a id="deleteAnalysis"></a>
# **deleteAnalysis**
Expand Down Expand Up @@ -233,9 +234,9 @@ public class Example {
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful Response | - |
| **422** | Invalid request parameters | - |
| **404** | Not Found | - |
| **403** | Forbidden | - |
| **404** | Not Found | - |
| **422** | Invalid request parameters | - |

<a id="getAnalysisBasicInfo"></a>
# **getAnalysisBasicInfo**
Expand Down Expand Up @@ -819,6 +820,78 @@ public class Example {
| **200** | Successful Response | - |
| **422** | Invalid request parameters | - |

<a id="putAnalysisStrings"></a>
# **putAnalysisStrings**
> BaseResponse putAnalysisStrings(analysisId, putAnalysisStringsRequest)

Add strings to the analysis

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

### Example
```java
// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesCoreApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.reveng.ai");

// Configure API key authorization: APIKey
ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
APIKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.setApiKeyPrefix("Token");

AnalysesCoreApi apiInstance = new AnalysesCoreApi(defaultClient);
Integer analysisId = 56; // Integer |
PutAnalysisStringsRequest putAnalysisStringsRequest = new PutAnalysisStringsRequest(); // PutAnalysisStringsRequest |
try {
BaseResponse result = apiInstance.putAnalysisStrings(analysisId, putAnalysisStringsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalysesCoreApi#putAnalysisStrings");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **analysisId** | **Integer**| | |
| **putAnalysisStringsRequest** | [**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 | - |

<a id="requeueAnalysis"></a>
# **requeueAnalysis**
> BaseResponseCreated requeueAnalysis(analysisId, reAnalysisForm, xRevEngApplication)
Expand Down Expand Up @@ -891,9 +964,9 @@ public class Example {
| 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 | - |

<a id="updateAnalysis"></a>
# **updateAnalysis**
Expand Down Expand Up @@ -1041,7 +1114,7 @@ public class Example {

<a id="uploadFile"></a>
# **uploadFile**
> BaseResponseUploadResponse uploadFile(uploadFileType, _file, packedPassword, forceOverwrite)
> BaseResponseUploadResponse uploadFile(_file, uploadFileType, packedPassword, forceOverwrite)

Upload File

Expand All @@ -1067,12 +1140,12 @@ public class Example {
//APIKey.setApiKeyPrefix("Token");

AnalysesCoreApi apiInstance = new AnalysesCoreApi(defaultClient);
UploadFileType uploadFileType = UploadFileType.fromValue("BINARY"); // UploadFileType |
File _file = new File("/path/to/file"); // File |
UploadFileType uploadFileType = UploadFileType.fromValue("BINARY"); // UploadFileType |
String packedPassword = "packedPassword_example"; // String |
Boolean forceOverwrite = false; // Boolean |
try {
BaseResponseUploadResponse result = apiInstance.uploadFile(uploadFileType, _file, packedPassword, forceOverwrite);
BaseResponseUploadResponse result = apiInstance.uploadFile(_file, uploadFileType, packedPassword, forceOverwrite);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalysesCoreApi#uploadFile");
Expand All @@ -1089,8 +1162,8 @@ public class Example {

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **uploadFileType** | [**UploadFileType**](UploadFileType.md)| | [enum: BINARY, DEBUG, PACKED, FIRMWARE] |
| **_file** | **File**| | |
| **uploadFileType** | [**UploadFileType**](UploadFileType.md)| | [enum: BINARY, DEBUG, PACKED, FIRMWARE] |
| **packedPassword** | **String**| | [optional] |
| **forceOverwrite** | **Boolean**| | [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 @@ -75,8 +75,8 @@ public class Example {
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **202** | Successful Response | - |
| **422** | Invalid request parameters | - |
| **409** | Security checks already extracted or queued | - |
| **422** | Invalid request parameters | - |

<a id="getSecurityChecks"></a>
# **getSecurityChecks**
Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysesXRefsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,6 @@ public class Example {
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful Response | - |
| **422** | Invalid request parameters | - |
| **404** | Xref or analysis cache not found | - |
| **422** | Invalid request parameters | - |

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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**tags** | **List&lt;String&gt;** | | |
|**analysisIds** | **List&lt;Integer&gt;** | | |
|**tags** | **List&lt;String&gt;** | | |



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



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**scrapeThirdPartyConfig** | [**ScrapeThirdPartyConfig**](ScrapeThirdPartyConfig.md) | Settings to scrape third party sources | [optional] |
|**advancedAnalysis** | **Boolean** | Enables an advanced security analysis. | [optional] |
|**generateCapabilities** | **Boolean** | A configuration option for generating capabilities of a binary | [optional] |
|**generateCves** | **Boolean** | A configuration option for fetching CVEs data. | [optional] |
|**generateSbom** | **Boolean** | A configuration option for generating software bill of materials data. | [optional] |
|**generateCapabilities** | **Boolean** | A configuration option for generating capabilities of a binary | [optional] |
|**noCache** | **Boolean** | When enabled, skips using cached data within the processing. | [optional] |
|**advancedAnalysis** | **Boolean** | Enables an advanced security analysis. | [optional] |
|**sandboxConfig** | [**SandboxOptions**](SandboxOptions.md) | Including a sandbox config enables the dynamic execution sandbox | [optional] |
|**scrapeThirdPartyConfig** | [**ScrapeThirdPartyConfig**](ScrapeThirdPartyConfig.md) | Settings to scrape third party sources | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**analysisConfig** | [**AnalysisConfig**](AnalysisConfig.md) | The analysis config enables the configuration of optional analysis stages | [optional] |
|**analysisScope** | **AnalysisScope** | The scope of the analysis determines who can access it | [optional] |
|**autoRunAgents** | [**AutoRunAgents**](AutoRunAgents.md) | | [optional] |
|**binaryConfig** | [**BinaryConfig**](BinaryConfig.md) | The binary config can override automatically determined values such as ISA, Platform, File Format, etc | [optional] |
|**debugHash** | **String** | | [optional] |
|**filename** | **String** | The name of the file | |
|**sha256Hash** | **String** | The name of the file | |
|**tags** | [**List&lt;Tag&gt;**](Tag.md) | List of community tags to assign to an analysis | [optional] |
|**analysisScope** | **AnalysisScope** | The scope of the analysis determines who can access it | [optional] |
|**symbols** | [**Symbols**](Symbols.md) | | [optional] |
|**debugHash** | **String** | | [optional] |
|**analysisConfig** | [**AnalysisConfig**](AnalysisConfig.md) | The analysis config enables the configuration of optional analysis stages | [optional] |
|**binaryConfig** | [**BinaryConfig**](BinaryConfig.md) | The binary config can override automatically determined values such as ISA, Platform, File Format, etc | [optional] |
|**autoRunAgents** | [**AutoRunAgents**](AutoRunAgents.md) | | [optional] |
|**tags** | [**List&lt;Tag&gt;**](Tag.md) | List of community tags to assign to an analysis | [optional] |



2 changes: 1 addition & 1 deletion docs/AnalysisDetailResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
|**analysisId** | **Integer** | | |
|**analysisScope** | **String** | | |
|**architecture** | **String** | | |
|**autoRunAgents** | [**AutoRunAgents**](AutoRunAgents.md) | | |
|**binaryDynamic** | **Boolean** | | |
|**binaryFormat** | **String** | | |
|**binaryName** | **String** | | |
Expand All @@ -22,7 +23,6 @@
|**modelName** | **String** | | |
|**sbom** | **Map&lt;String, Object&gt;** | | [optional] |
|**sha256Hash** | **String** | | |
|**autoRunAgents** | [**AutoRunAgents**](AutoRunAgents.md) | | |



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

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


Expand Down
Loading