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 @@
v2.4.0
v2.8.0
27 changes: 2 additions & 25 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>2.4.0</version>
<version>2.8.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -31,7 +31,7 @@ repositories {
}

dependencies {
implementation "ai.reveng:sdk:2.4.0"
implementation "ai.reveng:sdk:2.8.0"
}
```

Expand Down Expand Up @@ -82,7 +82,6 @@ Class | Method | HTTP request | Description
*AnalysesCommentsApi* | [**updateAnalysisComment**](docs/AnalysesCommentsApi.md#updateAnalysisComment) | **PATCH** /v2/analyses/{analysis_id}/comments/{comment_id} | Update a comment
*AnalysesCoreApi* | [**createAnalysis**](docs/AnalysesCoreApi.md#createAnalysis) | **POST** /v2/analyses | Create Analysis
*AnalysesCoreApi* | [**deleteAnalysis**](docs/AnalysesCoreApi.md#deleteAnalysis) | **DELETE** /v2/analyses/{analysis_id} | Delete Analysis
*AnalysesCoreApi* | [**findSimilarFunctionsBatch**](docs/AnalysesCoreApi.md#findSimilarFunctionsBatch) | **POST** /v2/analyses/{analysis_id}/similarity/functions | Batch Symbol ANN using Analysis ID
*AnalysesCoreApi* | [**getAnalysisBasicInfo**](docs/AnalysesCoreApi.md#getAnalysisBasicInfo) | **GET** /v2/analyses/{analysis_id}/basic | Gets basic analysis information
*AnalysesCoreApi* | [**getAnalysisFunctionMap**](docs/AnalysesCoreApi.md#getAnalysisFunctionMap) | **GET** /v2/analyses/{analysis_id}/func_maps | Get Analysis Function Map
*AnalysesCoreApi* | [**getAnalysisLogs**](docs/AnalysesCoreApi.md#getAnalysisLogs) | **GET** /v2/analyses/{analysis_id}/logs | Gets the logs of an analysis
Expand Down Expand Up @@ -130,10 +129,6 @@ Class | Method | HTTP request | Description
*CollectionsApi* | [**updateCollection**](docs/CollectionsApi.md#updateCollection) | **PATCH** /v2/collections/{collection_id} | Updates a collection
*CollectionsApi* | [**updateCollectionBinaries**](docs/CollectionsApi.md#updateCollectionBinaries) | **PATCH** /v2/collections/{collection_id}/binaries | Updates a collection binaries
*CollectionsApi* | [**updateCollectionTags**](docs/CollectionsApi.md#updateCollectionTags) | **PATCH** /v2/collections/{collection_id}/tags | Updates a collection tags
*ConfidenceApi* | [**getAnalysisTagScore**](docs/ConfidenceApi.md#getAnalysisTagScore) | **POST** /v2/confidence/analysis/{analysis_id}/tag_score | Calculate Tag Confidence Score for an Analysis
*ConfidenceApi* | [**getAnalysisThreatScore**](docs/ConfidenceApi.md#getAnalysisThreatScore) | **GET** /v2/confidence/analysis/{analysis_id}/threat_score | Calculate Threat Score for Binary
*ConfidenceApi* | [**getFunctionsNameScore**](docs/ConfidenceApi.md#getFunctionsNameScore) | **POST** /v2/confidence/functions/name_score | Calculate function name confidence for a set of Functions
*ConfidenceApi* | [**getFunctionsThreatScore**](docs/ConfidenceApi.md#getFunctionsThreatScore) | **POST** /v2/confidence/functions/threat_score | Calculate Threat Score for a set of Functions
*ExternalSourcesApi* | [**createExternalTaskMb**](docs/ExternalSourcesApi.md#createExternalTaskMb) | **POST** /v2/analysis/{analysis_id}/external/mb | Pulls data from VirusTotal
*ExternalSourcesApi* | [**createExternalTaskVt**](docs/ExternalSourcesApi.md#createExternalTaskVt) | **POST** /v2/analysis/{analysis_id}/external/vt | Pulls data from VirusTotal
*ExternalSourcesApi* | [**getMbData**](docs/ExternalSourcesApi.md#getMbData) | **GET** /v2/analysis/{analysis_id}/external/mb | Get MalwareBazaar data
Expand Down Expand Up @@ -166,7 +161,6 @@ Class | Method | HTTP request | Description
*FunctionsCoreApi* | [**getFunctionCapabilities**](docs/FunctionsCoreApi.md#getFunctionCapabilities) | **GET** /v2/functions/{function_id}/capabilities | Retrieve a functions capabilities
*FunctionsCoreApi* | [**getFunctionDetails**](docs/FunctionsCoreApi.md#getFunctionDetails) | **GET** /v2/functions/{function_id} | Get function details
*FunctionsCoreApi* | [**getFunctionStrings**](docs/FunctionsCoreApi.md#getFunctionStrings) | **GET** /v2/functions/{function_id}/strings | Get string information found in the function
*FunctionsCoreApi* | [**getSimilarFunctions**](docs/FunctionsCoreApi.md#getSimilarFunctions) | **GET** /v2/functions/{function_id}/similar-functions | Get list of similar functions
*FunctionsDataTypesApi* | [**generateFunctionDataTypesForAnalysis**](docs/FunctionsDataTypesApi.md#generateFunctionDataTypesForAnalysis) | **POST** /v2/analyses/{analysis_id}/functions/data_types | Generate Function Data Types
*FunctionsDataTypesApi* | [**generateFunctionDataTypesForFunctions**](docs/FunctionsDataTypesApi.md#generateFunctionDataTypesForFunctions) | **POST** /v2/functions/data_types | Generate Function Data Types for an arbitrary list of functions
*FunctionsDataTypesApi* | [**getFunctionDataTypes**](docs/FunctionsDataTypesApi.md#getFunctionDataTypes) | **GET** /v2/analyses/{analysis_id}/functions/{function_id}/data_types | Get Function Data Types
Expand All @@ -193,7 +187,6 @@ Class | Method | HTTP request | Description

## Documentation for Models

- [ANNFunction](docs/ANNFunction.md)
- [Addr](docs/Addr.md)
- [AiDecompilationRating](docs/AiDecompilationRating.md)
- [AiUnstripRequest](docs/AiUnstripRequest.md)
Expand Down Expand Up @@ -240,7 +233,6 @@ Class | Method | HTTP request | Description
- [BaseResponseBlockCommentsGenerationForFunctionResponse](docs/BaseResponseBlockCommentsGenerationForFunctionResponse.md)
- [BaseResponseBlockCommentsOverviewGenerationResponse](docs/BaseResponseBlockCommentsOverviewGenerationResponse.md)
- [BaseResponseBool](docs/BaseResponseBool.md)
- [BaseResponseBoxPlotConfidence](docs/BaseResponseBoxPlotConfidence.md)
- [BaseResponseCalleesCallerFunctionsResponse](docs/BaseResponseCalleesCallerFunctionsResponse.md)
- [BaseResponseCapabilities](docs/BaseResponseCapabilities.md)
- [BaseResponseCheckSecurityChecksTaskResponse](docs/BaseResponseCheckSecurityChecksTaskResponse.md)
Expand Down Expand Up @@ -273,16 +265,12 @@ Class | Method | HTTP request | Description
- [BaseResponseListCollectionResults](docs/BaseResponseListCollectionResults.md)
- [BaseResponseListCommentResponse](docs/BaseResponseListCommentResponse.md)
- [BaseResponseListDieMatch](docs/BaseResponseListDieMatch.md)
- [BaseResponseListFunctionBoxPlotConfidence](docs/BaseResponseListFunctionBoxPlotConfidence.md)
- [BaseResponseListFunctionNameHistory](docs/BaseResponseListFunctionNameHistory.md)
- [BaseResponseListSBOM](docs/BaseResponseListSBOM.md)
- [BaseResponseListSimilarFunctionsResponse](docs/BaseResponseListSimilarFunctionsResponse.md)
- [BaseResponseListTagOriginBoxPlotConfidence](docs/BaseResponseListTagOriginBoxPlotConfidence.md)
- [BaseResponseListUserActivityResponse](docs/BaseResponseListUserActivityResponse.md)
- [BaseResponseLoginResponse](docs/BaseResponseLoginResponse.md)
- [BaseResponseLogs](docs/BaseResponseLogs.md)
- [BaseResponseModelsResponse](docs/BaseResponseModelsResponse.md)
- [BaseResponseNearestNeighborAnalysis](docs/BaseResponseNearestNeighborAnalysis.md)
- [BaseResponseNetworkOverviewResponse](docs/BaseResponseNetworkOverviewResponse.md)
- [BaseResponseParams](docs/BaseResponseParams.md)
- [BaseResponseProcessDumps](docs/BaseResponseProcessDumps.md)
Expand Down Expand Up @@ -311,7 +299,6 @@ Class | Method | HTTP request | Description
- [BinaryTaskStatus](docs/BinaryTaskStatus.md)
- [Block](docs/Block.md)
- [BlockCommentsGenerationForFunctionResponse](docs/BlockCommentsGenerationForFunctionResponse.md)
- [BoxPlotConfidence](docs/BoxPlotConfidence.md)
- [CalleeFunctionInfo](docs/CalleeFunctionInfo.md)
- [CalleesCallerFunctionsResponse](docs/CalleesCallerFunctionsResponse.md)
- [CallerFunctionInfo](docs/CallerFunctionInfo.md)
Expand Down Expand Up @@ -367,7 +354,6 @@ Class | Method | HTTP request | Description
- [FunctionBlockResponse](docs/FunctionBlockResponse.md)
- [FunctionBlocksResponse](docs/FunctionBlocksResponse.md)
- [FunctionBoundary](docs/FunctionBoundary.md)
- [FunctionBoxPlotConfidence](docs/FunctionBoxPlotConfidence.md)
- [FunctionCapabilityResponse](docs/FunctionCapabilityResponse.md)
- [FunctionCommentCreateRequest](docs/FunctionCommentCreateRequest.md)
- [FunctionDataTypes](docs/FunctionDataTypes.md)
Expand All @@ -386,9 +372,7 @@ Class | Method | HTTP request | Description
- [FunctionMatchingFilters](docs/FunctionMatchingFilters.md)
- [FunctionMatchingRequest](docs/FunctionMatchingRequest.md)
- [FunctionMatchingResultWithBestMatch](docs/FunctionMatchingResultWithBestMatch.md)
- [FunctionNameConfidenceBody](docs/FunctionNameConfidenceBody.md)
- [FunctionNameHistory](docs/FunctionNameHistory.md)
- [FunctionNameInput](docs/FunctionNameInput.md)
- [FunctionParamResponse](docs/FunctionParamResponse.md)
- [FunctionRename](docs/FunctionRename.md)
- [FunctionRenameMap](docs/FunctionRenameMap.md)
Expand Down Expand Up @@ -425,13 +409,11 @@ Class | Method | HTTP request | Description
- [ModelName](docs/ModelName.md)
- [ModelsResponse](docs/ModelsResponse.md)
- [NameConfidence](docs/NameConfidence.md)
- [NearestNeighbor](docs/NearestNeighbor.md)
- [NetworkOverviewDns](docs/NetworkOverviewDns.md)
- [NetworkOverviewDnsAnswer](docs/NetworkOverviewDnsAnswer.md)
- [NetworkOverviewMetadata](docs/NetworkOverviewMetadata.md)
- [NetworkOverviewResponse](docs/NetworkOverviewResponse.md)
- [Order](docs/Order.md)
- [Origin](docs/Origin.md)
- [PDBDebugModel](docs/PDBDebugModel.md)
- [PEModel](docs/PEModel.md)
- [PaginationModel](docs/PaginationModel.md)
Expand All @@ -458,7 +440,6 @@ Class | Method | HTTP request | Description
- [SecurityChecksResult](docs/SecurityChecksResult.md)
- [SecurityModel](docs/SecurityModel.md)
- [SeverityType](docs/SeverityType.md)
- [SimilarFunctionsResponse](docs/SimilarFunctionsResponse.md)
- [SingleCodeCertificateModel](docs/SingleCodeCertificateModel.md)
- [SingleCodeSignatureModel](docs/SingleCodeSignatureModel.md)
- [SinglePDBEntryModel](docs/SinglePDBEntryModel.md)
Expand All @@ -476,15 +457,11 @@ Class | Method | HTTP request | Description
- [TTPSElement](docs/TTPSElement.md)
- [TTPSOccurance](docs/TTPSOccurance.md)
- [Tag](docs/Tag.md)
- [TagConfidenceBody](docs/TagConfidenceBody.md)
- [TagOriginBoxPlotConfidence](docs/TagOriginBoxPlotConfidence.md)
- [TagResponse](docs/TagResponse.md)
- [TagSearchResponse](docs/TagSearchResponse.md)
- [TagSearchResult](docs/TagSearchResult.md)
- [Tags](docs/Tags.md)
- [TaskResponse](docs/TaskResponse.md)
- [TaskStatus](docs/TaskStatus.md)
- [ThreatScoreFunctionBody](docs/ThreatScoreFunctionBody.md)
- [TimestampModel](docs/TimestampModel.md)
- [TypeDefinition](docs/TypeDefinition.md)
- [UpdateFunctionDataTypes](docs/UpdateFunctionDataTypes.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 = '2.4.0'
version = '2.8.0'



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

coordinates("ai.reveng", "sdk", "2.4.0")
coordinates("ai.reveng", "sdk", "2.8.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 := "2.4.0",
version := "2.8.0",
scalaVersion := "2.11.12",
scalacOptions ++= Seq("-feature"),
compile / javacOptions ++= Seq("-Xlint:deprecation"),
Expand Down
19 changes: 0 additions & 19 deletions docs/ANNFunction.md

This file was deleted.

73 changes: 0 additions & 73 deletions docs/AnalysesCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ All URIs are relative to *https://api.reveng.ai*
|------------- | ------------- | -------------|
| [**createAnalysis**](AnalysesCoreApi.md#createAnalysis) | **POST** /v2/analyses | Create Analysis |
| [**deleteAnalysis**](AnalysesCoreApi.md#deleteAnalysis) | **DELETE** /v2/analyses/{analysis_id} | Delete Analysis |
| [**findSimilarFunctionsBatch**](AnalysesCoreApi.md#findSimilarFunctionsBatch) | **POST** /v2/analyses/{analysis_id}/similarity/functions | Batch Symbol ANN using Analysis ID |
| [**getAnalysisBasicInfo**](AnalysesCoreApi.md#getAnalysisBasicInfo) | **GET** /v2/analyses/{analysis_id}/basic | Gets basic analysis information |
| [**getAnalysisFunctionMap**](AnalysesCoreApi.md#getAnalysisFunctionMap) | **GET** /v2/analyses/{analysis_id}/func_maps | Get Analysis Function Map |
| [**getAnalysisLogs**](AnalysesCoreApi.md#getAnalysisLogs) | **GET** /v2/analyses/{analysis_id}/logs | Gets the logs of an analysis |
Expand Down Expand Up @@ -165,78 +164,6 @@ public class Example {
| **404** | Not Found | - |
| **403** | Forbidden | - |

<a id="findSimilarFunctionsBatch"></a>
# **findSimilarFunctionsBatch**
> BaseResponseNearestNeighborAnalysis findSimilarFunctionsBatch(analysisId, anNFunction)

Batch Symbol ANN using Analysis ID

Takes a analysis ID and returns the nearest functions within the database that match those functions

### 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 |
ANNFunction anNFunction = new ANNFunction(); // ANNFunction |
try {
BaseResponseNearestNeighborAnalysis result = apiInstance.findSimilarFunctionsBatch(analysisId, anNFunction);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalysesCoreApi#findSimilarFunctionsBatch");
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**| | |
| **anNFunction** | [**ANNFunction**](ANNFunction.md)| | |

### Return type

[**BaseResponseNearestNeighborAnalysis**](BaseResponseNearestNeighborAnalysis.md)

### Authorization

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

### HTTP request headers

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

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful Response | - |
| **422** | Invalid request parameters | - |

<a id="getAnalysisBasicInfo"></a>
# **getAnalysisBasicInfo**
> BaseResponseBasic getAnalysisBasicInfo(analysisId)
Expand Down
17 changes: 0 additions & 17 deletions docs/BaseResponseBoxPlotConfidence.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/BaseResponseListFunctionBoxPlotConfidence.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/BaseResponseListSimilarFunctionsResponse.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/BaseResponseListTagOriginBoxPlotConfidence.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/BaseResponseNearestNeighborAnalysis.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/BoxPlotConfidence.md

This file was deleted.

Loading