Configuring secret scanning for your appliance

You can enable, configure, and disable 秘密扫描 for your GitHub Enterprise Server instance. 秘密扫描 allows users to scan code for accidentally committed secrets.

秘密扫描 适用于启用了 GitHub Advanced Security 的组织拥有的仓库。 更多信息请参阅“关于 GitHub Advanced Security”。

注: 秘密扫描 是 GitHub Enterprise Server 3.0 中的测试版功能。 对于 秘密扫描 的一般可用版本,请升级到 GitHub Enterprise Server 的最新版本。

About 秘密扫描

如果有人将使用已知模式的密码检入 GitHub Enterprise Server 上的仓库,则 秘密扫描 在该密码检入时可以捕获它,帮助您减小密码泄露的影响。 仓库管理员会收到包含密码的任何提交的通知, 然后他们可以快速查看仓库安全选项卡中所有检测到的密码。 For more information, see "About 秘密扫描."

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 秘密扫描

Checking support for the SSSE3 flag on your vCPUs

The SSSE3 set of instructions is required because 秘密扫描 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 秘密扫描 for your GitHub Enterprise Server instance. For more information, see "Enabling 秘密扫描" 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 秘密扫描

警告:更改此设置将导致 GitHub Enterprise Server 上面向用户的服务重新启动。 您应谨慎安排更改时间,以尽量减少用户的停机时间。

  1. 从 GitHub Enterprise Server 上的管理帐户,点击任何页面右上角的 用于访问站点管理员设置的火箭图标
  2. 在左侧边栏中,单击 管理控制台左侧边栏中的 管理控制台 选项卡
  3. In the left sidebar, click Security. Security sidebar
  4. Under "Security," click 秘密扫描. Checkbox to enable or disable 秘密扫描
  5. 在左侧边栏下,单击 Save settings(保存设置)管理控制台 中的 Save settings 按钮
  6. 等待配置运行完毕。

Disabling 秘密扫描

警告:更改此设置将导致 GitHub Enterprise Server 上面向用户的服务重新启动。 您应谨慎安排更改时间,以尽量减少用户的停机时间。

  1. 从 GitHub Enterprise Server 上的管理帐户,点击任何页面右上角的 用于访问站点管理员设置的火箭图标
  2. 在左侧边栏中,单击 管理控制台左侧边栏中的 管理控制台 选项卡
  3. In the left sidebar, click Security. Security sidebar
  4. Under "Security," unselect 秘密扫描. Checkbox to enable or disable 秘密扫描
  5. 在左侧边栏下,单击 Save settings(保存设置)管理控制台 中的 Save settings 按钮
  6. 等待配置运行完毕。

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或者, 了解如何参与。