*******************************************************************
*                                                                 *
* | |_| |__   ___    /\  /\__ _ _ ____   _____  ___| |_ ___ _ __  *
* | __| '_ \ / _ \  / /_/ / _` | '__\ \ / / _ \/ __| __/ _ \ '__| *
* | |_| | | |  __/ / __  / (_| | |   \ V /  __/\__ \ ||  __/ |    *
*  \__|_| |_|\___| \/ /_/ \__,_|_|    \_/ \___||___/\__\___|_|    *
*                                                                 *
* theHarvester 3.1.0 dev                                          *
* Coded by Christian Martorella                                   *
* Edge-Security Research                                          *
* cmartorella@edge-security.com                                   *
*******************************************************************

What is this?

theHarvester is a very simple, yet effective tool designed to be used in the early
stages of a penetration test. Use it for open source intelligence gathering and
helping to determine a company's external threat landscape on the internet. The
tool gathers emails, names, subdomains, IPs, and URLs using multiple public data
sources that include:

Passive:

• baidu: Baidu search engine - www.baidu.com

• bing: Microsoft search engine - www.bing.com

• bingapi: Microsoft search engine, through the API (Requires API key, see below.)

• censys: Censys.io search engine - www.censys.io

• crtsh: Comodo Certificate search - www.crt.sh

• dnsdumpster: DNSdumpster search engine - dnsdumpster.com

• dogpile: Dogpile search engine - www.dogpile.com

• duckduckgo: DuckDuckGo search engine - www.duckduckgo.com

• github-code: Github code search engine (Requires Github Personal Access Token, see below.) - www.github.com

• google: Google search engine (Optional Google dorking.) - www.google.com

• google-certificates: Google Certificate Transparency report

• hunter: Hunter search engine (Requires API key, see below.) - www.hunter.io

• intelx: Intelx search engine (Requires API key, see below.) - www.intelx.io

• linkedin: Google search engine, specific search for Linkedin users - www.linkedin.com

• netcraft: Netcraft Data Mining - www.netcraft.com

• securityTrails: Security Trails search engine, the world's largest repository
  of historical DNS data (Requires API key, see below.) - www.securitytrails.com

• shodan: Shodan search engine, will search for ports and banners from discovered
  hosts - www.shodanhq.com

• threatcrowd: Open source threat intelligence - www.threatcrowd.org

• trello: Search trello boards (Uses Google search.)

• twitter: Twitter accounts related to a specific domain (Uses Google search.)

• vhost: Bing virtual hosts search

• virustotal: virustotal.com domain search

• yahoo: Yahoo search engine

• all: currently a subset of all the most effective plugins

Active:

• DNS brute force: dictionary brute force enumeration
• DNS reverse lookup: reverse lookup of IP´s discovered in order to find hostnames
• DNS TDL expansion: TLD dictionary brute force enumeration

Modules that require an API key:

Add your keys to api-keys.yaml

• bingapi
• github
• hunter
• intelx
• securityTrails
• shodan

Dependencies:

• Python 3.6+
• python3 -m pip install -r requirements.txt
• Recommend that you use a virtualenv when cloning from git

Comments, bugs, or requests?

• Christian Martorella @laramies
• cmartorella@edge-security.com

Main contributors:

• Matthew Brown @NotoriousRebel1
• Jay "L1ghtn1ng" Townsend @jay_townsend1
• Janos Zold
• Lee Baird @discoverscripts

Thanks:

• John Matherly - Shodan project
• Ahmed Aboul Ela - subdomain names dictionaries (big and small)