332 lines
14 KiB
Python
332 lines
14 KiB
Python
"""
|
||
This plugin provides Shodan.io integration for security research and reconnaissance.
|
||
"""
|
||
|
||
import logging
|
||
import os
|
||
import aiohttp
|
||
import simplematrixbotlib as botlib
|
||
from plugins.common import html_escape, collapsible_summary
|
||
|
||
SHODAN_API_KEY = os.getenv("SHODAN_KEY", "")
|
||
SHODAN_API_BASE = "https://api.shodan.io"
|
||
|
||
async def handle_command(room, message, bot, prefix, config):
|
||
"""
|
||
Function to handle Shodan commands.
|
||
"""
|
||
match = botlib.MessageMatch(room, message, bot, prefix)
|
||
if match.is_not_from_this_bot() and match.prefix() and match.command("shodan"):
|
||
logging.info("Received !shodan command")
|
||
|
||
# Check if API key is configured
|
||
if not SHODAN_API_KEY:
|
||
await bot.api.send_text_message(
|
||
room.room_id,
|
||
"Shodan API key not configured. Please set SHODAN_KEY environment variable."
|
||
)
|
||
logging.error("Shodan API key not configured")
|
||
return
|
||
|
||
args = match.args()
|
||
|
||
if len(args) < 1:
|
||
await show_usage(room, bot)
|
||
return
|
||
|
||
subcommand = args[0].lower()
|
||
|
||
if subcommand == "ip":
|
||
if len(args) < 2:
|
||
await bot.api.send_text_message(room.room_id, "Usage: !shodan ip <ip_address>")
|
||
return
|
||
ip = args[1]
|
||
await shodan_ip_lookup(room, bot, ip)
|
||
|
||
elif subcommand == "search":
|
||
if len(args) < 2:
|
||
await bot.api.send_text_message(room.room_id, "Usage: !shodan search <query>")
|
||
return
|
||
query = ' '.join(args[1:])
|
||
await shodan_search(room, bot, query)
|
||
|
||
elif subcommand == "host":
|
||
if len(args) < 2:
|
||
await bot.api.send_text_message(room.room_id, "Usage: !shodan host <domain/ip>")
|
||
return
|
||
host = args[1]
|
||
await shodan_host(room, bot, host)
|
||
|
||
elif subcommand == "count":
|
||
if len(args) < 2:
|
||
await bot.api.send_text_message(room.room_id, "Usage: !shodan count <query>")
|
||
return
|
||
query = ' '.join(args[1:])
|
||
await shodan_count(room, bot, query)
|
||
|
||
else:
|
||
await show_usage(room, bot)
|
||
|
||
async def show_usage(room, bot):
|
||
"""Display Shodan command usage."""
|
||
usage = """
|
||
<strong>🔍 Shodan Commands:</strong>
|
||
|
||
<strong>!shodan ip <ip_address></strong> - Get detailed information about an IP
|
||
<strong>!shodan search <query></strong> - Search Shodan database
|
||
<strong>!shodan host <domain/ip></strong> - Get host information
|
||
<strong>!shodan count <query></strong> - Count results for a search query
|
||
|
||
<strong>Search Examples:</strong>
|
||
• <code>!shodan search apache</code>
|
||
• <code>!shodan search "port:22"</code>
|
||
• <code>!shodan search "country:US product:nginx"</code>
|
||
• <code>!shodan search "net:192.168.1.0/24"</code>
|
||
"""
|
||
await bot.api.send_markdown_message(room.room_id, usage)
|
||
|
||
async def shodan_ip_lookup(room, bot, ip):
|
||
"""Look up information about a specific IP address."""
|
||
try:
|
||
url = f"{SHODAN_API_BASE}/shodan/host/{ip}?key={SHODAN_API_KEY}"
|
||
logging.info(f"Fetching Shodan IP info for: {ip}")
|
||
async with aiohttp.ClientSession() as session:
|
||
async with session.get(url, timeout=15) as response:
|
||
if response.status == 404:
|
||
await bot.api.send_text_message(room.room_id, f"No information found for IP: {html_escape(ip)}")
|
||
return
|
||
elif response.status == 401:
|
||
await bot.api.send_text_message(room.room_id, "Invalid Shodan API key")
|
||
return
|
||
elif response.status != 200:
|
||
await bot.api.send_text_message(room.room_id, f"Shodan API error: {response.status}")
|
||
return
|
||
|
||
data = await response.json()
|
||
|
||
# Format the response
|
||
output = f"<strong>🔍 Shodan IP Lookup: {html_escape(ip)}</strong><br><br>"
|
||
|
||
if data.get('country_name'):
|
||
output += f"<strong>📍 Location:</strong> {html_escape(data.get('city', 'N/A'))}, {html_escape(data.get('country_name', 'N/A'))}<br>"
|
||
|
||
if data.get('org'):
|
||
output += f"<strong>🏢 Organization:</strong> {html_escape(data['org'])}<br>"
|
||
|
||
if data.get('os'):
|
||
output += f"<strong>💻 Operating System:</strong> {html_escape(data['os'])}<br>"
|
||
|
||
if data.get('ports'):
|
||
output += f"<strong>🔌 Open Ports:</strong> {', '.join(map(str, data['ports']))}<br>"
|
||
|
||
output += f"<strong>🕒 Last Update:</strong> {data.get('last_update', 'N/A')}<br><br>"
|
||
|
||
# Show services
|
||
if data.get('data'):
|
||
output += "<strong>📡 Services:</strong><br>"
|
||
for service in data['data'][:5]: # Limit to first 5 services
|
||
port = service.get('port', 'N/A')
|
||
product = service.get('product', 'Unknown')
|
||
version = service.get('version', '')
|
||
banner = service.get('data', '')[:100] + "..." if len(service.get('data', '')) > 100 else service.get('data', '')
|
||
|
||
output += f" • <strong>Port {port}:</strong> {html_escape(product)} {html_escape(version)}<br>"
|
||
if banner:
|
||
output += f" <em>{html_escape(banner)}</em><br>"
|
||
|
||
if len(data['data']) > 5:
|
||
output += f" • ... and {len(data['data']) - 5} more services<br>"
|
||
|
||
# Wrap in collapsible if output is large
|
||
if len(output) > 500:
|
||
output = collapsible_summary(f"🔍 Shodan IP Lookup: {html_escape(ip)}", output)
|
||
|
||
await bot.api.send_markdown_message(room.room_id, output)
|
||
logging.info(f"Sent Shodan IP info for {ip}")
|
||
|
||
except aiohttp.ClientError as e:
|
||
await bot.api.send_text_message(room.room_id, f"Error fetching Shodan data: {e}")
|
||
logging.error(f"Shodan API error: {e}")
|
||
except Exception as e:
|
||
await bot.api.send_text_message(room.room_id, f"Error: {str(e)}")
|
||
logging.error(f"Error in shodan_ip_lookup: {e}")
|
||
|
||
async def shodan_search(room, bot, query):
|
||
"""Search the Shodan database."""
|
||
try:
|
||
url = f"{SHODAN_API_BASE}/shodan/host/search"
|
||
params = {
|
||
"key": SHODAN_API_KEY,
|
||
"query": query,
|
||
"minify": "true",
|
||
"limit": 5
|
||
}
|
||
logging.info(f"Searching Shodan for: {query}")
|
||
async with aiohttp.ClientSession() as session:
|
||
async with session.get(url, params=params, timeout=15) as response:
|
||
if response.status != 200:
|
||
await handle_shodan_error(room, bot, response.status)
|
||
return
|
||
data = await response.json()
|
||
|
||
if not data.get('matches'):
|
||
await bot.api.send_text_message(room.room_id, f"No results found for: {html_escape(query)}")
|
||
return
|
||
|
||
output = f"<strong>🔍 Shodan Search: '{html_escape(query)}'</strong><br>"
|
||
output += f"<strong>Total Results:</strong> {data.get('total', 0):,}<br><br>"
|
||
|
||
for match in data['matches'][:5]: # Show first 5 results
|
||
ip = match.get('ip_str', 'N/A')
|
||
port = match.get('port', 'N/A')
|
||
org = match.get('org', 'Unknown')
|
||
product = match.get('product', 'Unknown')
|
||
|
||
output += f"<strong>🌐 {html_escape(ip)}:{port}</strong><br>"
|
||
output += f" • <strong>Organization:</strong> {html_escape(org)}<br>"
|
||
output += f" • <strong>Service:</strong> {html_escape(product)}<br>"
|
||
|
||
if match.get('location'):
|
||
loc = match['location']
|
||
if loc.get('city') and loc.get('country_name'):
|
||
output += f" • <strong>Location:</strong> {html_escape(loc['city'])}, {html_escape(loc['country_name'])}<br>"
|
||
|
||
output += "<br>"
|
||
|
||
if data.get('total', 0) > 5:
|
||
output += f"<em>Showing 5 of {data['total']:,} results. Refine your search for more specific results.</em>"
|
||
|
||
await bot.api.send_markdown_message(room.room_id, output)
|
||
logging.info(f"Sent Shodan search results for: {query}")
|
||
|
||
except aiohttp.ClientError as e:
|
||
await bot.api.send_text_message(room.room_id, f"Error searching Shodan: {e}")
|
||
logging.error(f"Shodan API error: {e}")
|
||
except Exception as e:
|
||
await bot.api.send_text_message(room.room_id, f"Error: {str(e)}")
|
||
logging.error(f"Error in shodan_search: {e}")
|
||
|
||
async def shodan_host(room, bot, host):
|
||
"""Get host information (domain or IP)."""
|
||
try:
|
||
url = f"{SHODAN_API_BASE}/dns/domain/{host}?key={SHODAN_API_KEY}"
|
||
logging.info(f"Fetching Shodan host info for: {host}")
|
||
async with aiohttp.ClientSession() as session:
|
||
async with session.get(url, timeout=15) as response:
|
||
if response.status == 404:
|
||
# Try IP lookup instead
|
||
await shodan_ip_lookup(room, bot, host)
|
||
return
|
||
elif response.status != 200:
|
||
await handle_shodan_error(room, bot, response.status)
|
||
return
|
||
data = await response.json()
|
||
|
||
output = f"<strong>🔍 Shodan Host: {html_escape(host)}</strong><br><br>"
|
||
|
||
if data.get('subdomains'):
|
||
output += f"<strong>🌐 Subdomains ({len(data['subdomains'])}):</strong><br>"
|
||
for subdomain in sorted(data['subdomains'])[:10]: # Show first 10
|
||
output += f" • {html_escape(subdomain)}.{html_escape(host)}<br>"
|
||
|
||
if len(data['subdomains']) > 10:
|
||
output += f" • ... and {len(data['subdomains']) - 10} more<br>"
|
||
|
||
if data.get('tags'):
|
||
output += f"<br><strong>🏷️ Tags:</strong> {', '.join(html_escape(t) for t in data['tags'])}<br>"
|
||
|
||
if data.get('data'):
|
||
output += f"<br><strong>📊 Records Found:</strong> {len(data['data'])}<br>"
|
||
|
||
await bot.api.send_markdown_message(room.room_id, output)
|
||
logging.info(f"Sent Shodan host info for: {host}")
|
||
|
||
except aiohttp.ClientError as e:
|
||
await bot.api.send_text_message(room.room_id, f"Error fetching host info: {e}")
|
||
logging.error(f"Shodan API error: {e}")
|
||
except Exception as e:
|
||
await bot.api.send_text_message(room.room_id, f"Error: {str(e)}")
|
||
logging.error(f"Error in shodan_host: {e}")
|
||
|
||
async def shodan_count(room, bot, query):
|
||
"""Count results for a search query."""
|
||
try:
|
||
url = f"{SHODAN_API_BASE}/shodan/host/count"
|
||
params = {
|
||
"key": SHODAN_API_KEY,
|
||
"query": query
|
||
}
|
||
logging.info(f"Counting Shodan results for: {query}")
|
||
async with aiohttp.ClientSession() as session:
|
||
async with session.get(url, params=params, timeout=15) as response:
|
||
if response.status != 200:
|
||
await handle_shodan_error(room, bot, response.status)
|
||
return
|
||
data = await response.json()
|
||
|
||
output = f"<strong>🔍 Shodan Count: '{html_escape(query)}'</strong><br><br>"
|
||
output += f"<strong>Total Results:</strong> {data.get('total', 0):,}<br>"
|
||
|
||
# Show top countries if available
|
||
if data.get('facets') and 'country' in data['facets']:
|
||
output += "<br><strong>🌍 Top Countries:</strong><br>"
|
||
for country in data['facets']['country'][:5]:
|
||
output += f" • {html_escape(country['value'])}: {country['count']:,}<br>"
|
||
|
||
# Show top organizations if available
|
||
if data.get('facets') and 'org' in data['facets']:
|
||
output += "<br><strong>🏢 Top Organizations:</strong><br>"
|
||
for org in data['facets']['org'][:5]:
|
||
output += f" • {html_escape(org['value'])}: {org['count']:,}<br>"
|
||
|
||
await bot.api.send_markdown_message(room.room_id, output)
|
||
logging.info(f"Sent Shodan count for: {query}")
|
||
|
||
except aiohttp.ClientError as e:
|
||
await bot.api.send_text_message(room.room_id, f"Error counting Shodan results: {e}")
|
||
logging.error(f"Shodan API error: {e}")
|
||
except Exception as e:
|
||
await bot.api.send_text_message(room.room_id, f"Error: {str(e)}")
|
||
logging.error(f"Error in shodan_count: {e}")
|
||
|
||
async def handle_shodan_error(room, bot, status_code):
|
||
"""Handle Shodan API errors."""
|
||
error_messages = {
|
||
401: "Invalid Shodan API key",
|
||
403: "Access denied - check API key permissions",
|
||
404: "No results found",
|
||
429: "Rate limit exceeded - try again later",
|
||
500: "Shodan API server error",
|
||
503: "Shodan API temporarily unavailable"
|
||
}
|
||
message = error_messages.get(status_code, f"Shodan API error: {status_code}")
|
||
await bot.api.send_text_message(room.room_id, message)
|
||
logging.error(f"Shodan API error: {status_code}")
|
||
|
||
# ---------------------------------------------------------------------------
|
||
# Plugin Metadata
|
||
# ---------------------------------------------------------------------------
|
||
|
||
__version__ = "1.0.1"
|
||
__author__ = "Funguy Bot"
|
||
__description__ = "Shodan.io reconnaissance"
|
||
__help__ = """
|
||
<details>
|
||
<summary><strong>!shodan</strong> – Shodan search</summary>
|
||
<ul>
|
||
<li><code>!shodan ip <ip></code> – IP info with open ports</li>
|
||
<li><code>!shodan search <query></code> – Search internet devices</li>
|
||
<li><code>!shodan host <domain></code> – Host & subdomain enumeration</li>
|
||
<li><code>!shodan count <query></code> – Result counts</li>
|
||
</ul>
|
||
<strong>Search Examples:</strong>
|
||
<ul>
|
||
<li><code>!shodan search apache</code></li>
|
||
<li><code>!shodan search "port:22"</code></li>
|
||
<li><code>!shodan search "country:US product:nginx"</code></li>
|
||
<li><code>!shodan search "net:192.168.1.0/24"</code></li>
|
||
</ul>
|
||
<p>Requires <strong>SHODAN_KEY</strong> env var.</p>
|
||
</details>
|
||
"""
|