Skip to content

Data Types Sync (Begin,IsCompleted,Set,Get) API Endpoints #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Data Types Sync (Begin,IsCompleted,Set,Get) API Endpoints #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5ef0a7f
Data Types Sync (Begin,IsCompleted,Set,Get) API Endpoints
brightprogrammer Jul 5, 2025
a84b934
GetFunctionsList JSON Parsing Fix (success->status)
brightprogrammer Jul 5, 2025
2d8456c
JI_ Macros, Fixes To Conditional Object Reading
brightprogrammer Jul 7, 2025
174af88
Compatibility With LibBS & Type Redundancy In ControlFlowGraph, DataType
brightprogrammer Jul 9, 2025
30c5fcf
Parse API Response With New Types
brightprogrammer Jul 11, 2025
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
199 changes: 139 additions & 60 deletions Include/Reai/Api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ extern "C" {
///
/// conn[in] : Connection information
///
/// SUCCESS : true
/// FAILURE : false, error messages are logged.
/// SUCCESS: true
/// FAILURE: false, error messages are logged.
///
REAI_API bool Authenticate (Connection* conn);

Expand All @@ -168,8 +168,8 @@ extern "C" {
/// conn[in] : A valid connection object with host and API key set.
/// request[in] : The request object to serialize and send to the server.
///
/// SUCCESS : A non-zero binary ID corresponding to newly created analysis.
/// FAILURE : 0, error messages logged.
/// SUCCESS: A non-zero binary ID corresponding to newly created analysis.
/// FAILURE: 0, error messages logged.
///
REAI_API BinaryId CreateNewAnalysis (Connection* conn, NewAnalysisRequest* request);

Expand All @@ -180,13 +180,13 @@ extern "C" {
/// a response containing basic function information. The response is parsed into a `BasicFunctionInfoResponse`
/// structure, which includes the success flag and a list of functions associated with the binary ID.
///
/// conn[in] : A valid connection object with host and API key set for making the request.
/// binary_id[in] : The binary ID used to identify the binary for which function information is to be fetched.
/// conn[in] : A valid connection object with host and API key set for making the request.
/// analysis_id[in] : The analysis ID used to identify the analysis for which function information is to be fetched.
///
/// SUCCESS : FunctionInfos vector filled with function symbol information retrieved from analysis.
/// FAILURE : Empty FunctionInfos vector.
/// SUCCESS: FunctionInfos vector filled with function symbol information retrieved from analysis.
/// FAILURE: Empty FunctionInfos vector.
///
REAI_API FunctionInfos GetBasicFunctionInfoUsingBinaryId (Connection* conn, BinaryId binary_id);
REAI_API FunctionInfos GetFunctionsList (Connection* conn, AnalysisId analysis_id);

///
/// Sends a request to retrieve recent analysis data based on the provided parameters.
Expand All @@ -197,8 +197,8 @@ extern "C" {
/// conn[in] : A valid connection object with host and API key set.
/// request[in] : The request object that contains the filters and parameters for retrieving recent analysis data.
///
/// SUCCESS : A populated `AnalysisInfos` struct on success.
/// FAILURE : An empty struct (all fields set to 0) on failure.
/// SUCCESS: A populated `AnalysisInfos` struct on success.
/// FAILURE: An empty struct (all fields set to 0) on failure.
///
REAI_API AnalysisInfos GetRecentAnalysis (Connection* conn, RecentAnalysisRequest* request);

Expand All @@ -208,8 +208,8 @@ extern "C" {
/// conn[in] : Connection information.
/// request[in] : Request info.
///
/// SUCCESS : BinaryInfos struct filled with valid data on success.
/// FAILURE : Empty struct otherwise.
/// SUCCESS: BinaryInfos struct filled with valid data on success.
/// FAILURE: Empty struct otherwise.
///
REAI_API BinaryInfos SearchBinary (Connection* conn, SearchBinaryRequest* request);

Expand All @@ -219,8 +219,8 @@ extern "C" {
/// conn[in] : Connection info.
/// request[in] : Request info.
///
/// SUCCESS : CollectionInfos struct filled with valid data on success.
/// FAILURE : Empty struct otherwise.
/// SUCCESS: CollectionInfos struct filled with valid data on success.
/// FAILURE: Empty struct otherwise.
///
REAI_API CollectionInfos SearchCollection (Connection* conn, SearchCollectionRequest* request);

Expand All @@ -230,8 +230,8 @@ extern "C" {
/// conn[in] : Connection
/// functions[in] : Functions to be renamed. Only `id` and `symbol.name` field will be used.
///
/// SUCCESS : true
/// FAILURE : false
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool BatchRenameFunctions (Connection* conn, FunctionInfos functions);

Expand All @@ -242,8 +242,8 @@ extern "C" {
/// fn_id[in] : Functions to be renamed. Only `id` and `symbol.name` field will be used.
/// new_name[in] : Name of function after rename
///
/// SUCCESS : true
/// FAILURE : false
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool RenameFunction (Connection* conn, FunctionId fn_id, Str new_name);

Expand All @@ -267,9 +267,8 @@ extern "C" {
/// conn[in] : Valid connection object with host and API key configured
/// binary_id[in] : Unique identifier for the binary being analyzed
///
/// RETURNS:
/// - Status code indicating current analysis state (STATUS_SUCCESS, STATUS_PENDING, etc.)
/// - STATUS_INVALID if connection parameters are invalid or request fails
/// SUCCESS: Status code indicating current analysis state (STATUS_SUCCESS, STATUS_PENDING, etc.)
/// FAILURE: STATUS_INVALID
///
REAI_API Status GetAnalysisStatus (Connection* conn, BinaryId binary_id);

Expand All @@ -280,9 +279,8 @@ extern "C" {
///
/// conn[in] : Valid connection object with host and API key configured
///
/// RETURNS:
/// - Vector of ModelInfo structures containing model IDs and names
/// - Empty vector if connection fails or no models available
/// SUCCESS: ModelInfos vector filled with model information
/// FAILURE: Empty ModelInfos vector
///
REAI_API ModelInfos GetAiModelInfos (Connection* conn);

Expand All @@ -294,9 +292,8 @@ extern "C" {
/// conn[in] : Valid connection object
/// function_id[in] : ID of the function to decompile
///
/// RETURNS:
/// - true if decompilation job started successfully
/// - false if invalid parameters or connection failure
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool BeginAiDecompilation (Connection* conn, FunctionId function_id);

Expand All @@ -308,9 +305,8 @@ extern "C" {
/// conn[in] : Valid connection object
/// function_id[in] : ID of the function being decompiled
///
/// RETURNS:
/// - Status code (STATUS_PENDING, STATUS_SUCCESS, etc.)
/// - STATUS_INVALID if invalid parameters or connection failure
/// SUCCESS: Status code (STATUS_PENDING, STATUS_SUCCESS, etc.)
/// FAILURE: STATUS_INVALID
///
REAI_API Status GetAiDecompilationStatus (Connection* conn, FunctionId function_id);

Expand All @@ -323,9 +319,8 @@ extern "C" {
/// function_id[in] : ID of the decompiled function
/// get_ai_summary[in]: Whether to include AI-generated summary
///
/// RETURNS:
/// - AiDecompilation structure containing decompilation results
/// - Empty structure if job failed or results unavailable
/// SUCCESS: AiDecompilation structure containing decompilation results
/// FAILURE: Empty AiDecompilation structure
///
REAI_API AiDecompilation
GetAiDecompilation (Connection* conn, FunctionId function_id, bool get_ai_summary);
Expand All @@ -339,8 +334,8 @@ extern "C" {
/// conn[in] : A valid connection object with host and API key set.
/// function_id[in]: The function ID for which to retrieve the CFG.
///
/// SUCCESS : ControlFlowGraph structure populated with CFG data
/// FAILURE : Empty ControlFlowGraph structure
/// SUCCESS: ControlFlowGraph structure populated with CFG data
/// FAILURE: Empty ControlFlowGraph structure
///
REAI_API ControlFlowGraph
GetFunctionControlFlowGraph (Connection* conn, FunctionId function_id);
Expand All @@ -353,9 +348,8 @@ extern "C" {
/// conn[in] : Valid connection object
/// request[in] : Parameters controlling search criteria and filters
///
/// RETURNS:
/// - Vector of SimilarFunction structures containing match details
/// - Empty vector if no matches found or connection failure
/// SUCCESS: Vector of SimilarFunction structures containing match details
/// FAILURE: Empty vector
///
REAI_API SimilarFunctions
GetSimilarFunctions (Connection* conn, SimilarFunctionsRequest* request);
Expand All @@ -368,11 +362,99 @@ extern "C" {
/// conn[in] : Valid connection object
/// binary_id[in] : ID of the binary file to look up
///
/// SUCCESS : Non-zero analysis ID if found
/// FAILURE : 0 if invalid input or no matching analysis found.
/// SUCCESS: Non-zero analysis ID if found
/// FAILURE: 0 if invalid input or no matching analysis found.
///
REAI_API AnalysisId AnalysisIdFromBinaryId (Connection* conn, BinaryId binary_id);

///
/// Start generating function type for a specific function.
///
/// conn[in] : Valid connection object
/// analysis_id[in] : ID of the analysis to generate function type for
/// function_ids[in] : IDs of the functions to generate function type for
///
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool BeginFunctionTypeGeneration (
Connection* conn,
AnalysisId analysis_id,
FunctionIds function_ids
);

///
/// Start generating function type for all functions in an analysis.
///
/// conn[in] : Valid connection object
/// analysis_id[in] : ID of the analysis to generate function type for
///
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool
BeginFunctionTypeGenerationForAllFunctions (Connection* conn, AnalysisId analysis_id);

///
/// Check if function type generation is completed for a specific function.
///
/// conn[in] : Valid connection object
/// function_id[in] : ID of the function to check
///
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool IsFunctionTypeGenerationCompleted (
Connection* conn,
AnalysisId analysis_id,
FunctionId function_id
);

///
/// Check if function type generation is completed for all functions in an analysis.
///
/// conn[in] : Valid connection object
/// analysis_id[in] : ID of the analysis to check
///
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool
IsFunctionTypeGenerationCompletedForAllFunctions (Connection* conn, AnalysisId analysis_id);

///
/// Retrieves function type information for a specific function.
///
/// This function queries the server for detailed data type information
/// including function signatures, dependencies, and variable information.
///
/// conn[in] : Valid connection object
/// function_id[in] : ID of the function to query
///
/// SUCCESS: FunctionType object
/// FAILURE: Empty FunctionType object
///
REAI_API Function
GetFunctionType (Connection* conn, AnalysisId analysis_id, FunctionId function_id);

///
/// Set function type for a specific function.
///
/// conn[in] : Valid connection object
/// analysis_id[in] : ID of the analysis to set function type for
/// function_id[in] : ID of the function to set
/// function_type[in] : Function type to set
///
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool SetFunctionType (
Connection* conn,
AnalysisId analysis_id,
FunctionId function_id,
Function function_type
);

/// Retrieves log data for a specific analysis job.
///
/// This function fetches diagnostic logs generated during
Expand All @@ -381,8 +463,8 @@ extern "C" {
/// conn[in] : Valid connection object
/// analysis_id[in] : ID of the analysis job to query
///
/// SUCCESS : String containing log text
/// FAILURE : Empty string.
/// SUCCESS: String containing log text
/// FAILURE: Empty string.
///
REAI_API Str GetAnalysisLogs (Connection* conn, AnalysisId analysis_id);

Expand All @@ -396,8 +478,8 @@ extern "C" {
/// conn[in] : Connection information including host and API key.
/// file_path[in] : File path of to-be-uploaded file
///
/// SUCCESS : Str object containing SHA-256 Hash of uploaded file.
/// FAILURE : Empty Str object.
/// SUCCESS: Str object containing SHA-256 Hash of uploaded file.
/// FAILURE: Empty Str object.
///
REAI_API Str UploadFile (Connection* conn, Str file_path);

Expand All @@ -412,8 +494,8 @@ extern "C" {
/// of whether this is first query param. If not provided
/// it'll be treated as first query param.
///
/// SUCCESS : Updated `url` string on success.
/// FAILURE : `NULL` otherwise.
/// SUCCESS: Updated `url` string on success.
/// FAILURE: `NULL` otherwise.
///
REAI_API Str* UrlAddQueryStr (Str* url, const char* key, const char* value, bool* is_first);

Expand All @@ -427,8 +509,8 @@ extern "C" {
/// of whether this is first query param. If not provided
/// it'll be treated as first query param.
///
/// SUCCESS : Updated `url` string on success.
/// FAILURE : `NULL` otherwise.
/// SUCCESS: Updated `url` string on success.
/// FAILURE: `NULL` otherwise.
///
REAI_API Str* UrlAddQueryInt (Str* url, const char* key, i64 value, bool* is_first);

Expand All @@ -442,8 +524,8 @@ extern "C" {
/// of whether this is first query param. If not provided
/// it'll be treated as first query param.
///
/// SUCCESS : Updated `url` string on success.
/// FAILURE : `NULL` otherwise.
/// SUCCESS: Updated `url` string on success.
/// FAILURE: `NULL` otherwise.
///
REAI_API Str* UrlAddQueryFloat (Str* url, const char* key, f64 value, bool* is_first);

Expand All @@ -453,9 +535,8 @@ extern "C" {
/// key[in] : Name of query parameter
/// value[in] : Value of query parameter.
///
/// RETURNS:
/// - Updated `url` string on success.
/// - `NULL` otherwise.
/// SUCCESS: Updated `url` string on success.
/// FAILURE: `NULL` otherwise.
///
REAI_API Str* UrlAddQueryBool (Str* url, const char* key, bool value, bool* is_first);

Expand All @@ -470,9 +551,8 @@ extern "C" {
/// response_json[out] : String object to store the response data in JSON format. Can be NULL if response is not required.
/// request_method[in] : The HTTP method to use for the request (e.g., "POST", "GET").
///
/// RETURNS:
/// On success - true
/// On failure - false, with log messages printed to log file or stderr.
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool MakeRequest (
Str* user_agent,
Expand All @@ -496,9 +576,8 @@ extern "C" {
/// request_method[in] : The HTTP method to use for the request (e.g., "POST", "GET").
/// file_path[in] : File to be uploaded.
///
/// RETURNS:
/// On success - true
/// On failure - false, with log messages printed to log file or stderr.
/// SUCCESS: true
/// FAILURE: false
///
REAI_API bool MakeUploadRequest (
Str* user_agent,
Expand Down
1 change: 1 addition & 0 deletions Include/Reai/Api/Types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
#include <Reai/Api/Types/CollectionInfo.h>
#include <Reai/Api/Types/Common.h>
#include <Reai/Api/Types/ControlFlowGraph.h>
#include <Reai/Api/Types/DataType.h>
#include <Reai/Api/Types/Error.h>
#include <Reai/Api/Types/FunctionInfo.h>
#include <Reai/Api/Types/ModelInfo.h>
Expand Down
Loading