Opciones básicas de línea de comandos

• -p LOCAL_PATH - ruta a la carpeta que contiene los archivos a analizar.
• -a, --advance - cuando esta bandera está activada, todos los archivos serán analizados adicionalmente usando las reglas especificadas en el archivo rules.yaml.
• -r, --remove - cuando esta bandera está activada, los archivos que no contengan ningún secreto (o nada interesante si la bandera -a está activada) serán eliminados.
• -s, --secret - cuando esta bandera está activada, todos los archivos serán analizados adicionalmente en busca de contraseñas codificadas.
• -o OUTFILE - archivo de salida en formato JSON.

Requisitos previos

Para ejecutar DumpsterDiver debes instalar las librerías de Python. Puedes hacerlo ejecutando el siguiente comando:

Si tienes instalados por separado Python 2 y 3, entonces debes usar pip3 o pip3.6.

Personalizando tu búsqueda

No existe una herramienta única que se adapte a las necesidades de todos y DumpsterDiver no es una excepción. Hay 2 formas de personalizar tu búsqueda:

• usando parámetros de línea de comandos
• usando el archivo config.yaml

Personalización mediante parámetros de línea de comandos

• --min-key MIN_KEY - especifica la longitud mínima de clave a analizar (por defecto es 20).
• --max-key MAX_KEY - especifica la longitud máxima de clave a analizar (por defecto es 80).
• --entropy ENTROPY - especifica el límite de alta entropía (por defecto es 4.3).

También se ha añadido un script separado que te permite calcular la entropía de un carácter en una sola palabra. Te ayudará a personalizar mejor DumpsterDiver según tus necesidades. Puedes probarlo usando el siguiente comando:

Esta forma es muy útil cuando sabes lo que buscas. Aquí hay algunos ejemplos:

• Cuando buscas una AWS Secret Access Key:

$> python3 DumpsterDiver.py -p [PATH_TO_FOLDER] --min-key 40 --max-key 40 --entropy 4.3

• Cuando buscas una Azure Shared Key:

$> python3 DumpsterDiver.py -p [PATH_TO_FOLDER] --min-key 66 --max-key 66 --entropy 5.1

• Cuando buscas una clave privada SSH (por defecto, la clave privada RSA está escrita en cadenas de 76 bytes):

$> python3 DumpsterDiver.py -p [PATH_TO_FOLDER] --min-key 76 --max-key 76 --entropy 5.1

• Cuando buscas cualquier ocurrencia de aws_access_key_id o aws_secret_access_key:

$> python3 DumpsterDiver.py -p ./test/ --grep-words *aws_access_key_id* *aws_secret_access_key* -a

Ten en cuenta que los comodines antes y después de una palabra de búsqueda se usan a propósito. De esta forma, expresiones como "aws_access_key_id" o aws_access_key_id= también serán reportadas.

Encontrando contraseñas codificadas

Usar la entropía para encontrar contraseñas no es muy efectivo ya que genera muchos falsos positivos. Por eso DumpsterDiver utiliza un enfoque diferente para encontrar contraseñas codificadas: verifica la complejidad de la contraseña usando passwordmeter. Para personalizar esta búsqueda puedes usar los siguientes comandos:

• --min-pass MIN_PASS - especifica la longitud mínima de contraseña a analizar (por defecto es 8). Requiere añadir la bandera -s a la sintaxis.
• --max-pass MAX_PASS - especifica la longitud máxima de contraseña a analizar (por defecto es 12). Requiere añadir la bandera -s a la sintaxis.
• --pass-complex {1,2,3,4,5,6,7,8,9} - especifica el límite de complejidad de contraseña entre 1 (contraseñas triviales) y 9 (contraseñas muy complejas) (por defecto es 8). Requiere añadir la bandera -s a la sintaxis.

Por ejemplo, si quieres encontrar contraseñas complejas (que contengan mayúsculas, minúsculas, caracteres especiales, dígitos y tengan entre 10 y 15 caracteres de longitud), puedes hacerlo usando el siguiente comando:

$> python3 DumpsterDiver.py -p [PATH_TO_FOLDER] --min-pass 10 --max-pass 15 --pass-complex 8

Limitando el escaneo

Puede que quieras omitir el escaneo de ciertos archivos. Para ello puedes usar los siguientes parámetros:

• --exclude-files - especifica nombres de archivos o extensiones que no deben ser analizados. La extensión debe contener el carácter . (por ejemplo, .pdf). Varios nombres y extensiones deben separarse por espacio.

• --bad-expressions - especifica expresiones malas. Si DumpsterDiver encuentra dicha expresión en un archivo, ese archivo no será analizado. Varias expresiones malas deben separarse por espacio.

Si quieres especificar varios nombres de archivo, expresiones malas o palabras de búsqueda usando un archivo separado, puedes hacerlo mediante el siguiente truco de bash:

root@kitploit:~

$> python3 DumpsterDiver.py -p ./test/ --exclude-files `while read -r line; do echo $line; done < blacklisted_files.txt`

Personalización mediante el archivo config.yaml

En lugar de usar múltiples parámetros de línea de comandos, puedes especificar valores para todos los parámetros mencionados anteriormente de una vez en el archivo config.yaml.

Búsqueda avanzada:

DumpsterDiver también admite una búsqueda avanzada. Más allá de un simple grep con comodines, esta herramienta te permite crear condiciones. Supongamos que estás buscando una fuga de correos electrónicos corporativos. Además, solo te interesan las fugas grandes que contengan al menos 100 direcciones de correo. Para ello debes editar el archivo rules.yaml de la siguiente manera:

Supongamos otro escenario: buscas los términos "pass", "password", "haslo", "hasło" (si estás analizando un repositorio de una empresa polaca) en un archivo .db o .sql. Entonces puedes lograrlo modificando el archivo rules.yaml de la siguiente manera:

Ten en cuenta que la regla se activará solo cuando el peso total (filetype_weight + grep_words_weight) sea >=10.

Usando Docker

Una imagen de Docker está disponible para DumpsterDiver. Ejecútala usando:

Si quieres sobrescribir uno de los archivos de configuración (config.yaml o rules.yaml):

Contribución

¿Tienes mejores ideas? ¿Quieres ayudar en este proyecto? Por favor contáctame en Twitter @Rzepsky. ¡Estaría más que feliz de ver aquí a cualquier colaborador!

Agradecimientos especiales

Aquí me gustaría agradecer mucho a todos los que ayudaron a desarrollar este proyecto:

• Stephen Sorriaux
• Andres Riancho
• Damian Stygar
• Disconnect3d

Licencia

Consulta el archivo LICENSE.