🐳 RAUDI: Imágenes Docker Actualizadas Regular y Automáticamente

RAUDI (Regularly and Automatically Updated Docker Images) genera y mantiene actualizadas automáticamente una serie de imágenes Docker mediante GitHub Actions para herramientas que no son proporcionadas por los desarrolladores.

Tabla de contenidos

• ¿Qué es RAUDI?
• Fork
• Configuración
• Prueba
• Uso local
• Herramientas disponibles
• Estructura de la herramienta
• Ayudantes
• Ejemplos
• Cómo pronunciar
• Contribuciones
• Créditos
• Licencia

¿Qué es RAUDI?

RAUDI es lo que te ahorrará la tarea de crear y gestionar muchas imágenes Docker manualmente. Cada vez que un software se actualiza, necesitas actualizar la imagen Docker si quieres usar las últimas funciones, las dependencias ya no funcionan.

Esto es desordenado y consume mucho tiempo.

No te preocupes más, nosotros te cubrimos.

Puedes hacer un fork de este repositorio y usar el flujo de trabajo de GitHub tú mismo, o usarlo localmente (y gestionar su ejecución como prefieras).

Fork

Si deseas hacer un fork de este repositorio, también debes configurar algunos secretos para poder subir tus imágenes a tu cuenta personal de Docker Hub. Dos secretos de GitHub deben configurarse:

• DOCKER_USER: Tu nombre de usuario de Docker Hub;
• DOCKER_API_TOKEN: Tu contraseña o token de API de Docker Hub.

Después de configurar esos secretos, debes editar la variable organization establecida en el archivo tools/main.py, ya que está configurada para subir a Docker Hub para SecSI.

Eso es todo: ve a Action, actívalo para tu repositorio bifurcado, espera hasta la medianoche, ¡y el flujo de trabajo hará el trabajo pesado!

Configuración

Este repositorio también se puede ejecutar localmente. Los requisitos que se deben cumplir son los siguientes:

• Python 3.x
• Docker (con BuildX)

Aquí está la documentación para trabajar con BuildX: https://docs.docker.com/buildx/working-with-buildx/

La fase de configuración es bastante sencilla, solo necesitas los siguientes comandos:

git clone https://github.com/cybersecsi/RAUDI
cd RAUDI
pip install -r requirements.txt

¡Estás listo para empezar!

Prueba

Para ejecutar la prueba necesitas instalar pytest con el comando pip install pytest (no está en requirements.txt ya que solo se necesita con fines de prueba) y luego puedes ejecutar:

pytest -s

o

python -m pytest -s

para ejecutar las pruebas.

Uso local

RAUDI puede construir y subir todas las herramientas que se colocan en el directorio tools. Hay diferentes opciones que se pueden usar al ejecutarlo. Antes de usarlo localmente, debes crear un archivo .env (puedes copiar el archivo .env.sample) y agregar tu token de acceso personal de GitHub para evitar la limitación de tasa. Para usuarios no autenticados, GitHub permite hasta 60 solicitudes por hora, mientras que los usuarios autenticados pueden realizar hasta 15.000 solicitudes por hora. ¡Por esta razón te recomendamos que lo agregues! También puedes crear un token de acceso personal sin ningún ámbito, ya que todo lo que hacemos es leer información de cada repositorio de GitHub.

Modos de ejecución

Ejecución normal

En este modo, RAUDI intenta construir todas las herramientas si es necesario. El comando para ejecutarlo es simplemente:

python3 ./raudi.py --all

Construcción única

En este modo, RAUDI intenta construir solo la herramienta especificada. El comando en este caso es:

python3 ./raudi.py --single <tool_name>

tool_name DEBE ser el nombre del directorio dentro de la carpeta tools.

Probar herramienta

Dado que el parámetro tests se ha añadido a la estructura de configuración de la herramienta, puede ser útil para probar si los comandos insertados devuelven un código de estado 0. El comando para probar una herramienta específica es:

python3 ./raudi.py --test <tool_name>

tool_name DEBE ser el nombre del directorio dentro de la carpeta tools.

Mostrar herramientas

Si quieres conocer las herramientas disponibles, puedes ejecutar este comando:

python3 ./raudi.py --list

Inicializar herramienta

Si quieres agregar rápidamente una nueva carpeta de herramienta a partir de una de las plantillas disponibles, puedes ejecutar este comando:

python3 ./raudi.py --bootstrap <new_tool_name>

Opciones

Herramientas disponibles

Esta es la lista actual de herramientas que se han añadido. Son todas aquellas herramientas que no tienen una imagen Docker oficial proporcionada por el desarrollador:

Estructura de la herramienta

Cada herramienta en el directorio tools contiene al menos dos archivos:

• config.py
• Dockerfile.
• README.md (README opcional para Docker Hub)

Si deseas agregar una nueva herramienta, solo tienes que crear una carpeta para esa herramienta específica dentro del directorio tools. En esta carpeta debes insertar el Dockerfile con argumentos de construcción definidos para personalizar y automatizar la construcción. Una vez que hayas creado el Dockerfile, debes crear un config.py en el mismo directorio con una función llamada get_config(organization, common_args). Ten cuidado: la función DEBE llamarse así y DEBE tener esos dos parámetros (incluso si no los usas). El valor de retorno es la configuración para esa herramienta específica y tiene la siguiente estructura:

config =  {
    'name': organization+'/<name_of_the_image>',
    'version': '', # Should be an helper function
    'buildargs': {
    },
    'tests': []
  }

Las cuatro claves son:

• name: el nombre de la imagen Docker (p. ej., secsi/<tool_name>);
• version: el número de versión de la imagen Docker. Para esto puedes usar una función auxiliar que pueda recuperar el número de versión más reciente disponible (mira tools/ffuf como ejemplo);
• buildargs: un diccionario para especificar las partes de las imágenes Docker que están sujetas a actualizaciones (de nuevo, mira tools/ffuf como ejemplo);
• tests: un arreglo de pruebas (generalmente solo una simple como '--help').

Después de hacerlo, ¡estás listo! Solo ten cuidado de que el nombre de la herramienta DEBE SER EL MISMO que el directorio en el que colocaste su Dockerfile.

Hay una CONVENCIÓN DE NOMBRES para las versiones: usa solo PUNTOS y DÍGITOS; por favor, elimina cualquier 'v' al final de la versión en el config.py específico (para un ejemplo funcional, consulta tools/dirsearch/config.py).

Ayudantes

Para obtener las últimas versiones e información sobre herramientas e imágenes base, se ha implementado un conjunto de ayudantes. Si deseas agregar una nueva herramienta, debes usar estos ayudantes para tener una imagen Docker que se actualice automáticamente mediante RAUDI.

get_latest_pip_version

Este ayudante se usa para obtener la última versión de un paquete pip. Solo necesita el nombre del paquete y devuelve el número de versión. Ejemplo:

VERSION = helper.get_latest_pip_version(package_name)

get_latest_npm_registry_version

Este ayudante se usa para obtener la última versión de un paquete npm. Solo necesita el nombre del paquete y devuelve el número de versión. Ejemplo:

VERSION = helper.get_latest_npm_registry_version(package_name)

get_latest_github_release

Este ayudante se usa para obtener información sobre un repositorio de GitHub que usa Releases y tiene varios tipos de activos (p. ej., ejecutables para diferentes sistemas operativos). Este ayudante toma el repositorio (en el formato user/repo) y una cadena objetivo para poder identificar el activo correcto a descargar. Devuelve un diccionario con dos claves (url y version). Ejemplo:

VERSION = helper.get_latest_github_release("user/repo", "linux_amd64")

get_latest_github_release_no_browser_download

Este ayudante se usa para obtener información sobre un repositorio de GitHub que usa Releases y solo tiene el código fuente (lo que significa que hay un zipball y un tarball). Este ayudante toma el repositorio (en el formato user/repo) y devuelve un diccionario con dos claves (url y version). Ejemplo:

VERSION = helper.get_latest_github_release_no_browser_download("user/repo")

get_latest_github_tag_no_browser_download

Este ayudante se usa para obtener información sobre un repositorio de GitHub que usa Tags y solo tiene el código fuente (lo que significa que hay un zipball y un tarball). Este ayudante toma el repositorio (en el formato user/repo) y devuelve un diccionario con dos claves (url y version). Ejemplo:

VERSION = helper.get_latest_github_tag_no_browser_download("user/repo")

get_latest_github_commit

Este ayudante se usa para obtener información sobre un repositorio de GitHub que no usa Tags ni Releases. En este caso, el objetivo es obtener el último commit. Este ayudante toma el repositorio (en el formato user/repo) y devuelve una cadena que representa la fecha del último commit en el formato YYYYYMMDD.

VERSION = helper.get_latest_github_commit("user/repo")

Ejemplos

Esta sección proporciona ejemplos para las herramientas de seguridad de red actualmente añadidas. Como puedes ver, las imágenes solo proporcionan la herramienta, por lo que si necesitas usar una wordlist, necesitas montarla.

Ejemplo genérico

docker run -it --rm secsi/<tool> <command>

Ejemplo específico

docker run -it --rm -v <wordlist_src_dir>:<wordlist_container_dir> secsi/dirb <url> <wordlist_container_dir>/<wordlist_file>

Cómo pronunciar

Somos italianos, por lo que probablemente lo pronunciamos de manera diferente a la tuya. La pronunciación correcta (usando la transcripción fonética) es la siguiente:

/ˈraʊdi/

De lo contrario, piensa en el perro de peluche del famoso programa de televisión Scrubs: Rowdy

Contribuciones

¡Todos están invitados a contribuir! Hemos creado un documento muy detallado que describe cómo contribuir a RAUDI.

Créditos

RAUDI es desarrollado con orgullo por @SecSI:

• Angelo Delicato
• Daniele Capone
• Gaetano Perrone
• Gabriele Previtera

Otros contribuyentes:

• frost19k

Licencia

RAUDI es un software de código abierto y gratuito publicado bajo la GNU GPL v3.