forensic-cli 1.4.2__tar.gz → 1.4.4__tar.gz

{forensic_cli-1.4.2/src/forensic_cli.egg-info → forensic_cli-1.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: forensic-cli
-Version: 1.4.2
+Version: 1.4.4
 Summary: DevKit Forense - CLI para análise de navegadores e rede
 Home-page: https://github.com/ErickG123/devkit_forense
 Author: Erick Gabriel dos Santos Alves
@@ -95,7 +95,9 @@ Dynamic: requires-python
 
 # DevKit Forense – Ferramenta Educacional de Perícia Digital
 
-![Python](https://img.shields.io/badge/Python-3.11-blue.svg) ![FastAPI](https://img.shields.io/badge/FastAPI-0.100-green.svg) ![Typer](https://img.shields.io/badge/Typer-0.7-orange.svg) ![SQLite](https://img.shields.io/badge/SQLite-3.41.2-lightgrey.svg)
+![Python](https://img.shields.io/badge/Python-3.11-blue.svg) ![Typer](https://img.shields.io/badge/Typer-0.7-orange.svg) ![SQLite](https://img.shields.io/badge/SQLite-3.41.2-lightgrey.svg)
+
+**ForenseLab** é um toolkit modular de análise forense digital, desenvolvido como um Trabalho de Conclusão de Curso em Engenharia da Computação. Seu principal objetivo é servir como uma ponte educacional para estudantes, educadores e entusiastas da área de segurança da informação.
 
 ## Sumário
 1. [Introdução](#introdução)  
@@ -111,43 +113,31 @@ Dynamic: requires-python
 
 ---
 
-# DevKit Forense: Uma Suíte de Ferramentas Educacionais para Análise Forense Digital
-
-## 📖 Introdução
-
-O estudo da perícia forense digital, embora fascinante, apresenta uma curva de aprendizado íngreme. Ferramentas profissionais são poderosas, mas muitas vezes complexas e pouco intuitivas para estudantes que estão dando os primeiros passos na área.
-
-Para endereçar essa lacuna, o **DevKit Forense** foi desenvolvido como um projeto de TCC. Trata-se de uma suíte de ferramentas projetada desde o início com um **foco educacional**. Nosso objetivo é simplificar a análise de evidências digitais, tornando o processo de aprendizado mais interativo, visual e didático.
+## 🎯 O Problema
+O ensino prático de computação forense enfrenta uma barreira significativa. Ferramentas comerciais padrão de mercado, como EnCase e FTK, são robustas, mas possuem um custo proibitivo para ambientes acadêmicos. Por outro lado, alternativas open-source consolidadas, como Autopsy e Volatility Framework, embora poderosas e gratuitas, apresentam uma curva de aprendizado íngreme que pode intimidar e frustrar iniciantes.
 
-Este projeto é destinado a **estudantes e professores da área de Segurança da Informação e Perícia Digital**, servindo como uma ponte entre o conhecimento teórico e a aplicação prática.
+Essa dualidade cria uma lacuna educacional: falta uma plataforma que permita ao estudante focar na **metodologia investigativa**, sem se perder na complexidade operacional da ferramenta.
 
----
-
-## ✨ Recursos em Destaque
+## 💡 A Proposta do ForenseLab
+O **ForenseLab** nasce para preencher essa lacuna, atuando como um "laboratório digital" introdutório. Ele não busca competir em funcionalidades com as suítes profissionais, mas sim oferecer um ambiente controlado, simplificado e didático para a aplicação de conceitos teóricos.
 
-O DevKit Forense combina o poder da linha de comando com a clareza de interfaces gráficas para oferecer uma experiência de aprendizado completa.
+Este projeto é destinado a **estudantes e professores da área de Segurança da Informação e Perícia Digital**, servindo como uma ponte entre a teoria e a prática.
 
-* **🔍 Análise Multifacetada:** Execute módulos de análise forense focados nos artefatos mais comuns do dia a dia digital, incluindo:
-    * Navegadores Web (histórico, cache, downloads)
-    * Clientes de E-mail
-    * Tráfego de Rede (análise de pacotes)
+## ✨ Recursos Principais
 
----
+* **💻 Interface de Linha de Comando (CLI) Intuitiva:** Todas as análises são executadas através de uma CLI clara e bem documentada, ideal para automação, scripts e para quem busca agilidade no terminal.
+* **🧩 Arquitetura Modular e Extensível:** O toolkit é organizado em módulos independentes (Navegadores, Rede, E-mails), o que permite que a comunidade adicione facilmente novas capacidades de análise sem alterar o núcleo do sistema.
+* **🎓 Foco Didático:** Ao abstrair complexidades desnecessárias, a ferramenta permite que o aluno se concentre em entender os artefatos digitais e desenvolver o raciocínio investigativo.
 
 ## 🏛️ Arquitetura do Projeto
 
-Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três camadas principais, cada uma com um propósito claro:
-
-1.  **`CLI (Command-Line Interface)`**
-    * **O que faz:** É a porta de entrada para a execução direta dos módulos forenses. Ideal para automação de tarefas, scripts e para usuários que preferem a agilidade do terminal.
+Para garantir a manutenibilidade e a clareza do código, o ForenseLab adota uma arquitetura de duas camadas principais, organizada em um monorepositório:
 
-2.  **`API (Application Programming Interface)`**
-    * **O que faz:** Expõe as funcionalidades do Core de forma programática. Permite que as aplicações de apoio (como dashboards visuais) consumam os dados e executem análises, além de possibilitar a integração do DevKit com outras ferramentas.
+1.  **`Core`**
+    * **O que faz:** É o cérebro do projeto. Contém toda a lógica de negócio, as classes de análise forense e as funções utilitárias. Centralizar a lógica no Core garante que as regras sejam consistentes e o código seja reutilizável.
 
-3.  **`Core`**
-    * **O que faz:** É o coração do projeto. Contém toda a lógica de negócio, as classes, funções e utilitários de análise. Centralizar a lógica no Core garante que as regras sejam consistentes, o código seja reutilizável e a manutenção seja simplificada, já que tanto a CLI quanto a API consomem desta mesma base.
-
----
+2.  **`CLI (Command-Line Interface)`**
+    * **O que faz:** É a interface do usuário e o ponto de entrada para todas as funcionalidades. Construída com Typer, ela invoca a lógica do `Core` para executar as análises e apresentar os resultados de forma estruturada no terminal.
 
 ## 3. Módulos Forenses
 
@@ -181,16 +171,11 @@ Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três ca
 | `email_parser` | Extrai e organiza informações de emails. |
 | `header_analysis` | Analisa cabeçalhos para identificar origem, roteamento e possíveis fraudes. |
 
----
-
 ## 4. Tecnologias Utilizadas
 
-- **Python** – Linguagem principal do projeto.  
-- **FastAPI** – API para integração e execução de módulos.  
-- **Typer** – CLI estruturada e interativa.  
-- **SQLite** – Banco de dados local leve.  
-
----
+* **Python:** Linguagem principal do projeto, escolhida por sua simplicidade e pelo vasto ecossistema de bibliotecas para manipulação de dados.
+* **Typer:** Utilizado para criar a interface de linha de comando (CLI) de forma robusta e intuitiva.
+* **SQLite:** Várias análises, como a de históricos de navegadores, interagem diretamente com bancos de dados SQLite.
 
 ## 5. Planejamento e Futuras Extensões
 
@@ -202,8 +187,6 @@ Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três ca
 | Novos módulos CLI | Expansão da análise forense | Logs de sistemas, recuperação de dispositivos móveis, análise de mídia, detecção de malware, integração com threat intelligence |
 | Ferramentas auxiliares | Suporte a módulos existentes e novos | Exportação avançada de relatórios, dashboards customizáveis, notificações em tempo real |
 
----
-
 ## 6. Instalação
 A forma mais simples de instalar a CLI é utilizando o **PyPI**.  
 Execute o seguinte comando no terminal:

{forensic_cli-1.4.2 → forensic_cli-1.4.4}/README.md

@@ -1,6 +1,8 @@
 # DevKit Forense – Ferramenta Educacional de Perícia Digital
 
-![Python](https://img.shields.io/badge/Python-3.11-blue.svg) ![FastAPI](https://img.shields.io/badge/FastAPI-0.100-green.svg) ![Typer](https://img.shields.io/badge/Typer-0.7-orange.svg) ![SQLite](https://img.shields.io/badge/SQLite-3.41.2-lightgrey.svg)
+![Python](https://img.shields.io/badge/Python-3.11-blue.svg) ![Typer](https://img.shields.io/badge/Typer-0.7-orange.svg) ![SQLite](https://img.shields.io/badge/SQLite-3.41.2-lightgrey.svg)
+
+**ForenseLab** é um toolkit modular de análise forense digital, desenvolvido como um Trabalho de Conclusão de Curso em Engenharia da Computação. Seu principal objetivo é servir como uma ponte educacional para estudantes, educadores e entusiastas da área de segurança da informação.
 
 ## Sumário
 1. [Introdução](#introdução)  
@@ -16,43 +18,31 @@
 
 ---
 
-# DevKit Forense: Uma Suíte de Ferramentas Educacionais para Análise Forense Digital
-
-## 📖 Introdução
-
-O estudo da perícia forense digital, embora fascinante, apresenta uma curva de aprendizado íngreme. Ferramentas profissionais são poderosas, mas muitas vezes complexas e pouco intuitivas para estudantes que estão dando os primeiros passos na área.
-
-Para endereçar essa lacuna, o **DevKit Forense** foi desenvolvido como um projeto de TCC. Trata-se de uma suíte de ferramentas projetada desde o início com um **foco educacional**. Nosso objetivo é simplificar a análise de evidências digitais, tornando o processo de aprendizado mais interativo, visual e didático.
+## 🎯 O Problema
+O ensino prático de computação forense enfrenta uma barreira significativa. Ferramentas comerciais padrão de mercado, como EnCase e FTK, são robustas, mas possuem um custo proibitivo para ambientes acadêmicos. Por outro lado, alternativas open-source consolidadas, como Autopsy e Volatility Framework, embora poderosas e gratuitas, apresentam uma curva de aprendizado íngreme que pode intimidar e frustrar iniciantes.
 
-Este projeto é destinado a **estudantes e professores da área de Segurança da Informação e Perícia Digital**, servindo como uma ponte entre o conhecimento teórico e a aplicação prática.
+Essa dualidade cria uma lacuna educacional: falta uma plataforma que permita ao estudante focar na **metodologia investigativa**, sem se perder na complexidade operacional da ferramenta.
 
----
-
-## ✨ Recursos em Destaque
+## 💡 A Proposta do ForenseLab
+O **ForenseLab** nasce para preencher essa lacuna, atuando como um "laboratório digital" introdutório. Ele não busca competir em funcionalidades com as suítes profissionais, mas sim oferecer um ambiente controlado, simplificado e didático para a aplicação de conceitos teóricos.
 
-O DevKit Forense combina o poder da linha de comando com a clareza de interfaces gráficas para oferecer uma experiência de aprendizado completa.
+Este projeto é destinado a **estudantes e professores da área de Segurança da Informação e Perícia Digital**, servindo como uma ponte entre a teoria e a prática.
 
-* **🔍 Análise Multifacetada:** Execute módulos de análise forense focados nos artefatos mais comuns do dia a dia digital, incluindo:
-    * Navegadores Web (histórico, cache, downloads)
-    * Clientes de E-mail
-    * Tráfego de Rede (análise de pacotes)
+## ✨ Recursos Principais
 
----
+* **💻 Interface de Linha de Comando (CLI) Intuitiva:** Todas as análises são executadas através de uma CLI clara e bem documentada, ideal para automação, scripts e para quem busca agilidade no terminal.
+* **🧩 Arquitetura Modular e Extensível:** O toolkit é organizado em módulos independentes (Navegadores, Rede, E-mails), o que permite que a comunidade adicione facilmente novas capacidades de análise sem alterar o núcleo do sistema.
+* **🎓 Foco Didático:** Ao abstrair complexidades desnecessárias, a ferramenta permite que o aluno se concentre em entender os artefatos digitais e desenvolver o raciocínio investigativo.
 
 ## 🏛️ Arquitetura do Projeto
 
-Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três camadas principais, cada uma com um propósito claro:
-
-1.  **`CLI (Command-Line Interface)`**
-    * **O que faz:** É a porta de entrada para a execução direta dos módulos forenses. Ideal para automação de tarefas, scripts e para usuários que preferem a agilidade do terminal.
+Para garantir a manutenibilidade e a clareza do código, o ForenseLab adota uma arquitetura de duas camadas principais, organizada em um monorepositório:
 
-2.  **`API (Application Programming Interface)`**
-    * **O que faz:** Expõe as funcionalidades do Core de forma programática. Permite que as aplicações de apoio (como dashboards visuais) consumam os dados e executem análises, além de possibilitar a integração do DevKit com outras ferramentas.
+1.  **`Core`**
+    * **O que faz:** É o cérebro do projeto. Contém toda a lógica de negócio, as classes de análise forense e as funções utilitárias. Centralizar a lógica no Core garante que as regras sejam consistentes e o código seja reutilizável.
 
-3.  **`Core`**
-    * **O que faz:** É o coração do projeto. Contém toda a lógica de negócio, as classes, funções e utilitários de análise. Centralizar a lógica no Core garante que as regras sejam consistentes, o código seja reutilizável e a manutenção seja simplificada, já que tanto a CLI quanto a API consomem desta mesma base.
-
----
+2.  **`CLI (Command-Line Interface)`**
+    * **O que faz:** É a interface do usuário e o ponto de entrada para todas as funcionalidades. Construída com Typer, ela invoca a lógica do `Core` para executar as análises e apresentar os resultados de forma estruturada no terminal.
 
 ## 3. Módulos Forenses
 
@@ -86,16 +76,11 @@ Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três ca
 | `email_parser` | Extrai e organiza informações de emails. |
 | `header_analysis` | Analisa cabeçalhos para identificar origem, roteamento e possíveis fraudes. |
 
----
-
 ## 4. Tecnologias Utilizadas
 
-- **Python** – Linguagem principal do projeto.  
-- **FastAPI** – API para integração e execução de módulos.  
-- **Typer** – CLI estruturada e interativa.  
-- **SQLite** – Banco de dados local leve.  
-
----
+* **Python:** Linguagem principal do projeto, escolhida por sua simplicidade e pelo vasto ecossistema de bibliotecas para manipulação de dados.
+* **Typer:** Utilizado para criar a interface de linha de comando (CLI) de forma robusta e intuitiva.
+* **SQLite:** Várias análises, como a de históricos de navegadores, interagem diretamente com bancos de dados SQLite.
 
 ## 5. Planejamento e Futuras Extensões
 
@@ -107,8 +92,6 @@ Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três ca
 | Novos módulos CLI | Expansão da análise forense | Logs de sistemas, recuperação de dispositivos móveis, análise de mídia, detecção de malware, integração com threat intelligence |
 | Ferramentas auxiliares | Suporte a módulos existentes e novos | Exportação avançada de relatórios, dashboards customizáveis, notificações em tempo real |
 
----
-
 ## 6. Instalação
 A forma mais simples de instalar a CLI é utilizando o **PyPI**.  
 Execute o seguinte comando no terminal:

{forensic_cli-1.4.2 → forensic_cli-1.4.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "forensic-cli"
-version = "1.4.2"
+version = "1.4.4"
 description = "DevKit Forense - CLI para análise de navegadores e rede"
 readme = "README.md"
 license = {text = "MIT"}

{forensic_cli-1.4.2 → forensic_cli-1.4.4}/setup.py

@@ -2,11 +2,11 @@ from setuptools import setup, find_packages
 
 setup(
     name="forensic_cli",
-    version="1.4.2",
+    version="1.4.4",
     author="Erick Gabriel dos Santos Alves",
     author_email="erickgabrielalves0@gmail.com",
     description="Toolkit modular para análise de evidências digitais",
-    long_description=open("README.md").read(),
+    long_description=open("README.md", encoding="utf-8").read(),
     long_description_content_type="text/markdown",
     url="https://github.com/ErickG123/devkit_forense",
     packages=find_packages(),

{forensic_cli-1.4.2 → forensic_cli-1.4.4}/src/cli/commands/browser.py

@@ -10,14 +10,17 @@ from core.browser.unusual_patterns import processar_historico_da_pasta
 from core.browser.logins import collect_chrome_logins, collect_edge_logins
 from core.browser.common_words import extract_words
 
-browser_app = typer.Typer()
+browser_app = typer.Typer(
+    help="Conjunto de ferramentas para extrair e processar artefatos de navegadores "
+         "(histórico, downloads, logins, favicons/screens e análises de padrões)."
+)
 
-@browser_app.command("history")
+@browser_app.command("history", help="Extrai o histórico dos navegadores especificados (Chrome, Edge, Firefox ou todos).")
 def history(
     chrome: bool = typer.Option(False, "--chrome", help="Extrair histórico do Chrome"),
     edge: bool = typer.Option(False, "--edge", help="Extrair histórico do Edge"),
     firefox: bool = typer.Option(False, "--firefox", help="Extrair histórico do Firefox"),
-    all: bool = typer.Option(False, "--all", help="Extrair histórico de todos navegadores")
+    all: bool = typer.Option(False, "--all", help="Extrair histórico de todos os navegadores")
 ):
     usuario = os.getlogin()
     home = str(Path.home())
@@ -52,7 +55,7 @@ def history(
         else:
             typer.echo("[!] Perfis do Firefox não encontrados.")
 
-@browser_app.command("downloads")
+@browser_app.command("downloads", help="Extrai registros de downloads dos navegadores e salva artefatos no diretório indicado.")
 def downloads(
     output_dir: Path = typer.Option(
         Path("artefatos/downloads"),
@@ -87,7 +90,7 @@ def downloads(
 
     typer.echo("✅ Extração concluída!")
 
-@browser_app.command("favscreen")
+@browser_app.command("favscreen", help="Processa JSONs de histórico, extrai URLs válidas e captura favicons/screenshots.")
 def favscreen(
     input_dir: Path = typer.Option(
         Path("artefatos/historico"),
@@ -130,7 +133,7 @@ def favscreen(
     except Exception as erro:
         typer.echo(f"\n❌ Erro geral: {erro}")
 
-@browser_app.command("logins")
+@browser_app.command("logins", help="Coleta credenciais/entradas de login dos navegadores suportados e grava JSONs com os resultados.")
 def logins(
     chrome: bool = typer.Option(False, "--chrome", help="Extrair logins do Chrome"),
     edge: bool = typer.Option(False, "--edge", help="Extrair logins do Edge"),
@@ -169,7 +172,7 @@ def logins(
             json.dump(data_edge, f, indent=2, ensure_ascii=False)
         typer.echo(f"✅ Logins do Edge salvos em: {arquivo_edge}")
 
-@browser_app.command("patterns")
+@browser_app.command("patterns", help="Analisa históricos para identificar padrões incomuns e gera gráficos/relatórios na pasta de saída.")
 def patterns(
     input_dir: Path = typer.Option(
         Path("artefatos/historico"),
@@ -204,7 +207,7 @@ def patterns(
     except Exception as erro:
         typer.echo(f"\n❌ Erro ao executar patterns: {erro}")
 
-@browser_app.command("words")
+@browser_app.command("words", help="Extrai palavras/termos mais frequentes do histórico (ex.: pesquisas) e salva um JSON com os resultados.")
 def words(
     chrome: bool = typer.Option(True, "--chrome", help="Extrair palavras mais pesquisadas do Chrome"),
     output_dir: Path = typer.Option(

forensic_cli-1.4.4/src/cli/commands/describe.py

@@ -0,0 +1,153 @@
+import json
+import difflib
+from typing import Any
+
+import typer
+from rich import print
+from rich.table import Table
+from rich.pretty import Pretty
+
+describe_app = typer.Typer(help="Ajuda interativa para os comandos/funcionalidades do toolkit forense.")
+
+docs = {
+    "map": {
+        "name": "map / run_network_map",
+        "description": "Retorna informações detalhadas de cada host da rede.",
+        "example_return": [
+            {
+                "host": "192.168.1.1",
+                "hostname": "router",
+                "mac": "AA:BB:CC:DD:EE:FF",
+                "vendor": "Cisco",
+                "open_ports": [22, 80],
+                "os_info": "Linux"
+            }
+        ],
+    },
+    "sweep": {
+        "name": "sweep / ping_sweep",
+        "description": "Faz um ping sweep na rede e retorna os hosts ativos.",
+        "example_return": ["192.168.1.1", "192.168.1.3"],
+    },
+    "scan": {
+        "name": "scan / port_scanner",
+        "description": "Verifica quais portas estão abertas, fechadas e filtradas.",
+        "example_return": [
+            {
+                "port": 53,
+                "protocol": "UDP",
+                "status": "open|filtered",
+                "banner": "sem resposta",
+                "alert": "DNS"
+            }
+        ],
+    },
+    "fingerprinting": {
+        "name": "fingerprinting / detect_os",
+        "description": "Detecta o sistema operacional, tipo de host, serviços e possíveis alertas de vulnerabilidade de um host.",
+        "example_return": {
+            "os": "Windows",
+            "host_type": "Servidor",
+            "services": ["SMB", "Web HTTP", "MySQL"],
+            "alerts": ["SMB vulnerável (Samba 3.0)"]
+        },
+    },
+    "traceroute": {
+        "name": "traceroute / traceroute_host",
+        "description": "Executa um traceroute até um host e retorna a rota (hops) percorrida.",
+        "example_return": [
+            {"hop": 1, "ip": "192.168.1.1", "rtt_ms": 1.2},
+            {"hop": 2, "ip": "10.0.0.1", "rtt_ms": 10.5},
+        ],
+    },
+    "arp_scan": {
+        "name": "arp_scan / arp_scan",
+        "description": "Faz uma varredura ARP na sub-rede para descobrir MACs/IPs ativos.",
+        "example_return": [
+            {"ip": "192.168.1.10", "mac": "AA:BB:CC:11:22:33", "vendor": "Intel"},
+        ],
+    },
+    "parse_ports": {
+        "name": "parse_ports",
+        "description": "Função auxiliar que transforma a saída do scanner em um formato padronizado.",
+        "example_return": [
+            {"port": 22, "state": "open", "service": "ssh"},
+            {"port": 80, "state": "open", "service": "http"},
+        ],
+    },
+    "parse_network": {
+        "name": "parse_network / ping_sweep.parse_network",
+        "description": "Analisa e normaliza a representação da rede (ex: 192.168.0.0/24).",
+        "example_return": {"network": "192.168.0.0/24", "hosts": 254},
+    },
+    "scan_host": {
+        "name": "scan_host",
+        "description": "Escaneia portas de um único host (wrapper do port_scanner).",
+        "example_return": [
+            {"port": 443, "protocol": "tcp", "status": "open", "service": "https"},
+        ],
+    },
+    "ping_host": {
+        "name": "ping_host",
+        "description": "Faz ping em um host e retorna latência e status.",
+        "example_return": {"host": "192.168.1.5", "alive": True, "rtt_ms": 2.3},
+    },
+}
+
+def _find_key(key: str) -> str | None:
+    key_lower = key.lower()
+    keys = list(docs.keys())
+    for k in keys:
+        if k == key_lower or docs[k].get("name", "").lower().split()[0] == key_lower:
+            return k
+
+    matches = difflib.get_close_matches(key_lower, keys, n=3, cutoff=0.5)
+
+    return matches[0] if matches else None
+
+def _print_example(example: Any, full: bool):
+    if full:
+        print(Pretty(example))
+    else:
+        try:
+            s = json.dumps(example, indent=2, ensure_ascii=False)
+        except Exception:
+            s = str(example)
+        print(s)
+
+@describe_app.command("func", help="Mostra a descrição e exemplo de retorno de uma função/command do toolkit.")
+def describe(
+    func: str = typer.Argument(..., help="Nome da função que você deseja entender (ex: map, scan, sweep)"),
+    full: bool = typer.Option(False, "--full", "-f", help="Mostrar exemplo formatado (mais detalhado)."),
+):
+    key = _find_key(func)
+    if not key:
+        candidates = difflib.get_close_matches(func.lower(), list(docs.keys()), n=5, cutoff=0.4)
+        if candidates:
+            print(f"[yellow]Função '{func}' não encontrada. Você quis dizer:[/yellow]")
+            for c in candidates:
+                print(f"  • {c} — {docs[c]['description']}")
+            raise typer.Exit(code=1)
+        else:
+            print(f"[red]Função '{func}' não encontrada e nenhuma sugestão foi localizada.[/red]")
+            raise typer.Exit(code=1)
+
+    info = docs[key]
+
+    print(f"[bold blue]Nome da Função:[/bold blue] {info.get('name', key)}")
+    print(f"[bold blue]Descrição:[/bold blue] {info.get('description')}")
+    print("[bold blue]Exemplo de Retorno:[/bold blue]")
+    _print_example(info.get("example_return"), full=full)
+
+@describe_app.command("list", help="Lista todas as funções/commands documentados.")
+def list_commands():
+    table = Table(title="Comandos documentados", show_lines=False)
+    table.add_column("chave", style="cyan", no_wrap=True)
+    table.add_column("nome", style="magenta")
+    table.add_column("descrição", style="white")
+    for k, v in sorted(docs.items()):
+        table.add_row(k, v.get("name", ""), v.get("description", ""))
+    print(table)
+
+if __name__ == "__main__":
+    describe_app()

{forensic_cli-1.4.2 → forensic_cli-1.4.4/src/forensic_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: forensic-cli
-Version: 1.4.2
+Version: 1.4.4
 Summary: DevKit Forense - CLI para análise de navegadores e rede
 Home-page: https://github.com/ErickG123/devkit_forense
 Author: Erick Gabriel dos Santos Alves
@@ -95,7 +95,9 @@ Dynamic: requires-python
 
 # DevKit Forense – Ferramenta Educacional de Perícia Digital
 
-![Python](https://img.shields.io/badge/Python-3.11-blue.svg) ![FastAPI](https://img.shields.io/badge/FastAPI-0.100-green.svg) ![Typer](https://img.shields.io/badge/Typer-0.7-orange.svg) ![SQLite](https://img.shields.io/badge/SQLite-3.41.2-lightgrey.svg)
+![Python](https://img.shields.io/badge/Python-3.11-blue.svg) ![Typer](https://img.shields.io/badge/Typer-0.7-orange.svg) ![SQLite](https://img.shields.io/badge/SQLite-3.41.2-lightgrey.svg)
+
+**ForenseLab** é um toolkit modular de análise forense digital, desenvolvido como um Trabalho de Conclusão de Curso em Engenharia da Computação. Seu principal objetivo é servir como uma ponte educacional para estudantes, educadores e entusiastas da área de segurança da informação.
 
 ## Sumário
 1. [Introdução](#introdução)  
@@ -111,43 +113,31 @@ Dynamic: requires-python
 
 ---
 
-# DevKit Forense: Uma Suíte de Ferramentas Educacionais para Análise Forense Digital
-
-## 📖 Introdução
-
-O estudo da perícia forense digital, embora fascinante, apresenta uma curva de aprendizado íngreme. Ferramentas profissionais são poderosas, mas muitas vezes complexas e pouco intuitivas para estudantes que estão dando os primeiros passos na área.
-
-Para endereçar essa lacuna, o **DevKit Forense** foi desenvolvido como um projeto de TCC. Trata-se de uma suíte de ferramentas projetada desde o início com um **foco educacional**. Nosso objetivo é simplificar a análise de evidências digitais, tornando o processo de aprendizado mais interativo, visual e didático.
+## 🎯 O Problema
+O ensino prático de computação forense enfrenta uma barreira significativa. Ferramentas comerciais padrão de mercado, como EnCase e FTK, são robustas, mas possuem um custo proibitivo para ambientes acadêmicos. Por outro lado, alternativas open-source consolidadas, como Autopsy e Volatility Framework, embora poderosas e gratuitas, apresentam uma curva de aprendizado íngreme que pode intimidar e frustrar iniciantes.
 
-Este projeto é destinado a **estudantes e professores da área de Segurança da Informação e Perícia Digital**, servindo como uma ponte entre o conhecimento teórico e a aplicação prática.
+Essa dualidade cria uma lacuna educacional: falta uma plataforma que permita ao estudante focar na **metodologia investigativa**, sem se perder na complexidade operacional da ferramenta.
 
----
-
-## ✨ Recursos em Destaque
+## 💡 A Proposta do ForenseLab
+O **ForenseLab** nasce para preencher essa lacuna, atuando como um "laboratório digital" introdutório. Ele não busca competir em funcionalidades com as suítes profissionais, mas sim oferecer um ambiente controlado, simplificado e didático para a aplicação de conceitos teóricos.
 
-O DevKit Forense combina o poder da linha de comando com a clareza de interfaces gráficas para oferecer uma experiência de aprendizado completa.
+Este projeto é destinado a **estudantes e professores da área de Segurança da Informação e Perícia Digital**, servindo como uma ponte entre a teoria e a prática.
 
-* **🔍 Análise Multifacetada:** Execute módulos de análise forense focados nos artefatos mais comuns do dia a dia digital, incluindo:
-    * Navegadores Web (histórico, cache, downloads)
-    * Clientes de E-mail
-    * Tráfego de Rede (análise de pacotes)
+## ✨ Recursos Principais
 
----
+* **💻 Interface de Linha de Comando (CLI) Intuitiva:** Todas as análises são executadas através de uma CLI clara e bem documentada, ideal para automação, scripts e para quem busca agilidade no terminal.
+* **🧩 Arquitetura Modular e Extensível:** O toolkit é organizado em módulos independentes (Navegadores, Rede, E-mails), o que permite que a comunidade adicione facilmente novas capacidades de análise sem alterar o núcleo do sistema.
+* **🎓 Foco Didático:** Ao abstrair complexidades desnecessárias, a ferramenta permite que o aluno se concentre em entender os artefatos digitais e desenvolver o raciocínio investigativo.
 
 ## 🏛️ Arquitetura do Projeto
 
-Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três camadas principais, cada uma com um propósito claro:
-
-1.  **`CLI (Command-Line Interface)`**
-    * **O que faz:** É a porta de entrada para a execução direta dos módulos forenses. Ideal para automação de tarefas, scripts e para usuários que preferem a agilidade do terminal.
+Para garantir a manutenibilidade e a clareza do código, o ForenseLab adota uma arquitetura de duas camadas principais, organizada em um monorepositório:
 
-2.  **`API (Application Programming Interface)`**
-    * **O que faz:** Expõe as funcionalidades do Core de forma programática. Permite que as aplicações de apoio (como dashboards visuais) consumam os dados e executem análises, além de possibilitar a integração do DevKit com outras ferramentas.
+1.  **`Core`**
+    * **O que faz:** É o cérebro do projeto. Contém toda a lógica de negócio, as classes de análise forense e as funções utilitárias. Centralizar a lógica no Core garante que as regras sejam consistentes e o código seja reutilizável.
 
-3.  **`Core`**
-    * **O que faz:** É o coração do projeto. Contém toda a lógica de negócio, as classes, funções e utilitários de análise. Centralizar a lógica no Core garante que as regras sejam consistentes, o código seja reutilizável e a manutenção seja simplificada, já que tanto a CLI quanto a API consomem desta mesma base.
-
----
+2.  **`CLI (Command-Line Interface)`**
+    * **O que faz:** É a interface do usuário e o ponto de entrada para todas as funcionalidades. Construída com Typer, ela invoca a lógica do `Core` para executar as análises e apresentar os resultados de forma estruturada no terminal.
 
 ## 3. Módulos Forenses
 
@@ -181,16 +171,11 @@ Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três ca
 | `email_parser` | Extrai e organiza informações de emails. |
 | `header_analysis` | Analisa cabeçalhos para identificar origem, roteamento e possíveis fraudes. |
 
----
-
 ## 4. Tecnologias Utilizadas
 
-- **Python** – Linguagem principal do projeto.  
-- **FastAPI** – API para integração e execução de módulos.  
-- **Typer** – CLI estruturada e interativa.  
-- **SQLite** – Banco de dados local leve.  
-
----
+* **Python:** Linguagem principal do projeto, escolhida por sua simplicidade e pelo vasto ecossistema de bibliotecas para manipulação de dados.
+* **Typer:** Utilizado para criar a interface de linha de comando (CLI) de forma robusta e intuitiva.
+* **SQLite:** Várias análises, como a de históricos de navegadores, interagem diretamente com bancos de dados SQLite.
 
 ## 5. Planejamento e Futuras Extensões
 
@@ -202,8 +187,6 @@ Para garantir modularidade e flexibilidade, o DevKit foi estruturado em três ca
 | Novos módulos CLI | Expansão da análise forense | Logs de sistemas, recuperação de dispositivos móveis, análise de mídia, detecção de malware, integração com threat intelligence |
 | Ferramentas auxiliares | Suporte a módulos existentes e novos | Exportação avançada de relatórios, dashboards customizáveis, notificações em tempo real |
 
----
-
 ## 6. Instalação
 A forma mais simples de instalar a CLI é utilizando o **PyPI**.  
 Execute o seguinte comando no terminal:

forensic_cli-1.4.2/src/cli/commands/describe.py

@@ -1,54 +0,0 @@
-import typer
-from rich import print
-
-describe_app = typer.Typer()
-
-@describe_app.command("func")
-def describe(
-    func: str = typer.Argument(..., help="Digite o nome da função que você deseja entender")
-):
-    docs = {
-        "map": {
-            "description": "Retorna informações detalhadas de cada host da rede.",
-            "example_return": [{
-                "host": "192.168.1.1",
-                "hostname": "router",
-                "mac": "AA:BB:CC:DD:EE:FF",
-                "vendor": "Cisco",
-                "open_ports": [22, 80],
-                "os_info": "Linux"
-            }]
-        },
-        "sweep": {
-            "description": "Faz um ping sweep na rede e retorna os hosts ativos.",
-            "example_return": ["192.168.1.1", "192.168.1.3"]
-        },
-        "scan": {
-            "description": "Verifica quais portas estão abertas, fechadas e filtradas.",
-            "example_return": [{
-                "port": 53,
-                "protocol": "UDP",
-                "status": "open|filtered",
-                "banner": "sem resposta",
-                "alert": "DNS"
-            }]
-        },
-        "fingerprinting": {
-            "description": "Detecta o sistema operacional, tipo de host, serviços e possíveis alertas de vulnerabilidade de um host.",
-            "example_return": {
-                "os": "Windows",
-                "host_type": "Servidor",
-                "services": ["SMB", "Web HTTP", "MySQL"],
-                "alerts": ["SMB vulnerável (Samba 3.0)"]
-            }
-        }
-    }
-
-    if func in docs:
-        info = docs[func]
-        print(f"[bold blue]Nome da Função:[/bold blue] {func}")
-        print(f"[bold blue]Descrição:[/bold blue] {info['description']}")
-        print("[bold blue]Exemplo de Retorno:[/bold blue]")
-        print(info['example_return'])
-    else:
-        typer.echo(f"Função {func} não encontrada.")