diff --git a/README.md b/README.md index b28b2b8..a5e6e0e 100644 --- a/README.md +++ b/README.md @@ -3,28 +3,28 @@ 该项目目前仅仅是规划项目中的冰山一角，如果您对此项目感兴趣或者想参与后继项目的开发工作或者翻译工作中，请发送邮件至blsm@vip.qq.com说明你的能力和诉求。 -### AppInfoScanner +## AppInfoScanner 一款适用于以HW行动/红队/渗透测试团队为场景的移动端(Android、iOS、WEB、H5、静态网站)信息收集扫描工具，可以帮助渗透测试工程师、攻击队成员、红队成员快速收集到移动端或者静态WEB站点中关键的资产信息并提供基本的信息输出,如：Title、Domain、CDN、指纹信息、状态信息等。 -### 前言 +## 前言 - 本项目的开发者目前为个人开发者同时有自己的工作，新的功能或者需求会在闲暇时间进行开发，BUG会优先进行处理。 - 如果在使用中遇到问题或者有新的需求，请在[](https://github.com/kelvinBen/AppInfoScanner/issues)提交BUG反馈，提交BUG前请先阅读最后的"常见问题"。 - 如果您觉得这个项目对您有用，请点击本项目右上角的"star"按钮。 - 如果您想持续跟进新的版本情况，请点击本项目右上角的"Watch"按钮。 - 如果您想参与本项目的开发，请点击本项目右上角的"Fork"按钮,否则请勿点击"Fork"按钮。 -### 免责声明 +## 免责声明 请勿将本项目技术或代码应用在恶意软件制作、软件著作权/知识产权盗取或不当牟利等**非法用途**中。实施上述行为或利用本项目对非自己著作权所有的程序进行数据嗅探将涉嫌违反《中华人民共和国刑法》第二百一十七条、第二百八十六条，《中华人民共和国网络安全法》《中华人民共和国计算机软件保护条例》等法律规定。本项目提及的技术仅可用于私人学习测试等合法场景中，任何不当利用该技术所造成的刑事、民事责任均与本项目作者无关。 -### 适用场景 +## 适用场景 - 日常渗透测试中对APP中进行关键资产信息收集，比如URL地址、IP地址、关键字等信息的采集等。 - 大型攻防演练场景中对APP中进行关键资产信息收集，比如URL地址、IP地址、关键字等信息的采集等。 - 对WEB网站源代码进行URL地址、IP地址、关键字等信息进行采集等(可以是开源的代码也可以是右击网页源代码另存为)。 - 对H5页面进行进行URL地址、IP地址、关键字等信息进行采集等。 - 对某个APP进行定相信息收集等 -### 功能介绍: +## 功能介绍: - [x] 支持目录级别的批量扫描 - [x] 支持DEX、APK、IPA、MACH-O、HTML、JS、Smali、ELF等文件的信息收集 - [x] 支持APK、IPA、H5等文件自动下载并进行一键信息收集 @@ -44,15 +44,15 @@ - [ ] 一键对APK文件进行自动修复 - [ ] 识别到壳后自动进行脱壳处理 -### 部分截图 +## 部分截图 ![](result.png) -### 环境说明 +## 环境说明 - Apk文件解析需要使用JAVA环境,JAVA版本1.8及以下 - Python3的运行环境 -### 目录说明 +## 目录说明 ``` AppInfoScanner |-- libs 程序的核心代码 @@ -81,7 +81,7 @@ AppInfoScanner |-- requirements.txt 程序中需要安装的依赖库 |-- update.md 程序历史版本信息 ``` -### 使用说明 +## 使用说明 1. 下载 ``` @@ -100,7 +100,7 @@ AppInfoScanner 2. 安装依赖库 ``` cd AppInfoScanner - python3 -m pip install -r requirements.txt + python -m pip install -r requirements.txt ``` 3. 运行(基础版) @@ -108,29 +108,29 @@ AppInfoScanner - 扫描Android应用的APK文件、DEX文件、需要下载的APK文件下载地址、保存需要扫描的文件的目录 ``` - python3 app.py android -i + python app.py android -i ``` - 扫描iOS应用的IPA文件、Mach-o文件、需要下载的IPA文件下载地址、保存需要扫描的文件目录 ``` - python3 app.py ios -i + python app.py ios -i ``` - 扫描Web站点的文件、目录、需要缓存的站点URl ``` - python3 app.py web -i + python app.py web -i ``` -### 进阶操作指南 +## 进阶操作指南 -#### 基本命令格式 +### 基本命令格式 ``` -python3 app.py [TYPE] [OPTIONS] +python app.py [TYPE] [OPTIONS] ``` -#### 符号信息说明 +### 符号信息说明 ``` <> 代表需要扫描的文件或者目录或者URL地址 @@ -138,7 +138,7 @@ python3 app.py [TYPE] [OPTIONS] [] 代表需要输入的参数 ``` -#### TYPE参数详细说明 +### TYPE参数详细说明 此参数类型对应基本命令格式中的[TYPE],目前仅支持[android/ios/web]三种类型形式，三种类型形式必须指定一个。 ``` @@ -150,7 +150,7 @@ web: 用于扫描WEB站点或者H5相关的文件内容 支持自动根据后缀名称进行修正，即便输入的是ios，实际上-i 输入的参数的文件名为XXX.apk，则会执行android相关的扫描。 -#### OPTIONS参数详细说明 +### OPTIONS参数详细说明 该参数类型对应基本命令格式中的[OPTIONS]，支持多个参数共同使用 ``` @@ -164,173 +164,173 @@ web: 用于扫描WEB站点或者H5相关的文件内容 -p 或者 -- package: 指定Android的APK文件或者DEX文件需要扫描的JAVA包名信息。此参数只能在android类型下使用。 ``` -#### 具体使用方法 +### 具体使用方法 -##### Android相关基本操作 +#### Android相关基本操作 - 对本地APK文件进行扫描 ``` -python3 app.py android -i +python app.py android -i 例: -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.apk +python app.py android -i C:\Users\Administrator\Desktop\Demo.apk ``` - 对本地Dex文件进行扫描 ``` -python3 app.py android -i +python app.py android -i 例: -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.dex +python app.py android -i C:\Users\Administrator\Desktop\Demo.dex ``` - 对URL地址中包含的APK文件进行扫描 ``` -python3 app.py android -i +python app.py android -i 例: -python3 app.py android -i "https://127.0.0.1/Demo.apk" +python app.py android -i "https://127.0.0.1/Demo.apk" ``` 需要注意此处如果URL地址过长需要使用双引号(")进行包裹 -##### iOS相关基本操作 +#### iOS相关基本操作 - 对本地IPA文件进行扫描 ``` -python3 app.py ios -i +python app.py ios -i 例: -python3 app.py ios -i "C:\Users\Administrator\Desktop\Demo.ipa" +python app.py ios -i "C:\Users\Administrator\Desktop\Demo.ipa" ``` - 对本地Macho文件进行扫描 ``` -python3 app.py ios -i +python app.py ios -i 例: -python3 app.py ios -i "C:\Users\Administrator\Desktop\Demo\Payload\Demo.app\Demo" +python app.py ios -i "C:\Users\Administrator\Desktop\Demo\Payload\Demo.app\Demo" ``` - 对URL地址中包含的IPA文件进行扫描 ``` -python3 app.py ios -i +python app.py ios -i 例: -python3 app.py ios -i "https://127.0.0.1/Demo.ipa" +python app.py ios -i "https://127.0.0.1/Demo.ipa" ``` 需要注意此处如果URL地址过长需要使用双引号(")进行包裹,暂时不支持对Apple Store中的IPA文件进行扫描 -##### Web相关基本操作 +#### Web相关基本操作 - 对本地WEB站点进行扫描 ``` -python3 app.py web -i +python app.py web -i 例: -python3 app.py web -i "C:\Users\Administrator\Desktop\Demo.html" +python app.py web -i "C:\Users\Administrator\Desktop\Demo.html" ``` - 对URL地址中包含的WEB站点文件进行扫描 ``` -python3 app.py web -i +python app.py web -i 例: -python3 app.py web -i "https://127.0.0.1/Demo.html" +python app.py web -i "https://127.0.0.1/Demo.html" ``` -##### 具有共同性的操作 +#### 具有共同性的操作 以下操作均以android类型为例： - 对一个本地的目录进行扫描 ``` -python3 app.py android -i +python app.py android -i 例： -python3 app.py android -i C:\Users\Administrator\Desktop\Demo +python app.py android -i C:\Users\Administrator\Desktop\Demo ``` - 添加临时规则或者关键字 ``` -python3 app.py android -i -r +python app.py android -i -r 例： 添加对百度域名的扫描 -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.apk -r ".*baidu.com.*" +python app.py android -i C:\Users\Administrator\Desktop\Demo.apk -r ".*baidu.com.*" ``` - 关闭网络嗅探功能 ``` -python3 app.py android -i -s +python app.py android -i -s 例： -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.apk -s +python app.py android -i C:\Users\Administrator\Desktop\Demo.apk -s ``` - 忽略所有的资源文件 ``` -python3 app.py android -i -n +python app.py android -i -n 例： -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.apk -n +python app.py android -i C:\Users\Administrator\Desktop\Demo.apk -n ``` - 关闭输出所有符合扫描规则内容的功能 ``` -python3 app.py android -i -a +python app.py android -i -a 例： -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.apk -a +python app.py android -i C:\Users\Administrator\Desktop\Demo.apk -a ``` - 设置并发数量 ``` -python3 app.py android -i -t 20 +python app.py android -i -t 20 例： 设置20个并发线程 -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.apk -t 20 +python app.py android -i C:\Users\Administrator\Desktop\Demo.apk -t 20 ``` - 指定结果集和缓存文件输出目录 ``` -python3 app.py android -i -o +python app.py android -i -o 例： 比如输出到桌面的Temp目录 -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.apk -o C:\Users\Administrator\Desktop\Temp +python app.py android -i C:\Users\Administrator\Desktop\Demo.apk -o C:\Users\Administrator\Desktop\Temp ``` - 对指定包名下的文件内容进行扫描，该功能仅支持android类型 ``` -python3 app.py android -i -p +python app.py android -i -p 例： 比如需要过滤com.baidu包名下的内容 -python3 app.py android -i C:\Users\Administrator\Desktop\Demo.apk -p "com.baidu" +python app.py android -i C:\Users\Administrator\Desktop\Demo.apk -p "com.baidu" ``` -### 高级版使用说明 +## 高级版使用说明 该项目中的程序仅作为一个基本的架子，会内置一些基本的规则，并不是每一个输入的内容都可以完成相关的扫描工作。所以可以根据自己的需要进行相关规则的配置，优秀的配置内容可以达到质的的效果。 - 配置文件路径为 根目录下的config.py文件，即README.md的同级目录 -#### 配置项说明 +### 配置项说明 ``` filter_components: 此配置项用于配置相关组件内容，包括Json组件或者XML组件等 filter_strs: 用于配置需要进行扫描的文件内容，比如需要扫描端口号，则配置为："r'.*://([\d{1,3}\.]{3}\d{1,3}).*'" @@ -343,16 +343,16 @@ data: 用于配置自动下载过程中需要的请求报文体 method: 用于配置自动下载过程中需要的请求方法 ``` -### 常见问题 +## 常见问题 -#### 1. 信息检索垃圾数据过多？ +### 1. 信息检索垃圾数据过多？ ``` 方法1： 根据实际情况调整config.py中的规则信息 方法2： 忽略资源文件 ``` -#### 2. 出现错误：Error: This application has shell, the retrieval results may not be accurate, Please remove the shell and try again! +### 2. 出现错误：Error: This application has shell, the retrieval results may not be accurate, Please remove the shell and try again! 说明需要扫描的应用存在壳，需要进行脱壳/砸壳以后才能进行扫描，目前可以结合以下工具进行脱壳/砸壳处理 ``` @@ -367,14 +367,14 @@ method: 用于配置自动下载过程中需要的请求方法 MacOS系统使用：frida-ios-dump ``` -#### 3. 出现错误: File download failed! Please download the file manually and try again. +### 3. 出现错误: File download failed! Please download the file manually and try again. 文件下载失败。 ``` 1) 请检查输入的URL地址是否正确 2）请检查网络是否存在问题或者在配置文件config.py中配置请求头信息(headers)、请求报文体(data)、请求方法(method)保存后重新再执行。 ``` -#### 4. 出现错误：Decompilation failed, please submit error information at https://github.com/kelvinBen/AppInfoScanner/issues" +### 4. 出现错误：Decompilation failed, please submit error information at https://github.com/kelvinBen/AppInfoScanner/issues" 文件反编译失败。