checkov vscode

Pemberitahuan Arsip

Repositori ini tidak lagi dipertahankan dan ekstensi kode VS yang dikenakannya.

Ekstensi Checkov vs Code diganti nama menjadi plugin Prisma Cloud vs Code dan sekarang dapat ditemukan di sini

Ekstensi checkov untuk kode studio visual

Checkov adalah alat analisis kode statis untuk infrastruktur-sebagai-kode, rahasia, dan analisis komposisi perangkat lunak.

Ekstensi checkov untuk kode Visual Studio memungkinkan pengembang untuk mendapatkan hasil pemindaian real-time, serta saran perbaikan inline saat mereka mengembangkan infrastruktur cloud.

Ekstensi saat ini tersedia untuk diunduh langsung dari Visual Studio Extension Marketplace dan kode sumbernya tersedia di repositori berlisensi Apache 2.0. Pengembangan ekstensi sedang berlangsung dan tersedia untuk penggunaan pra-pelepasan? .

Mengaktifkan ekstensi membutuhkan kunci akses cloud prisma dan API. Ini menggunakan API Cloud Prisma untuk mengevaluasi kode dan menawarkan perbaikan inline otomatis. Untuk informasi lebih lanjut tentang data yang dibagikan dengan Prisma Cloud lihat bagian Penafian di bawah).

Fitur ekstensi meliputi:

• 1000+ kebijakan bawaan yang mencakup praktik keamanan dan kepatuhan terbaik untuk AWS, Azure dan Google Cloud.
• Terraform, Rencana Terraform, CloudFormation, Kubernetes, Helm, Serverless dan Pemindaian Template ARM.
• Mendeteksi kredensial AWS di EC2 userdata, variabel lingkungan lambda dan penyedia terraform.
• Di Terraform, memeriksa evaluasi dukungan argumen yang dinyatakan dalam variabel dan modul jarak jauh ke nilai aktualnya.
• Mendukung penindasan inline melalui komentar.
• Tautan ke deskripsi kebijakan, rasional serta instruksi langkah demi langkah untuk memperbaiki kesalahan konfigurasi yang diketahui.
• Perbaiki saran untuk atribut terraform dan cloudformation yang umumnya konfigurasi.

Memulai

Memasang

Buka ekstensi checkov untuk kode studio visual di pasar Visual Studio.

Dependensi

• Python> = 3.7 atau Pipenv atau Docker Daemon Running

Ekstensi Checkov akan memohon versi terbaru dari Checkov .

Konfigurasi

• Di Prisma Cloud, buka Pengaturan> Kontrol Akses> Tambah> Kunci Akses dan Salin Kunci.

• Dalam kode Visual Studio, masukkan tombol Anda dan titik akhir API Anda di halaman Pengaturan Ekstensi Checkov.

• Menggunakan sertifikat CA khusus dimungkinkan. Jika diperlukan, atur path ke file sertifikat di halaman Pengaturan Ekstensi Checkov.

• Jika Anda menemukan pesan kesalahan berisik, Anda dapat menonaktifkannya sepenuhnya dengan memilih Disable error message di halaman Pengaturan Ekstensi Checkov.

Penggunaan

• Buka file yang ingin Anda pindai dengan checkov di vscode.
• Buka Palet Perintah (⇧⌘p) dan jalankan Command Checkov Scan .
• Hasil pemindaian sekarang harus muncul di editor Anda.
• Klik pemindaian untuk melihat detailnya. Rincian akan mencakup kebijakan yang melanggar dan tautan ke pedoman perbaikan langkah demi langkah.
• Dalam kebanyakan kasus, detailnya akan mencakup opsi perbaikan. Ini akan menambah, menghapus atau mengganti konfigurasi yang tidak diinginkan, berdasarkan kamus Fix Checkov.
• Anda dapat melewatkan cek dengan menambahkan inline skip annotation checkov:skip=<check_id>:<suppression_comment> . Untuk detail lebih lanjut lihat dokumen.
• Ekstensi akan terus memindai modifikasi file dan menyoroti kesalahan dalam editor Anda pada setiap modifikasi sumber daya material.

Pemecahan masalah Log

Untuk mengakses direktori log checkov-vscode, buka palet perintah vscode (Ctrl+Shift+P) atau (Command+Shift+P) , dan jalankan perintah Open Checkov Log . Sangat membantu jika Anda menghapus file log dan kemudian mencoba kembali operasi mana yang gagal untuk menghasilkan log bersih.

Masalah umum

Izin akses file Docker pada macOS

Jika Anda mengalami kegagalan dan menjalankan ekstensi checkov melalui Docker, mungkin macOS perlu memberikan izin Docker untuk mengakses lokasi direktori kode Anda. Di MacOS System Preferences > Privacy and Security > Privacy Temukan bagian Files and Folders dari daftar, dan pastikan Docker memiliki akses ke lokasi kode Anda.

Gejala masalah ini dapat ditemukan di log ekstensi, Anda akan melihat [info]: Running Checkov dengan executablePath: docker dan kemudian output yang menunjukkan nol lulus, gagal, atau dilewati, dan 1+ kesalahan parsing, seperti di bawah ini:

[info]: Running checkov {“executablePath”:“docker”,“arguments”
...
...
[debug]: Checkov task output:
...
 “ passed “ : 0, rn        “ failed “ : 0, rn        “ skipped “ : 0, rn        “ parsing_errors “ : 1, rn        “ checkov_version “ : “ 1.0.770 “rn    }

Berkontribusi

Kontribusi disambut!

Mulailah dengan meninjau pedoman kontribusi. Setelah itu, lihatlah masalah pertama yang bagus.

Ingin menyumbangkan cek baru? Pelajari cara menulis cek baru (kebijakan alias) di sini.

Penafian

Untuk menggunakan plugin ini, Anda akan memerlukan akun cloud prisma. Plugin ini menggunakan API perbaikan cloud prisma untuk menganalisis dan menghasilkan perbaikan kode, dan memperkaya hasil yang diberikan ke IDE. Harap perhatikan kebijakan privasi Cloud Prisma untuk lebih jelasnya. Untuk menghasilkan perbaikan, file yang ditemukan telah memicu pelanggaran checkov tersedia untuk perbaikan API untuk tujuan tunggal menghasilkan rekomendasi kode perbaikan inline.