非推奨のお知らせ

Leaktopusユーザーの皆様へ、

Leaktopusプロジェクトは正式に非推奨となります。慎重な評価の結果、このライブラリの活発な開発およびメンテナンスを終了することを決定しました。

これが何を意味するか

• 新機能やアップデートなし: Leaktopusに新機能やアップデートは追加されません。
• セキュリティパッチ: 脆弱性に対するセキュリティパッチや修正は提供されなくなります。
• リポジトリの状態: リポジトリはアーカイブされ、プロジェクトはGitHub上で読み取り専用になります（本日付）。

---

主な機能

• Plaugh&Play - Dockerによるワンラインインストール。

• さまざまなソースをスキャン - キーワードセット（例: ORGANIZATION-NAME.com）を含むソースをスキャンします。

  現在サポート:

  • GitHub
    • リポジトリ
    • Gist（近日対応予定）
  • ペーストサイト（例: PasteBin）（近日対応予定）

• 結果をフィルタリング - 内蔵ヒューリスティックエンジンで。

• IOL（漏洩指標）で結果を強化:

  • 見つかったソース内の機密情報（Gitリポジトリのコミット履歴を含む）:
    • Shhgit（カスタマイズされたルールリストを使用）。
    • TruffleHog。
  • URI（組織のドメインの兆候を含む）
  • メールアドレス（組織のメールアドレスの兆候を含む）
  • コントリビューター
  • 機密キーワード（例: カナリートークン、内部ドメイン）

• 公開ソース（例: Webクローラーによる「ジャンク」リポジトリ）を無視できます。

• 一般的な「ジャンク」ソースの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:~

  # イメージの再作成を強制
  docker-compose up --force-recreate --build
  

• APIを呼び出してDBを更新（一部のアップデート後に必要になる場合があります）。 http://{LEAKTOPUS_HOST}/api/updatedb

結果フィルタリングヒューリスティックエンジン

内蔵ヒューリスティックエンジンは、以下の方法で検索結果をフィルタリングし、誤検出を減らします:

• コンテンツ:
  • 組織外のドメインを含むメールがX件以上。
  • 組織外のドメインを含むURIがX件以上。
• メタデータ:
  • スターがX以上。
  • フォークがX以上。
• ソース除外リスト。

APIドキュメント

OpenAPIドキュメントは http://{LEAKTOPUS_HOST}:8000/apidocs で入手可能です。

Leaktopusサービス

上記はカスタムdocker-compose.ymlファイルを使用してカスタマイズできます。

セキュリティに関する注意

現時点では、Leaktopusは認証メカニズムを提供していません。 外部に公開しないようにし、Leaktopusインスタンスへのアクセスを制限するように最善を尽くしてください。

コントリビューション

コントリビューションは大歓迎です。

コントリビューションガイドラインとドキュメントに従ってください。