Codex 應用案例
掃描多個程式碼庫
對多個程式碼庫執行安全性掃描,並檢視發現的問題與掃描涵蓋範圍。
使用 Codex Security CLI 掃描清單中各程式碼庫的指定提交,逐一檢視結果,判斷哪些問題需要調查或修正。
最適合的對象
- 需要針對指定提交評估多項服務的資安團隊。
- 需要以一致的方式反覆盤點程式碼庫,並分別取得各程式碼庫掃描結果的工程團隊。
- 需要就各程式碼庫發現的問題與掃描未涵蓋的部分,排定處理順序的審查人員。
目錄
掃描多個程式碼庫
對多個程式碼庫執行安全性掃描,並檢視發現的問題與掃描涵蓋範圍。
使用 Codex Security CLI 掃描清單中各程式碼庫的指定提交,逐一檢視結果,判斷哪些問題需要調查或修正。
使用 Codex Security CLI 掃描清單中各程式碼庫的指定提交,逐一檢視結果,判斷哪些問題需要調查或修正。
最適合的對象
- 需要針對指定提交評估多項服務的資安團隊。
- 需要以一致的方式反覆盤點程式碼庫,並分別取得各程式碼庫掃描結果的工程團隊。
- 需要就各程式碼庫發現的問題與掃描未涵蓋的部分,排定處理順序的審查人員。
開始前的準備
依照 CLI 快速入門指南安裝 Codex Security 並完成身分驗證。確認你有執行安全性掃描的權限,也能透過 Git 存取你擁有或獲准評估的程式碼庫。掃描會使用你的本機權限,過程中不會暫停等候核准。請先閱讀掃描權限指南。
準備程式碼庫清單
先從少數幾個程式碼庫開始。將以下內容儲存為 repositories.csv,再將範例網址和提交 SHA 的預留位置換成實際值:
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
這項指令一次會執行兩個標準模式的掃描,每個程式碼庫只嘗試一次。使用 --max-cost 5 時,只要單次嘗試的預估費用超過 5 美元,就會停止該次嘗試。已在進行的工作仍可能產生超出預估的費用,因此這個金額並非費用的硬性上限,也不是整批掃描共用的預算。請在開始掃描前設定好這些參數值。
CLI 會在 security-scans/artifacts/ 下,將各程式碼庫的結果分別儲存到各自的資料夾中。請將結果保密,其中可能包含原始碼片段和漏洞詳情。
檢閱結果
開啟結果目錄,逐項檢查:
- 清單: 核對
manifest.json中列出的程式碼庫和提交。 - 狀態: 查看
results.jsonl,確認每次嘗試的狀態及輸出檔案的位置。 - 掃描範圍與發現的問題: 在每次嘗試的資料夾中,先查看
coverage.json,確認哪些部分未掃描、哪些項目已排除,再查看report.md和findings.json中列出的問題與佐證資料。
結束代碼 0 表示所有程式碼庫都已成功完成掃描,但不代表沒有漏洞。結束代碼 2 表示掃描涵蓋不完整、有程式碼庫未能完成掃描,或是輸入或執行階段發生錯誤。若掃描涵蓋不完整,即使問題清單是空的,也無法據此判定程式碼安全。
記錄每個程式碼庫的下一步:調查掃描發現的問題、修正已確認的問題,或追蹤尚未掃描的部分。將工作交給負責團隊時,請提供掃描時使用的提交及相關佐證資料。
若要繼續中斷的掃描,請使用相同的 CSV 檔案、指示和輸出目錄,再次執行同一個指令。CLI 會略過已完成的掃描,也不會自動重試涵蓋不完整的掃描。若變更程式碼庫清單、提交版本、掃描範圍、模式或指示,請改用新的輸出目錄。如需瞭解如何恢復掃描,請參閱繼續掃描與重試指南。
相關應用案例
執行深度安全掃描
使用 Codex Security 外掛程式,對程式碼庫或指定資料夾進行更全面的安全稽核。外掛程式會反覆搜尋潛在漏洞並逐一驗證,再列出發現的問題與掃描涵蓋範圍,供你審查。
執行第一次安全掃描
使用 Codex Security 外掛程式掃描本機程式碼庫,檢視證據與掃描涵蓋範圍,決定優先調查或修正哪些問題。
掃描程式碼變更,找出安全性問題
使用 Codex Security 外掛程式檢查 Git 追蹤的一組變更,驗證疑似安全性退化的問題,並在合併前產出附有佐證的報告。