PyQBDI 0.12.1__cp312-cp312-win32.whl

pyqbdi-0.12.1.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: PyQBDI
+Version: 0.12.1
+Summary: Python binding for QBDI
+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/
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: C++
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Debuggers
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Dynamic: license-file
+
+Introduction
+============
+
+.. image:: https://readthedocs.org/projects/qbdi/badge/?version=stable
+    :target: https://qbdi.readthedocs.io/en/stable/?badge=stable
+    :alt: Documentation Status
+
+.. image:: https://img.shields.io/github/v/release/QBDI/QBDI
+    :target: https://github.com/QBDI/QBDI/releases
+
+.. 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 `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)
+Linux and macOS injector for dynamic executables (QBDIPreload).
+QBDI is also fully integrated with `Frida <https://frida.re>`_, a reference dynamic instrumentation toolkit,
+allowing anybody to use their combined powers.
+
+A current limitation is that QBDI doesn't handle signals, multithreading (it doesn't deal with new
+threads creation) and C++ exception mechanisms.
+However, those system-dependent features will probably not be part of the core library (KISS),
+and should be integrated as a new layer (to be determined how).
+
+Status
+++++++
+
+.. role:: green
+.. role:: yellow
+.. 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       Android, Linux                   :green:`Supported`   :green:`Supported`
+AArch64   Android, Linux, macOS, IOs (*)   :green:`Supported`   :green:`Supported`
+=======   ==============================   ==================   =========================
+
+\* IOs support is unstable and need a jailbroken device.
+
+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:
+
+    pip install PyQBDI
+
+The PyQBDI package is self-contained so completely independent from the C/C++ package.
+
+Devel packages
+++++++++++++++
+
+There is no strict development timeline or scheduled release plan for the QBDI project.
+All the new features and fixes are merged onto the ``dev-next`` branch.
+Devel packages can be downloaded in the artefacts of `Github Actions <https://github.com/QBDI/QBDI/actions/workflows/python.yml?query=branch%3Adev-next>`__.
+
+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.12.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+pyqbdi.pyd,sha256=3WQj1SiswPcjMG-aN0OIMHFCVoo_YPGuDW2A5TZ2qi4,7343104
+pyqbdiWinPreloader.exe,sha256=EJLISki_pkdNO-I9LGDJ4KABIr3kPyMVJxhE7gDK4y8,11776
+pyqbdipreload.py,sha256=hANOaHha85XUt4Kub8f2lsKZhIErsfkKNAq4O6PZ3lA,5814
+pyqbdipreloadlib.cp312-win32.pyd,sha256=TrzGE7pmbr5W_nvRofC8UqAFKuN8LUISbiWg50-We3s,7356928
+pyqbdi-0.12.1.dist-info/licenses/LICENSE.txt,sha256=gOUvR_mAOk85D4IBVtoFVh5kieG_u0_0yKXHcETHd34,12687
+pyqbdi-0.12.1.dist-info/METADATA,sha256=_Bell7CFOs0T_ilQI8QJjvTO6syoXB_Ti5dvCevysWc,5001
+pyqbdi-0.12.1.dist-info/WHEEL,sha256=LwxTQZ0gyDP_uaeNCLm-ZIktY9hv6x0e22Q-hgFd-po,97
+pyqbdi-0.12.1.dist-info/top_level.txt,sha256=vaVfPcyi2OkulsN7QdaZiIKzq2GbFV2q24OujHZlbRc,7
+pyqbdi-0.12.1.dist-info/RECORD,,

pyqbdi-0.12.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp312-cp312-win32
+

pyqbdi-0.12.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,225 @@
+################################################################################
+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
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 - 2025 Quarkslab
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pyqbdi-0.12.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyqbdi

pyqbdipreload.py

@@ -0,0 +1,160 @@
+#!/usr/bin/env python3
+
+# This file is part of pyQBDI (python binding for QBDI).
+#
+# Copyright 2017 - 2025 Quarkslab
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import platform
+import pyqbdi
+from ctypes import util as ctypesutil
+import sys
+import os
+import argparse
+import subprocess
+
+def get_preloadlib():
+    if platform.system() == 'Windows':
+        import importlib
+        # ['.py', '.pyw', '.pyc', '.cp310-win_amd64.pyd', '.pyd']
+        # find correct extension on windows like .cp310-win_amd64.pyd
+        for ext in importlib.machinery.all_suffixes():
+            preloadlib = os.path.join(
+                os.path.dirname(pyqbdi.__file__),
+                f"pyqbdipreloadlib{ext}")
+            if os.path.isfile(preloadlib):
+                return preloadlib
+    else:
+        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 find pyqbdi preload library : {}".format(preloadlib))
+        exit(1)
+    return preloadlib
+
+def find_binary(environ, binary, canFail=False):
+    # https://docs.python.org/3.8/library/os.html#os.execve:
+    # "execve will not use the PATH variable to locate the executable; path must contain an appropriate absolute or relative path."
+    # seach the binary path in PATH if needed
+    binarypath = None
+    if '/' in binary or '\\' in binary:
+        # absolute or relative path
+        binarypath = binary
+    else:
+        if os.path.isfile(binary):  # case for current dir on windows
+            return binary
+        if "PATH" in environ:
+            for p in environ["PATH"].split(os.pathsep):
+                if os.path.isfile(os.path.join(p, binary)):
+                    binarypath = os.path.join(p, binary)
+                    break
+
+    if not binarypath or not os.path.isfile(binarypath):
+        if canFail:
+            return None
+        print("Cannot find binary {} make sure its in your PATH env".format(binary))
+        exit(1)
+
+    return binarypath
+
+def find_windows_inject_binary(environ):
+
+    listPreloader = [
+            os.path.join(os.path.dirname(pyqbdi.__file__), "pyqbdiWinPreloader.exe"),
+            "QBDIWinPreloader.exe"]
+
+    for binary in listPreloader:
+        binarypath = find_binary(environ, binary, True)
+        if binarypath is not None:
+            return binarypath
+
+    print("Cannot find Windows injector binary (within {}), make sure one of them are available".format(listPreloader))
+    exit(1)
+
+
+def run():
+
+    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 = args.script
+    binary = args.target
+    execargs = [args.target] + args.args
+    environ = os.environ.copy()
+
+    preloadlib = get_preloadlib()
+    binarypath = find_binary(environ, binary)
+
+    # add LD_PRELOAD or DYLD_INSERT_LIBRARIES
+    if platform.system() == 'Darwin':
+
+        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)
+        if not libpython:
+            libpythonname = "python{}.{}{}".format(
+                sys.version_info.major, sys.version_info.minor, sys.abiflags)
+            libpython = ctypesutil.find_library(libpythonname)
+            if not libpython:
+                print("PyQBDI in PRELOAD mode need lib{}.so".format(libpythonname))
+                exit(1)
+
+        for s in [libpython, preloadlib]:
+            for c in [" ", ";", os.pathsep]:
+                if c in s:
+                    print(f"Error: found character '{c}' in {s}")
+                    print(f"PyQBDIPrelaod is based on ld.so, which didn't accept '{c}' in LD_PRELOAD.")
+                    print("Please check your installation to avoid ' ' and ';' in file path")
+                    exit(1)
+
+
+        environ["LD_PRELOAD"] = os.pathsep.join([libpython, preloadlib])
+        environ["LD_BIND_NOW"] = "1"
+    elif platform.system() == 'Windows':
+        targetbinary = binarypath
+        binarypath = find_windows_inject_binary(environ)
+        execargs = [binarypath, preloadlib, targetbinary] + execargs[1:]
+    else:
+        print("PyQBDI in PRELOAD mode is not supported on this platform")
+        exit(1)
+
+    # add PYQBDI_TOOL
+    if not os.path.isfile(script):
+        print("Cannot find {} script".format(script))
+        exit(1)
+    else:
+        environ["PYQBDI_TOOL"] = script
+
+    if platform.system() == 'Windows':
+        proc = subprocess.run(execargs, env=environ)
+        exit(proc.returncode)
+    else:
+        os.execve(binarypath, execargs, environ)
+        print("Fail execve")
+        exit(1)
+
+
+if __name__ == "__main__":
+    run()