binaryview module<a class="headerlink" href="#module-binaryninja.binaryview" title="Link to this heading">¶

Example:

>>> bv.get_disassembly(0x100012ef)
'jg      0x100012f5'
>>> bv.always_branch(0x100012ef)
True
>>> bv.get_disassembly(0x100012ef)
'jmp     0x100012f5'
>>>

apply_debug_info(value: DebugInfo) → None[source]¶

Sets the debug info and applies its contents to the current binary view

Parameters:: value (DebugInfo) –
Return type:: None

attach_type_archive(archive: TypeArchive)[source]¶

Attach a given type archive to the analysis and try to connect to it. If attaching was successful, names from that archive will become available to pull, but no types will actually be associated by calling this.

Parameters:: archive (TypeArchive) – New archive

attach_type_archive_by_id(id: str, path: str) → TypeArchive | None[source]¶

Attach a type archive to the owned analysis and try to connect to it. If attaching was successful, names from that archive will become available to pull, but no types will actually be associated by calling this.

The behavior of this function is rather complicated, in an attempt to enable the ability to have attached, but disconnected Type Archives.

Normal operation:

If there was no previously connected Type Archive whose id matches id, and the file at path contains a Type Archive whose id matches id, it will be attached and connected.

Edge-cases:

If there was a previously connected Type Archive whose id matches id, nothing will happen, and it will simply be returned. If the file at path does not exist, nothing will happen and None will be returned. If the file at path exists but does not contain a Type Archive whose id matches id, nothing will happen and None will be returned. If there was a previously attached but disconnected Type Archive whose id matches id, and the file at path contains a Type Archive whose id matches id, the previously attached Type Archive will have its saved path updated to point to path. The Type Archive at path will be connected and returned.

Parameters:

id (str) – Id of Type Archive to attach
path (str) – Path to file of Type Archive to attach

Returns:

Attached archive object, if it could be connected.

Return type:

TypeArchive | None

begin_bulk_add_segments() → None[source]¶

begin_bulk_add_segments Begins a bulk segment addition operation.

This function prepares the BinaryView for bulk addition of both auto and user-defined segments. During the bulk operation, segments can be added using add_auto_segment or similar functions without immediately triggering the MemoryMap update process. The queued segments will not take effect until end_bulk_add_segments is called.

Return type:: None

begin_undo_actions(anonymous_allowed: bool = True) → str[source]¶

begin_undo_actions starts recording actions taken so they can be undone at some point.

Parameters:

anonymous_allowed (bool) – Legacy interop: prevent empty calls to commit_undo_actions` from affecting this undo state. Specifically for undoable_transaction`

Returns:

Id of undo state, for passing to commit_undo_actions` or revert_undo_actions.

Return type:

Example:

>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> state = bv.begin_undo_actions()
>>> bv.convert_to_nop(0x100012f1)
True
>>> bv.commit_undo_actions(state)
>>> bv.get_disassembly(0x100012f1)
'nop'
>>> bv.undo()
>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>>

bulk_modify_symbols()[source]¶: bulk_modify_symbols returns a context manager that improves performance when adding or removing a large number of symbols. Symbols added within the Python with keyword will defer processing until the end of the block. Many symbol getter APIs will return stale results inside the with block, so this function should only be used when symbol queries are not needed at the same time as the modifications.

can_assemble(arch: Architecture | None = None) → bool[source]¶

can_assemble queries the architecture plugin to determine if the architecture can assemble instructions.

Returns:

True if the architecture can assemble, False otherwise

Return type:

Example:

>>> bv.can_assemble()
True
>>>

Parameters:

arch (Architecture | None) –

cancel_bulk_add_segments() → None[source]¶

cancel_bulk_add_segments Cancels a bulk segment addition operation.

This function discards all auto and user segments that were queued since the last call to begin_bulk_add_segments without applying them. It allows you to abandon the changes in case they are no longer needed.

Note: If no bulk operation is in progress, calling this function has no effect.

Return type:: None

check_for_string_annotation_type(addr: int, allow_short_strings: bool = False, allow_large_strings: bool = False, child_width: int = 0) → Tuple[str, StringType] | None[source]¶

Check for string annotation at a given address. This returns the string (and type of the string) as annotated in the UI at a given address. If there’s no annotation, this function returns None.

Parameters:

addr (int) – address at which to check for string annotation
allow_short_strings (bool) – Allow string shorter than the analysis.limits.minStringLength setting
allow_large_strings (bool) – Allow strings longer than the rendering.strings.maxAnnotationLength setting (up to analysis.limits.maxStringLength)
child_width (int) – What width of strings to look for, 1 for ASCII/UTF8, 2 for UTF16, 4 for UTF32, 0 to check for all

Return type:

None

clear_user_global_pointer_value()[source]¶: Clear a previously set user global pointer value, so the auto-analysis can calculate a new value

commit_undo_actions(id: str | None = None) → None[source]¶

commit_undo_actions commits the actions taken since a call to begin_undo_actions Pass as id the value returned by begin_undo_actions. Empty values of id will commit all changes since the last call to begin_undo_actions.

Parameters:

id (Optional[str]) – id of undo state, from begin_undo_actions

Return type:

None

Example:

>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> state = bv.begin_undo_actions()
>>> bv.convert_to_nop(0x100012f1)
True
>>> bv.commit_undo_actions(state)
>>> bv.get_disassembly(0x100012f1)
'nop'
>>> bv.undo()
>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>>

convert_to_nop(addr: int, arch: Architecture | None = None) → bool[source]¶

convert_to_nop converts the instruction at virtual address addr to a nop of the provided architecture.

Note

This API performs a binary patch, analysis may need to be updated afterward. Additionally the binary file must be saved in order to preserve the changes made.

Parameters:

addr (int) – virtual address of the instruction to convert to nops
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

True on success, False on failure.

Return type:

Example:

>>> bv.get_disassembly(0x100012fb)
'call    0x10001629'
>>> bv.convert_to_nop(0x100012fb)
True
>>> #The above 'call' instruction is 5 bytes, a nop in x86 is 1 byte,
>>> # thus 5 nops are used:
>>> bv.get_disassembly(0x100012fb)
'nop'
>>> bv.get_disassembly(0x100012fb + 1)
'nop'
>>> bv.get_disassembly(0x100012fb + 2)
'nop'
>>> bv.get_disassembly(0x100012fb + 3)
'nop'
>>> bv.get_disassembly(0x100012fb + 4)
'nop'
>>> bv.get_disassembly(0x100012fb + 5)
'mov     byte [ebp-0x1c], al'

create_component(name: str | None = None, parent: Component | str | None = None) → Component[source]¶

Create a new component with an optional name and parent.

The parent argument can be either a Component or the Guid of a component to which the created component will be added as a child

Parameters:

name (str | None) – Optional name to create the component with
parent (Component | str | None) – Optional parent to which the component will be added

Returns:

The created component

Return type:

Component

create_database(filename: str, progress_func: Callable[[int, int], bool] | None = None, settings: SaveSettings | None = None) → bool[source]¶

create_database writes the current database (.bndb) out to the specified file.

Warning

This API will only save a database, NOT the original file from a view. To save the original file, use save. To update a database, use save_auto_snapshot

Parameters:

filename (str) – path and filename to write the bndb to, this string should have “.bndb” appended to it.
progress_func (callback) – optional function to be called with the current progress and total count.
settings (SaveSettings) – optional argument for special save options.

Returns:

True on success, False on failure

Return type:

Warning

The calling thread must not hold a lock on the BinaryView instance as this action is run on the main thread which requires the lock.

Example:

>>> settings = SaveSettings()
>>> bv.create_database(f"{bv.file.filename}.bndb", None, settings)
True

Parameters:

filename (str) –
progress_func (Callable[[int, int], bool] | None) –
settings (SaveSettings | None) –

Return type:

create_logger(logger_name: str) → Logger[source]¶

Parameters:: logger_name (str) –
Return type:: Logger

create_structure_from_offset_access(name: QualifiedName) → StructureType[source]¶

Parameters:: name (QualifiedName) –
Return type:: StructureType

create_structure_member_from_access(name: QualifiedName, offset: int) → Type[source]¶

Parameters:

name (QualifiedName) –
offset (int) –

Return type:

Type

create_tag_type(name: str, icon: str) → TagType[source]¶

create_tag_type creates a new TagType and adds it to the view

Parameters:

name (str) – The name for the tag
icon (str) – The icon (recommended 1 emoji or 2 chars) for the tag

Returns:

The created tag type

Return type:

TagType

Example:

>>> bv.create_tag_type("Crabby Functions", "🦀")
>>>

create_user_function(addr: int, plat: Platform | None = None) → Function | None[source]¶

create_user_function add a new user function of the given plat at the virtual address addr

Parameters:

addr (int) – virtual address of the user function to be added
plat (Platform) – Platform for the function to be added

Return type:

None

Example:

>>> bv.create_user_function(1)
>>> bv.functions
[<func: x86_64@0x1>]

define_auto_symbol(sym: CoreSymbol) → None[source]¶

define_auto_symbol adds a symbol to the internal list of automatically discovered Symbol objects in a given namespace.

Warning

If multiple symbols for the same address are defined, the symbol with the highest confidence and lowest SymbolType value will be used. Ties are broken by symbol name.

Parameters:: sym (CoreSymbol) – the symbol to define
Return type:: None

define_auto_symbol_and_var_or_function(sym: CoreSymbol, type: Type | None = None, plat: Platform | None = None, type_confidence: int | None = 0) → CoreSymbol | None[source]¶

define_auto_symbol_and_var_or_function Defines an “Auto” symbol, and a Variable/Function alongside it.

Warning

If multiple symbols for the same address are defined, the symbol with the highest confidence and lowest SymbolType value will be used. Ties are broken by symbol name.

Parameters:

sym (CoreSymbol) – Symbol to define
type (Type | None) – Type for the function/variable being defined (can be None)
plat (Platform | None) – Platform (optional)
type_confidence (int | None) – Optional confidence value for the type

Return type:

Optional[CoreSymbol]

define_data_var(addr: int, var_type: str | Type | TypeBuilder, name: str | CoreSymbol | None = None) → None[source]¶

define_data_var defines a non-user data variable var_type at the virtual address addr.

Parameters:

addr (int) – virtual address to define the given data variable
var_type (StringOrType) – type to be defined at the given virtual address
name (str | CoreSymbol | None) – Optionally additionally define a symbol at this location
name –

Return type:

None

Example:

>>> t = bv.parse_type_string("int foo")
>>> t
(<type: int32_t>, 'foo')
>>> bv.define_data_var(bv.entry_point, t[0])
>>> bv.define_data_var(bv.entry_point + 4, "int", "foo")
>>> bv.get_symbol_at(bv.entry_point + 4)
<DataSymbol: "foo" @ 0x23950>
>>> bv.get_data_var_at(bv.entry_point + 4)
<var 0x23950: int32_t>

define_imported_function(import_addr_sym: CoreSymbol, func: Function, type: Type | None = None) → None[source]¶

define_imported_function defines an imported Function func with a ImportedFunctionSymbol type.

Parameters:

import_addr_sym (CoreSymbol) – A Symbol object with type ImportedFunctionSymbol
func (Function) – A Function object to define as an imported function
type (Type | None) – Optional type for the function

Return type:

None

define_type(type_id: str, default_name: _types.QualifiedNameType | None, type_obj: str | _types.Type | _types.TypeBuilder) → _types.QualifiedName[source]¶

define_type registers a Type type_obj of the given name in the global list of types for the current BinaryView. This method should only be used for automatically generated types.

Parameters:

type_id (str) – Unique identifier for the automatically generated type
default_name (QualifiedName) – Name of the type to be registered
type_obj (StringOrType) – Type object to be registered

Returns:

Registered name of the type. May not be the same as the requested name if the user has renamed types.

Return type:

QualifiedName

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> registered_name = bv.define_type(Type.generate_auto_type_id("source", name), name, type)
>>> bv.get_type_by_name(registered_name)
<type: int32_t>
>>> registered_name = bv.define_type("mytypeid", None, "int bar")
>>> bv.get_type_by_name(registered_name)
<type: int32_t>

define_types(types: Sequence[Tuple[str, _types.QualifiedNameType | None, str | _types.Type | _types.TypeBuilder]], progress_func: Callable[[int, int], bool] | None) → Mapping[str, _types.QualifiedName][source]¶

define_types registers multiple types as though calling define_type multiple times. The difference with this plural version is that it is optimized for adding many types at the same time, using knowledge of all types at add-time to improve runtime. There is an optional progress_func callback function in case you want updates for a long-running call.

Warning

This method should only be used for automatically generated types, see define_user_types for interactive plugin uses.

The return values of this function provide a map of each type id and which name was chosen for that type (which may be different from the requested name).

Parameters:

types (Sequence[Tuple[str, _types.QualifiedNameType | None, str | _types.Type | _types.TypeBuilder]]) – List of type ids/names/definitions for the new types. Check define_type for more details.
progress – Function to call for progress updates
progress_func (Callable[[int, int], bool] | None) –

Returns:

A map of all the chosen names for the defined types with their ids.

Return type:

Mapping[str, _types.QualifiedName]

define_user_data_var defines a user data variable var_type at the virtual address addr.

Parameters:

addr (int) – virtual address to define the given data variable
var_type (binaryninja.Type) – type to be defined at the given virtual address
name (str | CoreSymbol | None) – Optionally, additionally define a symbol at this same address
name –

Return type:

Optional[DataVariable]

Example:

>>> t = bv.parse_type_string("int foo")
>>> t
(<type: int32_t>, 'foo')
>>> bv.define_user_data_var(bv.entry_point, t[0])
<var 0x2394c: int32_t>
>>> bv.define_user_data_var(bv.entry_point + 4, "int", "foo")
<var 0x23950: int32_t>
>>> bv.get_symbol_at(bv.entry_point + 4)
<DataSymbol: "foo" @ 0x23950>
>>> bv.get_data_var_at(bv.entry_point + 4)
<var 0x23950: int32_t>

define_user_symbol(sym: CoreSymbol) → None[source]¶

define_user_symbol adds a symbol to the internal list of user added Symbol objects.

Warning

If multiple symbols for the same address are defined, the symbol with the highest confidence and lowest SymbolType value will be used. Ties are broken by symbol name.

Parameters:: sym (Symbol) – the symbol to define
Return type:: None

define_user_type(name: _types.QualifiedNameType | None, type_obj: str | _types.Type | _types.TypeBuilder) → None[source]¶

define_user_type registers a Type type_obj of the given name in the global list of user types for the current BinaryView.

Parameters:

name (QualifiedName) – Name of the user type to be registered
type_obj (StringOrType) – Type object to be registered

Return type:

None

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> bv.define_user_type(name, type)
>>> bv.get_type_by_name(name)
<type: int32_t>
>>> bv.define_user_type(None, "int bas")
>>> bv.get_type_by_name("bas")
<type: int32_t>

define_user_types(types: Sequence[Tuple[_types.QualifiedNameType | None, str | _types.Type | _types.TypeBuilder]], progress_func: Callable[[int, int], bool] | None)[source]¶

define_user_types registers multiple types as though calling define_user_type multiple times. The difference with this plural version is that it is optimized for adding many types at the same time, using knowledge of all types at add-time to improve runtime. There is an optional progress_func callback function in case you want updates for a long-running call.

Parameters:

types (Sequence[Tuple[_types.QualifiedNameType | None, str | _types.Type | _types.TypeBuilder]]) – List of type names/definitions for the new types. Check define_user_type for more details.
progress – Function to call for progress updates
progress_func (Callable[[int, int], bool] | None) –

detach_type_archive(archive: TypeArchive)[source]¶

Detach from a type archive, breaking all associations to types within the archive

Parameters:: archive (TypeArchive) – Type archive to detach

detach_type_archive_by_id(id: str)[source]¶

Detach from a type archive, breaking all associations to types within the archive

Parameters:: id (str) – Id of archive to detach

static detect_search_mode(pattern: str, raw: bool = False) → str[source]¶

Detects the search mode that would be used by search for the given pattern.

Parameters:

pattern (str) – The search pattern to analyze.
raw (bool) – Whether to interpret the pattern as a raw string (default: False).

Returns:

The detected search mode: "FlexHex", "Regex", or "Raw String".

Return type:

disassembly_text(addr: int, arch: Architecture | None = None) → Generator[Tuple[str, int], None, None][source]¶

disassembly_text helper function for getting disassembly of a given address

Parameters:

addr (int) – virtual address of instruction
arch (Architecture) – optional Architecture, self.arch is used if this parameter is None

Returns:

a str representation of the instruction at virtual address addr or None

Return type:

str or None

Example:

>>> next(bv.disassembly_text(bv.entry_point))
'push    ebp', 1
>>>

disassembly_tokens(addr: int, arch: Architecture | None = None) → Generator[Tuple[List[InstructionTextToken], int], None, None][source]¶

Parameters:

addr (int) –
arch (Architecture | None) –

Return type:

Generator[Tuple[List[InstructionTextToken], int], None, None]

disassociate_type_archive_type(type: _types.QualifiedNameType) → bool[source]¶

Disassociate an associated type, so that it will no longer receive updates from its connected type archive

Parameters:: type (_types.QualifiedNameType) – Name of type in analysis
Returns:: True if successful
Return type:: bool

disassociate_type_archive_type_by_id(type_id: str) → bool[source]¶

Disassociate an associated type id, so that it will no longer receive updates from its connected type archive

Parameters:: type_id (str) – Id of type in analysis
Returns:: True if successful
Return type:: bool

end_bulk_add_segments() → None[source]¶

end_bulk_add_segments Finalizes and applies all queued segments (auto and user) added during a bulk segment addition operation.

This function commits all segments that were queued since the last call to begin_bulk_add_segments. The MemoryMap update process is executed at this point, applying all changes in one batch for improved performance.

Note: This function must be called after begin_bulk_add_segments to apply the queued segments.

Return type:: None

eval(expression: str, here: int = 0) → int[source]¶

Evaluates a string expression to an integer value. This is a more concise alias for the parse_expression API

Parameters:

expression (str) –
here (int) –

Return type:

list(ReferenceSource)

export_object_to_library(lib: TypeLibrary, name: str | None, type_obj: str | Type | TypeBuilder) → None[source]¶

Recursively exports type_obj into lib as an object with a name.

This should be used to store definitions for functions, variables, and other things that are named symbols. For example, MessageBoxA might be the name of a function with the type int ()(HWND, LPCSTR, LPCSTR, UINT). If you just want to store a type definition, you probably want export_type_to_library.

As other referenced types are encountered, they are either copied into the destination type library or else the type library that provided the referenced type is added as a dependency for the destination library.

Parameters:

lib (TypeLibrary) –
name (QualifiedName) –
type_obj (StringOrType) –

Return type:

None

export_type_to_library(lib: TypeLibrary, name: str | None, type_obj: str | Type | TypeBuilder) → None[source]¶

Recursively exports type_obj into lib as a type with a name.

This should be used to store type definitions with no symbol information. For example, color might be a type of enum {RED=0, ORANGE=1, YELLOW=2, …} used by this library. If you have a function, variable, or other object that is exported, you probably want export_object_to_library instead.

As other referenced types are encountered, they are either copied into the destination type library or else the type library that provided the referenced type is added as a dependency for the destination library.

Parameters:

lib (TypeLibrary) –
name (QualifiedName) –
type_obj (StringOrType) –

Return type:

None

static external_namespace() → NameSpace[source]¶

External namespace for the current BinaryView

Return type:: NameSpace

finalize_new_segments() → bool[source]¶

Performs “finalization” on segments added after initial Finalization (performed after an Init() has completed).

Finalizing a segment involves optimizing the relocation info stored in that segment, so if a segment is added and relocations are defined for that segment by some automated process, this function should be called afterwards.

An example of this can be seen in the KernelCache plugin, in KernelCache::LoadImageWithInstallName. After we load an image, map new segments, and define relocations for all of them, we call this function to let core know it is now safe to finalize the new segments

Returns:: Whether finalization was successful
Return type:: bool

find_all_constant(start: int, end: int, constant: int, settings: DisassemblySettings | None = None, graph_type: _function.FunctionViewTypeOrName = FunctionGraphType.NormalFunctionGraph, progress_func: Callable[[int, int], bool] | None = None, match_callback: None = None) → QueueGenerator[source]¶

find_all_constant(start: int, end: int, constant: int, settings: DisassemblySettings | None = None, graph_type: _function.FunctionViewTypeOrName = FunctionGraphType.NormalFunctionGraph, progress_func: Callable[[int, int], bool] | None = None, match_callback: Callable[[int, LinearDisassemblyLine], bool] = None) → bool

find_all_constant searches for the integer constant constant starting at the virtual address start until the virtual address end. Once a match is found, the match_callback is called.

Note

A constant is considered used if a line in the linear view expansion of the given function graph type contains a token with a value that matches that constant. This does not search for raw bytes/data in the binary, for that you want to use find_all_data.

Parameters:

start (int) – virtual address to start searching from.
end (int) – virtual address to end the search.
constant (int) – constant to search for
settings (DisassemblySettings) – DisassemblySettings object used to render the text to be searched
graph_type (FunctionViewType) – the IL to search within
progress_func (callback) – optional function to be called with the current progress and total count. This function should return a boolean value that decides whether the search should continue or stop
match_callback (callback) – function that gets called when a match is found. The callback takes two parameters, i.e., the address of the match, and the LinearDisassemblyLine that contains the matching line. If this parameter is None, this function becomes a generator and yields the matching address and the matching LinearDisassemblyLine. This function can return a boolean value that decides whether the search should continue or stop

Rtype QueueGenerator:

A generator object that will yield all the found results

find_all_data(start: int, end: int, data: bytes, flags: FindFlag = FindFlag.FindCaseSensitive, progress_func: Callable[[int, int], bool] | None = None, match_callback: None = None) → QueueGenerator[source]¶

find_all_data(start: int, end: int, data: bytes, flags: FindFlag = FindFlag.FindCaseSensitive, progress_func: Callable[[int, int], bool] | None = None, match_callback: Callable[[int, DataBuffer], bool] = None) → bool

find_all_data searches for the bytes data starting at the virtual address start until the virtual address end. Once a match is found, the match_callback is called.

Parameters:

start (int) – virtual address to start searching from.
end (int) – virtual address to end the search.
data (Union[bytes, bytearray, str]) – data to search for
flags (FindFlag) –
(optional) defaults to case-insensitive data search

FindFlag

Description

FindCaseSensitive

Case-sensitive search

FindCaseInsensitive

Case-insensitive search
progress_func (callback) – optional function to be called with the current progress and total count. This function should return a boolean value that decides whether the search should continue or stop
match_callback (callback) – function that gets called when a match is found. The callback takes two parameters, i.e., the address of the match, and the actual DataBuffer that satisfies the search. If this parameter is None, this function becomes a generator and yields a tuple of the matching address and the matched DataBuffer. This function can return a boolean value that decides whether the search should continue or stop.

Rtype QueueGenerator:

A generator object that will yield all the found results

find_all_text(start: int, end: int, text: str, settings: DisassemblySettings | None = None, flags=FindFlag.FindCaseSensitive, graph_type: _function.FunctionViewTypeOrName = FunctionGraphType.NormalFunctionGraph, progress_func=None, match_callback: None = None) → QueueGenerator[source]¶

find_all_text(start: int, end: int, text: str, settings: DisassemblySettings | None = None, flags=FindFlag.FindCaseSensitive, graph_type: _function.FunctionViewTypeOrName = FunctionGraphType.NormalFunctionGraph, progress_func=None, match_callback: Callable[[int, str, LinearDisassemblyLine], bool] = None) → bool

find_all_text searches for string text occurring in the linear view output starting at the virtual address start until the virtual address end. Once a match is found, the match_callback is called.

Parameters:

start (int) – virtual address to start searching from.
end (int) – virtual address to end the search.
text (str) – text to search for
settings (DisassemblySettings) – DisassemblySettings object used to render the text to be searched
flags (FindFlag) –
(optional) bit-flags list of options, defaults to case-insensitive data search

FindFlag

Description

FindCaseSensitive

Case-sensitive search

FindCaseInsensitive

Case-insensitive search

FindIgnoreWhitespace

Ignore whitespace characters
graph_type (FunctionViewType) – the IL to search within
progress_func (callback) – optional function to be called with the current progress and total count. This function should return a boolean value that decides whether the search should continue or stop
match_callback (callback) – function that gets called when a match is found. The callback takes three parameters, i.e., the address of the match, and the actual string that satisfies the search, and the LinearDisassemblyLine that contains the matching line. If this parameter is None, this function becomes a generator and yields a tuple of the matching address, the matched string, and the matching LinearDisassemblyLine. This function can return a boolean value that decides whether the search should continue or stop

Rtype QueueGenerator:

A generator object that will yield all the found results

find_next_constant(start: int, constant: int, settings: DisassemblySettings | None = None, graph_type: FunctionViewType | FunctionGraphType | str = FunctionGraphType.NormalFunctionGraph) → int | None[source]¶

find_next_constant searches for integer constant constant occurring in the linear view output starting at the virtual address start until the end of the BinaryView.

Parameters:

start (int) – virtual address to start searching from.
constant (int) – constant to search for
settings (DisassemblySettings) – disassembly settings
graph_type (FunctionViewType) – the IL to search within

Return type:

int | None

find_next_data(start: int, data: bytes, flags: FindFlag = FindFlag.FindCaseSensitive) → int | None[source]¶

find_next_data searches for the bytes data starting at the virtual address start until the end of the BinaryView.

Parameters:

start (int) – virtual address to start searching from.
data (bytes) – data to search for
flags (FindFlag) –
(optional) defaults to case-insensitive data search

FindFlag

Description

FindCaseSensitive

Case-sensitive search

FindCaseInsensitive

Case-insensitive search
data –

Return type:

int | None

find_next_text(start: int, text: str, settings: DisassemblySettings | None = None, flags: int = FindFlag.FindCaseSensitive, graph_type: FunctionViewType | FunctionGraphType | str = FunctionGraphType.NormalFunctionGraph) → int | None[source]¶

find_next_text searches for string text occurring in the linear view output starting at the virtual address start until the end of the BinaryView.

Parameters:

start (int) – virtual address to start searching from.
text (str) – text to search for
settings (DisassemblySettings) – disassembly settings
flags (FindFlag) –
(optional) bit-flags list of options, defaults to case-insensitive data search

FindFlag

Description

FindCaseSensitive

Case-sensitive search

FindCaseInsensitive

Case-insensitive search

FindIgnoreWhitespace

Ignore whitespace characters
graph_type (FunctionViewType) – the IL to search within

Return type:

int | None

forget_undo_actions(id: str | None = None) → None[source]¶

forget_undo_actions removes the actions taken since a call to begin_undo_actions Pass as id the value returned by begin_undo_actions. Empty values of id will remove all changes since the last call to begin_undo_actions.

Parameters:

id (Optional[str]) – id of undo state, from begin_undo_actions

Return type:

None

Example:

>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> state = bv.begin_undo_actions()
>>> bv.convert_to_nop(0x100012f1)
True
>>> bv.forget_undo_actions(state)
>>> bv.get_disassembly(0x100012f1)
'nop'
>>> bv.undo()
>>> bv.get_disassembly(0x100012f1)
'nop'
>>>

get_address_for_data_offset(offset: int) → int | None[source]¶

get_address_for_data_offset returns the virtual address that maps to the specific file offset.

Parameters:: offset (int) – file offset
Returns:: the virtual address of the first segment that contains that file location
Return type:: Int

get_address_input(prompt: str, title: str, current_address: int | None = None) → int | None[source]¶

get_address_input Gets a virtual address via a prompt displayed to the user

Parameters:

prompt (str) – Prompt for the dialog
title (str) – Window title, if used in the UI
current_address (int | None) – Optional current address, for relative inputs

Returns:

The value entered by the user, if one was entered

Return type:

int | None

get_all_fields_referenced(name: _types.QualifiedNameType) → List[int][source]¶

get_all_fields_referenced returns a list of offsets in the QualifiedName specified by name, which are referenced by code.

Parameters:

name (QualifiedName) – name of type to query for references

Returns:

List of offsets

Return type:

list(integer)

Example:

>>> bv.get_all_fields_referenced('A')
[0, 8, 16, 24, 32, 40]
>>>

get_all_sizes_referenced(name: _types.QualifiedNameType) → Mapping[int, List[int]][source]¶

get_all_sizes_referenced returns a map from field offset to a list of sizes of the accesses to it.

Parameters:

name (QualifiedName) – name of type to query for references

Returns:

A map from field offset to the size of the code accesses to it

Return type:

map

Example:

>>> bv.get_all_sizes_referenced('B')
{0: [1, 8], 8: [8], 16: [1, 8]}
>>>

get_all_types_referenced(name: _types.QualifiedNameType) → Mapping[int, List[_types.Type]][source]¶

get_all_types_referenced returns a map from field offset to a list of incoming types written to the specified type.

Parameters:

name (QualifiedName) – name of type to query for references

Returns:

A map from field offset to a list of incoming types written to it

Return type:

map

Example:

>>> bv.get_all_types_referenced('B')
{0: [<type: char, 0% confidence>], 8: [<type: int64_t, 0% confidence>],
16: [<type: char, 0% confidence>, <type: bool>]}
>>>

get_ascii_string_at(addr: int, min_length: int = 4, max_length: int | None = None, require_cstring: bool = True) → StringReference | None[source]¶

get_ascii_string_at returns an ascii string found at addr.

Note

This returns an ascii string irrespective of whether the core analysis identified a string at that location. For an alternative API that uses existing identified strings, use get_string_at.

Parameters:

addr (int) – virtual address to start the string
min_length (int) – minimum length to define a string
max_length (int) – max length string to return
require_cstring (bool) – only return 0x0-terminated strings

Returns:

the string found at addr or None if a string does not exist

Return type:

StringReference or None

Example:

>>> s1 = bv.get_ascii_string_at(0x70d0)
>>> s1
<AsciiString: 0x70d0, len 0xb>
>>> s1.value
'AWAVAUATUSH'
>>> s2 = bv.get_ascii_string_at(0x70d1)
>>> s2
<AsciiString: 0x70d1, len 0xa>
>>> s2.value
'WAVAUATUSH'

get_associated_type_archive_type_source(archive: TypeArchive, archive_type: _types.QualifiedNameType) → _types.QualifiedName | None[source]¶

Determine the local source type name for a given archive type

Parameters:

archive (TypeArchive) – Target type archive
archive_type (_types.QualifiedNameType) – Name of target archive type

Returns:

Name of source analysis type, if this type is associated. None otherwise.

Return type:

_types.QualifiedName | None

get_associated_type_archive_type_source_by_id(archive_id: str, archive_type_id: str) → str | None[source]¶

Determine the local source type id for a given archive type

Parameters:

archive_id (str) – Id of target type archive
archive_type_id (str) – Id of target archive type

Returns:

Id of source analysis type, if this type is associated. None otherwise.

Return type:

str | None

get_associated_type_archive_type_target(name: _types.QualifiedNameType) → Tuple[TypeArchive | None, str] | None[source]¶

Determine the target archive / type id of a given analysis type

Parameters:: name (_types.QualifiedNameType) – Analysis type
Returns:: (archive, archive type id) if the type is associated. None otherwise.
Return type:: Tuple[TypeArchive | None, str] | None

get_associated_type_archive_type_target_by_id(type_id: str) → Tuple[str, str] | None[source]¶

Determine the target archive / type id of a given analysis type

Parameters:: type_id (str) – Analysis type id
Returns:: (archive id, archive type id) if the type is associated. None otherwise.
Return type:: Tuple[str, str] | None

get_associated_types_from_archive(archive: TypeArchive) → Mapping[QualifiedName, str][source]¶

Get a list of all types in the analysis that are associated with a specific type archive

Returns:: Map of all analysis types to their corresponding archive id
Parameters:: archive (TypeArchive) –
Return type:: Mapping[QualifiedName, str]

get_associated_types_from_archive_by_id(archive_id: str) → Mapping[str, str][source]¶

Get a list of all types in the analysis that are associated with a specific type archive :return: Map of all analysis types to their corresponding archive id

Parameters:: archive_id (str) –
Return type:: Mapping[str, str]

get_basic_blocks_at(addr: int) → List[BasicBlock][source]¶

get_basic_blocks_at get a list of BasicBlock objects which exist at the provided virtual address.

Parameters:: addr (int) – virtual address of BasicBlock desired
Returns:: a list of BasicBlock objects
Return type:: list(BasicBlock)

get_basic_blocks_starting_at(addr: int) → List[BasicBlock][source]¶

get_basic_blocks_starting_at get a list of BasicBlock objects which start at the provided virtual address.

Parameters:: addr (int) – virtual address of BasicBlock desired
Returns:: a list of BasicBlock objects
Return type:: list(BasicBlock)

get_callees(addr: int, func: Function | None = None, arch: Architecture | None = None) → List[int][source]¶

get_callees returns a list of virtual addresses called by the call site in the function func, of the architecture arch, and at the address addr. If no function is specified, call sites from all functions and containing the address will be considered. If no architecture is specified, the architecture of the function will be used.

Parameters:

addr (int) – virtual address of the call site to query for callees
func (Architecture) – (optional) the function that the call site belongs to
func – (optional) the architecture of the call site
arch (Architecture | None) –

Returns:

list of integers

Return type:

list(integer)

get_callers(addr: int) → Generator[ReferenceSource, None, None][source]¶

get_callers returns a list of ReferenceSource objects (xrefs or cross-references) that call the provided virtual address. In this case, tail calls, jumps, and ordinary calls are considered.

Parameters:

addr (int) – virtual address of callee to query for callers

Returns:

List of References that call the given virtual address

Return type:

Example:

>>> bv.get_callers(here)
[<ref: x86@0x4165ff>]
>>>

get_code_refs(addr: int, length: int | None = None, max_items: int | None = None) → Generator[ReferenceSource, None, None][source]¶

get_code_refs returns a generator of ReferenceSource objects (xrefs or cross-references) that point to the provided virtual address. This function returns both autoanalysis (“auto”) and user-specified (“user”) xrefs. To add a user-specified reference, see add_user_code_ref.

The related get_data_refs is used to find data references to an address unlike this API which returns references that exist in code.

Note

Note that get_code_refs returns xrefs to code that references the address being queried. get_data_refs on the other hand returns references that exist in data (pointers in global variables for example). The related get_code_refs_from looks for references that are outgoing from the queried address to other locations.

Parameters:

addr (int) – virtual address to query for references
length (int) – optional length of query
max_items (int) – optional maximum number of references to fetch

Returns:

A generator of References for the given virtual address

Return type:

Generator[ReferenceSource, None, None]

Example:

>>> bv.get_code_refs(here)
[<ref: x86@0x4165ff>]
>>>

get_code_refs_for_type(name: str, max_items: int | None = None) → Generator[ReferenceSource, None, None][source]¶

get_code_refs_for_type returns a Generator[ReferenceSource] objects (xrefs or cross-references) that reference the provided QualifiedName.

Parameters:

name (QualifiedName) – name of type to query for references
max_items (int) – optional maximum number of references to fetch

Returns:

List of References for the given type

Return type:

list(ReferenceSource)

Example:

>>> bv.get_code_refs_for_type('A')
[<ref: x86@0x4165ff>]
>>>

get_code_refs_for_type_field(name: str, offset: int, max_items: int | None = None) → Generator[TypeFieldReference, None, None][source]¶

get_code_refs_for_type returns a Generator[TypeFieldReference] objects (xrefs or cross-references) that reference the provided type field.

Parameters:

name (QualifiedName) – name of type to query for references
offset (int) – offset of the field, relative to the type
max_items (int) – optional maximum number of references to fetch

Returns:

Generator of References for the given type

Return type:

Generator[TypeFieldReference]

Example:

>>> bv.get_code_refs_for_type_field('A', 0x8)
[<ref: x86@0x4165ff>]
>>>

get_code_refs_for_type_fields_from(addr: int, func: Function | None = None, arch: Architecture | None = None, length: int | None = None) → List[TypeReferenceSource][source]¶

get_code_refs_for_type_fields_from returns a list of type fields referenced by code in the function func, of the architecture arch, and at the address addr. If no function is specified, references from all functions and containing the address will be returned. If no architecture is specified, the architecture of the function will be used.

Parameters:

addr (int) – virtual address to query for references
length (int) – optional length of query
func (Function | None) –
arch (Architecture | None) –

Returns:

list of references

Return type:

get_code_refs_for_type_from(addr: int, func: Function | None = None, arch: Architecture | None = None, length: int | None = None) → List[TypeReferenceSource][source]¶

get_code_refs_for_type_from returns a list of types referenced by code in the function func, of the architecture arch, and at the address addr. If no function is specified, references from all functions and containing the address will be returned. If no architecture is specified, the architecture of the function will be used.

Parameters:

addr (int) – virtual address to query for references
length (int) – optional length of query
func (Function | None) –
arch (Architecture | None) –

Returns:

list of references

Return type:

get_code_refs_from(addr: int, func: Function | None = None, arch: Architecture | None = None, length: int | None = None) → List[int][source]¶

get_code_refs_from returns a list of virtual addresses referenced by code in the function func, of the architecture arch, and at the address addr. If no function is specified, references from all functions and containing the address will be returned. If no architecture is specified, the architecture of the function will be used. This function returns both autoanalysis (“auto”) and user-specified (“user”) xrefs. To add a user-specified reference, see add_user_code_ref.

Parameters:

addr (int) – virtual address to query for references
length (int) – optional length of query
arch (Architecture) – optional architecture of query
func (Function | None) –

Returns:

list of integers

Return type:

list(integer)

get_comment_at(addr: int) → str[source]¶

get_comment_at returns the address-based comment attached to the given address in this BinaryView Note that address-based comments are different from function-level comments which are specific to each Function. For more information, see address_comments.

Parameters:: addr (int) – virtual address within the current BinaryView to apply the comment to
Return type:: str

get_component(guid: str) → Component | None[source]¶

Lookup a Component by its GUID

Parameters:: guid (str) – GUID of the component to look up
Returns:: The Component with that Guid
Return type:: Component | None

get_component_by_path(path: str) → Component | None[source]¶

Lookup a Component by its pathname

Note:: This is a convenience method, and for performance-sensitive lookups, GetComponentByGuid is very highly recommended.
Parameters:: path (str) –
Return type:: Component | None

Lookups are done based on the .display_name of the Component.

All lookups are absolute from the root component, and are case-sensitive. Pathnames are delimited with “/”

Parameters:

path (str) – Pathname of the desired Component

Returns:

The Component at that pathname

Example:

>>> c = bv.create_component(name="MyComponent")
>>> c2 = bv.create_component(name="MySubComponent", parent=c)
>>> bv.get_component_by_path("/MyComponent/MySubComponent") == c2
True
>>> c3 = bv.create_component(name="MySubComponent", parent=c)
>>> c3
<Component "MySubComponent (1)" "(20712aff...")>
>>> bv.get_component_by_path("/MyComponent/MySubComponent (1)") == c3
True

Return type:

Component | None

get_data_offset_for_address(address: int) → int | None[source]¶

get_data_offset_for_address returns the file offset that maps to the given virtual address, if possible.

If address falls within a bss segment or an external segment, for example, no mapping is possible, and None will be returned.

Parameters:: address (int) – virtual address
Returns:: the file location that is mapped to the given virtual address, or None if no such mapping is possible
Return type:: Int

get_data_refs(addr: int, length: int | None = None, max_items: int | None = None) → Generator[int, None, None][source]¶

get_data_refs returns a list of virtual addresses of _data_ (not code) which references addr, optionally specifying a length. When length is set get_data_refs returns the data which references in the range addr-addr``+``length. This function returns both autoanalysis (“auto”) and user-specified (“user”) xrefs. To add a user-specified reference, see add_user_data_ref.

Warning

If you’re looking at this API, please double check that you don’t mean to use get_code_refs instead. get_code_refs returns references from code to the specified address while this API returns references from data (pointers in global variables for example). Also, note there exists get_data_refs_from.

Parameters:

addr (int) – virtual address to query for references
length (int) – optional length of query
max_items (int | None) –

Returns:

list of integers

Return type:

list(integer)

Example:

>>> bv.get_data_refs(here)
[4203812]
>>>

get_data_refs_for_type(name: str, max_items: int | None = None) → Generator[int, None, None][source]¶

get_data_refs_for_type returns a list of virtual addresses of data which references the type name. Note, the returned addresses are the actual start of the queried type. For example, suppose there is a DataVariable at 0x1000 that has type A, and type A contains type B at offset 0x10. Then get_data_refs_for_type(‘B’) will return 0x1010 for it.

Parameters:

name (QualifiedName) – name of type to query for references
max_items (int) – optional maximum number of references to fetch

Returns:

list of integers

Return type:

list(integer)

Example:

>>> bv.get_data_refs_for_type('A')
[4203812]
>>>

get_data_refs_for_type_field(name: _types.QualifiedNameType, offset: int, max_items: int | None = None) → List[int][source]¶

get_data_refs_for_type_field returns a list of virtual addresses of data which references the type name. Note, the returned addresses are the actual start of the queried type field. For example, suppose there is a DataVariable at 0x1000 that has type A, and type A contains type B at offset 0x10. Then get_data_refs_for_type_field(‘B’, 0x8) will return 0x1018 for it.

Parameters:

name (QualifiedName) – name of type to query for references
offset (int) – offset of the field, relative to the type
max_items (int) – optional maximum number of references to fetch

Returns:

list of integers

Return type:

list(integer)

Example:

>>> bv.get_data_refs_for_type_field('A', 0x8)
[4203812]
>>>

get_data_refs_from(addr: int, length: int | None = None) → Generator[int, None, None][source]¶

get_data_refs_from returns a list of virtual addresses referenced by the address addr. Optionally specifying a length. When length is set get_data_refs_from returns the data referenced in the range addr-addr``+``length. This function returns both autoanalysis (“auto”) and user-specified (“user”) xrefs. To add a user-specified reference, see add_user_data_ref. Also, note there exists get_data_refs.

Parameters:

addr (int) – virtual address to query for references
length (int) – optional length of query

Returns:

list of integers

Return type:

list(integer)

Example:

>>> bv.get_data_refs_from(here)
[4200327]
>>>

get_data_refs_from_for_type_field(name: _types.QualifiedNameType, offset: int, max_items: int | None = None) → List[int][source]¶

get_data_refs_from_for_type_field returns a list of virtual addresses of data which are referenced by the type name.

Only data referenced by structures with the __data_var_refs attribute are included.

Parameters:

name (QualifiedName) – name of type to query for references
offset (int) – offset of the field, relative to the type
max_items (int) – optional maximum number of references to fetch

Returns:

list of integers

Return type:

list(integer)

Example:

>>> bv.get_data_refs_from_for_type_field('A', 0x8)
[4203812]
>>>

get_data_var_at(addr: int) → DataVariable | None[source]¶

get_data_var_at returns the data type at a given virtual address.

Parameters:

addr (int) – virtual address to get the data type from

Returns:

returns the DataVariable at the given virtual address, None on error

Return type:

Example:

>>> t = bv.parse_type_string("int foo")
>>> bv.define_data_var(bv.entry_point, t[0])
>>> bv.get_data_var_at(bv.entry_point)
<var 0x100001174: int32_t>

get_data_variable_parent_components(data_variable: DataVariable) → List[Component][source]¶

Parameters:: data_variable (DataVariable) –
Return type:: List[Component]

get_derived_string_code_refs(str: DerivedString, max_items: int | None = None) → Generator[ReferenceSource, None, None][source]¶

Parameters:

str (DerivedString) –
max_items (int | None) –

Return type:

Generator[ReferenceSource, None, None]

get_disassembly(addr: int, arch: Architecture | None = None) → str | None[source]¶

get_disassembly simple helper function for printing disassembly of a given address

Parameters:

addr (int) – virtual address of instruction
arch (Architecture) – optional Architecture, self.arch is used if this parameter is None

Returns:

a str representation of the instruction at virtual address addr or None

Return type:

str or None

Example:

>>> bv.get_disassembly(bv.entry_point)
'push    ebp'
>>>

Note

This API is very simplistic and only returns text. See disassembly_text and instructions for more capable APIs.

get_entropy(addr: int, length: int, block_size: int = 0) → List[float][source]¶

get_entropy returns the shannon entropy given the start addr, length in bytes, and optionally in block_size chunks.

Parameters:

addr (int) – virtual address
length (int) – total length in bytes
block_size (int) – optional block size

Returns:

list of entropy values for each chunk

Return type:

list(float)

get_expression_parser_magic_value(name: str) → int | None[source]¶

Get the value of an expression parser magic value

If the queried magic value exists, the function returns true and the magic value is returned in value. If the queried magic value does not exist, the function returns None.

Parameters:: name (str) – name for the magic value to query
Returns:
Return type:: int | None

get_external_libraries() → List[ExternalLibrary][source]¶

Get a list of all ExternalLibrary in this BinaryView

Returns:: A list of ExternalLibraries in this BinaryView
Return type:: List[ExternalLibrary]

get_external_library(name: str) → ExternalLibrary | None[source]¶

Get an ExternalLibrary in this BinaryView by name

Parameters:: name (str) – Name of the external library
Returns:: An ExternalLibrary with the given name, or None
Return type:: ExternalLibrary | None

get_external_location(source_symbol: CoreSymbol) → ExternalLocation | None[source]¶

Get the ExternalLocation with the given source symbol in this BinaryView

Parameters:: source_symbol (CoreSymbol) – The source symbol of the ExternalLocation
Returns:: An ExternalLocation with the given source symbol, or None
Return type:: ExternalLocation | None

get_external_locations() → List[ExternalLocation][source]¶

Get a list of ExternalLocations in this BinaryView

Returns:: A list of ExternalLocations in this BinaryView
Return type:: List[ExternalLocation]

get_function_analysis_update_disabled() → bool[source]¶

Returns True when functions are prevented from being marked as updates required, False otherwise. :return:

Return type:: bool

get_function_at(addr: int, plat: Platform | None = None) → Function | None[source]¶

get_function_at gets a Function object for the function that starts at virtual address addr:

Parameters:

addr (int) – starting virtual address of the desired function
plat (Platform) – platform of the desired function

Returns:

returns a Function object or None for the function at the virtual address provided

Return type:

Function

Example:

>>> bv.get_function_at(bv.entry_point)
<func: x86_64@0x100001174>
>>>

get_function_parent_components(function: Function) → List[Component][source]¶

Parameters:: function (Function) –
Return type:: List[Component]

get_functions_at(addr: int) → List[Function][source]¶

get_functions_at get a list of Function objects (one for each valid platform) that start at the given virtual address. Binary Ninja does not limit the number of platforms in a given file thus there may be multiple functions defined from different architectures at the same location. This API allows you to query all of valid platforms.

You may also be interested in get_functions_containing which is useful for requesting all function that contain a given address

Parameters:: addr (int) – virtual address of the desired Function object list.
Returns:: a list of Function objects defined at the provided virtual address
Return type:: list(Function)

get_functions_by_name(name: str, plat: Platform | None = None, ordered_filter: List[SymbolType] | None = None) → List[Function][source]¶

get_functions_by_name returns a list of Function objects function with a Symbol of name.

Parameters:

name (str) – name of the functions
plat (Platform) – (optional) platform
ordered_filter (list(SymbolType)) – (optional) an ordered filter based on SymbolType

Returns:

returns a list of Function objects or an empty list

Return type:

list(Function)

Example:

>>> bv.get_functions_by_name("main")
[<func: x86_64@0x1587>]
>>>

get_functions_containing(addr: int, plat: Platform | None = None) → List[Function][source]¶

get_functions_containing returns a list of Function objects which contain the given address.

Parameters:

addr (int) – virtual address to query.
plat (Platform | None) –

Return type:

list of Function objects

get_incoming_direct_type_references(name: _types.QualifiedNameType) → List[_types.QualifiedName][source]¶

Parameters:: name (_types.QualifiedNameType) –
Return type:: List[_types.QualifiedName]

get_incoming_recursive_type_references(names: _types.QualifiedNameType | List[_types.QualifiedNameType]) → List[_types.QualifiedName][source]¶

Parameters:: names (_types.QualifiedNameType | List[_types.QualifiedNameType]) –
Return type:: List[_types.QualifiedName]

get_instruction_length(addr: int, arch: Architecture | None = None) → int[source]¶

get_instruction_length returns the number of bytes in the instruction of Architecture arch at the virtual address addr

Parameters:

addr (int) – virtual address of the instruction query
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

Number of bytes in instruction

Return type:

Example:

>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> bv.get_instruction_length(0x100012f1)
2L
>>>

get_linear_disassembly(settings: DisassemblySettings | None = None) → Iterator[LinearDisassemblyLine][source]¶

get_linear_disassembly gets an iterator for all lines in the linear disassembly of the view for the given disassembly settings.

Note

linear_disassembly doesn’t just return disassembly; it will return a single line from the linear view, and thus will contain both data views, and disassembly.
Warning: In order to get deterministic output, the WaitForIL DisassemblyOption should be set to True.

Parameters:

settings (DisassemblySettings) – instance specifying the desired output formatting. Defaults to None which will use default settings.

Returns:

An iterator containing formatted disassembly lines.

Return type:

LinearDisassemblyIterator

Example:

>>> settings = DisassemblySettings()
>>> lines = bv.get_linear_disassembly(settings)
>>> for line in lines:
...  print(line)
...  break
...
cf fa ed fe 07 00 00 01  ........

get_linear_disassembly_position_at(addr: int, settings: DisassemblySettings | None = None) → LinearViewCursor[source]¶

get_linear_disassembly_position_at instantiates a LinearViewCursor object for use in get_previous_linear_disassembly_lines or get_next_linear_disassembly_lines.

Parameters:

addr (int) – virtual address of linear disassembly position
settings (DisassemblySettings) – an instantiated DisassemblySettings object, defaults to None which will use default settings

Returns:

An instantiated LinearViewCursor object for the provided virtual address

Return type:

LinearViewCursor

Example:

>>> settings = DisassemblySettings()
>>> pos = bv.get_linear_disassembly_position_at(0x1000149f, settings)
>>> lines = bv.get_previous_linear_disassembly_lines(pos)
>>> lines
[<0x1000149a: pop     esi>, <0x1000149b: pop     ebp>,
<0x1000149c: retn    0xc>, <0x1000149f: >]

get_load_settings(type_name: str) → Settings | None[source]¶

get_load_settings retrieve a Settings object which defines the load settings for the given BinaryViewType type_name

Parameters:: type_name (str) – the BinaryViewType name
Returns:: the load settings
Return type:: Settings, or None

get_load_settings_type_names() → List[str][source]¶

get_load_settings_type_names retrieve a list BinaryViewType names for which load settings exist in this BinaryView context

Returns:: list of BinaryViewType names
Return type:: list(str)

get_metadata(key: str, default: Any = None) → metadata.MetadataValueType | Any[source]¶

get_metadata retrieves a metadata value associated with the given key stored in the current BinaryView.

This method behaves like dict.get():

If the key exists, its metadata value is returned.
If the key does not exist and default is not provided, None is returned.
If the key does not exist and default is provided, default is returned.

Parameters:

key (str) – key to query
default (Any) – value to return if the key does not exist (defaults to None)

Return type:

metadata associated with the key or the default value

Example:

>>> bv.store_metadata("integer", 1337)
>>> bv.get_metadata("integer")
1337L
>>> bv.get_metadata("missing")
None
>>> bv.get_metadata("missing", 42)
42

get_modification(addr: int, length: int | None = None) → List[ModificationStatus][source]¶

get_modification returns the modified bytes of up to length bytes from virtual address addr, or if length is None returns the ModificationStatus.

Parameters:

addr (int) – virtual address to get modification from
length (int) – optional length of modification

Returns:

List of ModificationStatus values for each byte in range

Return type:

List[ModificationStatus]

get_next_basic_block_start_after(addr: int) → int[source]¶

get_next_basic_block_start_after returns the virtual address of the BasicBlock that occurs after the virtual: address addr

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the next BasicBlock

Return type:

Example:

>>> hex(bv.get_next_basic_block_start_after(bv.entry_point))
'0x100014a8L'
>>> hex(bv.get_next_basic_block_start_after(0x100014a8))
'0x100014adL'
>>>

get_next_data_after(addr: int) → int[source]¶

get_next_data_after retrieves the virtual address of the next non-code byte.

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the next data byte which is data, not code

Return type:

Example:

>>> hex(bv.get_next_data_after(0x10000000))
'0x10000001L'

get_next_data_var_after(addr: int) → DataVariable | None[source]¶

get_next_data_var_after retrieves the next DataVariable, or None.

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the next DataVariable

Return type:

Example:

>>> bv.get_next_data_var_after(0x10000000)
<var 0x1000003c: int32_t>
>>>

get_next_data_var_start_after(addr: int) → int[source]¶

get_next_data_var_start_after retrieves the next virtual address of the next DataVariable

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the next DataVariable

Return type:

Example:

>>> hex(bv.get_next_data_var_start_after(0x10000000))
'0x1000003cL'
>>> bv.get_data_var_at(0x1000003c)
<var 0x1000003c: int32_t>
>>>

get_next_function_start_after(addr: int) → int[source]¶

get_next_function_start_after returns the virtual address of the Function that occurs after the virtual address addr

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the next Function

Return type:

List[LinearDisassemblyLine]

Example:

>>> bv.get_next_function_start_after(bv.entry_point)
268441061L
>>> hex(bv.get_next_function_start_after(bv.entry_point))
'0x100015e5L'
>>> hex(bv.get_next_function_start_after(0x100015e5))
'0x10001629L'
>>> hex(bv.get_next_function_start_after(0x10001629))
'0x1000165eL'
>>>

get_next_linear_disassembly_lines(pos: LinearViewCursor) → List[LinearDisassemblyLine][source]¶

get_next_linear_disassembly_lines retrieves a list of LinearDisassemblyLine objects for the next disassembly lines, and updates the LinearViewCursor passed in. This function can be called repeatedly to get more lines of linear disassembly.

Parameters:

pos (LinearViewCursor) – Position to start retrieving linear disassembly lines from

Returns:

a list of LinearDisassemblyLine objects for the next lines.

Example:

>>> settings = DisassemblySettings()
>>> pos = bv.get_linear_disassembly_position_at(0x10001483, settings)
>>> bv.get_next_linear_disassembly_lines(pos)
[<0x10001483: xor     eax, eax  {0x0}>, <0x10001485: inc     eax  {0x1}>, ... , <0x10001488: >]
>>> bv.get_next_linear_disassembly_lines(pos)
[<0x10001488: push    dword [ebp+0x10 {arg_c}]>, ... , <0x1000149a: >]
>>>

Return type:

get_next_valid_offset(addr: int) → int[source]¶

get_next_valid_offset returns the next valid offset in the BinaryView starting from the given virtual address addr.

Parameters:: addr (int) – a virtual address to start checking from.
Returns:: The minimum of the next valid offset in the BinaryView and the end address of the BinaryView
Return type:: int

get_outgoing_direct_type_references(name: _types.QualifiedNameType) → List[_types.QualifiedName][source]¶

Parameters:: name (_types.QualifiedNameType) –
Return type:: List[_types.QualifiedName]

get_outgoing_recursive_type_references(names: _types.QualifiedNameType | List[_types.QualifiedNameType]) → List[_types.QualifiedName][source]¶

Parameters:: names (_types.QualifiedNameType | List[_types.QualifiedNameType]) –
Return type:: List[_types.QualifiedName]

get_previous_basic_block_end_before(addr: int) → int[source]¶

get_previous_basic_block_end_before

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the previous BasicBlock end

Return type:

Example:

>>> hex(bv.entry_point)
'0x1000149fL'
>>> hex(bv.get_next_basic_block_start_after(bv.entry_point))
'0x100014a8L'
>>> hex(bv.get_previous_basic_block_end_before(0x100014a8))
'0x100014a8L'

get_previous_basic_block_start_before(addr: int) → int[source]¶

get_previous_basic_block_start_before returns the virtual address of the BasicBlock that occurs prior to the provided virtual address

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the previous BasicBlock

Return type:

Example:

>>> hex(bv.entry_point)
'0x1000149fL'
>>> hex(bv.get_next_basic_block_start_after(bv.entry_point))
'0x100014a8L'
>>> hex(bv.get_previous_basic_block_start_before(0x100014a8))
'0x1000149fL'
>>>

get_previous_data_before(addr: int) → int[source]¶

get_previous_data_before

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the previous data (non-code) byte

Return type:

Example:

>>> hex(bv.get_previous_data_before(0x1000001))
'0x1000000L'
>>>

get_previous_data_var_before(addr: int) → DataVariable | None[source]¶

get_previous_data_var_before retrieves the previous DataVariable, or None.

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the previous DataVariable

Return type:

Example:

>>> bv.get_previous_data_var_before(0x1000003c)
<var 0x10000000: int16_t>
>>>

get_previous_data_var_start_before(addr: int) → int[source]¶

get_previous_data_var_start_before

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the previous DataVariable

Return type:

Example:

>>> hex(bv.get_previous_data_var_start_before(0x1000003c))
'0x10000000L'
>>> bv.get_data_var_at(0x10000000)
<var 0x10000000: int16_t>
>>>

get_previous_function_start_before(addr: int) → int[source]¶

get_previous_function_start_before returns the virtual address of the Function that occurs prior to the virtual address provided

Parameters:

addr (int) – the virtual address to start looking from.

Returns:

the virtual address of the previous Function

Return type:

List[LinearDisassemblyLine]

Example:

>>> hex(bv.entry_point)
'0x1000149fL'
>>> hex(bv.get_next_function_start_after(bv.entry_point))
'0x100015e5L'
>>> hex(bv.get_previous_function_start_before(0x100015e5))
'0x1000149fL'
>>>

get_previous_linear_disassembly_lines(pos: LinearViewCursor) → List[LinearDisassemblyLine][source]¶

get_previous_linear_disassembly_lines retrieves a list of LinearDisassemblyLine objects for the previous disassembly lines, and updates the LinearViewCursor passed in. This function can be called repeatedly to get more lines of linear disassembly.

Parameters:

pos (LinearViewCursor) – Position to start retrieving linear disassembly lines from

Returns:

a list of LinearDisassemblyLine objects for the previous lines.

Example:

>>> settings = DisassemblySettings()
>>> pos = bv.get_linear_disassembly_position_at(0x1000149a, settings)
>>> bv.get_previous_linear_disassembly_lines(pos)
[<0x10001488: push    dword [ebp+0x10 {arg_c}]>, ... , <0x1000149a: >]
>>> bv.get_previous_linear_disassembly_lines(pos)
[<0x10001483: xor     eax, eax  {0x0}>, ... , <0x10001488: >]

Return type:

get_recent_basic_block_at(addr: int) → BasicBlock | None[source]¶

Parameters:: addr (int) –
Return type:: BasicBlock | None

get_recent_function_at(addr: int) → Function | None[source]¶

Parameters:: addr (int) –
Return type:: Function | None

get_section_by_name(name: str) → Section | None[source]¶

Parameters:: name (str) –
Return type:: Section | None

get_sections_at(addr: int) → List[Section][source]¶

Parameters:: addr (int) –
Return type:: List[Section]

get_segment_at(addr: int) → Segment | None[source]¶

get_segment_at gets the Segment a given virtual address is located in

Parameters:: addr (int) – A virtual address
Returns:: The segment, if it was found
Return type:: Segment | None

get_sizes_referenced(name: _types.QualifiedNameType, offset: int) → List[int][source]¶

get_sizes_referenced returns a list of access sizes to the specified type.

Parameters:

name (QualifiedName) – name of type to query for references
offset (int) – offset of the field

Returns:

a list of sizes of the accesses to it.

Return type:

list

Example:

>>> bv.get_sizes_referenced('B', 16)
[1, 8]
>>>

get_string_at(addr: int, partial: bool = False) → StringReference | None[source]¶

get_string_at returns the string that falls on given virtual address.

Note

This returns discovered strings and is therefore governed by analysis.limits.minStringLength and other settings. For an alternative API that simply returns any potential c-string at a given location, use get_ascii_string_at.

Parameters:

addr (int) – virtual address to get the string from
partial (bool) – whether to return a partial string reference or not

Returns:

returns the StringReference at the given virtual address, otherwise None.

Return type:

StringReference

Example:

>>> bv.get_string_at(0x40302f)
<StringType.AsciiString: 0x403028, len 0x12>

get_strings(start: int | None = None, length: int | None = None) → List[StringReference][source]¶

get_strings returns a list of strings defined in the binary in the optional virtual address range: start-(start+length)

Note that this API will only return strings that have been identified by the string-analysis and thus governed by the minimum and maximum length settings and unrelated to the type system.

Parameters:

start (int) – optional virtual address to start the string list from, defaults to start of the binary
length (int) – optional length range to return strings from, defaults to length of the binary

Returns:

a list of all strings or a list of strings defined between start and start+length

Return type:

list(StringReference)

Example:

>>> bv.get_strings(0x1000004d, 1)
[<AsciiString: 0x1000004d, len 0x2c>]
>>>

get_symbol_at(addr: int, namespace: _types.NameSpaceType = None) → _types.CoreSymbol | None[source]¶

get_symbol_at returns the Symbol at the provided virtual address.

Parameters:

addr (int) – virtual address to query for symbol
namespace (_types.NameSpaceType) – (optional) the namespace of the symbols to retrieve

Returns:

CoreSymbol for the given virtual address

Return type:

CoreSymbol

Example:

>>> bv.get_symbol_at(bv.entry_point)
<FunctionSymbol: "_start" @ 0x100001174>
>>>

get_symbol_by_raw_name(name: str, namespace: _types.NameSpaceType = None) → _types.CoreSymbol | None[source]¶

get_symbol_by_raw_name retrieves a Symbol object for the given raw (mangled) name.

Parameters:

name (str) – raw (mangled) name of Symbol to be retrieved
namespace (_types.NameSpaceType) – (optional) the namespace to search for the given symbol

Returns:

CoreSymbol object corresponding to the provided raw name

Return type:

CoreSymbol

Example:

>>> bv.get_symbol_by_raw_name('?testf@Foobar@@SA?AW4foo@1@W421@@Z')
<FunctionSymbol: "public: static enum Foobar::foo __cdecl Foobar::testf(enum Foobar::foo)" @ 0x10001100>
>>>

get_symbols(start: int | None = None, length: int | None = None, namespace: _types.NameSpaceType = None) → List[_types.CoreSymbol][source]¶

get_symbols retrieves the list of all Symbol objects in the optionally provided range.

Parameters:

start (int | None) – optional start virtual address
length (int | None) – optional length
namespace (_types.NameSpaceType) –

Returns:

list of all Symbol objects, or those Symbol objects in the range of start-start+length

Return type:

list(Symbol)

Example:

>>> bv.get_symbols(0x1000200c, 1)
[<ImportAddressSymbol: "KERNEL32!IsProcessorFeaturePresent" @ 0x1000200c>]
>>>

get_symbols_by_name(name: str, namespace: _types.NameSpaceType = None, ordered_filter: List[SymbolType] | None = None) → List[_types.CoreSymbol][source]¶

get_symbols_by_name retrieves a list of Symbol objects for the given symbol name and ordered filter

Parameters:

name (str) – name of Symbol object to be retrieved
namespace (_types.NameSpaceType) – (optional) the namespace to search for the given symbol
namespace – (optional) the namespace to search for the given symbol
ordered_filter (List[SymbolType] | None) – (optional) an ordered filter based on SymbolType

Returns:

Symbol object corresponding to the provided name

Return type:

Symbol

Example:

>>> bv.get_symbols_by_name('?testf@Foobar@@SA?AW4foo@1@W421@@Z')
[<FunctionSymbol: "public: static enum Foobar::foo __cdecl Foobar::testf(enum Foobar::foo)" @ 0x10001100>]
>>>

get_symbols_by_raw_name(name: str, namespace: _types.NameSpaceType = None) → List[_types.CoreSymbol][source]¶

Parameters:

name (str) –
namespace (_types.NameSpaceType) –

Return type:

List[_types.CoreSymbol]

get_symbols_of_type(sym_type: SymbolType, start: int | None = None, length: int | None = None, namespace: _types.NameSpaceType = None) → List[_types.CoreSymbol][source]¶

get_symbols_of_type retrieves a list of all Symbol objects of the provided symbol type in the optionally: provided range.

Parameters:

sym_type (SymbolType) – A Symbol type: SymbolType
start (int | None) – optional start virtual address
length (int | None) – optional length
namespace (_types.NameSpaceType) –

Returns:

list of all Symbol objects of type sym_type, or those Symbol objects in the range of start-start+length

Return type:

list(CoreSymbol)

Example:

>>> bv.get_symbols_of_type(SymbolType.ImportAddressSymbol, 0x10002028, 1)
[<ImportAddressSymbol: "KERNEL32!GetCurrentThreadId" @ 0x10002028>]
>>>

get_system_call_name(id: int, platform: Platform | None = None) → str | None[source]¶

Parameters:

id (int) –
platform (Platform | None) –

Return type:

str | None

get_system_call_type(id: int, platform: Platform | None = None) → Type | None[source]¶

Parameters:

id (int) –
platform (Platform | None) –

Return type:

Type | None

get_tag_type(name: str) → TagType | None[source]¶

Get a tag type by its name.

Parameters:: name (str) – Name of the tag type
Returns:: The relevant tag type, if it exists
Return type:: TagType

get_tags(auto: bool | None = None) → List[Tuple[int, Tag]][source]¶

tags gets a list of all data Tag objects in the view. Tags are returned as a list of (address, Tag) pairs.

Return type:: list(int, Tag)
Parameters:: auto (bool | None) –

get_tags_at(addr: int, auto: bool | None = None) → List[Tag][source]¶

get_data_tags_at gets a list of Tag objects for a data address.

Parameters:

addr (int) – address to get tags at
auto (bool) – If None, gets all tags, if True, gets auto tags, if False, gets user tags

Returns:

A list of data Tag objects

Return type:

list(Tag)

get_tags_in_range(address_range: AddressRange, auto: bool | None = None) → List[Tuple[int, Tag]][source]¶

get_data_tags_in_range gets a list of all data Tag objects in a given range. Range is inclusive at the start, exclusive at the end.

Parameters:

address_range (AddressRange) – address range from which to get tags
auto (bool) – If None, gets all tags, if True, gets auto tags, if False, gets auto tags

Returns:

A list of (address, data tag) tuples

Return type:

list((int, Tag))

get_type_archive(id: str) → TypeArchive | None[source]¶

Look up a connected archive by its id

Parameters:: id (str) – Id of archive
Returns:: Archive, if one exists with that id. Otherwise None
Return type:: TypeArchive | None

get_type_archive_path(id: str) → str | None[source]¶

Look up the path for an attached (but not necessarily connected) type archive by its id

Parameters:: id (str) – Id of archive
Returns:: Archive path, if it is attached. Otherwise None.
Return type:: str | None

get_type_archives_for_type_name(name: _types.QualifiedNameType) → List[Tuple[TypeArchive, str]][source]¶

Get a list of all connected type archives that have a given type name

Returns:: (archive, archive type id) for all archives
Parameters:: name (_types.QualifiedNameType) –
Return type:: List[Tuple[TypeArchive, str]]

get_type_by_id(id: str) → Type | None[source]¶

get_type_by_id returns the defined type whose unique identifier corresponds with the provided id

Parameters:

id (str) – Unique identifier to lookup

Returns:

A Type or None if the type does not exist

Return type:

Type or None

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> type_id = Type.generate_auto_type_id("source", name)
>>> bv.define_type(type_id, name, type)
>>> bv.get_type_by_id(type_id)
<type: int32_t>
>>>

get_type_by_name(name: _types.QualifiedNameType) → _types.Type | None[source]¶

get_type_by_name returns the defined type whose name corresponds with the provided name

Parameters:

name (QualifiedName) – Type name to lookup

Returns:

A Type or None if the type does not exist

Return type:

Type or None

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> bv.define_user_type(name, type)
>>> bv.get_type_by_name(name)
<type: int32_t>
>>>

get_type_id(name: _types.QualifiedNameType) → str[source]¶

get_type_id returns the unique identifier of the defined type whose name corresponds with the provided name

Parameters:

name (QualifiedName) – Type name to lookup

Returns:

The unique identifier of the type

Return type:

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> type_id = Type.generate_auto_type_id("source", name)
>>> registered_name = bv.define_type(type_id, name, type)
>>> bv.get_type_id(registered_name) == type_id
True
>>>

get_type_library(name: str) → TypeLibrary | None[source]¶

get_type_library returns the TypeLibrary

Parameters:: name (str) – Library name to lookup
Returns:: The Type Library object, if any
Return type:: TypeLibrary or None
Example:

get_type_name_by_id(id: str) → QualifiedName | None[source]¶

get_type_name_by_id returns the defined type name whose unique identifier corresponds with the provided id

Parameters:

id (str) – Unique identifier to lookup

Returns:

A QualifiedName or None if the type does not exist

Return type:

QualifiedName or None

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> type_id = Type.generate_auto_type_id("source", name)
>>> bv.define_type(type_id, name, type)
'foo'
>>> bv.get_type_name_by_id(type_id)
'foo'
>>>

get_type_refs_for_type(name: _types.QualifiedNameType, max_items: int | None = None) → List[_types.TypeReferenceSource][source]¶

get_type_refs_for_type returns a list of TypeReferenceSource objects (xrefs or cross-references) that reference the provided QualifiedName.

Parameters:

name (QualifiedName) – name of type to query for references
max_items (int) – optional maximum number of references to fetch

Returns:

List of references for the given type

Return type:

Example:

>>> bv.get_type_refs_for_type('A')
['<type D, offset 0x8, direct>', '<type C, offset 0x10, indirect>']
>>>

get_type_refs_for_type_field(name: _types.QualifiedNameType, offset: int, max_items: int | None = None) → List[_types.TypeReferenceSource][source]¶

get_type_refs_for_type returns a list of TypeReferenceSource objects (xrefs or cross-references) that reference the provided type field.

Parameters:

name (QualifiedName) – name of type to query for references
offset (int) – offset of the field, relative to the type
max_items (int) – optional maximum number of references to fetch

Returns:

List of references for the given type

Return type:

Example:

>>> bv.get_type_refs_for_type_field('A', 0x8)
['<type D, offset 0x8, direct>', '<type C, offset 0x10, indirect>']
>>>

get_types_referenced(name: QualifiedName, offset: int) → List[Type][source]¶

get_types_referenced returns a list of types related to the type field access.

Parameters:

name (QualifiedName) – name of type to query for references
offset (int) – offset of the field

Returns:

a list of types related to the type field access.

Return type:

list

Example:

>>> bv.get_types_referenced('B', 0x10)
[<type: bool>, <type: char, 0% confidence>]
>>>

get_unique_section_names(name_list: List[str]) → List[str][source]¶

Parameters:: name_list (List[str]) –
Return type:: List[str]

get_view_of_type(name: str) → BinaryView | None[source]¶

get_view_of_type returns the BinaryView associated with the provided name if it exists.

Parameters:: name (str) – Name of the view to be retrieved
Returns:: BinaryView object associated with the provided name or None on failure
Return type:: BinaryView or None

has_initial_analysis() → bool[source]¶

has_initial_analysis check for the presence of an initial analysis in this BinaryView.

Returns:: True if the BinaryView has a valid initial analysis, False otherwise
Return type:: bool

hlil_functions(preload_limit: int | None = None, function_generator: Generator[Function, None, None] | None = None) → Generator[HighLevelILFunction, None, None][source]¶

Generates a list of il functions. This method should be used instead of ‘functions’ property if HLIL is needed and performance is a concern.

Parameters:

preload_limit (int | None) –
function_generator (Generator[Function, None, None] | None) –

Return type:

Generator[HighLevelILFunction, None, None]

import_library_object(name: str, lib: TypeLibrary | None = None) → Tuple[TypeLibrary, Type] | None[source]¶

import_library_object recursively imports an object from the specified type library, or, if no library was explicitly provided, the first type library associated with the current BinaryView that provides the name requested.

This may have the impact of loading other type libraries as dependencies on other type libraries are lazily resolved when references to types provided by them are first encountered.

Note

If you are implementing a custom BinaryView and use this method to import object types, you should then call record_imported_object with the details of where the object is located.

Parameters:

name (QualifiedName) –
lib (TypeLibrary) –

Returns:

the object type, with any interior NamedTypeReferences renamed as necessary to be appropriate for the current view

Return type:

Type

import_library_type(name: str, lib: TypeLibrary | None = None) → Type | None[source]¶

import_library_type recursively imports a type from the specified type library, or, if no library was explicitly provided, the first type library associated with the current BinaryView that provides the name requested.

This may have the impact of loading other type libraries as dependencies on other type libraries are lazily resolved when references to types provided by them are first encountered.

Note that the name actually inserted into the view may not match the name as it exists in the type library in the event of a name conflict. To aid in this, the Type object returned is a NamedTypeReference to the deconflicted name used.

Parameters:

name (QualifiedName) –
lib (TypeLibrary) –

Returns:

a NamedTypeReference to the type, taking into account any renaming performed

Return type:

Type

import_type_by_guid(guid: str | UUID) → Type | None[source]¶

import_type_by_guid recursively imports a type interface given its GUID.

Note

To support this type of lookup a type library must have contain a metadata key called “type_guids” which is a map Dict[string_guid, string_type_name] or Dict[string_guid, Tuple[string_type_name, type_library_name]]

Parameters:: guid (str) – GUID of the COM interface to import
Returns:: the object type, with any interior NamedTypeReferences renamed as necessary to be appropriate for the current view
Return type:: Type

init() → bool[source]¶

Return type:: bool

insert(addr: int, data: bytes) → int[source]¶

insert inserts the bytes in data to the virtual address addr.

Parameters:

addr (int) – virtual address to write to.
data (bytes) – data to be inserted at addr.

Returns:

number of bytes inserted to virtual address addr

Return type:

Example:

>>> bv.insert(0,"BBBB")
4
>>> bv.read(0,8)
'BBBBAAAA'

static internal_namespace() → NameSpace[source]¶

Internal namespace for the current BinaryView

Return type:: NameSpace

invert_branch(addr: int, arch: Architecture | None = None) → bool[source]¶

invert_branch convert the branch instruction of architecture arch at the virtual address addr to the inverse branch.

Note

This API performs a binary patch, analysis may need to be updated afterward. Additionally the binary file must be saved in order to preserve the changes made.

Parameters:

addr (int) – virtual address of the instruction to be modified
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

True on success, False on failure.

Return type:

Example:

>>> bv.get_disassembly(0x1000130e)
'je      0x10001317'
>>> bv.invert_branch(0x1000130e)
True
>>>
>>> bv.get_disassembly(0x1000130e)
'jne     0x10001317'
>>>

is_always_branch_patch_available(addr: int, arch: Architecture | None = None) → bool[source]¶

is_always_branch_patch_available queries the architecture plugin to determine if the instruction at addr can be made to always branch. The actual logic of which is implemented in the perform_is_always_branch_patch_available in the corresponding architecture.

Parameters:

addr (int) – the virtual address of the instruction to be patched
arch (Architecture) – (optional) the architecture for the current view

Returns:

True if the instruction can be patched, False otherwise

Return type:

Example:

>>> bv.get_disassembly(0x100012ed)
'test    eax, eax'
>>> bv.is_always_branch_patch_available(0x100012ed)
False
>>> bv.get_disassembly(0x100012ef)
'jg      0x100012f5'
>>> bv.is_always_branch_patch_available(0x100012ef)
True
>>>

is_invert_branch_patch_available(addr: int, arch: Architecture | None = None) → bool[source]¶

is_invert_branch_patch_available queries the architecture plugin to determine if the instruction at addr is a branch that can be inverted. The actual logic of which is implemented in the perform_is_invert_branch_patch_available in the corresponding architecture.

Parameters:

addr (int) – the virtual address of the instruction to be patched
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

True if the instruction can be patched, False otherwise

Return type:

Example:

>>> bv.get_disassembly(0x100012ed)
'test    eax, eax'
>>> bv.is_invert_branch_patch_available(0x100012ed)
False
>>> bv.get_disassembly(0x100012ef)
'jg      0x100012f5'
>>> bv.is_invert_branch_patch_available(0x100012ef)
True
>>>

is_never_branch_patch_available(addr: int, arch: Architecture | None = None) → bool[source]¶

is_never_branch_patch_available queries the architecture plugin to determine if the instruction at the instruction at addr can be made to never branch. The actual logic of which is implemented in the perform_is_never_branch_patch_available in the corresponding architecture.

Parameters:

addr (int) – the virtual address of the instruction to be patched
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

True if the instruction can be patched, False otherwise

Return type:

Example:

>>> bv.get_disassembly(0x100012ed)
'test    eax, eax'
>>> bv.is_never_branch_patch_available(0x100012ed)
False
>>> bv.get_disassembly(0x100012ef)
'jg      0x100012f5'
>>> bv.is_never_branch_patch_available(0x100012ef)
True
>>>

is_offset_backed_by_file(addr: int) → bool[source]¶

is_offset_backed_by_file checks if a virtual address addr is backed by the original file.

Parameters:: addr (int) – a virtual address to be checked
Returns:: True if the virtual address is backed by original file, False if the not backed by original file or error
Return type:: bool

is_offset_code_semantics(addr: int) → bool[source]¶

is_offset_code_semantics checks if a virtual address addr is semantically valid for code.

Parameters:: addr (int) – a virtual address to be checked
Returns:: True if the virtual address is valid for code semantics, False if the virtual address is invalid or error
Return type:: bool

is_offset_executable(addr: int) → bool[source]¶

is_offset_executable checks if a virtual address addr is valid for executing.

Parameters:: addr (int) – a virtual address to be checked
Returns:: True if the virtual address is valid for executing, False if the virtual address is invalid or error
Return type:: bool

is_offset_extern_semantics(addr: int) → bool[source]¶

is_offset_extern_semantics checks if a virtual address addr is semantically valid for external references.

Parameters:: addr (int) – a virtual address to be checked
Returns:: true if the virtual address is valid for external references, false if the virtual address is invalid or error
Return type:: bool

is_offset_readable(addr: int) → bool[source]¶

is_offset_readable checks if a virtual address addr is valid for reading.

Parameters:: addr (int) – a virtual address to be checked
Returns:: True if the virtual address is valid for reading, False if the virtual address is invalid or error
Return type:: bool

is_offset_readonly_semantics(addr: int) → bool[source]¶

is_offset_readonly_semantics checks if a virtual address addr is semantically read-only. This considers both section semantics and segment permissions to determine if an address should be treated as read-only for analysis purposes.

Parameters:: addr (int) – a virtual address to be checked
Returns:: True if the virtual address is semantically read-only, False otherwise
Return type:: bool

is_offset_writable(addr: int) → bool[source]¶

is_offset_writable checks if a virtual address addr is valid for writing.

Parameters:: addr (int) – a virtual address to be checked
Returns:: True if the virtual address is valid for writing, False if the virtual address is invalid or error
Return type:: bool

is_offset_writable_semantics(addr: int) → bool[source]¶

is_offset_writable_semantics checks if a virtual address addr is semantically writable. Some sections may have writable permissions for linking purposes but can be treated as read-only for the purposes of analysis.

Parameters:: addr (int) – a virtual address to be checked
Returns:: True if the virtual address is valid for writing, False if the virtual address is invalid or error
Return type:: bool

is_skip_and_return_value_patch_available(addr: int, arch: Architecture | None = None) → bool[source]¶

is_skip_and_return_value_patch_available queries the architecture plugin to determine if the instruction at addr is similar to an x86 “call” instruction which can be made to return a value. The actual logic of which is implemented in the perform_is_skip_and_return_value_patch_available in the corresponding architecture.

Parameters:

addr (int) – the virtual address of the instruction to be patched
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

True if the instruction can be patched, False otherwise

Return type:

Example:

>>> bv.get_disassembly(0x100012f6)
'mov     dword [0x10003020], eax'
>>> bv.is_skip_and_return_value_patch_available(0x100012f6)
False
>>> bv.get_disassembly(0x100012fb)
'call    0x10001629'
>>> bv.is_skip_and_return_value_patch_available(0x100012fb)
True
>>>

is_skip_and_return_zero_patch_available(addr: int, arch: Architecture | None = None) → bool[source]¶

is_skip_and_return_zero_patch_available queries the architecture plugin to determine if the instruction at addr is similar to an x86 “call” instruction which can be made to return zero. The actual logic of which is implemented in the perform_is_skip_and_return_zero_patch_available in the corresponding architecture.

Parameters:

addr (int) – the virtual address of the instruction to be patched
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

True if the instruction can be patched, False otherwise

Return type:

Example:

>>> bv.get_disassembly(0x100012f6)
'mov     dword [0x10003020], eax'
>>> bv.is_skip_and_return_zero_patch_available(0x100012f6)
False
>>> bv.get_disassembly(0x100012fb)
'call    0x10001629'
>>> bv.is_skip_and_return_zero_patch_available(0x100012fb)
True
>>>

is_type_auto_defined(name: _types.QualifiedNameType) → bool[source]¶

is_type_auto_defined queries the user type list of name. If name is not in the user type list then the name is considered an auto type.

Parameters:

name (QualifiedName) – Name of type to query

Returns:

True if the type is not a user type. False if the type is a user type.

Example:

>>> bv.is_type_auto_defined("foo")
True
>>> bv.define_user_type("foo", bv.parse_type_string("struct {int x,y;}")[0])
>>> bv.is_type_auto_defined("foo")
False
>>>

Return type:

is_valid_offset(addr: int) → bool[source]¶

is_valid_offset checks if a virtual address addr is valid.

Parameters:: addr (int) – a virtual address to be checked
Returns:: True if the virtual address is valid, False if the virtual address is invalid or error
Return type:: bool

static load(source: str | bytes | bytearray | DataBuffer | PathLike | BinaryView | ProjectFile, update_analysis: bool = True, progress_func: Callable[[int, int], bool] | None = None, options: Mapping[str, Any] = {}) → BinaryView | None[source]¶

load opens, generates default load options (which are overridable), and returns the first available BinaryView. If no BinaryViewType is available, then a Mapped BinaryViewType is used to load the BinaryView with the specified load options. The Mapped view type attempts to auto-detect the architecture of the file during initialization. If no architecture is detected or specified in the load options, then the Mapped view type fails to initialize and returns None.

Note

Container file support enables automatic extraction from container formats such as Universal (Fat) Mach-O archives. The architecture preference for Universal archives can be controlled with the ‘files.universal.architecturePreference’ setting. When set, the first matching architecture is automatically selected for loading. When unset, headless operation defaults to the first available architecture, while interactive operation presents all available architectures for selection. This setting is scoped to SettingsUserScope and can be modified as follows

>>> Settings().set_string_list("files.universal.architecturePreference", ["arm64"])

It’s also possible to specify the architecture preference directly with load

>>> bv = binaryninja.load('/bin/ls', options={'files.universal.architecturePreference': ['arm64']})

Warning

The recommended code pattern for opening a BinaryView is to use the load API as a context manager like with load('/bin/ls') as bv: which will automatically clean up when done with the view. If using this API directly you will need to call bv.file.close() before the BinaryView leaves scope to ensure the reference is properly removed and prevents memory leaks.

Parameters:

source (str | bytes | bytearray | DataBuffer | PathLike | BinaryView | ProjectFile) – path to file/bndb, raw bytes, or raw view to load
update_analysis (bool) – whether or not to run update_analysis_and_wait after opening a BinaryView, defaults to True
progress_func (callback) – optional function to be called with the current progress and total count
options (dict) – a dictionary in the form {setting identifier string : object value}
source –

Returns:

returns a BinaryView object for the given filename or None

Return type:

BinaryView or None

Example:

>>> binaryninja.load('/bin/ls', options={'loader.imageBase': 0xfffffff0000, 'loader.macho.processFunctionStarts' : False})
<BinaryView: '/bin/ls', start 0xfffffff0000, len 0xa290>
>>>

lookup_imported_object_library(addr: int, platform: Platform | None = None) → Tuple[TypeLibrary, QualifiedName] | None[source]¶

lookup_imported_object_library gives you details of which type library and name was used to determine the type of a symbol at a given address

Parameters:

addr (int) – address of symbol at import site
platform (Platform | None) – Platform of symbol at import site

Returns:

A tuple of [TypeLibrary, QualifiedName] with the library and name used, or None if it was not imported

Return type:

Tuple[TypeLibrary, QualifiedName]

lookup_imported_type_library(name: _types.QualifiedNameType) → Tuple[TypeLibrary, _types.QualifiedName] | None[source]¶

lookup_imported_type_library gives you details of from which type library and name a given type in the analysis was imported.

Parameters:: name (_types.QualifiedNameType) – Name of type in analysis
Returns:: A tuple of [TypeLibrary, QualifiedName] with the library and name used, or None if it was not imported
Return type:: Optional[Tuple[TypeLibrary, QualifiedName]]

lookup_imported_type_platform(name: _types.QualifiedNameType) → Tuple[_platform.Platform, _types.QualifiedName] | None[source]¶

lookup_imported_type_platform gives you details of from which platform and name a given type in the analysis was imported.

Parameters:: name (_types.QualifiedNameType) – Name of type in analysis
Returns:: A tuple of [Platform, QualifiedName] with the platform and name used, or None if it was not imported
Return type:: Optional[Tuple[Platform, QualifiedName]]

mlil_functions(preload_limit: int | None = None, function_generator: Generator[Function, None, None] | None = None) → Generator[MediumLevelILFunction, None, None][source]¶

Generates a list of il functions. This method should be used instead of ‘functions’ property if MLIL is needed and performance is a concern.

Parameters:

preload_limit (int | None) –
function_generator (Generator[Function, None, None] | None) –

Return type:

Generator[MediumLevelILFunction, None, None]

navigate(view_name: str, offset: int) → bool[source]¶

navigate navigates the UI to the specified virtual address in the specified View

The View name is created by combining a View type (e.g. “Graph”) with a BinaryView type (e.g. “Mach-O”), separated by a colon, resulting in something like “Graph:Mach-O”.

Parameters:

view_name (str) – view name
offset (int) – address to navigate to

Returns:

whether navigation succeeded

Return type:

Example:

>>> bv.navigate(bv.view, bv.start)
True
>>> bv.file.existing_views
['Mach-O', 'Raw']
>>> import binaryninjaui
>>> [i.getName() for i in binaryninjaui.ViewType.getTypes()]
['Graph', 'Hex', 'Linear', 'Strings', 'Types', 'Triage', 'Bytes']
>>> bv.navigate('Graph:Mach-O', bv.entry_point)
True

never_branch(addr: int, arch: Architecture | None = None) → bool[source]¶

never_branch convert the branch instruction of architecture arch at the virtual address addr to a fall through.

Note

This API performs a binary patch, analysis may need to be updated afterward. Additionally the binary file must be saved in order to preserve the changes made.

Parameters:

addr (int) – virtual address of the instruction to be modified
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

True on success, False on failure.

Return type:

Example:

>>> bv.get_disassembly(0x1000130e)
'jne     0x10001317'
>>> bv.never_branch(0x1000130e)
True
>>> bv.get_disassembly(0x1000130e)
'nop'
>>>

new creates a new, Raw BinaryView for the provided data.

Parameters:

data (Union[str, bytes, bytearray, DataBuffer, os.PathLike, BinaryView]) – path to file/bndb, raw bytes, or raw view to load
file_metadata (FileMetadata) – Optional FileMetadata object for this new view

Returns:

returns a BinaryView object for the given filename or None

Return type:

BinaryView or None

Example:

>>> binaryninja.load('/bin/ls', options={'loader.imageBase': 0xfffffff0000, 'loader.macho.processFunctionStarts' : False})
<BinaryView: '/bin/ls', start 0xfffffff0000, len 0xa290>
>>>

notify_data_inserted(offset: int, length: int) → None[source]¶

Parameters:

offset (int) –
length (int) –

Return type:

None

notify_data_removed(offset: int, length: int) → None[source]¶

Parameters:

offset (int) –
length (int) –

Return type:

None

notify_data_written(offset: int, length: int) → None[source]¶

Parameters:

offset (int) –
length (int) –

Return type:

None

static open(src, file_metadata=None) → BinaryView | None[source]¶

Return type:: BinaryView | None

parse_expression(expression: str, here: int = 0) → int[source]¶

Evaluates a string expression to an integer value.

The parser uses the following rules:

Symbols are defined by the lexer as [A-Za-z0-9_:<>][A-Za-z0-9_:$\-<>]+ or anything enclosed in either single or double quotes

Symbols are everything in bv.symbols, unnamed DataVariables (i.e. data_00005000), unnamed functions (i.e. sub_00005000), or section names (i.e. .text)

Numbers are defaulted to hexadecimal thus _printf + 10 is equivalent to printf + 0x10 If decimal numbers required use the decimal prefix.

Since numbers and symbols can be ambiguous its recommended that you prefix your numbers with the following:

0x - Hexadecimal

0n - Decimal

0 - Octal

In the case of an ambiguous number/symbol (one with no prefix) for instance 12345 we will first attempt to look up the string as a symbol, if a symbol is found its address is used, otherwise we attempt to convert it to a hexadecimal number.

The following operations are valid: +, -, \*, /, %, (), &, \|, ^, ~, ==, !=, >, <, >=, <=

Comparison operators return 1 if the condition is true, 0 otherwise.

In addition to the above operators there are dereference operators similar to BNIL style IL:

[<expression>] - read the current address size at <expression>

[<expression>].b - read the byte at <expression>

[<expression>].w - read the word (2 bytes) at <expression>

[<expression>].d - read the dword (4 bytes) at <expression>

[<expression>].q - read the quadword (8 bytes) at <expression>

The $here (or more succinctly: $) keyword can be used in calculations and is defined as the here parameter, or the currently selected address

The $start/$end keyword represents the address of the first/last bytes in the file respectively

Arbitrary magic values (name-value-pairs) can be added to the expression parser via the add_expression_parser_magic_value API. Notably, the debugger adds all register values into the expression parser so they can be used directly when navigating. The register values can be referenced like $rbp, $x0, etc. For more details, refer to the related debugger docs.

Parameters:

expression (str) – Arithmetic expression to be evaluated
here (int) – (optional) Base address for relative expressions, defaults to zero

Return type:

parse_possiblevalueset(value: str, state: RegisterValueType, here: int = 0) → PossibleValueSet[source]¶

Evaluates a string representation of a PossibleValueSet into an instance of the PossibleValueSet value.

Note

Values are evaluated based on the rules as specified for parse_expression API. This implies that a ConstantValue [0x4000].d can be provided given that 4 bytes can be read at 0x4000. All constants are considered to be in hexadecimal form by default.

The parser uses the following rules:

ConstantValue - <value>
ConstantPointerValue - <value>
StackFrameOffset - <value>
SignedRangeValue - <value>:<value>:<value>{,<value>:<value>:<value>}* (Multiple ValueRanges can be provided by separating them by commas)
UnsignedRangeValue - <value>:<value>:<value>{,<value>:<value>:<value>}* (Multiple ValueRanges can be provided by separating them by commas)
InSetOfValues - <value>{,<value>}*
NotInSetOfValues - <value>{,<value>}*

Parameters:

value (str) – PossibleValueSet value to be parsed
state (RegisterValueType) – State for which the value is to be parsed
here (int) – (optional) Base address for relative expressions, defaults to zero

Return type:

PossibleValueSet

Example:

>>> psv_c = bv.parse_possiblevalueset("400", RegisterValueType.ConstantValue)
>>> psv_c
<const 0x400>
>>> psv_ur = bv.parse_possiblevalueset("1:10:1", RegisterValueType.UnsignedRangeValue)
>>> psv_ur
<unsigned ranges: [<range: 0x1 to 0x10>]>
>>> psv_is = bv.parse_possiblevalueset("1,2,3", RegisterValueType.InSetOfValues)
>>> psv_is
<in set([0x1, 0x2, 0x3])>
>>>

parse_type_string(text: str, import_dependencies: bool = True) → Tuple[Type, QualifiedName][source]¶

parse_type_string parses string containing C into a single type Type. In contrast to the parse_types_from_source or parse_types_from_source_file, parse_type_string can only load a single type, though it can take advantage of existing type information in the binary view, while those two APIs do not.

Parameters:

text (str) – C source code string of type to create
import_dependencies (bool) – If Type Library types should be imported during parsing

Returns:

A tuple of a Type and type name

Return type:

tuple(Type, QualifiedName)

Example:

>>> bv.parse_type_string("int foo")
(<type: int32_t>, 'foo')
>>>

parse_types_from_string(text: str, options: List[str] | None = None, include_dirs: List[str] | None = None, import_dependencies: bool = True) → BasicTypeParserResult[source]¶

parse_types_from_string parses string containing C into a BasicTypeParserResult objects. This API unlike the parse_types_from_source allows the reference of types already defined in the BinaryView.

Parameters:

text (str) – C source code string of types, variables, and function types, to create
options (List[str] | None) – Optional list of string options to be passed into the type parser
include_dirs (List[str] | None) – Optional list of header search directories
import_dependencies (bool) – If Type Library types should be imported during parsing

Returns:

BasicTypeParserResult (a SyntaxError is thrown on parse error)

Return type:

BasicTypeParserResult

Example:

>>> bv.parse_types_from_string('int foo;\nint bar(int x);\nstruct bas{int x,y;};\n')
({types: {'bas': <type: struct bas>}, variables: {'foo': <type: int32_t>}, functions:{'bar':
<type: int32_t(int32_t x)>}}, '')
>>>

abstract perform_get_address_size() → int[source]¶

Return type:: int

perform_get_default_endianness() → Endianness[source]¶

perform_get_default_endianness implements a check which returns the Endianness of the BinaryView

Note

This method may be implemented for custom BinaryViews that are not LittleEndian.

Warning

This method must not be called directly.

Returns:: either Endianness.LittleEndian or Endianness.BigEndian
Return type:: Endianness

perform_get_entry_point() → int[source]¶

perform_get_entry_point implements a query for the initial entry point for code execution.

Note

This method should be implemented for custom BinaryViews that are executable.

Warning

This method must not be called directly.

Returns:: the virtual address of the entry point
Return type:: int

perform_get_length() → int[source]¶

perform_get_length implements a query for the size of the virtual address range used by the BinaryView.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Returns:: returns the size of the virtual address range used by the BinaryView
Return type:: int

perform_get_modification(addr: int) → ModificationStatus[source]¶

perform_get_modification implements query to the whether the virtual address addr is modified.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Parameters:: addr (int) – a virtual address to be checked
Returns:: one of the following: Original = 0, Changed = 1, Inserted = 2
Return type:: ModificationStatus

perform_get_next_valid_offset(addr: int) → int[source]¶

perform_get_next_valid_offset implements a query for the next valid readable, writable, or executable virtual memory address.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Parameters:: addr (int) – a virtual address to start checking from.
Returns:: the next readable, writable, or executable virtual memory address
Return type:: int

perform_get_start() → int[source]¶

perform_get_start implements a query for the first readable, writable, or executable virtual address in the BinaryView.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Returns:: returns the first virtual address in the BinaryView
Return type:: int

perform_insert(addr: int, data: bytes) → int[source]¶

perform_insert implements a mapping between a virtual address and an absolute file offset, inserting the bytes data to rebased address addr.

Note

This method may be overridden by custom BinaryViews. If not overridden, inserting is disallowed

Warning

This method must not be called directly.

Parameters:

addr (int) – a virtual address
data (bytes) – the data to be inserted

Returns:

length of data inserted, should return 0 on error

Return type:

perform_is_executable() → bool[source]¶

perform_is_executable implements a check which returns true if the BinaryView is executable.

Note

This method must be implemented for custom BinaryViews that are executable.

Warning

This method must not be called directly.

Returns:: true if the current BinaryView is executable, false if it is not executable or on error
Return type:: bool

perform_is_offset_executable(addr: int) → bool[source]¶

perform_is_offset_executable implements a check if a virtual address addr is executable.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Parameters:: addr (int) – a virtual address to be checked
Returns:: true if the virtual address is executable, false if the virtual address is not executable or error
Return type:: bool

perform_is_offset_readable(offset: int) → bool[source]¶

perform_is_offset_readable implements a check if a virtual address is readable.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Parameters:: offset (int) – a virtual address to be checked
Returns:: true if the virtual address is readable, false if the virtual address is not readable or error
Return type:: bool

perform_is_offset_writable(addr: int) → bool[source]¶

perform_is_offset_writable implements a check if a virtual address addr is writable.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Parameters:: addr (int) – a virtual address to be checked
Returns:: true if the virtual address is writable, false if the virtual address is not writable or error
Return type:: bool

perform_is_relocatable() → bool[source]¶

perform_is_relocatable implements a check which returns true if the BinaryView is relocatable. Defaults to False

Note

This method may be implemented for custom BinaryViews that are relocatable.

Warning

This method must not be called directly.

Returns:: True if the BinaryView is relocatable, False otherwise
Return type:: boolean

perform_is_valid_offset(addr: int) → bool[source]¶

perform_is_valid_offset implements a check if a virtual address addr is valid.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Parameters:: addr (int) – a virtual address to be checked
Returns:: true if the virtual address is valid, false if the virtual address is invalid or error
Return type:: bool

perform_on_after_snapshot_data_applied() → None[source]¶

Return type:: None

perform_read(addr: int, length: int) → bytes[source]¶

perform_read implements a mapping between a virtual address and an absolute file offset, reading length bytes from the rebased address addr.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Parameters:

addr (int) – a virtual address to attempt to read from
length (int) – the number of bytes to be read

Returns:

length bytes read from addr, should return empty string on error

Return type:

bytes

perform_remove(addr: int, length: int) → int[source]¶

perform_remove implements a mapping between a virtual address and an absolute file offset, removing length bytes from the rebased address addr.

Note

This method may be overridden by custom BinaryViews. If not overridden, removing data is disallowed

Warning

This method must not be called directly.

Parameters:

addr (int) – a virtual address
length (int) – the number of bytes to be removed

Returns:

length of data removed, should return 0 on error

Return type:

perform_save(accessor) → bool[source]¶

Return type:: bool

perform_write(addr: int, data: bytes) → int[source]¶

perform_write implements a mapping between a virtual address and an absolute file offset, writing the bytes data to rebased address addr.

Note

This method may be overridden by custom BinaryViews. Use add_auto_segment to provide data without overriding this method.

Warning

This method must not be called directly.

Parameters:

addr (int) – a virtual address
data (bytes) – the data to be written

Returns:

length of data written, should return 0 on error

Return type:

pull_types_from_archive(archive: TypeArchive, names: List[_types.QualifiedNameType]) → Mapping[_types.QualifiedName, Tuple[_types.QualifiedName, _types.Type]] | None[source]¶

Pull types from a type archive, updating them and any dependencies

Parameters:

archive (TypeArchive) – Target type archive
names (List[_types.QualifiedNameType]) – Names of desired types in type archive

Returns:

{ name: (name, type) } Mapping from archive name to (analysis name, definition), None on error

Return type:

Mapping[_types.QualifiedName, Tuple[_types.QualifiedName, _types.Type]] | None

pull_types_from_archive_by_id(archive_id: str, archive_type_ids: List[str]) → Mapping[str, str] | None[source]¶

Pull types from a type archive by id, updating them and any dependencies

Parameters:

archive_id (str) – Target type archive id
archive_type_ids (List[str]) – Ids of desired types in type archive

Returns:

{ id: id } Mapping from archive type id to analysis type id, None on error

Return type:

Mapping[str, str] | None

push_types_to_archive(archive: TypeArchive, names: List[_types.QualifiedNameType]) → Mapping[_types.QualifiedName, Tuple[_types.QualifiedName, _types.Type]] | None[source]¶

Push a collection of types, and all their dependencies, into a type archive

Parameters:

archive (TypeArchive) – Target type archive
names (List[_types.QualifiedNameType]) – Names of types in analysis

Returns:

{ name: (name, type) } Mapping from analysis name to (archive name, definition), None on error

Return type:

Mapping[_types.QualifiedName, Tuple[_types.QualifiedName, _types.Type]] | None

push_types_to_archive_by_id(archive_id: str, type_ids: List[str]) → Mapping[str, str] | None[source]¶

Push a collection of types, and all their dependencies, into a type archive

Parameters:

archive_id (str) – Id of target type archive
type_ids (List[str]) – Ids of types in analysis

Returns:

True if successful

Return type:

Mapping[str, str] | None

query_metadata(key: str) → metadata.MetadataValueType[source]¶

query_metadata retrieves a metadata associated with the given key stored in the current BinaryView.

Parameters:

key (str) – key to query

Return type:

metadata associated with the key

Example:

>>> bv.store_metadata("integer", 1337)
>>> bv.query_metadata("integer")
1337L
>>> bv.store_metadata("list", [1,2,3])
>>> bv.query_metadata("list")
[1L, 2L, 3L]
>>> bv.store_metadata("string", "my_data")
>>> bv.query_metadata("string")
'my_data'

range_contains_relocation(addr: int, size: int) → bool[source]¶

Checks if the specified range overlaps with a relocation

Parameters:

addr (int) –
size (int) –

Return type:

read(addr: int, length: int) → bytes[source]¶

read returns the data reads at most length bytes from virtual address addr.

Parameters:

addr (int) – virtual address to read from.
length (int) – number of bytes to read.

Returns:

at most length bytes from the virtual address addr, empty string on error or no data

Return type:

bytes

Example:

>>> #Opening a x86_64 Mach-O binary
>>> bv = BinaryView.new("/bin/ls") # note that we are using `new` instead of `load` to get the raw view
>>> bv.read(0,4)
b'\xcf\xfa\xed\xfe'

read_int(address: int, size: int, sign: bool = True, endian: Endianness | None = None) → int[source]¶

Parameters:

address (int) –
size (int) –
sign (bool) –
endian (Endianness | None) –

Return type:

read_pointer(address: int, size: int | None = None) → int[source]¶

Parameters:

address (int) –
size (int | None) –

Return type:

read_uuid(address: int, ms_format: bool = True) → UUID[source]¶

Reads a UUID from the specified address in the binary view.

Parameters:

address (int) – The address to read the UUID from.
ms_format (bool) – Whether to return the UUID in Microsoft format (True) or standard format (False).

Returns:

A UUID object

Raises:

ValueError – If 16 bytes couldn’t be read from the specified address.

Return type:

UUID

reader(address: int | None = None) → BinaryReader[source]¶

Parameters:: address (int | None) –
Return type:: BinaryReader

reanalyze() → None[source]¶

reanalyze causes all functions to be reanalyzed. This function does not wait for the analysis to finish.

Return type:: None

rebase(address: int, force: bool | None = False, progress_func: Callable[[int, int], bool] | None = None) → BinaryView | None[source]¶

rebase rebase the existing BinaryView into a new BinaryView at the specified virtual address

Note

This method does not update corresponding UI components. If the BinaryView is associated with UI components then initiate the rebase operation within the UI, e.g. using the command palette or binaryninjaui.UIContext.activeContext().rebaseCurrentView(). If working with views that are not associated with UI components while the UI is active, then set force to True to enable rebasing.

Parameters:

address (int) – virtual address of the start of the BinaryView
force (bool) – enable rebasing while the UI is active
progress_func (Callable[[int, int], bool] | None) –

Returns:

the new BinaryView object or None on failure

Return type:

BinaryView or None

Example:

>>> from binaryninja import load
>>> bv = load('/bin/ls')
>>> print(bv)
<BinaryView: '/bin/ls', start 0x100000000, len 0x182f8>
>>> newbv = bv.rebase(0x400000)
>>> print(newbv)
<BinaryView: '/bin/ls', start 0x400000, len 0x182f8>
>>>
>>> # For rebasing the current view in the UI:
>>> import binaryninjaui
>>> execute_on_main_thread_and_wait(lambda: binaryninjaui.UIContext.activeContext().rebaseCurrentView(0x800000))

record_imported_object_library(lib: TypeLibrary, name: str, addr: int, platform: Platform | None = None) → None[source]¶

record_imported_object_library should be called by custom py:py:class:BinaryView implementations when they have successfully imported an object from a type library (e.g. a symbol’s type). Values recorded with this function will then be queryable via lookup_imported_object_library.

Parameters:

lib (TypeLibrary) – Type Library containing the imported type
name (str) – Name of the object in the type library
addr (int) – address of symbol at import site
platform (Platform | None) – Platform of symbol at import site

Return type:

None

redo() → None[source]¶

redo redo the last committed transaction in the undo database.

Return type:

None

Example:

>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> with bv.undoable_transaction():
>>>     bv.convert_to_nop(0x100012f1)
True
>>> bv.get_disassembly(0x100012f1)
'nop'
>>> bv.undo()
>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> bv.redo()
>>> bv.get_disassembly(0x100012f1)
'nop'
>>>

classmethod register() → None[source]¶

Return type:: None

register_notification(notify: BinaryDataNotification) → None[source]¶

register_notification enables the receipt of callbacks for various analysis events. A full list of callbacks is available in the BinaryDataNotification class. If the notification_barrier is enabled, then it is triggered upon the initial call to register_notification. Subsequent calls for an already registered notify instance also trigger a notification_barrier callback.

Parameters:: notify (BinaryDataNotification) – notify is a subclassed instance of BinaryDataNotification.
Return type:: None

register_platform_types(platform: Platform) → None[source]¶

register_platform_types ensures that the platform-specific types for a Platform are available for the current BinaryView. This is automatically performed when adding a new function or setting the default platform.

Parameters:

platform (Platform) – Platform containing types to be registered

Return type:

None

Example:

>>> platform = Platform["linux-x86"]
>>> bv.register_platform_types(platform)
>>>

relocation_ranges_at(addr: int) → List[Tuple[int, int]][source]¶

List of relocation range tuples for a given address

Parameters:: addr (int) –
Return type:: List[Tuple[int, int]]

relocation_ranges_in_range(addr: int, size: int) → List[Tuple[int, int]][source]¶

List of relocation range tuples for a given range

Parameters:

addr (int) –
size (int) –

Return type:

List[Tuple[int, int]]

relocations_at(addr: int) → List[Relocation][source]¶

List of relocations for a given address

Parameters:: addr (int) –
Return type:: List[Relocation]

remove(addr: int, length: int) → int[source]¶

remove removes at most length bytes from virtual address addr.

Parameters:

addr (int) – virtual address to remove from.
length (int) – number of bytes to remove.

Returns:

number of bytes removed from virtual address addr

Return type:

Example:

>>> bv.read(0,8)
'BBBBAAAA'
>>> bv.remove(0,4)
4
>>> bv.read(0,4)
'AAAA'

remove_auto_data_tag(addr: int, tag: Tag)[source]¶

remove_auto_data_tag removes a Tag object at a data address.

Parameters:

addr (int) – address at which to remove the tag
tag (Tag) – Tag object to be removed

Return type:

None

remove_auto_data_tags_of_type(addr: int, tag_type: str)[source]¶

remove_auto_data_tags_of_type removes all data tags at the given address of the given type.

Parameters:

addr (int) – address at which to add the tags
tag_type (str) – Tag type name to match for removing

Return type:

None

remove_auto_section(name: str) → None[source]¶

Parameters:: name (str) –
Return type:: None

remove_auto_segment(start: int, length: int = 0) → None[source]¶

remove_auto_segment Removes an automatically generated segment from the current segment mapping. This method removes the most recently added ‘auto’ segment that either matches the specified start address or contains it.

Parameters:

start (int) – virtual address of the start of the segment
length (int) – length of the segment (unused)

Return type:

None

Warning

This action is not persistent across saving of a BNDB and must be re-applied each time a BNDB is loaded.

remove_component(_component: Component | str) → bool[source]¶

Remove a component from the tree entirely.

Parameters:: _component (Component | str) – Component to remove
Returns:: Whether the removal was successful
Return type:: bool

remove_data_ref(from_addr: int, to_addr: int) → None[source]¶

remove_data_ref removes an auto data cross-reference (xref) from the address from_addr to the address to_addr. This function will only remove ones generated during autoanalysis. If the reference does not exist, no action is performed.

Parameters:

from_addr (int) – the reference’s source virtual address.
to_addr (int) – the reference’s destination virtual address.

Return type:

None

Note

It is intended to be used from within workflows or other reoccurring analysis tasks. Removed references will be re-created whenever auto analysis is re-run for the

remove_expression_parser_magic_value(name: str) → None[source]¶

Remove a magic value from the expression parser.

If the magic value gets referenced after removal, an error will occur during the parsing.

Parameters:: name (str) – name for the magic value to remove
Returns:
Return type:: None

remove_expression_parser_magic_values(names: List[str]) → None[source]¶

Remove a list of magic value from the expression parser

If any of the magic values gets referenced after removal, an error will occur during the parsing.

Parameters:: names (list(str)) – names for the magic value to remove
Returns:
Return type:: None

remove_external_library(name: str)[source]¶

Remove an ExternalLibrary from this BinaryView by name. Any associated ExternalLocations will be unassociated from the ExternalLibrary

Parameters:: name (str) – Name of the external library to remove

remove_external_location(source_symbol: CoreSymbol)[source]¶

Remove the ExternalLocation with the given source symbol from this BinaryView

Parameters:: source_symbol (CoreSymbol) – Source symbol that will be used to determine the ExternalLocation to remove

remove_function(func: Function, update_refs=False) → None[source]¶

remove_function removes the function func from the list of functions

Warning

This method should only be used when the function that is removed is expected to re-appear after any other analysis executes that could re-add it. Most users will want to use remove_user_function in their scripts.

Parameters:

func (Function) – a Function object.
update_refs (bool) – automatically update other functions that were referenced

Return type:

None

Example:

>>> bv.functions
[<func: x86_64@0x1>]
>>> bv.remove_function(next(bv.functions))
>>> bv.functions
[]

remove_metadata(key: str) → None[source]¶

remove_metadata removes the metadata associated with key from the current BinaryView.

Parameters:

key (str) – key associated with metadata to remove from the BinaryView

Return type:

None

Example:

>>> bv.store_metadata("integer", 1337)
>>> bv.remove_metadata("integer")

remove_tag_type(tag_type: str)[source]¶

remove_tag_type removes a TagType and all tags that use it

Parameters:: tag_type (str) – The name of the tag type to remove
Return type:: None

remove_user_data_ref(from_addr: int, to_addr: int) → None[source]¶

remove_user_data_ref removes a user-specified data cross-reference (xref) from the address from_addr to the address to_addr. This function will only remove user-specified references, not ones generated during autoanalysis. If the reference does not exist, no action is performed.

Parameters:

from_addr (int) – the reference’s source virtual address.
to_addr (int) – the reference’s destination virtual address.

Return type:

None

remove_user_data_tag(addr: int, tag: Tag)[source]¶

remove_user_data_tag removes a Tag object at a data address. Since this removes a user tag, it will be added to the current undo buffer.

Parameters:

addr (int) – address at which to remove the tag
tag (Tag) – Tag object to be removed

Return type:

None

remove_user_data_tags_of_type(addr: int, tag_type: str)[source]¶

remove_user_data_tags_of_type removes all data tags at the given address of the given type. Since this removes user tags, it will be added to the current undo buffer.

Parameters:

addr (int) – address at which to add the tags
tag_type (str) – Tag type name to match for removing

Return type:

None

remove_user_function(func: Function) → None[source]¶

remove_user_function removes the function func from the list of functions as a user action.

Note

This API will prevent the function from being re-created if any analysis later triggers that would re-add it, unlike remove_function.

Parameters:

func (Function) – a Function object.

Return type:

None

Example:

>>> bv.functions
[<func: x86_64@0x1>]
>>> bv.remove_user_function(next(bv.functions))
>>> bv.functions
[]

remove_user_section(name: str) → None[source]¶

Parameters:: name (str) –
Return type:: None

remove_user_segment(start: int, length: int = 0) → None[source]¶

remove_user_segment Removes a user-defined segment from the current segment mapping. This method removes the most recently added ‘user’ segment that either matches the specified start address or contains it.

Parameters:

start (int) – virtual address of the start of the segment
length (int) – length of the segment (unused)

Return type:

None

rename_type(old_name: _types.QualifiedNameType, new_name: _types.QualifiedNameType) → None[source]¶

rename_type renames a type in the global list of types for the current BinaryView

Parameters:

old_name (QualifiedName) – Existing name of type to be renamed
new_name (QualifiedName) – New name of type to be renamed

Return type:

None

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> bv.define_user_type(name, type)
>>> bv.get_type_by_name("foo")
<type: int32_t>
>>> bv.rename_type("foo", "bar")
>>> bv.get_type_by_name("bar")
<type: int32_t>
>>>

revert_undo_actions(id: str | None = None) → None[source]¶

revert_undo_actions reverts the actions taken since a call to begin_undo_actions Pass as id the value returned by begin_undo_actions. Empty values of id will revert all changes since the last call to begin_undo_actions.

Parameters:

id (Optional[str]) – id of undo state, from begin_undo_actions

Return type:

None

Example:

>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> state = bv.begin_undo_actions()
>>> bv.convert_to_nop(0x100012f1)
True
>>> bv.revert_undo_actions(state)
>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>>

save(dest: FileAccessor | str) → bool[source]¶

save saves the original binary file to the provided destination dest along with any modifications.

Warning

This API will only save the original file from a view. To save a database, use create_database.

Parameters:: dest (str) – destination path and filename of file to be written
Returns:: True on success, False on failure
Return type:: bool

save_auto_snapshot(progress_func: Callable[[int, int], bool] | None = None, settings: SaveSettings | None = None) → bool[source]¶

save_auto_snapshot saves the current database to the already created file.

Note

create_database should have been called prior to executing this method

Parameters:

progress_func (callback) – optional function to be called with the current progress and total count.
settings (SaveSettings) – optional argument for special save options.

Returns:

True if it successfully saved the snapshot, False otherwise

Return type:

search(pattern: str, start: int | None = None, end: int | None = None, raw: bool = False, ignore_case: bool = False, overlap: bool = False, align: int = 1, limit: int | None = None, progress_callback: Callable[[int, int], bool] | None = None, match_callback: Callable[[int, DataBuffer], bool] | None = None) → QueueGenerator[source]¶

Searches for matches of the specified pattern within this BinaryView with an optionally provided address range specified by start and end. This is the API used by the advanced binary search UI option. The search pattern can be interpreted in various ways:

specified as a string of hexadecimal digits where whitespace is ignored, and the ‘?’ character acts as a wildcard

a regular expression suitable for working with bytes

or if the raw option is enabled, the pattern is interpreted as a raw string, and any special characters are escaped and interpreted literally

Parameters:

pattern (str) – The pattern to search for.
start (int) – The address to start the search from. (default: None)
end (int) – The address to end the search (inclusive). (default: None)
raw (bool) – Whether to interpret the pattern as a raw string (default: False).
ignore_case (bool) – Whether to perform case-insensitive matching (default: False).
overlap (bool) – Whether to allow matches to overlap (default: False).
align (int) – The alignment of matches, must be a power of 2 (default: 1).
limit (int) – The maximum number of matches to return (default: None).
progress_callback (callback) – An optional function to be called with the current progress and total count. This function should return a boolean value that decides whether the search should continue or stop.
match_callback (callback) – A function that gets called when a match is found. The callback takes two parameters: the address of the match, and the actual DataBuffer that satisfies the search. This function can return a boolean value that decides whether the search should continue or stop.

Returns:

A generator object that yields the offset and matched DataBuffer for each match found.

Return type:

QueueGenerator

Example:

>>> from binaryninja import load
>>> bv = load('/bin/ls')
>>> print(bv)
<BinaryView: '/bin/ls', start 0x100000000, len 0x182f8>
>>> bytes(list(bv.search("50 ?4"))[0][1]).hex()
'5004'
>>> bytes(list(bv.search("[\x20-\x25][\x60-\x67]"))[0][1]).hex()
'2062'

set_analysis_hold(enable: bool) → None[source]¶

set_analysis_hold control the analysis hold for this BinaryView. Enabling analysis hold defers all future analysis updates, therefore causing update_analysis or update_analysis_and_wait to take no action.

Return type:: None
Parameters:: enable (bool) –

set_comment_at(addr: int, comment: str) → None[source]¶

set_comment_at sets a comment for the BinaryView at the address specified

Note that these are different from function-level comments which are specific to each Function. For more information, see address_comments.

Parameters:

addr (int) – virtual address within the current BinaryView to apply the comment to
comment (str) – string comment to apply

Return type:

None

Example:

>>> bv.set_comment_at(here, "hi")

static set_default_session_data(name: str, value: str) → None[source]¶

set_default_session_data saves a variable to the BinaryView. Session data is ephemeral not saved to a database. Consider using store_metadata if permanence is needed.

Parameters:

name (str) – name of the variable to be saved
value (str) – value of the variable to be saved

Example:

>>> BinaryView.set_default_session_data("variable_name", "value")
>>> bv.session_data.variable_name
'value'

Return type:

None

set_function_analysis_update_disabled(disabled: bool) → None[source]¶

set_function_analysis_update_disabled prevents any function from being marked as updates required, so that they would NOT be re-analyzed when the analysis is updated. The main difference between this API and set_analysis_hold is that set_analysis_hold only temporarily holds the analysis, and the functions are still arranged to be updated when the hold is turned off. However, with set_function_analysis_update_disabled, functions would not be put into the analysis queue at all.

Use with caution – in most cases, this is NOT what you want, and you should use set_analysis_hold instead.

Parameters:: disabled (bool) –
Returns:
Return type:: None

set_load_settings(type_name: str, settings: Settings | None) → None[source]¶

set_load_settings set a Settings object which defines the load settings for the given BinaryViewType type_name

Parameters:

type_name (str) – the BinaryViewType name
settings (Settings) – the load settings

Return type:

None

set_manual_type_source_override(entries: Mapping[QualifiedName, Tuple[QualifiedName, str]])[source]¶

This allows for fine-grained control over how types from this BinaryView are exported to a TypeLibrary by export_type_to_library and export_object_to_library. Types identified by the keys of the dict will NOT be exported to the destination TypeLibrary, but will instead be treated as a type that had come from the string component of the value tuple. This results in the destination TypeLibrary gaining a new dependency.

This is useful if a BinaryView was automatically marked up with a lot of debug information but you want to export only a subset of that information into a new TypeLibrary. By creating a description of which local types correspond to types in other already extant libraries, those types will be avoided during the recursive export.

This data is not persisted and does not impact analysis.

For example, if a BinaryView contains the following types:

struct RECT { ... }; // omitted
struct ContrivedExample { RECT rect; };

Then the following python:

overrides = {"RECT": ("tagRECT", "winX64common")}
bv.set_manual_type_source_override(overrides)
bv.export_type_to_library(dest_new_typelib, "ContrivedExample", bv.get_type_by_name("ContrivedExample"))

Results in dest_new_typelib only having ContrivedExample added, and “RECT” being inserted as a dependency to a the type “tagRECT” found in the typelibrary “winX64common”

Parameters:: entries (Mapping[QualifiedName, Tuple[QualifiedName, str]]) –

set_user_global_pointer_value(value: RegisterValue, confidence=255)[source]¶

Set a user global pointer value. This is useful when the auto analysis fails to find out the value of the global pointer, or the value is wrong. In this case, we can call set_user_global_pointer_value with a ConstantRegisterValue or ConstantPointerRegisterValue to provide a user global pointer value to assist the analysis.

On the other hand, if the auto analysis figures out a global pointer value, but there should not be one, we can call set_user_global_pointer_value with an Undetermined value to override it.

Whenever a user global pointer value is set/cleared, an analysis update must occur for it to take effect and all functions using the global pointer to be updated.

We can use user_global_pointer_value_set to query whether a user global pointer value is set, and use clear_user_global_pointer_value to clear a user global pointer value. Note, clear_user_global_pointer_value is different from calling set_user_global_pointer_value with an Undetermined value. The former clears the user global pointer value and let the analysis decide the global pointer value, whereas the latte forces the global pointer value to become undetermined.

Parameters:

value (RegisterValue) – the user global pointer value to be set
confidence (int) – the confidence value of the user global pointer value. In most cases this should be set to 255. Setting a value lower than the confidence of the global pointer value from the auto analysis will cause undesired effect.

Returns:

None

Return type:

None

Example:

>>> bv.global_pointer_value
<const ptr 0x3fd4>
>>> bv.set_user_global_pointer_value(ConstantPointerRegisterValue(0x12345678))
>>> bv.global_pointer_value
<const ptr 0x12345678>
>>> bv.user_global_pointer_value_set
True
>>> bv.clear_user_global_pointer_value()
>>> bv.global_pointer_value
<const ptr 0x3fd4>
>>> bv.set_user_global_pointer_value(Undetermined())
>>> bv.global_pointer_value
<undetermined>

should_skip_target_analysis(source_location: ArchAndAddr, source_function: Function, end: int, target_location: ArchAndAddr) → bool[source]¶

should_skip_target_analysis checks if target analysis should be skipped.

Note

This method is intended for use by architecture plugins only.

Parameters:

source_location (_function.ArchAndAddr) – The source location.
source_function (_function.Function) – The source function.
end (int) – The end address of the source branch instruction.
target_location (_function.ArchAndAddr) – The target location.

Returns:

True if the target analysis should be skipped, False otherwise

Return type:

show_graph_report(title: str, graph: FlowGraph) → None[source]¶

show_graph_report displays a FlowGraph object graph in a new tab with title.

Parameters:

title (Text string title of the tab) – Title of the graph
graph (FlowGraph object) – The graph you wish to display

Return type:

None

show_html_report(title: str, contents: str, plaintext: str = '') → None[source]¶

show_html_report displays the HTML contents in UI applications and plaintext in command-line applications. HTML reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: binaryninja://?expr=_start Where expr= specifies an expression parsable by the parse_expression API.

Note

This API function differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line a simple text prompt is used.

Parameters:

contents (str) – HTML contents to display
plaintext (str) – Plain text version to display (used on the command-line)
title (str) –

Return type:

None

Example:

>>> bv.show_html_report("title", "<h1>Contents</h1>", "Plain text contents")
Plain text contents

show_markdown_report(title: str, contents: str, plaintext: str = '') → None[source]¶

show_markdown_report displays the markdown contents in UI applications and plaintext in command-line applications. Markdown reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: binaryninja://?expr=_start Where expr= specifies an expression parsable by the parse_expression API.

Note

This API functions differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line a simple text prompt is used.

Parameters:

contents (str) – markdown contents to display
plaintext (str) – Plain text version to display (used on the command-line)
title (str) –

Return type:

None

Example:

>>> bv.show_markdown_report("title", "##Contents", "Plain text contents")
Plain text contents

show_plain_text_report(title: str, contents: str) → None[source]¶

Parameters:

title (str) –
contents (str) –

Return type:

None

skip_and_return_value(addr: int, value: int, arch: Architecture | None = None) → bool[source]¶

skip_and_return_value convert the call instruction of architecture arch at the virtual address addr to the equivalent of returning a value.

Parameters:

addr (int) – virtual address of the instruction to be modified
value (int) – value to make the instruction return
arch (Architecture) – (optional) the architecture of the instructions if different from the default

Returns:

True on success, False on failure.

Return type:

Example:

>>> bv.get_disassembly(0x1000132a)
'call    0x1000134a'
>>> bv.skip_and_return_value(0x1000132a, 42)
True
>>> #The return value from x86 functions is stored in eax thus:
>>> bv.get_disassembly(0x1000132a)
'mov     eax, 0x2a'
>>>

store_metadata stores an object for the given key in the current BinaryView. Objects stored using store_metadata can be retrieved when the database is reopened. Objects stored are not arbitrary python objects! The values stored must be able to be held in a Metadata object. See Metadata for more information. Python objects could obviously be serialized using pickle but this intentionally a task left to the user since there is the potential security issues.

Parameters:

key (str) – key value to associate the Metadata object with
md (Varies) – object to store.
isAuto (bool) – whether the metadata is an auto metadata. Most metadata should keep this as False. Only those automatically generated metadata should have this set to True. Auto metadata is not saved into the database and is presumably re-generated when re-opening the database.

Return type:

None

Example:

>>> bv.store_metadata("integer", 1337)
>>> bv.query_metadata("integer")
1337L
>>> bv.store_metadata("list", [1,2,3])
>>> bv.query_metadata("list")
[1L, 2L, 3L]
>>> bv.store_metadata("string", "my_data")
>>> bv.query_metadata("string")
'my_data'

stringify_unicode_data(arch: Architecture | None, buffer: DataBuffer, null_terminates: bool = True, allow_short_strings: bool = False) → Tuple[str | None, StringType | None][source]¶

stringify_unicode_data converts a buffer of unicode data into a string representation. :param arch: The architecture to use for stringification, or None to use the current architecture of the BinaryView :param buffer: The DataBuffer containing the unicode data to stringify :param null_terminates: If True, stops stringification at the first null character, otherwise continues until the end of the buffer :param allow_short_strings: If True, allows short strings to be returned, otherwise only long strings are returned :return: A tuple containing the string representation and its type, or (None, None) if the stringification fails :rtype: Tuple[Optional[str], Optional[StringType]]

Parameters:

arch (Architecture | None) –
buffer (DataBuffer) –
null_terminates (bool) –
allow_short_strings (bool) –

Return type:

Tuple[str | None, StringType | None]

tags_by_type(tag_type: TagType) → List[Tuple[int, Tag]][source]¶

tags_by_type fetches tags of a specific type.

Parameters:: tag_type (TagType) – The type of tags to fetch.
Return type:: List[Tuple[int, Tag]]

tags_for_data_by_type(tag_type: TagType) → List[Tuple[int, Tag]][source]¶

tags_for_data_by_type fetches data-specific tags of a specific type.

Parameters:: tag_type (TagType) – The type of tags to filter by.
Return type:: list(int, Tag)

tags_for_data_with_source(auto: bool = True) → List[Tuple[int, Tag]][source]¶

tags_for_data_with_source fetches data-specific tags filtered by source.

Parameters:: auto (bool) – If True, fetch auto tags. If False, fetch user tags.
Return type:: list(int, Tag)

typed_data_accessor(address: int, type: Type) → TypedDataAccessor[source]¶

Parameters:

address (int) –
type (Type) –

Return type:

TypedDataAccessor

undefine_auto_symbol(sym: CoreSymbol) → None[source]¶

undefine_auto_symbol removes a symbol from the internal list of automatically discovered Symbol objects.

Parameters:: sym (Symbol) – the symbol to undefine
Return type:: None

undefine_data_var(addr: int, blacklist: bool = True) → None[source]¶

undefine_data_var removes the non-user data variable at the virtual address addr.

Parameters:

addr (int) – virtual address to define the data variable to be removed
blacklist (bool) – whether to add the address to the data variable black list so that the auto analysis would not recreat the variable on re-analysis

Return type:

None

Example:

>>> bv.undefine_data_var(bv.entry_point)
>>>

undefine_type(type_id: str) → None[source]¶

undefine_type removes a Type from the global list of types for the current BinaryView

Parameters:

type_id (str) – Unique identifier of type to be undefined

Return type:

None

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> type_id = Type.generate_auto_type_id("source", name)
>>> bv.define_type(type_id, name, type)
>>> bv.get_type_by_name(name)
<type: int32_t>
>>> bv.undefine_type(type_id)
>>> bv.get_type_by_name(name)
>>>

undefine_user_data_var(addr: int) → None[source]¶

undefine_user_data_var removes the user data variable at the virtual address addr.

Parameters:

addr (int) – virtual address to define the data variable to be removed

Return type:

None

Example:

>>> bv.undefine_user_data_var(bv.entry_point)
>>>

undefine_user_symbol(sym: CoreSymbol) → None[source]¶

undefine_user_symbol removes a symbol from the internal list of user added Symbol objects.

Parameters:: sym (CoreSymbol) – the symbol to undefine
Return type:: None

undefine_user_type(name: _types.QualifiedNameType) → None[source]¶

undefine_user_type removes a Type from the global list of user types for the current BinaryView

Parameters:

name (QualifiedName) – Name of user type to be undefined

Return type:

None

Example:

>>> type, name = bv.parse_type_string("int foo")
>>> bv.define_user_type(name, type)
>>> bv.get_type_by_name(name)
<type: int32_t>
>>> bv.undefine_user_type(name)
>>> bv.get_type_by_name(name)
>>>

undo() → None[source]¶

undo undo the last committed transaction in the undo database.

Return type:

None

Example:

>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> with bv.undoable_transaction():
>>>     bv.convert_to_nop(0x100012f1)
True
>>> bv.get_disassembly(0x100012f1)
'nop'
>>> bv.undo()
>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> bv.redo()
>>> bv.get_disassembly(0x100012f1)
'nop'
>>>

undoable_transaction() → Generator[source]¶

undoable_transaction gives you a context in which you can make changes to analysis, and creates an Undo state containing those actions. If an exception is thrown, any changes made to the analysis inside the transaction are reverted.

Returns:

Transaction context manager, which will commit/revert actions depending on if an exception is thrown when it goes out of scope.

Return type:

Generator

Example:

>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> # Actions inside the transaction will be committed to the undo state upon exit
>>> with bv.undoable_transaction():
>>>     bv.convert_to_nop(0x100012f1)
True
>>> bv.get_disassembly(0x100012f1)
'nop'
>>> bv.undo()
>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'
>>> # A thrown exception inside the transaction will undo all changes made inside it
>>> with bv.undoable_transaction():
>>>     bv.convert_to_nop(0x100012f1)  # Reverted on thrown exception
>>>     raise RuntimeError("oh no")
RuntimeError: oh no
>>> bv.get_disassembly(0x100012f1)
'xor     eax, eax'

unregister_notification(notify: BinaryDataNotification) → None[source]¶

unregister_notification unregisters the BinaryDataNotification object passed to register_notification

Parameters:: notify (BinaryDataNotification) – notify is a subclassed instance of BinaryDataNotification.
Return type:: None

update_analysis() → None[source]¶

update_analysis asynchronously starts the analysis process and returns immediately.

Usage: Call update_analysis after making changes that could affect the analysis results, such as adding or modifying functions. This ensures that the analysis is updated to reflect the latest changes. The analysis runs in the background, allowing other operations to continue.

Return type:: None

update_analysis_and_wait() → None[source]¶

update_analysis_and_wait starts the analysis process and blocks until it is complete. This method should be used when it is necessary to ensure that analysis results are fully updated before proceeding with further operations. If an update is already in progress, this method chains a new update request to ensure that the update processes all pending changes before the call was made.

Usage: Call update_analysis_and_wait after making changes that could affect the analysis results, such as adding or modifying functions, to ensure that the analysis reflects the latest changes. Unlike update_analysis, this method waits for the analysis to finish before returning.

Thread Restrictions:

Worker Threads: This function cannot be called from a worker thread. If called from a worker thread, an error will be logged, and the function will return immediately.

UI Threads: This function cannot be called from a UI thread. If called from a UI thread, an error will be logged, and the function will return immediately.

Return type:: None

write(addr: int, data: bytes, except_on_relocation: bool = True) → int[source]¶

write writes the bytes in data to the virtual address addr.

Parameters:

addr (int) – virtual address to write to.
data (bytes) – data to be written at addr.
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

number of bytes written to virtual address addr

Return type:

Example:

>>> bv.read(0,4)
b'BBBB'
>>> bv.write(0, b"AAAA")
4
>>> bv.read(0,4)
b'AAAA'

writer(address: int | None = None) → BinaryWriter[source]¶

Parameters:: address (int | None) –
Return type:: BinaryWriter

property address_comments: Mapping[int, str]¶

Returns a read-only dict of the address comments attached to this BinaryView

Note that these are different from function-level comments which are specific to each Function. For annotating code, it is recommended to use comments attached to functions rather than address comments attached to the BinaryView. On the other hand, BinaryView comments can be attached to data whereas function comments cannot.

To create a function-level comment, use set_comment_at.

property address_size: int¶: Address size of the binary (read-only)

property allocated_ranges: List[AddressRange]¶: List of valid address ranges for this view (read-only) Deprecated: 4.1.5902 Use mapped_address_ranges instead.

property analysis_changed: bool¶: boolean analysis state changed of the currently running analysis (read-only)

property analysis_info: AnalysisInfo¶: Provides instantaneous analysis state information and a list of current functions under analysis (read-only). All times are given in units of milliseconds (ms). Per-function analysis_time is the aggregation of time spent performing incremental updates and is reset on a full function update. Per-function update_count tracks the current number of incremental updates and is reset on a full function update. Per-function submit_count tracks the current number of full updates that have completed.

Note

submit_count is currently not reset across analysis updates.

property analysis_is_aborted: bool¶

analysis_is_aborted checks if the analysis has been aborted.

Note

This property is intended for use by architecture plugins only.

Returns:: True if the analysis has been aborted, False otherwise
Return type:: bool

property analysis_progress: AnalysisProgress¶: Status of current analysis (read-only)

property analysis_state: AnalysisState¶: State of current analysis (read-only)

property arch: Architecture | None¶: The architecture associated with the current BinaryView (read/write)

property associated_type_archive_type_ids: Mapping[str, Tuple[str, str]]¶

Get a list of all types in the analysis that are associated with type archives

Returns:: Map of all analysis types to their corresponding archive / id

property associated_type_archive_types: Mapping[QualifiedName, Tuple[TypeArchive | None, str]]¶

Get a list of all types in the analysis that are associated with attached type archives

Returns:: Map of all analysis types to their corresponding archive / id. If a type is associated with a disconnected type archive, the archive will be None.

property attached_type_archives: Mapping[str, str]¶: All attached type archive ids and paths (read-only)

property auto_metadata: Dict[str, metadata.MetadataValueType]¶

metadata retrieves the metadata associated with the current BinaryView.

Return type:

metadata associated with the BinaryView

Example:

>>> bv.metadata
<metadata: {}>

property auto_type_container: TypeContainer¶: Type Container for ONLY auto types in the BinaryView. Any changes to types will NOT promote auto types to user types. :return: Auto types only Type Container

property available_view_types: List[BinaryViewType]¶: Available view types (read-only)

property backed_address_ranges: List[AddressRange]¶: List of backed address ranges for this view (read-only)

property basic_blocks: Generator[BasicBlock, None, None]¶: A generator of all BasicBlock objects in the BinaryView

property connected_type_archives: List[TypeArchive]¶: All connected type archive objects (read-only)

property data_vars: Mapping[int, DataVariable]¶: List of data variables (read-only)

property debug_info: DebugInfo¶: The current debug info object for this binary view

property dependency_sorted_types: TypeMapping¶

List of all types, sorted such that types are after all types on which they depend (read-only)

Order is guaranteed for any collection of types with no cycles. If you have cycles in type dependencies, order for types in a cycle is not guaranteed.

Note

Dependency order is based on named type references for all non-structure types, i.e. struct Foo m_foo will induce a dependency, whereas struct Foo* m_pFoo will not.

Returns:: sorted types as defined above

property derived_strings: List[DerivedString]¶

property end: int¶: End offset of the binary (read-only)

property endianness: Endianness¶: Endianness of the binary (read-only)

property entry_function: Function | None¶: Entry function (read-only)

property entry_functions: FunctionList¶

A List of entry functions (read-only) This list contains vanilla entry function, and functions like init_array, fini_array, and TLS callbacks etc. User-added entry functions(via add_entry_point) are also included.

We see entry_functions as good starting points for analysis, these functions normally don’t have internal references. However, note that exported functions in a dll/so file are not included.

Note the difference with entry_function

Example:

>>> bv.entry_function
<func: x86@0x4014c8>
>>> bv.entry_functions
[<func: x86@0x4014c8>, <func: x86@0x401618>]

Returns:

a list of functions, containing the vanilla entry and other platform-specific entry functions

Return type:

list(Function)

property entry_point: int¶: Entry point of the binary (read-only)

property executable: bool¶: Whether the binary is an executable (read-only)

property file: FileMetadata¶: FileMetadata backing the BinaryView

property functions: FunctionList¶: returns a FunctionList object (read-only)

property global_pointer_value: RegisterValue¶: Discovered value of the global pointer register, if the binary uses one (read-only)

property has_data_variables: bool¶: Boolean whether the binary has data variables (read-only)

property has_database: bool¶: boolean has a database been written to disk (read-only)

property has_functions: bool¶: Boolean whether the binary has functions (read-only)

property has_symbols: bool¶: Boolean whether the binary has symbols (read-only)

property hlil_basic_blocks: Generator[HighLevelILBasicBlock, None, None]¶: A generator of all HighLevelILBasicBlock objects in the BinaryView

property hlil_instructions: highlevelil.HLILInstructionsType¶: A generator of hlil instructions

property image_base: int¶: Image base of the binary

property instructions: Generator[Tuple[List[InstructionTextToken], int], None, None]¶: A generator of instruction tokens and their start addresses

property length¶

property libraries: List[str]¶

property linear_disassembly: Iterator[LinearDisassemblyLine]¶: Iterator for all lines in the linear disassembly of the view

property llil_basic_blocks: Generator[LowLevelILBasicBlock, None, None]¶: A generator of all LowLevelILBasicBlock objects in the BinaryView

property llil_instructions: lowlevelil.LLILInstructionsType¶: A generator of llil instructions

long_name: str | None = None¶

property mapped_address_ranges: List[AddressRange]¶: List of mapped address ranges for this view (read-only)

property max_function_size_for_analysis: int¶: Maximum size of function (sum of basic block sizes in bytes) for auto analysis

property memory_map¶: memory_map returns the MemoryMap object for the current BinaryView. The MemoryMap object is a proxy object that provides a high-level view of the memory map, allowing you to query and manipulate memory regions. This proxy ensures that the memory map always reflects the latest state of the core MemoryMap object in the underlying BinaryView.

property metadata: Dict[str, metadata.MetadataValueType]¶

metadata retrieves the metadata associated with the current BinaryView.

Return type:

metadata associated with the BinaryView

Example:

>>> bv.metadata
<metadata: {}>

property mlil_basic_blocks: Generator[MediumLevelILBasicBlock, None, None]¶: A generator of all MediumLevelILBasicBlock objects in the BinaryView

property mlil_instructions: Generator[MediumLevelILInstruction, None, None]¶: A generator of mlil instructions

property modified: bool¶: boolean modification state of the BinaryView (read/write)

name: str | None = None¶

property namespaces: List[NameSpace]¶: Returns a list of namespaces for the current BinaryView

property new_auto_function_analysis_suppressed: bool¶: Whether or not automatically discovered functions will be analyzed

property offset: int¶

property original_base: int¶: Original image base of the binary. Deprecated: 4.1.5902 Use original_image_base instead.

property original_image_base: int¶: Original image base of the binary

property parameters_for_analysis¶

property parent_view: BinaryView | None¶: View that contains the raw data used by this view (read-only)

property parse_only: bool¶

property platform: Platform | None¶: The platform associated with the current BinaryView (read/write)

property preload_limit: int¶

property project: Project | None¶

property project_file: ProjectFile | None¶

registered_view_type = None¶

property relocatable: bool¶: Boolean - is the binary relocatable (read-only)

property relocation_ranges: List[Tuple[int, int]]¶: List of relocation range tuples (read-only)

property root_component: Component¶

The root component for the BinaryView (read-only)

This Component cannot be removed, and houses all unparented Components.

Returns:: The root component

property saved: bool¶: boolean state of whether or not the file has been saved (read/write)

property sections: Mapping[str, Section]¶: Dictionary of sections (read-only)

property segments: List[Segment]¶: List of resolved segments (read-only)

property session_data¶: Dictionary object where plugins can store arbitrary data associated with the view. This data is ephemeral and not saved to a database. Consider using store_metadata if permanence is needed.

property start: int¶: Start offset of the binary (read-only)

property strings: List[StringReference]¶: List of strings (read-only)

property symbols: SymbolMapping¶

Dict of symbols (read-only) Items in the dict are lists of all symbols matching that name.

Example:

>>> bv.symbols['_main']
[<FunctionSymbol: "_main" @ 0x1dd0>]
>>> list(bv.symbols)
['_start', '_main', '_printf', '_scanf', ...]
>>> bv.symbols['foo']
KeyError: "'foo': symbol not found"

Returns:

a dict-like generator of symbol names and values

Return type:

Generator[str, None, None]

property tag_types: Mapping[str, TagType | List[TagType]]¶

tag_types gets a dictionary of all Tag Types present for the view, structured as {Tag Type Name => Tag Type}.

Warning

This method inconsistently returns a list of TagType objects or a single TagType this behavior will change in future revisions

Return type:: dict of (str, TagType)

property tags: List[Tuple[int, Tag]]¶

tags gets a list of all data Tag objects in the view. Tags are returned as a list of (address, Tag) pairs.

Return type:: list(int, Tag)

property tags_all_scopes: List[Tuple[int, Tag]]¶: tags_all_scopes fetches all tags in all scopes.

property tags_for_address: List[Tuple[int, Tag]]¶: tags_for_address fetches all address-specific tags.

property tags_for_data: List[Tuple[int, Tag]]¶: tags_for_data fetches all data-specific tags.

property tags_for_function: List[Tuple[int, Tag]]¶: tags_for_function fetches all function-specific tags.

property type_archive_type_names: Mapping[QualifiedName, List[Tuple[TypeArchive, str]]]¶

Get a list of all available type names in all connected archives, and their archive/type id pair

Returns:: name <-> [(archive, archive type id)] for all type names

property type_container: TypeContainer¶: Type Container for all types (user and auto) in the BinaryView. Any auto types modified through the Type Container will be converted into user types. :return: Full view Type Container

property type_libraries: List[TypeLibrary]¶: List of imported type libraries (read-only)

property type_names: List[QualifiedName]¶: List of defined type names (read-only)

Note

Sort order is not guaranteed in 5.2 and later.

property types: TypeMapping¶

property user_global_pointer_value_set: bool¶: Check whether a user global pointer value has been set

property user_type_container: TypeContainer¶: Type Container for ONLY user types in the BinaryView. :return: User types only Type Container

property view: str¶

property view_type: str¶: View type (read-only)

property workflow: Workflow | None¶

BinaryViewEvent¶

class BinaryViewEvent[source]¶

Bases: object

The BinaryViewEvent object provides a mechanism for receiving callbacks when a BinaryView is Finalized or the initial analysis is finished. The BinaryView finalized callbacks run before the initial analysis starts. The callbacks run one-after-another in the same order as they get registered. It is a good place to modify the BinaryView to add extra information to it.

For newly opened binaries, the initial analysis completion callbacks run after the initial analysis, as well as linear sweep and signature matcher (if they are configured to run), completed. For loading old databases, the callbacks run after the database is loaded, as well as any automatic analysis update finishes.

The callback function receives a BinaryView as its parameter. It is possible to call BinaryView.add_analysis_completion_event() on it to set up other callbacks for analysis completion.

Example:

>>> def callback(bv):
...     print('start: 0x%x' % bv.start)
...
>>> BinaryViewType.add_binaryview_finalized_event(callback)

classmethod register(event_type: BinaryViewEventType, callback: Callable[[BinaryView], None]) → None[source]¶

Parameters:

event_type (BinaryViewEventType) –
callback (Callable[[BinaryView], None]) –

Return type:

None

BinaryViewEventCallback¶: alias of Callable[[BinaryView], None]

BinaryViewType¶

class BinaryViewType[source]¶

Bases: object

The BinaryViewType object is used internally and should not be directly instantiated.

__init__(handle: LP_BNBinaryViewType)[source]¶

Parameters:: handle (LP_BNBinaryViewType) –

static add_binaryview_finalized_event(callback: Callable[[BinaryView], None]) → None[source]¶

add_binaryview_finalized_event adds a callback that gets executed when new binaryview is finalized. For more details, please refer to the documentation of BinaryViewEvent.

Warning

The callback provided must stay in scope for the lifetime of the process, deletion or garbage collection of the callback will result in a crash.

Parameters:: callback (Callable[[BinaryView], None]) –
Return type:: None

static add_binaryview_initial_analysis_completion_event(callback: Callable[[BinaryView], None]) → None[source]¶

add_binaryview_initial_analysis_completion_event adds a callback that gets executed after the initial analysis, as well as linear sweep and signature matcher (if they are configured to run) completed. For more details, please refer to the documentation of BinaryViewEvent.

Warning

The callback provided must stay in scope for the lifetime of the process, deletion or garbage collection of the callback will result in a crash.

Parameters:: callback (Callable[[BinaryView], None]) –
Return type:: None

create(data: BinaryView) → BinaryView | None[source]¶

Parameters:: data (BinaryView) –
Return type:: BinaryView | None

get_arch(ident: int, endian: Endianness) → Architecture | None[source]¶

Parameters:

ident (int) –
endian (Endianness) –

Return type:

Architecture | None

get_load_settings_for_data(data: BinaryView) → Settings | None[source]¶

Parameters:: data (BinaryView) –
Return type:: Settings | None

get_platform(ident: int, arch: Architecture) → Platform | None[source]¶

Parameters:

ident (int) –
arch (Architecture) –

Return type:

Platform | None

is_valid_for_data(data: BinaryView) → bool[source]¶

Parameters:: data (BinaryView) –
Return type:: bool

open(src: str | PathLike, file_metadata: FileMetadata | None = None) → BinaryView | None[source]¶

Parameters:

src (str | PathLike) –
file_metadata (FileMetadata | None) –

Return type:

BinaryView | None

parse(data: BinaryView) → BinaryView | None[source]¶

Parameters:: data (BinaryView) –
Return type:: BinaryView | None

recognize_platform(ident, endian: Endianness, view: BinaryView, metadata)[source]¶

Parameters:

endian (Endianness) –
view (BinaryView) –

register_arch(ident: int, endian: Endianness, arch: Architecture) → None[source]¶

Parameters:

ident (int) –
endian (Endianness) –
arch (Architecture) –

Return type:

None

register_default_platform(arch: Architecture, plat: Platform) → None[source]¶

Parameters:

arch (Architecture) –
plat (Platform) –

Return type:

None

register_platform(ident: int, arch: Architecture, plat: Platform) → None[source]¶

Parameters:

ident (int) –
arch (Architecture) –
plat (Platform) –

Return type:

None

register_platform_recognizer(ident, endian, cb)[source]¶

property is_deprecated: bool¶: returns if the BinaryViewType is deprecated (read-only)

property is_force_loadable: bool¶: returns if the BinaryViewType is force loadable (read-only)

property long_name: str¶: BinaryView long name (read-only)

property name: str¶: BinaryView name (read-only)

BinaryWriter¶

class BinaryWriter[source]¶

Bases: object

class BinaryWriter is a convenience class for writing binary data.

BinaryWriter can be instantiated as follows and the rest of the document will start from this context

>>> from binaryninja import *
>>> bv = load("/bin/ls")
>>> br = BinaryReader(bv)
>>> br.offset
4294967296
>>> bw = BinaryWriter(bv)
>>>

Or using the optional endian parameter

>>> from binaryninja import *
>>> bv = load("/bin/ls")
>>> br = BinaryReader(bv, Endianness.BigEndian)
>>> bw = BinaryWriter(bv, Endianness.BigEndian)
>>>

__init__(view: BinaryView, endian: Endianness | None = None, address: int | None = None)[source]¶

Parameters:

view (BinaryView) –
endian (Endianness | None) –
address (int | None) –

seek(offset: int) → None[source]¶

seek update internal offset to offset.

Parameters:

offset (int) – offset to set the internal offset to

Return type:

None

Example:

>>> hex(bw.offset)
'0x100000008L'
>>> bw.seek(0x100000000)
>>> hex(bw.offset)
'0x100000000L'
>>>

seek_relative(offset: int) → None[source]¶

seek_relative updates the internal offset by offset.

Parameters:

offset (int) – offset to add to the internal offset

Return type:

None

Example:

>>> hex(bw.offset)
'0x100000008L'
>>> bw.seek_relative(-8)
>>> hex(bw.offset)
'0x100000000L'
>>>

write(value: bytes, address: int | None = None, except_on_relocation=True) → bool[source]¶

write writes len(value) bytes to the internal offset, without regard to endianness.

Parameters:

bytes (str) – bytes to be written at current offset
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation
value (bytes) –

Returns:

boolean True on success, False on failure.

Return type:

Example:

>>> bw.write("AAAA")
True
>>> br.read(4)
'AAAA'
>>>

write16(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write16 writes the lowest order two bytes from the integer value to the current offset, using internal endianness.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write16be(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write16be writes the lowest order two bytes from the big endian integer value to the current offset.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write16le(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write16le writes the lowest order two bytes from the little endian integer value to the current offset.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write32(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write32 writes the lowest order four bytes from the integer value to the current offset, using internal endianness.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write32be(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write32be writes the lowest order four bytes from the big endian integer value to the current offset.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write32le(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write32le writes the lowest order four bytes from the little endian integer value to the current offset.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write64(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write64 writes the lowest order eight bytes from the integer value to the current offset, using internal endianness.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write64be(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write64be writes the lowest order eight bytes from the big endian integer value to the current offset.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write64le(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write64le writes the lowest order eight bytes from the little endian integer value to the current offset.

Parameters:

value (int) – integer value to write.
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean True on success, False on failure.

Return type:

write8(value: int, address: int | None = None, except_on_relocation=True) → bool[source]¶

write8 lowest order byte from the integer value to the current offset.

Parameters:

value (str) – bytes to be written at current offset
address (int) – offset to set the internal offset before writing
except_on_relocation (bool) – (default True) raise exception when write overlaps a relocation

Returns:

boolean

Return type:

Example:

>>> bw.write8(0x42)
True
>>> br.read(1)
'B'
>>>

property endianness: Endianness¶

The Endianness to written data. (read/write)

Getter:: returns the endianness of the reader
Setter:: sets the endianness of the reader (BigEndian or LittleEndian)
Type:: Endianness

property offset: int¶

The current write offset (read/write).

Getter:: returns the current internal offset
Setter:: sets the internal offset
Type:: int

CoreDataVariable¶

class CoreDataVariable[source]¶

Bases: object

CoreDataVariable(_address: int, _type: ‘_types.Type’, _auto_discovered: bool)

__init__(_address: int, _type: Type, _auto_discovered: bool) → None¶

Parameters:

_address (int) –
_type (Type) –
_auto_discovered (bool) –

Return type:

None

property address: int¶

property auto_discovered: bool¶

property type: Type¶

DataVariable¶

class DataVariable[source]¶

Bases: CoreDataVariable

__init__(view: BinaryView, address: int, type: Type, auto_discovered: bool)[source]¶

Parameters:

view (BinaryView) –
address (int) –
type (Type) –
auto_discovered (bool) –

classmethod from_core_struct(var: BNDataVariable, view: BinaryView) → DataVariable[source]¶

Parameters:

var (BNDataVariable) –
view (BinaryView) –

Return type:

property code_refs: Generator[ReferenceSource, None, None]¶: code references to this data variable (read-only)

property components: List[Component]¶

property data_refs: Generator[int, None, None] | None¶: data cross references to this data variable (read-only)

property data_refs_from: Generator[int, None, None] | None¶: data cross references from this data variable (read-only)

property name: str | None¶

property symbol: CoreSymbol | None¶

property type: Type¶

property value: Any¶

DataVariableAndName¶

class DataVariableAndName[source]¶

Bases: CoreDataVariable

__init__(addr: int, var_type: Type, var_name: str, auto_discovered: bool) → None[source]¶

Parameters:

addr (int) –
var_type (Type) –
var_name (str) –
auto_discovered (bool) –

Return type:

None

DerivedString¶

class DerivedString[source]¶

Bases: object

Contains a string derived from code or data. The string does not need to be directly present in the binary in its raw form. Derived strings can have optional locations to data or code. When creating new derived strings, a custom type should be registered with register on CustomStringType.

Parameters:

value (StringRef | str | bytes | bytearray | DataBuffer) –
location (DerivedStringLocation | None) –
custom_type (CustomStringType | None) –

custom_type: CustomStringType | None¶

location: DerivedStringLocation | None¶

value: StringRef¶

DerivedStringLocation¶

class DerivedStringLocation[source]¶

Bases: object

Location associated with a derived string. Locations are optional.

__init__(location_type: DerivedStringLocationType, address: int, length: int) → None¶

Parameters:

location_type (DerivedStringLocationType) –
address (int) –
length (int) –

Return type:

None

address: int¶

length: int¶

location_type: DerivedStringLocationType¶

FunctionList¶

class FunctionList[source]¶

Bases: object

__init__(view: BinaryView)[source]¶

Parameters:: view (BinaryView) –

MemoryMap¶

class MemoryMap[source]¶

Bases: object

Live proxy to the memory map of a BinaryView.

A MemoryMap describes how a BinaryView is loaded into memory. It contains regions, which are raw and possibly overlapping memory definitions, and exposes resolved ranges, which are a computed disjoint view of the address space produced by splitting overlapping regions.

Each BinaryView contributes its portion of the overall system memory layout through the segments and regions defined within that view. When regions overlap, the most recently added region takes precedence by default. Mutation is always performed by region name.

Container semantics: Iteration (__iter__), length (__len__), and indexing (__getitem__) operate on resolved ranges, the computed non-overlapping view of the address space. Configured regions are accessed explicitly via regions, get_region, and name-based membership (__contains__).

Snapshot semantics: MemoryRegionInfo and ResolvedRange objects are frozen snapshot value types captured at query time. They are not updated by later mutations to the memory map. The proxy itself (view.memory_map) always reflects the current state.

Architecture note: This Python MemoryMap object is a proxy that accesses the BinaryView’s current memory map state through the FFI boundary. Internally, the core uses immutable copy-on-write data structures to manage memory map updates, but the proxy presents a simple mutable interface.

Analysis note: For lock-free access during analysis, AnalysisContext provides memory layout query methods such as is_valid_offset(), is_offset_readable(), get_start(), and get_length(). These operate on an immutable snapshot of the MemoryMap captured when analysis begins.

Note

Repeated property access, for example regions or ranges, returns fresh snapshots of the current memory map state.

All MemoryMap APIs support undo and redo operations. During BinaryView::Init, these APIs should be used conditionally:

Initial load: Use the MemoryMap APIs to define the memory regions that compose the system.

Database load: Do not use the MemoryMap APIs, as the regions are already persisted and will be restored automatically.

This conditional usage prevents redundant operations and ensures database consistency. Using these APIs when loading from a database will also mark the analysis as modified, which is undesirable.

Example:

>>> base = 0x10000
>>> rom_base = 0xc0000000
>>> segments = SegmentDescriptorList(base)
>>> segments.append(start=base, length=0x1000, data_offset=0, data_length=0x1000, flags=SegmentFlag.SegmentReadable|SegmentFlag.SegmentExecutable)
>>> segments.append(start=rom_base, length=0x1000, flags=SegmentFlag.SegmentReadable)
>>> view = load(bytes.fromhex('5054ebfe'), options={'loader.imageBase': base, 'loader.platform': 'x86', 'loader.segments': json.dumps(segments)})
>>> view.memory_map
        <range: 0x10000 - 0x10004>
                size: 0x4
                regions:
                        'origin<Mapped>@0x0' | Mapped<Absolute> | <r-x>

        <range: 0xc0000000 - 0xc0001000>
                size: 0x1000
                regions:
                        'origin<Mapped>@0xbfff0000' | Unmapped | <r--> | FILL<0x0>

        <range: 0xc0001000 - 0xc0001014>
                size: 0x14
                regions:
                        'origin<Mapped>@0xbfff1000' | Unmapped | <---> | FILL<0x0>
>>> view.memory_map.add_memory_region("rom", rom_base, b'\x90' * 4096, SegmentFlag.SegmentReadable | SegmentFlag.SegmentExecutable)
True
>>> view.memory_map
        <range: 0x10000 - 0x10004>
                size: 0x4
                regions:
                        'origin<Mapped>@0x0' | Mapped<Absolute> | <r-x>

        <range: 0xc0000000 - 0xc0001000>
                size: 0x1000
                regions:
                        'rom' | Mapped<Relative> | <r-x>
                        'origin<Mapped>@0xbfff0000' | Unmapped | <r--> | FILL<0x0>

        <range: 0xc0001000 - 0xc0001014>
                size: 0x14
                regions:
                        'origin<Mapped>@0xbfff1000' | Unmapped | <---> | FILL<0x0>
>>> view.read(rom_base, 16)
b'\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90'
>>> view.memory_map.add_memory_region("pad", rom_base, b'\xa5' * 8)
True
>>> view.read(rom_base, 16) # "pad" wins for first 8 bytes
b'\xa5\xa5\xa5\xa5\xa5\xa5\xa5\xa5\x90\x90\x90\x90\x90\x90\x90\x90'
>>> view.memory_map # resolved ranges show the split
        <range: 0x10000 - 0x10004>
                size: 0x4
                regions:
                        'origin<Mapped>@0x0' | Mapped<Absolute> | <r-x>

        <range: 0xc0000000 - 0xc0000008>
                size: 0x8
                regions:
                        'pad' | Mapped<Relative> | <--->
                        'rom' | Mapped<Relative> | <r-x>
                        'origin<Mapped>@0xbfff0000' | Unmapped | <r--> | FILL<0x0>

        <range: 0xc0000008 - 0xc0001000>
                size: 0xff8
                regions:
                        'rom' | Mapped<Relative> | <r-x>
                        'origin<Mapped>@0xbfff0000' | Unmapped | <r--> | FILL<0x0>

        <range: 0xc0001000 - 0xc0001014>
                size: 0x14
                regions:
                        'origin<Mapped>@0xbfff1000' | Unmapped | <---> | FILL<0x0>

__init__(handle: BinaryView)[source]¶

Parameters:: handle (BinaryView) –

Adds a memory region to the memory map. Depending on the source parameter, the memory region is created as one of the following types:

BinaryMemoryRegion (*Unimplemented*): Represents a memory region loaded from a binary format.
DataMemoryRegion: Region backed by flat file or raw data (str, bytes, DataBuffer).
RemoteMemoryRegion: Ephemeral memory region via FileAccessor.
UnbackedMemoryRegion: Region not backed by any data source (requires length to be set).

The source parameter determines the type:

os.PathLike or str: File path to be loaded into memory as a DataMemoryRegion.

bytes or bytearray: Directly loaded into memory as a DataMemoryRegion.

databuffer.DataBuffer: Loaded as a DataMemoryRegion.

fileaccessor.FileAccessor: Remote proxy source.

BinaryView: (Reserved for future).

None: Creates an unbacked memory region (must specify length).

Note

If no flags are specified and the new memory region overlaps with one or more existing regions, the overlapping portions of the new region will inherit the flags of the respective underlying regions.

Parameters:: name (str): A unique name for the memory region. start (int): Starting address. source (Optional[Union[os.PathLike, str, bytes, bytearray, BinaryView, databuffer.DataBuffer, fileaccessor.FileAccessor]]): Source of data or None for unbacked. length (Optional[int]): Required if source is None (unbacked). flags (SegmentFlag): Flags to apply to the memory region. Defaults to 0 (no flags). fill (int): Fill byte for unbacked regions. Defaults to 0.
Returns:: bool: True if the memory region was successfully added, False otherwise.
Raises:: NotImplementedError: If source type is unsupported. ValueError: If source is None and length is not specified.

Parameters:

name (str) –
start (int) –
source (PathLike | str | bytes | bytearray | BinaryView | DataBuffer | FileAccessor | None) –
flags (SegmentFlag) –
fill (int) –
length (int | None) –

Return type:

description(base: bool = False) → dict[source]¶

Return the memory map description as a dict. If base is True, return the unresolved base map.

Parameters:: base (bool) –
Return type:: dict

format_description(description: dict) → str[source]¶

Format a memory map description dict as a human-readable string. Keep public for compatibility.

Parameters:: description (dict) –
Return type:: str

get_active_memory_region_at(addr: int) → str[source]¶

Return the name of the active region at addr, or an empty string if no region covers the address.

Parameters:: addr (int) –
Return type:: str

get_active_region_at(addr: int) → MemoryRegionInfo | None[source]¶

Return the active region snapshot covering addr, or None if no region covers the address.

Parameters:: addr (int) –
Return type:: MemoryRegionInfo | None

get_memory_region_display_name(name: str) → str[source]¶

Return the display name for the named region.

Parameters:: name (str) –
Return type:: str

get_memory_region_fill(name: str) → int[source]¶

Return the fill byte for the named region.

Parameters:: name (str) –
Return type:: int

get_memory_region_flags(name: str) → SegmentFlag[source]¶

Return the flags for the named region.

Parameters:: name (str) –
Return type:: SegmentFlag

get_region(name: str) → MemoryRegionInfo | None[source]¶

Look up a memory region by name, returning None if not found.

Parameters:: name (str) –
Return type:: MemoryRegionInfo | None

get_resolved_range_at(addr: int) → ResolvedRange | None[source]¶

Return the resolved range snapshot covering addr, or None if no range covers the address.

Parameters:: addr (int) –
Return type:: ResolvedRange | None

is_memory_region_enabled(name: str) → bool[source]¶

Return whether the named region is enabled.

Parameters:: name (str) –
Return type:: bool

is_memory_region_local(name: str) → bool[source]¶

Return whether the named region is local.

Parameters:: name (str) –
Return type:: bool

is_memory_region_rebaseable(name: str) → bool[source]¶

Return whether the named region is rebaseable.

Parameters:: name (str) –
Return type:: bool

remove_memory_region(name: str) → bool[source]¶

Remove a memory region by name. Returns True on success.

Parameters:: name (str) –
Return type:: bool

reset() → None[source]¶

Reset the memory map to its initial state. Supports undo.

Return type:: None

set_logical_memory_map_enabled(enabled: bool) → None[source]¶

Enable or disable the logical memory map.

When enabled, the memory map will present a simplified, logical view that merges and abstracts virtual memory regions based on criteria such as contiguity and flag consistency. This view is designed to provide a higher-level representation for user analysis, hiding underlying mapping details.

When disabled, the memory map will revert to displaying the virtual view, which corresponds directly to the individual segments mapped from the raw file without any merging or abstraction.

Parameters:: enabled (bool) – True to enable the logical view, False to revert to the virtual view.
Return type:: None

set_memory_region_display_name(name: str, display_name: str) → bool[source]¶

Set the display name for the named region.

Parameters:

name (str) –
display_name (str) –

Return type:

set_memory_region_enabled(name: str, enabled: bool = True) → bool[source]¶

Set the enabled state for the named region.

Parameters:

name (str) –
enabled (bool) –

Return type:

set_memory_region_fill(name: str, fill: int) → bool[source]¶

Set the fill byte for the named region.

Parameters:

name (str) –
fill (int) –

Return type:

set_memory_region_flags(name: str, flags: SegmentFlag | set) → bool[source]¶

Set flags for the named region. Accepts SegmentFlag or a set of flags.

Parameters:

name (str) –
flags (SegmentFlag | set) –

Return type:

set_memory_region_rebaseable(name: str, rebaseable: bool = True) → bool[source]¶

Set the rebaseable state for the named region.

Parameters:

name (str) –
rebaseable (bool) –

Return type:

property base_description: str¶: Formatted string of the base memory map, consisting of unresolved auto and user segments (read-only).

property is_activated: bool¶

Whether the memory map is activated for the associated view.

Returns True if this MemoryMap represents a parsed BinaryView with real segments (ELF, PE, Mach-O, etc.). Returns False for Raw BinaryViews or views that failed to parse segments.

This is determined by whether the BinaryView has a parent view - parsed views have a parent Raw view, while Raw views have no parent.

Use this to gate features that require parsed binary structure (sections, imports, relocations, etc.). For basic analysis queries (start, length, is_offset_readable, etc.), use the MemoryMap directly regardless of activation state - all BinaryViews have a usable MemoryMap.

Returns:: True if this is an activated (parsed) memory map, False otherwise
Return type:: bool

property ranges: List[ResolvedRange]¶

List of resolved, non-overlapping address ranges sorted by start address.

Each range contains an ordered list of memory regions at that interval, with the first being the active (highest-priority) region. This is the computed address-space view, analogous to segments.

Returns immutable snapshot objects that are not updated after later memory map mutations.

property regions: List[MemoryRegionInfo]¶

List of all memory regions (including disabled ones) as snapshot value types.

Returns immutable snapshot objects that are not updated after later memory map mutations.

MemoryRegionInfo¶

class MemoryRegionInfo[source]¶

Bases: object

Snapshot of a memory region’s properties at the time of query.

This is a frozen value type. Modifying the memory map will not update existing MemoryRegionInfo instances. To mutate a region, use the corresponding MemoryMap methods (e.g., memory_map.set_memory_region_flags(region.name, new_flags)).

__init__(name: str, display_name: str, start: int, length: int, flags: SegmentFlag, enabled: bool, rebaseable: bool, fill: int, has_target: bool, absolute_address_mode: bool, local: bool) → None¶

Parameters:

name (str) –
display_name (str) –
start (int) –
length (int) –
flags (SegmentFlag) –
enabled (bool) –
rebaseable (bool) –
fill (int) –
has_target (bool) –
absolute_address_mode (bool) –
local (bool) –

Return type:

None

absolute_address_mode: bool¶

display_name: str¶

enabled: bool¶

property end: int¶

fill: int¶

flags: SegmentFlag¶

has_target: bool¶

length: int¶

local: bool¶

name: str¶

rebaseable: bool¶

start: int¶

ReferenceSource¶

class ReferenceSource[source]¶

Bases: object

ReferenceSource(function: Optional[ForwardRef(‘_function.Function’)], arch: Optional[ForwardRef(‘architecture.Architecture’)], address: int)

__init__(function: Function | None, arch: Architecture | None, address: int) → None¶

Parameters:

function (Function | None) –
arch (Architecture | None) –
address (int) –

Return type:

None

address: int¶

arch: Architecture | None¶

function: Function | None¶

property hlil: HighLevelILInstruction | None¶: Returns the high level il instruction at the current location if one exists

property hlils: Iterator[HighLevelILInstruction]¶: Returns the high level il instructions at the current location if any exists

property llil: LowLevelILInstruction | None¶: Returns the low level il instruction at the current location if one exists

property llils: List[LowLevelILInstruction]¶: Returns the low level il instructions at the current location if any exists

property mlil: MediumLevelILInstruction | None¶: Returns the medium level il instruction at the current location if one exists

property mlils: Iterator[MediumLevelILInstruction]¶: Returns the medium level il instructions at the current location if any exists

Relocation¶

class Relocation[source]¶

Bases: object

__init__(handle: LP_BNRelocation)[source]¶

Parameters:: handle (LP_BNRelocation) –

property arch: Architecture | None¶: The architecture associated with the Relocation (read/write)

property info: RelocationInfo¶

property reloc: int¶: The actual pointer that needs to be relocated

property symbol: CoreSymbol | None¶

property target: int¶: Where the reloc needs to point to

RelocationInfo¶

class RelocationInfo[source]¶

Bases: object

RelocationInfo(info: binaryninja._binaryninjacore.BNRelocationInfo)

__init__(info: BNRelocationInfo)[source]¶

Parameters:: info (BNRelocationInfo) –

addend: int¶

address: int¶

base: int¶

base_relative: bool¶

data_relocation: bool¶

external: bool¶

has_sign: bool¶

implicit_addend: bool¶

native_type: int¶

pc_relative: bool¶

section_index: int¶

size: int¶

symbol_index: int¶

target: int¶

truncate_size: int¶

type: RelocationType¶

ResolvedRange¶

class ResolvedRange[source]¶

Bases: object

A computed, non-overlapping interval in the resolved address space.

Overlapping raw regions are split into disjoint intervals. Each ResolvedRange holds the regions that cover it, ordered by precedence, with the active region first. The active_region property returns the highest-precedence region.

__init__(start: int, length: int, regions: List[MemoryRegionInfo]) → None¶

Parameters:

start (int) –
length (int) –
regions (List[MemoryRegionInfo]) –

Return type:

None

property active_region: MemoryRegionInfo | None¶: The highest-priority region at this range, or None if empty.

property end: int¶

property flags: SegmentFlag¶: Flags of the active (highest-priority) region.

length: int¶

property name: str | None¶: Name of the active region, or None if empty.

regions: List[MemoryRegionInfo]¶

start: int¶

Section¶

class Section[source]¶

Bases: object

The Section object is returned during BinaryView creation and should not be directly instantiated.

__init__(handle: LP_BNSection)[source]¶

Parameters:: handle (LP_BNSection) –

classmethod serialize(image_base: int, name: str, start: int, length: int, semantics: SectionSemantics = SectionSemantics.DefaultSectionSemantics, type: str = '', align: int = 1, entry_size: int = 0, link: str = '', info_section: str = '', info_data: int = 0, auto_defined: bool = True, sections: str = '[]')[source]¶

Serialize section parameters into a JSON string. This is useful for generating a properly formatted section description as options when using load.

Parameters:

image_base (int) – The base address of the image.
name (str) – The name of the section.
start (int) – The start address of the section.
length (int) – The length of the section.
semantics (SectionSemantics) – The semantics of the section.
type (str) – The type of the section.
align (int) – The alignment of the section.
entry_size (int) – The entry size of the section.
link (str) – The linked section of the section.
info_section (str) – The info section of the section.
info_data (int) – The info data of the section.
auto_defined (bool) – Whether the section is auto-defined.
sections (str) – An optional, existing array of sections to append to.

Returns:

A JSON string representing the section.

Return type:

Deprecated since version 4.3.6653: Use SectionDescriptorList instead.

property align: int¶

property auto_defined: bool¶

property end: int¶

property entry_size: int¶

property info_data: int¶

property info_section: str¶

property length¶

property linked_section: str¶

property name: str¶

property section_info: SectionInfo¶: Returns a section info object representing this section.

property semantics: SectionSemantics¶

property start: int¶

property type: str¶

SectionDescriptorList¶

class SectionDescriptorList[source]¶

Bases: list

__init__(image_base: int)[source]¶

Initialize the SectionDescriptorList with a base image address.

Parameters:: image_base (int) – The base address of the image.

append(name: str, start: int, length: int, semantics: SectionSemantics = SectionSemantics.DefaultSectionSemantics, type: str = '', align: int = 1, entry_size: int = 0, link: str = '', info_section: str = '', info_data: int = 0, auto_defined: bool = True)[source]¶

Append a section descriptor to the list.

Parameters:

name (str) – The name of the section.
start (int) – The start address of the section.
length (int) – The length of the section.
semantics (SectionSemantics) – The semantics of the section.
type (str) – The type of the section.
align (int) – The alignment of the section.
entry_size (int) – The size of each entry in the section.
link (str) – An optional link field.
info_section (str) – An optional info_section field.
info_data (int) – An optional info_data field.
auto_defined (bool) – Whether the section is auto-defined.

SectionInfo¶

class SectionInfo[source]¶

Bases: object

SectionInfo is a helper class for describing sections to be added to a BinaryView. See BinaryView.add_auto_sections and BinaryView.add_auto_section for more details or see class Section for accessing section information from an existing BinaryView.

__init__(name: str, start: int, length: int, semantics: SectionSemantics, type: str, align: int, entry_size: int, linked_section: str, info_section: str, info_data: int) → None¶

Parameters:

name (str) –
start (int) –
length (int) –
semantics (SectionSemantics) –
type (str) –
align (int) –
entry_size (int) –
linked_section (str) –
info_section (str) –
info_data (int) –

Return type:

None

align: int¶

entry_size: int¶

info_data: int¶

info_section: str¶

length: int¶

linked_section: str¶

name: str¶

semantics: SectionSemantics¶

start: int¶

type: str¶

Segment¶

class Segment[source]¶

Bases: object

The Segment object is returned during BinaryView creation and should not be directly instantiated.

__init__(handle: LP_BNSegment)[source]¶

Parameters:: handle (LP_BNSegment) –

classmethod serialize(image_base: int, start: int, length: int, data_offset: int = 0, data_length: int = 0, flags: SegmentFlag = SegmentFlag.SegmentReadable, auto_defined=True, segments: str = '[]')[source]¶

Serialize segment parameters into a JSON string. This is useful for generating a properly formatted segment description as options when using load.

Parameters:

image_base (int) – The base address of the image.
start (int) – The start address of the segment.
length (int) – The length of the segment.
data_offset (int) – The offset of the data within the segment.
data_length (int) – The length of the data within the segment.
flags (SegmentFlag) – The flags of the segment.
auto_defined (bool) – Whether the segment is auto-defined.
segments (str) – An optional, existing array of segments to append to.

Returns:

A JSON string representing the segment.

Return type:

Example::

>>> base = 0x400000
>>> rom_base = 0xffff0000
>>> segments = SegmentDescriptorList(base)
>>> segments.append(start=base, length=0x1000, data_offset=0, data_length=0x1000, flags=SegmentFlag.SegmentReadable|SegmentFlag.SegmentExecutable)
>>> segments.append(start=rom_base, length=0x1000, flags=SegmentFlag.SegmentReadable)
>>> view = load(bytes.fromhex('5054ebfe'), options={'loader.imageBase': base, 'loader.platform': 'x86', 'loader.segments': json.dumps(segments)})

Deprecated since version 4.3.6653: Use SegmentDescriptorList instead.

property auto_defined: bool¶

property data_end: int¶

property data_length: int¶

property data_offset: int¶

property end: int¶

property executable: bool¶

property length¶

property readable: bool¶

property segment_info: SegmentInfo¶

property start: int¶

property writable: bool¶

SegmentDescriptorList¶

class SegmentDescriptorList[source]¶

Bases: list

__init__(image_base: int)[source]¶

Initialize the SegmentDescriptorList with a base image address.

Parameters:: image_base (int) – The base address of the image.

append(start: int, length: int, data_offset: int = 0, data_length: int = 0, flags: SegmentFlag = SegmentFlag.SegmentReadable, auto_defined: bool = True)[source]¶

Append a segment descriptor to the list.

Parameters:

start (int) – The start address of the segment.
length (int) – The length of the segment.
data_offset (int) – The offset of the data within the segment.
data_length (int) – The length of the data within the segment.
flags (SegmentFlag) – The flags of the segment.
auto_defined (bool) – Whether the segment is auto-defined.

SegmentInfo¶

class SegmentInfo[source]¶

Bases: object

This class helper class holds Segment information used to describe segments when creating a BinaryView. See BinaryView.add_auto_segments and BinaryView.add_user_segments for usage. See class Segment for segment information retrieval from an existing BinaryView.

__init__(start: int, length: int, data_offset: int, data_length: int, flags: SegmentFlag) → None¶

Parameters:

start (int) –
length (int) –
data_offset (int) –
data_length (int) –
flags (SegmentFlag) –

Return type:

None

data_length: int¶

data_offset: int¶

flags: SegmentFlag¶

length: int¶

start: int¶

StringRef¶

class StringRef[source]¶

Bases: object

Deduplicated reference to a string owned by the Binary Ninja core. Use str or bytes to convert this to a standard Python string or sequence of bytes.

__init__(handle)[source]¶

StringReference¶

class StringReference[source]¶

Bases: object

__init__(bv: BinaryView, string_type: StringType, start: int, length: int)[source]¶

Parameters:

bv (BinaryView) –
string_type (StringType) –
start (int) –
length (int) –

property length: int¶

property raw: bytes¶

property start: int¶

property type: StringType¶

property value: str¶

property view: BinaryView¶

StructuredDataValue¶

class StructuredDataValue[source]¶

Bases: object

StructuredDataValue()

address: int¶

endian: Endianness¶

property int: int¶

property str: str¶

type: Type¶

value: bytes¶

property width: int¶

SymbolMapping¶

class SymbolMapping[source]¶

Bases: Mapping

SymbolMapping object is used to improve performance of the bv.symbols API. This allows pythonic code like this to have reasonable performance characteristics

>>> my_symbols = get_my_symbols()
>>> for symbol in my_symbols:
>>>  if bv.symbols[symbol].address == 0x41414141:
>>>    print("Found")

__init__(view: BinaryView)[source]¶

Parameters:: view (BinaryView) –

get(k[, d]) → D[k] if k in D, else d. d defaults to None.[source]¶

Parameters:

key (str) –
default (List[CoreSymbol] | None) –

Return type:

List[CoreSymbol] | None

items() → a set-like object providing a view on D's items[source]¶

Return type:: ItemsView[str, List[CoreSymbol]]

keys() → a set-like object providing a view on D's keys[source]¶

Return type:: KeysView[str]

values() → an object providing a view on D's values[source]¶

Return type:: ValuesView[List[CoreSymbol]]

Tag¶

class Tag[source]¶

Bases: object

The Tag object is created by other APIs (create_*_tag) and should not be directly instantiated.

__init__(handle: LP_BNTag)[source]¶

Parameters:: handle (LP_BNTag) –

property data: str¶

property id: str¶

property type: TagType¶

TagType¶

class TagType[source]¶

Bases: object

The TagType object is created by the create_tag_type API and should not be directly instantiated.

__init__(handle: LP_BNTagType)[source]¶

Parameters:: handle (LP_BNTagType) –

property icon: str¶: Unicode str containing an emoji to be used as an icon

property id: str¶: Unique id of the TagType

property name: str¶: Name of the TagType

property type: TagTypeType¶: Type from enums.TagTypeType

property visible: bool¶: Boolean for whether the tags of this type are visible

TypeMapping¶

class TypeMapping[source]¶

Bases: Mapping

TypeMapping object is used to improve performance of the bv.types API. This allows pythonic code like this to have reasonable performance characteristics

>>> my_types = get_my_types()
>>> for type_name in my_types:
>>>  if bv.types[type_name].width == 4:
>>>    print("Found")

__init__(view: ~binaryninja.binaryview.BinaryView, get_list_fn=<function BNGetAnalysisTypeList>)[source]¶

Parameters:: view (BinaryView) –

get(k[, d]) → D[k] if k in D, else d. d defaults to None.[source]¶

items() → a set-like object providing a view on D's items[source]¶

keys() → a set-like object providing a view on D's keys[source]¶

values() → an object providing a view on D's values[source]¶

TypedDataAccessor¶

class TypedDataAccessor[source]¶

Bases: object

TypedDataAccessor(type: ‘_types.Type’, address: int, view: ‘BinaryView’, endian: binaryninja.enums.Endianness)

__init__(type: Type, address: int, view: BinaryView, endian: Endianness) → None¶

Parameters:

type (Type) –
address (int) –
view (BinaryView) –
endian (Endianness) –

Return type:

None

as_uuid(ms_format: bool = True) → UUID[source]¶

Converts the object to a UUID object using Microsoft byte ordering.

Parameters:: ms_format (bool) – Flag indicating whether to use Microsoft byte ordering. Default is True.
Returns:: The UUID object representing the byte array.
Return type:: UUID
Raises:: ValueError – If the byte array representation of this data is not exactly 16 bytes long.

static byte_order(endian) → str[source]¶

Return type:: str

static int_from_bytes(data: bytes, width: int, sign: bool, endian: Endianness | None = None) → int[source]¶

Parameters:

data (bytes) –
width (int) –
sign (bool) –
endian (Endianness | None) –

Return type: