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

Codex 使用场景

扫描多个代码仓库

对多个代码仓库进行安全扫描,查看扫描发现的问题和覆盖范围。

难度 Intermediate
时间跨度 Long-running

使用 Codex Security CLI 按清单扫描各个代码仓库的指定提交,逐一查看扫描结果,判断哪些问题需要调查或修复。

最适合

  • 需要针对指定提交评估一组服务的安全团队。
  • 需要复用代码仓库清单,并分别获取各代码仓库扫描结果的工程团队。
  • 需要综合各代码仓库的扫描结果,确定应优先处理哪些问题和扫描覆盖缺口的审查人员。

目录

    ← 所有使用场景

    扫描多个代码仓库

    对多个代码仓库进行安全扫描,查看扫描发现的问题和覆盖范围。

    使用 Codex Security CLI 按清单扫描各个代码仓库的指定提交,逐一查看扫描结果,判断哪些问题需要调查或修复。

    Intermediate
    Long-running
    按步骤操作

    使用 Codex Security CLI 按清单扫描各个代码仓库的指定提交,逐一查看扫描结果,判断哪些问题需要调查或修复。

    Intermediate
    Long-running

    最适合

    • 需要针对指定提交评估一组服务的安全团队。
    • 需要复用代码仓库清单,并分别获取各代码仓库扫描结果的工程团队。
    • 需要综合各代码仓库的扫描结果,确定应优先处理哪些问题和扫描覆盖缺口的审查人员。

    开始前的准备

    按照 CLI 快速入门指南安装 Codex Security 并完成身份验证。请确认您有权运行安全扫描,并且可以通过 Git 访问待扫描的代码仓库。您必须拥有这些代码仓库,或已获准对其进行评估。扫描使用您的本地权限,运行时不会暂停等待审批。请查阅扫描权限指南。

    准备代码仓库清单

    先选取少量代码仓库。将以下内容保存为 repositories.csv,然后将示例 URL 和提交占位符替换为实际值:

    id,repository,revision
    payments,https://github.com/YOUR-ORG/payments.git,REPLACE_WITH_FULL_COMMIT_SHA
    identity,https://github.com/YOUR-ORG/identity.git,REPLACE_WITH_FULL_COMMIT_SHA

    为每个代码仓库指定唯一的 id,并填写完整的提交 SHA。运行以下命令可获取本地代码仓库当前检出的提交 SHA:

    git -C /path/to/repository rev-parse HEAD

    每次扫描都会检查指定提交对应的整个代码仓库。此流程不接受分支名称或缩短的哈希值,也不会扫描尚未提交的更改。如需将扫描范围限定在特定文件夹,或为特定代码仓库指定扫描指令,请参阅 CSV 选项。

    通过 GitHub 选择: 您也可以从自己的 GitHub 账户或组织中以交互方式选择代码仓库,无需准备 CSV 文件。

    运行扫描

    进入 repositories.csv 所在的目录,将下方命令中的输出路径替换为待扫描代码仓库之外的私有目录,然后运行命令:

    npx @openai/codex-security bulk-scan repositories.csv \
      --output-dir /path/outside/repositories/security-scans \
      --workers 2 \
      --mode standard \
      --max-attempts 1 \
      --max-cost 5

    此命令同时运行两项标准扫描,每个代码仓库只尝试扫描一次。如果某次扫描的预估费用超过 5 美元,--max-cost 5 会停止该次扫描。由于已经开始的操作可能产生超出预估的费用,这个金额并非严格的费用上限,也不是整批扫描共用的预算。请在开始扫描前确定这些参数的值。

    CLI 会将每个代码仓库的扫描结果保存在 security-scans/artifacts/ 下各自的文件夹中。请勿公开扫描结果,因为其中可能包含源代码片段和漏洞详情。

    查看结果

    打开结果目录,检查以下内容:

    1. 清单: 在 manifest.json 中核对代码仓库和提交。
    2. 状态: 在 results.jsonl 中查看每次扫描尝试的状态和产物位置。
    3. 扫描覆盖情况和发现的问题: 在每次扫描尝试对应的文件夹中,先查看 coverage.json,了解扫描未覆盖的部分和排除项,再查看 report.md 和 findings.json,了解发现的问题及相关证据。

    退出码 0 表示所有代码仓库均已成功完成扫描,但不能据此断定不存在漏洞。退出码 2 表示扫描覆盖不完整、某个代码仓库未能完成扫描,或出现了输入错误或运行时错误。如果扫描覆盖不完整,即使发现的问题列表为空,也不能据此认定代码安全。

    记录每个代码仓库接下来需要采取的行动:调查扫描发现的问题、修复已确认的问题,或跟进扫描未覆盖的部分。将工作移交给负责的团队时,请注明扫描所用的提交,并提供相关证据。

    如需恢复中断的扫描,请使用相同的 CSV 文件、扫描指令和输出目录,再次运行同一条命令。CLI 会跳过已完成的扫描,也不会因为覆盖不完整而自动重试。如果更改了代码仓库清单、提交版本、扫描范围、扫描模式或扫描指令,请使用新的输出目录。有关恢复扫描的详细说明,请参阅恢复与重试指南。

    相关使用场景