checkov vscode

檔案通知

該存儲庫不再維護，也不再封裝的VS代碼擴展名。

Checkov VS代碼擴展名被重新命名為Prisma Cloud VS代碼插件，現在可以在此處找到

檢查視覺工作室代碼的擴展

Checkov是用於基礎架構 - 代碼，秘密和軟件組成分析的靜態代碼分析工具。

Visual Studio代碼的CheckOV擴展使開發人員能夠獲得實時掃描結果，以及在開發雲基礎架構時修復了建議的建議。

該擴展名當前可直接從Visual Studio擴展市場直接下載，其源代碼可在Apache 2.0許可存儲庫中獲得。擴展的開發正在進行中，並且可以用於預發行的使用情況？ 。

激活擴展名需要Prisma雲訪問密鑰和API。它使用Prisma Cloud API來評估代碼並提供自動的內聯修復程序。有關與Prisma Cloud共享的數據的更多信息，請參見下面的免責聲明部分。

擴展功能包括：

• 1000多個內置政策涵蓋了AWS，Azure和Google Cloud的安全性和合規性最佳實踐。
• Terraform，Terraform Plan，Cloudformation，Kubernetes，Helm，無服務器和手臂模板掃描。
• 檢測EC2 UserData，Lambda環境變量和Terraform提供商中的AWS憑據。
• 在Terraform中，支票支持對變量和遠程模塊中的參數的評估。
• 通過評論支持內聯抑制。
• 鏈接到策略描述，理由以及逐步固定已知錯誤配置的指令。
• 修復建議通常錯誤配置的地表和雲形式屬性。

入門

安裝

在Visual Studio Marketplace中打開視覺工作室代碼的CheckOV擴展。

依賴性

• Python> = 3.7或Pipenv或Docker守護程序運行

Checkov擴展程序將調用最新版本的Checkov 。

配置

• 在Prisma Cloud中，轉到設置>訪問控制>添加>訪問鍵並複制鍵。

• 在Visual Studio代碼中，在Checkov擴展設置頁面中輸入鍵和API端點。

• 可以使用自定義CA證書。如果需要，請在Checkov擴展設置頁面中設置通往證書文件的路徑。

• 如果您發現錯誤消息嘈雜，則可以通過在Checkov擴展設置頁面中選擇Disable error message完全禁用它。

用法

• 打開您希望在VSCODE中使用CheckOV掃描的文件。
• 打開命令調色板（⇧⌘P）並運行命令Checkov Scan 。
• 掃描結果現在應該出現在您的編輯器中。
• 單擊掃描以查看其詳細信息。詳細信息將包括違反政策和分步修復準則的鏈接。
• 在大多數情況下，詳細信息將包括一個修復選項。這將基於Checkov Fix詞典添加，刪除或替換不需要的配置。
• 您可以通過添加Inline Skip註釋CheckOV跳過checkov:skip=<check_id>:<suppression_comment> 。有關更多詳細信息，請參見文檔。
• 該擴展程序將繼續掃描文件修改，並在每個材料資源修改後突出顯示編輯器中的錯誤。

故障排除日誌

要訪問CheckOv-Vscode Logs目錄，請打開VSCODE命令調色板(Ctrl+Shift+P)或(Command+Shift+P) ，然後運行命令Open Checkov Log 。如果您刪除日誌文件，然後重試為了產生乾淨的日誌，則有所幫助。

常見問題

MACOS上的Docker文件訪問權限

如果您正在遇到故障並通過Docker運行CheckOV擴展程序，則MacOS可能需要授予Docker許可以訪問代碼的目錄位置。在MacOS System Preferences > Privacy and Security > Privacy從列表中找到Files and Folders部分，並確保Docker可以訪問您的代碼位置。

可以在擴展日誌中找到此問題的症狀，您將看到[info]: Running Checkov executablePath: docker ，然後輸出顯示零通過，失敗或跳過檢查，以及1+解析錯誤，如下所示：

[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    }

貢獻

歡迎貢獻！

首先審查貢獻指南。之後，看看一個好的第一期。

想要貢獻新的支票？在此處了解如何編寫新檢查（又稱策略）。

免責聲明

要使用此插件，您將需要一個Prisma Cloud帳戶。該插件使用Prisma Cloud的修復API來分析和生成代碼修復程序，並豐富了所提供的結果。請注意Prisma Cloud隱私政策以獲取更多詳細信息。為了生成修復程序，發現已觸發違規的文件可用於修復API，以便生成內聯固定代碼建議的唯一目的。