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.

쇼단 MCP 서버

표준화된 인터페이스를 통해 Shodan의 인터넷 스캐닝 기능에 대한 액세스를 제공하는 MCP(Model Context Protocol) 서버입니다.

개요

이 서버는 Shodan의 강력한 인터넷 스캐닝 및 정찰 기능을 제공하기 위해 모델 컨텍스트 프로토콜(Model Context Protocol)을 구현합니다. 또한, Shodan의 인터넷 연결 기기, 서비스 및 취약점 데이터베이스를 쿼리하기 위한 표준화된 인터페이스를 제공합니다.

특징

  • 검색 기능 : 고급 검색 필터를 사용하여 Shodan 데이터베이스 쿼리
  • DNS 조회 : 도메인 이름을 확인하고 자세한 DNS 정보를 얻으세요
  • CVE 정보 : 일반적인 취약점 및 노출에 대한 자세한 정보를 얻으세요
  • 취약점 정보 얻기 : IP 주소와 관련된 취약점에 대한 자세한 정보를 얻으세요
  • 표준화된 인터페이스 : 일관된 통신을 위해 MCP 프로토콜을 사용합니다.
  • 환경 변수 지원 : 환경 변수를 통한 안전한 API 키 관리

필수 조건

  • Node.js(v14 이상)
  • npm(v6 이상)
  • Shodan API 키

설치

  1. 저장소를 복제합니다.지엑스피1
  2. 종속성 설치:
    npm install
  3. 루트 디렉토리에 .env.local 파일을 만들고 Shodan API 키를 추가합니다.
    SHODAN_API_KEY=your_api_key_here

용법

서버 시작

  1. 서버를 빌드하세요:
    npm run build
  2. 서버를 시작합니다:
    node build/index.js

사용 가능한 도구

  1. 검색 도구
    • 쿼리: Shodan의 검색 구문을 사용하여 장치 및 서비스 검색
    • 예: log4j country:US city:Atlanta
    • 반환: 자세한 정보가 포함된 일치하는 장치 목록
  2. DNS 조회 도구
    • 쿼리: 확인할 도메인 이름
    • 예: example.com
    • 반환: DNS 레코드 및 관련 정보
  3. CVE 정보 도구
    • 쿼리: CVE 식별자
    • 예: CVE-2021-44228
    • 반환: 자세한 취약점 정보

예제 쿼리

// 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" }

MCP 검사기 사용

MCP 검사기를 사용하면 서버와 직접 상호 작용할 수 있습니다.

  1. MCP 검사기를 설치하세요:
npm install -g @modelcontextprotocol/inspector
  1. 서버에서 검사기를 실행하세요.
npx @modelcontextprotocol/inspector build/index.js

검사관은 다음과 같은 대화형 인터페이스를 제공합니다.

  • 사용 가능한 모든 도구를 테스트하세요
  • 도구 설명서 보기
  • 디버그 서버 응답
  • 서버 상태 모니터링

환경 변수

  • SHODAN_API_KEY : Shodan API 키(필수)
  • PORT : 서버 포트(선택 사항, 기본값은 3000)
  • LOG_LEVEL : 로깅 레벨(선택 사항, 기본값은 'info')

오류 처리

서버는 다음에 대한 포괄적인 오류 처리를 구현합니다.

  • 잘못된 API 키
  • 속도 제한
  • 네트워크 문제
  • 잘못된 쿼리
  • 서버 오류

보안 고려 사항

  1. API 키 보호:
    • API 키를 버전 제어에 커밋하지 마십시오.
    • 민감한 데이터에 환경 변수를 사용하세요
    • API 키를 정기적으로 회전하세요
  2. 속도 제한:
    • Shodan의 API 속도 제한을 존중하세요
    • 클라이언트 측 속도 제한 구현
  3. 데이터 개인정보 보호:
    • 응답에서 민감한 정보 필터링
    • 필요에 따라 액세스 제어를 구현합니다.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여되었습니다. 자세한 내용은 라이선스 파일을 참조하세요.

감사의 말

  • API를 제공해준 Shodan에게 감사드립니다.
  • MCP 사양을 위한 모델 컨텍스트 프로토콜 팀
-
security - not tested
F
license - not found
-
quality - not tested

Shodan API에 대한 액세스를 제공하는 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이를 통해 Shodan에 기기, 취약점 등에 대한 정보를 프로그래밍 방식으로 쿼리할 수 있습니다.

  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