Codex Security CI 扫描 | GitHub Actions、GitLab 与 SARIF

在 CI 中运行 Codex Security CLI 以查看 pull request 或 merge request 中的确切更改，保留安全发现和覆盖范围，并可选择在选定的严重性下使检查失败。从咨询性结果开始，检查扫描质量和运行时间，然后添加适合你的仓库的严重性策略。

本指南包含 GitHub Actions 和 GitLab CI/CD 示例。相同的扫描和导出命令适用于其他 CI 系统。

准备工作流

在 CI 提供商的 secret 存储中保存名为 CODEX_SECURITY_API_KEY 的 OpenAI API key。

将此 secret 直接映射到扫描步骤的 OPENAI_API_KEY 环境变量。只在扫描进程中提供该凭据，并使用 --auth api-key 显式选择它。

runner 需要：

Node.js 22 或更高版本。
Python 3.10 或更高版本。
公开发布的 @openai/codex-security 软件包；将其安装在仓库 checkout 之外。
pull request 或 merge request 的 head 与 base 历史记录，以便 Git 计算 merge base。

添加 GitHub Actions 工作流

对于私有或内部仓库，请先启用 GitHub 代码安全，再上传 SARIF。

创建 .github/workflows/codex-security.yml。在 checkout pull request 之前，在 $RUNNER_TEMP/codex-security 下安装 @openai/codex-security，使受信任的可执行文件位于 $RUNNER_TEMP/codex-security/node_modules/.bin/codex-security：

name: Codex Security scan

on:
  pull_request:

jobs:
  codex-security:
    if: github.event.pull_request.head.repo.full_name == github.repository && github.actor != 'dependabot[bot]'
    runs-on: ubuntu-latest
    permissions:
      actions: read
      contents: read
      security-events: write
    steps:
      - name: Set up Node.js
        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7
        with:
          node-version: "26"

      - name: Set up Python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7
        with:
          python-version: "3.14"

      - name: Install Codex Security
        run: |
          set -euo pipefail
          npm install \
            --prefix "$RUNNER_TEMP/codex-security" \
            --ignore-scripts \
            --no-audit \
            --no-fund \
            @openai/codex-security

      - name: Verify Codex Security
        env:
          CODEX_SECURITY_BIN: ${{ runner.temp }}/codex-security/node_modules/.bin/codex-security
        run: |
          set -euo pipefail
          test -x "$CODEX_SECURITY_BIN"
          "$CODEX_SECURITY_BIN" --version

      - name: Check out the pull request
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          fetch-depth: 0
          persist-credentials: false

      - name: Scan the pull request
        env:
          OPENAI_API_KEY: ${{ secrets.CODEX_SECURITY_API_KEY }}
          CODEX_SECURITY_BIN: ${{ runner.temp }}/codex-security/node_modules/.bin/codex-security
          CODEX_SECURITY_STATE_DIR: ${{ runner.temp }}/codex-security-state
          BASE_SHA: ${{ github.event.pull_request.base.sha }}
          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
          SCAN_DIR: ${{ runner.temp }}/codex-security-results
        run: |
          set -euo pipefail
          BASE_REVISION="$(git merge-base "$BASE_SHA" "$HEAD_SHA")"
          "$CODEX_SECURITY_BIN" scan . \
            --diff "$BASE_REVISION" \
            --head "$HEAD_SHA" \
            --auth api-key \
            --output-dir "$SCAN_DIR" \
            --json > "$RUNNER_TEMP/codex-security.json"

      - name: Export SARIF
        id: export-sarif
        if: always()
        env:
          CODEX_SECURITY_BIN: ${{ runner.temp }}/codex-security/node_modules/.bin/codex-security
          SCAN_DIR: ${{ runner.temp }}/codex-security-results
          SARIF_FILE: ${{ runner.temp }}/codex-security.sarif
        run: |
          set -euo pipefail
          if test -f "$SCAN_DIR/scan-manifest.json"; then
            "$CODEX_SECURITY_BIN" export "$SCAN_DIR" \
              --export-format sarif \
              --source-root "$GITHUB_WORKSPACE" \
              --output "$SARIF_FILE"
            echo "available=true" >> "$GITHUB_OUTPUT"
          fi

      - name: Upload SARIF
        if: always() && steps.export-sarif.outputs.available == 'true'
        uses: github/codeql-action/upload-sarif@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4
        with:
          sarif_file: ${{ runner.temp }}/codex-security.sarif
          ref: refs/pull/${{ github.event.pull_request.number }}/head
          sha: ${{ github.event.pull_request.head.sha }}
          category: codex-security

      - name: Preserve scan results
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
        with:
          name: codex-security-results
          path: |
            ${{ runner.temp }}/codex-security-results
            ${{ runner.temp }}/codex-security.json
          if-no-files-found: warn
          retention-days: 7

工作流会检出 pull request 的 head，计算 merge base，并扫描这些 revision 之间已提交的变更。完整历史记录可确保目标准确。persist-credentials: false 可避免把仓库 token 写入 checkout 目录的 Git 配置。在 checkout 仓库前安装 CLI，并通过绝对路径运行，可防止仓库控制的可执行文件接触扫描凭据。--auth api-key 会显式选择作用域受限的 API key；扫描历史记录则保存在仓库之外的可写状态目录中。

--json 将一份完整的 JSON 文档写入 stdout，因此工作流可以直接保存它。进度、完成摘要和错误保留在 stderr 上。这与 codex exec --json 不同，后者发出 JSON Lines 事件流。

导出步骤读取已完成的已封存的扫描并写入 SARIF。它使 Codex 运行时和凭证保持不变。扫描产物可能包含易受攻击的源代码片段、证据和补救详细信息。选择适合你的仓库的访问控制和较短的保留窗口。

添加 GitLab CI/CD pipeline

GitLab Ultimate 19.2 或更高版本可以接收 SARIF 2.1.0 报告。运行 pipeline 前，请添加经过掩码和隐藏处理的 CODEX_SECURITY_API_KEY CI/CD 变量。

把 security stage 和 Codex Security job 添加到根目录的 .gitlab-ci.yml，同时保留文件中已有的 stage 和 job。该示例默认扫描 merge request 变更。将 CODEX_SECURITY_FULL_SCAN_DEFAULT_BRANCH 设为 "true"，还可以扫描完整的默认分支：

variables:
  CODEX_SECURITY_FULL_SCAN_DEFAULT_BRANCH: "false"

stages:
  - test
  - security

codex-security:
  stage: security
  image: node:26-bookworm-slim
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_SOURCE_PROJECT_ID == $CI_PROJECT_ID'
      variables:
        CODEX_SECURITY_SCAN_SCOPE: "diff"
    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CODEX_SECURITY_FULL_SCAN_DEFAULT_BRANCH == "true"'
      variables:
        CODEX_SECURITY_SCAN_SCOPE: "full"
  variables:
    GIT_DEPTH: "0"
    CODEX_SECURITY_CLI_DIR: "/tmp/codex-security-cli"
  before_script:
    - |
      set -eu
      apt-get update -qq
      apt-get install -y -qq --no-install-recommends \
        ca-certificates \
        git \
        python3 \
        ripgrep
      npm install \
        --prefix "$CODEX_SECURITY_CLI_DIR" \
        --ignore-scripts \
        --no-audit \
        --no-fund \
        @openai/codex-security
      export CODEX_SECURITY_BIN="$CODEX_SECURITY_CLI_DIR/node_modules/.bin/codex-security"
      test -x "$CODEX_SECURITY_BIN"
      "$CODEX_SECURITY_BIN" --version
  script:
    - |
      set -eu
      if test -z "${CODEX_SECURITY_API_KEY:-}"; then
        echo "Set the CODEX_SECURITY_API_KEY CI/CD variable." >&2
        exit 2
      fi

      codex_security_api_key="$CODEX_SECURITY_API_KEY"
      unset CODEX_SECURITY_API_KEY

      case "${CODEX_SECURITY_SCAN_SCOPE:-}" in
        diff)
          BASE_SHA="$CI_MERGE_REQUEST_DIFF_BASE_SHA"
          HEAD_SHA="$CI_COMMIT_SHA"
          BASE_REVISION="$(git merge-base "$BASE_SHA" "$HEAD_SHA")"
          set -- --diff "$BASE_REVISION" --head "$HEAD_SHA"
          echo "Scanning committed changes from $BASE_REVISION to $HEAD_SHA."
          ;;
        full)
          set -- --mode standard
          echo "Scanning the complete default branch at $CI_COMMIT_SHA."
          ;;
        *)
          echo "Unsupported Codex Security scan scope: ${CODEX_SECURITY_SCAN_SCOPE:-unset}" >&2
          exit 2
          ;;
      esac

      export CODEX_SECURITY_STATE_DIR="/tmp/codex-security-state-$CI_JOB_ID"
      SCAN_DIR="/tmp/codex-security-results-$CI_JOB_ID"
      JSON_FILE="/tmp/codex-security-$CI_JOB_ID.json"
      SARIF_FILE="/tmp/codex-security-$CI_JOB_ID.sarif"

      install -d -m 700 "$CODEX_SECURITY_STATE_DIR" "$SCAN_DIR"

      set +e
      OPENAI_API_KEY="$codex_security_api_key" \
        "$CODEX_SECURITY_BIN" scan . \
          "$@" \
          --auth api-key \
          --output-dir "$SCAN_DIR" \
          --json > "$JSON_FILE"
      scan_exit="$?"
      set -e
      unset codex_security_api_key

      install -d -m 700 codex-security-artifacts/results
      cp -R "$SCAN_DIR"/. codex-security-artifacts/results/
      if test -s "$JSON_FILE"; then
        cp "$JSON_FILE" codex-security-artifacts/codex-security.json
      fi
      printf '%s\n' "$scan_exit" > codex-security-artifacts/scan-exit-code.txt

      export_exit=0
      if test -f "$SCAN_DIR/scan-manifest.json"; then
        set +e
        "$CODEX_SECURITY_BIN" export "$SCAN_DIR" \
          --export-format sarif \
          --source-root "$CI_PROJECT_DIR" \
          --output "$SARIF_FILE"
        export_exit="$?"
        set -e
        if test -s "$SARIF_FILE"; then
          cp "$SARIF_FILE" codex-security-artifacts/codex-security.sarif
        fi
      fi

      if test "$scan_exit" -ne 0; then
        exit "$scan_exit"
      fi
      exit "$export_exit"
  artifacts:
    when: always
    access: maintainer
    expire_in: 7 days
    paths:
      - codex-security-artifacts/
    reports:
      sarif: codex-security-artifacts/codex-security.sarif

默认情况下，该 job 只为同一项目分支的 merge request 运行，因此 fork pipeline 不会获得扫描凭据。在 group、project 或 pipeline 级别将 CODEX_SECURITY_FULL_SCAN_DEFAULT_BRANCH 设为 "true"，还可以对默认分支运行标准的完整扫描。完整扫描耗时更长且成本更高。

GIT_DEPTH: "0" 提供计算 merge request 扫描中 CI_MERGE_REQUEST_DIFF_BASE_SHA 与 CI_COMMIT_SHA 的 merge base 所需的历史记录。

该 job 在 /tmp 下安装 CLI，通过绝对路径运行它，并且只向扫描进程公开 API key。artifacts: when: always 会在扫描失败时保留 SARIF 报告，而 artifacts:access: maintainer 会将详细扫描结果的访问权限限制为 maintainer。

更改 .gitlab-ci.yml 可能公开 CI/CD 变量，因此请在运行 job 前评审 pipeline 变更。如果你保护 CODEX_SECURITY_API_KEY，GitLab 仅会在源分支和目标分支均受保护、且用户能够访问目标分支的同项目 merge request 中提供该变量。

选择严重性策略

两个示例默认都只报告，因为它们省略了 --fail-on-severity。一旦你准备好让安全发现影响检查，请向扫描命令添加阈值：

"$CODEX_SECURITY_BIN" scan . \
  --diff origin/main \
  --output-dir /path/outside/repository/results \
  --fail-on-severity high

支持的阈值包括 critical、high、medium 和 low。阈值包括该严重程度及以上的安全发现。

扫描步骤使用这些退出码：

退出	意义
`0`	扫描完成并完全覆盖，并且所有配置的策略均已通过。
`1`	完成的扫描包含等于或高于阈值的结果。
`2`	CLI 发现输入或运行时错误，或者已完成的扫描覆盖不完整。
`130`	Ctrl-C 中断扫描。
`143`	SIGTERM 终止扫描。

即使没有严重性策略，具有 partial 或 unknown 覆盖范围的扫描也会返回 2。CLI 仍然写下其可用的安全发现和报告。在将检查视为结论性检查之前，请检查 coverage.json 中的延后处理的范围。

使用现有结果目录重试

为每个 CI 作业使用新的运行器目录。对于持久或自托管运行器，请使用 --archive-existing 保留早期结果：

"$CODEX_SECURITY_BIN" scan . \
  --diff origin/main \
  --output-dir /path/outside/repository/results \
  --archive-existing

该命令存档早期的结果并从空扫描目录开始。

对 CI 扫描进行故障排除

未知的 Git revision 或意外差异： 获取 base 与 head 历史记录，计算 merge base，并显式传入两个 revision。
受保护或非空输出目录： 选择外层 Git 工作树之外的私有目录。当目录已包含结果时使用 --archive-existing。
缺少凭据： 确认 CODEX_SECURITY_API_KEY 可用于受信任的 workflow 或 pipeline，并直接映射到扫描进程的 OPENAI_API_KEY 环境变量。
扫描历史记录错误： 将 CODEX_SECURITY_STATE_DIR 设置为仓库之外的可写目录。
Python 设置错误： 确认运行器使用 Python 3.10 或更高版本。
覆盖不完整： 查看 coverage.json 中延后处理的范围和未解决的问题，然后使用适当的目标或环境重新运行。
SARIF 导出错误： 确认扫描已完成且完整扫描目录可用。导出在写入 SARIF 之前验证已封存的产物。
SARIF 上传错误： 对于 GitHub Actions，请确认组织已为仓库启用 GitHub 代码安全，并且 workflow 授予 actions: read、contents: read 和 security-events: write。对于 GitLab CI/CD，请确认项目使用 GitLab Ultimate 19.2 或更高版本，并通过 artifacts:reports:sarif 上传 SARIF 2.1.0 文件。

要查看每个命令、flag、产物和输出字段，请参阅 CLI 参考。有关基于交互式插件的 CI 评审，请参阅评审代码变更中的安全风险。

最近搜索

推荐搜索

文档导航

在 CI 中运行 Codex Security

准备工作流

添加 GitHub Actions 工作流

添加 GitLab CI/CD pipeline

选择严重性策略

使用现有结果目录重试

对 CI 扫描进行故障排除