Skip to main content

Configuring secret scanning for your appliance

You can enable, configure, and disable secret scanning for GitHub Enterprise Serverインスタンス. 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

Enterpriseの設定を確認すれば、EnterpriseがGitHub Advanced Securityライセンスを持っているかを確認できます。 詳しい情報については「EnterpriseでのGitHub Advanced Securityの有効化」を参照してください。

Prerequisites for secret scanning

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

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

  1. GitHub Enterprise Serverの管理アカウントから、任意のページの右上でをクリックしてください。

    サイトアドミン設定にアクセスするためのロケット船のスクリーンショット

  2. まだ"Site admin(サイトアドミン)"ページにいないなら、左上のSite admin(サイトアドミン)をクリックしてください。

    "Site admin"リンクのスクリーンショット

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

  4. 左のサイドバーでSecurity(セキュリティ)をクリックしてください。 セキュリティサイドバー

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

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

    Management Consoleの設定保存ボタンのスクリーンショット

    ノート:Management Consoleに設定を保存するとシステムサービスが再起動され、それによってユーザに影響するダウンタイムが発生することがあります。

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

    インスタンスの設定

Disabling secret scanning

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

  1. GitHub Enterprise Serverの管理アカウントから、任意のページの右上でをクリックしてください。

    サイトアドミン設定にアクセスするためのロケット船のスクリーンショット

  2. まだ"Site admin(サイトアドミン)"ページにいないなら、左上のSite admin(サイトアドミン)をクリックしてください。

    "Site admin"リンクのスクリーンショット

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

  4. 左のサイドバーでSecurity(セキュリティ)をクリックしてください。 セキュリティサイドバー

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

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

    Management Consoleの設定保存ボタンのスクリーンショット

    ノート:Management Consoleに設定を保存するとシステムサービスが再起動され、それによってユーザに影響するダウンタイムが発生することがあります。

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

    インスタンスの設定