OneForAll-mirror/docs/en-us

OneForAll

👊OneForAll is a powerful subdomain integration tool 📝中文文档

🎉Why OneForAll？

Project address : https://github.com/shmilylty/OneForAll

Problems with other tools

• Not powerful enough, few api, cannot automate, cannot valid subdomain, etc.

• Not friendly enough, do not have a good user interface.

• Not quickly enough, do not use multi-process, multi-threading, coroutine, etc.

• Lack of maintenance, lots of issues and bugs, and no one fixed it.

In order to solve the above problems, OneForAll born! As its name, OneForAll is committed to becoming the only one subdomain integration tool you need. We hope that one day OneForAll can be called "probably the best subdomain tool"

At present, OneForAll is under development, there must be a lot of problems and areas for improvement. Welcome to submit Issues or PR, If you like, star please✨. You can contact me through QQ group 824414244 or twitter tweet to me: 👨‍👨‍👦‍👦.

👍Features

• Powerful collection capability, For more details, please read collection module description.

1. Use 6 certificate modules: censys_api, certspotter, crtsh, entrust, google, spyse_api.
2. Use 6 baseline testing modules: scan domain transfer vulnerability axfr, cross-domain policy file cdx, HTTPS certificate cert, content security policy csp, robots file robots, and sitemap file sitemap, NSEC record nsec. NSEC3 record and other modules will be added later.
3. Use 2 web crawler modules: archirawl, commoncrawl, which is still being debugged and needs to be added and improved).
4. Use 23 DNS datasets modules: binaryedge_api, bufferover, cebaidu, chinaz, chinaz_api, circl_api, dnsdb_api, dnsdumpster, hackertarget, ip138, ipv4info_api, netcraft, passivedns_api, ptrarchive, qianxun, rapiddns, riddler, robtex, securitytrails_api, sitedossier, threatcrowd, wzpc, ximcx.
5. Use 6 DNS queries modules: enumerating SRV records srv and collect from MX, NS, SOA, TXT, SPF.
6. Use 6 threat intelligence modules: alienvault, riskiq_ api, threatbook_ api, threatkeeper , virustotal, virustotal_ api, which need to be added and improved.
7. Use 16 search engines modules: ask, baidu, bing, bing_api, fofa_api, gitee, github_api, google, google_api, shodan_api, so, sogou, yahoo, yandex, zoomeye_api, except for special search engines. General search engines support automatic exclusion of search, full search and recursive search.

• 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.
• Very fast, collection module uses multi-threading, brute module uses massdns, the speed can at least reach 10000pps by the default configuration. DNS resolve and HTTP requests use async-coroutine. subdomain takeover uses multi-threading.
• Good experience, each module has a progress bar, and save results asynchronously.

If you have any other good ideas, please let me know!😎

🚀Start Guide

📢 Please read this document to help you start quickly!

🐍Installation requirements

OneForAll is developed and tested based on Python 3.8.0. Recommend use release higher than Python 3.8.0 (Windows platform must use Python 3.8.0 or later). For more information on installing the Python environment, please read Python 3 installation Guide.

After installation python, run the following command to check the Python and pip3 versions:

python -V
pip3 -V

If you see the following output, there is no problem with the Python environment:

Python 3.8.0
pip 19.2.2 from C:\Users\shmilylty\AppData\Roaming\Python\Python37\site-packages\pip (python 3.8)

✔Installation steps (from Git)

1. Download

Because OneForAll is under development yet, it is recommended that use git clone to clone the latest code repository. Downloading from Releases is not recommended.

If you are in China, it is recommended that you choose Gitee for cloning:

git clone https://gitee.com/shmilylty/OneForAll.git

or:

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!)

cd OneForAll/
python -m pip install -U pip setuptools wheel
pip3 install -r requirements.txt
python oneforall.py --help

For other system platforms, please read dependency installation. If you compile failed during the installation, you can find solution in the troubleshooting.md documentation. If still not resolved, welcome issues.

3. Update

❗Note: If you have cloned the project before, please backup modified files (such as ./config) before updating, then run the following command to update project:

git fetch --all
git reset --hard origin/master
git pull

✔Installation steps (from Docker)

docker pull shmilylty/oneforall
docker run -it --rm -v ~/results:/OneForAll/results oneforall

Result will be saved in ~/results.

✨Usage

1. If you are use pip3, run the following command:

python3 oneforall.py --target example.com run

2. If you use pipenv, run the following command:

pipenv run python oneforall.py --target example.com run

🧐Instructions for results

Let's take the command python3 oneforall.py --target example.com run as an example. When command finished in the default configuration, OneForAll will generate results in the results directory:

example.com.csv is the result for each domain.

all_subdomain_result_1583034493.csv is the result for all domains when your target have multiple domains.

result.sqlite3 is the SQLite3 database that stores all the subdomains collected by OneForAll. The database structure is shown below:

example_com_origin_result table stores the origin subdomain results of each module.

example_com_resolve_result table stores the results of resolving subdomains.

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.

🤔Instructions for Use

The CLI only provide some common parameters. For more configuration, please read config.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 to configure the API. If not used, just ignore the error message. (For module detailes, please read collection module description)

The OneForAll command line interface is based on Fire. For more advanced usage of Fire, please refer to using the Fire CLI, if you have any doubts during the use, please feel free to give me feedback.

oneforall.py is the program main entrence, and oneforall.py can call brute.py, takerover.py, dbexport.py and other modules. But you can also use these modules separately, if you want, please refer to the usage help.

❗ Note: When you encounter some problems or doubts during use, please search answers on issues first. You can also read troubleshooting.md.

OneForAll help summary page

The following help information may not be up to date. You can use python oneforall.py --help to get the latest help information.

python oneforall.py --help

NAME
    oneforall.py - OneForAll help summary page

SYNOPSIS
    oneforall.py COMMAND | --target=TARGET <flags>

DESCRIPTION
    OneForAll is a powerful subdomain integration tool

    Example:
        python3 oneforall.py version
        python3 oneforall.py --target example.com run
        python3 oneforall.py --target ./domains.txt run
        python3 oneforall.py --target example.com --alive False run
        python3 oneforall.py --target example.com --brute True run
        python3 oneforall.py --target example.com --port medium run
        python3 oneforall.py --target example.com --format csv run
        python3 oneforall.py --target example.com --dns False run
        python3 oneforall.py --target example.com --req False run
        python3 oneforall.py --target example.com --takeover False run
        python3 oneforall.py --target example.com --show True run

    Note:
        --alive  True/False           Only export alive subdomains or not (default False)
        --port   default/small/large  See details in ./config/setting.py(default port 80)
        --format rst/csv/tsv/json/yaml/html/jira/xls/xlsx/dbf/latex/ods (result format)
        --path   Result directory (default directory is ./results)

ARGUMENTS
    TARGET
        One domain or File path of one domain per line (required)

FLAGS
    --brute=BRUTE
        Use brute module (default False)
    --dns=DNS
        Use DNS resolution (default True)
    --req=REQ
        HTTP request subdomains (default True)
    --port=PORT
        The port range request to the subdomains (default port 80)
    --alive=ALIVE
        Only export alive subdomains (default False)
    --format=FORMAT
        Result format (default csv)
    --path=PATH
        Result directory (default None)
    --takeover=TAKEOVER
        Scan subdomain takeover (default False)

COMMANDS
    COMMAND is one of the following:

     version

🌲Directory structure

For the description of the project's directory structure, please refer to directory_structure.

Description of the subdomain dictionary source:

1. Some common subdomain dictionary in open source tool.
2. List of the most popular subdomains published by domain service providers.

• DNSPod

3. Research results by security researchers:

• the_most_popular_subdomains_on_the_internet
• The most popular subdomains on the internet (2017 edition)
• Top 100000 Subdomains in Certificate Transparency

4. Common naming rules:

• single letter, single letter + single number, double letter, double letter + single number, double letter + double number, three letters, four letters;
• single number, double number, three numbers;

5. The names of tools and software that are common in companies or DevOps.
6. Common Chinese Pinyin words and common English words.
7. Optimize sorting and remove dirty data from the dictionary obtained above.
8. You are very welcome to contribute a better dictionary.

👏Framework used

• aiohttp - Asynchronous HTTP client/server framework for asyncio and Python
• beautifulsoup4 - Beautiful Soup is a library that makes it easy to scrape information from web pages
• fire - Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object
• loguru - Loguru is a library which aims to bring enjoyable logging in Python.
• massdns - A high-performance DNS stub resolver
• records - Records is a very simple, but powerful, library for making raw SQL queries to most relational databases
• requests - A simple, yet elegant HTTP library
• tqdm - A Fast, Extensible Progress Bar for Python and CLI

Thanks to these great Python libraries!

🙏Contribution

Very warmly welcome all people to make OneForAll better together!

⌛Follow-up plan

• Continuous optimize and improve of each module
• Subdomain monitoring (mark newly discovered subdomain)
• Subdomain collection crawler (collect subdomains from static files such as JS)
• Implementation of front-end interface for powerful interaction (tentative: front-end: Element + back-end: Flask)

For more details, read todo.md.

🔖Version control

The project uses SemVer for version management, and you can view the available version in Releases, You can check changes.md) for historical changes.

👨‍💻Contributors

• Jing Ling
  • Core developer

You can see all the developers involved in the project in contributors.md.

📄License

The project has signed a GPL-3.0 license, for more information, please read LICENSE.

😘Acknowledgement

Thanks to the various subdomain collection projects of online open source!

Thanks ace of A-Team for their enthusiastic and unselfish answers!

📜Announce

Please do not use in illegal purposes, don't be a dick.

💖Stargazers over time