Files
reverse-skills-max/vendor-new/apk-reverse/docs/tool-verification/REPO-DECISIONS.md

19 KiB
Raw Blame History

Repository decisions, and the evidence behind them

The pass was framed as a choice between two ways to split the skill. The measurement rejected the framing, and this file records why, then states exactly what changed in the repository.


The decision: no second skill. Fix skill A instead.

This is the "暂不建" outcome the brief explicitly permits, and it is supported by the evidence rather than by preference.

Why the framing did not survive contact with the target

The two candidate splits were:

  • by entry point — everything reached from an APK (including Flutter/IL2CPP) stays in A; only standalone ELF goes to B. Cost: A keeps growing.
  • by logic location — A keeps only logic genuinely in dex; Flutter, IL2CPP, hardened dex, native and standalone ELF all move out. Cost: four references (~962 lines) relocate.

The measured target is exactly the case that was supposed to discriminate between them: Flutter (machine-code side) whose entry point is an APK. It produced a third answer.

The problem is not where the content lives. It is one missing dependency. Everything the kit does after a snapshot dumper has produced pp.txt works correctly — the reference index, the disassembly windows, the caller index, all verified against capstone. The single thing it cannot do is get from the binary to pp.txt, because it has no snapshot container resolver, and that gap is not bridgeable from inside the scripts (4,241 shared strings, 4,237 distinct deltas, no constant).

A second skill would relocate Flutter documentation without adding the capability that is missing. The gap would travel with the documents. Worse, it would split the Coverage claim in two and leave the user of either skill less able to tell what actually works.

The supporting evidence, in order of weight

  1. The kit works where it was tested. dart_disasm.py decoded identically to capstone (32/32, 96/96); the caller index re-derived independently agrees with symmetric difference 0; dart_pool_strings.py was byte-exact on 18,356 of 18,363 rows with all 7 residuals explained as TSV escaping, and 12/12 random offsets re-located from raw bytes. These are not the results of a tool that needs replacing.
  2. The blocker is a front end, and free front ends exist. aotopsy ran the full pipeline out of the box — 30,586 functions, 39,202 pool entries, 175,120 call edges, 95.7% BLR annotation — with no toolchain: pure Go, no compiler, no Dart SDK. That is the "decoding the object pool" capability, delivered as a binary.
  3. A split would contradict the Coverage section's own structure. Coverage already lists Flutter under covered by verified mechanisms and Unity/IL2CPP under not covered. The real defect is that the Flutter line overstates what ships. The fix for an overstated claim is to correct the claim, not to relocate it.
  4. The cost of the split lands on the wrong people. Moving dart-aot.md, native-and-so.md, native-tamper-and-suicide.md and code-virtualization-and-custom-linkers.md would break 162 cross-references that currently resolve, and would move material that this pass could not exercise at all (packers, VMP) on the strength of evidence gathered about something else.

What the second skill would have been, stated so the decision can be revisited

If a future pass ever does need one, the boundary the evidence points at is "standalone machine-code targets with no APK" — a plain .so/ELF analysed on its own. That is the split the entry-point option described, and it remains untested: this target is an APK, so no evidence for or against it was produced here. The pass therefore declines to build it and says so plainly rather than inventing a skeleton.

Selective installation, measured — and what it implies for shared tooling

The brief asked for the shared-tooling question to be settled by the actual install product rather than by preference. Measured with npx skills add newliver666/apk-reverse --skill apk-reverse -y --copy in an empty directory:

  • The skill is copied whole and self-contained into each detected agent directory — .agents/, .claude/, .kiro/, .pi/, .qwen/, .zcode/, six in total on this host — plus a skills-lock.json at the root.
  • Every file lands under <agent>/skills/apk-reverse/: SKILL.md, all 28 references/*.md, all 34 scripts/* including the dexpatch/ subdirectory. Nothing outside the skill directory is installed. The repository's root-level docs/ and the three maintenance checkers are absent from the product, as intended.
  • There is no cross-skill sharing mechanism in the installed layout.

Consequence for this decision: had the skill been split, the two halves would each have needed their own copy of any shared script, or a path that points outside the skill directory — and the latter does not survive installation, because it is not part of the product. So the "shall we put shared tools in a root shared/" question resolves itself: it cannot work that way, and with one skill there is nothing to share. The record is kept here because the observation is what makes the reasoning checkable rather than asserted.


Changes made

references/dart-aot.md

Change Reason
Documented a pinned front end (aotopsy v1.6.0, sha256 5a90bcf2…fdc1; Dart 2.10–3.13; ARM64 + x86_64) as the entry point for the workflow, with blutter as the alternative when a compiled Dart VM is acceptable The workflow's step 1 was not performable with what the skill shipped. Measured: the kit cannot go from a string to a pool offset.
Corrected the build budget: ≈78 s measured, not "tens of minutes" Measured end to end, log timestamps 04:45:59 → 04:47:17
Corrected the compiler requirement: MSVC 19.34 (Nov 2022) suffices Verified by compiling and running a std::format probe with it
Removed the claim that asm/ contains no instructions Measured false: the file carries class layouts, signatures, a full instruction listing, pool annotations and resolved call targets
Recorded the version-probe trap: aotopsy doctor labels the snapshot 3.6.2, the engine banner and snapshot hash say 3.6.0, and 3.6.0 is correct Three independent facts agree on 3.6.0; aotopsy's number is a structural profile label and must not be passed to a VM-compiling tool
Noted that the two-byte chaining test in §7 did not hold here 9,840 two-byte CJK candidates → 2,081 chained runs, all junk

references/references-index / script defects

dart_pprefs.py is fixed in the repository. The defect — only the GP register file decoded, so ldr dD,[x27,#imm] (0xFD400000) and an entire class of double constants were dropped — was re-verified on the patched script against capstone over the whole .text: 0 displacements and 0 sites of difference, against 302 and 1,802 before.

find_refs.py, elf_plt.py and the so_constpatch.py alignment defect are documented but not fixed. The repository's rule is that nothing ships unrun, and the fixes for these were not exercised against the real target in this pass:

  • find_refs.py — accepting .dex input means deciding how to read dex without baksmali/jadx present, which is a design decision, not a one-line patch.
  • elf_plt.py — the three-bound fix was verified on a copy (work/native/tools/elf_plt_fixed.py), not in the repository, so the repository version is untouched.
  • so_constpatch.py — the alignment fix needs a padding implementation and a zipalign story.

Each is recorded in docs/tool-verification/FINDINGS.md with its root cause and the fix sketch, which is the honest form: the knowledge is preserved and the unrun code does not enter the tree.

SKILL.md — Coverage

Rewritten so the Flutter line states what was measured:

  • In coverage: Flutter/Dart AOT analysis given a snapshot dump — pool-reference counting, disassembly windows, caller indexing and patching — all verified on a real Dart 3.6.0 libapp.so, with the front end named as a documented dependency.
  • Explicit new dependency line: the kit does not decode the object pool; it requires a snapshot dumper (aotopsy pinned, or blutter built from source) and says so instead of implying otherwise.
  • Unchanged: Unity/IL2CPP, React Native/Hermes, iOS, defeating a server-side authority, and the general-unpacker/anti-detection arms race all remain uncovered.
  • Added: an explicit statement that packer, VMP and integrity-check scenarios were not exercised by this pass, so no claim is upgraded on their behalf.

SKILL.md — the three hand-off points

Written from the perspective that a hand-off is a pointer, and that duplicating content across two places is how the two copies drift. Each one says what the other side owns.

  1. JNI — Java declaring a native method ↔ its .so implementation. Static linkage shows as Java_com_pkg_Class_method and disappears under R8 short names; dynamic registration leaves the symbol table empty and must be found at RegisterNatives. This target ships the static form (FlutterJNI.loadLibrary appears in classes3.dex) but the pass did not trace a JNI boundary end to end, so the section carries the unverified label.
  2. Hardening — dex-side observation of a packer implies a native-side shell implementation. Not exercised here: this target has no packer. Recorded as a pointer with that stated.
  3. Existing boundary documents — native-and-so.md and native-tamper-and-suicide.md read native anomalies from the APK side (immediate SIGSEGV after a repack, Java claiming the check passed while the process dies). That belongs in A; deep native work is the other side. The new section points each way rather than repeating either.

docs/tool-verification/

New directory holding this pass's evidence record. README.md states the folder is a measurement record, not shipped target data, carries the strength-label convention, and requires that no target identity is recorded — only what a future reader can apply to a different APK. It is referenced from SKILL.md so a reader can check the Coverage claims against the runs behind them.

No APK is in the repository (.gitignore already excludes *.apk) and no credential or token appears in any file.

README.md

Updated for the directory tree, the install command and the division of labour between the skills, plus a pointer to the verification record.


Verification

All four gates were re-run against the final tree:

  • python -B check_repo.py
  • python -B check_refs.py
  • python -B build_scripts.py . <out>
  • npx skills add newliver666/apk-reverse --list

Two behaviours of the checkers worth knowing, both established by experiment during this pass: check_repo.py and check_refs.py have no argparse, so --help is silently ignored and the full check runs; and running check_repo.py with PYTHONIOENCODING=utf-8 set produces a spurious failure (exit 1, one script reported as crashed) because its subprocess.run(..., text=True) does not pin an encoding while the child emits UTF-8 — the parent then decodes as cp936 and the streams come back empty.


A later pass: fixing the find_refs.py defect, and what measuring it exposed

The three defects recorded above as "documented but not fixed" were left alone for a stated reason: the repository ships nothing unrun. One of them — find_refs.py and .dex input — was reported again from outside with a clean reproduction, and that reproduction is correct. It is now fixed, together with a deeper defect the fix exposed.

find_refs.py

Accepts a .dex, a directory of .smali and/or .dex, an .apk, or a smali tree. Dex input is decoded through dexutil, so baksmali is not required — which matters because the machine where the defect was found had no baksmali, jadx or apktool, and the tool was therefore completely unusable for that target. Input it cannot read is refused with exit 2 and a reason, and every run prints [scanned] N file(s) before the count, so "nothing was readable" can no longer print the same line as "read N files and found nothing".

dexutil.py — the part that could not be skipped

find_refs.py's dex path depends on decode()'s instruction boundaries, so those were measured instead of assumed. They were wrong: the opcode table was shifted from 0x16 to 0x2C with nine widths wrong (F9), and 65 of 50,791 method bodies on a real dex did not decode to their declared boundary.

Fixing find_refs while leaving that in place would have produced the same silent false zero the defect was reported for, one layer down. So names and widths were regenerated from the format specification's table, width became a lookup (OP_UNITS) rather than a chain of range tests, and the goto family was corrected in branch_target() and in dex_find_insn.py's kind map.

Verification

  • [scanned]/[total refs] from a .dex and from the equivalent smali tree agree with each other and with the count written into the fixture by construction (3 / 2 / 2).
  • 50,791 of 50,791 method bodies decode to their declared boundary (65 did not before), and 0 operand indices fall outside their table (32 did before).
  • androguard 4.1.4, a decoder sharing no code with this project, produces identical per-instruction width sequences for all 50,791 bodies.
  • Real target: Ljava/lang/String;->length → 356 references in 2.3 s; a five-dex directory → 9,472 across 2 files; a typo'd path → exit 2.
  • The four repo gates still pass: check_repo.py 0 problems, check_refs.py 0 dangling, build_scripts.py 0 findings, npx skills add … --list lists the skill.

Why the fixture is in the tree

docs/tool-verification/fixtures/make_fixture_dex.py is committed because it is the evidence for the counts above. Without it, "3 references" is a claim a later reader cannot check — which is exactly the evidentiary gap F5 describes, and the repository's rule that nothing ships unrun applies to claims as much as to code. It is dependency-free (stdlib only) so it reproduces on a machine with no Android toolchain, which is the machine the defect was found on. It carries no target data: the dex is synthesised from constants in the file.

Maintenance pass: the path audit's signal, three path families, and a corpus note

An external review found the repository in good shape on evidence and honesty but raised three concrete defects. All three are fixed here; the fourth item is a measurement added so the next pass can see what this one could not.

1. build_scripts.py reported 37 findings, most of them noise

The audit matched any X:\... literal, so C:\Program Files\..., C:\Python314\... and literal placeholders like <user> all counted as "machine-specific leftovers". A gate whose output is mostly noise stops being read, which is the same failure scan_leaks.py names when it refuses to exempt the RFC 5737 documentation ranges.

Added two explicit, auditable exemption families rather than a looser regex:

  • GENERIC_PATH_PREFIXES — install locations that exist on every host of that platform (Program Files, Python*, MinGW, /usr/, /opt/, ...).
  • _leaks_nothing() — also exempts an already-redacted path, i.e. one carrying a placeholder or an ellipsis, because that mark means a normalisation pass already ran.

One trap had to be handled explicitly. BARE_ABS stops at whitespace, so a real C:\Program Files\... arrives as the truncated C:\Program; a one-directional startswith misses the exemption. The comparison is therefore bidirectional, gated by a minimum length so a short drive prefix cannot become a blanket pass. The same function needed a second correction: with a lookahead of only [a-z0-9], the optional \\? backtracks to the empty string, the next character is the separator, it passes, and a real personal path is swallowed — the lookahead must exclude the separator too.

2. Three absolute paths left on the published surface

EXTENSION-desensitization.md, EXTENSION-extraction-shell-bench.md and EXTENSION-vmp-diff.md quoted a workbench root, a tool jar and an SDK location as absolute paths. docs/tool-verification/ already states the rule (§Workbench paths are an operation record, not a pointer): the record may say a run happened at a tools/... path, written relatively. The three files were made to match the rule they were already under; the tool-jar and SDK cases were rephrased rather than placeholder-ised, so no reader has to learn a new token.

3. check_budget.py could not see corpus growth

The gate budgets the always-loaded part and was silently blind to the other half of the problem: a new reference costs exactly one index line, so the corpus can double while the narrative count stays green. Two note-level thresholds now report it. Notes, not failures — a large corpus is a choice; a growth nobody measured is the defect.

A cross-tool inconsistency this pass ran into

build_scripts.py now exempts any <...> placeholder; scan_leaks.py recognises a fixed token list (<user>, <name>, <path>, ...). An invented placeholder in a source comment — <someone> — therefore passed the first and was read by the second as the very personal name its user_path_windows rule exists to catch, turning check_repo.py red. That is by design rather than a bug (a strict list is what stops <realname> hiding a real one), but the two tools disagree about what "already redacted" means, and the disagreement is invisible until someone writes a new placeholder. The fix here was to rephrase the comment; a future pass may want a shared token list.

Verification

  • build_scripts.py 37 → 0 findings on a clean clone, exit 0 (was exit 2). The generic-install hits (C:\MinGW\bin\gcc.exe, C:\Python314\..., C:\Program) no longer report; the real ones (E:\apk-reverse\..., E:\agb_apktool.jar) did, and were fixed in the documents, not by widening the list.
  • A purpose-written case table pins both directions — 18 cases, 0 failures: generic and already-redacted paths are exempt, while a real workbench path, a real personal name after C:\Users\, a real POSIX home and a real project path still report. Two defects in the first implementation were found by that table, not by the audit run.
  • All four gates pass: check_repo.py 0 problem, check_refs.py 0 dangling / 0 warning, check_budget.py 0 failure / 0 warning / 3 notes, build_scripts.py 0 findings.
  • check_budget.py now reports the corpus explicitly: 47 references + 55 scripts = 102 files, 31,423 lines, past the 26,000-line note threshold — the figure this pass could not see before.