Configuring secret scanning for your appliance

You can enable, configure, and disable escaneo de secretos for tu instancia de GitHub Enterprise Server. Escaneo de secretos allows users to scan code for accidentally committed secrets.

Las Escaneo de secretos están disponibles para los repositorios que pertenezcan a organizaciones en donde esté habilitada la GitHub Advanced Security. Para obtener más información, consulta la sección "Acerca de GitHub Advanced Security".

Nota: El Escaneo de secretos estaba en beta en GitHub Enterprise Server 3.0. Para encontrar el lanzamiento del escaneo de secretos que está generalmente disponible, mejora al último lanzamiento de GitHub Enterprise Server.

About escaneo de secretos

Si alguien registra un secreto con un patrón conocido en un repositorio en GitHub Enterprise Server, el escaneo de secretos atrapa el secreto tan pronto se registra y te ayuda a mitigar el impacto de la fuga. Se notifica a los administradores de repositorio sobre cualquier confirmación que contenga un secreto y pueden ver rápidamente todos los secretos en la pestaña de seguridad de éste. For more information, see "About escaneo de secretos."

Checking whether your license includes GitHub Advanced Security

You can identify if your enterprise has a GitHub Advanced Security license by reviewing your enterprise settings. For more information, see "Enabling GitHub Advanced Security for your enterprise."

Prerequisites for escaneo de secretos

Checking support for the SSSE3 flag on your vCPUs

The SSSE3 set of instructions is required because escaneo de secretos leverages hardware accelerated pattern matching to find potential credentials committed to your GitHub repositories. SSSE3 is enabled for most modern CPUs. You can check whether SSSE3 is enabled for the vCPUs available to your GitHub Enterprise Server instance.

  1. Connect to the administrative shell for your GitHub Enterprise Server instance. For more information, see "Accessing the administrative shell (SSH)."

  2. Enter the following command:

    grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $?

    If this returns the value 0, it means that the SSSE3 flag is available and enabled. You can now enable escaneo de secretos for tu instancia de GitHub Enterprise Server. For more information, see "Enabling escaneo de secretos" below.

    If this doesn't return 0, SSSE3 is not enabled on your VM/KVM. You need to refer to the documentation of the hardware/hypervisor on how to enable the flag, or make it available to guest VMs.

Enabling escaneo de secretos

Advertencia: El cambiar esta configuración ocasionará que se reinicien los servicios de cara al cliente en GitHub Enterprise Server. Debes calcular este cambio cuidadosamente para minimizar el tiempo de inactividad para los usuarios.

  1. Desde una cuenta administrativa en GitHub Enterprise Server, da clic en la esquina superior derecha de cualquier página. Ícono de cohete para acceder a las configuraciones de administrador del sitio
  2. En la barra lateral izquierda, haz clic en Consola de administración. pestaña Consola de administración en la barra lateral izquierda
  3. En la barra lateral izquierda, haz clic en Advanced Security. Advanced Security sidebar
  4. Under "Advanced Security," click Escaneo de secretos. Checkbox to enable or disable escaneo de secretos
  5. Debajo de la barra lateral izquierda, da clic en Guardar configuración. El botón de guardar en la Consola de administración
  6. Espera a que la configuración se ejecute por completo.

Disabling escaneo de secretos

Advertencia: El cambiar esta configuración ocasionará que se reinicien los servicios de cara al cliente en GitHub Enterprise Server. Debes calcular este cambio cuidadosamente para minimizar el tiempo de inactividad para los usuarios.

  1. Desde una cuenta administrativa en GitHub Enterprise Server, da clic en la esquina superior derecha de cualquier página. Ícono de cohete para acceder a las configuraciones de administrador del sitio
  2. En la barra lateral izquierda, haz clic en Consola de administración. pestaña Consola de administración en la barra lateral izquierda
  3. En la barra lateral izquierda, haz clic en Advanced Security. Advanced Security sidebar
  4. Under "Advanced Security," unselect Escaneo de secretos. Checkbox to enable or disable escaneo de secretos
  5. Debajo de la barra lateral izquierda, da clic en Guardar configuración. El botón de guardar en la Consola de administración
  6. Espera a que la configuración se ejecute por completo.

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.