# binaryninja module

`binaryninja.binaryninja.ActiveAnalysisInfo`(...) |
`binaryninja.binaryninja.AddressField`(prompt) | `AddressField` prompts the user for an address. By passing the optional view and current_address parameters
`binaryninja.binaryninja.AddressRange`(start, end) |
`binaryninja.binaryninja.AdvancedFunctionAnalysisDataRequestor`([func]) |
`binaryninja.binaryninja.AnalysisCompletionEvent`(...) | The `AnalysisCompletionEvent` object provides an asynchronous mechanism for receiving callbacks when analysis is complete.
`binaryninja.binaryninja.AnalysisInfo`(state, ...) |
`binaryninja.binaryninja.AnalysisProgress`(...) |
`binaryninja.binaryninja.Architecture`() | `class Architecture` is the parent class for all CPU architectures. Subclasses of Architecture implement assembly,
`binaryninja.binaryninja.ArchitectureHook`(...) |
`binaryninja.binaryninja.BackgroundTask`([...]) |
`binaryninja.binaryninja.BackgroundTaskThread`([...]) |
`binaryninja.binaryninja.BasicBlock`(view, handle) |
`binaryninja.binaryninja.BasicBlockEdge`(...) |
`binaryninja.binaryninja.BinaryDataNotification`() |
`binaryninja.binaryninja.BinaryDataNotificationCallbacks`(...) |
`binaryninja.binaryninja.BinaryReader`(view[, ...]) | `class BinaryReader` is a convenience class for reading binary data.
`binaryninja.binaryninja.BinaryView`([...]) | `class BinaryView` implements a view on binary data, and presents a queryable interface of a binary file. One key
`binaryninja.binaryninja.BinaryViewType`(handle) |
`binaryninja.binaryninja.BinaryWriter`(view[, ...]) | `class BinaryWriter` is a convenience class for writing binary data.
`binaryninja.binaryninja.BoolWithConfidence`(value) |
`binaryninja.binaryninja.CallingConvention`([...]) |
`binaryninja.binaryninja.ChoiceField`(prompt, ...) | `ChoiceField` prompts the user to choose from the list of strings provided in `choices`. Result is stored
`binaryninja.binaryninja.ConstantReference`(...) |
`binaryninja.binaryninja.CoreArchitecture`(handle) |
`binaryninja.binaryninja.CoreFileAccessor`(...) |
`binaryninja.binaryninja.DataBuffer`([...]) |
`binaryninja.binaryninja.DataVariable`(addr, ...) |
`binaryninja.binaryninja.DirectoryNameField`(prompt) | `DirectoryNameField` prompts the user to specify a directory name to open. Result is stored in self.result as
`binaryninja.binaryninja.DisassemblySettings`([...]) |
`binaryninja.binaryninja.DisassemblyTextLine`(...) |
`binaryninja.binaryninja.DownloadInstance`(...) |
`binaryninja.binaryninja.DownloadProvider`([...]) |
`binaryninja.binaryninja.Enumeration`([handle]) |
`binaryninja.binaryninja.EnumerationMember`(...) |
`binaryninja.binaryninja.FileAccessor`() |
`binaryninja.binaryninja.FileMetadata`([...]) | `class FileMetadata` represents the file being analyzed by Binary Ninja. It is responsible for opening,
`binaryninja.binaryninja.Function`(view, handle) |
`binaryninja.binaryninja.FunctionGraph`(view, ...) |
`binaryninja.binaryninja.FunctionGraphBlock`(...) |
`binaryninja.binaryninja.FunctionGraphEdge`(...) |
`binaryninja.binaryninja.FunctionParameter`(...) |
`binaryninja.binaryninja.FunctionRecognizer`() |
`binaryninja.binaryninja.HighlightColor`([...]) |
`binaryninja.binaryninja.ILFlag`(arch, flag) |
`binaryninja.binaryninja.ILIntrinsic`(arch, ...) |
`binaryninja.binaryninja.ILRegister`(arch, reg) |
`binaryninja.binaryninja.ILRegisterStack`(...) |
`binaryninja.binaryninja.ILSemanticFlagClass`(...) |
`binaryninja.binaryninja.ILSemanticFlagGroup`(...) |
`binaryninja.binaryninja.IndirectBranchInfo`(...) |
`binaryninja.binaryninja.InstructionBranch`(...) |
`binaryninja.binaryninja.InstructionInfo`() |
`binaryninja.binaryninja.InstructionTextToken`(...) | `class InstructionTextToken` is used to tell the core about the various components in the disassembly views.
`binaryninja.binaryninja.IntegerField`(prompt) | `IntegerField` add prompt for integer. Result is stored in self.result as an int.
`binaryninja.binaryninja.InteractionHandler`() |
`binaryninja.binaryninja.IntrinsicInfo`(...[, ...]) |
`binaryninja.binaryninja.IntrinsicInput`(type_obj) |
`binaryninja.binaryninja.LabelField`(text) | `LabelField` adds a text label to the display.
`binaryninja.binaryninja.LinearDisassemblyLine`(...) |
`binaryninja.binaryninja.LinearDisassemblyPosition`(...) | `class LinearDisassemblyPosition` is a helper object containing the position of the current Linear Disassembly.
`binaryninja.binaryninja.LookupTableEntry`(...) |
`binaryninja.binaryninja.LowLevelILBasicBlock`(...) |
`binaryninja.binaryninja.LowLevelILExpr`(index) | `class LowLevelILExpr` hold the index of IL Expressions.
`binaryninja.binaryninja.LowLevelILFunction`(arch) | `class LowLevelILFunction` contains the list of LowLevelILExpr objects that make up a binaryninja.function. LowLevelILExpr
`binaryninja.binaryninja.LowLevelILInstruction`(...) | `class LowLevelILInstruction` Low Level Intermediate Language Instructions are infinite length tree-based
`binaryninja.binaryninja.LowLevelILLabel`([handle]) |
`binaryninja.binaryninja.LowLevelILOperationAndSize`(...) |
`binaryninja.binaryninja.MainThreadAction`(handle) |
`binaryninja.binaryninja.MainThreadActionHandler`() |
`binaryninja.binaryninja.MediumLevelILBasicBlock`(...) |
`binaryninja.binaryninja.MediumLevelILExpr`(index) | `class MediumLevelILExpr` hold the index of IL Expressions.
`binaryninja.binaryninja.MediumLevelILFunction`(arch) | `class MediumLevelILFunction` contains the list of MediumLevelILExpr objects that make up a binaryninja.function. MediumLevelILExpr
`binaryninja.binaryninja.MediumLevelILInstruction`(...) | `class MediumLevelILInstruction` Medium Level Intermediate Language Instructions are infinite length tree-based
`binaryninja.binaryninja.MediumLevelILLabel`([...]) |
`binaryninja.binaryninja.MediumLevelILOperationAndSize`(...) |
`binaryninja.binaryninja.Metadata`([value, ...]) |
`binaryninja.binaryninja.MultilineTextField`(prompt) | `MultilineTextField` add multi-line text string input field. Result is stored in self.result
`binaryninja.binaryninja.NamedTypeReference`([...]) |
`binaryninja.binaryninja.NavigationHandler` |
`binaryninja.binaryninja.OpenFileNameField`(prompt) | `OpenFileNameField` prompts the user to specify a file name to open. Result is stored in self.result as a string.
`binaryninja.binaryninja.ParameterVariables`(...) |
`binaryninja.binaryninja.Platform`(arch[, handle]) | `class Platform` contains all information releated to the execution environment of the binary, mainly the
`binaryninja.binaryninja.PluginCommand`(cmd) |
`binaryninja.binaryninja.PluginCommandContext`(view) |
`binaryninja.binaryninja.PluginManagerLoadPluginCallback`() | Callback for BNLoadPluginForApi(“python2”, ...), dynamicly loads python plugins.
`binaryninja.binaryninja.PossibleValueSet`(...) |
`binaryninja.binaryninja.PythonDownloadInstance`(...) |
`binaryninja.binaryninja.PythonDownloadProvider`([...]) |
`binaryninja.binaryninja.PythonScriptingInstance`(...) |
`binaryninja.binaryninja.PythonScriptingProvider`([...]) |
`binaryninja.binaryninja.QualifiedName`([name]) |
`binaryninja.binaryninja.ReferenceSource`(...) |
`binaryninja.binaryninja.ReferenceTypeWithConfidence`(value) |
`binaryninja.binaryninja.RegisterInfo`(...[, ...]) |
`binaryninja.binaryninja.RegisterSet`(reg_list) |
`binaryninja.binaryninja.RegisterStackAdjustmentWithConfidence`(value) |
`binaryninja.binaryninja.RegisterStackInfo`(...) |
`binaryninja.binaryninja.RegisterValue`([...]) |
`binaryninja.binaryninja.RepoPlugin`(handle) | ``RepoPlugin` is mostly read-only, however you can install/uninstall enable/disable plugins. RepoPlugins are
`binaryninja.binaryninja.Repository`(handle) | `Repository` is a read-only class. Use RepositoryManager to Enable/Disable/Install/Uninstall plugins.
`binaryninja.binaryninja.RepositoryManager`([...]) | `RepositoryManager` Keeps track of all the repositories and keeps the enabled_plugins.json file coherent with
`binaryninja.binaryninja.SSAFlag`(flag, version) |
`binaryninja.binaryninja.SSARegister`(reg, version) |
`binaryninja.binaryninja.SSARegisterOrFlag`(...) |
`binaryninja.binaryninja.SSARegisterStack`(...) |
`binaryninja.binaryninja.SSAVariable`(var, version) |
`binaryninja.binaryninja.SaveFileNameField`(prompt) | `SaveFileNameField` prompts the user to specify a file name to save. Result is stored in self.result as a string.
`binaryninja.binaryninja.ScriptingInstance`(...) |
`binaryninja.binaryninja.ScriptingOutputListener` |
`binaryninja.binaryninja.ScriptingProvider`([...]) |
`binaryninja.binaryninja.Section`(name, ...) |
`binaryninja.binaryninja.Segment`(start, ...) |
`binaryninja.binaryninja.SeparatorField` | `SeparatorField` adds vertical separation to the display.
`binaryninja.binaryninja.Setting`([plugin_name]) |
`binaryninja.binaryninja.SizeWithConfidence`(value) |
`binaryninja.binaryninja.StackVariableReference`(...) |
`binaryninja.binaryninja.StringReference`(bv, ...) |
`binaryninja.binaryninja.Structure`([handle]) |
`binaryninja.binaryninja.StructureMember`(t, ...) |
`binaryninja.binaryninja.Symbol`(sym_type, ...) | Symbols are defined as one of the following types:
`binaryninja.binaryninja.TextLineField`(prompt) | `TextLineField` Adds prompt for text string input. Result is stored in self.result as a string on completion.
`binaryninja.binaryninja.Transform`(handle) |
`binaryninja.binaryninja.TransformParameter`(name) |
`binaryninja.binaryninja.Type`(handle[, ...]) |
`binaryninja.binaryninja.TypeParserResult`(...) |
`binaryninja.binaryninja.UndoAction`(view) |
`binaryninja.binaryninja.UpdateChannel`(name, ...) |
`binaryninja.binaryninja.UpdateProgressCallback`(func) |
`binaryninja.binaryninja.UpdateVersion`(...) |
`binaryninja.binaryninja.ValueRange`(start, ...) |
`binaryninja.binaryninja.Variable`(func, ...) |
`binaryninja.binaryninja.LLIL_GET_TEMP_REG_INDEX`(n) |
`binaryninja.binaryninja.LLIL_REG_IS_TEMP`(n) |
`binaryninja.binaryninja.LLIL_TEMP`(n) |
`binaryninja.binaryninja.are_auto_updates_enabled`() | `are_auto_updates_enabled` queries if auto updates are enabled.
`binaryninja.binaryninja.close_logs`() | `close_logs` close all log files.
`binaryninja.binaryninja.cstr`(arg) |
`binaryninja.binaryninja.demangle_gnu3`(arch, ...) |
`binaryninja.binaryninja.demangle_ms`(arch, ...) | `demangle_ms` demangles a mangled Microsoft Visual Studio C++ name to a Type object.
`binaryninja.binaryninja.escape_string`(text) |
`binaryninja.binaryninja.execute_on_main_thread`(func) |
`binaryninja.binaryninja.execute_on_main_thread_and_wait`(func) |
`binaryninja.binaryninja.get_address_input`(...) | `get_address_input` prompts the user for an address with the given prompt and title.
`binaryninja.binaryninja.get_choice_input`(...) | `get_choice_input` prompts the user to select the one of the provided choices.
`binaryninja.binaryninja.get_directory_name_input`(prompt) | `get_directory_name_input` prompts the user for a directory name to save as, optionally providing a default_name.
`binaryninja.binaryninja.get_form_input`(...) | `get_from_input` Prompts the user for a set of inputs specified in `fields` with given title.
`binaryninja.binaryninja.get_install_directory`() | `get_install_directory` returns a string pointing to the installed binary currently running
`binaryninja.binaryninja.get_int_input`(...) | `get_int_input` prompts the user to input a integer with the given prompt and title.
`binaryninja.binaryninja.get_open_filename_input`(prompt) | `get_open_filename_input` prompts the user for a file name to open.
`binaryninja.binaryninja.get_qualified_name`(names) | `get_qualified_name` gets a qualified name for the provied name list.
`binaryninja.binaryninja.get_save_filename_input`(prompt) | `get_save_filename_input` prompts the user for a file name to save as, optionally providing a file extension and
`binaryninja.binaryninja.get_text_line_input`(...) | `get_text_line_input` prompts the user to input a string with the given prompt and title.
`binaryninja.binaryninja.get_time_since_last_update_check`() | `get_time_since_last_update_check` returns the time stamp for the last time updates were checked.
`binaryninja.binaryninja.get_unique_identifier`() |
`binaryninja.binaryninja.get_worker_thread_count`() |
`binaryninja.binaryninja.install_pending_update`() | `install_pending_update` installs any pending updates
`binaryninja.binaryninja.is_output_redirected_to_log`() |
`binaryninja.binaryninja.is_update_installation_pending`() | `is_update_installation_pending` whether an update has been downloaded and is waiting installation
`binaryninja.binaryninja.log_alert`(text) | `log_alert` Logs message console and to a pop up window if run through the GUI.
`binaryninja.binaryninja.log_debug`(text) | `log_debug` Logs debuging information messages to the console.
`binaryninja.binaryninja.log_error`(text) | `log_error` Logs message to console, if run through the GUI it logs with Error icon, focusing the error console.
`binaryninja.binaryninja.log_info`(text) | `log_info` Logs general information messages to the console.
`binaryninja.binaryninja.log_to_file`(...[, ...]) | `log_to_file` redirects minimum log level to a file named `path`, optionally appending rather than overwritting.
`binaryninja.binaryninja.log_to_stderr`(min_level) | `log_to_stderr` redirects minimum log level to standard error.
`binaryninja.binaryninja.log_to_stdout`([...]) | `log_to_stdout` redirects minimum log level to standard out.
`binaryninja.binaryninja.log_warn`(text) | `log_warn` Logs message to console, if run through the GUI it logs with Warning icon.
`binaryninja.binaryninja.markdown_to_html`(...) | `markdown_to_html` converts the provided markdown to HTML.
`binaryninja.binaryninja.preprocess_source`(source) | `preprocess_source` run the C preprocessor on the given source or source filename.
`binaryninja.binaryninja.pyNativeStr`(arg) |
`binaryninja.binaryninja.range`(*args) | A Python2 and Python3 Compatible Range Generator
`binaryninja.binaryninja.redirect_output_to_log`() |
`binaryninja.binaryninja.redirect_stdio`() |
`binaryninja.binaryninja.set_auto_updates_enabled`(enabled) | `set_auto_updates_enabled` sets auto update enabled status.
`binaryninja.binaryninja.set_worker_thread_count`(count) |
`binaryninja.binaryninja.show_html_report`(...) | `show_html_report` displays the html contents in UI applications and plaintext in command line
`binaryninja.binaryninja.show_markdown_report`(...) | `show_markdown_report` displays the markdown contents in UI applications and plaintext in command line
`binaryninja.binaryninja.show_message_box`(...) | `show_message_box` Displays a configurable message box in the UI, or prompts on the console as appropriate
`binaryninja.binaryninja.show_plain_text_report`(...) | `show_plain_text_report` displays contents to the user in the UI or on the command line.
`binaryninja.binaryninja.shutdown`() | `shutdown` cleanly shuts down the core, stopping all workers and closing all log files.
`binaryninja.binaryninja.unescape_string`(text) |
`binaryninja.binaryninja.updates_checked`() |
`binaryninja.binaryninja.with_metaclass`(meta, ...) | Create a base class with a metaclass.
`binaryninja.binaryninja.worker_enqueue`(func) |
`binaryninja.binaryninja.worker_interactive_enqueue`(func) |
`binaryninja.binaryninja.worker_priority_enqueue`(func) |