945 lines
80 KiB
HTML
945 lines
80 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>binaryninja.datarender.BinaryView — Binary Ninja API Documentation v1.1</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index"
|
|||
|
|
href="genindex.html"/>
|
|||
|
|
<link rel="search" title="Search" href="search.html"/>
|
|||
|
|
<link rel="top" title="Binary Ninja API Documentation v1.1" href="index.html"/>
|
|||
|
|
<link rel="up" title="datarender module" href="binaryninja.datarender-module.html"/>
|
|||
|
|
<link rel="next" title="binaryninja.datarender.DataRenderer" href="binaryninja.datarender.DataRenderer.html"/>
|
|||
|
|
<link rel="prev" title="datarender module" href="binaryninja.datarender-module.html"/>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav" role="document">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home"> Binary Ninja API
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
<script>
|
|||
|
|
window.addEventListener("load", function() {
|
|||
|
|
var ver = document.getElementsByClassName("version");
|
|||
|
|
ver[0].innerHTML = DOCUMENTATION_OPTIONS['VERSION'];
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.architecture-module.html">architecture</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.atexit-module.html">atexit</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.basicblock-module.html">basicblock</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.binaryview-module.html">binaryview</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.callingconvention-module.html">callingconvention</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.databuffer-module.html">databuffer</a></li>
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="binaryninja.datarender-module.html">datarender</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">binaryninja.datarender.BinaryView</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.DataRenderer.html">binaryninja.datarender.DataRenderer</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.DisassemblyTextLine.html">binaryninja.datarender.DisassemblyTextLine</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.FileMetadata.html">binaryninja.datarender.FileMetadata</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.InstructionTextToken.html">binaryninja.datarender.InstructionTextToken</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.Type.html">binaryninja.datarender.Type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.log_error.html">binaryninja.datarender.log_error</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.demangle-module.html">demangle</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.downloadprovider-module.html">downloadprovider</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.enums-module.html">enums</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.fileaccessor-module.html">fileaccessor</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.filemetadata-module.html">filemetadata</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.flowgraph-module.html">flowgraph</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.function-module.html">function</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.functionrecognizer-module.html">functionrecognizer</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.highlight-module.html">highlight</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.interaction-module.html">interaction</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lineardisassembly-module.html">lineardisassembly</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.log-module.html">log</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lowlevelil-module.html">lowlevelil</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mainthread-module.html">mainthread</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mediumlevelil-module.html">mediumlevelil</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.metadata-module.html">metadata</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.numbers-module.html">numbers</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.platform-module.html">platform</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.plugin-module.html">plugin</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.pluginmanager-module.html">pluginmanager</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.scriptingprovider-module.html">scriptingprovider</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.settings-module.html">settings</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.transform-module.html">transform</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.types-module.html">types</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.undoaction-module.html">undoaction</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.update-module.html">update</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">Binary Ninja API</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html">Docs</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="binaryninja.datarender-module.html">datarender module</a> »</li>
|
|||
|
|
|
|||
|
|
<li>binaryninja.datarender.BinaryView</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/binaryninja.datarender.BinaryView.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="binaryninja-datarender-binaryview">
|
|||
|
|
<h1>binaryninja.datarender.BinaryView<a class="headerlink" href="#binaryninja-datarender-binaryview" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="binaryninja.datarender.BinaryView">
|
|||
|
|
<em class="property">class </em><code class="descname">BinaryView</code><span class="sig-paren">(</span><em>file_metadata=None</em>, <em>parent_view=None</em>, <em>handle=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/binaryview.html#BinaryView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.BinaryView" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p><code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">BinaryView</span></code> implements a view on binary data, and presents a queryable interface of a binary file. One key
|
|||
|
|
job of BinaryView is file format parsing which allows Binary Ninja to read, write, insert, remove portions
|
|||
|
|
of the file given a virtual address. For the purposes of this documentation we define a virtual address as the
|
|||
|
|
memory address that the various pieces of the physical file will be loaded at.</p>
|
|||
|
|
<p>A binary file does not have to have just one BinaryView, thus much of the interface to manipulate disassembly exists
|
|||
|
|
within or is accessed through a BinaryView. All files are guaranteed to have at least the <code class="docutils literal notranslate"><span class="pre">Raw</span></code> BinaryView. The
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Raw</span></code> BinaryView is simply a hex editor, but is helpful for manipulating binary files via their absolute addresses.</p>
|
|||
|
|
<p>BinaryViews are plugins and thus registered with Binary Ninja at startup, and thus should <strong>never</strong> be instantiated
|
|||
|
|
directly as this is already done. The list of available BinaryViews can be seen in the BinaryViewType class which
|
|||
|
|
provides an iterator and map of the various installed BinaryViews:</p>
|
|||
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">BinaryViewType</span><span class="p">)</span>
|
|||
|
|
<span class="go">[<view type: 'Raw'>, <view type: 'ELF'>, <view type: 'Mach-O'>, <view type: 'PE'>]</span>
|
|||
|
|
<span class="gp">>>> </span><span class="n">BinaryViewType</span><span class="p">[</span><span class="s1">'ELF'</span><span class="p">]</span>
|
|||
|
|
<span class="go"><view type: 'ELF'></span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<p>To open a file with a given BinaryView the following code can be used:</p>
|
|||
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">bv</span> <span class="o">=</span> <span class="n">BinaryViewType</span><span class="p">[</span><span class="s1">'Mach-O'</span><span class="p">]</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">"/bin/ls"</span><span class="p">)</span>
|
|||
|
|
<span class="gp">>>> </span><span class="n">bv</span>
|
|||
|
|
<span class="go"><BinaryView: '/bin/ls', start 0x100000000, len 0xa000></span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<p><cite>By convention in the rest of this document we will use bv to mean an open BinaryView of an executable file.</cite>
|
|||
|
|
When a BinaryView is open on an executable view, analysis does not automatically run, this can be done by running
|
|||
|
|
the <code class="docutils literal notranslate"><span class="pre">update_analysis_and_wait()</span></code> method which disassembles the executable and returns when all disassembly is
|
|||
|
|
finished:</p>
|
|||
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">bv</span><span class="o">.</span><span class="n">update_analysis_and_wait</span><span class="p">()</span>
|
|||
|
|
<span class="go">>>></span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<p>Since BinaryNinja’s analysis is multi-threaded (depending on version) this can also be done in the background by
|
|||
|
|
using the <code class="docutils literal notranslate"><span class="pre">update_analysis()</span></code> method instead.</p>
|
|||
|
|
<p>By standard python convention methods which start with ‘_’ should be considered private and should not be called
|
|||
|
|
externally. Additionally, methods which begin with <code class="docutils literal notranslate"><span class="pre">perform_</span></code> should not be called either and are
|
|||
|
|
used explicitly for subclassing the BinaryView.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">An important note on the <code class="docutils literal notranslate"><span class="pre">*_user_*()</span></code> methods. Binary Ninja makes a distinction between edits performed by the user and actions performed by auto analysis. Auto analysis actions that can quickly be recalculated are not saved to the database. Auto analysis actions that take a long time and all user edits are stored in the database (e.g. <code class="docutils literal notranslate"><span class="pre">remove_user_function()</span></code> rather than <code class="docutils literal notranslate"><span class="pre">remove_function()</span></code>). Thus use <code class="docutils literal notranslate"><span class="pre">_user_</span></code> methods if saving to the database is desired.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="binaryninja.datarender.BinaryView.__init__">
|
|||
|
|
<code class="descname">__init__</code><span class="sig-paren">(</span><em>file_metadata=None</em>, <em>parent_view=None</em>, <em>handle=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/binaryview.html#BinaryView.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.BinaryView.__init__" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>x.__init__(…) initializes x; see help(type(x)) for signature</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<p class="rubric">Methods</p>
|
|||
|
|
<table border="1" class="longtable docutils">
|
|||
|
|
<colgroup>
|
|||
|
|
<col width="10%" />
|
|||
|
|
<col width="90%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="row-odd"><td><a class="reference internal" href="#binaryninja.datarender.BinaryView.__init__" title="binaryninja.datarender.BinaryView.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>([file_metadata, parent_view, handle])</td>
|
|||
|
|
<td>x.__init__(…) initializes x; see help(type(x)) for signature</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">abort_analysis</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">abort_analysis</span></code> will abort the currently running analysis.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_analysis_completion_event</span></code>(callback)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">add_analysis_completion_event</span></code> sets up a call back function to be called when analysis has been completed.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_analysis_option</span></code>(name)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">add_analysis_option</span></code> adds an analysis option.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_auto_section</span></code>(name, start, length[, …])</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_auto_segment</span></code>(start, length, data_offset, …)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_entry_point</span></code>(addr[, plat])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">add_entry_point</span></code> adds an virtual address to start analysis from for a given plat.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_function</span></code>(addr[, plat])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">add_function</span></code> add a new function of the given <code class="docutils literal notranslate"><span class="pre">plat</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_undo_action</span></code>(action)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_user_section</span></code>(name, start, length[, …])</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_user_segment</span></code>(start, length, data_offset, …)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">always_branch</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">always_branch</span></code> convert the instruction of architecture <code class="docutils literal notranslate"><span class="pre">arch</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> to an unconditional branch.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">begin_undo_actions</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">begin_undo_actions</span></code> start recording actions taken so the can be undone at some point.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">commit_undo_actions</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">commit_undo_actions</span></code> commit the actions taken since the last commit to the undo database.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">convert_to_nop</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">convert_to_nop</span></code> converts the instruction at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> to a nop of the provided architecture.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_database</span></code>(filename[, progress_func])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">create_database</span></code> writes the current database (.bndb) file out to the specified file.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_user_function</span></code>(addr[, plat])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">create_user_function</span></code> add a new <em>user</em> function of the given <code class="docutils literal notranslate"><span class="pre">plat</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_auto_symbol</span></code>(sym)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">define_auto_symbol</span></code> adds a symbol to the internal list of automatically discovered Symbol objects in a given namespace.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_auto_symbol_and_var_or_function</span></code>(sym, …)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">define_auto_symbol_and_var_or_function</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_data_var</span></code>(addr, var_type)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">define_data_var</span></code> defines a non-user data variable <code class="docutils literal notranslate"><span class="pre">var_type</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_imported_function</span></code>(import_addr_sym, func)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">define_imported_function</span></code> defines an imported Function <code class="docutils literal notranslate"><span class="pre">func</span></code> with a ImportedFunctionSymbol type.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_type</span></code>(type_id, default_name, type_obj)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">define_type</span></code> registers a <a class="reference internal" href="binaryninja.datarender.Type.html#binaryninja.datarender.Type" title="binaryninja.datarender.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a> <code class="docutils literal notranslate"><span class="pre">type_obj</span></code> of the given <code class="docutils literal notranslate"><span class="pre">name</span></code> in the global list of types for the current <a class="reference internal" href="#binaryninja.datarender.BinaryView" title="binaryninja.datarender.BinaryView"><code class="xref py py-class docutils literal notranslate"><span class="pre">BinaryView</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_user_data_var</span></code>(addr, var_type)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">define_user_data_var</span></code> defines a user data variable <code class="docutils literal notranslate"><span class="pre">var_type</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_user_symbol</span></code>(sym)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">define_user_symbol</span></code> adds a symbol to the internal list of user added Symbol objects.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">define_user_type</span></code>(name, type_obj)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">define_user_type</span></code> registers a <a class="reference internal" href="binaryninja.datarender.Type.html#binaryninja.datarender.Type" title="binaryninja.datarender.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a> <code class="docutils literal notranslate"><span class="pre">type_obj</span></code> of the given <code class="docutils literal notranslate"><span class="pre">name</span></code> in the global list of user types for the current <a class="reference internal" href="#binaryninja.datarender.BinaryView" title="binaryninja.datarender.BinaryView"><code class="xref py py-class docutils literal notranslate"><span class="pre">BinaryView</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">eval</span></code>(expression[, here])</td>
|
|||
|
|
<td>Evaluates an string expression to an integer value.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">external_namespace</span></code>()</td>
|
|||
|
|
<td>External namespace for the current BinaryView</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">find_next_constant</span></code>(start, constant[, settings])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">find_next_constant</span></code> searches for integer constant <code class="docutils literal notranslate"><span class="pre">constant</span></code> occurring in the linear view output starting at the virtual address <code class="docutils literal notranslate"><span class="pre">start</span></code> until the end of the BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">find_next_data</span></code>(start, data[, flags])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">find_next_data</span></code> searches for the bytes <code class="docutils literal notranslate"><span class="pre">data</span></code> starting at the virtual address <code class="docutils literal notranslate"><span class="pre">start</span></code> until the end of the BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">find_next_text</span></code>(start, text[, settings, flags])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">find_next_text</span></code> searches for string <code class="docutils literal notranslate"><span class="pre">text</span></code> occurring in the linear view output starting at the virtual address <code class="docutils literal notranslate"><span class="pre">start</span></code> until the end of the BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_address_for_data_offset</span></code>(offset)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_address_input</span></code>(prompt, title[, …])</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_basic_blocks_at</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_basic_blocks_at</span></code> get a list of <code class="xref py py-class docutils literal notranslate"><span class="pre">BasicBlock</span></code> objects which exist at the provided virtual address.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_basic_blocks_starting_at</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_basic_blocks_starting_at</span></code> get a list of <code class="xref py py-class docutils literal notranslate"><span class="pre">BasicBlock</span></code> objects which start at the provided virtual address.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_code_refs</span></code>(addr[, length])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_code_refs</span></code> returns a list of ReferenceSource objects (xrefs or cross-references) that point to the provided virtual address.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_data_refs</span></code>(addr[, length])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_data_refs</span></code> returns a list of virtual addresses of data which references <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_data_var_at</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_data_var_at</span></code> returns the data type at a given virtual address.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_disassembly</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_disassembly</span></code> simple helper function for printing disassembly of a given address</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_function_at</span></code>(addr[, plat])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_function_at</span></code> gets a Function object for the function that starts at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>:</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_functions_at</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_functions_at</span></code> get a list of binaryninja.Function objects (one for each valid plat) at the given virtual address.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_functions_containing</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_functions_containing</span></code> returns a list of functions which contain the given address or None on failure.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_instruction_length</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_instruction_length</span></code> returns the number of bytes in the instruction of Architecture <code class="docutils literal notranslate"><span class="pre">arch</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_linear_disassembly</span></code>(settings)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_linear_disassembly</span></code> gets an iterator for all lines in the linear disassembly of the view for the given disassembly settings.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_linear_disassembly_position_at</span></code>(addr, …)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_linear_disassembly_position_at</span></code> instantiates a <code class="xref py py-class docutils literal notranslate"><span class="pre">LinearDisassemblyPosition</span></code> object for use in <code class="xref py py-meth docutils literal notranslate"><span class="pre">get_previous_linear_disassembly_lines()</span></code> or <code class="xref py py-meth docutils literal notranslate"><span class="pre">get_next_linear_disassembly_lines()</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_modification</span></code>(addr[, length])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_modification</span></code> returns the modified bytes of up to <code class="docutils literal notranslate"><span class="pre">length</span></code> bytes from virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>, or if <code class="docutils literal notranslate"><span class="pre">length</span></code> is None returns the ModificationStatus.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_next_basic_block_start_after</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_next_basic_block_start_after</span></code> returns the virtual address of the BasicBlock that occurs after the virtual</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_next_data_after</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_next_data_after</span></code> retrieves the virtual address of the next non-code byte.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_next_data_var_after</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_next_data_var_after</span></code> retrieves the next virtual address of the next <code class="xref py py-class docutils literal notranslate"><span class="pre">DataVariable</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_next_disassembly</span></code>([arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_next_disassembly</span></code> simple helper function for printing disassembly of the next instruction.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_next_function_start_after</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_next_function_start_after</span></code> returns the virtual address of the Function that occurs after the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_next_linear_disassembly_lines</span></code>(pos, settings)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_next_linear_disassembly_lines</span></code> retrieves a list of <code class="xref py py-class docutils literal notranslate"><span class="pre">LinearDisassemblyLine</span></code> objects for the next disassembly lines, and updates the LinearDisassemblyPosition passed in.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_previous_basic_block_end_before</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_previous_basic_block_end_before</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_previous_basic_block_start_before</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_previous_basic_block_start_before</span></code> returns the virtual address of the BasicBlock that occurs prior to the provided virtual address</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_previous_data_before</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_previous_data_before</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_previous_data_var_before</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_previous_data_var_before</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_previous_function_start_before</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_previous_function_start_before</span></code> returns the virtual address of the Function that occurs prior to the virtual address provided</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_previous_linear_disassembly_lines</span></code>(pos, …)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_previous_linear_disassembly_lines</span></code> retrieves a list of <code class="xref py py-class docutils literal notranslate"><span class="pre">LinearDisassemblyLine</span></code> objects for the previous disassembly lines, and updates the LinearDisassemblyPosition passed in.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_recent_basic_block_at</span></code>(addr)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_recent_function_at</span></code>(addr)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_section_by_name</span></code>(name)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_sections_at</span></code>(addr)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_segment_at</span></code>(addr)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_strings</span></code>([start, length])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_strings</span></code> returns a list of strings defined in the binary in the optional virtual address range: <code class="docutils literal notranslate"><span class="pre">start-(start+length)</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_symbol_at</span></code>(addr[, namespace])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_symbol_at</span></code> returns the Symbol at the provided virtual address.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_symbol_by_raw_name</span></code>(name[, namespace])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_symbol_by_raw_name</span></code> retrieves a Symbol object for the given a raw (mangled) name.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_symbols</span></code>([start, length, namespace])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_symbols</span></code> retrieves the list of all Symbol objects in the optionally provided range.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_symbols_by_name</span></code>(name[, namespace])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_symbols_by_name</span></code> retrieves a list of Symbol objects for the given symbol name.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_symbols_of_type</span></code>(sym_type[, start, …])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_symbols_of_type</span></code> retrieves a list of all Symbol objects of the provided symbol type in the optionally</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_type_by_id</span></code>(id)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_type_by_id</span></code> returns the defined type whose unique identifier corresponds with the provided <code class="docutils literal notranslate"><span class="pre">id</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_type_by_name</span></code>(name)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_type_by_name</span></code> returns the defined type whose name corresponds with the provided <code class="docutils literal notranslate"><span class="pre">name</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_type_id</span></code>(name)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_type_id</span></code> returns the unique identifier of the defined type whose name corresponds with the provided <code class="docutils literal notranslate"><span class="pre">name</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_type_name_by_id</span></code>(id)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_type_name_by_id</span></code> returns the defined type name whose unique identifier corresponds with the provided <code class="docutils literal notranslate"><span class="pre">id</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_unique_section_names</span></code>(name_list)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_view_of_type</span></code>(name)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">get_view_of_type</span></code> returns the BinaryView associated with the provided name if it exists.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">init</span></code>()</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">insert</span></code>(addr, data)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">insert</span></code> inserts the bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code> to the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">internal_namespace</span></code>()</td>
|
|||
|
|
<td>Internal namespace for the current BinaryView</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">invert_branch</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">invert_branch</span></code> convert the branch instruction of architecture <code class="docutils literal notranslate"><span class="pre">arch</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> to the inverse branch.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_always_branch_patch_available</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_always_branch_patch_available</span></code> queries the architecture plugin to determine if the instruction at <code class="docutils literal notranslate"><span class="pre">addr</span></code> can be made to <strong>always branch</strong>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_invert_branch_patch_available</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_invert_branch_patch_available</span></code> queries the architecture plugin to determine if the instruction at <code class="docutils literal notranslate"><span class="pre">addr</span></code> is a branch that can be inverted.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_never_branch_patch_available</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_never_branch_patch_available</span></code> queries the architecture plugin to determine if the instruction at the instruction at <code class="docutils literal notranslate"><span class="pre">addr</span></code> can be made to <strong>never branch</strong>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_offset_code_semantics</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_offset_code_semantics</span></code> checks if an virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is semantically valid for code.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_offset_executable</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_offset_executable</span></code> checks if an virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is valid for executing.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_offset_extern_semantics</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_offset_extern_semantics</span></code> checks if an virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is semantically valid for external references.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_offset_readable</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_offset_readable</span></code> checks if an virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is valid for reading.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_offset_writable</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_offset_writable</span></code> checks if an virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is valid for writing.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_offset_writable_semantics</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_offset_writable_semantics</span></code> checks if an virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is semantically writable.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_skip_and_return_value_patch_available</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_skip_and_return_value_patch_available</span></code> queries the architecture plugin to determine if the instruction at <code class="docutils literal notranslate"><span class="pre">addr</span></code> is similar to an x86 “call” instruction which can be made to return a value.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_skip_and_return_zero_patch_available</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_skip_and_return_zero_patch_available</span></code> queries the architecture plugin to determine if the instruction at <code class="docutils literal notranslate"><span class="pre">addr</span></code> is similar to an x86 “call” instruction which can be made to return zero.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_type_auto_defined</span></code>(name)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_type_auto_defined</span></code> queries the user type list of name.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_valid_offset</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">is_valid_offset</span></code> checks if an virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is valid .</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">navigate</span></code>(view, offset)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">never_branch</span></code>(addr[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">never_branch</span></code> convert the branch instruction of architecture <code class="docutils literal notranslate"><span class="pre">arch</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> to a fall through.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">new</span></code>([data, file_metadata])</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">notify_data_inserted</span></code>(offset, length)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">notify_data_removed</span></code>(offset, length)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">notify_data_written</span></code>(offset, length)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">open</span></code>(src[, file_metadata])</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">parse_expression</span></code>(expression[, here])</td>
|
|||
|
|
<td>Evaluates an string expression to an integer value.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">parse_type_string</span></code>(text)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">parse_type_string</span></code> converts <cite>C-style</cite> string into a <a class="reference internal" href="binaryninja.datarender.Type.html#binaryninja.datarender.Type" title="binaryninja.datarender.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_get_address_size</span></code>()</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_get_default_endianness</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_get_default_endianness</span></code> implements a check which returns true if the BinaryView is executable.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_get_entry_point</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_get_entry_point</span></code> implements a query for the initial entry point for code execution.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_get_length</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_get_length</span></code> implements a query for the size of the virtual address range used by the BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_get_modification</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_get_modification</span></code> implements query to the whether the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is modified.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_get_next_valid_offset</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_get_next_valid_offset</span></code> implements a query for the next valid readable, writable, or executable virtual memory address.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_get_start</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_get_start</span></code> implements a query for the first readable, writable, or executable virtual address in the BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_insert</span></code>(addr, data)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_insert</span></code> implements a mapping between a virtual address and an absolute file offset, inserting the bytes <code class="docutils literal notranslate"><span class="pre">data</span></code> to rebased address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_is_executable</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_is_executable</span></code> implements a check which returns true if the BinaryView is executable.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_is_offset_executable</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_is_offset_executable</span></code> implements a check if a virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is executable.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_is_offset_readable</span></code>(offset)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_is_offset_readable</span></code> implements a check if an virtual address is readable.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_is_offset_writable</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_is_offset_writable</span></code> implements a check if a virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is writable.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_is_relocatable</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_is_relocatable</span></code> implements a check which returns true if the BinaryView is relocatable.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_is_valid_offset</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_is_valid_offset</span></code> implements a check if an virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> is valid.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_read</span></code>(addr, length)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_read</span></code> implements a mapping between a virtual address and an absolute file offset, reading <code class="docutils literal notranslate"><span class="pre">length</span></code> bytes from the rebased address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_remove</span></code>(addr, length)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_remove</span></code> implements a mapping between a virtual address and an absolute file offset, removing <code class="docutils literal notranslate"><span class="pre">length</span></code> bytes from the rebased address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_save</span></code>(accessor)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">perform_write</span></code>(addr, data)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">perform_write</span></code> implements a mapping between a virtual address and an absolute file offset, writing the bytes <code class="docutils literal notranslate"><span class="pre">data</span></code> to rebased address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">query_metadata</span></code>(key)</td>
|
|||
|
|
<td><cite>query_metadata</cite> retrieves a metadata associated with the given key stored in the current BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">read</span></code>(addr, length)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">read</span></code> returns the data reads at most <code class="docutils literal notranslate"><span class="pre">length</span></code> bytes from virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">reanalyze</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">reanalyze</span></code> causes all functions to be reanalyzed.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">redo</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">redo</span></code> redo the last committed action in the undo database.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">register</span></code>()</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_notification</span></code>(notify)</td>
|
|||
|
|
<td><cite>register_notification</cite> provides a mechanism for receiving callbacks for various analysis events.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_platform_types</span></code>(platform)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">register_platform_types</span></code> ensures that the platform-specific types for a <code class="xref py py-class docutils literal notranslate"><span class="pre">Platform</span></code> are available for the current <a class="reference internal" href="#binaryninja.datarender.BinaryView" title="binaryninja.datarender.BinaryView"><code class="xref py py-class docutils literal notranslate"><span class="pre">BinaryView</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">relocation_ranges_at</span></code>(addr)</td>
|
|||
|
|
<td>List of relocation range tuples for a given address</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove</span></code>(addr, length)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">remove</span></code> removes at most <code class="docutils literal notranslate"><span class="pre">length</span></code> bytes from virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_auto_section</span></code>(name)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_auto_segment</span></code>(start, length)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_function</span></code>(func)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">remove_function</span></code> removes the function <code class="docutils literal notranslate"><span class="pre">func</span></code> from the list of functions</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_metadata</span></code>(key)</td>
|
|||
|
|
<td><cite>remove_metadata</cite> removes the metadata associated with key from the current BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_user_function</span></code>(func)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">remove_user_function</span></code> removes the <em>user</em> function <code class="docutils literal notranslate"><span class="pre">func</span></code> from the list of functions</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_user_section</span></code>(name)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_user_segment</span></code>(start, length)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">rename_type</span></code>(old_name, new_name)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">rename_type</span></code> renames a type in the global list of types for the current <a class="reference internal" href="#binaryninja.datarender.BinaryView" title="binaryninja.datarender.BinaryView"><code class="xref py py-class docutils literal notranslate"><span class="pre">BinaryView</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">save</span></code>(dest)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">save</span></code> saves the original binary file to the provided destination <code class="docutils literal notranslate"><span class="pre">dest</span></code> along with any modifications.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">save_auto_snapshot</span></code>([progress_func])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">save_auto_snapshot</span></code> saves the current database to the already created file.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_default_session_data</span></code>(name, value)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">set_default_session_data</span></code> saves a variable to the BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">show_graph_report</span></code>(title, graph)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">show_html_report</span></code>(title, contents[, plaintext])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">show_html_report</span></code> displays the HTML contents in UI applications and plaintext in command-line applications.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">show_markdown_report</span></code>(title, contents[, …])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">show_markdown_report</span></code> displays the markdown contents in UI applications and plaintext in command-line applications.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">show_plain_text_report</span></code>(title, contents)</td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">skip_and_return_value</span></code>(addr, value[, arch])</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">skip_and_return_value</span></code> convert the <code class="docutils literal notranslate"><span class="pre">call</span></code> instruction of architecture <code class="docutils literal notranslate"><span class="pre">arch</span></code> at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> to the equivalent of returning a value.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">store_metadata</span></code>(key, md)</td>
|
|||
|
|
<td><cite>store_metadata</cite> stores an object for the given key in the current BinaryView.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">undefine_auto_symbol</span></code>(sym)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">undefine_auto_symbol</span></code> removes a symbol from the internal list of automatically discovered Symbol objects.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">undefine_data_var</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">undefine_data_var</span></code> removes the non-user data variable at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">undefine_type</span></code>(type_id)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">undefine_type</span></code> removes a <a class="reference internal" href="binaryninja.datarender.Type.html#binaryninja.datarender.Type" title="binaryninja.datarender.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a> from the global list of types for the current <a class="reference internal" href="#binaryninja.datarender.BinaryView" title="binaryninja.datarender.BinaryView"><code class="xref py py-class docutils literal notranslate"><span class="pre">BinaryView</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">undefine_user_data_var</span></code>(addr)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">undefine_user_data_var</span></code> removes the user data variable at the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">undefine_user_symbol</span></code>(sym)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">undefine_user_symbol</span></code> removes a symbol from the internal list of user added Symbol objects.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">undefine_user_type</span></code>(name)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">undefine_user_type</span></code> removes a <a class="reference internal" href="binaryninja.datarender.Type.html#binaryninja.datarender.Type" title="binaryninja.datarender.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a> from the global list of user types for the current <a class="reference internal" href="#binaryninja.datarender.BinaryView" title="binaryninja.datarender.BinaryView"><code class="xref py py-class docutils literal notranslate"><span class="pre">BinaryView</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">undo</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">undo</span></code> undo the last committed action in the undo database.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">unregister_notification</span></code>(notify)</td>
|
|||
|
|
<td><cite>unregister_notification</cite> unregisters the <code class="xref py py-class docutils literal notranslate"><span class="pre">BinaryDataNotification</span></code> object passed to <cite>register_notification</cite></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_analysis</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">update_analysis</span></code> asynchronously starts the analysis running and returns immediately.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_analysis_and_wait</span></code>()</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">update_analysis_and_wait</span></code> blocking call to update the analysis, this call returns when the analysis is complete.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">write</span></code>(addr, data)</td>
|
|||
|
|
<td><code class="docutils literal notranslate"><span class="pre">write</span></code> writes the bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code> to the virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<p class="rubric">Attributes</p>
|
|||
|
|
<table border="1" class="longtable docutils">
|
|||
|
|
<colgroup>
|
|||
|
|
<col width="10%" />
|
|||
|
|
<col width="90%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">address_size</span></code></td>
|
|||
|
|
<td>Address size of the binary (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">allocated_ranges</span></code></td>
|
|||
|
|
<td>List of valid address ranges for this view (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">analysis_changed</span></code></td>
|
|||
|
|
<td>boolean analysis state changed of the currently running analysis (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">analysis_info</span></code></td>
|
|||
|
|
<td>Provides instantaneous analysis state information and a list of current functions under analysis (read-only).</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">analysis_progress</span></code></td>
|
|||
|
|
<td>Status of current analysis (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">arch</span></code></td>
|
|||
|
|
<td>The architecture associated with the current BinaryView (read/write)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">available_view_types</span></code></td>
|
|||
|
|
<td>Available view types (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">basic_blocks</span></code></td>
|
|||
|
|
<td>A generator of all BasicBlock objects in the BinaryView</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">data_vars</span></code></td>
|
|||
|
|
<td>List of data variables (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">end</span></code></td>
|
|||
|
|
<td>End offset of the binary (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">endianness</span></code></td>
|
|||
|
|
<td>Endianness of the binary (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">entry_function</span></code></td>
|
|||
|
|
<td>Entry function (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">entry_point</span></code></td>
|
|||
|
|
<td>Entry point of the binary (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">executable</span></code></td>
|
|||
|
|
<td>Whether the binary is an executable (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">functions</span></code></td>
|
|||
|
|
<td>List of functions (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">global_pointer_value</span></code></td>
|
|||
|
|
<td>Discovered value of the global pointer register, if the binary uses one (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">has_database</span></code></td>
|
|||
|
|
<td>boolean has a database been written to disk (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">has_functions</span></code></td>
|
|||
|
|
<td>Boolean whether the binary has functions (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">instructions</span></code></td>
|
|||
|
|
<td>A generator of instruction tokens and their start addresses</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">linear_disassembly</span></code></td>
|
|||
|
|
<td>Iterator for all lines in the linear disassembly of the view</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">llil_basic_blocks</span></code></td>
|
|||
|
|
<td>A generator of all LowLevelILBasicBlock objects in the BinaryView</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">llil_instructions</span></code></td>
|
|||
|
|
<td>A generator of llil instructions</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">long_name</span></code></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">max_function_size_for_analysis</span></code></td>
|
|||
|
|
<td>Maximum size of function (sum of basic block sizes in bytes) for auto analysis</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">mlil_basic_blocks</span></code></td>
|
|||
|
|
<td>A generator of all MediumLevelILBasicBlock objects in the BinaryView</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">mlil_instructions</span></code></td>
|
|||
|
|
<td>A generator of mlil instructions</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">modified</span></code></td>
|
|||
|
|
<td>boolean modification state of the BinaryView (read/write)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">namespaces</span></code></td>
|
|||
|
|
<td>Returns a list of namespaces for the current BinaryView</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">new_auto_function_analysis_suppressed</span></code></td>
|
|||
|
|
<td>Whether or not automatically discovered functions will be analyzed</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">next_address</span></code></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">offset</span></code></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">parameters_for_analysis</span></code></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">parent_view</span></code></td>
|
|||
|
|
<td>View that contains the raw data used by this view (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">platform</span></code></td>
|
|||
|
|
<td>The platform associated with the current BinaryView (read/write)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">registered_view_type</span></code></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">relocatable</span></code></td>
|
|||
|
|
<td>Boolean - is the binary relocatable (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">relocation_ranges</span></code></td>
|
|||
|
|
<td>List of relocation range tuples (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">saved</span></code></td>
|
|||
|
|
<td>boolean state of whether or not the file has been saved (read/write)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">sections</span></code></td>
|
|||
|
|
<td>List of sections (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">segments</span></code></td>
|
|||
|
|
<td>List of segments (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">session_data</span></code></td>
|
|||
|
|
<td>Dictionary object where plugins can store arbitrary data associated with the view</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">start</span></code></td>
|
|||
|
|
<td>Start offset of the binary (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">strings</span></code></td>
|
|||
|
|
<td>List of strings (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">symbols</span></code></td>
|
|||
|
|
<td>Dict of symbols (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">types</span></code></td>
|
|||
|
|
<td>List of defined types (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">view</span></code></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">view_type</span></code></td>
|
|||
|
|
<td>View type (read-only)</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="binaryninja.datarender.DataRenderer.html" class="btn btn-neutral float-right" title="binaryninja.datarender.DataRenderer" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="binaryninja.datarender-module.html" class="btn btn-neutral" title="datarender module" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2015-2019, Vector 35 Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.StickyNav.enable();
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|