Einstellungsmitteilung

Liebe Leaktopus-Nutzer,

Wir möchten Sie darüber informieren, dass das Leaktopus-Projekt offiziell eingestellt wird. Nach sorgfältiger Prüfung haben wir beschlossen, die aktive Entwicklung und Wartung dieser Bibliothek einzustellen.

Was bedeutet das für Sie?

• Keine neuen Funktionen oder Updates: Wir werden Leaktopus keine neuen Funktionen oder Updates hinzufügen.
• Sicherheitspatches: Wir werden keine Sicherheitspatches oder Fehlerbehebungen für Schwachstellen mehr bereitstellen.
• Repository-Status: Das Repository wird archiviert und das Projekt wird ab heute auf GitHub schreibgeschützt.

---

Hauptfunktionen

• Plug&Play - Einzeilige Installation mit Docker.

• Durchsuchen verschiedener Quellen, die eine Reihe von Schlüsselwörtern enthalten, z.B. ORGANIZATION-NAME.com.

  Derzeit unterstützt:

  • GitHub
    • Repositories
    • Gists (demnächst)
  • Paste-Sites (z.B. PasteBin) (demnächst)

• Ergebnisse filtern mit einer integrierten heuristischen Engine.

• Ergebnisse mit IOLs anreichern (Indikatoren für Lecks):

  • Geheimnisse in den gefundenen Quellen (einschließlich Git-Repository-Commit-Verlauf):
    • Mit Shhgit (unter Verwendung einer angepassten Regelliste).
    • Mit TruffleHog.
  • URIs (einschließlich Hinweis auf die Domänen Ihrer Organisation)
  • E-Mails (einschließlich Hinweis auf die E-Mail-Adressen Ihrer Organisation)
  • Mitwirkende
  • Sensitive Schlüsselwörter (z.B. Canary-Token, interne Domänen)

• Ermöglicht es, öffentliche Quellen zu ignorieren (z.B. "Junk"-Repositories von Webcrawlern).

• Vorkonfigurierte Ignorierliste für gängige "Junk"-Quellen.

• Ein Leck bestätigen und nur benachrichtigt werden, wenn die Quelle seit dem vorherigen Scan geändert wurde.

• Integriertes ELK zur Suche nach Daten in Lecks (einschließlich vollständigem Index von Git-Repositories mit IOLs).

• Über neue Lecks benachrichtigen

  • MS Teams Webhook.
  • Slack Bot.
  • Cortex XSOAR® (von Palo Alto Networks) Integration (in Arbeit).

Technologie-Stack

• Vollständig dockerisiert.
• API-first Python Flask Backend.
• Entkoppeltes Vue.js (3.x) Frontend.
• SQLite-Datenbank.
• Asynchrone Aufgaben mit Celery + Redis-Warteschlangen.

Voraussetzungen

• Docker-Compose

Installation

• Repository klonen
• Eine lokale .env-Datei erstellen
  root@kitploit:~

  cd Leaktopus
  cp .env.example .env
  

• Bearbeiten Sie .env gemäß Ihrer lokalen Konfiguration (siehe die internen Kommentare).
• Leaktopus ausführen
  root@kitploit:~

  docker-compose up -d
  

• Starten Sie die Installationssequenz durch Aufruf der Installations-API. Öffnen Sie einfach http://{LEAKTOPUS_HOST}:8000/api/install in Ihrem Browser.
• Überprüfen Sie, ob die API unter http://{LEAKTOPUS_HOST}:8000/up läuft.
• Die UI sollte unter http://{LEAKTOPUS_HOST}:8080 verfügbar sein.

Verwenden der Github App

Zusätzlich zur Option des persönlichen Zugriffstokens unterstützt Leaktopus die Authentifizierung über die Github App. Die Verwendung der Github App wird aufgrund der höheren Ratenlimits empfohlen.

1. Um die Github App-Authentifizierung zu nutzen, müssen Sie eine Github App erstellen und in Ihrer Organisation/Ihrem Konto installieren. Weitere Informationen finden Sie in der Github-Dokumentation für weitere Details.

2. Nach der Erstellung der App müssen Sie die folgenden Umgebungsvariablen setzen:

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID - Die Installations-ID finden Sie in Ihrer App-Installation.
   • GITHUB_APP_PRIVATE_KEY_PATH (Standardmäßig /app/private-key.pem)

3. Binden Sie die private Schlüsseldatei in den Container ein (siehe docker-compose.yml für ein Beispiel). ./leaktopus_backend/private-key.pem:/app/private-key.pem

* Beachten Sie, dass GITHUB_ACCESS_TOKEN ignoriert wird, wenn GITHUB_USE_APP auf True gesetzt ist.

Aktualisieren von Leaktopus

Wenn Sie Ihre Leaktopus-Version aktualisieren möchten (eine neuere Version ziehen), führen Sie einfach die folgenden Schritte aus.

• Die neueste Version ziehen.
  root@kitploit:~

  git pull
  

• Docker-Images neu erstellen (Daten werden nicht gelöscht).
  root@kitploit:~

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

• Führen Sie das DB-Update durch Aufruf seiner API aus (sollte nach einigen Updates erforderlich sein). http://{LEAKTOPUS_HOST}/api/updatedb

Heuristische Engine zur Ergebnisfilterung

Die integrierte heuristische Engine filtert die Suchergebnisse, um Fehlalarme zu reduzieren, indem:

• Inhalt:
  • Mehr als X E-Mails mit nicht-organisationalen Domänen.
  • Mehr als X URIs mit nicht-organisationalen Domänen.
• Metadaten:
  • Mehr als X Sterne.
  • Mehr als X Forks.
• Quellen-Ignorierliste.

API-Dokumentation

Die OpenAPI-Dokumentation ist unter http://{LEAKTOPUS_HOST}:8000/apidocs verfügbar.

Leaktopus-Dienste

Das oben Genannte kann durch eine benutzerdefinierte docker-compose.yml-Datei angepasst werden.

Sicherheitshinweise

Derzeit bietet Leaktopus keinen Authentifizierungsmechanismus. Stellen Sie sicher, dass Sie es nicht der Welt zugänglich machen, und tun Sie Ihr Bestes, um den Zugriff auf Ihre Leaktopus-Instanz(en) einzuschränken.

Mitwirken

Beiträge sind sehr willkommen.

Bitte folgen Sie unseren Beitragsrichtlinien und der Dokumentation.