Configuring secret scanning for your appliance

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 "비밀 검사 정보."

Checking whether your license includes GitHub Advanced Security

엔터프라이즈 설정을 검토하여 엔터프라이즈에 GitHub Advanced Security 라이선스가 있는지 확인할 수 있습니다. 자세한 내용은 "Enabling GitHub Advanced Security for your enterprise"을(를) 참조하세요.

Prerequisites for secret scanning

• The SSSE3 (Supplemental Streaming SIMD Extensions 3) CPU flag needs to be enabled on the VM/KVM that runs GitHub Enterprise Server 인스턴스. For more information about SSSE3, see Intel 64 and IA-32 Architectures Optimization Reference Manual in the Intel documentation.

• A license for GitHub Advanced Security (see "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.

1. Connect to the administrative shell for your GitHub Enterprise Server instance. For more information, see "관리 셸(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 secret scanning for GitHub Enterprise Server 인스턴스. 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

1. 페이지의 오른쪽 상단에 있는 GitHub Enterprise Server의 관리 계정에서 을 클릭합니다.

2. “Site admin”(사이트 관리자) 페이지에 아직 없는 경우 왼쪽 상단에서 Site admin(사이트 관리자)을 클릭합니다.

3. " 사이트 관리자" 사이드바에서 관리 콘솔 을 클릭합니다.

4. "설정" 사이드바에서 보안을 클릭합니다.

5. Under "Security," select Secret scanning.

6. "설정" 사이드바에서 설정 저장을 클릭합니다.

   참고: 관리 콘솔에 설정을 저장하면 시스템 서비스가 다시 시작되어 사용자에게 표시되는 가동 중지 시간이 발생할 수 있습니다.

7. 구성 실행이 완료될 때까지 기다립니다.

Disabling secret scanning

1. 페이지의 오른쪽 상단에 있는 GitHub Enterprise Server의 관리 계정에서 을 클릭합니다.

2. “Site admin”(사이트 관리자) 페이지에 아직 없는 경우 왼쪽 상단에서 Site admin(사이트 관리자)을 클릭합니다.

3. " 사이트 관리자" 사이드바에서 관리 콘솔 을 클릭합니다.

4. "설정" 사이드바에서 보안을 클릭합니다.

5. Under "Security," deselect Secret scanning.

6. "설정" 사이드바에서 설정 저장을 클릭합니다.

   참고: 관리 콘솔에 설정을 저장하면 시스템 서비스가 다시 시작되어 사용자에게 표시되는 가동 중지 시간이 발생할 수 있습니다.

7. 구성 실행이 완료될 때까지 기다립니다.