Rename project to Chomper (#41)

* Rename project to chomper

* Update version

* Update CHANGES.md

* Update badges

Author: sledgeh4w

CHANGES.md

@@ -1,8 +1,14 @@
+## v0.2.0
+
+Released: 2022-11-26
+
+- Rename project to Chomper.
+
 ## v0.1.1
 
 Released: 2022-11-21
 
-- Make ``add_hook`` return from ``hook_add`` of ``Unicorn`` and add ``del_hook`` method for ``Infernum``.
+- Make ``add_hook`` return from ``hook_add`` of ``Unicorn`` and add ``del_hook`` method for ``Chomper``.
 - Close the library file after loading.
 - Move default symbol hooks to ``arch`` module.
 
@@ -20,8 +26,8 @@ Released: 2022-09-10
 - Add ``user_data`` param for ``add_hook`` to customize params of callback.
 - Support trace symbol calls by using ``trace_symbol_calls`` param.
 - Raise ``EmulatorCrashedException`` with prompt message when missing symbol is required.
-- Add a default logger for ``Infernum``.
-- Add ``free`` method for ``Infernum``.
+- Add a default logger for ``Chomper``.
+- Add ``free`` method for ``Chomper``.
 
 ## v0.0.1
 

README.md

@@ -1,11 +1,11 @@
-# Infernum
+# Chomper
 
-[![build](https://github.com/Sh4ww/infernum/actions/workflows/tests.yml/badge.svg)](https://github.com/Sh4ww/infernum/actions/workflows/tests.yml)
-![PyPI](https://img.shields.io/pypi/v/infernum)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/infernum)
-[![GitHub license](https://img.shields.io/github/license/Sh4ww/infernum)](https://github.com/Sh4ww/infernum/blob/main/LICENSE)
+[![build](https://github.com/sh4w1/chomper/actions/workflows/tests.yml/badge.svg)](https://github.com/sh4w1/chomper/actions/workflows/tests.yml)
+![PyPI](https://img.shields.io/pypi/v/chomper)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/chomper)
+[![GitHub license](https://img.shields.io/github/license/sh4w1/chomper)](https://github.com/sh4w1/chomper/blob/main/LICENSE)
 
-Infernum is a lightweight Android native library emulation framework based on [Unicorn](https://github.com/unicorn-engine/unicorn). It is mainly used to execute the encryption algorithm, so it doesn't provide JNI or file system support. It supports arch ARM and ARM64.
+Chomper is a lightweight Android native library emulation framework based on [Unicorn](https://github.com/unicorn-engine/unicorn). It is mainly used to execute the encryption algorithm, so it doesn't provide JNI or file system support. It supports arch ARM and ARM64.
 
 ## Requirements
 
@@ -15,25 +15,25 @@ Infernum is a lightweight Android native library emulation framework based on [U
 ## Installation
 
 ```
-$ pip install infernum
+$ pip install chomper
 ```
 
 ## Usage
 
 Load modules and call functions.
 
 ```python
-from infernum import Infernum
-from infernum.const import ARCH_ARM64
+from chomper import Chomper
+from chomper.const import ARCH_ARM64
 
 # Initialize emulator
-emulator = Infernum(ARCH_ARM64)
+emulator = Chomper(ARCH_ARM64)
 
 # Load modules
 emulator.load_module("lib64/libz.so")
 
 # Construct arguments
-data = b"infernum"
+data = b"chomper"
 
 v1 = emulator.create_buffer(len(data))
 v2 = len(data)
@@ -51,23 +51,23 @@ emulator.call_address(symbol.address, 0, v1, v2)
 Emulate arch ARM.
 
 ```python
-from infernum import Infernum
-from infernum.const import ARCH_ARM
+from chomper import Chomper
+from chomper.const import ARCH_ARM
 
-emulator = Infernum(ARCH_ARM)
+emulator = Chomper(ARCH_ARM)
 ```
 
 Read/Write data.
 
 ```python
 # Create buffer
 v1 = emulator.create_buffer(64)
-v2 = emulator.create_string("infernum")
+v2 = emulator.create_string("chomper")
 
 # Write data
 emulator.write_int(v1, 1)
-emulator.write_bytes(v1, b"infernum")
-emulator.write_string(v2, "infernum")
+emulator.write_bytes(v1, b"chomper")
+emulator.write_string(v2, "chomper")
 
 # Read data
 emulator.read_int(v1)
@@ -89,7 +89,7 @@ Trace instructions.
 
 ```python
 # Trace all instructions
-emulator = Infernum(ARCH_ARM64, trace_inst=True)
+emulator = Chomper(ARCH_ARM64, trace_inst=True)
 
 # Trace instructions in this module
 emulator.load_module("lib64/libz.so", trace_inst=True)

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
-name = infernum
-version = attr: infernum.__version__
+name = chomper
+version = attr: chomper.__version__
 author = Sh4w
 author_email = sh4w0911@gmail.com
 description = A lightweight Android native library emulation framework for executing the encryption algorithm.
@@ -35,13 +35,13 @@ ignore =
     E203
     W503
 per-file-ignores =
-    src/infernum/__init__.py: F401, F403
+    src/chomper/__init__.py: F401, F403
 exclude =
     venv
 max-line-length = 88
 
 [mypy]
-files = src/infernum
+files = src/chomper
 python_version = 3.7
 show_error_codes = True
 allow_redefinition = True

src/chomper/__init__.py

@@ -0,0 +1,3 @@
+from .core import Chomper
+
+__version__ = "0.2.0"

src/infernum/arch.py src/chomper/arch.py

@@ -35,7 +35,7 @@
     from typing_extensions import Literal
 
 
-class Infernum:
+class Chomper:
     """Lightweight Android native library emulation framework.
 
     Args:

src/infernum/const.py src/chomper/const.py

@@ -7,10 +7,10 @@
 from unicorn.unicorn import UC_HOOK_CODE_TYPE
 
 if TYPE_CHECKING:
-    from .core import Infernum
+    from .core import Chomper
 
 
-def intercept(f: Callable[["Infernum"], Any]) -> UC_HOOK_CODE_TYPE:
+def intercept(f: Callable[["Chomper"], Any]) -> UC_HOOK_CODE_TYPE:
     """Intercept function call."""
 
     @wraps(f)
@@ -38,15 +38,15 @@ def hook_arc4random(_):
 
 
 @intercept
-def hook_free(emulator: "Infernum"):
+def hook_free(emulator: "Chomper"):
     """Intercept ``free`` of ``libc.so``."""
     addr = emulator.get_argument(0)
 
     emulator.memory_manager.free(addr)
 
 
 @intercept
-def hook_getcwd(emulator: "Infernum"):
+def hook_getcwd(emulator: "Chomper"):
     """Intercept ``getcwd`` of ``libc.so``."""
     buf = emulator.get_argument(0)
     cwd = os.getcwd()
@@ -62,19 +62,19 @@ def hook_getcwd(emulator: "Infernum"):
 
 
 @intercept
-def hook_getpid(emulator: "Infernum"):
+def hook_getpid(emulator: "Chomper"):
     """Intercept ``getpid`` of ``libc.so``."""
     emulator.set_retval(os.getpid())
 
 
 @intercept
-def hook_gettid(emulator: "Infernum"):
+def hook_gettid(emulator: "Chomper"):
     """Intercept ``gettid`` of ``libc.so``."""
     emulator.set_retval(threading.get_ident())
 
 
 @intercept
-def hook_malloc(emulator: "Infernum"):
+def hook_malloc(emulator: "Chomper"):
     """Intercept ``malloc`` of ``libc.so``."""
     size = emulator.get_argument(0)
     addr = emulator.memory_manager.alloc(size)
@@ -83,7 +83,7 @@ def hook_malloc(emulator: "Infernum"):
 
 
 @intercept
-def hook_memcpy(emulator: "Infernum"):
+def hook_memcpy(emulator: "Chomper"):
     """Intercept ``memcpy`` of ``libc.so``."""
     dst = emulator.get_argument(0)
     src = emulator.get_argument(1)
@@ -95,7 +95,7 @@ def hook_memcpy(emulator: "Infernum"):
 
 
 @intercept
-def hook_memset(emulator: "Infernum"):
+def hook_memset(emulator: "Chomper"):
     """Intercept ``memset`` of ``libc.so``."""
     addr = emulator.get_argument(0)
     char = emulator.get_argument(1)

src/infernum/core.py src/chomper/core.py

@@ -2,8 +2,8 @@
 
 import pytest
 
-from infernum import Infernum
-from infernum.const import ARCH_ARM, ARCH_ARM64
+from chomper import Chomper
+from chomper.const import ARCH_ARM, ARCH_ARM64
 
 base_path = os.path.abspath(os.path.dirname(__file__))
 
@@ -23,7 +23,7 @@ def sample_bytes(sample_str):
 
 @pytest.fixture(scope="module")
 def emu_arm():
-    yield Infernum(arch=ARCH_ARM)
+    yield Chomper(arch=ARCH_ARM)
 
 
 @pytest.fixture(scope="module")
@@ -46,7 +46,7 @@ def dusanwalib_v4856_arm(emu_arm):
 
 @pytest.fixture(scope="module")
 def emu_arm64():
-    yield Infernum(arch=ARCH_ARM64)
+    yield Chomper(arch=ARCH_ARM64)
 
 
 @pytest.fixture(scope="module")

src/infernum/exceptions.py src/chomper/exceptions.py

@@ -130,7 +130,7 @@ def test_write_and_read_bytes(emu_arm64, sample_bytes):
 
 def test_write_and_read_string(emu_arm64):
     buffer = emu_arm64.create_buffer(1024)
-    string = "infernum"
+    string = "chomper"
 
     emu_arm64.write_string(buffer, string)
     result = emu_arm64.read_string(buffer)

src/infernum/hooks.py src/chomper/hooks.py

@@ -4,14 +4,14 @@
 
 from .conftest import lib64_path
 
-from infernum import Infernum
-from infernum.const import ARCH_ARM64
-from infernum.exceptions import EmulatorCrashedException
+from chomper import Chomper
+from chomper.const import ARCH_ARM64
+from chomper.exceptions import EmulatorCrashedException
 
 
 def test_unhandled_system_call_exception():
     with pytest.raises(EmulatorCrashedException, match=r"Unhandled system call.*"):
-        emulator = Infernum(arch=ARCH_ARM64)
+        emulator = Chomper(arch=ARCH_ARM64)
         emulator._symbol_hooks.pop("malloc")
 
         emulator.load_module(os.path.join(lib64_path, "libc.so"))
@@ -21,7 +21,7 @@ def test_unhandled_system_call_exception():
 
 def test_missing_symbol_required_exception(sample_bytes):
     with pytest.raises(EmulatorCrashedException, match=r"Missing symbol.*"):
-        emulator = Infernum(arch=ARCH_ARM64)
+        emulator = Chomper(arch=ARCH_ARM64)
         szstonelib = emulator.load_module(
             os.path.join(lib64_path, "com.shizhuang.duapp_v4.94.5_libszstone.so")
         )