From a8c9686ccb552969c86d731e60665e6d13b5ab68 Mon Sep 17 00:00:00 2001 From: Jing Ling Date: Thu, 22 Oct 2020 14:07:43 +0800 Subject: [PATCH 1/2] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E4=BD=BF=E7=94=A8?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 46 +++++++++++++++++-------------------------- docs/contributors.md | 8 ++++---- docs/en-us/README.md | 47 +++++++++++++++++++------------------------- 3 files changed, 42 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index b9e54d0..8a4ca9e 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,8 @@ pip3 -V ``` 如果你看到类似以下的输出便说明Python环境没有问题： ```bash -Python 3.8.0 -pip 19.2.2 from C:\Users\shmilylty\AppData\Roaming\Python\Python38\site-packages\pip (python 3.8) +Python 3.6.0 +pip 19.2.2 from C:\Users\shmilylty\AppData\Roaming\Python\Python36\site-packages\pip (python 3.6) ``` @@ -36,7 +36,7 @@ pip 19.2.2 from C:\Users\shmilylty\AppData\Roaming\Python\Python38\site-packages 1. **下载** -由于该项目**处于开发中**，会不断进行更新迭代，下载时使用`git clone`**克隆**最新代码仓库，也方便后续的更新，不推荐从Releases下载，因为Releases里版本更新缓慢，也不方便更新， +由于该项目**处于开发中**，会不断进行更新迭代，下载时请使用`git clone`**克隆**最新代码仓库，也方便后续的更新，不推荐从Releases下载，因为Releases里版本更新缓慢，也不方便更新， 本项目已经在[码云](https://gitee.com/shmilylty/OneForAll.git)(Gitee)镜像了一份，国内推荐使用码云进行克隆比较快： ```bash @@ -49,7 +49,7 @@ git clone https://github.com/shmilylty/OneForAll.git 2. **安装** -你可以通过pip3安装OneForAll的依赖，以下为**Windows系统**下使用**pip3**安装依赖的示例：注意：如果你的Python3安装在系统Program Files目录下，如：`C:\Program Files\Python38`，那么请以管理员身份运行命令提示符cmd执行以下命令！ +你可以通过pip3安装OneForAll的依赖，以下为**Windows系统**下使用**pip3**安装依赖的示例：注意：如果你的Python3安装在系统Program Files目录下，如：`C:\Program Files\Python36`，那么请以管理员身份运行命令提示符cmd执行以下命令！ ```bash cd OneForAll/ @@ -58,7 +58,7 @@ pip3 install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/ python3 oneforall.py --help ``` -其他系统平台的请参考[依赖安装](https://github.com/shmilylty/OneForAll/tree/master/docs/installation_dependency.md)，如果在安装依赖过程中发现编译某个依赖库失败时可以参考[troubleshooting.md](https://github.com/shmilylty/OneForAll/tree/master/docs/troubleshooting.md)中解决方法，如果还没有解决欢迎加群反馈。 +其他系统平台的请参考[依赖安装](https://github.com/shmilylty/OneForAll/tree/master/docs/installation_dependency.md)，如果在安装依赖过程中发现编译某个依赖库失败时可以参考[常见问题与回答.md](https://github.com/shmilylty/OneForAll/tree/master/docs/troubleshooting.md)文档中解决方法，如果依然不能解决欢迎加群反馈问题。 3. **更新** @@ -99,7 +99,7 @@ docker run -it --rm -v ~/results:/OneForAll/results -v ~/.config:/OneForAll/conf 如果你的主机不在中国，请把 [setting](https://github.com/shmilylty/OneForAll/blob/master/config/setting.py#L46) 中`brute_nameservers_path`选项的`cn_nameservers.txt`修改为`nameservers.txt`。 -1. 如果你是通过pip3安装的依赖则使用以下命令运行示例： +如果你是通过pip3安装的依赖则使用以下命令运行示例： ```bash python3 oneforall.py --target example.com run python3 oneforall.py --targets ./example.txt run @@ -107,16 +107,6 @@ python3 oneforall.py --targets ./example.txt run ![Example](./docs/usage_example.svg) -2. 如果你通过pipenv安装的依赖则使用以下命令运行示例： -```bash -pipenv run python oneforall.py --target example.com run -``` -3. 开启爆破模块运行（使用massdns进行爆破，网络占用极大，可能会阻塞网络） -```bash -python3 oneforall.py --target example.com --brute True run -# or -pipenv run python oneforall.py --target example.com --brute True run -```
@@ -142,19 +132,19 @@ pipenv run python oneforall.py --target example.com --brute True run 其中类似`example_com_now_result`表存放现在子域收集结果，一般情况关注这张表就可以了。 -结果具体字段的解释说明请查看![相关文档](./docs/field.md)。 +更多信息请参阅[字段解释说明](./docs/field.md)。
🤔使用帮助 -命令行参数只提供了一些常用参数，更多详细的参数配置请见[config.py](https://github.com/shmilylty/OneForAll/tree/master/config/setting.py)，如果你认为有些参数是命令界面经常使用到的或缺少了什么参数等问题非常欢迎反馈。由于众所周知的原因，如果要使用一些被墙的收集接口请先到[config.py](https://github.com/shmilylty/OneForAll/tree/master/config/setting.py)配置代理，有些收集模块需要提供API（大多都是可以注册账号免费获取），如果需要使用请到[api.py](https://github.com/shmilylty/OneForAll/tree/master/config/api.py)配置API信息，如果不使用请忽略有关报错提示。（详细模块请阅读[收集模块说明](https://github.com/shmilylty/OneForAll/tree/master/docs/collection_modules.md)） +命令行参数只提供了一些常用参数，更多详细的参数配置请见[setting.py](https://github.com/shmilylty/OneForAll/tree/master/config/setting.py)，如果你认为有些参数是命令界面经常使用到的或缺少了什么参数等问题非常欢迎反馈。由于众所周知的原因，如果要使用一些被墙的收集接口请先到[setting.py](https://github.com/shmilylty/OneForAll/tree/master/config/setting.py)配置代理，有些收集模块需要提供API（大多都是可以注册账号免费获取），如果需要使用请到[api.py](https://github.com/shmilylty/OneForAll/tree/master/config/api.py)配置API信息，如果不使用请忽略有关报错提示。（详细模块请阅读[收集模块说明](https://github.com/shmilylty/OneForAll/tree/master/docs/collection_modules.md)） OneForAll命令行界面基于[Fire](https://github.com/google/python-fire/)实现，有关Fire更高级使用方法请参阅[使用Fire CLI](https://github.com/google/python-fire/blob/master/docs/using-cli.md)。 [oneforall.py](https://github.com/shmilylty/OneForAll/tree/master/oneforall.py)是主程序入口，oneforall.py可以调用[brute.py](https://github.com/shmilylty/OneForAll/tree/master/brute.py)，[takerover.py](https://github.com/shmilylty/OneForAll/tree/master/takerover.py)及[dbexport.py](https://github.com/shmilylty/OneForAll/tree/master/dbexport.py)等模块，为了方便进行子域爆破独立出了brute.py，为了方便进行子域接管风险检查独立出了takerover.py，为了方便数据库导出独立出了dbexport.py，这些模块都可以单独运行，并且所接受参数要更丰富一点，如果要单独使用这些模块请参考[使用帮助](https://github.com/shmilylty/OneForAll/tree/master/docs/usage_help.md) -❗注意：当你在使用过程中遇到一些问题或者疑惑时，请先到[Issues](https://github.com/shmilylty/OneForAll/issues)里使用搜索找找答案，还可以参阅[常见问题与回答](https://github.com/shmilylty/OneForAll/tree/master/docs/Q&A.md)。 +❗注意：当你在使用过程中遇到一些问题或者疑惑时，请先到[Issues](https://github.com/shmilylty/OneForAll/issues)里使用搜索找找答案，还可以参阅[常见问题与回答](https://github.com/shmilylty/OneForAll/tree/master/docs/troubleshooting.md)。 **oneforall.py使用帮助** @@ -246,7 +236,7 @@ FLAGS * **支持子域爆破**，该模块有常规的字典爆破，也有自定义的fuzz模式，支持批量爆破和递归爆破，自动判断泛解析并处理。 * **支持子域验证**，默认开启子域验证，自动解析子域DNS，自动请求子域获取title和banner，并综合判断子域存活情况。 * **支持子域接管**，默认开启子域接管风险检查，支持子域自动接管（目前只有Github，有待完善），支持批量检查。 -* **处理功能强大**，发现的子域结果支持自动去除，自动DNS解析，HTTP请求探测，自动筛选出有效子域，拓展子域的Banner信息，最终支持的导出格式有`rst`, `csv`, `tsv`, `json`, `yaml`, `html`, `xls`, `xlsx`, `dbf`, `latex`, `ods`。 +* **处理功能强大**，发现的子域结果支持自动去除，自动DNS解析，HTTP请求探测，自动筛选出有效子域，拓展子域的Banner信息，最终支持的导出格式有`txt`, `csv`, `json`。 * **速度极快**，[收集模块](https://github.com/shmilylty/OneForAll/tree/master/collect.py)使用多线程调用，[爆破模块](https://github.com/shmilylty/OneForAll/tree/master/brute.py)使用[massdns](https://github.com/blechschmidt/massdns)，DNS解析速度每秒可解析350000以上个域名，子域验证中DNS解析和HTTP请求使用异步多协程，多线程检查[子域接管](https://github.com/shmilylty/OneForAll/tree/master/takeover.py)风险。 * **体验良好**，各模块都有进度条，异步保存各模块结果。 @@ -254,9 +244,9 @@ FLAGS ## 🌲目录结构 -项目的目录结构说明请参阅[directory_structure.md](https://github.com/shmilylty/OneForAll/tree/master/docs/directory_structure.md)。 +更多信息请参阅[目录结构说明](https://github.com/shmilylty/OneForAll/tree/master/docs/directory_structure.md)。 -项目中子域字典来源说明请参阅[dictionary source.md](https://github.com/shmilylty/OneForAll/tree/master/docs/dictionary_source.md)。 +本项目[docs](https://github.com/shmilylty/OneForAll/tree/master/docs/)目录下还提供了一些帮助与说明，如[子域字典来源说明](https://github.com/shmilylty/OneForAll/tree/master/docs/dictionary_source.md)、[泛解析判断流程](https://github.com/shmilylty/OneForAll/tree/master/docs/wildcard_judgment.png)。 ## 👏用到框架 @@ -272,9 +262,9 @@ FLAGS 感谢这些伟大优秀的Python库！ -## 🙏贡献 +## 🔖版本控制 -非常热烈欢迎各位大佬一起完善本项目！ +该项目使用[SemVer](https://semver.org/)语言化版本格式进行版本管理，你可以参阅[变更记录说明](https://github.com/shmilylty/OneForAll/tree/master/docs/changes.md)了解历史变更情况。 ## ⌛后续计划 @@ -283,18 +273,18 @@ FLAGS - [x] 子域收集爬虫实现（包括从JS等静态资源文件中收集子域） - [ ] 操作强大交互人性的前端界面实现 -更多详细信息请阅读[todo.md](https://github.com/shmilylty/OneForAll/tree/master/docs/todo.md)。 +更多信息请参阅[后续开发计划](https://github.com/shmilylty/OneForAll/tree/master/docs/todo.md)。 -## 🔖版本控制 +## 🙏贡献 -该项目使用[SemVer](https://semver.org/)语言化版本格式进行版本管理，你可以在[Releases](https://github.com/shmilylty/OneForAll/releases)查看可用版本，你可以查阅[changes.md](https://github.com/shmilylty/OneForAll/tree/master/docs/changes.md)了解历史变更情况。 +非常热烈欢迎各位大佬一起完善本项目！ ## 👨‍💻贡献者 * **[Jing Ling](https://github.com/shmilylty)** * 核心开发 -你可以在[contributors.md](https://github.com/shmilylty/OneForAll/tree/master/docs/contributors.md)中查看所有参与该项目的开发者。 +你可以在[贡献者文档](https://github.com/shmilylty/OneForAll/tree/master/docs/contributors.md)中查看所有贡献者以及他们所做出的贡献，感谢他们让OneForAll变得更强大好用。 ## ☕赞赏 diff --git a/docs/contributors.md b/docs/contributors.md index 133060f..6ec7f83 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -3,16 +3,16 @@ * **[Jing Ling](https://github.com/shmilylty)** * 核心开发 -* **[Black Star](https://github.com/blackstar24)**，**[Echocipher](https://github.com/Echocipher)**，**[JrDw0](https://github.com/JrDw0)** +* **[Black Star](https://github.com/blackstar24)** **[Echocipher](https://github.com/Echocipher)** **[JrDw0](https://github.com/JrDw0)** * 模块贡献 - + * **[JrDw0](https://github.com/JrDw0)** * 项目翻译 -* **[iceMatcha](https://github.com/iceMatcha)**，**[mikuKeeper](https://github.com/mikuKeeper)** +* **[iceMatcha](https://github.com/iceMatcha)** **[mikuKeeper](https://github.com/mikuKeeper)** * 工具测试 -* **[奶茶](https://github.com/Tardis07)**，**[boy-hack](https://github.com/boy-hack)** +* **[奶茶](https://github.com/Tardis07)** **[boy-hack](https://github.com/boy-hack)** * Docker构建 * **Anyone** diff --git a/docs/en-us/README.md b/docs/en-us/README.md index b74ed48..df9b915 100644 --- a/docs/en-us/README.md +++ b/docs/en-us/README.md @@ -28,8 +28,8 @@ pip3 -V ``` If you see the following output, there is no problem with the Python environment: ```bash -Python 3.8.0 -pip 19.2.2 from C:\Users\shmilylty\AppData\Roaming\Python\Python37\site-packages\pip (python 3.8) +Python 3.6.0 +pip 19.2.2 from C:\Users\shmilylty\AppData\Roaming\Python\Python36\site-packages\pip (python 3.6) ```
@@ -53,7 +53,7 @@ git clone https://github.com/shmilylty/OneForAll.git 2. **Installation** -You can use pip3 install requirements, the following is an example of using **pip3** to install dependencies under **Windows**: (Note: If your Python3 is installed in the system Program Files In the directory, such as: `C:\Program Files\Python38`, please run the following as an administrator!) +You can use pip3 install requirements, the following is an example of using **pip3** to install dependencies under **Windows**: (Note: If your Python3 is installed in the system Program Files In the directory, such as: `C:\Program Files\Python36`, please run the following as an administrator!) ```bash cd OneForAll/ @@ -62,7 +62,7 @@ pip3 install -r requirements.txt python3 oneforall.py --help ``` -For other system platforms, please read [dependency installation](https://github.com/shmilylty/OneForAll/tree/master/docs/installation_dependency.md). If you compile failed during the installation, you can find solution in the [troubleshooting.md](https://github.com/shmilylty/OneForAll/tree/master/docs/troubleshooting.md) documentation. If still not resolved, welcome [issues](https://github.com/shmilylty/OneForAll/issues). +For other system platforms, please read [dependency installation](https://github.com/shmilylty/OneForAll/tree/master/docs/installation_dependency.md). If you compile failed during the installation, you can find solution in [Q&A](https://github.com/shmilylty/OneForAll/tree/master/docs/troubleshooting.md) documentation. If still not resolved, welcome [issues](https://github.com/shmilylty/OneForAll/issues). 3. **Update** @@ -91,7 +91,8 @@ Result will be saved in `~/results`. If your computer are not in China, change [setting](https://github.com/shmilylty/OneForAll/blob/master/config/setting.py#L46) `brute_nameservers_path` param `cn_nameservers.txt` to `nameservers.txt` plz. -1. If you are use pip3, run the following command: +If you are use pip3, run the following command: + ```bash python3 oneforall.py --target example.com run python3 oneforall.py --targets ./example.txt run @@ -99,17 +100,6 @@ python3 oneforall.py --targets ./example.txt run ![Example](../usage_example.svg) -2. If you use pipenv, run the following command: -```bash -pipenv run python oneforall.py --target example.com run -``` - -3. Turn on brute modules, run the following command(Use massdns for enumerating subdomains, the network may be blocked): -```bash -python3 oneforall.py --target example.com --brute True run -# or -pipenv run python oneforall.py --target example.com --brute True run -```
@@ -134,20 +124,23 @@ Let's take the command `python3 oneforall.py --target example.com run` as an exa `example_com_last_result` table stores the results of subdomain collection last time. `example_com_now_result` table stores the collection results of the current subdomains. Usually using this table is enough. + +For more information, please see [Field explanation](./docs/field.md). +
🤔Instructions for Use -The CLI only provide some common parameters. For more configuration, please read [config.py](https://github.com/shmilylty/OneForAll/tree/master/config/setting.py). IF you have any suggestions, welcome feedback. Some modules need access API (most of which are freely available after registered accounts). If you need , please go to [api.py](https://github.com/shmilylty/OneForAll/tree/master/config/api.py) to configure the API. If not used, just ignore the error message. (For module detailes, please read [collection module description](https://github.com/shmilylty/OneForAll/tree/master/docs/collection_modules.md)) +The CLI only provide some common parameters. For more configuration, please read [setting.py](https://github.com/shmilylty/OneForAll/tree/master/config/setting.py). IF you have any suggestions, welcome feedback. Some modules need access API (most of which are freely available after registered accounts). If you need , please go to [api.py](https://github.com/shmilylty/OneForAll/tree/master/config/api.py) to configure the API. If not used, just ignore the error message. (For module detailes, please read [collection module description](https://github.com/shmilylty/OneForAll/tree/master/docs/collection_modules.md)) The OneForAll command line interface is based on [Fire](https://github.com/google/python-fire/). For more advanced usage of Fire, please refer to [using the Fire CLI](https://github.com/google/Python-fire/blob/master/docs/using-cli.md), if you have any doubts during the use, please feel free to give me feedback. [oneforall.py](https://github.com/shmilylty/OneForAll/tree/master/oneforall.py) is the program main entrence, and oneforall.py can call [brute.py](https://github.com/shmilylty/OneForAll/tree/master/brute.py), [takerover.py](https://github.com/shmilylty/OneForAll/tree/master/takerover.py), [dbexport.py ](https://github.com/shmilylty/OneForAll/tree/master/dbexport.py) and other modules. But you can also use these modules separately, if you want, please refer to the [usage help](https://github.com/shmilylty/OneForAll/tree/master/docs/en-us/usage_help.md). -❗ Note: When you encounter some problems or doubts during use, please search answers on [issues](https://github.com/shmilylty/OneForAll/issues) first. You can also read [troubleshooting.md](https://github.com/shmilylty/OneForAll/tree/master/docs/troubleshooting.md). +❗ Note: When you encounter some problems or doubts during use, please search answers on [issues](https://github.com/shmilylty/OneForAll/issues) first. You can also read [Q&A](https://github.com/shmilylty/OneForAll/tree/master/docs/troubleshooting.md). -**OneForAll help summary page** +**OneForAll help summary** The following help information may not be up to date. You can use `python oneforall.py --help` to get the latest help information. @@ -245,7 +238,7 @@ At present, OneForAll is under development, there must be a lot of problems and * **Support subdomain brute force**, can use dictionary mode or custom fuzz mode. Supports bulk brute and recursive brute, and automatically determine wildcard or not and processing. * **Support subdmain verification**, default enable, automatically resolve DNS, request subdomain to obtain response, and determine subdomain alive or not. * **Support subdomain takeover**, default enable, supports bulk inspection, and automatic takeover subdomain (only Github, remains to be improved at present). -* **Powerful processing feature**, support automatic deduplicate, DNS resolve, HTTP request, filter valid subdomains and information for subdomains. Supported export formats: `rst`, `csv`, `tsv`, `json`, `yaml`, `html`, `xls`, `xlsx`, `dbf`, `latex`, `ods`. +* **Powerful processing feature**, support automatic deduplicate, DNS resolve, HTTP request, filter valid subdomains and information for subdomains. Supported export formats: `txt`, `csv`, `json`. * **Very fast**, [collection module](https://github.com/shmilylty/OneForAll/tree/master/collect.py) uses multi-threading, [brute module](https://github.com/shmilylty/OneForAll/tree/master/brute.py) uses [MassDNS](https://github.com/blechschmidt/massdns), MassDNS is capable of resolving over 350,000 names per second using publicly available resolvers. DNS resolve and HTTP requests use async-coroutine. [subdomain takeover](https://github.com/shmilylty/OneForAll/tree/master/takeover.py) uses multi-threading. * **Good experience**, each module has a progress bar, and save results asynchronously. @@ -253,9 +246,9 @@ If you have any other good ideas, please let me know!😎 ## 🌲Directory structure -For the description of the project's directory structure, please refer to [directory_structure.md](https://github.com/shmilylty/OneForAll/tree/master/docs/directory_structure.md). +For more information, please see [Directory structure description](https://github.com/shmilylty/OneForAll/tree/master/docs/directory_structure.md). -For a description of the source of the subdomain dictionary, please refer to [dictionary_source.md](https://github.com/shmilylty/OneForAll/tree/master/docs/en-us/dictionary_source.md). +Some help and instructions are also provided in the [docs](https://github.com/shmilylty/OneForAll/tree/master/docs/) directory of this project, such as [dictionary Source description](https://github.com/shmilylty/OneForAll/tree/master/docs/dictionary_source.md), [wildcard judgment process](https://github.com/shmilylty/OneForAll/tree/master/docs/wildcard_judgment.png). ## 👏Framework used @@ -270,9 +263,9 @@ For a description of the source of the subdomain dictionary, please refer to [di Thanks to these great Python libraries! -## 🙏Contribution +## 🔖Version control -Very warmly welcome all people to make OneForAll better together! +The project uses [SemVer](https://semver.org/) for version management, and you can view the available version in [Releases](https://github.com/shmilylty/OneForAll/releases), You can check [changes.md](https://github.com/shmilylty/OneForAll/tree/master/docs/changes.md)) for historical changes. ## ⌛Follow-up plan @@ -283,16 +276,16 @@ Very warmly welcome all people to make OneForAll better together! For more details, read [todo.md](https://github.com/shmilylty/OneForAll/tree/master/docs/todo.md). -## 🔖Version control +## 🙏Contribution -The project uses [SemVer](https://semver.org/) for version management, and you can view the available version in [Releases](https://github.com/shmilylty/OneForAll/releases), You can check [changes.md](https://github.com/shmilylty/OneForAll/tree/master/docs/changes.md)) for historical changes. +Very warmly welcome all people to make OneForAll better together! ## 👨‍💻Contributors * **[Jing Ling](https://github.com/shmilylty)** * Core developer -You can see all the developers involved in the project in [contributors.md](https://github.com/shmilylty/OneForAll/tree/master/docs/contributors.md). +You can view all contributors and their contributions in the [contributor documentation](https://github.com/shmilylty/OneForAll/tree/master/docs/contributors.md)) and thank them for making OneForAll more powerful and useful. ## 📄License From e05b05a591097e098b42e30d8b22cafd60984da7 Mon Sep 17 00:00:00 2001 From: Jing Ling Date: Thu, 22 Oct 2020 14:11:32 +0800 Subject: [PATCH 2/2] typo --- docs/en-us/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en-us/README.md b/docs/en-us/README.md index df9b915..71ea40b 100644 --- a/docs/en-us/README.md +++ b/docs/en-us/README.md @@ -265,7 +265,7 @@ Thanks to these great Python libraries! ## 🔖Version control -The project uses [SemVer](https://semver.org/) for version management, and you can view the available version in [Releases](https://github.com/shmilylty/OneForAll/releases), You can check [changes.md](https://github.com/shmilylty/OneForAll/tree/master/docs/changes.md)) for historical changes. +The project uses [SemVer](https://semver.org/) for version management, and you can view the available version in [Releases](https://github.com/shmilylty/OneForAll/releases), You can refer to the [change record instructions](https://github.com/shmilylty/OneForAll/tree/master/docs/changes.md) for historical changes. ## ⌛Follow-up plan