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
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 @@
v4.4.0
v4.51.0
193 changes: 189 additions & 4 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.4.0'
version = '4.51.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.4.0")
coordinates("ai.reveng", "sdk", "4.51.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.4.0",
version := "4.51.0",
scalaVersion := "2.11.12",
scalacOptions ++= Seq("-feature"),
compile / javacOptions ++= Seq("-Xlint:deprecation"),
Expand Down
2 changes: 1 addition & 1 deletion docs/APIError.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**error** | [**ErrorBody**](ErrorBody.md) | | |
|**error** | **ErrorBody** | | |



3,365 changes: 3,217 additions & 148 deletions docs/AgentApi.md

Large diffs are not rendered by default.

331 changes: 327 additions & 4 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 @@ -24,6 +24,7 @@
|**isSystem** | **Boolean** | True when the analysis is owned by a system user | |
|**modelId** | **Long** | Model ID | |
|**modelName** | **String** | Model used for analysis | |
|**modelUpgradeAvailable** | **Boolean** | True when the analysis ran on a model older than the current one, so its owner can re-analyse it on the latest. Describes the analysis, not the caller's rights β€” only the owner may act on it | |
|**ownerUsername** | **String** | Username of the analysis owner | |
|**sequencerVersion** | **String** | Sequencer version, omitted when not set | [optional] |
|**sha256Hash** | **String** | SHA-256 hash of the binary | |
Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysisConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**scrapeThirdPartyConfig** | [**ScrapeThirdPartyConfig**](ScrapeThirdPartyConfig.md) | Settings to scrape third party sources | [optional] |
|**scrapeThirdPartyConfig** | **ScrapeThirdPartyConfig** | Settings to scrape third party sources | [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] |
Expand Down
6 changes: 3 additions & 3 deletions docs/AnalysisCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
|**sha256Hash** | **String** | The sha256 hash of the file | |
|**tags** | [**List<Tag>**](Tag.md) | List of tags to assign to an analysis | [optional] |
|**analysisScope** | **AnalysisScope** | The scope of the analysis determines who can access it | [optional] |
|**symbols** | [**Symbols**](Symbols.md) | Symbols are user-defined properties which inform how the binary is decompiled | [optional] |
|**symbols** | **Symbols** | Symbols are user-defined properties which inform how the binary is decompiled | [optional] |
|**debugHash** | **String** | Hash of the debug file | [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] |
|**binaryConfig** | **BinaryConfig** | The binary config can override automatically determined values such as ISA, Platform, File Format, etc | [optional] |
|**autoRunAgents** | **AutoRunAgents** | | [optional] |



2 changes: 1 addition & 1 deletion docs/AnalysisDetailResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
|**debug** | **Boolean** | | |
|**modelName** | **String** | | |
|**sha256Hash** | **String** | | |
|**autoRunAgents** | [**AutoRunAgents**](AutoRunAgents.md) | | |
|**autoRunAgents** | **AutoRunAgents** | | |
|**requestedConfig** | [**AnalysisConfigSnapshot**](AnalysisConfigSnapshot.md) | Snapshot of the configuration the analysis was submitted with. | |


Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysisFunctionEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
|**functionName** | **String** | | |
|**functionSize** | **Long** | | |
|**functionVaddr** | **Long** | | |
|**mangledName** | **String** | Search is applied to string value | [optional] |
|**mangledName** | **String** | | [optional] |
|**sourceAnalysisId** | **Long** | ID of the analysis the source function belongs to, if any | [optional] |
|**sourceBinaryId** | **Long** | | [optional] |
|**sourceFunctionId** | **Long** | ID of the source function this name was transferred from, if any | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysisLogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**messageCount** | **Long** | | |
|**messages** | [**List<AnalysisLogMessage>**](AnalysisLogMessage.md) | | |
|**messages** | **List<AnalysisLogMessage>** | | |



3 changes: 2 additions & 1 deletion docs/AnalysisRecordBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@
|**isOwner** | **Boolean** | True when the caller owns the analysis | |
|**modelId** | **Long** | Model ID | |
|**modelName** | **String** | Model name | |
|**modelUpgradeAvailable** | **Boolean** | True when the analysis ran on a model older than the current one, so its owner can re-analyse it on the latest. Describes the analysis, not the caller's rights β€” only the owner may act on it | |
|**sha256Hash** | **String** | SHA-256 hash of the binary | |
|**status** | **String** | Analysis status | |
|**suppliedArchitecture** | **String** | User-supplied instruction-set architecture; \"AUTO\" when not overridden | |
|**suppliedBinaryFormat** | **String** | User-supplied binary container format; \"AUTO\" when not overridden | |
|**suppliedBinaryType** | **String** | User-supplied operating-system platform; \"AUTO\" when not overridden | |
|**tags** | [**List<AnalysisTagBody>**](AnalysisTagBody.md) | Tags associated with the binary | |
|**tags** | **List<AnalysisTagBody>** | Tags associated with the binary | |
|**username** | **String** | Username of the analysis owner | |


Expand Down
30 changes: 15 additions & 15 deletions docs/AnalysisReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**artifacts** | [**List<Artifact>**](Artifact.md) | | [optional] |
|**consoleOutput** | [**List<ConsoleOutputEntry>**](ConsoleOutputEntry.md) | | [optional] |
|**fileActivity** | [**List<FileActivityEntry>**](FileActivityEntry.md) | | [optional] |
|**info** | [**ReportInfo**](ReportInfo.md) | | |
|**memdumps** | [**List<ProcessMemdumps>**](ProcessMemdumps.md) | | [optional] |
|**moduleLoadAddresses** | [**List<ModuleLoadEntry>**](ModuleLoadEntry.md) | | [optional] |
|**mutexes** | [**List<MutexEntry>**](MutexEntry.md) | | [optional] |
|**networkActivity** | [**NetworkActivity**](NetworkActivity.md) | | [optional] |
|**processActivity** | [**List<ProcessActivityEntry>**](ProcessActivityEntry.md) | | [optional] |
|**processTree** | [**ProcessTree**](ProcessTree.md) | | [optional] |
|**registryOperations** | [**List<RegistryOperation>**](RegistryOperation.md) | | [optional] |
|**scheduledTasks** | [**List<ScheduledTaskEntry>**](ScheduledTaskEntry.md) | | [optional] |
|**services** | [**List<ServiceEntry>**](ServiceEntry.md) | | [optional] |
|**startup** | [**StartupInfo**](StartupInfo.md) | | [optional] |
|**ttps** | [**List<Ttp>**](Ttp.md) | | [optional] |
|**artifacts** | **List<Artifact>** | | [optional] |
|**consoleOutput** | **List<ConsoleOutputEntry>** | | [optional] |
|**fileActivity** | **List<FileActivityEntry>** | | [optional] |
|**info** | **ReportInfo** | | |
|**memdumps** | **List<ProcessMemdumps>** | | [optional] |
|**moduleLoadAddresses** | **List<ModuleLoadEntry>** | | [optional] |
|**mutexes** | **List<MutexEntry>** | | [optional] |
|**networkActivity** | **NetworkActivity** | | [optional] |
|**processActivity** | **List<ProcessActivityEntry>** | | [optional] |
|**processTree** | **ProcessTree** | | [optional] |
|**registryOperations** | **List<RegistryOperation>** | | [optional] |
|**scheduledTasks** | **List<ScheduledTaskEntry>** | | [optional] |
|**services** | **List<ServiceEntry>** | | [optional] |
|**startup** | **StartupInfo** | | [optional] |
|**ttps** | **List<Ttp>** | | [optional] |



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


# AnalysisRequirement


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**fields** | **List<String>** | CreateAnalysis field paths that must be provided or enabled to satisfy this requirement. | |
|**reason** | **String** | Why this requirement unblocks analysis. | |
|**values** | **Map<String, String>** | Field paths that must carry a specific value, keyed the same way as fields. | [optional] |



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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**functions** | [**List<AnalysisStringFunction>**](AnalysisStringFunction.md) | | |
|**functions** | **List<AnalysisStringFunction>** | | |
|**source** | **String** | | |
|**value** | **String** | | |

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


# ApiCombinationEvidence

A known combination of APIs without a demonstrated semantic flow.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**evidenceKind** | [**EvidenceKindEnum**](#EvidenceKindEnum) | | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | | [optional] |
|**effect** | **EvidenceEffect** | | |
|**strength** | [**StrengthEnum**](#StrengthEnum) | | [optional] |
|**apis** | [**List<ImportedApi>**](ImportedApi.md) | | |



## 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" |



3 changes: 2 additions & 1 deletion docs/ArrayDataType.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@
|------------ | ------------- | ------------- | -------------|
|**createdAt** | **OffsetDateTime** | When this type was extracted. | |
|**dataTypeId** | **Long** | Identifies the type within its analysis. 0 is a valid id. | |
|**definition** | [**ArrayDefinition**](ArrayDefinition.md) | Absent only for a type referenced but never defined. | [optional] |
|**definition** | **ArrayDefinition** | Absent only for a type referenced but never defined. | [optional] |
|**hasDefinition** | **Boolean** | Whether this type carries a definition. False for the kinds that never have one and for a type referenced but never defined. | |
|**kind** | [**KindEnum**](#KindEnum) | | |
|**name** | **String** | Type name. | |
|**namespace** | **String** | The scope qualifying the type name. Empty for a program-defined type. | |
|**size** | **Long** | Size in bytes, absent when it could not be determined. | [optional] |
|**sourceAnalysisId** | **Long** | ID of the analysis the source function belongs to, when it could be resolved. | [optional] |
|**sourceFunctionId** | **Long** | The function this type was copied from, when transferred rather than extracted. | [optional] |
|**sourceType** | [**SourceTypeEnum**](#SourceTypeEnum) | Where this type came from. | |

Expand Down
1 change: 1 addition & 0 deletions docs/BaseDataType.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
|**name** | **String** | Type name. | |
|**namespace** | **String** | The scope qualifying the type name. Empty for a program-defined type. | |
|**size** | **Long** | Size in bytes, absent when it could not be determined. | [optional] |
|**sourceAnalysisId** | **Long** | ID of the analysis the source function belongs to, when it could be resolved. | [optional] |
|**sourceFunctionId** | **Long** | The function this type was copied from, when transferred rather than extracted. | [optional] |
|**sourceType** | [**SourceTypeEnum**](#SourceTypeEnum) | Where this type came from. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/BaseResponseListDieMatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**status** | **Boolean** | Response status on whether the request succeeded | [optional] |
|**data** | [**List<DieMatch>**](DieMatch.md) | Response data | [optional] |
|**data** | **List<DieMatch>** | Response data | [optional] |
|**message** | **String** | Response message | [optional] |
|**errors** | [**List<ErrorModel>**](ErrorModel.md) | List of errors | [optional] |
|**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional] |
Expand Down
17 changes: 17 additions & 0 deletions docs/BaseResponseProtocolsAgentResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# BaseResponseProtocolsAgentResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**status** | **Boolean** | Response status on whether the request succeeded | [optional] |
|**data** | **ProtocolsAgentResponse** | Response data | [optional] |
|**message** | **String** | Response message | [optional] |
|**errors** | [**List<ErrorModel>**](ErrorModel.md) | List of errors | [optional] |
|**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional] |



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


# BaseResponseSecretsAgentResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**status** | **Boolean** | Response status on whether the request succeeded | [optional] |
|**data** | **SecretsAgentResponse** | Response data | [optional] |
|**message** | **String** | Response message | [optional] |
|**errors** | [**List<ErrorModel>**](ErrorModel.md) | List of errors | [optional] |
|**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional] |



2 changes: 1 addition & 1 deletion docs/BatchFunctionSignatureEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
|**functionId** | **Long** | | |
|**functionName** | **String** | Current name of the function. | |
|**hasSignature** | **Boolean** | Whether a signature was extracted for this function. False is a normal result: no signature is recorded unless data type extraction ran for the analysis, and thunks and external functions are skipped when it does. | |
|**parameters** | [**List<SignatureParameterEntry>**](SignatureParameterEntry.md) | Parameters in argument order. Empty with has_signature true means the function is known to take no arguments. | |
|**parameters** | **List<SignatureParameterEntry>** | Parameters in argument order. Empty with has_signature true means the function is known to take no arguments. | |
|**returnDataTypeId** | **Long** | Return type, resolvable against the analysis data types list. Absent for an unresolved return type. | [optional] |
|**sourceFunctionId** | **Long** | The function this signature was copied from, when it was transferred rather than extracted. | [optional] |
|**sourceType** | [**SourceTypeEnum**](#SourceTypeEnum) | Where this signature came from. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/BatchMatchingOutputBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**perBinary** | [**List<BatchBinaryMatchResult>**](BatchBinaryMatchResult.md) | Per-binary status (order matches the request). | |
|**perBinary** | **List<BatchBinaryMatchResult>** | Per-binary status (order matches the request). | |
|**status** | [**StatusEnum**](#StatusEnum) | Aggregate status across the batch: COMPLETED when every binary is completed, FAILED if any failed, RUNNING/PENDING otherwise. | |


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

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**functions** | [**List<BatchRenameItem>**](BatchRenameItem.md) | List of functions to rename | |
|**functions** | **List<BatchRenameItem>** | List of functions to rename | |



Loading
Loading