Init

Author: tiann

.gitignore

@@ -0,0 +1,56 @@
+### C++ template
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+### CMake template
+CMakeLists.txt.user
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Testing
+Makefile
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+_deps
+
+
+cmake-build*/
+.idea
+#CMakeLists.txt
+
+*.dex
+*.apk
+
+local.properties

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "dexkit/src/main/DexKit"]
+	path = dexkit/src/main/DexKit
+	url = https://github.com/LuckyPray/DexKit

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2022 LuckyPray
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -0,0 +1,72 @@
+ DexKit
+--
+
+[README](https://github.com/LuckyPray/DexKit/blob/master/README.md)|[中文文档](https://github.com/LuckyPray/DexKit/blob/master/README_zh.md)
+
+A high performance dex deobfuscator library.
+
+## API introduction
+
+These two APIs can meet most of your usage scenarios:
+
+- **`DexKit::LocationClasses`**
+- **`DexKit::LocationMethods`**
+
+And there are many other APIs:
+
+- `DexKit::FindMethodInvoked`: Find caller for specified method.
+- `DexKit::FindMethodUsedString`
+- `DexKit::FindMethod`: Find method with various conditions
+- `DexKit::FindSubClasses`: Find sub class of specified class
+- `DexKit::FindMethodOpPrefixSeq`: Find method with op prefix
+
+## Integration
+
+Gradle:
+
+`implementation: io.github.LuckyPray:DexKit:<version>`
+
+This library uses [prefab](https://google.github.io/prefab/), you should enable it in gradle (Android Gradle Plugin 4.1+):
+
+```
+android {
+    buildFeatures {
+        prefab true
+    }
+}
+```
+
+## Usage
+
+### CMake
+
+You can use `find_package` in `CMakeLists.txt`:
+
+```
+add_library(mylib SHARED main.cpp)
+
+# Add two lines below
+find_package(dexkit REQUIRED CONFIG)
+target_link_libraries(app dexkit::dex_kit_static z)
+```
+
+## Example
+
+- [main.cpp](https://github.com/LuckyPray/DexKit/blob/master/main.cpp)
+- [qq-example.cpp](https://github.com/LuckyPray/DexKit/blob/master/qq-example.cpp)
+
+## Benchmark
+
+qq-example.cpp in MacPro M1 to deobfuscate `qq-8.9.3.apk`, the result is:
+
+```txt
+findClass count: 47
+findMethod count: 29
+used time: 207 ms
+```
+
+## License
+
+The slicer directory is partially copied from [AOSP](https://cs.android.com/android/platform/superproject/+/master:frameworks/base/startop/view_compiler).
+
+Modified parts are owed by LuckyPray Developers. If you would like to use it in an open source project, please submodule it.

README_zh.md

@@ -0,0 +1,70 @@
+DexKit
+--
+
+[README](https://github.com/LuckyPray/DexKit/blob/master/README.md)|[中文文档](https://github.com/LuckyPray/DexKit/blob/master/README_zh.md)
+
+一个致力于更好用的dex解析(反混淆)工具。
+
+slicer目录下内容是从 [AOSP](https://cs.android.com/android/platform/superproject/+/master:frameworks/base/startop/view_compiler) 拷贝的.
+
+修改部分归 LuckyPray 所有。如果您想在开源项目中使用，请将其模块化。
+
+## API说明
+
+DexKit应该是目前最快的反混淆工具。
+
+自带多线程执行，配上**双数组Trie树AC自动机**带来的字符串匹配优化，单独增加的搜索复杂度可以忽略不计。
+
+在正常情况下使用 **`DexKit::LocationClasses`**、 **`DexKit::LocationMethods`** 这两个方法即可满足日常的反混淆定位需求。
+
+目前支持以下API:
+- **`DexKit::LocationClasses`**: 多字符串综合定位类
+- **`DexKit::LocationMethods`**: 多字符串综合定位方法
+- `DexKit::FindMethodInvoked`: 查找所有调用指定方法的方法(invoke-kind类别的opcode)
+- `DexKit::FindMethodUsedString`: 查找调用了指定字符串的方法(`const-string`、`const-string/jumbo`)
+- `DexKit::FindMethod`: 多条件查找方法
+- `DexKit::FindSubClasses`: 查找直系子类
+- `DexKit::FindMethodOpPrefixSeq`: 查找满足特定op前缀序列的方法(使用`0x00`-`0xff`)
+
+## 集成
+
+Gradle:
+
+`implementation: io.github.LuckyPray:DexKit:<version>`
+
+这个库使用了 [prefab](https://google.github.io/prefab/)，你需要在 gradle (Android Gradle Plugin 4.1+ 版本以上才支持)中开启此特性：
+
+```
+android {
+    buildFeatures {
+        prefab true
+    }
+}
+```
+
+## 使用
+
+### CMake
+
+你可以直接在 `CMakeLists.txt` 中使用 `find_package` 来使用 DexKit:
+
+```
+# 假设你的 library 名字为 mylib
+add_library(mylib SHARED main.cpp)
+
+# 添加如下两行，注意必须添加 libz，如果你有其他依赖可以放在后面
+find_package(dexkit REQUIRED CONFIG)
+target_link_libraries(app dexkit::dex_kit_static z)
+```
+
+## 使用示例
+
+- [main.cpp](https://github.com/LuckyPray/DexKit/blob/master/main.cpp)
+- [qq-example.cpp](https://github.com/LuckyPray/DexKit/blob/master/qq-example.cpp)
+
+qq-example.cpp 在MacPro M1环境下对 `qq-8.9.3.apk` 执行结果如下所示:
+```text
+findClass count: 47
+findMethod count: 29
+used time: 207 ms
+```

build.gradle

@@ -0,0 +1,9 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+plugins {
+    id 'com.android.application' version '7.2.2' apply false
+    id 'com.android.library' version '7.2.2' apply false
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}