如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题
Codex

Codex 使用场景

在 CI 中自动运行安全扫描

扫描 pull requests 或 main 分支上的提交,也可定期扫描您的代码仓库。

难度 Intermediate
时间跨度 Long-running

将 Codex Security CLI 添加到您的 CI 流水线中。选择何时扫描、审查哪些代码,保留扫描发现的问题及扫描覆盖范围的记录,并决定扫描结果如何影响交付流程。

最适合

  • 需要为 pull request 或合并请求添加安全检查的团队。
  • 需要在变更合入后扫描默认分支的维护者。
  • 需要安排定期代码仓库安全评估的安全团队。

目录

    ← 所有使用场景

    在 CI 中自动运行安全扫描

    扫描 pull requests 或 main 分支上的提交,也可定期扫描您的代码仓库。

    将 Codex Security CLI 添加到您的 CI 流水线中。选择何时扫描、审查哪些代码,保留扫描发现的问题及扫描覆盖范围的记录,并决定扫描结果如何影响交付流程。

    Intermediate
    Long-running
    配置 CI 扫描

    将 Codex Security CLI 添加到您的 CI 流水线中。选择何时扫描、审查哪些代码,保留扫描发现的问题及扫描覆盖范围的记录,并决定扫描结果如何影响交付流程。

    Intermediate
    Long-running

    最适合

    • 需要为 pull request 或合并请求添加安全检查的团队。
    • 需要在变更合入后扫描默认分支的维护者。
    • 需要安排定期代码仓库安全评估的安全团队。

    将安全扫描纳入开发工作流。您可以针对 Pull Request 运行 Codex Security,也可以在更改合入默认分支后运行,或按计划定期运行。为每种触发条件选择合适的扫描范围,保存发现的问题和扫描覆盖情况,让团队可以按同一套流程审查每次扫描的结果。

    选择扫描时机

    先选择一种适合团队工作流的触发条件。等您了解扫描耗时、费用以及团队如何处理扫描发现的问题后,再添加其他触发条件。

    运行时机 建议扫描范围 可审查的内容
    定期运行 整个代码仓库,可选择深度扫描 定期审查整个代码仓库的安全状况。
    有提交推送到 main 分支时 所推送提交对应的整个代码仓库 更改合入默认分支后的代码。
    有 Pull Request 或合并请求时 合并基点与拟合并提交之间的更改 合并前检查更改是否可能引入安全问题。

    如果代码仓库的默认分支名称不是 main,请使用实际的默认分支。请同时配置触发条件和扫描范围。针对 Pull Request 的差异扫描仅覆盖该请求中的更改,不会扫描整个代码仓库。等更改合入 main 后才运行扫描,就无法阻止已经完成的 Pull Request 合并。

    开始前的准备

    您需要有权对目标代码仓库进行安全评估,有权配置其 CI 流水线和密钥,并持有可访问 Codex Security 的 OpenAI API 密钥。请参阅 CLI 快速入门,了解访问和配置要求。

    请使用符合 CI 要求的可信运行器。扫描使用运行器的本地权限执行。请勿向扫描作业提供无关凭据,并遵守平台对来自派生代码仓库的 Pull Request 及其他不受信任代码的限制。

    设置流水线

    1. 将 Codex Security 添加到流水线

      选择适用于您所用 CI 平台的示例,按照示例安装 Codex Security CLI,并通过 CI 提供商的密钥存储提供 API 密钥。

      根据您的平台选择相应的指南:

      • GitHub Actions: 使用 Pull Request 工作流扫描拟合并的更改并保存结果。
      • GitLab CI/CD: 参照流水线指南配置合并请求扫描、默认分支扫描和定期扫描。指南提供可下载的流水线配置,并说明需要启用哪些选项。
      • 其他 CI 平台: 根据提供商的触发条件、密钥存储方式、代码检出流程和制品处理方式,调整在 CI 中运行 Codex Security 中的扫描和导出命令。
    2. 配置触发条件和扫描范围

      当更改合入 main 时,扫描所推送提交对应的代码仓库。对于您选定的分支,按计划定期扫描。可以先每周扫描一次,再根据代码仓库的活跃程度、扫描耗时和费用调整频率。

      对于 Pull Request 或合并请求,获取目标分支和源分支的提交历史,然后扫描两者的合并基点与拟合并提交之间的差异。

      为每个作业指定要扫描的代码:定期扫描以及向 main 推送提交时的扫描应覆盖整个代码仓库,Pull Request 扫描则应覆盖拟合并的更改。请按照您所用平台的示例配置相应的扫描。

      根据扫描范围和频率设置预算。扫描整个代码仓库可能比差异扫描更耗时,费用也可能更高。--max-cost 根据估算费用限制扫描,实际支出可能超过该金额。达到该限额时,扫描可能尚未覆盖全部目标代码。

    3. 运行流水线并审查结果

      按照团队的常规审查流程提交流水线配置更改,然后触发扫描。在本次运行记录和 scan-manifest.json 中确认扫描的目标版本和范围。

      在已保存的报告中审查扫描发现的问题及相关证据。即使扫描未报告任何问题,也请检查 coverage.json,确认哪些部分尚未扫描完毕或已推迟扫描。在提高扫描频率或将扫描扩展到更多代码仓库之前,先检查运行时间和费用。

      将报告保存为 CI 制品。根据制品所含的源代码和证据设置适当的访问权限和保留期限。

      您也可以将结果导出为 SARIF,以便在平台的安全界面中展示。SARIF 是一种用于记录安全问题的结构化格式。请查阅平台指南,了解支持的版本、所需权限和许可要求。

    4. 决定发现问题时是否阻止合并

      初期可以先审查扫描发现的问题,允许合并继续进行。等团队熟悉扫描结果后,您可以要求 Pull Request 通过安全检查才能合并。例如,扫描发现高危或严重级别的漏洞时,可以阻止合并。

      每次都要确认扫描是否完成,以及扫描覆盖了哪些代码。即使未报告任何问题,扫描失败或有代码被跳过的情况仍需跟进。

      有关配置细节,请参阅配置严重性阈值并解读扫描结果。

    5. 跟进扫描发现的问题

      按照团队的常规流程,将发现的问题分派给相应人员调查或修复。附上本次扫描对应的提交、受影响的代码和相关证据,以便其他开发者调查。

      关闭问题前,请验证修复是否有效,并在后续扫描中补查此前未完全覆盖的代码。

    相关使用场景