Ringkasan CI/CD Codex Security

Jalankan Codex Security di CI untuk meninjau perubahan pull request atau merge request, memindai cabang default Anda, serta menyimpan temuan dan cakupan. Lihat panduan penyedia CI Anda untuk alur kerja, penanganan laporan, dan opsi penerapan kebijakan.

Menyiapkan alur kerja

Menjalankan pemindaian memerlukan akses Codex Security. Simpan API key OpenAI di penyimpanan rahasia penyedia CI Anda sebagai CODEX_SECURITY_API_KEY, lalu petakan ke variabel lingkungan OPENAI_API_KEY pada proses pemindaian.

Jalankan pemindaian hanya untuk repositori dan perubahan yang Anda percayai. Pemindaian menggunakan izin lokal runner dan tidak berhenti untuk meminta persetujuan. Tempatkan kredensial yang tidak terkait dan langkah deployment dalam job terpisah.

Gunakan model Daybreak yang disetujui

Untuk akses Daybreak Blue melalui Trusted Access for Cyber, tetapkan input GitHub Action model ke gpt-6-sol dan cyber-access-program ke daybreak_blue. Untuk pemindaian CLI langsung, gunakan --model gpt-6-sol dan --cyber-access-program daybreak_blue.

Gunakan API key dari proyek yang telah mengaktifkan Daybreak Blue dan memiliki akses ke model yang dipilih. Menetapkan model atau program tidak memberikan akses. Lihat Konfigurasikan akses Daybreak opsional untuk pengaturan Action.

Pilih integrasi

Tambahkan alur kerja GitHub Actions

Gunakan panduan GitHub Actions untuk pemeriksaan pull request dan pemindaian repositori terjadwal. Codex Security Action menginstal CLI, menyimpan laporan, serta menambahkan ringkasan job dan anotasi kode sumber. Panduan ini mencakup penyiapan runner, akses Daybreak opsional, pengunggahan SARIF, dan penerapan kebijakan tingkat keparahan.

Tambahkan pipeline GitLab CI/CD

Gunakan panduan GitLab CI/CD untuk pemindaian merge request, cabang default, dan pemindaian terjadwal. Mulailah dengan pipeline khusus pemindaian, lalu terapkan penanganan laporan, penerapan kebijakan, dan remediasi terverifikasi opsional.

Gunakan sistem CI lain

Instal paket publik @openai/codex-security dan jalankan CLI secara langsung. Gunakan --auth api-key, pilih pemindaian repositori atau diff, lalu simpan output di direktori privat di luar worktree Git. Runner Anda harus menyediakan dependensi yang dijelaskan dalam panduan mulai cepat CLI.

Lihat referensi CLI untuk opsi pemindaian, revisi diff, format laporan, direktori status dan output, serta perilaku percobaan ulang.

Memilih kebijakan tingkat keparahan

Mulailah dengan hasil yang bersifat saran. Tinjau temuan yang representatif, cakupan pemindaian, biaya, dan waktu eksekusi sebelum menentukan hasil mana yang harus memblokir penggabungan.

Evaluasi temuan dan kelengkapan pemindaian. Kebijakan tingkat keparahan mengevaluasi temuan dari pemindaian saat ini yang mencapai atau melampaui ambang batas yang dikonfigurasi. Temuan terbuka sebelumnya dalam ringkasan repositori tidak memengaruhi kebijakan tersebut. Pemindaian yang tidak lengkap dapat menyisakan area yang belum ditinjau meskipun tidak melaporkan temuan.

Dalam rilis Action action-v0.3.0, pemindaian yang selesai berarti analisis yang dikonfigurasi memberikan hasil yang valid. Pengecualian cakupan, investigasi yang ditunda, dan catatan cakupan lainnya tidak meniadakan penerapan kebijakan tingkat keparahan. Kesalahan pemindai dan pelaporan wajib menyebabkan job gagal. CLI 0.3.0 mengembalikan kode keluar 2 untuk kegagalan input, eksekusi, integritas hasil, atau output wajib. Tinjau coverage.json saat menilai hasil; selesainya pemindaian tidak menjamin bahwa setiap kerentanan telah ditemukan.

Konfigurasikan penerapan kebijakan dalam panduan GitHub Actions atau panduan GitLab CI/CD. Untuk integrasi CLI langsung, lihat penerapan kebijakan tingkat keparahan dan kode keluar.