andalik / log4j-filescan

Scanner recursivo de arquivos desenvolvido em Python 3 para localização e varredura de versões vulneráveis do Log4j2, contemplando análise interna de arquivos JAR (CVE-2021-44228, CVE-2021-45046, CVE-2021-45105 e CVE-2021-44832)

████████████████▀███████████████████████████████████████████████████████████████████
█▄─▄███─▄▄─█─▄▄▄▄█░█░████▄─▄█▀▀▀▀▀██▄─▄▄─█▄─▄█▄─▄███▄─▄▄─█─▄▄▄▄█─▄▄▄─██▀▄─██▄─▀█▄─▄█
██─██▀█─██─█─██▄─█▄▄░██─▄█─██████████─▄████─███─██▀██─▄█▀█▄▄▄▄─█─███▀██─▀─███─█▄▀─██
▀▄▄▄▄▄▀▄▄▄▄▀▄▄▄▄▄▀▀▄▄▄▀▄▄▄▀▀▀▀▀▀▀▀▀▀▄▄▄▀▀▀▄▄▄▀▄▄▄▄▄▀▄▄▄▄▄▀▄▄▄▄▄▀▄▄▄▄▄▀▄▄▀▄▄▀▄▄▄▀▀▄▄▀
by Renato Andalik (@andalik)

Simples e direto ao ponto... Não requer prática, nem tão pouco habilidade!
Log4j-FileScan é um script desenvolvido em Python 3 para realizar a varredura completa de um filesystem buscando por versões vulneráveis do framework Log4j2 conforme descrito na CVE-2021-44228, CVE-2021-45046, CVE-2021-45105 e CVE-2021-44832.
A varredura é realizada recursivamente tanto em disco quanto dentro de arquivos Java Archive (JARs).

Funcionamento

Para otimizar a velocidade da varredura, a busca ocorre SOMENTE nos arquivos relacionados ao problema:

• Todos os arquivos com extensão Java ARchive (inclusive em arquivos compactados com zip):
  • *.jar, *.war, *.ear e *.zip

Se um arquivo com uma das extensões mencionadas acima é localizado, ocorre a varredura dos arquivos internos (tudo em memória).

Download e Execução

O script pode ser baixado e utilizado de 2 formas distintas:

1. Usando Binário (Piece of Cake Mode)

Para facilitar ainda mais, compilamos tudo e disponibilizamos um binário executável.
Basta baixar a versão para seu Sistema Operacional, abrir o prompt de comando e executar:

• Windows: log4j-filescan.exe
  IMPORTANTE: Devido ao modelo de empacotamento proporcionado pelo PyInstaller (tudo em um único executável), alguns antivírus podem gerar um alerta falso-positivo. Desta forma, basta incluir o executável na lista de excessões do seu antivírus.

• Linux: log4j-filescan

No Linux, via console, você também pode utilizar o wget para obter o binário:

wget https://github.com/andalik/log4j-filescan/releases/download/v1.1.1/log4j-filescan -O log4j-filescan
chmod +x log4j-filescan
sudo ./log4j-filescan

2. Usando Python 3

Para distribuições Linux com Python 3.6+ instalado, utilize um dos métodos abaixo:

wget https://github.com/andalik/log4j-filescan/raw/main/log4j-filescan.py
export LC_ALL=$(locale -a | grep UTF-8)
sudo python3 log4j-filescan.py

Criando executáveis

Criando executável Windows

1. Baixar Python 3.6 ou superior em https://www.python.org/downloads/

   • Certifique-se, durante a instalacão, de selecionar a opção Add Python 3.x to PATH.

2. Abrir o prompt de comando e executar pip para instalar o pyinstaller:

   pip install pyinstaller
   pip install colorama

3. Baixar a última versão do script log4j-filescan.py e executar o PyInstaller:

   pyinstaller --onefile --hidden-import colorama log4j-filescan.py

O executável Windows será criado no diretório dist: dist\log4j-filescan.exe

Criando executável Linux

Examplo para Debian 11:

sudo apt update
sudo apt install python3-pip git
pip3 install --user pyinstaller

git clone https://github.com/andalik/log4j-filescan
cd log4j-filescan
~/.local/bin/pyinstaller --onefile log4j-filescan.spec

./dist/log4j-finder --help

Exemplos de Uso

1. Varredura em um diretório específico (padrão é /):

$ python3 log4j-filescan.py
ou
$ python3 log4j-filescan.py /caminho/desejado (no Linux)
$ python3 log4j-filescan.py d:\ (no Windows)

2. Varredura em um arquivo JAR:

$ python3 log4j-filescan.py /caminho/arquivo.jar

3. Varredura em múltiplos diretórios e/ou arquivos:

$ python3 log4j-filescan.py /caminho/dir1 /caminho/dir2 /caminho/arquivo.jar

4. Varredura excluindo alguns arquivos e/ou diretórios

$ python3 log4j-filescan.py / --exclude "/caminho/*.war"

4. Verbose ou Modo Debug:

$ python3 log4j-filescan.py -v /caminho/desejado
$ python3 log4j-filescan.py -vv /caminho/desejado

Notas Importantes

• No Windows, se nenhuma unidade for informada, a varredura ocorrerá apenas em c:\.
  Entretanto, é possível especificar todas as unidades físicas do computador para varredura de uma única vez.

Abra o Powershell (de preferência com “Run as Administrator”) e digite:

python3 log4j-filescan.py c:\ d:\ e:\

A ferramenta realizará a varredura no C:, depois no D: e por fim E:. Se alguma unidade não existir, a ferramenta simplesmente ignorará a unidade informada sem apresentar erro. Tudo ficará registrado na tela (quais arquivos vulneráveis encontrados em qual unidade).

• Arquivos e/ou diretórios que não puderem ser acessados (permissão de acesso negado) não serão listados.