subfinder README

The project's README from github.com/projectdiscovery/subfinder. As one markdown file: README.md.

subfinder

Fast passive subdomain enumeration tool.

Features • Install • Usage • API Setup • Library • Join Discord


subfinder is a subdomain discovery tool that returns valid subdomains for websites, using passive online sources. It has a simple, modular architecture and is optimized for speed. subfinder is built for doing one thing only - passive subdomain enumeration, and it does that very well.

We have made it to comply with all the used passive source licenses and usage restrictions. The passive model guarantees speed and stealthiness that can be leveraged by both penetration testers and bug bounty hunters alike.

Features

subfinder

Usage

subfinder -h

This will display help for the tool. Here are all the switches it supports.

Usage:
  ./subfinder [flags]

Flags:
INPUT:
  -d, -domain string[]  domains to find subdomains for
  -dL, -list string     file containing list of domains for subdomain discovery

SOURCE:
  -s, -sources string[]           specific sources to use for discovery (-s crtsh,github). Use -ls to display all available sources.
  -recursive                      use only sources that can handle subdomains recursively (e.g. subdomain.domain.tld vs domain.tld)
  -all                            use all sources for enumeration (slow)
  -es, -exclude-sources string[]  sources to exclude from enumeration (-es alienvault,zoomeyeapi)

FILTER:
  -m, -match string[]   subdomain or list of subdomain to match (file or comma separated)
  -f, -filter string[]   subdomain or list of subdomain to filter (file or comma separated)

RATE-LIMIT:
  -rl, -rate-limit int  maximum number of http requests to send per second
  -rls value            maximum number of http requests to send per second for providers in key=value format (-rls "hackertarget=10/s,shodan=15/s")
  -t int                number of concurrent goroutines for resolving (-active only) (default 10)

UPDATE:
  -up, -update                 update subfinder to latest version
  -duc, -disable-update-check  disable automatic subfinder update check

OUTPUT:
  -o, -output string       file to write output to
  -oJ, -json               write output in JSONL(ines) format
  -oD, -output-dir string  directory to write output (-dL only)
  -cs, -collect-sources    include all sources in the output (-json only)
  -oI, -ip                 include host IP in output (-active only)

CONFIGURATION:
  -config string                flag config file (default "$CONFIG/subfinder/config.yaml")
  -pc, -provider-config string  provider config file (default "$CONFIG/subfinder/provider-config.yaml")
  -r string[]                   comma separated list of resolvers to use
  -rL, -rlist string            file containing list of resolvers to use
  -nW, -active                  display active subdomains only
  -proxy string                 http proxy to use with subfinder
  -ei, -exclude-ip              exclude IPs from the list of domains
  -mr, -max-results int         limit the number of results per source (0 = unlimited; honored by paginating sources)

DEBUG:
  -silent             show only subdomains in output
  -version            show version of subfinder
  -v                  show verbose output
  -nc, -no-color      disable color in output
  -ls, -list-sources  list all available sources (-oJ for JSON)

OPTIMIZATION:
  -timeout int                  seconds to wait before timing out (default 30)
  -max-time int                 minutes to wait for enumeration results (default 10)
  -rsr, -response-size-read int max response body size to read in bytes from passive sources (0 = unlimited)

Environment Variables

Subfinder supports environment variables to specify custom paths for configuration files:

Installation

subfinder requires go1.24 to install successfully. Run the following command to install the latest version:

go install -v github.com/projectdiscovery/subfinder/v2/cmd/subfinder@latest

Learn about more ways to install subfinder here: https://docs.projectdiscovery.io/tools/subfinder/install.

Post Installation Instructions

subfinder can be used right after the installation, however many sources required API keys to work. Learn more here: https://docs.projectdiscovery.io/tools/subfinder/install#post-install-configuration.

Running Subfinder

Learn about how to run Subfinder here: https://docs.projectdiscovery.io/tools/subfinder/running.

Subfinder Go library

Subfinder can also be used as library and a minimal examples of using subfinder SDK is available here

Resources

License

subfinder is made with 🖤 by the projectdiscovery team. Community contributions have made the project what it is. See the THANKS.md file for more details.

Read the usage disclaimer at DISCLAIMER.md and contact us for any API removal.

subfinder (projectdiscovery/subfinder)

Searching Database…

14.6K ·GitHub
Что это такое?Subfinder — это быстрый инструмент пассивного поиска поддоменов, который находит действующие поддомены сайта, запрашивая открытые пассивные источники. Создан для специалистов по тестированию на проникновение и охотников за багами.
Это только CLI-инструмент или его можно использовать и как библиотеку?В первую очередь это CLI-инструмент, но он также поставляется как библиотека на Go (SDK), которую можно напрямую подключить к своим программам на Go для поиска поддоменов.
Нужны ли мне API-ключи, чтобы им пользоваться?Subfinder можно запустить сразу после установки, но многим его пассивным источникам для выдачи результатов нужны API-ключи, которые задаются в файле provider-config.yaml.
Он делает активное сканирование или брутфорс?Нет, он работает строго пассивно: только запрашивает отобранные пассивные источники и не выполняет активных проверок. Это делает его быстрым и незаметным, но ограничивает результаты тем, что эти источники содержат.
Для кого в первую очередь создан этот инструмент?Он рассчитан на специалистов по тестированию на проникновение и охотников за багами, которым нужен быстрый и незаметный поиск поддоменов на этапе разведки.
Можно ли запускать это на любой ОС?Да, так как это бинарный файл на Go, он работает на Linux, macOS и Windows.
Соблюдает ли он условия лицензий источников, которые опрашивает?Да, проект спроектирован так, чтобы соблюдать ограничения на использование и лицензии всех пассивных источников данных, с которыми он интегрирован.
Какие форматы вывода он поддерживает?Subfinder поддерживает несколько форматов вывода: JSON, запись в файл и stdout. Также он хорошо работает со STDIN/STDOUT, так что результаты можно передавать другим инструментам через конвейер.
Можно ли изменить расположение конфигурационных файлов?Да, можно переопределить пути к стандартному конфигу и provider-config с помощью переменных окружения SUBFINDER_CONFIG и SUBFINDER_PROVIDER_CONFIG.
Есть ли готовый Docker-образ?Да, проект поддерживает Docker, так что Subfinder можно запустить в контейнере без установки Go на компьютер.
Size
10.1 MB
Stars
14.6K
Age
8y
Commits · 90 Days