Installing Subfinder
Learn about how to install and get started with Subfinder
Installation notes
- Subfinder requires the latest version of Go
- Add the Go bin path to the system paths. On OSX or Linux, in your terminal use
- To add the path in Windows, click this link for instructions.
- The binary will be located in
$home/go/bin/subfinder
Post install configuration
Subfinder is available immediately after installation, however the following services require the configuration of API keys to work:
BeVigil, BinaryEdge, BufferOver, C99, Censys, CertSpotter, Chaos, Chinaz, DNSDB, Fofa, FullHunt, GitHub, Intelx, PassiveTotal, quake, Robtex, SecurityTrails, Shodan, ThreatBook, VirusTotal, WhoisXML API, ZoomEye API china - worldwide, dnsrepo, Hunter, Facebook, BuiltWith
You can also use the subfinder -ls
command to display all the available sources.
These values are stored in the $HOME/.config/subfinder/provider-config.yaml
file which will be created when you run the tool for the first time.
The configuration file uses the YAML format. Multiple API keys can be specified for each of these services from which one of them will be used for enumeration.
Composite keys for sources like, Censys, PassiveTotal, Fofa, Intellix and 360quake, need to be separated with a colon (:).
Example provider config
An example provider config file:
RedHunt Lab Attack Surface Recon API
RedHunt Labs’s Attack Surface Recon API has different API endpoints depending on the user’s subscription. Make sure to add the appropriate endpoint before running any scans.
ZoomEye API
Before conducting any scans, please ensure you are using the correct host to comply with geographical access restrictions of the ZoomEye API:
- zoomeye.org is exclusively for users within China.
- zoomeye.hk is for users outside China.