theHarvester/README.md

117 lines
4 KiB
Markdown
Raw Normal View History

2018-08-09 03:40:29 +08:00
```
*******************************************************************
2014-12-17 07:28:01 +08:00
* *
* | |_| |__ ___ /\ /\__ _ _ ____ _____ ___| |_ ___ _ __ *
* | __| '_ \ / _ \ / /_/ / _` | '__\ \ / / _ \/ __| __/ _ \ '__| *
* | |_| | | | __/ / __ / (_| | | \ V / __/\__ \ || __/ | *
* \__|_| |_|\___| \/ /_/ \__,_|_| \_/ \___||___/\__\___|_| *
* *
2019-02-26 11:02:08 +08:00
* theHarvester 3.0.6 v322 *
2014-12-17 07:28:01 +08:00
* Coded by Christian Martorella *
* Edge-Security Research *
* cmartorella@edge-security.com *
2018-08-09 03:40:29 +08:00
*******************************************************************
```
2019-02-11 05:56:01 +08:00
[![Build Status](https://travis-ci.com/laramies/theHarvester.svg?branch=master)](https://travis-ci.com/laramies/theHarvester)
2011-05-04 23:07:06 +08:00
What is this?
-------------
2019-01-02 06:40:40 +08:00
theHarvester is a very simple, yet effective tool designed to be used in the early<br>
stages of a penetration test. Use it for open source intelligence gathering and helping<br>
to determine a company's external threat landscape on the internet. The tool gathers<br>
2019-01-02 10:08:05 +08:00
emails, names, subdomains, IPs, and URLs using multiple public data sources that include:
2018-12-23 04:29:11 +08:00
Passive:
--------
* baidu: Baidu search engine
2011-05-04 23:07:06 +08:00
2018-12-23 04:29:11 +08:00
* bing: Microsoft search engine - www.bing.com
2011-05-04 23:07:06 +08:00
2018-12-23 04:29:11 +08:00
* bingapi: Microsoft search engine, through the API (Requires API key, see below.)
2018-03-23 06:40:41 +08:00
2019-01-01 19:58:14 +08:00
* censys: Censys.io search engine
2018-03-23 06:40:41 +08:00
2018-08-09 03:44:02 +08:00
* crtsh: Comodo Certificate search - www.crt.sh
2018-03-23 06:40:41 +08:00
2019-01-01 19:58:14 +08:00
* cymon: Cymon.io search engine
2018-12-23 04:29:11 +08:00
* dogpile: Dogpile search engine - www.dogpile.com
2014-12-17 07:33:13 +08:00
2019-01-23 06:29:04 +08:00
* duckduckgo: DuckDuckGo search engine - www.duckduckgo.com
2019-01-02 10:43:42 +08:00
2018-12-27 15:19:13 +08:00
* google: Google search engine (Optional Google dorking.) - www.google.com
2018-12-23 04:29:11 +08:00
* google-certificates: Google Certificate Transparency report
2018-12-27 15:19:13 +08:00
* hunter: Hunter search engine (Requires API key, see below.) - www.hunter.io
2019-02-01 05:13:37 +08:00
* intelx: Intelx search engine (Requires API key, see below.) - www.intelx.io
2018-12-18 07:14:42 +08:00
* linkedin: Google search engine, specific search for Linkedin users
2019-01-01 19:58:14 +08:00
* netcraft: Netcraft Data Mining
2014-12-17 07:33:13 +08:00
2019-01-27 09:01:30 +08:00
* securityTrails: Security Trails search engine, the world's largest repository<br>
2018-12-27 15:19:13 +08:00
of historical DNS data (Requires API key, see below.) - www.securitytrails.com
2018-12-27 15:19:13 +08:00
* shodan: Shodan search engine, will search for ports and banners from discovered<br>
hosts - www.shodanhq.com
2014-12-17 07:33:13 +08:00
2018-12-23 04:29:11 +08:00
* threatcrowd: Open source threat intelligence - www.threatcrowd.org
2014-12-17 07:33:13 +08:00
* trello: Search trello boards (Uses Google search.)
2015-05-11 06:37:00 +08:00
2018-12-23 04:29:11 +08:00
* twitter: Twitter accounts related to a specific domain (Uses Google search.)
* vhost: Bing virtual hosts search
2014-12-17 07:33:13 +08:00
2019-01-23 06:29:04 +08:00
* virustotal: Virustotal.com domain search
2018-12-23 04:29:11 +08:00
* yahoo: Yahoo search engine
2019-01-01 19:58:14 +08:00
* all: currently a subset of all the most effective plugins
2018-11-23 07:33:04 +08:00
Active:
-------
2018-12-23 04:29:11 +08:00
* DNS brute force: dictionary brute force enumeration
* DNS reverse lookup: reverse lookup of IP´s discovered in order to find hostnames
2018-08-09 03:44:02 +08:00
* DNS TDL expansion: TLD dictionary brute force enumeration
2018-12-23 04:29:11 +08:00
Modules that require an API key:
--------------------------------
Add your keys to api-keys.yaml
2018-12-27 15:19:13 +08:00
* hunter: API key
2019-02-01 05:13:37 +08:00
* intelx: API key
2019-01-28 12:56:20 +08:00
* securityTrails: API key
2018-12-27 15:19:13 +08:00
* shodan: API key
2011-05-04 23:07:06 +08:00
Dependencies:
2018-12-23 04:29:11 +08:00
-------------
2019-01-02 06:40:40 +08:00
* Python 3.6
* python3 -m pip install -r requirements.txt
2018-12-27 15:19:13 +08:00
Changelog in 3.0:
-----------------
* Subdomain takeover checks.
* Port scanning (basic).
* Improved DNS dictionary.
* Shodan DB search fixed.
* Result storage in Sqlite.
2018-03-23 06:40:41 +08:00
2018-12-23 04:29:11 +08:00
Comments, bugs, or requests?
----------------------------
2011-05-04 23:07:06 +08:00
cmartorella@edge-security.com
2019-01-09 07:49:26 +08:00
Main contributors:
------------------
* Matthew Brown @NotoriousRebel
2018-12-27 15:19:13 +08:00
* Janos Zold @Jzold
* Lee Baird @discoverscripts [![Twitter Follow](https://img.shields.io/twitter/follow/discoverscripts.svg?style=social&label=Follow)](https://twitter.com/discoverscripts)
* Jay Townsend @L1ghtn1ng [![Twitter Follow](https://img.shields.io/twitter/follow/jay_townsend1.svg?style=social&label=Follow)](https://twitter.com/jay_townsend1)
2019-01-09 07:49:26 +08:00
Thanks:
-------
2019-01-01 19:58:14 +08:00
* John Matherly - Shodan project
2018-12-23 04:29:11 +08:00
* Ahmed Aboul Ela - subdomain names dictionaries (big and small)