Skip to content
Open
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 @@
v4.72.2
v4.73.0
66 changes: 64 additions & 2 deletions README.md

Large diffs are not rendered by default.

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 = '4.72.2'
version = '4.73.0'



Expand Down Expand Up @@ -174,7 +174,7 @@ mavenPublishing {
// key, and signing without one fails the build.
if (project.hasProperty("signingInMemoryKey")) signAllPublications()

coordinates("ai.reveng", "sdk", "4.72.2")
coordinates("ai.reveng", "sdk", "4.73.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 := "4.72.2",
version := "4.73.0",
scalaVersion := "2.11.12",
scalacOptions ++= Seq("-feature"),
compile / javacOptions ++= Seq("-Xlint:deprecation"),
Expand Down
54 changes: 54 additions & 0 deletions docs/APICombinationEvidence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@


# APICombinationEvidence


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**apis** | **List<ReportImportedAPI>** | The APIs in the combination. | |
|**effect** | [**EffectEnum**](#EffectEnum) | Whether the evidence supports or refutes the finding. | |
|**evidenceKind** | [**EvidenceKindEnum**](#EvidenceKindEnum) | Kind of evidence. | |
|**kind** | [**KindEnum**](#KindEnum) | How the evidence was derived. | |
|**strength** | [**StrengthEnum**](#StrengthEnum) | How directly the evidence bears on the finding. | |



## Enum: EffectEnum

| Name | Value |
|---- | -----|
| SUPPORTS | "supports" |
| REFUTES | "refutes" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: EvidenceKindEnum

| Name | Value |
|---- | -----|
| API_COMBINATION | "api_combination" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: KindEnum

| Name | Value |
|---- | -----|
| DETERMINISTIC_DERIVATION | "deterministic_derivation" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: StrengthEnum

| Name | Value |
|---- | -----|
| INDIRECT | "indirect" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



336 changes: 322 additions & 14 deletions docs/AgentApi.md

Large diffs are not rendered by default.

1,794 changes: 1,705 additions & 89 deletions docs/AnalysesCoreApi.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/AnalysisBasicInfoOutputBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
|**detectedArchitecture** | **String** | Detected instruction-set architecture; empty when unavailable | |
|**detectedBinaryFormat** | **String** | Detected binary container format; empty when unavailable | |
|**detectedBinaryType** | **String** | Detected operating-system platform; empty when unavailable | |
|**detectedLanguage** | **String** | Detected source language; empty when unavailable | |
|**functionCount** | **Long** | Number of functions in the binary | |
|**isAdvanced** | **Boolean** | True when the analysis was run in advanced mode | |
|**isOwner** | **Boolean** | True when the caller is the analysis owner | |
Expand Down
3 changes: 3 additions & 0 deletions docs/AnalysisDetailOutputBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,15 @@
|**binaryName** | **String** | | |
|**binarySize** | **Long** | | |
|**binaryType** | **String** | | |
|**capabilityCount** | **Long** | Number of capabilities in the latest capabilities agent result. Null when the agent has not produced a result | |
|**creation** | **String** | | |
|**dashboardUrl** | **String** | URL to view this analysis in the dashboard | |
|**debug** | **Boolean** | | |
|**modelName** | **String** | | |
|**requestedConfig** | **RequestedConfigBody** | Snapshot of the configuration the analysis was submitted with | |
|**securityFindingCount** | **Long** | Number of HIGH or CRITICAL findings in the latest security scan. Null when the scan has not produced a result | |
|**sha256Hash** | **String** | | |
|**threatScore** | **Double** | Software threat score from the latest triage result, from 0 to 1. Null when triage has not produced a result | |



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


# AnalysisOperationBody


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | Resource name of the operation, polled at /v3/{name} | |
|**operation** | **String** | Operation slug, the collection the operation is polled under | |
|**status** | [**StatusEnum**](#StatusEnum) | Status of the operation's latest run | |



## Enum: StatusEnum

| Name | Value |
|---- | -----|
| UNINITIALISED | "UNINITIALISED" |
| PENDING | "PENDING" |
| RUNNING | "RUNNING" |
| COMPLETED | "COMPLETED" |
| FAILED | "FAILED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



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


# AnalysisOperationsOutputBody


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**operations** | **List<AnalysisOperationBody>** | The analysis' static-analysis operation, followed by the latest run of each other operation started on its binary. Operations that have never run are omitted | |



1 change: 1 addition & 0 deletions docs/AnalysisRecordBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
|**detectedArchitecture** | **String** | Detected instruction-set architecture; empty when unavailable | |
|**detectedBinaryFormat** | **String** | Detected binary container format; empty when unavailable | |
|**detectedBinaryType** | **String** | Detected operating-system platform; empty when unavailable | |
|**detectedLanguage** | **String** | Detected source language; empty when unavailable | |
|**functionBoundariesHash** | **String** | Hash of the binary's provided function boundaries | |
|**isOwner** | **Boolean** | True when the caller owns the analysis | |
|**modelId** | **Long** | Model ID | |
Expand Down
75 changes: 75 additions & 0 deletions docs/AuthenticationUsersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ All URIs are relative to *https://api.reveng.ai*
| [**submitUserFeedback**](AuthenticationUsersApi.md#submitUserFeedback) | **POST** /v2/users/feedback | Submit feedback about the application |
| [**v3GetUser**](AuthenticationUsersApi.md#v3GetUser) | **GET** /v3/users/{user_id} | Get a user's public information |
| [**v3GetUserActivity**](AuthenticationUsersApi.md#v3GetUserActivity) | **GET** /v3/users/activity | Get the caller's activity feed |
| [**v3ListUsers**](AuthenticationUsersApi.md#v3ListUsers) | **GET** /v3/users | Search users |
| [**v3SubmitUserFeedback**](AuthenticationUsersApi.md#v3SubmitUserFeedback) | **POST** /v3/users/feedback | Submit feedback |


Expand Down Expand Up @@ -372,6 +373,80 @@ This endpoint does not need any parameter.
| **200** | OK | - |
| **0** | Error | - |

<a id="v3ListUsers"></a>
# **v3ListUsers**
> ListPublicUsersOutputBody v3ListUsers(searchTerm)

Search users

Returns up to 5 active users whose username contains the search term (case-insensitive), with their ID and username, ordered by username.

### 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.AuthenticationUsersApi;

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");

// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");

AuthenticationUsersApi apiInstance = new AuthenticationUsersApi(defaultClient);
String searchTerm = "searchTerm_example"; // String | Text the username contains (case-insensitive)
try {
ListPublicUsersOutputBody result = apiInstance.v3ListUsers(searchTerm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthenticationUsersApi#v3ListUsers");
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 |
|------------- | ------------- | ------------- | -------------|
| **searchTerm** | **String**| Text the username contains (case-insensitive) | |

### Return type

[**ListPublicUsersOutputBody**](ListPublicUsersOutputBody.md)

### Authorization

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

### HTTP request headers

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

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | OK | - |
| **0** | Error | - |

<a id="v3SubmitUserFeedback"></a>
# **v3SubmitUserFeedback**
> SubmitFeedbackOutputBody v3SubmitUserFeedback(submitFeedbackBody)
Expand Down
1 change: 1 addition & 0 deletions docs/Binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
|**createdAt** | **OffsetDateTime** | | |
|**detectedArchitecture** | **String** | Detected instruction-set architecture; empty when unavailable | |
|**detectedBinaryType** | **String** | Detected operating-system platform; empty when unavailable | |
|**detectedLanguage** | **String** | Detected source language; empty when unavailable | |
|**isSystemAnalysis** | **Boolean** | | |
|**modelName** | **String** | Name of the model the analysis ran on | |
|**ownerId** | **Long** | | |
Expand Down
21 changes: 15 additions & 6 deletions docs/CallChainEvidence.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,26 @@

# CallChainEvidence

A concrete sequence of calls connecting program locations.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**evidenceKind** | [**EvidenceKindEnum**](#EvidenceKindEnum) | | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | | [optional] |
|**effect** | **EvidenceEffect** | | |
|**strength** | [**StrengthEnum**](#StrengthEnum) | | [optional] |
|**callChain** | **List&lt;Integer&gt;** | | |
|**callChain** | **List&lt;Long&gt;** | Addresses along the call chain. | |
|**effect** | [**EffectEnum**](#EffectEnum) | Whether the evidence supports or refutes the finding. | |
|**evidenceKind** | [**EvidenceKindEnum**](#EvidenceKindEnum) | Kind of evidence. | |
|**kind** | [**KindEnum**](#KindEnum) | How the evidence was derived. | |
|**strength** | [**StrengthEnum**](#StrengthEnum) | How directly the evidence bears on the finding. | |



## Enum: EffectEnum

| Name | Value |
|---- | -----|
| SUPPORTS | &quot;supports&quot; |
| REFUTES | &quot;refutes&quot; |
| UNKNOWN_DEFAULT_OPEN_API | &quot;unknown_default_open_api&quot; |



Expand Down
21 changes: 15 additions & 6 deletions docs/DecompilerSummaryEvidence.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,26 @@

# DecompilerSummaryEvidence

Semantic summaries derived from decompiler output.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**evidenceKind** | [**EvidenceKindEnum**](#EvidenceKindEnum) | | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | | [optional] |
|**effect** | **EvidenceEffect** | | |
|**strength** | [**StrengthEnum**](#StrengthEnum) | | [optional] |
|**summaries** | [**List&lt;DecompilerSummary&gt;**](DecompilerSummary.md) | | |
|**effect** | [**EffectEnum**](#EffectEnum) | Whether the evidence supports or refutes the finding. | |
|**evidenceKind** | [**EvidenceKindEnum**](#EvidenceKindEnum) | Kind of evidence. | |
|**kind** | [**KindEnum**](#KindEnum) | How the evidence was derived. | |
|**strength** | [**StrengthEnum**](#StrengthEnum) | How directly the evidence bears on the finding. | |
|**summaries** | **List&lt;ReportCodeSummary&gt;** | Summaries of the decompiled code. | |



## Enum: EffectEnum

| Name | Value |
|---- | -----|
| SUPPORTS | &quot;supports&quot; |
| REFUTES | &quot;refutes&quot; |
| UNKNOWN_DEFAULT_OPEN_API | &quot;unknown_default_open_api&quot; |



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


# DisassemblySummaryEvidence


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**effect** | [**EffectEnum**](#EffectEnum) | Whether the evidence supports or refutes the finding. | |
|**evidenceKind** | [**EvidenceKindEnum**](#EvidenceKindEnum) | Kind of evidence. | |
|**kind** | [**KindEnum**](#KindEnum) | How the evidence was derived. | |
|**strength** | [**StrengthEnum**](#StrengthEnum) | How directly the evidence bears on the finding. | |
|**summaries** | **List&lt;ReportCodeSummary&gt;** | Summaries of the disassembled code. | |



## Enum: EffectEnum

| Name | Value |
|---- | -----|
| SUPPORTS | &quot;supports&quot; |
| REFUTES | &quot;refutes&quot; |
| UNKNOWN_DEFAULT_OPEN_API | &quot;unknown_default_open_api&quot; |



## Enum: EvidenceKindEnum

| Name | Value |
|---- | -----|
| DISASSEMBLY_SUMMARY | &quot;disassembly_summary&quot; |
| UNKNOWN_DEFAULT_OPEN_API | &quot;unknown_default_open_api&quot; |



## Enum: KindEnum

| Name | Value |
|---- | -----|
| MODEL_INTERPRETATION | &quot;model_interpretation&quot; |
| UNKNOWN_DEFAULT_OPEN_API | &quot;unknown_default_open_api&quot; |



## Enum: StrengthEnum

| Name | Value |
|---- | -----|
| INDIRECT | &quot;indirect&quot; |
| UNKNOWN_DEFAULT_OPEN_API | &quot;unknown_default_open_api&quot; |



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


# DynamicExecutionResult


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**reportAvailable** | **Boolean** | Whether the run&#39;s report can be fetched from the report endpoint. Always true when the operation succeeded. | |



Loading
Loading