findomain 0.3.1

The fastest and cross-platform subdomain enumerator, don't waste your time.
Documentation

Follow on Twitter Follow on Twitter

alt text

Mixed feelings with Findomain? Show your love

If you want to support the tool development and make it better, support us :) You will appear here.

Findomain

crates.io Travis CI Status Appveyor CI Status Build status

The fastest and cross-platform subdomain enumerator.

What Findomain can do?

It table gives you a idea why you should use findomain and what it can do for you. The domain used for the test was aol.com in the following BlackArch virtual machine:

Host: KVM/QEMU (Standard PC (i440FX + PIIX, 1996) pc-i440fx-3.1)
Kernel: 5.2.6-arch1-1-ARCH
CPU: Intel (Skylake, IBRS) (4) @ 2.904GHz
Memory: 139MiB / 3943MiB

The tool used to calculate the time, is the time command in Linux.

Enumeration Tool Serch Time Total Subdomains Found CPU Usage RAM Usage
Findomain real 0m6.299s 70582 Very Low Very Low

Summary: 70582 subdomains in 6.3 seconds.

Features

  • Multi-thread support, it makes that the maximun time that Findomain will take to search subdomains for any target is 20 seconds.
  • Discover subdomains without brute-force, it tool uses Certificate Transparency Logs and APIs.
  • Discover only resolved subdomains.
  • Read target from user argument (-t) or file (-f).
  • Write to one unique output file specified by the user all or only resolved subdomains.
  • Write results to automatically named TXT output file(s).
  • Cross platform support: Any platform, it's written in Rust and Rust is multiplatform. See the documentation for instructions.
  • Multiple API support.

Note: the proxy support is just to proxify APIs requests, the actual implementation to discover IP address of subdomains doesn't support proxyfing and it's made using the host network still if you use the -p option.

How it works?

It tool doesn't use the common methods for sub(domains) discover, the tool uses Certificate Transparency logs and specific well tested APIs to find subdomains. It method make it tool the most faster and reliable. The tool make use of multiple public available APIs to perform the search. If you want to know more about Certificate Transparency logs, read https://www.certificate-transparency.org/

APIs that we are using at the moment:

Notes

APIs marked with **, require an access token to work. Search in the Findomain documentation how to configure and use it.

APIs marked with * can optionally be used with an access token, create one if you start experiencing problems with that APIs. Search in the Findomain documentation how to configure and use it.

More APIs?

If you know other APIs that should be added, comment here.

Installation

We offer binarys ready to use for the following platforms (all are for 64 bits only):

If you need to run Findomain in another platform, continue reading the documentation.

Build for 32 bits or another platform

If you want to build the tool for your 32 bits system or another platform, follow it steps:

Note: You need to have rust, make and perl installed in your system first.

Using the crate:

  1. cargo install findomain
  2. Execute the tool from $HOME/.cargo/bin. See the cargo-install documentation.

Using the Github source code:

  1. Clone the repository or download the release source code.
  2. Extract the release source code (only needed if you downloaded the compressed file).
  3. Go to the folder where the source code is.
  4. Execute cargo build --release
  5. Now your binary is in target/release/findomain and you can use it.

Installation Android (Termux)

Install the Termux package, open it and follow it commands:

$ pkg install rust make perl
$ cargo install findomain
$ cd $HOME/.cargo/bin
$ ./findomain

Installation in Linux using source code

If you want to install it, you can do that manually compiling the source or using the precompiled binary.

Manually: You need to have rust, make and perl installed in your system first.

$ git clone https://github.com/Edu4rdSHL/findomain.git
$ cd findomain
$ cargo build --release
$ sudo cp target/release/findomain /usr/bin/
$ findomain

Installation in Linux using compiled artifacts

$ wget https://github.com/Edu4rdSHL/findomain/releases/latest/download/findomain-linux
$ chmod +x findomain-linux
$ ./findomain-linux

If you are using the BlackArch Linux distribution, you just need to use:

$ sudo pacman -S findomain

Installation Aarch64 (Raspberry Pi)

$ wget https://github.com/Edu4rdSHL/findomain/releases/latest/download/findomain-aarch64
$ chmod +x findomain-aarch64
$ ./findomain-aarch64

Installation Windows

Download the binary from https://github.com/Edu4rdSHL/findomain/releases/latest/download/findomain-windows.exe

Open a CMD shell and go to the dir where findomain-windows.exe was downloaded.

Exec: findomain-windows in the CMD shell.

Installation MacOS

$ wget https://github.com/Edu4rdSHL/findomain/releases/latest/download/findomain-osx
$ chmod +x findomain-osx.dms
$ ./findomain-osx.dms

Updating Findomain to latest version

To update Findomain to latest version, you can be in some scenarios:

  1. You downloaded a precompiled binary: If you are using a precompiled binary, then you need to download the new binary.
  2. You are using it from BlackArch Linux: Just run pacman -Syu
  3. You have cloned the repo and compiled it from source: You just need to go to the folder where the repo is cloned and run: git pull && cargo build --release, when finish, you have your executable in target/release/findomain.
  4. You downloaded a source code release and compiled it: You need to download the new source code release and compile it again.
  5. I used cargo install findomain: then just run cargo install --force findomain.

Access tokens configuration

In in section you can found the steps about how to configure APIs that need or can be used with access tokens.

Configuring the Facebook API

History

When I added the Facebook CT API in the beginning I was providing a Webhook token to search in the API, as consequence when a lot of users were using the same token the limit was reached and user can't search in the Facebook API anymore until Facebook unlocked it again. Since Findomain version 0.2.2, users can set their own Facebook Access Token for the webook and pass it to findomain setting the findomain_fb_token system variable. The change was introduced here. Also since 23/08/2019 I have removed the webhook that was providing that API token and it will not work anymore, if you're using findomain < 0.2.2 you are affected, please use a version >= 0.2.2.

Since Findomain 0.2.4 you don't need to explicity set the findomain_fb_token variable in your system, if you don't set that variable then Findomain will use one of our provided access tokens for the Facebook CT API, otherwise, if you set the environment variable then Findomain will use your token. See it commit. Please, if you can create your own token, do it. The usage limit of access tokens is reached when a lot of people use it and then the tool will fail.

Getting the Webhook token

The first step is get your Facebook application token. You need to create a Webhook, follow the next steps:

  1. Open https://developers.facebook.com/apps/
  2. Clic in "Create App", put the name that you want and send the information.
  3. In the next screen, select "Configure" in the Webhooks option.
  4. Go to "Configuration" -> "Basic" and clic on "Show" in the "App secret key" option.
  5. Now open in your browser the following URL: https://graph.facebook.com/oauth/access_token?client_id=your-app-id&client_secret=your-secret-key&grant_type=client_credentials

Note: replace your-app-id by the number of your webhook identifier and your-secret-key for the key that you got in the 4th step.

  1. You should have a JSON like:
{
  "access_token": "xxxxxxxxxx|yyyyyyyyyyyyyyyyyyyyyyy",
  "token_type": "bearer"
}
  1. Save the access_token value.

Now you can use that value to set the access token as following:

Unix based systems (Linux, BSD, MacOS, Android with Termux, etc):

Put in your terminal:

$ findomain_fb_token="YourAccessToken" findomain -(options)

Windows systems:

Put in the CMD command prompt:

> set findomain_fb_token=YourAccessToken && findomain -(options)

Note: In Windows you need to scape special characters like |, add ^ before the special character to scape it and don't quote the token. Example: set findomain_fb_token=xxxxxxx^|yyyyyyyy && findomain -(options)

Tip: If you don't want to write the access token everytime that you run findomain, export the findomain_fb_token in Unix based systems like putting export findomain_fb_token="YourAccessToken" into your .bashrc and set the findomain_fb_token variable in your Windows system as described here.

Configuring the Spyse API to use with token

  1. Open https://account.spyse.com/register and make the registration process (include email verification).
  2. Log in into your spyse account and go to https://account.spyse.com/user
  3. Search for the "API token" section and clic in "Show".
  4. Save that access token.

Now you can use that value to set the access token as following:

Unix based systems (Linux, BSD, MacOS, Android with Termux, etc):

Put in your terminal:

$ findomain_spyse_token="YourAccessToken" findomain -(options)

Windows systems:

Put in the CMD command prompt:

> set findomain_spyse_token=YourAccessToken && findomain -(options)

Note: In Windows you need to scape special characters like |, add ^ before the special character to scape it and don't quote the token. Example: set findomain_spyse_token=xxxxxxx^|yyyyyyyy && findomain -(options)

Tip: If you don't want to write the access token everytime that you run findomain, export the findomain_spyse_token in Unix based systems like putting export findomain_spyse_token="YourAccessToken" into your .bashrc and set the findomain_spyse_token variable in your Windows system as described here.

Configuring the Virustotal API to use with token

  1. Open https://www.virustotal.com/gui/join-us and make the registration process (include email verification).
  2. Log in into your spyse account and go to https://www.virustotal.com/gui/user/YourUsername/apikey
  3. Search for the "API key" section.
  4. Save that API key.

Now you can use that value to set the access token as following:

Unix based systems (Linux, BSD, MacOS, Android with Termux, etc):

Put in your terminal:

$ findomain_virustotal_token="YourAccessToken" findomain -(options)

Windows systems:

Put in the CMD command prompt:

> set findomain_virustotal_token=YourAccessToken && findomain -(options)

Note: In Windows you need to scape special characters like |, add ^ before the special character to scape it and don't quote the token. Example: set findomain_virustotal_token=xxxxxxx^|yyyyyyyy && findomain -(options)

Tip: If you don't want to write the access token everytime that you run findomain, export the findomain_virustotal_token in Unix based systems like putting export findomain_virustotal_token="YourAccessToken" into your .bashrc and set the findomain_virustotal_token variable in your Windows system as described here.

Usage

See findomain -h/--help to see all the options.

findomain 0.3.0
Eduard Tolosa <edu4rdshl@protonmail.com>
The fastest and cross-platform subdomain enumerator, don't waste your time.

USAGE:
    findomain [FLAGS] [OPTIONS]

FLAGS:
    -h, --help        Prints help information
    -o, --output      Write to an output file. The name of the output file will be the target string with TXT format.
    -r, --resolved    Show/write only resolved subdomains.
    -V, --version     Prints version information

OPTIONS:
    -f, --file <file>                      Sets the input file to use.
    -t, --target <target>                  Target host.
    -u, --unique-output <unique-output>    Write all the results for a target or a list of targets to a specified
                                           filename.

You can use the tool in two ways, only discovering the domain name or discovering the domain + the IP address.

Examples

  1. Make a simple search of subdomains and print the info in the screen:

findomain -t example.com

  1. Make a search of subdomains and print the info in the screen:

findomain -t example.com

  1. Make a search of subdomains and export the data to a output file (the output file name in it case is example.com.txt):

findomain -t example.com -o

  1. Make a search of subdomains and export the data to a custom output file name:

findomain -t example.com -u example.txt

  1. Make a search of only resolvable subdomains:

findomain -t example.com -r

  1. Make a search of only resolvable subdomains, exporting the data to a custom output file.

findomain -t example.com -r -u example.txt

  1. Search subdomains from a list of domains passed using a file (you need to put a domain in every line into the file):

findomain -f file_with_domains.txt

  1. Search subdomains from a list of domains passed using a file (you need to put a domain in every line into the file) and save all the resolved domains into a custom file name:

findomain -f file_with_domains.txt -r -u multiple_domains.txt

TODO

  • Add more APIs (It's longterm because I depend of new requests, at the moment I have not more APIs in the mind).

Issues and requests

If you have a problem or a feature request, open an issue.

Stargazers over time

Stargazers over time