Gitmails

Desarrollo - IMPORTANTE

Esta versión de Gitmails ya no recibe mantenimiento. Echa un vistazo a la versión de Gitmails Shell si deseas usar una versión que recibe mantenimiento y, con suerte, se desarrolla.

Si no deseas usar la versión de shell y prefieres la versión en Python, siéntete libre de hacer un fork de Gitmails y dirigirlo hacia el camino que consideres adecuado.

Vista general

Gitmails explora que los commits de git contienen un nombre y un correo electrónico configurados por el autor y que los servicios de alojamiento de control de versiones se utilizan para almacenar muchos proyectos.

Lo que Gitmails hace es:

• Consultar los servicios de alojamiento de control de versiones para obtener información sobre una organización, equipo, grupo, usuario o repositorio individual;
• Listar todos los repositorios (restringidos por autenticación) si no está en modo de repositorio único;
• Clonar el repositorio o consultar el servicio de alojamiento de control de versiones para obtener el historial de commits;
• Analizar el historial de commits para identificar autores únicos. Los autores se definen mediante un par de nombre y correo electrónico.

Con estos pasos, Gitmails puede recopilar todos los correos electrónicos encontrados en el historial de commits para un objetivo específico.

Uso

Primero, debes elegir el método de operación: recopilar correos de una organización, usuario o repositorio único. Esto se puede hacer con las opciones: -u --username, -o --organization o -r --repository.

Después de especificar el método de operación, debes establecer el objetivo. Debes pasarlo justo después del método de operación: python3 gitmails.py -u some_username, python3 gitmails.py -o some_org o python3 gitmails.py -r some_repo_url. NOTA: los nombres de usuario de gitlab distinguen entre mayúsculas y minúsculas, tenlo en cuenta al intentar recopilar correos allí.

Con esta configuración básica, Gitmails clonará todos los repositorios para el objetivo especificado (o clonará el repositorio en la URL) y analizará su historial de commits. Luego, imprimirá la información de alto nivel del usuario u organización y finalmente imprimirá, en una tabla "fancy_grid" (de tabulate), todos los pares Nombre-Correo encontrados durante el análisis.

Opciones útiles:

• --raw: Imprimirá los resultados en texto puro, sin tablas, solo valores separados por comas;
• -f | --file: Almacenará el resultado en el archivo especificado. Los resultados estarán en csv sin formato de cabecera.
• --include-repositories: Hará que Gitmails imprima el resultado con información sobre en qué repositorio se encontró el correo.
• -p | --path: Especifica la ruta temporal para clonar los repositorios.
• -e | --exclude: Ignorar repositorios especificados. Comparará el nombre del repositorio; si coincide, ignorará el repositorio y pasará al siguiente.
• --no-cleanup: No eliminará los repositorios clonados.
• --include-forks: Incluirá repositorios bifurcados en el análisis (Solo para github).
• --include-users: Si se recopila una organización, recopilará información sobre sus miembros públicos (Solo para github).
• --no-[gitlab|github|bitbucket]: No recopilará información del servicio de alojamiento especificado.
• --run-plugins: Ejecutará complementos en el resultado recopilado.

Instalación

Para instalar Gitmails, deberás ejecutar los siguientes pasos:

• pip3 install -r requirements.txt
• Instalar pygit2 a través del gestor de paquetes de tu sistema operativo.

Problemas con Debian

Si estás usando Debian (quizás Ubuntu también), el paquete libgit2 no funciona con Gitmails. Para solucionarlo, necesitarás compilar libgit2 manualmente. Los siguientes pasos deberían ser suficientes:

wget https://github.com/libgit2/libgit2/archive/v0.27.0.tar.gz && \
      tar xzf v0.27.0.tar.gz && \
      cd libgit2-0.27.0/ && \
      cmake . && \
      make && \
      sudo make install
ldconfig
pip3 install pygit2

O ejecuta el script de instalación para Debian.

Docker

También puedes usar la versión docker de la herramienta ejecutando el siguiente comando:

• docker run -it giovanifss/gitmails --help

Ten en cuenta que si deseas escribir en un archivo, necesitarás montar un volumen docker:

• docker run -v /tmp/output:/opt -it giovanifss/gitmails -f /opt/result.txt

Contribuir

Este proyecto ya no recibe mantenimiento. Si deseas contribuir, echa un vistazo a Gitmails Shell.

Aviso legal

Esta herramienta recopila datos que pueden ser útiles para trabajos legales de seguridad ofensiva. Los autores de este proyecto rechazan cualquier responsabilidad por daños o pérdidas causadas por el mal uso o uso malicioso de esta herramienta. Consulta LICENSE para más detalles.