binaryninja/commercial/docs/about/open-source/index.html

436 lines
16 KiB
HTML

<!DOCTYPE html>
<!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
<!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
<!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
<!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
<!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<title>Open Source - Binary Ninja Documentation</title>
<link rel="canonical" href="https://docs.binary.ninja/about/open-source/index.html">
<meta name="author" content="Vector 35 LLC">
<meta property="og:url" content="https://docs.binary.ninja/about/open-source/index.html">
<meta property="og:title" content="Binary Ninja Documentation">
<meta property="og:image" content="https://docs.binary.ninja/about/open-source/index.html/../../images/logo.png">
<meta name="apple-mobile-web-app-title" content="Binary Ninja Documentation">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="apple-touch-icon" href="../../images/logo.png">
<link rel="shortcut icon" type="image/x-icon" href="../../../../favicon.ico">
<link rel="icon" type="image/x-icon" href="../../../../favicon.ico">
<style>
@font-face {
font-family: 'Icon';
src: url('../../assets/fonts/icon.eot?52m981');
src: url('../../assets/fonts/icon.eot?#iefix52m981')
format('embedded-opentype'),
url('../../assets/fonts/icon.woff?52m981')
format('woff'),
url('../../assets/fonts/icon.ttf?52m981')
format('truetype'),
url('../../assets/fonts/icon.svg?52m981#icon')
format('svg');
font-weight: normal;
font-style: normal;
}
</style>
<link rel="stylesheet" href="../../assets/stylesheets/application-a422ff04cc.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu+Mono">
<style>
body, input {
font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
}
pre, code {
font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
}
</style>
<link rel="stylesheet" href="../../docs.css?1492471077">
<script src="../../assets/javascripts/modernizr-4ab42b99fd.js"></script>
</head>
<body class=" ">
<div class="backdrop">
<div class="backdrop-paper"></div>
</div>
<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>
<header class="header">
<nav aria-label="Header">
<div class="bar default">
<div class="button button-menu" role="button" aria-label="Menu">
<label class="toggle-button icon icon-menu" for="toggle-drawer">
<span></span>
</label>
</div>
<div class="stretch">
<div class="title">
<span class="path">
About <i class="icon icon-link"></i>
</span>
Open Source
</div>
</div>
</div>
<div class="bar search">
<div class="button button-close" role="button" aria-label="Close">
<label class="toggle-button icon icon-back" for="toggle-search"></label>
</div>
<div class="stretch">
<div class="field">
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
</div>
</div>
<div class="button button-reset" role="button" aria-label="Search">
<button class="toggle-button icon icon-close" id="reset-search"></button>
</div>
</div>
</nav>
</header>
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<a href="https://binary.ninja/" class="project">
<div class="banner">
<div class="logo">
<img src="../../images/logo.png">
</div>
<div class="name">
<strong>
Binary Ninja Documentation
<span class="version">
</span>
</strong>
</div>
</div>
</a>
<div class="scrollable">
<div class="wrapper">
<div class="toc">
<ul>
<li>
<a class="" title="Home" href="../../index.html">
Home
</a>
</li>
<li>
<a class="" title="Getting Started Guide" href="../../getting-started/index.html">
Getting Started Guide
</a>
</li>
<li>
<span class="section">User Guide</span>
<ul>
<li>
<a class="" title="Using and Writing Plugins" href="../../guide/plugins/index.html">
Using and Writing Plugins
</a>
</li>
<li>
<a class="" title="Troubleshooting" href="../../guide/troubleshooting/index.html">
Troubleshooting
</a>
</li>
</ul>
</li>
<li>
<span class="section">Developer Guide</span>
<ul>
<li>
<a class="" title="Contributing Documentation" href="../../dev/documentation/index.html">
Contributing Documentation
</a>
</li>
<li>
<a class="" title="BNIL Guide&#58; LLIL" href="../../dev/bnil-llil/index.html">
BNIL Guide&#58; LLIL
</a>
</li>
</ul>
</li>
<li>
<span class="section">About</span>
<ul>
<li>
<a class="" title="License" href="../license/index.html">
License
</a>
</li>
<li>
<a class="current" title="Open Source" href="index.html">
Open Source
</a>
<ul>
<li class="anchor">
<a title="Open Source" href="#open-source">
Open Source
</a>
</li>
<li class="anchor">
<a title="Building Qt" href="#building-qt">
Building Qt
</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</nav>
</div>
<article class="article">
<div class="wrapper">
<h1 id="binary-ninja">Binary Ninja<a class="headerlink" href="#binary-ninja" title="Permanent link">&para;</a></h1>
<h2 id="open-source">Open Source<a class="headerlink" href="#open-source" title="Permanent link">&para;</a></h2>
<p>Vector 35 is grateful for the following open source packages that are used in Binary Ninja directly or indirectly:</p>
<ul>
<li>Documentation<ul>
<li><a href="https://github.com/snide/sphinx_rtd_theme/">breathe-rtd-theme</a> (<a href="https://github.com/snide/sphinx_rtd_theme/blob/master/LICENSE">breathe-rtd-theme license</a> - MIT)</li>
<li><a href="https://github.com/michaeljones/breathe">breathe</a> (<a href="https://github.com/michaeljones/breathe/blob/master/LICENSE">breathe license</a> - BSD)</li>
<li><a href="http://www.stack.nl/~dimitri/doxygen/">doxygen</a> (<a href="https://github.com/doxygen/doxygen/blob/master/LICENSE">doxygen license</a> - GPLv2)</li>
<li><a href="https://github.com/squidfunk/mkdocs-material">mkdocs-material</a> (<a href="https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE">mkdocs-material License</a> - BSD)</li>
<li><a href="http://www.mkdocs.org/">mkdocs</a> (<a href="https://github.com/mkdocs/mkdocs/blob/master/LICENSE">mkdocs license</a> - BSD)</li>
<li><a href="http://www.sphinx-doc.org/en/stable/index.html">sphinx</a> (<a href="https://github.com/sphinx-doc/sphinx/blob/master/LICENSE">sphinx license</a> - BSD and others)</li>
</ul>
</li>
</ul>
<p>The previous tools are used in the generation of our documentation, but are not distributed themselves and are merely listed here in acknowledgement for the value they provide.</p>
<ul>
<li>
<p>UI</p>
<ul>
<li><a href="https://github.com/SSNikolaevich/DejaVuSansCode">dejavusanscode</a> (<a href="https://github.com/SSNikolaevich/DejaVuSansCode/blob/master/LICENSE">dejavusanscode license</a> - multiple open licenses)</li>
<li><a href="https://www.google.com/fonts/specimen/Open+Sans">opensans</a> (<a href="http://www.apache.org/licenses/LICENSE-2.0.html">opensans license</a> - Apache 2.0)</li>
<li><a href="https://www.qt.io/download/">qt</a> (<a href="https://www.qt.io/qt-licensing-terms/">qt license</a> - LGPLv3 / note, please see our <a href="index.html#building-qt">qt build instructions below</a>)</li>
<li><a href="https://github.com/adobe-fonts/source-code-pro">sourcecodepro</a> (<a href="https://github.com/adobe-fonts/source-code-pro/blob/master/LICENSE.txt">sourcecodepro license</a> - SIL open font license)</li>
</ul>
</li>
<li>
<p>Core</p>
<ul>
<li><a href="http://www.pell.portland.or.us/~orc/Code/discount/">discount</a> (<a href="http://www.pell.portland.or.us/~orc/Code/discount/COPYRIGHT.html">discount license</a> - BSD)</li>
<li><a href="https://libgit2.github.com/">libgit2</a> (<a href="https://github.com/libgit2/libgit2/blob/master/COPYING">libgit2 license</a> - GPLv2 with linking exception)</li>
<li><a href="https://www.cabextract.org.uk/libmspack/">libmspack</a> (<a href="https://www.cabextract.org.uk/libmspack/#license">libmspack license</a> - LGPL, v2)</li>
<li><a href="http://llvm.org/releases/3.8.1/">llvm</a> (<a href="http://llvm.org/releases/3.8.1/LICENSE.TXT">llvm license</a> - BSD-style)</li>
<li><a href="http://oldhome.schmorp.de/marc/liblzf.html">lzf</a> (<a href="http://oldhome.schmorp.de/marc/liblzf.html">lzf license</a> - BSD)</li>
<li><a href="http://jemalloc.net/">jemalloc</a> (<a href="https://github.com/jemalloc/jemalloc/blob/dev/COPYING">jemalloc license</a> - BSD)</li>
<li><a href="https://www.sqlite.org/index.html">sqlite</a> (<a href="https://www.sqlite.org/copyright.html">sqlite license</a> - public domain)</li>
<li><a href="http://www.zlib.net/">zlib</a> (<a href="http://www.zlib.net/zlib_license.html">zlib license</a> - zlib license)</li>
</ul>
</li>
<li>
<p>Other</p>
<ul>
<li><a href="http://yasm.tortall.net/">yasm</a> (<a href="https://github.com/yasm/yasm/blob/master/BSD.txt">yasm license</a> - 2-clause BSD) used for assembling x86 and x64</li>
<li><a href="https://github.com/aquynh/capstone">capstone</a> (<a href="https://github.com/aquynh/capstone/blob/master/LICENSE.TXT">capstone license</a> - 3-clause BSD) used in the PPC architecture module as an example of how to wrap an external disassembler</li>
</ul>
</li>
<li>
<p>Upvector update library</p>
<ul>
<li><a href="https://github.com/libtom/libtomcrypt">tomcrypt</a> (<a href="https://github.com/libtom/libtomcrypt/blob/develop/LICENSE">tomcrypt license</a> - public domain)</li>
</ul>
</li>
</ul>
<h2 id="building-qt">Building Qt<a class="headerlink" href="#building-qt" title="Permanent link">&para;</a></h2>
<p>Binary Ninja uses <a href="https://www.qt.io/qt-licensing-terms/">Qt 5.10</a> under an LGPLv3 license which requires that we host the original sources used to build Qt for our application along with instructions on how that source may be re-built and can replace the version of Qt shipped with Binary Ninja.</p>
<p>Please note that we offer no support for running Binary Ninja with modified Qt libraries.</p>
<ol>
<li>Follow the installation requirements on the <a href="https://wiki.qt.io/Building-Qt-5-from-Git">Building Qt 5 from Git</a> page.</li>
<li>Download the Qt 5.10.1 <a href="https://binary.ninja/qt5.10.1.tar.xz">tarball</a> from binary.ninja. (Note this is an unmodified 5.10 identical to that available from Qt's source control, but must be hosted locally according to the <a href="https://www.qt.io/qt-licensing-terms/">Qt 5.10</a> terms.)</li>
<li>Next, build QT using the aforementioned instructions.</li>
<li>On OS X, you will need to disable the code-signing signature since it would otherwise prevent changes to binaries or shared libraries. We recommend a tool such as <a href="https://github.com/steakknife/unsign">unsign</a>.</li>
<li>Finally, replace the built libraries:<ul>
<li>On OS X, replace the <code>QtCore.framework</code>, <code>QtDBus.framework</code>, <code>QtGui.framework</code>, <code>QtNetwork.framework</code>, <code>QtPrintSupport.framework</code>, <code>QtWidgets.framework</code> folders inside of <code>/Applications/Binary Ninja.app/Contents/Frameworks</code></li>
<li>On Windows, replace the <code>Qt5core.dll</code>, <code>Qt5Gui.dll</code>, <code>Qt5Network.dll</code>, and <code>Qt5Widgets.dll</code> files in <code>C:\Program Files\Vector35\BinaryNinja\</code></li>
<li>On Linux, replace the <code>libQt5Core.so.5</code>, <code>libQt5DBus.so.5</code>, <code>libQt5Gui.so.5</code>, <code>libQt5Network.so.5</code>, <code>libQt5Widgets.so.5</code>, <code>libQt5XcbQpa.so.5</code> files wherever Binary Ninja was extracted</li>
</ul>
</li>
</ol>
<aside class="copyright" role="note">
(<a href="https://creativecommons.org/licenses/by/3.0/">cc</a>) Vector 35 LLC
</aside>
<footer class="footer">
<nav class="pagination" aria-label="Footer">
<div class="previous">
<a href="../license/index.html" title="License">
<span class="direction">
Previous
</span>
<div class="page">
<div class="button button-previous" role="button" aria-label="Previous">
<i class="icon icon-back"></i>
</div>
<div class="stretch">
<div class="title">
License
</div>
</div>
</div>
</a>
</div>
<div class="next">
</div>
</nav>
</footer>
</div>
</article>
<div class="results" role="status" aria-live="polite">
<div class="scrollable">
<div class="wrapper">
<div class="meta"></div>
<div class="list"></div>
</div>
</div>
</div>
</main>
<script>
var base_url = '../..';
var repo_id = '';
</script>
<script src="../../assets/javascripts/application-997097ee0c.js"></script>
<script>
(function(i,s,o,g,r,a,m){
i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||
[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;
m.parentNode.insertBefore(a,m)
})(window, document,
'script', 'https://www.google-analytics.com/analytics.js', 'ga');
/* General initialization */
ga('create', 'UA-72420552-3', 'docs.binary.ninja');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
/* Track outbound links */
var buttons = document.querySelectorAll('a');
Array.prototype.map.call(buttons, function(item) {
if (item.host != document.location.host) {
item.addEventListener('click', function() {
var action = item.getAttribute('data-action') || 'follow';
ga('send', 'event', 'outbound', action, item.href);
});
}
});
/* Register handler to log search on blur */
var query = document.querySelector('.query');
query.addEventListener('blur', function() {
if (this.value) {
var path = document.location.pathname;
ga('send', 'pageview', path + '?q=' + this.value);
}
});
</script>
</body>
</html>