IKy
OSINT Project. Collect information from a mail. Gather. Profile. Timeline.
Install / Use
/learn @kennbroorg/IKyREADME
<div align="center"> <img alt="Logo" src="https://kennbroorg.gitlab.io/ikyweb/assets/img/Logo-Circular.png"> </div>
<div align="center">
Description | Installation | Website | Modules | Issues | Supporting
</div><!-- Website References --> <h1 align="center">iKy</h1> <h1 id="description">Description</h1> Project iKy is a tool that collects information from an email and shows results in a nice visual interface.
Visit the Gitlab Page of the Project
<div align="center"> <a href="https://vimeo.com/434501702"><img src="frontend/src/assets/images/iKySol.gif"></a> </div> <div align="center"> <a href="https://vimeo.com/434501702">Video Demo</a> </div> <h2 id="modules">Modules</h2> <div align="center" style="margin-bottom: 10px;"> <img alt="fullcontact" src="https://img.shields.io/badge/module-fullcontact-blue.svg?style=flat-square"> <img alt="twitter" src="https://img.shields.io/badge/module-twitter-blue.svg?style=flat-square"> <img alt="linkedin" src="https://img.shields.io/badge/module-linkedin-blue.svg?style=flat-square"> <img alt="github" src="https://img.shields.io/badge/module-github-blue.svg?style=flat-square"> <img alt="keybase" src="https://img.shields.io/badge/module-keybase-blue.svg?style=flat-square"> <img alt="ghostproject" src="https://img.shields.io/badge/module-ghostproject-red.svg?style=flat-square"> <img alt="haveibeenpwned" src="https://img.shields.io/badge/module-haveibeenpwned-blue.svg?style=flat-square"> <img alt="emailrep.io" src="https://img.shields.io/badge/amodule-emailrep.io-blue.svg?style=flat-square"> <img alt="socialscan" src="https://img.shields.io/badge/module-socialscan-blue.svg?style=flat-square"> <img alt="instagram" src="https://img.shields.io/badge/module-instagram-blue.svg?style=flat-square"> <img alt="tiktok" src="https://img.shields.io/badge/module-tiktok-blue.svg?style=flat-square"> <img alt="sherlock" src="https://img.shields.io/badge/module-sherlock-blue.svg?style=flat-square"> <img alt="skype" src="https://img.shields.io/badge/module-skype-blue.svg?style=flat-square"> <img alt="tinder" src="https://img.shields.io/badge/module-tinder-blue.svg?style=flat-square"> <img alt="venmo" src="https://img.shields.io/badge/module-venmo-blue.svg?style=flat-square"> <img alt="darkpass" src="https://img.shields.io/badge/module-darkpass-blue.svg?style=flat-square"> <img alt="tweetiment" src="https://img.shields.io/badge/module-tweetiment-blue.svg?style=flat-square"> <img alt="peopledatalabs" src="https://img.shields.io/badge/module-peopledatalabs-blue.svg?style=flat-square"> <img alt="reddit" src="https://img.shields.io/badge/module-reddit-blue.svg?style=flat-square"> <img alt="leaklookup" src="https://img.shields.io/badge/module-leaklookup-blue.svg?style=flat-square"> <img alt="twint" src="https://img.shields.io/badge/module-twint-blue.svg?style=flat-square"> <img alt="holehe" src="https://img.shields.io/badge/module-holehe-blue.svg?style=flat-square"> <img alt="spotify" src="https://img.shields.io/badge/module-spotify-blue.svg?style=flat-square"> <img alt="twitch" src="https://img.shields.io/badge/module-twitch-blue.svg?style=flat-square"> <img alt="dorks" src="https://img.shields.io/badge/module-dorks-blue.svg?style=flat-square"> <img alt="mastodon" src="https://img.shields.io/badge/module-mastodon-blue.svg?style=flat-square"> </div> <h1 id="installation">Installation</h1>Prerequisites
- Docker
- Docker Compose (included with Docker Desktop)
- (Optional) just task runner
Quick start
git clone https://gitlab.com/kennbroorg/iKy.git
cd iKy
docker compose build
docker compose up -d
Or, if you have just installed:
just build
just up
Open your browser at http://localhost:4200
To stop all services:
docker compose down
# or
just down
The development workflow uses a virtualenv for linting/pre-commit hooks and Docker for building and running the application.
Setting up the dev environment
Install just, then:
just setup
source .venv/bin/activate
This creates a Python virtualenv with pre-commit and ruff, and installs the git hooks.
Common recipes
| Command | Description |
|---------|-------------|
| just build | Build Docker images |
| just up | Start all services |
| just down | Stop all services |
| just logs | Follow backend logs (just logs frontend for frontend) |
| just ps | Show running containers |
| just shell-backend | Open a shell in the backend container |
| just shell-frontend | Open a shell in the frontend container |
| just lint | Run ruff linter and format check |
| just fmt | Auto-format Python code |
| just restart backend | Restart a specific service |
| just rebuild | Stop, rebuild, and start all services |
| just clean | Remove containers, volumes, and local images |
API Keys
Once the application is loaded in the browser, it should get most of the APIs and/or session cookies from the browser. Below is a table with all the fields to fill out
| Module | Status | Field in apikey | Description | | :------------- | :--------: | :--------- | :--------- | | Fullcontact | :octagonal_sign: | | Discontinued | | PeopleDataLabs | :ok: | peopledatalabs_key | :free: API Free. Explained here | | Linkedin | :ok: | linkedin_li_at / linkedin_JSESSIONID (***) | :free: Cookie browser(:cookie:) method. Explained here | | Twitter | :ok: | twitter_user / twitter_pass (***) | :free: Cookie browser(:cookie:) or user/pass. Explained here | | Instagram | :ok: | instagram_user / instagram_pass (***) | :free: Cookie browser(:cookie:) or user/pass. Explained here | | HaveIBeenPwned | :ok: | haveibeenpwned_key |:heavy_dollar_sign: API Paid. Explained here | | Emailrep | :ok: | emailrep_key | :free: API Free. Explained here | | Leaklookup | :ok: | leaklookup_key | :free: API Free. Explained here | | Spotify | :ok: | spotify_client_id / spotify_client_secret | :free: API Free. Explained here | | Twitch | :ok: | twitch_client_id / twitch_client_secret | :free: API Free. Explained here | | CSE (Google) | :ok: | cse_api_key / cse_cx |:free: API Free. Explained here | | Reddit | :warning: | | In revision | | Tiktok | :ok: | | Get from your preferred browser. Just log in with your user |
<h1 id="update">Update iKy</h1>Pull the latest changes and rebuild the Docker images:
git pull
docker compose build
docker compose up -d
Or with just:
git pull
just rebuild
