workflow module

binaryninja.workflow.Activity([...])	Activity in Binary Ninja represents an individual analysis or action to be performed on a BinaryView or Function object.
binaryninja.workflow.AnalysisContext(handle)	AnalysisContext is a proxy object that provides access to the current analysis context, including the associated BinaryView, Function, and intermediate language (IL) representations.
binaryninja.workflow.Workflow([name, ...])	class Workflow in Binary Ninja defines the set of analyses to perform on a binary,
binaryninja.workflow.WorkflowMachine([handle])
binaryninja.workflow.WorkflowMachineCLI(machine)

class Activity(configuration: str = '', handle: LP_BNActivity | None = None, action: Callable[[Any], None] | None = None, eligibility: Callable[[Any], bool] | None = None)

Bases: object

Activity in Binary Ninja represents an individual analysis or action to be performed on a BinaryView or Function object.

Activities are the fundamental units of execution within a Workflow. Each Activity encapsulates a specific task and defines its own behavior, dependencies, and eligibility criteria. Activities are executed in the context of an AnalysisContext, which provides access to binary data, analysis state, and utility functions.

Parameters:

• configuration (str) –

• handle (LP_BNActivity | None) –

• action (Callable[[Any], None] | None) –

• eligibility (Callable[[Any], bool] | None) –

property name: str

Activity name (read-only)

class AnalysisContext(handle: LP_BNAnalysisContext)

Bases: object

AnalysisContext is a proxy object that provides access to the current analysis context, including the associated BinaryView, Function, and intermediate language (IL) representations. It provides APIs to retrieve and modify the in-progress analysis state and allows users to notify the analysis system of any changes or updates.

Parameters:

handle (LP_BNAnalysisContext) –

inform(request: str) → bool

Parameters:

request (str) –

Return type:

bool

property basic_blocks: BasicBlockList

function.BasicBlockList of BasicBlocks in the current function (writable)

property function: Function

Function for the current AnalysisContext (read-only)

property hlil: HighLevelILFunction

HighLevelILFunction used to represent High Level IL (writable)

property lifted_il: LowLevelILFunction

LowLevelILFunction used to represent lifted IL (writable)

property llil: LowLevelILFunction

LowLevelILFunction used to represent Low Level IL (writable)

property mlil: MediumLevelILFunction

MediumLevelILFunction used to represent Medium Level IL (writable)

property view: BinaryView

BinaryView for the current AnalysisContext (writable)

class Workflow(name: str = '', handle: LP_BNWorkflow | None = None, query_registry: bool = True, object_handle: LP_BNFunction | LP_BNBinaryView | None = None)

Bases: object

class Workflow in Binary Ninja defines the set of analyses to perform on a binary, including their dependencies and execution order.

Workflows are represented as Directed Acyclic Graphs (DAGs), where each node corresponds to an Activity (an individual analysis or action). Workflows are used to tailor the analysis process for BinaryView or Function objects, providing granular control over analysis tasks at module or function levels.

A Workflow starts in an unregistered state, either by creating a new empty Workflow or by cloning an existing one. While unregistered, it is possible to add and remove Activity objects, as well as modify the execution strategy. To apply a Workflow to a binary, it must be registered. Once registered, the Workflow becomes immutable and is available for use.

Example:

# Define the custom activity configuration
configuration = json.dumps({
        "name": "analysis.plugins.xorStringDecoder",
        "title": "XOR String Decoder",
        "description": "This analysis step transforms XOR-encoded strings within the current function.",
        "eligibility": {
                "auto": {
                        "default": False
                }
        }
})

# Clone the meta function workflow for customization
workflow = Workflow("core.function.metaAnalysis").clone()

# Register a new activity
workflow.register_activity(Activity(
        configuration,
        action=lambda analysis_context: log_warn(
                f"Decoder running for function: {hex(analysis_context.function.start)}"
                # Insert decoder logic here :P
        )
))

# Insert the new activity before the "generateHighLevelIL" step
workflow.insert("core.function.generateHighLevelIL", ["analysis.plugins.xorStringDecoder"])

# Register the modified meta function workflow
workflow.register()

Parameters:

• name (str) –

• handle (LP_BNWorkflow) –

• query_registry (bool) –

• object_handle (LP_BNFunction | LP_BNBinaryView) –

activity_roots(activity: Activity | str = '') → List[str]

activity_roots Retrieve the list of activity roots for the Workflow, or if specified just for the given activity.

Parameters:

activity (str) – if specified, return the roots for the activity

Returns:

list of root activity names

Return type:

list[str]

assign_subactivities(activity: Activity, activities: List[str] | str) → bool

assign_subactivities Assign the list of activities as the new set of children for the specified activity.

Parameters:

• activity (str) – the Activity node to assign children

• activities (list[str]) – the list of Activities to assign

Returns:

True on success, False otherwise

Return type:

bool

clear() → bool

clear Remove all Activity nodes from this Workflow.

Returns:

True on success, False otherwise

Return type:

bool

clone(name: str | None = None, activity: Activity | str = '') → Workflow

clone Clone a new Workflow, copying all Activities and the execution strategy.

Parameters:

• name (str) – if specified, name the new Workflow, otherwise the name is copied from the original

• activity (str) – if specified, perform the clone operation using activity as the root

Returns:

a new Workflow

Return type:

Workflow

configuration(activity: Activity | str = '') → str

configuration Retrieve the configuration as an adjacency list in JSON for the Workflow, or if specified just for the given activity.

Parameters:

activity (ActivityType) – if specified, return the configuration for the activity

Returns:

an adjacency list representation of the configuration in JSON

Return type:

str

contains(activity: Activity | str) → bool

contains Determine if an Activity exists in this Workflow.

Parameters:

activity (ActivityType) – the Activity name

Returns:

True if the Activity exists, False otherwise

Return type:

bool

eligibility_settings() → List[str]

eligibility_settings Retrieve the list of eligibility settings for the Workflow.

Returns:

list of eligibility settings

Return type:

list[str]

get_activity(activity: Activity | str) → Activity | None

get_activity Retrieve the Activity object for the specified activity.

Parameters:

activity (str) – the Activity name

Returns:

the Activity object

Return type:

Activity

graph(activity: Activity | str = '', sequential: bool = False, show: bool = True) → FlowGraph | None

graph Generate a FlowGraph object for the current Workflow and optionally show it in the UI.

Parameters:

• activity (str) – if specified, generate the Flowgraph using activity as the root

• sequential (bool) – whether to generate a Composite or Sequential style graph

• show (bool) – whether to show the graph in the UI or not

Returns:

FlowGraph object on success, None on failure

Return type:

FlowGraph

insert(activity: Activity | str, activities: List[str] | str) → bool

insert Insert the list of activities before the specified activity and at the same level.

Parameters:

• activity (str) – the Activity node for which to insert activities before

• activities (list[str]) – the list of Activities to insert

Returns:

True on success, False otherwise

Return type:

bool

insert_after(activity: Activity | str, activities: List[str] | str) → bool

insert_after Insert the list of activities after the specified activity and at the same level.

Parameters:

• activity (str) – the Activity node for which to insert activities after

• activities (list[str]) – the list of Activities to insert

Returns:

True on success, False otherwise

Return type:

bool

register(configuration: str = '') → bool

register Register this Workflow, making it immutable and available for use.

Parameters:

configuration (str) – a JSON representation of the workflow configuration

Returns:

True on Success, False otherwise

Return type:

bool

register_activity(activity: Activity, subactivities: List[Activity | str] = []) → Activity | None

register_activity Register an Activity with this Workflow.

Parameters:

• activity (Activity) – the Activity to register

• subactivities (list[str]) – the list of Activities to assign

Returns:

the registered Activity

Return type:

Activity

remove(activity: Activity | str) → bool

remove Remove the specified activity.

Parameters:

activity (str) – the Activity to remove

Returns:

True on success, False otherwise

Return type:

bool

replace(activity: Activity | str, new_activity: str) → bool

replace Replace the specified activity.

Parameters:

• activity (str) – the Activity to replace

• new_activity (str) – the replacement Activity

Returns:

True on success, False otherwise

Return type:

bool

show_topology() → None

show_topology Show the Workflow topology in the UI.

Return type:

None

subactivities(activity: Activity | str = '', immediate: bool = True) → List[str]

subactivities Retrieve the list of all activities, or optionally a filtered list.

Parameters:

• activity (str) – if specified, return the direct children and optionally the descendants of the activity (includes activity)

• immediate (bool) – whether to include only direct children of activity or all descendants

Returns:

list of activity names

Return type:

list[str]

property machine

property name: str

property registered: bool

registered Whether this Workflow is registered or not. A Workflow becomes immutable once it is registered.

Type:

bool

class WorkflowMachine(handle: LP_BNFunction | LP_BNBinaryView | None = None)

Bases: object

Parameters:

handle (LP_BNFunction | LP_BNBinaryView) –

breakpoint_delete(activities)

breakpoint_query()

breakpoint_set(activities)

cli()

configure(advanced: bool = True, incremental: bool = False)

Parameters:

• advanced (bool) –

• incremental (bool) –

delay(duration)

disable()

dump()

enable()

halt()

log(enable: bool = True, is_global: bool = False)

Parameters:

• enable (bool) –

• is_global (bool) –

metrics(enable: bool = True, is_global: bool = False)

Parameters:

• enable (bool) –

• is_global (bool) –

override_clear(activity)

override_query(activity=None)

override_set(activity, enable)

request(request)

reset()

resume()

run()

show_metrics() → None

Return type:

None

show_topology() → None

Return type:

None

show_trace() → None

Return type:

None

status()

step()

class WorkflowMachineCLI(machine: WorkflowMachine)

Bases: Cmd

Parameters:

machine (WorkflowMachine) –

do_breakpoint(line)

Handle breakpoint commands.

do_configure(line)

Configure the workflow machine.

do_disable(line)

Disable the workflow machine.

do_dump(line)

Dump metrics from the workflow system.

do_enable(line)

Enable the workflow machine.

do_halt(line)

Halt the workflow machine.

do_log(line)

Control workflow logging.

do_metrics(line)

Control workflow metrics collection.

do_override(line)

Handle override commands.

do_quit(line)

Exit the WorkflowMachine CLI.

do_reset(line)

Reset the workflow machine.

do_resume(line)

Continue/Resume execution of a workflow.

do_run(line)

Run the workflow machine and generate a default configuration if the workflow is not configured.

do_status(line)

Retrieve the current machine status.

do_step(line)

Step to the next activity in the workflow machine.

help(arg)

precmd(line)

Hook method executed just before the command line is interpreted, but after the input prompt is generated and issued.

aliases = {'b': 'breakpoint', 'c': 'resume', 'd': 'dump', 'h': 'halt', 'l': 'log', 'm': 'metrics', 'o': 'override', 'q': 'quit', 'r': 'run', 's': 'step'}

intro = "Welcome to the Workflow Orchestrator. Type 'help' to list available commands."

prompt = '(dechora) '