Loading...
Searching...
No Matches
BinaryNinja::WorkflowMachine Class Reference

Classes

struct  Status
 

Public Member Functions

 WorkflowMachine (Ref< BinaryView > view)
 
 WorkflowMachine (Ref< Function > function)
 
bool PostJsonRequest (const std::string &request)
 
Ref< FlowGraphGetGraph (const std::string &activity="", bool sequential=false)
 
void ShowTopology ()
 
WorkflowMachine::Status GetStatus ()
 
bool Resume ()
 Resume the workflow machine.
 
bool Run ()
 Start the workflow Machine Starts the workflow machine for the given BinaryView or Function.
 
bool Configure ()
 Configure the workflow machine.
 
bool Halt ()
 Halt the workflow machine.
 
bool Reset ()
 Reset the workflow machine.
 
bool Enable ()
 Enable the workflow machine.
 
bool Disable ()
 Disable the workflow machine.
 
bool Step ()
 Step the workflow machine.
 
bool SetLogEnabled (bool enable, bool global=false)
 
std::optional< bool > QueryOverride (const std::string &activity)
 
bool SetOverride (const std::string &activity, bool enable)
 
bool ClearOverride (const std::string &activity)
 

Class Documentation

◆ BinaryNinja::WorkflowMachine::Status

struct BinaryNinja::WorkflowMachine::Status
Class Members
string state = "Invalid"
string activity
bool localLogEnabled
bool globalLogEnabled

Constructor & Destructor Documentation

◆ WorkflowMachine() [1/2]

WorkflowMachine::WorkflowMachine ( Ref< BinaryView > view)

◆ WorkflowMachine() [2/2]

WorkflowMachine::WorkflowMachine ( Ref< Function > function)

Member Function Documentation

◆ PostJsonRequest()

bool WorkflowMachine::PostJsonRequest ( const std::string & request)

◆ GetGraph()

Ref< FlowGraph > WorkflowMachine::GetGraph ( const std::string & activity = "",
bool sequential = false )

◆ ShowTopology()

void WorkflowMachine::ShowTopology ( )

◆ GetStatus()

WorkflowMachine::Status WorkflowMachine::GetStatus ( )

◆ Resume()

bool WorkflowMachine::Resume ( )

Resume the workflow machine.

Resumes the workflow machine for the given BinaryView or Function.

Returns
true if the command is accepted, false otherwise.

◆ Run()

bool WorkflowMachine::Run ( )

Start the workflow Machine Starts the workflow machine for the given BinaryView or Function.

Returns
true if the command is accepted, false otherwise.

◆ Configure()

bool WorkflowMachine::Configure ( )

Configure the workflow machine.

Configures the workflow machine.

Returns
true if the command is accepted, false otherwise.

◆ Halt()

bool WorkflowMachine::Halt ( )

Halt the workflow machine.

Halts analysis at a resumable point.

Returns
true if the command is accepted, false otherwise.

◆ Reset()

bool WorkflowMachine::Reset ( )

Reset the workflow machine.

Resets the workflow machine to its initial state.

Returns
true if the command is accepted, false otherwise.

◆ Enable()

bool WorkflowMachine::Enable ( )

Enable the workflow machine.

Re-enables the workflow machine if it is in the Suspend state.

Returns
true if the command is accepted, false otherwise.

◆ Disable()

bool WorkflowMachine::Disable ( )

Disable the workflow machine.

Disables analysis and suspends the workflow machine, equivalent to AbortAnalysis. This operation is recoverable and the workflow machine can be re-enabled via the Enable API.

Returns
true if the command is accepted, false otherwise.

◆ Step()

bool WorkflowMachine::Step ( )

Step the workflow machine.

Steps the workflow machine through a single activity.

Returns
true if the command is accepted, false otherwise.

◆ SetLogEnabled()

bool WorkflowMachine::SetLogEnabled ( bool enable,
bool global = false )

◆ QueryOverride()

std::optional< bool > WorkflowMachine::QueryOverride ( const std::string & activity)

◆ SetOverride()

bool WorkflowMachine::SetOverride ( const std::string & activity,
bool enable )

◆ ClearOverride()

bool WorkflowMachine::ClearOverride ( const std::string & activity)