pedrolclm/farejascan repository overview

⁠🇧🇷 Português (PT-BR)

⁠FarejaScan

O FarejaScan é uma ferramenta de reconhecimento e enumeração de redes desenvolvida em Python e distribuída em um contêiner Docker. A aplicação automatiza tarefas de reconhecimento utilizando o Nmap como mecanismo de varredura, permitindo identificar hosts ativos, portas abertas, serviços, versões e o sistema operacional estimado do alvo.

Seu objetivo é simplificar o processo de coleta de informações para inventário de ativos, administração de redes e testes de segurança autorizados, reduzindo a necessidade de múltiplas execuções manuais do Nmap.

⁠Funcionalidades

• Descoberta de hosts ativos
• Enumeração de portas TCP
• Detecção de serviços e versões (-sV)
• Estimativa do sistema operacional (-O)
• Execução de scripts NSE (quando aplicável)
• Execução em ambiente Docker
• Saída em formato textual para visualização ou exportação

⁠Como utilizar

⁠Escanear um host

docker run --rm farejascan 192.168.1.10

⁠Escanear um hostname

docker run --rm farejascan scanme.nmap.org

⁠Escanear uma rede

docker run --rm farejascan 192.168.1.0/24

⁠Salvar os resultados em um arquivo

⁠Linux/macOS

docker run --rm -v farejascan 192.168.1.10

⁠Windows (CMD)

docker run --rm farejascan 192.168.1.10 > resultado.txt

⁠Windows (PowerShell)

docker run --rm farejascan 192.168.1.10 | Out-File resultado.txt

⁠Fluxo de execução

1. Recebe um IP, hostname ou rede CIDR.
2. Descobre hosts ativos.
3. Enumera portas abertas.
4. Identifica serviços e versões.
5. Estima o sistema operacional.
6. Exibe os resultados da varredura.

⁠Tecnologias

• Python 3
• Nmap
• Docker

⁠Aviso

O FarejaScan deve ser utilizado exclusivamente em redes e sistemas para os quais o usuário possua autorização para realizar varreduras.

⁠🇺🇸 English

⁠FarejaScan

FarejaScan is a network reconnaissance and enumeration tool developed in Python and distributed as a Docker container. It automates reconnaissance tasks using Nmap as its scanning engine, enabling the identification of active hosts, open ports, running services, service versions, and the target operating system.

Its purpose is to simplify information gathering for asset inventory, network administration, and authorized security assessments by reducing the need to execute multiple Nmap commands manually.

⁠Features

• Active host discovery
• TCP port scanning
• Service and version detection (-sV)
• Operating system detection (-O)
• NSE script execution (when applicable)
• Docker-based execution
• Plain text output for viewing or exporting

⁠Usage

⁠Scan a host

docker run --rm farejascan 192.168.1.10

⁠Scan a hostname

docker run --rm farejascan scanme.nmap.org

⁠Scan a network

docker run --rm farejascan 192.168.1.0/24

⁠Save results to a file

⁠Linux/macOS

docker run --rm -v farejascan 192.168.1.10

⁠Windows (CMD)

docker run --rm farejascan 192.168.1.10 > results.txt

⁠Windows (PowerShell)

docker run --rm farejascan 192.168.1.10 | Out-File results.txt

⁠Execution Flow

1. Receives an IP address, hostname, or CIDR network.
2. Discovers active hosts.
3. Enumerates open TCP ports.
4. Identifies running services and their versions.
5. Estimates the target operating system.
6. Displays the scan results.

⁠Technologies

• Python 3
• Nmap
• Docker

⁠Disclaimer

FarejaScan should only be used on networks and systems for which you have explicit authorization to perform scanning and information gathering.