Configuring secret scanning for your appliance

About escaneo de secretos

If someone checks a secret from a GitHub partner into a repository on GitHub Enterprise, escaneo de secretos catches the secret as it's checked in, and helps you mitigate the impact of the leak. Repository administrators are notified about any commit that contains a secret, and they can quickly view all detected secrets in the Security tab for the repository. For more information, see "About secret scanning."

Prerequisites

To use escaneo de secretos in tu instancia de servidor de GitHub Enterprise you need these two prerequisites.

• The SSSE3 (Supplemental Streaming SIMD Extensions 3) CPU flag needs to be enabled on the VM/KVM that runs tu instancia de servidor de GitHub Enterprise.

• You need an Advanced Security license.

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 Servidor de GitHub Enterprise instance.

1. Connect to the administrative shell for your Servidor de GitHub Enterprise 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 servidor de GitHub Enterprise. For more information, see "Enabling secret scanning" 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.

Checking whether you have an Advanced Security license

1. En la esquina superior derecha de cualquier página, da clic en .
   
2. En la barra lateral izquierda, haz clic en Consola de administración.
   
3. Check if there is an Advanced Security entry in the left sidebar.
   

If you can't see Advanced Security in the sidebar, it means that your license doesn't include support for Advanced Security features, including escaneo de código and escaneo de secretos. The Advanced Security license gives you and your users access to features that help you make your repositories and code more secure. For more information, see "About GitHub Advanced Security" or contact Equipo de ventas de GitHub.

Enabling escaneo de secretos

1. En la esquina superior derecha de cualquier página, da clic en .
   
2. En la barra lateral izquierda, haz clic en Consola de administración.
   
3. En la barra lateral izquierda, haz clic en Advanced Security.
   
4. Under "Advanced Security," click Escaneo de secretos.
   
5. Debajo de la barra lateral izquierda, da clic en Guardar configuración.
   
6. Espera a que la configuración se ejecute por completo.

Disabling escaneo de secretos

1. En la esquina superior derecha de cualquier página, da clic en .
   
2. En la barra lateral izquierda, haz clic en Consola de administración.
   
3. En la barra lateral izquierda, haz clic en Advanced Security.
   
4. Under "Advanced Security", unselect Escaneo de secretos.
   
5. Debajo de la barra lateral izquierda, da clic en Guardar configuración.
   
6. Espera a que la configuración se ejecute por completo.