Avviso di Deprecazione

Cari utenti di Leaktopus,

Vi informiamo che il progetto Leaktopus sarà ufficialmente deprecato. Dopo un'attenta valutazione, abbiamo deciso di interrompere lo sviluppo attivo e la manutenzione di questa libreria.

Cosa Significa Questo per Voi?

• Nessuna Nuova Funzionalità o Aggiornamento: Non aggiungeremo nuove funzionalità o aggiornamenti a Leaktopus.
• Patch di Sicurezza: Non forniremo più patch di sicurezza o correzioni per eventuali vulnerabilità.
• Stato del Repository: Il repository sarà archiviato e il progetto diventerà di sola lettura su GitHub, con effetto immediato.

---

Caratteristiche Principali

• Plug&Play - installazione con un solo comando tramite Docker.

• Scansiona varie fonti contenenti un insieme di parole chiave, ad es. NOME-ORGANIZZAZIONE.com.

  Attualmente supporta:

  • GitHub
    • Repository
    • Gist (in arrivo)
  • Siti di Paste (es. PasteBin) (in arrivo)

• Filtra i risultati con un motore euristico integrato.

• Arricchisci i risultati con IOL (Indicatori di Perdita):

  • Segreti nelle fonti trovate (inclusa la cronologia dei commit dei repository Git):
    • Con Shhgit (utilizzando una lista di regole personalizzata).
    • Con TruffleHog.
  • URI (Inclusa indicazione dei domini della tua organizzazione)
  • Email (Inclusa indicazione degli indirizzi email della tua organizzazione)
  • Collaboratori
  • Parole chiave sensibili (es. canary token, domini interni)

• Permette di ignorare fonti pubbliche (es. repository "spazzatura" da web crawler).

• Lista di ignorati preconfigurata di fonti "spazzatura" comuni.

• Riconosci una perdita e ricevi notifiche solo se la fonte è stata modificata dalla scansione precedente.

• ELK integrato per cercare dati nelle perdite (incluso indice completo dei repository Git con IOL).

• Notifica su nuove perdite

  • Webhook di MS Teams.
  • Bot Slack.
  • Integrazione con Cortex XSOAR® (di Palo Alto Networks) (in lavorazione).

Stack Tecnologico

• Completamente Dockerizzato.
• Backend Flask Python API-first.
• Frontend Vue.js (3.x) disaccoppiato.
• Database SQLite.
• Attività asincrone con Celery + code Redis.

Prerequisiti

• Docker-Compose

Installazione

• Clona il repository
• Crea un file .env locale

  cd Leaktopus
  cp .env.example .env
  

• Modifica .env in base alla tua configurazione locale (vedi i commenti interni).
• Avvia Leaktopus

  docker-compose up -d
  

• Avvia la sequenza di installazione accedendo all'API di installazione. Apri semplicemente http://{LEAKTOPUS_HOST}:8000/api/install nel tuo browser.
• Controlla che l'API sia attiva all'indirizzo http://{LEAKTOPUS_HOST}:8000/up
• L'interfaccia utente dovrebbe essere disponibile all'indirizzo http://{LEAKTOPUS_HOST}:8080

Utilizzo di Github App

Oltre all'opzione base del token di accesso personale, Leaktopus supporta l'autenticazione tramite Github App. L'uso di Github App è consigliato a causa dei maggiori limiti di velocità.

1. Per utilizzare l'autenticazione tramite Github App, devi creare una Github App e installarla nella tua organizzazione/account. Vedi la documentazione di Github per maggiori dettagli.

2. Dopo aver creato l'app, devi impostare le seguenti variabili d'ambiente:

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID - L'ID di installazione può essere trovato in your app installation.
   • GITHUB_APP_PRIVATE_KEY_PATH (default /app/private-key.pem)

3. Monta il file della chiave privata nel contenitore (vedi docker-compose.yml per un esempio). ./leaktopus_backend/private-key.pem:/app/private-key.pem

* Nota che GITHUB_ACCESS_TOKEN verrà ignorato se GITHUB_USE_APP è impostato su True.

Aggiornamento di Leaktopus

Se desideri aggiornare la tua versione di Leaktopus (scaricando una versione più recente), segui i passaggi successivi.

• Scarica l'ultima versione.

  git pull
  

• Ricostruisci le immagini Docker (i dati non verranno eliminati).

  # Forza la ricreazione dell'immagine
  docker-compose up --force-recreate --build
  

• Esegui l'aggiornamento del DB chiamando la sua API (potrebbe essere necessario dopo alcuni aggiornamenti). http://{LEAKTOPUS_HOST}/api/updatedb

Motore Euristico di Filtraggio dei Risultati

Il motore euristico integrato filtra i risultati della ricerca per ridurre i falsi positivi tramite:

• Contenuto:
  • Più di X email contenenti domini non organizzativi.
  • Più di X URI contenenti domini non organizzativi.
• Metadati:
  • Più di X stelle.
  • Più di X fork.
• Lista di fonti ignorate.

Documentazione API

La documentazione OpenAPI è disponibile all'indirizzo http://{LEAKTOPUS_HOST}:8000/apidocs.

Servizi di Leaktopus

Servizio	Porta	Obbligatorio/Optionale
Backend (API)	8000	Obbligatorio
Backend (Worker)	N/A	Obbligatorio
Redis	6379	Obbligatorio
Frontend	8080	Opzionale
Elasticsearch	9200	Opzionale
Logstash	5000	Opzionale
Kibana	5601	Opzionale

Quanto sopra può essere personalizzato utilizzando un file docker-compose.yml personalizzato.

Note di Sicurezza

Al momento, Leaktopus non fornisce alcun meccanismo di autenticazione. Assicurati di non esporlo al mondo e di fare del tuo meglio per limitare l'accesso alle tue istanze di Leaktopus.

Contributi

I contributi sono molto graditi.

Segui le nostre linee guida per i contributi e la documentazione.