編集

Visual Studio Code拡張機能

Keeperボルトの機能を開発ワークフローに直接統合するVS Code拡張機能

概要

Keeperボルトの機能を開発ワークフローに直接統合する、包括的なVS Code拡張機能です。この拡張機能には、Keeperボルトからのシークレットの保存、取得、生成、コマンド実行といった安全なシークレット管理機能が備わっています。

開発者は開発環境を離れることなく、最高水準のセキュリティを維持しながらシークレットを安全に管理でき、既存のKeeperインフラとのシームレスな統合が可能です。

インストール方法

Visual Studio Codeの拡張機能は、VS Codeのメニューから [設定] > [拡張機能] に進み、「Keeper Security」を検索してインストールします。拡張機能の詳細ページはこちらです。

Cursorやその他のVS Codeフォークを使用している場合は、Open VSX Registryからもインストールできます。

主な機能

  • シークレット管理: Keeperボルトを利用し、VS Codeから直接シークレットの保存・取得・生成が可能

  • シークレット検出: 設定ファイル内のAPIキー、パスワード、トークン、JWT、AWSキー、Stripeキーなどの潜在的なシークレットをパターン認識で自動検出

  • 安全な実行: Keeperボルトから注入されたシークレットを使ってコマンドを安全に実行

  • 包括的なログ機能: デバッグモード対応の組み込みログシステムを搭載

要件

  • KeeperコマンダーCLI: 公式バイナリを使用してシステムにグローバルインストールし、認証済みであること

  • Keeperアカウント: ボルトアクセスを含む有効なサブスクリプション

  • システム要件: VS Code バージョン1.99.0以降

セットアップ

KeeperコマンダーCLIバイナリのインストール

  1. オペレーティングシステムに応じて、Keeperコマンダーインストールガイドに従いバイナリをダウンロードしてインストールします。

  2. インストール後、CLIがシステムのシェルPATHからアクセスできることを確認してください。

  3. ターミナルを開き、次のコマンドを実行します:

keeper --version

以下のような出力が表示されれば、コマンダーCLIが正しくインストールされ、グローバルにアクセス可能であることを確認できます。

Keeper Commander, version 17.1.8

インストール完了後、インストール中にVS Codeを開いていた場合は、VS Codeを開き直してください。

KeeperコマンダーCLIで認証する

  1. ターミナルまたはコマンドプロンプトを開きます。

  2. 次のコマンドを実行します。

    keeper shell

  3. ログインしていない場合は、Keeperの認証情報の入力を求められます。指示に従ってログインを完了してください。

  4. ログインが成功すると、プロンプトが次のように変わります:

    My Vault>

5.　この My Vault> プロンプト内で、以下のいずれかの方法でセットアップを完了します。

  • 永続ログインを有効化する場合

this-device persistent-login on
this-device register

一定時間操作がない場合の自動ログアウト時間を設定するには、次のコマンドを実行します。

this-device timeout 600

これにより「logout_timer」が10時間に設定されます。

  • 生体認証ログインを使用する場合

biometric register

生体認証(指紋またはFace ID)のプロンプトが表示されます。認証に成功すると、登録が完了します。

詳細については、こちらのページをご参照ください。

拡張機能のインストール

VS Codeの拡張機能マーケットプレイスで「Keeper Security」と検索し、拡張機能をインストールします。

拡張機能へのアクセスを確認する

  1. VS Codeのコマンドパレットを開きます (Ctrl+Shift+P または Cmd+Shift+P)。

  2. 「Keeper Security」と入力すると、利用可能なコマンドがすべて表示されます。

コマンダーCLIの設定を手動で変更した場合は、エディタウィンドウを再読み込みする必要があります。Ctrl+Shift+P (Macの場合はCmd+Shift+P) を押して、Developer: Reload Window　を選択します。

使用方法

利用可能なコマンド

認証後、コマンドパレット (Ctrl+Shift+P または Cmd+Shift+P) から以下のコマンドにアクセスできます。

コマンド
説明
使用例

Save in Keeper Security

選択したテキストをボルト内のシークレットとして保存します

ハードコードされたシークレットをKeeper参照に置き換えて保存

Get from Keeper Security

既存のシークレットをボルトからKeeper参照として挿入します

シークレットの値を露出させずに保存済みのシークレットを取得

Run Securely

シークレットを注入してコマンドを安全に実行します

実行時にボルト内のシークレットを利用してアプリケーションを実行

Choose Folder

シークレットを保存するボルトのフォルダを選択します

特定のフォルダにシークレットを保存する場合に使用

Generate Password

安全なパスワードを生成して保存します

新しい安全な認証情報を作成

Open Logs

拡張機能のアクティビティログを表示します

拡張機能の動作をデバッグまたは監視

コマンドの詳細

Keeperボルトに保存する

1. コマンドパレットから実行

目的

  • 選択したテキストをKeeper Securityボルト内のシークレットとして保存し、その部分をKeeper参照に置き換えます。

手順

  1. 保存したいデータを選択します。

  2. コマンドパレットを開きます (Ctrl+Shift+P または Cmd+Shift+P)。

  3. Keeper Security: Save in Keeper Vault と入力して選択します。

  4. 必要に応じて、拡張機能がKeeperに認証を行います。

  5. レコード名およびフィールド名を入力します。

  6. 拡張機能によりKeeperボルト内に新しいアイテムが作成されます。

  7. 選択したテキストが、ユーザーのカーソル位置にシークレット参照 (keeper://...) として自動的に置き換えられます。

2. シークレットの自動検出

目的

  • コード内の潜在的なシークレットを自動的に検出し、簡単に識別・保護できるようにします。

機能

  • 拡張機能が既知のシークレットパターンを基にファイルをスキャンします。

  • 検出されたシークレットの上にCodeLensが表示されます。

  • CodeLensには「Save in Keeper Security」オプションが表示されます。

  • CodeLensをクリックし、表示される手順に従って検出されたシークレットを保存します。

  • 検出されたシークレットは自動的にKeeper参照 (keeper://...) に置き換えられ、ユーザーのカーソル位置に挿入されます。

対応ファイル形式

  • 環境ファイル: .env, .env.* など

  • 設定ファイル: config.json, docker-compose.yml など

Keeperボルトから取得する

目的

  • Keeperボルト内の既存のシークレットを実際の値を表示せずに、Keeper参照としてコード内に挿入します。

手順

  1. コマンドパレットを開きます (Ctrl+Shift+P または Cmd+Shift+P)。

  2. Keeper Security: Get from Keeper Vault と入力して選択します。

  3. 拡張機能が利用可能なレコードの一覧を表示します。

  4. 使用したいレコードとフィールドを選択します。

  5. 選択したシークレット参照が、ユーザーのカーソル位置に挿入されます。

参照形式

keeper://record-uid/field/item

例

安全に実行する

目的

  • 選択した .env ファイル内で定義されたKeeper参照を基に、Keeperボルトから取得したシークレット値を注入してコマンドを実行します。

手順

  1. コマンドパレットを開きます (Ctrl+Shift+P または Cmd+Shift+P)。

  2. Keeper Security: Run Securely を検索して選択します。

  3. 使用する .env ファイルを選択します。

    • 現在のワークスペース内にある利用可能な .env ファイルがドロップダウンに表示されます。

    • 別の場所から選択する場合は「Browse Environment File」を選びます。

    • ファイル選択ダイアログで隠しファイル (.env など) が表示されない場合は、以下のショートカットを使用します。

      • macOS: Cmd + Shift + .

      • Windows: Ctrl + H (一部のファイルダイアログで有効)

      • Linux: Ctrl + H

  4. 実行したいコマンドを入力します。

  5. 拡張機能が選択した .env ファイルからシークレットを注入し、新しいターミナルを作成してコマンドを実行します。

注意: アプリケーション内で注入されたシークレット値を利用するためには、対応する環境変数を参照する必要があります。

process.env.DB_PASSWORD
os.environ.get("API_KEY")

.env ファイルには、次のようなKeeper参照を含めてください。

DB_PASSWORD=keeper://record-uid/password
API_KEY=keeper://record-uid/api_key

これらの参照は「Run Securely」を使用した実行時に解決され、実際の値が注入されます。

例

フォルダを選択する

目的

  • このワークスペースで使用するシークレットを保存するKeeperボルト内のフォルダを指定します。

手順

  1. コマンドパレットを開きます (Ctrl+Shift+P または Cmd+Shift+P)。

  2. Keeper Security: Choose Folder と入力して選択します。

  3. 拡張機能が利用可能なボルトフォルダの一覧を表示します。

  4. このワークスペースで使用するフォルダを選択します。

以後、「Save in Keeper Security」および「Generate Password」の操作で作成されるシークレットは、選択したフォルダに保存されます。

例

パスワードを生成する

目的

  • 安全なパスワードを生成し、Keeperボルトに保存します。

手順

  1. コマンドパレットを開きます (Ctrl+Shift+P または Cmd+Shift+P)。

  2. Keeper Security: Generate Password と入力して選択します。

  3. レコード名を入力します。

  4. 生成されたパスワードの参照が、ユーザーのカーソル位置に挿入されます。

例

ログを開く

目的

  • 拡張機能の動作ログを表示し、デバッグや監視を行います。

手順

  1. コマンドパレットを開きます (Ctrl+Shift+P または Cmd+Shift+P)。

  2. Keeper Security: Open Logs と入力して選択します。

  3. 拡張機能が出力パネルを開き、詳細なログが表示されます。

例

拡張機能の設定

この拡張機能には、以下の設定オプションがあります。

手順

  1. VS Codeの設定を開きます (Ctrl+, または Cmd+,)。

  2. 検索バーに「Keeper Security」と入力します。

  3. 以下のオプションを設定します。

設定項目
説明
デフォルト値

Debug Enabled

デバッグ用の詳細なログを有効にします

false

Secret Detection

シークレットの自動検出を有効にします

true

注意: デバッグモードを有効にした場合、変更を反映させるには拡張機能を再読み込みする必要があります。Ctrl+Shift+P (Macの場合はCmd+Shift+P) を押し、Developer: Reload Window を選択してください。

トラブルシューティング

デバッグモード

拡張機能の動作に関する詳細情報を確認するため、デバッグログを有効にします。

手順

  1. VS Codeの設定を開きます(Ctrl+, または Cmd+,)。

  2. 検索バーに「Keeper Security」と入力します。

  3. 「Debug」オプションを有効にします。

  4. ウィンドウを再読み込みします(Ctrl+Shift+P または Cmd+Shift+P → 「Developer: Reload Window」)。

よくある問題

1. 拡張機能全般の問題

問題

  • シークレットの取得に時間がかかる、ロードが続く、Keeper参照が解決されない、コマンダーCLI認証の手動変更後に不具合が出る、など。

解決策

  • エディターウィンドウを再読み込みする (Ctrl+Shift+P または Cmd+Shift+P → 「Developer: Reload Window」)

  • KeeperコマンダーCLIが永続ログインまたは生体認証ログインで認証されていることを確認する

  • インターネット接続およびファイアウォール設定を確認する

  • Keeperボルトにアクセスできることを確認する

  • 問題が続く場合は拡張機能のキャッシュをクリアする

2. KeeperコマンダーCLIが見つからない

問題

  • 「Keeper Commander CLI is not installed」と表示される

解決策

  • インストールガイドに従い、KeeperコマンダーCLIをグローバルにインストールする

  • CLIがシステムPATHからアクセス可能であることを確認する

  • ターミナルで次のコマンドを実行してインストールを確認する

    keeper --version

3. 認証エラー

問題

  • 「Keeper Commander CLI is not authenticated」と表示される

解決策

  1. ターミナルまたはコマンドプロンプトを開き、以下を実行します。

    keeper shell

  2. ログインしていない場合はKeeperの認証情報入力を求められます。指示に従ってログインしてください。

  3. ログイン成功後、プロンプトが次のように変わります。

    My Vault>

  4. こちらに記載の手順を使用して永続ログインまたは生体認証ログインを有効にします。

詳しくはログインのページをご参照ください。

注意: コマンダーCLIに再ログインした場合は、Ctrl+Shift+P (Macの場合Cmd+Shift+P) を押し、Developer: Reload Windowを選択してエディターウィンドウを再読み込みしてください。

4. コマンドが表示されない

問題

  • コマンドパレットにKeeper Securityのコマンドが表示されない

解決策

  • 正しいKeeper Security拡張機能がインストールされていることを確認する

  • コマンドが表示されない場合はVS Codeウィンドウを再読み込みする

  • 拡張機能が有効化されていることを確認する

5. 拡張機能が読み込まれない

問題

拡張機能がアクティブ化されない、またはエラーが発生する

解決策

  • VS Codeのバージョンを確認する (1.99.0以降が必要)

  • Node.jsのバージョンを確認する (18.0.0以降が必要)

  • 拡張機能を再インストールする

6. 「Run Securely」コマンドの問題

問題

  • コマンドでシークレットが注入されない

解決策

  • コマンドパレットから「Keeper Security: Run Securely」を使用して実行する

  • .env ファイルに有効な keeper:// 参照が含まれていることを確認する

  • 参照しているシークレットがボルト内に存在することを確認する

  • 不要なターミナルを削除し、拡張機能が新しいターミナルを作成していることを確認する

7. フォルダ選択の問題

問題

  • ボルトフォルダを選択または変更できない

解決策

  • ボルト内のフォルダにアクセスするための権限があることを確認する

  • KeeperコマンダーCLIに適切な権限が付与されていることを確認する

  • ボルト内のフォルダ構成を確認する

  • ウィンドウを再読み込みする

前へTerraform Provider次へWindows資格情報マネージャー

最終更新