About secret scanning
If someone checks a secret with a known pattern into a repository, secret scanning 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."
Checking whether your license includes GitHub Advanced Security
Identifique se a sua empresa tem uma licença do GitHub Advanced Security revisando as configurações da empresa. Para obter mais informações, confira "Como habilitar o GitHub Advanced Security para sua empresa".
Prerequisites for secret scanning
-
The SSSE3 (Supplemental Streaming SIMD Extensions 3) CPU flag needs to be enabled on the VM/KVM that runs your GitHub Enterprise Server instance.
-
A license for GitHub Advanced Security (see "About billing for GitHub Advanced Security")
-
Secret scanning enabled in the management console (see "Enabling GitHub Advanced Security for your enterprise")
Checking support for the SSSE3 flag on your vCPUs
The SSSE3 set of instructions is required because secret scanning 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.
-
Connect to the administrative shell for your GitHub Enterprise Server instance. For more information, see "Accessing the administrative shell (SSH)."
-
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 secret scanning for your GitHub Enterprise Server instance. 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.
Enabling secret scanning
Aviso: alterar esta configuração fará com que os serviços voltados para o usuário no GitHub Enterprise Server sejam reiniciados. Você deve cronometrar essa mudança com cuidado, para minimizar o tempo de inatividade dos usuários.
-
Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .
-
Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.
-
Na barra lateral � esquerda, clique em Console de Gerenciamento .
-
Na barra lateral esquerda, clique em Segurança.
-
Under "Security," click Secret scanning.
-
Na barra lateral esquerda, clique em Salvar configurações.
Observação: se você salvar as configurações no Console de Gerenciamento, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.
-
Aguarde a conclusão da execução de suas configurações.
Disabling secret scanning
Aviso: alterar esta configuração fará com que os serviços voltados para o usuário no GitHub Enterprise Server sejam reiniciados. Você deve cronometrar essa mudança com cuidado, para minimizar o tempo de inatividade dos usuários.
-
Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .
-
Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.
-
Na barra lateral � esquerda, clique em Console de Gerenciamento .
-
Na barra lateral esquerda, clique em Segurança.
-
Under "Security," unselect Secret scanning.
-
Na barra lateral esquerda, clique em Salvar configurações.
Observação: se você salvar as configurações no Console de Gerenciamento, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.
-
Aguarde a conclusão da execução de suas configurações.