AppShark 使用教程

AppShark 使用教程

appshark Appshark is a static taint analysis platform to scan vulnerabilities in an Android app. 项目地址: https://gitcode.com/gh_mirrors/app/appshark

1. 项目的目录结构及介绍

AppShark 的目录结构如下：

appshark/
├── .github/              # GitHub 工作流配置
├── build.gradle.kts      # Gradle 构建脚本
├── build.sh              # 构建脚本
├── gradle/
│   └── wrapper/          # Gradle 包装器配置
├── gradle.properties      # Gradle 属性配置
├── gradlew               # Gradle 命令行工具
├── gradlew.bat           # Gradle 命令行工具（Windows）
├── LICENSE               # Apache-2.0 许可证文件
├── README.md             # 项目说明文件
├── run.sh                # 运行脚本
├── settings.gradle.kts   # Gradle 设置脚本
├── src/                  # 源代码目录
├── ui/                   # 用户界面相关文件
├── CONTRIBUTORS.md       # 贡献者信息
└── appshark-lark.png     # 项目图标

• .github/: 包含项目的 GitHub 工作流文件，用于自动化项目管理任务。
• build.gradle.kts: Kotlin 编写的 Gradle 构建脚本，用于构建项目。
• build.sh: Linux 系统下的构建脚本，用于构建项目。
• gradle/: 包含 Gradle 包装器配置文件。
• gradle.properties: Gradle 属性配置文件，用于设置 Gradle 的运行参数。
• gradlew 和 gradlew.bat: Gradle 命令行工具，用于构建项目，gradlew.bat 是 Windows 系统下的版本。
• LICENSE: Apache-2.0 许可证文件，说明项目的开源协议。
• README.md: 项目说明文件，介绍了项目的基本信息。
• run.sh: 运行脚本，用于启动项目。
• settings.gradle.kts: Gradle 设置脚本，用于配置 Gradle 的项目设置。
• src/: 源代码目录，包含项目的核心代码。
• ui/: 用户界面相关文件，可能包含项目的图形用户界面代码或资源。
• CONTRIBUTORS.md: 记录了项目的贡献者信息。
• appshark-lark.png: 项目图标。

2. 项目的启动文件介绍

项目的启动文件是 run.sh 脚本，位于项目根目录。该脚本用于在支持 bash 的环境中启动 AppShark。

启动命令如下：

./run.sh

执行该脚本将运行 java -jar build/libs/AppShark-0.1.2-all.jar 命令，该命令会使用 Gradle 构建生成的 JAR 文件启动项目。

3. 项目的配置文件介绍

项目的配置文件是 config/config.json5，该文件用于设置 AppShark 的运行参数。

配置文件的基本内容如下：

{
  "apkPath": "/Users/apks/app1.apk",  // 要分析的 APK 文件路径
  "out": "output_path",               // 输出目录路径
  "rules": "rule1.json,rule2.json",   // 指定的规则文件，默认是规则目录下的所有 *.json 文件
  "rulePath": "./config/rules",        // 规则文件所在的目录
  "maxPointerAnalyzeTime": 300,        // 分析超时时间（秒）
  "debugRule": "rule_name"            // 启用调试的规则名称
}

配置文件中的字段包括以下参数：

• apkPath: 指定要分析的 APK 文件的路径。
• out: 指定分析结果的输出目录路径。
• rules: 指定要使用的规则文件，多个文件可以用逗号分隔。
• rulePath: 指定规则文件所在的目录。
• maxPointerAnalyzeTime: 设置分析的超时时间，单位为秒。
• debugRule: 指定要启用调试的规则名称。

appshark Appshark is a static taint analysis platform to scan vulnerabilities in an Android app. 项目地址: https://gitcode.com/gh_mirrors/app/appshark