Summarize the features we would like Shuriken-Analyzer to provide to build a Quark core library

[haeter525]

To build a Quark core library based on Shuriken-Analyzer, we need Shuriken-Analyzer to provide the following features.

For each feature in the following, we give a quick example with the API name, inputs, and outputs. However, we are pleased to discuss the final design with Shuriken-Analyzer.

1. List all methods used in the DEX/APK file.

   • Input:
     • The path to the DEX/APK file
   • Output:
     • A Python list of all methods used in the DEX/APK file
   • Example:

     pathToDex = "classes.dex"
     
     result = getMethods(pathToDex)
     
     # result = ['Ljava/io/File;->getName()Ljava/lang/String;']

2. Determine if the method is an Android API.

   • Input:
     • A method
   • Output:
     • A boolean value indicating if the method is an Android API
   • Example:

     method = "Ljava/io/File;->getName()Ljava/lang/String;"
     
     result = isAndroidAPI(method)
     
     # result = True

3. Determine if the method is defined in the DEX/APK file.

   • Input:
     • The path to the DEX/APK file
     • A method
   • Output:
     • A boolean value indicating if the method is defined in the DEX/APK file
   • Example:

     pathToDex = "classes.dex"
     method = "Ljava/io/File;->getName()Ljava/lang/String;"
     
     result = isDefindedInDex(pathToDex, method)
     
     # result = False

4. Find all matching methods in the DEX/APK file by regex strings for class name, method name, and descriptor.

   • Input:
     • The path to the DEX/APK file
     • A regex string for the class name
     • A regex string for the method name
     • A regex string for the descriptor
   • Output:
     • A Python list of all methods matching the regex strings in the DEX/APK file
   • Example:

     pathToDex = "classes.dex"
     className = "File"
     methodName = "getName"
     descriptor = ".*String;"
     
     result = findMethods(pathToDex, className, methodName, descriptor)
     
     # result = ['Ljava/io/File;->getName()Ljava/lang/String;']

5. List all methods called by the specified method in the DEX/APK file.

   • Input:
     • The path to the DEX/APK file
     • A method
   • Output:
     • A Python list of all methods called by the specified method in the DEX/APK file
   • Example:

     pathToDex = "classes.dex"
     method = "Lcom/vuldroid/application/ForgetPassword; onCreate (Landroid/os/Bundle;)V"
     
     result = xrefTo(pathToDex, method)
     
     # result = ['Ljava/io/File;->getName()Ljava/lang/String;']

6. List all methods that call the specified method in the DEX/APK file.

   • Input:
     • The path to the DEX/APK file
     • A method
   • Output:
     • A Python list of all methods that call the specified method in the DEX/APK file
   • Example:

     pathToDex = "classes.dex"
     method = "Ljava/io/File;->getName()Ljava/lang/String;"
     
     result = xrefFrom(pathToDex, method)
     
     # result = ['Lcom/vuldroid/application/ForgetPassword; onCreate (Landroid/os/Bundle;)V']

7. Get the smali code of the specified method in the DEX/APK file.

   • Input:
     • The path to the DEX/APK file
     • A method
   • Output:
     • The smali code of the specified method in the DEX/APK file
   • Example:

     pathToDex = "classes.dex"
     method = "Lcom/app/damnvulnerablebank/BankLogin;->backToMain(Landroid/view/View;)V"
     
     result = getBytecodes(pathToDex, method)
     
     # result = '''
     # .method public backToMain(Landroid/view/View;)V
     #     .registers 3
     #    new-instance p1, Landroid/content/Intent;
     #    const-class v0, Lcom/app/damnvulnerablebank/MainActivity;
     #    invoke-direct {p1, p0, v0}, Landroid/content/Intent;-><init>(Landroid/content/Context;Ljava/lang/Class;)V
     #    invoke-virtual {p0, p1}, Landroid/app/Activity;->startActivity(Landroid/content/Intent;)V
     #    return-void
     #.end method
     #'''

8. List all strings in the DEX/APK file.

   • Input:
     • The path to the DEX/APK file
   • Output:
     • A Python list containing all the strings in the DEX/APK file
   • Example:

     pathToDex = "classes.dex"
     
     result = getStrings(pathToDex)
     
     # result = ['abc', 'def']

9. Parse an Android Binary XML file into the XML format.

   • Input:
     • The path to an Android Binary XML file
   • Output:
     • A XML file or a Python XML object (e.g. xml.etree.ElementTree)
   • Example:

     pathToAndoridXML = "AndroidManifest.xml"
     
     result = parseAndroidXML(pathToAndoridXML)
     
     # result = <Element manifest at 0x7f72a4a897c0>
     # result.attrib = {
     #     '{http://schemas.android.com/apk/res/android}versionCode': '1',
     #     '{http://schemas.android.com/apk/res/android}versionName': '1.0',
     #     '{http://schemas.android.com/apk/res/android}compileSdkVersion': '29',
     #     '{http://schemas.android.com/apk/res/android}compileSdkVersionCodename': '10',
     #     'package': 'com.app.damnvulnerablebank', 'platformBuildVersionCode': '29',
     #     'platformBuildVersionName': '10'
     #}

10. Get the inheritance relationships of the classes in the DEX/APK file.

    • Input:
      • The path to the DEX/APK file
    • Output:
      • A Python dictionary storing the inheritance relationships, where the key stores the class name and the value stores a list of the superclass names
    • Example:

      pathToDex = "classes.dex"
      
      result = getClassRelationships(pathToDex)
      
      # result = {
      #    'Lahmyth/mine/king/ahmyth/BuildConfig;': {'Ljava/lang/Object;'},
      #    'Lahmyth/mine/king/ahmyth/CallsManager;': {'Ljava/lang/Object;'}
      #}

11. Provide Python APIs to interact with Shuriken-Analyzer.