VS Code Extension
ガイド
VS Code 拡張機能
VS Code の中からワークスペースをスキャンします。検出結果はエディター、問題パネル、Scanverra サイドバーに表示され、コードがマシンの外に出ることはありません。
インストール
拡張機能は Visual Studio Marketplace で Scanverra という名前で公開されています。
- 拡張機能ビューを開きます(Ctrl+Shift+X、macOS では Cmd+Shift+X)。
- Scanverra を検索して「インストール」をクリックします。
- アクティビティバーに盾のアイコンが表示されます。これが Scanverra ビューです。
または Quick Open(Ctrl+P、macOS では Cmd+P)に次を貼り付けます
ext install scanverra.scanverra-vscode
ログイン
スキャンには Scanverra の API キーが必要です。ダッシュボードの API Keys で作成してください。
- Scanverra ビューを開きます。ログインしていない場合はログインカードが表示されます。
- API キーを貼り付けて Save API key をクリックします。キーは保存前に Scanverra で確認されます。
- コマンドパレットから Scanverra: Log In with API Key を実行することもできます。
拡張機能と Scanverra CLI は同じ保存済みログイン情報を使います。scanverra login を実行済みなら拡張機能もログイン済みになり、VS Code からログインすると CLI もログインされます。
Scanverra ビューで Log out をクリックするか、Scanverra: Log Out を実行します。このマシン上の拡張機能と CLI の両方から保存済みキーが削除されます。
ワークスペースをスキャン
- VS Code でフォルダーを開きます。
- Scanverra ビューの Scan Workspace をクリックするか、ステータスバーの盾をクリックするか、Scanverra: Scan Workspace を実行します。
- 検出結果はエディター上の波線と問題パネルに表示され、サイドバーではファイルごとにまとめられます。
- 重大度のチップと検索ボックスで絞り込み、View で該当箇所に移動、Fix で修正案を確認します。
- Clear をクリックすると結果を消去できます。
仕組み
インライン診断
各検出結果はエディターの該当行に表示され、問題パネルにも一覧表示されます。
トリアージ用サイドバー
スコア、品質ゲート、重大度フィルター、ファイルごとの検出結果、別タブで依存関係の脆弱性。
ローカルでスキャン
CLI と同じエンジンです。ファイルはお使いのマシン上で読み取り・チェックされます。
前回のスキャンを保持
結果はワークスペースごとに保存され、VS Code を再起動しても残ります。
コマンド
すべてのコマンドはコマンドパレット(Ctrl+Shift+P、macOS では Cmd+Shift+P)から実行できます。
| コマンド | 説明 |
|---|---|
Scanverra: Scan Workspace | 開いているフォルダーをスキャンして結果を表示 |
Scanverra: Clear Scan Results | エディターとサイドバーから検出結果を消去 |
Scanverra: Open Full View | 結果をエディターのタブで大きく表示 |
Scanverra: Log In with API Key | API キーを貼り付けて確認 |
Scanverra: Get an API Key | ブラウザーで API Keys ページを開く |
Scanverra: Log Out | 保存済みの API キーを削除 |
マシンの外に送信されるもの
拡張機能は署名付きのスキャナールールを Scanverra からダウンロードして検証し、すべてのチェックをお使いのマシン上で実行します。ファイル、検出されたコード行、レポートがアップロードされることはありません。送信されるのはアカウントとプランを確認するための API キーのみです。
現在の制限事項
- スキャンは手動実行のみです。保存時の自動スキャンはまだありません。
- 検出結果は特定の列ではなく行全体で強調表示されます。
- マルチルートワークスペースでは、最初のフォルダーのみスキャンされます。
トラブルシューティング
| メッセージ | 対処方法 |
|---|---|
Log in to Scanverra | Scanverra ビューに API キーを貼り付けるか、Scanverra: Log In with API Key を実行してください |
That API key was rejected | キーが間違っているか取り消されています。API Keys で新しいキーを作成してください |
Your saved API key was rejected | 保存済みのキーが使えなくなりました。ログインカードに新しいキーを貼り付けてください |
Requires a Pro, Team or Enterprise plan | プランをアップグレードしてから再度スキャンしてください |
Open a folder to scan | ファイル > フォルダーを開く でフォルダーを開いてからスキャンしてください |
No scannable files found | フォルダーと .gitignore / .scanverraignore を確認してください |
エディターからスキャンする準備はできましたか?
API キーを作成し、拡張機能をインストールして、最初のスキャンを実行しましょう。