跳至主要内容

使用 Copilot 机密扫描生成自定义模式的正则表达式

您可以使用 Copilot 密钥扫描的正则表达式生成器来为自定义模式编写正则表达式。生成器使用 AI 模型根据您的输入(以及可选的示例字符串)生成匹配的表达式。

谁可以使用此功能?

仓库所有者、组织所有者、安全管理者,以及拥有 admin 角色的用户

为仓库生成正则表达式(使用 Copilot 密钥扫描)

注意

使用 Copilot 密钥扫描的正则表达式生成器不需要 GitHub Copilot 订阅。Copilot 密钥扫描功能对启用了 GitHub 密钥保护的组织和企业拥有的仓库可用。

  1. 在 GitHub 上,导航至仓库的主页面。

  2. 在您的仓库名称下,点击 设置。如果看不到 “设置” 选项卡,请选择 下拉菜单,然后点击 设置

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  3. 在侧边栏的Security部分,点击 Advanced Security

  4. 在 “密钥保护” 下的 “自定义模式” 中,点击 新建模式

  5. 在 “模式名称” 字段中,输入您为该模式取的名称。

  6. 在页面右上角,点击 使用 AI 生成

    注意

    您也可以手动在 “密钥格式” 字段中键入正则表达式来描述密钥模式,而不是使用生成器。更多信息请参阅 为仓库定义自定义模式为组织定义自定义模式

  7. 在显示的滑动面板中

    • 填写 “我想要的正则表达式是” 字段,最好使用简体中文(或英文)描述您希望正则表达式捕获的模式。您可以使用其他自然语言,但效果可能不如英文好。

    • 填写 “我在寻找的示例” 字段,提供一个您想要扫描的模式示例。

    • 点击 生成建议

    • 可选地,点击某个建议以查看该正则表达式的描述。

    • 在出现的 “结果” 区域,点击您想使用的结果旁的 使用结果

      Screenshot of a filled custom secret scanning pattern form for the generator to use.

  8. 您可以点击 更多选项 为密钥格式提供其他上下文或额外的匹配要求。GitHub 会将您在滑动面板中输入的示例添加到 测试字符串 字段中。

  9. 准备好测试新自定义模式时,若希望在仓库中识别匹配但不产生警报,请点击 保存并进行干运行

  10. 干运行完成后,您将看到最多 1000 条样本结果。请检查这些结果并识别任何误报。

    Screenshot showing results from dry run.

  11. 编辑新建的自定义模式以修正结果中的问题,然后再次点击 保存并进行干运行 以测试修改。

  12. 当您对新自定义模式满意后,点击 发布模式

您可以配置密钥扫描,在提交合并到默认分支之前检查推送是否匹配自定义模式。更多信息请参阅 为自定义模式启用推送保护

为组织生成正则表达式(使用 Copilot 密钥扫描)

  1. 在 GitHub 右上角,点击您的头像,然后点击 组织

  2. 点击即可选择组织。

  3. 在您的组织名称下,点击 设置。如果看不到 “设置” 选项卡,请选择 下拉菜单,然后点击 设置

    Screenshot of the tabs in an organization's profile. The "Settings" tab is outlined in dark orange.

  4. 在侧边栏的 “Security” 部分,点击 高级安全,然后点击 全局设置

  5. 在 “自定义模式” 下,点击 新建模式

  6. 在 “模式名称” 字段中,输入您为该模式取的名称。

  7. 在页面右上角,点击 使用 AI 生成

    注意

    您也可以手动在 “密钥格式” 字段中键入正则表达式来描述密钥模式,而不是使用生成器。更多信息请参阅 为仓库定义自定义模式为组织定义自定义模式

  8. 在显示的滑动面板中

    • 填写 “我想要的正则表达式是” 字段,最好使用简体中文(或英文)描述您希望正则表达式捕获的模式。您可以使用其他自然语言,但效果可能不如英文好。

    • 填写 “我在寻找的示例” 字段,提供一个您想要扫描的模式示例。

    • 点击 生成建议

    • 可选地,点击某个建议以查看该正则表达式的描述。

    • 在出现的 “结果” 区域,点击您想使用的结果旁的 使用结果

      Screenshot of a filled custom secret scanning pattern form for the generator to use.

  9. 您可以点击 更多选项 为密钥格式提供其他上下文或额外的匹配要求。GitHub 会将您在滑动面板中输入的示例添加到 测试字符串 字段中。

  10. 准备好测试新自定义模式时,若希望在所选仓库中识别匹配但不产生警报,请点击 保存并进行干运行

  11. 选择您想执行干运行的仓库。

    • 若要在整个组织范围内执行干运行,选择 组织中所有仓库
    • 若要指定需要进行干运行的仓库,选择 选定的仓库,随后搜索并最多选择 10 个仓库。
  12. 准备好测试新自定义模式时,点击 运行

  13. 干运行完成后,您将看到最多 1000 条样本结果。请检查这些结果并识别任何误报。

    Screenshot showing results from dry run.

  14. 编辑新建的自定义模式以修正结果中的问题,然后再次点击 保存并进行干运行 以测试修改。

  15. 当您对新自定义模式满意后,点击 发布模式

您可以配置密钥扫描,在提交合并到默认分支之前检查推送是否匹配自定义模式。更多信息请参阅 为自定义模式启用推送保护

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.