Add Simulate location function

.github/workflows/build.yml

@@ -0,0 +1,50 @@
+name: Build minimuxer
+
+on: [push]
+
+jobs:
+  build:
+    name: Build minimuxer
+    if: startsWith(github.event.head_commit.message, '[build]')
+    concurrency:
+      group: ${{ github.ref }}
+      cancel-in-progress: true
+    runs-on: macos-12
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Install rust
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        profile: minimal
+
+    - name: Install rust targets for iOS
+      run: rustup target add aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-ios
+
+    - name: Cache rust
+      uses: Swatinem/rust-cache@v2
+
+    - name: Setup Xcode
+      uses: maxim-lobanov/setup-xcode@v1.4.1
+      with:
+        xcode-version: 14.2
+
+    - name: Build
+      run: make zip
+
+    - name: Upload to release
+      uses: IsaacShelton/update-existing-release@v1.3.1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        release: "Build"
+        tag: "build"
+        files: |
+          minimuxer.xcframework.zip
+          generated.zip
+          target/libminimuxer-ios.a
+          target/libminimuxer-sim.a
+        body: |
+          Commit: https://github.com/${{ github.repository }}/commit/${{ github.sha }}

.gitignore

@@ -1,3 +1,11 @@
 /target
-/Cargo.lock
-minimuxer.h
+Cargo.lock
+
+/minimuxer.xcframework
+/minimuxer.xcframework.zip
+/include
+
+/generated.zip
+/generated/*
+!/generated/minimuxer-Bridging-Header.h
+!/generated/minimuxer-helpers.swift

Cargo.toml

@@ -6,20 +6,30 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-rusty_libimobiledevice = { version = "0.1.6", features = ["dynamic"], default-features = false }
-plist_plus = { version = "0.2.*", features = ["dynamic"] }
+rusty_libimobiledevice = { version = "0.1", features = ["dynamic"], default-features = false }
+plist_plus = { version = "0.2", features = ["dynamic"] }
+plist = "1"
+swift-bridge = { git = "https://github.com/naturecodevoid/swift-bridge" } # TODO: change to official repo once https://github.com/chinedufn/swift-bridge/pull/209 is merged
 
-libc = { version = "0.2.132" }
-simplelog = { version = "*" }
-log = { version = "*" }
+log = "*"
+simplelog = "0.12"
 
-reqwest = { version = "0.11.12", features = ["blocking"] }
-serde = { version = "1.0.147" }
-serde_json = { version = "1.0.87" }
-zip = { version = "0.6.3" }
+serde = "1.0"
+serde_json = "1.0"
+
+# apple-codesign-wrapper = { git = "https://github.com/SideStore/apple-private-apis" }
+# p12 = "0.6"
+# der = { version = "0.7", features = ["pem"] }
+
+reqwest = { version = "0.11", features = ["blocking"] }
+zip = "0.6"
+chrono = "0.4"
 
 [build-dependencies]
-cbindgen = "0.20.0"
+swift-bridge-build = { git = "https://github.com/naturecodevoid/swift-bridge" } # TODO: change to official repo once https://github.com/chinedufn/swift-bridge/pull/209 is merged
+
+[profile.release]
+panic = "abort"
 
 [lib]
-crate-type = ["staticlib", "rlib"]
+crate-type = ["staticlib", "rlib"]

Makefile

@@ -0,0 +1,147 @@
+SIDESTORE_REPO ?= ../SideStore
+SKIP_SIM ?= false
+TARGET="minimuxer"
+
+add_targets:
+	@echo "add_targets"
+	rustup target add aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-ios
+
+build:
+	@echo "build aarch64-apple-ios"
+	@cargo build --release --target aarch64-apple-ios
+	@cp target/aarch64-apple-ios/release/lib$(TARGET).a target/lib$(TARGET)-ios.a
+
+ifeq ($(SKIP_SIM),false)
+	@echo "build aarch64-apple-ios-sim"
+	@cargo build --release --target aarch64-apple-ios-sim
+
+	@echo "build x86_64-apple-ios"
+	@cargo build --release --target x86_64-apple-ios
+
+	@echo "lipo"
+	@lipo -create \
+		-output target/lib$(TARGET)-sim.a \
+		target/aarch64-apple-ios-sim/release/lib$(TARGET).a \
+		target/x86_64-apple-ios/release/lib$(TARGET).a
+else
+	@echo "skipping sim builds"
+endif
+
+# TODO: remove/update once SPM gets merged
+copy: build
+	@echo "SIDESTORE_REPO: $(SIDESTORE_REPO)"
+
+	@echo "copying libraries"
+	@cp target/libminimuxer-ios.a "$(SIDESTORE_REPO)/Dependencies/minimuxer"
+	@cp target/libminimuxer-sim.a "$(SIDESTORE_REPO)/Dependencies/minimuxer"
+
+	@echo "copying generated"
+	@cp generated/* "$(SIDESTORE_REPO)/Dependencies/minimuxer"
+
+	@touch "$(SIDESTORE_REPO)/Dependencies/.skip-prebuilt-fetch-minimuxer"
+
+clean:
+	@echo "clean"
+	@if [ -d "include" ]; then \
+		echo "cleaning include"; \
+        rm -r include; \
+    fi
+	@if [ -d "target" ]; then \
+		echo "cleaning target"; \
+        rm -r target; \
+    fi
+	@if [ -d "$(TARGET).xcframework" ]; then \
+		echo "cleaning $(TARGET).xcframework"; \
+        rm -r $(TARGET).xcframework; \
+    fi
+	@if [ -f "$(TARGET).xcframework.zip" ]; then \
+		echo "cleaning $(TARGET).xcframework.zip"; \
+        rm $(TARGET).xcframework.zip; \
+    fi
+
+xcframework: build
+	@echo "xcframework"
+
+	@if [ -d "include" ]; then \
+		echo "cleaning include"; \
+        rm -rf include; \
+    fi
+	@mkdir include
+	@mkdir include/$(TARGET)/
+	@cp generated/*.h include/$(TARGET)/
+	@cp module.modulemap include/$(TARGET)/
+
+	@if [ -d "$(TARGET).xcframework" ]; then \
+		echo "cleaning $(TARGET).xcframework"; \
+	    rm -rf $(TARGET).xcframework; \
+	fi
+
+	@xcodebuild \
+			-create-xcframework \
+			-library target/lib$(TARGET)-ios.a \
+			-headers include/ \
+			-library target/lib$(TARGET)-sim.a \
+			-headers include/ \
+			-output $(TARGET).xcframework
+
+xcframework_frameworks: build
+	@echo "xcframework_frameworks"
+
+	@if [ -d "include" ]; then \
+		echo "cleaning include"; \
+        rm -rf include; \
+    fi
+	@mkdir include
+	@mkdir include/$(TARGET)
+	@cp generated/*.h include/$(TARGET)
+	@cp module.modulemap include/$(TARGET)
+
+	@if [ -d "target/ios" ]; then \
+		echo "cleaning target/ios"; \
+        rm -rf target/ios; \
+    fi
+	@mkdir target/ios
+	@mkdir target/ios/$(TARGET).framework
+	@mkdir target/ios/$(TARGET).framework/Headers
+
+	@if [ -d "target/sim" ]; then \
+		echo "cleaning target/sim"; \
+        rm -rf target/sim; \
+    fi
+	@mkdir target/sim
+	@mkdir target/sim/$(TARGET).framework
+	@mkdir target/sim/$(TARGET).framework/Headers
+
+	@cp include/*.* target/ios/$(TARGET).framework/Headers
+	@libtool -static \
+		-o target/ios/$(TARGET).framework/$(TARGET) \
+		target/lib$(TARGET)-ios.a
+
+	@cp include/*.* target/sim/$(TARGET).framework/Headers
+	@xcrun \
+		-sdk iphonesimulator \
+		libtool -static \
+		-o target/sim/$(TARGET).framework/$(TARGET) \
+		target/lib$(TARGET)-sim.a
+
+	@if [ -d "$(TARGET).xcframework" ]; then \
+		echo "cleaning $(TARGET).xcframework"; \
+        rm -rf $(TARGET).xcframework; \
+    fi
+	@xcodebuild -create-xcframework \
+			-library target/sim/$(TARGET).framework \
+			-headers include/ \
+			-library target/ios/$(TARGET).framework \
+			-headers include/ \
+			-output $(TARGET).xcframework
+
+zip: xcframework
+	@echo "zip xcframework"
+	@if [ -f "$(TARGET).xcframework.zip" ]; then \
+		echo "cleaning $(TARGET).xcframework.zip"; \
+        rm $(TARGET).xcframework.zip; \
+    fi
+	zip -r $(TARGET).xcframework.zip $(TARGET).xcframework
+
+	@echo "zip generated"
+	@zip -r generated.zip generated/

README.md

@@ -0,0 +1,104 @@
+# minimuxer
+
+minimuxer is the lockdown muxer used by [SideStore](https://github.com/SideStore/SideStore). It runs on device through [em_proxy](https://github.com/SideStore/em_proxy).
+
+![Alt](https://repobeats.axiom.co/api/embed/95df7af50adae86935e34bc1f59083f1db326c24.svg "Repobeats analytics image")
+
+## Building
+
+```bash
+make build # builds static libs
+make xcframework # builds an xcframework
+make zip # same as `xcframework`, and zips the final product for upload to GitHub release
+```
+
+### Publishing new release
+
+We use a github action to generate a `.xcframework` for use in Swift PM or Xcode.
+
+This overwrites the last build on the tag `Build`.
+
+Either push a commit with `[build]` as the prefix for the commit message or push an empty commit with:
+
+```bash
+git commit --allow-empty -m "[build]"
+```
+
+## Development
+
+### Off device
+
+While minimuxer is built to run on device, it is recommended to test from your computer through USB to speed up the development process. (Obviously, you should still test on device; see
+[On device](#on-device) for more info)
+
+To test off device, open [tests.rs](src/tests.rs) and use the `make_test` macro to make a test (this ensures logging and other things are initialized). You can then use
+
+```bash
+cargo test <test function name> -- --nocapture
+```
+
+to run it. (`-- --nocapture` allows for logs to be shown, which are essential for debugging and knowing if a test did what it was supposed to do)
+
+Since libimobiledevice logging can be quick verbose, you can filter it to only minimuxer logging with this command:
+
+```bash
+cargo test <test function name> -- --nocapture 2>&1 | grep -e minimuxer:: -e tests.rs
+```
+
+After implementing your feature, you should also run
+
+```bash
+cargo clippy --no-deps
+```
+
+to lint your code.
+
+If you want some of the lints to auto fix, you can use
+
+```bash
+cargo clippy --no-deps --fix
+```
+
+(make sure to commit your changes beforehand).
+
+Note: tests currently don't automatically mount the developer disk image, you must do that yourself with `ideviceimagemounter` or open SideStore on device and let the auto mounter mount it (check
+minimuxer logs in View Error Logs to see if it did so successfully).
+
+### On device
+
+SideStore communicates with minimuxer through Swift and C bindings generated by [swift-bridge](https://github.com/chinedufn/swift-bridge). swift-bridge makes it very easy to pass arguments to
+functions, especially types like `Vec`, and it also makes returning `Result` very easy.
+
+As of February 20th, minimuxer is included in SideStore as a prebuilt static library, built by GitHub Actions. Previously, it was included in SideStore as an Xcode project using cargo-xcode, but this
+made build times very long.
+
+<!-- TODO: outdated -->
+<!-- To build minimuxer for iOS and copy it to the SideStore repo, use the Makefile. Example: `make copy SIDESTORE_REPO="../SideStore"` -->
+
+## Developer Notes
+
+Unless otherwise stated, references to AltServer implementations are referring to `AltServer/Devices/ALTDeviceManager.mm`
+
+### Adding a swift-bridge/ffi function
+
+Once you've made your function, added it to the tests and verified that it works, you can add it to swift-bridge/ffi to allow Swift to use it.
+
+1. Import your function in the `ffi imports` section of `lib.rs`
+2. In `mod ffi` -> `extern "Rust"`, add your function to the section for the file you added it to.
+
+### Returning a Result from a swift-bridge/ffi function
+
+When making your function, you might have something similar to this:
+
+```rs
+pub fn install_provisioning_profile(profile: &[u8]) -> Result<()> { ... }
+```
+
+You can `use crate::Res` as a shorthand to `Result<T, crate::Errors>`. (Most files already `use` this)
+
+When exposing your function to the `ffi` module, we unfortunately can't use the `crate::Res` type alias. Instead, do this:
+`Result<[the type your function returns. in the case of install_provisioning_profile, it is ()], Errors>`
+
+### `minimuxer_install_provisioning_profile`
+
+AltServer implementation: search `installProvisioningProfiles` and `installProvisioningProfile:(`