Avis de dépréciation

Chers utilisateurs de Leaktopus,

Nous souhaitons vous informer que le projet Leaktopus sera officiellement abandonné. Après une évaluation minutieuse, nous avons décidé d'arrêter le développement actif et la maintenance de cette bibliothèque.

Qu'est-ce que cela signifie pour vous ?

• Aucune nouvelle fonctionnalité ni mise à jour : Nous n'ajouterons aucune nouvelle fonctionnalité ni mise à jour à Leaktopus.
• Correctifs de sécurité : Nous ne fournirons plus de correctifs de sécurité ni de correctifs pour les vulnérabilités.
• Statut du dépôt : Le dépôt sera archivé et le projet deviendra en lecture seule sur GitHub, à compter d'aujourd'hui.

---

Fonctionnalités clés

• Plug&Play - installation en une ligne avec Docker.

• Scannez diverses sources contenant un ensemble de mots-clés, par ex. ORGANIZATION-NAME.com.

  Prend actuellement en charge :

  • GitHub
    • Dépôts
    • Gists (bientôt disponible)
  • Sites de paste (ex. PasteBin) (bientôt disponible)

• Filtrez les résultats avec un moteur heuristique intégré.

• Améliorez les résultats avec des IOLs (Indicateurs de Fuite) :

  • Secrets dans les sources trouvées (y compris l'historique des commits des dépôts Git) :
    • Avec Shhgit (en utilisant une liste de règles personnalisée).
    • Avec TruffleHog.
  • URIs (y compris l'indication des domaines de votre organisation)
  • Emails (y compris l'indication des adresses email de votre organisation)
  • Contributeurs
  • Mots-clés sensibles (ex. canary token, domaines internes)

• Permet d'ignorer les sources publiques, (ex. dépôts « indésirables » par les robots d'exploration).

• Liste d'ignorage prête à l'emploi des sources « indésirables » courantes.

• Reconnaissez une fuite, et ne soyez notifié que si la source a été modifiée depuis l'analyse précédente.

• ELK intégré pour rechercher des données dans les fuites (y compris l'index complet des dépôts Git avec IOLs).

• Notifier en cas de nouvelles fuites

  • Webhook MS Teams.
  • Bot Slack.
  • Intégration Cortex XSOAR® (par Palo Alto Networks) (WIP).

Pile technologique

• Entièrement dockerisé.
• Backend Flask Python orienté API.
• Frontend Vue.js (3.x) découplé.
• Base de données SQLite.
• Tâches asynchrones avec Celery + files d'attente Redis.

Prérequis

• Docker-Compose

Installation

• Clonez le dépôt
• Créez un fichier .env local
  root@kitploit:~

  cd Leaktopus
  cp .env.example .env
  

• Modifiez le fichier .env en fonction de votre configuration locale (voir les commentaires internes).
• Exécutez Leaktopus
  root@kitploit:~

  docker-compose up -d
  

• Lancez la séquence d'installation en accédant à l'API d'installation. Ouvrez simplement http://{LEAKTOPUS_HOST}:8000/api/install dans votre navigateur.
• Vérifiez que l'API fonctionne à l'adresse http://{LEAKTOPUS_HOST}:8000/up
• L'interface utilisateur devrait être disponible à l'adresse http://{LEAKTOPUS_HOST}:8080

Utilisation de Github App

En plus de l'option de base du jeton d'accès personnel, Leaktopus prend en charge l'authentification via Github App. L'utilisation de Github App est recommandée en raison des limites de débit accrues.

1. Pour utiliser l'authentification Github App, vous devez créer une Github App et l'installer sur votre organisation/compte. Voir la documentation de Github pour plus de détails.

2. Après avoir créé l'application, vous devez définir les variables d'environnement suivantes :

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID - L'identifiant d'installation se trouve dans l'installation de votre application.
   • GITHUB_APP_PRIVATE_KEY_PATH (par défaut /app/private-key.pem)

3. Montez le fichier de clé privée dans le conteneur (voir docker-compose.yml pour un exemple). ./leaktopus_backend/private-key.pem:/app/private-key.pem

* Notez que GITHUB_ACCESS_TOKEN sera ignoré si GITHUB_USE_APP est défini sur True.

Mise à jour de Leaktopus

Si vous souhaitez mettre à jour votre version de Leaktopus (en tirant une version plus récente), suivez simplement les étapes suivantes.

• Tirez la dernière version.
  root@kitploit:~

  git pull
  

• Reconstruisez les images Docker (les données ne seront pas supprimées).
  root@kitploit:~

  # Forcer la recréation des images
  docker-compose up --force-recreate --build
  

• Exécutez la mise à jour de la base de données en appelant son API (peut être nécessaire après certaines mises à jour). http://{LEAKTOPUS_HOST}/api/updatedb

Moteur heuristique de filtrage des résultats

Le moteur heuristique intégré filtre les résultats de recherche pour réduire les faux positifs en :

• Contenu :
  • Plus de X emails contenant des domaines non organisationnels.
  • Plus de X URI contenant des domaines non organisationnels.
• Métadonnées :
  • Plus de X étoiles.
  • Plus de X forks.
• Liste d'ignorage des sources.

Documentation de l'API

La documentation OpenAPI est disponible à l'adresse http://{LEAKTOPUS_HOST}:8000/apidocs.

Services Leaktopus

Ce qui précède peut être personnalisé en utilisant un fichier docker-compose.yml personnalisé.

Notes de sécurité

Pour l'instant, Leaktopus ne fournit aucun mécanisme d'authentification. Assurez-vous de ne pas l'exposer au monde extérieur et faites de votre mieux pour restreindre l'accès à votre (vos) instance(s) Leaktopus.

Contribution

Les contributions sont les bienvenues.

Veuillez suivre nos directives de contribution et documentation.