Описание   |   Установка   |   Веб-сайт   |   Модули   |   Проблемы   |   Поддержка

iKy

Описание

iKy — это OSINT-инструмент, который собирает информацию по адресу электронной почты или другим селекторам и отображает результаты в визуальном интерфейсе.

Установка

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

• Docker
• Docker Compose (входит в состав Docker Desktop)
• (Опционально) just — запускатель задач

Быстрый старт

git clone https://gitlab.com/kennbroorg/iKy.git
cd iKy
just build
just up

Откройте браузер по адресу http://localhost:4300

Чтобы остановить все сервисы:

just down

just up запускает backend, iky-frontend и redis. Другие сервисы по умолчанию не запускаются.

Без Docker (нативно)

Если вы не можете запустить Docker, iKy может работать нативно: Caddy обслуживает предварительно собранный фронтенд, а Redis + Celery + Uvicorn запускаются как локальные процессы. Требуется redis-server, Python 3.12, curl и tar на хосте (Caddy загружается автоматически).

just setup          # создать виртуальное окружение
just up-native      # установить зависимости, загрузить Caddy + фронтенд, запустить всё

Откройте браузер по адресу http://localhost:4300. Остановите с помощью Ctrl-C или just down-native.

Фронтенд загружается из последнего релиза GitHub — сборка Node не требуется. В нативном режиме tor не запускается; он нужен только для модуля darkweb.

Архитектура

Модули

iKy управляет 26 модулями через backend/module_registry.py:

API-ключи

После загрузки приложения в браузере введите свои API-ключи на панели настроек. Ниже приведена полная таблица полей из backend/factories/apikeys_default.json:

API, помеченные 🍪, используют куки сессии браузера; остальные — токены сервисов.

Куки сессии

Некоторые модули (LinkedIn, Twitter, TikTok) требуют куки сессии из вашего браузера. Куки сохраняются в backend/cookies/ (монтируются в контейнер как /app/cookies) и сохраняются между перезапусками. Есть два способа их загрузить, оба через just.

Куки — это личные токены сессии: не делитесь ими и не добавляйте их в репозиторий (backend/cookies/ игнорируется git'ом).

Вариант A: Импорт экспортированных из браузера

Экспортируйте куки сайта с помощью расширения, например Cookie-Editor, в JSON-файл и импортируйте его:

just cookies-import linkedin ~/Downloads/linkedin_cookies.json

Вариант B: Автоматическое извлечение из браузера

Извлекает куки напрямую из вашего локального браузера. Перед запуском закройте браузер (открытый браузер блокирует свою базу куки):

# Попробовать все установленные браузеры (firefox, chrome, brave, edge)
just cookies-grab linkedin linkedin.com

# Или указать конкретный
just cookies-grab linkedin linkedin.com brave

Команда сообщает, браузер за браузером, что удалось прочитать, а что нет, и записывает файл только если найдены необходимые модулю куки. Например, для LinkedIn требуются li_at и JSESSIONID.

Куки периодически истекают (куки LinkedIn живут от 1 до 3 месяцев). Когда модуль перестаёт аутентифицироваться, выполните команду снова.

Разработка

Рабочий процесс разработки использует виртуальное окружение для линтинга/предварительных хуков и Docker (или нативный just up-native) для сборки и запуска приложения.

Настройка среды разработки

Установите just, затем:

just setup
source .venv/bin/activate

Это создаст виртуальное окружение Python с pre-commit и ruff, а также установит хуки git.

Часто используемые рецепты

Обновление iKy

Загрузите последние изменения и пересоберите Docker-образы:

git pull
just rebuild

Чтобы сохранить ваши API-ключи при обновлениях, используйте опции экспорта/импорта в меню API-ключей графического интерфейса.

Вики

• iKy Вики

Видеодемонстрация

Vimeo

Поддержка проекта

Пользуетесь ли вы этим проектом, узнали ли что-то из него или просто он вам нравится — пожалуйста, поддержите его, купив мне кофе, чтобы я мог уделять больше времени таким проектам с открытым исходным кодом.

Отказ от ответственности

Любой, кто вносит или внёс вклад в проект, включая меня, не несёт ответственности за использование инструмента (ни за законное, ни за незаконное, ни за «иное» использование).

Имейте в виду, что изначально это программное обеспечение было написано ради шутки, затем для образовательных целей (чтобы обучить самих себя), и теперь цель — сотрудничать с сообществом, создавая качественное свободное программное обеспечение, и хотя качество не отличное (иногда даже не хорошее), мы стремимся к совершенству.

Учтите, что вся собранная информация бесплатна и доступна в сети, инструмент лишь пытается её обнаружить, собрать и отобразить. Зачастую инструмент даже не может достичь цели обнаружения и сбора. Пожалуйста, загрузите необходимые API, прежде чем вспоминать мою маму. Если даже с API он не показывает «хороших» вещей, которые вы ожидаете, попробуйте другие адреса электронной почты, прежде чем вспоминать мою маму. Если вы по-прежнему не видите «хороших» вещей, которые ожидаете, вы можете создать issue, связаться с нами по электронной почте или через любые социальные сети, но имейте в виду, что моя мама не является ни создателем, ни участником проекта.

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

Кстати, для тех, кто настаивает на упоминании моей мамы, она умерла много лет назад, но я люблю её так, как будто она здесь.