Descrição   |   Instalação   |   Website   |   Módulos   |   Issues   |   Apoiar

iKy

Descrição

iKy é uma ferramenta OSINT que coleta informações de um endereço de e-mail ou outros seletores e exibe os resultados em uma interface visual.

Instalação

Pré-requisitos

• Docker
• Docker Compose (incluído no Docker Desktop)
• (Opcional) just executor de tarefas

Início rápido

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

Abra o navegador em http://localhost:4300

Para parar todos os serviços:

just down

just up inicia backend, iky-frontend e redis. Nenhum outro serviço é iniciado por padrão.

Sem Docker (nativo)

Se não puder executar o Docker, o iKy pode ser executado nativamente: Caddy serve o frontend pré-construído e Redis + Celery + Uvicorn são executados como processos locais. Requer redis-server, Python 3.12, curl e tar no host (Caddy é baixado automaticamente).

just setup          # cria o venv
just up-native      # instala dependências, baixa Caddy + frontend, inicia tudo

Abra o navegador em http://localhost:4300. Pare com Ctrl-C ou just down-native.

O frontend é obtido da última release do GitHub — não é necessário build Node. tor não é iniciado no modo nativo; apenas o módulo darkweb precisa dele.

Arquitetura

Módulos

iKy roteia 26 módulos através de backend/module_registry.py:

Chaves de API

Depois que a aplicação for carregada no navegador, insira suas chaves de API no painel de configurações. Abaixo está a tabela completa dos campos de backend/factories/apikeys_default.json:

APIs marcadas com 🍪 usam cookies de sessão do navegador; as demais usam tokens de serviço.

Cookies de sessão

Alguns módulos (LinkedIn, Twitter, TikTok) exigem cookies de sessão do seu navegador. Os cookies são armazenados em backend/cookies/ (montados no container como /app/cookies) e persistem entre reinicializações. Há duas maneiras de carregá-los, ambas via just.

Cookies são tokens de sessão pessoais: não os compartilhe nem os commite no repositório (backend/cookies/ está no .gitignore).

Opção A: Importar uma exportação do navegador

Exporte os cookies do site com uma extensão como Cookie-Editor para um arquivo JSON e importe-o:

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

Opção B: Extraí-los automaticamente do navegador

Extrai cookies diretamente do seu navegador local. Feche o navegador antes de executar (um navegador aberto bloqueia seu banco de dados de cookies):

# Tentar todos os navegadores instalados (firefox, chrome, brave, edge)
just cookies-grab linkedin linkedin.com

# Ou um específico
just cookies-grab linkedin linkedin.com brave

O comando relata, navegador por navegador, o que conseguiu ler e o que não conseguiu, e escreve o arquivo apenas se encontrar os cookies que o módulo precisa. Por exemplo, LinkedIn requer li_at e JSESSIONID.

Os cookies expiram periodicamente (cookies do LinkedIn duram entre 1 e 3 meses). Quando um módulo parar de autenticar, execute o comando novamente.

Desenvolvimento

O fluxo de trabalho de desenvolvimento usa um virtualenv para linting/hooks pre-commit e Docker (ou o fluxo nativo just up-native) para construir e executar a aplicação.

Configurando o ambiente de desenvolvimento

Instale just, depois:

just setup
source .venv/bin/activate

Isso cria um virtualenv Python com pre-commit e ruff, e instala os hooks do git.

Receitas comuns

Atualizar iKy

Puxe as últimas alterações e reconstrua as imagens Docker:

git pull
just rebuild

Para preservar suas chaves de API durante as atualizações, use as opções Exportar/Importar no menu de chaves de API da interface gráfica.

Wiki

• Wiki do iKy

Vídeo Demo

Vimeo

Apoie o projeto

Quer você use este projeto, tenha aprendido algo com ele ou apenas goste dele, considere apoiá-lo comprando um café para mim, para que eu possa dedicar mais tempo a projetos de código aberto como este.

Aviso Legal

Qualquer pessoa que contribua ou tenha contribuído para o projeto, incluindo eu, não é responsável pelo uso da ferramenta (nem pelo uso legal, nem pelo uso ilegal, nem pelo "outro" uso).

Tenha em mente que este software foi inicialmente escrito para uma brincadeira, depois para fins educacionais (para nos educar), e agora o objetivo é colaborar com a comunidade fazendo software livre de qualidade, e embora a qualidade não seja excelente (às vezes nem boa), nos esforçamos para buscar a excelência.

Considere que todas as informações coletadas são gratuitas e estão disponíveis online, a ferramenta apenas tenta descobri-las, coletá-las e exibi-las. Muitas vezes a ferramenta nem consegue atingir seu objetivo de descoberta e coleta. Por favor, carregue as APIs necessárias antes de lembrar da minha mãe. Se mesmo com as APIs ela não mostrar coisas "legais" que você espera ver, tente outros e-mails antes de lembrar da minha mãe. Se ainda assim você não vir as coisas "legais" que espera ver, você pode abrir uma issue, entrar em contato conosco por e-mail ou por qualquer uma das redes sociais, mas tenha em mente que minha mãe não é a criadora nem contribui para o projeto.

Nós não reembolsamos seu dinheiro se você não ficar satisfeito. Espero que você goste de usar a ferramenta tanto quanto nós gostamos de fazê-la. O esforço foi e é enorme (Tempo, conhecimento, codificação, testes, revisões, etc.) mas faríamos tudo de novo. Não use a ferramenta se você não conseguir ler as instruções e/ou este aviso legal claramente.

A propósito, para aqueles que insistem em lembrar da minha mãe, ela faleceu há muitos anos, mas a amo como se estivesse bem aqui.