Description   |   Installation   |   Site web   |   Modules   |   Problèmes   |   Soutenir

iKy

Description

iKy est un outil OSINT qui collecte des informations à partir d'une adresse e-mail ou d'autres sélecteurs et affiche les résultats dans une interface visuelle.

Installation

Prérequis

• Docker
• Docker Compose (inclus avec Docker Desktop)
• (Facultatif) just exécuteur de tâches

Démarrage rapide

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

Ouvrez votre navigateur à http://localhost:4300

Pour arrêter tous les services :

just down

just up démarre backend, iky-frontend et redis. Aucun autre service n'est lancé par défaut.

Sans Docker (natif)

Si vous ne pouvez pas exécuter Docker, iKy peut fonctionner de manière native : Caddy sert le frontend pré-construit et Redis + Celery + Uvicorn s'exécutent comme des processus locaux. Nécessite redis-server, Python 3.12, curl et tar sur l'hôte (Caddy est téléchargé automatiquement).

just setup          # create the venv
just up-native      # installs deps, downloads Caddy + frontend, starts everything

Ouvrez votre navigateur à http://localhost:4300. Arrêtez avec Ctrl-C ou just down-native.

Le frontend est extrait de la dernière version GitHub — aucune construction Node n'est nécessaire. tor n'est pas lancé en mode natif ; seul le module darkweb en a besoin.

Architecture

Modules

iKy route 26 modules via backend/module_registry.py :

Clés API

Une fois l'application chargée dans le navigateur, saisissez vos clés API dans le panneau de paramètres. Voici la table complète des champs de backend/factories/apikeys_default.json :

Les API marquées avec 🍪 utilisent des cookies de session navigateur ; les autres utilisent des jetons de service.

Cookies de session

Certains modules (LinkedIn, Twitter, TikTok) nécessitent des cookies de session de votre navigateur. Les cookies sont stockés dans backend/cookies/ (montés dans le conteneur en tant que /app/cookies) et persistent entre les redémarrages. Il y a deux façons de les charger, toutes deux via just.

Les cookies sont des jetons de session personnels : ne les partagez pas et ne les commitez pas dans le dépôt (backend/cookies/ est ignoré par git).

Option A : Importer une exportation du navigateur

Exportez les cookies du site avec une extension telle que Cookie-Editor vers un fichier JSON et importez-le :

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

Option B : Les extraire automatiquement du navigateur

Extrait les cookies directement de votre navigateur local. Fermez le navigateur avant d'exécuter (un navigateur ouvert verrouille sa base de données de cookies) :

# Essayez tous les navigateurs installés (firefox, chrome, brave, edge)
just cookies-grab linkedin linkedin.com

# Ou un spécifique
just cookies-grab linkedin linkedin.com brave

La commande rapporte, navigateur par navigateur, ce qu'elle a pu lire et ce qu'elle n'a pas pu, et écrit le fichier seulement si elle trouve les cookies dont le module a besoin. Par exemple, LinkedIn nécessite li_at et JSESSIONID.

Les cookies expirent périodiquement (les cookies LinkedIn durent entre 1 et 3 mois). Lorsqu'un module cesse de s'authentifier, exécutez à nouveau la commande.

Développement

Le flux de travail de développement utilise un virtualenv pour les hooks de linting/pre-commit et Docker (ou le flux natif just up-native) pour construire et exécuter l'application.

Configuration de l'environnement de développement

Installez just, puis :

just setup
source .venv/bin/activate

Ceci crée un virtualenv Python avec pre-commit et ruff, et installe les hooks git.

Recettes courantes

Mettre à jour iKy

Tirez les dernières modifications et reconstruisez les images Docker :

git pull
just rebuild

Pour préserver vos clés API lors des mises à jour, utilisez les options Exporter/Importer dans le menu apikeys de l'interface graphique.

Wiki

• iKy Wiki

Démo vidéo

Vimeo

Soutenir le projet

Que vous utilisiez ce projet, que vous ayez appris quelque chose de lui, ou que vous l'aimiez simplement, veuillez envisager de le soutenir en m'offrant un café, afin que je puisse consacrer plus de temps à des projets open-source comme celui-ci.

Avertissement

Toute personne qui contribue ou a contribué au projet, y compris moi, n'est pas responsable de l'utilisation de l'outil (ni de l'utilisation légale, ni de l'utilisation illégale, ni de l'utilisation « autre »).

Gardez à l'esprit que ce logiciel a été initialement écrit pour plaisanter, puis à des fins éducatives (pour nous éduquer nous-mêmes), et maintenant l'objectif est de collaborer avec la communauté en faisant des logiciels libres de qualité, et bien que la qualité ne soit pas excellente (parfois même pas bonne), nous nous efforçons de viser l'excellence.

Considérez que toutes les informations collectées sont gratuites et disponibles en ligne, l'outil essaie seulement de les découvrir, collecter et afficher. Souvent, l'outil ne peut même pas atteindre son objectif de découverte et de collecte. Veuillez charger les API nécessaires avant de vous souvenir de ma mère. Même avec les API, s'il n'affiche pas les choses « intéressantes » que vous espérez voir, essayez d'autres e-mails avant de vous souvenir de ma mère. Si vous ne voyez toujours pas les choses « intéressantes » que vous espérez voir, vous pouvez créer un problème, nous contacter par e-mail ou via l'un des réseaux sociaux, mais gardez à l'esprit que ma mère n'est ni la créatrice ni une contributrice du projet.

Nous ne remboursons pas votre argent si vous n'êtes pas satisfait. J'espère que vous apprécierez utiliser l'outil autant que nous avons aimé le faire. L'effort était et est énorme (temps, connaissances, codage, tests, révisions, etc.) mais nous le referions. N'utilisez pas l'outil si vous ne pouvez pas lire les instructions et/ou cet avertissement clairement.

Au fait, pour ceux qui insistent pour se souvenir de ma mère, elle est décédée il y a de nombreuses années mais je l'aime comme si elle était là.