getKeyVault()

このバージョンのドキュメントはアーカイブされており、サポートされなくなりました。5.0 配置をアップグレードするには、 MongoDB 6.0 のアップグレード手順を参照してください。

getKeyVault()

現在のデータベース接続のKeyVaultオブジェクトを返します。 KeyVaultオブジェクトは、クライアント側のフィールドレベル暗号化のためのデータ暗号化キー管理をサポートします。

次の値を返します。	現在のデータベース接続の`KeyVault`オブジェクト。

互換性

このコマンドは、次の環境でホストされている配置で使用できます。

MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージドサービスです

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

getKeyVault() の構文は次のとおりです。

keyVault = db.getMongo().getKeyVault();

次のデータ暗号化キー管理メソッドにアクセスするには、 KeyVaultオブジェクトを使用します。

動作

データベース接続にクライアント側のフィールドレベル暗号化を構成する必要があります

次の例では、クライアント側のフィールドレベル暗号化構成にローカルで管理されているキーを使用しています。

mongoクライアント側のフィールドレベル暗号化メソッドでは、クライアント側のフィールドレベル暗号化が有効になっているデータベース接続が必要です。現在のデータベース接続がクライアント側のフィールドレベル暗号化を有効にして開始されなかった場合、次のいずれかが発生します。

必要なクライアント側のフィールドレベル暗号化オプションとの接続を確立するには、 Mongo()mongoshell からコンストラクターを使用します。The Mongo() method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:
or
必要なオプションとの接続を確立するには、 mongo shellコマンドラインオプションを使用します。コマンドラインオプションは、CMK 管理用のAmazon Web Services KMSプロバイダーのみをサポートしています。

キーヴォールトの一意の部分インデックス

getKeyVault()keyAltNamesメソッドは、keyAltNames が存在するドキュメントのみの部分インデックスフィルターを使用して、フィールドに一意のインデックスを自動的に作成します。getKeyVault()は、キーヴォールトコレクションにこのインデックスを作成します。これにより、同じキーヴォールト内の 2 つのデータ暗号化キーが同じキーの別名を持つことがなくなり、どのデータ暗号化キーが暗号化および復号化に適しているかがあいまいになることがなくなります。

警告

getKeyVault()によって作成された一意のインデックスを削除しないでください。クライアント側のフィールドレベル暗号化操作は、サーバーが強制する一意性であるkeyAltNamesに依存します。インデックスを削除すると、予期しない、または予測できない動作が発生する可能性があります。

例

次の例では、クライアント側のフィールドレベル暗号化構成にローカルで管理されているキーを使用しています。

ローカルで管理されているキーに対してクライアント側のフィールドレベル暗号化を構成するには、改行を含まない base64 でエンコードされた 96 バイトのstringを指定する必要があります。次の操作では、前述の要件を満たすキーを生成し、それをmongo shell にロードします。

TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")
mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"

生成されたローカルキーstringを使用して、クライアント側のフィールドレベル暗号化オブジェクトを作成します。

var ClientSideFieldLevelEncryptionOptions = {
  "keyVaultNamespace" : "encryption.__dataKeys",
  "kmsProviders" : {
    "local" : {
      "key" : BinData(0, TEST_LOCAL_KEY)
    }
  }
}

Mongo()コンストラクターを使用して、クライアント側のフィールドレベル暗号化オプションを持つデータベース接続を作成します。 mongodb://myMongo.example.net URI を、ターゲットクラスターの接続string URIに置き換えます。

encryptedClient = Mongo(
  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
  ClientSideFieldLevelEncryptionOptions
)

キーヴォールトオブジェクトを取得するには、 getKeyVault()メソッドを使用します。

keyVault = encryptedClient.getKeyVault()

クライアント側のフィールドレベル暗号化を有効にして MongoDB 接続を開始する方法に関する詳細なドキュメントについては、 Mongo()を参照してください。

戻る

getClientEncryption

KeyVault.addKeyAlternateName