--- name: theharvester-b03012243d5d description: >- theHarvester is an open-source OSINT tool that collects subdomains, email addresses, IP addresses and URLs for a domain from public sources such as certificate transparency logs, search engines and threat-intelligence APIs. Use it for passive pre-engagement reconnaissance, subdomain enumeration, finding exposed employee emails, and attack-surface checks on domains you are authorized to assess. license: Apache-2.0 compatibility: "Python 3.14 and uv (source checkout), or the Kali theharvester package; outbound internet access" metadata: author: terminal-skills version: "1.1.0" category: research tags: "theharvester, email, subdomain, passive, harvesting" repository: https://github.com/laramies/theHarvester --- # theHarvester ## Overview theHarvester queries public data sources (certificate transparency, search engines, passive DNS, code hosts, threat-intelligence APIs) for a target domain and reports hostnames, emails, IPs, ASNs, URLs and people. By default it only talks to those providers, not to the target ("P0 passive"). DNS actions are P1 and anything that touches the target directly (screenshots, takeover checks, API path scanning, virtual hosts) is P2; both run only when you ask for them. This skill follows the 5.0.0 source on the default branch (the latest tagged release is 4.11.1, June 2026). The 5.0 CLI dropped several sources and options that older tutorials use: `-b google`, `-b bing` and `-b linkedin` no longer exist, and there is no `theHarvester.py` launcher. Run `theHarvester -h` on your version if a flag is rejected. ## Instructions ### Install There is no usable PyPI package: the `theHarvester` name on PyPI is an unrelated 0.0.1 upload. Use one of: ```bash # Source checkout (needs uv; it fetches Python 3.14 itself) git clone https://github.com/laramies/theHarvester.git cd theHarvester uv sync uv run theHarvester -h # Kali Linux (may be an older 4.x version) sudo apt install theharvester ``` The Docker image starts HarvestView (the web UI and REST API), not the CLI. Use a source checkout or the Kali package for command-line work. ### Basic runs ```bash # Two keyless passive sources uv run theHarvester -d terminalskills.io -b crtsh,certspotter # All sources that can return subdomains / emails (capability selectors form a union) uv run theHarvester -d terminalskills.io -b subdomains uv run theHarvester -d terminalskills.io -b emails,urls # Every P0 passive source, results capped at 200 per source, saved as report.json/.xml/.jsonl uv run theHarvester -d terminalskills.io -b all -l 200 -f report ``` Key options: `-d` target, `-b` sources or capabilities (`subdomains`, `emails`, `ips`, `asns`, `urls`, `people`, `breaches`, `all`), `-l` per-source limit (default 500, `0` = no cap), `-f NAME` output files, `-j` parallel sources (default 3), `--no-hosts` drop hostname results, `-q` silence missing-key warnings. `-b all` runs only P0 sources; `shodan` is P1 and must be named. ### Active options (authorized targets only) `-r` resolves discovered hostnames, `-n` does PTR lookups across each IP's /24, `-c` brute-forces DNS, `-t` checks for takeover indicators, `-a` probes common API paths, `--screenshot DIR` captures pages, `--vhost` runs virtual host discovery. These contact DNS servers or the target itself. A takeover indicator is evidence to review, not a confirmed takeover. ### API keys The first run that selects a keyed source creates `~/.theHarvester/api-keys.yaml` (also read from `/etc/theHarvester/` and `/usr/local/etc/theHarvester/`). Edit it and restrict access: ```bash chmod 600 ~/.theHarvester/api-keys.yaml ``` ```yaml apikeys: hunter: key: hk_4f9a1c7e2b virustotal: key: vt_8d21e0b3a5 securityTrails: key: st_6c33f1d09e github: key: ghp_Zk3m9QxT1vLw ``` Sources needing a key are skipped without one. Keyless sources include `crtsh`, `certspotter`, `duckduckgo`, `yahoo`, `baidu`, `otx`, `rapiddns`, `urlscan`, `waybackarchive`, `commoncrawl`, `hudsonrock`. Keyed ones include `hunter`, `virustotal`, `securityTrails`, `dnsdumpster`, `fullhunt`, `github-code`, `intelx`, `tomba`, `netlas`, `leakix` and `shodan`. The full table is in the README ("Discovery sources"). Configure HTTP/SOCKS proxies in `~/.theHarvester/proxies.yaml` and enable them with `-p`; the run fails instead of going direct if no proxy is available. ### Process the output `-f report` writes `report.json` with `hosts` and, when found, `emails` and `ips` lists; with `-r` each host entry is `hostname:ip`. `report.jsonl` holds the normalized evidence (per-source outcomes, counts). ```python import json from pathlib import Path data = json.loads(Path("report.json").read_text()) domain = "terminalskills.io" hosts = sorted({h.split(":")[0] for h in data.get("hosts", []) if h.split(":")[0].endswith(domain)}) emails = sorted({e for e in data.get("emails", []) if e.endswith("@" + domain)}) print(f"{len(hosts)} subdomains, {len(emails)} emails") Path("subdomains.txt").write_text("\n".join(hosts) + "\n") ``` ## Examples ### Example 1: Passive subdomain inventory before a penetration test The user says: "List the public subdomains of terminalskills.io without touching it. We own the domain." ```bash uv run theHarvester -d terminalskills.io -b crtsh,certspotter -l 50 -f subs ``` ```console [*] Activity: P0 passive collection [*] Target: terminalskills.io [*] Searching Certspotter. [*] Searching Crtsh. [*] Hosts found: 4 admin.terminalskills.io api.terminalskills.io docs.terminalskills.io www.terminalskills.io [*] JSONL File saved. ``` Files `subs.json`, `subs.xml` and `subs.jsonl` are written to the current directory. ### Example 2: Exposed employee emails The user says: "Which staff emails for terminalskills.io are findable publicly?" ```bash uv run theHarvester -d terminalskills.io -b emails -l 200 -f emails ``` The `emails` capability runs every source that can return emails; those needing a key are skipped unless configured in `api-keys.yaml`. Read `emails.json` for the `emails` list and confirm each address by hand; scraped results contain false positives. Report the naming pattern (for example `first.last@`) rather than generating guessed addresses. ## Guidelines - Get written authorization first. Passive does not mean invisible: providers receive and may log your target string. - Treat P1/P2 options as active testing; use them only on hosts the engagement scope names exactly (`www.terminalskills.io` and `terminalskills.io` are different targets). - Found hostnames, IPs and ASNs are leads, not extended scope. - Results are partial by nature: a source can finish with zero findings or stop at a rate limit. Read the per-source outcomes in the terminal or the JSONL before concluding that nothing exists. - Do not commit `api-keys.yaml`. - For version-specific differences from 4.x, see `docs/wiki/Moving-from-4.11-to-5.0.md` in the repository. --- Source attribution: terminal-skills Original project: https://github.com/TerminalSkills/skills/blob/8a9852d489f274538be9bf1c9121aeb403750b1c/skills/theharvester/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to the Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by the Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding any notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2025 Terminal Skills Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: terminal-skills Original project: https://github.com/TerminalSkills/skills/blob/8a9852d489f274538be9bf1c9121aeb403750b1c/skills/theharvester/SKILL.md Attribution basis: Source repository record Fields of work: Data & Analytics, Sales, Development & Engineering Roles: Market Research Analyst, Sales Development Rep (SDR), Business Development, Security Engineer, Customer Success Manager Specialties: API Tools: Theharvester Country applicability: Country not specified Classification basis: Source category, role and specialization labels Instruction SHA-256: fe39661e5b19d989e995317e63d8a42e4ddc93d851fc212664b393656b316fd7