PyQBDI 0.8.0__cp39-cp39-macosx_10_14_x86_64.whl → 0.11.0__cp39-cp39-macosx_10_14_x86_64.whl

{PyQBDI-0.8.0.dist-info → PyQBDI-0.11.0.dist-info}/LICENSE.txt

@@ -1,3 +1,26 @@
+################################################################################
+QBDI package license
+################################################################################
+
+QBDI binaries and packages can be statically linked with the followed source:
+
+- QBDI under the Apache License v2.0
+- LLVM under the Apache License v2.0 with LLVM Exceptions
+    https://releases.llvm.org/10.0.0/LICENSE.TXT
+- spdlog under the MIT License
+    https://github.com/gabime/spdlog/blob/v1.x/LICENSE
+- fmtlib under the MIT License
+    https://github.com/fmtlib/fmt/blob/master/LICENSE.rst
+- Catch2 under the Boost Software License 1.0
+    https://github.com/catchorg/Catch2/blob/devel/LICENSE.txt
+- Pybind11 under a BSD-style license
+    https://github.com/pybind/pybind11/blob/master/LICENSE
+- A sha256 implementation under GPLv3 / Apache License v2.0
+    https://github.com/aguinet/sha256_literal#licensing
+
+################################################################################
+QBDI source code is under the Apache License v2.0
+################################################################################
 
                                  Apache License
                            Version 2.0, January 2004
@@ -187,7 +210,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2017 Quarkslab
+   Copyright 2017 - 2024 Quarkslab
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

{PyQBDI-0.8.0.dist-info → PyQBDI-0.11.0.dist-info}/METADATA

@@ -1,29 +1,29 @@
 Metadata-Version: 2.1
 Name: PyQBDI
-Version: 0.8.0
+Version: 0.11.0
 Summary: Python binding for QBDI
-Home-page: UNKNOWN
 Author: Nicolas Surbayrole
 Author-email: qbdi@quarkslab.com
 License: apache2
 Project-URL: Documentation, https://qbdi.readthedocs.io/
 Project-URL: Source, https://github.com/QBDI/QBDI
 Project-URL: Homepage, https://qbdi.quarkslab.com/
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: C++
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Security
 Classifier: Topic :: Software Development :: Debuggers
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
 
 Introduction
 ============
@@ -32,17 +32,20 @@ Introduction
     :target: https://qbdi.readthedocs.io/en/stable/?badge=stable
     :alt: Documentation Status
 
-.. image:: https://travis-ci.com/QBDI/QBDI.svg?branch=master
-    :target: https://travis-ci.com/QBDI/QBDI
+.. image:: https://img.shields.io/github/v/release/QBDI/QBDI
+    :target: https://github.com/QBDI/QBDI/releases
 
-.. image:: https://ci.appveyor.com/api/projects/status/s2qvpu8k8yiau647/branch/master?svg=true
-    :target: https://ci.appveyor.com/project/QBDI/qbdi/branch/master
+.. image:: https://img.shields.io/pypi/pyversions/PyQBDI
+    :target: https://pypi.org/project/PyQBDI/
+
+.. image:: https://img.shields.io/pypi/v/PyQBDI
+    :target: https://pypi.org/project/PyQBDI/
 
 QuarkslaB Dynamic binary Instrumentation (QBDI) is a modular, cross-platform and cross-architecture
 DBI framework. It aims to support Linux, macOS, Android, iOS and Windows operating systems running on
 x86, x86-64, ARM and AArch64 architectures. In addition of C/C++ API, Python and JS/frida bindings are
 available to script QBDI. Information about what is a DBI framework and how QBDI
-works can be found in the user documentation introduction (`User Documentation <https://qbdi.readthedocs.io/en/stable/user.html>`_).
+works can be found in the `documentation introduction <https://qbdi.readthedocs.io/en/stable/intro.html>`_.
 
 QBDI modularity means it doesn't contain a preferred injection method and it is designed to be
 used in conjunction with an external injection tool. QBDI includes a tiny (``LD_PRELOAD`` based)
@@ -63,18 +66,16 @@ Status
 .. role:: orange
 .. role:: red
 
-=======   ==============================   ======================   =================================
-CPU       Operating Systems                Execution                Memory Access Information
-=======   ==============================   ======================   =================================
-x86-64    Android, Linux, macOS, Windows   :green:`Supported`       :green:`Supported`
-x86       Android, Linux, macOS, Windows   :green:`Supported`       :green:`Supported`
-ARM       Linux, Android, iOS              :orange:`Planned (*)`    :orange:`Planned (*)`
-AArch64   Android                          :orange:`Planned (*)`    :orange:`Planned (*)`
-=======   ==============================   ======================   =================================
-
-.. warning::
+=======   ==============================   ========================   =================================
+CPU       Operating Systems                Execution                  Memory Access Information
+=======   ==============================   ========================   =================================
+x86-64    Android, Linux, macOS, Windows   :green:`Supported`         :green:`Supported`
+x86       Android, Linux, macOS, Windows   :green:`Supported`         :green:`Supported`
+ARM       Android, Linux                   :yellow:`Supported (*)`    :yellow:`Supported (*)`
+AArch64   Android, Linux, macOS            :yellow:`Supported (*)`    :yellow:`Supported (*)`
+=======   ==============================   ========================   =================================
 
-   The ARM and AArch64 instruction sets are supported but they still need to be integrated along with x86 and x86-64.
+\* The ARM and AArch64 instruction sets are supported but in early support.
 
 Installation
 ============
@@ -82,7 +83,7 @@ Installation
 Python API (PyQBDI)
 +++++++++++++++++++
 
-PyQBDI is available through PyPI. The wheel package can be either `downloaded <https://pypi.org/project/PyQBDI/#files>`_ or installed with the following command:
+PyQBDI is available through PyPI. The wheel package can be either `downloaded <https://pypi.org/project/PyQBDI/#files>`__ or installed with the following command:
 
     pip install PyQBDI
 
@@ -95,8 +96,20 @@ There is no strict development timeline or scheduled release plan for the QBDI p
 All the new features and fixes are merged onto the ``dev-next`` branch.
 Devel packages can be downloaded in the artefacts of:
 
-- `Appveyor <https://ci.appveyor.com/project/QBDI/qbdi/branch/dev-next>`_ for Windows packages PyQBDI
-- `Github Actions PyQBDI Linux <https://github.com/QBDI/QBDI/actions?query=workflow%3A%22PyQBDI+Linux+package%22+branch%3Adev-next>`_ for Linux PyQBDI
-- `Github Actions PyQBDI OSX <https://github.com/QBDI/QBDI/actions?query=workflow%3A%22PyQBDI+OSX+package%22+branch%3Adev-next>`_ for OSX PyQBDI
+- `Github Actions <https://github.com/QBDI/QBDI/actions/workflows/python_linux.yml?query=branch%3Adev-next>`__ for Linux PyQBDI
+- `Github Actions <https://github.com/QBDI/QBDI/actions/workflows/python_osx.yml?query=branch%3Adev-next>`__ for OSX PyQBDI
+- `Github Actions <https://github.com/QBDI/QBDI/actions/workflows/python_windows.yml?query=branch%3Adev-next>`__ for windows PyQBDI
+
+Compilation
+===========
+
+The PyQDBI library (apart from the wheel package) can be built by solely passing the **'-DQBDI_TOOLS_PYQBDI=ON'** option to the CMake build system.
+
+However, if you want to build the wheel package, you can run these commands::
 
+    git clone https://github.com/QBDI/QBDI.git
+    python -m pip install --upgrade pip
+    python -m pip install setuptools wheel build
+    python -m build -w
 
+A 32-bit version of Python is mandatory for the X86 architecture whereas a 64-bit one is required for the X86-64 architecture.

PyQBDI-0.11.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+pyqbdi.cpython-39-darwin.so,sha256=CmoJFqVEEutwXkfT_QFbdK6AvEqZuGuXa7PDwNF3HB8,6993336
+pyqbdipreload.py,sha256=FkavEnds5DCFPnNLoHJ0LJtXVTjSRaWyYJRkcsjPFLc,3505
+pyqbdipreloadlib.cpython-39-darwin.so,sha256=ikIcn565ds686CzGaJNQ8Wmz4NfXstfQL663_2CV6w0,7085104
+PyQBDI-0.11.0.dist-info/LICENSE.txt,sha256=J-slihDKKorAhYuNFzflMLU8JARSPYV9wfMZIHWr0qE,12462
+PyQBDI-0.11.0.dist-info/METADATA,sha256=fPm09oSNOR_cjMiaHya5YeXOOp4O0L1k7UfPLRKjG-0,5210
+PyQBDI-0.11.0.dist-info/WHEEL,sha256=9KZ-3KJ1_ukzk3kLb-1Vnr7aqAIrAYGNgZNCTAyImgs,110
+PyQBDI-0.11.0.dist-info/top_level.txt,sha256=vaVfPcyi2OkulsN7QdaZiIKzq2GbFV2q24OujHZlbRc,7
+PyQBDI-0.11.0.dist-info/RECORD,,

{PyQBDI-0.8.0.dist-info → PyQBDI-0.11.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.36.2)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: false
 Tag: cp39-cp39-macosx_10_14_x86_64
 

pyqbdipreload.py

@@ -2,7 +2,7 @@
 
 # This file is part of pyQBDI (python binding for QBDI).
 #
-# Copyright 2017 Quarkslab
+# Copyright 2017 - 2024 Quarkslab
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,22 +22,37 @@ import pyqbdi
 from ctypes import util as ctypesutil
 import sys
 import os
-
+import argparse
 
 def run():
 
-    if len(sys.argv) <= 2 or sys.argv[1] in ['-h', '--help']:
-        print("Usage: python -m {} <script> <target> [<args> ...]".format(sys.argv[0]))
-        exit(1)
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("script", type=str, help="PyQBDI script")
+    parser.add_argument("target", type=str, help="command to instrument")
+    parser.add_argument("args", type=str, help="command arguments", nargs='*')
+
+    args = parser.parse_args()
 
-    script = sys.argv[1]
-    binary = sys.argv[2]
-    args = sys.argv[2:]
+    script = args.script
+    binary = args.target
+    args = [args.target] + args.args
     environ = os.environ.copy()
 
+    preloadlib = os.path.join(
+            os.path.dirname(pyqbdi.__file__),
+            os.path.basename(pyqbdi.__file__).replace("pyqbdi", "pyqbdipreloadlib"))
+
+    if not os.path.isfile(preloadlib):
+        print("Cannot found pyqbdi preload library : {}".format(preloadlib))
+        exit(1)
+
     # add LD_PRELOAD or DYLD_INSERT_LIBRARIES
     if platform.system() == 'Darwin':
-        environ["DYLD_INSERT_LIBRARIES"] = pyqbdi.__file__
+
+        environ["DYLD_INSERT_LIBRARIES"] = preloadlib
+        environ["DYLD_LIBRARY_PATH"] = os.path.join(sys.base_prefix, 'lib')
+        environ["DYLD_BIND_AT_LAUNCH"] = "1"
     elif platform.system() == 'Linux':
         libpythonname = "python{}.{}".format(sys.version_info.major, sys.version_info.minor)
         libpython = ctypesutil.find_library(libpythonname)
@@ -48,7 +63,7 @@ def run():
                 print("PyQBDI in PRELOAD mode need lib{}.so".format(libpythonname))
                 exit(1)
 
-        environ["LD_PRELOAD"] = os.pathsep.join([libpython, pyqbdi.__file__])
+        environ["LD_PRELOAD"] = os.pathsep.join([libpython, preloadlib])
         environ["LD_BIND_NOW"] = "1"
     else:
         print("PyQBDI in PRELOAD mode is not supported on this platform")

PyQBDI-0.8.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-pyqbdi.so,sha256=W9JU133gX12DpIRsqokaxNdFDwNARCPygkgcTmtSOKM,6673600
-pyqbdipreload.py,sha256=hmbPXj9_SxfwGfs7-YPqH90Wr-DW7y0P1hDFsG-fYck,2937
-PyQBDI-0.8.0.dist-info/LICENSE.txt,sha256=9gme0jaChArmCnb843j6rptcdffRYhiIg-E7eQyhi5g,11340
-PyQBDI-0.8.0.dist-info/METADATA,sha256=kbU6iq-Z33cwisegCPiTeM0C9gT2Hwdyy8-RgtJPvGw,4662
-PyQBDI-0.8.0.dist-info/WHEEL,sha256=7vkJ3ZnexegyTUl8grQkOVww_TVBMjxMIgcotcWEQj4,110
-PyQBDI-0.8.0.dist-info/top_level.txt,sha256=vaVfPcyi2OkulsN7QdaZiIKzq2GbFV2q24OujHZlbRc,7
-PyQBDI-0.8.0.dist-info/RECORD,,