chore(agents): 添加 Android 逆向工程 skill

包含 APK 反编译、API 调用提取、调用链分析、Kotlin 名称恢复等参考文档,
以及 jadx/fernflower 相关脚本与第三方域名过滤列表。

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
voidandClaude Sonnet 4.6 committed 2026-11-08 21:15:24 +08:00
1 parent 252b7088cf
commit c29e425996
19 files changed
+4392

No files matched your search

@@ -0,0 +1,165 @@
# check-deps.ps1 — Verify dependencies and report what's missing
# Output includes machine-readable INSTALL_REQUIRED/INSTALL_OPTIONAL lines.
$ErrorActionPreference = 'Stop'
# Refresh PATH from user environment so we pick up tools installed in the same session
$userPath = [Environment]::GetEnvironmentVariable('PATH', 'User')
if ($userPath) {
foreach ($dir in $userPath -split ';') {
if ($dir -and $env:PATH -notlike "*$dir*") {
$env:PATH = "$dir;$env:PATH"
}
}
}
$REQUIRED_JAVA_MAJOR = 17
$errors = 0
$missingRequired = @()
$missingOptional = @()
Write-Host "=== Android Reverse Engineering: Dependency Check ==="
Write-Host ""
# --- Java ---
$javaOk = $false
$javaBin = Get-Command java -ErrorAction SilentlyContinue
if ($javaBin) {
$javaVersionOutput = & java -version 2>&1 | Select-Object -First 1
$javaVersionStr = "$javaVersionOutput"
if ($javaVersionStr -match '"(\d+)') {
$javaVersion = [int]$Matches[1]
if ($javaVersion -eq 1 -and $javaVersionStr -match '"1\.(\d+)') {
$javaVersion = [int]$Matches[1]
}
if ($javaVersion -ge $REQUIRED_JAVA_MAJOR) {
Write-Host "[OK] Java $javaVersion detected"
$javaOk = $true
} else {
Write-Host "[WARN] Java detected but version $javaVersion is below $REQUIRED_JAVA_MAJOR"
$errors++
$missingRequired += "java"
}
} else {
Write-Host "[WARN] Java detected but could not parse version from: $javaVersionStr"
$errors++
$missingRequired += "java"
}
} else {
Write-Host "[MISSING] Java is not installed or not in PATH"
$errors++
$missingRequired += "java"
}
# --- jadx ---
$jadxBin = Get-Command jadx -ErrorAction SilentlyContinue
if (-not $jadxBin) {
# Check common Windows install locations
$jadxCandidates = @(
"$env:USERPROFILE\.local\share\jadx\bin\jadx.bat",
"$env:USERPROFILE\jadx\bin\jadx.bat",
"$env:LOCALAPPDATA\jadx\bin\jadx.bat"
)
foreach ($c in $jadxCandidates) {
if (Test-Path $c) {
$jadxBin = $c
break
}
}
}
if ($jadxBin) {
try {
$jadxCmd = if ($jadxBin -is [string]) { $jadxBin } else { 'jadx' }
$jadxVersion = & $jadxCmd --version 2>$null
Write-Host "[OK] jadx $jadxVersion detected"
} catch {
Write-Host "[OK] jadx detected"
}
} else {
Write-Host "[MISSING] jadx is not installed or not in PATH"
$errors++
$missingRequired += "jadx"
}
# --- Fernflower / Vineflower ---
$ffFound = $false
$vineflowerBin = Get-Command vineflower -ErrorAction SilentlyContinue
$fernflowerBin = Get-Command fernflower -ErrorAction SilentlyContinue
if ($vineflowerBin) {
Write-Host "[OK] vineflower CLI detected"
$ffFound = $true
} elseif ($fernflowerBin) {
Write-Host "[OK] fernflower CLI detected"
$ffFound = $true
} else {
$ffCandidates = @(
$env:FERNFLOWER_JAR_PATH,
"$env:USERPROFILE\.local\share\vineflower\vineflower.jar",
"$env:USERPROFILE\fernflower\build\libs\fernflower.jar",
"$env:USERPROFILE\vineflower\build\libs\vineflower.jar",
"$env:USERPROFILE\fernflower\fernflower.jar",
"$env:USERPROFILE\vineflower\vineflower.jar"
)
foreach ($candidate in $ffCandidates) {
if ($candidate -and (Test-Path $candidate -ErrorAction SilentlyContinue)) {
Write-Host "[OK] Fernflower/Vineflower JAR found: $candidate"
$ffFound = $true
break
}
}
}
if (-not $ffFound) {
Write-Host "[MISSING] Fernflower/Vineflower not found (optional - better output on complex Java code)"
$missingOptional += "vineflower"
}
# --- dex2jar ---
$d2jBin = Get-Command d2j-dex2jar -ErrorAction SilentlyContinue
if (-not $d2jBin) {
$d2jBin = Get-Command d2j-dex2jar.bat -ErrorAction SilentlyContinue
}
if ($d2jBin) {
Write-Host "[OK] dex2jar detected"
} else {
Write-Host "[MISSING] dex2jar not found (optional - needed to use Fernflower on APK/DEX files)"
$missingOptional += "dex2jar"
}
# --- Optional: apktool ---
if (Get-Command apktool -ErrorAction SilentlyContinue) {
Write-Host "[OK] apktool detected (optional)"
} else {
Write-Host "[MISSING] apktool not found (optional - useful for resource decoding)"
$missingOptional += "apktool"
}
# --- Optional: adb ---
if (Get-Command adb -ErrorAction SilentlyContinue) {
Write-Host "[OK] adb detected (optional)"
} else {
Write-Host "[MISSING] adb not found (optional - useful for pulling APKs from devices)"
$missingOptional += "adb"
}
# --- Machine-readable summary ---
Write-Host ""
foreach ($dep in $missingRequired) {
Write-Host "INSTALL_REQUIRED:$dep"
}
foreach ($dep in $missingOptional) {
Write-Host "INSTALL_OPTIONAL:$dep"
}
Write-Host ""
if ($errors -gt 0) {
Write-Host "*** $($missingRequired.Count) required dependency/ies missing. ***"
Write-Host "Run install-dep.ps1 <name> to install, or see references/setup-guide.md."
exit 1
} else {
if ($missingOptional.Count -gt 0) {
Write-Host "Required dependencies OK. $($missingOptional.Count) optional dependency/ies missing."
Write-Host "Run install-dep.ps1 <name> to install optional tools."
} else {
Write-Host "All dependencies are installed. Ready to decompile."
}
exit 0
}
@@ -0,0 +1,129 @@
#!/usr/bin/env bash
# check-deps.sh — Verify dependencies and report what's missing
# Output includes machine-readable INSTALL:<dep> lines for each missing dependency.
# The install-dep.sh script can install each one.
set -euo pipefail
REQUIRED_JAVA_MAJOR=17
errors=0
missing_required=()
missing_optional=()
echo "=== Android Reverse Engineering: Dependency Check ==="
echo
# --- Java ---
java_ok=false
if command -v java &>/dev/null; then
java_version_output=$(java -version 2>&1 | head -1)
java_version=$(echo "$java_version_output" | sed -n 's/.*"\([0-9]*\)\..*/\1/p')
if [[ -z "$java_version" ]]; then
java_version=$(echo "$java_version_output" | grep -oP '\d+' | head -1)
fi
if [[ "$java_version" == "1" ]]; then
java_version=$(echo "$java_version_output" | sed -n 's/.*"1\.\([0-9]*\)\..*/\1/p')
fi
if [[ -n "$java_version" ]] && (( java_version >= REQUIRED_JAVA_MAJOR )); then
echo "[OK] Java $java_version detected"
java_ok=true
else
echo "[WARN] Java detected but version $java_version is below $REQUIRED_JAVA_MAJOR"
errors=$((errors + 1))
missing_required+=("java")
fi
else
echo "[MISSING] Java is not installed or not in PATH"
errors=$((errors + 1))
missing_required+=("java")
fi
# --- jadx ---
if command -v jadx &>/dev/null; then
jadx_version=$(jadx --version 2>/dev/null || echo "unknown")
echo "[OK] jadx $jadx_version detected"
else
echo "[MISSING] jadx is not installed or not in PATH"
errors=$((errors + 1))
missing_required+=("jadx")
fi
# --- Fernflower / Vineflower ---
ff_found=false
if command -v vineflower &>/dev/null; then
echo "[OK] vineflower CLI detected"
ff_found=true
elif command -v fernflower &>/dev/null; then
echo "[OK] fernflower CLI detected"
ff_found=true
else
for candidate in \
"${FERNFLOWER_JAR_PATH:-}" \
"$HOME/.local/share/vineflower/vineflower.jar" \
"$HOME/fernflower/build/libs/fernflower.jar" \
"$HOME/vineflower/build/libs/vineflower.jar" \
"$HOME/fernflower/fernflower.jar" \
"$HOME/vineflower/vineflower.jar"; do
if [[ -n "$candidate" ]] && [[ -f "$candidate" ]]; then
echo "[OK] Fernflower/Vineflower JAR found: $candidate"
ff_found=true
break
fi
done
fi
if [[ "$ff_found" == false ]]; then
echo "[MISSING] Fernflower/Vineflower not found (optional — better output on complex Java code)"
missing_optional+=("vineflower")
fi
# --- dex2jar ---
if command -v d2j-dex2jar &>/dev/null || command -v d2j-dex2jar.sh &>/dev/null; then
echo "[OK] dex2jar detected"
else
echo "[MISSING] dex2jar not found (optional — needed to use Fernflower on APK/DEX files)"
missing_optional+=("dex2jar")
fi
# --- Optional: apktool ---
if command -v apktool &>/dev/null; then
echo "[OK] apktool detected (optional)"
else
echo "[MISSING] apktool not found (optional — useful for resource decoding)"
missing_optional+=("apktool")
fi
# --- Optional: adb ---
if command -v adb &>/dev/null; then
echo "[OK] adb detected (optional)"
else
echo "[MISSING] adb not found (optional — useful for pulling APKs from devices)"
missing_optional+=("adb")
fi
# --- Machine-readable summary ---
echo
if [[ ${#missing_required[@]} -gt 0 ]]; then
for dep in "${missing_required[@]}"; do
echo "INSTALL_REQUIRED:$dep"
done
fi
if [[ ${#missing_optional[@]} -gt 0 ]]; then
for dep in "${missing_optional[@]}"; do
echo "INSTALL_OPTIONAL:$dep"
done
fi
echo
if (( errors > 0 )); then
echo "*** ${#missing_required[@]} required dependency/ies missing. ***"
echo "Run install-dep.sh <name> to install, or see references/setup-guide.md."
exit 1
else
if [[ ${#missing_optional[@]} -gt 0 ]]; then
echo "Required dependencies OK. ${#missing_optional[@]} optional dependency/ies missing."
echo "Run install-dep.sh <name> to install optional tools."
else
echo "All dependencies are installed. Ready to decompile."
fi
exit 0
fi
@@ -0,0 +1,400 @@
# decompile.ps1 — Decompile APK/XAPK/JAR/AAR using jadx, fernflower, or both
param(
[Alias('o')]
[string]$Output,
[switch]$Deobf,
[switch]$NoRes,
[string]$Engine = 'jadx',
[Parameter(Position=0)]
[string]$InputFile,
[Alias('h')]
[switch]$Help
)
$ErrorActionPreference = 'Stop'
# Refresh PATH from user environment so we pick up tools installed in the same session
$userPath = [Environment]::GetEnvironmentVariable('PATH', 'User')
if ($userPath) {
foreach ($dir in $userPath -split ';') {
if ($dir -and $env:PATH -notlike "*$dir*") {
$env:PATH = "$dir;$env:PATH"
}
}
}
function Show-Usage {
Write-Host @"
Usage: decompile.ps1 [OPTIONS] <file>
Decompile an Android APK, XAPK, JAR, or AAR file.
Arguments:
<file> Path to the .apk, .xapk, .jar, or .aar file
Options:
-Output DIR Output directory (default: <filename>-decompiled)
-Deobf Enable deobfuscation of names
-NoRes Skip resource decoding (faster, code-only)
-Engine ENGINE Decompiler engine: jadx, fernflower, or both (default: jadx)
-Help Show this help message
Engines:
jadx Use jadx (default). Handles APK/JAR/AAR natively, decodes resources.
fernflower Use Fernflower/Vineflower. Better on complex Java, lambdas, generics.
For APK files, requires dex2jar as intermediate step.
both Run both decompilers side by side for comparison.
jadx output -> <output>/jadx/
fernflower -> <output>/fernflower/
Environment:
FERNFLOWER_JAR_PATH Path to fernflower.jar or vineflower.jar
Examples:
.\decompile.ps1 app-release.apk
.\decompile.ps1 app-bundle.xapk
.\decompile.ps1 -Engine both -Deobf app-release.apk
.\decompile.ps1 -Engine fernflower library.jar
"@
exit 0
}
if ($Help) { Show-Usage }
# --- Validate input ---
if (-not $InputFile) {
Write-Host "Error: No input file specified." -ForegroundColor Red
Show-Usage
}
if (-not (Test-Path $InputFile)) {
Write-Host "Error: File not found: $InputFile" -ForegroundColor Red
exit 1
}
$extLower = [IO.Path]::GetExtension($InputFile).TrimStart('.').ToLower()
if ($extLower -notin @('apk', 'xapk', 'jar', 'aar')) {
Write-Host "Error: Unsupported file type '.$extLower'. Expected .apk, .xapk, .jar, or .aar" -ForegroundColor Red
exit 1
}
if ($Engine -notin @('jadx', 'fernflower', 'both')) {
Write-Host "Error: Unknown engine '$Engine'. Use jadx, fernflower, or both." -ForegroundColor Red
exit 1
}
$baseName = [IO.Path]::GetFileNameWithoutExtension($InputFile)
$inputFileAbs = (Resolve-Path $InputFile).Path
if (-not $Output) {
$Output = "$baseName-decompiled"
}
# --- XAPK handling ---
$xapkExtractedDir = $null
$xapkApkFiles = @()
if ($extLower -eq 'xapk') {
$xapkExtractedDir = Join-Path $env:TEMP "xapk-extract-$(Get-Random)"
Write-Host "=== Extracting XAPK archive ==="
New-Item -ItemType Directory -Path $xapkExtractedDir -Force | Out-Null
Expand-Archive -Path $inputFileAbs -DestinationPath $xapkExtractedDir -Force
# Show manifest.json if present
$manifestPath = Join-Path $xapkExtractedDir 'manifest.json'
if (Test-Path $manifestPath) {
Write-Host "XAPK manifest found:"
Get-Content $manifestPath
Write-Host ""
}
# Find all APK files inside
$xapkApkFiles = Get-ChildItem -Path $xapkExtractedDir -Recurse -Filter '*.apk' | Sort-Object Name
if ($xapkApkFiles.Count -eq 0) {
Write-Host "Error: No APK files found inside XAPK archive." -ForegroundColor Red
Remove-Item $xapkExtractedDir -Recurse -Force
exit 1
}
Write-Host "Found $($xapkApkFiles.Count) APK(s) inside XAPK:"
foreach ($f in $xapkApkFiles) {
Write-Host " - $($f.Name)"
}
Write-Host ""
}
# --- Locate fernflower JAR ---
function Find-FernflowerJar {
if ($env:FERNFLOWER_JAR_PATH -and (Test-Path $env:FERNFLOWER_JAR_PATH -ErrorAction SilentlyContinue)) {
return $env:FERNFLOWER_JAR_PATH
}
$candidates = @(
"$env:USERPROFILE\.local\share\vineflower\vineflower.jar",
"$env:USERPROFILE\fernflower\build\libs\fernflower.jar",
"$env:USERPROFILE\vineflower\build\libs\vineflower.jar",
"$env:USERPROFILE\fernflower\fernflower.jar",
"$env:USERPROFILE\vineflower\vineflower.jar"
)
foreach ($c in $candidates) {
if (Test-Path $c -ErrorAction SilentlyContinue) { return $c }
}
return $null
}
# --- Locate dex2jar ---
function Find-Dex2Jar {
$cmd = Get-Command d2j-dex2jar -ErrorAction SilentlyContinue
if ($cmd) { return $cmd.Source }
$cmd = Get-Command d2j-dex2jar.bat -ErrorAction SilentlyContinue
if ($cmd) { return $cmd.Source }
return $null
}
# --- jadx decompilation ---
function Invoke-Jadx {
param([string]$OutDir, [string]$FileAbs, [string]$FileExt)
if (-not (Get-Command jadx -ErrorAction SilentlyContinue)) {
Write-Host "Error: jadx is not installed or not in PATH." -ForegroundColor Red
return $false
}
$jadxArgs = @('-d', $OutDir)
if ($Deobf) { $jadxArgs += '--deobf' }
if ($NoRes) { $jadxArgs += '--no-res' }
$jadxArgs += '--show-bad-code'
$jadxArgs += $FileAbs
Write-Host "Running: jadx $($jadxArgs -join ' ')"
& jadx @jadxArgs
$sourcesDir = Join-Path $OutDir 'sources'
if (Test-Path $sourcesDir) {
$count = (Get-ChildItem -Path $sourcesDir -Recurse -Filter '*.java').Count
Write-Host "jadx output: $sourcesDir\"
Write-Host "Java files decompiled by jadx: $count"
}
return $true
}
# --- Fernflower decompilation ---
function Invoke-Fernflower {
param([string]$OutDir, [string]$FileAbs, [string]$FileExt)
$ffJar = Find-FernflowerJar
if (-not $ffJar) {
Write-Host "Error: Fernflower/Vineflower JAR not found." -ForegroundColor Red
Write-Host "Set FERNFLOWER_JAR_PATH or see references/setup-guide.md"
return $false
}
New-Item -ItemType Directory -Path $OutDir -Force | Out-Null
$jarToDecompile = $FileAbs
$convertedJar = $null
# For APK/AAR, we need dex2jar first
if ($FileExt -in @('apk', 'aar')) {
$d2j = Find-Dex2Jar
if (-not $d2j) {
Write-Host "Error: dex2jar is required to use Fernflower on .$FileExt files." -ForegroundColor Red
Write-Host "Install dex2jar - see references/setup-guide.md"
return $false
}
Write-Host "Converting $FileExt to JAR with dex2jar..."
$convertedJar = Join-Path $OutDir "$baseName-dex2jar.jar"
& $d2j -f -o $convertedJar $FileAbs 2>&1 | Write-Host
if (-not (Test-Path $convertedJar)) {
Write-Host "Error: dex2jar conversion failed." -ForegroundColor Red
return $false
}
$jarToDecompile = $convertedJar
}
# Build fernflower args
$ffArgs = @('-dgs=1', '-mpm=60')
if ($Deobf) { $ffArgs += '-ren=1' }
$ffArgs += $jarToDecompile
$ffArgs += $OutDir
Write-Host "Running: java -jar $ffJar $($ffArgs -join ' ')"
& java -jar $ffJar @ffArgs
# Fernflower outputs a JAR containing .java files — extract it
$resultJar = Join-Path $OutDir ([IO.Path]::GetFileName($jarToDecompile))
if (Test-Path $resultJar) {
$sourcesDir = Join-Path $OutDir 'sources'
New-Item -ItemType Directory -Path $sourcesDir -Force | Out-Null
Expand-Archive -Path $resultJar -DestinationPath $sourcesDir -Force
Remove-Item $resultJar -Force
$count = (Get-ChildItem -Path $sourcesDir -Recurse -Filter '*.java').Count
Write-Host "Fernflower output: $sourcesDir\"
Write-Host "Java files decompiled by Fernflower: $count"
}
# Clean up intermediate dex2jar output
if ($convertedJar -and (Test-Path $convertedJar -ErrorAction SilentlyContinue)) {
Remove-Item $convertedJar -Force
}
return $true
}
# --- Summary helper ---
function Show-Structure {
param([string]$SrcDir, [string]$Label)
if (Test-Path $SrcDir) {
Write-Host ""
Write-Host "Top-level packages ($Label):"
Get-ChildItem -Path $SrcDir -Directory -Recurse -Depth 2 |
Select-Object -First 20 |
ForEach-Object { $_.FullName.Replace("$SrcDir\", '') } |
Sort-Object
}
}
# --- Decompile a single file ---
function Invoke-DecompileSingle {
param([string]$FileAbs, [string]$OutDir, [string]$Label)
$fileExt = [IO.Path]::GetExtension($FileAbs).TrimStart('.').ToLower()
if ($Label) {
Write-Host "=== Decompiling $Label (engine: $Engine) ==="
}
switch ($Engine) {
'jadx' {
Invoke-Jadx -OutDir $OutDir -FileAbs $FileAbs -FileExt $fileExt
Show-Structure (Join-Path $OutDir 'sources') 'jadx'
}
'fernflower' {
Invoke-Fernflower -OutDir $OutDir -FileAbs $FileAbs -FileExt $fileExt
Show-Structure (Join-Path $OutDir 'sources') 'fernflower'
}
'both' {
Write-Host "--- Pass 1: jadx ---"
Invoke-Jadx -OutDir (Join-Path $OutDir 'jadx') -FileAbs $FileAbs -FileExt $fileExt
Write-Host ""
Write-Host "--- Pass 2: Fernflower ---"
Invoke-Fernflower -OutDir (Join-Path $OutDir 'fernflower') -FileAbs $FileAbs -FileExt $fileExt
Show-Structure (Join-Path $OutDir 'jadx\sources') 'jadx'
Show-Structure (Join-Path $OutDir 'fernflower\sources') 'fernflower'
Write-Host ""
Write-Host "=== Comparison ==="
$jadxCount = 0; $ffCount = 0
$jadxSources = Join-Path $OutDir 'jadx\sources'
$ffSources = Join-Path $OutDir 'fernflower\sources'
if (Test-Path $jadxSources) {
$jadxCount = (Get-ChildItem -Path $jadxSources -Recurse -Filter '*.java').Count
}
if (Test-Path $ffSources) {
$ffCount = (Get-ChildItem -Path $ffSources -Recurse -Filter '*.java').Count
}
Write-Host "jadx: $jadxCount Java files"
Write-Host "Fernflower: $ffCount Java files"
if (Test-Path $jadxSources) {
$jadxErrors = (Get-ChildItem -Path $jadxSources -Recurse -Filter '*.java' -File |
Select-String -Pattern 'JADX WARNING|JADX WARN|JADX ERROR|Code decompiled incorrectly' -SimpleMatch -ErrorAction SilentlyContinue |
Select-Object -ExpandProperty Path -Unique).Count
Write-Host "jadx files with warnings/errors: $jadxErrors"
}
Write-Host ""
Write-Host "Tip: compare specific classes between jadx/ and fernflower/ to pick the better output."
}
}
}
# --- Run ---
Write-Host "=== Decompiling $InputFile (engine: $Engine) ==="
Write-Host "Output directory: $Output"
Write-Host ""
if ($extLower -eq 'xapk') {
New-Item -ItemType Directory -Path $Output -Force | Out-Null
# Copy XAPK manifest for reference
$manifestSrc = Join-Path $xapkExtractedDir 'manifest.json'
if (Test-Path $manifestSrc) {
Copy-Item $manifestSrc (Join-Path $Output 'xapk-manifest.json')
}
# List OBB files
$obbFiles = Get-ChildItem -Path $xapkExtractedDir -Recurse -Filter '*.obb' -ErrorAction SilentlyContinue
if ($obbFiles) {
Write-Host "OBB files found (not decompiled, data-only):"
foreach ($obb in $obbFiles) {
$size = '{0:N1} MB' -f ($obb.Length / 1MB)
Write-Host " - $($obb.Name) ($size)"
}
Write-Host ""
}
foreach ($apkFile in $xapkApkFiles) {
$apkName = [IO.Path]::GetFileNameWithoutExtension($apkFile.Name)
Write-Host ""
Write-Host "======================================================"
Invoke-DecompileSingle -FileAbs $apkFile.FullName -OutDir (Join-Path $Output $apkName) -Label "$($apkFile.Name)"
}
# Cleanup extracted XAPK
Remove-Item $xapkExtractedDir -Recurse -Force
Write-Host ""
Write-Host "=== XAPK decompilation complete ==="
Write-Host "Subdirectories in ${Output}\"
Get-ChildItem -Path $Output -Directory | ForEach-Object { Write-Host $_.Name }
} else {
Invoke-DecompileSingle -FileAbs $inputFileAbs -OutDir $Output -Label ''
# --- Split/bundled APK detection ---
# Some APKs are bundles: the outer APK contains
# base.apk + split_config.*.apk inside the resources directory. jadx will
# decompile the thin outer wrapper and produce very few Java files.
# Detect this and automatically decompile the inner base.apk.
$sourcesDir = Join-Path $Output 'sources'
$resourcesDir = Join-Path $Output 'resources'
if ((Test-Path $sourcesDir) -and (Test-Path $resourcesDir)) {
$javaCount = (Get-ChildItem -Path $sourcesDir -Recurse -Filter '*.java' -File -ErrorAction SilentlyContinue).Count
$innerApks = Get-ChildItem -Path $resourcesDir -Filter '*.apk' -File -ErrorAction SilentlyContinue
$baseApk = $innerApks | Where-Object { $_.Name -eq 'base.apk' }
if ($javaCount -le 10 -and $baseApk) {
Write-Host ""
Write-Host "=== Split/bundled APK detected ==="
Write-Host "Outer APK produced only $javaCount Java file(s) but contains $($innerApks.Count) inner APK(s):"
foreach ($inner in $innerApks) {
Write-Host " - $($inner.Name)"
}
Write-Host ""
Write-Host "Decompiling base.apk (contains the actual app code)..."
$baseOutput = Join-Path $Output 'base'
Invoke-DecompileSingle -FileAbs $baseApk.FullName -OutDir $baseOutput -Label 'base.apk'
# Decompile any split APKs that aren't just config splits
$splitApks = $innerApks | Where-Object { $_.Name -ne 'base.apk' -and $_.Name -notmatch 'split_config\.' }
foreach ($split in $splitApks) {
$splitName = [IO.Path]::GetFileNameWithoutExtension($split.Name)
Write-Host ""
Write-Host "Decompiling $($split.Name)..."
Invoke-DecompileSingle -FileAbs $split.FullName -OutDir (Join-Path $Output $splitName) -Label $split.Name
}
if ($innerApks | Where-Object { $_.Name -match 'split_config\.' }) {
Write-Host ""
Write-Host "Skipped config splits (resource/ABI only):"
$innerApks | Where-Object { $_.Name -match 'split_config\.' } | ForEach-Object { Write-Host " - $($_.Name)" }
}
Write-Host ""
Write-Host "NOTE: The main decompiled source is in: $(Join-Path $Output 'base\sources')"
}
}
Write-Host ""
Write-Host "=== Decompilation complete ==="
}
@@ -0,0 +1,578 @@
#!/usr/bin/env bash
# decompile.sh — Decompile APK/JAR/AAR using jadx, fernflower, or both
set -euo pipefail
usage() {
cat <<EOF
Usage: decompile.sh [OPTIONS] <file>
Decompile an Android APK, XAPK, JAR, or AAR file.
Arguments:
<file> Path to the .apk, .xapk, .jar, or .aar file
Options:
-o, --output DIR Output directory (default: <filename>-decompiled)
--deobf Enable deobfuscation of names
--no-res Skip resource decoding (faster, code-only)
--engine ENGINE Decompiler engine: jadx, fernflower, or both (default: jadx)
-h, --help Show this help message
Engines:
jadx Use jadx (default). Handles APK/JAR/AAR natively, decodes resources.
fernflower Use Fernflower/Vineflower. Better on complex Java, lambdas, generics.
For APK files, requires dex2jar as intermediate step.
both Run both decompilers side by side for comparison.
jadx output → <output>/jadx/
fernflower → <output>/fernflower/
Environment:
FERNFLOWER_JAR_PATH Path to fernflower.jar or vineflower.jar
Examples:
decompile.sh app-release.apk
decompile.sh app-bundle.xapk
decompile.sh --engine both --deobf app-release.apk
decompile.sh --engine fernflower library.jar
EOF
exit 0
}
# --- Parse arguments ---
OUTPUT_DIR=""
DEOBF=false
NO_RES=false
ENGINE="jadx"
INPUT_FILE=""
while [[ $# -gt 0 ]]; do
case "$1" in
-o|--output) OUTPUT_DIR="$2"; shift 2 ;;
--deobf) DEOBF=true; shift ;;
--no-res) NO_RES=true; shift ;;
--engine) ENGINE="$2"; shift 2 ;;
-h|--help) usage ;;
-*) echo "Error: Unknown option $1" >&2; usage ;;
*) INPUT_FILE="$1"; shift ;;
esac
done
# --- Validate input ---
if [[ -z "$INPUT_FILE" ]]; then
echo "Error: No input file specified." >&2
usage
fi
if [[ ! -f "$INPUT_FILE" ]]; then
echo "Error: File not found: $INPUT_FILE" >&2
exit 1
fi
ext="${INPUT_FILE##*.}"
ext_lower=$(echo "$ext" | tr '[:upper:]' '[:lower:]')
case "$ext_lower" in
apk|xapk|jar|aar) ;;
*)
echo "Error: Unsupported file type '.$ext'. Expected .apk, .xapk, .jar, or .aar" >&2
exit 1
;;
esac
case "$ENGINE" in
jadx|fernflower|both) ;;
*)
echo "Error: Unknown engine '$ENGINE'. Use jadx, fernflower, or both." >&2
exit 1
;;
esac
BASENAME=$(basename "$INPUT_FILE" ".$ext_lower")
INPUT_FILE_ABS=$(realpath "$INPUT_FILE")
if [[ -z "$OUTPUT_DIR" ]]; then
OUTPUT_DIR="${BASENAME}-decompiled"
fi
# --- XAPK handling ---
# XAPK is a ZIP containing one or more APKs, optional OBB files, and a manifest.json.
# We extract it, find all APKs inside, and decompile each one.
XAPK_EXTRACTED_DIR=""
XAPK_APK_FILES=()
if [[ "$ext_lower" == "xapk" ]]; then
XAPK_EXTRACTED_DIR=$(mktemp -d "${TMPDIR:-/tmp}/xapk-extract-XXXXXX")
echo "=== Extracting XAPK archive ==="
unzip -qo "$INPUT_FILE_ABS" -d "$XAPK_EXTRACTED_DIR"
# Show manifest.json if present
if [[ -f "$XAPK_EXTRACTED_DIR/manifest.json" ]]; then
echo "XAPK manifest found:"
cat "$XAPK_EXTRACTED_DIR/manifest.json"
echo
fi
# Find all APK files inside
while IFS= read -r -d '' apk_file; do
XAPK_APK_FILES+=("$apk_file")
done < <(find "$XAPK_EXTRACTED_DIR" -name "*.apk" -print0 | sort -z)
if [[ ${#XAPK_APK_FILES[@]} -eq 0 ]]; then
echo "Error: No APK files found inside XAPK archive." >&2
rm -rf "$XAPK_EXTRACTED_DIR"
exit 1
fi
echo "Found ${#XAPK_APK_FILES[@]} APK(s) inside XAPK:"
for f in "${XAPK_APK_FILES[@]}"; do
echo " - $(basename "$f")"
done
echo
fi
# --- Locate fernflower JAR ---
find_fernflower_jar() {
if [[ -n "${FERNFLOWER_JAR_PATH:-}" ]] && [[ -f "$FERNFLOWER_JAR_PATH" ]]; then
echo "$FERNFLOWER_JAR_PATH"
return
fi
# Check common locations
for candidate in \
"$HOME/fernflower/build/libs/fernflower.jar" \
"$HOME/vineflower/build/libs/vineflower.jar" \
"$HOME/fernflower/fernflower.jar" \
"$HOME/vineflower/vineflower.jar"; do
if [[ -f "$candidate" ]]; then
echo "$candidate"
return
fi
done
return 1
}
# --- Locate dex2jar ---
find_dex2jar() {
if command -v d2j-dex2jar &>/dev/null; then
echo "d2j-dex2jar"
elif command -v d2j-dex2jar.sh &>/dev/null; then
echo "d2j-dex2jar.sh"
else
return 1
fi
}
# --- jadx decompilation ---
run_jadx() {
local out_dir="$1"
local jadx_status=0
local count=0
if ! command -v jadx &>/dev/null; then
echo "Error: jadx is not installed or not in PATH." >&2
return 1
fi
local args=()
args+=("-d" "$out_dir")
[[ "$DEOBF" == true ]] && args+=("--deobf")
[[ "$NO_RES" == true ]] && args+=("--no-res")
args+=("--show-bad-code")
args+=("$INPUT_FILE_ABS")
echo "Running: jadx ${args[*]}"
if jadx "${args[@]}"; then
jadx_status=0
else
jadx_status=$?
fi
echo "jadx output: $out_dir/sources/"
if [[ -d "$out_dir/sources" ]]; then
count=$(find "$out_dir/sources" -name "*.java" | wc -l)
echo "Java files decompiled by jadx: $count"
fi
if [[ $jadx_status -eq 0 ]]; then
return 0
fi
if [[ $count -gt 0 ]]; then
echo "Warning: jadx exited with status $jadx_status after writing $count Java files; treating this as partial success." >&2
return 2
fi
echo "Error: jadx failed with status $jadx_status and produced no Java output." >&2
return 1
}
# --- Fernflower decompilation ---
run_fernflower() {
local out_dir="$1"
local jar_to_decompile=""
local converted_jar=""
local intermediate_dir="$out_dir/intermediate"
local ff_status=0
local d2j_status=0
local count=0
local ff_timeout_seconds="${FERNFLOWER_TIMEOUT_SECONDS:-900}"
local ff_jar
if ! ff_jar=$(find_fernflower_jar); then
echo "Error: Fernflower/Vineflower JAR not found." >&2
echo "Set FERNFLOWER_JAR_PATH or see references/setup-guide.md" >&2
return 1
fi
mkdir -p "$out_dir"
# For APK/AAR, we need dex2jar first to convert DEX→JAR
if [[ "$ext_lower" == "apk" || "$ext_lower" == "aar" ]]; then
local d2j
if ! d2j=$(find_dex2jar); then
echo "Error: dex2jar is required to use Fernflower on .$ext_lower files." >&2
echo "Install dex2jar — see references/setup-guide.md" >&2
return 1
fi
echo "Converting $ext_lower to JAR with dex2jar..."
mkdir -p "$intermediate_dir"
converted_jar="$intermediate_dir/${BASENAME}-dex2jar.jar"
if "$d2j" -f -o "$converted_jar" "$INPUT_FILE_ABS" 2>&1; then
d2j_status=0
else
d2j_status=$?
fi
if [[ ! -f "$converted_jar" ]]; then
echo "Error: dex2jar conversion failed with status $d2j_status." >&2
return 1
fi
if [[ $d2j_status -ne 0 ]]; then
echo "Warning: dex2jar exited with status $d2j_status but produced $converted_jar; continuing." >&2
fi
jar_to_decompile="$converted_jar"
else
jar_to_decompile="$INPUT_FILE_ABS"
fi
# Build fernflower args
local ff_args=()
ff_args+=("-dgs=1") # decompile generic signatures
ff_args+=("-mpm=60") # 60s max per method to avoid hangs
if [[ "$DEOBF" == true ]]; then
ff_args+=("-ren=1") # rename obfuscated identifiers
fi
ff_args+=("$jar_to_decompile")
ff_args+=("$out_dir")
echo "Running: java -jar $ff_jar ${ff_args[*]}"
if command -v timeout &>/dev/null && [[ "$ff_timeout_seconds" =~ ^[0-9]+$ ]] && (( ff_timeout_seconds > 0 )); then
echo "Fernflower timeout: ${ff_timeout_seconds}s (override with FERNFLOWER_TIMEOUT_SECONDS)"
if timeout "${ff_timeout_seconds}s" java -jar "$ff_jar" "${ff_args[@]}"; then
ff_status=0
else
ff_status=$?
fi
elif java -jar "$ff_jar" "${ff_args[@]}"; then
ff_status=0
else
ff_status=$?
fi
# Fernflower outputs a JAR containing .java files — extract it
local result_jar="$out_dir/$(basename "$jar_to_decompile")"
if [[ -f "$result_jar" ]]; then
local sources_dir="$out_dir/sources"
mkdir -p "$sources_dir"
if unzip -qo "$result_jar" -d "$sources_dir"; then
rm -f "$result_jar"
else
echo "Warning: Fernflower result jar $result_jar could not be extracted; checking for direct folder output." >&2
fi
fi
local sources_dir="$out_dir/sources"
mkdir -p "$sources_dir"
count=$(find "$sources_dir" -name "*.java" | wc -l)
# Vineflower may write sources directly into the destination folder tree instead of a result jar.
if [[ $count -eq 0 ]]; then
local direct_count=0
direct_count=$(find "$out_dir" \
-path "$sources_dir" -prune -o \
-path "$intermediate_dir" -prune -o \
-name "*.java" -type f -print | wc -l)
if [[ $direct_count -gt 0 ]]; then
while IFS= read -r -d '' entry; do
mv "$entry" "$sources_dir"/
done < <(find "$out_dir" -mindepth 1 -maxdepth 1 \
! -name "sources" \
! -name "intermediate" \
-print0)
count=$(find "$sources_dir" -name "*.java" | wc -l)
fi
fi
# Clean up intermediate dex2jar output
if [[ $count -gt 0 ]]; then
echo "Fernflower output: $sources_dir/"
echo "Java files decompiled by Fernflower: $count"
if [[ -n "${converted_jar:-}" ]] && [[ -f "${converted_jar:-}" ]]; then
rm -f "$converted_jar"
fi
if [[ -d "$intermediate_dir" ]]; then
rmdir "$intermediate_dir" 2>/dev/null || true
fi
if [[ $ff_status -ne 0 ]]; then
echo "Warning: Fernflower/Vineflower exited with status $ff_status after writing $count Java files; treating this as partial success." >&2
return 2
fi
return 0
fi
if [[ -n "${converted_jar:-}" ]] && [[ -f "${converted_jar:-}" ]]; then
echo "Error: Fernflower/Vineflower produced no Java output. Intermediate dex2jar artifact kept at $converted_jar" >&2
else
echo "Error: Fernflower/Vineflower produced no Java output." >&2
fi
if [[ $ff_status -ne 0 ]]; then
if [[ $ff_status -eq 124 ]]; then
echo "Error: Fernflower/Vineflower exceeded timeout (${ff_timeout_seconds}s)." >&2
fi
echo "Error: Fernflower/Vineflower exited with status $ff_status." >&2
fi
return 1
}
# --- Summary helper ---
print_structure() {
local src_dir="$1"
local label="$2"
if [[ -d "$src_dir" ]]; then
local packages=()
echo
echo "Top-level packages ($label):"
while IFS= read -r pkg; do
[[ -n "$pkg" ]] && packages+=("$pkg")
done < <(find "$src_dir" -mindepth 1 -maxdepth 3 -type d -printf '%P\n' | sort)
local limit=${#packages[@]}
if (( limit > 20 )); then
limit=20
fi
if (( limit == 0 )); then
echo "(none)"
return
fi
local i=0
while (( i < limit )); do
echo "${packages[$i]}"
((i += 1))
done
fi
}
# --- Decompile a single file with the selected engine ---
decompile_single() {
local file_abs="$1"
local out_dir="$2"
local label="$3"
# Temporarily override INPUT_FILE_ABS for run_jadx/run_fernflower
local saved_input="$INPUT_FILE_ABS"
local saved_ext="$ext_lower"
INPUT_FILE_ABS="$file_abs"
ext_lower="${file_abs##*.}"
ext_lower=$(echo "$ext_lower" | tr '[:upper:]' '[:lower:]')
if [[ -n "$label" ]]; then
echo "=== Decompiling $label (engine: $ENGINE) ==="
fi
case "$ENGINE" in
jadx)
local jadx_status=0
if run_jadx "$out_dir"; then
jadx_status=0
else
jadx_status=$?
fi
print_structure "$out_dir/sources" "jadx"
if [[ $jadx_status -eq 1 ]]; then
return 1
fi
if [[ $jadx_status -eq 2 ]]; then
echo "jadx completed with warnings but produced usable output."
fi
;;
fernflower)
local ff_status=0
if run_fernflower "$out_dir"; then
ff_status=0
else
ff_status=$?
fi
print_structure "$out_dir/sources" "fernflower"
if [[ $ff_status -eq 1 ]]; then
return 1
fi
if [[ $ff_status -eq 2 ]]; then
echo "Fernflower completed with warnings but produced usable output."
fi
;;
both)
local jadx_status=0
local ff_status=0
echo "--- Pass 1: jadx ---"
if run_jadx "$out_dir/jadx"; then
jadx_status=0
else
jadx_status=$?
fi
if [[ $jadx_status -eq 1 ]]; then
return 1
fi
if [[ $jadx_status -eq 2 ]]; then
echo "Continuing to Fernflower because jadx produced usable output despite warnings."
fi
echo
echo "--- Pass 2: Fernflower ---"
if run_fernflower "$out_dir/fernflower"; then
ff_status=0
else
ff_status=$?
fi
if [[ $ff_status -eq 1 ]]; then
return 1
fi
if [[ $ff_status -eq 2 ]]; then
echo "Continuing with Fernflower output because it produced usable sources despite warnings."
fi
print_structure "$out_dir/jadx/sources" "jadx"
print_structure "$out_dir/fernflower/sources" "fernflower"
echo
echo "=== Comparison ==="
local jadx_count=0 ff_count=0
if [[ -d "$out_dir/jadx/sources" ]]; then
jadx_count=$(find "$out_dir/jadx/sources" -name "*.java" | wc -l)
fi
if [[ -d "$out_dir/fernflower/sources" ]]; then
ff_count=$(find "$out_dir/fernflower/sources" -name "*.java" | wc -l)
fi
echo "jadx: $jadx_count Java files"
echo "Fernflower: $ff_count Java files"
if [[ -d "$out_dir/jadx/sources" ]]; then
local jadx_error_files
local jadx_errors
jadx_error_files=$(grep -rl 'JADX WARNING\|JADX WARN\|JADX ERROR\|Code decompiled incorrectly' "$out_dir/jadx/sources" 2>/dev/null || true)
if [[ -n "$jadx_error_files" ]]; then
jadx_errors=$(printf '%s\n' "$jadx_error_files" | wc -l)
else
jadx_errors=0
fi
echo "jadx files with warnings/errors: $jadx_errors"
fi
echo
echo "Tip: compare specific classes between jadx/ and fernflower/ to pick the better output."
;;
esac
INPUT_FILE_ABS="$saved_input"
ext_lower="$saved_ext"
}
# --- Run ---
echo "=== Decompiling $INPUT_FILE (engine: $ENGINE) ==="
echo "Output directory: $OUTPUT_DIR"
echo
if [[ "$ext_lower" == "xapk" ]]; then
# Decompile each APK found inside the XAPK
mkdir -p "$OUTPUT_DIR"
# Copy XAPK manifest for reference
if [[ -f "$XAPK_EXTRACTED_DIR/manifest.json" ]]; then
cp "$XAPK_EXTRACTED_DIR/manifest.json" "$OUTPUT_DIR/xapk-manifest.json"
fi
# Copy OBB file list for reference
obb_files=()
while IFS= read -r -d '' obb; do
obb_files+=("$obb")
done < <(find "$XAPK_EXTRACTED_DIR" -name "*.obb" -print0 2>/dev/null)
if [[ ${#obb_files[@]} -gt 0 ]]; then
echo "OBB files found (not decompiled, data-only):"
for obb in "${obb_files[@]}"; do
echo " - $(basename "$obb") ($(du -h "$obb" | cut -f1))"
done
echo
fi
for apk_file in "${XAPK_APK_FILES[@]}"; do
apk_name=$(basename "$apk_file" .apk)
echo
echo "======================================================"
decompile_single "$apk_file" "$OUTPUT_DIR/$apk_name" "$apk_name.apk"
done
# Cleanup extracted XAPK
rm -rf "$XAPK_EXTRACTED_DIR"
echo
echo "=== XAPK decompilation complete ==="
echo "Subdirectories in $OUTPUT_DIR/:"
ls -1 "$OUTPUT_DIR/"
else
decompile_single "$INPUT_FILE_ABS" "$OUTPUT_DIR" ""
# --- Split/bundled APK detection ---
# Some APKs are bundles: the outer APK contains base.apk + split_config.*.apk
# inside the resources directory. jadx will decompile the thin outer wrapper
# and produce very few Java files. Detect this and re-decompile base.apk.
sources_dir="$OUTPUT_DIR/sources"
resources_dir="$OUTPUT_DIR/resources"
if [[ -d "$sources_dir" && -d "$resources_dir" ]]; then
java_count=$(find "$sources_dir" -name "*.java" -type f 2>/dev/null | wc -l)
base_apk=$(find "$resources_dir" -maxdepth 1 -name "base.apk" -type f 2>/dev/null | head -1)
inner_apk_count=$(find "$resources_dir" -maxdepth 1 -name "*.apk" -type f 2>/dev/null | wc -l)
if [[ "$java_count" -le 10 && -n "$base_apk" ]]; then
echo
echo "=== Split/bundled APK detected ==="
echo "Outer APK produced only $java_count Java file(s) but contains $inner_apk_count inner APK(s):"
find "$resources_dir" -maxdepth 1 -name "*.apk" -type f -exec basename {} \; | while read -r f; do echo " - $f"; done
echo
echo "Decompiling base.apk (contains the actual app code)..."
decompile_single "$base_apk" "$OUTPUT_DIR/base" "base.apk"
# Decompile non-config split APKs
while IFS= read -r -d '' split_apk; do
split_name=$(basename "$split_apk" .apk)
case "$split_name" in
base|split_config.*) continue ;;
esac
echo
echo "Decompiling $split_name.apk..."
decompile_single "$split_apk" "$OUTPUT_DIR/$split_name" "$split_name.apk"
done < <(find "$resources_dir" -maxdepth 1 -name "*.apk" -type f -print0 2>/dev/null)
# Report skipped config splits
config_splits=$(find "$resources_dir" -maxdepth 1 -name "split_config.*.apk" -type f 2>/dev/null)
if [[ -n "$config_splits" ]]; then
echo
echo "Skipped config splits (resource/ABI only):"
echo "$config_splits" | while read -r f; do echo " - $(basename "$f")"; done
fi
echo
echo "Main decompiled source is in: $OUTPUT_DIR/base/sources/"
fi
fi
echo
echo "=== Decompilation complete ==="
fi
@@ -0,0 +1,121 @@
# find-api-calls.ps1 — Search decompiled source for API calls and HTTP endpoints
param(
[Parameter(Position=0)]
[string]$SourceDir,
[switch]$Retrofit,
[switch]$OkHttp,
[switch]$Volley,
[switch]$Urls,
[switch]$Auth,
[switch]$All,
[Alias('h')]
[switch]$Help
)
$ErrorActionPreference = 'Stop'
function Show-Usage {
Write-Host @"
Usage: find-api-calls.ps1 <source-dir> [OPTIONS]
Search decompiled Java/Kotlin source for HTTP API calls and endpoints.
Arguments:
<source-dir> Path to the decompiled sources directory
Options:
-Retrofit Search only for Retrofit annotations
-OkHttp Search only for OkHttp patterns
-Volley Search only for Volley patterns
-Urls Search only for hardcoded URLs
-Auth Search only for auth-related patterns
-All Search all patterns (default)
-Help Show this help message
Output:
Results are printed as file:line:match for easy navigation.
"@
exit 0
}
if ($Help) { Show-Usage }
if (-not $SourceDir) {
Write-Host "Error: No source directory specified." -ForegroundColor Red
Show-Usage
}
if (-not (Test-Path $SourceDir)) {
Write-Host "Error: Directory not found: $SourceDir" -ForegroundColor Red
exit 1
}
# Default to all if no specific flag set
$searchAll = (-not $Retrofit -and -not $OkHttp -and -not $Volley -and -not $Urls -and -not $Auth) -or $All
function Write-Section {
param([string]$Title)
Write-Host ""
Write-Host "==== $Title ===="
Write-Host ""
}
function Search-Sources {
param([string]$Pattern)
Get-ChildItem -Path $SourceDir -Recurse -Include '*.java','*.kt' -File |
Select-String -Pattern $Pattern -ErrorAction SilentlyContinue |
ForEach-Object {
"$($_.Path):$($_.LineNumber):$($_.Line.Trim())"
}
}
# --- Retrofit ---
if ($searchAll -or $Retrofit) {
Write-Section "Retrofit Annotations"
Search-Sources '@(GET|POST|PUT|DELETE|PATCH|HEAD|OPTIONS|HTTP)\s*\('
Write-Section "Retrofit Headers & Parameters"
Search-Sources '@(Headers|Header|Query|QueryMap|Path|Body|Field|FieldMap|Part|PartMap|Url)\s*\('
Write-Section "Retrofit Base URL"
Search-Sources '(baseUrl|base_url)\s*\('
}
# --- OkHttp ---
if ($searchAll -or $OkHttp) {
Write-Section "OkHttp Request Building"
Search-Sources '(Request\.Builder|HttpUrl|\.newCall|\.enqueue|addInterceptor|addNetworkInterceptor)'
Write-Section "OkHttp URL Construction"
Search-Sources '(\.url\s*\(|\.addQueryParameter|\.addPathSegment|\.scheme\s*\(|\.host\s*\()'
}
# --- Volley ---
if ($searchAll -or $Volley) {
Write-Section "Volley Requests"
Search-Sources '(StringRequest|JsonObjectRequest|JsonArrayRequest|ImageRequest|RequestQueue|Volley\.newRequestQueue)'
}
# --- Hardcoded URLs ---
if ($searchAll -or $Urls) {
Write-Section "Hardcoded URLs (http:// and https://)"
Search-Sources '"https?://[^"]+'
Write-Section "HttpURLConnection"
Search-Sources '(openConnection|setRequestMethod|HttpURLConnection|HttpsURLConnection)'
Write-Section "WebView URLs"
Search-Sources '(loadUrl|loadData|evaluateJavascript|addJavascriptInterface|WebViewClient|WebChromeClient)'
}
# --- Auth patterns ---
if ($searchAll -or $Auth) {
Write-Section "Authentication & API Keys"
Search-Sources '(?i)(api[_\-]?key|auth[_\-]?token|bearer|authorization|x-api-key|client[_\-]?secret|access[_\-]?token)'
Write-Section "Base URLs and Constants"
Search-Sources '(?i)(BASE_URL|API_URL|SERVER_URL|ENDPOINT|API_BASE|HOST_NAME)'
}
Write-Host ""
Write-Host "=== Search complete ==="
@@ -0,0 +1,339 @@
#!/usr/bin/env bash
# find-api-calls.sh — Search decompiled source for API calls and HTTP endpoints
set -euo pipefail
usage() {
cat <<EOF
Usage: find-api-calls.sh <source-dir> [OPTIONS]
Search decompiled Java/Kotlin source for HTTP API calls and endpoints.
Arguments:
<source-dir> Path to the decompiled sources directory
Options:
--retrofit Search only for Retrofit annotations
--okhttp Search only for OkHttp patterns
--ktor Search only for Ktor client patterns
--apollo Search only for Apollo (GraphQL) patterns
--volley Search only for Volley patterns
--urls Search only for hardcoded URLs
--paths Extract unique endpoint-shaped path string literals
(works on heavily obfuscated apps where call sites are inlined)
--auth Search only for auth-related patterns
--all Search all patterns (default)
-h, --help Show this help message
Output:
Results are printed as file:line:match for easy navigation.
EOF
exit 0
}
SOURCE_DIR=""
SEARCH_RETROFIT=false
SEARCH_OKHTTP=false
SEARCH_KTOR=false
SEARCH_APOLLO=false
SEARCH_VOLLEY=false
SEARCH_URLS=false
SEARCH_PATHS=false
SEARCH_AUTH=false
SEARCH_ALL=true
while [[ $# -gt 0 ]]; do
case "$1" in
--retrofit) SEARCH_RETROFIT=true; SEARCH_ALL=false; shift ;;
--okhttp) SEARCH_OKHTTP=true; SEARCH_ALL=false; shift ;;
--ktor) SEARCH_KTOR=true; SEARCH_ALL=false; shift ;;
--apollo) SEARCH_APOLLO=true; SEARCH_ALL=false; shift ;;
--volley) SEARCH_VOLLEY=true; SEARCH_ALL=false; shift ;;
--urls) SEARCH_URLS=true; SEARCH_ALL=false; shift ;;
--paths) SEARCH_PATHS=true; SEARCH_ALL=false; shift ;;
--auth) SEARCH_AUTH=true; SEARCH_ALL=false; shift ;;
--all) SEARCH_ALL=true; shift ;;
-h|--help) usage ;;
-*) echo "Error: Unknown option $1" >&2; usage ;;
*) SOURCE_DIR="$1"; shift ;;
esac
done
if [[ -z "$SOURCE_DIR" ]]; then
echo "Error: No source directory specified." >&2
usage
fi
if [[ ! -d "$SOURCE_DIR" ]]; then
echo "Error: Directory not found: $SOURCE_DIR" >&2
exit 1
fi
GREP_OPTS="-rn --include=*.java --include=*.kt"
section() {
echo
echo "==== $1 ===="
echo
}
run_grep() {
local pattern="$1"
# shellcheck disable=SC2086
grep $GREP_OPTS -E "$pattern" "$SOURCE_DIR" 2>/dev/null || true
}
# Print a one-screen summary FIRST so a reader knows what to expect from
# the long output that follows. Skipped when a single section flag was
# requested (the user wants raw matches, not an overview). One pass over
# the tree, counts bucketed by tag — running 8 separate greps was too slow.
if [[ "$SEARCH_ALL" == true ]]; then
section "Summary (counted in a single pass)"
declare -A H=(
[retrofit]=0 [okhttp]=0 [ktor]=0 [apollo]=0 [volley]=0
[hilt]=0 [koin]=0 [bearer]=0 [hmac]=0
)
while IFS= read -r line; do
case "$line" in
*"@GET("*|*"@POST("*|*"@PUT("*|*"@DELETE("*|*"@PATCH("*|*"@HTTP("*) H[retrofit]=$((H[retrofit]+1));;
esac
case "$line" in
*"Request.Builder"*|*"HttpUrl"*|*".newCall("*) H[okhttp]=$((H[okhttp]+1));;
esac
case "$line" in
*"BearerTokens"*|*"defaultRequest {"*|*"client.get("*|*"client.post("*|*"httpClient.get("*|*"httpClient.post("*|*"HttpClient.get("*) H[ktor]=$((H[ktor]+1));;
esac
case "$line" in
*"ApolloClient"*|*".serverUrl("*) H[apollo]=$((H[apollo]+1));;
esac
case "$line" in
*"StringRequest"*|*"JsonObjectRequest"*|*"RequestQueue"*) H[volley]=$((H[volley]+1));;
esac
case "$line" in
*"@HiltAndroidApp"*|*"@AndroidEntryPoint"*|*"@HiltViewModel"*|*"@Provides"*|*"@Binds"*) H[hilt]=$((H[hilt]+1));;
esac
case "$line" in
*"org.koin."*|*"module {"*|*"single<"*|*"factory<"*|*"singleOf("*|*"factoryOf("*) H[koin]=$((H[koin]+1));;
esac
case "$line" in
*'"Bearer '*|*'"bearer '*|*"BearerTokens"*) H[bearer]=$((H[bearer]+1));;
esac
case "$line" in
*"HmacSHA"*|*'Mac.getInstance("Hmac'*) H[hmac]=$((H[hmac]+1));;
esac
done < <(grep -rEh --include='*.java' --include='*.kt' \
'@(GET|POST|PUT|DELETE|PATCH|HTTP)\(|Request\.Builder|HttpUrl|\.newCall\(|BearerTokens|defaultRequest \{|client\.(get|post)\(|httpClient\.(get|post)\(|ApolloClient|\.serverUrl\(|StringRequest|JsonObjectRequest|RequestQueue|@HiltAndroidApp|@AndroidEntryPoint|@HiltViewModel|@Provides|@Binds|org\.koin\.|module \{|single<|factory<|"[Bb]earer |HmacSHA|Mac\.getInstance' \
"$SOURCE_DIR" 2>/dev/null || true)
printf ' HTTP framework: Retrofit=%-5s OkHttp=%-5s Ktor=%-5s Apollo=%-5s Volley=%-5s\n' \
"${H[retrofit]}" "${H[okhttp]}" "${H[ktor]}" "${H[apollo]}" "${H[volley]}"
printf ' DI framework: Hilt/Dagger=%-5s Koin=%-5s\n' \
"${H[hilt]}" "${H[koin]}"
printf ' Auth signals: Bearer=%-5s HMAC/Sign=%-5s\n' \
"${H[bearer]}" "${H[hmac]}"
echo
echo " Run with one of --retrofit / --okhttp / --ktor / --apollo / --volley /"
echo " --paths / --urls / --auth to inspect a single section."
fi
# --- Retrofit ---
if [[ "$SEARCH_ALL" == true || "$SEARCH_RETROFIT" == true ]]; then
section "Retrofit Annotations"
run_grep '@(GET|POST|PUT|DELETE|PATCH|HEAD|OPTIONS|HTTP)\s*\('
section "Retrofit Headers & Parameters"
run_grep '@(Headers|Header|Query|QueryMap|Path|Body|Field|FieldMap|Part|PartMap|Url)\s*\('
section "Retrofit Base URL"
run_grep '(baseUrl|base_url)\s*\('
fi
# --- OkHttp ---
if [[ "$SEARCH_ALL" == true || "$SEARCH_OKHTTP" == true ]]; then
section "OkHttp Request Building"
run_grep '(Request\.Builder|HttpUrl|\.newCall|\.enqueue|addInterceptor|addNetworkInterceptor)'
section "OkHttp URL Construction"
run_grep '(\.url\s*\(|\.addQueryParameter|\.addPathSegment|\.scheme\s*\(|\.host\s*\()'
fi
# --- Ktor (Kotlin) ---
# Ktor doesn't use annotations. Endpoints appear as string args to
# client.get/post/etc., or are built via HttpRequestBuilder.url(...). Auth
# is configured via the bearer { loadTokens / refreshTokens } DSL.
if [[ "$SEARCH_ALL" == true || "$SEARCH_KTOR" == true ]]; then
section "Ktor — Client Calls"
run_grep '\b(client|httpClient|HttpClient)\.(get|post|put|delete|patch|head|request)\s*[<(]'
section "Ktor — Request Building / Default Request"
run_grep '(HttpRequestBuilder|defaultRequest\s*\{|\burl\s*\(\s*"|URLBuilder|URLProtocol)'
section "Ktor — Auth Plugin (Bearer / Refresh)"
run_grep '(\bbearer\s*\{|BearerTokens\s*\(|loadTokens\s*\{|refreshTokens\s*\{|\bAuth\s*\)\s*\{)'
fi
# --- Apollo (GraphQL) ---
if [[ "$SEARCH_ALL" == true || "$SEARCH_APOLLO" == true ]]; then
section "Apollo — GraphQL Client"
run_grep '(ApolloClient|\.serverUrl\s*\(|\.subscriptionNetworkTransport|HttpNetworkTransport)'
section "Apollo — Operations"
run_grep '(\.query\s*\(\s*[A-Z]|\.mutation\s*\(\s*[A-Z]|\.subscription\s*\(\s*[A-Z])'
fi
# --- Volley ---
if [[ "$SEARCH_ALL" == true || "$SEARCH_VOLLEY" == true ]]; then
section "Volley Requests"
run_grep '(StringRequest|JsonObjectRequest|JsonArrayRequest|ImageRequest|RequestQueue|Volley\.newRequestQueue)'
fi
# --- Endpoint-shaped path literals ---
# Survives R8 obfuscation: even when call sites are inlined to a.b(c, "path"),
# the path strings themselves are not obfuscated. This produces a deduplicated
# inventory of likely API endpoints that other modes miss.
if [[ "$SEARCH_ALL" == true || "$SEARCH_PATHS" == true ]]; then
section "Endpoint-Shaped Path Literals (deduplicated)"
# Quoted strings that begin with /<segment> or <segment>/ where the leading
# segment is a typical API root word. Cap segment count and length to keep
# the regex grounded.
# An endpoint-shaped string is one of:
# "/seg/seg..." — absolute path with >= 2 segments
# "api-root/seg/seg..." — relative path starting with a known
# API root keyword and containing >= 1
# '/' followed by another segment
# Segments are URL-safe chars plus {} for path-template placeholders.
SEG='[A-Za-z0-9_{}.\-]+'
ROOT='(api|v[0-9]+|graphql|rest|mobile|auth|oauth|sso|users?|account|session|token|register|signup|signin|logout|password|verify|otp|sms|profile|customer|cart|basket|order|checkout|payment|invoice|product|catalog|inventory|search|category|favo[u]?rites?|wishlist|address|location|delivery|shipping|review|feedback|notification|push|message|chat|track|event|stat[a-z]*|metric|config|settings?|feature|flag|banner|content|media|upload|download|file|image|video|live|stream|webhook|callback)'
PATHS_REGEX="\"(/${SEG}(/${SEG})+/?|${ROOT}(/${SEG})+/?)\""
# Filter out frequent false positives (MIME types, /proc, /sys, /dev).
EXCLUDE='^"(image|video|audio|text|application|content|font|model|multipart|message)/|^"/(proc|sys|dev|tmp|etc|usr|var|opt)/'
# Print a flat unique list rather than file:line — this is the inventory.
grep -rhoE --include='*.java' --include='*.kt' "$PATHS_REGEX" "$SOURCE_DIR" 2>/dev/null \
| grep -Ev "$EXCLUDE" \
| sort -u || true
echo
section "Endpoint-Shaped Path Literals — call sites"
grep $GREP_OPTS -E "$PATHS_REGEX" "$SOURCE_DIR" 2>/dev/null \
| grep -Ev ":[0-9]+:.*${EXCLUDE#^}" || true
fi
# --- Hardcoded URLs ---
# A loose grep for http(s)://... drowns in compression-dictionary garbage and
# in third-party SDK URLs (Google, Firebase, AppsFlyer, Datadog, ...). The
# strict regex requires a syntactically valid hostname and rejects strings
# containing whitespace, angle brackets, or non-printable bytes. Hosts are
# then bucketed into "first-party candidates" vs "third-party (denylist)".
if [[ "$SEARCH_ALL" == true || "$SEARCH_URLS" == true ]]; then
HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DENYLIST="$HERE/../references/third_party_hosts.txt"
# Accept three host shapes, all rejecting whitespace / angle brackets /
# non-printables in the path:
# * IPv4 literal (dev/staging endpoints, high signal) 192.168.0.1
# * dotted host: >=2 labels ending in a 2+ letter TLD (incl apex) example.com
# * bare single-label host, BUT only when followed by ':port' or localhost:3000
# '/path' — keeps internal hosts (localhost, internal-backend) svc/health
# while still dropping Kotlin-stdlib dictionary fragments like
# "http://An Introduction..." (bare word, no port/path follows).
STRICT_URL='https?://(([0-9]{1,3}(\.[0-9]{1,3}){3}|[A-Za-z0-9-]+(\.[A-Za-z0-9-]+)*\.[A-Za-z]{2,})(:[0-9]{1,5})?(/[^"<>[:space:]]*)?|[A-Za-z0-9-]+(:[0-9]{1,5}(/[^"<>[:space:]]*)?|/[^"<>[:space:]]*))'
TMP="$(mktemp)"
trap 'rm -f "$TMP"' EXIT
# Extraction (STRICT_URL) is deliberately permissive; this awk pass drops the
# residual Kotlin-stdlib dictionary noise WITHOUT losing the high-signal
# shapes a strict-only regex discards (IPs, apex domains, internal hosts).
# Decision table, top-down, on the host (authority before any :port / /path):
# * IPv4 literal -> keep (dict fragments are words,
# never dotted-quads)
# * >=3 labels (sub.domain.tld) -> keep (any TLD; same tolerance the
# original strict regex had)
# * any host WITH a :port or /path -> keep (structured = high signal:
# localhost:3000, svc/health)
# * bare 2-label apex, no port/path -> keep ONLY if the TLD is a real one,
# compared as a whole field (kills
# "www.this" / "this.introduction",
# keeps "mytrackera-api.com")
# Trade-off: a first-party host referenced bare with an uncommon TLD (e.g.
# https://foo.store with no path) is dropped — give it a path/port, or add the
# TLD to the list below, if you hit that case.
{ grep -rhoE --include='*.java' --include='*.kt' "$STRICT_URL" "$SOURCE_DIR" 2>/dev/null || true; } \
| sort -u \
| awk '
{ rest=$0; sub(/^https?:\/\//,"",rest)
host=rest; sub(/[/:].*/,"",host)
haspathport = (rest ~ /[/:]/)
if (host ~ /^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$/) { print; next } # IPv4
n = split(host, a, ".")
if (n >= 3) { print; next } # sub.domain.tld
if (haspathport) { print; next } # has :port or /path
if (n == 2 && a[2] ~ /^(com|net|org|io|co|app|dev|me|ai|xyz|info|biz|gov|edu|mil|int|tech|cloud|uk|de|fr|it|es|nl|in|us|ca|au|jp|cn|br|ru|eu|ch|se|no|fi|dk|pl|pt|gr|ie|be|at|cz|sg|hk|kr|tw|mx|ar|cl|za|nz)$/) print # real apex TLD
}' > "$TMP"
# Extract host: strip scheme, take part up to first ':' or '/'.
HOSTS_TMP="$(mktemp)"
sed -E 's#^https?://##; s#[/:].*$##' "$TMP" | sort -u > "$HOSTS_TMP"
if [[ -f "$DENYLIST" ]]; then
# Build a single combined regex from the denylist (one line each).
DENY_REGEX="$(grep -vE '^\s*(#|$)' "$DENYLIST" | tr '\n' '|' | sed 's/|$//')"
THIRD_HOSTS=$(grep -E "$DENY_REGEX" "$HOSTS_TMP" || true)
FIRST_HOSTS=$(grep -vE "$DENY_REGEX" "$HOSTS_TMP" || true)
else
THIRD_HOSTS=""
FIRST_HOSTS=$(cat "$HOSTS_TMP")
fi
section "Likely First-Party Hosts (frequency-sorted)"
if [[ -n "$FIRST_HOSTS" ]]; then
while IFS= read -r h; do
[[ -z "$h" ]] && continue
n=$(grep -cE "://${h//./\\.}([/:\"]|$)" "$TMP" || true)
printf ' %5d %s\n' "$n" "$h"
done <<< "$FIRST_HOSTS" | sort -rn -k1
else
echo " (none — every URL matched the third-party denylist)"
fi
section "Third-Party Hosts (denylist matches, collapsed)"
if [[ -n "$THIRD_HOSTS" ]]; then
echo "$THIRD_HOSTS" | sed 's/^/ /'
else
echo " (none)"
fi
section "All First-Party URLs (full strings)"
if [[ -n "$FIRST_HOSTS" ]]; then
while IFS= read -r h; do
[[ -z "$h" ]] && continue
grep -E "://${h//./\\.}([/:\"]|$)" "$TMP" | sed 's/^/ /'
done <<< "$FIRST_HOSTS"
fi
rm -f "$HOSTS_TMP" "$TMP"
trap - EXIT
section "HttpURLConnection"
run_grep '(openConnection|setRequestMethod|HttpURLConnection|HttpsURLConnection)'
section "WebView URLs"
run_grep '(loadUrl|loadData|evaluateJavascript|addJavascriptInterface|WebViewClient|WebChromeClient)'
fi
# --- Auth patterns ---
if [[ "$SEARCH_ALL" == true || "$SEARCH_AUTH" == true ]]; then
section "Authentication & API Keys"
run_grep -i '(api[_-]?key|auth[_-]?token|bearer|authorization|x-api-key|client[_-]?secret|access[_-]?token|refresh[_-]?token)'
# Request-signing schemes: a hardcoded HMAC / RSA secret in an APK is a
# security finding worth surfacing prominently. These patterns catch the
# common shapes of homegrown / SDK-issued request signers.
section "Request Signing (HMAC / signature schemes)"
run_grep '(HmacSHA(1|256|512)|Mac\.getInstance\("Hmac|SecretKeySpec\(|Signature\.getInstance\()'
run_grep -i '(x-signature|x-client-authorization|x-amz-signature|x-hmac|aws4-hmac|signRequest|signatureFor|computeSignature|signaturev[0-9])'
# Hardcoded high-entropy strings adjacent to "secret"/"key" assignments
# are the canonical leaked-credential pattern.
section "Possible Hardcoded Secrets / Keys"
run_grep -i '(app[_-]?secret|client[_-]?secret|signing[_-]?key|hmac[_-]?secret|consumer[_-]?secret|private[_-]?key)'
section "Base URLs and Constants"
run_grep -i '(BASE_URL|API_URL|SERVER_URL|ENDPOINT|API_BASE|HOST_NAME)'
# Ktor BearerTokens / refresh DSL — common on Kotlin apps and lives on
# Ktor's public API, so it survives R8 unchanged.
section "Ktor Auth (Bearer + Refresh)"
run_grep '(BearerTokens|loadTokens\s*\{|refreshTokens\s*\{|\bbearer\s*\{)'
fi
echo
echo "=== Search complete ==="
@@ -0,0 +1,241 @@
#!/usr/bin/env bash
# fingerprint.sh — Triage an APK/XAPK before decompiling.
#
# Detects mobile framework (Flutter, React Native, Cordova/Capacitor,
# Xamarin, KMP/native), HTTP-stack hints, obfuscation level, native libs,
# and notable third-party SDKs.
#
# Decompiling Java is mostly useless for Flutter / RN / Xamarin / Cordova
# apps — different tools are needed. Run this BEFORE Phase 2 to choose
# the right path.
set -euo pipefail
usage() {
cat <<EOF
Usage: fingerprint.sh <file.apk|file.xapk>
Prints a one-screen summary:
* mobile framework (with rationale)
* HTTP / DI / serialization stack hints
* obfuscation indicator
* native libraries (consolidated across split APKs)
* notable third-party SDKs found in assets/
EOF
exit 0
}
[[ $# -lt 1 || "$1" == "-h" || "$1" == "--help" ]] && usage
INPUT="$1"
[[ ! -f "$INPUT" ]] && { echo "File not found: $INPUT" >&2; exit 1; }
TMP="$(mktemp -d -t apkfp.XXXXXX)"
trap 'rm -rf "$TMP"' EXIT
# Resolve to a list of APKs (handle XAPK = ZIP of APKs)
APKS=()
case "${INPUT,,}" in
*.xapk|*.apks|*.apkm)
unzip -q -o "$INPUT" -d "$TMP/xapk"
while IFS= read -r p; do APKS+=("$p"); done < <(find "$TMP/xapk" -maxdepth 2 -type f -name '*.apk')
;;
*.apk)
APKS=("$INPUT")
;;
*)
echo "Unsupported input: $INPUT" >&2; exit 1 ;;
esac
# Aggregate ZIP listings from every APK in the bundle (split-aware view)
LISTING="$TMP/listing.txt"
: > "$LISTING"
for apk in "${APKS[@]}"; do
unzip -l -- "$apk" 2>/dev/null | awk '{print $NF}' >> "$LISTING"
done
# Most class-level libs live inside classes*.dex, not as visible zip paths.
# Extract the type-name strings out of each dex with `strings` and append them
# to the listing so `has()` can match e.g. 'io/ktor/' or 'org/koin/'.
DEX_STRINGS="$TMP/dex_strings.txt"
: > "$DEX_STRINGS"
for apk in "${APKS[@]}"; do
for dex in $(unzip -Z1 -- "$apk" 2>/dev/null | grep -E '^classes[0-9]*\.dex$' || true); do
# DEX type descriptors look like "Lcom/foo/Bar;". Extract the inner
# slash-separated FQN so callers can match e.g. 'io/ktor/' directly.
unzip -p -- "$apk" "$dex" 2>/dev/null \
| strings -n 8 \
| grep -oE 'L[a-z][a-zA-Z0-9_]*(/[a-zA-Z0-9_$]+)+;' \
| sed -E 's/^L//; s/;$//' \
>> "$DEX_STRINGS" || true
done
done
sort -u "$DEX_STRINGS" -o "$DEX_STRINGS"
has() { grep -qE "$1" "$LISTING" || grep -qE "$1" "$DEX_STRINGS"; }
# ----------------------------------------------------------------------
# Framework detection (priority order — first match wins)
# ----------------------------------------------------------------------
FRAMEWORK="unknown"
RATIONALE=""
if has '^lib/[^/]+/libflutter\.so$'; then
FRAMEWORK="Flutter"
RATIONALE="lib/<abi>/libflutter.so present"
has '^lib/[^/]+/libapp\.so$' && RATIONALE+="; libapp.so contains AOT-compiled Dart"
elif has '^lib/[^/]+/libhermes\.so$' || has '^assets/index\.android\.bundle$' || has '^lib/[^/]+/libreactnativejni\.so$'; then
FRAMEWORK="React Native"
reasons=()
has '^lib/[^/]+/libhermes\.so$' && reasons+=("libhermes.so")
has '^lib/[^/]+/libreactnativejni\.so$' && reasons+=("libreactnativejni.so")
has '^assets/index\.android\.bundle$' && reasons+=("assets/index.android.bundle")
RATIONALE="${reasons[*]}"
elif has '^assets/www/index\.html$' || has '^assets/www/cordova\.js$' || has '^assets/public/index\.html$'; then
FRAMEWORK="Cordova / Capacitor (WebView hybrid)"
RATIONALE="assets/www/ or assets/public/ shell present"
elif has '^lib/[^/]+/libmonodroid\.so$' || has '^assemblies/'; then
FRAMEWORK="Xamarin / .NET MAUI"
RATIONALE="libmonodroid.so or assemblies/ present — code is in .NET DLLs"
elif has '^lib/[^/]+/libmaui\.so$'; then
FRAMEWORK=".NET MAUI"
RATIONALE="libmaui.so present"
elif has '^assets/flutter_assets/' && ! has '^lib/[^/]+/libflutter\.so$'; then
FRAMEWORK="Flutter (code-only split?)"
RATIONALE="flutter_assets/ but no libflutter.so in this APK — check splits"
else
# Native: distinguish Compose vs classic Android by androidx.compose presence
if has 'androidx\.compose'; then
FRAMEWORK="Native Android (Kotlin + Jetpack Compose)"
RATIONALE="androidx.compose.* libraries detected"
elif has '^META-INF/.*\.kotlin_module$'; then
FRAMEWORK="Native Android (Kotlin)"
RATIONALE="kotlin_module metadata present, no Compose markers"
else
FRAMEWORK="Native Android (Java/Kotlin)"
RATIONALE="no cross-platform framework markers found"
fi
fi
# ----------------------------------------------------------------------
# HTTP / DI / serialization stack hints
# ----------------------------------------------------------------------
http=()
has 'retrofit2' && http+=("Retrofit")
has 'okhttp3' && http+=("OkHttp")
has 'io/ktor/' && http+=("Ktor")
has 'com/apollographql/' && http+=("Apollo (GraphQL)")
has 'com/android/volley' && http+=("Volley")
di=()
has 'dagger/hilt/' && di+=("Hilt")
has '^META-INF/.*dagger.*' && di+=("Dagger")
has 'org/koin/' && di+=("Koin")
has 'javax/inject/' && [[ ${#di[@]} -eq 0 ]] && di+=("javax.inject")
ser=()
has 'kotlinx/serialization/' && ser+=("kotlinx.serialization")
has 'com/google/gson/' && ser+=("Gson")
has 'com/squareup/moshi/' && ser+=("Moshi")
has 'com/fasterxml/jackson/' && ser+=("Jackson")
# ----------------------------------------------------------------------
# Obfuscation indicator (R8/ProGuard) — count single-letter dex packages
# ----------------------------------------------------------------------
# Note: pipefail is on, so guard greps that may legitimately return 0 matches.
short_dirs=$( { grep -oE '^[a-z]{1,2}/' "$LISTING" || true; } | sort -u | wc -l | tr -d ' ')
if [[ "$short_dirs" -gt 30 ]]; then
OBFUSCATION="HIGH ($short_dirs single/double-letter dirs at root)"
elif [[ "$short_dirs" -gt 10 ]]; then
OBFUSCATION="MODERATE ($short_dirs short root dirs)"
else
OBFUSCATION="LOW (no significant short-name namespace pollution)"
fi
# ----------------------------------------------------------------------
# Native libraries (consolidated)
# ----------------------------------------------------------------------
NATIVE=$(grep -E '^lib/[^/]+/[^/]+\.so$' "$LISTING" | sort -u || true)
# ----------------------------------------------------------------------
# Notable third-party SDKs (assets-based markers)
# ----------------------------------------------------------------------
sdks=()
has '^assets/com/appsflyer/' && sdks+=("AppsFlyer")
has 'datadog\.buildId|com/datadog/' && sdks+=("Datadog")
has 'io/sentry/' && sdks+=("Sentry")
has 'com/google/firebase/' && sdks+=("Firebase")
has 'com/google/android/gms/' && sdks+=("Google Play Services")
has 'com/facebook/' && sdks+=("Facebook SDK")
has 'com/payu/' && sdks+=("PayU")
has 'com/stripe/' && sdks+=("Stripe")
has 'com/braintreepayments/' && sdks+=("Braintree")
has 'com/storyteller/' && sdks+=("Storyteller")
has 'zendesk/' && sdks+=("Zendesk")
has 'com/intercom/' && sdks+=("Intercom")
has 'com/segment/analytics' && sdks+=("Segment")
has 'com/amplitude/' && sdks+=("Amplitude")
has 'com/mixpanel/' && sdks+=("Mixpanel")
has 'com/onesignal/' && sdks+=("OneSignal")
has 'com/microsoft/clarity' && sdks+=("Microsoft Clarity")
has 'com/hotjar/' && sdks+=("Hotjar")
has 'com/instabug/' && sdks+=("Instabug")
# BuildConfig.java is almost never obfuscated and often holds base URLs / flavor.
if has 'BuildConfig\.class$'; then
BUILDCONFIG="present (grep BuildConfig.java after decompile for base URLs / flavor)"
else
BUILDCONFIG="not detected in zip listing (still worth grepping after decompile)"
fi
# ----------------------------------------------------------------------
# Summary
# ----------------------------------------------------------------------
echo "=== APK Fingerprint: $(basename "$INPUT") ==="
echo
echo "Framework: $FRAMEWORK"
echo " Rationale: $RATIONALE"
echo "Obfuscation: $OBFUSCATION"
echo
echo "HTTP stack: ${http[*]:-none detected}"
echo "DI: ${di[*]:-none detected}"
echo "Serialization: ${ser[*]:-none detected}"
echo "BuildConfig: $BUILDCONFIG"
echo
echo "Third-party SDKs: ${sdks[*]:-none detected}"
echo
echo "Native libraries (consolidated across splits):"
if [[ -n "$NATIVE" ]]; then
echo "$NATIVE" | sed 's/^/ /'
else
echo " (none)"
fi
echo
# ----------------------------------------------------------------------
# Recommendation
# ----------------------------------------------------------------------
echo "Recommended next step:"
case "$FRAMEWORK" in
Flutter*)
echo " Java decompilation will yield ~no app code. The Dart logic lives in"
echo " libapp.so (AOT). Use tools designed for Flutter:"
echo " - reFlutter / Doldrums / blutter (extract Dart class structure)"
echo " - strings/rabin2 on libapp.so for endpoints & string constants"
;;
React*)
echo " Java code is just the RN host. Real app logic is in JS/Hermes:"
echo " - if Hermes: hbctool disasm assets/index.android.bundle"
echo " - if JSC: js-beautify the bundle and grep for 'fetch('/'axios'"
;;
Cordova*)
echo " All app code is in assets/www/ (or assets/public/). Just unzip and"
echo " inspect the HTML/JS — no Java decompile needed."
;;
Xamarin*|.NET*)
echo " App logic is in .NET DLLs (assemblies/). Use ILSpy or dotPeek;"
echo " jadx will only show the Mono host."
;;
*)
echo " Proceed with Phase 2: bash scripts/decompile.sh <file>"
;;
esac
@@ -0,0 +1,345 @@
# install-dep.ps1 — Install a single dependency for Android reverse engineering
# Usage: install-dep.ps1 <dependency>
# Dependencies: java, jadx, vineflower, dex2jar, apktool, adb
#
# Exit codes:
# 0 — installed successfully
# 1 — installation failed
# 2 — requires manual action
param(
[Parameter(Position=0)]
[string]$Dep
)
$ErrorActionPreference = 'Stop'
function Show-Usage {
Write-Host @"
Usage: install-dep.ps1 <dependency>
Install a dependency required for Android reverse engineering.
Available dependencies:
java Java JDK 17+
jadx jadx decompiler
vineflower Vineflower (Fernflower fork) decompiler
dex2jar DEX to JAR converter
apktool Android resource decoder
adb Android Debug Bridge
The script detects available package managers (winget, scoop, choco), then:
- Installs using the first available manager
- Falls back to direct download to %USERPROFILE%\.local\share\
- Prints manual instructions if no option works
"@
exit 0
}
if (-not $Dep -or $Dep -eq '-h' -or $Dep -eq '--help') { Show-Usage }
# --- Detect environment ---
$hasWinget = [bool](Get-Command winget -ErrorAction SilentlyContinue)
$hasScoop = [bool](Get-Command scoop -ErrorAction SilentlyContinue)
$hasChoco = [bool](Get-Command choco -ErrorAction SilentlyContinue)
function Write-Info { param($msg) Write-Host "[INFO] $msg" }
function Write-Ok { param($msg) Write-Host "[OK] $msg" }
function Write-Fail { param($msg) Write-Host "[FAIL] $msg" -ForegroundColor Red }
function Write-Manual {
param($msg)
Write-Host "[MANUAL] $msg" -ForegroundColor Yellow
Write-Host " Cannot install automatically. Please install manually and retry." -ForegroundColor Yellow
exit 2
}
# --- Helper: download a file ---
function Invoke-Download {
param([string]$Url, [string]$Dest)
Write-Info "Downloading $Url..."
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Invoke-WebRequest -Uri $Url -OutFile $Dest -UseBasicParsing
}
# --- Helper: get latest GitHub release tag ---
function Get-GHLatestTag {
param([string]$Repo)
$url = "https://api.github.com/repos/$Repo/releases/latest"
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$response = Invoke-RestMethod -Uri $url -UseBasicParsing
return $response.tag_name
}
# --- Helper: ensure directory on PATH ---
function Add-ToUserPath {
param([string]$Dir)
$currentPath = [Environment]::GetEnvironmentVariable('PATH', 'User')
if ($currentPath -notlike "*$Dir*") {
[Environment]::SetEnvironmentVariable('PATH', "$Dir;$currentPath", 'User')
Write-Info "Added $Dir to user PATH. Restart your terminal to apply."
}
if ($env:PATH -notlike "*$Dir*") {
$env:PATH = "$Dir;$env:PATH"
}
}
$localBin = Join-Path $env:USERPROFILE '.local\bin'
$localShare = Join-Path $env:USERPROFILE '.local\share'
# =====================================================================
# Dependency installers
# =====================================================================
function Install-Java {
$javaBin = Get-Command java -ErrorAction SilentlyContinue
if ($javaBin) {
$verOutput = & java -version 2>&1 | Select-Object -First 1
if ("$verOutput" -match '"(\d+)') {
$ver = [int]$Matches[1]
if ($ver -ge 17) {
Write-Ok "Java $ver already installed"
return
}
}
}
Write-Info "Installing Java JDK 17+..."
if ($hasWinget) {
Write-Info "Installing via winget..."
winget install --id Microsoft.OpenJDK.17 --accept-source-agreements --accept-package-agreements
} elseif ($hasScoop) {
Write-Info "Installing via scoop..."
scoop install openjdk17
} elseif ($hasChoco) {
Write-Info "Installing via choco..."
choco install openjdk17 -y
} else {
Write-Manual "Install Java JDK 17+ from https://adoptium.net/"
}
# Verify
$javaBin = Get-Command java -ErrorAction SilentlyContinue
if ($javaBin) {
Write-Ok "Java installed: $(& java -version 2>&1 | Select-Object -First 1)"
} else {
Write-Fail "Java installation may require a terminal restart for PATH update."
exit 1
}
}
function Install-Jadx {
if (Get-Command jadx -ErrorAction SilentlyContinue) {
Write-Ok "jadx already installed"
return
}
# Try scoop first (cleanest on Windows)
if ($hasScoop) {
Write-Info "Installing jadx via scoop..."
scoop install jadx
if (Get-Command jadx -ErrorAction SilentlyContinue) {
Write-Ok "jadx installed via scoop"
return
}
}
# Direct download from GitHub releases
Write-Info "Installing jadx from GitHub releases..."
$tag = Get-GHLatestTag "skylot/jadx"
if (-not $tag) {
Write-Fail "Could not determine latest jadx version."
Write-Manual "Download from https://github.com/skylot/jadx/releases/latest"
}
$version = $tag -replace '^v', ''
$url = "https://github.com/skylot/jadx/releases/download/$tag/jadx-$version.zip"
$tmpZip = Join-Path $env:TEMP "jadx-$version.zip"
Invoke-Download -Url $url -Dest $tmpZip
$installDir = Join-Path $localShare 'jadx'
if (Test-Path $installDir) { Remove-Item $installDir -Recurse -Force }
New-Item -ItemType Directory -Path $installDir -Force | Out-Null
Expand-Archive -Path $tmpZip -DestinationPath $installDir -Force
Remove-Item $tmpZip -Force
# Add jadx\bin to PATH
$jadxBin = Join-Path $installDir 'bin'
Add-ToUserPath $jadxBin
if (Get-Command jadx -ErrorAction SilentlyContinue) {
Write-Ok "jadx $version installed to $installDir"
} else {
Write-Ok "jadx $version installed to $installDir"
Write-Info "Restart your terminal or run: `$env:PATH = '$jadxBin;' + `$env:PATH"
}
}
function Install-Vineflower {
if (Get-Command vineflower -ErrorAction SilentlyContinue) {
Write-Ok "Vineflower CLI already installed"
return
}
if (Get-Command fernflower -ErrorAction SilentlyContinue) {
Write-Ok "Fernflower CLI already installed"
return
}
$ffCandidates = @(
$env:FERNFLOWER_JAR_PATH,
"$env:USERPROFILE\.local\share\vineflower\vineflower.jar",
"$env:USERPROFILE\vineflower\vineflower.jar",
"$env:USERPROFILE\fernflower\fernflower.jar"
)
foreach ($c in $ffCandidates) {
if ($c -and (Test-Path $c -ErrorAction SilentlyContinue)) {
Write-Ok "Vineflower/Fernflower JAR already exists: $c"
return
}
}
# Download JAR from GitHub releases
Write-Info "Installing Vineflower from GitHub releases..."
$tag = Get-GHLatestTag "Vineflower/vineflower"
if (-not $tag) {
Write-Fail "Could not determine latest Vineflower version."
Write-Manual "Download from https://github.com/Vineflower/vineflower/releases/latest"
}
$version = $tag -replace '^v', ''
$url = "https://github.com/Vineflower/vineflower/releases/download/$tag/vineflower-$version.jar"
$installDir = Join-Path $localShare 'vineflower'
New-Item -ItemType Directory -Path $installDir -Force | Out-Null
Invoke-Download -Url $url -Dest (Join-Path $installDir 'vineflower.jar')
# Create wrapper batch file
New-Item -ItemType Directory -Path $localBin -Force | Out-Null
$wrapperPath = Join-Path $localBin 'vineflower.cmd'
Set-Content -Path $wrapperPath -Value "@echo off`r`njava -jar `"$installDir\vineflower.jar`" %*"
Add-ToUserPath $localBin
[Environment]::SetEnvironmentVariable('FERNFLOWER_JAR_PATH', "$installDir\vineflower.jar", 'User')
$env:FERNFLOWER_JAR_PATH = "$installDir\vineflower.jar"
Write-Ok "Vineflower $version installed to $installDir\vineflower.jar"
Write-Info "FERNFLOWER_JAR_PATH set to $installDir\vineflower.jar"
}
function Install-Dex2Jar {
if ((Get-Command d2j-dex2jar -ErrorAction SilentlyContinue) -or
(Get-Command d2j-dex2jar.bat -ErrorAction SilentlyContinue)) {
Write-Ok "dex2jar already installed"
return
}
Write-Info "Installing dex2jar from GitHub releases..."
$tag = try { Get-GHLatestTag "ThexXTURBOXx/dex2jar" } catch { "2.4.35" }
if (-not $tag) { $tag = "2.4.35" }
$version = $tag -replace '^v', ''
$url = "https://github.com/ThexXTURBOXx/dex2jar/releases/download/$tag/dex-tools-$version.zip"
$tmpZip = Join-Path $env:TEMP "dex2jar-$version.zip"
try {
Invoke-Download -Url $url -Dest $tmpZip
} catch {
# Try alternate naming (pre-2.4.30 releases)
$url = "https://github.com/ThexXTURBOXx/dex2jar/releases/download/$tag/dex-tools-v$version.zip"
try {
Invoke-Download -Url $url -Dest $tmpZip
} catch {
Write-Fail "Download failed."
Write-Manual "Download from https://github.com/ThexXTURBOXx/dex2jar/releases/latest"
}
}
$installDir = Join-Path $localShare 'dex2jar'
if (Test-Path $installDir) { Remove-Item $installDir -Recurse -Force }
New-Item -ItemType Directory -Path $installDir -Force | Out-Null
Expand-Archive -Path $tmpZip -DestinationPath $installDir -Force
Remove-Item $tmpZip -Force
# Find the actual bin directory (may be nested)
$d2jBat = Get-ChildItem -Path $installDir -Recurse -Filter 'd2j-dex2jar.bat' | Select-Object -First 1
if (-not $d2jBat) {
$d2jBat = Get-ChildItem -Path $installDir -Recurse -Filter 'd2j-dex2jar.sh' | Select-Object -First 1
}
if (-not $d2jBat) {
Write-Fail "Could not find d2j-dex2jar in extracted archive."
Write-Manual "Download and extract manually from https://github.com/ThexXTURBOXx/dex2jar/releases"
}
$binDir = $d2jBat.DirectoryName
Add-ToUserPath $binDir
Write-Ok "dex2jar $version installed to $installDir"
}
function Install-Apktool {
if (Get-Command apktool -ErrorAction SilentlyContinue) {
Write-Ok "apktool already installed"
return
}
if ($hasScoop) {
Write-Info "Installing apktool via scoop..."
scoop install apktool
} elseif ($hasChoco) {
Write-Info "Installing apktool via choco..."
choco install apktool -y
} else {
Write-Manual "Install apktool from https://apktool.org/docs/install"
}
if (Get-Command apktool -ErrorAction SilentlyContinue) {
Write-Ok "apktool installed"
} else {
Write-Fail "apktool installation may have failed."
exit 1
}
}
function Install-Adb {
if (Get-Command adb -ErrorAction SilentlyContinue) {
Write-Ok "adb already installed"
return
}
if ($hasScoop) {
Write-Info "Installing adb via scoop..."
scoop install adb
} elseif ($hasChoco) {
Write-Info "Installing adb via choco..."
choco install adb -y
} elseif ($hasWinget) {
Write-Info "Installing via winget..."
winget install Google.PlatformTools --accept-source-agreements --accept-package-agreements
} else {
Write-Manual "Install Android SDK Platform Tools from https://developer.android.com/tools/releases/platform-tools"
}
if (Get-Command adb -ErrorAction SilentlyContinue) {
Write-Ok "adb installed"
} else {
Write-Fail "adb installation may have failed."
exit 1
}
}
# =====================================================================
# Dispatch
# =====================================================================
switch ($Dep) {
'java' { Install-Java }
'jadx' { Install-Jadx }
'vineflower' { Install-Vineflower }
'fernflower' { Install-Vineflower }
'dex2jar' { Install-Dex2Jar }
'apktool' { Install-Apktool }
'adb' { Install-Adb }
default {
Write-Host "Error: Unknown dependency '$Dep'" -ForegroundColor Red
Write-Host "Available: java, jadx, vineflower, dex2jar, apktool, adb"
exit 1
}
}
@@ -0,0 +1,448 @@
#!/usr/bin/env bash
# install-dep.sh — Install a single dependency for Android reverse engineering
# Usage: install-dep.sh <dependency>
# Dependencies: java, jadx, vineflower, dex2jar, apktool, adb
#
# Exit codes:
# 0 — installed successfully
# 1 — installation failed
# 2 — requires manual action (e.g. sudo needed but not available)
set -euo pipefail
usage() {
cat <<EOF
Usage: install-dep.sh <dependency>
Install a dependency required for Android reverse engineering.
Available dependencies:
java Java JDK 17+
jadx jadx decompiler
vineflower Vineflower (Fernflower fork) decompiler
dex2jar DEX to JAR converter
apktool Android resource decoder
adb Android Debug Bridge
The script detects your OS and package manager, then:
- Installs directly if possible (brew, or user-local install)
- Uses sudo if available and needed
- Prints manual instructions if neither option works
EOF
exit 0
}
if [[ $# -lt 1 || "$1" == "-h" || "$1" == "--help" ]]; then
usage
fi
DEP="$1"
# --- Detect environment ---
OS="unknown"
PKG_MANAGER="none"
HAS_SUDO=false
ARCH=$(uname -m)
case "$(uname -s)" in
Linux) OS="linux" ;;
Darwin) OS="macos" ;;
esac
# Detect package manager
if command -v brew &>/dev/null; then
PKG_MANAGER="brew"
elif command -v apt-get &>/dev/null; then
PKG_MANAGER="apt"
elif command -v dnf &>/dev/null; then
PKG_MANAGER="dnf"
elif command -v pacman &>/dev/null; then
PKG_MANAGER="pacman"
fi
# Check sudo availability
if command -v sudo &>/dev/null; then
if sudo -n true 2>/dev/null; then
HAS_SUDO=true
else
# sudo exists but may need password — we'll try it and let it prompt
HAS_SUDO=true
fi
fi
info() { echo "[INFO] $*"; }
ok() { echo "[OK] $*"; }
fail() { echo "[FAIL] $*" >&2; }
manual() {
echo "[MANUAL] $*" >&2
echo " Cannot install automatically. Please install manually and retry." >&2
exit 2
}
# --- Helper: install via system package manager (needs sudo on Linux) ---
pkg_install() {
local pkg="$1"
case "$PKG_MANAGER" in
brew)
info "Installing $pkg via Homebrew..."
brew install "$pkg"
;;
apt)
if [[ "$HAS_SUDO" == true ]]; then
info "Installing $pkg via apt..."
sudo apt-get update -qq && sudo apt-get install -y -qq "$pkg"
else
manual "Run: sudo apt-get install $pkg"
fi
;;
dnf)
if [[ "$HAS_SUDO" == true ]]; then
info "Installing $pkg via dnf..."
sudo dnf install -y "$pkg"
else
manual "Run: sudo dnf install $pkg"
fi
;;
pacman)
if [[ "$HAS_SUDO" == true ]]; then
info "Installing $pkg via pacman..."
sudo pacman -S --noconfirm "$pkg"
else
manual "Run: sudo pacman -S $pkg"
fi
;;
*)
manual "No supported package manager found. Install $pkg manually."
;;
esac
}
# --- Helper: download a file ---
download() {
local url="$1" dest="$2"
if command -v curl &>/dev/null; then
curl -fsSL -o "$dest" "$url"
elif command -v wget &>/dev/null; then
wget -q -O "$dest" "$url"
else
fail "Neither curl nor wget available."
return 1
fi
}
# --- Helper: get latest GitHub release tag ---
gh_latest_tag() {
local repo="$1"
local url="https://api.github.com/repos/$repo/releases/latest"
if command -v curl &>/dev/null; then
curl -fsSL "$url" | grep '"tag_name"' | head -1 | sed 's/.*"tag_name":[[:space:]]*"\([^"]*\)".*/\1/'
elif command -v wget &>/dev/null; then
wget -q -O - "$url" | grep '"tag_name"' | head -1 | sed 's/.*"tag_name":[[:space:]]*"\([^"]*\)".*/\1/'
fi
}
# --- Helper: add a line to shell profile if not already present ---
add_to_profile() {
local line="$1"
local profile=""
if [[ -f "$HOME/.zshrc" ]]; then
profile="$HOME/.zshrc"
elif [[ -f "$HOME/.bashrc" ]]; then
profile="$HOME/.bashrc"
elif [[ -f "$HOME/.profile" ]]; then
profile="$HOME/.profile"
fi
if [[ -n "$profile" ]]; then
if ! grep -qF "$line" "$profile" 2>/dev/null; then
echo "$line" >> "$profile"
info "Added to $profile: $line"
info "Run 'source $profile' or start a new shell to apply."
fi
else
info "Add this to your shell profile: $line"
fi
}
# =====================================================================
# Dependency installers
# =====================================================================
install_java() {
if command -v java &>/dev/null; then
local ver
ver=$(java -version 2>&1 | head -1 | sed -n 's/.*"\([0-9]*\)\..*/\1/p')
if [[ -n "$ver" ]] && (( ver >= 17 )); then
ok "Java $ver already installed"
return 0
fi
fi
info "Installing Java JDK 17+..."
case "$PKG_MANAGER" in
brew) brew install openjdk@17 ;;
apt) pkg_install "openjdk-17-jdk" ;;
dnf) pkg_install "java-17-openjdk-devel" ;;
pacman) pkg_install "jdk17-openjdk" ;;
*) manual "Install Java JDK 17+ from https://adoptium.net/" ;;
esac
# Verify
if command -v java &>/dev/null; then
ok "Java installed: $(java -version 2>&1 | head -1)"
else
fail "Java installation may require PATH update."
if [[ "$PKG_MANAGER" == "brew" ]]; then
add_to_profile 'export PATH="/opt/homebrew/opt/openjdk@17/bin:$PATH"'
fi
exit 1
fi
}
install_jadx() {
if command -v jadx &>/dev/null; then
ok "jadx already installed: $(jadx --version 2>/dev/null || echo 'unknown')"
return 0
fi
# Try brew first (cleanest)
if [[ "$PKG_MANAGER" == "brew" ]]; then
info "Installing jadx via Homebrew..."
brew install jadx
ok "jadx installed via Homebrew"
return 0
fi
# User-local install from GitHub releases (no sudo needed)
info "Installing jadx from GitHub releases..."
local tag
tag=$(gh_latest_tag "skylot/jadx")
if [[ -z "$tag" ]]; then
fail "Could not determine latest jadx version."
manual "Download from https://github.com/skylot/jadx/releases/latest"
fi
local version="${tag#v}"
local url="https://github.com/skylot/jadx/releases/download/${tag}/jadx-${version}.zip"
local tmp_zip
tmp_zip=$(mktemp /tmp/jadx-XXXXXX.zip)
info "Downloading jadx $version..."
download "$url" "$tmp_zip"
local install_dir="$HOME/.local/share/jadx"
rm -rf "$install_dir"
mkdir -p "$install_dir"
unzip -qo "$tmp_zip" -d "$install_dir"
rm -f "$tmp_zip"
chmod +x "$install_dir/bin/jadx" "$install_dir/bin/jadx-gui" 2>/dev/null || true
# Add to PATH
mkdir -p "$HOME/.local/bin"
ln -sf "$install_dir/bin/jadx" "$HOME/.local/bin/jadx"
ln -sf "$install_dir/bin/jadx-gui" "$HOME/.local/bin/jadx-gui"
export PATH="$HOME/.local/bin:$PATH"
add_to_profile 'export PATH="$HOME/.local/bin:$PATH"'
if command -v jadx &>/dev/null; then
ok "jadx $version installed to $install_dir"
else
ok "jadx $version installed to $install_dir"
info "Run: export PATH=\"\$HOME/.local/bin:\$PATH\" to use it now"
fi
}
install_vineflower() {
# Check if already available
if command -v vineflower &>/dev/null || command -v fernflower &>/dev/null; then
ok "Vineflower/Fernflower CLI already installed"
return 0
fi
for candidate in \
"${FERNFLOWER_JAR_PATH:-}" \
"$HOME/vineflower/vineflower.jar" \
"$HOME/fernflower/fernflower.jar" \
"$HOME/fernflower/build/libs/fernflower.jar" \
"$HOME/vineflower/build/libs/vineflower.jar"; do
if [[ -n "$candidate" ]] && [[ -f "$candidate" ]]; then
ok "Vineflower/Fernflower JAR already exists: $candidate"
return 0
fi
done
# Try brew
if [[ "$PKG_MANAGER" == "brew" ]]; then
info "Installing vineflower via Homebrew..."
if brew install vineflower 2>/dev/null; then
ok "Vineflower installed via Homebrew"
return 0
fi
info "Homebrew formula not available, falling back to direct download."
fi
# Download JAR from GitHub releases (no sudo needed)
info "Installing Vineflower from GitHub releases..."
local tag
tag=$(gh_latest_tag "Vineflower/vineflower")
if [[ -z "$tag" ]]; then
fail "Could not determine latest Vineflower version."
manual "Download from https://github.com/Vineflower/vineflower/releases/latest"
fi
local version="${tag#v}"
local url="https://github.com/Vineflower/vineflower/releases/download/${tag}/vineflower-${version}.jar"
local install_dir="$HOME/.local/share/vineflower"
mkdir -p "$install_dir"
info "Downloading Vineflower $version..."
download "$url" "$install_dir/vineflower.jar"
# Create wrapper script
mkdir -p "$HOME/.local/bin"
cat > "$HOME/.local/bin/vineflower" <<'WRAPPER'
#!/usr/bin/env bash
exec java -jar "$HOME/.local/share/vineflower/vineflower.jar" "$@"
WRAPPER
chmod +x "$HOME/.local/bin/vineflower"
export PATH="$HOME/.local/bin:$PATH"
export FERNFLOWER_JAR_PATH="$install_dir/vineflower.jar"
add_to_profile 'export PATH="$HOME/.local/bin:$PATH"'
add_to_profile "export FERNFLOWER_JAR_PATH=\"$install_dir/vineflower.jar\""
ok "Vineflower $version installed to $install_dir/vineflower.jar"
info "FERNFLOWER_JAR_PATH set to $install_dir/vineflower.jar"
}
install_dex2jar() {
if command -v d2j-dex2jar &>/dev/null || command -v d2j-dex2jar.sh &>/dev/null; then
ok "dex2jar already installed"
return 0
fi
# Try brew
if [[ "$PKG_MANAGER" == "brew" ]]; then
info "Installing dex2jar via Homebrew..."
if brew install dex2jar 2>/dev/null; then
ok "dex2jar installed via Homebrew"
return 0
fi
info "Homebrew formula not available, falling back to direct download."
fi
# Download from GitHub (no sudo needed)
info "Installing dex2jar from GitHub releases..."
local tag
tag=$(gh_latest_tag "ThexXTURBOXx/dex2jar")
if [[ -z "$tag" ]]; then
# Fallback to a known maintained release if GitHub metadata is unavailable.
tag="2.4.35"
fi
local version="${tag#v}"
local url="https://github.com/ThexXTURBOXx/dex2jar/releases/download/${tag}/dex-tools-${version}.zip"
local tmp_zip
tmp_zip=$(mktemp /tmp/dex2jar-XXXXXX.zip)
info "Downloading dex2jar $version..."
if ! download "$url" "$tmp_zip"; then
# Try alternate naming
url="https://github.com/ThexXTURBOXx/dex2jar/releases/download/${tag}/dex-tools-v${version}.zip"
download "$url" "$tmp_zip" || {
fail "Download failed."
manual "Download from https://github.com/ThexXTURBOXx/dex2jar/releases/latest"
}
fi
local install_dir="$HOME/.local/share/dex2jar"
rm -rf "$install_dir"
mkdir -p "$install_dir"
unzip -qo "$tmp_zip" -d "$install_dir"
rm -f "$tmp_zip"
# The zip may contain a top-level directory — find the actual bin location
local bin_dir=""
if [[ -f "$install_dir/d2j-dex2jar.sh" ]]; then
bin_dir="$install_dir"
else
bin_dir=$(find "$install_dir" -name "d2j-dex2jar.sh" -exec dirname {} \; | head -1)
fi
if [[ -z "$bin_dir" ]]; then
fail "Could not find d2j-dex2jar.sh in extracted archive."
manual "Download and extract manually from https://github.com/ThexXTURBOXx/dex2jar/releases"
fi
chmod +x "$bin_dir"/*.sh 2>/dev/null || true
mkdir -p "$HOME/.local/bin"
for script in "$bin_dir"/d2j-*.sh; do
local name
name=$(basename "$script" .sh)
ln -sf "$script" "$HOME/.local/bin/$name"
done
export PATH="$HOME/.local/bin:$PATH"
add_to_profile 'export PATH="$HOME/.local/bin:$PATH"'
ok "dex2jar $version installed to $install_dir"
}
install_apktool() {
if command -v apktool &>/dev/null; then
ok "apktool already installed"
return 0
fi
case "$PKG_MANAGER" in
brew) info "Installing apktool via Homebrew..."; brew install apktool ;;
apt) pkg_install "apktool" ;;
*) manual "Install apktool from https://apktool.org/docs/install" ;;
esac
if command -v apktool &>/dev/null; then
ok "apktool installed"
else
fail "apktool installation may have failed."
exit 1
fi
}
install_adb() {
if command -v adb &>/dev/null; then
ok "adb already installed"
return 0
fi
case "$PKG_MANAGER" in
brew) info "Installing adb via Homebrew..."; brew install android-platform-tools ;;
apt) pkg_install "adb" ;;
dnf) pkg_install "android-tools" ;;
pacman) pkg_install "android-tools" ;;
*) manual "Install Android SDK Platform Tools from https://developer.android.com/tools/releases/platform-tools" ;;
esac
if command -v adb &>/dev/null; then
ok "adb installed"
else
fail "adb installation may have failed."
exit 1
fi
}
# =====================================================================
# Dispatch
# =====================================================================
case "$DEP" in
java) install_java ;;
jadx) install_jadx ;;
vineflower|fernflower) install_vineflower ;;
dex2jar) install_dex2jar ;;
apktool) install_apktool ;;
adb) install_adb ;;
*)
echo "Error: Unknown dependency '$DEP'" >&2
echo "Available: java, jadx, vineflower, dex2jar, apktool, adb" >&2
exit 1
;;
esac
@@ -0,0 +1,85 @@
#!/usr/bin/env bash
# lookup-name.sh — Query the mapping produced by recover-kotlin-names.sh.
#
# Modes:
# lookup-name.sh <mapping-dir> <substring> search by real-FQN substring
# lookup-name.sh <mapping-dir> -o <obf> resolve obf -> real
# lookup-name.sh <mapping-dir> -p <pkg> list a real package
# lookup-name.sh <mapping-dir> --grep <regex> <sources-dir>
# grep decompiled sources and annotate each hit with the real class name
set -euo pipefail
usage() {
cat <<EOF
Usage: lookup-name.sh <mapping-dir> <query>
lookup-name.sh <mapping-dir> -o <obf-fqn>
lookup-name.sh <mapping-dir> -p <real-package-substring>
lookup-name.sh <mapping-dir> --grep <regex> <sources-dir>
<mapping-dir> is the directory produced by recover-kotlin-names.sh
(must contain mapping.json).
EOF
exit 0
}
[[ $# -lt 2 ]] && usage
DIR="$1"; shift
[[ ! -f "$DIR/mapping.json" ]] && { echo "no mapping.json in $DIR" >&2; exit 1; }
python3 - "$DIR" "$@" <<'PY'
import json, os, re, sys, subprocess
DIR = sys.argv[1]
args = sys.argv[2:]
MAP = json.load(open(os.path.join(DIR, "mapping.json")))
REV = {}
for o, r in MAP.items():
REV.setdefault(r, []).append(o)
def search(q):
ql = q.lower()
for r in sorted(REV):
if ql in r.lower():
print(r)
for o in sorted(REV[r]):
print(f" {o}")
def by_obf(o):
if o not in MAP:
print(f"no mapping for {o}", file=sys.stderr); sys.exit(1)
print(f"{o} -> {MAP[o]}")
sibs = [s for s in REV[MAP[o]] if s != o]
for s in sorted(sibs):
print(f" sibling: {s}")
def by_pkg(p):
pl = p.lower()
for r in sorted(REV):
if pl in r.rsplit(".", 1)[0].lower():
print(r)
for o in sorted(REV[r]):
print(f" {o}")
def grep_annot(pattern, sources):
res = subprocess.run(
["grep", "-rEn", "--include=*.java", pattern, sources],
capture_output=True, text=True)
for line in res.stdout.splitlines():
try:
path, lineno, content = line.split(":", 2)
except ValueError:
continue
rel = os.path.relpath(path, sources)
obf = rel.replace(os.sep, ".")[:-5]
suffix = f" // {MAP[obf]}" if obf in MAP else ""
print(f"{rel}:{lineno}:{content}{suffix}")
if args[0] == "-o" and len(args) == 2:
by_obf(args[1])
elif args[0] == "-p" and len(args) == 2:
by_pkg(args[1])
elif args[0] == "--grep" and len(args) == 3:
grep_annot(args[1], args[2])
else:
search(" ".join(args))
PY
@@ -0,0 +1,140 @@
#!/usr/bin/env bash
# recover-kotlin-names.sh — Rebuild a (obfuscated -> real) class-name map
# from Kotlin metadata strings left in decompiled sources.
#
# R8 obfuscates JVM symbols but cannot strip the Kotlin metadata strings —
# the Kotlin runtime (reflection, coroutines) needs them at runtime. Two
# annotations carry the original FQN:
#
# * @DebugMetadata(c = "<full.qualified.Name>", f = "<File.kt>", ...)
# emitted for almost every `suspend` function (every coroutine
# SuspendLambda).
#
# * @Metadata(... d2 = {"...L<pkg/Class>;..."} ...) listing internal
# class refs of the file.
#
# Typical recovery on a real-world app: 30-50 % of classes regain their real
# names — usually 100 % of the *Repository / *ViewModel / *UseCase / *Impl
# classes you actually want to read.
set -euo pipefail
usage() {
cat <<EOF
Usage: recover-kotlin-names.sh <decompiled-sources-dir> [output-dir]
Walks every *.java under <decompiled-sources-dir>, mines @DebugMetadata
and @Metadata annotations, and writes:
<output-dir>/mapping.tsv tab-separated obf_fqn <TAB> real_fqn <TAB> file
<output-dir>/mapping.json same data as JSON { obf_fqn: real_fqn, ... }
<output-dir>/by_package/ one file per real package, listing
real_fqn <TAB> obf_fqn <TAB> file
If [output-dir] is omitted, files are written next to the sources dir.
EOF
exit 0
}
[[ $# -lt 1 || "$1" == "-h" || "$1" == "--help" ]] && usage
SRC="$1"
OUT="${2:-$(dirname "$SRC")/mapping}"
[[ ! -d "$SRC" ]] && { echo "not a directory: $SRC" >&2; exit 1; }
mkdir -p "$OUT/by_package"
python3 - "$SRC" "$OUT" <<'PY'
import os, re, sys, json
from collections import defaultdict
SRC, OUT = sys.argv[1], sys.argv[2]
# @DebugMetadata(c = "com.foo.Bar$Inner$1", ...)
RE_DEBUG = re.compile(r'@DebugMetadata\([^)]*?c\s*=\s*"([^"]+)"', re.S)
# @Metadata(... d2 = { "...Lcom/foo/Bar;..." ...} )
RE_DTWO = re.compile(r'@Metadata\([^)]*?d2\s*=\s*\{([^}]*)\}', re.S)
RE_LCLASS = re.compile(r'L([A-Za-z][\w/$]+);')
# jadx sometimes emits this comment for renamed classes
RE_RENAMED = re.compile(r'/\*\s*renamed from:\s*([\w.$]+)\s*\*/')
# Skip third-party / framework trees — their names are already real.
SKIP_PREFIXES = (
"kotlin.", "kotlinx.", "androidx.", "android.", "java.", "javax.",
"com.google.", "com.facebook.", "com.appsflyer.", "com.datadog.",
"io.ktor.", "io.sentry.", "io.realm.", "okhttp3.", "okio.",
"com.squareup.", "com.bumptech.", "com.airbnb.", "com.payu.",
"com.storyteller.", "zendesk.", "io.intercom.", "com.microsoft.",
"com.tinder.", "com.hotjar.", "com.amplitude.", "com.segment.",
"com.mixpanel.", "com.onesignal.", "com.stripe.", "com.braintreepayments.",
"retrofit2.", "dagger.", "javax.inject.", "org.jetbrains.",
)
mapping = {}
file_real = {}
counts = defaultdict(int)
for dp, _, files in os.walk(SRC):
for f in files:
if not f.endswith(".java"):
continue
path = os.path.join(dp, f)
rel = os.path.relpath(path, SRC)
obf = rel[:-5].replace(os.sep, ".")
if obf.startswith(SKIP_PREFIXES):
continue
try:
text = open(path, "r", errors="replace").read()
except OSError:
continue
real = None
m = RE_DEBUG.search(text)
if m:
real = m.group(1).split("$", 1)[0]
counts["debug_meta"] += 1
if not real:
m = RE_DTWO.search(text)
if m:
for lm in RE_LCLASS.finditer(m.group(1)):
cand = lm.group(1).replace("/", ".").split("$", 1)[0]
if "." in cand and not cand.startswith(("kotlin.", "java.", "android")):
real = cand
counts["d2"] += 1
break
if not real:
m = RE_RENAMED.search(text)
if m:
real = m.group(1)
counts["renamed"] += 1
if real:
mapping[obf] = real
file_real[obf] = path
with open(os.path.join(OUT, "mapping.tsv"), "w") as f:
f.write("obf_fqn\treal_fqn\tfile\n")
for k in sorted(mapping):
f.write(f"{k}\t{mapping[k]}\t{file_real[k]}\n")
with open(os.path.join(OUT, "mapping.json"), "w") as f:
json.dump(mapping, f, indent=2, sort_keys=True)
by_pkg = defaultdict(list)
for obf, real in mapping.items():
pkg = real.rsplit(".", 1)[0] if "." in real else "(default)"
by_pkg[pkg].append((real, obf, file_real[obf]))
for pkg, rows in by_pkg.items():
safe = os.path.basename(pkg).replace(".", "_") or "default"
with open(os.path.join(OUT, "by_package", f"{safe}.txt"), "w") as f:
for real, obf, p in sorted(rows):
f.write(f"{real}\t{obf}\t{p}\n")
print(f"Recovered {len(mapping)} class names")
for k, v in counts.items():
print(f" via {k}: {v}")
print(f"Real packages: {len(by_pkg)}")
print(f"Wrote {OUT}/mapping.tsv, mapping.json, by_package/")
PY