feat: compile to WebAssembly to eliminate native dependencies (#8)

* wip: compile to WebAssembly to eliminate native dependencies

* chore: add jobs option to build script

* ci: various config fixes

* chore: attempt at fixing build issue on Windows

* test: make tests Windows friendly

* test: fix resource content check

* build: check for emcmake

* wip: initial porting of ELF injection

* wip: initial porting of PE code

* chore: check files exist in CLI

* chore: disable more parts of LIEF

* chore: change variable name for consistency

* chore: remove TODO note

* ci: add lint job

* chore: only remove Mach-O signature if present

* chore: update README instructions

* docs: update usage example

* chore: make main.js executable

* ci: install dependencies on 'linux' executor

* chore: reduce required Node.js version

* ci: upload test results to CircleCI

* chore: fix linting on Windows

* test: refactor testing setup

* chore: use dev suffix for version number

* chore: more error handling for file operations

* test: bump timeout on test

Was timing out on Ubuntu executor on CI

* ci: tweak CI executors

* test: tweak test

* ci: streamline CI config

* test: don't use zx in tests

* test: add more expectations around CLI output

* fix: use correct uppercase method

* test: comment out expect for now

* fix: use correct resource type for PE

* chore: improve build script on Windows

* test: bump test timeout

* chore: address review comments

* ci: drop unused git config for Windows

* test: another bump to timeout for CI

Author: dsanders11

.circleci/config.yml

@@ -21,7 +21,7 @@ executors:
   debian:
     resource_class: medium
     docker:
-      - image: docker.io/library/debian:11
+      - image: docker.io/library/debian:bookworm
 
   linux:
     resource_class: medium
@@ -36,35 +36,64 @@ executors:
 ## COMMANDS ##
 
 commands:
+  npm_install:
+    parameters:
+      <<: *common_parameters
+    steps:
+      - when:
+          condition:
+            equal: [ alpine, << parameters.os >> ]
+          steps:
+            - run: apk update
+            - run: apk add --no-cache nodejs npm
+
+      - when:
+          condition:
+            equal: [ debian, << parameters.os >> ]
+          steps:
+            - run: apt-get update
+            - run: apt-get install --no-install-recommends -y ca-certificates nodejs npm
+
+      - when:
+          condition:
+            equal: [ linux, << parameters.os >> ]
+          steps:
+            - run: sudo apt-get update
+            - run: sudo apt-get install --no-install-recommends -y ca-certificates nodejs npm
+
+      - run: npm install
+
   prepare:
     parameters:
       <<: *common_parameters
     steps:
-      # NOTE: minimal effort to allow moving most conditionals out of ci config
       - when:
           condition:
             equal: [ alpine, << parameters.os >> ]
           steps:
-            - run: apk add -U make
+            - run: apk update
+            - run: apk add --no-cache build-base git ninja cmake python3 python3-dev py3-setuptools
 
       - when:
           condition:
             equal: [ debian, << parameters.os >> ]
           steps:
-            - run: apt-get update -y && apt-get install -y make
+            - run: apt-get update
+            - run: apt-get install --no-install-recommends -y build-essential git ninja-build cmake python3 python3-dev python3-setuptools
 
       - when:
           condition:
             equal: [ linux, << parameters.os >> ]
           steps:
-            - run: sudo apt-get update -y && sudo apt-get install -y make
+            - run: sudo apt-get update
+            - run: sudo apt-get install --no-install-recommends -y build-essential git ninja-build cmake
 
       - when:
           condition:
-            not:
-              equal: [ "win/default", << parameters.os >> ]
+            equal: [ macos, << parameters.os >> ]
           steps:
-            - run: make install-deps EXECUTOR=<< parameters.os >>
+            - run: brew install cmake
+            - run: brew install ninja
 
       - when:
           condition:
@@ -73,6 +102,28 @@ commands:
             - run: choco install cmake.install --installargs '"ADD_CMAKE_TO_PATH=User"'
             - run: choco install ninja
 
+      - run: git clone https://github.com/emscripten-core/emsdk.git
+
+      - when:
+          condition:
+            equal: [ "win/default", << parameters.os >> ]
+          steps:
+            - run:
+               command: cd emsdk & emsdk install latest
+               shell: cmd.exe
+
+      - when:
+          condition:
+            not:
+              equal: [ "win/default", << parameters.os >> ]
+          steps:
+            - run: cd emsdk && ./emsdk install latest
+            - run: cd emsdk && ./emsdk activate latest
+
+  lint:
+    steps:
+      - run: npm run lint
+
   build:
     parameters:
       <<: *common_parameters
@@ -94,76 +145,88 @@ commands:
                 # compilation terminated
                 #
                 # force overwrite job count here:
-                command: make lief JOBS=3
+                command: cd emsdk && source ./emsdk_env.sh && cd .. && npm run build -- --jobs=3
 
       - when:
           condition:
             equal: [ "win/default", << parameters.os >> ]
           steps:
             - run:
-               command: refreshenv & cd vendor\lief & python ./setup.py --ninja build_ext -b ..\..\dist\lief
+               command: refreshenv & cd emsdk & emsdk activate latest & cd .. & npm run build
                shell: cmd.exe
 
       - persist_to_workspace:
           root: .
           paths:
-            - dist/lief
+            - build
+            - dist
+            - emsdk
 
   test:
     steps:
       - attach_workspace:
           at: .
 
-      - run: make check
+      - run: npm test -- --reporter mocha-junit-reporter
+
+      - store_test_results:
+          path: .
 
 ## JOBS ##
 
 jobs:
+  lint:
+    parameters:
+      <<: *common_parameters
+    executor: { name: << parameters.os >> }
+    steps:
+      - checkout
+      - npm_install:
+          os: << parameters.os >>
+      - lint
+
   build:
     parameters:
       <<: *common_parameters
     executor: { name: << parameters.os >> }
     steps:
       - checkout
+      - npm_install:
+          os: << parameters.os >>
       - prepare:
           os: << parameters.os >>
       - build:
           os: << parameters.os >>
       - store_artifacts:
           path: dist
-      - store_artifacts:
-          path: postject-api.h
-      - store_artifacts:
-          path: postject.py
 
   test:
     parameters:
       <<: *common_parameters
     executor: { name: << parameters.os >> }
     steps:
       - checkout
-      - prepare:
+      - npm_install:
           os: << parameters.os >>
       - test
 
 ## WORKFLOWS ##
 
-build_matrix: &build_matrix
-  matrix:
-    parameters:
-      os: [ alpine, debian, linux, macos, "win/default" ]
-
-test_matrix: &test_matrix
+matrix: &matrix
   matrix:
     parameters:
-      os: [ alpine, debian, linux, macos ]
+      os: [ debian, linux, macos, "win/default" ]
 
 workflows:
   postject:
     jobs:
+      - lint:
+          matrix:
+            parameters:
+              os: [ linux, macos ]
       - build:
-          <<: *build_matrix
+          <<: *matrix
       - test:
-          <<: *test_matrix
-          requires: [ build-<<matrix.os>> ]
+          <<: *matrix
+          requires: [ build-<< matrix.os >> ]
 

.gitignore

@@ -50,6 +50,4 @@ Thumbs.db
 
 vendor/lief/lief.*.so
 vendor/lief/build/
-examples/data.txt
-examples/test
-examples/*.o
+build/

CMakeLists.txt

@@ -0,0 +1,29 @@
+cmake_minimum_required(VERSION 3.9)
+set(CMAKE_CXX_STANDARD 11)
+
+project(postject)
+
+# Disable unnecessary LIEF options
+option(LIEF_DOC "Build LIEF docs" OFF)
+option(LIEF_PYTHON_API "Build LIEF Python API" OFF)
+option(LIEF_EXAMPLES "Build LIEF examples" OFF)
+option(LIEF_TESTS "Build LIEF tests" OFF)
+option(LIEF_ART "Build LIEF with ART module" OFF)
+option(LIEF_DEX "Build LIEF with DEX module" OFF)
+option(LIEF_VDEX "Build LIEF with VDEX module" OFF)
+option(LIEF_OAT "Build LIEF with OAT module" OFF)
+
+if(MSVC)
+  set(LIEF_USE_CRT_RELEASE "MT" CACHE STRING "LIEF CRT option")
+endif()
+
+add_subdirectory(vendor/lief)
+
+add_executable(postject src/postject.cpp)
+set_target_properties(postject PROPERTIES LINK_FLAGS "-sMODULARIZE=1 --bind")
+
+if(MSVC)
+  set_property(TARGET postject PROPERTY LINK_FLAGS /NODEFAULTLIB:MSVCRT)
+endif()
+
+target_link_libraries(postject PUBLIC LIEF::LIEF)

Makefile

@@ -7,32 +7,45 @@ Easily inject arbitrary read-only resources into executable formats
 
 ## Building
 
-### Windows
-
-You'll need CMake and Ninja to build LIEF.
+### Prerequisites
 
-```sh
-$ cd vendor\lief
-$ python3 ./setup.py --ninja build_ext -b ..\..\dist\lief
-```
+* CMake
+* Ninja
+* [Emscripten (emsdk)](https://emscripten.org/docs/getting_started/downloads.html)
 
-### macOS / Linux
+### Build Command
 
 ```sh
-$ sudo make install-deps
-$ make lief
+$ npm run build
 ```
 
+The final output is placed in `dist/`, with `main.js` being the
+entrypoint.
+
 ## Usage
 
 ```sh
-$ ./postject.py --macho-segment-name __ELECTRON /Users/dsanders/electron/src/out/Testing/Electron.app/Contents/Frameworks/Electron\ Framework.framework/Electron\ Framework app_asar /Users/dsanders/test.asar
+$ postject -h
+Usage: postject [options] <filename> <resource_name> <resource>
+
+Inject arbitrary read-only resources into an executable for use at runtime
+
+Arguments:
+  filename                             The executable to inject into
+  resource_name                        The resource name to use (section name on Mach-O and ELF, resource name for PE)
+  resource                             The resource to inject
+
+Options:
+  --macho-segment-name <segment_name>  Name for the Mach-O segment (default: "__POSTJECT")
+  --output-api-header                  Output the API header to stdout
+  --overwrite                          Overwrite the resource if it already exists
+  -h, --help                           display help for command
 ```
 
 ### Testing
 
 ```sh
-$ make check
+$ npm test
 ```
 
 ## Design