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は、Organizationが所有するリポジトリでGitHub Advanced Securityが有効化されていれば利用できます。 詳しい情報については、「GitHub Advanced Security について」を参照してください。

ノート: Secret scanningはGitHub Enterprise Server 3.0ではベータでした。 secret scanningの一般に利用なリリースについては、GitHub Enterprise Serverの最新リリースにアップグレードしてください。

About secret scanning

GitHub Enterprise Server上のリポジトリに既知のパターンを持つシークレットを誰かがチェックインすると、secret scanningはチェックインの時点でそのシークレットを捕捉し、漏洩のインパクトを緩和する手助けをします。 リポジトリ管理者は、シークレットを含むコミットについて通知され、リポジトリのセキュリティタブですべての検出されたシークレットを素早く見ることができます。 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 your enterprise settings. For more information, see "Enabling GitHub Advanced Security for your enterprise."

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 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. GitHub Enterprise Serverの管理アカウントから、任意のページの右上にあるをクリックしてください。 サイトアドミン設定にアクセスするための宇宙船のアイコン
  2. 左のサイドバーでManagement Consoleをクリックしてください。 左のサイドバーのManagement Consoleタブ
  3. In the left sidebar, click Security. Security sidebar
  4. Under "Security," click Secret scanning. Checkbox to enable or disable secret scanning
  5. 左のサイドバーの下でSave settings(設定の保存)をクリックしてください。 Management Console での [Save settings] ボタン
  6. 設定が完了するのを待ってください。

Disabling secret scanning

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

  1. GitHub Enterprise Serverの管理アカウントから、任意のページの右上にあるをクリックしてください。 サイトアドミン設定にアクセスするための宇宙船のアイコン
  2. 左のサイドバーでManagement Consoleをクリックしてください。 左のサイドバーのManagement Consoleタブ
  3. In the left sidebar, click Security. Security sidebar
  4. Under "Security," unselect Secret scanning. Checkbox to enable or disable secret scanning
  5. 左のサイドバーの下でSave settings(設定の保存)をクリックしてください。 Management Console での [Save settings] ボタン
  6. 設定が完了するのを待ってください。

このドキュメントは役立ちましたか?

プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?