Initial commit

Initial commit
This commit is contained in:
Stephen 2026-06-23 12:17:03 -04:00
commit 99f2db2161
16 changed files with 8699 additions and 0 deletions

2
.gitattributes vendored Normal file
View file

@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto

50
.github/workflows/build.yml vendored Normal file
View file

@ -0,0 +1,50 @@
name: Build
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
jobs:
build:
name: Build XCFramework
runs-on: macos-15
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Show toolchain
run: xcodebuild -version
- name: Install XcodeGen
run: brew install xcodegen
- name: Generate Xcode project
run: xcodegen generate
- name: Build framework
run: |
xcodebuild archive \
-project StikJIT.xcodeproj \
-scheme StikJIT \
-destination 'generic/platform=iOS' \
-archivePath build/StikJIT-iOS \
SKIP_INSTALL=NO \
BUILD_LIBRARY_FOR_DISTRIBUTION=YES \
CODE_SIGNING_ALLOWED=NO
- name: Assemble XCFramework
run: |
xcodebuild -create-xcframework \
-framework build/StikJIT-iOS.xcarchive/Products/Library/Frameworks/StikJIT.framework \
-output StikJIT.xcframework
- name: Upload XCFramework
uses: actions/upload-artifact@v4
with:
name: StikJIT.xcframework
path: StikJIT.xcframework
if-no-files-found: error

19
.gitignore vendored Normal file
View file

@ -0,0 +1,19 @@
# Build output
build/
DerivedData/
# The framework is a build artifact — rebuild it with the steps in README.md.
StikJIT.xcframework/
# XcodeGen-generated project — run `xcodegen generate`.
*.xcodeproj
# Xcode user data
xcuserdata/
*.xcuserstate
# OS / editor junk
.DS_Store
*.bak
*.swp
*.log

373
LICENSE Normal file
View file

@ -0,0 +1,373 @@
Mozilla Public License Version 2.0
==================================
1. Definitions
--------------
1.1. "Contributor"
means each individual or legal entity that creates, contributes to
the creation of, or owns Covered Software.
1.2. "Contributor Version"
means the combination of the Contributions of others (if any) used
by a Contributor and that particular Contributor's Contribution.
1.3. "Contribution"
means Covered Software of a particular Contributor.
1.4. "Covered Software"
means Source Code Form to which the initial Contributor has attached
the notice in Exhibit A, the Executable Form of such Source Code
Form, and Modifications of such Source Code Form, in each case
including portions thereof.
1.5. "Incompatible With Secondary Licenses"
means
(a) that the initial Contributor has attached the notice described
in Exhibit B to the Covered Software; or
(b) that the Covered Software was made available under the terms of
version 1.1 or earlier of the License, but not also under the
terms of a Secondary License.
1.6. "Executable Form"
means any form of the work other than Source Code Form.
1.7. "Larger Work"
means a work that combines Covered Software with other material, in
a separate file or files, that is not Covered Software.
1.8. "License"
means this document.
1.9. "Licensable"
means having the right to grant, to the maximum extent possible,
whether at the time of the initial grant or subsequently, any and
all of the rights conveyed by this License.
1.10. "Modifications"
means any of the following:
(a) any file in Source Code Form that results from an addition to,
deletion from, or modification of the contents of Covered
Software; or
(b) any new file in Source Code Form that contains any Covered
Software.
1.11. "Patent Claims" of a Contributor
means any patent claim(s), including without limitation, method,
process, and apparatus claims, in any patent Licensable by such
Contributor that would be infringed, but for the grant of the
License, by the making, using, selling, offering for sale, having
made, import, or transfer of either its Contributions or its
Contributor Version.
1.12. "Secondary License"
means either the GNU General Public License, Version 2.0, the GNU
Lesser General Public License, Version 2.1, the GNU Affero General
Public License, Version 3.0, or any later versions of those
licenses.
1.13. "Source Code Form"
means the form of the work preferred for making modifications.
1.14. "You" (or "Your")
means an individual or a legal entity exercising rights under this
License. For legal entities, "You" includes any entity that
controls, is controlled by, or is under common control with You. For
purposes of this definition, "control" means (a) the power, direct
or indirect, to cause the direction or management of such entity,
whether by contract or otherwise, or (b) ownership of more than
fifty percent (50%) of the outstanding shares or beneficial
ownership of such entity.
2. License Grants and Conditions
--------------------------------
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
(a) under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
(b) under Patent Claims of such Contributor to make, use, sell, offer
for sale, have made, import, and otherwise transfer either its
Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:
(a) for any code that a Contributor has removed from Covered Software;
or
(b) for infringements caused by: (i) Your and any other third party's
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
(c) under Patent Claims infringed by Covered Software in the absence of
its Contributions.
This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights
to grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
in Section 2.1.
3. Responsibilities
-------------------
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
(a) such Covered Software must also be made available in Source Code
Form, as described in Section 3.1, and You must inform recipients of
the Executable Form how they can obtain a copy of such Source Code
Form by reasonable means in a timely manner, at a charge no more
than the cost of distribution to the recipient; and
(b) You may distribute such Executable Form under the terms of this
License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter
the recipients' rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
3.4. Notices
You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty,
or limitations of liability) contained within the Source Code Form of
the Covered Software, except that You may alter any license notices to
the extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
---------------------------------------------------
If it is impossible for You to comply with any of the terms of this
License with respect to some or all of the Covered Software due to
statute, judicial order, or regulation then You must: (a) comply with
the terms of this License to the maximum extent possible; and (b)
describe the limitations and the code they affect. Such description must
be placed in a text file included with all distributions of the Covered
Software under this License. Except to the extent prohibited by statute
or regulation, such description must be sufficiently detailed for a
recipient of ordinary skill to be able to understand it.
5. Termination
--------------
5.1. The rights granted under this License will terminate automatically
if You fail to comply with any of its terms. However, if You become
compliant, then the rights granted under this License from a particular
Contributor are reinstated (a) provisionally, unless and until such
Contributor explicitly and finally terminates Your grants, and (b) on an
ongoing basis, if such Contributor fails to notify You of the
non-compliance by some reasonable means prior to 60 days after You have
come back into compliance. Moreover, Your grants from a particular
Contributor are reinstated on an ongoing basis if such Contributor
notifies You of the non-compliance by some reasonable means, this is the
first time You have received notice of non-compliance with this License
from such Contributor, and You become compliant prior to 30 days after
Your receipt of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
end user license agreements (excluding distributors and resellers) which
have been validly granted by You or Your distributors under this License
prior to termination shall survive termination.
************************************************************************
* *
* 6. Disclaimer of Warranty *
* ------------------------- *
* *
* Covered Software is provided under this License on an "as is" *
* basis, without warranty of any kind, either expressed, implied, or *
* statutory, including, without limitation, warranties that the *
* Covered Software is free of defects, merchantable, fit for a *
* particular purpose or non-infringing. The entire risk as to the *
* quality and performance of the Covered Software is with You. *
* Should any Covered Software prove defective in any respect, You *
* (not any Contributor) assume the cost of any necessary servicing, *
* repair, or correction. This disclaimer of warranty constitutes an *
* essential part of this License. No use of any Covered Software is *
* authorized under this License except under this disclaimer. *
* *
************************************************************************
************************************************************************
* *
* 7. Limitation of Liability *
* -------------------------- *
* *
* Under no circumstances and under no legal theory, whether tort *
* (including negligence), contract, or otherwise, shall any *
* Contributor, or anyone who distributes Covered Software as *
* permitted above, be liable to You for any direct, indirect, *
* special, incidental, or consequential damages of any character *
* including, without limitation, damages for lost profits, loss of *
* goodwill, work stoppage, computer failure or malfunction, or any *
* and all other commercial damages or losses, even if such party *
* shall have been informed of the possibility of such damages. This *
* limitation of liability shall not apply to liability for death or *
* personal injury resulting from such party's negligence to the *
* extent applicable law prohibits such limitation. Some *
* jurisdictions do not allow the exclusion or limitation of *
* incidental or consequential damages, so this exclusion and *
* limitation may not apply to You. *
* *
************************************************************************
8. Litigation
-------------
Any litigation relating to this License may be brought only in the
courts of a jurisdiction where the defendant maintains its principal
place of business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions.
Nothing in this Section shall prevent a party's ability to bring
cross-claims or counter-claims.
9. Miscellaneous
----------------
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides
that the language of a contract shall be construed against the drafter
shall not be used to construe this License against a Contributor.
10. Versions of the License
---------------------------
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses
If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
-------------------------------------------
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to look
for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
---------------------------------------------------------
This Source Code Form is "Incompatible With Secondary Licenses", as
defined by the Mozilla Public License, v. 2.0.

36
README.md Normal file
View file

@ -0,0 +1,36 @@
# StikJIT
An iOS XCFramework that enables JIT for another process over the device's RSD tunnel. Based on StikDebug.
A separate process (e.g. an app extension) attaches a debugserver to the target by PID, marks its JIT memory executable, then detaches. It is self-contained: the idevice FFI and `universal.js` are bundled inside. The target must carry the `get-task-allow` entitlement.
## Use
Add `StikJIT.xcframework` to your target (Embed & Sign), then call it off the main thread:
```swift
import StikJIT
try StikJIT.enableJIT(
targetPID: hostPID, // process to enable JIT for
pairingFile: pairingFileURL, // device pairing file
progress: { print("[StikJIT] \($0)") }
)
```
It blocks until done and throws `StikJITError` on failure. Pass `configuration:` to override the tunnel endpoint (defaults to `10.7.0.1:49152`).
## Build
```sh
xcodegen generate
xcodebuild archive -scheme StikJIT -destination 'generic/platform=iOS' \
-archivePath build/StikJIT BUILD_LIBRARY_FOR_DISTRIBUTION=YES
xcodebuild -create-xcframework \
-framework build/StikJIT.xcarchive/Products/Library/Frameworks/StikJIT.framework \
-output StikJIT.xcframework
```
## License
StikJIT is licensed under the MPL-2.0 (see [`LICENSE`](LICENSE)). It uses StikDebug as a reference, with the bundled [idevice](https://github.com/jkcoxson/idevice) and universal.js retaining their own licenses.

296
Resources/universal.js Normal file
View file

@ -0,0 +1,296 @@
// Universal JIT Script, last updated 2026-29-03 (YYYY-DD-MM)
/*
// JIT "syscalls"
__attribute__((noinline,optnone,naked))
void JIT26Detach(void) {
asm("mov x16, #0 \n"
"brk #0xf00d \n"
"ret");
}
__attribute__((noinline,optnone,naked))
void* JIT26PrepareRegion(void *addr, size_t len) {
asm("mov x16, #1 \n"
"brk #0xf00d \n"
"ret");
}
__attribute__((noinline,optnone,naked))
void BreakSendJITScript(char* script, size_t len) {
asm("mov x16, #2 \n"
"brk #0xf00d \n"
"ret");
}
*/
const CMD_DETACH = 0;
const CMD_PREPARE_REGION = 1;
const CMD_NEW_BREAKPOINTS = 2;
const commands = {
[CMD_DETACH]: JIT26Detach,
[CMD_PREPARE_REGION]: JIT26PrepareRegion,
[CMD_NEW_BREAKPOINTS]: JIT26NewBreakpoints
};
const legacyCommands = {
[0x68]: JIT26NewBreakpoints,
[0x69]: JIT26HandleBrk0x69,
[0xf00d]: JIT26HandleBrk0xf00d
};
// Log levels
//const LOG_NONE = 0;
const LOG_INFO = 1;
const LOG_VERBOSE = 2;
let logLevel = LOG_INFO;
function log_verbose(msg) {
if (logLevel >= LOG_VERBOSE) {
log(msg);
}
}
// To avoid having to re-parse these in each function, we save some registers here
let tid, x0, x1, x16, pc;
let detached = false;
let continuesWithSignal = true;
let pid = get_pid();
let attachResponse = send_command(`vAttach;${pid.toString(16)}`);
log(`pid = ${pid}`);
log(`attach_response = ${attachResponse}`);
let totalBreakpoints = 0;
while (!detached) {
totalBreakpoints++;
log(`Handling signal ${totalBreakpoints}`);
let brkResponse = send_command(`c`);
log_verbose(`brkResponse = ${brkResponse}`);
// extract tid, pc, x16
let tmpMatch = /T[0-9a-f]+thread:(?<tid>[0-9a-f]+);/.exec(brkResponse);
tid = tmpMatch ? tmpMatch.groups['tid'] : null;
tmpMatch = /20:(?<reg>[0-9a-f]{16});/.exec(brkResponse);
pc = tmpMatch ? tmpMatch.groups['reg'] : null;
tmpMatch = /10:(?<reg>[0-9a-f]{16});/.exec(brkResponse);
x16 = tmpMatch ? tmpMatch.groups['reg'] : null;
if (!tid || !pc || !x16) {
log(`Failed to extract registers: tid=${tid}, pc=${pc}, x16=${x16}`);
continue;
}
pc = littleEndianHexStringToNumber(pc);
x16 = littleEndianHexStringToNumber(x16);
let instructionResponse = send_command(`m${pc.toString(16)},4`);
log(`instruction at pc: ${instructionResponse}`);
let instrU32 = littleEndianHexToU32(instructionResponse);
// check if this is a brk
if ((instrU32 & 0xFFE0001F)>>>0 != 0xD4200000) {
log(`Skipping: instruction was not a brk (was 0x${instrU32.toString(16)})`);
if (continuesWithSignal) {
let signum = /^T(?<sig>[a-z0-9;]{2})/.exec(brkResponse);
signum = signum ? signum.groups['sig'] : null;
if (!signum) {
log(`Failed to extract signal number: ${signum}`);
continue;
}
log(`Continuing with signal 0x${signum}`);
send_command(`vCont;S${signum}:${tid}`);
}
continue;
}
let brkImmediate = extractBrkImmediate(instrU32);
log(`BRK immediate: 0x${brkImmediate.toString(16)} (${brkImmediate})`);
if (legacyCommands[brkImmediate] != undefined) {
// when we find a valid brk immediate command, parse x0 and x1
tmpMatch = /00:(?<reg>[0-9a-f]{16});/.exec(brkResponse);
x0 = tmpMatch ? tmpMatch.groups['reg'] : null;
tmpMatch = /01:(?<reg>[0-9a-f]{16});/.exec(brkResponse);
x1 = tmpMatch ? tmpMatch.groups['reg'] : null;
if (!x0 || !x1) {
log(`Failed to extract registers: x0=${x0}, x1=${x1}`);
continue;
}
x0 = littleEndianHexStringToNumber(x0);
x1 = littleEndianHexStringToNumber(x1);
// jump over brk
let pcPlus4 = numberToLittleEndianHexString(pc + 4n);
let pcPlus4Response = send_command(`P20=${pcPlus4};thread:${tid};`);
log(`pcPlus4Response = ${pcPlus4Response}`);
// dispatch brk-immediate command
const command = legacyCommands[brkImmediate];
command(brkResponse);
} else {
log(`Skipping breakpoint: brk immediate 0x${brkImmediate.toString(16)} was not handled by this script. You could add it by evaluating legacyCommands[0x${brkImmediate.toString(16)}] = yourFunction;`);
continue;
}
}
function JIT26Detach() {
let detachResponse = send_command(`D`);
log_verbose(`detachResponse = ${detachResponse}`);
detached = true;
}
// brk 0x68
function JIT26NewBreakpoints(brkResponse) {
let instructionResponse = send_command(`m${pc.toString(16)},4`);
log(`instruction at pc: ${instructionResponse}`);
let instrU32 = littleEndianHexToU32(instructionResponse);
let brkImmediate = extractBrkImmediate(instrU32);
let memResponse = send_command(`m${x0.toString(16)},${x1}`);
let scriptText = hexToAscii(memResponse);
log_verbose(`Script text: ${scriptText}`);
const res = runScriptAndCapture(scriptText);
if (res.ok) {
log('Script succeeded:', res.value);
} else {
log('Script failed:', res.name, res.message);
log(res.stack);
}
}
// brk 0x69
function JIT26HandleBrk0x69(brkResponse) {
// in the old script we chose 0x69, so now we check here and return error
// if you wish to keep using this, you can set your own handler like `legacyCommands[0x69] = yourHandler;` using BreakSendJITScript
log(`Error: It seems you are using legacy breakpoint 0x69. Please set your legacy handler using \`legacyCommands[0x69] = yourHandler;\` or migrate to universal jitcalls to use this script. The function will now return 0xE0000069.`);
let putX0Response = send_command(`P0=E0000069;thread:${tid};`);
log(`putX0Response = ${putX0Response}`);
}
// brk 0xf00d
function JIT26HandleBrk0xf00d(brkResponse) {
// dispatch command via x16
const command = commands[x16];
if (command === undefined) {
log(`Unknown command ${x16.toString(16)}`);
return;
}
log(`Invoking command ${x16.toString(16)}`);
command(brkResponse);
}
function JIT26PrepareRegion(brkResponse) {
let instructionResponse = send_command(`m${pc.toString(16)},4`);
log(`instruction at pc: ${instructionResponse}`);
let instrU32 = littleEndianHexToU32(instructionResponse);
let brkImmediate = extractBrkImmediate(instrU32);
if (x0 == 0n && x1 == 0n) {
return;
}
let jitPageAddress = x0;
if (x0 == 0n) {
let requestRXResponse = send_command(`_M${x1.toString(16)},rx`);
log_verbose(`requestRXResponse = ${requestRXResponse}`);
if (!requestRXResponse || requestRXResponse.length === 0) {
log(`Failed to allocate RX memory`);
return;
}
jitPageAddress = BigInt(`0x${requestRXResponse}`);
log(`Allocated JIT page at address: 0x${jitPageAddress.toString(16)}`);
}
let prepareJITPageResponse = prepare_memory_region(jitPageAddress, x1);
log(`prepareJITPageResponse = ${prepareJITPageResponse}`);
let putX0Response = send_command(`P0=${numberToLittleEndianHexString(jitPageAddress)};thread:${tid};`);
log(`putX0Response = ${putX0Response}`);
}
// utilities
function littleEndianHexStringToNumber(hexStr) {
const bytes = [];
for (let i = 0; i < hexStr.length; i += 2) {
bytes.push(parseInt(hexStr.substr(i, 2), 16));
}
let num = 0n;
for (let i = 4; i >= 0; i--) {
num = (num << 8n) | BigInt(bytes[i]);
}
return num;
}
function numberToLittleEndianHexString(num) {
const bytes = [];
for (let i = 0; i < 5; i++) {
bytes.push(Number(num & 0xFFn));
num >>= 8n;
}
while (bytes.length < 8) {
bytes.push(0);
}
return bytes.map(b => b.toString(16).padStart(2, '0')).join('');
}
function littleEndianHexToU32(hexStr) {
return parseInt(hexStr.match(/../g).reverse().join(''), 16);
}
function extractBrkImmediate(u32) {
return (u32 >> 5) & 0xFFFF;
}
function hexToAscii(hexStr) {
let str = '';
for (let i = 0; i < hexStr.length; i += 2) {
const byte = parseInt(hexStr.substr(i, 2), 16);
if (byte === 0) break;
str += String.fromCharCode(byte);
}
return str;
}
function runScriptAndCapture(scriptText) {
try {
const value = eval(scriptText);
return { ok: true, value };
} catch (err) {
return {
ok: false,
name: err && err.name,
message: err && err.message,
stack: err && err.stack
};
}
}
// For making your own script / adding your own breakpoints. you can send this string to BreakSendJITScript and it'll add it for any subsequent breakpoints
// x0, x1, x16, pc and tid are global variables. If you need more registers, parse them like:
// tmpMatch = /02:(?<reg>[0-9a-f]{16});/.exec(brkResponse); // x2
// let x2 = tmpMatch ? tmpMatch.groups['reg'] : null;
// if (!x2) {
// log(`Failed to extract registers: x2=${x2}`);
// return;
// }
// x2 = littleEndianHexStringToNumber(x2);
//
/*
commands[3] = wowBreakPoint;
function wowBreakPoint(brekpoint) {
let instructionResponse = send_command(`m${pc.toString(16)},4`);
log(`instruction at pc: ${instructionResponse}`);
let instrU32 = littleEndianHexToU32(instructionResponse);
let brkImmediate = extractBrkImmediate(instrU32);
if (x0 == 0n && x1 == 0n) {
return;
}
let jitPageAddress = x0;
let prepareJITPageResponse = prepare_memory_region(jitPageAddress, x1);
log(`prepareJITPageResponse = ${prepareJITPageResponse}`);
let putX0Response = send_command(`P0=${numberToLittleEndianHexString(jitPageAddress)};thread:${tid};`);
log(`putX0Response = ${putX0Response}`);
}
*/

View file

@ -0,0 +1,16 @@
import Foundation
enum BundledScript {
static func universalJS() throws -> String {
let bundle = Bundle(for: BundleToken.self)
guard let url = bundle.url(forResource: "universal", withExtension: "js"),
let source = try? String(contentsOf: url, encoding: .utf8),
!source.isEmpty else {
throw StikJITError.scriptUnavailable
}
return source
}
}
private final class BundleToken {}

21
Sources/IdeviceFFI.swift Normal file
View file

@ -0,0 +1,21 @@
import Foundation
@_implementationOnly import idevice
enum IdeviceFFI {
static func consume(_ pointer: UnsafeMutablePointer<IdeviceFfiError>?,
fallback: String) -> StikJITError {
guard let pointer else { return .device(code: -1, subCode: 0, message: fallback) }
let error = StikJITError.device(
code: pointer.pointee.code,
subCode: pointer.pointee.sub_code,
message: pointer.pointee.message.map { String(cString: $0) } ?? fallback)
idevice_error_free(pointer)
return error
}
static func check(_ fallback: String,
_ call: () -> UnsafeMutablePointer<IdeviceFfiError>?) throws {
if let error = call() { throw consume(error, fallback: fallback) }
}
}

108
Sources/JITSession.swift Normal file
View file

@ -0,0 +1,108 @@
import Foundation
@_implementationOnly import idevice
final class JITSession {
struct Tunnel {
var adapter: OpaquePointer?
var handshake: OpaquePointer?
func free() {
if let handshake { rsd_handshake_free(handshake) }
if let adapter { adapter_free(adapter) }
}
}
private struct DebugSession {
var remoteServer: OpaquePointer?
var debugProxy: OpaquePointer?
func free() {
if let debugProxy { debug_proxy_free(debugProxy) }
if let remoteServer { remote_server_free(remoteServer) }
}
}
private let pairingFilePath: String
private let configuration: StikJIT.Configuration
init(pairingFilePath: String, configuration: StikJIT.Configuration) {
self.pairingFilePath = pairingFilePath
self.configuration = configuration
}
func enableJIT(targetPID: Int32, progress: @escaping (String) -> Void) throws {
let tunnel = try makeTunnel()
defer { tunnel.free() }
let session = try connectDebugSession(over: tunnel)
defer { session.free() }
guard let debugProxy = session.debugProxy else { throw StikJITError.debugProxyUnavailable }
debug_proxy_send_ack(debugProxy)
_ = try? sendCommand("QStartNoAckMode", over: debugProxy)
debug_proxy_set_ack_mode(debugProxy, 0)
try ScriptRunner(targetPID: targetPID, debugProxy: debugProxy, progress: progress).run()
}
private func openPairingFile() throws -> OpaquePointer {
guard !pairingFilePath.isEmpty, FileManager.default.fileExists(atPath: pairingFilePath) else {
throw StikJITError.pairingFile("not found at \(pairingFilePath)")
}
var handle: OpaquePointer?
try IdeviceFFI.check("failed to read pairing file") {
pairingFilePath.withCString { rp_pairing_file_read($0, &handle) }
}
guard let handle else { throw StikJITError.pairingFile("unreadable at \(pairingFilePath)") }
return handle
}
private func makeTunnel() throws -> Tunnel {
let pairing = try openPairingFile()
defer { rp_pairing_file_free(pairing) }
var address = sockaddr_in()
address.sin_family = sa_family_t(AF_INET)
address.sin_port = configuration.rsdPort.bigEndian
_ = configuration.deviceAddress.withCString { inet_pton(AF_INET, $0, &address.sin_addr) }
var tunnel = Tunnel()
try IdeviceFFI.check("failed to create RSD tunnel") {
"StikJIT".withCString { hostname in
withUnsafePointer(to: &address) { pointer in
pointer.withMemoryRebound(to: sockaddr.self, capacity: 1) { sa in
tunnel_create_rppairing(
sa, socklen_t(MemoryLayout<sockaddr_in>.stride),
hostname, pairing, nil, nil,
&tunnel.adapter, &tunnel.handshake)
}
}
}
}
return tunnel
}
private func connectDebugSession(over tunnel: Tunnel) throws -> DebugSession {
var session = DebugSession()
try IdeviceFFI.check("failed to connect remote server") {
remote_server_connect_rsd(tunnel.adapter, tunnel.handshake, &session.remoteServer)
}
try IdeviceFFI.check("failed to connect debug proxy") {
debug_proxy_connect_rsd(tunnel.adapter, tunnel.handshake, &session.debugProxy)
}
return session
}
@discardableResult
private func sendCommand(_ command: String, over debugProxy: OpaquePointer) throws -> String? {
guard let handle = command.withCString({ debugserver_command_new($0, nil, 0) }) else { return nil }
defer { debugserver_command_free(handle) }
var response: UnsafeMutablePointer<CChar>?
try IdeviceFFI.check("debugserver command failed") {
debug_proxy_send_command(debugProxy, handle, &response)
}
guard let response else { return nil }
defer { idevice_string_free(response) }
return String(cString: response)
}
}

View file

@ -0,0 +1,81 @@
import Foundation
import JavaScriptCore
@_implementationOnly import idevice
final class ScriptRunner {
private static let jitPageSize: UInt64 = 16384
private let targetPID: Int32
private let debugProxy: OpaquePointer
private let progress: (String) -> Void
private var context: JSContext?
init(targetPID: Int32, debugProxy: OpaquePointer, progress: @escaping (String) -> Void) {
self.targetPID = targetPID
self.debugProxy = debugProxy
self.progress = progress
}
func run() throws {
let source = try BundledScript.universalJS()
guard let context = JSContext() else { throw StikJITError.scriptUnavailable }
self.context = context
context.exceptionHandler = { [weak self] _, value in
self?.progress("JS exception: \(value?.toString() ?? "<unknown>")")
}
let getPID: @convention(block) () -> Int = { [targetPID] in Int(targetPID) }
let send: @convention(block) (String?) -> String = { [weak self] command in
guard let self, let command else { return "" }
return self.sendCommand(command) ?? ""
}
let prepare: @convention(block) (Double, Double) -> String = { [weak self] address, length in
guard let self else { return "" }
return self.prepareMemoryRegion(UInt64(address), length: UInt64(length)) ?? "OK"
}
let log: @convention(block) (JSValue?) -> Void = { [weak self] value in
self?.progress(value?.toString() ?? "")
}
context.setObject(getPID, forKeyedSubscript: "get_pid" as NSString)
context.setObject(send, forKeyedSubscript: "send_command" as NSString)
context.setObject(prepare, forKeyedSubscript: "prepare_memory_region" as NSString)
context.setObject(log, forKeyedSubscript: "log" as NSString)
progress("Running universal.js against pid \(targetPID)…")
context.evaluateScript(source)
progress("JIT script finished (region blessed, detached).")
}
private func sendCommand(_ command: String) -> String? {
guard let handle = command.withCString({ debugserver_command_new($0, nil, 0) }) else { return nil }
defer { debugserver_command_free(handle) }
var response: UnsafeMutablePointer<CChar>?
if let error = debug_proxy_send_command(debugProxy, handle, &response) {
progress("send_command error: \(IdeviceFFI.consume(error, fallback: "send_command").localizedDescription)")
return nil
}
guard let response else { return "" }
defer { idevice_string_free(response) }
return String(cString: response)
}
private func prepareMemoryRegion(_ address: UInt64, length: UInt64) -> String? {
guard length > 0 else { return "OK" }
let pageCount = (length - 1) / Self.jitPageSize + 1
for page in 0..<pageCount {
let pageAddress = address + page * Self.jitPageSize
let response = sendCommand("M\(String(pageAddress, radix: 16)),1:69")
if let response, !(response.hasPrefix("OK") || response.isEmpty) {
progress("page bless failed @0x\(String(pageAddress, radix: 16)): \(response)")
return nil
}
}
progress("Blessed \(pageCount) JIT page(s) at 0x\(String(address, radix: 16))")
return "OK"
}
}

26
Sources/StikJIT.swift Normal file
View file

@ -0,0 +1,26 @@
import Foundation
public enum StikJIT {
public struct Configuration: Sendable {
public var deviceAddress: String
public var rsdPort: UInt16
public init(deviceAddress: String = "10.7.0.1", rsdPort: UInt16 = 49152) {
self.deviceAddress = deviceAddress
self.rsdPort = rsdPort
}
public static let `default` = Configuration()
}
public static func enableJIT(targetPID: Int32,
pairingFile: URL,
configuration: Configuration = .default,
progress: @escaping (String) -> Void = { _ in }) throws {
let session = JITSession(pairingFilePath: pairingFile.path, configuration: configuration)
try session.enableJIT(targetPID: targetPID, progress: progress)
}
}

View file

@ -0,0 +1,25 @@
import Foundation
public enum StikJITError: Error, LocalizedError {
case pairingFile(String)
case scriptUnavailable
case debugProxyUnavailable
case device(code: Int32, subCode: Int32, message: String)
public var errorDescription: String? {
switch self {
case .pairingFile(let detail):
return "Pairing file error: \(detail)."
case .scriptUnavailable:
return "The bundled universal.js could not be loaded from the StikJIT framework."
case .debugProxyUnavailable:
return "Failed to establish a debugserver connection to the target process."
case .device(let code, let subCode, let message):
return "\(message) (idevice code \(code)/\(subCode))."
}
}
}

7593
idevice/idevice.h Normal file

File diff suppressed because it is too large Load diff

BIN
idevice/libidevice_ffi.a Normal file

Binary file not shown.

4
idevice/module.modulemap Normal file
View file

@ -0,0 +1,4 @@
module idevice [system] {
header "idevice.h"
export *
}

49
project.yml Normal file
View file

@ -0,0 +1,49 @@
name: StikJIT
options:
bundleIdPrefix: com.stik
deploymentTarget:
iOS: "17.4"
createIntermediateGroups: true
settings:
base:
SWIFT_VERSION: "5.0"
MARKETING_VERSION: "1.0.0"
CURRENT_PROJECT_VERSION: "1"
CLANG_CXX_LIBRARY: "libc++"
targets:
StikJIT:
type: framework
platform: iOS
sources:
- path: Sources
- path: Resources
buildPhase: resources
dependencies:
- sdk: JavaScriptCore.framework
- sdk: Network.framework
- sdk: Security.framework
- sdk: CFNetwork.framework
- sdk: SystemConfiguration.framework
settings:
base:
PRODUCT_BUNDLE_IDENTIFIER: com.stik.StikJIT
PRODUCT_NAME: StikJIT
DEFINES_MODULE: YES
BUILD_LIBRARY_FOR_DISTRIBUTION: YES
SKIP_INSTALL: NO
# idevice FFI: modulemap/headers to compile `import idevice`, and force_load the
# static lib so all its symbols are embedded in the framework binary (self-contained).
SWIFT_INCLUDE_PATHS: "$(SRCROOT)/idevice"
HEADER_SEARCH_PATHS: "$(SRCROOT)/idevice"
LIBRARY_SEARCH_PATHS: "$(SRCROOT)/idevice"
OTHER_LDFLAGS: "-force_load $(SRCROOT)/idevice/libidevice_ffi.a"
schemes:
StikJIT:
build:
targets:
StikJIT: all
archive:
config: Release