forensic-cli


Nameforensic-cli JSON
Version 1.2.11 PyPI version JSON
download
home_pagehttps://github.com/ErickG123/devkit_forense
SummaryDevKit Forense - CLI para análise de navegadores e rede
upload_time2025-09-03 12:21:51
maintainerNone
docs_urlNone
authorErick Gabriel
requires_python>=3.11
licenseMIT
keywords forensics cli network browser
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)

## Sumário
1. [Introdução](#introdução)  
2. [Estrutura do Projeto](#estrutura-do-projeto)  
3. [Módulos Forenses](#módulos-forenses)  
   - [Network](#network)  
   - [Browser](#browser)  
   - [Email](#email)  
4. [Tecnologias Utilizadas](#tecnologias-utilizadas)  
5. [Planejamento e Futuras Extensões](#planejamento-e-futuras-extensões)  
6. [Instalação](#instalação)  
7. [Exemplos de Execução](#exemplos-de-execução)  

---

## 1. Introdução

**Objetivo:**  
O DevKit Forense é uma suíte de ferramentas educacionais para análise de evidências digitais, projetada para auxiliar no ensino de perícia digital. Combina **CLI**, **API** e **aplicações de apoio**, tornando o uso mais interativo, visual e didático.  

**Escopo:**  
- Execução de análises forenses em browsers, arquivos, emails e redes.  
- Visualização interativa de resultados.  
- Geração de relatórios automáticos.  
- Assistente interativo (Wizard) para guiar o usuário em tarefas complexas.  

**Público-alvo:**  
- Estudantes e professores de Segurança da Informação e Perícia Digital.  

---

## 2. Estrutura do Projeto

O DevKit está organizado em três camadas principais:

1. **CLI** – Executa os módulos forenses pelo terminal.  
2. **API** – Interface programática para execução de módulos e integração com dashboards.  
3. **Core** – Contém a lógica central, classes, funções e utilitários compartilhados pelos módulos.  

---

## 3. Módulos Forenses

### Network
| Função | Descrição |
|--------|-----------|
| `ipinfo` | Consulta informações detalhadas sobre um endereço IP. |
| `arpscan` | Varre a rede para identificar dispositivos conectados via ARP. |
| `dnscan` | Realiza levantamento de informações de DNS de domínios e hosts. |
| `snmpscan` | Realiza varredura SNMP em dispositivos de rede. |
| `smbscan` | Verifica serviços SMB ativos em um host . |
| `sweep` | Verifica quais hosts estão ativos em uma faixa de IP. |
| `traceroute` | Traça o caminho percorrido por pacotes até um host alvo. |
| `map` | Gera mapa visual de hosts e conexões detectadas. |
| `scan` | Identifica portas abertas e serviços ativos em hosts. |
| `fingerprinting` | Identifica sistemas, serviços e versões na rede. |

### Browser
| Função | Descrição |
|--------|-----------|
| `logins` | Extração de credenciais armazenadas no Chrome e Edge. |
| `favscreen` | Captura e organiza screenshots de sites favoritos ou acessados. |
| `words` | Identifica palavras mais comuns em histórico de navegação e downloads. |
| `history` | Coleta histórico de navegação de diferentes browsers. |
| `patterns` | Identifica padrões suspeitos em histórico de navegação ou downloads. |
| `downloads` | Lista arquivos baixados pelos usuários. |

### Email
| Função | Descrição |
|--------|-----------|
| `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.  

---

## 5. Planejamento e Futuras Extensões

| Aplicação / Módulo | Objetivo | Possíveis Extensões |
|-------------------|----------|------------------|
| Dashboard | Painel central para visualização e execução de módulos | Filtros avançados, alertas em tempo real, integração direta com relatórios |
| Visualizadores | Transformar dados da CLI em gráficos, mapas e tabelas | Timeline interativa, heatmaps de rede, gráficos de comportamento de usuários |
| Wizard | Guiar o usuário passo a passo | Templates de análise rápida, integração automática com módulos de email e data, relatórios PDF/HTML |
| 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

```bash
pip install forensic-cli
```

---

## 7. Exemplos de Execução

**CLI:**
```bash
# Executar módulo de network scan
forensic-cli network map --network 192.168.0.0/24

# Coletar histórico do Chrome
forensic-cli browser history --chrome
```

**API:**
```bash
# Executar API
uvicorn api.main:app --reload
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ErickG123/devkit_forense",
    "name": "forensic-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "forensics, cli, network, browser",
    "author": "Erick Gabriel",
    "author_email": "Erick Gabriel dos Santos Alves <erickgabrielalves0@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/40/d1/165290fd0753650fdbe9cad5486ce50969c9b6e21c6a019f68f0806e33f8/forensic_cli-1.2.11.tar.gz",
    "platform": null,
    "description": "# DevKit Forense \u2013 Ferramenta Educacional de Per\u00edcia Digital\n\n![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)\n\n## Sum\u00e1rio\n1. [Introdu\u00e7\u00e3o](#introdu\u00e7\u00e3o)  \n2. [Estrutura do Projeto](#estrutura-do-projeto)  \n3. [M\u00f3dulos Forenses](#m\u00f3dulos-forenses)  \n   - [Network](#network)  \n   - [Browser](#browser)  \n   - [Email](#email)  \n4. [Tecnologias Utilizadas](#tecnologias-utilizadas)  \n5. [Planejamento e Futuras Extens\u00f5es](#planejamento-e-futuras-extens\u00f5es)  \n6. [Instala\u00e7\u00e3o](#instala\u00e7\u00e3o)  \n7. [Exemplos de Execu\u00e7\u00e3o](#exemplos-de-execu\u00e7\u00e3o)  \n\n---\n\n## 1. Introdu\u00e7\u00e3o\n\n**Objetivo:**  \nO DevKit Forense \u00e9 uma su\u00edte de ferramentas educacionais para an\u00e1lise de evid\u00eancias digitais, projetada para auxiliar no ensino de per\u00edcia digital. Combina **CLI**, **API** e **aplica\u00e7\u00f5es de apoio**, tornando o uso mais interativo, visual e did\u00e1tico.  \n\n**Escopo:**  \n- Execu\u00e7\u00e3o de an\u00e1lises forenses em browsers, arquivos, emails e redes.  \n- Visualiza\u00e7\u00e3o interativa de resultados.  \n- Gera\u00e7\u00e3o de relat\u00f3rios autom\u00e1ticos.  \n- Assistente interativo (Wizard) para guiar o usu\u00e1rio em tarefas complexas.  \n\n**P\u00fablico-alvo:**  \n- Estudantes e professores de Seguran\u00e7a da Informa\u00e7\u00e3o e Per\u00edcia Digital.  \n\n---\n\n## 2. Estrutura do Projeto\n\nO DevKit est\u00e1 organizado em tr\u00eas camadas principais:\n\n1. **CLI** \u2013 Executa os m\u00f3dulos forenses pelo terminal.  \n2. **API** \u2013 Interface program\u00e1tica para execu\u00e7\u00e3o de m\u00f3dulos e integra\u00e7\u00e3o com dashboards.  \n3. **Core** \u2013 Cont\u00e9m a l\u00f3gica central, classes, fun\u00e7\u00f5es e utilit\u00e1rios compartilhados pelos m\u00f3dulos.  \n\n---\n\n## 3. M\u00f3dulos Forenses\n\n### Network\n| Fun\u00e7\u00e3o | Descri\u00e7\u00e3o |\n|--------|-----------|\n| `ipinfo` | Consulta informa\u00e7\u00f5es detalhadas sobre um endere\u00e7o IP. |\n| `arpscan` | Varre a rede para identificar dispositivos conectados via ARP. |\n| `dnscan` | Realiza levantamento de informa\u00e7\u00f5es de DNS de dom\u00ednios e hosts. |\n| `snmpscan` | Realiza varredura SNMP em dispositivos de rede. |\n| `smbscan` | Verifica servi\u00e7os SMB ativos em um host . |\n| `sweep` | Verifica quais hosts est\u00e3o ativos em uma faixa de IP. |\n| `traceroute` | Tra\u00e7a o caminho percorrido por pacotes at\u00e9 um host alvo. |\n| `map` | Gera mapa visual de hosts e conex\u00f5es detectadas. |\n| `scan` | Identifica portas abertas e servi\u00e7os ativos em hosts. |\n| `fingerprinting` | Identifica sistemas, servi\u00e7os e vers\u00f5es na rede. |\n\n### Browser\n| Fun\u00e7\u00e3o | Descri\u00e7\u00e3o |\n|--------|-----------|\n| `logins` | Extra\u00e7\u00e3o de credenciais armazenadas no Chrome e Edge. |\n| `favscreen` | Captura e organiza screenshots de sites favoritos ou acessados. |\n| `words` | Identifica palavras mais comuns em hist\u00f3rico de navega\u00e7\u00e3o e downloads. |\n| `history` | Coleta hist\u00f3rico de navega\u00e7\u00e3o de diferentes browsers. |\n| `patterns` | Identifica padr\u00f5es suspeitos em hist\u00f3rico de navega\u00e7\u00e3o ou downloads. |\n| `downloads` | Lista arquivos baixados pelos usu\u00e1rios. |\n\n### Email\n| Fun\u00e7\u00e3o | Descri\u00e7\u00e3o |\n|--------|-----------|\n| `email_parser` | Extrai e organiza informa\u00e7\u00f5es de emails. |\n| `header_analysis` | Analisa cabe\u00e7alhos para identificar origem, roteamento e poss\u00edveis fraudes. |\n\n---\n\n## 4. Tecnologias Utilizadas\n\n- **Python** \u2013 Linguagem principal do projeto.  \n- **FastAPI** \u2013 API para integra\u00e7\u00e3o e execu\u00e7\u00e3o de m\u00f3dulos.  \n- **Typer** \u2013 CLI estruturada e interativa.  \n- **SQLite** \u2013 Banco de dados local leve.  \n\n---\n\n## 5. Planejamento e Futuras Extens\u00f5es\n\n| Aplica\u00e7\u00e3o / M\u00f3dulo | Objetivo | Poss\u00edveis Extens\u00f5es |\n|-------------------|----------|------------------|\n| Dashboard | Painel central para visualiza\u00e7\u00e3o e execu\u00e7\u00e3o de m\u00f3dulos | Filtros avan\u00e7ados, alertas em tempo real, integra\u00e7\u00e3o direta com relat\u00f3rios |\n| Visualizadores | Transformar dados da CLI em gr\u00e1ficos, mapas e tabelas | Timeline interativa, heatmaps de rede, gr\u00e1ficos de comportamento de usu\u00e1rios |\n| Wizard | Guiar o usu\u00e1rio passo a passo | Templates de an\u00e1lise r\u00e1pida, integra\u00e7\u00e3o autom\u00e1tica com m\u00f3dulos de email e data, relat\u00f3rios PDF/HTML |\n| Novos m\u00f3dulos CLI | Expans\u00e3o da an\u00e1lise forense | Logs de sistemas, recupera\u00e7\u00e3o de dispositivos m\u00f3veis, an\u00e1lise de m\u00eddia, detec\u00e7\u00e3o de malware, integra\u00e7\u00e3o com threat intelligence |\n| Ferramentas auxiliares | Suporte a m\u00f3dulos existentes e novos | Exporta\u00e7\u00e3o avan\u00e7ada de relat\u00f3rios, dashboards customiz\u00e1veis, notifica\u00e7\u00f5es em tempo real |\n\n---\n\n## 6. Instala\u00e7\u00e3o\n\n```bash\npip install forensic-cli\n```\n\n---\n\n## 7. Exemplos de Execu\u00e7\u00e3o\n\n**CLI:**\n```bash\n# Executar m\u00f3dulo de network scan\nforensic-cli network map --network 192.168.0.0/24\n\n# Coletar hist\u00f3rico do Chrome\nforensic-cli browser history --chrome\n```\n\n**API:**\n```bash\n# Executar API\nuvicorn api.main:app --reload\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "DevKit Forense - CLI para an\u00e1lise de navegadores e rede",
    "version": "1.2.11",
    "project_urls": {
        "Changelog": "https://erickg123.github.io/devkit_forense/",
        "Homepage": "https://github.com/ErickG123/devkit_forense",
        "Issues": "https://github.com/ErickG123/devkit_forense/issues",
        "Source": "https://github.com/ErickG123/devkit_forense"
    },
    "split_keywords": [
        "forensics",
        " cli",
        " network",
        " browser"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "72efe1c376e77bcdcdc6437c1549cd2ca86f63ed34bfab0d05061e22815d2c11",
                "md5": "02b8cb44df51c960d88f285c74b84e9a",
                "sha256": "3f704fec806a98754b8eb27b32c730844e09c9cbbca253bc3a7991d1e7b448a1"
            },
            "downloads": -1,
            "filename": "forensic_cli-1.2.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "02b8cb44df51c960d88f285c74b84e9a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 49500,
            "upload_time": "2025-09-03T12:21:50",
            "upload_time_iso_8601": "2025-09-03T12:21:50.515833Z",
            "url": "https://files.pythonhosted.org/packages/72/ef/e1c376e77bcdcdc6437c1549cd2ca86f63ed34bfab0d05061e22815d2c11/forensic_cli-1.2.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "40d1165290fd0753650fdbe9cad5486ce50969c9b6e21c6a019f68f0806e33f8",
                "md5": "3f0a48d5d8e6d8c3ac791368a0310f08",
                "sha256": "8bbd5df205f1b3832fe67cd77dde63d947eaa11d8ec74b15e17a9699ff544a28"
            },
            "downloads": -1,
            "filename": "forensic_cli-1.2.11.tar.gz",
            "has_sig": false,
            "md5_digest": "3f0a48d5d8e6d8c3ac791368a0310f08",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 42985,
            "upload_time": "2025-09-03T12:21:51",
            "upload_time_iso_8601": "2025-09-03T12:21:51.809662Z",
            "url": "https://files.pythonhosted.org/packages/40/d1/165290fd0753650fdbe9cad5486ce50969c9b6e21c6a019f68f0806e33f8/forensic_cli-1.2.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-03 12:21:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ErickG123",
    "github_project": "devkit_forense",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "forensic-cli"
}
        
Elapsed time: 1.86531s