사용 중단 공지

친애하는 Leaktopus 사용자 여러분,

Leaktopus 프로젝트가 공식적으로 중단됨을 알려드립니다. 신중한 평가 후, 저희는 이 라이브러리의 활발한 개발 및 유지보수를 중단하기로 결정했습니다.

이것이 여러분에게 의미하는 바는?

• 새 기능이나 업데이트 없음: Leaktopus에 새로운 기능이나 업데이트를 추가하지 않습니다.
• 보안 패치: 더 이상 보안 패치나 취약점 수정을 제공하지 않습니다.
• 저장소 상태: 저장소가 보관 처리되며, 오늘부터 GitHub에서 프로젝트가 읽기 전용이 됩니다.

---

주요 기능

• Plug&Play - Docker로 한 줄 설치.

• 다양한 소스 스캔 - 키워드 집합이 포함된 소스 스캔 (예: ORGANIZATION-NAME.com).

  현재 지원:

  • GitHub
    • 저장소
    • Gists (출시 예정)
  • Paste 사이트 (예: PasteBin) (출시 예정)

• 내장 휴리스틱 엔진으로 결과 필터링.

• IOL(누출 지표)로 결과 향상:

  • 발견된 소스의 비밀 (Git 저장소 커밋 기록 포함):
    • Shhgit 사용 (사용자 정의 규칙 목록 사용).
    • TruffleHog 사용.
  • URI (조직의 도메인 표시 포함)
  • 이메일 (조직의 이메일 주소 표시 포함)
  • 기여자
  • 민감한 키워드 (예: canary token, 내부 도메인)

• 공개 소스 무시 허용 (예: 웹 크롤러의 "정크" 저장소).

• 일반적인 "정크" 소스에 대한 OOTB 무시 목록.

• 누출 인정, 이전 스캔 이후 소스가 수정된 경우에만 알림 받기.

• 내장 ELK로 누출 데이터 검색 (IOL이 포함된 Git 저장소 전체 인덱스 포함).

• 새 누출 알림

  • MS Teams Webhook.
  • Slack Bot.
  • Cortex XSOAR® (Palo Alto Networks) 통합 (작업 중).

기술 스택

• 완전 Docker화.
• API 중심 Python Flask 백엔드.
• 분리된 Vue.js (3.x) 프론트엔드.
• SQLite DB.
• Celery + Redis 큐를 이용한 비동기 작업.

사전 요구사항

• Docker-Compose

설치

• 저장소 복제
• 로컬 .env 파일 생성
  root@kitploit:~

  cd Leaktopus
  cp .env.example .env
  

• .env를 로컬 설정에 맞게 편집 (내부 주석 참고).
• Leaktopus 실행
  root@kitploit:~

  docker-compose up -d
  

• 설치 API에 접근하여 설치 시퀀스 시작. 브라우저에서 http://{LEAKTOPUS_HOST}:8000/api/install을 열기만 하면 됩니다.
• API가 http://{LEAKTOPUS_HOST}:8000/up에서 실행 중인지 확인.
• UI는 http://{LEAKTOPUS_HOST}:8080에서 사용 가능해야 합니다.

Github App 사용

기본 개인 액세스 토큰 옵션 외에도 Leaktopus는 Github App 인증을 지원합니다. 증가된 속도 제한으로 인해 Github App 사용을 권장합니다.

1. Github App 인증을 사용하려면 Github App을 생성하고 조직/계정에 설치해야 합니다. 자세한 내용은 Github 문서를 참조하세요.

2. 앱 생성 후, 다음 환경 변수를 설정해야 합니다:

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID - 설치 ID는 앱 설치 페이지에서 확인할 수 있습니다.
   • GITHUB_APP_PRIVATE_KEY_PATH (기본값 /app/private-key.pem)

3. 개인 키 파일을 컨테이너에 마운트 (예시는 docker-compose.yml 참조). ./leaktopus_backend/private-key.pem:/app/private-key.pem

* 참고: GITHUB_USE_APP이 True로 설정된 경우 GITHUB_ACCESS_TOKEN은 무시됩니다.

Leaktopus 업데이트

Leaktopus 버전을 업데이트하려면 (최신 버전을 가져오려면) 다음 단계를 따르세요.

• 최신 버전 가져오기.
  root@kitploit:~

  git pull
  

• Docker 이미지 재빌드 (데이터는 삭제되지 않습니다).
  root@kitploit:~

  # Force image recreation
  docker-compose up --force-recreate --build
  

• API를 호출하여 DB 업데이트 실행 (일부 업데이트 후 필요할 수 있음). http://{LEAKTOPUS_HOST}/api/updatedb

결과 필터링 휴리스틱 엔진

내장 휴리스틱 엔진은 검색 결과를 필터링하여 거짓 긍정을 줄입니다:

• 콘텐츠:
  • X개 이상의 비조직 도메인을 포함하는 이메일.
  • X개 이상의 비조직 도메인을 포함하는 URI.
• 메타데이터:
  • X개 이상의 별.
  • X개 이상의 포크.
• 소스 무시 목록.

API 문서

OpenAPI 문서는 http://{LEAKTOPUS_HOST}:8000/apidocs에서 확인할 수 있습니다.

Leaktopus 서비스

위 내용은 사용자 정의 docker-compose.yml 파일을 사용하여 변경할 수 있습니다.

보안 참고사항

현재 Leaktopus는 인증 메커니즘을 제공하지 않습니다. 외부에 노출되지 않도록 하고 Leaktopus 인스턴스에 대한 접근을 제한하기 위해 최선을 다하십시오.

기여

기여는 대환영입니다.

기여 가이드라인 및 문서를 따라주세요.