Repository navigation
Expand file tree
/
Copy path__init__.py
More file actions
614 lines (496 loc) · 19.7 KB
/
Copy path__init__.py
File metadata and controls
614 lines (496 loc) · 19.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
# Copyright (c) 2015-2026 Vector 35 Inc
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
import atexit
import sys
import ctypes
import inspect
from dataclasses import dataclass
from time import gmtime, struct_time
import os
from typing import List, Mapping, Optional
import functools
# Binary Ninja components
import binaryninja._binaryninjacore as core
__version__ = core.BNGetVersionString()
import binaryninja
from .enums import *
from .databuffer import *
from .filemetadata import *
from .fileaccessor import *
from .binaryview import *
from .transform import *
from .architecture import *
from .basicblock import *
from .function import *
from .lowlevelil import *
from .mediumlevelil import *
from .highlevelil import *
from .types import *
from .typelibrary import *
from .functionrecognizer import *
from .update import *
from .plugin import *
from .callingconvention import *
from .platform import *
from .demangle import *
from .mainthread import *
from .interaction import *
from .lineardisassembly import *
from .highlight import *
from .scriptingprovider import *
from .downloadprovider import *
from .extensionmanager import *
from .settings import *
from .metadata import *
from .flowgraph import *
from .datarender import *
from .variable import *
from .websocketprovider import *
from .workflow import *
from .commonil import *
from .database import *
from .secretsprovider import *
from .typeparser import *
from .typeprinter import *
from .component import *
from .typearchive import *
from .typecontainer import *
from .exceptions import *
from .project import *
from .basedetection import *
from .debuginfo import *
from .externallibrary import *
from .undo import *
from .fileaccessor import *
from .languagerepresentation import *
from .lineformatter import *
from .renderlayer import *
from .constantrenderer import *
from .stringrecognizer import *
from .unicode import *
from .similarity import *
# mcp is imported only as a module because names such as Tool and Address are too generic for the binaryninja namespace.
from . import mcp
# We import each of these by name to prevent conflicts between
# log.py and the function 'log' which we don't import below
from .log import (
redirect_output_to_log, is_output_redirected_to_log, log_debug, log_info, log_warn, log_error, log_alert,
log_to_stdout, log_to_stderr, log_to_file, close_logs
)
from .log import log as log_at_level
from .deprecation import *
import warnings
# We must alter the filter settings for DeprecatedWarning. Otherwise, it will never show up.
# https://docs.python.org/3/library/warnings.html#default-warning-filter
warnings.filterwarnings('once', '', DeprecatedWarning)
# Only load Enterprise Client support on Ultimate builds
if core.BNGetProduct() == "Binary Ninja Enterprise Client" or core.BNGetProduct() == "Binary Ninja Ultimate":
from .enterprise import *
from .firmwareninja import *
def _get_parameter_count(callback):
if sys.version_info >= (3, 14):
import annotationlib
return len(inspect.signature(callback, annotation_format=annotationlib.Format.STRING).parameters)
return len(inspect.signature(callback).parameters)
def shutdown():
"""
``shutdown`` cleanly shuts down the core, stopping all workers and closing all log files.
.. note:: This will be called automatically on script exit if you import the binaryninja module.
"""
# Release license if we have one
global _enterprise_license_checkout
_enterprise_license_checkout = None
core.BNShutdown()
atexit.register(shutdown)
@functools.total_ordering
@dataclass
class CoreVersionInfo:
"""
Structure representing the Binary Ninja Version.
Use :py:func:`core_version_info` to look up the current version of Binary Ninja loaded.
:Example:
>>> from binaryninja import core_version_info, CoreVersionInfo
>>> # Check if the current version meets minimum requirements for a plugin
>>> if core_version_info() >= CoreVersionInfo(5, 1, 8104):
... print("Using new API available in 5.1.8104 and later")
>>> # Parse and compare against a version string
>>> if core_version_info() >= CoreVersionInfo("4.2.0"):
... print("Version 4.2.0 or later detected")
>>> # Get individual version components
>>> version = core_version_info()
>>> print(f"Running Binary Ninja {version.major}.{version.minor}.{version.build}")
"""
major: int
"""Major version number, e.g. 4.0.5000-dev would be 4"""
minor: int
"""Minor version number, e.g. 4.0.5000-dev would be 0"""
build: int
"""Build version number, e.g. 4.0.5000-dev would be 5000"""
channel: str
"""Release channel name, e.g. "dev" or "Stable" """
def __init__(self, major, minor = None, build = None, channel = None):
self.major = 0
self.minor = 0
self.build = 0
self.channel = ""
if isinstance(major, str) and minor is None and build is None and channel is None:
core_version_info = core.BNParseVersionString(major)
self.major = core_version_info.major
self.minor = core_version_info.minor
self.build = core_version_info.build
if core_version_info.channel is not None:
self.channel = core_version_info.channel
else:
self.major = major
if minor is not None:
self.minor = minor
if build is not None:
self.build = build
self.channel = channel
def __str__(self):
if self.channel == "":
return f"{self.major}.{self.minor}.{self.build}"
else:
return f"{self.major}.{self.minor}.{self.build}-{self.channel}"
def __eq__(self, other):
if isinstance(other, CoreVersionInfo):
return self.major == other.major and self.minor == other.minor and self.build == other.build # channel doesn't matter
if isinstance(other, str):
return self == CoreVersionInfo(other)
return False
def _versionCompare(self, other):
a = core.BNVersionInfo()
a.major = self.major
a.minor = self.minor
a.build = self.build
b = core.BNVersionInfo()
b.major = other.major
b.minor = other.minor
b.build = other.build
return core.BNVersionLessThan(a, b)
def __lt__(self, other):
if isinstance(other, CoreVersionInfo):
return self._versionCompare(other)
if isinstance(other, str):
return self._versionCompare(CoreVersionInfo(other))
return False
def get_unique_identifier():
"""
Generate a GUID
:return: A GUID string
"""
return core.BNGetUniqueIdentifierString()
def get_install_directory():
"""
``get_install_directory`` returns a string pointing to the installed binary currently running
"""
return core.BNGetInstallDirectory()
class _DestructionCallbackHandler:
def __init__(self):
self._cb = core.BNObjectDestructionCallbacks()
self._cb.context = 0
self._cb.destructBinaryView = self._cb.destructBinaryView.__class__(self.destruct_binary_view)
self._cb.destructFileMetadata = self._cb.destructFileMetadata.__class__(self.destruct_file_metadata)
self._cb.destructFunction = self._cb.destructFunction.__class__(self.destruct_function)
core.BNRegisterObjectDestructionCallbacks(self._cb)
def destruct_binary_view(self, ctxt, view):
binaryninja.binaryview.BinaryView._unregister(view)
def destruct_file_metadata(self, ctxt, f):
binaryninja.filemetadata.FileMetadata._unregister(f)
def destruct_function(self, ctxt, func):
binaryninja.function.Function._unregister(func)
_enable_default_log = True
_plugin_init = False
_enterprise_license_checkout = None
def _init_plugins():
global _enable_default_log
global _plugin_init
global _enterprise_license_checkout
if not _plugin_init:
if not core_ui_enabled() and (core.BNGetProduct() == "Binary Ninja Enterprise Client" or core.BNGetProduct() == "Binary Ninja Ultimate"):
# Enterprise client needs to reserve a license or else BNInitPlugins will fail
_enterprise_license_checkout = enterprise.LicenseCheckout()
_enterprise_license_checkout.acquire()
# The first call to BNInitCorePlugins returns True for successful initialization and True in this context indicates headless operation.
# The result is pulled from BNInitPlugins as that now wraps BNInitCorePlugins.
is_headless_init_once = core.BNInitPlugins(not os.environ.get('BN_DISABLE_USER_PLUGINS'))
min_level = Settings().get_string("python.log.minLevel")
if _enable_default_log and is_headless_init_once and min_level in LogLevel.__members__ and not core_ui_enabled(
) and sys.stderr.isatty():
log_to_stderr(LogLevel[min_level])
if core.BNIsLicenseValidated():
_plugin_init = True
else:
raise RuntimeError("License is not valid. Please supply a valid license.")
_destruct_callbacks = _DestructionCallbackHandler()
def disable_default_log() -> None:
'''Disable default logging in headless mode for the current session. By default, logging in headless operation is controlled by the 'python.log.minLevel' settings.'''
global _enable_default_log
_enable_default_log = False
close_logs()
def bundled_plugin_path() -> Optional[str]:
"""
``bundled_plugin_path`` returns a string containing the current plugin path inside the `install path <https://docs.binary.ninja/guide/#binary-path>`_
:return: current bundled plugin path
:rtype: str, or None on failure
"""
return core.BNGetBundledPluginDirectory()
def user_plugin_path() -> Optional[str]:
"""
``user_plugin_path`` returns a string containing the current plugin path inside the `user directory <https://docs.binary.ninja/guide/#user-folder>`_
:return: current user plugin path
:rtype: str, or None on failure
"""
return core.BNGetUserPluginDirectory()
def user_directory() -> Optional[str]:
"""
``user_directory`` returns a string containing the path to the `user directory <https://docs.binary.ninja/guide/#user-folder>`_
:return: current user path
:rtype: str, or None on failure
"""
return core.BNGetUserDirectory()
def core_version() -> Optional[str]:
"""
``core_version`` returns a string containing the current version
:return: current version
:rtype: str, or None on failure
"""
return core.BNGetVersionString()
def core_version_info() -> CoreVersionInfo:
"""
``core_version_info`` returns a CoreVersionInfo containing the current version information
:return: current version information
:rtype: CoreVersionInfo
"""
handle = core.BNGetVersionInfo()
return CoreVersionInfo(major=handle.major, minor=handle.minor, build=handle.build, channel=handle.channel)
def core_build_id() -> int:
"""
``core_build_id`` returns a integer containing the current build id
:return: current build id
:rtype: int
"""
return core.BNGetBuildId()
def core_serial() -> Optional[str]:
"""
``core_serial`` returns a string containing the current serial number
:return: current serial
:rtype: str, or None on failure
"""
_init_plugins()
return core.BNGetSerialNumber()
def core_expires() -> struct_time:
'''License Expiration'''
_init_plugins()
return gmtime(core.BNGetLicenseExpirationTime())
def core_product() -> Optional[str]:
'''Product string from the license file'''
_init_plugins()
return core.BNGetProduct()
def core_product_type() -> Optional[str]:
'''Product type from the license file'''
_init_plugins()
return core.BNGetProductType()
def core_license_count() -> int:
'''License count from the license file'''
_init_plugins()
return core.BNGetLicenseCount()
@dataclass(frozen=True)
class LicenseAddon:
'''A verified add-on attached to the active license.'''
id: str
license_serial: str
product: str
created: str
created_timestamp: int
expiration: str
expiration_timestamp: int
signature: str
def core_license_addons() -> List[LicenseAddon]:
'''License addons from the license file'''
_init_plugins()
count = ctypes.c_ulonglong()
addons = core.BNGetLicenseAddons(ctypes.byref(count))
if not addons:
return []
try:
return [LicenseAddon(
id=addons[i].id,
license_serial=addons[i].licenseSerial,
product=addons[i].product,
created=addons[i].created,
created_timestamp=addons[i].createdTimestamp,
expiration=addons[i].expiration,
expiration_timestamp=addons[i].expirationTimestamp,
signature=addons[i].signature,
) for i in range(count.value)]
finally:
core.BNFreeLicenseAddons(addons, count.value)
def core_ui_enabled() -> bool:
'''Indicates that a UI exists and the UI has invoked BNInitUI'''
return core.BNIsUIEnabled()
def core_set_license(licenseData: str) -> None:
'''
``core_set_license`` is used to initialize the core with a license file that doesn't necessarily reside on a file system. This is especially useful for headless environments such as docker where loading the license file via an environment variable allows for greater security of the license file itself.
:param str licenseData: string containing the full contents of a license file
:rtype: None
:Example:
>>> import os
>>> core_set_license(os.environ['BNLICENSE']) #Do this before creating any BinaryViews
>>> with load("/bin/ls") as bv:
... print(len(list(bv.functions)))
128
'''
core.BNSetLicense(licenseData)
def get_memory_usage_info() -> Mapping[str, int]:
"""
Get counts of various Binary Ninja objects in memory.
:return: Dictionary of {class name: count} for objects in memory
"""
count = ctypes.c_ulonglong()
info = core.BNGetMemoryUsageInfo(count)
assert info is not None, "core.BNGetMemoryUsageInfo returned None"
result = {}
for i in range(0, count.value):
result[info[i].name] = info[i].value
core.BNFreeMemoryUsageInfo(info, count.value)
return result
def get_stat_histograms() -> Mapping[str, dict]:
"""
Get per-tag bit-length histograms gathered by StatCollector instrumentation.
Each entry maps a tag name to ``{"total": int, "buckets": [int; 65]}`` where
``buckets[k]`` counts samples whose value has ``bit_width == k`` (k in 0..64) and
``total`` is the sum of the sampled values. Empty unless a ``StatCollector`` was
instantiated somewhere in the core during analysis.
:return: Dictionary of {tag name: {"total": int, "buckets": list[int]}}
"""
count = ctypes.c_ulonglong()
info = core.BNGetStatHistograms(count)
assert info is not None, "core.BNGetStatHistograms returned None"
result = {}
for i in range(0, count.value):
result[info[i].name] = {
"total": info[i].total,
"buckets": list(info[i].buckets),
}
core.BNFreeStatHistograms(info, count.value)
return result
def load(*args, **kwargs) -> BinaryView:
"""
Opens a BinaryView object.
:param Union[str, bytes, bytearray, 'databuffer.DataBuffer', 'os.PathLike', 'project.ProjectFile'] source: a file or byte stream to load into a virtual memory space
:param bool update_analysis: whether or not to run :func:`update_analysis_and_wait` after opening a :py:class:`BinaryView`, defaults to ``True``
:param callback progress_func: optional function to be called with the current progress and total count for BNDB files only
:param dict options: a dictionary in the form {setting identifier string : object value}
:return: returns a :py:class:`BinaryView` object for the given filename
:rtype: :py:class:`BinaryView`
:raises Exception: When a BinaryView could not be created
.. note:: The progress_func callback **must** return True to continue the load operation, False will abort the load operation.
.. warning:: The progress_func will **only** be called for BNDB files, not for any other file format due to a `design limitation <https://github.com/Vector35/binaryninja-api/issues/4116#issuecomment-1479496712>`_.
:Example:
>>> from binaryninja import *
>>> with load("/bin/ls") as bv:
... print(len(list(bv.functions)))
...
134
>>> with load(bytes.fromhex('5054ebfe'), options={'loader.platform' : 'x86'}) as bv:
... print(len(list(bv.functions)))
...
1
"""
bv = BinaryView.load(*args, **kwargs)
if bv is None:
raise Exception("Unable to create new BinaryView")
return bv
def connect_pycharm_debugger(port=5678):
"""
Connect to PyCharm (Professional Edition) for debugging.
.. note:: See the user documentation `pycharm note <https://docs.binary.ninja/dev/plugins.html#remote-debugging-with-intellij-pycharm>`_ for step-by-step instructions on how to set up Python debugging.
:param port: Port number for connecting to the debugger.
"""
# Get pip install string from PyCharm's Python Debug Server Configuration
# e.g. for PyCharm 2021.1.1 #PY-7142.13:
# pip install --user pydevd-pycharm~=211.7142.13
import pydevd_pycharm # type: ignore
pydevd_pycharm.settrace('localhost', port=port, stdoutToServer=True, stderrToServer=True, suspend=False)
def connect_vscode_debugger(port=5678):
"""
Connect to Visual Studio Code for debugging. This function blocks until the debugger
is connected! Not recommended for use in startup.py
.. note:: See the user documentation `vscode note <https://docs.binary.ninja/dev/plugins.html#remote-debugging-with-vscode>`_ for step-by-step instructions on how to set up Python debugging.
:param port: Port number for connecting to the debugger.
"""
# pip install --user debugpy
import debugpy # type: ignore
import sys
if sys.platform == "win32":
debugpy.configure(python=f"{sys.base_exec_prefix}/python", qt="pyside2")
else:
debugpy.configure(python=f"{sys.base_exec_prefix}/bin/python3", qt="pyside2")
debugpy.listen(("127.0.0.1", port))
debugpy.wait_for_client()
execute_on_main_thread(lambda: debugpy.debug_this_thread())
def get_system_cache_directory() -> Optional[str]:
"""
Returns Binary Ninja's system cache directory on the system.
Supported default locations:
- macOS: ~/Library/Caches/Binary Ninja
- Linux: $XDG_CACHE_HOME/Binary Ninja or ~/.cache/Binary Ninja
- Windows: %LOCALAPPDATA%/Binary Ninja/cache
:return: Returns a string containing the system cache directory, or None on failure.
"""
return core.BNGetSystemCacheDirectory()
class UIPluginInHeadlessError(Exception):
"""
Error thrown when trying to load a UI plugin in a headless Binary Ninja installation.
"""
def __init__(self, *args, **kwargs):
Exception.__init__(self, *args, **kwargs)
def fuzzy_match_single(target, query) -> Optional[int]:
"""
Fuzzy match a string against a query string. Returns a score that is higher for
a more confident match, or None if the query does not match the target string.
:param target: Target (larger) string
:param query: Query (smaller) string
:return: Confidence of match, or None if the string doesn't match
"""
result = core.BNFuzzyMatchSingle(target, query)
if result == 0:
return None
return result
def fuzzy_match_contextual(target, query) -> Optional[int]:
"""
Fuzzy match a string against a query string. Returns a score that is higher for
a more confident match, or None if the query does not match the target string.
Same algorithm as `fuzzy_match_single` but with extra heuristics based on
word boundaries and match offsets.
:param target: Target (larger) string
:param query: Query (smaller) string
:return: Confidence of match, or None if the string doesn't match
"""
result = core.BNFuzzyMatchContextual(target, query)
if result == 0:
return None
return result
# Load Collaboration scripts from Ultimate (they are bundled in shipping builds)
try:
from . import collaboration
except ImportError:
pass