Eliminar datos confidenciales de un repositorio

La herramienta git filter-repo y el BFG Repo-Cleaner reescriben el historial de tu repositorio, el cual cambia los SHA para las confirmaciones existentes que alteras y cualquier confirmación dependiente. Las SHA de confirmación modificadas pueden afectar las solicitudes de extracción abiertas de tu repositorio. Recomendamos fusionar o cerrar todas las solicitudes de extracción abiertas antes de eliminar archivos de tu repositorio.

Puedes eliminar el archivo desde la última confirmación con git rm. Para obtener más información sobre cómo eliminar un archivo que se agregó con la última confirmación, consulta la sección "Acerca de los archivos grandes en GitHub".

Purgar un archivo del historial de tu repositorio

Puedes purgar un archivo del historial de tu repositorio utilizando ya sea la herramienta git filter-repo o la herramienta de código abierto BFG Repo-Cleaner.

Usar el BFG

El BFG Repo-Cleaner es una herramienta construida y mantenida por la comunidad de código abierto. Proporciona una alternativa más rápida y simple que git filter-branch para eliminar datos no deseados.

Por ejemplo, para eliminar tu archivo con datos confidenciales y dejar intacta tu última confirmación, ejecuta lo siguiente:

$ bfg --delete-files YOUR-FILE-WITH-SENSITIVE-DATA

Para reemplazar todo el texto detallado en passwords.txt donde sea que se encuentre en el historial de tu repositorio, ejecuta lo siguiente:

$ bfg --replace-text passwords.txt

Después de que se eliminan los datos sensibles, debes subir forzadamente tus cambios a GitHub Enterprise Server.

$ git push --force

Consulta los documentos de BFG Repo-Cleaner para obtener todas las indicaciones para el uso y la descarga.

Utilizar git filter-repo

Para ilustrar cómo funciona git filter-repo, te mostraremos cómo eliminar tu archivo con datos confidenciales del historial de tu repositorio y agregarlo a .gitignore para asegurar que no se reconfirmó de manera accidental.

1. Instala el último lanzamiento de la herramienta git filter-repo. Puedes instalar git-filter-repo manualmente o utilizando un administrador de paquete. Por ejemplo, para instalar la herramienta con HomeBrew, utiliza el comando brew install.

   brew install git-filter-repo
   

   Para obtener más información, consulta el archivo INSTALL.md en el repositorio newren/git-filter-repo.

2. Si aún no tienes una copia local de tu repositorio con datos confidenciales en el historial, clona el repositorio en tu computadora local.

   $ git clone https://nombre de host/YOUR-USERNAME/YOUR-REPOSITORY
   > Initialized empty Git repository in /Users/YOUR-FILE-PATH/YOUR-REPOSITORY/.git/
   > remote: Counting objects: 1301, done.
   > remote: Compressing objects: 100% (769/769), done.
   > remote: Total 1301 (delta 724), reused 910 (delta 522)
   > Receiving objects: 100% (1301/1301), 164.39 KiB, done.
   > Resolving deltas: 100% (724/724), done.

3. Navega hacia el directorio de trabajo del repositorio.

   $ cd YOUR-REPOSITORY

4. Ejecuta el siguiente comando, reemplazando PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA por la ruta al archivo que quieres eliminar, no solo con su nombre de archivo. Estos argumentos harán lo siguiente:

   • Forzar a Git a que procese, pero no revise, todo el historial de cada rama y etiqueta
   • Eliminar el archivo especificado y cualquier confirmación vacía generada como resultado
   • Elimina algunas configuraciones, tales como la URL remota almacenada en el archivo .git/config. Podrías necesitar respaldar este archivo con anticipación para restaurarlo posteriormente.
   • Sobrescribir tus etiquetas existentes

     $ git filter-repo --invert-paths --path PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA
       Parsed 197 commits
       New history written in 0.11 seconds; now repacking/cleaning...
       Repacking your repo and cleaning out old unneeded objects
       Enumerating objects: 210, done.
       Counting objects: 100% (210/210), done.
       Delta compression using up to 12 threads
       Compressing objects: 100% (127/127), done.
       Writing objects: 100% (210/210), done.
       Building bitmaps: 100% (48/48), done.
       Total 210 (delta 98), reused 144 (delta 75), pack-reused 0
       Completely finished after 0.64 seconds.

   Nota: Si se utilizó el archivo con datos confidenciales para que existiera en cualquier otra ruta (porque se movió o se renombró), debes ejecutar este comando en esas rutas también.

5. Agrega tu archivo con datos confidenciales a .gitignore para asegurar que no lo volviste a confirmar por accidente.

   $ echo "YOUR-FILE-WITH-SENSITIVE-DATA" >> .gitignore
   $ git add .gitignore
   $ git commit -m "Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore"
   > [main 051452f] Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore
   >  1 files changed, 1 insertions(+), 0 deletions(-)

6. Comprueba que hayas eliminado todo lo que querías del historial de tu repositorio y que todas tus ramas estén revisadas.

7. Una vez que estés conforme con el estado de tu repositorio, realiza un empuje forzado de tus cambios locales para sobrescribir tu GitHub Enterprise Server repositorio y todas las ramas que hayas subido:

   $ git push origin --force --all
   > Counting objects: 1074, done.
   > Delta compression using 2 threads.
   > Compressing objects: 100% (677/677), done.
   > Writing objects: 100% (1058/1058), 148.85 KiB, done.
   > Total 1058 (delta 590), reused 602 (delta 378)
   > To https://nombre de host/YOUR-USERNAME/YOUR-REPOSITORY.git
   >  + 48dc599...051452f main -> main (forced update)

8. Para eliminar el archivo confidencial de tus lanzamientos etiquetados, también deberás realizar un empuje forzado contra tus etiquetas de Git:

   $ git push origin --force --tags
   > Counting objects: 321, done.
   > Delta compression using up to 4 threads.
   > Compressing objects: 100% (166/166), done.
   > Writing objects: 100% (321/321), 331.74 KiB | 0 bytes/s, done.
   > Total 321 (delta 124), reused 269 (delta 108)
   > To https://nombre de host/YOUR-USERNAME/YOUR-REPOSITORY.git
   >  + 48dc599...051452f main -> main (forced update)

Eliminar los datos de GitHub por completo

Después de utilizar ya sea la herramienta de BFG o git filter-repo para eliminar los datos sensibles y subir tus cambios a GitHub Enterprise Server, debes tomar algunos pasos adicionales para eliminar los datos de GitHub Enterprise Server completamente.

1. Contáctate con el administrador de tu sitio y pregúntale cómo eliminar visualizaciones cacheadas y referencias a los datos confidenciales en las solicitudes de extracción en GitHub Enterprise Server. Por favor, proporciona el nombre del repositorio o un enlace a la confirmación que necesitas eliminar.

2. Pídeles a tus colaboradores que rebasen, no fusionen, cualquier rama que hayan creado fuera del historial de tu repositorio antiguo (contaminado). Una confirmación de fusión podría volver a introducir algo o todo el historial contaminado sobre el que acabas de tomarte el trabajo de purgar.

3. Después de que haya transcurrido un tiempo y estés seguro de que la herramienta BFG / git filter-repo no tuvo efectos secundarios inesperados, puedes forzar a todos los objetos de tu repositorio local a desreferenciarse y recolectar la basura con los siguientes comandos (usando Git 1.8.5 o posterior):

   $ git for-each-ref --format="delete %(refname)" refs/original | git update-ref --stdin
   $ git reflog expire --expire=now --all
   $ git gc --prune=now
   > Counting objects: 2437, done.
   > Delta compression using up to 4 threads.
   > Compressing objects: 100% (1378/1378), done.
   > Writing objects: 100% (2437/2437), done.
   > Total 2437 (delta 1461), reused 1802 (delta 1048)

   Nota: También puedes lograrlo subiendo tu historial filtrado a un repositorio nuevo o vacío para después hacer un nuevo clon desde GitHub Enterprise Server.

Evitar confirmaciones accidentales en el futuro

Existen algunos trucos sencillos para evitar confirmar cosas que no quieres confirmar:

• Utiliza un programa visual como GitHub Desktop o gitk para confirmar los cambios. Los programas visuales suelen hacer que sea más sencillo ver exactamente qué archivos se agregarán, eliminarán y modificarán con cada confirmación.
• Evita los comandos para atrapar todo git add . y git commit -a de la línea de comando —en su lugar, utiliza git add filename y git rm filename para ordenar por etapas los archivos.
• Utiliza git add --interactive para revisar por separado y preparar los cambios de cada archivo.
• Utiliza git diff --cached para revisar los cambios que hayas preparado para la confirmación. Esta es la diferencia exacta que git commit generará siempre que no utilices la marca -a.

Leer más

• página man de git filter-repo
• Pro Git: Herramientas de Git - Reescribiendo la historia