はじめに
Corgeaは、プロジェクト内の安全でないコードを検出し、AIが生成した修正をエディター内で適用できるIntelliJベースのIDE向けプラグインです。IntelliJ IDEA、PyCharm、WebStorm、GoLand、PhpStorm、RubyMine、CLion、Rider、DataSpell、DataGrip、Android Studioに対応しています。問題やサポートに関するお問い合わせは、support@corgea.comまでメールでご連絡ください。
特徴
- セキュリティスキャン：プロジェクト全体、または未コミットの変更のみをスキャンできます。
- コードの脆弱性：検出結果をファイル別にまとめ、重大度と行番号とともに表示します。
- 依存関係の脆弱性：SCAの検出結果をパッケージ別にまとめ、CVE番号と修正済みバージョンとともに表示します。
- エディター上での強調表示：脆弱な行に下線を引き、ガターにアイコンを表示します。
- 検出結果の詳細：検出結果の説明を確認し、提案された修正を差分として事前に確認できます。
- ワンクリックでの修正適用：ガターアイコン、コンテキストメニュー、
Alt+EnterのいずれからでもAIが生成したパッチを適用できます。 - スキャン進行状況の表示：各ステップとCLIの出力を確認しながら、結果がツールウィンドウに順次表示されます。
- OAuthとAPIキーによる認証：どちらの方式にも対応し、エンタープライズ環境やセルフホスト環境のサーバーでも利用できます。
前提条件
Corgeaプラグインをインストールする前に、次の要件を満たしていることを確認します。- Corgeaアカウント：有効なCorgeaアカウント
- JetBrains IDE（2024.3以降）：IntelliJベースのIDE。Android Studioは Meerkat（2024.3.1）以降に対応
- Corgea CLI：IDEからスキャンを実行する場合に必要です。既存のスキャン結果を閲覧するだけであれば不要です。詳細はCLIのインストール手順を参照してください。
インストールガイド
ステップ1：プラグイン設定を開く
- JetBrains IDEを開きます。
Settings>Pluginsを開きます。
ステップ2：プラグインをインストールする
Marketplaceタブを選択し、「Corgea」を検索します。Installをクリックします。
ステップ3：IDEを再起動する
OKをクリックして設定ダイアログを閉じます。- 再起動を求められたらIDEを再起動し、プラグインを読み込みます。
ステップ4：ログイン
- 右側のサイドバーから
Corgeaツールウィンドウを開きます。 - CorgeaのURLを確認します。デフォルトURL（corgea.app）を使用する場合は、あらかじめ入力されています。シングルテナント環境をご利用の場合は、自社のサーバーURLを入力します。
Login with OAuthをクリックし、ブラウザーでプラグインを認可します。トークンはIDEが自動的に取得します。- APIキーを使用する場合は、
Login with API Keyをクリックします。APIキーはCorgeaダッシュボードのIntegrationsセクションで取得できます。
使用方法
スキャンの実行
- Corgeaツールウィンドウの
Scanningタブを開きます。 - プロジェクト全体をスキャンするには
Full Scanを、変更されたファイルのみをスキャンするにはScan Uncommitted Changesをクリックします。 Tools>Corgea>Full ScanまたはTools>Corgea>Scan Uncommitted Changesからスキャンを開始することもできます。- スキャン中は、完了した各ステップとCLIの出力がタブに表示され、検出結果が届くたびに結果タブが自動的に更新されます。
コードの脆弱性を見る
Codeタブには、ファイル別にまとめられた脆弱性が、重大度と該当する行番号とともに表示されます。- 検出結果をクリックすると、エディターで該当する行に移動します。脆弱な行には下線が引かれ、ガターにアイコンが表示されます。
検出結果の詳細を見る
- 検出結果をクリックすると、新しいエディタータブで詳細が開きます。詳細ビューには、分類、重大度、問題の説明、修正の説明が表示されます。
- Corgeaが修正を生成している場合は、
Suggested Changeセクションに差分が並べて表示され、適用する前に内容を確認できます。 Open Sourceをクリックすると脆弱なコードに移動し、Open in CorgeaをクリックするとWebアプリケーションで検出結果を確認できます。
修正の適用
- 修正を適用するには、詳細ビューの
Apply Fixボタンをクリックします。Corgeaが関連ファイルを自動的に更新します。 - エディターから直接適用することもできます。強調表示された行のガターアイコンをクリックする、
Alt+Enterを押してApply Corgea fixを選択する、または右クリックしてCorgea>Apply Corgea Fixを選択します。 - CorgeaはAIで修正を生成し、品質チェック後に提示します。ただし、変更内容はコードベース上でも検証してください。
- 更新されたファイルを保存します。
依存関係の脆弱性を見る
Dependenciesタブには、パッケージ別にまとめられたSCAの検出結果が、重大度、CVE番号、脆弱性が解消されるバージョンとともに表示されます。
- 検出結果をクリックすると詳細が開き、パッケージのレジストリ、現在のバージョンと修正済みバージョン、脆弱性の説明が表示されます。
Open in Corgeaをクリックすると、Webアプリケーションで検出結果を確認できます。
ログアウト
- ログアウトする場合や別のユーザーでログインする場合は、Corgeaツールウィンドウの
Logoutをクリックします。