# osintverse-community/uncover

Finds exposed hosts by querying Shodan, Censys, FOFA and other internet search engines

## Install and run

```sh
ot install osintverse-community/uncover
ot run osintverse-community/uncover --query 1.1.1.1
```

The first `ot run` installs the tool after asking once. New to `ot`? See https://otinstaller.com/docs/getting-started.

From an AI agent, through ot's MCP server (`ot mcp`):

```
run_tool {"tool":"osintverse-community/uncover","inputs":{"query":"1.1.1.1"}}
```

## Inputs

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `query` | string | yes |  | Search query in the engine's syntax, such as ssl:"example.com" for Shodan, or an IP for shodan-idb |
| `engine` | enum (shodan-idb, shodan, censys, fofa, zoomeye, netlas, criminalip, onyphe, hunter, quake, publicwww, hunterhow, google, driftnet, daydaymap) | no | `shodan-idb` | Search engine to query; shodan-idb (Shodan InternetDB) needs no key, the others need their key |
| `limit` | integer | no |  | Maximum number of results (default 100) |

## Outputs

Finds: ip, domain, other.

- `domain`: Host name, when the engine reports one
- `other`: Open port

## What a run does

- Does not contact the target.
- Does not collect personal data.
- Does not need an account.
- Does not notify the target.
- Usually takes about 20 seconds.
- Publisher's note: It only queries the search engines' APIs, never the hosts. Every engine except shodan-idb needs its own API key, set with `ot keys set`.
- Connects to the internet.

An agent needs the person's consent before running this tool, because it goes online. See https://otinstaller.com/docs/agents#consent.

## API keys

- `SHODAN_API_KEY` (optional, free tier): Shodan API key (engine shodan) Get one at https://account.shodan.io
- `CENSYS_API_TOKEN` (optional, free tier): Censys API token (engine censys) Get one at https://censys.io/register
- `CENSYS_ORGANIZATION_ID` (optional, free tier): Censys organisation ID (engine censys) Get one at https://censys.io/register
- `FOFA_EMAIL` (optional, free tier): FOFA account email (engine fofa) Get one at https://fofa.info
- `FOFA_KEY` (optional, free tier): FOFA API key (engine fofa) Get one at https://fofa.info
- `ZOOMEYE_API_KEY` (optional, free tier): ZoomEye API key (engine zoomeye) Get one at https://www.zoomeye.ai
- `NETLAS_API_KEY` (optional, free tier): Netlas API key (engine netlas) Get one at https://app.netlas.io/registration/
- `CRIMINALIP_API_KEY` (optional, free tier): Criminal IP API key (engine criminalip) Get one at https://www.criminalip.io/register
- `ONYPHE_API_KEY` (optional, free tier): ONYPHE API key (engine onyphe) Get one at https://search.onyphe.io/signup
- `HUNTER_API_KEY` (optional, free tier): Hunter (Qianxin) API key (engine hunter) Get one at https://hunter.qianxin.com
- `QUAKE_TOKEN` (optional, free tier): Quake (360) API token (engine quake) Get one at https://quake.360.net
- `PUBLICWWW_API_KEY` (optional, free tier): PublicWWW API key (engine publicwww) Get one at https://publicwww.com/profile/signup.html
- `HUNTERHOW_API_KEY` (optional, free tier): Hunter.how API key (engine hunterhow) Get one at https://hunter.how
- `GOOGLE_API_KEY` (optional, free tier): Google Custom Search API key (engine google) Get one at https://developers.google.com/custom-search/v1/introduction
- `GOOGLE_API_CX` (optional, free tier): Google Programmable Search engine ID (engine google) Get one at https://programmablesearchengine.google.com/controlpanel/create
- `DRIFTNET_API_KEY` (optional, free tier): Driftnet API key (engine driftnet) Get one at https://driftnet.io
- `DAYDAYMAP_API_KEY` (optional, free tier): DayDayMap API key (engine daydaymap) Get one at https://www.daydaymap.com

Store a key with `ot keys set NAME`; it stays in the OS keychain.

## Trust

- Latest version: 1.2.1
- Signed: yes
- Verified publisher: yes
- Health: unknown
- Installs in the last 30 days: 0
- License: MIT
- Runtime: Docker image, pinned by digest
- Repository: https://github.com/osintverse-community/uncover
- Packaged by the community from a third-party tool

## Links

- Web page: https://otinstaller.com/osintverse-community/uncover
- JSON: https://api.otinstaller.com/v1/tools/osintverse-community/uncover
- README: https://github.com/osintverse-community/uncover#readme
- Homepage: https://github.com/projectdiscovery/uncover
- Security details: https://otinstaller.com/osintverse-community/uncover/security