Уведомление о прекращении поддержки

Уважаемые пользователи Leaktopus,

Сообщаем вам, что проект Leaktopus будет официально прекращён. После тщательной оценки мы приняли решение прекратить активную разработку и поддержку этой библиотеки.

Что это значит для вас?

• Новых функций или обновлений не будет: Мы не будем добавлять новые функции или обновления в Leaktopus.
• Обновления безопасности: Мы больше не будем предоставлять исправления безопасности или исправления для каких-либо уязвимостей.
• Статус репозитория: Репозиторий будет заархивирован, и проект станет доступен только для чтения на GitHub, начиная с сегодняшнего дня.

---

Ключевые возможности

• Plug&Play — установка в одну строку с помощью Docker.

• Сканирование различных источников, содержащих набор ключевых слов, например ORGANIZATION-NAME.com.

  В настоящее время поддерживаются:

  • GitHub
    • Репозитории
    • Gists (скоро)
  • Сайты с вставками (например, PasteBin) (скоро)

• Фильтрация результатов с помощью встроенного эвристического движка.

• Обогащение результатов IOL (Индикаторами утечки):

  • Секреты в найденных источниках (включая историю коммитов Git-репозиториев):
    • С помощью Shhgit (используя настраиваемый список правил).
    • С помощью TruffleHog.
  • URI (включая указание доменов вашей организации)
  • Электронные письма (включая указание адресов электронной почты вашей организации)
  • Участники
  • Чувствительные ключевые слова (например, canary token, внутренние домены)

• Позволяет игнорировать публичные источники (например, «мусорные» репозитории веб-сканеров).

• Встроенный список игнорирования общих «мусорных» источников.

• Подтверждение утечки — получать уведомления только в случае, если источник был изменён с момента предыдущего сканирования.

• Встроенный ELK для поиска данных в утечках (включая полный индекс Git-репозиториев с IOL).

• Уведомление о новых утечках

  • Webhook MS Teams.
  • Slack Bot.
  • Интеграция с Cortex XSOAR® (от Palo Alto Networks) (в разработке).

Технологический стек

• Полностью контейнеризировано с помощью Docker.
• Бэкенд на Python Flask с подходом API-first.
• Декупленный фронтенд на Vue.js (3.x).
• SQLite БД.
• Асинхронные задачи с Celery + очереди Redis.

Предварительные требования

• Docker-Compose

Установка

• Клонируйте репозиторий
• Создайте локальный файл .env
  root@kitploit:~

  cd Leaktopus
  cp .env.example .env
  

• Отредактируйте .env в соответствии с вашей локальной настройкой (см. внутренние комментарии).
• Запустите Leaktopus
  root@kitploit:~

  docker-compose up -d
  

• Запустите последовательность установки, обратившись к API установки. Просто откройте http://{LEAKTOPUS_HOST}:8000/api/install в вашем браузере.
• Проверьте, что API работает, перейдя по адресу http://{LEAKTOPUS_HOST}:8000/up
• Пользовательский интерфейс будет доступен по адресу http://{LEAKTOPUS_HOST}:8080

Использование Github App

В дополнение к базовой опции с персональным токеном доступа Leaktopus поддерживает аутентификацию через Github App. Использование Github App рекомендуется из-за повышенных лимитов скорости.

1. Для использования аутентификации через Github App необходимо создать Github App и установить его в вашей организации/аккаунте. См. документацию Github для получения дополнительной информации.

2. После создания приложения необходимо задать следующие переменные окружения:

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID — идентификатор установки можно найти в вашей установке приложения.
   • GITHUB_APP_PRIVATE_KEY_PATH (по умолчанию /app/private-key.pem)

3. Подключите файл закрытого ключа к контейнеру (см. пример в docker-compose.yml). ./leaktopus_backend/private-key.pem:/app/private-key.pem

* Обратите внимание, что GITHUB_ACCESS_TOKEN будет игнорироваться, если GITHUB_USE_APP установлен в True.

Обновление Leaktopus

Если вы хотите обновить версию Leaktopus (скачать более новую версию), просто выполните следующие действия.

• Загрузите последнюю версию.
  root@kitploit:~

  git pull
  

• Пересоберите Docker-образы (данные не будут удалены).
  root@kitploit:~

  # Принудительное пересоздание образов
  docker-compose up --force-recreate --build
  

• Запустите обновление БД, вызвав соответствующий API (может потребоваться после некоторых обновлений). http://{LEAKTOPUS_HOST}/api/updatedb

Эвристический движок фильтрации результатов

Встроенный эвристический движок фильтрует результаты поиска для снижения ложных срабатываний по следующим критериям:

• Содержимое:
  • Более X адресов электронной почты, содержащих домены не относящиеся к организации.
  • Более X URI, содержащих домены не относящиеся к организации.
• Метаданные:
  • Более X звёзд.
  • Более X форков.
• Список игнорируемых источников.

Документация API

Документация OpenAPI доступна по адресу http://{LEAKTOPUS_HOST}:8000/apidocs.

Сервисы Leaktopus

Вышеуказанное можно настроить, используя собственный файл docker-compose.yml.

Замечания по безопасности

На данный момент Leaktopus не предоставляет механизма аутентификации. Убедитесь, что вы не выставляете его на всеобщее обозрение, и делайте всё возможное, чтобы ограничить доступ к вашим экземплярам Leaktopus.

Вклад

Вклад всячески приветствуется.

Пожалуйста, ознакомьтесь с нашими рекомендациями по внесению вклада и документацией.