variable module¶

`binaryninja.variable.AddressRange`(start, end)
`binaryninja.variable.ConstantPointerRegisterValue`(...)
`binaryninja.variable.ConstantReference`(...)
`binaryninja.variable.ConstantRegisterValue`(...)
`binaryninja.variable.CoreVariable`(...)
`binaryninja.variable.EntryRegisterValue`(...)
`binaryninja.variable.ExternalPointerRegisterValue`(...)
`binaryninja.variable.ImportedAddressRegisterValue`(...)
`binaryninja.variable.IndirectBranchInfo`(...)
`binaryninja.variable.LookupTableEntry`(...)
`binaryninja.variable.ParameterVariables`(var_list)	Note This object is a "passive" object. Any changes you make to it will not be reflected in the core and vice-versa. If you wish to update a core version of this object you should use the appropriate API.
`binaryninja.variable.PossibleValueSet`([...])	class PossibleValueSet PossibleValueSet is used to define possible values that a variable can take.
`binaryninja.variable.RegisterValue`(value, ...)
`binaryninja.variable.ReturnAddressRegisterValue`(...)
`binaryninja.variable.StackFrameOffsetRegisterValue`(...)
`binaryninja.variable.StackVariableReference`(...)
`binaryninja.variable.Undetermined`(value, ...)
`binaryninja.variable.ValueRange`(start, end, step)
`binaryninja.variable.Variable`(func, ...)
`binaryninja.variable.VariableNameAndType`(...)

class AddressRange(start: int, end: int)[source]¶

Bases: object

Parameters

start (int) –
end (int) –

Return type

None

end: int¶

start: int¶

class ConstantPointerRegisterValue(value: int, offset: int = 0, type: binaryninja.enums.RegisterValueType = <RegisterValueType.ConstantPointerValue: 3>, confidence: int = 255)[source]¶

Bases: binaryninja.variable.RegisterValue

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –

Return type

None

offset: int = 0¶

type: RegisterValueType = 3¶

class ConstantReference(value: int, size: int, pointer: bool, intermediate: bool)[source]¶

Bases: object

Parameters

value (int) –
size (int) –
pointer (bool) –
intermediate (bool) –

Return type

None

intermediate: bool¶

pointer: bool¶

size: int¶

value: int¶

class ConstantRegisterValue(value: int, offset: int = 0, type: binaryninja.enums.RegisterValueType = <RegisterValueType.ConstantValue: 2>, confidence: int = 255)[source]¶

Bases: binaryninja.variable.RegisterValue

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –

Return type

None

offset: int = 0¶

type: RegisterValueType = 2¶

class CoreVariable(_source_type: int, index: int, storage: int)[source]¶

Bases: object

Parameters

_source_type (int) –
index (int) –
storage (int) –

Return type

None

classmethod from_BNVariable(var: binaryninja._binaryninjacore.BNVariable)[source]¶

Parameters: var (binaryninja._binaryninjacore.BNVariable) –

classmethod from_identifier(identifier)[source]¶

to_BNVariable()[source]¶

property identifier: int¶

index: int¶

property source_type: VariableSourceType¶

storage: int¶

class EntryRegisterValue(value: int = 0, offset: int = 0, type: binaryninja.enums.RegisterValueType = <RegisterValueType.EntryValue: 1>, confidence: int = 255, reg: Union[ForwardRef('binaryninja.architecture.RegisterName'), NoneType] = None)[source]¶

Bases: binaryninja.variable.RegisterValue

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –
reg (Optional[RegisterName]) –

Return type

None

offset: int = 0¶

reg: Optional[RegisterName] = None¶

type: RegisterValueType = 1¶

value: int = 0¶

class ExternalPointerRegisterValue(value: int, offset: int, type: binaryninja.enums.RegisterValueType = <RegisterValueType.ExternalPointerValue: 4>, confidence: int = 255)[source]¶

Bases: binaryninja.variable.RegisterValue

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –

Return type

None

type: RegisterValueType = 4¶

class ImportedAddressRegisterValue(value: int, offset: int = 0, type: binaryninja.enums.RegisterValueType = <RegisterValueType.ImportedAddressValue: 7>, confidence: int = 255)[source]¶

Bases: binaryninja.variable.RegisterValue

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –

Return type

None

offset: int = 0¶

type: RegisterValueType = 7¶

class IndirectBranchInfo(source_arch: 'binaryninja.architecture.Architecture', source_addr: int, dest_arch: 'binaryninja.architecture.Architecture', dest_addr: int, auto_defined: bool)[source]¶

Bases: object

Parameters

source_arch (Architecture) –
source_addr (int) –
dest_arch (Architecture) –
dest_addr (int) –
auto_defined (bool) –

Return type

None

auto_defined: bool¶

dest_addr: int¶

dest_arch: Architecture¶

source_addr: int¶

source_arch: Architecture¶

class LookupTableEntry(from_values: List[int], to_value: int, type: binaryninja.enums.RegisterValueType = <RegisterValueType.LookupTableValue: 10>)[source]¶

Bases: object

Parameters

from_values (List[int]) –
to_value (int) –
type (RegisterValueType) –

Return type

None

from_values: List[int]¶

to_value: int¶

type: RegisterValueType = 10¶

class ParameterVariables(var_list: List[Variable], confidence: int = 255, func: Optional[Function] = None)[source]¶

Bases: object

Note

This object is a “passive” object. Any changes you make to it will not be reflected in the core and vice-versa. If you wish to update a core version of this object you should use the appropriate API.

Parameters

var_list (List[Variable]) –
confidence (int) –
func (Optional[Function]) –

with_confidence(confidence: int) → ParameterVariables[source]¶

Parameters: confidence (int) –
Return type: ParameterVariables

property confidence: int¶

property function: Optional[Function]¶

property vars: List[Variable]¶

class PossibleValueSet(arch=None, value=None)[source]¶

Bases: object

class PossibleValueSet PossibleValueSet is used to define possible values that a variable can take. It contains methods to instantiate different value sets such as Constant, Signed/Unsigned Ranges, etc.

Note

This object is a “passive” object. Any changes you make to it will not be reflected in the core and vice-versa. If you wish to update a core version of this object you should use the appropriate API.

static constant(value: int) → PossibleValueSet[source]¶

Create a constant valued PossibleValueSet object.

Parameters: value (int) – Integer value of the constant
Return type: PossibleValueSet

static constant_ptr(value: int) → PossibleValueSet[source]¶

Create constant pointer valued PossibleValueSet object.

Parameters: value (int) – Integer value of the constant pointer
Return type: PossibleValueSet

static in_set_of_values(values: Union[List[int], Set[int]]) → PossibleValueSet[source]¶

Create a PossibleValueSet object for a value in a set of values.

Parameters: values (list(int)) – List of integer values
Return type: PossibleValueSet

static lookup_table_value(lookup_table, mapping) → PossibleValueSet[source]¶

Create a PossibleValueSet object for a value which is a member of a lookuptable.

Parameters

lookup_table (list(LookupTableEntry)) – List of table entries
mapping (dict of (int, int)) – Mapping used for resolution

Return type

PossibleValueSet

static not_in_set_of_values(values) → PossibleValueSet[source]¶

Create a PossibleValueSet object for a value NOT in a set of values.

Parameters: values (list(int)) – List of integer values
Return type: PossibleValueSet

static signed_range_value(ranges: List[ValueRange]) → PossibleValueSet[source]¶

Create a PossibleValueSet object for a signed range of values.

Parameters

ranges (list(ValueRange)) – List of ValueRanges

Return type

PossibleValueSet

Example

>>> v_1 = ValueRange(-5, -1, 1)
>>> v_2 = ValueRange(7, 10, 1)
>>> val = PossibleValueSet.signed_range_value([v_1, v_2])
<signed ranges: [<range: -0x5 to -0x1>, <range: 0x7 to 0xa>]>

static stack_frame_offset(offset: int) → PossibleValueSet[source]¶

Create a PossibleValueSet object for a stack frame offset.

Parameters: offset (int) – Integer value of the offset
Return type: PossibleValueSet

static undetermined() → PossibleValueSet[source]¶

Create a PossibleValueSet object of type UndeterminedValue.

Returns: PossibleValueSet object of type UndeterminedValue
Return type: PossibleValueSet

static unsigned_range_value(ranges: List[ValueRange]) → PossibleValueSet[source]¶

Create a PossibleValueSet object for a unsigned signed range of values.

Parameters

ranges (list(ValueRange)) – List of ValueRanges

Return type

PossibleValueSet

Example

>>> v_1 = ValueRange(0, 5, 1)
>>> v_2 = ValueRange(7, 10, 1)
>>> val = PossibleValueSet.unsigned_range_value([v_1, v_2])
<unsigned ranges: [<range: 0x0 to 0x5>, <range: 0x7 to 0xa>]>

property count: int¶

property mapping: Mapping[int, int]¶

property offset: int¶

property ranges: List[ValueRange]¶

property reg: RegisterName¶

property table: List[LookupTableEntry]¶

property type: RegisterValueType¶

property value: int¶

property values: Set[int]¶

class RegisterValue(value: int, offset: int, type: binaryninja.enums.RegisterValueType = <RegisterValueType.UndeterminedValue: 0>, confidence: int = 255)[source]¶

Bases: object

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –

Return type

None

classmethod from_BNRegisterValue(reg_value: Union[binaryninja._binaryninjacore.BNRegisterValue, binaryninja._binaryninjacore.BNRegisterValueWithConfidence], arch: Optional[Architecture] = None) → RegisterValue[source]¶

Parameters

reg_value (Union[binaryninja._binaryninjacore.BNRegisterValue, binaryninja._binaryninjacore.BNRegisterValueWithConfidence]) –
arch (Optional[Architecture]) –

Return type

RegisterValue

confidence: int = 255¶

offset: int¶

type: RegisterValueType = 0¶

value: int¶

class ReturnAddressRegisterValue(value: int, offset: int = 0, type: binaryninja.enums.RegisterValueType = <RegisterValueType.ReturnAddressValue: 6>, confidence: int = 255)[source]¶

Bases: binaryninja.variable.RegisterValue

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –

Return type

None

offset: int = 0¶

type: RegisterValueType = 6¶

class StackFrameOffsetRegisterValue(value: int, offset: int = 0, type: binaryninja.enums.RegisterValueType = <RegisterValueType.StackFrameOffset: 5>, confidence: int = 255)[source]¶

Bases: binaryninja.variable.RegisterValue

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –

Return type

None

offset: int = 0¶

type: RegisterValueType = 5¶

class StackVariableReference(_source_operand: Union[int, NoneType], type: 'binaryninja.types.Type', name: str, var: 'Variable', referenced_offset: int, size: int)[source]¶

Bases: object

Parameters

_source_operand (Optional[int]) –
type (Type) –
name (str) –
var (Variable) –
referenced_offset (int) –
size (int) –

Return type

None

name: str¶

referenced_offset: int¶

size: int¶

property source_operand¶

type: Type¶

var: Variable¶

class Undetermined(value: int = 0, offset: int = 0, type: binaryninja.enums.RegisterValueType = <RegisterValueType.UndeterminedValue: 0>, confidence: int = 255)[source]¶

Bases: binaryninja.variable.RegisterValue

Parameters

value (int) –
offset (int) –
type (RegisterValueType) –
confidence (int) –

Return type

None

offset: int = 0¶

type: RegisterValueType = 0¶

value: int = 0¶

class ValueRange(start: int, end: int, step: int)[source]¶

Bases: object

Parameters

start (int) –
end (int) –
step (int) –

Return type

None

end: int¶

start: int¶

step: int¶

class Variable(func: Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction], source_type: VariableSourceType, index: int, storage: int)[source]¶

Bases: binaryninja.variable.CoreVariable

Parameters

func (Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction]) –
source_type (VariableSourceType) –
index (int) –
storage (int) –

classmethod from_BNVariable(func: Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction], var: binaryninja._binaryninjacore.BNVariable)[source]¶

Parameters

func (Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction]) –
var (binaryninja._binaryninjacore.BNVariable) –

classmethod from_core_variable(func: Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction], var: CoreVariable)[source]¶

Parameters

func (Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction]) –
var (CoreVariable) –

classmethod from_identifier(func: Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction], identifier: int)[source]¶

Parameters

func (Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction]) –
identifier (int) –

classmethod from_variable_name_and_type(func: Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction], var: VariableNameAndType)[source]¶

Parameters

func (Union[Function, LowLevelILFunction, MediumLevelILFunction, HighLevelILFunction]) –
var (VariableNameAndType) –

set_name_and_type_async(name: Optional[str], new_type: Type) → None[source]¶

set_name_and_type_async provides a way to asynchronously set both the name and type of a variable. This method should be used when speed is of concern.

Parameters

name (Optional[str]) –
new_type (Type) –

Return type

None

set_name_async(name: Optional[str]) → None[source]¶

set_name_async provides a way to asynchronously set the name of a variable. This method should be used when speed is of concern.

Parameters: name (Optional[str]) –
Return type: None

set_type_async(new_type: Type) → None[source]¶

set_type_async provides a way to asynchronously set the type of a variable. This method should be used when speed is of concern.

Parameters: new_type (Type) –
Return type: None

property core_variable: CoreVariable¶

property dead_store_elimination: DeadStoreElimination¶

property function: Function¶: returns the source Function object which this variable belongs to

index: int¶

property last_seen_name: str¶: Name of the variable, or the name most recently assigned if the variable has since been removed (read-only).

property name: str¶: Name of the variable, Settings thisslow because it ensures that analysis has been updated.

property ssa_versions: Generator[int, None, None]¶: Returns the SSA versions associated with this variable. Doesn’t return anything for aliased variables.

storage: int¶

property type: Optional[Type]¶

property var_name_and_type: VariableNameAndType¶

class VariableNameAndType(_source_type: int, index: int, storage: int, name: str, type: 'binaryninja.types.Type')[source]¶

Bases: binaryninja.variable.CoreVariable

Parameters

_source_type (int) –
index (int) –
storage (int) –
name (str) –
type (Type) –

Return type

None

classmethod from_core_variable(var, name, type)[source]¶

classmethod from_identifier(identifier, name, type)[source]¶

name: str¶

type: Type¶