Skip to main content

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

可以使用 Copilot 机密扫描的正则表达式生成器为自定义模式编写正则表达式。 生成器使用 AI 模型生成与输入匹配的表达式,并选择性地生成示例字符串。

谁可以使用此功能?

具有管理员角色的存储库所有者、组织所有者、安全管理员和用户

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

Note

无需订阅 GitHub Copilot 即可使用 Copilot 机密扫描 的 正则表达式生成器。 Copilot 机密扫描 功能可用于启用了 GitHub Advanced Security 的 GitHub Enterprise Cloud 企业中的专用存储库。

  1. 在 GitHub 上,导航到存储库的主页面。

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

    存储库标头的屏幕截图,其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在边栏的“Security”部分中,单击“Code security”****。

  4. 在“Code security”下,找到“GitHub Advanced Security”。

  5. 在“Secret scanning”下的“自定义模式”下,单击“新建模式”。

  6. 在“模式名称”字段中,键入模式的名称。

  7. 单击右上角的“使用 AI 生成”。****。

    Note

    可以通过在“Secret format”字段中键入机密模式格式的正则表达式手动输入正则表达式,而不是使用生成器。 有关详细信息,请参阅“为存储库定义自定义模式”或“为组织定义自定义模式”。

  8. 在显示的滑动面板中:

    • 填写“我想要一个这样的正则表达式”字段,最好用简单的英语描述你希望正则表达式捕获哪些模式。 可以使用其他自然语言,但性能可能不如英语。

    • 填写“我要查找的内容示例”字段,举例说明你要扫描的模式。

    • 单击“生成建议”****。

    • (可选)单击建议可查看正则表达式的说明。

    • 单击显示的“结果”部分中的“使用结果”****,以获取要使用的结果。

      供生成器使用的填充自定义 secret scanning 模式表单的屏幕截图。

  9. 可以单击“More options ”来提供密钥格式的其他周围内容或额外匹配要求****。 GitHub 会将在滑动面板中键入的示例添加到“测试字符串”**** 字段。

  10. 准备好测试新的自定义模式时,若要识别存储库中的匹配项而不创建警报,请单击“保存并试运行”。

  11. 试运行完成后,你将看到结果示例(最多 1000 个)。 查看结果并确定任何误报结果。

    显示试运行结果的屏幕截图。

  12. 编辑新的自定义模式以修复结果的任何问题,然后测试更改,单击“保存并试运行”。

  13. 如果对新的自定义模式感到满意,请单击“发布模式”。

可以配置 secret scanning,以便在提交合并到默认分支之前检查自定义模式的推送。 有关详细信息,请参阅“为自定义模式启用推送保护”。

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

  1. 在 GitHub 的右上角,选择个人资料照片,然后单击 你的组织”。

  2. 在组织旁边,单击“设置”。

  3. 在边栏的“安全”部分中,单击 代码安全,然后单击全局设置

  4. 在“自定义模式”下,单击“新建模式”。

  5. 在“模式名称”字段中,键入模式的名称。

  6. 单击右上角的“使用 AI 生成”。****。

    Note

    可以通过在“Secret format”字段中键入机密模式格式的正则表达式手动输入正则表达式,而不是使用生成器。 有关详细信息,请参阅“为存储库定义自定义模式”或“为组织定义自定义模式”。

  7. 在显示的滑动面板中:

    • 填写“我想要一个这样的正则表达式”字段,最好用简单的英语描述你希望正则表达式捕获哪些模式。 可以使用其他自然语言,但性能可能不如英语。

    • 填写“我要查找的内容示例”字段,举例说明你要扫描的模式。

    • 单击“生成建议”****。

    • (可选)单击建议可查看正则表达式的说明。

    • 单击显示的“结果”部分中的“使用结果”****,以获取要使用的结果。

      供生成器使用的填充自定义 secret scanning 模式表单的屏幕截图。

  8. 可以单击“More options ”来提供密钥格式的其他周围内容或额外匹配要求****。 GitHub 会将在滑动面板中键入的示例添加到“测试字符串”**** 字段。

  9. 准备好测试新的自定义模式时,要在不创建警报的情况下识别所选存储库中的匹配项,请单击“保存并试运行”****。

  10. 选择要在其中执行试运行的存储库。

    • 若要在整个组织中执行试运行,请选择“组织中的所有存储库”。
    • 若要指定要在其中执行试运行的存储库,请选择“所选存储库”,然后搜索并选择最多 10 个存储库。
  11. 准备好测试新的自定义模式后,请单击“运行”。

  12. 试运行完成后,你将看到结果示例(最多 1000 个)。 查看结果并确定任何误报结果。

    显示试运行结果的屏幕截图。

  13. 编辑新的自定义模式以修复结果的任何问题,然后测试更改,单击“保存并试运行”。

  14. 如果对新的自定义模式感到满意,请单击“发布模式”。

可以配置 secret scanning,以便在提交合并到默认分支之前检查自定义模式的推送。 有关详细信息,请参阅“为自定义模式启用推送保护”。

延伸阅读