Binary Ninja Python API Documentation¶
- architecture
- atexit
- basicblock
- binaryview
- binaryninja.binaryview.ActiveAnalysisInfo
- binaryninja.binaryview.AddressRange
- binaryninja.binaryview.AnalysisCompletionEvent
- binaryninja.binaryview.AnalysisInfo
- binaryninja.binaryview.AnalysisProgress
- binaryninja.binaryview.BinaryDataNotification
- binaryninja.binaryview.BinaryDataNotificationCallbacks
- binaryninja.binaryview.BinaryReader
- binaryninja.binaryview.BinaryView
- binaryninja.binaryview.BinaryViewType
- binaryninja.binaryview.BinaryWriter
- binaryninja.binaryview.DataVariable
- binaryninja.binaryview.OrderedDict
- binaryninja.binaryview.Section
- binaryninja.binaryview.Segment
- binaryninja.binaryview.StringReference
- binaryninja.binaryview.StructuredDataValue
- binaryninja.binaryview.StructuredDataView
- binaryninja.binaryview.range
- binaryninja.binaryview.with_metaclass
- callingconvention
- databuffer
- datarender
- demangle
- downloadprovider
- binaryninja.downloadprovider.DownloadInstance
- binaryninja.downloadprovider.DownloadProvider
- binaryninja.downloadprovider.ProxyHandler
- binaryninja.downloadprovider.PythonDownloadInstance
- binaryninja.downloadprovider.PythonDownloadProvider
- binaryninja.downloadprovider.Settings
- binaryninja.downloadprovider.URLError
- binaryninja.downloadprovider.build_opener
- binaryninja.downloadprovider.install_opener
- binaryninja.downloadprovider.pyNativeStr
- binaryninja.downloadprovider.range
- binaryninja.downloadprovider.urlopen
- binaryninja.downloadprovider.with_metaclass
- enums
- binaryninja.enums.ActionType
- binaryninja.enums.AnalysisSkipReason
- binaryninja.enums.AnalysisState
- binaryninja.enums.BranchType
- binaryninja.enums.CallingConventionName
- binaryninja.enums.DisassemblyOption
- binaryninja.enums.Endianness
- binaryninja.enums.FindFlag
- binaryninja.enums.FlagRole
- binaryninja.enums.FormInputFieldType
- binaryninja.enums.FunctionAnalysisSkipOverride
- binaryninja.enums.FunctionGraphType
- binaryninja.enums.HighlightColorStyle
- binaryninja.enums.HighlightStandardColor
- binaryninja.enums.ILBranchDependence
- binaryninja.enums.ImplicitRegisterExtend
- binaryninja.enums.InstructionTextTokenContext
- binaryninja.enums.InstructionTextTokenType
- binaryninja.enums.IntegerDisplayType
- binaryninja.enums.LinearDisassemblyLineType
- binaryninja.enums.LogLevel
- binaryninja.enums.LowLevelILFlagCondition
- binaryninja.enums.LowLevelILOperation
- binaryninja.enums.MediumLevelILOperation
- binaryninja.enums.MemberAccess
- binaryninja.enums.MemberScope
- binaryninja.enums.MessageBoxButtonResult
- binaryninja.enums.MessageBoxButtonSet
- binaryninja.enums.MessageBoxIcon
- binaryninja.enums.MetadataType
- binaryninja.enums.ModificationStatus
- binaryninja.enums.NameType
- binaryninja.enums.NamedTypeReferenceClass
- binaryninja.enums.PluginCommandType
- binaryninja.enums.PluginLoadOrder
- binaryninja.enums.PluginOrigin
- binaryninja.enums.PluginType
- binaryninja.enums.PluginUpdateStatus
- binaryninja.enums.PointerSuffix
- binaryninja.enums.ReferenceType
- binaryninja.enums.RegisterValueType
- binaryninja.enums.RelocationType
- binaryninja.enums.ReportType
- binaryninja.enums.ScriptingProviderExecuteResult
- binaryninja.enums.ScriptingProviderInputReadyState
- binaryninja.enums.SectionSemantics
- binaryninja.enums.SegmentFlag
- binaryninja.enums.SettingsScope
- binaryninja.enums.StringType
- binaryninja.enums.StructureType
- binaryninja.enums.SymbolBinding
- binaryninja.enums.SymbolType
- binaryninja.enums.TransformType
- binaryninja.enums.TypeClass
- binaryninja.enums.UpdateResult
- binaryninja.enums.VariableSourceType
- fileaccessor
- filemetadata
- flowgraph
- function
- binaryninja.function.AdvancedFunctionAnalysisDataRequestor
- binaryninja.function.ConstantReference
- binaryninja.function.DisassemblySettings
- binaryninja.function.DisassemblyTextLine
- binaryninja.function.DisassemblyTextRenderer
- binaryninja.function.Function
- binaryninja.function.IndirectBranchInfo
- binaryninja.function.InstructionBranch
- binaryninja.function.InstructionInfo
- binaryninja.function.InstructionTextToken
- binaryninja.function.IntrinsicInfo
- binaryninja.function.IntrinsicInput
- binaryninja.function.LookupTableEntry
- binaryninja.function.ParameterVariables
- binaryninja.function.PossibleValueSet
- binaryninja.function.RegisterInfo
- binaryninja.function.RegisterStackInfo
- binaryninja.function.RegisterValue
- binaryninja.function.StackVariableReference
- binaryninja.function.ValueRange
- binaryninja.function.Variable
- binaryninja.function.range
- functionrecognizer
- highlight
- interaction
- binaryninja.interaction.AddressField
- binaryninja.interaction.ChoiceField
- binaryninja.interaction.DirectoryNameField
- binaryninja.interaction.FlowGraphReport
- binaryninja.interaction.HTMLReport
- binaryninja.interaction.IntegerField
- binaryninja.interaction.InteractionHandler
- binaryninja.interaction.LabelField
- binaryninja.interaction.MarkdownReport
- binaryninja.interaction.MultilineTextField
- binaryninja.interaction.OpenFileNameField
- binaryninja.interaction.PlainTextReport
- binaryninja.interaction.ReportCollection
- binaryninja.interaction.SaveFileNameField
- binaryninja.interaction.SeparatorField
- binaryninja.interaction.TextLineField
- binaryninja.interaction.get_address_input
- binaryninja.interaction.get_choice_input
- binaryninja.interaction.get_directory_name_input
- binaryninja.interaction.get_form_input
- binaryninja.interaction.get_int_input
- binaryninja.interaction.get_open_filename_input
- binaryninja.interaction.get_save_filename_input
- binaryninja.interaction.get_text_line_input
- binaryninja.interaction.markdown_to_html
- binaryninja.interaction.range
- binaryninja.interaction.show_graph_report
- binaryninja.interaction.show_html_report
- binaryninja.interaction.show_markdown_report
- binaryninja.interaction.show_message_box
- binaryninja.interaction.show_plain_text_report
- binaryninja.interaction.show_report_collection
- lineardisassembly
- log
- binaryninja.log.close_logs
- binaryninja.log.is_output_redirected_to_log
- binaryninja.log.log
- binaryninja.log.log_alert
- binaryninja.log.log_debug
- binaryninja.log.log_error
- binaryninja.log.log_info
- binaryninja.log.log_to_file
- binaryninja.log.log_to_stderr
- binaryninja.log.log_to_stdout
- binaryninja.log.log_warn
- binaryninja.log.redirect_output_to_log
- lowlevelil
- binaryninja.lowlevelil.ILFlag
- binaryninja.lowlevelil.ILIntrinsic
- binaryninja.lowlevelil.ILRegister
- binaryninja.lowlevelil.ILRegisterStack
- binaryninja.lowlevelil.ILSemanticFlagClass
- binaryninja.lowlevelil.ILSemanticFlagGroup
- binaryninja.lowlevelil.LowLevelILBasicBlock
- binaryninja.lowlevelil.LowLevelILExpr
- binaryninja.lowlevelil.LowLevelILFunction
- binaryninja.lowlevelil.LowLevelILInstruction
- binaryninja.lowlevelil.LowLevelILLabel
- binaryninja.lowlevelil.LowLevelILOperationAndSize
- binaryninja.lowlevelil.SSAFlag
- binaryninja.lowlevelil.SSARegister
- binaryninja.lowlevelil.SSARegisterOrFlag
- binaryninja.lowlevelil.SSARegisterStack
- binaryninja.lowlevelil.LLIL_GET_TEMP_REG_INDEX
- binaryninja.lowlevelil.LLIL_REG_IS_TEMP
- binaryninja.lowlevelil.LLIL_TEMP
- binaryninja.lowlevelil.range
- mainthread
- binaryninja.mainthread.execute_on_main_thread
- binaryninja.mainthread.execute_on_main_thread_and_wait
- binaryninja.mainthread.get_worker_thread_count
- binaryninja.mainthread.set_worker_thread_count
- binaryninja.mainthread.worker_enqueue
- binaryninja.mainthread.worker_interactive_enqueue
- binaryninja.mainthread.worker_priority_enqueue
- mediumlevelil
- binaryninja.mediumlevelil.MediumLevelILBasicBlock
- binaryninja.mediumlevelil.MediumLevelILExpr
- binaryninja.mediumlevelil.MediumLevelILFunction
- binaryninja.mediumlevelil.MediumLevelILInstruction
- binaryninja.mediumlevelil.MediumLevelILLabel
- binaryninja.mediumlevelil.MediumLevelILOperationAndSize
- binaryninja.mediumlevelil.SSAVariable
- binaryninja.mediumlevelil.range
- metadata
- numbers
- platform
- plugin
- pluginmanager
- scriptingprovider
- binaryninja.scriptingprovider.PythonScriptingInstance
- binaryninja.scriptingprovider.PythonScriptingProvider
- binaryninja.scriptingprovider.ScriptingInstance
- binaryninja.scriptingprovider.ScriptingOutputListener
- binaryninja.scriptingprovider.ScriptingProvider
- binaryninja.scriptingprovider.range
- binaryninja.scriptingprovider.redirect_stdio
- binaryninja.scriptingprovider.with_metaclass
- settings
- transform
- types
- binaryninja.types.BoolWithConfidence
- binaryninja.types.Enumeration
- binaryninja.types.EnumerationMember
- binaryninja.types.FunctionParameter
- binaryninja.types.NameSpace
- binaryninja.types.NamedTypeReference
- binaryninja.types.QualifiedName
- binaryninja.types.ReferenceTypeWithConfidence
- binaryninja.types.RegisterSet
- binaryninja.types.RegisterStackAdjustmentWithConfidence
- binaryninja.types.SizeWithConfidence
- binaryninja.types.Structure
- binaryninja.types.StructureMember
- binaryninja.types.Symbol
- binaryninja.types.Type
- binaryninja.types.TypeParserResult
- binaryninja.types.preprocess_source
- binaryninja.types.pyNativeStr
- binaryninja.types.range
- undoaction
- update
- binaryninja.update.UpdateChannel
- binaryninja.update.UpdateProgressCallback
- binaryninja.update.UpdateVersion
- binaryninja.update.are_auto_updates_enabled
- binaryninja.update.get_time_since_last_update_check
- binaryninja.update.install_pending_update
- binaryninja.update.is_update_installation_pending
- binaryninja.update.range
- binaryninja.update.set_auto_updates_enabled
- binaryninja.update.updates_checked
- binaryninja.update.with_metaclass
-
class
PluginManagerLoadPluginCallback
[source]¶ Bases:
object
Callback for BNLoadPluginForApi(“python2”, …), dynamically loads python plugins.
-
bundled_plugin_path
()[source]¶ bundled_plugin_path
returns a string containing the current plugin path inside the install pathReturns: current bundled plugin path Return type: str, or None on failure
-
core_build_id
()[source]¶ core_build_id
returns a string containing the current build idReturns: current build id Return type: str, or None on failure
-
core_serial
()[source]¶ core_serial
returns a string containing the current serial numberReturns: current serial Return type: str, or None on failure
-
core_version
()[source]¶ core_version
returns a string containing the current versionReturns: current version Return type: str, or None on failure
-
get_install_directory
()[source]¶ get_install_directory
returns a string pointing to the installed binary currently running..warning:: ONLY for use within the Binary Ninja UI, behavior is undefined and unreliable if run headlessly
-
shutdown
()[source]¶ shutdown
cleanly shuts down the core, stopping all workers and closing all log files.
-
user_plugin_path
()[source]¶ user_plugin_path
returns a string containing the current plugin path inside the user directoryReturns: current user plugin path Return type: str, or None on failure