Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となります: 2022-02-16. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの改善、新機能のためには、最新バージョンのGitHub Enterpriseにアップグレードしてください。 アップグレードに関する支援については、GitHub Enterprise supportに連絡してください。

Configuring secret scanning for your appliance

You can enable, configure, and disable secret scanning for your GitHub Enterprise Server instance. Secret scanning allows users to scan code for accidentally committed secrets.

Secret scanning is available for organization-owned repositories in GitHub Enterprise Server if your enterprise has a license for GitHub Advanced Security. For more information, see "GitHub's products."

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

You can identify if your enterprise has a GitHub Advanced Security license by reviewing the Management Console. For more information, see "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 your GitHub Enterprise Server instance.

  • A license 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.

  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 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

警告: この設定を変更すると、GitHub Enterprise Serverのユーザが利用するサービスが再起動されます。 ユーザにとってのダウンタイムを最小化するために、この変更の時間は慎重に調整しなければなりません。

  1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

    Screenshot of the rocket ship icon for accessing site admin settings

  2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

    Screenshot of "Site admin" link

  3. 左のサイドバーでManagement Consoleをクリックしてください。 左のサイドバーのManagement Consoleタブ

  4. In the left sidebar, click Advanced Security. Advanced Security sidebar

  5. Under "Advanced Security," click Secret scanning. Checkbox to enable or disable secret scanning

  6. 左のサイドバーの下でSave settings(設定の保存)をクリックしてください。 Management Console での [Save settings] ボタン

  7. 設定が完了するのを待ってください。

Disabling secret scanning

警告: この設定を変更すると、GitHub Enterprise Serverのユーザが利用するサービスが再起動されます。 ユーザにとってのダウンタイムを最小化するために、この変更の時間は慎重に調整しなければなりません。

  1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

    Screenshot of the rocket ship icon for accessing site admin settings

  2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

    Screenshot of "Site admin" link

  3. 左のサイドバーでManagement Consoleをクリックしてください。 左のサイドバーのManagement Consoleタブ

  4. In the left sidebar, click Advanced Security. Advanced Security sidebar

  5. Under "Advanced Security," unselect Secret scanning. Checkbox to enable or disable secret scanning

  6. 左のサイドバーの下でSave settings(設定の保存)をクリックしてください。 Management Console での [Save settings] ボタン

  7. 設定が完了するのを待ってください。