Shodan-MCP-Server

by X3r0K
Verified

Integrations

  • Enables secure API key management through environment variables, supporting configuration of the Shodan API key and other server settings.

  • Hosts the repository for the Shodan MCP Server, allowing users to clone the project for installation.

  • Provides the runtime environment for the MCP server, with version 14 or higher required to run the Shodan integration.

Servidor MCP de Shodan

Un servidor de Protocolo de Contexto Modelo (MCP) que proporciona acceso a las capacidades de escaneo de Internet de Shodan a través de una interfaz estandarizada.

Descripción general

Este servidor implementa el Protocolo de Contexto de Modelo para exponer las potentes capacidades de escaneo y reconocimiento de internet de Shodan. Proporciona una interfaz estandarizada para consultar la base de datos de Shodan de dispositivos, servicios y vulnerabilidades conectados a internet.

Características

  • Capacidades de búsqueda : Consulta la base de datos de Shodan utilizando filtros de búsqueda avanzados
  • Búsqueda de DNS : resuelva nombres de dominio y obtenga información detallada de DNS
  • Información sobre CVE : Obtenga información detallada sobre vulnerabilidades y exposiciones comunes
  • Obtener vulnerabilidades : Obtenga información detallada sobre vulnerabilidades relacionadas con una dirección IP
  • Interfaz estandarizada : utiliza el protocolo MCP para una comunicación consistente
  • Compatibilidad con variables de entorno : gestión segura de claves API mediante variables de entorno

Prerrequisitos

  • Node.js (v14 o superior)
  • npm (v6 o superior)
  • Clave API de Shodan

Instalación

  1. Clonar el repositorio:
    git clone https://github.com/X3r0K/Shodan-MCP-Server-Inspector.git cd shodan-mcp-server-Inspector
  2. Instalar dependencias:
    npm install
  3. Crea un archivo .env.local en el directorio raíz y agrega tu clave API de Shodan:
    SHODAN_API_KEY=your_api_key_here

Uso

Iniciando el servidor

  1. Construir el servidor:
    npm run build
  2. Iniciar el servidor:
    node build/index.js

Herramientas disponibles

  1. Herramienta de búsqueda
    • Consulta: Busque dispositivos y servicios utilizando la sintaxis de búsqueda de Shodan
    • Ejemplo: log4j country:US city:Atlanta
    • Devoluciones: Lista de dispositivos coincidentes con información detallada
  2. Herramienta de búsqueda de DNS
    • Consulta: Nombre de dominio a resolver
    • Ejemplo: example.com
    • Devuelve: registros DNS e información relacionada
  3. Herramienta de información CVE
    • Consulta: identificador CVE
    • Ejemplo: CVE-2021-44228
    • Devoluciones: Información detallada sobre vulnerabilidades

Consultas de ejemplo

// Search for Log4j vulnerable systems in the US { "query": "log4j country:US" } // DNS lookup for a domain { "query": "example.com" } // Get CVE information { "query": "CVE-2021-44228" }

Uso del inspector MCP

Puede utilizar el inspector MCP para interactuar con el servidor directamente:

  1. Instalar el inspector MCP:
npm install -g @modelcontextprotocol/inspector
  1. Ejecute el inspector con su servidor:
npx @modelcontextprotocol/inspector build/index.js

El inspector proporciona una interfaz interactiva para:

  • Pruebe todas las herramientas disponibles
  • Ver la documentación de la herramienta
  • Respuestas del servidor de depuración
  • Supervisar el estado del servidor

Variables de entorno

  • SHODAN_API_KEY : Su clave API de Shodan (obligatoria)
  • PORT : Puerto del servidor (opcional, predeterminado 3000)
  • LOG_LEVEL : Nivel de registro (opcional, el valor predeterminado es 'info')

Manejo de errores

El servidor implementa un manejo integral de errores para:

  • Claves API no válidas
  • Limitación de velocidad
  • Problemas de red
  • Consultas no válidas
  • Errores del servidor

Consideraciones de seguridad

  1. Protección de clave API:
    • Nunca envíe claves API al control de versiones
    • Utilice variables de entorno para datos confidenciales
    • Rotar las claves API periódicamente
  2. Limitación de velocidad:
    • Respete los límites de velocidad de la API de Shodan
    • Implementar la limitación de velocidad del lado del cliente
  3. Privacidad de datos:
    • Filtrar información confidencial de las respuestas
    • Implementar controles de acceso según sea necesario

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

Expresiones de gratitud

  • Shodan por proporcionar la API
  • Equipo del Protocolo de Contexto de Modelo para la especificación MCP
-
security - not tested
F
license - not found
-
quality - not tested

Este es un servidor de Protocolo de Contexto de Modelo (MCP) que proporciona acceso a la API de Shodan. Permite consultar a Shodan programáticamente para obtener información sobre dispositivos, vulnerabilidades y más.

  1. Overview
    1. Features
      1. Prerequisites
        1. Installation
          1. Usage
            1. Starting the Server
            2. Available Tools
            3. Example Queries
            4. Using the MCP Inspector
          2. Environment Variables
            1. Error Handling
              1. Security Considerations
                1. License
                  1. Acknowledgments
                    ID: fi8zaw0bu7