Soot Tutorial

This repository contains (will contain) several simple examples of static program analysis in Java using Soot.

Who this tutorial is for?

Anybody who knows Java programming and wants to do some static analysis in practice but does not know anything about Soot and static analysis in theory.

If you have some prior knowledge about static program analysis I suggest you learn Soot from here.

Why another tutorial for Soot?

Setup

In short, use Java 8 and run ./gradlew build. For more information and Docker setup, follow this link.

Chapters

1: Get your hands dirty

In this chapter, you will visit a very simple code example to be familiar with Soot essential data structures and Jimple, Soot's principle intermediate representation.

./gradlew run --args="HelloSoot": The Jimple representation of the printFizzBuzz method alongside the branch statement.
./gradlew run --args="HelloSoot draw": The visualization of the printFizzBuzz control-flow graph.

Title	Tutorial	Soot Code	Example Input
Hello Soot	Doc	HelloSoot.java	FizzBuzz.java

2: Know the basic APIs

In this chapter, you get familiar with some basic but useful methods in Soot to help read, analyze, and even update java code.

./gradlew run --args="BasicAPI": Analyze the class Circle.
./gradlew run --args="BasicAPI draw": Analyze the class Circle and draws the call graph.

Title	Tutorial	Soot Code	Example Input
Basic API	Doc	BasicAPI.java	Circle

3: Android Instrumentation

In this chapter, you learn how to insert code into Android apps (without having their source code) using Soot. To run the code, you need Android SDK (check this link).

./gradlew run --args="AndroidLogger": Insert logging method calls at the beginning of APK methods of Numix Calculator.
./gradlew run --args="AndroidClassInjector": Create a new class from scratch and inject it to the Numix Calculator.

The instrumented APK is located in demo/Android/Instrumented. You need to sign it in order to install on an Android device:

cd ./demo/Android
# on Windows, replace 'sign.sh' by 'sign.ps1'
./sign.sh Instrumented/calc.apk key "android"
adb install -r -t Instrumented/calc.apk

To see the logs, run adb logcat | grep -e "<SOOT_TUTORIAL>"

Title	Tutorial	Soot Code	Example APK
Log method calls in an APK	Doc	AndroidLogger.java	Numix Calculator (from F-Droid)
Create and inject a class into an APK	Doc	AndroidClassInjector.java	Numix Calculator (from F-Droid)

4: Call graphs and PointsTo Analysis in Android

This chapter gives you a brief overview o call graphs and PointsTo analysis in Android and you learn how to create calls graphs using FlowDroid. The source code of the example code is here. To run the code, you need Android SDK (check this link).

./gradlew run --args="AndroidCallGraph <CG_Algorithm> (draw)": Create the call graph of SootTutorial Demo App using <CG_Algorithm> algorithm and print information such as reachable methods or the number of edges.
- <CG_Algorithm> can be SPARK or CHA
- draw argument is optional, if provided a visualization of call graph will shown.
- For example, ./gradlew run --args="AndroidCallGraph SPARK draw" visualizes the call graph generated by SPARK algorithm.
./gradlew run --args="AndroidPTA": Perform PointsTo and Alias Analysis on SootTutorial Demo App using FlowDroid.

Title	Tutorial	Soot Code	Example APK
Call graphs in Android	Doc	AndroidCallgraph.java	SootTutorial Demo App (source code)
PointsTo Analysis in Android	Doc	AndroidPointsToAnalysis.java	SootTutorial Demo App (source code)

5: Some Real Static Analysis (:construction: WIP)

./gradlew run --args="UsageFinder 'void println(java.lang.String)' 'java.io.PrintStream": Find usages of the method with the given subsignature in all methods of UsageExample.java.
./gradlew run --args="UsageFinder 'void println(java.lang.String)' 'java.io.PrintStream": Find usages of the method with the given subsignature of the given class signature in all methods of UsageExample.java.

Title	Tutorial	Soot Code	Example Input
Find usages of a method		UsageFinder.java	UsageExample.java
Null Pointer Analysis		NullPointerAnalysis	NullPointerExample.java

6: Interprocedural analysis (:construction: WIP)

Title	Tutorial	Soot Code	Example Input

noidsirius/SootTutorial