Aviso de Desuso

Estimados usuarios de Leaktopus,

Queremos informarles que el proyecto Leaktopus será oficialmente descontinuado. Después de una cuidadosa evaluación, hemos decidido detener el desarrollo activo y el mantenimiento de esta biblioteca.

¿Qué Significa Esto para Ustedes?

• Sin Nuevas Funcionalidades ni Actualizaciones: No añadiremos nuevas características ni actualizaciones a Leaktopus.
• Parches de Seguridad: Ya no proporcionaremos parches de seguridad ni correcciones para ninguna vulnerabilidad.
• Estado del Repositorio: El repositorio será archivado y el proyecto pasará a ser de solo lectura en GitHub, a partir de hoy.

---

Características Principales

• Plug&Play - instalación en una línea con Docker.

• Escanea varias fuentes que contienen un conjunto de palabras clave, p.ej. ORGANIZATION-NAME.com.

  Actualmente compatible con:

  • GitHub
    • Repositorios
    • Gists (próximamente)
  • Sitios de paste (p.ej., PasteBin) (próximamente)

• Filtra resultados con un motor heurístico integrado.

• Mejora los resultados con IOL (Indicadores de Fuga):

  • Secretos en las fuentes encontradas (incluyendo el historial de commits de repositorios Git):
    • Con Shhgit (usando una lista de reglas personalizada).
    • Con TruffleHog.
  • URIs (incluyendo indicación de los dominios de su organización)
  • Correos electrónicos (incluyendo indicación de las direcciones de correo de su organización)
  • Contribuyentes
  • Palabras clave sensibles (p.ej., canary token, dominios internos)

• Permite ignorar fuentes públicas (p.ej., repositorios "basura" de rastreadores web).

• Lista de ignorados OOTB de fuentes "basura" comunes.

• Reconocer una fuga, y solo recibir notificación si la fuente ha sido modificada desde el escaneo anterior.

• ELK integrado para buscar datos en fugas (incluyendo índice completo de repositorios Git con IOL).

• Notificar sobre nuevas fugas

  • Webhook de MS Teams.
  • Bot de Slack.
  • Integración con Cortex XSOAR® (de Palo Alto Networks) (en proceso).

Pila Tecnológica

• Completamente Dockerizado.
• Backend API-first con Python Flask.
• Frontend desacoplado con Vue.js (3.x).
• Base de datos SQLite.
• Tareas asíncronas con Celery + colas Redis.

Prerrequisitos

• Docker-Compose

Instalación

• Clonar el repositorio
• Crear un archivo .env local

  cd Leaktopus
  cp .env.example .env
  

• Editar .env según su configuración local (ver los comentarios internos).
• Ejecutar Leaktopus

  docker-compose up -d
  

• Iniciar la secuencia de instalación accediendo a la API de instalación. Simplemente abra http://{LEAKTOPUS_HOST}:8000/api/install en su navegador.
• Verificar que la API esté funcionando en http://{LEAKTOPUS_HOST}:8000/up
• La interfaz de usuario debería estar disponible en http://{LEAKTOPUS_HOST}:8080

Usando Github App

Además de la opción básica de token de acceso personal, Leaktopus admite autenticación mediante Github App. Se recomienda usar Github App debido a los límites de tasa aumentados.

1. Para usar la autenticación de Github App, necesita crear una Github App e instalarla en su organización/cuenta. Ver documentación de Github para más detalles.

2. Después de crear la app, debe establecer las siguientes variables de entorno:

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID - El id de instalación se puede encontrar en su instalación de app.
   • GITHUB_APP_PRIVATE_KEY_PATH (por defecto /app/private-key.pem)

3. Montar el archivo de clave privada en el contenedor (ver docker-compose.yml para un ejemplo). ./leaktopus_backend/private-key.pem:/app/private-key.pem

* Nota: GITHUB_ACCESS_TOKEN será ignorado si GITHUB_USE_APP está establecido en True.

Actualizando Leaktopus

Si desea actualizar su versión de Leaktopus (obtener una versión más reciente), simplemente siga los siguientes pasos.

• Obtener la última versión.

  git pull
  

• Reconstruir las imágenes Docker (los datos no se eliminarán).

  # Forzar recreación de imágenes
  docker-compose up --force-recreate --build
  

• Ejecutar la actualización de la base de datos llamando a su API (puede ser necesario después de algunas actualizaciones). http://{LEAKTOPUS_HOST}/api/updatedb

Motor Heurístico de Filtrado de Resultados

El motor heurístico integrado filtra los resultados de búsqueda para reducir falsos positivos mediante:

• Contenido:
  • Más de X correos electrónicos que contienen dominios no organizacionales.
  • Más de X URIs que contienen dominios no organizacionales.
• Metadatos:
  • Más de X estrellas.
  • Más de X forks.
• Lista de ignorados de fuentes.

Documentación de la API

La documentación de OpenAPI está disponible en http://{LEAKTOPUS_HOST}:8000/apidocs.

Servicios de Leaktopus

Servicio	Puerto	Obligatorio/Opcional
Backend (API)	8000	Obligatorio
Backend (Worker)	N/A	Obligatorio
Redis	6379	Obligatorio
Frontend	8080	Opcional
Elasticsearch	9200	Opcional
Logstash	5000	Opcional
Kibana	5601	Opcional

Lo anterior se puede personalizar usando un archivo docker-compose.yml personalizado.

Notas de Seguridad

Por ahora, Leaktopus no proporciona ningún mecanismo de autenticación. Asegúrese de no exponerlo al mundo y haga todo lo posible para restringir el acceso a su(s) instancia(s) de Leaktopus.

Contribuciones

Las contribuciones son muy bienvenidas.

Por favor, siga nuestras guías de contribución y documentación.