checkov vscode

アーカイブ通知

このリポジトリは、維持されなくなっておらず、VSコード拡張機能をカプセル化しません。

Checkov vsコード拡張機能は、Prisma Cloud vs Codeプラグインとしてブランド変更されましたが、こちらから見つけることができます。

Visual StudioコードのCheckov拡張機能

CHECKOVは、コード、秘密、ソフトウェア構成分析としてのインフラストラクチャの静的コード分析ツールです。

Visual StudioコードのCHECKOV拡張機能により、開発者はリアルタイムスキャン結果を取得できます。また、クラウドインフラストラクチャを開発する際のインライン修正提案を行うことができます。

拡張機能は現在、Visual Studio Extension Marketplaceから直接ダウンロードでき、そのソースコードはApache 2.0ライセンスリポジトリで利用できます。拡張機能の開発は進行中であり、リリース前の使用に利用できますか？ 。

拡張機能をアクティブにするには、Prisma Cloud Access KeyとAPIが必要です。 Prisma Cloud APIを使用してコードを評価し、自動インラインの修正を提供します。 Prisma Cloudと共有されるデータの詳細については、以下の免責事項セクションを参照してください。

拡張機能は次のとおりです。

• AWS、Azure、Google Cloudのセキュリティとコンプライアンスのベストプラクティスをカバーする1000以上の組み込みポリシー。
• Terraform、Terraform Plan、CloudFormation、Kubernetes、Helm、ServerLess、ARMテンプレートスキャン。
• EC2 UserData、Lambda環境変数、TerraformプロバイダーのAWS資格情報を検出します。
• Terraformでは、変数とリモートモジュールで表現された引数の評価を実際の値にサポートします。
• コメントを介してインライン抑制をサポートします。
• 既知の誤解を修正するための段階的な指示と同様に、ポリシーの説明、理論的根拠、および段階的な指示へのリンク。
• 一般的に誤解されているテラフォームとクラウドフォーム属性の提案を修正します。

はじめる

インストール

Visual Studio MarketplaceでVisual Studioコードの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修正辞書に基づいて、不要な構成を追加、削除、または交換します。
• インラインSKIPアノテーションcheckov:skip=<check_id>:<suppression_comment>を追加して、チェックをスキップできます。詳細については、ドキュメントを参照してください。
• 拡張機能は、すべてのマテリアルリソースの変更により、エディターのファイルの変更をスキャンし続け、エディターのエラーを強調表示します。

ログのトラブルシューティング

CheckoV-VSCODEログディレクトリにアクセスするには、VSCODEコマンドパレット(Ctrl+Shift+P)または(Command+Shift+P)を開き、Command 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クラウドアカウントが必要です。プラグインは、Prisma Cloudの修正APIを使用してコード修正を分析および作成し、IDEに提供された結果を濃縮します。詳細については、Prismaクラウドプライバシーポリシーに注意してください。修正を生成するために、CHECKOV違反がトリガーされていることが判明したファイルは、インライン修正コードの推奨を生成することを目的とするために、修正APIで利用可能になります。