Codex Security CI/CD'ye genel bakış

Çekme isteği veya birleştirme isteği değişikliklerini incelemek, varsayılan dalınızı taramak ve bulgular ile kapsamı saklamak için Codex Security'yi CI'da çalıştırın. İş akışı, rapor işleme ve yaptırım seçenekleri için CI sağlayıcınızın kılavuzuna bakın.

İş akışını hazırlama

Tarama çalıştırmak için Codex Security erişimi gerekir. Bir OpenAI API key değerini CI sağlayıcınızın gizli bilgi deposunda CODEX_SECURITY_API_KEY olarak saklayın, ardından tarama sürecinin OPENAI_API_KEY ortam değişkenine eşleyin.

Taramaları yalnızca güvendiğiniz depolar ve değişiklikler için çalıştırın. Taramalar, çalıştırıcının yerel izinlerini kullanır ve onay için duraklamaz. İlgisiz kimlik bilgilerini ve dağıtım adımlarını ayrı işlerde tutun.

Onaylı bir Daybreak modeli kullanın

Siber Güvenlik için Güvenilir Erişim üzerinden Daybreak Blue erişimi için GitHub Action'ın model girdisini gpt-6-sol ve cyber-access-program girdisini daybreak_blue olarak ayarlayın. Doğrudan CLI taramaları için --model gpt-6-sol ve --cyber-access-program daybreak_blue kullanın.

Daybreak Blue'nun etkin olduğu ve seçilen modele erişimi bulunan bir projeden API key kullanın. Modeli veya programı ayarlamak erişim sağlamaz. Action ayarları için İsteğe bağlı Daybreak erişimini yapılandırma bölümüne bakın.

Bir entegrasyon seçin

GitHub Actions iş akışını ekleyin

Çekme isteği denetimleri ve zamanlanmış depo taramaları için GitHub Actions kılavuzunu kullanın. Codex Security Action, CLI aracını yükler, raporları kaydeder ve bir iş özeti ile kaynak kodu açıklamaları ekler. Kılavuz; çalıştırıcı kurulumu, isteğe bağlı Daybreak erişimi, SARIF yükleme ve önem derecesi kurallarının uygulanmasını kapsar.

GitLab CI/CD işlem hattını ekleyin

Birleştirme isteği, varsayılan dal ve zamanlanmış taramalar için GitLab CI/CD kılavuzunu kullanın. Yalnızca tarama yapan bir işlem hattıyla başlayın, ardından rapor işleme, politika uygulama ve isteğe bağlı doğrulanmış düzeltmeyi benimseyin.

Başka bir CI sistemi kullanın

Herkese açık @openai/codex-security paketini yükleyin ve CLI aracını doğrudan çalıştırın. --auth api-key kullanın, depo veya fark taraması seçin ve çıktıyı Git çalışma ağacının dışındaki özel bir dizine kaydedin. Çalıştırıcınız, CLI hızlı başlangıç kılavuzunda açıklanan bağımlılıkları sağlamalıdır.

Tarama seçenekleri, fark revizyonları, rapor biçimleri, durum ve çıktı dizinleri ve yeniden deneme davranışı için CLI başvuru kılavuzuna bakın.

Önem derecesi politikası seçme

Bilgilendirme amaçlı sonuçlarla başlayın. Hangi sonuçların birleştirmeyi engellemesi gerektiğine karar vermeden önce temsili bulguları, tarama kapsamını, maliyeti ve çalışma süresini inceleyin.

Hem bulguları hem de taramanın eksiksizliğini değerlendirin. Önem derecesi politikası, mevcut taramada yapılandırılan eşikte veya üzerindeki bulguları değerlendirir. Depo özetindeki önceki açık bulgular bu politikayı etkilemez. Eksik bir tarama, hiçbir bulgu bildirmese bile bazı alanların incelenmeden kalmasına yol açabilir.

Action'ın action-v0.3.0 sürümünde tamamlanmış bir tarama, yapılandırılan analizin geçerli bir sonuç ürettiği anlamına gelir. Kapsam dışı bırakılan alanlar, ertelenmiş incelemeler ve diğer kapsam notları önem derecesi politikasını devre dışı bırakmaz. Tarama aracı ve zorunlu raporlama hataları işi başarısız kılar. CLI 0.3.0; girdi, yürütme, sonuç bütünlüğü veya zorunlu çıktı hatalarında 2 çıkış kodunu döndürür. Sonucu değerlendirirken coverage.json dosyasını inceleyin; taramanın tamamlanması, her güvenlik açığının bulunduğunu doğrulamaz.

Kuralların uygulanmasını GitHub Actions kılavuzunda veya GitLab CI/CD kılavuzunda yapılandırın. Doğrudan CLI entegrasyonları için önem derecesi kurallarının uygulanması ve çıkış kodları bölümüne bakın.