Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.76 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.76 KB

Alpakka

Alpakka is a LARA Framework source-to-source compiler for Android's smali syntax. It enables the analysis and transformation of Android apps through APK files.

The name "Alpakka" derives from the Icelandic word for package, "Pakka", reflecting its core functionality in handling Android Packages (APKs).

Installing

To install Alpakka, follow these steps:

  1. Clone the repositories for Alpakka, the LARA Framework and Specs Java Libs to the root of your workspace.

  2. Since the LARA Framework and Alpakka are not yet being distributed as npm packages, if you want to use them with Node.js, you'll need to create a package.json file at the root of your workspace with the following contents:

{
  "type": "module",
  "workspaces": [
    "lara-framework/Lara-JS",
    "alpakka/Alpakka-JS",
  ]
}
  1. Run the following commands at the root of your workspace to install dependencies and build the projects:
npm install
cd lara-framework/Lara-JS
npm run build
cd ../../alpakka/AlpakkaWeaver
gradle installDist
mv build/install/AlpakkaWeaver/lib/* ../Alpakka-JS/java-binaries/
cd ../../alpakka/Alpakka-JS
npm install
npm run build

Running Alpakka-JS

To execute Alpakka-JS, use the following command:

npx alpakka-js <scriptToRun.js> -- smali <input file>

Replace <scriptToRun.js> with your JavaScript file and <input file> with the input APK or smali files you want to analyze.

Alpakka-JS comes with a built-in script to detect and correct resource leaks in Android apps. You can try it by specifying ./scripts/DetectAndCorrectLeaks.js as the script to run.