Add GitHub Actions to publish to PyPI

Author: mrexodia

.github/workflows/build.yml

@@ -0,0 +1,59 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    # Skip building pull requests from the same repository
+    if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository) }}
+    runs-on: windows-2019
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Python environment
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+        architecture: 'x64'
+    
+    - name: Build
+      run: |
+        python setup.py develop
+
+    - name: StringEncryptionFun_x64
+      run: |
+        curl -sSOJL https://github.com/mrexodia/dumpulator/releases/download/v0.0.1/StringEncryptionFun_x64.dmp
+        python tests/getting-started.py
+
+    - name: StringEncryptionFun_x86
+      run: |
+        curl -sSOJL https://github.com/mrexodia/dumpulator/releases/download/v0.0.1/StringEncryptionFun_x86.dmp
+        python tests/getting-started32.py
+
+  publish:
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Python environment
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+        architecture: 'x64'
+
+    - name: Package
+      run: |
+        python setup.py sdist
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}
+
+    - name: Release
+      uses: softprops/action-gh-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

setup.cfg

@@ -2,7 +2,7 @@
 
 [metadata]
 name = dumpulator
-version = 0.0.2
+version = v0.0.3
 author = Duncan Ogilvie
 author_email = [email protected]
 description = An easy-to-use library for emulating code in minidump files.
@@ -22,8 +22,8 @@ package_dir =
 packages = find:
 python_requires = >=3.6
 install_requires =
-    #minidump ==0.0.21 # this library has a bug, is vendored locally
-    unicorn >=1.0.3
+    #minidump ~=0.0.21 # this library has a bug, is vendored locally
+    unicorn ~=1.0.3
     pefile >=2021.9.3
 
 [options.packages.find]

setup.py

@@ -1,8 +1,25 @@
 #!/usr/bin/env python
 
-# Source: https://stackoverflow.com/a/62983901/1806760
+# Based on: https://stackoverflow.com/a/62983901/1806760
 
 import setuptools
+import os
 
 if __name__ == "__main__":
+    ref_name = os.getenv("GITHUB_REF_NAME")
+    if ref_name:
+        from pkg_resources import parse_version
+        try:
+            parse_version(ref_name)
+            print(f"injecting version = {ref_name} into setup.cfg")
+            with open("setup.cfg", "r") as f:
+                lines = f.readlines()
+            with open("setup.cfg", "w") as f:
+                for line in lines:
+                    if line.startswith("version = "):
+                        line = f"version = {ref_name}\n"
+                    f.write(line)
+        except:
+            pass
+
     setuptools.setup()

src/dumpulator/dumpulator.py

@@ -75,7 +75,6 @@ def __init__(self, uc: Uc, x64):
             "edx": UC_X86_REG_EDX,
             "eflags": UC_X86_REG_EFLAGS,
             "eip": UC_X86_REG_EIP,
-            "eiz": UC_X86_REG_EIZ,
             "es": UC_X86_REG_ES,
             "esi": UC_X86_REG_ESI,
             "esp": UC_X86_REG_ESP,

tests/emulate-process.py

@@ -1,4 +1,4 @@
 from dumpulator import Dumpulator
 
-dp = Dumpulator("test.dmp", trace=False)
+dp = Dumpulator("StringEncryptionFun_x64.dmp")
 dp.start(dp.regs.rip)

tests/emulate-process32.py

@@ -1,4 +1,4 @@
 from dumpulator import Dumpulator
 
-dp = Dumpulator("stringenc32_entry.dmp", trace=True)
+dp = Dumpulator("StringEncryptionFun_x86.dmp")
 dp.start(dp.regs.eip, count=0)

tests/getting-started32.py

@@ -1,13 +1,7 @@
 from dumpulator import Dumpulator
 
 dp = Dumpulator("StringEncryptionFun_x86.dmp")
-x = dp.regs.csp
-print(dp.regs.csp)
-x -= 4
-dp.regs.csp = x
-print(dp.regs.csp)
 temp_addr = dp.allocate(256)
-print(f"temp_addr: {temp_addr:0x}")
 dp.call(0x401000, [temp_addr, 0x413000])
 decrypted = dp.read_str(temp_addr)
 print(f"decrypted: '{decrypted}'")