MCPcopy Index your code
hub / github.com/asLody/SandHook

github.com/asLody/SandHook @3.4.6

Chat with this repo
repository ↗ · DeepWiki ↗ · release 3.4.6 ↗ · + Follow
1,829 symbols 4,309 edges 153 files 738 documented · 40%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

SandHook

Android ART Hook

Version

Version

Chinese

中文文档以及实现

中文 Blog

arch support

  • ARM64
  • ARM32(no tested)
  • Thumb-2

OS

4.4(ART Runtime) - 10.0

Scope

  • Object Methods
  • Static Methods
  • Constructors
  • System Methods
  • JNI Methods

hook abstract method is not recommended, you can invoke its impl method.

cant hook if lined

how to use

implementation 'com.swift.sandhook:hooklib:3.1.0'

Annotation API


  • hook method must be a static method
  • first par must be this if method is not static
  • method description must "same"(can be isAssignableFrom) with origin method
  • backup method same with above
@HookClass(Activity.class)
//@HookReflectClass("android.app.Activity")
public class ActivityHooker {

    @HookMethodBackup("onCreate")
    @MethodParams(Bundle.class)
    static Method onCreateBackup;

    @HookMethodBackup("onPause")
    static HookWrapper.HookEntity onPauseBackup;

    @HookMethod("onCreate")
    @MethodParams(Bundle.class)
    public static void onCreate(Activity thiz, Bundle bundle) throws Throwable {
        Log.e("ActivityHooker", "hooked onCreate success " + thiz);
        SandHook.callOriginByBackup(onCreateBackup, thiz, bundle);
    }

    @HookMethod("onPause")
    public static void onPause(@ThisObject Activity thiz) throws Throwable {
        Log.e("ActivityHooker", "hooked onPause success " + thiz);
        onPauseBackup.callOrigin(thiz);
    }

}



//or like this:

@HookClass(TestClass.class)
public class NewAnnotationApiHooker {

    @HookMethod("testNewHookApi")
    public static void onTestNewHookApi(@ThisObject TestClass thiz, @Param("com.swift.sandhook.MainActivity") Activity activity, int a) {
        Log.e("TestClassHook", "testNewHookApi been hooked");
        onTestNewHookApiBackup(thiz, activity, a);
    }

    @HookMethodBackup("testNewHookApi")
    public static void onTestNewHookApiBackup(@ThisObject TestClass thiz, @Param("com.swift.sandhook.MainActivity") Activity activity, int a) {
        onTestNewHookApiBackup(thiz, activity, a);
    }

}



//first set debuggable
SandHookConfig.DEBUG = BuildConfig.DEBUG;

and

//add hookers
SandHook.addHookClass(CtrHook.class, LogHooker.class, CustmizeHooker.class, ActivityHooker.class, ObjectHooker.class);

you can also use:
SanHook.public static boolean hook(Member target, Method hook, Method backup) {}

if hookers is in plugin(like xposed):

provided 'com.swift.sandhook:hookannotation:3.1.0'

in your plugin

if OS <= 5.1 backup method can call itself to avoid be inlining

Xposed API


Now you can use Xposed api:

implementation 'com.swift.sandhook:xposedcompat:3.1.0'
//setup for xposed
XposedCompat.cacheDir = getCacheDir();
XposedCompat.context = this;
XposedCompat.classLoader = getClassLoader();
XposedCompat.isFirstApplication= true;  
//do hook
XposedHelpers.findAndHookMethod(Activity.class, "onResume", new XC_MethodHook() {
      @Override
      protected void beforeHookedMethod(MethodHookParam param) throws Throwable {
          super.beforeHookedMethod(param);
          Log.e("XposedCompat", "beforeHookedMethod: " + param.method.getName());
      }

      @Override
      protected void afterHookedMethod(MethodHookParam param) throws Throwable {
          super.afterHookedMethod(param);
          Log.e("XposedCompat", "afterHookedMethod: " + param.method.getName());
      }
});

Notice

Call Origin

!!!!!!!!

when OS >= 8.0 you must call backup method in hook method, if you want call it in other method, please call SandHook.compileMethod(otherMethod) before call backup method.

because when ART trigger JIT from profiling, JIT will invoke -> ResolveCompilingMethodsClass -> ClassLinker::ResolveMethod -> CheckIncompatibleClassChange -> ThrowIncompatibleClassChangeError finally!!!

Inline

disable JIT inline

We can do nothing to prevent some methods been inlined before app start, but we can try to disable VM Jit Inline after launch.

if you will hook some method that could be inlined, please call SandHook.disableVMInline()(OS >= 7.0) in Application.OnCreate()

Deoptimize

You can also deoptimize a caller that inlined your hook method by SandHook.deCompile(caller), just implement >= 7.0

Hidden API

SandHook.passApiCheck();

To bypass hidden api on P & Q

Demo

SandVXPosed

non-Root Xposed Environment Demo (VirtualApp with SandHook):

https://github.com/ganyao114/SandVXposed

EdXposed(SandHook Brunch)

Unofficial xposed framework >= 8.0

See release above

https://github.com/ElderDrivers/EdXposed/tree/sandhook

Android Q(10.0)

in MyApp.java

//if you want test Android Q, please set true, because SDK_INT of Android Q is still 28 public final static boolean testAndroidQ = false;

References

  • Epic:https://github.com/tiann/epic
  • Yahfa:https://github.com/rk700/YAHFA

Extension points exported contracts — how you extend this code

Builder (Interface)
The Builder interface is designed to designate a class as a builder object in the Builder design pattern. B [5 implementers]
xposedcompat/src/main/java/external/org/apache/commons/lang3/builder/Builder.java
Inter (Interface)
(no doc) [3 implementers]
app/src/main/java/com/swift/sandhook/test/Inter.java
LibLoader (Interface)
(no doc) [1 implementers]
hooklib/src/main/java/com/swift/sandhook/SandHookConfig.java
CallOriginCallBack (Interface)
(no doc) [4 implementers]
xposedcompat/src/main/java/com/swift/sandhook/xposedcompat/hookstub/CallOriginCallBack.java
HookModeCallBack (Interface)
(no doc)
hooklib/src/main/java/com/swift/sandhook/SandHook.java
HookMaker (Interface)
(no doc) [4 implementers]
xposedcompat/src/main/java/com/swift/sandhook/xposedcompat/methodgen/HookMaker.java
HookResultCallBack (Interface)
(no doc)
hooklib/src/main/java/com/swift/sandhook/SandHook.java
IXposedHookInitPackageResources (Interface)
Get notified when the resources for an app are initialized. In #handleInitPackageResources, resource replacement [2 implementers]
xposedcompat/src/main/java/de/robv/android/xposed/IXposedHookInitPackageResources.java

Core symbols most depended-on inside this repo

getMethodId
called by 484
xposedcompat/src/main/java/com/swift/sandhook/xposedcompat/hookstub/HookStubManager.java
hookBridge
called by 483
xposedcompat/src/main/java/com/swift/sandhook/xposedcompat/hookstub/HookStubManager.java
length
called by 174
xposedcompat/src/main/java/external/org/apache/commons/lang3/StringUtils.java
get
called by 165
xposedcompat/src/main/java/com/android/dx/TypeId.java
getClass
called by 92
xposedcompat/src/main/java/external/org/apache/commons/lang3/ClassUtils.java
getName
called by 84
xposedcompat/src/main/java/com/android/dx/TypeId.java
newLocal
called by 77
xposedcompat/src/main/java/com/android/dx/Code.java
append
called by 75
xposedcompat/src/main/java/external/org/apache/commons/lang3/builder/EqualsBuilder.java

Shape

Method 1,574
Class 166
Function 65
Interface 15
Enum 9

Languages

Java86%
C++13%
Python1%

Modules by API surface

hooklib/src/main/java/com/swift/sandhook/wrapper/BackupMethodStubs.java303 symbols
xposedcompat/src/main/java/external/org/apache/commons/lang3/StringUtils.java109 symbols
xposedcompat/src/main/java/de/robv/android/xposed/XposedHelpers.java85 symbols
xposedcompat/src/main/java/external/org/apache/commons/lang3/builder/ToStringStyle.java83 symbols
xposedcompat/src/main/java/com/swift/sandhook/xposedcompat/hookstub/MethodHookerStubs64.java51 symbols
xposedcompat/src/main/java/com/android/dx/Code.java51 symbols
xposedcompat/src/main/java/com/android/dx/stock/ProxyBuilder.java45 symbols
hooklib/src/main/java/com/swift/sandhook/SandHook.java40 symbols
xposedcompat/src/main/java/com/swift/sandhook/xposedcompat/hookstub/MethodHookerStubs32.java31 symbols
xposedcompat/src/main/java/external/org/apache/commons/lang3/ArrayUtils.java29 symbols
hooklib/src/main/cpp/art/art_method.cpp28 symbols
xposedcompat/src/main/java/com/android/dx/DexMaker.java26 symbols

For agents

$ claude mcp add SandHook \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact