From 3b766be616ed76124b3273b33c42842b16def2e0 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Mar 2019 20:36:18 -0700 Subject: [PATCH 01/25] Add utils.search_buffer_verbatim() --- mem_edit/utils.py | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/mem_edit/utils.py b/mem_edit/utils.py index c2e691f..fc15970 100644 --- a/mem_edit/utils.py +++ b/mem_edit/utils.py @@ -23,9 +23,32 @@ class MemEditError(Exception): pass +def search_buffer_verbatim(needle_buffer: ctypes_buffer_t, haystack_buffer: ctypes_buffer_t) -> List[int]: + """ + Search for a buffer inside another buffer, using a direct (bitwise) comparison + + :param needle_buffer: Buffer to search for. + :param haystack_buffer: Buffer to search in. + :return: List of offsets where the needle_buffer was found. + """ + found = [] + + haystack = bytes(haystack_buffer) + needle = bytes(needle_buffer) + + start = 0 + result = haystack.find(needle, start) + while start < len(haystack) and result != -1: + found.append(result) + start = result + 1 + result = haystack.find(needle, start) + return found + + def search_buffer(needle_buffer: ctypes_buffer_t, haystack_buffer: ctypes_buffer_t) -> List[int]: """ - Search for a buffer inside another buffer. + Search for a buffer inside another buffer, using ctypes_equal for comparison. + Much slower than search_buffer_verbatim. :param needle_buffer: Buffer to search for. :param haystack_buffer: Buffer to search in. @@ -46,7 +69,7 @@ def ctypes_equal(a: ctypes_buffer_t, b: ctypes_buffer_t) -> bool: """ if not type(a) == type(b): return False - + if isinstance(a, ctypes.Array): return a[:] == b[:] elif isinstance(a, ctypes.Structure) or isinstance(a, ctypes.Union): From 522999cd61a9ac66fa33545477a587c737246366 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Mar 2019 20:39:58 -0700 Subject: [PATCH 02/25] Add verbatim mode to searches (default true) --- mem_edit/abstract.py | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/mem_edit/abstract.py b/mem_edit/abstract.py index e08740a..fb463f7 100644 --- a/mem_edit/abstract.py +++ b/mem_edit/abstract.py @@ -9,7 +9,8 @@ import copy import ctypes import logging -from .utils import ctypes_buffer_t, search_buffer, ctypes_equal +from . import utils +from .utils import ctypes_buffer_t logging.basicConfig(level=logging.INFO) @@ -240,7 +241,7 @@ class Process(metaclass=ABCMeta): values = [self.read_memory(base + offset, buffer) for offset, buffer in targets] return values - def search_addresses(self, addresses: List[int], needle_buffer: ctypes_buffer_t) -> List[int]: + def search_addresses(self, addresses: List[int], needle_buffer: ctypes_buffer_t, verbatim: bool=True) -> List[int]: """ Search for the provided value at each of the provided addresses, and return the addresses where it is found. @@ -249,18 +250,26 @@ class Process(metaclass=ABCMeta): :param needle_buffer: The value to search for. This should be a ctypes object of the same sorts as used by .read_memory(...), which will be compared to the contents of memory at each of the given addresses. + :param verbatim: If True, perform bitwise comparison when searching for needle_buffer. + If False, perform utils.ctypes_equal-based comparison. Default True. :return: List of addresses where the needle_buffer was found. """ found = [] read_buffer = copy.copy(needle_buffer) + if verbatim: + def compare(a, b): + return bytes(read_buffer) == bytes(needle_buffer) + else: + compare = utils.ctypes_equal + for address in addresses: - read = self.read_memory(address, read_buffer) - if ctypes_equal(needle_buffer, read): + self.read_memory(address, read_buffer) + if compare(needle_buffer, read_buffer): found.append(address) return found - def search_all_memory(self, needle_buffer, writeable_only=True) -> List[int]: + def search_all_memory(self, needle_buffer: ctypes_buffer_t, writeable_only: bool=True, verbatim: bool=True) -> List[int]: """ Search the entire memory space accessible to the process for the provided value. @@ -268,14 +277,22 @@ class Process(metaclass=ABCMeta): sorts as used by .read_memory(...), which will be compared to the contents of memory at each accessible address. :param writeable_only: If True, only search regions where the process has write access. + Default True. + :param verbatim: If True, perform bitwise comparison when searching for needle_buffer. + If False, perform utils.ctypes_equal-based comparison. Default True. :return: List of addresses where the needle_buffer was found. """ found = [] + if verbatim: + search = utils.search_buffer_verbatim + else: + search = utils.search_buffer + for start, stop in self.list_mapped_regions(writeable_only): try: region_buffer = (ctypes.c_byte * (stop - start))() self.read_memory(start, region_buffer) - found += [offset + start for offset in search_buffer(needle_buffer, region_buffer)] + found += [offset + start for offset in search(needle_buffer, region_buffer)] except OSError: logger.error('Failed to read in range 0x{} - 0x{}'.format(start, stop)) return found From 5021d5fb9ad38e9baef1c6f33d8cae8c69aabcff Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Mar 2019 20:50:19 -0700 Subject: [PATCH 03/25] indicate python3 for setup --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 46b51f6..fff6ea7 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 from setuptools import setup, find_packages From 571ecc7a956b2d9cad6e09d90633a354d43729b6 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Mar 2019 20:51:26 -0700 Subject: [PATCH 04/25] Add readme as long_description --- setup.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/setup.py b/setup.py index fff6ea7..b34402f 100644 --- a/setup.py +++ b/setup.py @@ -2,9 +2,16 @@ from setuptools import setup, find_packages + +with open('README.md', 'r') as f: + long_description = f.read() + + setup(name='mem_edit', version='0.1', description='Multi-platform library for memory editing', + long_description=long_description, + long_description_content_type='text/markdown', author='Jan Petykiewicz', author_email='anewusername@gmail.com', url='https://mpxd.net/code/jan/mem_edit', From 53b1b1ade8a6c4ff82d52dcaea955303db026314 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Mar 2019 20:52:41 -0700 Subject: [PATCH 05/25] Bump python version used for writing/testing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 71840ab..66ecc88 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ ## Installation **Dependencies:** -* python 3 (written and tested with 3.5) +* python 3 (written and tested with 3.7) * ctypes * typing (for type annotations) From 83e105dc302b8ccc4dd96b6c158b3da1a5cd27ec Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Mar 2019 20:53:24 -0700 Subject: [PATCH 06/25] Bump version to 0.2; Move version number into module --- mem_edit/__init__.py | 1 + setup.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/mem_edit/__init__.py b/mem_edit/__init__.py index 9f3fbf9..8391f4f 100644 --- a/mem_edit/__init__.py +++ b/mem_edit/__init__.py @@ -17,6 +17,7 @@ from .utils import MemEditError __author__ = 'Jan Petykiewicz' +version = '0.2' system = platform.system() diff --git a/setup.py b/setup.py index b34402f..2b6ecbe 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,7 @@ #!/usr/bin/env python3 from setuptools import setup, find_packages +import mem_edit with open('README.md', 'r') as f: @@ -8,7 +9,7 @@ with open('README.md', 'r') as f: setup(name='mem_edit', - version='0.1', + version=mem_edit.version, description='Multi-platform library for memory editing', long_description=long_description, long_description_content_type='text/markdown', From d0bbed8db1bcf279d27ff9f3c8a1b5f8291bc1d5 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Mar 2019 20:57:09 -0700 Subject: [PATCH 07/25] remove ctypes from reqs, should be built-in --- setup.py | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.py b/setup.py index 2b6ecbe..bec3d13 100644 --- a/setup.py +++ b/setup.py @@ -51,7 +51,6 @@ setup(name='mem_edit', ], packages=find_packages(), install_requires=[ - 'ctypes', 'typing', ], extras_require={ From 6321d4221c1a9e5e7a20e706780c04e6184ae41c Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Mar 2019 21:13:19 -0700 Subject: [PATCH 08/25] specify pip3 in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 66ecc88..7367bc5 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,12 @@ Install with pip, from PyPI (preferred): ```bash -pip install mem_edit +pip3 install mem_edit ``` Install with pip from git repository ```bash -pip install git+https://mpxd.net/code/jan/mem_edit.git@release +pip3 install git+https://mpxd.net/code/jan/mem_edit.git@release ``` From 49a7c21ed2c1d38e8cac2f65223da7884551ea91 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Mon, 30 Sep 2019 23:59:20 -0700 Subject: [PATCH 09/25] Move version number into VERSION file to avoid importing mem_edit in setup.py --- MANIFEST.in | 1 + mem_edit/VERSION | 1 + mem_edit/__init__.py | 6 +++++- setup.py | 9 ++++++--- 4 files changed, 13 insertions(+), 4 deletions(-) create mode 100644 mem_edit/VERSION diff --git a/MANIFEST.in b/MANIFEST.in index c28ab72..2b8b271 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,3 @@ include README.md include LICENSE.md +include mem_edit/VERSION diff --git a/mem_edit/VERSION b/mem_edit/VERSION new file mode 100644 index 0000000..3b04cfb --- /dev/null +++ b/mem_edit/VERSION @@ -0,0 +1 @@ +0.2 diff --git a/mem_edit/__init__.py b/mem_edit/__init__.py index 8391f4f..8947638 100644 --- a/mem_edit/__init__.py +++ b/mem_edit/__init__.py @@ -12,12 +12,16 @@ To get started, try: """ import platform +import pathlib from .utils import MemEditError __author__ = 'Jan Petykiewicz' -version = '0.2' + +with open(pathlib.Path(__file__).parent / 'VERSION', 'r') as f: + __version__ = f.read().strip() +version = __version__ system = platform.system() diff --git a/setup.py b/setup.py index bec3d13..5f6ecf2 100644 --- a/setup.py +++ b/setup.py @@ -1,15 +1,15 @@ #!/usr/bin/env python3 from setuptools import setup, find_packages -import mem_edit - with open('README.md', 'r') as f: long_description = f.read() +with open('mem_edit/VERSION', 'r') as f: + version = f.read().strip() setup(name='mem_edit', - version=mem_edit.version, + version=version, description='Multi-platform library for memory editing', long_description=long_description, long_description_content_type='text/markdown', @@ -50,6 +50,9 @@ setup(name='mem_edit', 'Topic :: Utilities', ], packages=find_packages(), + package_data={ + 'mem_edit': ['VERSION'] + }, install_requires=[ 'typing', ], From e842f8157509c6e19d47752fed4e3458d5698ebb Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Mon, 30 Sep 2019 23:59:28 -0700 Subject: [PATCH 10/25] update tags --- setup.py | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.py b/setup.py index 5f6ecf2..5b53ab7 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,6 @@ setup(name='mem_edit', 'trainer', ], classifiers=[ - 'Programming Language :: Python', 'Programming Language :: Python :: 3', 'Development Status :: 4 - Beta', 'Environment :: Other Environment', From e8c6c4f74c393615e6ec20c386bd9361e0787a7a Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Mon, 30 Sep 2019 23:59:37 -0700 Subject: [PATCH 11/25] clean up whitespace --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7367bc5..53789b7 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ **Dependencies:** * python 3 (written and tested with 3.7) -* ctypes -* typing (for type annotations) +* ctypes +* typing (for type annotations) Install with pip, from PyPI (preferred): @@ -55,7 +55,7 @@ Increment a magic number (unsigned long 1234567890) found in 'magic.exe': pid = Process.get_pid_by_name('magic.exe') with Process.open_process(pid) as p: addrs = p.search_all_memory(magic_number) - + # We don't want to edit if there's more than one result... assert(len(addrs) == 1) @@ -104,7 +104,7 @@ Read and alter a structure: s = MyStruct() s.first_member = 1234567890 s.second_member = 0x1234 - + addrs = p.search_all_memory(s) print(addrs) From 8b5d5af95b0abc0a06c95b8187dd120b1acbb7f2 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Tue, 1 Oct 2019 00:00:06 -0700 Subject: [PATCH 12/25] bump version number to 0.3 --- mem_edit/VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem_edit/VERSION b/mem_edit/VERSION index 3b04cfb..be58634 100644 --- a/mem_edit/VERSION +++ b/mem_edit/VERSION @@ -1 +1 @@ -0.2 +0.3 From 4deaa41d7e8a48a15da53d2f363e00da6db91d8b Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 27 Oct 2019 13:05:27 -0700 Subject: [PATCH 13/25] whitespace fixes --- mem_edit/linux.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/mem_edit/linux.py b/mem_edit/linux.py index 4dafd1c..ae8404d 100644 --- a/mem_edit/linux.py +++ b/mem_edit/linux.py @@ -40,7 +40,7 @@ def ptrace(command: int, pid: int = 0, arg1: int = 0, arg2: int = 0) -> int: """ Call ptrace() with the provided pid and arguments. See the ```man ptrace```. """ - logger.debug('ptrace({}, {}, {}, {})'.format(command, pid, arg1, arg2)) + logger.debug('ptrace({}, {}, {}, {})'.format(command, pid, arg1, arg2)) result = _ptrace(command, pid, arg1, arg2) if result == -1: err_no = ctypes.get_errno() @@ -58,7 +58,7 @@ class Process(AbstractProcess): self.pid = process_id def close(self): - os.kill(self.pid, signal.SIGSTOP) + os.kill(self.pid, signal.SIGSTOP) ptrace(ptrace_commands['PTRACE_DETACH'], self.pid, 0, 0) self.pid = None @@ -78,7 +78,7 @@ class Process(AbstractProcess): with open('/proc/{}/cmdline', 'rb') as f: return f.read().decode().split('\x00')[0] except FileNotFoundError: - return '' + return '' @staticmethod def list_available_pids() -> List[int]: From 260d67bf815796371d63e87cdd791c98f765d71b Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 27 Oct 2019 13:54:43 -0700 Subject: [PATCH 14/25] update gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 79a8109..6ad846b 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ __pycache__ *.pyc *.egg-info/ +build/ dist/ From bd6c22ca1d70ec579891b3f45e3ce40ce7886d43 Mon Sep 17 00:00:00 2001 From: jan Date: Wed, 15 Apr 2020 01:32:33 -0700 Subject: [PATCH 15/25] windows: Don't fail search on unopenable process --- mem_edit/windows.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mem_edit/windows.py b/mem_edit/windows.py index 038c58a..0954403 100644 --- a/mem_edit/windows.py +++ b/mem_edit/windows.py @@ -205,6 +205,8 @@ class Process(AbstractProcess): return pid except ValueError: pass + except MemEditError as err: + logger.info(repr(err)) logger.info('Found no process with name {}'.format(target_name)) return None From 5c75da31d5a7ec1e43f9ab542c1f8b4eea01f44a Mon Sep 17 00:00:00 2001 From: jan Date: Wed, 15 Apr 2020 01:33:36 -0700 Subject: [PATCH 16/25] support 64-bit python --- mem_edit/windows.py | 44 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 38 insertions(+), 6 deletions(-) diff --git a/mem_edit/windows.py b/mem_edit/windows.py index 0954403..cdaf657 100644 --- a/mem_edit/windows.py +++ b/mem_edit/windows.py @@ -67,19 +67,51 @@ mem_types = { 'MEM_PRIVATE': 0x20000, } - # C struct for VirtualQueryEx -class MEMORY_BASIC_INFORMATION(ctypes.Structure): +class MEMORY_BASIC_INFORMATION32(ctypes.Structure): _fields_ = [ - ('BaseAddress', ctypes.c_void_p), - ('AllocationBase', ctypes.c_void_p), + ('BaseAddress', ctypes.wintypes.DWORD), + ('AllocationBase', ctypes.wintypes.DWORD), ('AllocationProtect', ctypes.wintypes.DWORD), - ('RegionSize', ctypes.wintypes.UINT), + ('RegionSize', ctypes.wintypes.DWORD), ('State', ctypes.wintypes.DWORD), ('Protect', ctypes.wintypes.DWORD), ('Type', ctypes.wintypes.DWORD), ] +class MEMORY_BASIC_INFORMATION64(ctypes.Structure): + _fields_ = [ + ('BaseAddress', ctypes.c_ulonglong), + ('AllocationBase', ctypes.c_ulonglong), + ('AllocationProtect', ctypes.wintypes.DWORD), + ('__alignment1', ctypes.wintypes.DWORD), + ('RegionSize', ctypes.c_ulonglong), + ('State', ctypes.wintypes.DWORD), + ('Protect', ctypes.wintypes.DWORD), + ('Type', ctypes.wintypes.DWORD), + ('__alignment2', ctypes.wintypes.DWORD), + ] + +PTR_SIZE = ctypes.sizeof(ctypes.c_void_p) +if PTR_SIZE == 8: # 64-bit python + MEMORY_BASIC_INFORMATION = MEMORY_BASIC_INFORMATION64 +elif PTR_SIZE == 4: # 32-bit python + MEMORY_BASIC_INFORMATION = MEMORY_BASIC_INFORMATION32 + +ctypes.windll.kernel32.VirtualQueryEx.argtypes = [ctypes.wintypes.HANDLE, + ctypes.wintypes.LPCVOID, + ctypes.c_void_p, + ctypes.c_size_t] +ctypes.windll.kernel32.ReadProcessMemory.argtypes = [ctypes.wintypes.HANDLE, + ctypes.wintypes.LPCVOID, + ctypes.c_void_p, + ctypes.c_size_t, + ctypes.c_void_p] +ctypes.windll.kernel32.WriteProcessMemory.argtypes = [ctypes.wintypes.HANDLE, + ctypes.wintypes.LPCVOID, + ctypes.c_void_p, + ctypes.c_size_t, + ctypes.c_void_p] # C struct for GetSystemInfo class SYSTEM_INFO(ctypes.Structure): @@ -89,7 +121,7 @@ class SYSTEM_INFO(ctypes.Structure): ('dwPageSize', ctypes.wintypes.DWORD), ('lpMinimumApplicationAddress', ctypes.c_void_p), ('lpMaximumApplicationAddress', ctypes.c_void_p), - ('dwActiveProcessorMask', ctypes.wintypes.DWORD), + ('dwActiveProcessorMask', ctypes.c_void_p), ('dwNumberOfProcessors', ctypes.wintypes.DWORD), ('dwProcessorType', ctypes.wintypes.DWORD), ('dwAllocationGranularity', ctypes.wintypes.DWORD), From 0632b205abd708879443af9765ca57d26bd72238 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Wed, 15 Apr 2020 02:03:13 -0700 Subject: [PATCH 17/25] bump version number to v0.4: fixed on 64-bit python on windows --- mem_edit/VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem_edit/VERSION b/mem_edit/VERSION index be58634..bd73f47 100644 --- a/mem_edit/VERSION +++ b/mem_edit/VERSION @@ -1 +1 @@ -0.3 +0.4 From 9759645f927f42f72794b7df2f57fa721fbda39c Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 1 Nov 2020 20:16:06 -0800 Subject: [PATCH 18/25] move version info into VERSION.py This avoid needing custom spec files for pyinstaller, which doesn't handle package_data by default --- mem_edit/VERSION | 1 - mem_edit/VERSION.py | 4 ++++ mem_edit/__init__.py | 6 ++---- setup.py | 6 +++--- 4 files changed, 9 insertions(+), 8 deletions(-) delete mode 100644 mem_edit/VERSION create mode 100644 mem_edit/VERSION.py diff --git a/mem_edit/VERSION b/mem_edit/VERSION deleted file mode 100644 index bd73f47..0000000 --- a/mem_edit/VERSION +++ /dev/null @@ -1 +0,0 @@ -0.4 diff --git a/mem_edit/VERSION.py b/mem_edit/VERSION.py new file mode 100644 index 0000000..a3aacc8 --- /dev/null +++ b/mem_edit/VERSION.py @@ -0,0 +1,4 @@ +""" VERSION defintion. THIS FILE IS MANUALLY PARSED BY setup.py and REQUIRES A SPECIFIC FORMAT """ +__version__ = ''' +0.4 +''' diff --git a/mem_edit/__init__.py b/mem_edit/__init__.py index 8947638..a4a0178 100644 --- a/mem_edit/__init__.py +++ b/mem_edit/__init__.py @@ -12,16 +12,14 @@ To get started, try: """ import platform -import pathlib from .utils import MemEditError __author__ = 'Jan Petykiewicz' -with open(pathlib.Path(__file__).parent / 'VERSION', 'r') as f: - __version__ = f.read().strip() -version = __version__ +from .VERSION import __version__ +version = __version__ # legacy compatibility system = platform.system() diff --git a/setup.py b/setup.py index 5b53ab7..3a55145 100644 --- a/setup.py +++ b/setup.py @@ -5,8 +5,8 @@ from setuptools import setup, find_packages with open('README.md', 'r') as f: long_description = f.read() -with open('mem_edit/VERSION', 'r') as f: - version = f.read().strip() +with open('mem_edit/VERSION.py', 'rt') as f: + version = f.readlines()[2].strip() setup(name='mem_edit', version=version, @@ -50,7 +50,7 @@ setup(name='mem_edit', ], packages=find_packages(), package_data={ - 'mem_edit': ['VERSION'] + 'mem_edit': [] }, install_requires=[ 'typing', From 6913f73db4e822cb75959df863b8424455cda991 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 1 Nov 2020 20:16:46 -0800 Subject: [PATCH 19/25] cosmetic and typing-related changes --- mem_edit/abstract.py | 184 ++++++++++++++++++++++--------------- mem_edit/linux.py | 18 ++-- mem_edit/utils.py | 38 +++++--- mem_edit/windows.py | 212 ++++++++++++++++++++++--------------------- setup.py | 3 +- 5 files changed, 256 insertions(+), 199 deletions(-) diff --git a/mem_edit/abstract.py b/mem_edit/abstract.py index fb463f7..f2e6cd1 100644 --- a/mem_edit/abstract.py +++ b/mem_edit/abstract.py @@ -2,7 +2,7 @@ Abstract class for cross-platform memory editing. """ -from typing import List, Tuple +from typing import List, Tuple, Optional, Union, Generator from abc import ABCMeta, abstractmethod from contextlib import contextmanager import copy @@ -23,8 +23,8 @@ class Process(metaclass=ABCMeta): (i.e., by reading from or writing to the memory used by a given process). The static methods - Process.list_available_pids() - Process.get_pid_by_name(executable_filename) + `Process.list_available_pids()` + `Process.get_pid_by_name(executable_filename)` can be used to help find the process id (pid) of the target process. They are provided for convenience only; it is probably better to use the tools built in to your operating system to discover the pid of the specific process you @@ -32,18 +32,19 @@ class Process(metaclass=ABCMeta): Once you have found the pid, you are ready to construct an instance of Process and use it to read and write to memory. Once you are done with the process, - use .close() to free up the process for access by other debuggers etc. - + use `.close()` to free up the process for access by other debuggers etc. + ``` p = Process(1239) p.close() + ``` To read/write to memory, first create a buffer using ctypes: - + ``` buffer0 = (ctypes.c_byte * 5)(39, 50, 03, 40, 30) buffer1 = ctypes.c_ulong() - + ``` and then use - + ``` p.write_memory(0x2fe, buffer0) val0 = p.read_memory(0x220, buffer0)[:] @@ -51,52 +52,52 @@ class Process(metaclass=ABCMeta): val1a = p.read_memory(0x149, buffer1).value val2b = buffer1.value assert(val1a == val2b) + ``` Searching for a value can be done in a number of ways: Search a list of addresses: - found_addresses = p.search_addresses([0x1020, 0x1030], buffer0) + `found_addresses = p.search_addresses([0x1020, 0x1030], buffer0)` Search the entire memory space: - found_addresses = p.search_all_memory(buffer0, writeable_only=False) + `found_addresses = p.search_all_memory(buffer0, writeable_only=False)` You can also get a list of which regions in memory are mapped (readable): - regions = p.list_mapped_regions(writeable_only=False) - - which can be used along with search_buffer(...) to re-create .search_all_memory(...): - + `regions = p.list_mapped_regions(writeable_only=False)` + which can be used along with search_buffer(...) to re-create .search_all_memory(...): + ``` found = [] for region_start, region_stop in regions: region_buffer = (ctypes.c_byte * (region_stop - region_start))() p.read_memory(region_start, region_buffer) found += utils.search_buffer(ctypes.c_ulong(123456790), region_buffer) - + ``` Other useful methods include the context manager, implemented as a static method: - + ``` with Process.open_process(pid) as p: # use p here, no need to call p.close() - + ``` .get_path(), which reports the path of the executable file which was used to start the process: - + ``` executable_path = p.get_path() - + ``` and deref_struct_pointer, which takes a pointer to a struct and reads out the struct members: - + ``` # struct is a list of (offset, buffer) pairs struct_defintion = [(0x0, ctypes.c_ulong()), (0x20, ctypes.c_byte())] values = p.deref_struct_pointer(0x0feab4, struct_defintion) - + ``` which is shorthand for - + ``` struct_addr = p.read_memory(0x0feab4, ctypes.c_void_p()) values = [p.read_memory(struct_addr + 0x0, ctypes.c_ulong()), p.read_memory(struct_addr + 0x20, ctypes.c_byte())] - + ``` ================= Putting all this together, a simple program which alters a magic number in the only running instance of 'magic.exe' might look like this: - + ``` import ctypes from mem_edit import Process @@ -107,9 +108,9 @@ class Process(metaclass=ABCMeta): addrs = p.search_all_memory(magic_number) assert(len(addrs) == 1) p.write_memory(addrs[0], ctypes.c_ulong(42)) - + ``` Searching for a value which changes: - + ``` pid = Process.get_pid_by_name('monitor_me.exe') with Process.open_process(pid) as p: addrs = p.search_all_memory(ctypes.c_int(40)) @@ -118,18 +119,19 @@ class Process(metaclass=ABCMeta): print('Found addresses:') for addr in filtered_addrs: print(hex(addr)) - + ``` """ @abstractmethod def __init__(self, process_id: int): """ Constructing a Process object prepares the process with specified process_id for - memory editing. Finding the process_id for the process you want to edit is often + memory editing. Finding the `process_id` for the process you want to edit is often easiest using os-specific tools (or by launching the process yourself, e.g. with - subprocess.Popen(...)). + `subprocess.Popen(...)`). - :param process_id: Process id (pid) of the target process + Args: + process_id: Process id (pid) of the target process """ pass @@ -140,7 +142,7 @@ class Process(metaclass=ABCMeta): letting other debuggers attach to it instead. This function should be called after you are done working with the process - and will no longer need it. See the Process.open_process(...) context + and will no longer need it. See the `Process.open_process(...)` context manager to avoid having to call this function yourself. """ pass @@ -148,38 +150,45 @@ class Process(metaclass=ABCMeta): @abstractmethod def write_memory(self, base_address: int, write_buffer: ctypes_buffer_t): """ - Write the given buffer to the process's address space, starting at base_address. + Write the given buffer to the process's address space, starting at `base_address`. - :param base_address: The address to write at, in the process's address space. - :param write_buffer: A ctypes object, for example, ctypes.c_ulong(48), - (ctypes.c_byte * 3)(43, 21, 0xff), or a subclass of ctypes.Structure, - which will be written into memory starting at base_address. + Args: + base_address: The address to write at, in the process's address space. + write_buffer: A ctypes object, for example, `ctypes.c_ulong(48)`, + `(ctypes.c_byte * 3)(43, 21, 0xff)`, or a subclass of `ctypes.Structure`, + which will be written into memory starting at `base_address`. """ pass @abstractmethod def read_memory(self, base_address: int, read_buffer: ctypes_buffer_t) -> ctypes_buffer_t: """ - Read into the given buffer from the process's address space, starting at base_address. + Read into the given buffer from the process's address space, starting at `base_address`. - :param base_address: The address to read from, in the process's address space. - :param read_buffer: A ctypes object, for example. ctypes.c_ulong(), - (ctypes.c_byte * 3)(), or a subclass of ctypes.Structure, which will be - overwritten with the contents of the process's memory starting at base_address. - :returns: read_buffer is returned as well as being overwritten. + Args: + base_address: The address to read from, in the process's address space. + read_buffer: A `ctypes` object, for example. `ctypes.c_ulong()`, + `(ctypes.c_byte * 3)()`, or a subclass of `ctypes.Structure`, which will be + overwritten with the contents of the process's memory starting at `base_address`. + + Returns: + `read_buffer` is returned as well as being overwritten. """ pass @abstractmethod def list_mapped_regions(self, writeable_only=True) -> List[Tuple[int, int]]: """ - Return a list of (start_address, stop_address) for the regions of the address space + Return a list of `(start_address, stop_address)` for the regions of the address space accessible to (readable and possibly writable by) the process. By default, this function does not return non-writeable regions. - :param writeable_only: If True, only return regions which are also writeable. - Default true. - :return: List of (start_address, stop_address) for each accessible memory region. + Args: + writeable_only: If `True`, only return regions which are also writeable. + Default `True`. + + Returns: + List of `(start_address, stop_address)` for each accessible memory region. """ pass @@ -188,7 +197,8 @@ class Process(metaclass=ABCMeta): """ Return the path to the executable file which was run to start this process. - :return: A string containing the path. + Returns: + A string containing the path. """ pass @@ -198,13 +208,14 @@ class Process(metaclass=ABCMeta): """ Return a list of all process ids (pids) accessible on this system. - :return: List of running process ids. + Returns: + List of running process ids. """ pass @staticmethod @abstractmethod - def get_pid_by_name(target_name: str) -> int or None: + def get_pid_by_name(target_name: str) -> Optional[int]: """ Attempt to return the process id (pid) of a process which was run with an executable file with the provided name. If no process is found, return None. @@ -215,7 +226,12 @@ class Process(metaclass=ABCMeta): Don't rely on this method if you can possibly avoid it, since it makes no attempt to confirm that it found a unique process and breaks trivially (e.g. if the executable file is renamed). - :return: Process id (pid) of a process with the provided name, or None. + + Args: + target_name: Name of the process to find the PID for + + Returns: + Process id (pid) of a process with the provided name, or `None`. """ pass @@ -225,34 +241,48 @@ class Process(metaclass=ABCMeta): ) -> List[ctypes_buffer_t]: """ Take a pointer to a struct and read out the struct members: + ``` struct_defintion = [(0x0, ctypes.c_ulong()), (0x20, ctypes.c_byte())] values = p.deref_struct_pointer(0x0feab4, struct_defintion) + ``` which is shorthand for + ``` struct_addr = p.read_memory(0x0feab4, ctypes.c_void_p()) values = [p.read_memory(struct_addr + 0x0, ctypes.c_ulong()), p.read_memory(struct_addr + 0x20, ctypes.c_byte())] + ``` - :param base_address: Address at which the struct pointer is located. - :param targets: List of (offset, read_buffer) pairs which will be read from the struct. - :return: List of read values corresponding to the provided targets. + Args: + base_address: Address at which the struct pointer is located. + targets: List of `(offset, read_buffer)` pairs which will be read from the struct. + + Return: + List of read values corresponding to the provided targets. """ base = self.read_memory(base_address, ctypes.c_void_p()).value values = [self.read_memory(base + offset, buffer) for offset, buffer in targets] return values - def search_addresses(self, addresses: List[int], needle_buffer: ctypes_buffer_t, verbatim: bool=True) -> List[int]: + def search_addresses(self, + addresses: List[int], + needle_buffer: ctypes_buffer_t, + verbatim: bool = True, + ) -> List[int]: """ Search for the provided value at each of the provided addresses, and return the addresses where it is found. - :param addresses: List of addresses which should be probed. - :param needle_buffer: The value to search for. This should be a ctypes object of the same - sorts as used by .read_memory(...), which will be compared to the contents of + Args: + addresses: List of addresses which should be probed. + needle_buffer: The value to search for. This should be a `ctypes` object of the same + sorts as used by `.read_memory(...)`, which will be compared to the contents of memory at each of the given addresses. - :param verbatim: If True, perform bitwise comparison when searching for needle_buffer. - If False, perform utils.ctypes_equal-based comparison. Default True. - :return: List of addresses where the needle_buffer was found. + verbatim: If `True`, perform bitwise comparison when searching for `needle_buffer`. + If `False`, perform `utils.ctypes_equal`-based comparison. Default `True`. + + Returns: + List of addresses where the `needle_buffer` was found. """ found = [] read_buffer = copy.copy(needle_buffer) @@ -269,18 +299,25 @@ class Process(metaclass=ABCMeta): found.append(address) return found - def search_all_memory(self, needle_buffer: ctypes_buffer_t, writeable_only: bool=True, verbatim: bool=True) -> List[int]: + def search_all_memory(self, + needle_buffer: ctypes_buffer_t, + writeable_only: bool = True, + verbatim: bool = True, + ) -> List[int]: """ Search the entire memory space accessible to the process for the provided value. - :param needle_buffer: The value to search for. This should be a ctypes object of the same - sorts as used by .read_memory(...), which will be compared to the contents of + Args: + needle_buffer: The value to search for. This should be a ctypes object of the same + sorts as used by `.read_memory(...)`, which will be compared to the contents of memory at each accessible address. - :param writeable_only: If True, only search regions where the process has write access. - Default True. - :param verbatim: If True, perform bitwise comparison when searching for needle_buffer. - If False, perform utils.ctypes_equal-based comparison. Default True. - :return: List of addresses where the needle_buffer was found. + writeable_only: If `True`, only search regions where the process has write access. + Default `True`. + verbatim: If `True`, perform bitwise comparison when searching for `needle_buffer`. + If `False`, perform `utils.ctypes_equal-based` comparison. Default `True`. + + Returns: + List of addresses where the `needle_buffer` was found. """ found = [] if verbatim: @@ -299,15 +336,20 @@ class Process(metaclass=ABCMeta): @classmethod @contextmanager - def open_process(cls, process_id: int) -> 'Process': + def open_process(cls, process_id: int) -> Generator['Process', None, None]: """ Context manager which automatically closes the constructed Process: + ``` with Process.open_process(2394) as p: # use p here # no need to run p.close() + ``` - :param process_id: Process id (pid), passed to the Process constructor. - :return: Constructed Process object. + Args: + process_id: Process id (pid), passed to the Process constructor. + + Returns: + Constructed Process object. """ process = cls(process_id) yield process diff --git a/mem_edit/linux.py b/mem_edit/linux.py index ae8404d..58460b8 100644 --- a/mem_edit/linux.py +++ b/mem_edit/linux.py @@ -2,7 +2,7 @@ Implementation of Process class for Linux """ -from typing import List, Tuple +from typing import List, Tuple, Optional from os import strerror import os import os.path @@ -20,13 +20,13 @@ logger = logging.getLogger(__name__) ptrace_commands = { - 'PTRACE_GETREGS': 12, - 'PTRACE_SETREGS': 13, - 'PTRACE_ATTACH': 16, - 'PTRACE_DETACH': 17, - 'PTRACE_SYSCALL': 24, - 'PTRACE_SEIZE': 16902, - } + 'PTRACE_GETREGS': 12, + 'PTRACE_SETREGS': 13, + 'PTRACE_ATTACH': 16, + 'PTRACE_DETACH': 17, + 'PTRACE_SYSCALL': 24, + 'PTRACE_SEIZE': 16902, + } # import ptrace() from libc @@ -91,7 +91,7 @@ class Process(AbstractProcess): return pids @staticmethod - def get_pid_by_name(target_name: str) -> int or None: + def get_pid_by_name(target_name: str) -> Optional[int]: for pid in Process.list_available_pids(): try: logger.info('Checking name for pid {}'.format(pid)) diff --git a/mem_edit/utils.py b/mem_edit/utils.py index fc15970..2c9c022 100644 --- a/mem_edit/utils.py +++ b/mem_edit/utils.py @@ -12,24 +12,29 @@ Utility functions and types: ctypes_equal(a, b) """ -from typing import List +from typing import List, Union import ctypes -ctypes_buffer_t = ctypes._SimpleCData or ctypes.Array or ctypes.Structure or ctypes.Union +ctypes_buffer_t = Union[ctypes._SimpleCData, ctypes.Array, ctypes.Structure, ctypes.Union] class MemEditError(Exception): pass -def search_buffer_verbatim(needle_buffer: ctypes_buffer_t, haystack_buffer: ctypes_buffer_t) -> List[int]: +def search_buffer_verbatim(needle_buffer: ctypes_buffer_t, + haystack_buffer: ctypes_buffer_t, + ) -> List[int]: """ Search for a buffer inside another buffer, using a direct (bitwise) comparison - :param needle_buffer: Buffer to search for. - :param haystack_buffer: Buffer to search in. - :return: List of offsets where the needle_buffer was found. + Args: + needle_buffer: Buffer to search for. + haystack_buffer: Buffer to search in. + + Returns: + List of offsets where the `needle_buffer` was found. """ found = [] @@ -45,14 +50,19 @@ def search_buffer_verbatim(needle_buffer: ctypes_buffer_t, haystack_buffer: ctyp return found -def search_buffer(needle_buffer: ctypes_buffer_t, haystack_buffer: ctypes_buffer_t) -> List[int]: +def search_buffer(needle_buffer: ctypes_buffer_t, + haystack_buffer: ctypes_buffer_t, + ) -> List[int]: """ - Search for a buffer inside another buffer, using ctypes_equal for comparison. - Much slower than search_buffer_verbatim. + Search for a buffer inside another buffer, using `ctypes_equal` for comparison. + Much slower than `search_buffer_verbatim`. - :param needle_buffer: Buffer to search for. - :param haystack_buffer: Buffer to search in. - :return: List of offsets where the needle_buffer was found. + Args: + needle_buffer: Buffer to search for. + haystack_buffer: Buffer to search in. + + Returns: + List of offsets where the needle_buffer was found. """ found = [] read_type = type(needle_buffer) @@ -63,7 +73,9 @@ def search_buffer(needle_buffer: ctypes_buffer_t, haystack_buffer: ctypes_buffer return found -def ctypes_equal(a: ctypes_buffer_t, b: ctypes_buffer_t) -> bool: +def ctypes_equal(a: ctypes_buffer_t, + b: ctypes_buffer_t, + ) -> bool: """ Check if the values stored inside two ctypes buffers are equal. """ diff --git a/mem_edit/windows.py b/mem_edit/windows.py index cdaf657..e3bb013 100644 --- a/mem_edit/windows.py +++ b/mem_edit/windows.py @@ -2,7 +2,7 @@ Implementation of Process class for Windows """ -from typing import List, Tuple +from typing import List, Tuple, Optional from math import floor from os import strerror import os.path @@ -20,77 +20,77 @@ logger = logging.getLogger(__name__) # Process handle privileges privileges = { - 'PROCESS_QUERY_INFORMATION': 0x0400, - 'PROCESS_VM_OPERATION': 0x0008, - 'PROCESS_VM_READ': 0x0010, - 'PROCESS_VM_WRITE': 0x0020, - } + 'PROCESS_QUERY_INFORMATION': 0x0400, + 'PROCESS_VM_OPERATION': 0x0008, + 'PROCESS_VM_READ': 0x0010, + 'PROCESS_VM_WRITE': 0x0020, + } privileges['PROCESS_RW'] = ( - privileges['PROCESS_QUERY_INFORMATION'] | - privileges['PROCESS_VM_OPERATION'] | - privileges['PROCESS_VM_READ'] | - privileges['PROCESS_VM_WRITE'] - ) + privileges['PROCESS_QUERY_INFORMATION'] | + privileges['PROCESS_VM_OPERATION'] | + privileges['PROCESS_VM_READ'] | + privileges['PROCESS_VM_WRITE'] + ) # Memory region states mem_states = { - 'MEM_COMMIT': 0x1000, - 'MEM_FREE': 0x10000, - 'MEM_RESERVE': 0x2000, - } + 'MEM_COMMIT': 0x1000, + 'MEM_FREE': 0x10000, + 'MEM_RESERVE': 0x2000, + } # Memory region permissions page_protections = { - 'PAGE_EXECUTE': 0x10, - 'PAGE_EXECUTE_READ': 0x20, - 'PAGE_EXECUTE_READWRITE': 0x40, - 'PAGE_EXECUTE_WRITECOPY': 0x80, - 'PAGE_NOACCESS': 0x01, - 'PAGE_READWRITE': 0x04, - 'PAGE_WRITECOPY': 0x08, - } + 'PAGE_EXECUTE': 0x10, + 'PAGE_EXECUTE_READ': 0x20, + 'PAGE_EXECUTE_READWRITE': 0x40, + 'PAGE_EXECUTE_WRITECOPY': 0x80, + 'PAGE_NOACCESS': 0x01, + 'PAGE_READWRITE': 0x04, + 'PAGE_WRITECOPY': 0x08, + } # Custom (combined) permissions page_protections['PAGE_READABLE'] = ( - page_protections['PAGE_EXECUTE_READ'] | - page_protections['PAGE_EXECUTE_READWRITE'] | - page_protections['PAGE_READWRITE'] - ) + page_protections['PAGE_EXECUTE_READ'] | + page_protections['PAGE_EXECUTE_READWRITE'] | + page_protections['PAGE_READWRITE'] + ) page_protections['PAGE_READWRITEABLE'] = ( - page_protections['PAGE_EXECUTE_READWRITE'] | - page_protections['PAGE_READWRITE'] - ) + page_protections['PAGE_EXECUTE_READWRITE'] | + page_protections['PAGE_READWRITE'] + ) # Memory types mem_types = { - 'MEM_IMAGE': 0x1000000, - 'MEM_MAPPED': 0x40000, - 'MEM_PRIVATE': 0x20000, - } + 'MEM_IMAGE': 0x1000000, + 'MEM_MAPPED': 0x40000, + 'MEM_PRIVATE': 0x20000, + } # C struct for VirtualQueryEx class MEMORY_BASIC_INFORMATION32(ctypes.Structure): _fields_ = [ - ('BaseAddress', ctypes.wintypes.DWORD), - ('AllocationBase', ctypes.wintypes.DWORD), - ('AllocationProtect', ctypes.wintypes.DWORD), - ('RegionSize', ctypes.wintypes.DWORD), - ('State', ctypes.wintypes.DWORD), - ('Protect', ctypes.wintypes.DWORD), - ('Type', ctypes.wintypes.DWORD), - ] + ('BaseAddress', ctypes.wintypes.DWORD), + ('AllocationBase', ctypes.wintypes.DWORD), + ('AllocationProtect', ctypes.wintypes.DWORD), + ('RegionSize', ctypes.wintypes.DWORD), + ('State', ctypes.wintypes.DWORD), + ('Protect', ctypes.wintypes.DWORD), + ('Type', ctypes.wintypes.DWORD), + ] class MEMORY_BASIC_INFORMATION64(ctypes.Structure): _fields_ = [ - ('BaseAddress', ctypes.c_ulonglong), - ('AllocationBase', ctypes.c_ulonglong), - ('AllocationProtect', ctypes.wintypes.DWORD), - ('__alignment1', ctypes.wintypes.DWORD), - ('RegionSize', ctypes.c_ulonglong), - ('State', ctypes.wintypes.DWORD), - ('Protect', ctypes.wintypes.DWORD), - ('Type', ctypes.wintypes.DWORD), - ('__alignment2', ctypes.wintypes.DWORD), - ] + ('BaseAddress', ctypes.c_ulonglong), + ('AllocationBase', ctypes.c_ulonglong), + ('AllocationProtect', ctypes.wintypes.DWORD), + ('__alignment1', ctypes.wintypes.DWORD), + ('RegionSize', ctypes.c_ulonglong), + ('State', ctypes.wintypes.DWORD), + ('Protect', ctypes.wintypes.DWORD), + ('Type', ctypes.wintypes.DWORD), + ('__alignment2', ctypes.wintypes.DWORD), + ] PTR_SIZE = ctypes.sizeof(ctypes.c_void_p) if PTR_SIZE == 8: # 64-bit python @@ -98,36 +98,39 @@ if PTR_SIZE == 8: # 64-bit python elif PTR_SIZE == 4: # 32-bit python MEMORY_BASIC_INFORMATION = MEMORY_BASIC_INFORMATION32 -ctypes.windll.kernel32.VirtualQueryEx.argtypes = [ctypes.wintypes.HANDLE, - ctypes.wintypes.LPCVOID, - ctypes.c_void_p, - ctypes.c_size_t] -ctypes.windll.kernel32.ReadProcessMemory.argtypes = [ctypes.wintypes.HANDLE, - ctypes.wintypes.LPCVOID, - ctypes.c_void_p, - ctypes.c_size_t, - ctypes.c_void_p] -ctypes.windll.kernel32.WriteProcessMemory.argtypes = [ctypes.wintypes.HANDLE, - ctypes.wintypes.LPCVOID, - ctypes.c_void_p, - ctypes.c_size_t, - ctypes.c_void_p] +ctypes.windll.kernel32.VirtualQueryEx.argtypes = [ + ctypes.wintypes.HANDLE, + ctypes.wintypes.LPCVOID, + ctypes.c_void_p, + ctypes.c_size_t] +ctypes.windll.kernel32.ReadProcessMemory.argtypes = [ + ctypes.wintypes.HANDLE, + ctypes.wintypes.LPCVOID, + ctypes.c_void_p, + ctypes.c_size_t, + ctypes.c_void_p] +ctypes.windll.kernel32.WriteProcessMemory.argtypes = [ + ctypes.wintypes.HANDLE, + ctypes.wintypes.LPCVOID, + ctypes.c_void_p, + ctypes.c_size_t, + ctypes.c_void_p] # C struct for GetSystemInfo class SYSTEM_INFO(ctypes.Structure): _fields_ = [ - ('wProcessorArchitecture', ctypes.wintypes.WORD), - ('wReserved', ctypes.wintypes.WORD), - ('dwPageSize', ctypes.wintypes.DWORD), - ('lpMinimumApplicationAddress', ctypes.c_void_p), - ('lpMaximumApplicationAddress', ctypes.c_void_p), - ('dwActiveProcessorMask', ctypes.c_void_p), - ('dwNumberOfProcessors', ctypes.wintypes.DWORD), - ('dwProcessorType', ctypes.wintypes.DWORD), - ('dwAllocationGranularity', ctypes.wintypes.DWORD), - ('wProcessorLevel', ctypes.wintypes.WORD), - ('wProcessorRevision', ctypes.wintypes.WORD), - ] + ('wProcessorArchitecture', ctypes.wintypes.WORD), + ('wReserved', ctypes.wintypes.WORD), + ('dwPageSize', ctypes.wintypes.DWORD), + ('lpMinimumApplicationAddress', ctypes.c_void_p), + ('lpMaximumApplicationAddress', ctypes.c_void_p), + ('dwActiveProcessorMask', ctypes.c_void_p), + ('dwNumberOfProcessors', ctypes.wintypes.DWORD), + ('dwProcessorType', ctypes.wintypes.DWORD), + ('dwAllocationGranularity', ctypes.wintypes.DWORD), + ('wProcessorLevel', ctypes.wintypes.WORD), + ('wProcessorRevision', ctypes.wintypes.WORD), + ] class Process(AbstractProcess): @@ -152,24 +155,24 @@ class Process(AbstractProcess): def write_memory(self, base_address: int, write_buffer: ctypes_buffer_t): try: ctypes.windll.kernel32.WriteProcessMemory( - self.process_handle, - base_address, - ctypes.byref(write_buffer), - ctypes.sizeof(write_buffer), - None - ) + self.process_handle, + base_address, + ctypes.byref(write_buffer), + ctypes.sizeof(write_buffer), + None + ) except (BufferError, ValueError, TypeError): raise MemEditError('Error with handle {}: {}'.format(self.process_handle, self._get_last_error())) def read_memory(self, base_address: int, read_buffer: ctypes_buffer_t) -> ctypes_buffer_t: try: ctypes.windll.kernel32.ReadProcessMemory( - self.process_handle, - base_address, - ctypes.byref(read_buffer), - ctypes.sizeof(read_buffer), - None - ) + self.process_handle, + base_address, + ctypes.byref(read_buffer), + ctypes.sizeof(read_buffer), + None + ) except (BufferError, ValueError, TypeError): raise MemEditError('Error with handle {}: {}'.format(self.process_handle, self._get_last_error())) @@ -184,10 +187,9 @@ class Process(AbstractProcess): max_path_len = 260 name_buffer = (ctypes.c_char * max_path_len)() rval = ctypes.windll.psapi.GetProcessImageFileNameA( - self.process_handle, - name_buffer, - max_path_len - ) + self.process_handle, + name_buffer, + max_path_len) if rval > 0: return name_buffer.value.decode() @@ -199,7 +201,7 @@ class Process(AbstractProcess): # According to EnumProcesses docs, you can't find out how many processes there are before # fetching the list. As a result, we grab 100 on the first try, and if we get a full list # of 100, repeatedly double the number until we get fewer than we asked for. - + n = 100 returned_size = ctypes.wintypes.DWORD() returned_size_ptr = ctypes.byref(returned_size) @@ -224,7 +226,7 @@ class Process(AbstractProcess): return pids[:num_returned] @staticmethod - def get_pid_by_name(target_name: str) -> int or None: + def get_pid_by_name(target_name: str) -> Optional[int]: for pid in Process.list_available_pids(): try: logger.info('Checking name for pid {}'.format(pid)) @@ -260,11 +262,10 @@ class Process(AbstractProcess): mbi_size = ctypes.sizeof(mbi) success = ctypes.windll.kernel32.VirtualQueryEx( - self.process_handle, - address, - mbi_ptr, - mbi_size, - ) + self.process_handle, + address, + mbi_ptr, + mbi_size) if success != mbi_size: if success == 0: @@ -279,10 +280,11 @@ class Process(AbstractProcess): page_ptr = start while page_ptr < stop: page_info = get_mem_info(page_ptr) - if page_info.Type == mem_types['MEM_PRIVATE'] and \ - page_info.State == mem_states['MEM_COMMIT'] and \ - page_info.Protect & page_protections['PAGE_READABLE'] != 0 and \ - (page_info.Protect & page_protections['PAGE_READWRITEABLE'] != 0 or not writeable_only): + if (page_info.Type == mem_types['MEM_PRIVATE'] + and page_info.State == mem_states['MEM_COMMIT'] + and page_info.Protect & page_protections['PAGE_READABLE'] != 0 + and (page_info.Protect & page_protections['PAGE_READWRITEABLE'] != 0 + or not writeable_only)): regions.append((page_ptr, page_ptr + page_info.RegionSize)) page_ptr += page_info.RegionSize diff --git a/setup.py b/setup.py index 3a55145..130ebf2 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,8 @@ from setuptools import setup, find_packages -with open('README.md', 'r') as f: + +with open('README.md', 'rt') as f: long_description = f.read() with open('mem_edit/VERSION.py', 'rt') as f: From 6ab295fc265d52ca0e584b9385f8227b2300bffc Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 1 Nov 2020 20:21:35 -0800 Subject: [PATCH 20/25] bump version to v0.5 --- mem_edit/VERSION.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem_edit/VERSION.py b/mem_edit/VERSION.py index a3aacc8..d15f477 100644 --- a/mem_edit/VERSION.py +++ b/mem_edit/VERSION.py @@ -1,4 +1,4 @@ """ VERSION defintion. THIS FILE IS MANUALLY PARSED BY setup.py and REQUIRES A SPECIFIC FORMAT """ __version__ = ''' -0.4 +0.5 ''' From 5a032da984b753744536af2b18506d65a02018c8 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Thu, 8 Apr 2021 19:49:19 -0700 Subject: [PATCH 21/25] try to reduce log spam --- mem_edit/abstract.py | 1 - mem_edit/linux.py | 5 ++--- mem_edit/windows.py | 7 +++---- 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/mem_edit/abstract.py b/mem_edit/abstract.py index f2e6cd1..e086d4e 100644 --- a/mem_edit/abstract.py +++ b/mem_edit/abstract.py @@ -13,7 +13,6 @@ from . import utils from .utils import ctypes_buffer_t -logging.basicConfig(level=logging.INFO) logger = logging.getLogger(__name__) diff --git a/mem_edit/linux.py b/mem_edit/linux.py index 58460b8..18f3b8f 100644 --- a/mem_edit/linux.py +++ b/mem_edit/linux.py @@ -15,7 +15,6 @@ from .abstract import Process as AbstractProcess from .utils import ctypes_buffer_t, MemEditError -logging.basicConfig(level=logging.INFO) logger = logging.getLogger(__name__) @@ -94,14 +93,14 @@ class Process(AbstractProcess): def get_pid_by_name(target_name: str) -> Optional[int]: for pid in Process.list_available_pids(): try: - logger.info('Checking name for pid {}'.format(pid)) + logger.debug('Checking name for pid {}'.format(pid)) with open('/proc/{}/cmdline'.format(pid), 'rb') as cmdline: path = cmdline.read().decode().split('\x00')[0] except FileNotFoundError: continue name = os.path.basename(path) - logger.info('Name was "{}"'.format(name)) + logger.debug('Name was "{}"'.format(name)) if path is not None and name == target_name: return pid diff --git a/mem_edit/windows.py b/mem_edit/windows.py index e3bb013..b945058 100644 --- a/mem_edit/windows.py +++ b/mem_edit/windows.py @@ -14,7 +14,6 @@ from .abstract import Process as AbstractProcess from .utils import ctypes_buffer_t, MemEditError -logging.basicConfig(level=logging.INFO) logger = logging.getLogger(__name__) @@ -229,18 +228,18 @@ class Process(AbstractProcess): def get_pid_by_name(target_name: str) -> Optional[int]: for pid in Process.list_available_pids(): try: - logger.info('Checking name for pid {}'.format(pid)) + logger.debug('Checking name for pid {}'.format(pid)) with Process.open_process(pid) as process: path = process.get_path() name = os.path.basename(path) - logger.info('Name was "{}"'.format(name)) + logger.debug('Name was "{}"'.format(name)) if path is not None and name == target_name: return pid except ValueError: pass except MemEditError as err: - logger.info(repr(err)) + logger.debug(repr(err)) logger.info('Found no process with name {}'.format(target_name)) return None From c29be9f4293a70a51ff9dfafce7f5cff117bd4df Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Thu, 8 Apr 2021 19:49:55 -0700 Subject: [PATCH 22/25] strip newlines from version string --- mem_edit/VERSION.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem_edit/VERSION.py b/mem_edit/VERSION.py index d15f477..aa70ad0 100644 --- a/mem_edit/VERSION.py +++ b/mem_edit/VERSION.py @@ -1,4 +1,4 @@ """ VERSION defintion. THIS FILE IS MANUALLY PARSED BY setup.py and REQUIRES A SPECIFIC FORMAT """ __version__ = ''' 0.5 -''' +'''.strip() From ef1a39152ccbe75e63f232f40a69448718a48abc Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Thu, 8 Apr 2021 19:50:22 -0700 Subject: [PATCH 23/25] bump version to v0.6 --- mem_edit/VERSION.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem_edit/VERSION.py b/mem_edit/VERSION.py index aa70ad0..e4f476e 100644 --- a/mem_edit/VERSION.py +++ b/mem_edit/VERSION.py @@ -1,4 +1,4 @@ """ VERSION defintion. THIS FILE IS MANUALLY PARSED BY setup.py and REQUIRES A SPECIFIC FORMAT """ __version__ = ''' -0.5 +0.6 '''.strip() From f3154e443dc906b8bfe23c56a12dcf9b679f8f42 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 11 Jul 2021 17:25:00 -0700 Subject: [PATCH 24/25] update email --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 130ebf2..b5a234e 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ setup(name='mem_edit', long_description=long_description, long_description_content_type='text/markdown', author='Jan Petykiewicz', - author_email='anewusername@gmail.com', + author_email='jan@mpxd.net', url='https://mpxd.net/code/jan/mem_edit', keywords=[ 'memory', From 46e9456fd4ef46ee440102780067f26e58af61d8 Mon Sep 17 00:00:00 2001 From: xerool Date: Sat, 30 Apr 2022 22:37:17 -0500 Subject: [PATCH 25/25] linux: wait for process before detach, and send SIGCONT I had issues with the ptrace call failing because the process had not yet stopped from SIGSTOP. From this stackoverflow answer, it seems that you can use waitpid to wait until the process is actually stopped. In python, this is exposed as os.waitpid. https://stackoverflow.com/questions/20510300/ptrace-detach-fails-after-ptrace-cont-with-errno-esrch#20525326 Additionally, the process was left frozen. I send a SIGCONT to continue the process after the detach, so that it isn't left stopped. --- mem_edit/linux.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mem_edit/linux.py b/mem_edit/linux.py index 18f3b8f..aa25a49 100644 --- a/mem_edit/linux.py +++ b/mem_edit/linux.py @@ -58,7 +58,9 @@ class Process(AbstractProcess): def close(self): os.kill(self.pid, signal.SIGSTOP) + os.waitpid(self.pid, 0) ptrace(ptrace_commands['PTRACE_DETACH'], self.pid, 0, 0) + os.kill(self.pid, signal.SIGCONT) self.pid = None def write_memory(self, base_address: int, write_buffer: ctypes_buffer_t):