Aviso de Descontinuação

Caros Usuários do Leaktopus,

Queremos informar que o projeto Leaktopus será oficialmente descontinuado. Após uma avaliação cuidadosa, decidimos interromper o desenvolvimento ativo e a manutenção desta biblioteca.

O Que Isso Significa para Você?

• Sem Novos Recursos ou Atualizações: Não adicionaremos novos recursos ou atualizações ao Leaktopus.
• Patches de Segurança: Não forneceremos mais patches de segurança ou correções para quaisquer vulnerabilidades.
• Status do Repositório: O repositório será arquivado e o projeto se tornará somente leitura no GitHub, a partir de hoje.

---

Principais Características

• Plug&Play - instalação em uma linha com Docker.

• Escaneie várias fontes contendo um conjunto de palavras-chave, ex.: ORGANIZATION-NAME.com.

  Atualmente suporta:

  • GitHub
    • Repositórios
    • Gists (em breve)
  • Sites de colagem (ex.: PasteBin) (em breve)

• Filtrar resultados com um motor heurístico embutido.

• Aprimore resultados com IOLs (Indicadores de Vazamento):

  • Segredos nas fontes encontradas (incluindo histórico de commits de repositórios Git):
    • Com Shhgit (usando uma lista de regras personalizada).
    • Com TruffleHog.
  • URIs (Incluindo indicação de domínios da sua organização)
  • Emails (Incluindo indicação de endereços de email da sua organização)
  • Contribuidores
  • Palavras-chave sensíveis (ex.: canary token, domínios internos)

• Permite ignorar fontes públicas (ex.: repositórios "lixo" de rastreadores web).

• Lista de ignorados OOTB de fontes "lixo" comuns.

• Reconhecer um vazamento, e só ser notificado se a fonte foi modificada desde a varredura anterior.

• ELK embutido para pesquisar dados em vazamentos (incluindo índice completo de repositórios Git com IOLs).

• Notificar sobre novos vazamentos

  • MS Teams Webhook.
  • Slack Bot.
  • Integração Cortex XSOAR® (da Palo Alto Networks) (WIP).

Pilha de Tecnologia

• Totalmente Dockerizado.
• Backend Python Flask com foco em API.
• Frontend Vue.js (3.x) desacoplado.
• SQLite DB.
• Tarefas assíncronas com filas Celery + Redis.

Pré-requisitos

• Docker-Compose

Instalação

• Clone o repositório
• Crie um arquivo .env local
  root@kitploit:~

  cd Leaktopus
  cp .env.example .env
  

• Edite o .env de acordo com sua configuração local (veja os comentários internos).
• Execute o Leaktopus
  root@kitploit:~

  docker-compose up -d
  

• Inicie a sequência de instalação acessando a API de instalação. Basta abrir http://{LEAKTOPUS_HOST}:8000/api/install no seu navegador.
• Verifique se a API está funcionando em http://{LEAKTOPUS_HOST}:8000/up
• A interface deve estar disponível em http://{LEAKTOPUS_HOST}:8080

Usando o Github App

Além da opção básica de token de acesso pessoal, o Leaktopus suporta autenticação do Github App. O uso do Github App é recomendado devido aos limites de taxa aumentados.

1. Para usar a autenticação do Github App, você precisa criar um Github App e instalá-lo na sua organização/conta. Veja a documentação do Github para mais detalhes.

2. Após criar o app, você precisa definir as seguintes variáveis de ambiente:

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID - O id de instalação pode ser encontrado em sua instalação do app.
   • GITHUB_APP_PRIVATE_KEY_PATH (padrão /app/private-key.pem)

3. Monte o arquivo de chave privada no contêiner (veja docker-compose.yml para um exemplo). ./leaktopus_backend/private-key.pem:/app/private-key.pem

* Observe que GITHUB_ACCESS_TOKEN será ignorado se GITHUB_USE_APP estiver definido como True.

Atualizando o Leaktopus

Se você deseja atualizar sua versão do Leaktopus (obtendo uma versão mais recente), siga os próximos passos.

• Baixe a versão mais recente.
  root@kitploit:~

  git pull
  

• Reconstrua as imagens Docker (os dados não serão excluídos).
  root@kitploit:~

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

• Execute a atualização do banco de dados chamando sua API (pode ser necessário após algumas atualizações). http://{LEAKTOPUS_HOST}/api/updatedb

Motor Heurístico de Filtragem de Resultados

O motor heurístico embutido filtra os resultados da pesquisa para reduzir falsos positivos por:

• Conteúdo:
  • Mais de X emails contendo domínios não organizacionais.
  • Mais de X URIs contendo domínios não organizacionais.
• Metadados:
  • Mais de X estrelas.
  • Mais de X forks.
• Lista de ignorados de fontes.

Documentação da API

A documentação OpenAPI está disponível em http://{LEAKTOPUS_HOST}:8000/apidocs.

Leaktopus Services

O acima pode ser personalizado usando um arquivo docker-compose.yml customizado.

Notas de Segurança

Atualmente, o Leaktopus não fornece nenhum mecanismo de autenticação. Certifique-se de não expô-lo ao mundo e faça o possível para restringir o acesso à(s) sua(s) instância(s) do Leaktopus.

Contribuindo

Contribuições são muito bem-vindas.

Por favor, siga nossas diretrizes de contribuição e documentação.