KeyVault.getKey()（mongoshメソッド）

KeyVault.getKey(UUID)

指定されたUUIDのデータ暗号化キーを取得します。データ暗号化キーは、データベース接続に関連付けられたキーヴォールトに存在する必要があります。

次の値を返します。	一致するデータ暗号化キーを表すドキュメント。

互換性

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

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

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

構文

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

keyVault = db.getMongo().getKeyVault()
keyVault.getKey(UUID("<UUID String>"))

UUID は、サブタイプ 4 を持つ BSON binary data オブジェクトです。

動作

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

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

Mongo()必要なクライアント側のフィールドレベル暗号化オプションとの接続を確立するには、mongosh からコンストラクターを使用します。Mongo()メソッドは、CMK（Customer Master Key）管理のために次のKMS （ KMS ）プロバイダーをサポートしています。
or
必要なオプションとの接続を確立するには、 mongoshコマンドラインオプションを使用します。コマンドラインオプションは、CMK 管理用のAmazon Web Services KMSプロバイダーのみをサポートしています。

例

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

mongosh を起動する

mongoshクライアントを起動します。

mongosh --nodb

キーの生成

ローカルで管理されているキーのクライアント側フィールドレベル暗号化を構成するには、改行を含まない base64 でエンコードされた 96 バイトのstringを生成します。

const TEST_LOCAL_KEY = require("crypto").randomBytes(96).toString("base64")

クライアント側のフィールドレベル暗号化オプションの作成

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

 let autoEncryptionOpts = {   "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",   autoEncryptionOpts)

keyVaultオブジェクトを取得し、 KeyVault.getKey()を使用してそのUUIDを使用してデータ暗号化のキーを取得します。

keyVault = encryptedClient.getKeyVault()keyVault.getKey(UUID("b4b41b33-5c97-412e-a02b-743498346079"))

getKey() は、データ暗号化キーを返し、次のような出力を返します。

{  "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"),  "keyMaterial" : BinData(0,"E+0jZKzA4YuE1lGmSVIy2mivqH4JxFo0yFATdxYX/s0YtMFsgVXyu7Bbn4IQ2gn7F/9JAPJFOxdQc5lN3AR+oX33ewVZsd63f3DN1zzcukqdR2Y+EeO7ekRxyRjdzMaNNrBNIv9Gn5LEJgWPSYkG8VczF7cNZnc1YmnR0tuDPNYfm0J7dCZuZUNWW3FCGRcdFx6AlXiCtXKNR97hJ216pQ=="),  "creationDate" : ISODate("2021-03-16T18:22:43.733Z"),  "updateDate" : ISODate("2021-03-16T18:22:43.733Z"),  "status" : 0, "version" : Long(0),  "masterKey" : {    "provider" : "local"  },  "keyAltNames" : [     "alpha"  ]}

戻る

KeyVault.deleteKey

KeyVault.getKeys